new media APIs

Author: manu4543

index.ts

@@ -26,6 +26,9 @@ import {
   CreateFolderOptions,
   CopyFolderOptions,
   MoveFolderOptions,
+  FileVersionDetailsOptions,
+  DeleteFileVersionOptions,
+  RestoreFileVersionOptions,
 } from "./libs/interfaces";
 import { IKCallback } from "./libs/interfaces/IKCallback";
 import manage from "./libs/manage";
@@ -147,6 +150,32 @@ class ImageKit {
     return promisify<FileDetailsResponse>(this, manage.getFileDetails)(fileId, this.options, callback);
   }
 
+  /**
+   * Get all versions of an assset API
+   *
+   * @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-versions}
+   *
+   * @param fileId
+   */
+  getFileVersions(fileId: string): Promise<FileDetailsResponse>;
+  getFileVersions(fileId: string, callback: IKCallback<FileDetailsResponse>): void;
+  getFileVersions(fileId: string, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
+    return promisify<FileDetailsResponse>(this, manage.getFileVersions)(fileId, this.options, callback);
+  }
+
+  /**
+  * Get file version details API
+  *
+  * @see {@link https://docs.imagekit.io/api-reference/media-api/get-file-version-details}
+  *
+  * @param fileVersionDetailsOptions
+  */
+  getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions): Promise<FileDetailsResponse>;
+  getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback: IKCallback<FileDetailsResponse>): void;
+  getFileVersionDetails(fileVersionDetailsOptions: FileVersionDetailsOptions, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
+    return promisify<FileDetailsResponse>(this, manage.getFileVersionDetails)(fileVersionDetailsOptions, this.options, callback);
+  }
+
   /**
    * Get image exif, pHash and other metadata for uploaded files in ImageKit.io media library using this API.
    *
@@ -206,6 +235,20 @@ class ImageKit {
     return promisify(this, manage.bulkRemoveTags)(fileIds, tags, this.options, callback);
   }
 
+  /**
+   * Remove AITags from multiple files in a single request.
+   *
+   * @see {@link https://docs.imagekit.io/api-reference/media-api/remove-aitags-bulk}
+   *
+   * @param fileIds
+   * @param tags
+   */
+  bulkRemoveAITags(fileIds: string[], tags: string[]): void;
+  bulkRemoveAITags(fileIds: string[], tags: string[], callback: IKCallback<void>): void;
+  bulkRemoveAITags(fileIds: string[], tags: string[], callback?: IKCallback<void>): void | Promise<void> {
+    return promisify(this, manage.bulkRemoveAITags)(fileIds, tags, this.options, callback);
+  }
+
   /**
    * You can programmatically delete uploaded files in media library using delete file API.
    *
@@ -219,6 +262,32 @@ class ImageKit {
     return promisify(this, manage.deleteFile)(fileId, this.options, callback);
   }
 
+  /**
+   * Delete any non-current version of a file.
+   *
+   * @see {@link https://docs.imagekit.io/api-reference/media-api/delete-file-version}
+   *
+   * @param deleteFileVersionOptions
+   */
+  deleteFileVersion(deleteFileVersionOptions: DeleteFileVersionOptions): Promise<void>;
+  deleteFileVersion(deleteFileVersionOptions: DeleteFileVersionOptions, callback: IKCallback<void>): void;
+  deleteFileVersion(deleteFileVersionOptions: DeleteFileVersionOptions, callback?: IKCallback<void>): void | Promise<void> {
+    return promisify(this, manage.deleteFileVersion)(deleteFileVersionOptions, this.options, callback);
+  }
+
+  /**
+  * Restore file version to a different version of a file.
+  *
+  * @see {@link https://docs.imagekit.io/api-reference/media-api/restore-file-version}
+  *
+  * @param restoreFileVersionOptions
+  */
+  restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions): Promise<FileDetailsResponse>;
+  restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback: IKCallback<FileDetailsResponse>): void;
+  restoreFileVersion(restoreFileVersionOptions: RestoreFileVersionOptions, callback?: IKCallback<FileDetailsResponse>): void | Promise<FileDetailsResponse> {
+    return promisify<FileDetailsResponse>(this, manage.restoreFileVersion)(restoreFileVersionOptions, this.options, callback);
+  }
+
   /**
    * This will purge CDN and ImageKit.io internal cache.
    *

libs/constants/errorMessages.ts

@@ -7,6 +7,7 @@ export default {
     "CACHE_PURGE_URL_MISSING": { message: "Missing URL parameter for this request", help: "" },
     "CACHE_PURGE_STATUS_ID_MISSING": { message: "Missing Request ID parameter for this request", help: "" },
     "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: "" },
     "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']" },
@@ -29,5 +30,6 @@ export default {
     "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 array of fileId of the files. The array should have atleast one fileId." },
-    "BULK_ADD_TAGS_INVALID": { message: "Invalid value for tags", help: "tags should be a non empty array of string like ['tag1', 'tag2']." }
+    "BULK_ADD_TAGS_INVALID": { message: "Invalid value for tags", help: "tags should be a non empty array of string like ['tag1', 'tag2']." },
+    "BULK_AI_TAGS_INVALID": { message: "Invalid value for AITags", help: "AITags should be a non empty array of string like ['tag1', 'tag2']." }
 };

libs/interfaces/FileDetails.ts

@@ -61,7 +61,7 @@ export interface FileDetailsResponse {
   /**
    * Array of tags associated with the image. If no tags are set, it will be null.
    */
