@car-cutter/vue-webplayer 0.4.2 → 0.6.0

package/dist/index.d.ts

@@ -1,21 +1,39 @@
 import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
 import { DefineComponent } from 'vue';
-import { ExtractPropTypes } from 'vue';
-import { PropType } from 'vue';
 import { PublicProps } from 'vue';
 
-declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+declare type AspectRatio = `${number}:${number}`;
 
-declare type __VLS_TypePropsToOption<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: PropType<T[K]>;
-        required: true;
-    };
+declare type AspectRatio_2 = `${number}:${number}`;
+
+declare type Category = {
+    id: string;
+    title: string;
+    items: Item[];
 };
 
-export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:";
+declare type Category_2 = {
+    id: string;
+    title: string;
+    items: Item_2[];
+};
+
+export declare type Composition = {
+    aspectRatio: AspectRatio_2;
+    imageHdWidth: ImageWidth_2;
+    imageSubWidths: ImageWidth_2[];
+    categories: Category_2[];
+};
+
+declare type Composition_2 = {
+    aspectRatio: AspectRatio;
+    imageHdWidth: ImageWidth;
+    imageSubWidths: ImageWidth[];
+    categories: Category[];
+};
+
+export declare const DEFAULT_EVENT_PREFIX: string = "cc-webplayer:";
 
 export declare const EVENT_COMPOSITION_LOAD_ERROR = "composition-load-error";
 
@@ -35,38 +53,124 @@ export declare const EVENT_HOTSPOTS_OFF = "hotspots-off";
 
 export declare const EVENT_HOTSPOTS_ON = "hotspots-on";
 
+/**
+ * Generates a URL for fetching the composition JSON for a given customer and vehicle.
+ *
+ * @param {string} customerId - The ID of the customer.
+ * @param {string} vin - The Vehicle Identification Number.
+ * @returns {string} The URL to fetch the composition JSON.
+ */
+export declare function generateCompositionUrl(
+customerId: string,
+vin: string
+): string {
+    return `https://cdn.car-cutter.com/gallery/${customerId}/${vin}/composition_v3.json`;
+}
+
+declare type Hotspot = {
+    title: string;
+    icon?: string;
+    description?: string;
+    position: {
+        x: number;
+        y: number;
+    };
+    detail?: {
+        type: "image" | "link" | "pdf";
+        src: string;
+    };
+};
+
+declare type Hotspot_2 = {
+    title: string;
+    icon?: string;
+    description?: string;
+    position: {
+        x: number;
+        y: number;
+    };
+    detail?: {
+        type: "image" | "link" | "pdf";
+        src: string;
+    };
+};
+
+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[];
+};
+
+declare type ImageWithHotspots_2 = {
+    src: string;
+    hotspots?: Hotspot_2[];
+};
+
+declare type Item = ImageItem | VideoItem | ThreeSixtyItem;
+
+declare type Item_2 = ImageItem_2 | VideoItem_2 | ThreeSixtyItem_2;
+
+declare type ThreeSixtyItem = {
+    type: "360";
+    images: ImageWithHotspots[];
+};
+
+declare type ThreeSixtyItem_2 = {
+    type: "360";
+    images: ImageWithHotspots_2[];
+};
+
+declare type VideoItem = {
+    type: "video";
+    src: string;
+    poster: string;
+};
+
+declare type VideoItem_2 = {
+    type: "video";
+    src: 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<__VLS_TypePropsToOption<WebPlayerProps>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-compositionLoading: () => void;
-compositionLoaded: () => void;
-compositionLoadError: () => void;
-extendModeOn: () => void;
-extendModeOff: () => void;
-hotspotsOn: () => void;
-hotspotsOff: () => void;
-galleryOpen: () => void;
-galleryClose: () => void;
-}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToOption<WebPlayerProps>>> & {
-onCompositionLoading?: (() => any) | undefined;
-onCompositionLoaded?: (() => any) | undefined;
-onCompositionLoadError?: (() => any) | undefined;
+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 type WebPlayerEvents = {
-    compositionLoading: [];
-    compositionLoaded: [];
-    compositionLoadError: [];
+    compositionLoading: [url: string];
+    compositionLoaded: [composition: Composition_2];
+    compositionLoadError: [error: unknown];
     extendModeOn: [];
     extendModeOff: [];
     hotspotsOn: [];
@@ -77,7 +181,7 @@ export declare type WebPlayerEvents = {
 
 export declare type WebPlayerProps = {
     compositionUrl: string;
-    flatten?: boolean;
+    hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
     imageLoadStrategy?: ImageLoadStrategy;