@delmaredigital/payload-puck 0.3.1 → 0.6.0

package/dist/ai/tools/index.js

@@ -0,0 +1,214 @@
+/**
+ * Pre-built AI tools for Payload CMS integration
+ *
+ * These tools allow the AI to query your Payload database during page generation,
+ * enabling it to use real content instead of placeholder text.
+ *
+ * @example
+ * ```typescript
+ * import { createPayloadTools } from '@delmaredigital/payload-puck/ai'
+ *
+ * createPuckPlugin({
+ *   ai: {
+ *     enabled: true,
+ *     tools: createPayloadTools({
+ *       collections: ['products', 'team-members', 'testimonials'],
+ *       media: true,
+ *       pages: 'pages',
+ *     }),
+ *   },
+ * })
+ * ```
+ */
+import { z } from 'zod';
+/**
+ * Creates a set of AI tools for querying Payload CMS
+ *
+ * IMPORTANT: These tools need the `payload` instance at runtime.
+ * The plugin automatically injects `payload` into the tool execution context.
+ *
+ * @example
+ * ```typescript
+ * import { createPayloadTools } from '@delmaredigital/payload-puck/ai'
+ *
+ * createPuckPlugin({
+ *   ai: {
+ *     enabled: true,
+ *     context: 'You are building pages for Acme Corp...',
+ *     tools: createPayloadTools({
+ *       collections: {
+ *         products: 'Products with name, price, description, and image',
+ *         testimonials: 'Customer testimonials with quote, author, and company',
+ *       },
+ *       media: true,
+ *       pages: 'pages',
+ *       globals: ['site-settings'],
+ *     }),
+ *   },
+ * })
+ * ```
+ */
+export function createPayloadTools(config) {
+    const tools = {};
+    // Collection query tools
+    if (config.collections) {
+        const collections = Array.isArray(config.collections)
+            ? Object.fromEntries(config.collections.map((c) => [c, `Items from the ${c} collection`]))
+            : config.collections;
+        for (const [slug, description] of Object.entries(collections)) {
+            const toolName = `get${slug.charAt(0).toUpperCase()}${slug.slice(1).replace(/-([a-z])/g, (_, c) => c.toUpperCase())}`;
+            tools[toolName] = {
+                description: `Query ${slug} collection. ${description}`,
+                inputSchema: z.object({
+                    limit: z.number().optional().describe('Maximum number of items to return (default: 10)'),
+                    where: z
+                        .record(z.string(), z.unknown())
+                        .optional()
+                        .describe('Payload where query for filtering results'),
+                    search: z.string().optional().describe('Search term to filter by title/name fields'),
+                }),
+                execute: async (input, context) => {
+                    if (!context?.payload) {
+                        throw new Error('Payload instance not available in tool context');
+                    }
+                    const { payload } = context;
+                    const query = {
+                        collection: slug,
+                        limit: input.limit || 10,
+                    };
+                    if (input.where) {
+                        query.where = input.where;
+                    }
+                    // If search is provided, try common text fields
+                    if (input.search) {
+                        query.where = {
+                            or: [
+                                { title: { contains: input.search } },
+                                { name: { contains: input.search } },
+                                { label: { contains: input.search } },
+                            ],
+                        };
+                    }
+                    const result = await payload.find(query);
+                    return result.docs;
+                },
+            };
+        }
+    }
+    // Media library tool
+    if (config.media) {
+        const mediaCollection = typeof config.media === 'string' ? config.media : 'media';
+        tools.getMedia = {
+            description: 'Search the media library for images. Returns URLs and metadata for matching images.',
+            inputSchema: z.object({
+                search: z.string().optional().describe('Search by filename or alt text'),
+                mimeType: z.string().optional().describe('Filter by MIME type (e.g., "image/jpeg")'),
+                limit: z.number().optional().describe('Maximum number of results (default: 10)'),
+            }),
+            execute: async (input, context) => {
+                if (!context?.payload) {
+                    throw new Error('Payload instance not available in tool context');
+                }
+                const { payload } = context;
+                const query = {
+                    collection: mediaCollection,
+                    limit: input.limit || 10,
+                };
+                const conditions = [];
+                if (input.search) {
+                    conditions.push({ filename: { contains: input.search } }, { alt: { contains: input.search } });
+                }
+                if (input.mimeType) {
+                    conditions.push({ mimeType: { equals: input.mimeType } });
+                }
+                if (conditions.length > 0) {
+                    query.where = input.search ? { or: conditions } : { and: conditions };
+                }
+                const result = await payload.find(query);
+                return result.docs.map((doc) => ({
+                    id: doc.id,
+                    url: doc.url,
+                    filename: doc.filename,
+                    alt: doc.alt,
+                    width: doc.width,
+                    height: doc.height,
+                    mimeType: doc.mimeType,
+                }));
+            },
+        };
+    }
+    // Pages tool for internal linking
+    if (config.pages) {
+        tools.getPages = {
+            description: 'Look up existing pages for internal linking. Returns page titles, slugs, and URLs.',
+            inputSchema: z.object({
+                search: z.string().optional().describe('Search by page title'),
+                limit: z.number().optional().describe('Maximum number of results (default: 10)'),
+            }),
+            execute: async (input, context) => {
+                if (!context?.payload) {
+                    throw new Error('Payload instance not available in tool context');
+                }
+                const { payload } = context;
+                const query = {
+                    collection: config.pages,
+                    limit: input.limit || 10,
+                };
+                if (input.search) {
+                    query.where = {
+                        or: [{ title: { contains: input.search } }, { slug: { contains: input.search } }],
+                    };
+                }
+                const result = await payload.find(query);
+                return result.docs.map((doc) => ({
+                    id: doc.id,
+                    title: doc.title,
+                    slug: doc.slug,
+                    url: `/${doc.slug}`,
+                }));
+            },
+        };
+    }
+    // Globals tools
+    if (config.globals && config.globals.length > 0) {
+        for (const globalSlug of config.globals) {
+            const toolName = `get${globalSlug.charAt(0).toUpperCase()}${globalSlug.slice(1).replace(/-([a-z])/g, (_, c) => c.toUpperCase())}`;
+            tools[toolName] = {
+                description: `Get ${globalSlug} global data (site-wide settings/configuration)`,
+                inputSchema: z.object({}),
+                execute: async (_input, context) => {
+                    if (!context?.payload) {
+                        throw new Error('Payload instance not available in tool context');
+                    }
+                    const { payload } = context;
+                    return await payload.findGlobal({ slug: globalSlug });
+                },
+            };
+        }
+    }
+    return tools;
+}
+/**
+ * Create a custom AI tool with proper typing
+ *
+ * @example
+ * ```typescript
+ * import { createTool } from '@delmaredigital/payload-puck/ai'
+ * import { z } from 'zod'
+ *
+ * const getWeather = createTool({
+ *   description: 'Get current weather for a location',
+ *   inputSchema: z.object({
+ *     city: z.string().describe('City name'),
+ *   }),
+ *   execute: async ({ city }, context) => {
+ *     const response = await fetch(`https://api.weather.com/...`)
+ *     return response.json()
+ *   },
+ * })
+ * ```
+ */
+export function createTool(tool) {
+    return tool;
+}
+//# sourceMappingURL=index.js.map

