@openzim/libzim 4.1.0 → 4.2.0

package/.env

@@ -1 +1 @@
-LIBZIM_VERSION=9.5.1
+LIBZIM_VERSION=9.7.0

package/Changelog

@@ -1,4 +1,9 @@
-Unreleased
+4.2.0
+* NEW: Use libzim 9.7.0
+* NEW: Add addAlias method to Creator
+* UPDATE: Change EditorConfig cpp spacing to 2 spaces
+
+4.1.0
 * NEW: Use libzim 9.5.1
 * FIX: Fix lib directories for aarch64
 * FIX: Update Node.JS dependencies

package/README.md

@@ -61,7 +61,7 @@ import { Creator, StringItem } from "@openzim/libzim";
 ### Reading a ZIM file
 ```javascript
 // read.js
-import { Archive, SuggestionSearcher, Searcher } from "@openzim/libzim";
+import { Archive, Query, SuggestionSearcher, Searcher } from "@openzim/libzim";
 
 (async () => {
     const outFile = "./test.zim";
@@ -89,12 +89,12 @@ import { Archive, SuggestionSearcher, Searcher } from "@openzim/libzim";
     }
 
 
-    const entry = await archive.getEntryByPath("A/laborum");
+    const entry = archive.getEntryByPath("A/laborum");
     const item = entry.item;
     const blob = item.data;
     console.info(`Entry by url (laborum):`, blob.data);
-    delete archive;
 })();
+```
 
 ## Local Development
 

package/dist/index.d.ts

@@ -118,6 +118,7 @@ export class Creator {
     targetPath: string,
     hints?: Hint,
   ): void;
+  addAlias(path: string, title: string, targetPath: string, hints?: Hint): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
   finishZimCreation(): Promise<void>;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@openzim/libzim",
   "main": "dist/index.js",
-  "types": "dist/index.d.js",
-  "version": "4.1.0",
+  "types": "dist/index.d.ts",
+  "version": "4.2.0",
   "description": "Libzim bindings for NodeJS",
   "type": "module",
   "scripts": {

package/src/creator.h

@@ -342,6 +342,29 @@ class Creator : public Napi::ObjectWrap<Creator> {
     }
   }
 
+  void addAlias(const Napi::CallbackInfo &info) {
+    try {
+      auto env = info.Env();
+      if (info.Length() < 3) {
+        throw Napi::Error::New(env,
+                               "addAlias requires arguments: path, title, "
+                               "targetPath, [hints]");
+      }
+
+      auto path = info[0].As<Napi::String>().Utf8Value();
+      auto title = info[1].As<Napi::String>().Utf8Value();
+      auto targetPath = info[2].As<Napi::String>().Utf8Value();
+      if (info[3].IsObject()) {
+        auto hints = Object2Hints(info[3].ToObject());
+        creator_->addAlias(path, title, targetPath, hints);
+      } else {
+        creator_->addAlias(path, title, targetPath);
+      }
+    } catch (const std::exception &err) {
+      throw Napi::Error::New(info.Env(), err.what());
+    }
+  }
+
   void setMainPath(const Napi::CallbackInfo &info) {
     try {
       auto env = info.Env();
@@ -387,6 +410,7 @@ class Creator : public Napi::ObjectWrap<Creator> {
             InstanceMethod<&Creator::addMetadata>("addMetadata"),
             InstanceMethod<&Creator::addIllustration>("addIllustration"),
             InstanceMethod<&Creator::addRedirection>("addRedirection"),
+            InstanceMethod<&Creator::addAlias>("addAlias"),
             InstanceMethod<&Creator::setMainPath>("setMainPath"),
             InstanceMethod<&Creator::setUuid>("setUuid"),
 

package/src/index.d.ts

@@ -118,6 +118,7 @@ export class Creator {
     targetPath: string,
     hints?: Hint,
   ): void;
+  addAlias(path: string, title: string, targetPath: string, hints?: Hint): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
   finishZimCreation(): Promise<void>;