@vkontakte/videoplayer-interactive 1.0.19-dev.d432d6cd.0 → 1.0.19-dev.d6f5a76a.0

package/types/movika.core/manifest/index.d.ts

@@ -0,0 +1,24 @@
+import type { Chapter as Chapter_3_2, ChapterContainer as ChapterContainer_3_2, ChapterBranch as ChapterBranch_3_2 } from './manifest_3_2/chapter';
+import type { Manifest_3_2, ManifestVideo as ManifestVideo_3_2, ManifestVideoVariant as ManifestVideoVariant_3_2, Media as Media_3_2, Metadata as Metadata_3_2 } from './manifest_3_2/manifest';
+import type { Chapter as Chapter_3_3, ChapterContainer as ChapterContainer_3_3, ChapterBranch as ChapterBranch_3_3 } from './manifest_3_3/chapter';
+import type { Manifest_3_3, ManifestVideo as ManifestVideo_3_3, ManifestVideoVariant as ManifestVideoVariant_3_3, Media as Media_3_3, Metadata as Metadata_3_3, ManifestVideoVariantType, Extensions, Standard } from './manifest_3_3/manifest';
+import type { Control, ControlLayoutParams } from './manifest_3_3/control';
+export type Container = ChapterContainer_3_2 | ChapterContainer_3_3;
+export type Media = Media_3_2 | Media_3_3;
+export type Chapter = Chapter_3_2 | Chapter_3_3;
+export type Manifest = Manifest_3_2 | Manifest_3_3;
+export type Metadata = Metadata_3_2 | Metadata_3_3;
+export type ManifestVideo = ManifestVideo_3_2 | ManifestVideo_3_3;
+export type ManifestVideoVariant = ManifestVideoVariant_3_2 | ManifestVideoVariant_3_3;
+export type ChapterBranch = ChapterBranch_3_2 | ChapterBranch_3_3;
+export type { ManifestVideoVariantType, Extensions, Standard };
+export type LatestMedia = Media_3_3;
+export type LatestManifestVideo = ManifestVideo_3_3;
+export type LatestChapter = Chapter_3_3;
+export type LatestManifest = Manifest_3_3;
+export type LatestContainer = ChapterContainer_3_3;
+export type LatestControl = Control;
+export type LatestControlLayoutParams = ControlLayoutParams;
+export * from './migrations';
+export * from './types';
+export * from './utils';

package/types/movika.core/manifest/manifest_3_2/chapter.d.ts

