@imagekit/javascript 5.0.0-beta.7 → 5.0.0

package/README.md

@@ -2,8 +2,6 @@
 
 # ImageKit.io JavaScript SDK
 
-![gzip size](https://img.badgesize.io/https://unpkg.com/@imagekit/javascript/dist/imagekit.min.js?compression=gzip&label=gzip)
-![brotli size](https://img.badgesize.io/https://unpkg.com/@imagekit/javascript/dist/imagekit.min.js?compression=brotli&label=brotli)
 ![Node CI](https://github.com/imagekit-developer/imagekit-javascript/workflows/Node%20CI/badge.svg)
 [![npm version](https://img.shields.io/npm/v/@imagekit/javascript)](https://www.npmjs.com/package/@imagekit/javascript) 
 [![codecov](https://codecov.io/gh/imagekit-developer/imagekit-javascript/branch/master/graph/badge.svg)](https://codecov.io/gh/imagekit-developer/imagekit-javascript)

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SrcOptions, Transformation, UploadOptions, UploadResponse } from "./interfaces";
+import type { 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 };

package/dist/interfaces/UploadOptions.d.ts

@@ -16,6 +16,8 @@ interface Transformation {
     /**
      * Specifies pre-transformations to be applied. Must be a valid string of transformations like "w-300,h-300".
      * Refer to the docs for more details on transformations.
+     *
+     * {@link https://imagekit.io/docs/dam/pre-and-post-transformation-on-upload#pre-transformation}
      */
     pre?: string;
     /**
@@ -25,6 +27,8 @@ interface Transformation {
      *  - protocol: Used only when type is "abs". Can be "hls" or "dash".
      *
      * Refer to the docs for more details on transformations and usage in post.
+     *
+     * {@link https://imagekit.io/docs/dam/pre-and-post-transformation-on-upload#post-transformation}
      */
     post?: PostTransformation[];
 }

package/dist/upload.d.ts

@@ -1,4 +1,4 @@
-import { ResponseMetadata, UploadOptions, UploadResponse } from "./interfaces";
+import type { ResponseMetadata, UploadOptions, UploadResponse } from "./interfaces";
 /**
  * Represents an error when a request to ImageKit is invalid.
  */

package/dist/url.d.ts

@@ -1,5 +1,5 @@
-import { SrcOptions } from "./interfaces";
-import { Transformation } from "./interfaces/Transformation";
+import type { SrcOptions } from "./interfaces";
+import type { Transformation } from "./interfaces/Transformation";
 /**
  * Builds a source URL with the given options.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@imagekit/javascript",
-    "version": "5.0.0-beta.7",
+    "version": "5.0.0",
     "description": "ImageKit Javascript SDK",
     "main": "dist/imagekit.cjs.js",
     "module": "dist/imagekit.esm.js",
@@ -8,8 +8,7 @@
     "unpkg": "dist/imagekit.min.js",
     "types": "dist/index.d.ts",
     "files": [
-        "dist",
-        "src"
+        "dist"
     ],
     "devDependencies": {
         "@babel/cli": "^7.10.5",

package/src/constants/errorMessages.ts

@@ -1,14 +0,0 @@
-export default {
-  MISSING_UPLOAD_FILE_PARAMETER: { message: "Missing file parameter for upload" },
-  MISSING_UPLOAD_FILENAME_PARAMETER: { message: "Missing fileName parameter for upload" },
-  MISSING_PUBLIC_KEY: { message: "Missing public key for upload" },
-  UPLOAD_ENDPOINT_NETWORK_ERROR: {
-    message: "Request to ImageKit upload endpoint failed due to network error"
-  },
-  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." }
-};

package/src/constants/supportedTransforms.ts

@@ -1,80 +0,0 @@
-/**
- * {@link https://imagekit.io/docs/transformations}
- */
-export const supportedTransforms: { [key: string]: string } = {
-  // Basic sizing & layout
-  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",
-
-  // AI & advanced effects
-  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",
-
-  // Other flags & finishing
-  progressive: "pr",
-  lossless: "lo",
-  colorProfile: "cp",
-  metadata: "md",
-  opacity: "o",
-  trim: "t",
-  zoom: "z",
-  page: "pg",
-
-  // Text overlay transformations which are not defined yet
-  fontSize: "fs",
-  fontFamily: "ff",
-  fontColor: "co",
-  innerAlignment: "ia",
-  padding: "pa",
-  alpha: "al",
-  typography: "tg",
-  lineHeight: "lh",
-
-  // Subtitles transformations which are not defined
-  fontOutline: "fol",
-  fontShadow: "fsh",
-
-  // Raw pass-through
-  raw: "raw",
-};
-
-
-
-export default supportedTransforms

package/src/index.ts

@@ -1,13 +0,0 @@
-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/src/interfaces/SrcOptions.ts

@@ -1,35 +0,0 @@
-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;
-}