@storyteller-platform/align 0.1.27 → 0.1.28

package/dist/readium/guidedNavigation.cjs

@@ -0,0 +1,234 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var guidedNavigation_exports = {};
+__export(guidedNavigation_exports, {
+  generateGuidedNavigationDocuments: () => generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest: () => generateGuidedNavigationManifest
+});
+module.exports = __toCommonJS(guidedNavigation_exports);
+var import_shared = require("@readium/shared");
+var import_change_case = require("change-case");
+var import_itertools = require("itertools");
+var import_smil_clockvalue = __toESM(require("smil-clockvalue"), 1);
+var import_audiobook = require("@storyteller-platform/audiobook");
+var import_epub = require("@storyteller-platform/epub");
+function generateGuidedNavigationManifest(title, guidedNavDocs) {
+  const readingOrder = [];
+  for (const doc of guidedNavDocs) {
+    const href = doc.links?.findWithRel("self")?.href;
+    if (!href) continue;
+    const textref = doc.guided?.[0]?.textref;
+    if (!textref) continue;
+    const referencedAudioFiles = {};
+    const pars = flatten(doc.guided ?? []);
+    for (const par of pars) {
+      if (!par.audioFile) continue;
+      const range = par.audioTime;
+      if (!range) continue;
+      const [startString, endString] = range.slice(2).split(",");
+      const start = parseFloat(startString ?? "0");
+      const end = endString ? parseFloat(endString) : null;
+      const existing = referencedAudioFiles[par.audioFile];
+      if (!existing) {
+        referencedAudioFiles[par.audioFile] = {
+          start,
+          end
+        };
+        continue;
+      }
+      existing.end = end;
+    }
+    const audioReferences = Object.entries(referencedAudioFiles).map(
+      ([audioFile, { start, end }]) => ({
+        href: `${audioFile}#t=${start},${end}`,
+        type: (0, import_audiobook.lookupAudioMime)(audioFile)
+      })
+    );
+    readingOrder.push(
+      new import_shared.Link({
+        href,
+        properties: new import_shared.Properties({
+          references: [
+            {
+              href: textref,
+              type: "application/xhtml+xml"
+            },
+            ...audioReferences
+          ]
+        })
+      })
+    );
+  }
+  return new import_shared.Manifest({
+    metadata: new import_shared.Metadata({
+      title,
+      conformsTo: [
+        "https://readium.org/webpub-manifest/profiles/guided-navigation"
+      ]
+    }),
+    links: new import_shared.Links([
+      new import_shared.Link({
+        href: "manifest.json",
+        type: "application/webpub+json",
+        rels: /* @__PURE__ */ new Set(["self"])
+      })
+    ]),
+    readingOrder: new import_shared.Links(readingOrder)
+  });
+}
+async function generateGuidedNavigationDocuments(epub) {
+  const manifest = await epub.getManifest();
+  const spine = await epub.getSpineItems();
+  const mediaOverlays = [];
+  for (const item of spine) {
+    if (!item.mediaOverlay) continue;
+    const mediaOverlayItem = manifest[item.mediaOverlay];
+    if (!mediaOverlayItem) continue;
+    mediaOverlays.push(mediaOverlayItem);
+  }
+  const guidedNavDocs = [];
+  for (const [i, overlay] of (0, import_itertools.enumerate)(mediaOverlays)) {
+    const contents = await epub.readItemContents(overlay.id, "utf-8");
+    const xml = import_epub.Epub.xmlParser.parse(contents);
+    const body = import_epub.Epub.findXmlDescendantByName("body", xml);
+    if (!body) continue;
+    const links = [];
+    const prevOverlay = mediaOverlays[i - 1];
+    if (prevOverlay) {
+      links.push(
+        new import_shared.Link({
+          rels: /* @__PURE__ */ new Set(["prev"]),
+          href: `GND/${prevOverlay.id}.json`,
+          type: "application/guided-navigation+json"
+        })
+      );
+    }
+    links.push(
+      new import_shared.Link({
+        rels: /* @__PURE__ */ new Set(["self"]),
+        href: `GND/${overlay.id}.json`,
+        type: "application/guided-navigation+json"
+      })
+    );
+    const nextOverlay = mediaOverlays[i + 1];
+    if (nextOverlay) {
+      links.push(
+        new import_shared.Link({
+          rels: /* @__PURE__ */ new Set(["next"]),
+          href: `GND/${nextOverlay.id}.json`,
+          type: "application/guided-navigation+json"
+        })
+      );
+    }
+    const guidedNavDoc = new import_shared.GuidedNavigationDocument({
+      links: new import_shared.Links(links),
+      guided: await parseGuidedNavigationObjects(
+        epub,
+        overlay.href,
+        import_epub.Epub.getXmlChildren(body)
+      )
+    });
+    guidedNavDocs.push(guidedNavDoc);
+  }
+  return guidedNavDocs;
+}
+async function parseGuidedNavigationObjects(epub, overlayHref, xml) {
+  const guidedNavObjects = [];
+  const children = xml.filter(
+    (node) => !import_epub.Epub.isXmlTextNode(node) && ["seq", "par"].includes(import_epub.Epub.getXmlElementName(node))
+  );
+  for (const element of children) {
+    if (import_epub.Epub.getXmlElementName(element) === "par") {
+      const text = import_epub.Epub.findXmlChildByName("text", import_epub.Epub.getXmlChildren(element));
+      const audio = import_epub.Epub.findXmlChildByName(
+        "audio",
+        import_epub.Epub.getXmlChildren(element)
+      );
+      if (!text || !audio) continue;
+      const textSrc = import_epub.Epub.getXmlAttributes(text)["src"];
+      const { src: audioSrc, clipBegin, clipEnd } = import_epub.Epub.getXmlAttributes(audio);
+      if (!textSrc || !audioSrc || clipBegin === void 0 || clipEnd === void 0) {
+        continue;
+      }
+      const textref = await epub.resolveHref(textSrc, overlayHref, {
+        toRoot: true
+      });
+      const audioref = await epub.resolveHref(audioSrc, overlayHref, {
+        toRoot: true
+      });
+      const clipBeginSeconds = (0, import_smil_clockvalue.default)(clipBegin) / 1e3;
+      const clipEndSeconds = (0, import_smil_clockvalue.default)(clipEnd) / 1e3;
+      guidedNavObjects.push(
+        new import_shared.GuidedNavigationObject({
+          // Slice off the leading slash
+          textref,
+          audioref: `${audioref}#t=${clipBeginSeconds},${clipEndSeconds}`
+        })
+      );
+    }
+    if (import_epub.Epub.getXmlElementName(element) === "seq") {
+      const attrs = import_epub.Epub.getXmlAttributes(element);
+      const epubType = attrs["epub:type"];
+      const role = epubType && (0, import_change_case.camelCase)(epubType);
+      const textref = attrs["epub:textref"];
+      if (!textref) continue;
+      const children2 = await parseGuidedNavigationObjects(
+        epub,
+        overlayHref,
+        import_epub.Epub.getXmlChildren(element)
+      );
+      guidedNavObjects.push(
+        new import_shared.GuidedNavigationObject({
+          textref: await epub.resolveHref(textref, overlayHref, {
+            toRoot: true
+          }),
+          ...role && { role: /* @__PURE__ */ new Set([role]) },
+          children: children2
+        })
+      );
+    }
+  }
+  return guidedNavObjects;
+}
+function flatten(input) {
+  const pars = [];
+  for (const obj of input) {
+    if (obj.children) {
+      pars.push(...flatten(obj.children));
+    } else {
+      pars.push(obj);
+    }
+  }
+  return pars;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest
+});