@@ -0,0 +1,62 @@
+import type { Control } from './control';
+export type ChapterEventType = 'onSuspense';
+export type ContainerEventType = 'onSuspense';
+export type ChapterSuspenseActionType = 'setNextBranch' | 'setWeightlessRandomBranch' | 'setRandomBranch' | 'setMaxWeightBranch' | 'setMinWeightBranch' | 'setDefaultBranch' | 'continuePlayback' | 'openURI';
+export type ContainerSuspenseActionType = 'setNextBranch' | 'continuePlayback';
+export interface ChapterEvent {
+    type: ChapterEventType;
+    action: {
+        type: ChapterSuspenseActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+export interface ChapterBranch {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+}
+export interface ContainerEvent {
+    type: ContainerEventType;
+    action: {
+        type: ContainerSuspenseActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: string;
+        };
+    };
+}
+export interface ChapterContainer {
+    id: string;
+    /**
+     * Interactivity start time in milliseconds
+     */
+    startTime: number;
+    /**
+     * Interactivity end time in milliseconds
+     */
+    endTime?: number | null;
+    controls: Control[];
+    layout: {
+        type: 'Relative';
+    };
+    type: 'Choice' | 'TextInput';
+    events?: ContainerEvent[];
+}
+export interface Chapter {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer[];
+    branches: ChapterBranch[];
+    events?: ChapterEvent[];
+    label: string;
+    x: number;
+    y: number;
+    order: 'start' | 'end' | 'simple';
+}

package/types/movika.core/manifest/manifest_3_2/control.d.ts

@@ -0,0 +1,67 @@
+export type ControlType = 'Text' | 'Button' | 'Area';
+export type ControlEventType = 'onClick';
+export type ControlActionType = 'setNextBranch' | 'continuePlayback' | 'openURI';
+export interface ControlEvent {
+    type: ControlEventType;
+    action: {
+        type: ControlActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: string;
+        };
+    };
+}
+export interface ControlLayoutParams {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: 'video' | 'self';
+}
+export 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;
+        };
+        /**
+         * @deprecated accepted but no one uses
+         */
+        alignment?: 'left' | 'right' | 'center';
+    };
+    background: {
+        type: 'color';
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: 'rectangle';
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+export interface Control {
+    id: string;
+    type: 'Button' | 'Area';
+    label: string;
+    subtype: ControlType;
+    layoutParams: ControlLayoutParams;
+    props: ControlProps;
+    events?: ControlEvent[];
+}

package/types/movika.core/manifest/manifest_3_2/manifest.d.ts

@@ -0,0 +1,50 @@
+import type { Chapter } from './chapter';
+export type ManifestVideoVariantType = 'custom' | 'mp4' | 'hls' | 'dash' | 'mpeg';
+export type Extensions = Exclude<ManifestVideoVariantType, 'custom'>;
+export type Standard = '144p' | '240p' | '360p' | '480p' | '720p' | '1080p' | '1440p' | '2160p' | '4320p';
+export interface CustomManifestVideoVariant {
+    type: Extract<ManifestVideoVariantType, 'custom'>;
+    payload: {
+        type: string;
+        id: string;
+    };
+}
+export interface DefaultManifestVideoVariant {
+    type: Extensions;
+    url: string;
+    size?: number | null;
+    standard?: Standard | null;
+    resolution?: string | null;
+    bitrate?: number | null;
+    cover?: string | null;
+    preview?: string | null;
+}
+export type ManifestVideoVariant = CustomManifestVideoVariant | DefaultManifestVideoVariant;
+export interface ManifestVideo {
+    id: string;
+    duration?: number | null;
+    shortlink?: string | null;
+    variants: ManifestVideoVariant[];
+    title?: string;
+}
+export type Media = {
+    videos: ManifestVideo[];
+};
+export interface Metadata {
+    id: string;
+    version: '3.2';
+    build: number;
+    initChapterId?: string;
+    created: string;
+    updated: string;
+    types?: string[];
+    /**
+     * @deprecated
+     */
+    media?: Media | string;
+}
+export interface Manifest_3_2 {
+    metadata: Metadata;
+    media: Media;
+    chapters: Chapter[];
+}

package/types/movika.core/manifest/manifest_3_2/template.d.ts

@@ -0,0 +1,34 @@
+export interface ManifestDataTemplate {
+    /**
+     * uuid
+     */
+    id: string;
+    /**
+     * Template name
+     */
+    name: string;
+    /**
+     * Chapter type this template can be applied to
+     */
+    chapterType: 'start' | 'simple' | 'end';
+    /**
+     * Template includes stringified JSON object that applied to chapter
+     */
+    template: string;
+    /**
+     * Template data type to apply to
+     */
+    type: 'container';
+    /**
+     * Manifest version of template
+     */
+    manifestVersion: string;
+    /**
+     * Date when template was created
+     */
+    created?: number;
+    /**
+     * Date when template was updated
+     */
+    updated?: number;
+}

package/types/movika.core/manifest/manifest_3_3/chapter.d.ts

@@ -0,0 +1,70 @@
+import type { Control } from './control';
+export type ChapterEventType = 'onSuspense';
+export type ContainerEventType = 'onSuspense';
+export type ChapterSuspenseActionType = 'setNextBranch' | 'setWeightlessRandomBranch' | 'setRandomBranch' | 'setMaxWeightBranch' | 'setMinWeightBranch' | 'setDefaultBranch' | 'continuePlayback' | 'openURI' | 'expect';
+export type ContainerSuspenseActionType = 'setNextBranch' | 'continuePlayback' | 'expect';
+export interface ChapterEvent {
+    type: ChapterEventType;
+    action: {
+        type: ChapterSuspenseActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: string;
+        };
+    };
+}
+export interface ChapterBranch {
+    id: string;
+    chapterId: string;
+    weight?: number;
+    manifestUrl?: string;
+}
+export interface ContainerEvent {
+    type: ContainerEventType;
+    action: {
+        type: ContainerSuspenseActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+        };
+    };
+}
+export interface ChapterContainer {
+    id: string;
+    /**
+     * Interactivity start time in milliseconds
+     */
+    startTime: number;
+    /**
+     * Interactivity end time in milliseconds
+     */
+    endTime?: number | null;
+    controls: Control[];
+    layout: {
+        type: 'Relative';
+    };
+    type: 'Choice' | 'TextInput';
+    events?: ContainerEvent[];
+}
+export interface Chapter {
+    id: string;
+    videoId?: string;
+    containers: ChapterContainer[];
+    branches: ChapterBranch[];
+    events?: ChapterEvent[];
+    label: string;
+    order: 'start' | 'end' | 'simple';
+}
+/**
+ * ------------ WARNING! ------------
+ * This is editor specific type only.
+ * Not used in stored manifest
+ */
+export declare enum ChapterError {
+    NoVideo = 0,
+    NoEOV = 1,
+    NoBranches = 2
+}

