@imgly/plugin-ai-generation-web 0.1.0-rc.0

package/dist/__tests__/middleware-disposer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/middleware-rateLimiting.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/middleware.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/common/renderImageUrlProperty.d.ts

@@ -0,0 +1,14 @@
+import CreativeEditorSDK from '@cesdk/cesdk-js';
+import { RenderCustomProperty } from '../generation/provider';
+/**
+ * Provides render function for a image url property that allows
+ * to select an image from the library with a MediaPreview
+ *
+ * By default this expects the property key to be `image_url`. This can be changed in the options.
+ */
+declare function renderImageUrlProperty(provderId: string, options: {
+    cesdk: CreativeEditorSDK;
+    propertyKey?: string;
+    defaultUrl?: string;
+}): RenderCustomProperty;
+export default renderImageUrlProperty;

package/dist/generation/generate.d.ts

@@ -0,0 +1,16 @@
+import type Provider from './provider';
+import { type GetInput, type GetBlockInput, OutputKind, type Output } from './provider';
+import { InitProviderConfiguration, UIOptions } from './types';
+type Result<O> = {
+    status: 'success';
+    output: O;
+} | {
+    status: 'aborted';
+};
+/**
+ * Generate content using the provider with the given input
+ */
+declare function generate<K extends OutputKind, I, O extends Output>(kind: K, getInput: GetInput<I>, getBlockInput: GetBlockInput<K, I>, provider: Provider<K, I, O>, options: UIOptions & {
+    createPlaceholderBlock?: boolean;
+}, config: InitProviderConfiguration, abortSignal: AbortSignal): Promise<Result<O>>;
+export default generate;

package/dist/generation/getAssetResultForGenerated.d.ts

@@ -0,0 +1,4 @@
+import { type AssetResult } from '@cesdk/cesdk-js';
+import { type OutputKind, GetBlockInputResult, Output } from './provider';
+declare function getAssetResultForGenerated<K extends OutputKind>(id: string, kind: K, blockInputs: GetBlockInputResult<K>, output: Output): Promise<AssetResult>;
+export default getAssetResultForGenerated;

package/dist/generation/getAssetResultForPlaceholder.d.ts

@@ -0,0 +1,4 @@
+import { type AssetResult } from '@cesdk/cesdk-js';
+import { type OutputKind, GetBlockInputResult } from './provider';
+declare function getAssetResultForPlaceholder<K extends OutputKind>(id: string, kind: K, blockInput: GetBlockInputResult<K>): AssetResult;
+export default getAssetResultForPlaceholder;

package/dist/generation/getDryRunOutput.d.ts

@@ -0,0 +1,3 @@
+import { type OutputKind, type GetBlockInputResult, type Output } from './provider';
+declare function getDryRunOutput<K extends OutputKind>(kind: K, input: GetBlockInputResult<K>): Output;
+export default getDryRunOutput;

package/dist/generation/handleGenerationError.d.ts

@@ -0,0 +1,9 @@
+import CreativeEditorSDK from '@cesdk/cesdk-js';
+import Provider, { GetInput, Output, OutputKind } from './provider';
+import { InitProviderConfiguration } from './types';
+declare function handleGenerationError<K extends OutputKind, I, O extends Output>(error: unknown, options: {
+    cesdk: CreativeEditorSDK;
+    provider: Provider<K, I, O>;
+    getInput?: GetInput<I>;
+}, config: InitProviderConfiguration): void;
+export default handleGenerationError;

package/dist/generation/initProvider.d.ts

@@ -0,0 +1,20 @@
+import type Provider from './provider';
+import { OutputKind, type Output } from './provider';
+import { InitProviderConfiguration, Options } from './types';
+import { BuilderRenderFunction } from '@cesdk/cesdk-js';
+type RenderBuilderFunctions = {
+    panel?: BuilderRenderFunction<any>;
+};
+/**
+ * Initialize the provider. Based on the given options and configuration
+ * it will register panels and components that is used to render
+ * the provider in the UI.
+ *
+ * @param provider The provider to initialize.
+ * @param options The options to use for the provider.
+ * @param config The configuration to use for the provider.
+ */
+declare function initProvider<K extends OutputKind, I, O extends Output>(provider: Provider<K, I, O>, options: Options, config: InitProviderConfiguration): Promise<{
+    renderBuilderFunctions?: RenderBuilderFunctions;
+}>;
+export default initProvider;

