@openzim/libzim 2.4.4 → 3.1.0

package/download-libzim.js

@@ -1,59 +1,78 @@
-require('dotenv').config();
-const axios = require('axios');
-const mkdirp = require('mkdirp');
-const exec = require('exec-then');
-const os = require('os');
-const fs = require('fs');
-const urlParser = require('url');
+require("dotenv").config();
+const axios = require("axios");
+const mkdirp = require("mkdirp");
+const exec = require("exec-then");
+const os = require("os");
+const fs = require("fs");
+const urlParser = require("url");
 
-mkdirp.sync('./download');
+mkdirp.sync("./download");
 
-const isMacOS = os.type() === 'Darwin'
-const isLinux = os.type() === 'Linux'
+const isMacOS = os.type() === "Darwin";
+const isLinux = os.type() === "Linux";
+const rawArch = os.arch();
+const isAvailableArch =
+  rawArch === "x64" || rawArch === "arm" || rawArch === "arm64";
 
 if (!isMacOS && !isLinux) {
-    console.warn(`\x1b[41m\n================================ README \n\nPre-built binaries only available on Linux and MacOS for now...\nPlease ensure you have libzim installed globally on this machine:\n\n\thttps://github.com/openzim/libzim/\n\n================================\x1b[0m\n`);
+  console.warn(
+    `\x1b[41m\n================================ README \n\nPre-built binaries only available on Linux and MacOS for now...\nPlease ensure you have libzim installed globally on this machine:\n\n\thttps://github.com/openzim/libzim/\n\n================================\x1b[0m\n`
+  );
+}
+if (!isAvailableArch) {
+  console.warn(
+    `\x1b[41m\n================================ README \n\nPre-built binaries only available on x86_64, arm and arm64 for now...\nPlease ensure you have libzim installed globally on this machine:\n\n\thttps://github.com/openzim/libzim/\n\n================================\x1b[0m\n`
+  );
+}
+
+let osPrefix = isMacOS ? "macos" : "linux";
+let osArch = isLinux ? "x86_64-bionic" : "x86_64";
+
+if (rawArch !== "x64") {
+  if (isLinux) {
+    osArch = rawArch === "arm64" ? "aarch64-bionic" : "armhf";
+  } else {
+    osArch = rawArch;
+  }
 }
 