package/types/movika.core/manifest/manifest_3_3/control.d.ts

@@ -0,0 +1,66 @@
+export type ControlType = 'Text' | 'Button' | 'Area';
+export type ControlEventType = 'onClick';
+export type ControlActionType = 'setNextBranch' | 'continuePlayback' | 'openURI';
+export interface ControlEvent {
+    type: ControlEventType;
+    action: {
+        type: ControlActionType;
+        args: {
+            branchId?: string;
+            shouldOpenNow: boolean;
+            isDetachContainer?: boolean;
+            uri?: string;
+        };
+    };
+}
+export interface ControlLayoutParams {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    angle: number;
+    innerSizesDependOn?: 'video' | 'self';
+}
+export 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;
+        };
+        /**
+         * @deprecated accepted but no one uses
+         */
+        alignment?: 'left' | 'right' | 'center';
+    };
+    background: {
+        type: 'color';
+        color: string;
+        alpha: number;
+        src?: string;
+    };
+    shape: {
+        type: 'rectangle';
+        roundCorners: number;
+        border: {
+            width: number;
+            color: string;
+            alpha: number;
+        };
+    };
+}
+export interface Control {
+    id: string;
+    type: ControlType;
+    label: string;
+    layoutParams: ControlLayoutParams;
+    props: ControlProps;
+    events?: ControlEvent[];
+}

package/types/movika.core/manifest/manifest_3_3/graph.d.ts

@@ -0,0 +1,73 @@
+export interface GraphBackground {
+    color?: string;
+    grid?: {
+        enabled?: boolean;
+        color?: string;
+    };
+}
+export interface GraphCustomChapter {
+    id: string;
+    x: number;
+    y: number;
+}
+export interface GraphEditDefaultChapter {
+    flipTo?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    controls?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    hover?: {
+        enabled?: boolean;
+        borderColor?: string;
+        shadowColor?: string;
+    };
+}
+export type GraphEditChapter = GraphCustomChapter & GraphEditDefaultChapter;
+export interface GraphViewDefaultChapter extends GraphEditDefaultChapter {
+    watchAgain?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    preview?: {
+        enabled?: boolean;
+        backgroundColor?: string;
+        textColor?: string;
+    };
+    goBlind?: boolean;
+}
+export type GraphViewChapter = Pick<GraphCustomChapter, 'id'> & Partial<Pick<GraphCustomChapter, 'x' | 'y'>> & GraphViewDefaultChapter;
+export interface GraphDefaultBranch {
+    display?: boolean;
+    color?: string;
+    connectionColor?: string;
+    actionConnectionColor?: string;
+    actionIconColor?: string;
+    inactionConnectionColor?: string;
+    inactionIconColor?: string;
+    displayActionConnections?: boolean;
+}
+export interface GraphBranch extends GraphDefaultBranch {
+    id: string;
+}
+export interface GraphDesign {
+    edit: {
+        background?: GraphBackground;
+        defaultChapter?: GraphEditDefaultChapter;
+        chapters: GraphEditChapter[];
+        defaultBranch?: GraphDefaultBranch;
+        branches?: GraphBranch[];
+    };
+    view: {
+        background?: GraphBackground;
+        defaultChapter?: GraphViewDefaultChapter;
+        chapters?: GraphViewChapter[];
+        defaultBranch?: GraphDefaultBranch;
+        branches?: GraphBranch[];
+    };
+}

package/types/movika.core/manifest/manifest_3_3/manifest.d.ts

