feat(api): dam related webhook events

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 47
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-63aff1629530786015da3c86131afa8a9b60545d488884b77641f1d4b89c6e9d.yml
-openapi_spec_hash: 586d357bd7e5217d240a99e0d83c6d1f
-config_hash: 47cb702ee2cb52c58d803ae39ade9b44
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-1422f7513f230162270b197061e5768c2e0c803b94b8cd03a5e72544ac75a27f.yml
+openapi_spec_hash: 41175e752e6f6ce900b36aecba687fa7
+config_hash: 17e408231b0b01676298010c7405f483

README.md

@@ -430,6 +430,7 @@ You can use the `maxRetries` option to configure or disable this:
 ```js
 // Configure the default for all requests:
 const client = new ImageKit({
+  privateKey: 'My Private Key',
   maxRetries: 0, // default is 2
 });
 
@@ -447,6 +448,7 @@ Requests time out after 1 minute by default. You can configure this with a `time
 ```ts
 // Configure the default for all requests:
 const client = new ImageKit({
+  privateKey: 'My Private Key',
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 

api.md

@@ -229,6 +229,11 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/webhooks.ts">BaseWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks.ts">DamFileCreateEvent</a></code>
+- <code><a href="./src/resources/webhooks.ts">DamFileDeleteEvent</a></code>
+- <code><a href="./src/resources/webhooks.ts">DamFileUpdateEvent</a></code>
+- <code><a href="./src/resources/webhooks.ts">DamFileVersionCreateEvent</a></code>
+- <code><a href="./src/resources/webhooks.ts">DamFileVersionDeleteEvent</a></code>
 - <code><a href="./src/resources/webhooks.ts">UploadPostTransformErrorEvent</a></code>
 - <code><a href="./src/resources/webhooks.ts">UploadPostTransformSuccessEvent</a></code>
 - <code><a href="./src/resources/webhooks.ts">UploadPreTransformErrorEvent</a></code>

packages/mcp-server/README.md

@@ -80,24 +80,13 @@ and repeatably.
 
 Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket.
 
-Authorization can be provided via the `Authorization` header using the Basic scheme.
-
-Additionally, authorization can be provided via the following headers:
-| Header | Equivalent client option | Security scheme |
-| ---------------------------------- | ------------------------ | --------------- |
-| `x-imagekit-private-key` | `privateKey` | basicAuth |
-| `x-optional-imagekit-ignores-this` | `password` | basicAuth |
-
 A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`:
 
 ```json
 {
   "mcpServers": {
     "imagekit_nodejs_api": {
-      "url": "http://localhost:3000",
-      "headers": {
-        "Authorization": "Basic <auth value>"
-      }
+      "url": "http://localhost:3000"
     }
   }
 }

packages/mcp-server/src/auth.ts

@@ -5,34 +5,7 @@ import { ClientOptions } from '@imagekit/nodejs';
 import { McpOptions } from './options';
 
 export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial<ClientOptions> => {
-  if (req.headers.authorization) {
-    const scheme = req.headers.authorization.split(' ')[0]!;
-    const value = req.headers.authorization.slice(scheme.length + 1);
-    switch (scheme) {
-      case 'Basic':
-        const rawValue = Buffer.from(value, 'base64').toString();
-        return {
-          privateKey: rawValue.slice(0, rawValue.search(':')),
-          password: rawValue.slice(rawValue.search(':') + 1),
-        };
-      default:
-        throw new Error(
-          'Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Basic).',
-        );
-    }
-  } else if (required) {
-    throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.');
-  }
-
-  const privateKey =
-    Array.isArray(req.headers['x-imagekit-private-key']) ?
-      req.headers['x-imagekit-private-key'][0]
-    : req.headers['x-imagekit-private-key'];
-  const password =
-    Array.isArray(req.headers['x-optional-imagekit-ignores-this']) ?
-      req.headers['x-optional-imagekit-ignores-this'][0]
-    : req.headers['x-optional-imagekit-ignores-this'];
-  return { privateKey, password };
+  return {};
 };
 
 export const getStainlessApiKey = (req: IncomingMessage, mcpOptions: McpOptions): string | undefined => {

packages/mcp-server/src/local-docs-search.ts

@@ -35,6 +35,11 @@ import {
 } from './resources/saved-extensions';
 import {
   BaseWebhookEvent,
+  DamFileCreateEvent,
+  DamFileDeleteEvent,
+  DamFileUpdateEvent,
+  DamFileVersionCreateEvent,
+  DamFileVersionDeleteEvent,
   UnsafeUnwrapWebhookEvent,
   UnwrapWebhookEvent,
   UploadPostTransformErrorEvent,
@@ -82,7 +87,6 @@ import {
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
-import { toBase64 } from './internal/utils/base64';
 import { readEnv } from './internal/utils/env';
 import {
   type LogLevel,
@@ -295,30 +299,7 @@ export class ImageKit {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.privateKey && this.password && values.get('authorization')) {
-      return;
-    }
-    if (nulls.has('authorization')) {
-      return;
-    }
-
-    throw new Error(
-      'Could not resolve authentication method. Expected the privateKey or password to be set. Or for the "Authorization" headers to be explicitly omitted',
-    );
-  }
-
-  protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (!this.privateKey) {
-      return undefined;
-    }
-
-    if (!this.password) {
-      return undefined;
-    }
-
-    const credentials = `${this.privateKey}:${this.password}`;
-    const Authorization = `Basic ${toBase64(credentials)}`;
-    return buildHeaders([{ Authorization }]);
+    return;
   }
 
   /**
@@ -747,7 +728,6 @@ export class ImageKit {
         ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}),
         ...getPlatformHeaders(),
       },
-      await this.authHeaders(options),
       this._options.defaultHeaders,
       bodyHeaders,
       options.headers,
@@ -917,6 +897,11 @@ export declare namespace ImageKit {
   export {
     Webhooks as Webhooks,
     type BaseWebhookEvent as BaseWebhookEvent,
+    type DamFileCreateEvent as DamFileCreateEvent,
+    type DamFileDeleteEvent as DamFileDeleteEvent,
+    type DamFileUpdateEvent as DamFileUpdateEvent,
+    type DamFileVersionCreateEvent as DamFileVersionCreateEvent,
+    type DamFileVersionDeleteEvent as DamFileVersionDeleteEvent,
     type UploadPostTransformErrorEvent as UploadPostTransformErrorEvent,
     type UploadPostTransformSuccessEvent as UploadPostTransformSuccessEvent,
     type UploadPreTransformErrorEvent as UploadPreTransformErrorEvent,

src/client.ts

@@ -53,6 +53,11 @@ export {
 export {
   Webhooks,
   type BaseWebhookEvent,
+  type DamFileCreateEvent,
+  type DamFileDeleteEvent,
+  type DamFileUpdateEvent,
+  type DamFileVersionCreateEvent,
+  type DamFileVersionDeleteEvent,
   type UploadPostTransformErrorEvent,
   type UploadPostTransformSuccessEvent,
   type UploadPreTransformErrorEvent,

src/resources/index.ts

@@ -147,10 +147,8 @@ export namespace ExtensionConfig {
       min_selections?: number;
 
       /**
-       * 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.
+       * Array of possible tag values. Combined length of all strings must not exceed 500
+       * characters. Cannot contain the `%` character.
        */
       vocabulary?: Array<string>;
     }
@@ -183,10 +181,7 @@ export namespace ExtensionConfig {
       min_selections?: number;
 
       /**
-       * 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.
+       * Array of possible values matching the custom metadata field type.
        */
       vocabulary?: Array<string | number | boolean>;
     }
@@ -473,10 +468,8 @@ export namespace Extensions {
       min_selections?: number;
 
       /**
-       * 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.
+       * Array of possible tag values. Combined length of all strings must not exceed 500
+       * characters. Cannot contain the `%` character.
        */
       vocabulary?: Array<string>;
     }
@@ -509,10 +502,7 @@ export namespace Extensions {
       min_selections?: number;
 
       /**
-       * 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.
+       * Array of possible values matching the custom metadata field type.
        */
       vocabulary?: Array<string | number | boolean>;
     }
@@ -792,25 +782,8 @@ export type Overlay = TextOverlay | ImageOverlay | VideoOverlay | SubtitleOverla
 
 export interface OverlayPosition {
   /**
-   * 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.
+   * Specifies the position of the overlay relative to the parent image or video.
+   * Maps to `lfo` in the URL.
    */
   focus?:
     | 'center'
@@ -832,15 +805,6 @@ 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
@@ -849,15 +813,6 @@ 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 {