package/dist/generation/middleware/alwaysOnTopMiddleware.d.ts

@@ -0,0 +1,14 @@
+import { Middleware } from './middleware';
+import { Output } from '../provider';
+/**
+ * Sets the blocks to a pending state while the middleware is running.
+ */
+declare function alwaysOnTopMiddleware<I, O extends Output>({ pending }: {
+    /**
+     * Should the blocks be set to a pending state?
+     *
+     * @default true
+     */
+    pending?: boolean;
+}): Middleware<I, O>;
+export default alwaysOnTopMiddleware;

package/dist/generation/middleware/editModeMiddleware.d.ts

@@ -0,0 +1,30 @@
+import { Middleware } from './middleware';
+import { Output } from '../provider';
+/**
+ * For a given edit mode and block ids, this middleware will
+ * ensure that as long as these blocks are selected, the edit mode is
+ * set to the given edit mode and cannot be changed.
+ *
+ * The use-case is to show only the generation canvas menu during
+ * the generation process.
+ */
+declare function editModeMiddleware<I, O extends Output>({ editMode, automaticallyUnlock, showNotification }: {
+    /**
+     * The edit mode to lock the selection to.
+     */
+    editMode: string;
+    /**
+     * Should the selection be automatically unlocked after the function completes?
+     * Otherwise the returned unlock function must be called manually.
+     *
+     * @default false
+     */
+    automaticallyUnlock?: boolean;
+    /**
+     * Should the blocks be set when the generation is done
+     *
+     * @default true
+     */
+    showNotification?: boolean;
+}): Middleware<I, O>;
+export default editModeMiddleware;

package/dist/generation/middleware/highlightBlocksMiddleware.d.ts

@@ -0,0 +1,24 @@
+import { Middleware } from './middleware';
+import { Output } from '../provider';
+/**
+ * Highlights the blocks while the middleware is running.
+ *
+ * - Sets the blocks to always on top
+ * - Disables clipping of the parent of the blocks so it is visible
+ */
+declare function highlightBlocksMiddleware<I, O extends Output>({ alwaysOnTop, disableClipping }: {
+    /**
+     * Until disposed, should the block be always on top to be visible?
+     *
+     * @default true
+     */
+    alwaysOnTop?: boolean;
+    /**
+     * If true, the clipping of the parent of the affected blocks will be
+     * temporarily disabled until unlocked.
+     *
+     * @default true
+     */
+    disableClipping?: boolean;
+}): Middleware<I, O>;
+export default highlightBlocksMiddleware;

package/dist/generation/middleware/lockMiddleware.d.ts

@@ -0,0 +1,19 @@
+import { Middleware } from './middleware';
+import { Output } from '../provider';
+/**
+ * Highlights the blocks while the middleware is running.
+ */
+declare function lockMiddleware<I, O extends Output>({ editMode, automaticallyUnlock }: {
+    /**
+     * The edit mode to lock the selection to.
+     */
+    editMode: string;
+    /**
+     * Should the selection be automatically unlocked after the function completes?
+     * Otherwise the returned unlock function must be called manually.
+     *
+     * @default false
+     */
+    automaticallyUnlock?: boolean;
+}): Middleware<I, O>;
+export default lockMiddleware;

package/dist/generation/middleware/loggingMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { Output } from '../provider';
+import { Middleware } from './middleware';
+declare function loggingMiddleware<I, O extends Output>(): Middleware<I, O>;
+export default loggingMiddleware;

package/dist/generation/middleware/middleware.d.ts

