@storyteller-platform/epub 0.8.0 → 0.8.2

package/dist/index.d.ts

@@ -36,6 +36,7 @@ export type ParsedXml = Array<XmlNode>;
 export type ManifestItem = {
     id: string;
     href: string;
+    title?: string | undefined;
     mediaType?: string | undefined;
     fallback?: string | undefined;
     mediaOverlay?: string | undefined;
@@ -107,14 +108,16 @@ export interface Collection {
 export interface NavigationItem {
     title: string;
     href?: string;
+    role?: string;
     children?: NavigationList;
 }
 export type NavigationList = NavigationItem[];
 export interface Navigation {
     title?: string;
+    role: string;
     children: NavigationList;
 }
-interface GuideItem {
+export interface GuideItem {
     href: string;
     title: string;
     type: string;
@@ -312,6 +315,7 @@ export declare class Epub {
      */
     getItemArchiveLength(id: string): Promise<number>;
     getRootfile(): Promise<string>;
+    getPackageDocumentSource(): Promise<string>;
     private getPackageDocument;
     getPackageElement(): Promise<XmlElement<"package">>;
     /**
@@ -834,7 +838,9 @@ export declare class Epub {
      *
      * @link https://www.w3.org/TR/epub-33/#sec-spine-elem
      */
-    getSpineItems(): Promise<ManifestItem[]>;
+    getSpineItems(): Promise<(ManifestItem & {
+        linear: boolean;
+    })[]>;
     /**
      * Add an item to the spine of the EPUB.
      *
@@ -1129,6 +1135,7 @@ export declare class EpubFactory<A extends EpubStorageAdapterClass> {
     from(source: string | Uint8Array, options?: FromOptions & AdapterOptions<A>): Promise<EpubInstanceFor<A> & {
         storage: A["kind"];
     }>;
+    readPackageDocumentSource(source: string | Uint8Array, options?: AdapterOptions<A>): Promise<string>;
     /**
      * Construct a new EPUB on this factory's adapter, optionally seeded
      * with the provided metadata. Requires a writable adapter that

package/dist/index.js

@@ -440,12 +440,15 @@ export class Epub {
         this.rootfile = await this.resolveEntry("", fullPath);
         return this.rootfile;
     }
-    async getPackageDocument() {
+    async getPackageDocumentSource() {
         const rootfile = await this.getRootfile();
         const packageDocumentString = await this.adapter.read(rootfile, "utf-8");
         if (!packageDocumentString)
             throw new Error(`Failed to parse EPUB: could not find package document at ${rootfile}`);
-        const packageDocument = Epub.xmlParser.parse(packageDocumentString);
+        return packageDocumentString;
+    }
+    async getPackageDocument() {
+        const packageDocument = Epub.xmlParser.parse(await this.getPackageDocumentSource());
         return normalizeOpfNamespacePrefixes(packageDocument);
     }
     async getPackageElement() {
@@ -1824,8 +1827,15 @@ export class Epub {
             throw new Error("Failed to parse EPUB: Found no spine element in package document");
         this.spine = spine["spine"]
             .filter((node) => !Epub.isXmlTextNode(node))
-            .map((itemref) => itemref[":@"]?.["@_idref"])
-            .filter((idref) => !!idref);
+            .map((itemref) => {
+            const idRef = itemref[":@"]?.["@_idref"];
+            const linear = itemref[":@"]?.["@_linear"];
+            return {
+                itemRef: idRef,
+                linear: linear === "no" ? false : true,
+            };
+        })
+            .filter((itemref) => !!itemref.itemRef);
         return this.spine;
     }
     /**
@@ -1839,7 +1849,14 @@ export class Epub {
     async getSpineItems() {
         const spine = await this.getSpine();
         const manifest = await this.getManifest();
-        return spine.map((itemref) => manifest[itemref]).filter((entry) => !!entry);
+        const spineItems = [];
+        for (const itemref of spine) {
+            const item = manifest[itemref.itemRef];
+            if (!item)
+                continue;
+            spineItems.push({ ...item, linear: itemref.linear });
+        }
+        return spineItems;
     }
     /**
      * Add an item to the spine of the EPUB.
@@ -1903,12 +1920,16 @@ export class Epub {
                 (!secondChild || Epub.getXmlElementName(secondChild) !== "ol")) {
                 continue;
             }
+            const role = firstChild[":@"]?.["@_epub:type"]?.trim();
             children.push({
                 title: Epub.getXhtmlTextContent(Epub.getXmlChildren(firstChild)),
                 ...(Epub.getXmlElementName(firstChild) === "a" &&
                     firstChild[":@"]?.["@_href"] && {
-                    href: await this.resolveHref(firstChild[":@"]["@_href"], undefined, { toRoot: resolveToRoot }),
+                    href: await this.resolveHref(firstChild[":@"]["@_href"], navHref, {
+                        toRoot: resolveToRoot,
+                    }),
                 }),
+                ...(role && { role }),
                 ...(secondChild &&
                     Epub.getXmlElementName(secondChild) === "ol" && {
                     children: await this.getNavigationChildren(secondChild, navHref, {
@@ -1947,6 +1968,7 @@ export class Epub {
         });
         return {
             ...(title && { title }),
+            role,
             children,
         };
     }
@@ -1962,6 +1984,7 @@ export class Epub {
             return navigationToc;
         const ncxToc = await this.getNcxTableOfContents();
         return {
+            role: "toc",
             children: ncxToc,
         };
     }
@@ -2490,6 +2513,16 @@ export class EpubFactory {
         }
         return epub;
     }
+    async readPackageDocumentSource(source, options = {}) {
+        const adapter = await this.adapterClass.init(source, options);
+        const epub = new Epub(this.adapterClass, adapter, typeof source === "string" ? source : undefined, true);
+        try {
+            return await epub.getPackageDocumentSource();
+        }
+        finally {
+            epub.discardAndClose();
+        }
+    }
     /**
      * Construct a new EPUB on this factory's adapter, optionally seeded
      * with the provided metadata. Requires a writable adapter that

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyteller-platform/epub",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "type": "module",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -38,10 +38,10 @@
     "vitest": "^5.0.0"
   },
   "dependencies": {
-    "@readium/shared": "^2.2.0",
+    "@readium/shared": "^2.5.0",
     "@storyteller-platform/fs": "^0.3.0",
-    "@storyteller-platform/media-types": "^0.2.0",
-    "@storyteller-platform/path": "^0.3.0",
+    "@storyteller-platform/media-types": "^0.2.1",
+    "@storyteller-platform/path": "^0.3.1",
     "@zip.js/zip.js": "^2.0.0",
     "async-mutex": "^0.5.0",
     "fast-xml-builder": "^1.3.1",