@puckeditor/plugin-ai 0.8.0-canary.fed2989a → 0.8.0

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import * as react from 'react';
+import { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PuckAction, Data, Config } from '@puckeditor/core';
-import { LanguageModelUsage, UIMessage, CreateUIMessage, DataUIPart, ChatStatus } from 'ai';
+import { LanguageModelUsage, UIMessage, CreateUIMessage, DataUIPart, ChatStatus, ChatOnFinishCallback } from 'ai';
 
 type _JSONSchema = boolean | JSONSchema;
 type JSONSchema = {
@@ -122,14 +123,23 @@ type AddOperation = {
     type: string;
     props: object;
 };
+/**
+ * Streamed string tails keyed by prop path (e.g. `html`, `cta.label`,
+ * `items[2].title`). Each tail is appended to the value currently at that
+ * path. A top-level prop is carried either in `props` (full replacement) or
+ * in `appends` — never both — so applying them can't double-append.
+ */
+type StringAppends = Record<string, string>;
 type UpdateOperation = {
     op: "update";
     id: string;
     props: object;
+    appends?: StringAppends;
 };
 type UpdateRootOperation = {
     op: "updateRoot";
     props: object;
+    appends?: StringAppends;
 };
 type MoveOperation = {
     op: "move";
@@ -155,6 +165,7 @@ type TokenUsage = {
     totalTokens: number | undefined;
     reasoningTokens?: number | undefined;
     cachedInputTokens?: number | undefined;
+    cacheWriteTokens?: number | undefined;
 };
 type DataFinish = {
     totalCost: number;
@@ -222,6 +233,13 @@ type PuckDataParts = {
     "subagent-event": SubagentEvent;
     finish: DataFinish;
     page: Data;
+    "version-notice": {
+        package: string;
+        message: string;
+        currentVersion: string;
+        latestVersion: string;
+        blogUrl: string;
+    };
 };
 type PuckProviderMetadata = {
     tokenUsage?: LanguageModelUsage;
@@ -229,6 +247,7 @@ type PuckProviderMetadata = {
 
 type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
 
+type Mode = "assembly" | "design";
 type RequestOptions = {
     body?: {
         chatId?: string;
@@ -236,6 +255,7 @@ type RequestOptions = {
         messages?: PuckMessage[];
         pageData?: Data;
         config?: Config;
+        mode?: Mode;
         [key: string]: any;
     };
     headers?: HeadersInit;
@@ -255,14 +275,23 @@ type AiPluginProps = {
                 type: "file";
             }>[];
         }) => void | Promise<void>;
+        onFinish?: ChatOnFinishCallback<PuckMessage>;
         examplePrompts?: {
             label: string;
             href?: string;
             onClick?: () => void;
         }[];
+        placeholder?: ReactNode;
+        actions?: ReactNode | ((state: {
+            disabled: boolean;
+        }) => ReactNode);
     };
     scrollTracking?: boolean;
     prepareRequest?: (opts: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+    designMode?: boolean | {
+        visible?: boolean;
+    };
+    defaultMode?: "assembly" | "design";
 };
 declare global {
     interface Window {
@@ -271,10 +300,12 @@ declare global {
             setMessages: (_messages: PuckMessage[]) => void;
             processData: (_messages: DataUIPart<PuckDataParts>) => void;
             setStatus: (_status: ChatStatus) => void;
+            focus: () => void;
         };
     }
 }
 
+declare function withDynamicConfig(config: Config, data: Data): Config;
 declare function createAiPlugin(opts?: AiPluginProps): {
     label: string;
     name: string;
@@ -282,10 +313,13 @@ declare function createAiPlugin(opts?: AiPluginProps): {
     icon: react_jsx_runtime.JSX.Element;
     mobilePanelHeight: "min-content";
     overrides: {
+        drawer: ({ children }: {
+            children: react.ReactNode;
+        }) => react_jsx_runtime.JSX.Element;
         preview: ({ children }: {
             children: react.ReactNode;
         }) => react_jsx_runtime.JSX.Element;
     };
 };
 
-export { type ComponentAiParams, type FieldAiParams, createAiPlugin };
+export { type ComponentAiParams, type FieldAiParams, createAiPlugin, withDynamicConfig };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as react from 'react';
+import { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { PuckAction, Data, Config } from '@puckeditor/core';
-import { LanguageModelUsage, UIMessage, CreateUIMessage, DataUIPart, ChatStatus } from 'ai';
+import { LanguageModelUsage, UIMessage, CreateUIMessage, DataUIPart, ChatStatus, ChatOnFinishCallback } from 'ai';
 
 type _JSONSchema = boolean | JSONSchema;
 type JSONSchema = {
@@ -122,14 +123,23 @@ type AddOperation = {
     type: string;
     props: object;
 };
+/**
+ * Streamed string tails keyed by prop path (e.g. `html`, `cta.label`,
+ * `items[2].title`). Each tail is appended to the value currently at that
+ * path. A top-level prop is carried either in `props` (full replacement) or
+ * in `appends` — never both — so applying them can't double-append.
+ */
+type StringAppends = Record<string, string>;
 type UpdateOperation = {
     op: "update";
     id: string;
     props: object;
+    appends?: StringAppends;
 };
 type UpdateRootOperation = {
     op: "updateRoot";
     props: object;
+    appends?: StringAppends;
 };
 type MoveOperation = {
     op: "move";
@@ -155,6 +165,7 @@ type TokenUsage = {
     totalTokens: number | undefined;
     reasoningTokens?: number | undefined;
     cachedInputTokens?: number | undefined;
+    cacheWriteTokens?: number | undefined;
 };
 type DataFinish = {
     totalCost: number;
@@ -222,6 +233,13 @@ type PuckDataParts = {
     "subagent-event": SubagentEvent;
     finish: DataFinish;
     page: Data;
+    "version-notice": {
+        package: string;
+        message: string;
+        currentVersion: string;
+        latestVersion: string;
+        blogUrl: string;
+    };
 };
 type PuckProviderMetadata = {
     tokenUsage?: LanguageModelUsage;
@@ -229,6 +247,7 @@ type PuckProviderMetadata = {
 
 type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
 
+type Mode = "assembly" | "design";
 type RequestOptions = {
     body?: {
         chatId?: string;
@@ -236,6 +255,7 @@ type RequestOptions = {
         messages?: PuckMessage[];
         pageData?: Data;
         config?: Config;
+        mode?: Mode;
         [key: string]: any;
     };
     headers?: HeadersInit;
@@ -255,14 +275,23 @@ type AiPluginProps = {
                 type: "file";
             }>[];
         }) => void | Promise<void>;
+        onFinish?: ChatOnFinishCallback<PuckMessage>;
         examplePrompts?: {
             label: string;
             href?: string;
             onClick?: () => void;
         }[];
+        placeholder?: ReactNode;
+        actions?: ReactNode | ((state: {
+            disabled: boolean;
+        }) => ReactNode);
     };
     scrollTracking?: boolean;
     prepareRequest?: (opts: RequestOptions) => RequestOptions | Promise<RequestOptions>;
+    designMode?: boolean | {
+        visible?: boolean;
+    };
+    defaultMode?: "assembly" | "design";
 };
 declare global {
     interface Window {
@@ -271,10 +300,12 @@ declare global {
             setMessages: (_messages: PuckMessage[]) => void;
             processData: (_messages: DataUIPart<PuckDataParts>) => void;
             setStatus: (_status: ChatStatus) => void;
+            focus: () => void;
         };
     }
 }
 
+declare function withDynamicConfig(config: Config, data: Data): Config;
 declare function createAiPlugin(opts?: AiPluginProps): {
     label: string;
     name: string;
@@ -282,10 +313,13 @@ declare function createAiPlugin(opts?: AiPluginProps): {
     icon: react_jsx_runtime.JSX.Element;
     mobilePanelHeight: "min-content";
     overrides: {
+        drawer: ({ children }: {
+            children: react.ReactNode;
+        }) => react_jsx_runtime.JSX.Element;
         preview: ({ children }: {
             children: react.ReactNode;
         }) => react_jsx_runtime.JSX.Element;
     };
 };
 
-export { type ComponentAiParams, type FieldAiParams, createAiPlugin };
+export { type ComponentAiParams, type FieldAiParams, createAiPlugin, withDynamicConfig };