-let osPrefix = (isMacOS) ? 'macos' : 'linux';
 const urls = [
-    `http://download.openzim.org/release/libzim/libzim_${osPrefix}-x86_64-${process.env.LIBZIM_VERSION}.tar.gz`,
-].filter(a => a);
+  `https://download.openzim.org/release/libzim/libzim_${osPrefix}-${osArch}-${process.env.LIBZIM_VERSION}.tar.gz`,
+].filter((a) => a);
 
 for (let url of urls) {
-    console.info(`Downloading Libzim from: `, url);
-    const filename = urlParser.parse(url).pathname.split('/').slice(-1)[0];
-    const dlFile = `./download/${filename}`;
-
-    try {
-        fs.statSync(dlFile);
-        console.warn(`File [${dlFile}] already exists, not downloading`);
-        return;
-    } catch (err) { }
-
-    axios({
-        url,
-        method: 'get',
-        responseType: 'stream'
+  console.info(`Downloading Libzim from: `, url);
+  const filename = urlParser.parse(url).pathname.split("/").slice(-1)[0];
+  const dlFile = `./download/${filename}`;
+
+  try {
+    fs.statSync(dlFile);
+    console.warn(`File [${dlFile}] already exists, not downloading`);
+    return;
+  } catch (err) {
+    //
+  }
+
+  axios({
+    url,
+    method: "get",
+    responseType: "stream",
+  })
+    .then(function (response) {
+      const ws = fs.createWriteStream(dlFile);
+      return new Promise((resolve, reject) => {
+        response.data.pipe(ws).on("error", reject).on("close", resolve);
+      });
+    })
+    .then(() => {
+      const cmd = `tar --strip-components 1 -xf ${dlFile} -C ./download`;
+      console.log(`Running Extract:`, `[${cmd}]`);
+      return exec(cmd);
+    })
+    .then(() => {
+      console.info(`Successfully downloaded and extracted file`);
     })
-        .then(function (response) {
-            const ws = fs.createWriteStream(dlFile);
-            return new Promise((resolve, reject) => {
-                response.data
-                    .pipe(ws)
-                    .on('error', reject)
-                    .on('close', resolve);
-            });
-        })
-        .then(() => {
-            const cmd = `tar --strip-components 1 -xf ${dlFile} -C ./download`;
-            console.log(`Running Extract:`, `[${cmd}]`);
-            return exec(cmd);
-        })
-        .then(() => {
-            console.info(`Successfully downloaded and extracted file`);
-        })
-        .catch(err => {
-            console.error(`Failed to download and extract file:`, err);
-        });
+    .catch((err) => {
+      console.error(`Failed to download and extract file:`, err);
+    });
 }

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "@openzim/libzim",
-  "version": "2.4.4",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "version": "3.1.0",
   "description": "Libzim bindings for NodeJS",
   "scripts": {
     "clean": "rm -rf dist build/native/build",
     "tsc": "tsc",
-    "prepare": "npm run tsc",
+    "prepare": "mkdir -p dist/ && cp -v src/index.js src/index.d.ts dist/",
     "codecov": "nyc --reporter=lcov npm t",
     "install": "npm run download && node-gyp rebuild -v && npm run bundle",
+    "build": "node-gyp rebuild -v && npm run bundle",
     "download": "node ./download-libzim.js",
     "bundle": "node ./bundle-libzim.js",
     "test": "jest",
-    "test-mem-leak": "node -r ts-node/register test/makeLargeZim.ts"
+    "test-mem-leak": "node -r ts-node/register test/makeLargeZim.ts",
+    "lint": "npx eslint .",
+    "lint:fix": "npx eslint . --fix"
   },
   "nyc": {
     "extension": [
@@ -22,7 +27,6 @@
       "node_modules"
     ]
   },
-  "main": "dist/index.js",
   "author": "Joseph Reeve",
   "license": "GPL-3.0",
   "repository": {
@@ -35,32 +39,32 @@
   "homepage": "https://github.com/openzim/node-libzim#readme",
   "gypfile": true,
   "dependencies": {
-    "@types/bindings": "^1.5.0",
-    "@types/faker": "^4.1.12",
-    "@types/jest": "^25.2.3",
-    "@types/mime": "^2.0.3",
-    "@types/node": "^13.13.52",
-    "@types/rimraf": "^3.0.0",
-    "axios": "^0.21.1",
+    "@types/bindings": "^1.5.1",
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.0.6",
+    "axios": "^1.6.0",
     "bindings": "^1.5.0",
-    "dotenv": "^8.6.0",
+    "dotenv": "^16.0.1",
     "exec-then": "^1.3.1",
-    "faker": "^4.1.0",
-    "jest": "^25.5.4",
-    "mime": "^2.5.2",
-    "minimist": "^1.2.5",
     "mkdirp": "^1.0.4",
-    "node-addon-api": "^2.0.2",
-    "node-gyp": "^6.1.0",
-    "rimraf": "^3.0.2",
-    "tar": "^6.1.0",
-    "ts-jest": "^25.4.0",
-    "ts-node": "^8.10.2",
-    "tsconfig-paths": "^3.9.0"
+    "node-addon-api": "^5.0.0",
+    "node-gyp": "^9.3.1",
+    "tqdm": "^2.0.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.0.0"
   },
   "devDependencies": {
+    "@faker-js/faker": "^7.6.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
+    "eslint": "^8.39.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^28.1.3",
     "nyc": "^15.1.0",
-    "typescript": "^3.9.9"
+    "prettier": "^2.8.8",
+    "ts-jest": "^28.0.7",
+    "typescript": "^4.7.4"
   },
   "jest": {
     "preset": "ts-jest/presets/js-with-ts"