@imagekit/nodejs 7.2.2 → 7.4.0

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -323,21 +324,8 @@ export class ImageKit {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.ImageKitError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -369,12 +357,13 @@ export class ImageKit {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -558,7 +547,7 @@ export class ImageKit {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -599,9 +588,10 @@ export class ImageKit {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -678,9 +668,9 @@ export class ImageKit {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -768,6 +758,12 @@ export class ImageKit {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -800,6 +796,14 @@ export class ImageKit {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: ImageKit, props: APIRespon
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { ImageKitError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new ImageKitError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

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

@@ -22,10 +22,11 @@ export class Files extends APIResource {
    * about how to implement secure client-side file upload.
    *
    * **File size limit** \
-   * On the free plan, the maximum upload file sizes are 20MB for images, audio, and raw
-   * files, and 100MB for videos. On the paid plan, these limits increase to 40MB for
-   * images, audio, and raw files, and 2GB for videos. These limits can be further increased
-   * with higher-tier plans.
+   * On the free plan, the maximum upload file sizes are 25MB for images, audio, and raw
+   * files, and 100MB for videos. On the Lite paid plan, these limits increase to 40MB
+   * for images, audio, and raw files and 300MB for videos, whereas on the Pro paid plan,
+   * these limits increase to 50MB for images, audio, and raw files and 2GB for videos.
+   * These limits can be further increased with enterprise plans.
    *
    * **Version limit** \
    * A file can have a maximum of 100 versions.

package/src/resources/files/files.ts

@@ -152,10 +152,11 @@ export class Files extends APIResource {
    * by verifying the entire payload using JWT.
    *
    * **File size limit** \
-   * On the free plan, the maximum upload file sizes are 20MB for images, audio, and raw
-   * files and 100MB for videos. On the paid plan, these limits increase to 40MB for images,
-   * audio, and raw files and 2GB for videos. These limits can be further increased with
-   * higher-tier plans.
+   * On the free plan, the maximum upload file sizes are 25MB for images, audio, and raw
+   * files and 100MB for videos. On the Lite paid plan, these limits increase to 40MB
+   * for images, audio, and raw files and 300MB for videos, whereas on the Pro paid plan,
+   * these limits increase to 50MB for images, audio, and raw files and 2GB for videos.
+   * These limits can be further increased with enterprise plans.
    *
    * **Version limit** \
    * A file can have a maximum of 100 versions.
@@ -199,6 +200,16 @@ export interface File {
    */
   AITags?: Array<File.AITag> | null;
 
+  /**
+   * The audio codec used in the video (only for video/audio).
+   */
+  audioCodec?: string;
+
+  /**
+   * The bit rate of the video in kbps (only for video).
+   */
+  bitRate?: number;
+
   /**
    * Date and time when the file was uploaded. The date and time is in ISO8601
    * format.
@@ -221,6 +232,17 @@ export interface File {
    */
   description?: string;
 
+  /**
+   * The duration of the video in seconds (only for video).
+   */
+  duration?: number;
+
+  /**
+   * Consolidated embedded metadata associated with the file. It includes exif, iptc,
+   * and xmp data.
+   */
+  embeddedMetadata?: { [key: string]: unknown };
+
   /**
    * Unique identifier of the asset.
    */
@@ -318,6 +340,11 @@ export interface File {
    */
   versionInfo?: File.VersionInfo;
 
+  /**
+   * The video codec used in the video (only for video).
+   */
+  videoCodec?: string;
+
   /**
    * Width of the file.
    */
@@ -426,6 +453,12 @@ export interface Folder {
    */
   createdAt?: string;
 
+  /**
+   * An object with custom metadata for the folder. Returns empty object if no custom
+   * metadata is set.
+   */
+  customMetadata?: { [key: string]: unknown };
+
   /**
    * Unique identifier of the asset.
    */

package/src/resources/helper.ts

@@ -314,16 +314,25 @@ function processOverlay(overlay: Transformation['overlay']): string | undefined
     entries.push(`lm-${overlay.layerMode}`);
   }
 
-  const { x, y, focus } = position;
+  const { x, y, xCenter, yCenter, focus, anchorPoint } = position;
   if (x) {
     entries.push(`lx-${x}`);
   }
   if (y) {
     entries.push(`ly-${y}`);
   }
+  if (xCenter) {
+    entries.push(`lxc-${xCenter}`);
+  }
+  if (yCenter) {
+    entries.push(`lyc-${yCenter}`);
+  }
   if (focus) {
     entries.push(`lfo-${focus}`);
   }
+  if (anchorPoint) {
+    entries.push(`lap-${anchorPoint}`);
+  }
 
   const { start, end, duration } = timing;
   if (start) {

package/src/resources/shared.ts

@@ -147,8 +147,10 @@ export namespace ExtensionConfig {
       min_selections?: number;
 
       /**
-       * Array of possible tag values. Combined length of all strings must not exceed 500
-       * characters. Cannot contain the `%` character.
+       * Array of possible tag values. The combined length of all strings must not exceed
+       * 500 characters, and values cannot include the `%` character. When providing
+       * large vocabularies (more than 30 items), the AI may not follow the list
+       * strictly.
        */
       vocabulary?: Array<string>;
     }
@@ -181,7 +183,10 @@ export namespace ExtensionConfig {
       min_selections?: number;
 
       /**
-       * Array of possible values matching the custom metadata field type.
+       * An array of possible values matching the custom metadata field type. If not
+       * provided for SingleSelect or MultiSelect field types, all values from the custom
+       * metadata field definition will be used. When providing large vocabularies (above
+       * 30 items), the AI may not strictly adhere to the list.
        */
       vocabulary?: Array<string | number | boolean>;
     }
@@ -468,8 +473,10 @@ export namespace Extensions {
       min_selections?: number;
 
       /**
-       * Array of possible tag values. Combined length of all strings must not exceed 500
-       * characters. Cannot contain the `%` character.
+       * Array of possible tag values. The combined length of all strings must not exceed
+       * 500 characters, and values cannot include the `%` character. When providing
+       * large vocabularies (more than 30 items), the AI may not follow the list
+       * strictly.
        */
       vocabulary?: Array<string>;
     }
@@ -502,7 +509,10 @@ export namespace Extensions {
       min_selections?: number;
 
       /**
-       * Array of possible values matching the custom metadata field type.
+       * An array of possible values matching the custom metadata field type. If not
+       * provided for SingleSelect or MultiSelect field types, all values from the custom
+       * metadata field definition will be used. When providing large vocabularies (above
+       * 30 items), the AI may not strictly adhere to the list.
        */
       vocabulary?: Array<string | number | boolean>;
     }
@@ -782,8 +792,25 @@ export type Overlay = TextOverlay | ImageOverlay | VideoOverlay | SubtitleOverla
 
 export interface OverlayPosition {
   /**
-   * Specifies the position of the overlay relative to the parent image or video.
-   * Maps to `lfo` in the URL.
+   * Sets the anchor point on the base asset from which the overlay offset is
+   * calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only
+   * be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
+   */
+  anchorPoint?:
+    | 'top'
+    | 'left'
+    | 'right'
+    | 'bottom'
+    | 'top_left'
+    | 'top_right'
+    | 'bottom_left'
+    | 'bottom_right'
+    | 'center';
+
+  /**
+   * Specifies the position of the overlay relative to the parent image or video. If
+   * one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this
+   * parameter is ignored. Maps to `lfo` in the URL.
    */
   focus?:
     | 'center'
@@ -805,6 +832,15 @@ export interface OverlayPosition {
    */
   x?: number | string;
 
+  /**
+   * Specifies the x-coordinate on the base asset where the overlay's center will be
+   * positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or
+   * `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can
+   * be used with `y`. Learn about
+   * [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+   */
+  xCenter?: number | string;
+
   /**
    * Specifies the y-coordinate of the top-left corner of the base asset where the
    * overlay's top-left corner will be positioned. It also accepts arithmetic
@@ -813,6 +849,15 @@ export interface OverlayPosition {
    * [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
    */
   y?: number | string;
+
+  /**
+   * Specifies the y-coordinate on the base asset where the overlay's center will be
+   * positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or
+   * `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can
+   * be used with `x`. Learn about
+   * [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
+   */
+  yCenter?: number | string;
 }
 
 export interface OverlayTiming {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.2.2'; // x-release-please-version
+export const VERSION = '7.4.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.2.2";
+export declare const VERSION = "7.4.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.2.2'; // x-release-please-version
+exports.VERSION = '7.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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