v6.6.0 - CldVideoPlayer getVideoPlayerOptions (#477)

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [6.6.0-beta.1](https://github.com/cloudinary-community/next-cloudinary/compare/v6.5.2...v6.6.0-beta.1) (2024-05-23)
+
+
+### Features
+
+* CldVideoPlayer - getVideoPlayerOptions ([#477](https://github.com/cloudinary-community/next-cloudinary/issues/477)) ([4ad73c5](https://github.com/cloudinary-community/next-cloudinary/commit/4ad73c5ec881cfa68e0ba65c6ba59ffa057c12f1))
+
 ## [6.5.2](https://github.com/cloudinary-community/next-cloudinary/compare/v6.5.1...v6.5.2) (2024-05-06)
 
 

next-cloudinary/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-cloudinary",
-  "version": "6.5.2",
+  "version": "6.6.0-beta.1",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -16,8 +16,8 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@cloudinary-util/types": "1.0.3",
-    "@cloudinary-util/url-loader": "5.2.2",
+    "@cloudinary-util/types": "1.0.5",
+    "@cloudinary-util/url-loader": "5.3.0",
     "@cloudinary-util/util": "^3.0.0",
     "@tsconfig/recommended": "^1.0.3"
   },

next-cloudinary/src/components/CldVideoPlayer/CldVideoPlayer.tsx

@@ -1,13 +1,11 @@
 import React, {useRef, MutableRefObject, useEffect} from 'react';
 import Script from 'next/script';
 import Head from 'next/head';
-import { parseUrl } from '@cloudinary-util/util';
-import { CloudinaryVideoPlayer, CloudinaryVideoPlayerOptionsLogo, CloudinaryVideoPlayerOptions, } from '@cloudinary-util/types';
+import { CloudinaryVideoPlayer } from '@cloudinary-util/types';
+import { getVideoPlayerOptions } from '@cloudinary-util/url-loader';
 
 import { CldVideoPlayerProps } from './CldVideoPlayer.types';
 
-import { getCldImageUrl } from '../../helpers/getCldImageUrl';
-import { getCldVideoUrl } from '../../helpers/getCldVideoUrl';
 import { getCloudinaryConfig } from "../../lib/cloudinary";
 
 let playerInstances: string[] = [];
@@ -17,56 +15,28 @@ const PLAYER_VERSION = '1.11.1';
 const CldVideoPlayer = (props: CldVideoPlayerProps) => {
 
   const {
-    autoplay,
     className,
-    colors,
     config,
-    controls = true,
-    fontFace,
     height,
     id,
-    language,
-    languages,
-    logo = true,
-    loop = false,
-    muted = false,
     onDataLoad,
     onError,
     onMetadataLoad,
     onPause,
     onPlay,
     onEnded,
-    poster,
-    src,
-    sourceTypes,
-    transformation,
-    quality = 'auto',
     width,
-    ...otherCldVidPlayerOptions
   } = props as CldVideoPlayerProps;
 
-  const playerTransformations = Array.isArray(transformation) ? transformation : [transformation];
-  let publicId: string = src || "";
 
+  const cloudinaryConfig = getCloudinaryConfig(config);
+  const playerOptions = getVideoPlayerOptions(props, cloudinaryConfig);
+  const { publicId } = playerOptions;
 
-  // If the publicId/src is a URL, attempt to parse it as a Cloudinary URL
-  // to get the public ID alone
-
-  if ( publicId.startsWith('http') ) {
-    try {
-      const parts = parseUrl(src);
-      if ( typeof parts?.publicId === 'string' ) {
-        publicId = parts?.publicId;
-      }
-    } catch(e) {}
+  if ( typeof publicId === 'undefined' ) {
+    throw new Error('Video Player requires a Public ID or Cloudinary URL - please specify a src prop');
   }
 
-  // Set default transformations for the player
-
-  playerTransformations.unshift({
-    quality
-  });
-
   // Setup the refs and allow for the caller to pass through their
   // own ref instance
 
@@ -123,95 +93,6 @@ const CldVideoPlayer = (props: CldVideoPlayerProps) => {
   function handleOnLoad() {
     if ( 'cloudinary' in window ) {
       cloudinaryRef.current = window.cloudinary;
-      let logoOptions: CloudinaryVideoPlayerOptionsLogo = {};
-
-      if ( typeof logo === 'boolean' ) {
-        logoOptions.showLogo = logo;
-      } else if ( typeof logo === 'object' ) {
-        logoOptions = {
-          ...logoOptions,
-          showLogo: true,
-          logoImageUrl: logo.imageUrl,
-          logoOnclickUrl: logo.onClickUrl
-        }
-      }
-
-      // Parse the value passed to 'autoplay';
-      // if its a boolean or a boolean passed as string ("true") set it directly to browser standard prop autoplay else fallback to default;
-      // if its a string and not a boolean passed as string ("true") set it to cloudinary video player autoplayMode prop else fallback to undefined;
-
-      let autoPlayValue: boolean | 'true' | 'false' = false;
-      let autoplayModeValue: string | undefined = undefined;
-
-      if (typeof autoplay === 'boolean' || autoplay === 'true' || autoplay === 'false') {
-        autoPlayValue = autoplay
-      }
-
-      if (typeof autoplay === 'string' && autoplay !== 'true' && autoplay !== 'false') {
-        autoplayModeValue = autoplay;
-      }
-
-      const cloudinaryConfig = getCloudinaryConfig(config);
-      const { cloudName } = cloudinaryConfig?.cloud;
-      const { secureDistribution, privateCdn } = cloudinaryConfig?.url;
-
-      let playerOptions: CloudinaryVideoPlayerOptions = {
-        cloud_name: cloudName,
-        privateCdn,
-        secureDistribution,
-
-        autoplayMode: autoplayModeValue,
-        autoplay: autoPlayValue,
-        controls,
-        fontFace: fontFace || '',
-        language,
-        languages,
-        loop,
-        muted,
-        publicId,
-        width,
-        height,
-        aspectRatio: `${width}:${height}`,
-        transformation: playerTransformations,
-        ...logoOptions,
-        ...otherCldVidPlayerOptions
-      };
-
-      if ( Array.isArray(sourceTypes) ) {
-        playerOptions.sourceTypes = sourceTypes;
-      }
-
-      if ( typeof colors === 'object' ) {
-        playerOptions.colors = colors;
-      }
-
-      if ( typeof poster === 'string' ) {
-        // If poster is a string, assume it's either a public ID
-        // or a remote URL, in either case pass to `publicId`
-        playerOptions.posterOptions = {
-          publicId: poster
-        };
-      } else if ( typeof poster === 'object' ) {
-        // If poster is an object, we can either customize the
-        // automatically generated image from the video or generate
-        // a completely new image from a separate public ID, so look
-        // to see if the src is explicitly set to determine whether
-        // or not to use the video's ID or just pass things along
-        if ( typeof poster.src !== 'string' ) {
-          playerOptions.posterOptions = {
-            publicId: getCldVideoUrl({
-              ...poster,
-              src: publicId,
-              format: 'auto:image',
-            })
-          };
-        } else {
-          playerOptions.posterOptions = {
-            publicId: getCldImageUrl(poster)
-          };
-        }
-      }
-
       playerRef.current = cloudinaryRef.current.videoPlayer(videoRef.current, playerOptions);
 
       Object.keys(events).forEach((key) => {