next-cloudinary 0.1.1 → 0.3.0

package/dist/next-cloudinary.modern.mjs

@@ -1,6 +1,9 @@
 import Image from 'next/image';
 import { Cloudinary } from '@cloudinary/url-gen';
-import { jsx } from 'react/jsx-runtime';
+import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
+import Head from 'next/head';
+import { useRef } from 'react';
+import Script from 'next/script';
 
 function _extends() {
   _extends = Object.assign ? Object.assign.bind() : function (target) {
@@ -34,95 +37,32 @@ function _objectWithoutPropertiesLoose(source, excluded) {
   return target;
 }
 
-const cld$1 = new Cloudinary({
-  cloud: {
-    cloudName: process.env.NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME
-  },
-  url: {
-    // Used to avoid issues with SSR particularly for the blurred placeholder
-    analytics: false
-  }
-});
-/**
- * Retrieves the public id of a cloudiary image url. If no url is recognized it returns the parameter it self.
- * If it's recognized that is a url and it's not possible to get the public id, it warns the user.
- *
- * @param {string} src The cloudiary url or public id.
- *
- * @return {string} The images public id
- */
-
-function getPublicId(src) {
-  if (src.includes('res.cloudinary.com')) {
-    const regexWithTransformations = /(https?)\:\/\/(res.cloudinary.com)\/([^\/]+)\/(image|video|raw)\/(upload|authenticated)\/(.*)\/(v[0-9]+)\/(.+)(?:\.[a-z]{3})?/;
-    const regexWithoutTransformations = /(https?)\:\/\/(res.cloudinary.com)\/([^\/]+)\/(image|video|raw)\/(upload|authenticated)\/(v[0-9]+)\/(.+)(?:\.[a-z]{3})?/;
-    const withTransformations = src.match(regexWithTransformations);
-    const withoutTransformations = src.match(regexWithoutTransformations);
-
-    if (withTransformations) {
-      return withTransformations[withTransformations.length - 1];
-    } else if (withoutTransformations) {
-      return withoutTransformations[withoutTransformations.length - 1];
-    } else {
-      console.warn(`Not possible to retrieve the publicUrl from ${src}, make sure it's a valid cloudinary image url.`);
-    }
-  }
-
-  return src;
-}
-/**
- * createPlaceholderUrl
- */
-
-function createPlaceholderUrl({
-  src,
-  placeholder
-}) {
-  const cldImage = cld$1.image(src).resize('c_limit,w_100').delivery('q_1').format('auto');
-
-  if (placeholder === 'grayscale') {
-    cldImage.effect('e_grayscale');
-  }
-
-  if (placeholder.includes('color:')) {
-    const color = placeholder.split(':').splice(1).join(':');
-    cldImage.effect('e_grayscale');
-    cldImage.effect(`e_colorize:60,co_${color}`);
-  }
-
-  return cldImage.toURL();
-}
-
 const cropsGravityAuto = ['crop', 'fill', 'lfill', 'fill_pad', 'thumb'];
 const props$6 = ['crop', 'gravity'];
 function plugin$6({
   cldImage,
-  options,
-  cldOptions
+  options
 } = {}) {
   const {
     width,
-    height
+    height,
+    crop = 'limit'
   } = options;
-  const {
-    crop = 'limit',
-    gravity
-  } = cldOptions;
   let transformationString = `c_${crop},w_${width}`;
 
-  if (!gravity && cropsGravityAuto.includes(crop)) {
-    gravity = 'auto';
+  if (!options.gravity && cropsGravityAuto.includes(crop)) {
+    options.gravity = 'auto';
   }
 
   if (!['limit'].includes(crop)) {
     transformationString = `${transformationString},h_${height}`;
   }
 
-  if (gravity) {
-    if (gravity === 'auto' && !cropsGravityAuto.includes(crop)) {
+  if (options.gravity) {
+    if (options.gravity === 'auto' && !cropsGravityAuto.includes(crop)) {
       console.warn('Auto gravity can only be used with crop, fill, lfill, fill_pad or thumb. Not applying gravity.');
     } else {
-      transformationString = `${transformationString},g_${gravity}`;
+      transformationString = `${transformationString},g_${options.gravity}`;
     }
   }
 
@@ -184,20 +124,16 @@ const params = ['art', {
 const props$5 = params.map(param => param.prop || param);
 function plugin$5({
   cldImage,
-  cldOptions
+  options
 } = {}) {
   params.forEach(key => {
     const prop = key.prop || key;
     const effect = key.effect || key;
 
-    if (prop === 'oilPaint' && cldOptions[prop]) {
-      console.log('cldOptions[prop]', cldOptions[prop]);
-    }
-
-    if (cldOptions[prop] === true) {
+    if (options[prop] === true) {
       cldImage.effect(`e_${effect}`);
-    } else if (typeof cldOptions[prop] === 'string') {
-      cldImage.effect(`e_${effect}:${cldOptions[prop]}`);
+    } else if (typeof options[prop] === 'string') {
+      cldImage.effect(`e_${effect}:${options[prop]}`);
     }
   });
 }
@@ -262,29 +198,56 @@ const text = {
   }
 };
 
-const _excluded$1 = ["publicId", "position", "text", "effects"];
-const props$4 = ['overlays'];
+const _excluded$3 = ["publicId", "position", "text", "effects"];
+const props$4 = ['text', 'overlays'];
+const DEFAULT_TEXT_OPTIONS = {
+  color: 'black',
+  fontFamily: 'Arial',
+  fontSize: 200,
+  fontWeight: 'bold'
+};
 function plugin$4({
   cldImage,
-  options,
-  cldOptions
+  options
 } = {}) {
   const {
+    text: text$1,
     overlays = []
-  } = cldOptions;
+  } = options;
   const type = 'overlay';
   const typeQualifier = 'l';
-  overlays.forEach(_ref => {
+
+  if (Array.isArray(overlays)) {
+    overlays.forEach(applyOverlay);
+  }
+
+  if (typeof text$1 === 'string') {
+    applyOverlay({
+      text: _extends({}, DEFAULT_TEXT_OPTIONS, {
+        text: text$1
+      })
+    });
+  } else if (typeof text$1 === 'object') {
+    applyOverlay({
+      text: _extends({}, DEFAULT_TEXT_OPTIONS, text$1)
+    });
+  }
+  /**
+   * applyOverlay
+   */
+
+
+  function applyOverlay(_ref) {
     let {
       publicId,
       position: position$1,
       text: text$1,
       effects: layerEffects = []
     } = _ref,
-        options = _objectWithoutPropertiesLoose(_ref, _excluded$1);
+        options = _objectWithoutPropertiesLoose(_ref, _excluded$3);
 
     const hasPublicId = typeof publicId === 'string';
-    const hasText = typeof text$1 === 'object';
+    const hasText = typeof text$1 === 'object' || typeof text$1 === 'string';
     const hasPosition = typeof position$1 === 'object';
 
     if (!hasPublicId && !hasText) {
@@ -326,6 +289,12 @@ function plugin$4({
     }); // Text styling
 
     if (hasText) {
+      if (typeof text$1 === 'string') {
+        text$1 = _extends({}, DEFAULT_TEXT_OPTIONS, {
+          text: text$1
+        });
+      }
+
       const textTransformations = [];
       Object.keys(text$1).forEach(key => {
         if (!text[key]) return;
@@ -357,7 +326,7 @@ function plugin$4({
 
     layerTransformation = `${layerTransformation},${primary$1.join(',')}`; // Add all applied transformations
 
-    layerTransformation = `${layerTransformation}/fl_layer_apply`;
+    layerTransformation = `${layerTransformation}/fl_layer_apply,fl_no_overflow`;
 
     if (applied.length > 0) {
       layerTransformation = `${layerTransformation},${applied.join(',')}`;
@@ -365,23 +334,24 @@ function plugin$4({
 
 
     cldImage.addTransformation(layerTransformation);
-  });
+  }
 }
 
 var overlaysPlugin = {
   __proto__: null,
   props: props$4,
+  DEFAULT_TEXT_OPTIONS: DEFAULT_TEXT_OPTIONS,
   plugin: plugin$4
 };
 
 const props$3 = ['rawTransformations'];
 function plugin$3({
   cldImage,
-  cldOptions
+  options
 } = {}) {
   const {
     rawTransformations = []
-  } = cldOptions;
+  } = options;
   rawTransformations.forEach(transformation => {
     cldImage.addTransformation(transformation);
   });
@@ -396,12 +366,11 @@ var rawTransformationsPlugin = {
 const props$2 = ['removeBackground'];
 function plugin$2({
   cldImage,
-  options,
-  cldOptions
+  options
 } = {}) {
   const {
     removeBackground = false
-  } = cldOptions;
+  } = options;
 
   if (removeBackground) {
     cldImage.effect('e_background_removal');
@@ -414,25 +383,51 @@ var removeBackgroundPlugin = {
   plugin: plugin$2
 };
 
-const _excluded = ["publicId", "type", "position", "text", "effects"];
-const props$1 = ['underlays'];
+const _excluded$2 = ["publicId", "type", "position", "text", "effects"];
+const props$1 = ['underlay', 'underlays'];
 function plugin$1({
   cldImage,
-  options,
-  cldOptions
+  options
 } = {}) {
   const {
+    underlay,
     underlays = []
-  } = cldOptions;
+  } = options;
   const typeQualifier = 'u';
-  underlays.forEach(_ref => {
+
+  if (Array.isArray(underlays)) {
+    underlays.forEach(applyUnderlay);
+  }
+
+  if (typeof underlay === 'string') {
+    const underlayOptions = {
+      publicId: underlay,
+      crop: 'fill'
+    };
+
+    if (options.width) {
+      underlayOptions.width = options.width;
+    }
+
+    if (options.height) {
+      underlayOptions.height = options.height;
+    }
+
+    applyUnderlay(underlayOptions);
+  }
+  /**
+   * applyUnderlay
+   */
+
+
+  function applyUnderlay(_ref) {
     let {
       publicId,
       type,
       position: position$1,
       effects: layerEffects = []
     } = _ref,
-        options = _objectWithoutPropertiesLoose(_ref, _excluded);
+        options = _objectWithoutPropertiesLoose(_ref, _excluded$2);
 
     const hasPublicId = typeof publicId === 'string';
     const hasPosition = typeof position$1 === 'object';
@@ -481,7 +476,7 @@ function plugin$1({
 
     layerTransformation = `${layerTransformation},${primary$1.join(',')}`; // Add all applied transformations
 
-    layerTransformation = `${layerTransformation}/fl_layer_apply`;
+    layerTransformation = `${layerTransformation}/fl_layer_apply,fl_no_overflow`;
 
     if (applied.length > 0) {
       layerTransformation = `${layerTransformation},${applied.join(',')}`;
@@ -489,7 +484,7 @@ function plugin$1({
 
 
     cldImage.addTransformation(layerTransformation);
-  });
+  }
 }
 
 var underlaysPlugin = {
@@ -501,12 +496,12 @@ var underlaysPlugin = {
 const props = ['zoompan'];
 function plugin({
   cldImage,
-  cldOptions
+  options
 } = {}) {
   const {
     zoompan = false
-  } = cldOptions;
-  const options = {};
+  } = options;
+  const overrides = {};
 
   if (zoompan === true) {
     cldImage.effect('e_zoompan');
@@ -539,11 +534,11 @@ function plugin({
   }
 
   if (zoompan !== false) {
-    options.format = 'gif';
+    overrides.format = 'gif';
   }
 
   return {
-    options
+    options: overrides
   };
 }
 
@@ -553,12 +548,19 @@ var zoompanPlugin = {
   plugin: plugin
 };
 
-let cld;
 const transformationPlugins = [// Background Removal must always come first
 removeBackgroundPlugin, croppingPlugin, effectsPlugin, overlaysPlugin, underlaysPlugin, zoompanPlugin, // Raw transformations needs to be last simply to make sure
 // it's always expected to applied the same way
 rawTransformationsPlugin];
-function cloudinaryLoader(defaultOptions, cldOptions, cldConfig = {}) {
+let cld;
+/**
+ * constructCloudinaryUrl
+ */
+
+function constructCloudinaryUrl({
+  options,
+  config
+}) {
   if (!cld) {
     cld = new Cloudinary(_extends({
       cloud: {
@@ -568,14 +570,9 @@ function cloudinaryLoader(defaultOptions, cldOptions, cldConfig = {}) {
         // Used to avoid issues with SSR particularly for the blurred placeholder
         analytics: false
       }
-    }, cldConfig));
+    }, config));
   }
 
-  const options = _extends({
-    format: 'auto',
-    quality: 'auto'
-  }, defaultOptions);
-
   const publicId = getPublicId(options.src);
   const cldImage = cld.image(publicId);
   transformationPlugins.forEach(({
@@ -585,15 +582,83 @@ function cloudinaryLoader(defaultOptions, cldOptions, cldConfig = {}) {
       options: pluginOptions
     } = plugin({
       cldImage,
-      options,
-      cldOptions
+      options
     }) || {};
 
     if (pluginOptions != null && pluginOptions.format) {
       options.format = pluginOptions.format;
     }
   });
-  return cldImage.format(options.format).delivery(`q_${options.quality}`).toURL();
+  return cldImage.setDeliveryType(options.deliveryType || 'upload').format(options.format || 'auto').delivery(`q_${options.quality || 'auto'}`).toURL();
+}
+/**
+ * Retrieves the public id of a cloudiary image url. If no url is recognized it returns the parameter it self.
+ * If it's recognized that is a url and it's not possible to get the public id, it warns the user.
+ *
+ * @param {string} src The cloudiary url or public id.
+ *
+ * @return {string} The images public id
+ */
+
+function getPublicId(src) {
+  if (typeof src !== 'string') {
+    throw new Error(`Invalid src of type ${typeof src}`);
+  }
+
+  if (src.includes('res.cloudinary.com')) {
+    const regexWithTransformations = /(https?)\:\/\/(res.cloudinary.com)\/([^\/]+)\/(image|video|raw)\/(upload|authenticated)\/(.*)\/(v[0-9]+)\/(.+)(?:\.[a-z]{3})?/;
+    const regexWithoutTransformations = /(https?)\:\/\/(res.cloudinary.com)\/([^\/]+)\/(image|video|raw)\/(upload|authenticated)\/(v[0-9]+)\/(.+)(?:\.[a-z]{3})?/;
+    const withTransformations = src.match(regexWithTransformations);
+    const withoutTransformations = src.match(regexWithoutTransformations);
+
+    if (withTransformations) {
+      return withTransformations[withTransformations.length - 1];
+    } else if (withoutTransformations) {
+      return withoutTransformations[withoutTransformations.length - 1];
+    } else {
+      console.warn(`Not possible to retrieve the publicUrl from ${src}, make sure it's a valid cloudinary image url.`);
+    }
+  }
+
+  return src;
+}
+/**
+ * createPlaceholderUrl
+ */
+
+function createPlaceholderUrl({
+  src,
+  placeholder = true,
+  config
+}) {
+  const rawTransformations = [];
+
+  if (placeholder === 'grayscale') {
+    rawTransformations.push('e_grayscale');
+  }
+
+  if (typeof placeholder === 'string' && placeholder.includes('color:')) {
+    const color = placeholder.split(':').splice(1).join(':');
+    rawTransformations.push('e_grayscale');
+    rawTransformations.push(`e_colorize:60,co_${color}`);
+  }
+
+  return constructCloudinaryUrl({
+    options: {
+      src,
+      width: 100,
+      quality: 1,
+      rawTransformations
+    },
+    config
+  });
+}
+
+function cloudinaryLoader(defaultOptions, cldOptions, cldConfig = {}) {
+  return constructCloudinaryUrl({
+    options: _extends({}, defaultOptions, cldOptions),
+    config: cldConfig
+  });
 }
 
 const CldImage = props => {
@@ -646,5 +711,190 @@ const CldImage = props => {
   }));
 };
 
-export { CldImage, cloudinaryLoader, position, primary, text };
+const _excluded$1 = ["excludeTags", "twitterTitle"];
+const IMAGE_WIDTH = 2400;
+const IMAGE_HEIGHT = 1200;
+const TWITTER_CARD = 'summary_large_image';
+
+const CldOgImage = _ref => {
+  let {
+    excludeTags = [],
+    twitterTitle
+  } = _ref,
+      props = _objectWithoutPropertiesLoose(_ref, _excluded$1);
+
+  const options = _extends({}, props, {
+    width: props.width || IMAGE_WIDTH,
+    height: props.height || IMAGE_HEIGHT,
+    crop: props.crop || 'fill',
+    gravity: props.gravity || 'center'
+  });
+
+  const ogImageUrl = constructCloudinaryUrl({
+    options
+  }); // We need to include the tags within the Next.js Head component rather than
+  // direcly adding them inside of the Head otherwise we get unexpected results
+
+  return /*#__PURE__*/jsxs(Head, {
+    children: [/*#__PURE__*/jsx("meta", {
+      property: "og:image",
+      content: ogImageUrl
+    }), /*#__PURE__*/jsx("meta", {
+      property: "og:image:secure_url",
+      content: ogImageUrl
+    }), /*#__PURE__*/jsx("meta", {
+      property: "og:image:width",
+      content: options.width
+    }), /*#__PURE__*/jsx("meta", {
+      property: "og:image:height",
+      content: options.height
+    }), options.alt && /*#__PURE__*/jsx("meta", {
+      property: "og:image:alt",
+      content: options.alt
+    }), !excludeTags.includes('twitter:title') && /*#__PURE__*/jsx("meta", {
+      property: "twitter:title",
+      content: twitterTitle || ' '
+    }), /*#__PURE__*/jsx("meta", {
+      property: "twitter:card",
+      content: TWITTER_CARD
+    }), /*#__PURE__*/jsx("meta", {
+      property: "twitter:image",
+      content: ogImageUrl
+    })]
+  });
+};
+
+const CldUploadWidget = ({
+  children,
+  onUpload,
+  options,
+  signed,
+  signatureEndpoint
+}) => {
+  const cloudinary = useRef();
+  const widget = useRef();
+  /**
+   * generateSignature
+   * @description Makes a request to an endpoint to sign Cloudinary parameters as part of widget creation
+   */
+
+  function generateSignature(callback, paramsToSign) {
+    fetch(signatureEndpoint, {
+      method: "POST",
+      body: JSON.stringify({
+        paramsToSign
+      })
+    }).then(r => r.json()).then(({
+      signature
+    }) => {
+      callback(signature);
+    });
+  }
+  /**
+   * createWidget
+   * @description Creates a new instance of the Cloudinary widget and stores in a ref
+   */
+
+
+  function createWidget() {
+    var _cloudinary$current;
+
+    // When creating a signed upload, you need to provide both your Cloudinary API Key
+    // as well as a signature generator function that will sign any paramters
+    // either on page load or during the upload process. Read more about signed uploads at:
+    // https://cloudinary.com/documentation/upload_widget#signed_uploads
+    const totalOptions = _extends({}, options, !!signed && {
+      uploadSignature: generateSignature
+    }); // no need for apiSecret because of api/sign-cloudinary-params
+
+
+    if (signed && !totalOptions.apiKey) {
+      return new Error("Signed Upload needs apiKey!");
+    }
+
+    return (_cloudinary$current = cloudinary.current) == null ? void 0 : _cloudinary$current.createUploadWidget(totalOptions, function (error, result) {
+      // The callback is a bit more chatty than failed or success so
+      // only trigger when one of those are the case. You can additionally
+      // create a separate handler such as onEvent and trigger it on
+      // ever occurance
+      if (error || result.event === "success") {
+        onUpload(error, result, widget == null ? void 0 : widget.current);
+      }
+    });
+  }
+  /**
+   * open
+   * @description When triggered, uses the current widget instance to open the upload modal
+   */
+
+
+  function open() {
+    if (!(widget != null && widget.current)) {
+      widget.current = createWidget();
+    }
+
+    (widget == null ? void 0 : widget.current) && widget.current.open();
+  }
+  /**
+   * handleOnLoad
+   * @description Stores the Cloudinary window instance to a ref when the widget script loads
+   */
+
+
+  function handleOnLoad() {
+    cloudinary.current = window.cloudinary;
+  }
+
+  return /*#__PURE__*/jsxs(Fragment, {
+    children: [children({
+      cloudinary: cloudinary.current,
+      widget: widget.current,
+      open
+    }), /*#__PURE__*/jsx(Script, {
+      id: `cloudinary-${Math.floor(Math.random() * 100)}`,
+      src: "https://widget.cloudinary.com/v2.0/global/all.js",
+      onLoad: handleOnLoad,
+      onError: e => {
+        console.error("Script failed to load", e);
+      }
+    })]
+  });
+};
+
+const _excluded = ["onUpload", "options", "signed", "label", "children"];
+
+const CldUploadButton = _ref => {
+  let {
+    onUpload,
+    options,
+    signed,
+    children
+  } = _ref,
+      props = _objectWithoutPropertiesLoose(_ref, _excluded);
+
+  return /*#__PURE__*/jsx(Fragment, {
+    children: /*#__PURE__*/jsx(CldUploadWidget, {
+      signed: signed,
+      options: options,
+      onUpload: onUpload,
+      signatureEndpoint: signed != null ? signed : props.signatureEndpoint,
+      children: ({
+        open
+      }) => {
+        function handleOnClick(e) {
+          e.preventDefault();
+          open();
+        }
+
+        return /*#__PURE__*/jsx("button", _extends({
+          onClick: handleOnClick
+        }, props, {
+          children: children
+        }));
+      }
+    })
+  });
+};
+
+export { CldImage, CldOgImage, CldUploadButton, CldUploadWidget, cloudinaryLoader, position, primary, text };
 //# sourceMappingURL=next-cloudinary.modern.mjs.map