@@ -0,0 +1,52 @@
+import type { Chapter } from './chapter';
+import type { GraphDesign } from './graph';
+export type ManifestVideoVariantType = 'custom' | 'mp4' | 'hls' | 'dash' | 'mpeg';
+export type Extensions = Exclude<ManifestVideoVariantType, 'custom'>;
+export type Standard = '144p' | '240p' | '360p' | '480p' | '720p' | '1080p' | '1440p' | '2160p' | '4320p';
+export interface CustomManifestVideoVariant {
+    type: Extract<ManifestVideoVariantType, 'custom'>;
+    payload: {
+        type: string;
+        id: string;
+    };
+}
+export interface DefaultManifestVideoVariant {
+    type: Extensions;
+    url: string;
+    size?: number | null;
+    standard?: Standard | null;
+    resolution?: string | null;
+    bitrate?: number | null;
+    cover?: string | null;
+    preview?: string | null;
+}
+export type ManifestVideoVariant = CustomManifestVideoVariant | DefaultManifestVideoVariant;
+export interface ManifestVideo {
+    id: string;
+    duration?: number | null;
+    shortlink?: string | null;
+    variants: ManifestVideoVariant[];
+    title?: string;
+}
+export type Media = {
+    videos: ManifestVideo[];
+};
+export interface Metadata {
+    id: string;
+    version: '3.3';
+    build: number;
+    initChapterId?: string;
+    created: string;
+    updated: string;
+    types?: string[];
+    /**
+     * @deprecated
+     */
+    media?: Media | string;
+}
+export interface Manifest_3_3 {
+    metadata: Metadata;
+    media: Media;
+    chapters: Chapter[];
+    graph: GraphDesign;
+}

package/types/movika.core/manifest/manifest_3_3/template.d.ts

@@ -0,0 +1,34 @@
+export interface ManifestDataTemplate {
+    /**
+     * uuid
+     */
+    id: string;
+    /**
+     * Template name
+     */
+    name: string;
+    /**
+     * Chapter type this template can be applied to
+     */
+    chapterType: 'start' | 'simple' | 'end';
+    /**
+     * Template includes stringified JSON object that applied to chapter
+     */
+    template: string;
+    /**
+     * Template data type to apply to
+     */
+    type: 'container';
+    /**
+     * Manifest version of template
+     */
+    manifestVersion: string;
+    /**
+     * Date when template was created
+     */
+    created?: number;
+    /**
+     * Date when template was updated
+     */
+    updated?: number;
+}

package/types/movika.core/manifest/migrations/index.d.ts

@@ -0,0 +1 @@
+export { migrateManifestToLatestVersion } from "./migrateManifestToLatestVersion";

package/types/movika.core/manifest/migrations/migrateManifestToLatestVersion.d.ts

@@ -0,0 +1 @@
+export function migrateManifestToLatestVersion(manifest: any): any;

package/types/movika.core/manifest/migrations/migrate_from_3_0_to_3_1.d.ts

@@ -0,0 +1,21 @@
+export const DEFAULT_MANIFEST_VERSION: "3.1";
+export namespace FALLBACK_STRATEGY_TO_ACTION_TYPE {
+    let _default: string;
+    export { _default as default };
+    export let random: string;
+    export let weightlessRandom: string;
+    export let max: string;
+    export let min: string;
+}
+export namespace defaultEvent {
+    let type: string;
+    namespace action {
+        let type_1: string;
+        export { type_1 as type };
+        export namespace args {
+            let shouldOpenNow: boolean;
+            let isDetachContainer: boolean;
+        }
+    }
+}
+export function migrate_from_3_0_to_3_1(manifest: any): any;

package/types/movika.core/manifest/migrations/migrate_from_3_1_to_3_2.d.ts

@@ -0,0 +1,2 @@
+export const DEFAULT_MANIFEST_VERSION: "3.2";
+export function migrate_from_3_1_to_3_2(manifest: any): any;

package/types/movika.core/manifest/migrations/migrate_from_3_2_to_3_3.d.ts

@@ -0,0 +1,8 @@
+import type { Manifest_3_2 } from '../manifest_3_2/manifest';
+import type { ChapterEvent, ContainerEvent } from '../manifest_3_3/chapter';
+import type { GraphCustomChapter, GraphDesign } from '../manifest_3_3/graph';
+import type { Manifest_3_3 } from '../manifest_3_3/manifest';
+export declare const DEFAULT_MANIFEST_VERSION = "3.3";
+export declare const createDefaultGraphDesign: (chapters?: GraphCustomChapter[] | undefined) => GraphDesign;
+export declare const expectEvent: ContainerEvent & ChapterEvent;
+export declare const migrate_from_3_2_to_3_3: (manifest: Manifest_3_2) => Manifest_3_3;

