@car-cutter/react-webplayer 0.4.2 → 0.6.0

package/dist/index.d.ts

@@ -1,6 +1,21 @@
 import { FC } from 'react';
 
-export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:";
+declare type AspectRatio = `${number}:${number}`;
+
+declare type Category = {
+    id: string;
+    title: string;
+    items: Item[];
+};
+
+export declare type Composition = {
+    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";
 
@@ -20,8 +35,58 @@ 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 ImageItem = { type: "image" } & ImageWithHotspots;
+
 declare type ImageLoadStrategy = "quality" | "speed";
 
+declare type ImageWidth = number;
+
+declare type ImageWithHotspots = {
+    src: string;
+    hotspots?: Hotspot[];
+};
+
+declare type Item = ImageItem | VideoItem | ThreeSixtyItem;
+
+declare type ThreeSixtyItem = {
+    type: "360";
+    images: ImageWithHotspots[];
+};
+
+declare type VideoItem = {
+    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";
@@ -36,9 +101,9 @@ export declare type WebPlayerIconProps = {
 };
 
 export declare type WebPlayerProps = WebPlayerProps_2 & {
-    onCompositionLoading?: () => void;
-    onCompositionLoaded?: () => void;
-    onCompositionLoadError?: () => void;
+    onCompositionLoading?: (url: string) => void;
+    onCompositionLoaded?: (composition: Composition) => void;
+    onCompositionLoadError?: (error: unknown) => void;
     onExtendModeOn?: () => void;
     onExtendModeOff?: () => void;
     onHotspotsOn?: () => void;
@@ -49,7 +114,7 @@ export declare type WebPlayerProps = WebPlayerProps_2 & {
 
 declare type WebPlayerProps_2 = {
     compositionUrl: string;
-    flatten?: boolean;
+    hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
     imageLoadStrategy?: ImageLoadStrategy;