list API tags array input fix

Author: manu4543

libs/constants/errorMessages.ts

@@ -9,6 +9,7 @@ export default {
     "FILE_ID_MISSING": { message: "Missing File ID parameter for this request", help: "" },
     "FILE_VERSION_ID_MISSING": { message: "Missing File version ID parameter for this request", help: "" },
     "FILE_ID_OR_URL_MISSING": { message: "Pass either File ID or remote URL of the image as first parameter", help: "" },
+    "INVALID_LIST_OPTIONS": { message: "Pass a valid JSON list options e.g. {skip: 10, limit: 100}.", help: "" },
     "UPDATE_DATA_MISSING": { message: "Missing file update data for this request", help: "" },
     "UPDATE_DATA_TAGS_INVALID": { message: "Invalid tags parameter for this request", help: "tags should be passed as null or an array like ['tag1', 'tag2']" },
     "UPDATE_DATA_COORDS_INVALID": { message: "Invalid customCoordinates parameter for this request", help: "customCoordinates should be passed as null or a string like 'x,y,width,height'" },

libs/interfaces/ListFile.ts

@@ -22,7 +22,7 @@ export interface ListFileOptions {
   /**
    * Comma-separated list of tags. Files matching any of the tags are included in result response. If no tag is matched, the file is not included in result set.
    */
-  tags?: string;
+  tags?: string | string[];
   /**
    * Whether to include folders in search results or not. By default only files are searched.
    * Accepts true and false. If this is set to true then tags and fileType parameters are ignored.

libs/manage/file.ts

@@ -225,10 +225,14 @@ const listFiles = function (
   callback?: IKCallback<FileDetailsResponse[]>,
 ) {
   if (listOptions && !_.isObject(listOptions)) {
-    respond(true, errorMessages.UPDATE_DATA_MISSING, callback);
+    respond(true, errorMessages.INVALID_LIST_OPTIONS, callback);
     return;
   }
 
+  if (listOptions && listOptions.tags && _.isArray(listOptions.tags) && listOptions.tags.length) {
+    listOptions.tags = listOptions.tags.join(",");
+  }
+
   var requestOptions = {
     url: `https://api.imagekit.io/v1/files/`,
     method: "GET",

tests/mediaLibrary.js

@@ -339,13 +339,18 @@ describe("Media library APIs", function () {
         it('List files', function (done) {
             var listOptions = {
                 skip: 0,
-                limit: 100
+                limit: 100,
+                tags: ["t-shirt", "summer"]
             }
 
             const scope = nock('https://api.imagekit.io')
                 .get(`/v1/files/`)
                 .basicAuth({ user: initializationParams.privateKey, pass: '' })
-                .query(listOptions)
+                .query({
+                    skip: listOptions.skip,
+                    limit: listOptions.limit,
+                    tags: listOptions.tags.join(",")
+                })
                 .reply(function (uri, requestBody) {
                     expect(requestBody).equal("")
                     done()
@@ -377,7 +382,7 @@ describe("Media library APIs", function () {
         it('List files empty invalid options', function (done) {
             imagekit.listFiles("invalid", function (err, response) {
                 expect(err).to.deep.equal({
-                    message: "Missing file update data for this request",
+                    message: "Pass a valid JSON list options e.g. {skip: 10, limit: 100}.",
                     help: ""
                 })
                 done();