@car-cutter/vue-webplayer 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -1,20 +1,8 @@
 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 __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 = `${number}:${number}`;
 
 declare type AspectRatio_2 = `${number}:${number}`;
@@ -45,7 +33,7 @@ declare type Composition_2 = {
     categories: Category[];
 };
 
-export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:";
+export declare const DEFAULT_EVENT_PREFIX: string = "cc-webplayer:";
 
 export declare const EVENT_COMPOSITION_LOAD_ERROR = "composition-load-error";
 
@@ -65,6 +53,20 @@ 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;
@@ -143,17 +145,17 @@ 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: (url: string) => void;
-compositionLoaded: (composition: Composition_2) => void;
-compositionLoadError: (error: unknown) => void;
-extendModeOn: () => void;
-extendModeOff: () => void;
-hotspotsOn: () => void;
-hotspotsOff: () => void;
-galleryOpen: () => void;
-galleryClose: () => void;
-}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToOption<WebPlayerProps>>> & {
+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;
@@ -163,7 +165,7 @@ onHotspotsOn?: (() => any) | undefined;
 onHotspotsOff?: (() => any) | undefined;
 onGalleryOpen?: (() => any) | undefined;
 onGalleryClose?: (() => any) | undefined;
-}, {}, {}>;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 export declare type WebPlayerEvents = {
     compositionLoading: [url: string];
@@ -179,7 +181,7 @@ export declare type WebPlayerEvents = {
 
 export declare type WebPlayerProps = {
     compositionUrl: string;
-    flatten?: boolean;
+    hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
     imageLoadStrategy?: ImageLoadStrategy;