@storyteller-platform/align 0.1.40 → 0.1.41

package/dist/readium/index.cjs

@@ -0,0 +1,33 @@
+"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 readium_exports = {};
+__export(readium_exports, {
+  generateGuidedNavigationDocuments: () => import_guidedNavigation.generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest: () => import_guidedNavigation.generateGuidedNavigationManifest,
+  generateReadiumManifest: () => import_manifest.generateReadiumManifest
+});
+module.exports = __toCommonJS(readium_exports);
+var import_manifest = require("./manifest.cjs");
+var import_guidedNavigation = require("./guidedNavigation.cjs");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest,
+  generateReadiumManifest
+});

package/dist/readium/index.d.cts

@@ -0,0 +1,5 @@
+export { generateReadiumManifest } from './manifest.cjs';
+export { ReadiumWebPublicationManifest } from './manifest.types.cjs';
+export { generateGuidedNavigationDocuments, generateGuidedNavigationManifest } from './guidedNavigation.cjs';
+import '@storyteller-platform/epub';
+import '@readium/shared';

package/dist/readium/index.d.ts

@@ -0,0 +1,5 @@
+export { generateReadiumManifest } from './manifest.js';
+export { ReadiumWebPublicationManifest } from './manifest.types.js';
+export { generateGuidedNavigationDocuments, generateGuidedNavigationManifest } from './guidedNavigation.js';
+import '@storyteller-platform/epub';
+import '@readium/shared';

package/dist/readium/index.js

@@ -0,0 +1,11 @@
+import "../chunk-BIEQXUOY.js";
+import { generateReadiumManifest } from "./manifest.js";
+import {
+  generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest
+} from "./guidedNavigation.js";
+export {
+  generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest,
+  generateReadiumManifest
+};

package/dist/readium/manifest.cjs

@@ -28,12 +28,13 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var manifest_exports = {};
 __export(manifest_exports, {
-  generateManifest: () => generateManifest
+  generateReadiumManifest: () => generateReadiumManifest
 });
 module.exports = __toCommonJS(manifest_exports);
 var import_shared = require("@readium/shared");
 var import_smil_clockvalue = __toESM(require("smil-clockvalue"), 1);
