@imgly/plugin-ai-image-generation-web 0.1.10 → 0.2.1

package/dist/open-ai/quickActions/ChangeStyleLibrary.d.ts

@@ -0,0 +1,39 @@
+import { QuickActionDefinition } from '@imgly/plugin-ai-generation-web';
+import CreativeEditorSDK from '@cesdk/cesdk-js';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.gpt-image-1.changeStyleLibrary";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.gpt-image-1.changeStyleLibrary";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+/**
+ * Function to create the ChangeStyleLibrary quick action.
+ */
+declare const ChangeStyleLibrary: (context: {
+    cesdk: CreativeEditorSDK;
+    modelKey: string;
+    baseURL?: string;
+}) => QuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default ChangeStyleLibrary;

package/dist/plugin.d.ts

@@ -1,5 +1,6 @@
 import { type EditorPlugin } from '@cesdk/cesdk-js';
+import { Output } from '@imgly/plugin-ai-generation-web';
 import { PluginConfiguration } from './types';
-export { PLUGIN_ID } from './constants';
-export declare function ImageGeneration(options: PluginConfiguration): Omit<EditorPlugin, 'name' | 'version'>;
+export { PLUGIN_ID, DEFAULT_IMAGE_QUICK_ACTION_ORDER } from './constants';
+export declare function ImageGeneration<I, O extends Output>(config: PluginConfiguration<I, O>): Omit<EditorPlugin, 'name' | 'version'>;
 export default ImageGeneration;

package/dist/quickActions/ArtistTransfer.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.artistTransfer";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.artistTransfer";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    artist: string;
+    uri: string;
+};
+declare const ArtistTransfer: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default ArtistTransfer;

package/dist/quickActions/CombineImages.d.ts

@@ -0,0 +1,32 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.combineImages";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.combineImages";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uris: string[];
+    exportFromBlockIds: number[];
+};
+declare const CombineImages: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default CombineImages;

package/dist/quickActions/CreateVariant.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.createVariant";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.createVariant";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+declare const CreateVariant: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default CreateVariant;

package/dist/quickActions/EditImage.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.editImage";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.editImage";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+declare const EditImage: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default EditImage;

package/dist/quickActions/RemixPage.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.remixPage";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.remixPage";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+declare const RemixPage: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default RemixPage;

package/dist/quickActions/RemixPageWithPrompt.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.remixPageWithPrompt";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.remixPageWithPrompt";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+declare const RemixPageWithPrompt: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default RemixPageWithPrompt;

package/dist/quickActions/StyleTransfer.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.styleTransfer";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.styleTransfer";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    style: string;
+    uri: string;
+};
+declare const StyleTransfer: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default StyleTransfer;

package/dist/quickActions/SwapBackground.d.ts

@@ -0,0 +1,31 @@
+import { GetQuickActionDefinition } from './types';
+/**
+ * The ID of the quick action.
+ */
+export declare const ID = "ly.img.swapBackground";
+/**
+ * The i18n prefix for the quick action.
+ */
+export declare const I18N_PREFIX = "ly.img.ai.quickAction.image.swapBackground";
+/**
+ * The input generated from this quick action which needs
+ * to be mapped to the specific provider.
+ */
+export type InputType = {
+    prompt: string;
+    uri: string;
+};
+declare const SwapBackground: GetQuickActionDefinition<InputType>;
+/**
+ * Extend ImageQuickActionInputs with this action's input type.
+ * This will ensure that the types are correctly recognized
+ * in the ImageProvider.
+ *
+ * COPY this file to other quick action to support type safety
+ */
+declare module '../types' {
+    interface ImageQuickActionInputs {
+        [ID]: InputType;
+    }
+}
+export default SwapBackground;

package/dist/quickActions/types.d.ts

@@ -0,0 +1,6 @@
+import CreativeEditorSDK from '@cesdk/cesdk-js';
+import { QuickActionDefinition } from '@imgly/plugin-ai-generation-web';
+export type GetQuickActionDefinitionContext = {
+    cesdk: CreativeEditorSDK;
+};
+export type GetQuickActionDefinition<Q extends Record<string, any>> = (context: GetQuickActionDefinitionContext) => QuickActionDefinition<Q>;

