@car-cutter/wc-webplayer 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export declare type Composition = {
     categories: Category[];
 };
 
-export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:";
+export declare const DEFAULT_EVENT_PREFIX: string = "cc-webplayer:";
 
 /**
  * Defines WebPlayer's custom elements in the DOM.
@@ -51,6 +51,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;
@@ -113,7 +127,7 @@ export declare const webPlayerIconPropsToAttributes: (props: WebPlayerIconProps_
 
 export declare type WebPlayerProps = {
     compositionUrl: string;
-    flatten?: boolean;
+    hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
     imageLoadStrategy?: ImageLoadStrategy;
@@ -126,7 +140,7 @@ export declare type WebPlayerProps = {
 
 declare type WebPlayerProps_2 = {
     compositionUrl: string;
-    flatten?: boolean;
+    hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
     imageLoadStrategy?: ImageLoadStrategy_2;