@storyteller-platform/epub 0.4.2 → 0.4.6

package/dist/index.cjs

@@ -80,38 +80,15 @@ var import_node_crypto = require("node:crypto");
 var import_node_fs = require("node:fs");
 var import_promises = require("node:fs/promises");
 var import_node_os = require("node:os");
-var util = __toESM(require("node:util"), 1);
+var import_promises2 = require("node:stream/promises");
 var import_async_mutex = require("async-mutex");
 var import_fast_xml_parser = require("fast-xml-parser");
 var import_mem = __toESM(require("mem"), 1);
 var import_mime_types = require("mime-types");
 var import_nanoid = require("nanoid");
-var import_yauzl = __toESM(require("yauzl"), 1);
+var import_yauzl_promise = require("yauzl-promise");
 var import_yazl = require("yazl");
 var import_path = require("@storyteller-platform/path");
-function promisify(api) {
-  return function(arg, options) {
-    return new Promise(function(resolve2, reject) {
-      api(arg, options, function(err, response) {
-        if (err) {
-          reject(err);
-          return;
-        }
-        resolve2(response);
-      });
-    });
-  };
-}
-const unzipFromBuffer = promisify(
-  (arg, options, callback) => {
-    import_yauzl.default.fromBuffer(arg, options, callback);
-  }
-);
-const unzipFromPath = promisify(
-  (arg, options, callback) => {
-    import_yauzl.default.open(arg, options, callback);
-  }
-);
 class Epub {
   constructor(extractPath, inputPath) {
     this.extractPath = extractPath;
@@ -130,22 +107,27 @@ class Epub {
     ignoreAttributes: false,
     parseTagValue: false
   });
-  static xhtmlParser = new import_fast_xml_parser.XMLParser({
-    allowBooleanAttributes: true,
-    alwaysCreateTextNode: true,
-    preserveOrder: true,
-    ignoreAttributes: false,
-    htmlEntities: true,
-    trimValues: false,
-    stopNodes: ["*.pre", "*.script"],
-    parseTagValue: false,
-    updateTag(_tagName, _jPath, attrs) {
-      if (attrs && "@_/" in attrs) {
-        delete attrs["@_/"];
+  static xhtmlParser = (() => {
+    const parser = new import_fast_xml_parser.XMLParser({
+      allowBooleanAttributes: true,
+      alwaysCreateTextNode: true,
+      preserveOrder: true,
+      ignoreAttributes: false,
+      htmlEntities: true,
+      trimValues: false,
+      stopNodes: ["*.pre", "*.script"],
+      parseTagValue: false,
+      updateTag(_tagName, _jPath, attrs) {
+        if (attrs && "@_/" in attrs) {
+          delete attrs["@_/"];
+        }
+        return true;
       }
-      return true;
-    }
-  });
+    });
+    parser.addEntity("nbsp", "\xA0");
+    parser.addEntity("#160", "\xA0");
+    return parser;
+  })();
   static xmlBuilder = new import_fast_xml_parser.XMLBuilder({
     preserveOrder: true,
     format: true,
@@ -297,7 +279,7 @@ ${JSON.stringify(element, null, 2)}`
     );
     const encoder = new TextEncoder();
     const container = encoder.encode(`<?xml version="1.0"?>
-<container>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
   <rootfiles>
     <rootfile media-type="application/oebps-package+xml" full-path="OEBPS/content.opf"/>
   </rootfiles>
@@ -306,7 +288,7 @@ ${JSON.stringify(element, null, 2)}`
     await (0, import_promises.mkdir)((0, import_path.join)(extractPath, "META-INF"), { recursive: true });
     await (0, import_promises.writeFile)((0, import_path.join)(extractPath, "META-INF", "container.xml"), container);
     const packageDocument = encoder.encode(`<?xml version="1.0"?>
-<package unique-identifier="pub-id" dir="${language.textInfo.direction}" xml:lang=${language.toString()} version="3.0">
+<package unique-identifier="pub-id" dir="${language.textInfo.direction}" xml:lang="${language.toString()}" version="3.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
   <metadata>
   </metadata>
   <manifest>
@@ -355,52 +337,42 @@ ${JSON.stringify(element, null, 2)}`
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   static async from(pathOrData) {
-    var _stack = [];
+    const extractPath = (0, import_path.join)(
+      (0, import_node_os.tmpdir)(),
+      `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
+    );
     try {
-      const extractPath = (0, import_path.join)(
-        (0, import_node_os.tmpdir)(),
-        `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
-      );
-      const zipfile = typeof pathOrData === "string" ? await unzipFromPath(pathOrData, { lazyEntries: true }) : await unzipFromBuffer(Buffer.from(pathOrData), { lazyEntries: true });
-      const stack = __using(_stack, new DisposableStack());
-      stack.defer(() => {
-        zipfile.close();
-      });
-      const { promise, resolve: resolve2 } = Promise.withResolvers();
-      zipfile.on("end", () => {
-        resolve2();
-      });
-      const openReadStream = util.promisify(zipfile.openReadStream.bind(zipfile));
-      zipfile.readEntry();
-      zipfile.on("entry", async (entry) => {
-        if (entry.fileName.endsWith("/")) {
-          zipfile.readEntry();
-        } else {
-          const writePath = (0, import_path.join)(extractPath, entry.fileName);
-          const readStream = await openReadStream(entry);
-          await (0, import_promises.mkdir)((0, import_path.dirname)(writePath), { recursive: true });
-          await new Promise((resolvePipe) => {
-            const writePath2 = (0, import_path.join)(extractPath, entry.fileName);
-            const writeStream = (0, import_node_fs.createWriteStream)(writePath2);
-            writeStream.on("finish", () => {
-              resolvePipe();
-            });
-            readStream.pipe(writeStream);
-          }).finally(() => {
-            zipfile.readEntry();
-          });
+      var _stack = [];
+      try {
+        const zipfile = typeof pathOrData === "string" ? await (0, import_yauzl_promise.open)(pathOrData) : await (0, import_yauzl_promise.fromBuffer)(Buffer.from(pathOrData));
+        const stack = __using(_stack, new AsyncDisposableStack(), true);
+        stack.defer(async () => {
+          await zipfile.close();
+        });
+        for await (const entry of zipfile) {
+          if (entry.filename.endsWith("/")) {
+          } else {
+            const writePath = (0, import_path.join)(extractPath, entry.filename);
+            const readStream = await entry.openReadStream();
+            await (0, import_promises.mkdir)((0, import_path.dirname)(writePath), { recursive: true });
+            const writeStream = (0, import_node_fs.createWriteStream)(writePath);
+            await (0, import_promises2.pipeline)(readStream, writeStream);
+          }
         }
-      });
-      await promise;
-      return new this(
-        extractPath,
-        typeof pathOrData === "string" ? pathOrData : void 0
-      );
-    } catch (_) {
-      var _error = _, _hasError = true;
-    } finally {
-      __callDispose(_stack, _error, _hasError);
+      } catch (_) {
+        var _error = _, _hasError = true;
+      } finally {
+        var _promise = __callDispose(_stack, _error, _hasError);
+        _promise && await _promise;
+      }
+    } catch (error) {
+      (0, import_node_fs.rmSync)(extractPath, { force: true, recursive: true });
+      throw error;
     }
+    return new this(
+      extractPath,
+      typeof pathOrData === "string" ? pathOrData : void 0
+    );
   }
   async removeEntry(href) {
     const rootfile = await this.getRootfile();
@@ -1597,7 +1569,9 @@ ${JSON.stringify(element, null, 2)}`
   async createXhtmlDocument(body, head, language) {
     const lang = language ?? await this.getLanguage();
     return [
-      Epub.createXmlElement("?xml", { version: "1.0", encoding: "UTF-8" }),
+      Epub.createXmlElement("?xml", { version: "1.0", encoding: "UTF-8" }, [
+        { "#text": "" }
+      ]),
       Epub.createXmlElement(
         "html",
         {

package/dist/index.js

@@ -47,38 +47,15 @@ import { randomUUID } from "node:crypto";
 import { createWriteStream, rmSync } from "node:fs";
 import { cp, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import * as util from "node:util";
+import { pipeline } from "node:stream/promises";
 import { Mutex } from "async-mutex";
 import { XMLBuilder, XMLParser } from "fast-xml-parser";
 import memoize from "mem";
 import { lookup } from "mime-types";
 import { nanoid } from "nanoid";
-import yauzl from "yauzl";
+import { fromBuffer, open } from "yauzl-promise";
 import { ZipFile } from "yazl";
 import { dirname, join, resolve } from "@storyteller-platform/path";
-function promisify(api) {
-  return function(arg, options) {
-    return new Promise(function(resolve2, reject) {
-      api(arg, options, function(err, response) {
-        if (err) {
-          reject(err);
-          return;
-        }
-        resolve2(response);
-      });
-    });
-  };
-}
-const unzipFromBuffer = promisify(
-  (arg, options, callback) => {
-    yauzl.fromBuffer(arg, options, callback);
-  }
-);
-const unzipFromPath = promisify(
-  (arg, options, callback) => {
-    yauzl.open(arg, options, callback);
-  }
-);
 class Epub {
   constructor(extractPath, inputPath) {
     this.extractPath = extractPath;
@@ -97,22 +74,27 @@ class Epub {
     ignoreAttributes: false,
     parseTagValue: false
   });
-  static xhtmlParser = new XMLParser({
-    allowBooleanAttributes: true,
-    alwaysCreateTextNode: true,
-    preserveOrder: true,
-    ignoreAttributes: false,
-    htmlEntities: true,
-    trimValues: false,
-    stopNodes: ["*.pre", "*.script"],
-    parseTagValue: false,
-    updateTag(_tagName, _jPath, attrs) {
-      if (attrs && "@_/" in attrs) {
-        delete attrs["@_/"];
+  static xhtmlParser = (() => {
+    const parser = new XMLParser({
+      allowBooleanAttributes: true,
+      alwaysCreateTextNode: true,
+      preserveOrder: true,
+      ignoreAttributes: false,
+      htmlEntities: true,
+      trimValues: false,
+      stopNodes: ["*.pre", "*.script"],
+      parseTagValue: false,
+      updateTag(_tagName, _jPath, attrs) {
+        if (attrs && "@_/" in attrs) {
+          delete attrs["@_/"];
+        }
+        return true;
       }
-      return true;
-    }
-  });
+    });
+    parser.addEntity("nbsp", "\xA0");
+    parser.addEntity("#160", "\xA0");
+    return parser;
+  })();
   static xmlBuilder = new XMLBuilder({
     preserveOrder: true,
     format: true,
@@ -264,7 +246,7 @@ ${JSON.stringify(element, null, 2)}`
     );
     const encoder = new TextEncoder();
     const container = encoder.encode(`<?xml version="1.0"?>
-<container>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
   <rootfiles>
     <rootfile media-type="application/oebps-package+xml" full-path="OEBPS/content.opf"/>
   </rootfiles>
@@ -273,7 +255,7 @@ ${JSON.stringify(element, null, 2)}`
     await mkdir(join(extractPath, "META-INF"), { recursive: true });
     await writeFile(join(extractPath, "META-INF", "container.xml"), container);
     const packageDocument = encoder.encode(`<?xml version="1.0"?>
-<package unique-identifier="pub-id" dir="${language.textInfo.direction}" xml:lang=${language.toString()} version="3.0">
+<package unique-identifier="pub-id" dir="${language.textInfo.direction}" xml:lang="${language.toString()}" version="3.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
   <metadata>
   </metadata>
   <manifest>
@@ -322,52 +304,42 @@ ${JSON.stringify(element, null, 2)}`
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   static async from(pathOrData) {
-    var _stack = [];
+    const extractPath = join(
+      tmpdir(),
+      `storyteller-platform-epub-${randomUUID()}.epub`
+    );
     try {
-      const extractPath = join(
-        tmpdir(),
-        `storyteller-platform-epub-${randomUUID()}.epub`
-      );
-      const zipfile = typeof pathOrData === "string" ? await unzipFromPath(pathOrData, { lazyEntries: true }) : await unzipFromBuffer(Buffer.from(pathOrData), { lazyEntries: true });
-      const stack = __using(_stack, new DisposableStack());
-      stack.defer(() => {
-        zipfile.close();
-      });
-      const { promise, resolve: resolve2 } = Promise.withResolvers();
-      zipfile.on("end", () => {
-        resolve2();
-      });
-      const openReadStream = util.promisify(zipfile.openReadStream.bind(zipfile));
-      zipfile.readEntry();
-      zipfile.on("entry", async (entry) => {
-        if (entry.fileName.endsWith("/")) {
-          zipfile.readEntry();
-        } else {
-          const writePath = join(extractPath, entry.fileName);
-          const readStream = await openReadStream(entry);
-          await mkdir(dirname(writePath), { recursive: true });
-          await new Promise((resolvePipe) => {
-            const writePath2 = join(extractPath, entry.fileName);
-            const writeStream = createWriteStream(writePath2);
-            writeStream.on("finish", () => {
-              resolvePipe();
-            });
-            readStream.pipe(writeStream);
-          }).finally(() => {
-            zipfile.readEntry();
-          });
+      var _stack = [];
+      try {
+        const zipfile = typeof pathOrData === "string" ? await open(pathOrData) : await fromBuffer(Buffer.from(pathOrData));
+        const stack = __using(_stack, new AsyncDisposableStack(), true);
+        stack.defer(async () => {
+          await zipfile.close();
+        });
+        for await (const entry of zipfile) {
+          if (entry.filename.endsWith("/")) {
+          } else {
+            const writePath = join(extractPath, entry.filename);
+            const readStream = await entry.openReadStream();
+            await mkdir(dirname(writePath), { recursive: true });
+            const writeStream = createWriteStream(writePath);
+            await pipeline(readStream, writeStream);
+          }
         }
-      });
-      await promise;
-      return new this(
-        extractPath,
-        typeof pathOrData === "string" ? pathOrData : void 0
-      );
-    } catch (_) {
-      var _error = _, _hasError = true;
-    } finally {
-      __callDispose(_stack, _error, _hasError);
+      } catch (_) {
+        var _error = _, _hasError = true;
+      } finally {
+        var _promise = __callDispose(_stack, _error, _hasError);
+        _promise && await _promise;
+      }
+    } catch (error) {
+      rmSync(extractPath, { force: true, recursive: true });
+      throw error;
     }
+    return new this(
+      extractPath,
+      typeof pathOrData === "string" ? pathOrData : void 0
+    );
   }
   async removeEntry(href) {
     const rootfile = await this.getRootfile();
@@ -1564,7 +1536,9 @@ ${JSON.stringify(element, null, 2)}`
   async createXhtmlDocument(body, head, language) {
     const lang = language ?? await this.getLanguage();
     return [
-      Epub.createXmlElement("?xml", { version: "1.0", encoding: "UTF-8" }),
+      Epub.createXmlElement("?xml", { version: "1.0", encoding: "UTF-8" }, [
+        { "#text": "" }
+      ]),
       Epub.createXmlElement(
         "html",
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "0.4.2",
+  "version": "0.4.6",
   "type": "module",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,11 +28,14 @@
     "prepack": "yarn build"
   },
   "devDependencies": {
+    "@storyteller-platform/eslint": "0.1.0",
     "@storyteller-platform/tsup": "^0.1.0",
     "@tsconfig/strictest": "^2.0.5",
     "@types/mime-types": "^2",
     "@types/node": "^24.0.0",
+    "@types/yauzl-promise": "^4",
     "@types/yazl": "^3",
+    "eslint": "^8.0.0",
     "markdown-toc": "^1.2.0",
     "remark-toc": "^9.0.0",
     "tsup": "^8.5.0",
@@ -43,16 +46,15 @@
     "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@storyteller-platform/fs": "^0.1.3",
+    "@storyteller-platform/fs": "^0.1.4",
     "@storyteller-platform/path": "^0.1.1",
-    "@types/yauzl": "^2.10.3",
     "@zip.js/zip.js": "^2.0.0",
     "async-mutex": "^0.5.0",
-    "fast-xml-parser": "^4.0.0",
+    "fast-xml-parser": "^4.0.1",
     "mem": "^8.0.0",
     "mime-types": "^3.0.1",
     "nanoid": "^5.1.5",
-    "yauzl": "^3.2.0",
+    "yauzl-promise": "^4.0.0",
     "yazl": "^3.3.1"
   },
   "publishConfig": {