Merge pull request #95 from imagekit-developer/layer-support

Layer support

Author: imagekitio

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Version 4.0.0
+
+### Breaking Changes
+
+1. The default value for `transformationPosition` is now `query` instead of `path`. This change enables wildcard cache purging to remove CDN cache for all generated transformations.
+
+   **Action Required:**  
+   If you're using the `transformationPosition` parameter in the `url` method and want to apply transformations in the path, you must now explicitly set the value to `path`. The default is `query`.
+
+2. Removed the following deprecated parameters:  
+   `effectSharpen`, `effectUSM`, `effectContrast`, `effectGray`, `effectShadow`, `effectGradient`, and `rotate`.
+
+### Other Changes
+
+1. Native support for overlays has been added. See the README for usage examples.
+2. New AI-powered transformations are now supported:  
+   `aiRemoveBackground`, `aiUpscale`, `aiVariation`, `aiDropShadow`, `aiChangeBackground`, and more.  
+   *(Introduced in version 3.1.0)*
+
+---
+
 ## SDK Version 3.0.0
 
 ### Breaking Changes

README.md

@@ -1,6 +1,6 @@
 {
     "name": "imagekit-javascript",
-    "version": "3.1.0",
+    "version": "4.0.0",
     "description": "Javascript SDK for using ImageKit.io in the browser",
     "main": "dist/imagekit.cjs.js",
     "module": "dist/imagekit.esm.js",
@@ -43,7 +43,7 @@
         "dev": "rollup -c -w",
         "export-types": "tsc",
         "build": "rm -rf dist*;rollup -c && yarn export-types",
-        "test": "NODE_ENV=test nyc ./node_modules/mocha/bin/mocha test/*.js",
+        "test": "NODE_ENV=test nyc ./node_modules/mocha/bin/mocha \"test/**/*.js\"",
         "startSampleApp": "yarn build && cd samples/sample-app/ && yarn install && node index.js",
         "report-coverage": "codecov"
     },
@@ -56,13 +56,13 @@
         "javascript",
         "sdk",
         "js",
-        "sdk",
         "image",
         "optimization",
-        "image",
         "transformation",
-        "image",
-        "resize"
+        "resize",
+        "upload",
+        "video",
+        "overlay"
     ],
     "author": "ImageKit Developer",
     "license": "MIT",

package-lock.json

@@ -32,15 +32,6 @@ export const supportedTransforms: { [key: string]: string } = {
   duration: "du",
   streamingResolutions: "sr",
 
-  // Old deprecated mappings
-  effectSharpen: "e-sharpen",
-  effectUSM: "e-usm",
-  effectContrast: "e-contrast",
-  effectGray: "e-grayscale",
-  effectShadow: "e-shadow",
-  effectGradient: "e-gradient",
-  rotate: "rt",
-
   // AI & advanced effects
   grayscale: "e-grayscale",
   aiUpscale: "e-upscale",
@@ -66,6 +57,20 @@ export const supportedTransforms: { [key: string]: string } = {
   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",
 };

package.json

@@ -37,13 +37,12 @@ const promisify = function <T = void>(thisContext: ImageKit, fn: Function) {
 
 class ImageKit {
   options: ImageKitOptions = {
-    sdkVersion: `javascript-${version}`,
     publicKey: "",
     urlEndpoint: "",
     transformationPosition: transformationUtils.getDefault(),
   };
 
-  constructor(opts: Omit<ImageKitOptions, "sdkVersion">) {
+  constructor(opts: ImageKitOptions) {
     this.options = { ...this.options, ...(opts || {}) };
     if (!mandatoryParametersAvailable(this.options)) {
       throw errorMessages.MANDATORY_INITIALIZATION_MISSING;

src/constants/supportedTransforms.ts

@@ -2,7 +2,6 @@ import { TransformationPosition } from ".";
 
 export interface ImageKitOptions {
   urlEndpoint: string;
-  sdkVersion?: string;
   publicKey?: string;
   transformationPosition?: TransformationPosition;
 }