@imagekit/javascript 5.0.0-beta.7 → 5.1.0-beta.1

package/src/url.ts

@@ -1,301 +0,0 @@
-import { SrcOptions } from "./interfaces";
-import { ImageOverlay, SolidColorOverlay, SubtitleOverlay, TextOverlay, Transformation, VideoOverlay } from "./interfaces/Transformation";
-import transformationUtils, { safeBtoa } from "./utils/transformation";
-const TRANSFORMATION_PARAMETER = "tr";
-const SIMPLE_OVERLAY_PATH_REGEX = new RegExp('^[a-zA-Z0-9-._/ ]*$')
-const SIMPLE_OVERLAY_TEXT_REGEX = new RegExp('^[a-zA-Z0-9-._ ]*$') // These characters are selected by testing actual URLs on both path and query parameters. If and when backend starts supporting wide range of characters, this regex should be updated to improve URL readability.
-
-function removeTrailingSlash(str: string) {
-  if (typeof str == "string" && str[str.length - 1] == "/") {
-    str = str.substring(0, str.length - 1);
-  }
-  return str;
-}
-
-function removeLeadingSlash(str: string) {
-  if (typeof str == "string" && str[0] == "/") {
-    str = str.slice(1);
-  }
-  return str;
-}
-
-function pathJoin(parts: string[], sep?: string) {
-  var separator = sep || "/";
-  var replace = new RegExp(separator + "{1,}", "g");
-  return parts.join(separator).replace(replace, separator);
-}
-
-/**
- * Builds a source URL with the given options.
- *
- * @param {SrcOptions} opts - The options for building the source URL.
- * @returns {string} The constructed source URL.
- */
-export const buildSrc = (opts: SrcOptions): string => {
-  opts.urlEndpoint = opts.urlEndpoint || "";
-  opts.src = opts.src || "";
-  opts.transformationPosition = opts.transformationPosition || "query";
-
-  if (!opts.src) {
-    return "";
-  }
-
-  const isAbsoluteURL = opts.src.startsWith("http://") || opts.src.startsWith("https://");
-
-  var urlObj, isSrcParameterUsedForURL, urlEndpointPattern;
-
-  try {
-    if (!isAbsoluteURL) {
-      urlEndpointPattern = new URL(opts.urlEndpoint).pathname;
-      urlObj = new URL(pathJoin([opts.urlEndpoint.replace(urlEndpointPattern, ""), opts.src]));
-    } else {
-      urlObj = new URL(opts.src!);
-      isSrcParameterUsedForURL = true;
-    }
-  } catch (e) {
-    console.error(e)
-    return "";
-  }
-
-  for (var i in opts.queryParameters) {
-    urlObj.searchParams.append(i, String(opts.queryParameters[i]));
-  }
-
-  var transformationString = buildTransformationString(opts.transformation);
-
-  if (transformationString && transformationString.length) {
-    if (!transformationUtils.addAsQueryParameter(opts) && !isSrcParameterUsedForURL) {
-      urlObj.pathname = pathJoin([
-        TRANSFORMATION_PARAMETER + transformationUtils.getChainTransformDelimiter() + transformationString,
-        urlObj.pathname,
-      ]);
-    }
-  }
-
-  if (urlEndpointPattern) {
-    urlObj.pathname = pathJoin([urlEndpointPattern, urlObj.pathname]);
-  } else {
-    urlObj.pathname = pathJoin([urlObj.pathname]);
-  }
-
-  if (transformationString && transformationString.length) {
-    if (transformationUtils.addAsQueryParameter(opts) || isSrcParameterUsedForURL) {
-      if (urlObj.searchParams.toString() !== "") { // In 12 node.js .size was not there. So, we need to check if it is an object or not.
-        return `${urlObj.href}&${TRANSFORMATION_PARAMETER}=${transformationString}`;
-      }
-      else {
-        return `${urlObj.href}?${TRANSFORMATION_PARAMETER}=${transformationString}`;
-      }
-    }
-  }
-
-  return urlObj.href;
-};
-
-function processInputPath(str: string, enccoding: string): string {
-  // Remove leading and trailing slashes
-  str = removeTrailingSlash(removeLeadingSlash(str));
-  if (enccoding === "plain") {
-    return `i-${str.replace(/\//g, "@@")}`;
-  }
-  if (enccoding === "base64") {
-    return `ie-${encodeURIComponent(safeBtoa(str))}`;
-  }
-  if (SIMPLE_OVERLAY_PATH_REGEX.test(str)) {
-    return `i-${str.replace(/\//g, "@@")}`;
-  } else {
-    return `ie-${encodeURIComponent(safeBtoa(str))}`;
-  }
-}
-
-function processText(str: string, enccoding: TextOverlay["encoding"]): string {
-  if (enccoding === "plain") {
-    return `i-${encodeURIComponent(str)}`;
-  }
-  if (enccoding === "base64") {
-    return `ie-${encodeURIComponent(safeBtoa(str))}`;
-  }
-  if (SIMPLE_OVERLAY_TEXT_REGEX.test(str)) {
-    return `i-${encodeURIComponent(str)}`;
-  }
-  return `ie-${encodeURIComponent(safeBtoa(str))}`;
-}
-
-function processOverlay(overlay: Transformation["overlay"]): string | undefined {
-  const entries = [];
-
-  const { type, position = {}, timing = {}, transformation = [] } = overlay || {};
-
-  if (!type) {
-    return;
-  }
-
-  switch (type) {
-    case "text": {
-      const textOverlay = overlay as TextOverlay;
-      if (!textOverlay.text) {
-        return;
-      }
-      const enccoding = textOverlay.encoding || "auto";
-
-      entries.push("l-text");
-      entries.push(processText(textOverlay.text, enccoding));
-    }
-      break;
-    case "image":
-      entries.push("l-image");
-      {
-        const imageOverlay = overlay as ImageOverlay;
-        const enccoding = imageOverlay.encoding || "auto";
-        if (imageOverlay.input) {
-          entries.push(processInputPath(imageOverlay.input, enccoding));
-        } else {
-          return;
-        }
-      }
-      break;
-    case "video":
-      entries.push("l-video");
-      {
-        const videoOverlay = overlay as VideoOverlay;
-        const enccoding = videoOverlay.encoding || "auto";
-        if (videoOverlay.input) {
-          entries.push(processInputPath(videoOverlay.input, enccoding));
-        } else {
-          return;
-        }
-      }
-      break;
-    case "subtitle":
-      entries.push("l-subtitle");
-      {
-        const subtitleOverlay = overlay as SubtitleOverlay;
-        const enccoding = subtitleOverlay.encoding || "auto";
-        if (subtitleOverlay.input) {
-          entries.push(processInputPath(subtitleOverlay.input, enccoding));
-        } else {
-          return;
-        }
-      }
-      break;
-    case "solidColor":
-      entries.push("l-image");
-      entries.push(`i-ik_canvas`);
-      {
-        const solidColorOverlay = overlay as SolidColorOverlay;
-        if (solidColorOverlay.color) {
-          entries.push(`bg-${solidColorOverlay.color}`);
-        } else {
-          return;
-        }
-      }
-      break;
-  }
-
-  const { x, y, focus } = position;
-  if (x) {
-    entries.push(`lx-${x}`);
-  }
-  if (y) {
-    entries.push(`ly-${y}`);
-  }
-  if (focus) {
-    entries.push(`lfo-${focus}`);
-  }
-
-  const { start, end, duration } = timing;
-
-  if (start) {
-    entries.push(`lso-${start}`);
-  }
-  if (end) {
-    entries.push(`leo-${end}`);
-  }
-  if (duration) {
-    entries.push(`ldu-${duration}`);
-  }
-
-  const transformationString = buildTransformationString(transformation);
-
-  if (transformationString && transformationString.trim() !== "") entries.push(transformationString);
-
-  entries.push("l-end");
-
-  return entries.join(transformationUtils.getTransformDelimiter());
-}
-
-/**
- * Builds a transformation string from the given transformations.
- *
- * @param {Transformation[] | undefined} transformation - The transformations to apply.
- * @returns {string} The constructed transformation string.
- */
-export const buildTransformationString = function (transformation: Transformation[] | undefined): string {
-  if (!Array.isArray(transformation)) {
-    return "";
-  }
-
-  var parsedTransforms: string[] = [];
-  for (var i = 0, l = transformation.length; i < l; i++) {
-    var parsedTransformStep: string[] = [];
-    for (var key in transformation[i]) {
-      let value = transformation[i][key as keyof Transformation];
-      if (value === undefined || value === null) {
-        continue;
-      }
-
-      if (key === "overlay" && typeof value === "object") {
-        var rawString = processOverlay(value as Transformation["overlay"]);
-        if (rawString && rawString.trim() !== "") {
-          parsedTransformStep.push(rawString);
-        }
-        continue; // Always continue as overlay is processed.
-      }
-
-      var transformKey = transformationUtils.getTransformKey(key);
-      if (!transformKey) {
-        transformKey = key;
-      }
-
-      if (transformKey === "") {
-        continue;
-      }
-
-      if (
-        ["e-grayscale", "e-contrast", "e-removedotbg", "e-bgremove", "e-upscale", "e-retouch", "e-genvar"].includes(transformKey)
-      ) {
-        if (value === true || value === "-" || value === "true") {
-          parsedTransformStep.push(transformKey);
-        } else {
-          // Any other value means that the effect should not be applied
-          continue;
-        }
-      } else if (
-        ["e-sharpen", "e-shadow", "e-gradient", "e-usm", "e-dropshadow"].includes(transformKey) &&
-        (value.toString().trim() === "" || value === true || value === "true")
-      ) {
-        parsedTransformStep.push(transformKey);
-      } else if (key === "raw") {
-        parsedTransformStep.push(transformation[i][key] as string);
-      } else {
-        if (transformKey === "di") {
-          value = removeTrailingSlash(removeLeadingSlash(value as string || ""));
-          value = value.replace(/\//g, "@@");
-        }
-        if (transformKey === "sr" && Array.isArray(value)) {
-          value = value.join("_");
-        }
-        // Special case for trim with empty string - should be treated as true
-        if (transformKey === "t" && value.toString().trim() === "") {
-          value = "true";
-        }
-        parsedTransformStep.push([transformKey, value].join(transformationUtils.getTransformKeyValueDelimiter()));
-      }
-    }
-    if (parsedTransformStep.length) {
-      parsedTransforms.push(parsedTransformStep.join(transformationUtils.getTransformDelimiter()));
-    }
-  }
-
-  return parsedTransforms.join(transformationUtils.getChainTransformDelimiter());
-}

package/src/utils/transformation.ts

@@ -1,40 +0,0 @@
-import supportedTransforms from "../constants/supportedTransforms";
-import { TransformationPosition, SrcOptions } from "../interfaces";
-
-const QUERY_TRANSFORMATION_POSITION: TransformationPosition = "query";
-const PATH_TRANSFORMATION_POSITION: TransformationPosition = "path";
-const DEFAULT_TRANSFORMATION_POSITION: TransformationPosition = QUERY_TRANSFORMATION_POSITION;
-const VALID_TRANSFORMATION_POSITIONS = [PATH_TRANSFORMATION_POSITION, QUERY_TRANSFORMATION_POSITION];
-const CHAIN_TRANSFORM_DELIMITER: string = ":";
-const TRANSFORM_DELIMITER: string = ",";
-const TRANSFORM_KEY_VALUE_DELIMITER: string = "-";
-
-export default {
-    addAsQueryParameter: (options: SrcOptions) => {
-        return options.transformationPosition === QUERY_TRANSFORMATION_POSITION;
-    },
-    getTransformKey: function (transform: string) {
-        if (!transform) { return ""; }
-
-        return supportedTransforms[transform] || supportedTransforms[transform.toLowerCase()] || "";
-    },
-    getChainTransformDelimiter: function () {
-        return CHAIN_TRANSFORM_DELIMITER;
-    },
-    getTransformDelimiter: function () {
-        return TRANSFORM_DELIMITER;
-    },
-    getTransformKeyValueDelimiter: function () {
-        return TRANSFORM_KEY_VALUE_DELIMITER;
-    }
-}
-
-export const safeBtoa = function (str: string): string {
-    if (typeof window !== "undefined") {
-        /* istanbul ignore next */
-        return btoa(str);
-    } else {
-        // Node fallback
-        return Buffer.from(str, "utf8").toString("base64");
-    }
-}