-async function generateManifest(epub) {
+const BYTES_PER_PAGE = 1024;
+async function generateReadiumManifest(epub, options = {}) {
   const primaryLocale = await epub.getLanguage() ?? new Intl.Locale("en-US");
   const creators = await epub.getCreators();
   const authors = creators.filter((contributor) => contributor.role === "aut").map((author) => createContributor(author, primaryLocale));
@@ -53,9 +54,13 @@ async function generateManifest(epub) {
   const dcSubjects = await epub.getSubjects();
   const subjects = dcSubjects.map((subject) => {
     if (typeof subject === "string") {
-      return new import_shared.Subject({ name: new import_shared.LocalizedString(subject) });
+      return new import_shared.Subject({
+        // TODO: should this be in primary locale?
+        name: new import_shared.LocalizedString(subject)
+      });
     }
     return new import_shared.Subject({
+      // TODO: should this be in primary locale?
       name: new import_shared.LocalizedString(subject.value),
       scheme: subject.authority,
       code: subject.term
@@ -86,6 +91,7 @@ async function generateManifest(epub) {
   const duration = epubMetadata.find(
     ({ properties }) => properties["property"] === "media:duration"
   )?.value;
+  const durationMs = duration !== void 0 ? (0, import_smil_clockvalue.default)(duration) : void 0;
   const otherMetadata = epubMetadata.filter(
     (meta) => (meta.properties["property"]?.split(":")[0] ?? "") in vocab
   ).map((meta) => {
@@ -93,6 +99,9 @@ async function generateManifest(epub) {
     const scheme = vocab[prefix];
     return [`${scheme}#${property}`, meta.value];
   });
+  const spine = await epub.getSpineItems();
+  const epubManifest = await epub.getManifest();
+  const numberOfPages = options.inferPageCount ? await inferPageCount(epub, spine, options.signal) : void 0;
   const metadata = new import_shared.Metadata({
     title: new import_shared.LocalizedString(title ?? ""),
     conformsTo: [import_shared.Profile.EPUB],
@@ -122,11 +131,10 @@ async function generateManifest(epub) {
       readingProgression: dir === "ltr" ? import_shared.ReadingProgression.ltr : import_shared.ReadingProgression.rtl
     },
     // TODO: is this meant to be in milliseconds (as here) or seconds?
-    ...duration !== void 0 && { duration: (0, import_smil_clockvalue.default)(duration) },
+    ...durationMs !== void 0 && { duration: durationMs },
+    ...numberOfPages !== void 0 && { numberOfPages },
     otherMetadata: Object.fromEntries(otherMetadata)
   });
-  const spine = await epub.getSpineItems();
-  const epubManifest = await epub.getManifest();
   const readingOrder = await Promise.all(
     spine.map(async (item) => {
       const link = new import_shared.Link({
@@ -158,9 +166,9 @@ async function generateManifest(epub) {
         rels.add("cover");
       }
       if (item.mediaType === "application/xhtml+xml") {
-        rels.add("content");
+        rels.add("contents");
       }
-      const otherMetadata2 = epubMetadata.filter((meta) => meta.properties["refines"] === `#${item.id}`).filter(
+      const otherResourceMetadata = epubMetadata.filter((meta) => meta.properties["refines"] === `#${item.id}`).filter(
         (meta) => (meta.properties["property"]?.split(":")[0] ?? "") in vocab
       ).map((meta) => {
         const prefix = meta.properties["property"].split(":")[0];
@@ -171,7 +179,7 @@ async function generateManifest(epub) {
         href: await epub.resolveHref(item.href, void 0, { toRoot: true }),
         ...item.mediaType && { type: item.mediaType },
         rels,
-        properties: new import_shared.Properties(Object.fromEntries(otherMetadata2))
+        properties: new import_shared.Properties(Object.fromEntries(otherResourceMetadata))
       });
       if (!item.mediaOverlay) return link;
       const mediaOverlayItem = epubManifest[item.id];
@@ -180,12 +188,12 @@ async function generateManifest(epub) {
         ({ properties }) => properties["property"] === "media:duration" && properties["refines"] === `#${mediaOverlayItem.id}`
       );
       if (!refinedBy?.value) return link;
-      const duration2 = (0, import_smil_clockvalue.default)(refinedBy.value);
+      const itemDuration = (0, import_smil_clockvalue.default)(refinedBy.value);
       return new import_shared.Link({
         href: link.href,
         type: link.mediaType.string,
         ...link.properties && { properties: link.properties },
-        duration: duration2
+        duration: itemDuration
       });
     })
   );
@@ -210,7 +218,7 @@ async function generateManifest(epub) {
       })
     ]);
   }
-  return new import_shared.Manifest({
+  const manifest = new import_shared.Manifest({
     context: ["https://readium.org/webpub-manifest/context.jsonld"],
     metadata,
     readingOrder: new import_shared.Links(readingOrder),
@@ -225,6 +233,25 @@ async function generateManifest(epub) {
     ...toc && { toc: new import_shared.Links(toc) },
     subcollections
   });
+  return manifest.serialize();
+}
+async function inferPageCount(epub, spine, signal) {
+  let total = 0;
+  for (const item of spine) {
+    if (signal?.aborted) {
+      throw new (signal.reason instanceof Error ? signal.reason.constructor : Error)(
+        signal.reason instanceof Error ? signal.reason.message : "Aborted while inferring page count"
+      );
+    }
+    if (item.mediaType !== "application/xhtml+xml") continue;
+    try {
+      const length = await epub.getItemArchiveLength(item.id);
+      total += Math.max(1, Math.ceil(length / BYTES_PER_PAGE));
+    } catch {
+      total += 1;
+    }
+  }
+  return total > 0 ? total : void 0;
 }
 function createContributor(dcCreator, primaryLocale) {
   return new import_shared.Contributor({
@@ -256,5 +283,5 @@ function createLinkTree(navList) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  generateManifest
+  generateReadiumManifest
 });

package/dist/readium/manifest.d.cts

@@ -1,6 +1,17 @@
-import { Manifest } from '@readium/shared';
-import { Epub } from '@storyteller-platform/epub';
+import { EpubReader } from '@storyteller-platform/epub';
+import { ReadiumWebPublicationManifest } from './manifest.types.cjs';
 
-declare function generateManifest(epub: Epub): Promise<Manifest>;
+interface ReadiumManifestOptions {
+    /**
+     * if true, infer a `numberOfPages`
+     * uses the compressed size of the entries, see {@link https://github.com/readium/architecture/issues/123}
+     */
+    inferPageCount?: boolean;
+    signal?: AbortSignal;
+}
+/**
+ * build a Readium WebPub manifest for an EPUB
+ */
+declare function generateReadiumManifest(epub: EpubReader, options?: ReadiumManifestOptions): Promise<ReadiumWebPublicationManifest>;
 
-export { generateManifest };
+export { type ReadiumManifestOptions, generateReadiumManifest };

package/dist/readium/manifest.d.ts

@@ -1,6 +1,17 @@
-import { Manifest } from '@readium/shared';
-import { Epub } from '@storyteller-platform/epub';
+import { EpubReader } from '@storyteller-platform/epub';
+import { ReadiumWebPublicationManifest } from './manifest.types.js';
 
-declare function generateManifest(epub: Epub): Promise<Manifest>;
+interface ReadiumManifestOptions {
+    /**
+     * if true, infer a `numberOfPages`
+     * uses the compressed size of the entries, see {@link https://github.com/readium/architecture/issues/123}
+     */
+    inferPageCount?: boolean;
+    signal?: AbortSignal;
+}
+/**
+ * build a Readium WebPub manifest for an EPUB
+ */
+declare function generateReadiumManifest(epub: EpubReader, options?: ReadiumManifestOptions): Promise<ReadiumWebPublicationManifest>;
 
-export { generateManifest };
+export { type ReadiumManifestOptions, generateReadiumManifest };

package/dist/readium/manifest.js

@@ -16,7 +16,8 @@ import {
   Subjects
 } from "@readium/shared";
 import clockvalue from "smil-clockvalue";
-async function generateManifest(epub) {
+const BYTES_PER_PAGE = 1024;
+async function generateReadiumManifest(epub, options = {}) {
   const primaryLocale = await epub.getLanguage() ?? new Intl.Locale("en-US");
   const creators = await epub.getCreators();
   const authors = creators.filter((contributor) => contributor.role === "aut").map((author) => createContributor(author, primaryLocale));
@@ -36,9 +37,13 @@ async function generateManifest(epub) {
   const dcSubjects = await epub.getSubjects();
   const subjects = dcSubjects.map((subject) => {
     if (typeof subject === "string") {
-      return new Subject({ name: new LocalizedString(subject) });
+      return new Subject({
+        // TODO: should this be in primary locale?
+        name: new LocalizedString(subject)
+      });
     }
     return new Subject({
+      // TODO: should this be in primary locale?
       name: new LocalizedString(subject.value),
       scheme: subject.authority,
       code: subject.term
@@ -69,6 +74,7 @@ async function generateManifest(epub) {
   const duration = epubMetadata.find(
     ({ properties }) => properties["property"] === "media:duration"
   )?.value;
+  const durationMs = duration !== void 0 ? clockvalue(duration) : void 0;
   const otherMetadata = epubMetadata.filter(
     (meta) => (meta.properties["property"]?.split(":")[0] ?? "") in vocab
   ).map((meta) => {
@@ -76,6 +82,9 @@ async function generateManifest(epub) {
     const scheme = vocab[prefix];
     return [`${scheme}#${property}`, meta.value];
   });
+  const spine = await epub.getSpineItems();
+  const epubManifest = await epub.getManifest();
+  const numberOfPages = options.inferPageCount ? await inferPageCount(epub, spine, options.signal) : void 0;
   const metadata = new Metadata({
     title: new LocalizedString(title ?? ""),
     conformsTo: [Profile.EPUB],
@@ -105,11 +114,10 @@ async function generateManifest(epub) {
       readingProgression: dir === "ltr" ? ReadingProgression.ltr : ReadingProgression.rtl
     },
     // TODO: is this meant to be in milliseconds (as here) or seconds?
-    ...duration !== void 0 && { duration: clockvalue(duration) },
+    ...durationMs !== void 0 && { duration: durationMs },
+    ...numberOfPages !== void 0 && { numberOfPages },
     otherMetadata: Object.fromEntries(otherMetadata)
   });
-  const spine = await epub.getSpineItems();
-  const epubManifest = await epub.getManifest();
   const readingOrder = await Promise.all(
     spine.map(async (item) => {
       const link = new Link({
@@ -141,9 +149,9 @@ async function generateManifest(epub) {
         rels.add("cover");
       }
       if (item.mediaType === "application/xhtml+xml") {
-        rels.add("content");
+        rels.add("contents");
       }
-      const otherMetadata2 = epubMetadata.filter((meta) => meta.properties["refines"] === `#${item.id}`).filter(
+      const otherResourceMetadata = epubMetadata.filter((meta) => meta.properties["refines"] === `#${item.id}`).filter(
         (meta) => (meta.properties["property"]?.split(":")[0] ?? "") in vocab
       ).map((meta) => {
         const prefix = meta.properties["property"].split(":")[0];
@@ -154,7 +162,7 @@ async function generateManifest(epub) {
         href: await epub.resolveHref(item.href, void 0, { toRoot: true }),
         ...item.mediaType && { type: item.mediaType },
         rels,
-        properties: new Properties(Object.fromEntries(otherMetadata2))
+        properties: new Properties(Object.fromEntries(otherResourceMetadata))
       });
       if (!item.mediaOverlay) return link;
       const mediaOverlayItem = epubManifest[item.id];
@@ -163,12 +171,12 @@ async function generateManifest(epub) {
         ({ properties }) => properties["property"] === "media:duration" && properties["refines"] === `#${mediaOverlayItem.id}`
       );
       if (!refinedBy?.value) return link;
-      const duration2 = clockvalue(refinedBy.value);
+      const itemDuration = clockvalue(refinedBy.value);
       return new Link({
         href: link.href,
         type: link.mediaType.string,
         ...link.properties && { properties: link.properties },
-        duration: duration2
+        duration: itemDuration
       });
     })
   );
@@ -193,7 +201,7 @@ async function generateManifest(epub) {
       })
     ]);
   }
-  return new Manifest({
+  const manifest = new Manifest({
     context: ["https://readium.org/webpub-manifest/context.jsonld"],
     metadata,
     readingOrder: new Links(readingOrder),
@@ -208,6 +216,25 @@ async function generateManifest(epub) {
     ...toc && { toc: new Links(toc) },
     subcollections
   });
+  return manifest.serialize();
+}
+async function inferPageCount(epub, spine, signal) {
+  let total = 0;
+  for (const item of spine) {
+    if (signal?.aborted) {
+      throw new (signal.reason instanceof Error ? signal.reason.constructor : Error)(
+        signal.reason instanceof Error ? signal.reason.message : "Aborted while inferring page count"
+      );
+    }
+    if (item.mediaType !== "application/xhtml+xml") continue;
+    try {
+      const length = await epub.getItemArchiveLength(item.id);
+      total += Math.max(1, Math.ceil(length / BYTES_PER_PAGE));
+    } catch {
+      total += 1;
+    }
+  }
+  return total > 0 ? total : void 0;
 }
 function createContributor(dcCreator, primaryLocale) {
   return new Contributor({
@@ -238,5 +265,5 @@ function createLinkTree(navList) {
   );
 }
 export {
-  generateManifest
+  generateReadiumManifest
 };

package/dist/readium/manifest.types.cjs

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 manifest_types_exports = {};
+module.exports = __toCommonJS(manifest_types_exports);