@puckeditor/plugin-ai 0.9.0-canary.ce36db61 → 0.9.0-canary.d4a0bc62

package/dist/index.d.mts

@@ -115,6 +115,37 @@ type DataToolStatus = {
     status: ToolStatus;
     toolCallId: string;
 };
+type AiFieldTypeShape<Value> = {
+    /** What the field represents, and any rules for using it */
+    description?: string;
+    /**
+     * JSON Schema for the field's value — the shape the model may write, at
+     * creation and in later edits. Without one the model never writes the
+     * field, like `ai.exclude`.
+     */
+    schema?: Record<string, any>;
+    /**
+     * What a field the model designs starts as. When set, the model places the
+     * field and this value fills it; the model authors a value against `schema`
+     * only when this is absent.
+     */
+    defaultValue?: Value;
+};
+/**
+ * A user field type registered by the developer's config. Puck can't infer a
+ * value shape for one, so a type carries `schema`, `defaultValue`, or both.
+ */
+type AiFieldType$1<Value = AiFieldTypeValue> = AiFieldTypeShape<Value> & ({
+    schema: Record<string, any>;
+} | {
+    defaultValue: Value;
+});
+/**
+ * Any JSON-ish value. Spelled out rather than `unknown` so a union with a
+ * function form doesn't collapse, which would drop the callback's parameter
+ * types at the call site.
+ */
+type AiFieldTypeValue = string | number | boolean | null | readonly unknown[] | Record<string, unknown>;
 type AddOperation = {
     op: "add";
     id: string;
@@ -247,6 +278,21 @@ type PuckProviderMetadata = {
 
 type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
 
+type AiFieldTypeContext = {
+    /** The designed component the field belongs to */
+    componentName: string;
+    /** The field's name within that component */
+    fieldName: string;
+};
+/**
+ * A field type the developer's config registers: `schema` is what the model
+ * may write, `defaultValue` is what a designed field starts as — one or both.
+ * In the editor the default may be a function of the component and field
+ * being created.
+ */
+type AiFieldType = AiFieldType$1<AiFieldTypeValue | ((ctx: AiFieldTypeContext) => AiFieldTypeValue)>;
+type AiFieldTypeRegistry = Record<string, AiFieldType>;
+
 type Mode = "assembly" | "design";
 type RequestOptions = {
     body?: {
@@ -263,6 +309,13 @@ type RequestOptions = {
 };
 type AiPluginProps = {
     host?: string;
+    /**
+     * Field types this config registers, keyed by field type. Each gives either
+     * a `schema` the AI writes the value against, or a `defaultValue` every
+     * field of the type starts with. Sent to the server as JSON, so a function
+     * `defaultValue` only resolves in the editor.
+     */
+    fieldTypes?: AiFieldTypeRegistry;
     chat?: {
         attachments?: {
             enabled?: boolean;

package/dist/index.d.ts

@@ -115,6 +115,37 @@ type DataToolStatus = {
     status: ToolStatus;
     toolCallId: string;
 };
+type AiFieldTypeShape<Value> = {
+    /** What the field represents, and any rules for using it */
+    description?: string;
+    /**
+     * JSON Schema for the field's value — the shape the model may write, at
+     * creation and in later edits. Without one the model never writes the
+     * field, like `ai.exclude`.
+     */
+    schema?: Record<string, any>;
+    /**
+     * What a field the model designs starts as. When set, the model places the
+     * field and this value fills it; the model authors a value against `schema`
+     * only when this is absent.
+     */
+    defaultValue?: Value;
+};
+/**
+ * A user field type registered by the developer's config. Puck can't infer a
+ * value shape for one, so a type carries `schema`, `defaultValue`, or both.
+ */
+type AiFieldType$1<Value = AiFieldTypeValue> = AiFieldTypeShape<Value> & ({
+    schema: Record<string, any>;
+} | {
+    defaultValue: Value;
+});
+/**
+ * Any JSON-ish value. Spelled out rather than `unknown` so a union with a
+ * function form doesn't collapse, which would drop the callback's parameter
+ * types at the call site.
+ */
+type AiFieldTypeValue = string | number | boolean | null | readonly unknown[] | Record<string, unknown>;
 type AddOperation = {
     op: "add";
     id: string;
@@ -247,6 +278,21 @@ type PuckProviderMetadata = {
 
 type PuckMessage = UIMessage<PuckProviderMetadata, PuckDataParts>;
 
+type AiFieldTypeContext = {
+    /** The designed component the field belongs to */
+    componentName: string;
+    /** The field's name within that component */
+    fieldName: string;
+};
+/**
+ * A field type the developer's config registers: `schema` is what the model
+ * may write, `defaultValue` is what a designed field starts as — one or both.
+ * In the editor the default may be a function of the component and field
+ * being created.
+ */
+type AiFieldType = AiFieldType$1<AiFieldTypeValue | ((ctx: AiFieldTypeContext) => AiFieldTypeValue)>;
+type AiFieldTypeRegistry = Record<string, AiFieldType>;
+
 type Mode = "assembly" | "design";
 type RequestOptions = {
     body?: {
@@ -263,6 +309,13 @@ type RequestOptions = {
 };
 type AiPluginProps = {
     host?: string;
+    /**
+     * Field types this config registers, keyed by field type. Each gives either
+     * a `schema` the AI writes the value against, or a `defaultValue` every
+     * field of the type starts with. Sent to the server as JSON, so a function
+     * `defaultValue` only resolves in the editor.
+     */
+    fieldTypes?: AiFieldTypeRegistry;
     chat?: {
         attachments?: {
             enabled?: boolean;