@storyteller-platform/epub 0.4.0 → 0.4.2

package/dist/index.cjs

@@ -5,6 +5,10 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __knownSymbol = (name, symbol) => (symbol = Symbol[name]) ? symbol : Symbol.for("Symbol." + name);
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -26,6 +30,47 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __using = (stack, value, async) => {
+  if (value != null) {
+    if (typeof value !== "object" && typeof value !== "function") __typeError("Object expected");
+    var dispose, inner;
+    if (async) dispose = value[__knownSymbol("asyncDispose")];
+    if (dispose === void 0) {
+      dispose = value[__knownSymbol("dispose")];
+      if (async) inner = dispose;
+    }
+    if (typeof dispose !== "function") __typeError("Object not disposable");
+    if (inner) dispose = function() {
+      try {
+        inner.call(this);
+      } catch (e) {
+        return Promise.reject(e);
+      }
+    };
+    stack.push([async, dispose, value]);
+  } else if (async) {
+    stack.push([async]);
+  }
+  return value;
+};
+var __callDispose = (stack, error, hasError) => {
+  var E = typeof SuppressedError === "function" ? SuppressedError : function(e, s, m, _) {
+    return _ = Error(m), _.name = "SuppressedError", _.error = e, _.suppressed = s, _;
+  };
+  var fail = (e) => error = hasError ? new E(e, error, "An error was suppressed during disposal") : (hasError = true, e);
+  var next = (it) => {
+    while (it = stack.pop()) {
+      try {
+        var result = it[1] && it[1].call(it[2]);
+        if (it[0]) return Promise.resolve(result).then(next, (e) => (fail(e), next()));
+      } catch (e) {
+        fail(e);
+      }
+    }
+    if (hasError) throw error;
+  };
+  return next();
+};
 var index_exports = {};
 __export(index_exports, {
   Epub: () => Epub
@@ -35,17 +80,41 @@ 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 import_fslib = require("@yarnpkg/fslib");
-var import_libzip = require("@yarnpkg/libzip");
+var util = __toESM(require("node:util"), 1);
 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_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(zipFs, zipPath, inputPath) {
-    this.zipFs = zipFs;
-    this.zipPath = zipPath;
+  constructor(extractPath, inputPath) {
+    this.extractPath = extractPath;
     this.inputPath = inputPath;
     this.readXhtmlItemContents = (0, import_mem.default)(
       this.readXhtmlItemContents.bind(this),
@@ -222,11 +291,10 @@ ${JSON.stringify(element, null, 2)}`
     creators,
     contributors
   }, additionalMetadata = []) {
-    const tmp = import_fslib.npath.join(
+    const extractPath = (0, import_path.join)(
       (0, import_node_os.tmpdir)(),
-      `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
+      `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}`
     );
-    const zipFs = new import_libzip.ZipFS(import_fslib.npath.toPortablePath(tmp), { create: true });
     const encoder = new TextEncoder();
     const container = encoder.encode(`<?xml version="1.0"?>
 <container>
@@ -235,11 +303,8 @@ ${JSON.stringify(element, null, 2)}`
   </rootfiles>
 </container>
 `);
-    await zipFs.mkdirpPromise(import_fslib.ppath.join(import_fslib.PortablePath.root, "META-INF"));
-    await zipFs.writeFilePromise(
-      import_fslib.ppath.join(import_fslib.PortablePath.root, "META-INF", "container.xml"),
-      container
-    );
+    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">
   <metadata>
@@ -250,12 +315,9 @@ ${JSON.stringify(element, null, 2)}`
   </spine>
 </package>
 `);
-    await zipFs.mkdirpPromise(import_fslib.ppath.join(import_fslib.PortablePath.root, "OEBPS"));
-    await zipFs.writeFilePromise(
-      import_fslib.ppath.join(import_fslib.PortablePath.root, "OEBPS", "content.opf"),
-      packageDocument
-    );
-    const epub = new this(zipFs, tmp, path);
+    await (0, import_promises.mkdir)((0, import_path.join)(extractPath, "OEBPS"));
+    await (0, import_promises.writeFile)((0, import_path.join)(extractPath, "OEBPS", "content.opf"), packageDocument);
+    const epub = new this(extractPath, path);
     const metadata = [
       {
         id: "pub-id",
@@ -293,35 +355,66 @@ ${JSON.stringify(element, null, 2)}`
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   static async from(pathOrData) {
-    const tmp = import_fslib.npath.join(
-      (0, import_node_os.tmpdir)(),
-      `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}.epub`
-    );
-    if (typeof pathOrData !== "string") {
-      await (0, import_promises.writeFile)(tmp, pathOrData);
-    } else {
-      await (0, import_promises.cp)(pathOrData, tmp);
+    var _stack = [];
+    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();
+          });
+        }
+      });
+      await promise;
+      return new this(
+        extractPath,
+        typeof pathOrData === "string" ? pathOrData : void 0
+      );
+    } catch (_) {
+      var _error = _, _hasError = true;
+    } finally {
+      __callDispose(_stack, _error, _hasError);
     }
-    const zipFs = new import_libzip.ZipFS(import_fslib.npath.toPortablePath(tmp));
-    return new this(
-      zipFs,
-      tmp,
-      typeof pathOrData === "string" ? pathOrData : void 0
-    );
   }
   async removeEntry(href) {
     const rootfile = await this.getRootfile();
     const filename = this.resolveHref(rootfile, href);
-    await this.zipFs.removePromise(filename);
+    await (0, import_promises.rm)(filename);
   }
   async getFileData(path, encoding) {
-    return await this.zipFs.readFilePromise(path, encoding);
+    return await (0, import_promises.readFile)(path, encoding);
   }
   async getRootfile() {
     var _a;
     if (this.rootfile !== null) return this.rootfile;
     const containerString = await this.getFileData(
-      import_fslib.ppath.join(import_fslib.PortablePath.root, "META-INF", "container.xml"),
+      (0, import_path.join)(this.extractPath, "META-INF", "container.xml"),
       "utf-8"
     );
     if (!containerString)
@@ -353,7 +446,7 @@ ${JSON.stringify(element, null, 2)}`
       throw new Error(
         "Failed to parse EPUB container.xml: Found no rootfile element"
       );
-    this.rootfile = import_fslib.ppath.resolve(import_fslib.PortablePath.root, fullPath);
+    this.rootfile = (0, import_path.resolve)(this.extractPath, fullPath);
     return this.rootfile;
   }
   migratePackageDocument(packageDocument) {
@@ -836,7 +929,11 @@ ${JSON.stringify(element, null, 2)}`
     if (!primaryLanguage) return null;
     const locale = primaryLanguage.value;
     if (!locale || locale.toLowerCase() === "und") return null;
-    return new Intl.Locale(locale);
+    try {
+      return new Intl.Locale(locale);
+    } catch {
+      return null;
+    }
   }
   /**
    * Update the Epub's language metadata entry.
@@ -1476,8 +1573,8 @@ ${JSON.stringify(element, null, 2)}`
    * Returns a Zip Entry path for an HREF
    */
   resolveHref(from, href) {
-    const startPath = import_fslib.ppath.dirname(from);
-    return import_fslib.ppath.resolve(import_fslib.PortablePath.root, startPath, href);
+    const startPath = (0, import_path.dirname)(from);
+    return (0, import_path.resolve)(this.extractPath, startPath, href);
   }
   async readItemContents(id, encoding) {
     const rootfile = await this.getRootfile();
@@ -1523,8 +1620,8 @@ ${JSON.stringify(element, null, 2)}`
     return Epub.getXhtmlTextContent(body);
   }
   async writeEntryContents(path, contents, encoding) {
-    await this.zipFs.mkdirpPromise(import_fslib.ppath.dirname(path));
-    await this.zipFs.writeFilePromise(path, contents, encoding);
+    await (0, import_promises.mkdir)((0, import_path.dirname)(path), { recursive: true });
+    await (0, import_promises.writeFile)(path, contents, encoding);
   }
   async writeItemContents(id, contents, encoding) {
     const rootfile = await this.getRootfile();
@@ -1614,8 +1711,8 @@ ${JSON.stringify(element, null, 2)}`
         contents
       )
     ) : contents;
