@storyteller-platform/epub 0.2.0

package/dist/node.cjs

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var node_exports = {};
+__export(node_exports, {
+  Epub: () => Epub
+});
+module.exports = __toCommonJS(node_exports);
+var import_promises = require("node:fs/promises");
+var import_node_path = require("node:path");
+var import_fs = require("@storyteller-platform/fs");
+var import_index = require("./index.cjs");
+class Epub extends import_index.Epub {
+  static create(...args) {
+    return super.create(...args);
+  }
+  static async from(...args) {
+    const pathOrData = args[0];
+    const fileData = typeof pathOrData === "string" ? await (0, import_fs.streamFile)(pathOrData) : pathOrData;
+    return super.from(fileData);
+  }
+  /**
+   * Write the current contents of the Epub to a new
+   * EPUB archive on disk.
+   *
+   * This _does not_ close the Epub. It can continue to
+   * be modified after it has been written to disk. Use
+   * `epub.close()` to close the Epub.
+   *
+   * When this method is called, the "dcterms:modified"
+   * meta tag is automatically updated to the current UTC
+   * timestamp.
+   *
+   * @param path The file path to write the new archive to. The
+   *  parent directory does not need te exist -- the path will be
+   *  recursively created.
+   */
+  async writeToFile(path) {
+    const data = await this.writeToArray();
+    if (!data.length)
+      throw new Error(
+        "Failed to write zip archive to file; writer returned no data"
+      );
+    await (0, import_promises.mkdir)((0, import_node_path.dirname)(path), { recursive: true });
+    await (0, import_promises.writeFile)(path, data);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Epub
+});

package/dist/node.d.cts

@@ -0,0 +1,28 @@
+import { Epub as Epub$1 } from './index.cjs';
+export { AlternateScript, Collection, DcCreator, DcSubject, DublinCore, ElementName, EpubMetadata, ManifestItem, MetadataEntry, ParsedXml, XmlElement, XmlNode, XmlTextNode } from './index.cjs';
+import '@zip.js/zip.js';
+import 'fast-xml-parser';
+
+declare class Epub extends Epub$1 {
+    static create(...args: Parameters<typeof Epub$1.create>): Promise<Epub>;
+    static from(...args: Parameters<typeof Epub$1.from>): Promise<Epub>;
+    /**
+     * Write the current contents of the Epub to a new
+     * EPUB archive on disk.
+     *
+     * This _does not_ close the Epub. It can continue to
+     * be modified after it has been written to disk. Use
+     * `epub.close()` to close the Epub.
+     *
+     * When this method is called, the "dcterms:modified"
+     * meta tag is automatically updated to the current UTC
+     * timestamp.
+     *
+     * @param path The file path to write the new archive to. The
+     *  parent directory does not need te exist -- the path will be
+     *  recursively created.
+     */
+    writeToFile(path: string): Promise<void>;
+}
+
+export { Epub };

package/dist/node.d.ts

@@ -0,0 +1,28 @@
+import { Epub as Epub$1 } from './index.js';
+export { AlternateScript, Collection, DcCreator, DcSubject, DublinCore, ElementName, EpubMetadata, ManifestItem, MetadataEntry, ParsedXml, XmlElement, XmlNode, XmlTextNode } from './index.js';
+import '@zip.js/zip.js';
+import 'fast-xml-parser';
+
+declare class Epub extends Epub$1 {
+    static create(...args: Parameters<typeof Epub$1.create>): Promise<Epub>;
+    static from(...args: Parameters<typeof Epub$1.from>): Promise<Epub>;
+    /**
+     * Write the current contents of the Epub to a new
+     * EPUB archive on disk.
+     *
+     * This _does not_ close the Epub. It can continue to
+     * be modified after it has been written to disk. Use
+     * `epub.close()` to close the Epub.
+     *
+     * When this method is called, the "dcterms:modified"
+     * meta tag is automatically updated to the current UTC
+     * timestamp.
+     *
+     * @param path The file path to write the new archive to. The
+     *  parent directory does not need te exist -- the path will be
+     *  recursively created.
+     */
+    writeToFile(path: string): Promise<void>;
+}
+
+export { Epub };

package/dist/node.js

@@ -0,0 +1,42 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+import { streamFile } from "@storyteller-platform/fs";
+import { Epub as BaseEpub } from "./index.js";
+class Epub extends BaseEpub {
+  static create(...args) {
+    return super.create(...args);
+  }
+  static async from(...args) {
+    const pathOrData = args[0];
+    const fileData = typeof pathOrData === "string" ? await streamFile(pathOrData) : pathOrData;
+    return super.from(fileData);
+  }
+  /**
+   * Write the current contents of the Epub to a new
+   * EPUB archive on disk.
+   *
+   * This _does not_ close the Epub. It can continue to
+   * be modified after it has been written to disk. Use
+   * `epub.close()` to close the Epub.
+   *
+   * When this method is called, the "dcterms:modified"
+   * meta tag is automatically updated to the current UTC
+   * timestamp.
+   *
+   * @param path The file path to write the new archive to. The
+   *  parent directory does not need te exist -- the path will be
+   *  recursively created.
+   */
+  async writeToFile(path) {
+    const data = await this.writeToArray();
+    if (!data.length)
+      throw new Error(
+        "Failed to write zip archive to file; writer returned no data"
+      );
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, data);
+  }
+}
+export {
+  Epub
+};

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@storyteller-platform/epub",
+  "version": "0.2.0",
+  "type": "module",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "@storyteller": "./index.ts",
+      "@storyteller-node": "./node.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./node": {
+      "@storyteller": "./node.ts",
+      "@storyteller-node": "./node.ts",
+      "import": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      },
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "readme:toc": "markdown-toc --maxdepth=5 --append='\n- [API Docs](#api-docs)' --bullets='-' -i readme-stub.md",
+    "readme:api": "typedoc",
+    "readme": "yarn readme:api && yarn readme:toc && cat readme-stub.md > README.md && tail -n +2 gen/README.md >> README.md",
+    "test": "tsx -C @storyteller --test index.test.ts",
+    "test:watch": "tsx -C @storyteller --test --watch index.test.ts",
+    "prepack": "yarn build"
+  },
+  "devDependencies": {
+    "@storyteller-platform/tsup": "^0.1.0",
+    "@tsconfig/strictest": "^2.0.5",
+    "@types/mime-types": "^2",
+    "@types/node": "^22.10.1",
+    "markdown-toc": "^1.2.0",
+    "remark-toc": "^9.0.0",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.2",
+    "typedoc": "^0.28.4",
+    "typedoc-plugin-markdown": "^4.6.3",
+    "typedoc-plugin-remark": "^1.2.0",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@storyteller-platform/fs": "^0.1.2",
+    "@storyteller-platform/path": "^0.1.0",
+    "@zip.js/zip.js": "^2.0.0",
+    "async-mutex": "^0.5.0",
+    "fast-xml-parser": "^4.0.0",
+    "mem": "^8.0.0",
+    "mime-types": "^3.0.1",
+    "nanoid": "^5.1.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}