@mtillmann/chapters 0.0.2 → 0.1.0

package/dist/index.d.ts

@@ -66,7 +66,8 @@ declare abstract class Base implements MediaItem {
     mimeType: string;
     duration: number;
     isChapterFormat: boolean;
-    static create(input?: string | MediaItem): MediaItem;
+    constructor(duration?: number);
+    static create(input?: string | MediaItem, duration?: number): MediaItem;
     from(input?: string | MediaItem): MediaItem;
     detect(inputString: string): boolean;
     test(data: object): {
@@ -206,6 +207,7 @@ declare class PySceneDetect extends Base {
 }
 
 declare class Scenecut extends Base {
+    supportsPrettyPrint: boolean;
     filename: string;
     mimeType: string;
     frameRate: number;

package/dist/index.js

@@ -189,8 +189,11 @@ var Base = class {
   mimeType = "application/json";
   duration = 0;
   isChapterFormat = true;
-  static create(input) {
-    return new this().from(input);
+  constructor(duration = 3600) {
+    this.duration = duration;
+  }
+  static create(input, duration) {
+    return new this(duration).from(input);
   }
   from(input) {
     if (!input) {
@@ -209,9 +212,6 @@ var Base = class {
         this.duration = chapter.startTime;
       }
     }
-    if (this.duration === 0) {
-      this.duration = 3600;
-    }
     this.bump();
     return this;
   }
@@ -1213,6 +1213,7 @@ var AppleHLS = class extends Base {
 
 // src/Formats/Scenecut.ts
 var Scenecut = class extends Base {
+  supportsPrettyPrint = true;
   filename = "scene-cuts.json";
   mimeType = "application/json";
   frameRate = 30;

package/package.json

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

package/readme.md

@@ -2,7 +2,7 @@
 
 # chapters
 
-Create, manage and convert chapters for 17 chapters formats:
+Supported formats:
 
 | class                               | description                  | key            | ext    | info                                                                                                                                                               |
 |-------------------------------------|------------------------------|----------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -22,7 +22,7 @@ Create, manage and convert chapters for 17 chapters formats:
 | 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)                                                    |
 | 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                     | scenecut       | `json` | [source](https://github.com/slhck/scenecut-extractor#:~:text=cuts%20in%20JSON-,format,-%3A)                                                                        |
+| Scenecut | Scenecut format              | scenecut       | `json` | [source](https://github.com/slhck/scenecut-extractor#:~:text=cuts%20in%20JSON-,format,-%3A)                                                                        |
 
 ## Installation
 
@@ -69,6 +69,10 @@ const vtt2 = Autoformat.as(WebVTT, webVttString) // returns an instance of WebVT
 
 All formats support the following methods:
 
+### `constructor (duration: number = 3600)`
+
+Creates a new instance of the class, optionally with a duration in seconds.
+
 ### `static create (input?: string | MediaItem): MediaItem`
 
 Creates a new media item. This is the suggested way to create a media item: