@delmaredigital/payload-puck 0.6.12 → 0.6.14

package/dist/plugin/fields/index.js

@@ -29,24 +29,22 @@
  *   ],
  * }
  * ```
- */
-import { createIsHomepageUniqueHook } from '../hooks/isHomepageUnique';
-import { DEFAULT_LAYOUTS } from '../../layouts/defaults';
-import { layoutsToPayloadOptions } from '../../layouts/utils';
+ */ import { createIsHomepageUniqueHook } from '../hooks/isHomepageUnique.js';
+import { DEFAULT_LAYOUTS } from '../../layouts/defaults.js';
+import { layoutsToPayloadOptions } from '../../layouts/utils.js';
 // =============================================================================
 // Core Fields
 // =============================================================================
 /**
  * Puck data field - stores the visual editor JSON data.
  * This field is always hidden in the admin UI as it's managed via the visual editor.
- */
-export const puckDataField = {
+ */ export const puckDataField = {
     name: 'puckData',
     type: 'json',
     admin: {
         hidden: true,
-        description: 'Puck editor data - managed via visual editor',
-    },
+        description: 'Puck editor data - managed via visual editor'
+    }
 };
 /**
  * Creates an editor version field with smart detection for hybrid setups.
@@ -62,27 +60,31 @@ export const puckDataField = {
  * @param defaultValue - The default editor version for NEW pages ('puck' or 'legacy')
  * @param sidebar - Whether to position in the sidebar (default: true)
  * @param legacyBlocksFieldName - Name of the legacy blocks field to check (default: 'layout')
- */
-export function createEditorVersionField(defaultValue = 'puck', sidebar = true, legacyBlocksFieldName = 'layout') {
+ */ export function createEditorVersionField(defaultValue = 'puck', sidebar = true, legacyBlocksFieldName = 'layout') {
     return {
         name: 'editorVersion',
         type: 'select',
         // NO defaultValue here - we use the hook to intelligently detect the value
         // This prevents migrations from blindly setting 'puck' on legacy pages
         options: [
-            { label: 'Legacy (Payload Blocks)', value: 'legacy' },
-            { label: 'Puck Visual Editor', value: 'puck' },
+            {
+                label: 'Legacy (Payload Blocks)',
+                value: 'legacy'
+            },
+            {
+                label: 'Puck Visual Editor',
+                value: 'puck'
+            }
         ],
         admin: {
             position: sidebar ? 'sidebar' : undefined,
-            description: 'Which editor was used to create this page',
+            description: 'Which editor was used to create this page'
         },
         hooks: {
             beforeValidate: [
-                ({ value, data, operation }) => {
+                ({ value, data, operation })=>{
                     // If value is explicitly set (and not null/undefined), keep it
-                    if (value)
-                        return value;
+                    if (value) return value;
                     // Detect based on content - works for both new and existing documents
                     const legacyBlocks = data?.[legacyBlocksFieldName];
                     const hasLegacyBlocks = Array.isArray(legacyBlocks) && legacyBlocks.length > 0;
@@ -99,23 +101,21 @@ export function createEditorVersionField(defaultValue = 'puck', sidebar = true,
                     // For new documents with no content yet, use configured default
                     // For existing documents with no content, also use default
                     return defaultValue;
-                },
-            ],
-        },
+                }
+            ]
+        }
     };
 }
 /**
  * Pre-configured editor version field with 'puck' as default.
  * Use createEditorVersionField() for custom configuration.
- */
-export const editorVersionField = createEditorVersionField('puck', true);
+ */ export const editorVersionField = createEditorVersionField('puck', true);
 /**
  * Creates a page layout field with custom layouts.
  *
  * @param layouts - Array of layout definitions (defaults to DEFAULT_LAYOUTS)
  * @param sidebar - Whether to position in the sidebar (default: true)
- */
-export function createPageLayoutField(layouts = DEFAULT_LAYOUTS, sidebar = true) {
+ */ export function createPageLayoutField(layouts = DEFAULT_LAYOUTS, sidebar = true) {
     return {
         name: 'pageLayout',
         type: 'select',
@@ -124,26 +124,24 @@ export function createPageLayoutField(layouts = DEFAULT_LAYOUTS, sidebar = true)
         options: layoutsToPayloadOptions(layouts),
         admin: {
             position: sidebar ? 'sidebar' : undefined,
-            description: 'Overall page structure and layout style',
-        },
+            description: 'Overall page structure and layout style'
+        }
     };
 }
 /**
  * Pre-configured page layout field with DEFAULT_LAYOUTS.
  * Use createPageLayoutField() for custom layouts.
- */
-export const pageLayoutField = createPageLayoutField();
+ */ export const pageLayoutField = createPageLayoutField();
 /**
  * Homepage flag field - marks a page as the site homepage.
- */
-export const isHomepageField = {
+ */ export const isHomepageField = {
     name: 'isHomepage',
     type: 'checkbox',
     defaultValue: false,
     admin: {
         position: 'sidebar',
-        description: 'Mark this page as the homepage',
-    },
+        description: 'Mark this page as the homepage'
+    }
 };
 // =============================================================================
 // Field Groups
@@ -153,13 +151,12 @@ export const isHomepageField = {
  * Uses the official @payloadcms/plugin-seo convention: meta.title, meta.description
  *
  * Includes: title, description, image, noindex, nofollow, excludeFromSitemap
- */
-export const seoFieldGroup = {
+ */ export const seoFieldGroup = {
     name: 'meta',
     type: 'group',
     label: 'SEO',
     admin: {
-        position: 'sidebar',
+        position: 'sidebar'
     },
     fields: [
         {
@@ -167,16 +164,16 @@ export const seoFieldGroup = {
             type: 'text',
             label: 'Meta Title',
             admin: {
-                description: 'Override the page title for search engines',
-            },
+                description: 'Override the page title for search engines'
+            }
         },
         {
             name: 'description',
             type: 'textarea',
             label: 'Meta Description',
             admin: {
-                description: 'Description shown in search engine results',
-            },
+                description: 'Description shown in search engine results'
+            }
         },
         {
             name: 'image',
@@ -184,8 +181,8 @@ export const seoFieldGroup = {
             relationTo: 'media',
             label: 'Open Graph Image',
             admin: {
-                description: 'Image shown when sharing on social media',
-            },
+                description: 'Image shown when sharing on social media'
+            }
         },
         {
             name: 'noindex',
@@ -193,8 +190,8 @@ export const seoFieldGroup = {
             label: 'No Index',
             defaultValue: false,
             admin: {
-                description: 'Prevent search engines from indexing this page',
-            },
+                description: 'Prevent search engines from indexing this page'
+            }
         },
         {
             name: 'nofollow',
@@ -202,8 +199,8 @@ export const seoFieldGroup = {
             label: 'No Follow',
             defaultValue: false,
             admin: {
-                description: 'Prevent search engines from following links on this page',
-            },
+                description: 'Prevent search engines from following links on this page'
+            }
         },
         {
             name: 'excludeFromSitemap',
@@ -211,22 +208,42 @@ export const seoFieldGroup = {
             label: 'Exclude from Sitemap',
             defaultValue: false,
             admin: {
-                description: 'Exclude this page from the XML sitemap',
-            },
-        },
-    ],
+                description: 'Exclude this page from the XML sitemap'
+            }
+        }
+    ]
 };
 /**
  * Default conversion type options
- */
-export const DEFAULT_CONVERSION_TYPES = [
-    { label: 'Lead', value: 'lead' },
-    { label: 'Registration', value: 'registration' },
-    { label: 'Purchase', value: 'purchase' },
-    { label: 'Donation', value: 'donation' },
-    { label: 'Newsletter Signup', value: 'newsletter' },
-    { label: 'Contact Form', value: 'contact' },
-    { label: 'Custom', value: 'custom' },
+ */ export const DEFAULT_CONVERSION_TYPES = [
+    {
+        label: 'Lead',
+        value: 'lead'
+    },
+    {
+        label: 'Registration',
+        value: 'registration'
+    },
+    {
+        label: 'Purchase',
+        value: 'purchase'
+    },
+    {
+        label: 'Donation',
+        value: 'donation'
+    },
+    {
+        label: 'Newsletter Signup',
+        value: 'newsletter'
+    },
+    {
+        label: 'Contact Form',
+        value: 'contact'
+    },
+    {
+        label: 'Custom',
+        value: 'custom'
+    }
 ];
 /**
  * Creates a conversion tracking field group with custom options.
@@ -250,15 +267,14 @@ export const DEFAULT_CONVERSION_TYPES = [
  *   ],
  * })
  * ```
