@imagekit/nodejs 7.0.1 → 7.1.1

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/helper.ts

@@ -45,12 +45,11 @@ export class Helper extends APIResource {
 
     const isAbsoluteURL = opts.src.startsWith('http://') || opts.src.startsWith('https://');
 
-    var urlObj, isSrcParameterUsedForURL, urlEndpointPattern;
+    var urlObj, isSrcParameterUsedForURL;
 
     try {
       if (!isAbsoluteURL) {
-        urlEndpointPattern = new URL(opts.urlEndpoint).pathname;
-        urlObj = new URL(pathJoin([opts.urlEndpoint.replace(urlEndpointPattern, ''), opts.src]));
+        urlObj = new URL(opts.urlEndpoint);
       } else {
         urlObj = new URL(opts.src!);
         isSrcParameterUsedForURL = true;
@@ -65,19 +64,25 @@ export class Helper extends APIResource {
 
     var transformationString = this.buildTransformationString(opts.transformation);
 
-    if (transformationString && transformationString.length) {
-      if (!transformationUtils.addAsQueryParameter(opts) && !isSrcParameterUsedForURL) {
-        urlObj.pathname = pathJoin([
-          TRANSFORMATION_PARAMETER + transformationUtils.getChainTransformDelimiter() + transformationString,
-          urlObj.pathname,
-        ]);
+    const addAsQuery = transformationUtils.addAsQueryParameter(opts) || isSrcParameterUsedForURL;
+
+    const TRANSFORMATION_PLACEHOLDER = 'PLEASEREPLACEJUSTBEFORESIGN';
+
+    if (!isAbsoluteURL) {
+      // For non-absolute URLs, construct the path: endpoint_path + transformations + src
+      const endpointPath = new URL(opts.urlEndpoint).pathname;
+      const pathParts = [endpointPath];
+
+      if (transformationString && transformationString.length && !addAsQuery) {
+        pathParts.push(
+          TRANSFORMATION_PARAMETER +
+            transformationUtils.getChainTransformDelimiter() +
+            TRANSFORMATION_PLACEHOLDER,
+        );
       }
-    }
 
-    if (urlEndpointPattern) {
-      urlObj.pathname = pathJoin([urlEndpointPattern, urlObj.pathname]);
-    } else {
-      urlObj.pathname = pathJoin([urlObj.pathname]);
+      pathParts.push(opts.src);
+      urlObj.pathname = pathJoin(pathParts);
     }
 
     // First, build the complete URL with transformations
@@ -85,12 +90,16 @@ export class Helper extends APIResource {
 
     // Add transformation parameter manually to avoid URL encoding
     // URLSearchParams.set() would encode commas and colons in transformation string,
-    // It would work correctly but not very readable e.g., "w-300,h-400" is better than "w-300%2Ch-400"
+    // It would work correctly but not very readable e.g., "w-300,h-400" is better than "w-300%2Ch-400". Moreover we ensure transformation string is URL safe by encoding individual components while building it.
+    if (transformationString && transformationString.length && addAsQuery) {
+      const separator = urlObj.searchParams.toString() ? '&' : '?';
+      finalUrl = `${finalUrl}${separator}${TRANSFORMATION_PARAMETER}=${TRANSFORMATION_PLACEHOLDER}`;
+    }
+
+    // Replace the placeholder with actual transformation string
+    // We don't put actual transformation string before signing to avoid issues with URL encoding. Though in node it works correctly but other libraries use this code as blueprint and can double encode when using URL object .href equivalent.
     if (transformationString && transformationString.length) {
-      if (transformationUtils.addAsQueryParameter(opts) || isSrcParameterUsedForURL) {
-        const separator = urlObj.searchParams.toString() ? '&' : '?';
-        finalUrl = `${finalUrl}${separator}${TRANSFORMATION_PARAMETER}=${transformationString}`;
-      }
+      finalUrl = finalUrl.replace(TRANSFORMATION_PLACEHOLDER, transformationString);
     }
 
     // Then sign the URL if needed

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.1'; // 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.1";
 //# 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.1";
 //# 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.1'; // 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.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map