-  tags: string[] | null;
+  tags?: string[] | null;
   /**
    * Is the file marked as private. It can be either true or false.
    */
@@ -126,5 +126,21 @@ export interface FileDetailsResponse {
   /*
    * MIME Type of the file. For example - image/jpeg
    */
-  mime: string;
+  mime?: string;
+  /**
+   * An object containing the file or file version's id (versionId) and name.
+   */
+  versionInfo?: object;
 }
+
+
+export interface FileVersionDetailsOptions {
+  /**
+   * The unique fileId of the uploaded file. fileId is returned in list files API and upload API.
+   */
+  fileId: string;
+  /**
+   * 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/FileVersion.ts

@@ -0,0 +1,21 @@
+export interface DeleteFileVersionOptions {
+    /**
+   * The unique fileId of the uploaded file. fileId is returned in list files API and upload API.
+   */
+    fileId: string;
+    /**
+     * 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;
+}
+
+export interface RestoreFileVersionOptions {
+    /**
+   * The unique fileId of the uploaded file. fileId is returned in list files API and upload API.
+   */
+    fileId: string;
+    /**
+     * 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/index.ts

@@ -8,12 +8,13 @@ import { ListFileOptions, ListFileResponse } from "./ListFile";
 import { CopyFileOptions } from "./CopyFile";
 import { MoveFileOptions } from "./MoveFile";
 import { CreateFolderOptions } from "./CreateFolder";
-import { FileDetailsOptions, FileDetailsResponse } from "./FileDetails";
+import { FileDetailsOptions, FileVersionDetailsOptions, FileDetailsResponse } from "./FileDetails";
 import { FileMetadataResponse } from "./FileMetadata";
 import { PurgeCacheResponse, PurgeCacheStatusResponse } from "./PurgeCache";
 import { BulkDeleteFilesResponse, BulkDeleteFilesError } from "./BulkDeleteFiles";
 import { CopyFolderOptions, CopyFolderResponse, CopyFolderError } from "./CopyFolder";
 import { MoveFolderOptions, MoveFolderResponse, MoveFolderError } from "./MoveFolder";
+import { DeleteFileVersionOptions, RestoreFileVersionOptions } from "./FileVersion"
 
 type FinalUrlOptions = ImageKitOptions & UrlOptions; // actual options used to construct url
 
@@ -29,6 +30,7 @@ export {
   ListFileOptions,
   ListFileResponse,
   FileDetailsOptions,
+  FileVersionDetailsOptions,
   FileDetailsResponse,
   FileMetadataResponse,
   PurgeCacheResponse,
@@ -44,5 +46,7 @@ export {
   CreateFolderOptions,
   CopyFolderOptions,
   MoveFolderOptions,
+  DeleteFileVersionOptions,
+  RestoreFileVersionOptions,
 };
 export { IKCallback } from "./IKCallback";