Added sample app. Promisification. Bulk Delete API. Sample App.

Author: Jagveer

.gitignore

@@ -1 +1,2 @@
 node_modules/*
+.vscode

README.md

@@ -219,11 +219,25 @@ The `upload()` method requires at least the `file` and the `fileName` parameter
 
 Sample usage
 ```
+// Using Callback Function
+
 imagekit.upload({
-  file : <url|base_64|binary>, //required
-  fileName : "my_file_name.jpg",   //required
+    file : <url|base_64|binary>, //required
+    fileName : "my_file_name.jpg",   //required
 }, function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
 
+// Using Promises 
+
+imagekit.upload({
+    file : <url|base_64|binary>, //required
+    fileName : "my_file_name.jpg",   //required
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
@@ -241,11 +255,26 @@ The SDK provides a simple interface for all the [media APIs mentioned here](http
 Accepts an object specifying the parameters to be used to list and search files. All parameters specified in the [documentation here](https://docs.imagekit.io/api-reference/media-api/list-and-search-files) can be passed as is with the correct values to get the results.
 
 ```
+// Using Callback Function
+
+imagekit.listFiles({
+    skip : 10,
+    limit : 10
+}, function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
+
 imagekit.listFiles({
     skip : 10,
     limit : 10
-}, function(err, result) { 
-    
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
@@ -254,8 +283,21 @@ imagekit.listFiles({
 Accepts the file ID and fetches the details as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/get-file-details).
 
 ```
-imagekit.getFileDetails("file_id", function(err, result) {  
+// Using Callback Function
+
+imagekit.getFileDetails("file_id", function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
 
+// Using Promises 
+
+imagekit.getFileDetails("file_id")
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
@@ -264,8 +306,21 @@ imagekit.getFileDetails("file_id", function(err, result) {
 Accepts the file ID and fetches the metadata as per the [API documentation here](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files).
 
 ```
-imagekit.getFileMetadata("file_id", function(err, result) {  
+// Using Callback Function
+
+imagekit.getFileMetadata("file_id", function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
 
+imagekit.getFileMetadata("file_id")
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
@@ -274,11 +329,26 @@ imagekit.getFileMetadata("file_id", function(err, result) {
 Update parameters associated with the file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/update-file-details). The first argument to the `updateFileDetails` method is the file ID and the second argument is an object with the parameters to be updated.
 
 ```
+// Using Callback Function
+
 imagekit.updateFileDetails("file_id", { 
     tags : ['image_tag'],
     customCoordinates : "10,10,100,100"
-}, function(err, result) { 
+}, function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
 
+// Using Promises 
+
+imagekit.updateFileDetails("file_id", {
+    tags : ['image_tag'],
+    customCoordinates : "10,10,100,100"
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
@@ -287,28 +357,92 @@ imagekit.updateFileDetails("file_id", {
 Delete a file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-file). The method accepts the file ID of the file that has to be deleted.
 
 ```
-imagekit.deleteFile("file_id", function(err, result) {
-    
+
+// Using Callback Function
+
+imagekit.deleteFile("file_id", function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
+
+imagekit.deleteFile("file_id"})
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
+});
+```
+
+**6. Bulk Delete Files**
+
+Delete multiple file as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/delete-files-bulk). The method accepts an array of file IDs of the files that have to be deleted.
+
+```
+
+// Using Callback Function
+
+imagekit.bulkDeleteFiles(["fileIds"], function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
+
+imagekit.bulkDeleteFiles(["fileIds"])
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
-**6. Purge Cache**
+**7. Purge Cache**
 
 Programmatically issue a cache clear request as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache). Accepts the full URL of the file for which the cache has to be cleared.
 
 ```
-imagekit.purgeCache("full_url", function(err, result) { 
-    
+// Using Callback Function
+
+imagekit.purgeCache("full_url", function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
+
+imagekit.purgeCache("full_url")
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 
-**7. Purge Cache Status**
+**8. Purge Cache Status**
 
 Get the purge cache request status using the request ID returned when a purge cache request gets submitted as per the [API documentation here](https://docs.imagekit.io/api-reference/media-api/purge-cache-status)
 
 ```
-imagekit.getPurgeCacheStatus("cache_request_id", function(err, result) {
-    
+// Using Callback Function
+
+imagekit.getPurgeCacheStatus("cache_request_id", function(error, result) {
+    if(error) console.log(error);
+    else console.log(result);
+});
+
+
+// Using Promises 
+
+imagekit.getPurgeCacheStatus("cache_request_id")
+}).then(response => {
+    console.log(response);
+}).catch(error => {
+    console.log(error);
 });
 ```
 

constants/errorMessages.js

@@ -15,4 +15,6 @@ module.exports = {
     "INVALID_PHASH_VALUE": { message: "Invalid pHash value", help: "Both pHash strings must be valid hexadecimal numbers" },
     "MISSING_PHASH_VALUE": { message: "Missing pHash value", help: "Please pass two pHash values" },
     "UNEQUAL_STRING_LENGTH": { message: "Unequal pHash string length", help: "For distance calucation, the two pHash strings must have equal length" },
+    //bulk delete errors
+    "INVALID_FILEIDS_VALUE": {message: "Invalid value for fileIds", help: "fileIds should be an string array of fileId of the files to delete. The array should have atleast one fileId."}
 };

demo/index.js

@@ -115,6 +115,10 @@ var ImageKit = function(opts) {
     this.getPurgeCacheStatus = promisify(function(requestId, callback) {
         return manage.getPurgeCacheStatus(requestId, this.options, callback);
     });
+
+    this.bulkDeleteFiles = promisify(function(fileIdArray, callback) {
+        return manage.bulkDeleteFiles(fileIdArray, this.options, callback);
+    });
 
     // To generate Signature for upload request
     this.getAuthenticationParameters = function(token, timestamp) {

index.js

@@ -157,4 +157,34 @@ module.exports.listFiles = function(listOptions, defaultOptions, callback) {
     });
 };
 
+/*
+    Bulk Delete By FileIds
+*/
+module.exports.bulkDeleteFiles = function(fileIdArray, defaultOptions, callback) {
+    
+    if(!Array.isArray(fileIdArray) 
+        || fileIdArray.length === 0 
+        || fileIdArray.filter(fileId => typeof(fileId) !== 'string').length > 0) {
+        respond(true, errorMessages.INVALID_FILEIDS_VALUE, callback);
+        return;
+    }
+
+    const data = {
+        fileIds: fileIdArray,
+    }
+
+    const requestOptions = {
+        url: "https://api.imagekit.io/v1/files/batch/deleteByFileIds",
+        method: "POST",
+        json: data
+    }
 
+    request(requestOptions, defaultOptions, function(err, response, body) {
+        if(err) {
+            respond(true, err, callback);
+            return;
+        }
+
+        respond(false, body, callback)
+    });
+};

libs/manage/file.js

@@ -6,5 +6,6 @@ module.exports.getFileDetails = file.getDetails;
 module.exports.updateFileDetails = file.updateDetails;
 module.exports.getFileMetadata = file.getMetadata;
 module.exports.deleteFile = file.deleteFile;
+module.exports.bulkDeleteFiles = file.bulkDeleteFiles;
 module.exports.purgeCache = cache.purgeCache;
 module.exports.getPurgeCacheStatus = cache.getPurgeCacheStatus;

libs/manage/index.js

@@ -1,6 +1,6 @@
 {
   "name": "imagekit",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Offical NodeJS SDK for ImageKit.io integration",
   "main": "index.js",
   "scripts": {