@imagekit/javascript 5.0.0-beta.3

package/dist/imagekit.esm.js

@@ -0,0 +1,609 @@
+var errorMessages = {
+  MANDATORY_INITIALIZATION_MISSING: {
+    message: "Missing urlEndpoint during SDK initialization"
+  },
+  INVALID_TRANSFORMATION_POSITION: {
+    message: "Invalid transformationPosition parameter"
+  },
+  PRIVATE_KEY_CLIENT_SIDE: {
+    message: "privateKey should not be passed on the client side"
+  },
+  MISSING_UPLOAD_DATA: {
+    message: "Missing data for upload"
+  },
+  MISSING_UPLOAD_FILE_PARAMETER: {
+    message: "Missing file parameter for upload"
+  },
+  MISSING_UPLOAD_FILENAME_PARAMETER: {
+    message: "Missing fileName parameter for upload"
+  },
+  MISSING_AUTHENTICATION_ENDPOINT: {
+    message: "Missing authentication endpoint for upload"
+  },
+  MISSING_PUBLIC_KEY: {
+    message: "Missing public key for upload"
+  },
+  AUTH_ENDPOINT_TIMEOUT: {
+    message: "The authenticationEndpoint you provided timed out in 60 seconds"
+  },
+  AUTH_ENDPOINT_NETWORK_ERROR: {
+    message: "Request to authenticationEndpoint failed due to network error"
+  },
+  AUTH_INVALID_RESPONSE: {
+    message: "Invalid response from authenticationEndpoint. The SDK expects a JSON response with three fields i.e. signature, token and expire."
+  },
+  UPLOAD_ENDPOINT_NETWORK_ERROR: {
+    message: "Request to ImageKit upload endpoint failed due to network error"
+  },
+  INVALID_UPLOAD_OPTIONS: {
+    message: "Invalid uploadOptions parameter"
+  },
+  MISSING_SIGNATURE: {
+    message: "Missing signature for upload. The SDK expects token, signature and expire for authentication."
+  },
+  MISSING_TOKEN: {
+    message: "Missing token for upload. The SDK expects token, signature and expire for authentication."
+  },
+  MISSING_EXPIRE: {
+    message: "Missing expire for upload. The SDK expects token, signature and expire for authentication."
+  },
+  INVALID_TRANSFORMATION: {
+    message: "Invalid transformation parameter. Please include at least pre, post, or both."
+  },
+  INVALID_PRE_TRANSFORMATION: {
+    message: "Invalid pre transformation parameter."
+  },
+  INVALID_POST_TRANSFORMATION: {
+    message: "Invalid post transformation parameter."
+  },
+  UPLOAD_ABORTED: {
+    message: "Request aborted by the user"
+  }
+};
+
+class ImageKitInvalidRequestError extends Error {
+  constructor(message, responseMetadata) {
+    super(message);
+    this.$ResponseMetadata = void 0;
+    this.name = "ImageKitInvalidRequestError";
+    this.$ResponseMetadata = responseMetadata;
+  }
+}
+class ImageKitAbortError extends Error {
+  constructor(message, reason) {
+    super(message);
+    this.reason = void 0;
+    this.name = "ImageKitAbortError";
+    this.reason = reason;
+  }
+}
+class ImageKitUploadNetworkError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ImageKitUploadNetworkError";
+  }
+}
+class ImageKitServerError extends Error {
+  constructor(message, responseMetadata) {
+    super(message);
+    this.$ResponseMetadata = void 0;
+    this.name = "ImageKitServerError";
+    this.$ResponseMetadata = responseMetadata;
+  }
+}
+const upload = uploadOptions => {
+  if (!uploadOptions) {
+    return Promise.reject(new ImageKitInvalidRequestError("Invalid options provided for upload"));
+  }
+  return new Promise((resolve, reject) => {
+    const {
+      xhr: userProvidedXHR
+    } = uploadOptions || {};
+    delete uploadOptions.xhr;
+    const xhr = userProvidedXHR || new XMLHttpRequest();
+    if (!uploadOptions.file) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_UPLOAD_FILE_PARAMETER.message));
+    }
+    if (!uploadOptions.fileName) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_UPLOAD_FILENAME_PARAMETER.message));
+    }
+    if (!uploadOptions.publicKey || uploadOptions.publicKey.length === 0) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_PUBLIC_KEY.message));
+    }
+    if (!uploadOptions.token) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_TOKEN.message));
+    }
+    if (!uploadOptions.signature) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_SIGNATURE.message));
+    }
+    if (!uploadOptions.expire) {
+      return reject(new ImageKitInvalidRequestError(errorMessages.MISSING_EXPIRE.message));
+    }
+    if (uploadOptions.transformation) {
+      if (!(Object.keys(uploadOptions.transformation).includes("pre") || Object.keys(uploadOptions.transformation).includes("post"))) {
+        return reject(new ImageKitInvalidRequestError(errorMessages.INVALID_TRANSFORMATION.message));
+      }
+      if (Object.keys(uploadOptions.transformation).includes("pre") && !uploadOptions.transformation.pre) {
+        return reject(new ImageKitInvalidRequestError(errorMessages.INVALID_PRE_TRANSFORMATION.message));
+      }
+      if (Object.keys(uploadOptions.transformation).includes("post")) {
+        if (Array.isArray(uploadOptions.transformation.post)) {
+          for (let transformation of uploadOptions.transformation.post) {
+            if (transformation.type === "abs" && !(transformation.protocol || transformation.value)) {
+              return reject(new ImageKitInvalidRequestError(errorMessages.INVALID_POST_TRANSFORMATION.message));
+            } else if (transformation.type === "transformation" && !transformation.value) {
+              return reject(new ImageKitInvalidRequestError(errorMessages.INVALID_POST_TRANSFORMATION.message));
+            }
+          }
+        } else {
+          return reject(new ImageKitInvalidRequestError(errorMessages.INVALID_POST_TRANSFORMATION.message));
+        }
+      }
+    }
+    var formData = new FormData();
+    let key;
+    for (key in uploadOptions) {
+      if (key) {
+        if (key === "file" && typeof uploadOptions.file != "string") {
+          formData.append('file', uploadOptions.file, String(uploadOptions.fileName));
+        } else if (key === "tags" && Array.isArray(uploadOptions.tags)) {
+          formData.append('tags', uploadOptions.tags.join(","));
+        } else if (key === 'signature') {
+          formData.append("signature", uploadOptions.signature);
+        } else if (key === 'expire') {
+          formData.append("expire", String(uploadOptions.expire));
+        } else if (key === 'token') {
+          formData.append("token", uploadOptions.token);
+        } else if (key === "responseFields" && Array.isArray(uploadOptions.responseFields)) {
+          formData.append('responseFields', uploadOptions.responseFields.join(","));
+        } else if (key === "extensions" && Array.isArray(uploadOptions.extensions)) {
+          formData.append('extensions', JSON.stringify(uploadOptions.extensions));
+        } else if (key === "customMetadata" && typeof uploadOptions.customMetadata === "object" && !Array.isArray(uploadOptions.customMetadata) && uploadOptions.customMetadata !== null) {
+          formData.append('customMetadata', JSON.stringify(uploadOptions.customMetadata));
+        } else if (key === "transformation" && typeof uploadOptions.transformation === "object" && uploadOptions.transformation !== null) {
+          formData.append(key, JSON.stringify(uploadOptions.transformation));
+        } else if (key === 'checks' && uploadOptions.checks) {
+          formData.append("checks", uploadOptions.checks);
+        } else if (uploadOptions[key] !== undefined) {
+          if (["onProgress", "abortSignal"].includes(key)) continue;
+          formData.append(key, String(uploadOptions[key]));
+        }
+      }
+    }
+    formData.append("publicKey", uploadOptions.publicKey);
+    if (uploadOptions.onProgress) {
+      xhr.upload.onprogress = function (event) {
+        if (uploadOptions.onProgress) uploadOptions.onProgress(event);
+      };
+    }
+    function onAbortHandler() {
+      var _uploadOptions$abortS;
+      xhr.abort();
+      return reject(new ImageKitAbortError("Upload aborted", (_uploadOptions$abortS = uploadOptions.abortSignal) === null || _uploadOptions$abortS === void 0 ? void 0 : _uploadOptions$abortS.reason));
+    }
+    if (uploadOptions.abortSignal) {
+      if (uploadOptions.abortSignal.aborted) {
+        var _uploadOptions$abortS2;
+        return reject(new ImageKitAbortError("Upload aborted", (_uploadOptions$abortS2 = uploadOptions.abortSignal) === null || _uploadOptions$abortS2 === void 0 ? void 0 : _uploadOptions$abortS2.reason));
+      }
+      uploadOptions.abortSignal.addEventListener("abort", onAbortHandler);
+      xhr.addEventListener("loadend", () => {
+        if (uploadOptions.abortSignal) {
+          uploadOptions.abortSignal.removeEventListener("abort", onAbortHandler);
+        }
+      });
+    }
+    xhr.open('POST', 'https://upload.imagekit.io/api/v1/files/upload');
+    xhr.onerror = function (e) {
+      return reject(new ImageKitUploadNetworkError(errorMessages.UPLOAD_ENDPOINT_NETWORK_ERROR.message));
+    };
+    xhr.onload = function () {
+      if (xhr.status >= 200 && xhr.status < 300) {
+        try {
+          var body = JSON.parse(xhr.responseText);
+          var uploadResponse = addResponseHeadersAndBody(body, xhr);
+          return resolve(uploadResponse);
+        } catch (ex) {
+          return reject(ex);
+        }
+      } else if (xhr.status >= 400 && xhr.status < 500) {
+        try {
+          var body = JSON.parse(xhr.responseText);
+          return reject(new ImageKitInvalidRequestError(body.message ?? "Invalid request. Please check the parameters.", getResponseMetadata(xhr)));
+        } catch (ex) {
+          return reject(ex);
+        }
+      } else {
+        try {
+          var body = JSON.parse(xhr.responseText);
+          return reject(new ImageKitServerError(body.message ?? "Server error occurred while uploading the file. This is rare and usually temporary.", getResponseMetadata(xhr)));
+        } catch (ex) {
+          return reject(new ImageKitServerError("Server error occurred while uploading the file. This is rare and usually temporary.", getResponseMetadata(xhr)));
+        }
+      }
+    };
+    xhr.send(formData);
+  });
+};
+const addResponseHeadersAndBody = (body, xhr) => {
+  let response = {
+    ...body
+  };
+  const responseMetadata = getResponseMetadata(xhr);
+  Object.defineProperty(response, "$ResponseMetadata", {
+    value: responseMetadata,
+    enumerable: false,
+    writable: false
+  });
+  return response;
+};
+const getResponseMetadata = xhr => {
+  const headers = getResponseHeaderMap(xhr);
+  const responseMetadata = {
+    statusCode: xhr.status,
+    headers: headers,
+    requestId: headers["x-request-id"]
+  };
+  return responseMetadata;
+};
+function getResponseHeaderMap(xhr) {
+  const headers = {};
+  const responseHeaders = xhr.getAllResponseHeaders();
+  if (Object.keys(responseHeaders).length) {
+    responseHeaders.trim().split(/[\r\n]+/).map(value => value.split(/: /)).forEach(keyValue => {
+      headers[keyValue[0].trim().toLowerCase()] = keyValue[1].trim();
+    });
+  }
+  return headers;
+}
+
+const supportedTransforms = {
+  width: "w",
+  height: "h",
+  aspectRatio: "ar",
+  background: "bg",
+  border: "b",
+  crop: "c",
+  cropMode: "cm",
+  dpr: "dpr",
+  focus: "fo",
+  quality: "q",
+  x: "x",
+  xCenter: "xc",
+  y: "y",
+  yCenter: "yc",
+  format: "f",
+  videoCodec: "vc",
+  audioCodec: "ac",
+  radius: "r",
+  rotation: "rt",
+  blur: "bl",
+  named: "n",
+  defaultImage: "di",
+  flip: "fl",
+  original: "orig",
+  startOffset: "so",
+  endOffset: "eo",
+  duration: "du",
+  streamingResolutions: "sr",
+  grayscale: "e-grayscale",
+  aiUpscale: "e-upscale",
+  aiRetouch: "e-retouch",
+  aiVariation: "e-genvar",
+  aiDropShadow: "e-dropshadow",
+  aiChangeBackground: "e-changebg",
+  aiRemoveBackground: "e-bgremove",
+  aiRemoveBackgroundExternal: "e-removedotbg",
+  contrastStretch: "e-contrast",
+  shadow: "e-shadow",
+  sharpen: "e-sharpen",
+  unsharpMask: "e-usm",
+  gradient: "e-gradient",
+  progressive: "pr",
+  lossless: "lo",
+  colorProfile: "cp",
+  metadata: "md",
+  opacity: "o",
+  trim: "t",
+  zoom: "z",
+  page: "pg",
+  fontSize: "fs",
+  fontFamily: "ff",
+  fontColor: "co",
+  innerAlignment: "ia",
+  padding: "pa",
+  alpha: "al",
+  typography: "tg",
+  lineHeight: "lh",
+  fontOutline: "fol",
+  fontShadow: "fsh",
+  raw: "raw"
+};
+
+const QUERY_TRANSFORMATION_POSITION = "query";
+const CHAIN_TRANSFORM_DELIMITER = ":";
+const TRANSFORM_DELIMITER = ",";
+const TRANSFORM_KEY_VALUE_DELIMITER = "-";
+var transformationUtils = {
+  addAsQueryParameter: options => {
+    return options.transformationPosition === QUERY_TRANSFORMATION_POSITION;
+  },
+  getTransformKey: function (transform) {
+    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;
+  }
+};
+const safeBtoa = function (str) {
+  if (typeof window !== "undefined") {
+    return btoa(str);
+  } else {
+    return Buffer.from(str, "utf8").toString("base64");
+  }
+};
+
+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-._ ]*$');
+function removeTrailingSlash(str) {
+  if (typeof str == "string" && str[str.length - 1] == "/") {
+    str = str.substring(0, str.length - 1);
+  }
+  return str;
+}
+function removeLeadingSlash(str) {
+  if (typeof str == "string" && str[0] == "/") {
+    str = str.slice(1);
+  }
+  return str;
+}
+function pathJoin(parts, sep) {
+  var separator = sep || "/";
+  var replace = new RegExp(separator + "{1,}", "g");
+  return parts.join(separator).replace(replace, separator);
+}
+const buildSrc = opts => {
+  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() !== "") {
+        return `${urlObj.href}&${TRANSFORMATION_PARAMETER}=${transformationString}`;
+      } else {
+        return `${urlObj.href}?${TRANSFORMATION_PARAMETER}=${transformationString}`;
+      }
+    }
+  }
+  return urlObj.href;
+};
+function processInputPath(str, enccoding) {
+  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, enccoding) {
+  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) {
+  const entries = [];
+  const {
+    type,
+    position = {},
+    timing = {},
+    transformation = []
+  } = overlay || {};
+  if (!type) {
+    return;
+  }
+  switch (type) {
+    case "text":
+      {
+        const textOverlay = overlay;
+        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;
+        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;
+        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;
+        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;
+        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());
+}
+const buildTransformationString = function (transformation) {
+  if (!Array.isArray(transformation)) {
+    return "";
+  }
+  var parsedTransforms = [];
+  for (var i = 0, l = transformation.length; i < l; i++) {
+    var parsedTransformStep = [];
+    for (var key in transformation[i]) {
+      let value = transformation[i][key];
+      if (value === undefined || value === null) {
+        continue;
+      }
+      if (key === "overlay" && typeof value === "object") {
+        var rawString = processOverlay(value);
+        if (rawString && rawString.trim() !== "") {
+          parsedTransformStep.push(rawString);
+        }
+        continue;
+      }
+      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 {
+          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]);
+      } else {
+        if (transformKey === "di") {
+          value = removeTrailingSlash(removeLeadingSlash(value || ""));
+          value = value.replace(/\//g, "@@");
+        }
+        if (transformKey === "sr" && Array.isArray(value)) {
+          value = value.join("_");
+        }
+        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());
+};
+
+export { ImageKitAbortError, ImageKitInvalidRequestError, ImageKitServerError, ImageKitUploadNetworkError, buildSrc, buildTransformationString, upload };

package/dist/imagekit.min.js

@@ -0,0 +1 @@
+!function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports):"function"==typeof define&&define.amd?define(["exports"],r):r((e="undefined"!=typeof globalThis?globalThis:e||self).ImageKit={})}(this,(function(e){"use strict";var r={message:"Missing file parameter for upload"},t={message:"Missing fileName parameter for upload"},n={message:"Missing public key for upload"},a={message:"Request to ImageKit upload endpoint failed due to network error"},s={message:"Missing signature for upload. The SDK expects token, signature and expire for authentication."},o={message:"Missing token for upload. The SDK expects token, signature and expire for authentication."},i={message:"Missing expire for upload. The SDK expects token, signature and expire for authentication."},u={message:"Invalid transformation parameter. Please include at least pre, post, or both."},p={message:"Invalid pre transformation parameter."},l={message:"Invalid post transformation parameter."};class c extends Error{constructor(e,r){super(e),this.$ResponseMetadata=void 0,this.name="ImageKitInvalidRequestError",this.$ResponseMetadata=r}}class d extends Error{constructor(e,r){super(e),this.reason=void 0,this.name="ImageKitAbortError",this.reason=r}}class f extends Error{constructor(e){super(e),this.name="ImageKitUploadNetworkError"}}class g extends Error{constructor(e,r){super(e),this.$ResponseMetadata=void 0,this.name="ImageKitServerError",this.$ResponseMetadata=r}}const m=(e,r)=>{let t={...e};const n=h(r);return Object.defineProperty(t,"$ResponseMetadata",{value:n,enumerable:!1,writable:!1}),t},h=e=>{const r=function(e){const r={},t=e.getAllResponseHeaders();Object.keys(t).length&&t.trim().split(/[\r\n]+/).map(e=>e.split(/: /)).forEach(e=>{r[e[0].trim().toLowerCase()]=e[1].trim()});return r}(e);return{statusCode:e.status,headers:r,requestId:r["x-request-id"]}};const y={width:"w",height:"h",aspectRatio:"ar",background:"bg",border:"b",crop:"c",cropMode:"cm",dpr:"dpr",focus:"fo",quality:"q",x:"x",xCenter:"xc",y:"y",yCenter:"yc",format:"f",videoCodec:"vc",audioCodec:"ac",radius:"r",rotation:"rt",blur:"bl",named:"n",defaultImage:"di",flip:"fl",original:"orig",startOffset:"so",endOffset:"eo",duration:"du",streamingResolutions:"sr",grayscale:"e-grayscale",aiUpscale:"e-upscale",aiRetouch:"e-retouch",aiVariation:"e-genvar",aiDropShadow:"e-dropshadow",aiChangeBackground:"e-changebg",aiRemoveBackground:"e-bgremove",aiRemoveBackgroundExternal:"e-removedotbg",contrastStretch:"e-contrast",shadow:"e-shadow",sharpen:"e-sharpen",unsharpMask:"e-usm",gradient:"e-gradient",progressive:"pr",lossless:"lo",colorProfile:"cp",metadata:"md",opacity:"o",trim:"t",zoom:"z",page:"pg",fontSize:"fs",fontFamily:"ff",fontColor:"co",innerAlignment:"ia",padding:"pa",alpha:"al",typography:"tg",lineHeight:"lh",fontOutline:"fol",fontShadow:"fsh",raw:"raw"};var b=e=>"query"===e.transformationPosition,v=function(e){return e&&(y[e]||y[e.toLowerCase()])||""},w=function(){return":"},x=function(){return","},S=function(){return"-"};const k=function(e){return"undefined"!=typeof window?btoa(e):Buffer.from(e,"utf8").toString("base64")},R=new RegExp("^[a-zA-Z0-9-._/ ]*$"),I=new RegExp("^[a-zA-Z0-9-._ ]*$");function E(e){return"string"==typeof e&&"/"==e[e.length-1]&&(e=e.substring(0,e.length-1)),e}function M(e){return"string"==typeof e&&"/"==e[0]&&(e=e.slice(1)),e}function j(e,r){var t=r||"/",n=new RegExp(t+"{1,}","g");return e.join(t).replace(n,t)}function A(e,r){return e=E(M(e)),"plain"===r?"i-"+e.replace(/\//g,"@@"):"base64"===r?"ie-"+encodeURIComponent(k(e)):R.test(e)?"i-"+e.replace(/\//g,"@@"):"ie-"+encodeURIComponent(k(e))}function P(e){const r=[],{type:t,position:n={},timing:a={},transformation:s=[]}=e||{};if(!t)return;switch(t){case"text":{const t=e;if(!t.text)return;const n=t.encoding||"auto";r.push("l-text"),r.push(function(e,r){return"plain"===r?"i-"+encodeURIComponent(e):"base64"===r?"ie-"+encodeURIComponent(k(e)):I.test(e)?"i-"+encodeURIComponent(e):"ie-"+encodeURIComponent(k(e))}(t.text,n))}break;case"image":r.push("l-image");{const t=e,n=t.encoding||"auto";if(!t.input)return;r.push(A(t.input,n))}break;case"video":r.push("l-video");{const t=e,n=t.encoding||"auto";if(!t.input)return;r.push(A(t.input,n))}break;case"subtitle":r.push("l-subtitle");{const t=e,n=t.encoding||"auto";if(!t.input)return;r.push(A(t.input,n))}break;case"solidColor":r.push("l-image"),r.push("i-ik_canvas");{const t=e;if(!t.color)return;r.push("bg-"+t.color)}}const{x:o,y:i,focus:u}=n;o&&r.push("lx-"+o),i&&r.push("ly-"+i),u&&r.push("lfo-"+u);const{start:p,end:l,duration:c}=a;p&&r.push("lso-"+p),l&&r.push("leo-"+l),c&&r.push("ldu-"+c);const d=K(s);return d&&""!==d.trim()&&r.push(d),r.push("l-end"),r.join(x())}const K=function(e){if(!Array.isArray(e))return"";for(var r=[],t=0,n=e.length;t<n;t++){var a=[];for(var s in e[t]){let r=e[t][s];if(null!=r)if("overlay"!==s||"object"!=typeof r){var o=v(s);if(o||(o=s),""!==o)if(["e-grayscale","e-contrast","e-removedotbg","e-bgremove","e-upscale","e-retouch","e-genvar"].includes(o)){if(!0!==r&&"-"!==r&&"true"!==r)continue;a.push(o)}else!["e-sharpen","e-shadow","e-gradient","e-usm","e-dropshadow"].includes(o)||""!==r.toString().trim()&&!0!==r&&"true"!==r?"raw"===s?a.push(e[t][s]):("di"===o&&(r=E(M(r||"")),r=r.replace(/\//g,"@@")),"sr"===o&&Array.isArray(r)&&(r=r.join("_")),"t"===o&&""===r.toString().trim()&&(r="true"),a.push([o,r].join(S()))):a.push(o)}else{var i=P(r);i&&""!==i.trim()&&a.push(i)}}a.length&&r.push(a.join(x()))}return r.join(w())};e.ImageKitAbortError=d,e.ImageKitInvalidRequestError=c,e.ImageKitServerError=g,e.ImageKitUploadNetworkError=f,e.buildSrc=e=>{if(e.urlEndpoint=e.urlEndpoint||"",e.src=e.src||"",e.transformationPosition=e.transformationPosition||"query",!e.src)return"";const r=e.src.startsWith("http://")||e.src.startsWith("https://");var t,n,a;try{r?(t=new URL(e.src),n=!0):(a=new URL(e.urlEndpoint).pathname,t=new URL(j([e.urlEndpoint.replace(a,""),e.src])))}catch(e){return console.error(e),""}for(var s in e.queryParameters)t.searchParams.append(s,String(e.queryParameters[s]));var o=K(e.transformation);return o&&o.length&&(b(e)||n||(t.pathname=j(["tr"+w()+o,t.pathname]))),t.pathname=j(a?[a,t.pathname]:[t.pathname]),o&&o.length&&(b(e)||n)?""!==t.searchParams.toString()?`${t.href}&tr=${o}`:`${t.href}?tr=${o}`:t.href},e.buildTransformationString=K,e.upload=e=>e?new Promise((y,b)=>{const{xhr:v}=e||{};delete e.xhr;const w=v||new XMLHttpRequest;if(!e.file)return b(new c(r.message));if(!e.fileName)return b(new c(t.message));if(!e.publicKey||0===e.publicKey.length)return b(new c(n.message));if(!e.token)return b(new c(o.message));if(!e.signature)return b(new c(s.message));if(!e.expire)return b(new c(i.message));if(e.transformation){if(!Object.keys(e.transformation).includes("pre")&&!Object.keys(e.transformation).includes("post"))return b(new c(u.message));if(Object.keys(e.transformation).includes("pre")&&!e.transformation.pre)return b(new c(p.message));if(Object.keys(e.transformation).includes("post")){if(!Array.isArray(e.transformation.post))return b(new c(l.message));for(let r of e.transformation.post){if("abs"===r.type&&!r.protocol&&!r.value)return b(new c(l.message));if("transformation"===r.type&&!r.value)return b(new c(l.message))}}}var x=new FormData;let S;for(S in e)if(S)if("file"===S&&"string"!=typeof e.file)x.append("file",e.file,String(e.fileName));else if("tags"===S&&Array.isArray(e.tags))x.append("tags",e.tags.join(","));else if("signature"===S)x.append("signature",e.signature);else if("expire"===S)x.append("expire",String(e.expire));else if("token"===S)x.append("token",e.token);else if("responseFields"===S&&Array.isArray(e.responseFields))x.append("responseFields",e.responseFields.join(","));else if("extensions"===S&&Array.isArray(e.extensions))x.append("extensions",JSON.stringify(e.extensions));else if("customMetadata"!==S||"object"!=typeof e.customMetadata||Array.isArray(e.customMetadata)||null===e.customMetadata){if("transformation"===S&&"object"==typeof e.transformation&&null!==e.transformation)x.append(S,JSON.stringify(e.transformation));else if("checks"===S&&e.checks)x.append("checks",e.checks);else if(void 0!==e[S]){if(["onProgress","abortSignal"].includes(S))continue;x.append(S,String(e[S]))}}else x.append("customMetadata",JSON.stringify(e.customMetadata));function k(){var r;return w.abort(),b(new d("Upload aborted",null===(r=e.abortSignal)||void 0===r?void 0:r.reason))}if(x.append("publicKey",e.publicKey),e.onProgress&&(w.upload.onprogress=function(r){e.onProgress&&e.onProgress(r)}),e.abortSignal){var R;if(e.abortSignal.aborted)return b(new d("Upload aborted",null===(R=e.abortSignal)||void 0===R?void 0:R.reason));e.abortSignal.addEventListener("abort",k),w.addEventListener("loadend",()=>{e.abortSignal&&e.abortSignal.removeEventListener("abort",k)})}w.open("POST","https://upload.imagekit.io/api/v1/files/upload"),w.onerror=function(e){return b(new f(a.message))},w.onload=function(){if(w.status>=200&&w.status<300)try{var e=JSON.parse(w.responseText),r=m(e,w);return y(r)}catch(e){return b(e)}else if(w.status>=400&&w.status<500)try{e=JSON.parse(w.responseText);return b(new c(e.message??"Invalid request. Please check the parameters.",h(w)))}catch(e){return b(e)}else try{e=JSON.parse(w.responseText);return b(new g(e.message??"Server error occurred while uploading the file. This is rare and usually temporary.",h(w)))}catch(e){return b(new g("Server error occurred while uploading the file. This is rare and usually temporary.",h(w)))}},w.send(x)}):Promise.reject(new c("Invalid options provided for upload")),Object.defineProperty(e,"__esModule",{value:!0})}));

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { SrcOptions, Transformation, UploadOptions, UploadResponse } from "./interfaces";
+import { ImageKitAbortError, ImageKitInvalidRequestError, ImageKitServerError, ImageKitUploadNetworkError, upload } from "./upload";
+import { buildSrc, buildTransformationString } from "./url";
+export { buildSrc, buildTransformationString, upload, ImageKitInvalidRequestError, ImageKitAbortError, ImageKitServerError, ImageKitUploadNetworkError };
+export type { Transformation, SrcOptions, UploadOptions, UploadResponse };

package/dist/interfaces/SrcOptions.d.ts

@@ -0,0 +1,32 @@
+import { Transformation } from "./Transformation";
+import { TransformationPosition } from ".";
+export interface SrcOptions {
+    /**
+     * Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`.
+     * If an absolute path is provided, `urlEndpoint` is ignored.
+     */
+    src: string;
+    /**
+     * Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints).
+     */
+    urlEndpoint: string;
+    /**
+     * An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations.
+     *
+     * {@link https://imagekit.io/docs/transformations#chained-transformations}
+     */
+    transformation?: Array<Transformation>;
+    /**
+     * These are additional query parameters that you want to add to the final URL.
+     * They can be any query parameters and not necessarily related to ImageKit.
+     * This is especially useful if you want to add a versioning parameter to your URLs.
+     */
+    queryParameters?: {
+        [key: string]: string | number;
+    };
+    /**
+     * By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`.
+     * If you want to add the transformation string in the path of the URL, set this to `path`.
+     */
+    transformationPosition?: TransformationPosition;
+}