added promise support, new api parameters

Author: dev-saad07

src/constants/supportedTransforms.ts

@@ -281,6 +281,11 @@ const supportedTransforms: { [key: string]: string } = {
    * @link https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#original-image-orig
    */
   original: "orig",
+
+  /**
+   * @link https://docs.imagekit.io/features/image-transformations/conditional-transformations
+   */
+   raw: "raw",
 }
 
 

src/index.ts

@@ -13,6 +13,31 @@ function privateKeyPassed(options: ImageKitOptions) {
   return typeof (options as any).privateKey != "undefined";
 }
 
+const promisify = function <T = void>(thisContext: ImageKit, fn: Function) {
+  return function (...args: any[]): Promise<T> | void {
+    console.log('arg: ', args);
+    if (args.length === fn.length && typeof args[args.length - 1] !== "undefined") {
+      if (typeof args[args.length - 1] !== "function") {
+        throw new Error("Callback must be a function.");
+      }
+      fn.call(thisContext, ...args);
+    } else {
+      return new Promise<T>((resolve, reject) => {
+        const callback = function (err: Error, ...results: any[]) {
+          if (err) {
+            return reject(err);
+          } else {
+            resolve(results.length > 1 ? results : results[0]);
+          }
+        };
+        args.pop()
+        args.push(callback);
+        fn.call(thisContext, ...args);
+      });
+    }
+  };
+};
+
 class ImageKit {
   options: ImageKitOptions = {
     sdkVersion: `javascript-${version}`,
@@ -58,16 +83,20 @@ class ImageKit {
    *
    * @param uploadOptions
    */
-  upload(
-    uploadOptions: UploadOptions,
-    callback?: (err: Error | null, response: UploadResponse | null) => void,
-    options?: Partial<ImageKitOptions>,
-  ): void {
-    var mergedOptions = {
+  upload(uploadOptions: UploadOptions, options?: Partial<ImageKitOptions>): Promise<UploadResponse>
+  upload(uploadOptions: UploadOptions, callback: (err: Error | null, response: UploadResponse | null) => void, options?: Partial<ImageKitOptions>): void;
+  upload(uploadOptions: UploadOptions, callbackOrOptions?: ((err: Error | null, response: UploadResponse | null) => void) | Partial<ImageKitOptions>, options?: Partial<ImageKitOptions>): void | Promise<UploadResponse> {
+    let callback;
+    if (typeof callbackOrOptions === 'function') {
+      callback = callbackOrOptions;
+    } else {
+      options = callbackOrOptions || {};
+    }
+    var mergedOptions = { 
       ...this.options,
       ...options,
     };
-    return upload(uploadOptions, mergedOptions, callback);
+    return promisify<UploadResponse>(this, upload)(uploadOptions, mergedOptions, callback);
   }
 }
 

src/interfaces/UploadOptions.ts

@@ -75,4 +75,22 @@ export interface UploadOptions {
    * Final status of pending extensions will be sent to this URL. 
    */
   webhookUrl?: string
+  /*
+   * Default is true. If overwriteFile is set to false and useUniqueFileName is also false, and a file already exists at the exact location, upload API will return an error immediately.
+   */
+  overwriteFile?: boolean
+  /*
+   * Default is true. If set to true and a file already exists at the exact location, its AITags will be removed. Set overwriteAITags to false to preserve AITags.
+   */
+  overwriteAITags?: boolean
+  /*
+   * Default is true. If the request does not have tags , overwriteTags is set to true and a file already exists at the exact location, exiting tags will be removed.
+   * In case the request body has tags, setting overwriteTags to false has no effect and request's tags are set on the asset.
+   */
+  overwriteTags?: boolean
+  /*
+   * Default is true. If the request does not have customMetadata , overwriteCustomMetadata is set to true and a file already exists at the exact location, exiting customMetadata will be removed.
+   * In case the request body has customMetadata, setting overwriteCustomMetadata to false has no effect and request's customMetadata is set on the asset.
+   */
+  overwriteCustomMetadata?: boolean
 }

test/url-generation.js

@@ -337,11 +337,11 @@ describe("URL generation", function () {
                 effectContrast: true,
                 effectGray: true,
                 original: true,
-                raw: "this_should_come_as_it_is"
+                raw: "h-200,w-300,l-image,i-logo.png,l-end"
             }]
         })
 
-        expect(url).equal(`https://ik.imagekit.io/test_url_endpoint/tr:h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,ox-35,oy-35,ofo-bottom,oh-20,ow-20,oi-folder@@file.jpg,oit-false,oiar-4:3,oibg-0F0F0F,oib-10_0F0F0F,oidpr-2,oiq-50,oic-force,ot-two%20words,ots-20,otf-Open%20Sans,otc-00FFFF,oa-5,ott-b,obg-00AAFF55,ote-b3ZlcmxheSBtYWRlIGVhc3k%3D,otw-50,otbg-00AAFF55,otp-40,otia-left,or-10,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,e-contrast-true,e-grayscale-true,orig-true,this_should_come_as_it_is/test_path.jpg?ik-sdk-version=javascript-${pkg.version}`);
+        expect(url).equal(`https://ik.imagekit.io/test_url_endpoint/tr:h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,ox-35,oy-35,ofo-bottom,oh-20,ow-20,oi-folder@@file.jpg,oit-false,oiar-4:3,oibg-0F0F0F,oib-10_0F0F0F,oidpr-2,oiq-50,oic-force,ot-two%20words,ots-20,otf-Open%20Sans,otc-00FFFF,oa-5,ott-b,obg-00AAFF55,ote-b3ZlcmxheSBtYWRlIGVhc3k%3D,otw-50,otbg-00AAFF55,otp-40,otia-left,or-10,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,e-contrast-true,e-grayscale-true,orig-true,h-200,w-300,l-image,i-logo.png,l-end/test_path.jpg?ik-sdk-version=javascript-${pkg.version}`);
     });
 });