package/types/movika.core/manifest/types.d.ts

@@ -0,0 +1,29 @@
+export type { Control } from './manifest_3_3/control';
+import type { Chapter } from './manifest_3_3/chapter';
+export declare const containerTypes: Readonly<{
+    Choice: "Choice";
+    TextInput: "TextInput";
+}>;
+export declare const controlTypes: Readonly<{
+    Button: "Button";
+    Area: "Area";
+    Text: "Text";
+}>;
+export declare const eventTypes: Readonly<{
+    onClick: "onClick";
+    onSuspense: "onSuspense";
+}>;
+export declare const eventActionTypes: Readonly<{
+    openURI: "openURI";
+    setNextBranch: "setNextBranch";
+    setWeightlessRandomBranch: "setWeightlessRandomBranch";
+    setRandomBranch: "setRandomBranch";
+    setMaxWeightBranch: "setMaxWeightBranch";
+    setMinWeightBranch: "setMinWeightBranch";
+    setDefaultBranch: "setDefaultBranch";
+    continuePlayback: "continuePlayback";
+    expect: "expect";
+}>;
+export type VideoId = number | string;
+export type ChapterContainers = Chapter['containers'];
+export type { Chapter } from './manifest_3_3/chapter';

package/types/movika.core/manifest/utils.d.ts

@@ -0,0 +1,5 @@
+export function isSupportedManifest(manifestVersion: string): boolean;
+export function isValidManifest(manifest: object): boolean;
+export function isTextControl(controlItem: any): boolean;
+export function isButtonControl(controlItem: any): boolean;
+export function isAreaControl(controlItem: any): boolean;

package/types/utils/LastFrame.d.ts

@@ -1,4 +1,4 @@
-import type { Chapter } from '../manifest';
+import type { Chapter } from '../movika.core/manifest';
 import { LastFrameCanvasAPI } from './LastFrameCanvasAPI';
 type ConstructorParams = {
     parentElement: HTMLElement;

package/types/utils/chapterHelpers.d.ts

@@ -1,4 +1,4 @@
-import type { Manifest, ManifestVideoVariant, ManifestVideo, VideoId } from '../manifest';
+import type { Manifest, ManifestVideoVariant, ManifestVideo, VideoId } from '../movika.core/manifest';
 export declare const chapterIdsToVKVideoIds: (chapterIds: string[], interactiveManifest: Manifest) => number[];
 export declare const getVideoRawIdByMedia: (mediaVideo: ManifestVideo) => string | undefined;
 export declare const isVKVariantItem: (variantItem: ManifestVideoVariant) => boolean;

package/types/utils/extractVkMovieId.d.ts

@@ -1,2 +1,2 @@
-import type { ManifestVideo } from '../manifest';
+import type { ManifestVideo } from '../movika.core/manifest';
 export declare const extractVkMovieId: (media: ManifestVideo) => [] | [string, string];

package/types/manifest/index.d.ts

@@ -1,3 +0,0 @@
-export type { ChapterContainer, ChapterContainer as Container, Chapter, Control, Manifest, ManifestVideo, ManifestVideoVariant, Media, Metadata, VideoInfo, VideoId, CustomManifestVideoVariant, Extension, AnyManifest, AnyControl, GraphEditChapter, GraphViewChapter, ChapterBranch, Standard, ControlLayoutParams, ControlEvent, ContainerEvent, ChapterEvent, } from '@interactiveplatform/movika-graph-editor';
-export { isSupportedManifest, ControlTypes, EventActionTypes, migrateManifestToLatestVersion, compareVersions, } from '@interactiveplatform/movika-graph-editor';
-export * from './utils';

package/types/manifest/utils.d.ts

@@ -1,11 +0,0 @@
-import { EventActionTypes, type AnyManifest, type AnyControl } from '../manifest';
-/**
- * checks manifest object validity
- * @param manifest - manifest to check
- * @returns true is valid, false is invalid
- */
-export declare const isValidManifest: (manifest: AnyManifest) => boolean;
-export declare const isTextControl: (controlItem: AnyControl) => boolean;
-export declare const isButtonControl: (controlItem: AnyControl) => boolean;
-export declare const isAreaControl: (controlItem: AnyControl) => boolean;
-export type EventActionKeys = keyof typeof EventActionTypes;