@interactiveplatform/movika-manifest 1.0.0-dev.0

package/dist/chapter-COPBtRYg.d.cts

@@ -0,0 +1,741 @@
+type ControlType$3 = "Text" | "Button" | "Area";
+type ControlEventType$3 = "onClick";
+interface ControlEvent$3 {
+    type: ControlEventType$3;
+    action: {
+        type: "setNextBranch";
+        args: {
+            branchId: string;
+            shouldOpenNow: boolean;
+        };
+    };
+}
+interface ControlLayoutParams$3 {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: "video" | "self";
+}
+interface ControlProps$3 {
+    text?: {
+        value: string;
+        gravityHorizontal: "start" | "end" | "center";
+        gravityVertical: "top" | "bottom" | "center";
+        color: string;
+        alpha: number;
+        size: number;
+        paddings?: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+    };
+    background: {
+        type: "color";
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: "rectangle";
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+interface Control$3 {
+    id: string;
+    type: "Button" | "Area";
+    label: string;
+    subtype: ControlType$3;
+    layoutParams: ControlLayoutParams$3;
+    props: ControlProps$3;
+    events: ControlEvent$3[];
+}
+
+interface ChapterBranch$3 {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+    isDefault: boolean;
+}
+declare enum ContainerFallbackStrategy {
+    Await = "await",
+    Min = "min",
+    Max = "max",
+    Random = "random",
+    WeightlessRandom = "weightlessRandom",
+    Default = "default"
+}
+interface ChapterContainer$3 {
+    id: string;
+    startTime: number;
+    fallbackStrategy: ContainerFallbackStrategy | null;
+    controls: Control$3[];
+    layout: {
+        type: "Relative";
+    };
+    type: "Choice" | "TextInput";
+}
+interface Chapter$3 {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer$3[];
+    branches: ChapterBranch$3[];
+    label: string;
+    x: number;
+    y: number;
+    order: "start" | "end" | "simple";
+}
+
+interface ManifestVideoVariant$3 {
+    type: string;
+    url: string;
+    size?: number;
+    standard?: string;
+    resolution?: string;
+    bitrate?: number;
+    cover?: string;
+    preview?: string;
+}
+interface ManifestVideo$3 {
+    id: string;
+    duration?: number;
+    shortlink?: string;
+    variants: ManifestVideoVariant$3[];
+    title?: string;
+}
+type DraftMediaMetadata$1 = {
+    videos: ManifestVideo$3[];
+};
+type MediaMetadata$1 = string | DraftMediaMetadata$1;
+interface Metadata$3 {
+    id: string;
+    version: string;
+    build: number;
+    initChapterId: string;
+    created: string;
+    updated: string;
+    media: MediaMetadata$1;
+}
+interface Manifest_3_0 {
+    metadata: Metadata$3;
+    chapters: Chapter$3[];
+}
+
+type ControlType$2 = "Text" | "Button" | "Area";
+type ControlEventType$2 = "onClick";
+type ControlActionType$2 = "setNextBranch" | "continuePlayback";
+interface ControlEvent$2 {
+    type: ControlEventType$2;
+    action: {
+        type: ControlActionType$2;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ControlLayoutParams$2 {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: "video" | "self";
+}
+interface ControlProps$2 {
+    text?: {
+        value: string;
+        gravityHorizontal: "start" | "end" | "center";
+        gravityVertical: "top" | "bottom" | "center";
+        color: string;
+        alpha: number;
+        size: number;
+        paddings?: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+    };
+    background: {
+        type: "color";
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: "rectangle";
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+interface Control$2 {
+    id: string;
+    type: "Button" | "Area";
+    label: string;
+    subtype: ControlType$2;
+    layoutParams: ControlLayoutParams$2;
+    props: ControlProps$2;
+    events?: ControlEvent$2[];
+}
+
+type ChapterEventType$2 = "onSuspense";
+type ContainerEventType$2 = "onSuspense";
+type ChapterSuspenseActionType$2 = "setNextBranch" | "setRandomBranch";
+type ContainerSuspenseActionType$2 = "setNextBranch" | "continuePlayback";
+interface ChapterEvent$2 {
+    type: ChapterEventType$2;
+    action: {
+        type: ChapterSuspenseActionType$2;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ChapterBranch$2 {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+}
+interface ContainerEvent$2 {
+    type: ContainerEventType$2;
+    action: {
+        type: ContainerSuspenseActionType$2;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ChapterContainer$2 {
+    id: string;
+    startTime: number;
+    endTime?: number | null;
+    controls: Control$2[];
+    layout: {
+        type: "Relative";
+    };
+    type: "Choice" | "TextInput";
+    events?: ContainerEvent$2[];
+}
+interface Chapter$2 {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer$2[];
+    branches: ChapterBranch$2[];
+    events?: ChapterEvent$2[];
+    label: string;
+    x: number;
+    y: number;
+    order: "start" | "end" | "simple";
+}
+
+interface ManifestVideoVariant$2 {
+    type: string;
+    url: string;
+    size?: number;
+    standard?: string;
+    resolution?: string;
+    bitrate?: number;
+    cover?: string;
+    preview?: string;
+}
+interface ManifestVideo$2 {
+    id: string;
+    duration?: number;
+    shortlink?: string;
+    variants: ManifestVideoVariant$2[];
+    title?: string;
+}
+type DraftMediaMetadata = {
+    videos: ManifestVideo$2[];
+};
+type MediaMetadata = string | DraftMediaMetadata;
+interface Metadata$2 {
+    id: string;
+    version: string;
+    build: number;
+    initChapterId?: string;
+    created: string;
+    updated: string;
+    media: MediaMetadata;
+}
+interface Manifest_3_1 {
+    metadata: Metadata$2;
+    chapters: Chapter$2[];
+}
+
+type ControlType$1 = "Text" | "Button" | "Area";
+type ControlEventType$1 = "onClick";
+type ControlActionType$1 = "setNextBranch" | "continuePlayback";
+interface ControlEvent$1 {
+    type: ControlEventType$1;
+    action: {
+        type: ControlActionType$1;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ControlLayoutParams$1 {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: "video" | "self";
+}
+interface ControlProps$1 {
+    text?: {
+        value: string;
+        gravityHorizontal: "start" | "end" | "center";
+        gravityVertical: "top" | "bottom" | "center";
+        color: string;
+        alpha: number;
+        size: number;
+        paddings?: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+    };
+    background: {
+        type: "color";
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: "rectangle";
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+interface Control$1 {
+    id: string;
+    type: "Button" | "Area";
+    label: string;
+    subtype: ControlType$1;
+    layoutParams: ControlLayoutParams$1;
+    props: ControlProps$1;
+    events?: ControlEvent$1[];
+}
+
+type ChapterEventType$1 = "onSuspense";
+type ContainerEventType$1 = "onSuspense";
+type ChapterSuspenseActionType$1 = "setNextBranch" | "setRandomBranch";
+type ContainerSuspenseActionType$1 = "setNextBranch" | "continuePlayback";
+interface ChapterEvent$1 {
+    type: ChapterEventType$1;
+    action: {
+        type: ChapterSuspenseActionType$1;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ChapterBranch$1 {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+}
+interface ContainerEvent$1 {
+    type: ContainerEventType$1;
+    action: {
+        type: ContainerSuspenseActionType$1;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+interface ChapterContainer$1 {
+    id: string;
+    startTime: number;
+    endTime?: number | null;
+    controls: Control$1[];
+    layout: {
+        type: "Relative";
+    };
+    type: "Choice" | "TextInput";
+    events?: ContainerEvent$1[];
+}
+interface Chapter$1 {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer$1[];
+    branches: ChapterBranch$1[];
+    events?: ChapterEvent$1[];
+    label: string;
+    x: number;
+    y: number;
+    order: "start" | "end" | "simple";
+}
+
+interface ManifestVideoVariant$1 {
+    type: string;
+    url: string;
+    size?: number;
+    standard?: string;
+    resolution?: string;
+    bitrate?: number;
+    cover?: string;
+    preview?: string;
+    payload?: {
+        type: string;
+        id: string;
+    };
+}
+interface ManifestVideo$1 {
+    id: string;
+    duration?: number;
+    shortlink?: string;
+    variants: ManifestVideoVariant$1[];
+    title?: string;
+}
+type Media$1 = {
+    videos: ManifestVideo$1[];
+};
+interface Metadata$1 {
+    id: string;
+    version: string;
+    build: number;
+    initChapterId?: string;
+    created: string;
+    updated: string;
+    types?: string[];
+    media?: Media$1;
+}
+interface Manifest_3_2 {
+    metadata: Metadata$1;
+    media: Media$1;
+    chapters: Chapter$1[];
+}
+
+interface GraphBackground {
+    color?: string;
+    grid?: {
+        enabled?: boolean;
+        color?: string;
+    };
+}
+interface GraphCustomChapter {
+    id: string;
+    x: number;
+    y: number;
+}
+interface GraphEditDefaultChapter {
+    flipTo?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    controls?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    hover?: {
+        enabled?: boolean;
+        borderColor?: string;
+        shadowColor?: string;
+    };
+}
+type GraphEditChapter = GraphCustomChapter & GraphEditDefaultChapter;
+interface GraphViewDefaultChapter extends GraphEditDefaultChapter {
+    header?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    watchAgain?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    preview?: {
+        visible?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    goBlind?: boolean;
+}
+type GraphViewChapter = Pick<GraphCustomChapter, "id"> & Partial<Pick<GraphCustomChapter, "x" | "y">> & GraphViewDefaultChapter;
+interface GraphDefaultBranch {
+    display?: boolean;
+    color?: string;
+    connectionColor?: string;
+    actionConnectionColor?: string;
+    actionIconColor?: string;
+    inactionConnectionColor?: string;
+    inactionIconColor?: string;
+    displayActionConnections?: boolean;
+}
+interface GraphBranch extends GraphDefaultBranch {
+    id: string;
+}
+interface GraphEditModeDesign {
+    background?: GraphBackground;
+    defaultChapter?: GraphEditDefaultChapter;
+    chapters: GraphEditChapter[];
+    defaultBranch?: GraphDefaultBranch;
+    branches?: GraphBranch[];
+}
+interface GraphViewModeDesign {
+    background?: GraphBackground;
+    defaultChapter?: GraphViewDefaultChapter;
+    chapters?: GraphViewChapter[];
+    defaultBranch?: GraphDefaultBranch;
+    branches?: GraphBranch[];
+}
+interface GraphDesign {
+    edit: GraphEditModeDesign;
+    view: GraphViewModeDesign;
+}
+
+declare const DEFAULT_MANIFEST_VERSION = "3.3";
+declare const TEST_VERSION_REGEX: RegExp;
+type ManifestVideoVariantType = "custom" | "mp4" | "hls" | "dash" | "mpeg";
+type Extension = Exclude<ManifestVideoVariantType, "custom">;
+type Standard = "144p" | "240p" | "360p" | "480p" | "720p" | "1080p" | "1440p" | "2160p" | "4320p";
+interface CustomManifestVideoVariant {
+    type: Extract<ManifestVideoVariantType, "custom">;
+    payload: {
+        type: string;
+        id: string;
+    };
+}
+interface DefaultManifestVideoVariant {
+    type: Extension;
+    url: string;
+    size?: Nullable<number>;
+    standard?: Nullable<Standard>;
+    resolution?: Nullable<string>;
+    bitrate?: Nullable<number>;
+    cover?: Nullable<string>;
+    preview?: Nullable<string>;
+}
+type ManifestVideoVariant = Omit<DefaultManifestVideoVariant, "type"> & {
+    type: ManifestVideoVariantType;
+    payload?: Nullable<CustomManifestVideoVariant["payload"]>;
+};
+interface ManifestVideo {
+    id: string;
+    duration?: Nullable<number>;
+    shortlink?: Nullable<string>;
+    variants: ManifestVideoVariant[];
+    title?: string;
+}
+type Media = {
+    videos: ManifestVideo[];
+};
+type MediaLink = string;
+interface Metadata {
+    id: string;
+    version: typeof DEFAULT_MANIFEST_VERSION;
+    build: number;
+    initChapterId?: string;
+    created: string;
+    updated: string;
+    types?: Nullable<string[]>;
+    media?: Media | MediaLink;
+}
+interface Manifest_3_3 {
+    metadata: Metadata;
+    media: Media;
+    chapters: Chapter[];
+    graph: GraphDesign;
+}
+
+declare enum ContainerTypes {
+    Choice = "Choice",
+    TextInput = "TextInput"
+}
+declare enum ControlTypes {
+    Button = "Button",
+    Area = "Area",
+    Text = "Text"
+}
+declare enum EventTypes {
+    onClick = "onClick",
+    onSuspense = "onSuspense"
+}
+declare enum EventActionTypes {
+    openURI = "openURI",
+    setNextBranch = "setNextBranch",
+    setWeightlessRandomBranch = "setWeightlessRandomBranch",
+    setRandomBranch = "setRandomBranch",
+    setMaxWeightBranch = "setMaxWeightBranch",
+    setMinWeightBranch = "setMinWeightBranch",
+    setDefaultBranch = "setDefaultBranch",
+    continuePlayback = "continuePlayback",
+    expect = "expect"
+}
+type VideoId = number | string;
+type AnyManifest = Manifest_3_0 | Manifest_3_1 | Manifest_3_2 | Manifest_3_3;
+type AnyChapter = AnyManifest["chapters"][0];
+type AnyContainer = AnyChapter["containers"][0];
+type AnyControl = AnyContainer["controls"][0];
+type Nullable<T> = T | null;
+
+type ControlType = "Text" | "Button" | "Area";
+type ControlEventType = "onClick";
+type ControlActionType = "setNextBranch" | "continuePlayback" | "openURI";
+interface ControlEvent {
+    type: ControlEventType;
+    action: {
+        type: ControlActionType;
+        args: {
+            branchId?: Nullable<string>;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: Nullable<string>;
+        };
+    };
+}
+interface Font {
+    family: string;
+    style: "normal" | "italic";
+    weight: "normal" | "bold" | "lighter" | "bolder";
+}
+interface ControlLayoutParams {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: "video" | "self";
+    alignment?: Nullable<"left" | "right" | "center">;
+    font?: Nullable<Font>;
+}
+interface ControlProps {
+    text?: {
+        value: string;
+        gravityHorizontal: "start" | "end" | "center";
+        gravityVertical: "top" | "bottom" | "center";
+        color: string;
+        alpha: number;
+        size: number;
+        paddings?: {
+            top: number;
+            right: number;
+            bottom: number;
+            left: number;
+        };
+    };
+    background: {
+        type: "color";
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: "rectangle";
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+interface Control {
+    id: string;
+    type: ControlType;
+    label: string;
+    layoutParams: ControlLayoutParams;
+    props: ControlProps;
+    events: ControlEvent[];
+}
+
+type ChapterEventType = "onSuspense";
+type ContainerEventType = "onSuspense";
+type ChapterSuspenseActionType = "setNextBranch" | "setRandomBranch" | "openURI";
+type ContainerSuspenseActionType = "setNextBranch" | "continuePlayback" | "expect" | "openURI";
+interface ChapterEvent {
+    type: ChapterEventType;
+    action: {
+        type: ChapterSuspenseActionType;
+        args: {
+            branchId?: Nullable<string>;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: Nullable<string>;
+        };
+    };
+}
+interface ChapterBranch {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+    isDefault?: boolean;
+}
+interface ContainerEvent {
+    type: ContainerEventType;
+    action: {
+        type: ContainerSuspenseActionType;
+        args: {
+            branchId?: Nullable<string>;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: Nullable<string>;
+        };
+    };
+}
+interface ChapterContainer {
+    id: string;
+    startTime: number;
+    endTime?: number | null;
+    controls: Control[];
+    layout: {
+        type: "Relative";
+    };
+    type: "Choice" | "TextInput";
+    events: ContainerEvent[];
+}
+interface Chapter {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer[];
+    branches: ChapterBranch[];
+    events: ChapterEvent[];
+    label: string;
+    order: "start" | "end" | "simple";
+}
+declare enum ChapterError {
+    NoVideo = 0,
+    NoEOV = 1,
+    NoBranches = 2
+}
+
+export { type Manifest_3_1 as $, type AnyManifest as A, type GraphDefaultBranch as B, type Chapter as C, type GraphBranch as D, DEFAULT_MANIFEST_VERSION as E, type Font as F, type GraphCustomChapter as G, type ManifestVideoVariantType as H, type Extension as I, type CustomManifestVideoVariant as J, type DefaultManifestVideoVariant as K, type ManifestVideoVariant as L, type Manifest_3_3 as M, type ManifestVideo as N, type MediaLink as O, ContainerTypes as P, ControlTypes as Q, EventTypes as R, type Standard as S, TEST_VERSION_REGEX as T, EventActionTypes as U, type VideoId as V, type AnyChapter as W, type AnyContainer as X, type AnyControl as Y, type Nullable as Z, type Manifest_3_0 as _, ChapterError as a, type Manifest_3_2 as a0, type ChapterBranch as b, type ContainerSuspenseActionType as c, type ContainerEvent as d, type Control as e, type ChapterSuspenseActionType as f, type ChapterContainer as g, type ControlType as h, type ControlEventType as i, type ControlActionType as j, type ControlEvent as k, type GraphDesign as l, type Metadata as m, type Media as n, type GraphEditModeDesign as o, type GraphEditChapter as p, type GraphViewModeDesign as q, type GraphViewChapter as r, type ChapterEventType as s, type ContainerEventType as t, type ChapterEvent as u, type ControlLayoutParams as v, type ControlProps as w, type GraphBackground as x, type GraphEditDefaultChapter as y, type GraphViewDefaultChapter as z };