@imagekit/nodejs 7.0.1 → 7.1.0

package/src/resources/beta/v2/files.ts

@@ -174,6 +174,17 @@ export interface FileUploadResponse {
    */
   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.
    */
@@ -253,6 +264,66 @@ export namespace FileUploadResponse {
     'remove-bg'?: 'success' | 'pending' | 'failed';
   }
 
+  export 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`.
    */
@@ -403,6 +474,7 @@ export interface FileUploadParams {
     | 'isPublished'
     | 'customMetadata'
     | 'metadata'
+    | 'selectedFieldsSchema'
   >;
 
   /**

package/src/resources/custom-metadata-fields.ts

@@ -59,6 +59,11 @@ export class CustomMetadataFields extends APIResource {
    * the API returns only non deleted field objects, but you can include deleted
    * fields in the API response.
    *
+   * You can also filter results by a specific folder path to retrieve custom
+   * metadata fields applicable at that location. This path-specific filtering is
+   * useful when using the **Path policy** feature to determine which custom metadata
+   * fields are selected for a given path.
+   *
    * @example
    * ```ts
    * const customMetadataFields =
@@ -126,7 +131,7 @@ export namespace CustomMetadataField {
     type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
 
     /**
-     * The default value for this custom metadata field. Date type of default value
+     * The default value for this custom metadata field. Data type of default value
      * depends on the field type.
      */
     defaultValue?: string | number | boolean | Array<string | number | boolean>;
@@ -319,6 +324,14 @@ export namespace CustomMetadataFieldUpdateParams {
 }
 
 export interface CustomMetadataFieldListParams {
+  /**
+   * The folder path (e.g., `/path/to/folder`) for which to retrieve applicable
+   * custom metadata fields. Useful for determining path-specific field selections
+   * when the [Path policy](https://imagekit.io/docs/dam/path-policy) feature is in
+   * use.
+   */
+  folderPath?: string;
+
   /**
    * Set it to `true` to include deleted field objects in the API response.
    */

package/src/resources/files/files.ts

@@ -269,6 +269,17 @@ export interface File {
    */
   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]: File.SelectedFieldsSchema };
+
   /**
    * Size of the file in bytes.
    */
@@ -332,6 +343,66 @@ export namespace File {
     source?: string;
   }
 
+  export 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 with details of the file version.
    */
@@ -838,6 +909,17 @@ export interface FileUploadResponse {
    */
   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.
    */
@@ -917,6 +999,66 @@ export namespace FileUploadResponse {
     'remove-bg'?: 'success' | 'pending' | 'failed';
   }
 
+  export 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`.
    */
@@ -1236,6 +1378,7 @@ export interface FileUploadParams {
     | 'isPublished'
     | 'customMetadata'
     | 'metadata'
+    | 'selectedFieldsSchema'
   >;
 
   /**

package/src/resources/webhooks.ts

@@ -383,6 +383,17 @@ export namespace UploadPreTransformSuccessEvent {
      */
     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]: Data.SelectedFieldsSchema };
+
     /**
      * Size of the image file in Bytes.
      */
@@ -462,6 +473,66 @@ export namespace UploadPreTransformSuccessEvent {
       'remove-bg'?: 'success' | 'pending' | 'failed';
     }
 
+    export 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`.
      */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.0.1'; // x-release-please-version
+export const VERSION = '7.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.0.1";
+export declare const VERSION = "7.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.0.1";
+export declare const VERSION = "7.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.0.1'; // x-release-please-version
+exports.VERSION = '7.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.0.1'; // x-release-please-version
+export const VERSION = '7.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map