@@ -0,0 +1,35 @@
+import { GenerationOptions, GenerationResult, Output } from '../provider';
+/**
+ * Result of the generation with a dispose function to clean up
+ */
+export interface DisposableGenerationResult<O extends Output> {
+    /**
+     * The actual generation result
+     */
+    result: GenerationResult<O>;
+    /**
+     * Function to dispose/clean up resources created during generation
+     * This should be called when the generation is cancelled or completely
+     * finished including the confirmation of the generation if applicable.
+     */
+    dispose: () => Promise<void>;
+}
+/**
+ * Define the type for middleware functions
+ */
+export type Middleware<I, O extends Output> = (input: I, options: GenerationOptions & {
+    /**
+     * The block ids the generation is applied on
+     * If this value is undefined, the selected blocks will be used.
+     * Setting this value to null will explicitly tell every
+     * middleware that no block shall be used.
+     */
+    blockIds?: number[] | null;
+    /**
+     * Adds a disposer function to this genereation which is called
+     * when the generation is cancelled or completely finished
+     * including the confirmation of the generation if applicable.
+     */
+    addDisposer: (dispose: () => Promise<void>) => void;
+}, next: (input: I, options: GenerationOptions) => Promise<GenerationResult<O>>) => Promise<GenerationResult<O>>;
+export declare function composeMiddlewares<I, O extends Output>(middlewares: (Middleware<I, O> | false | undefined | null)[]): (baseHandler: (input: I, options: GenerationOptions) => Promise<GenerationResult<O>>) => (input: I, options: GenerationOptions) => Promise<DisposableGenerationResult<O>>;

package/dist/generation/middleware/pendingMiddleware.d.ts

@@ -0,0 +1,14 @@
+import { Middleware } from './middleware';
+import { Output } from '../provider';
+/**
+ * Sets the blocks to a pending state while the middleware is running.
+ */
+declare function pendingMiddleware<I, O extends Output>({ pending }: {
+    /**
+     * Should the blocks be set to a pending state?
+     *
+     * @default true
+     */
+    pending?: boolean;
+}): Middleware<I, O>;
+export default pendingMiddleware;

package/dist/generation/middleware/rateLimitMiddleware.d.ts

@@ -0,0 +1,40 @@
+import { GenerationOptions, Output } from '../provider';
+import { Middleware } from './middleware';
+export interface RateLimitOptions {
+    /**
+     * Maximum number of requests allowed in the time window
+     */
+    maxRequests: number;
+    /**
+     * Time window in milliseconds
+     */
+    timeWindowMs: number;
+    /**
+     * Optional key function to create different rate limits for different inputs
+     * If not provided, all requests share the same rate limit
+     */
+    keyFn?: <I>(input: I, options: GenerationOptions) => string;
+    /**
+     * Callback function that is called when rate limit is exceeded
+     * Return value determines if the operation should be rejected (throw error) or allowed
+     * If true is returned, the operation will proceed despite exceeding the rate limit
+     * If false or undefined is returned, the operation will be rejected with a default error
+     */
+    onRateLimitExceeded?: <I>(input: I, options: GenerationOptions, rateLimitInfo: {
+        key: string;
+        currentCount: number;
+        maxRequests: number;
+        timeWindowMs: number;
+        remainingTimeMs: number;
+    }) => boolean | Promise<boolean> | void;
+}
+interface RequestTracker {
+    timestamps: number[];
+    lastCleanup: number;
+}
+export declare const requestsStore: Record<string, RequestTracker>;
+/**
+ * Middleware that implements rate limiting for AI generation requests
+ */
+declare function rateLimitMiddleware<I, O extends Output>(middlewareOptions: RateLimitOptions): Middleware<I, O>;
+export default rateLimitMiddleware;

package/dist/generation/openapi/dereferenceDocument.d.ts

@@ -0,0 +1,14 @@
+import { type OpenAPIV3 } from 'openapi-types';
+/**
+ * Resolves a JSON reference path within a document
+ * @param document The OpenAPI document
+ * @param refPath The reference path (e.g. "#/components/schemas/MySchema")
+ * @returns The resolved object from the document
+ */
+export declare function resolveReference(document: OpenAPIV3.Document, refPath: string): unknown;
+/**
+ * Dereferences all $ref properties in an OpenAPI document
+ * @param document The OpenAPI document to dereference
+ * @returns A new document with all references resolved
+ */
+export default function dereferenceDocument(document: OpenAPIV3.Document): OpenAPIV3.Document;

package/dist/generation/openapi/getProperties.d.ts

@@ -0,0 +1,5 @@
+import { OpenAPIV3 } from 'openapi-types';
+import { OutputKind, PanelInputSchema } from '../provider';
+import { Property } from './types';
+declare function getProperties<K extends OutputKind, I>(inputSchema: OpenAPIV3.SchemaObject, panelInput: PanelInputSchema<K, I>): Property[];
+export default getProperties;