package/dist/readium/guidedNavigation.d.cts

@@ -0,0 +1,7 @@
+import { LocalizedString, GuidedNavigationDocument, Manifest } from '@readium/shared';
+import { Epub } from '@storyteller-platform/epub';
+
+declare function generateGuidedNavigationManifest(title: LocalizedString, guidedNavDocs: GuidedNavigationDocument[]): Manifest;
+declare function generateGuidedNavigationDocuments(epub: Epub): Promise<GuidedNavigationDocument[]>;
+
+export { generateGuidedNavigationDocuments, generateGuidedNavigationManifest };

package/dist/readium/guidedNavigation.d.ts

@@ -0,0 +1,7 @@
+import { LocalizedString, GuidedNavigationDocument, Manifest } from '@readium/shared';
+import { Epub } from '@storyteller-platform/epub';
+
+declare function generateGuidedNavigationManifest(title: LocalizedString, guidedNavDocs: GuidedNavigationDocument[]): Manifest;
+declare function generateGuidedNavigationDocuments(epub: Epub): Promise<GuidedNavigationDocument[]>;
+
+export { generateGuidedNavigationDocuments, generateGuidedNavigationManifest };

package/dist/readium/guidedNavigation.js

@@ -0,0 +1,210 @@
+import "../chunk-BIEQXUOY.js";
+import {
+  GuidedNavigationDocument,
+  GuidedNavigationObject,
+  Link,
+  Links,
+  Manifest,
+  Metadata,
+  Properties
+} from "@readium/shared";
+import { camelCase } from "change-case";
+import { enumerate } from "itertools";
+import clockvalue from "smil-clockvalue";
+import { lookupAudioMime } from "@storyteller-platform/audiobook";
+import {
+  Epub
+} from "@storyteller-platform/epub";
+function generateGuidedNavigationManifest(title, guidedNavDocs) {
+  const readingOrder = [];
+  for (const doc of guidedNavDocs) {
+    const href = doc.links?.findWithRel("self")?.href;
+    if (!href) continue;
+    const textref = doc.guided?.[0]?.textref;
+    if (!textref) continue;
+    const referencedAudioFiles = {};
+    const pars = flatten(doc.guided ?? []);
+    for (const par of pars) {
+      if (!par.audioFile) continue;
+      const range = par.audioTime;
+      if (!range) continue;
+      const [startString, endString] = range.slice(2).split(",");
+      const start = parseFloat(startString ?? "0");
+      const end = endString ? parseFloat(endString) : null;
+      const existing = referencedAudioFiles[par.audioFile];
+      if (!existing) {
+        referencedAudioFiles[par.audioFile] = {
+          start,
+          end
+        };
+        continue;
+      }
+      existing.end = end;
+    }
+    const audioReferences = Object.entries(referencedAudioFiles).map(
+      ([audioFile, { start, end }]) => ({
+        href: `${audioFile}#t=${start},${end}`,
+        type: lookupAudioMime(audioFile)
+      })
+    );
+    readingOrder.push(
+      new Link({
+        href,
+        properties: new Properties({
+          references: [
+            {
+              href: textref,
+              type: "application/xhtml+xml"
+            },
+            ...audioReferences
+          ]
+        })
+      })
+    );
+  }
+  return new Manifest({
+    metadata: new Metadata({
+      title,
+      conformsTo: [
+        "https://readium.org/webpub-manifest/profiles/guided-navigation"
+      ]
+    }),
+    links: new Links([
+      new Link({
+        href: "manifest.json",
+        type: "application/webpub+json",
+        rels: /* @__PURE__ */ new Set(["self"])
+      })
+    ]),
+    readingOrder: new Links(readingOrder)
+  });
+}
+async function generateGuidedNavigationDocuments(epub) {
+  const manifest = await epub.getManifest();
+  const spine = await epub.getSpineItems();
+  const mediaOverlays = [];
+  for (const item of spine) {
+    if (!item.mediaOverlay) continue;
+    const mediaOverlayItem = manifest[item.mediaOverlay];
+    if (!mediaOverlayItem) continue;
+    mediaOverlays.push(mediaOverlayItem);
+  }
+  const guidedNavDocs = [];
+  for (const [i, overlay] of enumerate(mediaOverlays)) {
+    const contents = await epub.readItemContents(overlay.id, "utf-8");
+    const xml = Epub.xmlParser.parse(contents);
+    const body = Epub.findXmlDescendantByName("body", xml);
+    if (!body) continue;
+    const links = [];
+    const prevOverlay = mediaOverlays[i - 1];
+    if (prevOverlay) {
+      links.push(
+        new Link({
+          rels: /* @__PURE__ */ new Set(["prev"]),
+          href: `GND/${prevOverlay.id}.json`,
+          type: "application/guided-navigation+json"
+        })
+      );
+    }
+    links.push(
+      new Link({
+        rels: /* @__PURE__ */ new Set(["self"]),
+        href: `GND/${overlay.id}.json`,
+        type: "application/guided-navigation+json"
+      })
+    );
+    const nextOverlay = mediaOverlays[i + 1];
+    if (nextOverlay) {
+      links.push(
+        new Link({
+          rels: /* @__PURE__ */ new Set(["next"]),
+          href: `GND/${nextOverlay.id}.json`,
+          type: "application/guided-navigation+json"
+        })
+      );
+    }
+    const guidedNavDoc = new GuidedNavigationDocument({
+      links: new Links(links),
+      guided: await parseGuidedNavigationObjects(
+        epub,
+        overlay.href,
+        Epub.getXmlChildren(body)
+      )
+    });
+    guidedNavDocs.push(guidedNavDoc);
+  }
+  return guidedNavDocs;
+}
+async function parseGuidedNavigationObjects(epub, overlayHref, xml) {
+  const guidedNavObjects = [];
+  const children = xml.filter(
+    (node) => !Epub.isXmlTextNode(node) && ["seq", "par"].includes(Epub.getXmlElementName(node))
+  );
+  for (const element of children) {
+    if (Epub.getXmlElementName(element) === "par") {
+      const text = Epub.findXmlChildByName("text", Epub.getXmlChildren(element));
+      const audio = Epub.findXmlChildByName(
+        "audio",
+        Epub.getXmlChildren(element)
+      );
+      if (!text || !audio) continue;
+      const textSrc = Epub.getXmlAttributes(text)["src"];
+      const { src: audioSrc, clipBegin, clipEnd } = Epub.getXmlAttributes(audio);
+      if (!textSrc || !audioSrc || clipBegin === void 0 || clipEnd === void 0) {
+        continue;
+      }
+      const textref = await epub.resolveHref(textSrc, overlayHref, {
+        toRoot: true
+      });
+      const audioref = await epub.resolveHref(audioSrc, overlayHref, {
+        toRoot: true
+      });
+      const clipBeginSeconds = clockvalue(clipBegin) / 1e3;
+      const clipEndSeconds = clockvalue(clipEnd) / 1e3;
+      guidedNavObjects.push(
+        new GuidedNavigationObject({
+          // Slice off the leading slash
+          textref,
+          audioref: `${audioref}#t=${clipBeginSeconds},${clipEndSeconds}`
+        })
+      );
+    }
+    if (Epub.getXmlElementName(element) === "seq") {
+      const attrs = Epub.getXmlAttributes(element);
+      const epubType = attrs["epub:type"];
+      const role = epubType && camelCase(epubType);
+      const textref = attrs["epub:textref"];
+      if (!textref) continue;
+      const children2 = await parseGuidedNavigationObjects(
+        epub,
+        overlayHref,
+        Epub.getXmlChildren(element)
+      );
+      guidedNavObjects.push(
+        new GuidedNavigationObject({
+          textref: await epub.resolveHref(textref, overlayHref, {
+            toRoot: true
+          }),
+          ...role && { role: /* @__PURE__ */ new Set([role]) },
+          children: children2
+        })
+      );
+    }
+  }
+  return guidedNavObjects;
+}
+function flatten(input) {
+  const pars = [];
+  for (const obj of input) {
+    if (obj.children) {
+      pars.push(...flatten(obj.children));
+    } else {
+      pars.push(obj);
+    }
+  }
+  return pars;
+}
+export {
+  generateGuidedNavigationDocuments,
+  generateGuidedNavigationManifest
+};