- */
-export function createConversionFieldGroup(conversionTypes = DEFAULT_CONVERSION_TYPES, sidebar = true) {
+ */ export function createConversionFieldGroup(conversionTypes = DEFAULT_CONVERSION_TYPES, sidebar = true) {
     return {
         name: 'conversionTracking',
         type: 'group',
         label: 'Conversion Tracking',
         admin: {
             position: sidebar ? 'sidebar' : undefined,
-            description: 'Configure conversion tracking for analytics',
+            description: 'Configure conversion tracking for analytics'
         },
         fields: [
             {
@@ -267,8 +283,8 @@ export function createConversionFieldGroup(conversionTypes = DEFAULT_CONVERSION_
                 label: 'Is Conversion Page',
                 defaultValue: false,
                 admin: {
-                    description: 'Check this if this page represents a completed conversion (e.g., thank you page)',
-                },
+                    description: 'Check this if this page represents a completed conversion (e.g., thank you page)'
+                }
             },
             {
                 name: 'conversionType',
@@ -277,8 +293,8 @@ export function createConversionFieldGroup(conversionTypes = DEFAULT_CONVERSION_
                 options: conversionTypes,
                 admin: {
                     description: 'Type of conversion this page represents',
-                    condition: (data, siblingData) => siblingData?.isConversionPage === true,
-                },
+                    condition: (data, siblingData)=>siblingData?.isConversionPage === true
+                }
             },
             {
                 name: 'conversionValue',
@@ -287,17 +303,16 @@ export function createConversionFieldGroup(conversionTypes = DEFAULT_CONVERSION_
                 defaultValue: 0,
                 admin: {
                     description: 'Monetary value of this conversion (0 for non-monetary conversions)',
-                    condition: (data, siblingData) => siblingData?.isConversionPage === true,
-                },
-            },
-        ],
+                    condition: (data, siblingData)=>siblingData?.isConversionPage === true
+                }
+            }
+        ]
     };
 }
 /**
  * Pre-configured conversion tracking field group with default options.
  * Use createConversionFieldGroup() for custom conversion types.
- */
-export const conversionFieldGroup = createConversionFieldGroup();
+ */ export const conversionFieldGroup = createConversionFieldGroup();
 // =============================================================================
 // Main Utility Function
 // =============================================================================
