@imgly/plugin-ai-generation-web 1.72.0-rc.2 → 1.72.1-rc.0

package/dist/gateway/types.d.ts

@@ -0,0 +1,163 @@
+import type CreativeEditorSDK from '@cesdk/cesdk-js';
+import type { OutputKind, Output, RenderCustomProperty, QuickActionsInput } from '../core/provider';
+import type { GatewayClient } from './createGatewayClient';
+export interface GatewayProviderConfiguration {
+    /**
+     * Base URL of the gateway service.
+     *
+     * @default 'https://gateway.img.ly'
+     */
+    gatewayUrl?: string;
+    /**
+     * Human-readable display name for this model. Overrides the name
+     * returned by the gateway schema. If not set, the schema name is
+     * used once it loads, with `modelId` as the initial fallback.
+     */
+    modelName?: string;
+    /**
+     * The action ID used to retrieve an auth token via `cesdk.ui.actions.run()`.
+     * The registered action should return a token string.
+     *
+     * @default 'ly.img.ai.getToken'
+     */
+    tokenActionId?: string;
+    /**
+     * Additional headers to send with gateway requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * History storage strategy for generated assets.
+     *
+     * @default '@imgly/indexedDB'
+     */
+    history?: false | '@imgly/local' | '@imgly/indexedDB' | (string & {});
+    /**
+     * Called when an error occurs during schema loading or provider initialization.
+     * Generation errors are handled separately via middleware.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * How long (in milliseconds) to cache auth tokens before re-fetching.
+     * Concurrent requests while a fetch is in-flight share the same call.
+     *
+     * @default 300000 (5 minutes)
+     */
+    tokenCacheTTL?: number;
+    /**
+     * Enable debug logging.
+     */
+    debug?: boolean;
+}
+export declare const DEFAULT_GATEWAY_URL = "https://gateway.img.ly";
+export declare const DEFAULT_TOKEN_ACTION_ID = "ly.img.ai.getToken";
+/**
+ * Return type for the gateway token action.
+ *
+ * - Return a **string** for short-lived credentials (JWT, Clerk token, session token).
+ * - Return `{ dangerouslyExposeApiKey: string }` if you intentionally want to use
+ *   a raw API key. This exposes the key to anyone with browser DevTools access.
+ */
+export type GatewayTokenActionResult = string | {
+    dangerouslyExposeApiKey: string;
+};
+export type GatewayInput = Record<string, any>;
+export interface GatewayProviderOptions<K extends OutputKind, O extends Output> {
+    /** The output kind (e.g., 'image', 'video', 'audio', 'text'). */
+    kind: K;
+    /**
+     * Called once when the provider initializes (e.g., to register icons).
+     */
+    onInitialize?: (cesdk: CreativeEditorSDK) => void;
+    /**
+     * Called after the schema resolves. Return a `renderCustomProperty` map
+     * to customize how specific schema properties are rendered in the panel.
+     *
+     * Only called when a schema-driven panel is used (i.e., `createOutput` is provided).
+     */
+    onSchemaReady?: (context: {
+        schema: GatewaySchemaResult;
+        providerId: string;
+        cesdk: CreativeEditorSDK;
+    }) => RenderCustomProperty | undefined;
+    /**
+     * Preprocess input before generation (e.g., upload local blob: URLs).
+     * If omitted, input is forwarded to the gateway as-is.
+     */
+    processInput?: (input: GatewayInput, client: GatewayClient, cesdk: CreativeEditorSDK) => Promise<GatewayInput>;
+    /**
+     * Construct the typed output from a generated URL.
+     * Used for URL-based outputs (image, video, audio).
+     *
+     * When provided, a schema-driven panel is set up and `getBlockInput` is required.
+     * Mutually exclusive with `createStreamOutput`.
+     */
+    createOutput?: (url: string) => O | Promise<O>;
+    /**
+     * Construct the typed output from accumulated streamed text.
+     * Used for streaming outputs (text).
+     *
+     * When provided, no schema panel is created — use `quickActions` for input.
+     * Mutually exclusive with `createOutput`.
+     */
+    createStreamOutput?: (accumulatedText: string) => O;
+    /**
+     * Extract block input from user input (for placeholder creation).
+     * Required when `createOutput` is provided (panel mode).
+     */
+    getBlockInput?: (input: GatewayInput) => Promise<Record<K, any>>;
+    /**
+     * Filter the SSE output array to find the relevant result.
+     * If omitted, the first output entry is used.
+     * Only used in URL mode (`createOutput`).
+     */
+    outputFilter?: (output: GatewaySSEOutput) => boolean;
+    /**
+     * Quick actions supported by this provider.
+     * Each entry maps a quick action ID to an input transformation.
+     */
+    quickActions?: QuickActionsInput<GatewayInput>;
+    /**
+     * Panel user flow.
+     * @default 'placeholder'
+     */
+    userFlow?: 'placeholder' | 'generation-only';
+}
+export interface GatewaySchemaResult {
+    model: string;
+    name?: string;
+    type: string;
+    input_schema: {
+        type: 'object';
+        required: string[];
+        properties: Record<string, unknown>;
+        'x-property-order'?: string[];
+    };
+}
+export interface GatewaySSEOutput {
+    type: string;
+    url: string;
+    content_type: string;
+}
+export interface GatewaySSECompletedData {
+    request_id: string;
+    status: 'completed';
+    output: GatewaySSEOutput[];
+}
+export interface GatewaySSEFailedData {
+    request_id: string;
+    status: 'failed';
+    error: {
+        message: string;
+    };
+}
+export interface GatewaySSEDeltaData {
+    contentType: 'text' | 'tool_call';
+    data: string;
+    request_id: string;
+}
+export interface GatewayUploadResult {
+    id: string;
+    upload_url: string;
+    asset_url: string;
+    expires_in: number;
+}

