@mtillmann/chapters 0.1.5 → 0.1.7

package/dist/index.js

@@ -4,9 +4,6 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 
-// src/Formats/AppleChapters.ts
-import { JSDOM as JSDOM2 } from "jsdom";
-
 // src/util.ts
 var util_exports = {};
 __export(util_exports, {
@@ -488,7 +485,7 @@ var Base = class {
 };
 
 // src/Formats/MatroskaXML.ts
-import { JSDOM } from "jsdom";
+import { XMLParser } from "fast-xml-parser";
 var MatroskaXML = class extends Base {
   supportsPrettyPrint = true;
   filename = "matroska-chapters.xml";
@@ -507,20 +504,29 @@ var MatroskaXML = class extends Base {
     if (!this.detect(string)) {
       throw new Error("Input needs xml declaration and a <Chapters> node");
     }
-    let dom;
     if (typeof DOMParser !== "undefined") {
-      dom = new DOMParser().parseFromString(string, "application/xml");
+      const dom = new DOMParser().parseFromString(string, "application/xml");
+      this.chapters = [...dom.querySelectorAll("ChapterAtom")].map((chapter) => {
+        return {
+          title: String(chapter.querySelector(this.chapterStringNodeName)?.textContent),
+          startTime: this.inputTimeToSeconds(String(chapter.querySelector("ChapterTimeStart")?.textContent)),
+          endTime: this.inputTimeToSeconds(String(chapter.querySelector("ChapterTimeEnd")?.textContent))
+        };
+      });
     } else {
-      dom = new JSDOM(string, { contentType: "application/xml" });
-      dom = dom.window.document;
+      const parsed = new XMLParser({
+        ignoreAttributes: false,
+        attributeNamePrefix: "@_"
+      }).parse(string);
+      this.chapters = parsed.Chapters.EditionEntry.ChapterAtom.map((chapter) => {
+        const title = chapter.ChapterDisplay[this.chapterStringNodeName];
+        return {
+          title,
+          startTime: this.inputTimeToSeconds(String(chapter.ChapterTimeStart)),
+          endTime: this.inputTimeToSeconds(String(chapter.ChapterTimeEnd))
+        };
+      });
     }
-    this.chapters = [...dom.querySelectorAll("ChapterAtom")].map((chapter) => {
-      return {
-        title: String(chapter.querySelector(this.chapterStringNodeName)?.textContent),
-        startTime: this.inputTimeToSeconds(String(chapter.querySelector("ChapterTimeStart")?.textContent)),
-        endTime: this.inputTimeToSeconds(String(chapter.querySelector("ChapterTimeEnd")?.textContent))
-      };
-    });
   }
   toString(pretty = false) {
     const indent = indenter(pretty ? 2 : 0);
@@ -550,6 +556,7 @@ var MatroskaXML = class extends Base {
 };
 
 // src/Formats/AppleChapters.ts
+import { XMLParser as XMLParser2 } from "fast-xml-parser";
 var AppleChapters = class extends MatroskaXML {
   supportsPrettyPrint = true;
   filename = "apple-chapters.xml";
@@ -561,20 +568,28 @@ var AppleChapters = class extends MatroskaXML {
     if (!this.detect(string)) {
       throw new Error("Input needs xml declaration and a <TextStream...> node");
     }
-    let dom;
     if (typeof DOMParser !== "undefined") {
-      dom = new DOMParser().parseFromString(string, "application/xml");
+      const dom = new DOMParser().parseFromString(string, "application/xml");
+      this.chapters = [...dom.querySelectorAll("TextSample")].map((chapter) => {
+        const title = String(chapter.getAttribute("text") ?? chapter.textContent);
+        return {
+          title,
+          startTime: timestampToSeconds(String(chapter.getAttribute("sampleTime")))
+        };
+      });
     } else {
-      dom = new JSDOM2(string, { contentType: "application/xml" });
-      dom = dom.window.document;
+      const parsed = new XMLParser2({
+        ignoreAttributes: false,
+        attributeNamePrefix: "@_"
+      }).parse(string);
+      this.chapters = parsed.TextStream.TextSample.map((chapter) => {
+        const title = chapter["#text"] || chapter["@_text"];
+        return {
+          title,
+          startTime: timestampToSeconds(chapter["@_sampleTime"])
+        };
+      });
     }
-    this.chapters = [...dom.querySelectorAll("TextSample")].map((chapter) => {
-      const title = String(chapter.getAttribute("text") ?? chapter.textContent);
-      return {
-        title,
-        startTime: timestampToSeconds(String(chapter.getAttribute("sampleTime")))
-      };
-    });
   }
   toString(pretty = false, exportOptions = {}) {
     const indent = indenter(pretty ? 2 : 0);
@@ -983,7 +998,7 @@ var ShutterEDL = class extends Base {
 };
 
 // src/Formats/PodloveSimpleChapters.ts
-import { JSDOM as JSDOM3 } from "jsdom";
+import { XMLParser as XMLParser3 } from "fast-xml-parser";
 var PodloveSimpleChapters = class extends Base {
   supportsPrettyPrint = true;
   filename = "podlove-simple-chapters-fragment.xml";
@@ -995,45 +1010,64 @@ var PodloveSimpleChapters = class extends Base {
     if (!this.detect(string)) {
       throw new Error("Input must contain <psc:chapters ...> node");
     }
-    let dom;
     if (typeof DOMParser !== "undefined") {
-      dom = new DOMParser().parseFromString(string, "application/xml");
+      const dom = new DOMParser().parseFromString(string, "application/xml");
+      this.chapters = [...dom.querySelectorAll("[start]")].reduce((acc, node) => {
+        if (node.tagName === "psc:chapter") {
+          const start = node.getAttribute("start");
+          const title = node.getAttribute("title");
+          const image = node.getAttribute("image");
+          const href = node.getAttribute("href");
+          const chapter = {
+            startTime: NPTToSeconds(start)
+          };
+          if (title) {
+            chapter.title = title;
+          }
+          if (image) {
+            chapter.img = image;
+          }
+          if (href) {
+            chapter.url = href;
+          }
+          acc.push(chapter);
+        }
+        return acc;
+      }, []);
     } else {
-      dom = new JSDOM3(string, { contentType: "application/xml" });
-      dom = dom.window.document;
-    }
-    this.chapters = [...dom.querySelectorAll("[start]")].reduce((acc, node) => {
-      if (node.tagName === "psc:chapter") {
-        const start = node.getAttribute("start");
-        const title = node.getAttribute("title");
-        const image = node.getAttribute("image");
-        const href = node.getAttribute("href");
-        const chapter = {
-          startTime: NPTToSeconds(start)
+      const parsed = new XMLParser3({
+        ignoreAttributes: false,
+        attributeNamePrefix: "@_"
+      }).parse(string);
+      this.chapters = parsed.rss.channel.item["psc:chapters"]["psc:chapter"].map((chapter) => {
+        const item = {
+          startTime: NPTToSeconds(chapter["@_start"])
         };
-        if (title) {
-          chapter.title = title;
+        if (chapter["@_title"]) {
+          item.title = chapter["@_title"];
         }
-        if (image) {
-          chapter.img = image;
+        if (chapter["@_image"]) {
+          item.img = chapter["@_image"];
         }
-        if (href) {
-          chapter.url = href;
+        if (chapter["@_href"]) {
+          item.url = chapter["@_href"];
         }
-        acc.push(chapter);
-      }
-      return acc;
-    }, []);
+        return item;
+      });
+    }
   }
   toString(pretty = false) {
     const indent = indenter(pretty ? 2 : 0);
     const output = [
+      '<?xml version="1.0" encoding="UTF-8"?>',
       '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">',
       indent(1, "<channel>"),
       indent(2, "<!-- this is only a fragment of an rss feed, see -->"),
       indent(2, "<!-- https://podlove.org/simple-chapters/#:~:text=37%20seconds-,Embedding%20Example,-This%20is%20an -->"),
       indent(2, "<!-- for more information -->"),
-      indent(2, '<psc:chapters version="1.2" xmlns:psc="http://podlove.org/simple-chapters">')
+      indent(2, '<atom:link type="text/html" href="http://podlove.org/" />'),
+      indent(2, "<item>"),
+      indent(3, '<psc:chapters version="1.2" xmlns:psc="http://podlove.org/simple-chapters">')
     ];
     this.chapters.forEach((chapter) => {
       const node = [
@@ -1049,10 +1083,11 @@ var PodloveSimpleChapters = class extends Base {
         node.push(` href="${chapter.url}"`);
       }
       node.push("/>");
-      output.push(indent(3, node.join("")));
+      output.push(indent(4, node.join("")));
     });
     output.push(
-      indent(2, "</psc:chapters>"),
+      indent(3, "</psc:chapters>"),
+      indent(2, "</item>"),
       indent(1, "</channel>"),
       indent(0, "</rss>")
     );
@@ -1263,6 +1298,125 @@ var Scenecut = class extends Base {
   }
 };
 
+// src/Formats/Audible.ts
+var Audible = class extends Base {
+  filename = "audible-chapters.json";
+  mimeType = "application/json";
+  test(data) {
+    if (!("content_license" in data)) {
+      return { errors: ["JSON Structure: key content_license missing"] };
+    }
+    if (!("content_metadata" in data.content_license)) {
+      return { errors: ["JSON Structure: key content_license.content_metadata missing"] };
+    }
+    if (!("chapter_info" in data.content_license.content_metadata)) {
+      return { errors: ["JSON Structure: key content_license.content_metadata.chapter_info missing"] };
+    }
+    if (!("chapters" in data.content_license.content_metadata.chapter_info)) {
+      return { errors: ["JSON Structure: key content_license.content_metadata.chapter_info.chapters missing"] };
+    }
+    if (!Array.isArray(data.content_license.content_metadata.chapter_info.chapters)) {
+      return { errors: ["JSON Structure: content_license.content_metadata.chapter_info.chapters must be an array"] };
+    }
+    if (!data.content_license.content_metadata.chapter_info.chapters.every((chapter) => "start_offset_sec" in chapter)) {
+      return { errors: ["JSON Structure: every chapter must have a start property"] };
+    }
+    return { errors: [] };
+  }
+  parse(string) {
+    const data = JSON.parse(string);
+    const { errors } = this.test(data);
+    if (errors.length > 0) {
+      throw new Error(errors.join(""));
+    }
+    this.duration = data.content_license.content_metadata.chapter_info.runtime_length_ms;
+    this.chapters = data.content_license.content_metadata.chapter_info.chapters.map((raw) => {
+      const { start_offset_ms: startTime, title } = raw;
+      const chapter = {
+        startTime
+      };
+      if (title) {
+        chapter.title = title;
+      }
+      return chapter;
+    });
+    this.bump();
+  }
+  toString(pretty = false) {
+    return JSON.stringify({
+      content_license: {
+        content_metadata: {
+          chapter_info: {
+            brandIntroDurationMs: 2043,
+            brandOutroDurationMs: 5061,
+            chapters: this.chapters.map((chapter, i) => ({
+              length_ms: Math.round(chapter.duration),
+              start_offset_ms: chapter.startTime,
+              start_offset_sec: Math.round(chapter.startTime / 1e3),
+              title: this.ensureTitle(i)
+            }))
+          }
+        }
+      }
+    }, null, pretty ? 2 : 0);
+  }
+};
+
+// src/Formats/Podigee.ts
+var Podigee = class extends Base {
+  supportsPrettyPrint = true;
+  test(data) {
+    if (!Array.isArray(data)) {
+      return { errors: ["JSON Structure: must be an array"] };
+    }
+    if (data.length === 0) {
+      return { errors: ["JSON Structure: must not be empty"] };
+    }
+    if (!data.every((chapter) => "start_time" in chapter && "title" in chapter)) {
+      return { errors: ["JSON Structure: every chapter must have a start_time and title property"] };
+    }
+    return { errors: [] };
+  }
+  parse(string) {
+    const data = JSON.parse(string);
+    const { errors } = this.test(data);
+    if (errors.length > 0) {
+      throw new Error(errors.join(""));
+    }
+    this.chapters = data.map((raw) => {
+      const { start_time: start, title, image, url } = raw;
+      const chapter = {
+        startTime: timestampToSeconds(start)
+      };
+      if (title) {
+        chapter.title = title;
+      }
+      if (image) {
+        chapter.img = image;
+      }
+      if (url) {
+        chapter.url = url;
+      }
+      return chapter;
+    });
+  }
+  toString(pretty = false) {
+    return JSON.stringify(this.chapters.map((chapter, i) => {
+      const output = {
+        start_time: secondsToTimestamp(chapter.startTime),
+        title: this.ensureTitle(i)
+      };
+      if (chapter.img) {
+        output.image = chapter.img;
+      }
+      if (chapter.url) {
+        output.url = chapter.url;
+      }
+      return output;
+    }), null, pretty ? 2 : 0);
+  }
+};
+
 // src/Formats/AutoFormat.ts
 var classMap = {
   chaptersjson: ChaptersJson,
@@ -1281,7 +1435,9 @@ var classMap = {
   mp4chaps: MP4Chaps,
   podlovejson: PodloveJson,
   applehls: AppleHLS,
-  scenecut: Scenecut
+  scenecut: Scenecut,
+  audible: Audible,
+  podigee: Podigee
 };
 var AutoFormat = {
   classMap,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mtillmann/chapters",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "library that manages and converts chapters of multiple formats",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,7 +34,8 @@
     "podcast-chapters",
     "edl",
     "hls",
-    "scenecut"
+    "scenecut",
+    "podigee"
   ],
   "license": "MIT",
   "devDependencies": {

package/readme.md

@@ -24,6 +24,7 @@ This is the core library of the [chaptertool](https://github.com/Mtillmann/chapt
 | VorbisComment         | Vorbis Comment Format        | vorbiscomment  | `txt`  | [spec](https://wiki.xiph.org/Chapter_Extension)                                                                                                                    |
 | AppleChapters         | "Apple Chapters"             | applechapters  | `xml`  | [source](https://github.com/rigaya/NVEnc/blob/master/NVEncC_Options.en.md#--chapter-string:~:text=CHAPTER03NAME%3Dchapter%2D3-,apple%20format,-(should%20be%20in)) |
 | ShutterEDL            | Shutter EDL                  | edl            | `edl`  | [source](https://github.com/paulpacifico/shutter-encoder/blob/f3d6bb6dfcd629861a0b0a50113bf4b062e1ba17/src/application/SceneDetection.java)                        |
+| Podigee | Podigee Chapters/Chaptermarks | podigee | `json` | [spec](https://app.podigee.com/api-docs#!/ChapterMarks/updateChapterMark:~:text=Model-,Example%20Value,-%7B%0A%20%20%22title%22%3A%20%22string%22%2C%0A%20%20%22start_time)                                                                                                                        | 
 | PodloveSimpleChapters | Podlove Simple Chapters      | psc            | `xml`  | [spec](https://podlove.org/simple-chapters/)                                                                                                                       |
 | PodloveJson           | Podlove Simple Chapters JSON | podlovejson    | `json` | [source](https://github.com/podlove/chapters#:~:text=org/%3E-,Encode%20to%20JSON,-iex%3E%20Chapters)                                                               |
 | MP4Chaps              | MP4Chaps                     | mp4chaps       | `txt`  | [source](https://github.com/podlove/chapters#:~:text=%3Achapters%3E-,Encode%20to%20mp4chaps,-iex%3E%20Chapters)                                                    |