@openzim/libzim 3.0.0 → 3.1.0

package/.env

@@ -1 +1 @@
-LIBZIM_VERSION=8.2.0
+LIBZIM_VERSION=8.2.1

package/.eslintignore

@@ -0,0 +1,3 @@
+.eslintrc.js
+node_modules
+dist/*

package/.eslintrc.js

@@ -0,0 +1,39 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+  },
+  rules: {
+    "prettier/prettier": "error",
+    eqeqeq: "error",
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "tsconfig.json",
+    sourceType: "module",
+  },
+  plugins: ["prettier"],
+  root: true,
+  overrides: [
+    {
+      files: ["*.ts", "*.js"],
+      rules: {
+        "@typescript-eslint/no-var-requires": "off",
+        "no-import-assign": "off",
+        "no-useless-escape": "off",
+      },
+      parserOptions: {
+        sourceType: "module",
+      },
+      extends: ["plugin:@typescript-eslint/recommended"],
+      parser: "@typescript-eslint/parser",
+      plugins: ["@typescript-eslint"],
+    },
+  ],
+};

package/Changelog

@@ -1,3 +1,9 @@
+3.1.0:
+* NEW: Use libzim v8.2.1
+* FIX: Handling of binary data in the creator
+* FIX: Use ESLint instead of TSLint
+* REMOVE: Node.js 16 from the CI
+
 3.0.0:
 * NEW: Use libzim v8.2.0
 * NEW: Calling API (to follow libzim changes)

package/README.md

@@ -22,7 +22,7 @@ here](https://github.com/openzim/libzim/)).
 ## Usage
 
 ```bash
-npm i openzim/libzim
+npm i @openzim/libzim
 ```
 
 ### Writing a ZIM file

package/bundle-libzim.js

@@ -1,26 +1,32 @@
-require('dotenv').config();
-const mkdirp = require('mkdirp');
-const exec = require('exec-then');
-const os = require('os');
+require("dotenv").config();
+const mkdirp = require("mkdirp");
+const exec = require("exec-then");
+const os = require("os");
 
-mkdirp.sync('./build/Release');
+mkdirp.sync("./build/Release");
 
-const isMacOS = os.type() === 'Darwin'
-const isLinux = os.type() === 'Linux'
+const isMacOS = os.type() === "Darwin";
+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`);
+  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"
+  );
 }
 
 if (isLinux) {
-    console.info(`Copying libzim.so.8 to build folder`)
-    exec(`cp download/lib/x86_64-linux-gnu/libzim.so.8 build/Release/libzim.so.8`)
-    exec(`ln -sf build/Release/libzim.so.8 build/Release/libzim.so`)  // convienience only, not required
+  console.info("Copying libzim.so.8 to build folder");
+  exec(
+    "cp download/lib/x86_64-linux-gnu/libzim.so.8 build/Release/libzim.so.8"
+  );
+  exec("ln -sf build/Release/libzim.so.8 build/Release/libzim.so"); // convienience only, not required
 }
 if (isMacOS) {
-    console.info(`Copying libzim.8.dylib to build folder`);
-    exec(`cp download/lib/libzim.8.dylib build/Release/libzim.8.dylib`)
-    exec(`ln -sf build/Release/libzim.8.dylib build/Release/libzim.dylib`)   // convienience only, not required
-    console.info(`Fixing rpath`)
-    exec(`install_name_tool -change libzim.8.dylib @loader_path/libzim.8.dylib build/Release/zim_binding.node`)
+  console.info("Copying libzim.8.dylib to build folder");
+  exec("cp download/lib/libzim.8.dylib build/Release/libzim.8.dylib");
+  exec("ln -sf build/Release/libzim.8.dylib build/Release/libzim.dylib"); // convienience only, not required
+  console.info("Fixing rpath");
+  exec(
+    "install_name_tool -change libzim.8.dylib @loader_path/libzim.8.dylib build/Release/zim_binding.node"
+  );
 }

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-
 export class IntegrityCheck {
   static CHECKSUM: symbol;
   static DIRENT_PTRS: symbol;
@@ -6,7 +5,7 @@ export class IntegrityCheck {
   static TITLE_INDEX: symbol;
   static CLUSTER_PTRS: symbol;
   static DIRENT_MIMETYPES: symbol;
-  static COUNT: symbol;  // DO NOT USE THIS. See libzim docs.
+  static COUNT: symbol; // DO NOT USE THIS. See libzim docs.
 }
 
 export class Compression {
@@ -23,25 +22,25 @@ export class Blob {
 
 export type ContentProvider = {
   size: number | bigint;
-  feed() : Blob;
-}
+  feed(): Blob;
+};
 
 export class StringProvider {
   constructor(content: string);
   get size(): number;
-  feed() : Blob;
+  feed(): Blob;
 }
 
 export class FileProvider {
   constructor(filepath: string);
   get size(): number | bigint;
-  feed() : Blob;
+  feed(): Blob;
 }
 
 export type Hint = {
   COMPRESS?: number;
   FRONT_ARTICLE?: number;
-}
+};
 
 export interface IndexData {
   hasIndexData?: boolean;
@@ -56,44 +55,65 @@ export interface WriterItem {
   path: string;
   title: string;
   mimeType: string;
-  getContentProvider() : ContentProvider;
+  getContentProvider(): ContentProvider;
   hints: Hint;
   getIndexData?: () => IndexData;
 }
 
 export class StringItem {
-  constructor(path: string, mimeType: string, title: string, hint: Hint, content: string);
+  constructor(
+    path: string,
+    mimeType: string,
+    title: string,
+    hint: Hint,
+    content: ArrayBuffer | Buffer | string
+  );
   readonly path: string;
   readonly title: string;
   readonly mimeType: string;
-  getContentProvider() : StringProvider;
+  getContentProvider(): StringProvider;
   readonly hints: Hint;
 }
 
 export class FileItem {
-  constructor(path: string, mimeType: string, title: string, hints: Hint, filePath: string);
+  constructor(
+    path: string,
+    mimeType: string,
+    title: string,
+    hints: Hint,
+    filePath: string
+  );
   readonly path: string;
   readonly title: string;
   readonly mimeType: string;
-  getContentProvider() : StringProvider;
+  getContentProvider(): StringProvider;
   readonly hints: Hint;
 }
 
 export class Creator {
   constructor();
-  configVerbose(verbose: boolean) : this;
-  configCompression(value: Compression) : this;
-  configClusterSize(size: number) : this;
-  configIndexing(indexing: boolean, language: string) : this;
-  configNbWorkers(num: number) : this;
+  configVerbose(verbose: boolean): this;
+  configCompression(value: Compression): this;
+  configClusterSize(size: number): this;
+  configIndexing(indexing: boolean, language: string): this;
+  configNbWorkers(num: number): this;
   startZimCreation(filepath: string): this;
   addItem(item: WriterItem): Promise<void>;
-  addMetadata(name: string, content: string | ContentProvider, mimetype?: string): void;
+  addMetadata(
+    name: string,
+    content: string | ContentProvider,
+    mimetype?: string
+  ): void;
   addIllustration(size: number, content: string | ContentProvider): void;
-  addRedirection(path: string, title: string, targetPath: string, hints?: Hint): void;
+  addRedirection(
+    path: string,
+    title: string,
+    targetPath: string,
+    hints?: Hint
+  ): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
-  finishZimCreation() : Promise<void>;
+  finishZimCreation(): Promise<void>;
 }
 
 export class Item {
@@ -101,11 +121,11 @@ export class Item {
   get path(): string;
   get mimetype(): string;
   get data(): Blob;
-  getData(offset?: number | bigint, limit?: number | bigint) : Blob;
+  getData(offset?: number | bigint, limit?: number | bigint): Blob;
   get size(): number | bigint;
   get directAccessInformation(): {
-    filename: string,
-      offset: number,
+    filename: string;
+    offset: number;
   };
   get index(): number | bigint;
 }
@@ -115,7 +135,7 @@ export class Entry {
   get title(): string;
   get path(): string;
   get item(): Item;
-  getItem(followRedirect?: boolean) : Item;
+  getItem(followRedirect?: boolean): Item;
   get redirect(): Item;
   get redirectEntry(): Entry;
   get index(): number;
@@ -123,7 +143,7 @@ export class Entry {
 
 export interface EntryRange extends Iterable<Entry> {
   size: number;
-  offset(start: number, maxResults: number) : EntryRange;
+  offset(start: number, maxResults: number): EntryRange;
 }
 
 export class Archive {
@@ -134,35 +154,35 @@ export class Archive {
   get entryCount(): number;
   get articleCount(): number;
   get uuid(): string;
-  getMetadata(name: string) : string;
-  getMetadataItem(name: string) : Item;
+  getMetadata(name: string): string;
+  getMetadataItem(name: string): Item;
   get metadataKeys(): string[];
-  getIllustrationItem(size: number) : Item;
-  get illustrationSizes() : Set<number>;
-  getEntryByPath(path_or_idx: string | number) : Entry;
-  getEntryByTitle(title_or_idx: string | number) : Entry;
-  getEntryByClusterOrder(idx: number) : Entry;
+  getIllustrationItem(size: number): Item;
+  get illustrationSizes(): Set<number>;
+  getEntryByPath(path_or_idx: string | number): Entry;
+  getEntryByTitle(title_or_idx: string | number): Entry;
+  getEntryByClusterOrder(idx: number): Entry;
   get mainEntry(): Entry;
   get randomEntry(): Entry;
-  hasEntryByPath(path: string) : boolean;
-  hasEntryByTitle(title: string) : boolean;
+  hasEntryByPath(path: string): boolean;
+  hasEntryByTitle(title: string): boolean;
   hasMainEntry(): boolean;
-  hasIllustration(size: number) : boolean;
-  hasFulltextIndex() : boolean;
+  hasIllustration(size: number): boolean;
+  hasFulltextIndex(): boolean;
   hasTitleIndex(): boolean;
-  iterByPath() : EntryRange;
-  iterByTitle() : EntryRange;
-  iterEfficient() : EntryRange;
-  findByPath(path: string) : EntryRange;
-  findByTitle(title: string) : EntryRange;
+  iterByPath(): EntryRange;
+  iterByTitle(): EntryRange;
+  iterEfficient(): EntryRange;
+  findByPath(path: string): EntryRange;
+  findByTitle(title: string): EntryRange;
   get hasChecksum(): boolean;
   get checksum(): string;
-  check() : boolean;
-  checkIntegrity(checkType: symbol) : boolean;  // one of IntegrityCheck
+  check(): boolean;
+  checkIntegrity(checkType: symbol): boolean; // one of IntegrityCheck
   get isMultiPart(): boolean;
   get hasNewNamespaceScheme(): boolean;
 
-  static validate(zimPath: string, checksToRun: symbol[]) : boolean; // list of IntegrityCheck
+  static validate(zimPath: string, checksToRun: symbol[]): boolean; // list of IntegrityCheck
 }
 
 interface Georange {
@@ -175,10 +195,10 @@ export class Query {
   constructor(query: string);
   setQuery(query: string): this;
   setGeorange(latitude: number, longitude: number, distance: number): this;
-  get query() : string;
+  get query(): string;
   set query(query: string);
   toString(): string;
-  get georange() : Georange;
+  get georange(): Georange;
   set georange(range: Georange);
 }
 
@@ -188,7 +208,7 @@ export class SearchIterator {
   get score(): number;
   get snippet(): string;
   get wordCount(): number;
-  get size() : number;
+  get size(): number;
   get fileIndex(): number;
   get zimId(): string;
   get entry(): Entry;
@@ -199,15 +219,15 @@ export interface SearchResultSet extends Iterable<SearchIterator> {
 }
 
 export class Search {
-  getResults(start: number, maxResults: number) : SearchResultSet;
+  getResults(start: number, maxResults: number): SearchResultSet;
   get estimatedMatches(): number;
 }
 
 export class Searcher {
   constructor(archives: Archive | Archive[]);
   addArchive(archive: Archive): this;
-  search(query: string | Query) : Search;
-  setVerbose(verbose: boolean) : this;
+  search(query: string | Query): Search;
+  setVerbose(verbose: boolean): this;
 }
 
 export class SuggestionIterator {
@@ -223,12 +243,12 @@ export interface SuggestionResultSet extends Iterable<SuggestionIterator> {
 }
 
 export class SuggestionSearch {
-  getResults(start: number, maxResults: number) : SuggestionResultSet;
+  getResults(start: number, maxResults: number): SuggestionResultSet;
   get estimatedMatches(): number;
 }
 
 export class SuggestionSearcher {
   constructor(archives: Archive);
   suggest(query: string): SuggestionSearch;
-  setVerbose(verbose: boolean) : this;
+  setVerbose(verbose: boolean): this;
 }

package/dist/index.js

@@ -1,5 +1,4 @@
-
-const bindings = require('bindings');
+import bindings from "bindings";
 
 const {
   Archive,
@@ -15,7 +14,7 @@ const {
   FileProvider,
   StringItem,
   FileItem,
-} = bindings('zim_binding');
+} = bindings("zim_binding");
 
 module.exports = {
   Archive,
@@ -31,4 +30,4 @@ module.exports = {
   FileProvider,
   StringItem,
   FileItem,
-}
+};

package/download-libzim.js

@@ -1,74 +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 rawArch = os.arch()
-const isAvailableArch = rawArch === 'x64' || rawArch == 'arm' || rawArch == 'arm64'
+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`);
+  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';
+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
-    }
+if (rawArch !== "x64") {
+  if (isLinux) {
+    osArch = rawArch === "arm64" ? "aarch64-bionic" : "armhf";
+  } else {
+    osArch = rawArch;
+  }
 }
 
 const urls = [
-    `https://download.openzim.org/release/libzim/libzim_${osPrefix}-${osArch}-${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}`;
+  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) { }
+  try {
+    fs.statSync(dlFile);
+    console.warn(`File [${dlFile}] already exists, not downloading`);
+    return;
+  } catch (err) {
+    //
+  }
 
-    axios({
-        url,
-        method: 'get',
-        responseType: 'stream'
+  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(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);
-        });
+    .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);
+    });
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@openzim/libzim",
   "main": "dist/index.js",
   "types": "dist/index.d.js",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Libzim bindings for NodeJS",
   "scripts": {
     "clean": "rm -rf dist build/native/build",
@@ -14,7 +14,9 @@
     "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": [
@@ -40,7 +42,7 @@
     "@types/bindings": "^1.5.1",
     "@types/jest": "^28.1.6",
     "@types/node": "^18.0.6",
-    "axios": "^0.27.2",
+    "axios": "^1.6.0",
     "bindings": "^1.5.0",
     "dotenv": "^16.0.1",
     "exec-then": "^1.3.1",
@@ -53,8 +55,14 @@
   },
   "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",
+    "prettier": "^2.8.8",
     "ts-jest": "^28.0.7",
     "typescript": "^4.7.4"
   },

package/src/index.d.ts

@@ -1,4 +1,3 @@
-
 export class IntegrityCheck {
   static CHECKSUM: symbol;
   static DIRENT_PTRS: symbol;
@@ -6,7 +5,7 @@ export class IntegrityCheck {
   static TITLE_INDEX: symbol;
   static CLUSTER_PTRS: symbol;
   static DIRENT_MIMETYPES: symbol;
-  static COUNT: symbol;  // DO NOT USE THIS. See libzim docs.
+  static COUNT: symbol; // DO NOT USE THIS. See libzim docs.
 }
 
 export class Compression {
@@ -23,25 +22,25 @@ export class Blob {
 
 export type ContentProvider = {
   size: number | bigint;
-  feed() : Blob;
-}
+  feed(): Blob;
+};
 
 export class StringProvider {
   constructor(content: string);
   get size(): number;
-  feed() : Blob;
+  feed(): Blob;
 }
 
 export class FileProvider {
   constructor(filepath: string);
   get size(): number | bigint;
-  feed() : Blob;
+  feed(): Blob;
 }
 
 export type Hint = {
   COMPRESS?: number;
   FRONT_ARTICLE?: number;
-}
+};
 
 export interface IndexData {
   hasIndexData?: boolean;
@@ -56,44 +55,65 @@ export interface WriterItem {
   path: string;
   title: string;
   mimeType: string;
-  getContentProvider() : ContentProvider;
+  getContentProvider(): ContentProvider;
   hints: Hint;
   getIndexData?: () => IndexData;
 }
 
 export class StringItem {
-  constructor(path: string, mimeType: string, title: string, hint: Hint, content: string);
+  constructor(
+    path: string,
+    mimeType: string,
+    title: string,
+    hint: Hint,
+    content: ArrayBuffer | Buffer | string
+  );
   readonly path: string;
   readonly title: string;
   readonly mimeType: string;
-  getContentProvider() : StringProvider;
+  getContentProvider(): StringProvider;
   readonly hints: Hint;
 }
 
 export class FileItem {
-  constructor(path: string, mimeType: string, title: string, hints: Hint, filePath: string);
+  constructor(
+    path: string,
+    mimeType: string,
+    title: string,
+    hints: Hint,
+    filePath: string
+  );
   readonly path: string;
   readonly title: string;
   readonly mimeType: string;
-  getContentProvider() : StringProvider;
+  getContentProvider(): StringProvider;
   readonly hints: Hint;
 }
 
 export class Creator {
   constructor();
-  configVerbose(verbose: boolean) : this;
-  configCompression(value: Compression) : this;
-  configClusterSize(size: number) : this;
-  configIndexing(indexing: boolean, language: string) : this;
-  configNbWorkers(num: number) : this;
+  configVerbose(verbose: boolean): this;
+  configCompression(value: Compression): this;
+  configClusterSize(size: number): this;
+  configIndexing(indexing: boolean, language: string): this;
+  configNbWorkers(num: number): this;
   startZimCreation(filepath: string): this;
   addItem(item: WriterItem): Promise<void>;
-  addMetadata(name: string, content: string | ContentProvider, mimetype?: string): void;
+  addMetadata(
+    name: string,
+    content: string | ContentProvider,
+    mimetype?: string
+  ): void;
   addIllustration(size: number, content: string | ContentProvider): void;
-  addRedirection(path: string, title: string, targetPath: string, hints?: Hint): void;
+  addRedirection(
+    path: string,
+    title: string,
+    targetPath: string,
+    hints?: Hint
+  ): void;
   setMainPath(mainPath: string): void;
   setUuid(uuid: string): void;
-  finishZimCreation() : Promise<void>;
+  finishZimCreation(): Promise<void>;
 }
 
 export class Item {
@@ -101,11 +121,11 @@ export class Item {
   get path(): string;
   get mimetype(): string;
   get data(): Blob;
-  getData(offset?: number | bigint, limit?: number | bigint) : Blob;
+  getData(offset?: number | bigint, limit?: number | bigint): Blob;
   get size(): number | bigint;
   get directAccessInformation(): {
-    filename: string,
-      offset: number,
+    filename: string;
+    offset: number;
   };
   get index(): number | bigint;
 }
@@ -115,7 +135,7 @@ export class Entry {
   get title(): string;
   get path(): string;
   get item(): Item;
-  getItem(followRedirect?: boolean) : Item;
+  getItem(followRedirect?: boolean): Item;
   get redirect(): Item;
   get redirectEntry(): Entry;
   get index(): number;
@@ -123,7 +143,7 @@ export class Entry {
 
 export interface EntryRange extends Iterable<Entry> {
   size: number;
-  offset(start: number, maxResults: number) : EntryRange;
+  offset(start: number, maxResults: number): EntryRange;
 }
 
 export class Archive {
@@ -134,35 +154,35 @@ export class Archive {
   get entryCount(): number;
   get articleCount(): number;
   get uuid(): string;
-  getMetadata(name: string) : string;
-  getMetadataItem(name: string) : Item;
+  getMetadata(name: string): string;
+  getMetadataItem(name: string): Item;
   get metadataKeys(): string[];
-  getIllustrationItem(size: number) : Item;
-  get illustrationSizes() : Set<number>;
-  getEntryByPath(path_or_idx: string | number) : Entry;
-  getEntryByTitle(title_or_idx: string | number) : Entry;
-  getEntryByClusterOrder(idx: number) : Entry;
+  getIllustrationItem(size: number): Item;
+  get illustrationSizes(): Set<number>;
+  getEntryByPath(path_or_idx: string | number): Entry;
+  getEntryByTitle(title_or_idx: string | number): Entry;
+  getEntryByClusterOrder(idx: number): Entry;
   get mainEntry(): Entry;
   get randomEntry(): Entry;
-  hasEntryByPath(path: string) : boolean;
-  hasEntryByTitle(title: string) : boolean;
+  hasEntryByPath(path: string): boolean;
+  hasEntryByTitle(title: string): boolean;
   hasMainEntry(): boolean;
-  hasIllustration(size: number) : boolean;
-  hasFulltextIndex() : boolean;
+  hasIllustration(size: number): boolean;
+  hasFulltextIndex(): boolean;
   hasTitleIndex(): boolean;
-  iterByPath() : EntryRange;
-  iterByTitle() : EntryRange;
-  iterEfficient() : EntryRange;
-  findByPath(path: string) : EntryRange;
-  findByTitle(title: string) : EntryRange;
+  iterByPath(): EntryRange;
+  iterByTitle(): EntryRange;
+  iterEfficient(): EntryRange;
+  findByPath(path: string): EntryRange;
+  findByTitle(title: string): EntryRange;
   get hasChecksum(): boolean;
   get checksum(): string;
-  check() : boolean;
-  checkIntegrity(checkType: symbol) : boolean;  // one of IntegrityCheck
+  check(): boolean;
+  checkIntegrity(checkType: symbol): boolean; // one of IntegrityCheck
   get isMultiPart(): boolean;
   get hasNewNamespaceScheme(): boolean;
 
-  static validate(zimPath: string, checksToRun: symbol[]) : boolean; // list of IntegrityCheck
+  static validate(zimPath: string, checksToRun: symbol[]): boolean; // list of IntegrityCheck
 }
 
 interface Georange {
@@ -175,10 +195,10 @@ export class Query {
   constructor(query: string);
   setQuery(query: string): this;
   setGeorange(latitude: number, longitude: number, distance: number): this;
-  get query() : string;
+  get query(): string;
   set query(query: string);
   toString(): string;
-  get georange() : Georange;
+  get georange(): Georange;
   set georange(range: Georange);
 }
 
@@ -188,7 +208,7 @@ export class SearchIterator {
   get score(): number;
   get snippet(): string;
   get wordCount(): number;
-  get size() : number;
+  get size(): number;
   get fileIndex(): number;
   get zimId(): string;
   get entry(): Entry;
@@ -199,15 +219,15 @@ export interface SearchResultSet extends Iterable<SearchIterator> {
 }
 
 export class Search {
-  getResults(start: number, maxResults: number) : SearchResultSet;
+  getResults(start: number, maxResults: number): SearchResultSet;
   get estimatedMatches(): number;
 }
 
 export class Searcher {
   constructor(archives: Archive | Archive[]);
   addArchive(archive: Archive): this;
-  search(query: string | Query) : Search;
-  setVerbose(verbose: boolean) : this;
+  search(query: string | Query): Search;
+  setVerbose(verbose: boolean): this;
 }
 
 export class SuggestionIterator {
@@ -223,12 +243,12 @@ export interface SuggestionResultSet extends Iterable<SuggestionIterator> {
 }
 
 export class SuggestionSearch {
-  getResults(start: number, maxResults: number) : SuggestionResultSet;
+  getResults(start: number, maxResults: number): SuggestionResultSet;
   get estimatedMatches(): number;
 }
 
 export class SuggestionSearcher {
   constructor(archives: Archive);
   suggest(query: string): SuggestionSearch;
-  setVerbose(verbose: boolean) : this;
+  setVerbose(verbose: boolean): this;
 }

package/src/index.js

@@ -1,5 +1,4 @@
-
-const bindings = require('bindings');
+import bindings from "bindings";
 
 const {
   Archive,
@@ -15,7 +14,7 @@ const {
   FileProvider,
   StringItem,
   FileItem,
-} = bindings('zim_binding');
+} = bindings("zim_binding");
 
 module.exports = {
   Archive,
@@ -31,4 +30,4 @@ module.exports = {
   FileProvider,
   StringItem,
   FileItem,
-}
+};

package/src/writerItem.h

@@ -262,7 +262,22 @@ class StringItem : public Napi::ObjectWrap<StringItem> {
       auto mimetype = info[1].ToString().Utf8Value();
       auto title = info[2].ToString().Utf8Value();
       auto hints = Object2Hints(info[3].ToObject());
-      auto content = info[4].ToString().Utf8Value();
+
+      const auto &&cval = info[4];
+      std::string content;
+
+      if (cval.IsArrayBuffer()) {  // handle ArrayBuffer
+        auto buf = cval.As<Napi::ArrayBuffer>();
+        auto size = buf.ByteLength();
+        content = std::string(reinterpret_cast<const char *>(buf.Data()), size);
+      } else if (cval.IsBuffer()) {  // handle Buffer
+        auto buf = cval.As<Napi::Buffer<char>>();
+        auto size = buf.Length();
+        content = std::string(reinterpret_cast<const char *>(buf.Data()), size);
+      } else {
+        content = cval.ToString().Utf8Value();
+      }
+
       item_ = zim::writer::StringItem::create(path, mimetype, title, hints,
                                               content);
     } catch (const std::exception &e) {