package/dist/index.d.ts

@@ -5,7 +5,7 @@ declare const CommonProperties: {
     StyleTransfer: typeof renderStyleTransferProperty;
 };
 export { CommonProperties };
-export { type default as Provider, type ImageOutput, type VideoOutput, type TextOutput, type AudioOutput, type StickerOutput, type Output, type OutputKind, type PanelInputSchema, type RenderCustomProperty, type GetBlockInput, type GetBlockInputResult, type GetInput } from './core/provider';
+export { type default as Provider, type ImageOutput, type VideoOutput, type TextOutput, type AudioOutput, type StickerOutput, type Output, type OutputKind, type PanelInputSchema, type RenderCustomProperty, type GetBlockInput, type GetBlockInputResult, type GetInput, type QuickActionsInput } from './core/provider';
 export { type GetPropertyInput, type Property } from './openapi/types';
 export { type GetProvider, type CommonProviderConfiguration, type CommonPluginConfiguration, type CommonConfiguration, type InternalPluginConfiguration } from './types';
 export type { PropertyContext, PropertyConfig, PropertiesConfiguration, ExtendPropertyContexts } from './core/propertyConfiguration';
@@ -29,4 +29,7 @@ export { default as initializeProvider } from './providers/initializeProvider';
 export { default as initializeQuickActionComponents } from './ui/quickActions/initializeQuickActionComponents';
 export { extractAndSetSchemaTranslations } from './openapi/extractSchemaTranslations';
 export { AI_EDIT_MODE, AI_METADATA_KEY } from './ui/quickActions/utils';
+export { createGatewayProvider } from './gateway/createGatewayProvider';
+export { createGatewayClient, type GatewayClient } from './gateway/createGatewayClient';
+export type { GatewayProviderConfiguration, GatewayProviderOptions, GatewayInput, GatewaySchemaResult, GatewaySSEOutput, GatewaySSECompletedData, GatewaySSEDeltaData, GatewaySSEFailedData, GatewayUploadResult, GatewayTokenActionResult } from './gateway/types';
 export { setDefaultTranslations, createTranslationCallback, buildTranslationKeys } from './utils/translationHelpers';