Merge pull request #36 from abhinavr4/feat/upload-options

Adding new upload options

Author: imagekitio

libs/interfaces/UploadOptions.ts

@@ -76,5 +76,12 @@ export interface UploadOptions {
   /*
    * Final status of pending extensions will be sent to this URL. 
    */
-  webhookUrl?: string
+  webhookUrl?: string;
+  overwriteFile?: boolean;
+  overwriteAITags?: boolean;
+  overwriteTags?: boolean;
+  overwriteCustomMetadata?: boolean;
+  customMetadata?: {
+    [key: string]: string | number | boolean | Array<string | number | boolean>;
+  }
 }

libs/upload/index.ts

@@ -14,6 +14,11 @@ type FormDataOptions = Modify<
     isPrivateFile: string;
     extensions?: string;
     webhookUrl?: string;
+    overwriteFile?: string;
+    overwriteAITags?: string;
+    overwriteTags?: string;
+    overwriteCustomMetadata?: string;
+    customMetadata?: string;
   }
 >;
 
@@ -55,6 +60,9 @@ export default function (
       }
         else if(key == "extensions" && Array.isArray(uploadOptions.extensions)){
           formData.extensions = JSON.stringify(uploadOptions.extensions);
+      } else if (key === "customMetadata" && typeof uploadOptions.customMetadata === "object" &&
+                        !Array.isArray(uploadOptions.customMetadata) && uploadOptions.customMetadata !== null) {
+          formData.customMetadata = JSON.stringify(uploadOptions.customMetadata)
       }
        else {
         formData[key] = String(uploadOptions[key]);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "imagekit",
-  "version": "3.2.4",
+  "version": "3.2.5",
   "description": "Offical NodeJS SDK for ImageKit.io integration",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

tests/upload.js

@@ -107,11 +107,20 @@ describe("File upload", function () {
                     maxTags: 10
                 }
             ],
-            webhookUrl: "https://your-domain/?appId=some-id"
+            webhookUrl: "https://your-domain/?appId=some-id",
+            overwriteFile: true,
+            overwriteAITags: false,
+            overwriteTags: true,
+            overwriteCustomMetadata: false,
+            customMetadata: {
+                brand: "Nike",
+                color: "red"
+            },
         };
 
         var callback = sinon.spy();
         var jsonStringifiedExtensions = JSON.stringify(fileOptions.extensions);
+        const customMetadata = JSON.stringify(fileOptions.customMetadata);
 
         const scope = nock('https://upload.imagekit.io/api')
             .post('/v1/files/upload')
@@ -127,6 +136,11 @@ describe("File upload", function () {
                 checkFormData({requestBody,boundary,fieldName:"responseFields",fieldValue:"tags,metadata"});
                 checkFormData({requestBody,boundary,fieldName:"extensions",fieldValue:jsonStringifiedExtensions});
                 checkFormData({requestBody,boundary,fieldName:"webhookUrl",fieldValue:"https://your-domain/?appId=some-id"});
+                checkFormData({requestBody,boundary,fieldName:"overwriteFile",fieldValue:"true"});
+                checkFormData({requestBody,boundary,fieldName:"overwriteAITags",fieldValue:"false"});
+                checkFormData({requestBody,boundary,fieldName:"overwriteTags",fieldValue:"true"});
+                checkFormData({requestBody,boundary,fieldName:"overwriteCustomMetadata",fieldValue:"false"});
+                checkFormData({requestBody,boundary,fieldName:"customMetadata",fieldValue:customMetadata});
                 done()
               })