includeDeleted option in get custom metadata fields

Author: manu4543

index.ts

@@ -30,6 +30,7 @@ import {
   DeleteFileVersionOptions,
   RestoreFileVersionOptions,
   CreateCustomMetadataFieldOptions,
+  GetCustomMetadataFieldsOptions,
   CustomMetadataField,
   UpdateCustomMetadataFieldOptions,
   RenameFileOptions,
@@ -187,12 +188,12 @@ class ImageKit {
    *
    * @see {@link https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files}
    *
-   * @param fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API.
+   * @param fileIdOrURL The unique fileId of the uploaded file or absolute URL.
    */
-  getFileMetadata(fileId: string): Promise<FileMetadataResponse>;
-  getFileMetadata(fileId: string, callback: IKCallback<FileMetadataResponse>): void;
-  getFileMetadata(fileId: string, callback?: IKCallback<FileMetadataResponse>): void | Promise<FileMetadataResponse> {
-    return promisify<FileMetadataResponse>(this, manage.getFileMetadata)(fileId, this.options, callback);
+  getFileMetadata(fileIdOrURL: string): Promise<FileMetadataResponse>;
+  getFileMetadata(fileIdOrURL: string, callback: IKCallback<FileMetadataResponse>): void;
+  getFileMetadata(fileIdOrURL: string, callback?: IKCallback<FileMetadataResponse>): void | Promise<FileMetadataResponse> {
+    return promisify<FileMetadataResponse>(this, manage.getFileMetadata)(fileIdOrURL, this.options, callback);
   }
 
   /**
@@ -496,10 +497,10 @@ class ImageKit {
    * @see {@link https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field}
    *
    */
-  getCustomMetadataFields(): Promise<CustomMetadataField[]>;
-  getCustomMetadataFields(callback: IKCallback<CustomMetadataField[]>): Promise<CustomMetadataField[]>;
-  getCustomMetadataFields(callback?: IKCallback<CustomMetadataField[]>): void | Promise<CustomMetadataField[]> {
-    return promisify<CustomMetadataField[]>(this, customMetadataField.list)(this.options, callback);
+  getCustomMetadataFields(getCustomMetadataFieldsOptions: GetCustomMetadataFieldsOptions): Promise<CustomMetadataField[]>;
+  getCustomMetadataFields(getCustomMetadataFieldsOptions: GetCustomMetadataFieldsOptions, callback: IKCallback<CustomMetadataField[]>): Promise<CustomMetadataField[]>;
+  getCustomMetadataFields(getCustomMetadataFieldsOptions: GetCustomMetadataFieldsOptions, callback?: IKCallback<CustomMetadataField[]>): void | Promise<CustomMetadataField[]> {
+    return promisify<CustomMetadataField[]>(this, customMetadataField.list)(getCustomMetadataFieldsOptions, this.options, callback);
   }
 
   /**

libs/interfaces/CustomMetatadaField.ts

@@ -69,4 +69,11 @@ export interface UpdateCustomMetadataFieldOptions {
      * Note: type cannot be updated and will be ignored if sent with the schema. The schema will be validated as per the existing type.
      */
     schema?: CustomMetadataFieldSchemaMinusType
+}
+
+export interface GetCustomMetadataFieldsOptions {
+    /**
+     * Set it to true if you want to receive deleted fields as well in the API response.
+     */
+    includeDeleted?: boolean;
 }

libs/interfaces/index.ts

@@ -15,7 +15,7 @@ import { BulkDeleteFilesResponse, BulkDeleteFilesError } from "./BulkDeleteFiles
 import { CopyFolderOptions, CopyFolderResponse, CopyFolderError } from "./CopyFolder";
 import { MoveFolderOptions, MoveFolderResponse, MoveFolderError } from "./MoveFolder";
 import { DeleteFileVersionOptions, RestoreFileVersionOptions } from "./FileVersion"
-import { CreateCustomMetadataFieldOptions, CustomMetadataField, UpdateCustomMetadataFieldOptions } from "./CustomMetatadaField"
+import { CreateCustomMetadataFieldOptions, CustomMetadataField, UpdateCustomMetadataFieldOptions, GetCustomMetadataFieldsOptions } from "./CustomMetatadaField"
 import { RenameFileOptions, RenameFileResponse } from "./Rename"
 
 type FinalUrlOptions = ImageKitOptions & UrlOptions; // actual options used to construct url
@@ -51,6 +51,7 @@ export {
   DeleteFileVersionOptions,
   RestoreFileVersionOptions,
   CreateCustomMetadataFieldOptions,
+  GetCustomMetadataFieldsOptions,
   CustomMetadataField,
   UpdateCustomMetadataFieldOptions,
   RenameFileOptions,

libs/manage/custom-metadata-field.ts

@@ -17,7 +17,8 @@ import {
     ImageKitOptions,
     CreateCustomMetadataFieldOptions,
     CustomMetadataField,
-    UpdateCustomMetadataFieldOptions
+    UpdateCustomMetadataFieldOptions,
+    GetCustomMetadataFieldsOptions,
 } from "../interfaces/";
 
 const create = function (createCustomMetadataFieldOptions: CreateCustomMetadataFieldOptions, defaultOptions: ImageKitOptions, callback?: IKCallback<CustomMetadataField>) {
@@ -56,12 +57,15 @@ const create = function (createCustomMetadataFieldOptions: CreateCustomMetadataF
 };
 
 const list = function (
+    getCustomMetadataFieldsOptions: GetCustomMetadataFieldsOptions,
     defaultOptions: ImageKitOptions,
     callback?: IKCallback<CustomMetadataField[]>,
 ) {
+    const { includeDeleted = false } = getCustomMetadataFieldsOptions || {};
     var requestOptions = {
         url: "https://api.imagekit.io/v1/customMetadataFields",
         method: "GET",
+        qs: { includeDeleted }
     };
 
     request(requestOptions, defaultOptions, callback);

tests/custom-metadata-field.js

@@ -115,6 +115,9 @@ describe("Custom metadata field API", function () {
         it('Get field', function (done) {
             const scope = nock('https://api.imagekit.io')
                 .get("/v1/customMetadataFields")
+                .query({
+                    includeDeleted: false
+                })
                 .basicAuth({ user: initializationParams.privateKey, pass: '' })
                 .reply(function (uri, requestBody) {
                     expect(requestBody).to.be.empty;
@@ -125,6 +128,24 @@ describe("Custom metadata field API", function () {
             imagekit.getCustomMetadataFields();
         });
 
+        it('Get field - includeDeleted true', function (done) {
+            const scope = nock('https://api.imagekit.io')
+                .get("/v1/customMetadataFields")
+                .query({
+                    includeDeleted: true
+                })
+                .basicAuth({ user: initializationParams.privateKey, pass: '' })
+                .reply(function (uri, requestBody) {
+                    expect(requestBody).to.be.empty;
+                    done();
+                    return [200];
+                })
+
+            imagekit.getCustomMetadataFields({
+                includeDeleted: true
+            });
+        });
+
         it('Update field', function (done) {
             const scope = nock('https://api.imagekit.io')
                 .patch("/v1/customMetadataFields/fieldId")
@@ -235,11 +256,14 @@ describe("Custom metadata field API", function () {
         it('Get fields', function (done) {
             const scope = nock('https://api.imagekit.io')
                 .get("/v1/customMetadataFields")
+                .query({
+                    includeDeleted: false
+                })
                 .basicAuth({ user: initializationParams.privateKey, pass: '' })
                 .reply(200, [dummyAPISuccessResponse, dummyAPISuccessResponse])
 
             var callback = sinon.spy();
-            imagekit.getCustomMetadataFields(callback);
+            imagekit.getCustomMetadataFields({}, callback);
 
             setTimeout(function () {
                 expect(callback.calledOnce).to.be.true;
@@ -312,11 +336,14 @@ describe("Custom metadata field API", function () {
         it('Get fields', function (done) {
             const scope = nock('https://api.imagekit.io')
                 .get("/v1/customMetadataFields")
+                .query({
+                    includeDeleted: false
+                })
                 .basicAuth({ user: initializationParams.privateKey, pass: '' })
                 .reply(500, dummyAPIErrorResponse)
 
             var callback = sinon.spy();
-            imagekit.getCustomMetadataFields(callback);
+            imagekit.getCustomMetadataFields({}, callback);
 
             setTimeout(function () {
                 expect(callback.calledOnce).to.be.true;