@openzim/libzim 3.3.0 → 3.5.0

package/Changelog

@@ -1,3 +1,11 @@
+3.5.0
+* NEW: Build now supports ARM64 (`aarch64`) and ARM (32‑bit)
+* UPDATE: CI matrix extended with ARM64 Ubuntu runners
+* UPDATE: drop Node.JS 18, add Node.JS 24
+
+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

package/binding.gyp

@@ -11,13 +11,14 @@
                 "link_settings": {
                   "ldflags": [
                       "<!(pkg-config --libs-only-other --libs-only-L libzim)",
+                      "-Wl,-rpath,<!(pkg-config --variable=libdir libzim)>"
                   ],
                   "libraries": [
                       "<!(pkg-config --libs-only-l libzim)",
                   ],
                 },
               }],
-              ["libzim_local!='true' and OS=='linux'", {
+              ["libzim_local!='true' and OS=='linux' and target_arch=='x64'", {
                 "include_dirs": [
                   "<(libzim_include)",
                 ],
@@ -27,6 +28,26 @@
                   "<(libzim_dir)/lib/x86_64-linux-gnu/libzim.so.9",
                 ],
               }],
+              ["libzim_local!='true' and OS=='linux' and target_arch=='arm64'", {
+                "include_dirs": [
+                  "<(libzim_include)",
+                ],
+                "libraries": [
+                  "-Wl,-rpath,'$$ORIGIN'",
+                  "-L<(libzim_dir)/lib/aarch64-linux-gnu",
+                  "<(libzim_dir)/lib/aarch64-linux-gnu/libzim.so.9",
+                ],
+              }],
+              ["libzim_local!='true' and OS=='linux' and target_arch=='arm'", {
+                "include_dirs": [
+                  "<(libzim_include)",
+                ],
+                "libraries": [
+                  "-Wl,-rpath,'$$ORIGIN'",
+                  "-L<(libzim_dir)/lib/arm-linux-gnueabihf",
+                  "<(libzim_dir)/lib/arm-linux-gnueabihf/libzim.so.9",
+                ],
+              }],
               ["libzim_local!='true' and OS=='mac'", {
                   "include_dirs": ["<(libzim_include)"],
                   "cflags+": ["-fvisibility=hidden"],

package/bundle-libzim.js

@@ -16,11 +16,19 @@ if (!isMacOS && !isLinux) {
 }
 
 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",
-  );
-  exec("ln -sf build/Release/libzim.so.9 build/Release/libzim.so"); // convienience only, not required
+  const rawArch = os.arch();
+  let libDir;
+  if (rawArch === "arm64") {
+    libDir = "aarch64-linux-gnu";
+  } else if (rawArch === "arm") {
+    libDir = "arm-linux-gnueabihf";
+  } else {
+    libDir = "x86_64-linux-gnu";
+  }
+
+  console.info(`Copying libzim.so.9 from ${libDir} to build folder`);
+  exec(`cp download/lib/${libDir}/libzim.so.9 build/Release/libzim.so.9`);
+  exec("ln -sf build/Release/libzim.so.9 build/Release/libzim.so"); // convenience only, not required
 }
 if (isMacOS) {
   console.info("Copying libzim.9.dylib to build folder");

package/dist/index.d.ts

@@ -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/package.json

@@ -2,7 +2,7 @@
   "name": "@openzim/libzim",
   "main": "dist/index.js",
   "types": "dist/index.d.js",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "Libzim bindings for NodeJS",
   "type": "module",
   "scripts": {
@@ -38,6 +38,9 @@
   "bugs": {
     "url": "https://github.com/openzim/node-libzim/issues"
   },
+  "engines": {
+    "node": ">=20 <25"
+  },
   "homepage": "https://github.com/openzim/node-libzim#readme",
   "gypfile": true,
   "dependencies": {
@@ -70,4 +73,4 @@
   "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

@@ -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
 }