@storyteller-platform/epub 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -146,7 +146,7 @@ export declare class EpubReadOnlyError extends Error {
  * ```ts
  * import { Epub, getBody, findByName, textContent } from '@storyteller-platform/epub';
  *
- * const epub = await Epub.from('./path/to/book.epub');
+ * using epub = await Epub.from('./path/to/book.epub');
  * const title = await epub.getTitle();
  * const spineItems = await epub.getSpineItems();
  * const chptOne = spineItems[0];
@@ -157,8 +157,7 @@ export declare class EpubReadOnlyError extends Error {
  * const headingText = textContent(h1);
  *
  * await epub.setTitle(headingText);
- * await epub.writeToFile('./path/to/updated.epub');
- * await epub.close();
+ * await epub.saveAndClose();
  * ```
  *
  * @link https://www.w3.org/TR/epub-33/

package/dist/index.js

@@ -1,12 +1,11 @@
 import { jsx as _jsx, jsxs as _jsxs } from "@storyteller-platform/epub/jsx-runtime";
 import { Mutex } from "async-mutex";
 import memoize from "mem";
-import { nanoid } from "nanoid";
 import { MediaType } from "@storyteller-platform/media-types";
 import { copyFile } from "#files";
 import { TmpFsAdapter } from "#tmpfs";
 import * as Upgrade from "./upgrade.js";
-import { createDocument, createDocumentType, declareDefaultNamespace, findXmlChildByName, findXmlChildByNameNS, findXmlDescendantByName, getXhtmlBody, insert, isElement, isText, NS, parse, replace, serialize, text, x, } from "./xml.js";
+import { createDocument, createDocumentType, declareDefaultNamespace, findXmlChildByName, findXmlChildByNameNS, findXmlDescendantByName, getXhtmlBody, insert, isElement, isText, NS, parse, replace, serialize, text, x, xmlId, } from "./xml.js";
 export { TmpFsAdapter } from "#tmpfs";
 export { MemoryAdapter } from "./adapters/memory.js";
 /**
@@ -93,7 +92,7 @@ function spineReferenceable(manifest, item) {
  * ```ts
  * import { Epub, getBody, findByName, textContent } from '@storyteller-platform/epub';
  *
- * const epub = await Epub.from('./path/to/book.epub');
+ * using epub = await Epub.from('./path/to/book.epub');
  * const title = await epub.getTitle();
  * const spineItems = await epub.getSpineItems();
  * const chptOne = spineItems[0];
@@ -104,8 +103,7 @@ function spineReferenceable(manifest, item) {
  * const headingText = textContent(h1);
  *
  * await epub.setTitle(headingText);
- * await epub.writeToFile('./path/to/updated.epub');
- * await epub.close();
+ * await epub.saveAndClose();
  * ```
  *
  * @link https://www.w3.org/TR/epub-33/
@@ -487,7 +485,7 @@ export class Epub {
             let uniqueId = await this.getUniqueIdentifierId();
             if (!uniqueId) {
                 // Create a new unique identifier id
-                const newUniqueId = nanoid();
+                const newUniqueId = xmlId();
                 packageElement.setAttribute("unique-identifier", newUniqueId);
                 uniqueId = newUniqueId;
             }
@@ -676,7 +674,7 @@ export class Epub {
                 if (identifier.id && identifier.id === uniqueId)
                     continue;
                 const id = identifier.id ??
-                    (identifier.identifierType !== undefined ? nanoid() : undefined);
+                    (identifier.identifierType !== undefined ? xmlId() : undefined);
                 insert(metadata, _jsx("dc:identifier", { ...(id && { id }), ...(identifier.scheme &&
                         identifier.id === undefined && {
                         "opf:scheme": identifier.scheme,
@@ -743,7 +741,7 @@ export class Epub {
             ]);
             for (const source of sources) {
                 const needsId = source.identifierType !== undefined || source.isPageBreakSource;
-                const id = source.id ?? (needsId ? nanoid() : undefined);
+                const id = source.id ?? (needsId ? xmlId() : undefined);
                 insert(metadata, _jsx("dc:source", { ...(id && { id }), ...(source.scheme &&
                         source.identifierType === undefined && {
                         "opf:scheme": source.scheme,
@@ -943,7 +941,7 @@ export class Epub {
                 value: subject,
             }
             : subject;
-        const subjectId = nanoid();
+        const subjectId = xmlId();
         await this.addMetadata({
             id: subjectId,
             type: "dc:subject",
@@ -1243,7 +1241,7 @@ export class Epub {
             for (let i = 0; i < entries.length; i++) {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 const entry = entries[i];
-                const id = nanoid();
+                const id = xmlId();
                 insert(metadata, _jsx("dc:title", { id: id, children: entry.title }));
                 if (entry.type) {
                     insert(metadata, _jsx("meta", { refines: `#${id}`, property: "title-type", children: entry.type }));
@@ -1282,7 +1280,7 @@ export class Epub {
      * will be added to the end of the list.
      */
     async addCollection(collection, index) {
-        const collectionId = nanoid();
+        const collectionId = xmlId();
         // Order matters for creators and contributors,
         // so we can't just append these to the end of the
         // metadata element's children using `addMetadata`.
@@ -1426,7 +1424,7 @@ export class Epub {
      * @link https://www.w3.org/TR/epub-33/#sec-opf-dccreator
      */
     async addCreator(creator, index, type = "creator") {
-        const creatorId = nanoid();
+        const creatorId = xmlId();
         // Order matters for creators and contributors,
         // so we can't just append these to the end of the
         // metadata element's children using `addMetadata`.
@@ -1783,8 +1781,6 @@ export class Epub {
          Use if resolving a relative href from a file other than the package document.
      */
     async resolveHref(href, relativeTo, { toRoot } = {}) {
-        if (href.startsWith("#"))
-            return href;
         const rootfile = await this.getRootfile();
         const from = relativeTo
             ? await this.resolveEntry(rootfile, relativeTo)

package/dist/upgrade.js

@@ -1,7 +1,6 @@
 import { jsx as _jsx, jsxs as _jsxs } from "@storyteller-platform/epub/jsx-runtime";
-import { nanoid } from "nanoid";
 import { MediaType } from "@storyteller-platform/media-types";
-import { findXmlChildByNameNS, findXmlDescendantByName, findXmlDescendantByNameNS, insert, NS, replace, serialize, text, x, } from "./xml.js";
+import { findXmlChildByNameNS, findXmlDescendantByName, findXmlDescendantByNameNS, insert, NS, replace, serialize, text, x, xmlId, } from "./xml.js";
 const GUIDE_TO_EPUBTYPE = {
     acknowledgements: "acknowledgments",
     "other.afterword": "afterword",
@@ -78,7 +77,7 @@ function ensureId(element) {
     const existing = element.getAttribute("id");
     if (existing)
         return existing;
-    const id = `id-${nanoid(8)}`;
+    const id = `id-${xmlId(8)}`;
     element.setAttribute("id", id);
     return id;
 }

package/dist/xml.d.ts

@@ -1,4 +1,5 @@
 import xmldom, { type Document, type CharacterData, type Element, type Node, type Text, type DocumentType } from "@xmldom/xmldom";
+export declare const xmlId: (size?: number) => string;
 export declare const XMLSerializer: typeof xmldom.XMLSerializer;
 export declare function isElement(n: Node): n is Element;
 export declare function isText(n: Node): n is CharacterData;

package/dist/xml.js

@@ -1,4 +1,7 @@
 import xmldom from "@xmldom/xmldom";
+import { customAlphabet } from "nanoid";
+// XML IDs can't start with numbers or symbols. Only use characters for simplicity
+export const xmlId = customAlphabet("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ", 22);
 const { DOMParser } = xmldom;
 export const { XMLSerializer } = xmldom;
 export function isElement(n) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "types": "dist/index.d.ts",
   "license": "MIT",