@delmaredigital/payload-puck 0.4.0 → 0.6.0

package/dist/ai/types.d.ts

@@ -0,0 +1,507 @@
+import type { NextRequest } from 'next/server';
+import type { Config as PuckConfig, Data as PuckData } from '@puckeditor/core';
+import type { SanitizedConfig } from 'payload';
+import type { PuckApiAuthHooks, AuthenticatedUser } from '../api/types.js';
+/**
+ * Tool definition for AI agent
+ *
+ * Tools enable the AI to query your system for information,
+ * executing functions directly on your server.
+ *
+ * @example
+ * ```typescript
+ * import { z } from 'zod'
+ *
+ * const getProducts: AiTool = {
+ *   description: 'Get a list of products',
+ *   inputSchema: z.object({
+ *     category: z.enum(['consumer', 'business']),
+ *   }),
+ *   execute: async ({ category }) => {
+ *     return await payload.find({ collection: 'products', where: { category } })
+ *   },
+ * }
+ * ```
+ */
+/**
+ * Context passed to tool execution
+ * Contains the Payload instance for database operations
+ */
+export interface AiToolContext {
+    /**
+     * Payload CMS instance for database operations
+     */
+    payload: import('payload').Payload;
+    /**
+     * The authenticated user making the request
+     */
+    user?: import('payload').User;
+}
+export interface AiTool<TInput = unknown, TOutput = unknown> {
+    /**
+     * A description that the agent will use to understand how to use this tool
+     */
+    description: string;
+    /**
+     * The shape of the parameters provided to the execute function.
+     * Must be a Zod object schema.
+     */
+    inputSchema: import('zod').ZodObject<any>;
+    /**
+     * The execution function for the tool.
+     * Will receive parameters provided by the agent that match the inputSchema.
+     * The second parameter is optional execution context containing the Payload instance
+     * (available when using createPuckPlugin with auto-registered endpoints).
+     */
+    execute: (params: TInput, context?: AiToolContext) => Promise<TOutput> | TOutput;
+    /**
+     * Optional name for the tool
+     */
+    name?: string;
+}
+/**
+ * AI-specific configuration options for the server-side handler
+ */
+export interface AiOptions {
+    /**
+     * System context and instructions for the AI agent.
+     * Guides the AI's behavior and output.
+     *
+     * @example
+     * ```typescript
+     * context: `## Overview
+     * We are Google. You help us build Google landing pages.
+     *
+     * ## Brand Guidelines
+     * Our brand colors are:
+     * - #4285F4 (primary)
+     * - #DB4437
+     *
+     * ## Tone of Voice
+     * - American English
+     * - Professional but friendly`
+     * ```
+     */
+    context?: string;
+    /**
+     * Custom tools that enable the AI to execute server-side functions.
+     * Tools allow the agent to query your database, fetch external data, etc.
+     */
+    tools?: Record<string, AiTool>;
+    /**
+     * Custom Puck Cloud API key.
+     * Defaults to PUCK_API_KEY environment variable.
+     */
+    apiKey?: string;
+    /**
+     * Custom Puck Cloud host URL
+     */
+    host?: string;
+}
+/**
+ * AI configuration for a Puck field
+ *
+ * Add to any field's configuration to control how the AI generates content for it.
+ *
+ * @example
+ * ```typescript
+ * fields: {
+ *   title: {
+ *     type: 'text',
+ *     ai: {
+ *       instructions: 'Always use sentence case',
+ *       required: true,
+ *     },
+ *   },
+ * }
+ * ```
+ */
+export interface AiFieldConfig {
+    /**
+     * Instructions for the AI when generating this field's value
+     */
+    instructions?: string;
+    /**
+     * Whether this field is required for AI generation
+     * (even if not present in defaultProps)
+     */
+    required?: boolean;
+    /**
+     * Exclude this field from AI generation.
+     * Useful for fields like media library references that AI can't populate.
+     */
+    exclude?: boolean;
+    /**
+     * Custom JSON schema for the field.
+     * Required for 'custom', 'external', or user-defined fields
+     * where Puck AI cannot automatically infer the schema.
+     */
+    schema?: {
+        type: string;
+        [key: string]: unknown;
+    };
+}
+/**
+ * AI configuration for a Puck component
+ *
+ * @example
+ * ```typescript
+ * const HeadingConfig = {
+ *   ai: {
+ *     instructions: 'Always place this at the top of sections',
+ *   },
+ *   fields: { ... },
+ *   render: ({ title }) => <h1>{title}</h1>,
+ * }
+ * ```
+ */
+export interface AiComponentConfig {
+    /**
+     * Instructions for the AI when using this component
+     */
+    instructions?: string;
+    /**
+     * Custom JSON schema for the entire component.
+     * For when Puck can't infer from fields.
+     */
+    schema?: {
+        type: 'object';
+        parameters: Record<string, {
+            type: string;
+            [key: string]: unknown;
+        }>;
+        required?: string[];
+    };
+}
+/**
+ * Configuration for Puck AI API routes
+ *
+ * @example
+ * ```typescript
+ * // app/api/puck/[...all]/route.ts
+ * import { createPuckAiApiRoutes } from '@delmaredigital/payload-puck/ai'
+ *
+ * export const POST = createPuckAiApiRoutes({
+ *   payloadConfig: config,
+ *   auth: {
+ *     authenticate: async (request) => {
+ *       // Your auth implementation
+ *     },
+ *   },
+ *   ai: {
+ *     context: 'We are Acme Corp. You build our landing pages.',
+ *   },
+ * })
+ * ```
+ */
+export interface PuckAiRoutesConfig {
+    /**
+     * Payload configuration - import from @payload-config
+     */
+    payloadConfig: Promise<SanitizedConfig>;
+    /**
+     * Authentication hooks (reuses existing pattern from API routes)
+     */
+    auth: PuckApiAuthHooks;
+    /**
+     * AI-specific options
+     */
+    ai?: AiOptions;
+    /**
+     * Custom error handler for logging/monitoring
+     */
+    onError?: (error: unknown, context: {
+        operation: string;
+        request: NextRequest;
+    }) => void;
+}
+/**
+ * Route handlers returned by createPuckAiApiRoutes
+ */
+export interface PuckAiRouteHandlers {
+    POST: (request: NextRequest) => Promise<Response>;
+}
+/**
+ * Configuration for headless AI page generation
+ *
+ * @example
+ * ```typescript
+ * const generatePage = createAiGenerate({
+ *   payloadConfig: config,
+ *   auth: { authenticate: async (req) => ... },
+ *   ai: { context: 'We are Acme Corp...' },
+ * })
+ *
+ * const pageData = await generatePage({
+ *   prompt: 'Create a landing page for our new product',
+ *   puckConfig: editorConfig,
+ * })
+ * ```
+ */
+export interface AiGenerateConfig {
+    /**
+     * Payload configuration - import from @payload-config
+     */
+    payloadConfig: Promise<SanitizedConfig>;
+    /**
+     * Authentication hooks
+     */
+    auth: PuckApiAuthHooks;
+    /**
+     * AI-specific options
+     */
+    ai?: AiOptions;
+}
+/**
+ * Options for a single generation request
+ */
+export interface AiGenerateOptions {
+    /**
+     * Natural language prompt for generation
+     */
+    prompt: string;
+    /**
+     * The Puck configuration with component definitions
+     */
+    puckConfig: PuckConfig;
+    /**
+     * Optional authenticated user for the generation
+     */
+    user?: AuthenticatedUser;
+    /**
+     * Existing Puck data to consider when actioning the prompt.
+     * Use this to update an existing page rather than create from scratch.
+     */
+    pageData?: PuckData;
+}
+/**
+ * Function returned by createAiGenerate
+ */
+export type AiGenerateFunction = (options: AiGenerateOptions) => Promise<PuckData>;
+/**
+ * Example prompt for the AI chat interface
+ */
+export interface AiExamplePrompt {
+    /**
+     * Display label for the prompt
+     */
+    label: string;
+    /**
+     * The actual prompt text
+     */
+    prompt: string;
+}
+/**
+ * Configuration options for the AI plugin
+ *
+ * @example
+ * ```typescript
+ * const aiPlugin = createAiPlugin({
+ *   host: '/api/puck',
+ *   examplePrompts: [
+ *     { label: 'Landing page', prompt: 'Create a landing page about dogs' },
+ *   ],
+ * })
+ * ```
+ */
+export interface AiPluginOptions {
+    /**
+     * API host for AI requests.
+     * @default '/api/puck'
+     */
+    host?: string;
+    /**
+     * Example prompts to show in the chat interface.
+     * Users can click these to quickly send common prompts.
+     */
+    examplePrompts?: AiExamplePrompt[];
+    /**
+     * Callback when user submits a prompt
+     */
+    onSubmit?: (prompt: string) => void;
+}
+/**
+ * AI configuration overrides for components
+ *
+ * Used with injectAiConfig to add AI metadata to existing component configs.
+ *
+ * @example
+ * ```typescript
+ * const overrides: ComponentAiOverrides = {
+ *   Heading: {
+ *     ai: {
+ *       instructions: 'Use for section titles',
+ *     },
+ *     fields: {
+ *       text: {
+ *         ai: { required: true },
+ *       },
+ *     },
+ *   },
+ * }
+ * ```
+ */
+export interface ComponentAiOverrides {
+    [componentName: string]: {
+        ai?: AiComponentConfig;
+        fields?: {
+            [fieldName: string]: {
+                ai?: AiFieldConfig;
+            };
+        };
+    };
+}
+/**
+ * A stored AI prompt from the database
+ */
+export interface AiPrompt {
+    id: string;
+    label: string;
+    prompt: string;
+    category?: string;
+    order?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * A stored AI context entry from the database
+ */
+export interface AiContext {
+    id: string;
+    name: string;
+    content: string;
+    category?: 'brand' | 'tone' | 'product' | 'industry' | 'technical' | 'patterns' | 'other';
+    enabled: boolean;
+    order?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Configuration for the prompt editor plugin
+ */
+export interface PromptEditorPluginOptions {
+    /**
+     * API endpoint for prompt CRUD operations
+     * @default '/api/puck/ai-prompts'
+     */
+    apiEndpoint?: string;
+    /**
+     * Whether users can edit prompts in the panel
+     * @default true
+     */
+    canEdit?: boolean;
+    /**
+     * Whether to show the create button
+     * @default true
+     */
+    canCreate?: boolean;
+    /**
+     * Whether to show delete buttons
+     * @default true
+     */
+    canDelete?: boolean;
+}
+/**
+ * Configuration for the context editor plugin
+ */
+export interface ContextEditorPluginOptions {
+    /**
+     * API endpoint for context CRUD operations
+     * @default '/api/puck/ai-context'
+     */
+    apiEndpoint?: string;
+    /**
+     * Whether users can edit context in the panel
+     * @default true
+     */
+    canEdit?: boolean;
+    /**
+     * Whether to show the create button
+     * @default true
+     */
+    canCreate?: boolean;
+    /**
+     * Whether to show delete buttons
+     * @default true
+     */
+    canDelete?: boolean;
+}
+/**
+ * AI configuration for createPuckPlugin
+ */
+export interface PuckPluginAiConfig {
+    /**
+     * Enable AI features
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * System context for the AI agent
+     */
+    context?: string;
+    /**
+     * Custom tools that enable the AI to execute server-side functions.
+     * Tools allow the agent to query your database, fetch external data, etc.
+     *
+     * @example
+     * ```typescript
+     * import { z } from 'zod'
+     *
+     * createPuckPlugin({
+     *   ai: {
+     *     enabled: true,
+     *     tools: {
+     *       getProducts: {
+     *         description: 'Get products from the database',
+     *         inputSchema: z.object({ category: z.string() }),
+     *         execute: async ({ category }) => {
+     *           return await payload.find({ collection: 'products', where: { category } })
+     *         },
+     *       },
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    tools?: Record<string, AiTool>;
+    /**
+     * Example prompts for the chat interface
+     */
+    examplePrompts?: AiExamplePrompt[];
+    /**
+     * Auto-create puck-ai-prompts collection for storing prompts
+     * @default false
+     */
+    promptsCollection?: boolean;
+    /**
+     * Auto-create puck-ai-context collection for dynamic business context.
+     * When enabled, context entries can be managed via Payload admin and
+     * the Context Editor panel in the Puck editor.
+     * @default false
+     */
+    contextCollection?: boolean;
+    /**
+     * Custom component AI instructions to override or extend defaults.
+     * When AI is enabled, built-in component instructions are auto-applied.
+     * Use this to customize instructions for your brand/use case.
+     *
+     * @example
+     * ```typescript
+     * createPuckPlugin({
+     *   ai: {
+     *     enabled: true,
+     *     componentInstructions: {
+     *       Heading: {
+     *         ai: { instructions: 'Use our brand voice: professional but approachable' },
+     *         fields: {
+     *           text: { ai: { instructions: 'Keep under 8 words' } },
+     *         },
+     *       },
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    componentInstructions?: ComponentAiOverrides;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/ai/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/ai/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAM1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,OAAO,SAAS,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,SAAS,EAAE,IAAI,CAAA;CAC9B;AAED,MAAM,WAAW,MAAM,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO;IACzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,WAAW,EAAE,OAAO,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACzC;;;;;OAKG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IAChF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAMD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACvB,CAAA;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,QAAQ,CAAA;QACd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC,CAAA;QACpE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;CACF;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IACvC;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAA;CACzF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAClD;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IACvC;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,SAAS,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,UAAU,EAAE,UAAU,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AAMlF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,cAAc,CAAC,EAAE,eAAe,EAAE,CAAA;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;CACpC;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,aAAa,EAAE,MAAM,GAAG;QACvB,EAAE,CAAC,EAAE,iBAAiB,CAAA;QACtB,MAAM,CAAC,EAAE;YACP,CAAC,SAAS,EAAE,MAAM,GAAG;gBACnB,EAAE,CAAC,EAAE,aAAa,CAAA;aACnB,CAAA;SACF,CAAA;KACF,CAAA;CACF;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,OAAO,CAAA;IACzF,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,EAAE,CAAA;IAClC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,CAAC,EAAE,oBAAoB,CAAA;CAC7C"}

package/dist/ai/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/ai/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/ai/types.ts"],"names":[],"mappings":""}

package/dist/ai/utils/injectAiConfig.d.ts

@@ -0,0 +1,67 @@
+import type { Config as PuckConfig } from '@puckeditor/core';
+import type { ComponentAiOverrides } from '../types.js';
+/**
+ * Injects AI configuration into an existing Puck config
+ *
+ * This function:
+ * 1. Applies component-level and field-level AI overrides from the provided config
+ * 2. **Automatically excludes ALL `type: 'custom'` fields** from AI generation
+ *    (custom fields are UI-only interactive fields that AI cannot generate values for)
+ *
+ * @example Basic usage
+ * ```typescript
+ * import { editorConfig } from '@delmaredigital/payload-puck/config/editor'
+ * import { injectAiConfig, defaultComponentAiConfig } from '@delmaredigital/payload-puck/ai'
+ *
+ * // Use default AI configs for built-in components
+ * const aiEnabledConfig = injectAiConfig(editorConfig, defaultComponentAiConfig)
+ * ```
+ *
+ * @example With custom overrides
+ * ```typescript
+ * const aiEnabledConfig = injectAiConfig(editorConfig, {
+ *   ...defaultComponentAiConfig,
+ *   // Override a built-in component
+ *   Heading: {
+ *     ai: {
+ *       instructions: 'Use our brand voice: professional but approachable',
+ *     },
+ *     fields: {
+ *       text: {
+ *         ai: {
+ *           instructions: 'Keep headings concise (under 10 words)',
+ *           required: true,
+ *         },
+ *       },
+ *     },
+ *   },
+ *   // Add config for a custom component
+ *   HeroSection: {
+ *     ai: {
+ *       instructions: 'Always place at the top of the page',
+ *     },
+ *     fields: {
+ *       headline: {
+ *         ai: {
+ *           instructions: 'Use power words, keep under 8 words',
+ *           required: true,
+ *         },
+ *       },
+ *     },
+ *   },
+ * })
+ * ```
+ *
+ * @param config - The base Puck configuration to enhance
+ * @param overrides - AI configuration overrides for each component
+ * @returns A new Puck config with AI metadata injected
+ */
+export declare function injectAiConfig(config: PuckConfig, overrides: ComponentAiOverrides): PuckConfig;
+/**
+ * Checks if a config already has AI configuration
+ *
+ * @param config - The Puck configuration to check
+ * @returns True if any component has AI configuration
+ */
+export declare function hasAiConfig(config: PuckConfig): boolean;
+//# sourceMappingURL=injectAiConfig.d.ts.map

package/dist/ai/utils/injectAiConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"injectAiConfig.d.ts","sourceRoot":"","sources":["../../../src/ai/utils/injectAiConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAuBvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,UAAU,EAClB,SAAS,EAAE,oBAAoB,GAC9B,UAAU,CAuJZ;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAgBvD"}