@imgly/plugin-ai-generation-web 1.74.0-rc.0 → 1.74.0-rc.1

package/dist/gateway/types.d.ts

@@ -1,5 +1,6 @@
 import type CreativeEditorSDK from '@cesdk/cesdk-js';
 import type { OutputKind, Output, RenderCustomProperty, QuickActionsInput } from '../core/provider';
+import type { Middleware } from '../middleware/middleware';
 import type { GatewayClient } from './createGatewayClient';
 export interface GatewayProviderConfiguration {
     /**
@@ -37,6 +38,12 @@ export interface GatewayProviderConfiguration {
      * Generation errors are handled separately via middleware.
      */
     onError?: (error: Error) => void;
+    /**
+     * Middlewares to add to the provider generation. Middlewares run around the
+     * base `generate` call and can observe/modify input, retry on failure, add
+     * logging, rate limiting, etc.
+     */
+    middlewares?: Middleware<any, any>[];
     /**
      * How long (in milliseconds) to cache auth tokens before re-fetching.
      * Concurrent requests while a fetch is in-flight share the same call.
@@ -44,6 +51,34 @@ export interface GatewayProviderConfiguration {
      * @default 300000 (5 minutes)
      */
     tokenCacheTTL?: number;
+    /**
+     * Override or disable individual quick actions on top of the provider's
+     * capability-derived defaults.
+     *
+     * - Set a quick-action ID to `false` (or `null`) to disable it for this provider.
+     * - Set it to an object with `mapInput` to override how the quick action's
+     *   input is mapped to the provider's input.
+     *
+     * @example
+     * ```ts
+     * ImageGatewayProvider('fal-ai/some-model', {
+     *   gatewayUrl,
+     *   supportedQuickActions: {
+     *     'ly.img.editImage': false,                       // disable
+     *     'ly.img.swapBackground': {                       // override mapping
+     *       mapInput: (input) => ({ prompt: input.prompt, image_urls: [input.uri] })
+     *     }
+     *   }
+     * })
+     * ```
+     */
+    supportedQuickActions?: {
+        [quickActionId: string]: {
+            mapInput: (input: any) => GatewayInput;
+        } | {
+            [key: string]: any;
+        } | true | false | null;
+    };
     /**
      * Enable debug logging.
      */
@@ -113,8 +148,24 @@ export interface GatewayProviderOptions<K extends OutputKind, O extends Output>
      */
     outputFilter?: (output: GatewaySSEOutput) => boolean;
     /**
-     * Quick actions supported by this provider.
-     * Each entry maps a quick action ID to an input transformation.
+     * Returns the default quick actions for this model based on its schema
+     * (specifically `schema.capability`). Called once after the schema
+     * resolves; the result is merged with any `supportedQuickActions`
+     * overrides from the provider configuration.
+     *
+     * Return `undefined` when the model has no quick actions (e.g. a pure
+     * text2image model).
+     */
+    resolveQuickActions?: (context: {
+        schema: GatewaySchemaResult;
+        providerId: string;
+        cesdk: CreativeEditorSDK;
+    }) => QuickActionsInput<GatewayInput> | undefined;
+    /**
+     * Unconditional quick actions for this provider. Used by content types
+     * with a single capability (e.g., text generation where every model
+     * accepts the same chat-style input). Mutually exclusive with
+     * `resolveQuickActions`.
      */
     quickActions?: QuickActionsInput<GatewayInput>;
     /**
@@ -123,10 +174,21 @@ export interface GatewayProviderOptions<K extends OutputKind, O extends Output>
      */
     userFlow?: 'placeholder' | 'generation-only';
 }
+/**
+ * Known gateway capabilities. Unknown string values are allowed for
+ * forward compatibility with capabilities added on the server side
+ * before the client is updated.
+ */
+export type GatewayCapability = 'text2text' | 'text2image' | 'image2image' | 'text2video' | 'image2video' | 'text2speech' | (string & {});
 export interface GatewaySchemaResult {
     model: string;
     name?: string;
     type: string;
+    /**
+     * The model's capability (e.g., 'image2image'). Used by the gateway
+     * providers to decide which default quick actions to offer.
+     */
+    capability: GatewayCapability;
     input_schema: {
         type: 'object';
         required: string[];