prebuilt-tdlib - npm Package Compare versions

Comparing version 0.1008000.0 to 0.1008000.1

index.js

@@ -6,2 +6,3 @@ // @flow
 // For now, the `Options` object is present for forward compatibility.
+// TODO: Add an option like "fallback"?
 /*::
@@ -11,3 +12,4 @@ export type Options = {
   libc: 'glibc'
-} */
+}
+*/
 
@@ -20,10 +22,10 @@ function prebuild (pathcomps/*: string[] */) {
 function getTdjson (options/*:: ?: Options */)/*: string */ {
-  if (process.arch !== 'x64')
-    throw new Error(`The ${process.arch} architecture is not supported`)
-  switch (process.platform) {
-    case 'win32': return prebuild(['tdlib-windows-x64', 'tdjson.dll'])
-    case 'darwin': return prebuild(['tdlib-macos-x64', 'libtdjson.dylib'])
-    case 'linux': return prebuild(['tdlib-linux-x64', 'libtdjson.so'])
-    case 'android': return prebuild(['tdlib-linux-x64', 'libtdjson.so'])
-    default: throw new Error(`The ${process.platform} OS is not supported`)
+  const platform = process.platform + '-' + process.arch
+  switch (platform) {
+    case 'win32-x64': return prebuild(['tdlib-windows-x64', 'tdjson.dll'])
+    case 'darwin-x64': return prebuild(['tdlib-macos', 'libtdjson.dylib'])
+    case 'darwin-arm64': return prebuild(['tdlib-macos', 'libtdjson.dylib'])
+    case 'linux-x64': return prebuild(['tdlib-linux-x64', 'libtdjson.so'])
+    case 'android-x64': return prebuild(['tdlib-linux-x64', 'libtdjson.so'])
+    default: throw new Error(`The ${platform} platform is not supported`)
   }
@@ -30,0 +32,0 @@ }

package.json

 {
   "name": "prebuilt-tdlib",
-  "version": "0.1008000.0",
+  "version": "0.1008000.1",
   "description": "Prebuilt TDLib libraries",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,2 @@
-## Prebuilt TDLib
+# Prebuilt TDLib
 
@@ -12,17 +12,24 @@ This package distributes pre-built [TDLib][] shared libraries through npm.
 
-Supported systems are GNU/Linux x86_64, macOS x86_64, Windows x86_64.
+Supported systems:
+- GNU/Linux x86_64 (requires glibc >= 2.17)
+- macOS x86_64, arm64 (universal, requires macOS >= 10.14)
+- Windows x86_64
 
-On Linux, TDLib is built on Ubuntu 20.04 and requires glibc version >= 2.31 to
-be installed on your system.
+To install `prebuilt-tdlib` for e.g. TDLib v1.8.19, run:
 
-Note that M1 Macs are not supported yet.
-
-To install `prebuilt-tdlib` for e.g. TDLib v1.8.0, run:
-
 ```console
-$ npm install prebuilt-tdlib@td-1.8.0
+$ npm install prebuilt-tdlib@td-1.8.19
 ```
 
-### Usage
+`prebuilt-tdlib` can be installed for other TDLib versions, run
+`$ npm info prebuilt-tdlib dist-tags` to get the list of available versions
+(or see the "npm tags" section below).
 
+> **Note**: Before `prebuilt-tdlib@td-1.8.14` (2023-06-26), the Linux binary was
+> built on Ubuntu 20.04 requiring glibc >= 2.31, and macOS arm64 was not
+> supported. Currently, the Linux build environment is based on CentOS 7. The
+> macOS arm64 binary isn't tested in the CI.
+
+## Usage
+
 The `prebuilt-tdlib` package exports a single function `getTdjson`, which
@@ -39,3 +46,3 @@ returns the path to the `tdjson` shared library.
 This package can be used with, for example, [`tdl`][tdl]. You can pass the
-path to the `TDLib` constructor:
+path to `tdl.configure` (since tdl v7.3.0):
 
@@ -45,10 +52,17 @@ [tdl]: https://github.com/Bannerets/tdl
 ```javascript
-const { TDLib } = require('tdl-tdlib-addon')
+const tdl = require('tdl')
 const { getTdjson } = require('prebuilt-tdlib')
-/* ... */ new TDLib(getTdjson()) /* ... */
+tdl.configure({ tdjson: getTdjson() })
+// ...
 ```
 
-### Versioning
+The pre-built libraries can also be extracted and used with any other library
+or programming language.
 
-Because TDLib does not follow Semver, to not require the users to manually
+## Versioning conventions
+
+> **Note**: This information is mostly for maintaining `prebuilt-tdlib`, it
+> isn't necessary for using this package.
+
+Because TDLib does not follow SemVer, not to require the users to manually
 specify the exact version of `prebuilt-tdlib` in their `package.json`, the TDLib
@@ -66,3 +80,3 @@ version is packed into a single minor version.
 
-E.g. the npm release for TDLib `v1.8.5` is `0.1008005.0`.
+Example: the npm release for TDLib `v1.8.5` is `0.1008005.0`.
 
@@ -74,10 +88,25 @@ For convenience, `td-X` dist-tags are available. To install `prebuilt-tdlib` for
 
-Additionaly, TDLib's versioning is weird, and some of the `prebuilt-tdlib`
-releases are not tied to a specific tag release in the TDLib repository.
+Additionaly, TDLib's releasing process is weird, and most of the
+`prebuilt-tdlib` releases are not connected to a specific tag release in the
+TDLib repository.
 
-### npm tags
+The releases of the `prebuilt-tdlib` npm package are not git-tagged.
 
-[![npm](https://img.shields.io/npm/v/prebuilt-tdlib/latest.svg)](https://www.npmjs.com/package/prebuilt-tdlib)<br>
-[![npm](https://img.shields.io/npm/v/prebuilt-tdlib/beta.svg)](https://www.npmjs.com/package/prebuilt-tdlib)<br>
-[![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.5.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.5) (tdlib commit [d9cfcf88fe4ad06dae1716ce8f66bbeb7f9491d9](https://github.com/tdlib/td/commit/d9cfcf88fe4ad06dae1716ce8f66bbeb7f9491d9))<br>
-[![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.0.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.0)<br>
+## npm tags
+
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/latest.svg)](https://www.npmjs.com/package/prebuilt-tdlib)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/stable.svg)](https://www.npmjs.com/package/prebuilt-tdlib)
+
+<!-- Add new versions below -->
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.19.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.19) tdlib [2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09](https://github.com/tdlib/td/commit/2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.14.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.14) tdlib [66234ae2537a99ec0eaf7b0857245a6e5c2d2bc9](https://github.com/tdlib/td/commit/66234ae2537a99ec0eaf7b0857245a6e5c2d2bc9)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.12.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.12) tdlib [70bee089d492437ce931aa78446d89af3da182fc](https://github.com/tdlib/td/commit/70bee089d492437ce931aa78446d89af3da182fc)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.7.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.7) tdlib [de5379f00b6af7686f197037ca3b494e6277e523](https://github.com/tdlib/td/commit/de5379f00b6af7686f197037ca3b494e6277e523)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.5.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.5) tdlib [d9cfcf88fe4ad06dae1716ce8f66bbeb7f9491d9](https://github.com/tdlib/td/commit/d9cfcf88fe4ad06dae1716ce8f66bbeb7f9491d9)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.8.0.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.8.0)
+
+Outdated versions:
+
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.7.0.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.7.0)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.6.0.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.6.0)
+- [![npm](https://img.shields.io/npm/v/prebuilt-tdlib/td-1.5.0.svg)](https://www.npmjs.com/package/prebuilt-tdlib/v/td-1.5.0)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

78421341

increased by23.21%

Number of package files

13

increased by44.44%

Lines of code

31

increased by10.71%

Number of lines in readme file

108

increased by36.71%

No dependency changes