package/dist/ai/tools/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ai/tools/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAoEvB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAA0B;IAC3D,MAAM,KAAK,GAAqC,EAAE,CAAA;IAElD,yBAAyB;IACzB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;YACnD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,CAAC,CAAC,MAAM,CAAC,WAAW,CAAA;QAEtB,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAA;YAErH,KAAK,CAAC,QAAQ,CAAC,GAAG;gBAChB,WAAW,EAAE,SAAS,IAAI,gBAAgB,WAAW,EAAE;gBACvD,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;oBACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;oBACxF,KAAK,EAAE,CAAC;yBACL,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;yBAC/B,QAAQ,EAAE;yBACV,QAAQ,CAAC,2CAA2C,CAAC;oBACxD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;iBACrF,CAAC;gBACF,OAAO,EAAE,KAAK,EAAE,KAA2B,EAAE,OAAuB,EAAE,EAAE;oBACtE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;wBACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;oBACnE,CAAC;oBACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;oBAE3B,MAAM,KAAK,GAIP;wBACF,UAAU,EAAE,IAAI;wBAChB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;qBACzB,CAAA;oBAED,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;wBAChB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;oBAC3B,CAAC;oBAED,gDAAgD;oBAChD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;wBACjB,KAAK,CAAC,KAAK,GAAG;4BACZ,EAAE,EAAE;gCACF,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE;gCACrC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE;gCACpC,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE;6BACtC;yBACF,CAAA;oBACH,CAAC;oBAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,KAAY,CAAC,CAAA;oBAC/C,OAAO,MAAM,CAAC,IAAI,CAAA;gBACpB,CAAC;aACF,CAAA;QACH,CAAC;IACH,CAAC;IAED,qBAAqB;IACrB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,eAAe,GAAG,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAA;QAEjF,KAAK,CAAC,QAAQ,GAAG;YACf,WAAW,EACT,qFAAqF;YACvF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;gBACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;gBACxE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0CAA0C,CAAC;gBACpF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;aACjF,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,KAAsB,EAAE,OAAuB,EAAE,EAAE;gBACjE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;oBACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;gBACnE,CAAC;gBACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;gBAE3B,MAAM,KAAK,GAIP;oBACF,UAAU,EAAE,eAAe;oBAC3B,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;iBACzB,CAAA;gBAED,MAAM,UAAU,GAA8B,EAAE,CAAA;gBAEhD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,UAAU,CAAC,IAAI,CACb,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,EACxC,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CACpC,CAAA;gBACH,CAAC;gBAED,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACnB,UAAU,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;gBAC3D,CAAC;gBAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAA;gBACvE,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,KAAY,CAAC,CAAA;gBAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC;oBACpC,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,GAAG,EAAE,GAAG,CAAC,GAAG;oBACZ,QAAQ,EAAE,GAAG,CAAC,QAAQ;oBACtB,GAAG,EAAE,GAAG,CAAC,GAAG;oBACZ,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC,CAAC,CAAA;YACL,CAAC;SACF,CAAA;IACH,CAAC;IAED,kCAAkC;IAClC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,KAAK,CAAC,QAAQ,GAAG;YACf,WAAW,EACT,oFAAoF;YACtF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;gBACpB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;gBAC9D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;aACjF,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,KAAsB,EAAE,OAAuB,EAAE,EAAE;gBACjE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;oBACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;gBACnE,CAAC;gBACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;gBAE3B,MAAM,KAAK,GAIP;oBACF,UAAU,EAAE,MAAM,CAAC,KAAM;oBACzB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;iBACzB,CAAA;gBAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,KAAK,CAAC,KAAK,GAAG;wBACZ,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;qBAClF,CAAA;gBACH,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,KAAY,CAAC,CAAA;gBAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC;oBACpC,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,GAAG,EAAE,IAAI,GAAG,CAAC,IAAI,EAAE;iBACpB,CAAC,CAAC,CAAA;YACL,CAAC;SACF,CAAA;IACH,CAAC;IAED,gBAAgB;IAChB,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAA;YAEjI,KAAK,CAAC,QAAQ,CAAC,GAAG;gBAChB,WAAW,EAAE,OAAO,UAAU,iDAAiD;gBAC/E,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzB,OAAO,EAAE,KAAK,EAAE,MAA6B,EAAE,OAAuB,EAAE,EAAE;oBACxE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;wBACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;oBACnE,CAAC;oBACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;oBAE3B,OAAO,MAAM,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;gBACvD,CAAC;aACF,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,UAAU,CAAkB,IAA6B;IACvE,OAAO,IAAI,CAAA;AACb,CAAC"}