@@ -333,9 +348,8 @@ export const conversionFieldGroup = createConversionFieldGroup();
  *   ],
  * }
  * ```
- */
-export function getPuckFields(options = {}) {
-    const { includeSEO = true, includeConversion = false, includeEditorVersion = true, includePageLayout = true, includeIsHomepage = false, layouts = DEFAULT_LAYOUTS, defaultEditorVersion = 'puck', legacyBlocksFieldName = 'layout', sidebarPosition = true, conversionTypeOptions, } = options;
+ */ export function getPuckFields(options = {}) {
+    const { includeSEO = true, includeConversion = false, includeEditorVersion = true, includePageLayout = true, includeIsHomepage = false, layouts = DEFAULT_LAYOUTS, defaultEditorVersion = 'puck', legacyBlocksFieldName = 'layout', sidebarPosition = true, conversionTypeOptions } = options;
     const fields = [];
     // Core puckData field (always included - this is essential for Puck)
     fields.push(puckDataField);
@@ -397,19 +411,25 @@ export function getPuckFields(options = {}) {
  *   ],
  * }
  * ```
- */
-export function getPuckCollectionConfig(options = {}) {
+ */ export function getPuckCollectionConfig(options = {}) {
     const { includeHomepageHook = true, includeIsHomepage = false, ...fieldOptions } = options;
     // Get the fields using the existing getPuckFields function
-    const fields = getPuckFields({ includeIsHomepage, ...fieldOptions });
+    const fields = getPuckFields({
+        includeIsHomepage,
+        ...fieldOptions
+    });
     // Build hooks object
     const hooks = {};
     // Add isHomepage uniqueness hook if:
     // - includeIsHomepage is true (the field is being added)
     // - includeHomepageHook is not explicitly false
     if (includeIsHomepage && includeHomepageHook !== false) {
-        hooks.beforeChange = [createIsHomepageUniqueHook()];
+        hooks.beforeChange = [
+            createIsHomepageUniqueHook()
+        ];
     }
-    return { fields, hooks };
+    return {
+        fields,
+        hooks
+    };
 }
-//# sourceMappingURL=index.js.map

package/dist/plugin/fields/types.d.ts

@@ -3,7 +3,7 @@
  *
  * These types support the getPuckFields() utility for hybrid collection integration.
  */
-import type { LayoutDefinition } from '../../layouts/types';
+import type { LayoutDefinition } from '../../layouts/types.js';
 /**
  * Conversion type option for the conversion tracking field
  */
@@ -138,4 +138,3 @@ export interface GetPuckCollectionConfigOptions extends GetPuckFieldsOptions {
      */
     includeHomepageHook?: boolean;
 }
-//# sourceMappingURL=types.d.ts.map

package/dist/plugin/fields/types.js

@@ -2,6 +2,28 @@
  * Types for Puck field utilities
  *
  * These types support the getPuckFields() utility for hybrid collection integration.
- */
-export {};
-//# sourceMappingURL=types.js.map
+ */ /**
+ * Options for getPuckCollectionConfig() utility function
+ *
+ * Extends GetPuckFieldsOptions with hook configuration for hybrid collection integration.
+ * Returns both fields AND hooks so you don't have to manually configure the isHomepage hook.
+ *
+ * @example
+ * ```typescript
+ * import { getPuckCollectionConfig } from '@delmaredigital/payload-puck'
+ *
+ * const { fields, hooks } = getPuckCollectionConfig({
+ *   includeIsHomepage: true,
+ *   includeSEO: false,
+ * })
+ *
+ * const Pages: CollectionConfig = {
+ *   slug: 'pages',
+ *   hooks,
+ *   fields: [
+ *     { name: 'title', type: 'text', required: true },
+ *     ...fields,
+ *   ],
+ * }
+ * ```
+ */ export { };

package/dist/plugin/hooks/index.d.ts

@@ -3,5 +3,4 @@
  *
  * Reusable Payload hooks for Puck-enabled collections.
  */
-export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, type IsHomepageUniqueHookOptions, type ExistingHomepageInfo, } from './isHomepageUnique';
-//# sourceMappingURL=index.d.ts.map
+export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, type IsHomepageUniqueHookOptions, type ExistingHomepageInfo, } from './isHomepageUnique.js';