-    await this.zipFs.mkdirpPromise(import_fslib.ppath.dirname(filename));
-    await this.zipFs.writeFilePromise(filename, data);
+    await (0, import_promises.mkdir)((0, import_path.dirname)(filename), { recursive: true });
+    await (0, import_promises.writeFile)(filename, data);
   }
   /**
    * Update the manifest entry for an existing item.
@@ -1766,11 +1863,10 @@ ${JSON.stringify(element, null, 2)}`
     });
   }
   discardAndClose() {
-    this.zipFs.discardAndClose();
     this.rootfile = null;
     this.manifest = null;
     this.spine = null;
-    (0, import_node_fs.rmSync)(this.zipPath, { recursive: true, force: true });
+    (0, import_node_fs.rmSync)(this.extractPath, { recursive: true, force: true });
   }
   /**
    * Write the current contents of the Epub to a new
@@ -1781,32 +1877,62 @@ ${JSON.stringify(element, null, 2)}`
    * timestamp.
    */
   async saveAndClose() {
-    if (!this.inputPath) {
-      throw new Error("In-memory EPUB files cannot be saved to disk");
-    }
-    await this.replaceMetadata(
-      (entry) => entry.properties["property"] === "dcterms:modified",
-      {
-        type: "meta",
-        properties: { property: "dcterms:modified" },
-        // We need UTC with integer seconds, but toISOString gives UTC with ms
-        value: (/* @__PURE__ */ new Date()).toISOString().replace(/\.\d+/, "")
+    var _stack = [];
+    try {
+      if (!this.inputPath) {
+        throw new Error("In-memory EPUB files cannot be saved to disk");
       }
-    );
-    this.zipFs.level = 0;
-    await this.zipFs.writeFilePromise(
-      import_fslib.ppath.join(import_fslib.PortablePath.root, "mimetype"),
-      "application/epub+zip",
-      "utf-8"
-    );
-    this.zipFs.level = import_libzip.DEFAULT_COMPRESSION_LEVEL;
-    this.zipFs.saveAndClose();
-    await (0, import_promises.cp)(this.zipPath, this.inputPath, { force: true });
+      await this.replaceMetadata(
+        (entry) => entry.properties["property"] === "dcterms:modified",
+        {
+          type: "meta",
+          properties: { property: "dcterms:modified" },
+          // We need UTC with integer seconds, but toISOString gives UTC with ms
+          value: (/* @__PURE__ */ new Date()).toISOString().replace(/\.\d+/, "")
+        }
+      );
+      const tmpArchivePath = (0, import_path.join)(
+        (0, import_node_os.tmpdir)(),
+        `storyteller-platform-epub-${(0, import_node_crypto.randomUUID)()}`
+      );
+      const { promise, resolve: resolve2 } = Promise.withResolvers();
+      const zipfile = new import_yazl.ZipFile();
+      const writeStream = (0, import_node_fs.createWriteStream)(tmpArchivePath);
+      writeStream.on("close", () => {
+        resolve2();
+      });
+      const stack = __using(_stack, new AsyncDisposableStack(), true);
+      stack.defer(async () => {
+        writeStream.close();
+        await (0, import_promises.rm)(tmpArchivePath, { force: true });
+      });
+      zipfile.outputStream.pipe(writeStream);
+      zipfile.addBuffer(Buffer.from("application/epub+zip"), "mimetype", {
+        compress: false
+      });
+      const entries = await (0, import_promises.readdir)(this.extractPath, {
+        recursive: true,
+        withFileTypes: true
+      });
+      for (const entry of entries) {
+        if (entry.name === "mimetype" || entry.isDirectory()) continue;
+        zipfile.addFile(
+          (0, import_path.join)(entry.parentPath, entry.name),
+          (0, import_path.join)(entry.parentPath, entry.name).replace(`${this.extractPath}/`, "")
+        );
+      }
+      zipfile.end();
+      await promise;
+      await (0, import_promises.cp)(tmpArchivePath, this.inputPath);
+    } catch (_) {
+      var _error = _, _hasError = true;
+    } finally {
+      var _promise = __callDispose(_stack, _error, _hasError);
+      _promise && await _promise;
+    }
   }
   [Symbol.dispose]() {
-    if (this.zipFs.ready) {
-      this.discardAndClose();
-    }
+    this.discardAndClose();
   }
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -1,5 +1,3 @@
-import { NativePath } from '@yarnpkg/fslib';
-import { ZipFS } from '@yarnpkg/libzip';
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
 
 declare global {
@@ -105,8 +103,7 @@ type PackageElement = XmlElement<"package"> | XmlElement<"opf:package">;
  * @link https://www.w3.org/TR/epub-33/
  */
 declare class Epub {
-    protected zipFs: ZipFS;
-    protected zipPath: NativePath;
+    protected extractPath: string;
     protected inputPath: string | undefined;
     static xmlParser: XMLParser;
     static xhtmlParser: XMLParser;
@@ -167,7 +164,7 @@ declare class Epub {
     private manifest;
     private spine;
     private packageMutex;
-    protected constructor(zipFs: ZipFS, zipPath: NativePath, inputPath: string | undefined);
+    protected constructor(extractPath: string, inputPath: string | undefined);
     /**
      * Construct an Epub instance, optionally beginning
      * with the provided metadata.

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { NativePath } from '@yarnpkg/fslib';
-import { ZipFS } from '@yarnpkg/libzip';
 import { XMLParser, XMLBuilder } from 'fast-xml-parser';
 
 declare global {
@@ -105,8 +103,7 @@ type PackageElement = XmlElement<"package"> | XmlElement<"opf:package">;
  * @link https://www.w3.org/TR/epub-33/
  */
 declare class Epub {
-    protected zipFs: ZipFS;
-    protected zipPath: NativePath;
+    protected extractPath: string;
     protected inputPath: string | undefined;
     static xmlParser: XMLParser;
     static xhtmlParser: XMLParser;
@@ -167,7 +164,7 @@ declare class Epub {
     private manifest;
     private spine;
     private packageMutex;
-    protected constructor(zipFs: ZipFS, zipPath: NativePath, inputPath: string | undefined);
+    protected constructor(extractPath: string, inputPath: string | undefined);
     /**
      * Construct an Epub instance, optionally beginning
      * with the provided metadata.