@mtillmann/chapters 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,295 @@
+interface Chapter {
+    startTime: number;
+    endTime?: number;
+    img?: string;
+    img_type?: string;
+    img_filename?: string;
+    id?: string;
+    duration?: number;
+    title?: string;
+    url?: string;
+    location?: string;
+    toc?: boolean;
+}
+
+interface MediaItemMeta {
+    author?: string;
+    title?: string;
+    podcastName?: string;
+    description?: string;
+    fileName?: string;
+    waypoints?: boolean;
+    version?: string;
+}
+
+interface MediaItem {
+    chapters: Chapter[];
+    meta: MediaItemMeta;
+    supportsPrettyPrint: boolean;
+    chapterTitleTemplate: string;
+    defaultMeta: MediaItemMeta;
+    filename: string;
+    mimeType: string;
+    duration: number;
+    isChapterFormat: boolean;
+    to: (format: any) => any;
+    rebuildChapterTitles: () => void;
+    toString: (pretty?: boolean, exportOptions?: any) => string;
+    detect: (inputString: string) => boolean;
+    from: (input: string | MediaItem) => MediaItem;
+    add: (chapter: Chapter) => void;
+    expandFirstToStart: () => void;
+    remove: (index: number) => void;
+    applyImgUri: (prefix: string) => void;
+    ensureUniqueFilenames: () => void;
+    chapterIndexFromTime: (time: number | string) => number | null;
+    chapterIndexFromStartTime: (time: number | string) => number;
+    updateChapterStartTime: (index: number, time: string | number) => number | 'timeInUse';
+    addChapterAt: (index: number, chapter?: object) => number;
+    addChapterAtTime: (time: number | string, chapter?: object) => boolean;
+}
+
+declare const AutoFormat: {
+    classMap: Record<string, any>;
+    detect(inputString: string, returnWhat?: 'instance' | 'key' | 'class'): any;
+    from(inputString: string): MediaItem;
+    as(classKeyOrClass: any, input: string): MediaItem;
+};
+
+declare abstract class Base implements MediaItem {
+    supportsPrettyPrint: boolean;
+    chapterTitleTemplate: string;
+    chapters: Chapter[];
+    defaultMeta: MediaItemMeta;
+    meta: MediaItemMeta;
+    filename: string;
+    mimeType: string;
+    duration: number;
+    isChapterFormat: boolean;
+    static create(input?: string | MediaItem): MediaItem;
+    from(input?: string | MediaItem): MediaItem;
+    detect(inputString: string): boolean;
+    test(data: object): {
+        errors: string[];
+    };
+    bump(keepDuration?: boolean): void;
+    endTime(index: number): number;
+    expandFirstToStart(): void;
+    add(chapter: Chapter): void;
+    remove(index: number): void;
+    to(className: any): 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;
+    rebuildChapterTitles(template?: string): void;
+    ensureTitle(index: number): string;
+    getChapterTitle(index: number, template?: string): string;
+    chapterExistsAtStartTime(time: number): boolean;
+    updateChapterStartTime(index: number, startTime: number | string): number | 'timeInUse';
+    chapterIndexFromStartTime(startTime: number | string): number;
+    chapterIndexFromTime(time: number | string): null | number;
+    ensureUniqueFilenames(): void;
+    applyImgUri(imgUri: string): void;
+}
+
+declare class MatroskaXML extends Base {
+    supportsPrettyPrint: boolean;
+    filename: string;
+    mimeType: string;
+    chapterStringNodeName: string;
+    inputTimeToSeconds(string: string): number;
+    secondsToOutputTime(seconds: number): string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
+declare class AppleChapters extends MatroskaXML {
+    supportsPrettyPrint: boolean;
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(pretty?: boolean, exportOptions?: any): string;
+}
+
+declare class AppleHLS extends Base {
+    filename: string;
+    mimeType: string;
+    supportsPrettyPrint: boolean;
+    titleLanguage: string;
+    imageDims: number[];
+    test(data: object[]): {
+        errors: string[];
+    };
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
+declare class ChaptersJson extends Base {
+    supportsPrettyPrint: boolean;
+}
+
+declare class FFMetadata extends Base {
+    filename: string;
+    mimeType: string;
+    characters: string[];
+    safeCharacters: string;
+    unescapeRegexp: RegExp;
+    escapeRegexp: RegExp;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    unescape(string: string): string;
+    escape(string: string): string;
+    toString(): string;
+}
+
+declare class FFMpegInfo extends Base {
+    detect(inputString: string): boolean;
+    parse(input: string): void;
+    toString(): string;
+}
+
+declare class MKVMergeSimple extends Base {
+    filename: string;
+    mimeType: string;
+    protected zeroPad: number;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(): string;
+}
+
+declare class MKVMergeXML extends MatroskaXML {
+    supportsPrettyPrint: boolean;
+    filename: string;
+    mimeType: string;
+    chapterStringNodeName: string;
+    inputTimeToSeconds(string: string): number;
+    secondsToOutputTime(seconds: number): string;
+}
+
+declare class MP4Chaps extends Base {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(): string;
+}
+
+declare class PodloveJson extends Base {
+    filename: string;
+    mimeType: string;
+    test(data: object[]): {
+        errors: string[];
+    };
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
+declare class PodloveSimpleChapters extends Base {
+    supportsPrettyPrint: boolean;
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(pretty?: boolean): string;
+}
+
+declare class PySceneDetect extends Base {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(pretty?: boolean, exportOptions?: any): string;
+}
+
+declare class Scenecut extends Base {
+    filename: string;
+    mimeType: string;
+    frameRate: number;
+    /**
+       * The number "1001" in the context of video processing and multimedia, especially in relation to frame rates and timecodes, is often associated with the NTSC color system used in North America and Japan.
+       * In this system, the frame rate is often described as "29.97 frames per second", but it's technically 30000/1001 frames per second, which is approximately 29.97 but not exactly. This is known as a "drop frame" rate, and the "1001" comes from this fractional frame rate.
+      */
+    ptsScale: number;
+    score: number;
+    test(data: object[]): {
+        errors: string[];
+    };
+    parse(string: string): void;
+    toString(pretty?: boolean, exportOptions?: {}): string;
+}
+
+declare class ShutterEDL extends Base {
+    detect(inputString: string): boolean;
+    decodeTime(timeString: string): string;
+    encodeTime(time: number): string;
+    parse(input: string): void;
+    toString(): string;
+}
+
+declare class VorbisComment extends MKVMergeSimple {
+    filename: string;
+    mimeType: string;
+    zeroPad: number;
+}
+
+declare class WebVTT extends Base {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(): string;
+}
+
+declare class Youtube extends Base {
+    filename: string;
+    mimeType: string;
+    detect(inputString: string): boolean;
+    parse(string: string): void;
+    toString(): string;
+}
+
+declare function zeroPad(num: string | number, len?: number): string;
+declare function secondsToTimestamp(seconds: number | string, options?: any): string;
+/**
+ * Converts a NPT (normal play time) to seconds, used by podlove simple chapters
+ */
+declare function NPTToSeconds(npt: string): number;
+declare function secondsToNPT(seconds: number): string;
+declare function timestampToSeconds(timestamp: string, fixedString?: boolean): number;
+declare function hash(): string;
+declare function escapeRegExpCharacters(text: string): string;
+declare function enforceMilliseconds(seconds: number): number;
+declare function formatBytes(bytes: number, decimals?: number, format?: 'kB' | 'KiB'): string;
+declare function Int(value: unknown, defaultValue?: number): number;
+declare function Float(value: unknown, defaultValue?: number): number;
+declare function Ints(value: unknown[], defaultValue?: number): number[];
+declare function Floats(value: unknown[], defaultValue?: number): number[];
+declare function indenter(spacesPerDepth?: number): (depth: number, string: string) => string;
+declare function stringToLines(string: string): string[];
+declare function toSeconds(input: number | string): number;
+
+declare const util_Float: typeof Float;
+declare const util_Floats: typeof Floats;
+declare const util_Int: typeof Int;
+declare const util_Ints: typeof Ints;
+declare const util_NPTToSeconds: typeof NPTToSeconds;
+declare const util_enforceMilliseconds: typeof enforceMilliseconds;
+declare const util_escapeRegExpCharacters: typeof escapeRegExpCharacters;
+declare const util_formatBytes: typeof formatBytes;
+declare const util_hash: typeof hash;
+declare const util_indenter: typeof indenter;
+declare const util_secondsToNPT: typeof secondsToNPT;
+declare const util_secondsToTimestamp: typeof secondsToTimestamp;
+declare const util_stringToLines: typeof stringToLines;
+declare const util_timestampToSeconds: typeof timestampToSeconds;
+declare const util_toSeconds: typeof toSeconds;
+declare const util_zeroPad: typeof zeroPad;
+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, ChaptersJson, FFMetadata, FFMpegInfo, MKVMergeSimple, MKVMergeXML, MP4Chaps, MatroskaXML, PodloveJson, PodloveSimpleChapters, PySceneDetect, Scenecut, ShutterEDL, util as Util, VorbisComment, WebVTT, Youtube };