package/dist/plugin/hooks/index.js

@@ -2,6 +2,4 @@
  * Puck Plugin Hooks
  *
  * Reusable Payload hooks for Puck-enabled collections.
- */
-export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, } from './isHomepageUnique';
-//# sourceMappingURL=index.js.map
+ */ export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError } from './isHomepageUnique.js';

package/dist/plugin/hooks/isHomepageUnique.d.ts

@@ -53,4 +53,3 @@ export declare function createIsHomepageUniqueHook(options?: IsHomepageUniqueHoo
  * Used when swapping homepages.
  */
 export declare function unsetHomepage(payload: any, collectionSlug: string, pageId: string): Promise<void>;
-//# sourceMappingURL=isHomepageUnique.d.ts.map

package/dist/plugin/hooks/isHomepageUnique.js

@@ -2,13 +2,13 @@ import { APIError } from 'payload';
 /**
  * Error thrown when attempting to set a second page as homepage.
  * Contains information about the existing homepage for client-side handling.
- */
-export class HomepageConflictError extends APIError {
+ */ export class HomepageConflictError extends APIError {
     existingHomepage;
-    constructor(existingHomepage) {
-        super(`Another page is already set as homepage: "${existingHomepage.title}" (/${existingHomepage.slug})`, 400, 
-        // Pass existingHomepage in the data parameter so it appears in the API response
-        { existingHomepage }, true // isPublic - allows the message to be shown to the client
+    constructor(existingHomepage){
+        super(`Another page is already set as homepage: "${existingHomepage.title}" (/${existingHomepage.slug})`, 400, // Pass existingHomepage in the data parameter so it appears in the API response
+        {
+            existingHomepage
+        }, true // isPublic - allows the message to be shown to the client
         );
         this.name = 'HomepageConflictError';
         this.existingHomepage = existingHomepage;
@@ -34,9 +34,8 @@ export class HomepageConflictError extends APIError {
  *   fields: [...],
  * }
  * ```
- */
-export function createIsHomepageUniqueHook(options = {}) {
-    return async ({ data, originalDoc, req, collection, context }) => {
+ */ export function createIsHomepageUniqueHook(options = {}) {
+    return async ({ data, originalDoc, req, collection, context })=>{
         // Skip if explicitly bypassed (used during homepage swap)
         if (context?.skipIsHomepageHook) {
             return data;
@@ -54,20 +53,30 @@ export function createIsHomepageUniqueHook(options = {}) {
             collection: collectionSlug,
             where: {
                 and: [
-                    { isHomepage: { equals: true } },
+                    {
+                        isHomepage: {
+                            equals: true
+                        }
+                    },
                     // Exclude current document if it has an ID
-                    ...(originalDoc?.id ? [{ id: { not_equals: originalDoc.id } }] : []),
-                ],
+                    ...originalDoc?.id ? [
+                        {
+                            id: {
+                                not_equals: originalDoc.id
+                            }
+                        }
+                    ] : []
+                ]
             },
             limit: 1,
-            depth: 0,
+            depth: 0
         });
         if (existingHomepage.docs.length > 0) {
             const existing = existingHomepage.docs[0];
             throw new HomepageConflictError({
                 id: String(existing.id),
                 title: existing.title || 'Untitled',
-                slug: existing.slug || '',
+                slug: existing.slug || ''
             });
         }
         return data;
@@ -76,18 +85,16 @@ export function createIsHomepageUniqueHook(options = {}) {
 /**
  * Unsets isHomepage on the specified page.
  * Used when swapping homepages.
- */
-export async function unsetHomepage(payload, collectionSlug, pageId) {
+ */ export async function unsetHomepage(payload, collectionSlug, pageId) {
     await payload.update({
         collection: collectionSlug,
         id: pageId,
         data: {
-            isHomepage: false,
+            isHomepage: false
         },
         // Skip hooks to avoid infinite loops
         context: {
-            skipIsHomepageHook: true,
-        },
+            skipIsHomepageHook: true
+        }
     });
 }
-//# sourceMappingURL=isHomepageUnique.js.map

package/dist/plugin/index.d.ts

@@ -1,5 +1,5 @@
 import type { Field, Plugin } from 'payload';
-import type { PuckPluginOptions, PuckAdminConfig } from '../types';
+import type { PuckPluginOptions, PuckAdminConfig } from '../types/index.js';
 /**
  * Generates the UI field configuration for the Edit with Puck button
  */
@@ -38,13 +38,12 @@ declare function generatePuckEditField(collectionSlug: string, adminConfig?: Puc
  * ```
  */
 export declare function createPuckPlugin(options?: PuckPluginOptions): Plugin;
-export { generatePagesCollection } from './collections/Pages';
-export { TemplatesCollection } from '../collections/Templates';
-export { getPuckFields, getPuckCollectionConfig, puckDataField, editorVersionField, createEditorVersionField, pageLayoutField, createPageLayoutField, isHomepageField, seoFieldGroup, conversionFieldGroup, } from './fields';
+export { generatePagesCollection } from './collections/Pages.js';
+export { TemplatesCollection } from '../collections/Templates.js';
+export { getPuckFields, getPuckCollectionConfig, puckDataField, editorVersionField, createEditorVersionField, pageLayoutField, createPageLayoutField, isHomepageField, seoFieldGroup, conversionFieldGroup, } from './fields/index.js';
 export { generatePuckEditField };
 export { PUCK_STYLES_ENDPOINT } from '../endpoints/styles.js';
-export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, } from './hooks';
-export type { IsHomepageUniqueHookOptions } from './hooks';
-export type { PuckPluginOptions, PuckAdminConfig } from '../types';
-export type { GetPuckFieldsOptions, GetPuckCollectionConfigOptions } from './fields/types';
-//# sourceMappingURL=index.d.ts.map
+export { createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, } from './hooks/index.js';
+export type { IsHomepageUniqueHookOptions } from './hooks/index.js';
+export type { PuckPluginOptions, PuckAdminConfig } from '../types/index.js';
+export type { GetPuckFieldsOptions, GetPuckCollectionConfigOptions } from './fields/types.js';