@openzim/libzim 3.2.3 → 3.4.0

package/.env

@@ -1 +1 @@
-LIBZIM_VERSION=9.2.1
+LIBZIM_VERSION=9.3.0

package/Changelog

@@ -1,3 +1,12 @@
+3.4.0
+* NEW: Add new libzim 9.3.0 APIs around cache management
+
+3.3.0
+* NEW: Use libzim 9.3.0
+* UPDATE: Upgrade many dependencies versions
+* UPDATE: drop macOS12, add macOS15 in the CI
+* UPDATE: drop ubuntu-20.04, add ubuntu-24.04 in the CI
+
 3.2.3
 * FIX: Module (finally) properly in ESM format
 

package/README.md

@@ -6,10 +6,11 @@ This is the Node.js binding to the
 [ZIM](https://openzim.org) files easily in Javascript.
 
 [![npm](https://img.shields.io/npm/v/@openzim/libzim.svg)](https://www.npmjs.com/package/@openzim/libzim)
-[![Build Status](https://github.com/openzim/node-libzim/workflows/CI/badge.svg?branch=main)](https://github.com/openzim/node-libzim/actions?query=branch%3Amain)
+[![Build Status](https://github.com/openzim/node-libzim/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openzim/node-libzim/actions/workflows/ci.yml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/openzim/node-libzim/branch/main/graph/badge.svg)](https://codecov.io/gh/openzim/node-libzim)
 [![CodeFactor](https://www.codefactor.io/repository/github/openzim/node-libzim/badge)](https://www.codefactor.io/repository/github/openzim/node-libzim)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![Join Slack](https://img.shields.io/badge/Join%20us%20on%20Slack%20%23mwoffliner-2EB67D)](https://slack.kiwix.org)
 
 ## Dependencies
 

package/bundle-libzim.js

@@ -1,6 +1,6 @@
 import dotenv from "dotenv";
 dotenv.config();
-import mkdirp from "mkdirp";
+import { mkdirp } from "mkdirp";
 import exec from "exec-then";
 import os from "os";
 
@@ -11,14 +11,14 @@ const isLinux = os.type() === "Linux";
 
 if (!isMacOS && !isLinux) {
   console.warn(
-    "\x1b[41m\n================================ README \n\nlibzim bundle with prebuilt binaries only available for macOS and Linux:\n\n\thttps://github.com/openzim/libzim/\n\n================================\x1b[0m\n"
+    "\x1b[41m\n================================ README \n\nlibzim bundle with prebuilt binaries only available for macOS and Linux:\n\n\thttps://github.com/openzim/libzim/\n\n================================\x1b[0m\n",
   );
 }
 
 if (isLinux) {
   console.info("Copying libzim.so.9 to build folder");
   exec(
-    "cp download/lib/x86_64-linux-gnu/libzim.so.9 build/Release/libzim.so.9"
+    "cp download/lib/x86_64-linux-gnu/libzim.so.9 build/Release/libzim.so.9",
   );
   exec("ln -sf build/Release/libzim.so.9 build/Release/libzim.so"); // convienience only, not required
 }
@@ -28,6 +28,6 @@ if (isMacOS) {
   exec("ln -sf build/Release/libzim.9.dylib build/Release/libzim.dylib"); // convienience only, not required
   console.info("Fixing rpath");
   exec(
-    "install_name_tool -change libzim.9.dylib @loader_path/libzim.9.dylib build/Release/zim_binding.node"
+    "install_name_tool -change libzim.9.dylib @loader_path/libzim.9.dylib build/Release/zim_binding.node",
   );
 }

package/dist/index.d.ts

@@ -66,7 +66,7 @@ export class StringItem {
     mimeType: string,
     title: string,
     hint: Hint,
-    content: ArrayBuffer | Buffer | string
+    content: ArrayBuffer | Buffer | string,
   );
   readonly path: string;
   readonly title: string;
@@ -81,7 +81,7 @@ export class FileItem {
     mimeType: string,
     title: string,
     hints: Hint,
-    filePath: string
+    filePath: string,
   );
   readonly path: string;
   readonly title: string;
@@ -102,14 +102,14 @@ export class Creator {
   addMetadata(
     name: string,
     content: string | ContentProvider,
-    mimetype?: string
+    mimetype?: string,
   ): void;
   addIllustration(size: number, content: string | ContentProvider): void;
   addRedirection(
     path: string,
     title: string,
     targetPath: string,
-    hints?: Hint
+    hints?: Hint,
   ): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
@@ -182,6 +182,14 @@ export class Archive {
   checkIntegrity(checkType: symbol): boolean; // one of IntegrityCheck
   get isMultiPart(): boolean;
   get hasNewNamespaceScheme(): boolean;
+  getClusterCacheMaxSize(): number;
+  getClusterCacheCurrentSize(): number;
+  setClusterCacheMaxSize(nbClusters: number): void;
+  getDirentCacheMaxSize(): number;
+  getDirentCacheCurrentSize(): number;
+  setDirentCacheMaxSize(nbDirents: number): void;
+  getDirentLookupCacheMaxSize(): number;
+  setDirentLookupCacheMaxSize(nbRanges: number): void;
 
   static validate(zimPath: string, checksToRun: symbol[]): boolean; // list of IntegrityCheck
 }

package/download-libzim.js

@@ -1,7 +1,7 @@
 import dotenv from "dotenv";
 dotenv.config();
 import axios from "axios";
-import mkdirp from "mkdirp";
+import { mkdirp } from "mkdirp";
 import exec from "exec-then";
 import os from "os";
 import fs from "fs";
@@ -20,21 +20,21 @@ const isAvailableArch =
 
 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`
+    `\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`
+    `\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";
+let osArch = isLinux ? "x86_64" : "x86_64";
 
 if (rawArch !== "x64") {
   if (isLinux) {
-    osArch = rawArch === "arm64" ? "aarch64-bionic" : "armhf";
+    osArch = rawArch === "arm64" ? "aarch64-manylinux" : "armhf";
   } else {
     osArch = rawArch;
   }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@openzim/libzim",
   "main": "dist/index.js",
   "types": "dist/index.d.js",
-  "version": "3.2.3",
+  "version": "3.4.0",
   "description": "Libzim bindings for NodeJS",
   "type": "module",
   "scripts": {
@@ -42,31 +42,30 @@
   "gypfile": true,
   "dependencies": {
     "@types/bindings": "^1.5.1",
-    "@types/jest": "^28.1.6",
+    "@types/jest": "^29.5.12",
     "@types/node": "^18.0.6",
     "axios": "^1.6.0",
     "bindings": "^1.5.0",
     "dotenv": "^16.0.1",
     "exec-then": "^1.3.1",
-    "mkdirp": "^1.0.4",
-    "node-addon-api": "^5.0.0",
+    "mkdirp": "^3.0.1",
+    "node-addon-api": "^8.0.0",
     "node-gyp": "^10.1.0",
     "tqdm": "^2.0.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.0.0"
   },
   "devDependencies": {
-    "@faker-js/faker": "^7.6.0",
+    "@faker-js/faker": "^8.4.1",
     "@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",
-    "prettier": "^2.8.8",
-    "ts-jest": "^28.0.7",
-    "typescript": "^4.7.4"
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "nyc": "^17.0.0",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.1.6"
   },
   "jest": {
     "preset": "ts-jest/presets/js-with-ts"

package/src/archive.h

@@ -411,6 +411,85 @@ class Archive : public Napi::ObjectWrap<Archive> {
     }
   }
 
+  Napi::Value getClusterCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      return Napi::Value::From(info.Env(), archive_->getClusterCacheMaxSize());
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  Napi::Value getClusterCacheCurrentSize(const Napi::CallbackInfo &info) {
+    try {
+      return Napi::Value::From(info.Env(),
+                               archive_->getClusterCacheCurrentSize());
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  void setClusterCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      if (!info[0].IsNumber()) {
+        throw Napi::Error::New(info.Env(), "Expected a number");
+      }
+      auto nbClusters = info[0].As<Napi::Number>().Uint32Value();
+      archive_->setClusterCacheMaxSize(nbClusters);
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  Napi::Value getDirentCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      return Napi::Value::From(info.Env(), archive_->getDirentCacheMaxSize());
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  Napi::Value getDirentCacheCurrentSize(const Napi::CallbackInfo &info) {
+    try {
+      return Napi::Value::From(info.Env(),
+                               archive_->getDirentCacheCurrentSize());
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  void setDirentCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      if (!info[0].IsNumber()) {
+        throw Napi::Error::New(info.Env(), "Expected a number");
+      }
+      auto nbDirents = info[0].As<Napi::Number>().Uint32Value();
+      archive_->setDirentCacheMaxSize(nbDirents);
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  Napi::Value getDirentLookupCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      return Napi::Value::From(info.Env(),
+                               archive_->getDirentLookupCacheMaxSize());
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
+  void setDirentLookupCacheMaxSize(const Napi::CallbackInfo &info) {
+    try {
+      if (!info[0].IsNumber()) {
+        throw Napi::Error::New(info.Env(), "Expected a number");
+      }
+      auto nbRanges = info[0].As<Napi::Number>().Uint32Value();
+      archive_->setDirentLookupCacheMaxSize(nbRanges);
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
   static Napi::Value validate(const Napi::CallbackInfo &info) {
     Napi::Env env = info.Env();
     Napi::HandleScope scope(env);
@@ -485,6 +564,22 @@ class Archive : public Napi::ObjectWrap<Archive> {
             InstanceAccessor<&Archive::getChecksum>("checksum"),
             InstanceMethod<&Archive::check>("check"),
             InstanceMethod<&Archive::checkIntegrity>("checkIntegrity"),
+            InstanceMethod<&Archive::getClusterCacheMaxSize>(
+                "getClusterCacheMaxSize"),
+            InstanceMethod<&Archive::getClusterCacheCurrentSize>(
+                "getClusterCacheCurrentSize"),
+            InstanceMethod<&Archive::setClusterCacheMaxSize>(
+                "setClusterCacheMaxSize"),
+            InstanceMethod<&Archive::getDirentCacheMaxSize>(
+                "getDirentCacheMaxSize"),
+            InstanceMethod<&Archive::getDirentCacheCurrentSize>(
+                "getDirentCacheCurrentSize"),
+            InstanceMethod<&Archive::setDirentCacheMaxSize>(
+                "setDirentCacheMaxSize"),
+            InstanceMethod<&Archive::getDirentLookupCacheMaxSize>(
+                "getDirentLookupCacheMaxSize"),
+            InstanceMethod<&Archive::setDirentLookupCacheMaxSize>(
+                "setDirentLookupCacheMaxSize"),
             InstanceAccessor<&Archive::isMultiPart>("isMultiPart"),
             InstanceAccessor<&Archive::hasNewNamespaceScheme>(
                 "hasNewNamespaceScheme"),

package/src/index.d.ts

@@ -66,7 +66,7 @@ export class StringItem {
     mimeType: string,
     title: string,
     hint: Hint,
-    content: ArrayBuffer | Buffer | string
+    content: ArrayBuffer | Buffer | string,
   );
   readonly path: string;
   readonly title: string;
@@ -81,7 +81,7 @@ export class FileItem {
     mimeType: string,
     title: string,
     hints: Hint,
-    filePath: string
+    filePath: string,
   );
   readonly path: string;
   readonly title: string;
@@ -102,14 +102,14 @@ export class Creator {
   addMetadata(
     name: string,
     content: string | ContentProvider,
-    mimetype?: string
+    mimetype?: string,
   ): void;
   addIllustration(size: number, content: string | ContentProvider): void;
   addRedirection(
     path: string,
     title: string,
     targetPath: string,
-    hints?: Hint
+    hints?: Hint,
   ): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
@@ -182,6 +182,14 @@ export class Archive {
   checkIntegrity(checkType: symbol): boolean; // one of IntegrityCheck
   get isMultiPart(): boolean;
   get hasNewNamespaceScheme(): boolean;
+  getClusterCacheMaxSize(): number;
+  getClusterCacheCurrentSize(): number;
+  setClusterCacheMaxSize(nbClusters: number): void;
+  getDirentCacheMaxSize(): number;
+  getDirentCacheCurrentSize(): number;
+  setDirentCacheMaxSize(nbDirents: number): void;
+  getDirentLookupCacheMaxSize(): number;
+  setDirentLookupCacheMaxSize(nbRanges: number): void;
 
   static validate(zimPath: string, checksToRun: symbol[]): boolean; // list of IntegrityCheck
 }