fix: added folder object in ListFileResponse

Author: ahnv

README.md

@@ -408,7 +408,15 @@ imagekit.listFiles({
     limit : 10
 }, function(error, result) {
     if(error) console.log(error);
-    else console.log(result);
+    else {
+      result.forEach((item) => { 
+        if (item.type === "folder") {
+          console.log(item) // item is of type FolderObject
+        } else {
+          console.log(item) // item is of type FileObject
+        }
+      })
+    };
 });
 
 
@@ -418,7 +426,13 @@ imagekit.listFiles({
     skip : 10,
     limit : 10
 }).then(response => {
-    console.log(response);
+    response.forEach((item) => { 
+        if (item.type === "folder") {
+            console.log(item) // item is of type FolderObject
+        } else {
+            console.log(item) // item is of type FileObject
+        }
+    })
 }).catch(error => {
     console.log(error);
 });

index.ts

@@ -10,6 +10,7 @@ import {
   CopyFolderResponse,
   FileDetailsOptions,
   FileObject,
+  FolderObject,
   FileMetadataResponse,
   ImageKitOptions,
   ListFileOptions,
@@ -135,13 +136,13 @@ class ImageKit {
    *
    * @param listFilesOptions
    */
-  listFiles(listOptions: ListFileOptions): Promise<IKResponse<FileObject[]>>;
-  listFiles(listOptions: ListFileOptions, callback: IKCallback<IKResponse<FileObject[]>>): void;
+  listFiles(listOptions: ListFileOptions): Promise<IKResponse<ListFileResponse>>;
+  listFiles(listOptions: ListFileOptions, callback: IKCallback<IKResponse<ListFileResponse>>): void;
   listFiles(
     listOptions: ListFileOptions,
-    callback?: IKCallback<IKResponse<FileObject[]>>,
-  ): void | Promise<IKResponse<FileObject[]>> {
-    return promisify<IKResponse<FileObject[]>>(this, manage.listFiles)(listOptions, this.options, callback);
+    callback?: IKCallback<IKResponse<ListFileResponse>>,
+  ): void | Promise<IKResponse<ListFileResponse>> {
+    return promisify<IKResponse<ListFileResponse>>(this, manage.listFiles)(listOptions, this.options, callback);
   }
 
   /**

libs/interfaces/FileDetails.ts

@@ -1,5 +1,4 @@
 import { FileType } from "./FileType";
-import { Item } from "./Item";
 
 export interface EmbeddedMetadataValues {
   [key: string]:
@@ -56,13 +55,13 @@ export interface FileDetailsOptions {
    * Example - 50,50,500,500
    */
   customCoordinates?: string;
-  /* 
-  * Object with array of extensions to be processed on the image.
-  */
+  /*
+   * Object with array of extensions to be processed on the image.
+   */
   extensions?: Extension;
   /*
-    * Final status of pending extensions will be sent to this URL. 
-    */
+   * Final status of pending extensions will be sent to this URL.
+   */
   webhookUrl?: string
   /*
    * Array of AI tags to remove from the asset.
@@ -93,9 +92,9 @@ export interface FileObject {
    */
   fileId: string;
   /**
-   * Type of item. It can be either file or folder.
+   * Type of item. It can be either file, file-version or folder.
    */
-  type: Item;
+  type: "file" | "file-version";
   /**
    * Name of the file or folder.
    */
@@ -180,6 +179,38 @@ export interface FileObject {
   versionInfo?: { name: string; id: string };
 }
 
+/**
+ *
+ * Folder object.
+ *
+ * @see {@link https://docs.imagekit.io/api-reference/media-api#file-object-structure}
+ */
+export interface FolderObject {
+  /**
+   * The unique fileId of the folder.
+   */
+  folderId: string;
+  /**
+   * Type of item. It can be either file, file-version or folder.
+   */
+  type: "folder";
+  /**
+   * Name of the file or folder.
+   */
+  name: string;
+  /**
+   * The relative path of the folder.
+   */
+  folderPath: string;
+  /*
+   * The date and time when the folder was first created. The format is YYYY-MM-DDTHH:mm:ss.sssZ
+   */
+  createdAt: string;
+  /*
+   * The date and time when the folder was last updated. The format is YYYY-MM-DDTHH:mm:ss.sssZ
+   */
+  updatedAt: string;
+}
 
 export interface FileVersionDetailsOptions {
   /**
@@ -190,4 +221,4 @@ export interface FileVersionDetailsOptions {
    * The unique versionId of the uploaded file's version. This is returned in list files API and upload API as id within the versionInfo parameter.
    */
   versionId: string;
-}
+}

libs/interfaces/Item.ts

@@ -1,5 +1,5 @@
+import { FileObject, FolderObject } from "./FileDetails";
 import { FileType } from "./FileType";
-import { Item } from "./Item";
 
 /**
  * List and search files options
@@ -76,50 +76,4 @@ export interface ListFileOptions {
  *
  * @see {@link https://docs.imagekit.io/api-reference/media-api/list-and-search-files#response-structure-and-status-code-application-json}
  */
-export interface ListFileResponse {
-  /**
-   * The unique fileId of the uploaded file.
-   */
-  fileId: string;
-  /**
-   * Type of item. It can be either file or folder.
-   */
-  type: Item;
-  /**
-   * Name of the file or folder.
-   */
-  name: string;
-  /**
-   * The date and time when the file was first uploaded. The format is `YYYY-MM-DDTHH:mm:ss.sssZ`.
-   */
-  createdAt: string;
-  /**
-   * The relative path of the file. In the case of an image, you can use this
-   * path to construct different transformations.
-   */
-  filePath: string;
-  /**
-   * Array of tags associated with the image. If no tags are set, it will be null.
-   */
-  tags: string[] | null;
-  /**
-   * Is the file marked as private. It can be either true or false.
-   */
-  isPrivateFile: boolean;
-  /**
-   * Value of custom coordinates associated with the image in format x,y,width,height. If customCoordinates are not defined then it is null.
-   */
-  customCoordinates: string | null;
-  /**
-   * A publicly accessible URL of the file.
-   */
-  url: string;
-  /**
-   * In case of an image, a small thumbnail URL.
-   */
-  thumbnail: string;
-  /**
-   * The type of file, it could be either image or non-image.
-   */
-  fileType: FileType;
-}
+export type ListFileResponse = Array<FileObject | FolderObject>;

libs/interfaces/ListFile.ts

@@ -8,7 +8,7 @@ import { ListFileOptions, ListFileResponse } from "./ListFile";
 import { CopyFileOptions } from "./CopyFile";
 import { MoveFileOptions } from "./MoveFile";
 import { CreateFolderOptions } from "./CreateFolder";
-import { FileDetailsOptions, FileVersionDetailsOptions, FileObject } from "./FileDetails";
+import { FileDetailsOptions, FileVersionDetailsOptions, FileObject, FolderObject } from "./FileDetails";
 import { FileMetadataResponse } from "./FileMetadata";
 import { PurgeCacheResponse, PurgeCacheStatusResponse } from "./PurgeCache";
 import { BulkDeleteFilesResponse, BulkDeleteFilesError } from "./BulkDeleteFiles";
@@ -44,6 +44,7 @@ export type {
   FileDetailsOptions,
   FileVersionDetailsOptions,
   FileObject,
+  FolderObject,
   FileMetadataResponse,
   PurgeCacheResponse,
   PurgeCacheStatusResponse,

libs/interfaces/index.ts

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