package/dist/types.d.ts

@@ -1,35 +1,66 @@
-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>>;
+import { CommonPluginConfiguration, GetProvider, Output, Provider, ImageOutput } from '@imgly/plugin-ai-generation-web';
 /**
  * Configuration to set provider and models for image generation.
  */
-export interface PluginConfiguration {
+export interface PluginConfiguration<I, O extends Output> extends CommonPluginConfiguration<'image', I, O> {
+    providers: {
+        /**
+         * Provider of a model for image generation just from a (prompt) text.
+         */
+        text2image?: GetProvider<'image'>[] | GetProvider<'image'>;
+        /**
+         * Provider of a model for image generation from a given image.
+         */
+        image2image?: GetProvider<'image'>[] | GetProvider<'image'>;
+    };
     /**
      * Provider of a model for image generation just from a (prompt) text.
+     * @deprecated Use `providers.text2image` instead.
      */
-    text2image?: AiImageProvider;
+    text2image?: GetProvider<'image'>[] | GetProvider<'image'>;
     /**
      * Provider of a model for image generation from a given image.
+     * @deprecated Use `providers.image2image` instead.
      */
-    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;
+    image2image?: GetProvider<'image'>[] | GetProvider<'image'>;
+}
+/**
+ * Input types for image-specific quick actions
+ * This interface is extended by individual quick action files using module augmentation
+ */
+export interface ImageQuickActionInputs {
+}
+/**
+ * Type-safe support mapping for image quick actions
+ * Allows `true` or `{}` when the quick action input type extends the provider input type
+ */
+export type ImageQuickActionSupport<I, K extends keyof ImageQuickActionInputs> = ImageQuickActionInputs[K] extends I ? true | {
+    mapInput: (input: ImageQuickActionInputs[K]) => I;
+} | {
+    [key: string]: any;
+} : {
+    mapInput: (input: ImageQuickActionInputs[K]) => I;
+};
+/**
+ * Type-safe mapping for image quick action support
+ */
+export type ImageQuickActionSupportMap<I> = {
+    [K in keyof ImageQuickActionInputs]?: ImageQuickActionSupport<I, K>;
+} & {
+    [key: string]: true | {
+        mapInput: (input: any) => I;
+    } | {
+        [key: string]: any;
+    };
+};
+/**
+ * Image provider extension with type-safe quick action support
+ * Only parameterized by K (the quick action key), O is fixed to ImageOutput
+ */
+export interface ImageProvider<I> extends Provider<'image', I, ImageOutput> {
+    input: Omit<Provider<'image', I, ImageOutput>['input'], 'quickActions'> & {
+        quickActions?: {
+            supported?: ImageQuickActionSupportMap<I>;
+        };
+    };
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imgly/plugin-ai-image-generation-web",
-  "version": "0.1.10",
+  "version": "0.2.1",
   "description": "AI image generation plugin for the CE.SDK editor",
   "keywords": [
     "CE.SDK",
@@ -53,7 +53,7 @@
     "build": "pnpm run clean && pnpm _syncPnpm && pnpm exec node scripts/build.mjs",
     "test": "echo No tests",
     "dev": "pnpm --filter \"${npm_package_name}^...\" --parallel run dev:wait && pnpm exec concurrently 'node scripts/watch.mjs' 'pnpm _syncPnpm --watch' --names 'build,sync deps'",
-    "dev:wait": "pnpm exec wait-on ./dist/index.mjs ./dist/index.d.ts ./dist/fal-ai/index.mjs ./dist/fal-ai/index.d.ts ./dist/open-ai/index.mjs ./dist/open-ai/index.d.ts --window 250 --timeout 30000",
+    "dev:wait": "pnpm exec wait-on ./dist/index.mjs ./dist/index.d.ts ./dist/fal-ai/index.mjs ./dist/fal-ai/index.d.ts ./dist/open-ai/index.mjs ./dist/open-ai/index.d.ts --window 250 --timeout 60000",
     "dev:types": "tsc --emitDeclarationOnly --watch --preserveWatchOutput",
     "publish:latest": "pnpm run build && npm publish --tag latest --access public",
     "publish:next": "pnpm run build && npm publish --tag next --access public",