@imgly/plugin-ai-generation-web 0.1.9 → 0.2.0

package/dist/generation/quickAction/common/QuickActionBasePrompt.d.ts

@@ -1,13 +0,0 @@
-import { ButtonOptions, TextAreaOptions } from '@cesdk/cesdk-js';
-import { Output, QuickAction, QuickActionContext } from '../../provider';
-/**
- * Quick action base for quick actions that require a prompt.
- * Will render a text area for the prompt.
- */
-declare function QuickActionBasePrompt<I, O extends Output>(options: {
-    buttonOptions?: ButtonOptions;
-    textAreaOptions?: TextAreaOptions;
-    quickAction: Omit<QuickAction<I, O>, 'render' | 'renderExpanded'>;
-    onApply: (prompt: string, context: QuickActionContext<I, O>) => Promise<O>;
-}): QuickAction<I, O>;
-export default QuickActionBasePrompt;

package/dist/generation/quickAction/common/QuickActionBaseSelect.d.ts

@@ -1,28 +0,0 @@
-import CreativeEditorSDK, { ButtonOptions } from '@cesdk/cesdk-js';
-import { Output, QuickAction, QuickActionContext } from '../../provider';
-interface QuickActionBaseSelectItem {
-    id: string;
-    label: string;
-    icon?: string;
-    prompt: string;
-}
-/**
- * Quick action base for quick actions that require a selection of items.
- */
-declare function QuickActionBaseSelect<I, O extends Output>(options: {
-    cesdk: CreativeEditorSDK;
-    items: QuickActionBaseSelectItem[];
-    buttonOptions?: ButtonOptions;
-    quickAction: Omit<QuickAction<I, O>, 'render' | 'renderExpanded'>;
-    mapInput?: (input: {
-        item: QuickActionBaseSelectItem;
-        uri: string;
-        blockId: number;
-    }) => I;
-    onApply?: (options: {
-        item: QuickActionBaseSelectItem;
-        uri: string;
-        blockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-}): QuickAction<I, O>;
-export default QuickActionBaseSelect;

package/dist/generation/quickAction/common/QuickActionChangeImage.d.ts

@@ -1,17 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { ImageOutput, QuickAction, QuickActionContext } from '../../provider';
-declare function QuickActionChangeImage<I, O extends ImageOutput>(options: {
-    id?: string;
-    cesdk: CreativeEditorSDK;
-    mapInput?: (input: {
-        prompt: string;
-        uri: string;
-        blockId: number;
-    }) => I;
-    onApply?: (options: {
-        prompt: string;
-        uri: string;
-        blockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-}): QuickAction<I, O>;
-export default QuickActionChangeImage;

package/dist/generation/quickAction/common/QuickActionCombineImages.d.ts

@@ -1,17 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { ImageOutput, QuickAction, QuickActionContext } from '../../provider';
-declare function QuickActionCombineImages<I, O extends ImageOutput>(options: {
-    id?: string;
-    mapInput?: (input: {
-        prompt: string;
-        uris: string[];
-        duplicatedBlockId: number;
-    }) => I;
-    onApply?: (options: {
-        prompt: string;
-        uris: string[];
-        duplicatedBlockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-    cesdk: CreativeEditorSDK;
-}): QuickAction<I, O>;
-export default QuickActionCombineImages;

package/dist/generation/quickAction/common/QuickActionEditTextStyle.d.ts

@@ -1,17 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { ImageOutput, QuickAction, QuickActionContext } from '../../provider';
-declare function QuickActionEditTextStyle<I, O extends ImageOutput>(options: {
-    id?: string;
-    cesdk: CreativeEditorSDK;
-    mapInput?: (input: {
-        prompt: string;
-        uri: string;
-        duplicatedBlockId: number;
-    }) => I;
-    onApply?: (options: {
-        prompt: string;
-        uri: string;
-        duplicatedBlockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-}): QuickAction<I, O>;
-export default QuickActionEditTextStyle;

package/dist/generation/quickAction/common/QuickActionImageVariant.d.ts

@@ -1,17 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { ImageOutput, QuickAction, QuickActionContext } from '../../provider';
-declare function QuickActionImageVariant<I, O extends ImageOutput>(options: {
-    id?: string;
-    mapInput?: (input: {
-        prompt: string;
-        uri: string;
-        duplicatedBlockId: number;
-    }) => I;
-    onApply?: (options: {
-        prompt: string;
-        uri: string;
-        duplicatedBlockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-    cesdk: CreativeEditorSDK;
-}): QuickAction<I, O>;
-export default QuickActionImageVariant;

package/dist/generation/quickAction/common/QuickActionSwapImageBackground.d.ts

@@ -1,17 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { ImageOutput, QuickAction, QuickActionContext } from '../../provider';
-declare function QuickActionChangeImage<I, O extends ImageOutput>(options: {
-    id?: string;
-    mapInput?: (input: {
-        prompt: string;
-        uri: string;
-        blockId: number;
-    }) => I;
-    onApply?: (options: {
-        prompt: string;
-        uri: string;
-        blockId: number;
-    }, context: QuickActionContext<I, O>) => Promise<O>;
-    cesdk: CreativeEditorSDK;
-}): QuickAction<I, O>;
-export default QuickActionChangeImage;

package/dist/generation/quickAction/generate.d.ts

@@ -1,19 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { QuickActionMenu, ApplyCallbacks } from './types';
-import Provider, { Output, OutputKind, QuickAction } from '../provider';
-import { InitProviderConfiguration } from '../types';
-declare function generate<K extends OutputKind, I, O extends Output>(options: {
-    input: I;
-    blockIds: number[];
-    cesdk: CreativeEditorSDK;
-    quickAction: QuickAction<I, O>;
-    quickActionMenu: QuickActionMenu;
-    provider: Provider<K, I, O>;
-    abortSignal: AbortSignal;
-    confirmationComponentId: string;
-}, config: InitProviderConfiguration): Promise<{
-    dispose: () => void;
-    returnValue: O;
-    applyCallbacks?: ApplyCallbacks;
-}>;
-export default generate;

package/dist/generation/quickAction/getQuickActionMenu.d.ts

@@ -1,10 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { QuickActionMenu } from './types';
-/**
- * Returns an object representing the quick action menu. Can be called and
- * retrieved multiple times.
- *
- * It's backed up by the global state.
- */
-declare function getQuickActionMenu(cesdk: CreativeEditorSDK, id: string): QuickActionMenu;
-export default getQuickActionMenu;

package/dist/generation/quickAction/registerQuickActionMenuComponent.d.ts

@@ -1,12 +0,0 @@
-import CreativeEditorSDK from '@cesdk/cesdk-js';
-import { QuickActionMenu } from './types';
-import Provider, { Output, OutputKind } from '../provider';
-import { InitProviderConfiguration } from '../types';
-declare function registerQuickActionMenuComponent<K extends OutputKind, I, O extends Output>(options: {
-    cesdk: CreativeEditorSDK;
-    quickActionMenu: QuickActionMenu;
-    provider: Provider<K, I, O>;
-}, config: InitProviderConfiguration): {
-    canvasMenuComponentId: string;
-};
-export default registerQuickActionMenuComponent;

package/dist/generation/quickAction/types.d.ts

@@ -1,25 +0,0 @@
-import { Output, type QuickAction } from '../provider';
-export type QuickActionId = 'ly.img.separator' | (string & {});
-export type ApplyCallbacks = {
-    onBefore?: () => void;
-    onAfter?: () => void;
-    onCancel?: () => void;
-    onApply: () => void;
-};
-export interface QuickActionMenu {
-    id: string;
-    registerQuickAction: <I, O extends Output>(quickAction: QuickAction<I, O>) => void;
-    setQuickActionMenuOrder: (quickActionIds: QuickActionId[]) => void;
-    getQuickActionMenuOrder: () => string[];
-    getQuickAction: <I, O extends Output>(magicId: QuickActionId) => QuickAction<I, O> | undefined;
-}
-export type InferenceStatus = 'processing' | 'confirmation';
-export type InferenceProcessingMetadata = {
-    status: 'processing';
-    quickActionId: string;
-};
-export type InferenceConfirmationMetadata = {
-    status: 'confirmation';
-    quickActionId: string;
-};
-export type InferenceMetadata = InferenceProcessingMetadata | InferenceConfirmationMetadata;

package/dist/generation/quickAction/utils.d.ts

@@ -1,13 +0,0 @@
-import { Output, QuickAction } from '../provider';
-export declare const INFERENCE_AI_EDIT_MODE = "ly.img.ai.inference.editMode";
-export declare const INFERENCE_AI_METADATA_KEY = "ly.img.ai.inference.metadata";
-export declare const INFERENCE_CONFIRMATION_COMPONENT_ID = "ly.img.ai.inference.confirmation.canvasMenu";
-export declare function getFeatureIdForQuickAction(options: {
-    quickActionId: string;
-    quickActionMenuId: string;
-}): string;
-/**
- * Removes all two following `ly.img.separator` entries from the quick
- * actions array or if it is first or last in the array.
- */
-export declare function removeDuplicatedSeparators<I, O extends Output>(quickActions: (QuickAction<I, O> | 'ly.img.separator')[]): (QuickAction<I, O> | 'ly.img.separator')[];

package/dist/generation/registerPanelInputCustom.d.ts

@@ -1,6 +0,0 @@
-import { BuilderRenderFunction } from '@cesdk/cesdk-js';
-import type Provider from './provider';
-import { OutputKind, PanelInputCustom, type Output } from './provider';
-import { InitProviderConfiguration, UIOptions } from './types';
-declare function registerPanelInputCustom<K extends OutputKind, I, O extends Output>(provider: Provider<K, I, O>, panelInput: PanelInputCustom<K, I>, options: UIOptions, config: InitProviderConfiguration): Promise<BuilderRenderFunction<any>>;
-export default registerPanelInputCustom;

package/dist/generation/registerPanelInputSchema.d.ts

@@ -1,9 +0,0 @@
-import { type OutputKind, type Output, type PanelInputSchema } from './provider';
-import type Provider from './provider';
-import { InitProviderConfiguration, UIOptions } from './types';
-import { BuilderRenderFunction } from '@cesdk/cesdk-js';
-/**
- * Registers a schema-based panel input for a provider
- */
-declare function registerPanelInputSchema<K extends OutputKind, I, O extends Output>(provider: Provider<K, I, O>, panelInput: PanelInputSchema<K, I>, options: UIOptions, config: InitProviderConfiguration): Promise<BuilderRenderFunction<any>>;
-export default registerPanelInputSchema;

package/dist/generation/types.d.ts

@@ -1,79 +0,0 @@
-import type CreativeEditorSDK from '@cesdk/cesdk-js';
-import { type CreativeEngine } from '@cesdk/cesdk-js';
-import type Provider from './provider';
-import { Output } from './provider';
-import { Middleware } from './middleware/middleware';
-/**
- * Configuration options for provider initialization
- */
-export type InitProviderConfiguration = {
-    /**
-     * Whether to enable debug mode
-     */
-    debug?: boolean;
-    /**
-     * If true the generation process wll be replaced with a dummy generation.
-     * Useful for testing the UI without actually generating images.
-     */
-    dryRun?: boolean;
-    /**
-     * Is called after an error occurred during the generation process.
-     * Can be used to show an error message to the user, e.g. with the
-     * Dialog or Notification API
-     *
-     * The default implementation logs the error to the console and
-     * shows a notification to the user.
-     */
-    onError?: (error: unknown) => void;
-    /**
-     * Is called when the generation process is started. Can be used to
-     * extend the generation process with additional steps.
-     *
-     * @param generate A function that starts the actual generation process.
-     */
-    middleware?: GenerationMiddleware;
-};
-/**
- * Common provider configuration that all providers should provide.
- */
-export interface CommonProviderConfiguration<I, O extends Output> {
-    /**
-     * The proxy URL to use for the provider.
-     */
-    proxyUrl: string;
-    /**
-     * Indicates whether the provider is in debug mode and should log additional information.
-     */
-    debug?: boolean;
-    /**
-     * Middleware that shall be executed during the generation process.
-     */
-    middleware?: Middleware<I, O>[];
-    /**
-     * Headers that shall be sent with the request of the provider.
-     */
-    headers?: Record<string, string>;
-}
-export type GenerationMiddleware = (generate: () => Promise<void>, context: {
-    provider: Provider<any, any, any>;
-    abort: () => void;
-}) => Promise<void>;
-/**
- * Options for UI interactions
- */
-export type UIOptions = {
-    cesdk: CreativeEditorSDK;
-    engine: CreativeEngine;
-    historyAssetSourceId?: string;
-    historyAssetLibraryEntryId?: string;
-    i18n?: {
-        prompt?: string;
-    };
-};
-/**
- * Basic context for provider initialization
- */
-export type Options = {
-    cesdk?: CreativeEditorSDK;
-    engine: CreativeEngine;
-};