@imgly/plugin-ai-image-generation-web/dist/types.d.ts

AI image generation plugin for the CE.SDK editor

import type CreativeEditorSDK from '@cesdk/cesdk-js';
import { type Provider, type GenerationMiddleware } from '@imgly/plugin-ai-generation-web';
type AiImageProvider = (context: {
    cesdk: CreativeEditorSDK;
}) => Promise<Provider<'image', any, any>>;
/**
 * Configuration to set provider and models for image generation.
 */
export interface PluginConfiguration {
    /**
     * Provider of a model for image generation just from a (prompt) text.
     */
    text2image?: AiImageProvider;
    /**
     * Provider of a model for image generation from a given image.
     */
    image2image?: AiImageProvider;
    /**
     * Render console logs for debugging purposes.
     */
    debug?: boolean;
    /**
     * Dry run mode. If set to true, the plugin will not make any API calls.
     */
    dryRun?: boolean;
    /**
     * 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.
     * @param context The context of the generation process.
     */
    middleware?: GenerationMiddleware;
}
export {};