@car-cutter/wc-webplayer 0.6.1 → 0.8.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 declare type AspectRatio = `${number}:${number}`;
 
-declare type CamelToKebab<S extends string> = S extends `${infer T}${infer U}` ? `${T extends Lowercase<T> ? "" : "-"}${Lowercase<T>}${CamelToKebab<U>}` : S;
+declare type CamelToDashed<S extends string> = S extends `${infer T}${infer U}` ? `${T extends Lowercase<T> ? "" : "-"}${Lowercase<T>}${CamelToDashed<U>}` : S;
 
 declare type Category = {
     id: string;
@@ -15,12 +15,12 @@ export declare function checkCustomElementsDefinition(): boolean;
 
 export declare type Composition = {
     aspectRatio: AspectRatio;
-    imageHdWidth: ImageWidth;
-    imageSubWidths: ImageWidth[];
+    imageHdWidth: MediaWidth;
+    imageSubWidths: MediaWidth[];
     categories: Category[];
 };
 
-export declare const DEFAULT_EVENT_PREFIX: string = "cc-webplayer:";
+export declare const DEFAULT_EVENT_PREFIX = "cc-webplayer:" satisfies string;
 
 /**
  * Defines WebPlayer's custom elements in the DOM.
@@ -51,6 +51,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.
  *
@@ -81,76 +83,79 @@ declare type Hotspot = {
 
 declare type ImageItem = { type: "image" } & ImageWithHotspots;
 
-declare type ImageLoadStrategy = "quality" | "speed";
-
-declare type ImageLoadStrategy_2 = "quality" | "speed";
-
-declare type ImageWidth = number;
-
 declare type ImageWithHotspots = {
     src: string;
     hotspots?: Hotspot[];
 };
 
-declare type Item = ImageItem | VideoItem | ThreeSixtyItem;
+export declare type Item = ImageItem | VideoItem | ThreeSixtyItem;
+
+export declare type MediaLoadStrategy = "quality" | "balanced" | "speed";
+
+declare type MediaLoadStrategy_2 = "quality" | "balanced" | "speed";
+
+declare type MediaWidth = number;
+
+declare type MediaWidth_2 = number;
+
+declare type PropsToAttributes<T> = {
+    [K in keyof T as CamelToDashed<string & K>]: ToStringOrOptional<T[K]>;
+};
 
 declare type ThreeSixtyItem = {
     type: "360";
     images: ImageWithHotspots[];
 };
 
+declare type ToStringOrOptional<T> = T extends undefined ? string | undefined : string;
+
 declare type VideoItem = {
     type: "video";
     src: string;
-    poster: string;
+    poster?: string;
 };
 
+export declare const WEB_PLAYER_CUSTOM_MEDIA_WC_TAG = "cc-webplayer-custom-media";
+
 export declare const WEB_PLAYER_ICON_WC_TAG = "cc-webplayer-icon";
 
 export declare const WEB_PLAYER_WC_TAG = "cc-webplayer";
 
-export declare type WebPlayerAttributes = Record<CamelToKebab<keyof WebPlayerProps_2>, string>;
+export declare type WebPlayerAttributes = PropsToAttributes<WebPlayerProps>;
 
-export declare type WebPlayerIconAttributes = Record<CamelToKebab<keyof WebPlayerIconProps_2>, string>;
+export declare type WebPlayerCustomMediaAttributes = PropsToAttributes<WebPlayerCustomMediaProps>;
 
-export declare type WebPlayerIconProps = {
-    name: string;
-    color?: string;
+declare type WebPlayerCustomMediaProps = {
+    index: number;
+    thumbnailSrc?: string;
 };
 
-declare type WebPlayerIconProps_2 = {
-    name: string;
-    color?: string;
-};
+export declare const webPlayerCustomMediaPropsToAttributes: (props: WebPlayerCustomMediaProps) => WebPlayerCustomMediaAttributes;
 
-export declare const webPlayerIconPropsToAttributes: (props: WebPlayerIconProps_2) => WebPlayerIconAttributes;
+export declare type WebPlayerIconAttributes = PropsToAttributes<WebPlayerIconProps>;
 
-export declare type WebPlayerProps = {
-    compositionUrl: string;
-    hideCategories?: boolean;
-    infiniteCarrousel?: boolean;
-    permanentGallery?: boolean;
-    imageLoadStrategy?: ImageLoadStrategy;
-    minImageWidth?: number;
-    maxImageWidth?: number;
-    preventFullScreen?: boolean;
-    eventPrefix?: string;
-    reverse360?: boolean;
+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 & {});
+
+declare type WebPlayerIconProps = {
+    name: WebPlayerIconName;
 };
 
-declare type WebPlayerProps_2 = {
+export declare const webPlayerIconPropsToAttributes: (props: WebPlayerIconProps) => WebPlayerIconAttributes;
+
+declare type WebPlayerProps = {
     compositionUrl: string;
     hideCategories?: boolean;
     infiniteCarrousel?: boolean;
     permanentGallery?: boolean;
-    imageLoadStrategy?: ImageLoadStrategy_2;
-    minImageWidth?: number;
-    maxImageWidth?: number;
+    mediaLoadStrategy?: MediaLoadStrategy_2;
+    minMediaWidth?: MediaWidth_2;
+    maxMediaWidth?: MediaWidth_2;
+    preloadRange?: number;
     preventFullScreen?: boolean;
     eventPrefix?: string;
     reverse360?: boolean;
 };
 
-export declare const webPlayerPropsToAttributes: (props: WebPlayerProps_2) => WebPlayerAttributes;
+export declare const webPlayerPropsToAttributes: (props: WebPlayerProps) => WebPlayerAttributes;
 
 export { }