@mtillmann/chapters 0.1.7 → 0.2.0

package/dist/index.d.ts

@@ -8,9 +8,14 @@ interface Chapter {
     duration?: number;
     title?: string;
     url?: string;
-    location?: string;
+    location?: ChapterLocation;
     toc?: boolean;
 }
+interface ChapterLocation {
+    name: string;
+    geo: string;
+    osm?: string;
+}
 
 interface MediaItemMeta {
     author?: string;
@@ -70,7 +75,7 @@ declare abstract class Base implements MediaItem {
     static create(input?: string | MediaItem, duration?: number): MediaItem;
     from(input?: string | MediaItem): MediaItem;
     detect(inputString: string): boolean;
-    test(data: object): {
+    test(data: Record<string, any>): {
         errors: string[];
     };
     bump(keepDuration?: boolean): void;
@@ -82,8 +87,8 @@ declare abstract class Base implements MediaItem {
     parse(string: string): void;
     toString(pretty?: boolean, exportOptions?: {}): string;
     applyChapterMinLength(seconds: number): object;
-    addChapterAt(index: number, chapter?: object): number;
-    addChapterAtTime(time: number | string, chapter?: object): boolean;
+    addChapterAt(index: number, chapter?: Partial<Chapter>): number;
+    addChapterAtTime(time: number | string, chapter?: Partial<Chapter>): boolean;
     rebuildChapterTitles(template?: string): void;
     ensureTitle(index: number): string;
     getChapterTitle(index: number, template?: string): string;
@@ -129,6 +134,16 @@ declare class AppleHLS extends Base {
     toString(pretty?: boolean): string;
 }
 
+declare class Audible extends Base {
+    filename: string;
+    mimeType: string;
+    test(data: Record<string, any>): {
+        errors: string[];
+    };
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
 declare class ChaptersJson extends Base {
     supportsPrettyPrint: boolean;
 }
@@ -179,6 +194,39 @@ declare class MP4Chaps extends Base {
     toString(): string;
 }
 
+declare class TextGeneric extends Base {
+    filename: string;
+    mimeType: string;
+    formats: Record<string, Record<string, any>>;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(pretty?: boolean, exportOptions?: string | Record<string, any>): string;
+}
+
+declare class PodcastPage extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
+declare class Podigee extends Base {
+    filename: string;
+    supportsPrettyPrint: boolean;
+    test(data: object[]): {
+        errors: string[];
+    };
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
+declare class PodigeeText extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
 declare class PodloveJson extends Base {
     filename: string;
     mimeType: string;
@@ -224,6 +272,13 @@ declare class Scenecut extends Base {
     toString(pretty?: boolean, exportOptions?: {}): string;
 }
 
+declare class ShowNotes extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
 declare class ShutterEDL extends Base {
     detect(inputString: string): boolean;
     decodeTime(timeString: string): string;
@@ -232,6 +287,27 @@ declare class ShutterEDL extends Base {
     toString(): string;
 }
 
+declare class SpotifyA extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
+declare class SpotifyB extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
+declare class TransistorFM extends TextGeneric {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    toString(): string;
+}
+
 declare class VorbisComment extends MKVMergeSimple {
     filename: string;
     mimeType: string;
@@ -246,11 +322,10 @@ declare class WebVTT extends Base {
     toString(): string;
 }
 
-declare class Youtube extends Base {
+declare class Youtube extends TextGeneric {
     filename: string;
     mimeType: string;
     detect(inputString: string): boolean;
-    parse(string: string): void;
     toString(): string;
 }
 
@@ -294,4 +369,4 @@ declare namespace util {
   export { util_Float as Float, util_Floats as Floats, util_Int as Int, util_Ints as Ints, util_NPTToSeconds as NPTToSeconds, util_enforceMilliseconds as enforceMilliseconds, util_escapeRegExpCharacters as escapeRegExpCharacters, util_formatBytes as formatBytes, util_hash as hash, util_indenter as indenter, util_secondsToNPT as secondsToNPT, util_secondsToTimestamp as secondsToTimestamp, util_stringToLines as stringToLines, util_timestampToSeconds as timestampToSeconds, util_toSeconds as toSeconds, util_zeroPad as zeroPad };
 }
 
-export { AppleChapters, AppleHLS, AutoFormat, type Chapter, ChaptersJson, FFMetadata, FFMpegInfo, MKVMergeSimple, MKVMergeXML, MP4Chaps, MatroskaXML, type MediaItem, type MediaItemMeta, PodloveJson, PodloveSimpleChapters, PySceneDetect, Scenecut, ShutterEDL, util as Util, VorbisComment, WebVTT, Youtube };
+export { AppleChapters, AppleHLS, Audible, AutoFormat, type Chapter, ChaptersJson, FFMetadata, FFMpegInfo, MKVMergeSimple, MKVMergeXML, MP4Chaps, MatroskaXML, type MediaItem, type MediaItemMeta, PodcastPage, Podigee, PodigeeText, PodloveJson, PodloveSimpleChapters, PySceneDetect, Scenecut, ShowNotes, ShutterEDL, SpotifyA, SpotifyB, TransistorFM, util as Util, VorbisComment, WebVTT, Youtube };

package/dist/index.js

@@ -243,6 +243,14 @@ var Base = class {
       const endTime = this.endTime(index);
       const duration = endTime - this.chapters[index].startTime;
       const timestampOptions = { hours: false };
+      const location = {
+        ...{
+          name: "",
+          geo: "",
+          osm: ""
+        },
+        ..."location" in chapter ? chapter.location : {}
+      };
       return {
         ...{
           id: hash(),
@@ -250,6 +258,7 @@ var Base = class {
         },
         ...chapter,
         ...{
+          location,
           endTime,
           duration,
           startTime_hr: secondsToTimestamp(chapter.startTime, timestampOptions),
@@ -332,12 +341,24 @@ var Base = class {
             if (!("toc" in filtered) && options.writeRedundantToc) {
               filtered.toc = true;
             }
-            ["location", "img", "url", "title"].forEach((property) => {
+            ["img", "url", "title"].forEach((property) => {
               const key = property;
               if (key in chapter && String(chapter[key]).trim().length > 0) {
                 filtered[key] = chapter[key];
               }
             });
+            if ("location" in chapter) {
+              const name = chapter.location?.name?.trim();
+              const geo = chapter.location?.geo?.trim();
+              const osm = chapter.location?.osm?.trim();
+              if (name || geo || osm) {
+                filtered.location = {
+                  name,
+                  geo,
+                  osm
+                };
+              }
+            }
             if ("img_filename" in chapter && "img" in filtered && chapter.img_type === "relative") {
               filtered.img = filenamify(chapter.img_filename);
             }
@@ -909,38 +930,88 @@ var WebVTT = class extends Base {
   }
 };
 
-// src/Formats/Youtube.ts
-var Youtube = class extends Base {
-  filename = "youtube-chapters.txt";
+// src/Formats/TextGeneric.ts
+var TextGeneric = class extends Base {
+  filename = "chapters.txt";
   mimeType = "text/plain";
+  formats = {
+    spotifya: {
+      string: (title, start) => `(${start}) ${title}`,
+      hours: "default"
+    },
+    spotifyb: {
+      string: (title, start) => `${start}-${title}`,
+      hours: "default"
+    },
+    youtube: {
+      string: (title, start) => `${start} ${title}`,
+      hours: "whenOverOneHour",
+      enforceZeroStartTime: true
+    },
+    shownotes: {
+      string: (title, start) => [`(${start})`, "", title, ""].join("\n"),
+      hours: "default"
+    },
+    transistorfm: {
+      string: (title, start) => `${start} - ${title}`,
+      hours: "default"
+    },
+    podigeetext: {
+      string: (title, start) => `${start} - ${title}`,
+      hours: "always"
+    },
+    podcastpage: {
+      string: (title, start) => `(${start}) - ${title}`,
+      hours: "default"
+    }
+  };
   detect(inputString) {
-    return /^0?0:00(:00)?\s/.test(inputString.trim());
+    return /^\(?(?<ts>\d?\d:\d\d(?::\d\d)?)\)?[\s-]+(?<title>[^\n]+)/.test(inputString.trim());
   }
   parse(string) {
     if (!this.detect(string)) {
-      throw new Error("Youtube Chapters *MUST* begin with (0)0:00(:00), received: " + string.substr(0, 10) + "...");
+      throw new Error("Invalid format, see documentation for supported formats");
     }
-    this.chapters = stringToLines(string).map((line) => {
-      const l = line.split(" ");
-      const timestamp = String(l.shift());
+    const matches = [...string.matchAll(/^\(?(?<ts>\d?\d:\d\d(?::\d\d)?)\)?[\s-]+(?<title>[^\n]+)/gm)];
+    this.chapters = matches.map((match) => {
       return {
-        startTime: timestampToSeconds(timestamp),
-        title: l.join(" ")
+        startTime: timestampToSeconds(match.groups.ts),
+        title: match.groups.title
       };
     });
   }
-  toString() {
-    const options = {
-      milliseconds: false,
-      hours: this.chapters.at(-1).startTime > 3600
-    };
+  toString(pretty = false, exportOptions = "youtube") {
+    const formatKey = typeof exportOptions === "string" ? exportOptions : exportOptions.format;
+    if (!(formatKey in this.formats)) {
+      throw new Error("Invalid format: " + formatKey);
+    }
+    const template = this.formats[formatKey];
+    const exceedsOneHour = this.chapters.at(-1).startTime > 3600;
     return this.chapters.map((chapter, index) => {
-      const startTime = index === 0 && chapter.startTime !== 0 ? 0 : chapter.startTime;
-      return `${secondsToTimestamp(startTime, options)} ${this.ensureTitle(index)}`;
+      const startTime = template.enforceZeroStartTime && index === 0 && chapter.startTime !== 0 ? 0 : chapter.startTime;
+      let hours;
+      if (startTime > 3600 || template.hours === "always" || template.hours === "whenOverOneHour" && exceedsOneHour) {
+        hours = true;
+      } else {
+        hours = false;
+      }
+      return template.string(chapter.title, secondsToTimestamp(startTime, { hours }));
     }).join("\n");
   }
 };
 
+// src/Formats/Youtube.ts
+var Youtube = class extends TextGeneric {
+  filename = "youtube-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^(?<ts>\d?\d:\d\d(?::\d\d)?) [^-](?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "youtube" });
+  }
+};
+
 // src/Formats/ShutterEDL.ts
 var ShutterEDL = class extends Base {
   // this format is based on the shutter encoder edl format
@@ -1364,6 +1435,7 @@ var Audible = class extends Base {
 
 // src/Formats/Podigee.ts
 var Podigee = class extends Base {
+  filename = "podigee-chapters.json";
   supportsPrettyPrint = true;
   test(data) {
     if (!Array.isArray(data)) {
@@ -1417,6 +1489,78 @@ var Podigee = class extends Base {
   }
 };
 
+// src/Formats/PodigeeText.ts
+var PodigeeText = class extends TextGeneric {
+  filename = "podigee-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^(?<ts>\d?\d:\d\d(?::\d\d)?) - (?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "podigeetext" });
+  }
+};
+
+// src/Formats/ShowNotes.ts
+var ShowNotes = class extends TextGeneric {
+  filename = "shownote-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^\((?<ts>\d?\d:\d\d(?::\d\d)?)\)\n\n(?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "shownotes" });
+  }
+};
+
+// src/Formats/SpotifyA.ts
+var SpotifyA = class extends TextGeneric {
+  filename = "spotify-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^\((?<ts>\d?\d:\d\d(?::\d\d)?)\) [^-](?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "spotifya" });
+  }
+};
+
+// src/Formats/SpotifyB.ts
+var SpotifyB = class extends TextGeneric {
+  filename = "spotify-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^(?<ts>\d?\d:\d\d(?::\d\d)?)-(?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "spotifyb" });
+  }
+};
+
+// src/Formats/PodcastPage.ts
+var PodcastPage = class extends TextGeneric {
+  filename = "podcastpage-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^\((?<ts>\d?\d:\d\d(?::\d\d)?)\) - (?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "podcastpage" });
+  }
+};
+
+// src/Formats/TransistorFM.ts
+var TransistorFM = class extends TextGeneric {
+  filename = "transistorfm-chapters.txt";
+  mimeType = "text/plain";
+  detect(inputString) {
+    return /^(?<ts>\d?\d:\d\d(?::\d\d)?) - (?<title>[^\n]+)/.test(inputString.trim());
+  }
+  toString() {
+    return super.toString(false, { format: "transistorfm" });
+  }
+};
+
 // src/Formats/AutoFormat.ts
 var classMap = {
   chaptersjson: ChaptersJson,
@@ -1437,7 +1581,13 @@ var classMap = {
   applehls: AppleHLS,
   scenecut: Scenecut,
   audible: Audible,
-  podigee: Podigee
+  podigee: Podigee,
+  podigeetext: PodigeeText,
+  shownotes: ShowNotes,
+  spotifya: SpotifyA,
+  spotifyb: SpotifyB,
+  podcastpage: PodcastPage,
+  transistorfm: TransistorFM
 };
 var AutoFormat = {
   classMap,
@@ -1477,6 +1627,7 @@ var AutoFormat = {
 export {
   AppleChapters,
   AppleHLS,
+  Audible,
   AutoFormat,
   ChaptersJson,
   FFMetadata,
@@ -1485,11 +1636,18 @@ export {
   MKVMergeXML,
   MP4Chaps,
   MatroskaXML,
+  PodcastPage,
+  Podigee,
+  PodigeeText,
   PodloveJson,
   PodloveSimpleChapters,
   PySceneDetect,
   Scenecut,
+  ShowNotes,
   ShutterEDL,
+  SpotifyA,
+  SpotifyB,
+  TransistorFM,
   util_exports as Util,
   VorbisComment,
   WebVTT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mtillmann/chapters",
-  "version": "0.1.7",
+  "version": "0.2.0",
   "description": "library that manages and converts chapters of multiple formats",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -4,9 +4,9 @@
 
 # chapters
 
-This is the core library of the [chaptertool](https://github.com/Mtillmann/chaptertool) project and provides the functionality to handle the formats below.  
+This is the core library of [chaptertool](https://github.com/Mtillmann/chaptertool) and [chapconv](https://github.com/Mtillmann/chapconv/) and provides the functionality to handle the formats below.  
 
-[Click here to open the web GUI](https://mtillmann.github.io/chaptertool) or go install chaptertool locally for CLI use.
+[Click here to open the chaptertool web GUI](https://mtillmann.github.io/chaptertool).
 
 ## Supported formats
 
@@ -31,6 +31,11 @@ This is the core library of the [chaptertool](https://github.com/Mtillmann/chapt
 | AppleHLS              | Apple HLS Chapters           | applehls       | `json` | [spec](https://developer.apple.com/documentation/http-live-streaming/providing-javascript-object-notation-json-chapters), partial support                          |
 | Scenecut              | Scenecut format              | scenecut       | `json` | [source](https://github.com/slhck/scenecut-extractor#:~:text=cuts%20in%20JSON-,format,-%3A)                                                                        |
 | Audible               | Audible Chapter Format         | audible        | `json` | [source](./audible-chapter-spec.md)                                                                                                                               |
+| Spotify | Spotify Formats A/B | spotifya\|spotifyb | `txt` | [see](misc-text-chapter-spec.md) |
+| Podcastpage | Podcastpage Format | podcastpage | `txt` | [see](misc-text-chapter-spec.md) |
+| Podigee Text | Podigee Text Format | podigeetext | `txt` | [see](misc-text-chapter-spec.md) |
+| TransistorFM | TransistorFM Chapter Format | transistorfm | `txt` | [see](misc-text-chapter-spec.md) |
+| "Show Notes Chapters" | Unknown Shownotes Format | shownotes | `txt` | [see](misc-text-chapter-spec.md) |
 
 ## Installation
 
@@ -86,7 +91,7 @@ const chapters = (new ChaptersJson(3600)).from(input)
 ```
 
 > the constructor will not accept any input due to javascript's order of initialization which prevents the parse method
-> from having access to cerain locally defined properties and methods.
+> from having access to certain locally defined properties and methods.
 
 ### `static create (input?: string | MediaItem): MediaItem`
 
@@ -97,7 +102,7 @@ const chapters = MatroskaXML.create(input)
 // chapters is now an instance of MatroskaXML
 
 const chapterString = WebVTT.create(chapters).toString()
-// chapterString is now a string representation of the chapters
+// chapterString is now a WebVTT string representation of the chapters
 ```
 
 ### `from (input?: string | MediaItem): MediaItem`
@@ -112,11 +117,11 @@ Converts the media item to another format.
 
 Adds a chapter.
 
-### `addChapterAt (index: number, chapter: object = {}): number`
+### `addChapterAt (index: number, chapter: Partial<Chapter> = {}): number`
 
 Adds a chapter at the given index.
 
-### `addChapterAtTime (time: number | string, chapter: object = {}): boolean`
+### `addChapterAtTime (time: number | string, chapter: Partial<Chapter> = {}): boolean`
 
 Adds a chapter at the given time.