package/dist/generation/openapi/isOpenAPISchema.d.ts

@@ -0,0 +1,9 @@
+import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Checks if an unknown object is an OpenAPI schema (first level only)
+ *
+ * @param obj - The object to check (potentially undefined)
+ * @param debug - If true, log the reason when validation fails
+ * @returns A boolean indicating whether the object is an OpenAPI schema
+ */
+export declare function isOpenAPISchema(obj: unknown, debug?: boolean): obj is OpenAPIV3.SchemaObject;

package/dist/generation/openapi/renderProperty.d.ts

@@ -0,0 +1,6 @@
+import { BuilderRenderFunctionContext } from '@cesdk/cesdk-js';
+import { GetPropertyInput, Property } from './types';
+import Provider, { Output, OutputKind, PanelInputSchema } from '../provider';
+import { InitProviderConfiguration, UIOptions } from '../types';
+declare function renderProperty<K extends OutputKind, I, O extends Output>(context: BuilderRenderFunctionContext<any>, property: Property, provider: Provider<K, I, O>, panelInput: PanelInputSchema<K, I>, options: UIOptions, config: InitProviderConfiguration): GetPropertyInput | undefined;
+export default renderProperty;

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

@@ -0,0 +1,41 @@
+import { Builder } from '@cesdk/cesdk-js';
+import { OpenAPIV3 } from 'openapi-types';
+export interface Property {
+    id: string;
+    schema: OpenAPIV3.SchemaObject;
+}
+type PropertyInputForString = {
+    id: string;
+    type: 'string';
+    value: string;
+};
+type PropertyInputForBoolean = {
+    id: string;
+    type: 'boolean';
+    value: boolean;
+};
+type PropertyInputForInteger = {
+    id: string;
+    type: 'integer';
+    value: number;
+};
+type PropertyInputForObject = {
+    id: string;
+    type: 'object';
+    value: Record<string, PropertyInput>;
+};
+export type PropertyInput = PropertyInputForString | PropertyInputForBoolean | PropertyInputForInteger | PropertyInputForObject;
+export type GetPropertyInput = () => PropertyInput;
+type CustomIcon = string | (({ theme, iconSize }: {
+    theme: string;
+    iconSize: 'normal' | 'large';
+}) => string);
+export interface EnumValue {
+    id: string;
+    label: string | string[];
+    icon?: CustomIcon;
+}
+export interface ExtensionImglyBuilder {
+    component?: keyof Builder;
+}
+export {};

package/dist/generation/previewUri.d.ts

