[email protected]

.eslintrc.cjs

@@ -38,5 +38,6 @@ module.exports = defineConfig({
     "@typescript-eslint/ban-types": "off",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-namespace": ["warn", { allowDeclarations: true }],
   },
 });

docs/src/lib/util.ts

@@ -6,7 +6,7 @@
 export function sortByKey(
   array: Array<object> = [],
   key: string,
-  type: string = "asc"
+  type: string = "asc",
 ) {
   function compare(a: object, b: object) {
     let keyA = a[key];

packages/types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudinary-util/types",
-  "version": "1.5.11",
+  "version": "2.0.0-beta.2",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.cts",

packages/types/src/index.ts

@@ -1,5 +1,9 @@
 export type {
-  CloudinaryResource, CloudinaryResourceAccessMode, CloudinaryResourceContext, CloudinaryResourceDeliveryType, CloudinaryResourceResourceType
+  CloudinaryResource,
+  CloudinaryResourceAccessMode,
+  CloudinaryResourceContext,
+  CloudinaryResourceDeliveryType,
+  CloudinaryResourceResourceType,
 } from "./types/resources.js";
 
 export type {
@@ -14,24 +18,30 @@ export type {
   CloudinaryUploadWidgetInstanceMethods,
   CloudinaryUploadWidgetOptions,
   CloudinaryUploadWidgetResults,
-  CloudinaryUploadWidgetSources
+  CloudinaryUploadWidgetSources,
 } from "./types/cloudinary-upload-widget.js";
 
 export type {
   CloudinaryVideoPlayer,
   CloudinaryVideoPlayerOptionPosterOptions,
   CloudinaryVideoPlayerOptions,
   CloudinaryVideoPlayerOptionsColors,
-  CloudinaryVideoPlayerOptionsLogo, CloudinaryVideoPlayerPlaylistByTagOptions,
-  CloudinaryVideoPlayerPlaylistOptions, CloudinaryVideoPlayerTextTracks, CloudinaryVideoPlayerTextTracksTrack, CloudinaryVideoPlayerTextTracksTrackOptions, CloudinaryVideoPlayerTextTracksTrackOptionsBox,
+  CloudinaryVideoPlayerOptionsLogo,
+  CloudinaryVideoPlayerPlaylistByTagOptions,
+  CloudinaryVideoPlayerPlaylistOptions,
+  CloudinaryVideoPlayerTextTracks,
+  CloudinaryVideoPlayerTextTracksTrack,
+  CloudinaryVideoPlayerTextTracksTrackOptions,
+  CloudinaryVideoPlayerTextTracksTrackOptionsBox,
   CloudinaryVideoPlayerTextTracksTrackOptionsGravity,
-  CloudinaryVideoPlayerTextTracksTrackOptionsTheme
+  CloudinaryVideoPlayerTextTracksTrackOptionsTheme,
 } from "./types/cloudinary-video-player.js";
 
+export type { CloudinaryProductGallery } from "./types/cloudinary-product-gallery.js";
+
 export type {
   CloudinaryAssetConfiguration,
   CloudinaryAssetConfigurationAuthToken,
   CloudinaryAssetConfigurationCloud,
-  CloudinaryAssetConfigurationUrl
+  CloudinaryAssetConfigurationUrl,
 } from "./types/configuration.js";
-

packages/types/src/types/cloudinary-product-gallery.ts

@@ -0,0 +1,135 @@
+export interface CloudinaryProductGallery {
+  // Required parameters
+  cloudName?: string;
+  mediaAssets?:
+    | {
+        publicId?: string;
+        tag?: string;
+        mediaType?: string;
+        resourceType?: string;
+        transformation?: object;
+        thumbnailTransformation?: object;
+        altText?: string;
+        videoPlayerSource?: object;
+      }[]
+    | string[]; // string[] is a list of publicIDs
+  container?: string | HTMLElement;
+
+  // Widget
+  analytics?: boolean;
+  displayProps?: {
+    mode?: "classic" | "expanded";
+    spacing?: number;
+    columns?: number;
+    topOffset?: number;
+    bottomOffset?: number;
+  };
+  focus?: boolean;
+  loaderProps?: {
+    color?: string;
+    opacity?: number;
+    style?: "cloudinary" | "circle" | "custom";
+    url?: string;
+  };
+  placeholderImage?: boolean;
+  sort?: "none" | "asc" | "desc";
+  sortProps?: {
+    source?: string;
+    id?: string;
+    direction?: string;
+  };
+  themeProps?: {
+    primary?: string; // Default: "#FFFFFF"
+    onPrimary?: string; // Default: "#000000"
+    active?: string; // Default: "#0078FF"
+  };
+  viewportBreakpoints?: {
+    breakpoint: number; // Required
+    [key: string]: any; // Other configuration parameters to override
+  }[];
+
+  // Main viewer parameters
+  accessibilityProps?: {
+    mediaAltSource?: string;
+    mediaAltId?: string;
+  };
+  ar3dProps?: {
+    shadows?: boolean;
+    showAR?: boolean;
+  };
+  aspectRatio?:
+    | "square"
+    | "1:1"
+    | "3:4"
+    | "4:3"
+    | "4:6"
+    | "6:4"
+    | "5:7"
+    | "7:5"
+    | "5:8"
+    | "8:5"
+    | "9:16"
+    | "16:9";
+  borderColor?: string;
+  borderWidth?: number;
+  imageBreakpoint?: number;
+  videoBreakpoint?: number;
+  preload?: string[];
+  radius?: number;
+  spinProps?: {
+    animate?: "none" | "start" | "end" | "both";
+    spinDirection?: "clockwise" | "counter-clockwise";
+    disableZoom?: boolean;
+    showTip?: "always" | "never" | "touch";
+    tipPosition?: "top" | "center" | "bottom";
+    tipText?: string; // Default: "Drag to rotate"
+    tipTouchText?: string; // Default: "Swipe to rotate"
+  };
+  startIndex?: number;
+  tipProps?: {
+    textColor?: string;
+    color?: string;
+    radius?: number;
+    opacity?: number;
+  };
+  transition?: "slide" | "fade" | "none";
+  videoProps?: {
+    controls?: string;
+    sound?: boolean;
+    autoplay?: boolean;
+    loop?: boolean;
+    playerType?: string;
+  };
+  zoom?: boolean;
+  zoomProps?: any;
+  zoomPopupProps?: {
+    backdropColor?: string;
+    backdropOpacity?: number;
+    zIndex?: number;
+  };
+
+  // Carousel parameters
+  carouselLocation?: "left" | "right" | "top" | "bottom";
+  carouselOffset?: number;
+  carouselStyle?: "none" | "thumbnails" | "indicators";
+  indicatorProps?: {
+    color?: string;
+    selectedColor?: string;
+    shape?: "round" | "square" | "radius";
+    size?: number;
+    spacing?: number;
+    sticky?: boolean;
+  };
+  thumbnailProps?: any;
+
+  // Navigation parameters
+  navigation?: "none" | "always" | "mouseover";
+  navigationButtonProps?: {
+    shape?: "none" | "round" | "square" | "radius" | "rectangle";
+    iconColor?: string;
+    color?: string;
+    size?: number;
+  };
+  navigationOffset?: number;
+  navigationPosition?: "inside" | "outside" | "offset";
+}

packages/types/src/types/cloudinary-upload-widget.ts

@@ -1,4 +1,4 @@
-import type { CloudinaryResource } from './resources.js';
+import type { CloudinaryResource } from "./resources.js";
 
 // Sourced from: https://cloudinary.com/documentation/upload_widget_reference
 

packages/types/src/types/cloudinary-video-player.ts

@@ -306,9 +306,8 @@ export interface CloudinaryVideoPlayer {
   videojs: {
     cloudinary: {
       dispose: () => void;
-    }
-  }
-
+    };
+  };
 }
 
 export interface CloudinaryVideoPlayerOptionsLogo {
@@ -366,8 +365,10 @@ export interface CloudinaryVideoPlayerTextTracksTrack {
 
 export interface CloudinaryVideoPlayerTextTracks {
   captions?: CloudinaryVideoPlayerTextTracksTrack;
-  options?: CloudinaryVideoPlayerTextTracksTrackOptions
-  subtitles?: CloudinaryVideoPlayerTextTracksTrack | Array<CloudinaryVideoPlayerTextTracksTrack>;
+  options?: CloudinaryVideoPlayerTextTracksTrackOptions;
+  subtitles?:
+    | CloudinaryVideoPlayerTextTracksTrack
+    | Array<CloudinaryVideoPlayerTextTracksTrack>;
 }
 
 export interface CloudinaryVideoPlayerOptions
@@ -442,7 +443,9 @@ export interface CloudinaryVideoPlayerOptions
   };
   analytics?: boolean;
   allowUsageReport?: boolean;
-  cloudinaryAnalytics?: boolean | CloudinaryVideoPlayerOptionsCloudinaryAnalytics;
+  cloudinaryAnalytics?:
+    | boolean
+    | CloudinaryVideoPlayerOptionsCloudinaryAnalytics;
 
   // ------------ Delivery ------------
   cloud_name?: string;
@@ -495,4 +498,4 @@ export interface CloudinaryVideoPlayerOptionsCloudinaryAnalyticsCustomData {
   customData3?: string;
   customData4?: string;
   customData5?: string;
-}
+}

packages/types/src/types/configuration.ts

@@ -23,16 +23,16 @@ export interface CloudinaryAssetConfigurationUrl {
   useRootPath?: boolean;
   forceVersion?: boolean;
   queryParams?: Record<string, string | number | boolean> | string;
-};
+}
 
 export interface CloudinaryAssetConfigurationCloud {
   cloudName?: string;
   apiKey?: string;
   apiSecret?: string;
   authToken?: CloudinaryAssetConfigurationAuthToken;
-};
+}
 
 export interface CloudinaryAssetConfiguration {
   cloud?: CloudinaryAssetConfigurationCloud;
   url?: CloudinaryAssetConfigurationUrl;
-}
+}

packages/types/src/types/resources.ts

@@ -1,5 +1,13 @@
-export type CloudinaryResourceAccessMode = "public" | "authenticated" | (string & {});
-export type CloudinaryResourceResourceType = "image" | "video" | "raw" | "auto" | (string & {});
+export type CloudinaryResourceAccessMode =
+  | "public"
+  | "authenticated"
+  | (string & {});
+export type CloudinaryResourceResourceType =
+  | "image"
+  | "video"
+  | "raw"
+  | "auto"
+  | (string & {});
 export type CloudinaryResourceDeliveryType =
   | "animoto"
   | "asset"
@@ -68,4 +76,4 @@ export interface CloudinaryResource {
   version: number;
   width: number;
   [key: string]: unknown;
-}
+}