puckeditor-plugin-ai 0.6.0

package/dist/index.d.mts

@@ -0,0 +1,237 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PuckAction, Data, Config, Plugin } from '@puckeditor/core';
+import { CreateUIMessage, UIMessage, LanguageModelUsage, DataUIPart, ChatStatus } from 'ai';
+
+interface AttachedImage {
+    /** Unique key for React lists */
+    id: string;
+    /** base64 data URL e.g. "data:image/png;base64,..." */
+    dataUrl: string;
+    /** Original file name */
+    name: string;
+}
+type _JSONSchema = boolean | JSONSchema;
+type JSONSchema = {
+    [k: string]: unknown;
+    $schema?: string;
+    $id?: string;
+    $ref?: string;
+    $defs?: Record<string, JSONSchema>;
+    type?: "object" | "array" | "string" | "number" | "boolean" | "null" | "integer";
+    additionalItems?: _JSONSchema;
+    unevaluatedItems?: _JSONSchema;
+    prefixItems?: _JSONSchema[];
+    items?: _JSONSchema | _JSONSchema[];
+    contains?: _JSONSchema;
+    additionalProperties?: _JSONSchema;
+    unevaluatedProperties?: _JSONSchema;
+    properties?: Record<string, _JSONSchema>;
+    patternProperties?: Record<string, _JSONSchema>;
+    dependentSchemas?: Record<string, _JSONSchema>;
+    propertyNames?: _JSONSchema;
+    if?: _JSONSchema;
+    then?: _JSONSchema;
+    else?: _JSONSchema;
+    allOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    oneOf?: JSONSchema[];
+    not?: _JSONSchema;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number | boolean;
+    minimum?: number;
+    exclusiveMinimum?: number | boolean;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxContains?: number;
+    minContains?: number;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    dependentRequired?: Record<string, string[]>;
+    enum?: Array<string | number | boolean | null>;
+    const?: string | number | boolean | null;
+    id?: string;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    deprecated?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    nullable?: boolean;
+    examples?: unknown[];
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    contentSchema?: JSONSchema;
+    _prefault?: unknown;
+};
+type ComponentAiParams = {
+    instructions?: string;
+    exclude?: boolean;
+    defaultZone?: {
+        allow?: string[];
+        disallow?: string[];
+        disabled?: boolean;
+    };
+};
+type FieldAiParams = {
+    instructions?: string;
+    exclude?: boolean;
+    required?: boolean;
+    stream?: boolean;
+    schema?: JSONSchema;
+    bind?: string;
+};
+type AddOperation = {
+    op: "add";
+    id: string;
+    index: number;
+    zone: string;
+    type: string;
+    props: object;
+};
+type UpdateOperation = {
+    op: "update";
+    id: string;
+    props: object;
+};
+type UpdateRootOperation = {
+    op: "updateRoot";
+    props: object;
+};
+type MoveOperation = {
+    op: "move";
+    zone: string;
+    id: string;
+    index: number;
+};
+type DeleteOperation = {
+    op: "delete";
+    id: string;
+};
+type DuplicateOperation = {
+    op: "duplicate";
+    id: string;
+};
+type ResetOperation = {
+    op: "reset";
+};
+type Operation = AddOperation | UpdateOperation | UpdateRootOperation | MoveOperation | DeleteOperation | DuplicateOperation | ResetOperation;
+type ToolStatus = {
+    loading: boolean;
+    label: string;
+    error?: {
+        message: string;
+    };
+};
+type DataToolStatus = {
+    status: ToolStatus;
+    toolCallId: string;
+};
+type TokenUsage = {
+    inputTokens: number | undefined;
+    outputTokens: number | undefined;
+    totalTokens: number | undefined;
+    reasoningTokens?: number | undefined;
+    cachedInputTokens?: number | undefined;
+};
+type DataFinish = {
+    totalCost: number;
+    tokenUsage: TokenUsage;
+};
+type PuckDataParts = {
+    "new-chat-created": {
+        chatId: string;
+    };
+    "puck-actions": PuckAction[];
+    "build-op": Operation;
+    "tool-status": DataToolStatus;
+    "user-tool": {
+        toolCallId: string;
+        tools: {
+            name: string;
+            input: any;
+        }[];
+    };
+    "send-screenshot": {
+        id: string;
+        urls: {
+            [breakpoint: number]: string;
+        }[];
+    };
+    finish: DataFinish;
+    page: Data;
+};
+type PuckProviderMetadata = {
+    tokenUsage?: LanguageModelUsage;
+};
+type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
+type RequestOptions = {
+    body?: {
+        chatId?: string;
+        trigger?: string;
+        messages?: PuckMessage[];
+        pageData?: Data;
+        config?: Config;
+        [key: string]: any;
+    };
+    headers?: HeadersInit;
+    credentials?: RequestCredentials;
+};
+type AiPluginProps = {
+    host?: string;
+    chat?: {
+        onSubmit?: (prompt: string) => void;
+        examplePrompts?: {
+            label: string;
+            href?: string;
+            onClick?: () => void;
+        }[];
+    };
+    scrollTracking?: boolean;
+    prepareRequest?: (opts: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+};
+declare module "@puckeditor/core" {
+    interface ComponentMetadata {
+        ai?: ComponentAiParams;
+    }
+    interface ComponentConfigExtensions {
+        ai?: ComponentAiParams;
+    }
+    interface FieldMetadata {
+        ai?: FieldAiParams;
+    }
+    interface BaseField {
+        ai?: FieldAiParams;
+    }
+}
+type TargetComponent = {
+    id: string;
+    type: string;
+    label?: string;
+};
+declare global {
+    interface Window {
+        __PUCK_AI: {
+            sendMessage: (message: CreateUIMessage<PuckMessage>) => void;
+            setMessages: (_messages: PuckMessage[]) => void;
+            processData: (_dataPart: DataUIPart<PuckDataParts>) => void;
+            setStatus: (_status: ChatStatus) => void;
+            setPrompt: (_value: string) => void;
+            setTargetComponent: (_target: TargetComponent | null) => void;
+        };
+    }
+}
+declare function Chat({ chat, host, prepareRequest, }: {
+    chat?: AiPluginProps["chat"];
+    host?: string;
+    prepareRequest?: AiPluginProps["prepareRequest"];
+}): react_jsx_runtime.JSX.Element;
+declare function createAiPlugin(opts?: AiPluginProps): Plugin;
+
+export { type AddOperation, type AiPluginProps, type AttachedImage, Chat, type ComponentAiParams, type DataToolStatus, type DeleteOperation, type DuplicateOperation, type FieldAiParams, type JSONSchema, type MoveOperation, type Operation, type PuckMessage, type RequestOptions, type ResetOperation, type TargetComponent, type ToolStatus, type UpdateOperation, type UpdateRootOperation, createAiPlugin, createAiPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PuckAction, Data, Config, Plugin } from '@puckeditor/core';
+import { CreateUIMessage, UIMessage, LanguageModelUsage, DataUIPart, ChatStatus } from 'ai';
+
+interface AttachedImage {
+    /** Unique key for React lists */
+    id: string;
+    /** base64 data URL e.g. "data:image/png;base64,..." */
+    dataUrl: string;
+    /** Original file name */
+    name: string;
+}
+type _JSONSchema = boolean | JSONSchema;
+type JSONSchema = {
+    [k: string]: unknown;
+    $schema?: string;
+    $id?: string;
+    $ref?: string;
+    $defs?: Record<string, JSONSchema>;
+    type?: "object" | "array" | "string" | "number" | "boolean" | "null" | "integer";
+    additionalItems?: _JSONSchema;
+    unevaluatedItems?: _JSONSchema;
+    prefixItems?: _JSONSchema[];
+    items?: _JSONSchema | _JSONSchema[];
+    contains?: _JSONSchema;
+    additionalProperties?: _JSONSchema;
+    unevaluatedProperties?: _JSONSchema;
+    properties?: Record<string, _JSONSchema>;
+    patternProperties?: Record<string, _JSONSchema>;
+    dependentSchemas?: Record<string, _JSONSchema>;
+    propertyNames?: _JSONSchema;
+    if?: _JSONSchema;
+    then?: _JSONSchema;
+    else?: _JSONSchema;
+    allOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    oneOf?: JSONSchema[];
+    not?: _JSONSchema;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number | boolean;
+    minimum?: number;
+    exclusiveMinimum?: number | boolean;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxContains?: number;
+    minContains?: number;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    dependentRequired?: Record<string, string[]>;
+    enum?: Array<string | number | boolean | null>;
+    const?: string | number | boolean | null;
+    id?: string;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    deprecated?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    nullable?: boolean;
+    examples?: unknown[];
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    contentSchema?: JSONSchema;
+    _prefault?: unknown;
+};
+type ComponentAiParams = {
+    instructions?: string;
+    exclude?: boolean;
+    defaultZone?: {
+        allow?: string[];
+        disallow?: string[];
+        disabled?: boolean;
+    };
+};
+type FieldAiParams = {
+    instructions?: string;
+    exclude?: boolean;
+    required?: boolean;
+    stream?: boolean;
+    schema?: JSONSchema;
+    bind?: string;
+};
+type AddOperation = {
+    op: "add";
+    id: string;
+    index: number;
+    zone: string;
+    type: string;
+    props: object;
+};
+type UpdateOperation = {
+    op: "update";
+    id: string;
+    props: object;
+};
+type UpdateRootOperation = {
+    op: "updateRoot";
+    props: object;
+};
+type MoveOperation = {
+    op: "move";
+    zone: string;
+    id: string;
+    index: number;
+};
+type DeleteOperation = {
+    op: "delete";
+    id: string;
+};
+type DuplicateOperation = {
+    op: "duplicate";
+    id: string;
+};
+type ResetOperation = {
+    op: "reset";
+};
+type Operation = AddOperation | UpdateOperation | UpdateRootOperation | MoveOperation | DeleteOperation | DuplicateOperation | ResetOperation;
+type ToolStatus = {
+    loading: boolean;
+    label: string;
+    error?: {
+        message: string;
+    };
+};
+type DataToolStatus = {
+    status: ToolStatus;
+    toolCallId: string;
+};
+type TokenUsage = {
+    inputTokens: number | undefined;
+    outputTokens: number | undefined;
+    totalTokens: number | undefined;
+    reasoningTokens?: number | undefined;
+    cachedInputTokens?: number | undefined;
+};
+type DataFinish = {
+    totalCost: number;
+    tokenUsage: TokenUsage;
+};
+type PuckDataParts = {
+    "new-chat-created": {
+        chatId: string;
+    };
+    "puck-actions": PuckAction[];
+    "build-op": Operation;
+    "tool-status": DataToolStatus;
+    "user-tool": {
+        toolCallId: string;
+        tools: {
+            name: string;
+            input: any;
+        }[];
+    };
+    "send-screenshot": {
+        id: string;
+        urls: {
+            [breakpoint: number]: string;
+        }[];
+    };
+    finish: DataFinish;
+    page: Data;
+};
+type PuckProviderMetadata = {
+    tokenUsage?: LanguageModelUsage;
+};
+type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
+type RequestOptions = {
+    body?: {
+        chatId?: string;
+        trigger?: string;
+        messages?: PuckMessage[];
+        pageData?: Data;
+        config?: Config;
+        [key: string]: any;
+    };
+    headers?: HeadersInit;
+    credentials?: RequestCredentials;
+};
+type AiPluginProps = {
+    host?: string;
+    chat?: {
+        onSubmit?: (prompt: string) => void;
+        examplePrompts?: {
+            label: string;
+            href?: string;
+            onClick?: () => void;
+        }[];
+    };
+    scrollTracking?: boolean;
+    prepareRequest?: (opts: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+};
+declare module "@puckeditor/core" {
+    interface ComponentMetadata {
+        ai?: ComponentAiParams;
+    }
+    interface ComponentConfigExtensions {
+        ai?: ComponentAiParams;
+    }
+    interface FieldMetadata {
+        ai?: FieldAiParams;
+    }
+    interface BaseField {
+        ai?: FieldAiParams;
+    }
+}
+type TargetComponent = {
+    id: string;
+    type: string;
+    label?: string;
+};
+declare global {
+    interface Window {
+        __PUCK_AI: {
+            sendMessage: (message: CreateUIMessage<PuckMessage>) => void;
+            setMessages: (_messages: PuckMessage[]) => void;
+            processData: (_dataPart: DataUIPart<PuckDataParts>) => void;
+            setStatus: (_status: ChatStatus) => void;
+            setPrompt: (_value: string) => void;
+            setTargetComponent: (_target: TargetComponent | null) => void;
+        };
+    }
+}
+declare function Chat({ chat, host, prepareRequest, }: {
+    chat?: AiPluginProps["chat"];
+    host?: string;
+    prepareRequest?: AiPluginProps["prepareRequest"];
+}): react_jsx_runtime.JSX.Element;
+declare function createAiPlugin(opts?: AiPluginProps): Plugin;
+
+export { type AddOperation, type AiPluginProps, type AttachedImage, Chat, type ComponentAiParams, type DataToolStatus, type DeleteOperation, type DuplicateOperation, type FieldAiParams, type JSONSchema, type MoveOperation, type Operation, type PuckMessage, type RequestOptions, type ResetOperation, type TargetComponent, type ToolStatus, type UpdateOperation, type UpdateRootOperation, createAiPlugin, createAiPlugin as default };