@imagekit/javascript 5.1.0-beta.1 → 5.2.0

package/dist/interfaces/UploadResponse.d.ts

@@ -1,98 +1,160 @@
 /**
- * Type of files to include in result set. Accepts three values:
- * all - include all types of files in result set
- * image - only search in image type files
- * non-image - only search in files which are not image, e.g., JS or CSS or video files.
- *
- * {@link https://imagekit.io/docs/api-reference/digital-asset-management-dam/list-and-search-assets}
+ * JSON object containing metadata.
  */
-type FileType = "all" | "image" | "non-image";
-/**
- * Metadata object structure
- *
- * {@link https://imagekit.io/docs/api-reference/file-metadata/get-uploaded-file-metadata#Responses}
- *
- * Contents of Object
- *
- * - Exif
- *
- * For more information about the Exif standard, please refer to the specification found on http://www.exif.org. A comprehensive list of available Exif attributes and their meaning can be found on http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/.
- *
- * - Perceptual Hash (pHash)
- *
- * Perceptual hashing allows you to construct a hash value that uniquely identifies an input image based on the image's contents. It is different from cryptographic hash functions like MD5 and SHA1. pHash provides similar hash value after minor distortions, like small rotations, blurring, and compression in the image.
- */
-interface Metadata {
-    height: number;
-    width: number;
-    size: number;
-    format: string;
-    hasColorProfile: boolean;
-    quality: number;
-    density: number;
-    hasTransparency: boolean;
-    pHash: string;
-    exif: {
-        image: {
-            Make: string;
-            Model: string;
-            Orientation: number;
-            XResolution: number;
-            YResolution: number;
-            ResolutionUnit: number;
-            Software: string;
-            ModifyDate: string;
-            YCbCrPositioning: number;
-            ExifOffset: number;
-            GPSInfo: number;
-        };
-        thumbnail: {
-            Compression: number;
-            XResolution: number;
-            YResolution: number;
-            ResolutionUnit: number;
-            ThumbnailOffset: number;
-            ThumbnailLength: number;
-        };
-        exif: {
-            ExposureTime: number;
-            FNumber: number;
-            ExposureProgram: number;
-            ISO: number;
-            ExifVersion: string;
-            DateTimeOriginal: string;
-            CreateDate: string;
-            ShutterSpeedValue: number;
-            ApertureValue: number;
-            ExposureCompensation: number;
-            MeteringMode: number;
-            Flash: number;
-            FocalLength: number;
-            SubSecTime: string;
-            SubSecTimeOriginal: string;
-            SubSecTimeDigitized: string;
-            FlashpixVersion: string;
-            ColorSpace: number;
-            ExifImageWidth: number;
-            ExifImageHeight: number;
-            InteropOffset: number;
-            FocalPlaneXResolution: number;
-            FocalPlaneYResolution: number;
-            FocalPlaneResolutionUnit: number;
-            CustomRendered: number;
-            ExposureMode: number;
-            WhiteBalance: number;
-            SceneCaptureType: number;
-        };
-        gps: {
-            GPSVersionID: number[];
-        };
-        interoperability: {
-            InteropIndex: string;
-            InteropVersion: string;
+export interface Metadata {
+    /**
+     * The audio codec used in the video (only for video).
+     */
+    audioCodec?: string;
+    /**
+     * The bit rate of the video in kbps (only for video).
+     */
+    bitRate?: number;
+    /**
+     * The density of the image in DPI.
+     */
+    density?: number;
+    /**
+     * The duration of the video in seconds (only for video).
+     */
+    duration?: number;
+    exif?: Metadata.Exif;
+    /**
+     * The format of the file (e.g., 'jpg', 'mp4').
+     */
+    format?: string;
+    /**
+     * Indicates if the image has a color profile.
+     */
+    hasColorProfile?: boolean;
+    /**
+     * Indicates if the image contains transparent areas.
+     */
+    hasTransparency?: boolean;
+    /**
+     * The height of the image or video in pixels.
+     */
+    height?: number;
+    /**
+     * Perceptual hash of the image.
+     */
+    pHash?: string;
+    /**
+     * The quality indicator of the image.
+     */
+    quality?: number;
+    /**
+     * The file size in bytes.
+     */
+    size?: number;
+    /**
+     * The video codec used in the video (only for video).
+     */
+    videoCodec?: string;
+    /**
+     * The width of the image or video in pixels.
+     */
+    width?: number;
+}
+export declare namespace Metadata {
+    interface Exif {
+        /**
+         * Object containing Exif details.
+         */
+        exif?: Exif.Exif;
+        /**
+         * Object containing GPS information.
+         */
+        gps?: Exif.Gps;
+        /**
+         * Object containing EXIF image information.
+         */
+        image?: Exif.Image;
+        /**
+         * JSON object.
+         */
+        interoperability?: Exif.Interoperability;
+        makernote?: {
+            [key: string]: unknown;
         };
-        makernote: any;
-    };
+        /**
+         * Object containing Thumbnail information.
+         */
+        thumbnail?: Exif.Thumbnail;
+    }
+    namespace Exif {
+        /**
+         * Object containing Exif details.
+         */
+        interface Exif {
+            ApertureValue?: number;
+            ColorSpace?: number;
+            CreateDate?: string;
+            CustomRendered?: number;
+            DateTimeOriginal?: string;
+            ExifImageHeight?: number;
+            ExifImageWidth?: number;
+            ExifVersion?: string;
+            ExposureCompensation?: number;
+            ExposureMode?: number;
+            ExposureProgram?: number;
+            ExposureTime?: number;
+            Flash?: number;
+            FlashpixVersion?: string;
+            FNumber?: number;
+            FocalLength?: number;
+            FocalPlaneResolutionUnit?: number;
+            FocalPlaneXResolution?: number;
+            FocalPlaneYResolution?: number;
+            InteropOffset?: number;
+            ISO?: number;
+            MeteringMode?: number;
+            SceneCaptureType?: number;
+            ShutterSpeedValue?: number;
+            SubSecTime?: string;
+            WhiteBalance?: number;
+        }
+        /**
+         * Object containing GPS information.
+         */
+        interface Gps {
+            GPSVersionID?: Array<number>;
+        }
+        /**
+         * Object containing EXIF image information.
+         */
+        interface Image {
+            ExifOffset?: number;
+            GPSInfo?: number;
+            Make?: string;
+            Model?: string;
+            ModifyDate?: string;
+            Orientation?: number;
+            ResolutionUnit?: number;
+            Software?: string;
+            XResolution?: number;
+            YCbCrPositioning?: number;
+            YResolution?: number;
+        }
+        /**
+         * JSON object.
+         */
+        interface Interoperability {
+            InteropIndex?: string;
+            InteropVersion?: string;
+        }
+        /**
+         * Object containing Thumbnail information.
+         */
+        interface Thumbnail {
+            Compression?: number;
+            ResolutionUnit?: number;
+            ThumbnailLength?: number;
+            ThumbnailOffset?: number;
+            XResolution?: number;
+            YResolution?: number;
+        }
+    }
 }
 export interface ResponseMetadata {
     statusCode: number;
@@ -100,67 +162,148 @@ export interface ResponseMetadata {
     headers: Record<string, string | number | boolean>;
 }
 /**
- * Response from server when file is uploaded successfully.
- *
- * {@link https://imagekit.io/docs/api-reference/upload-file/upload-file#Responses}
+ * Object containing details of a successful upload.
  */
 export interface UploadResponse {
     /**
-     * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file.
+     * An array of tags assigned to the uploaded file by auto tagging.
      */
-    fileId?: string;
+    AITags?: Array<FileUploadResponse.AITag> | null;
     /**
-     * The name of the uploaded file.
+     * The audio codec used in the video (only for video).
      */
-    name?: string;
+    audioCodec?: string;
     /**
-     * The URL of the file.
+     * The bit rate of the video in kbps (only for video).
      */
-    url?: string;
+    bitRate?: number;
     /**
-     * In case of an image, a small thumbnail URL.
+     * Value of custom coordinates associated with the image in the format
+     * `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`.
+     * Send `customCoordinates` in `responseFields` in API request to get the value of
+     * this field.
      */
-    thumbnailUrl?: string;
+    customCoordinates?: string | null;
     /**
-     * Height of the uploaded image file. Only applicable when file type is image.
+     * A key-value data associated with the asset. Use `responseField` in API request
+     * to get `customMetadata` in the upload API response. Before setting any custom
+     * metadata on an asset, you have to create the field using custom metadata fields
+     * API. Send `customMetadata` in `responseFields` in API request to get the value
+     * of this field.
      */
-    height?: number;
+    customMetadata?: {
+        [key: string]: unknown;
+    };
     /**
-     * Width of the uploaded image file. Only applicable when file type is image.
+     * Optional text to describe the contents of the file. Can be set by the user or
+     * the ai-auto-description extension.
      */
-    width?: number;
+    description?: string;
     /**
-     * Size of the uploaded file in bytes.
+     * The duration of the video in seconds (only for video).
      */
-    size?: number;
+    duration?: number;
     /**
-     * Type of file. It can either be image or non-image.
+     * Consolidated embedded metadata associated with the file. It includes exif, iptc,
+     * and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get
+     * embeddedMetadata in the upload API response.
      */
-    fileType?: FileType;
+    embeddedMetadata?: {
+        [key: string]: unknown;
+    };
     /**
-     * The path of the file uploaded. It includes any folder that you specified while uploading.
+     * Extension names with their processing status at the time of completion of the
+     * request. It could have one of the following status values:
+     *
+     * `success`: The extension has been successfully applied. `failed`: The extension
+     * has failed and will not be retried. `pending`: The extension will finish
+     * processing in some time. On completion, the final status (success / failed) will
+     * be sent to the `webhookUrl` provided.
+     *
+     * If no extension was requested, then this parameter is not returned.
+     */
+    extensionStatus?: FileUploadResponse.ExtensionStatus;
+    /**
+     * Unique fileId. Store this fileld in your database, as this will be used to
+     * perform update action on this file.
+     */
+    fileId?: string;
+    /**
+     * The relative path of the file in the media library e.g.
+     * `/marketing-assets/new-banner.jpg`.
      */
     filePath?: string;
     /**
-     * Array of tags associated with the image.
+     * Type of the uploaded file. Possible values are `image`, `non-image`.
      */
-    tags?: string[];
+    fileType?: string;
     /**
-     * Is the file marked as private. It can be either true or false.
+     * Height of the image in pixels (Only for images)
+     */
+    height?: number;
+    /**
+     * Is the file marked as private. It can be either `true` or `false`. Send
+     * `isPrivateFile` in `responseFields` in API request to get the value of this
+     * field.
      */
     isPrivateFile?: boolean;
     /**
-     * Value of custom coordinates associated with the image in format x,y,width,height.
+     * Is the file published or in draft state. It can be either `true` or `false`.
+     * Send `isPublished` in `responseFields` in API request to get the value of this
+     * field.
      */
-    customCoordinates?: string | null;
+    isPublished?: boolean;
     /**
-     * The metadata of the upload file. Use responseFields property in request to get the metadata returned in response of upload API.
+     * Legacy metadata. Send `metadata` in `responseFields` in API request to get
+     * metadata in the upload API response.
      */
     metadata?: Metadata;
-    AITags?: object[];
-    extensionStatus?: {
-        [key: string]: string;
+    /**
+     * Name of the asset.
+     */
+    name?: string;
+    /**
+     * This field is included in the response only if the Path policy feature is
+     * available in the plan. It contains schema definitions for the custom metadata
+     * fields selected for the specified file path. Field selection can only be done
+     * when the Path policy feature is enabled.
+     *
+     * Keys are the names of the custom metadata fields; the value object has details
+     * about the custom metadata schema.
+     */
+    selectedFieldsSchema?: {
+        [key: string]: FileUploadResponse.SelectedFieldsSchema;
     };
+    /**
+     * Size of the image file in Bytes.
+     */
+    size?: number;
+    /**
+     * The array of tags associated with the asset. If no tags are set, it will be
+     * `null`. Send `tags` in `responseFields` in API request to get the value of this
+     * field.
+     */
+    tags?: Array<string> | null;
+    /**
+     * In the case of an image, a small thumbnail URL.
+     */
+    thumbnailUrl?: string;
+    /**
+     * A publicly accessible URL of the file.
+     */
+    url?: string;
+    /**
+     * An object containing the file or file version's `id` (versionId) and `name`.
+     */
+    versionInfo?: FileUploadResponse.VersionInfo;
+    /**
+     * The video codec used in the video (only for video).
+     */
+    videoCodec?: string;
+    /**
+     * Width of the image in pixels (Only for Images)
+     */
+    width?: number;
     /**
      * Message indicating that the file upload is accepted. This field is only present when the upload is accepted but not yet processed.
      * This can happen when the file is being processed for pre-transformation for video.
@@ -172,4 +315,102 @@ export interface UploadResponse {
      */
     readonly $ResponseMetadata: ResponseMetadata;
 }
-export {};
+export declare namespace FileUploadResponse {
+    interface AITag {
+        /**
+         * Confidence score of the tag.
+         */
+        confidence?: number;
+        /**
+         * Name of the tag.
+         */
+        name?: string;
+        /**
+         * Array of `AITags` associated with the image. If no `AITags` are set, it will be
+         * null. These tags can be added using the `google-auto-tagging` or
+         * `aws-auto-tagging` extensions.
+         */
+        source?: string;
+    }
+    /**
+     * Extension names with their processing status at the time of completion of the
+     * request. It could have one of the following status values:
+     *
+     * `success`: The extension has been successfully applied. `failed`: The extension
+     * has failed and will not be retried. `pending`: The extension will finish
+     * processing in some time. On completion, the final status (success / failed) will
+     * be sent to the `webhookUrl` provided.
+     *
+     * If no extension was requested, then this parameter is not returned.
+     */
+    interface ExtensionStatus {
+        'ai-auto-description'?: 'success' | 'pending' | 'failed';
+        'ai-tasks'?: 'success' | 'pending' | 'failed';
+        'aws-auto-tagging'?: 'success' | 'pending' | 'failed';
+        'google-auto-tagging'?: 'success' | 'pending' | 'failed';
+        'remove-bg'?: 'success' | 'pending' | 'failed';
+    }
+    interface SelectedFieldsSchema {
+        /**
+         * Type of the custom metadata field.
+         */
+        type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
+        /**
+         * The default value for this custom metadata field. The value should match the
+         * `type` of custom metadata field.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Specifies if the custom metadata field is required or not.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * Maximum value of the field. Only set if field type is `Date` or `Number`. For
+         * `Date` type field, the value will be in ISO8601 string format. For `Number` type
+         * field, it will be a numeric value.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * Minimum value of the field. Only set if field type is `Date` or `Number`. For
+         * `Date` type field, the value will be in ISO8601 string format. For `Number` type
+         * field, it will be a numeric value.
+         */
+        minValue?: string | number;
+        /**
+         * Indicates whether the custom metadata field is read only. A read only field
+         * cannot be modified after being set. This field is configurable only via the
+         * **Path policy** feature.
+         */
+        readOnly?: boolean;
+        /**
+         * An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+        /**
+         * Specifies if the selectOptions array is truncated. It is truncated when number
+         * of options are > 100.
+         */
+        selectOptionsTruncated?: boolean;
+    }
+    /**
+     * An object containing the file or file version's `id` (versionId) and `name`.
+     */
+    interface VersionInfo {
+        /**
+         * Unique identifier of the file version.
+         */
+        id?: string;
+        /**
+         * Name of the file version.
+         */
+        name?: string;
+    }
+}

package/dist/interfaces/index.d.ts

@@ -1,4 +1,3 @@
+export * from './shared';
 export * from './UploadResponse';
 export * from './UploadOptions';
-export * from './Transformation';
-export * from './SrcOptions';