@car-cutter/vue-webplayer 0.6.1 → 0.8.0

package/dist/index.d.ts

@@ -3,6 +3,88 @@ import { ComponentProvideOptions } from 'vue';
 import { DefineComponent } from 'vue';
 import { PublicProps } from 'vue';
 
+declare const __VLS_component: DefineComponent<WebPlayerProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+compositionLoading: (url: string) => any;
+compositionLoaded: (composition: Composition_2) => any;
+compositionLoadError: (error: unknown) => any;
+itemChange: (props: {
+index: number;
+item: Item_2;
+}) => any;
+extendModeOn: () => any;
+extendModeOff: () => any;
+hotspotsOn: () => any;
+hotspotsOff: () => any;
+galleryOpen: () => any;
+galleryClose: () => any;
+}, string, PublicProps, Readonly<WebPlayerProps> & Readonly<{
+onCompositionLoading?: ((url: string) => any) | undefined;
+onCompositionLoaded?: ((composition: Composition_2) => any) | undefined;
+onCompositionLoadError?: ((error: unknown) => any) | undefined;
+onItemChange?: ((props: {
+index: number;
+item: Item_2;
+}) => any) | undefined;
+onExtendModeOn?: (() => any) | undefined;
+onExtendModeOff?: (() => any) | undefined;
+onHotspotsOn?: (() => any) | undefined;
+onHotspotsOff?: (() => any) | undefined;
+onGalleryOpen?: (() => any) | undefined;
+onGalleryClose?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare const __VLS_component_2: DefineComponent<WebPlayerCustomMediaProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<WebPlayerCustomMediaProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare const __VLS_component_3: DefineComponent<WebPlayerIconProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<WebPlayerIconProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare function __VLS_template(): {
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+
+declare function __VLS_template_2(): {
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+
+declare function __VLS_template_3(): {
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    attrs: Partial<{}>;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
+
+declare type __VLS_TemplateResult_3 = ReturnType<typeof __VLS_template_3>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_3<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 declare type AspectRatio = `${number}:${number}`;
 
 declare type AspectRatio_2 = `${number}:${number}`;
@@ -10,30 +92,30 @@ declare type AspectRatio_2 = `${number}:${number}`;
 declare type Category = {
     id: string;
     title: string;
-    items: Item[];
+    items: Item_2[];
 };
 
 declare type Category_2 = {
     id: string;
     title: string;
-    items: Item_2[];
+    items: Item[];
 };
 
 export declare type Composition = {
     aspectRatio: AspectRatio_2;
-    imageHdWidth: ImageWidth_2;
-    imageSubWidths: ImageWidth_2[];
+    imageHdWidth: MediaWidth_3;
+    imageSubWidths: MediaWidth_3[];
     categories: Category_2[];
 };
 
 declare type Composition_2 = {
     aspectRatio: AspectRatio;
-    imageHdWidth: ImageWidth;
-    imageSubWidths: ImageWidth[];
+    imageHdWidth: MediaWidth_2;
+    imageSubWidths: MediaWidth_2[];
     categories: Category[];
 };
 
-export declare const DEFAULT_EVENT_PREFIX: string = "cc-webplayer:";
+export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:" satisfies string;
 
 export declare const EVENT_COMPOSITION_LOAD_ERROR = "composition-load-error";
 
@@ -53,6 +135,8 @@ export declare const EVENT_HOTSPOTS_OFF = "hotspots-off";
 
 export declare const EVENT_HOTSPOTS_ON = "hotspots-on";
 
+export declare const EVENT_ITEM_CHANGE = "item-change";
+
 /**
  * Generates a URL for fetching the composition JSON for a given customer and vehicle.
  *
@@ -99,12 +183,6 @@ declare type ImageItem = { type: "image" } & ImageWithHotspots;
 
 declare type ImageItem_2 = { type: "image" } & ImageWithHotspots_2;
 
-declare type ImageLoadStrategy = "quality" | "speed";
-
-declare type ImageWidth = number;
-
-declare type ImageWidth_2 = number;
-
 declare type ImageWithHotspots = {
     src: string;
     hotspots?: Hotspot[];
@@ -115,9 +193,19 @@ declare type ImageWithHotspots_2 = {
     hotspots?: Hotspot_2[];
 };
 
-declare type Item = ImageItem | VideoItem | ThreeSixtyItem;
+export declare type Item = ImageItem_2 | VideoItem_2 | ThreeSixtyItem_2;
+
+declare type Item_2 = ImageItem | VideoItem | ThreeSixtyItem;
+
+export declare type MediaLoadStrategy = "quality" | "balanced" | "speed";
 
-declare type Item_2 = ImageItem_2 | VideoItem_2 | ThreeSixtyItem_2;
+declare type MediaLoadStrategy_2 = "quality" | "balanced" | "speed";
+
+declare type MediaWidth = number;
+
+declare type MediaWidth_2 = number;
+
+declare type MediaWidth_3 = number;
 
 declare type ThreeSixtyItem = {
     type: "360";
@@ -132,45 +220,36 @@ declare type ThreeSixtyItem_2 = {
 declare type VideoItem = {
     type: "video";
     src: string;
-    poster: string;
+    poster?: string;
 };
 
 declare type VideoItem_2 = {
     type: "video";
     src: string;
-    poster: string;
+    poster?: string;
 };
 
 export declare const WEB_PLAYER_ICON_WC_TAG = "cc-webplayer-icon";
 
 export declare const WEB_PLAYER_WC_TAG = "cc-webplayer";
 
-export declare const WebPlayer: DefineComponent<WebPlayerProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-compositionLoading: (url: string) => any;
-compositionLoaded: (composition: Composition_2) => any;
-compositionLoadError: (error: unknown) => any;
-extendModeOn: () => any;
-extendModeOff: () => any;
-hotspotsOn: () => any;
-hotspotsOff: () => any;
-galleryOpen: () => any;
-galleryClose: () => any;
-}, string, PublicProps, Readonly<WebPlayerProps> & Readonly<{
-onCompositionLoading?: ((url: string) => any) | undefined;
-onCompositionLoaded?: ((composition: Composition_2) => any) | undefined;
-onCompositionLoadError?: ((error: unknown) => any) | undefined;
-onExtendModeOn?: (() => any) | undefined;
-onExtendModeOff?: (() => any) | undefined;
-onHotspotsOn?: (() => any) | undefined;
-onHotspotsOff?: (() => any) | undefined;
-onGalleryOpen?: (() => any) | undefined;
-onGalleryClose?: (() => any) | undefined;
-}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+export declare const WebPlayer: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare const WebPlayerCustomMedia: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
+export declare type WebPlayerCustomMediaProps = {
+    index: number;
+    thumbnailSrc?: string;
+};
 
 export declare type WebPlayerEvents = {
     compositionLoading: [url: string];
     compositionLoaded: [composition: Composition_2];
     compositionLoadError: [error: unknown];
+    itemChange: [props: {
+        index: number;
+        item: Item_2;
+    }];
     extendModeOn: [];
     extendModeOff: [];
     hotspotsOn: [];
@@ -179,14 +258,28 @@ export declare type WebPlayerEvents = {
     galleryClose: [];
 };
 
-export declare type WebPlayerProps = {
+export declare const WebPlayerIcon: __VLS_WithTemplateSlots_3<typeof __VLS_component_3, __VLS_TemplateResult_3["slots"]>;
+
+declare type WebPlayerIconName = "UI_ARROW_RIGHT" | "UI_BURGER" | "UI_CLOSE" | "UI_EXTEND" | "UI_GALLERY" | "UI_HOTSPOTS" | "UI_IMAGE" | "UI_MINUS" | "UI_PAUSE" | "UI_PLAY" | "UI_PLUS" | "UI_REDUCE" | "UI_360" | "UI_VOLUME" | "UI_VOLUME_OFF" | "CONTROLS_PREV" | "CONTROLS_NEXT" | (string & {});
+
+export declare type WebPlayerIconProps = {
+    name: WebPlayerIconName;
+};
+
+export declare type WebPlayerProps = WebPlayerProps_2 & {
+    class?: string;
+    style?: HTMLElement["style"];
+};
+
+declare type WebPlayerProps_2 = {
     compositionUrl: string;
     hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
-    imageLoadStrategy?: ImageLoadStrategy;
-    minImageWidth?: number;
-    maxImageWidth?: number;
+    mediaLoadStrategy?: MediaLoadStrategy_2;
+    minMediaWidth?: MediaWidth;
+    maxMediaWidth?: MediaWidth;
+    preloadRange?: number;
     preventFullScreen?: boolean;
     eventPrefix?: string;
     reverse360?: boolean;