@@ -0,0 +1,2 @@
+declare const previewUri = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMzIzIiBoZWlnaHQ9IjMyMyIgdmlld0JveD0iMCAwIDMyMyAzMjMiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxyZWN0IHdpZHRoPSIzMjMiIGhlaWdodD0iMzIzIiBmaWxsPSIjRTlFQkVEIi8+CjxnIG9wYWNpdHk9IjAuMyI+CjxwYXRoIGQ9Ik0xMTYgMTg0VjE5MS41QzExNiAxOTkuNzg0IDEyMi43MTYgMjA2LjUgMTMxIDIwNi41SDE5MUMxOTkuMjg0IDIwNi41IDIwNiAxOTkuNzg0IDIwNiAxOTEuNVYxMzEuNUMyMDYgMTIzLjIxNiAxOTkuMjg0IDExNi41IDE5MSAxMTYuNUwxOTAuOTk1IDEyNi41QzE5My43NTcgMTI2LjUgMTk2IDEyOC43MzkgMTk2IDEzMS41VjE5MS41QzE5NiAxOTQuMjYxIDE5My43NjEgMTk2LjUgMTkxIDE5Ni41SDEzMUMxMjguMjM5IDE5Ni41IDEyNiAxOTQuMjYxIDEyNiAxOTEuNVYxODRIMTE2WiIgZmlsbD0iIzhGOEY4RiIvPgo8cGF0aCBkPSJNMTY2LjQ5NCAxMDUuOTI0QzE2NS44NjkgMTA0LjM0MiAxNjMuNjI5IDEwNC4zNDIgMTYzLjAwNSAxMDUuOTI0TDE1OS43NDUgMTE0LjE5MUMxNTkuNTU0IDExNC42NzQgMTU5LjE3MiAxMTUuMDU3IDE1OC42ODggMTE1LjI0N0wxNTAuNDIyIDExOC41MDhDMTQ4LjgzOSAxMTkuMTMyIDE0OC44MzkgMTIxLjM3MiAxNTAuNDIyIDEyMS45OTZMMTU4LjY4OCAxMjUuMjU2QzE1OS4xNzIgMTI1LjQ0NyAxNTkuNTU0IDEyNS44MjkgMTU5Ljc0NSAxMjYuMzEzTDE2My4wMDUgMTM0LjU3OUMxNjMuNjI5IDEzNi4xNjIgMTY1Ljg2OSAxMzYuMTYyIDE2Ni40OTQgMTM0LjU3OUwxNjkuNzU0IDEyNi4zMTNDMTY5Ljk0NCAxMjUuODI5IDE3MC4zMjcgMTI1LjQ0NyAxNzAuODEgMTI1LjI1NkwxNzkuMDc3IDEyMS45OTZDMTgwLjY2IDEyMS4zNzIgMTgwLjY2IDExOS4xMzIgMTc5LjA3NyAxMTguNTA4TDE3MC44MSAxMTUuMjQ3QzE3MC4zMjcgMTE1LjA1NyAxNjkuOTQ0IDExNC42NzQgMTY5Ljc1NCAxMTQuMTkxTDE2Ni40OTQgMTA1LjkyNFoiIGZpbGw9IiM4RjhGOEYiLz4KPHBhdGggZD0iTTEzMy4wMDUgMTI4LjQyNEMxMzMuNjI5IDEyNi44NDIgMTM1Ljg2OSAxMjYuODQyIDEzNi40OTQgMTI4LjQyNEwxNDEuODc1IDE0Mi4wN0MxNDIuMDY2IDE0Mi41NTMgMTQyLjQ0OCAxNDIuOTM1IDE0Mi45MzIgMTQzLjEyNkwxNTYuNTc3IDE0OC41MDhDMTU4LjE2IDE0OS4xMzIgMTU4LjE2IDE1MS4zNzIgMTU2LjU3NyAxNTEuOTk2TDE0Mi45MzIgMTU3LjM3OEMxNDIuNDQ4IDE1Ny41NjggMTQyLjA2NiAxNTcuOTUxIDE0MS44NzUgMTU4LjQzNEwxMzYuNDk0IDE3Mi4wNzlDMTM1Ljg2OSAxNzMuNjYyIDEzMy42MjkgMTczLjY2MiAxMzMuMDA1IDE3Mi4wNzlMMTI3LjYyMyAxNTguNDM0QzEyNy40MzMgMTU3Ljk1MSAxMjcuMDUgMTU3LjU2OCAxMjYuNTY3IDE1Ny4zNzhMMTEyLjkyMiAxNTEuOTk2QzExMS4zMzkgMTUxLjM3MiAxMTEuMzM5IDE0OS4xMzIgMTEyLjkyMiAxNDguNTA4TDEyNi41NjcgMTQzLjEyNkMxMjcuMDUgMTQyLjkzNSAxMjcuNDMzIDE0Mi41NTMgMTI3LjYyMyAxNDIuMDdMMTMzLjAwNSAxMjguNDI0WiIgZmlsbD0iIzhGOEY4RiIvPgo8cGF0aCBkPSJNMTk1Ljk5OSAxODQuMDA0VjE5MS41MDJDMTk1Ljk5OSAxOTQuMjYzIDE5My43NjEgMTk2LjUwMiAxOTAuOTk5IDE5Ni41MDJIMTQ3LjY2OEwxNzIuODc5IDE1OC42ODRDMTc0LjM2MyAxNTYuNDU4IDE3Ny42MzUgMTU2LjQ1OCAxNzkuMTIgMTU4LjY4NEwxOTUuOTk5IDE4NC4wMDRaIiBmaWxsPSIjOEY4RjhGIi8+CjwvZz4KPC9zdmc+Cg==";
+export default previewUri;