@delmaredigital/payload-puck 0.1.0

package/dist/index-CQu6SzDg.d.mts

@@ -0,0 +1,327 @@
+import { CollectionConfig, Access, Field } from 'payload';
+import { Data, Config } from '@measured/puck';
+import { L as LayoutDefinition } from './types-D7D3rZ1J.mjs';
+
+/**
+ * Theme Type Definitions
+ *
+ * Defines all theme-related TypeScript interfaces for the payload-puck plugin.
+ * These types enable consuming applications to customize button variants,
+ * color presets, and other visual styles.
+ */
+/**
+ * Configuration for a single button variant
+ */
+interface ButtonVariantConfig {
+    /** Tailwind classes for the variant */
+    classes: string;
+    /** Optional CSS variable reference for dynamic theming */
+    cssVariable?: string;
+}
+/**
+ * Map of button variant names to their configurations
+ */
+interface ButtonVariantStyles {
+    default?: ButtonVariantConfig;
+    primary?: ButtonVariantConfig;
+    secondary?: ButtonVariantConfig;
+    outline?: ButtonVariantConfig;
+    ghost?: ButtonVariantConfig;
+    destructive?: ButtonVariantConfig;
+    link?: ButtonVariantConfig;
+    [key: string]: ButtonVariantConfig | undefined;
+}
+/**
+ * Color preset for the color picker
+ */
+interface ColorPreset {
+    /** Hex color value (e.g., '#3b82f6') */
+    hex: string;
+    /** Display label for the preset */
+    label: string;
+    /** Optional CSS variable reference (e.g., 'var(--color-primary)') */
+    cssVariable?: string;
+}
+/**
+ * Background style configurations for CTA components
+ */
+interface BackgroundStyles {
+    default?: string;
+    dark?: string;
+    light?: string;
+    [key: string]: string | undefined;
+}
+/**
+ * Theme configuration provided by consuming applications
+ * All properties are optional and will be merged with defaults
+ */
+interface ThemeConfig {
+    /**
+     * Button variant styles
+     * Merged with default button variants
+     */
+    buttonVariants?: Partial<ButtonVariantStyles>;
+    /**
+     * CTA button variant styles
+     * Merged with default CTA button variants
+     */
+    ctaButtonVariants?: Partial<ButtonVariantStyles>;
+    /**
+     * CTA background styles
+     * Merged with default background styles
+     */
+    ctaBackgroundStyles?: Partial<BackgroundStyles>;
+    /**
+     * Color picker preset colors
+     * If provided, replaces defaults unless extendColorPresets is true
+     */
+    colorPresets?: ColorPreset[];
+    /**
+     * Whether to extend default color presets (true) or replace them (false)
+     * @default false
+     */
+    extendColorPresets?: boolean;
+    /**
+     * Focus ring color class (e.g., 'focus:ring-primary')
+     * @default 'focus:ring-blue-500'
+     */
+    focusRingColor?: string;
+}
+
+/**
+ * Admin UI configuration for the Puck plugin
+ */
+interface PuckAdminConfig {
+    /**
+     * Whether to add the visual editor button to the collection
+     * @default true
+     */
+    addEditButton?: boolean;
+    /**
+     * URL pattern for the Puck editor page (outside of Payload admin)
+     * Use {id} as placeholder for document ID
+     * @default '/pages/{id}/edit'
+     */
+    editorPathPattern?: string;
+    /**
+     * Button label text
+     * @default 'Edit with Puck'
+     */
+    buttonLabel?: string;
+    /**
+     * Position of the edit button in admin sidebar
+     * @default 'sidebar'
+     */
+    buttonPosition?: 'sidebar' | 'main';
+}
+/**
+ * Configuration options for the Puck plugin
+ */
+interface PuckPluginOptions {
+    /**
+     * Collection slug for pages
+     * @default 'pages'
+     */
+    pagesCollection?: string;
+    /**
+     * Whether to auto-generate the Pages collection
+     * Set to false if you want to define your own collection
+     * @default true
+     */
+    autoGenerateCollection?: boolean;
+    /**
+     * Custom collection config to merge with defaults
+     */
+    collectionOverrides?: Partial<CollectionConfig>;
+    /**
+     * Access control for Puck operations
+     * Uses Payload's Access type for full compatibility
+     */
+    access?: {
+        read?: Access;
+        create?: Access;
+        update?: Access;
+        delete?: Access;
+    };
+    /**
+     * Page layout configuration
+     * Define custom layouts that affect how page content is rendered
+     * @default DEFAULT_LAYOUTS
+     */
+    layouts?: LayoutDefinition[];
+    /**
+     * Additional fields to add to the Pages collection
+     */
+    additionalFields?: Field[];
+    /**
+     * Admin UI configuration
+     * Configure how the visual editor integrates with Payload admin
+     */
+    admin?: PuckAdminConfig;
+    /**
+     * Theme configuration for customizing button styles, colors, and presets
+     * All values are optional and will fall back to defaults
+     */
+    theme?: ThemeConfig;
+}
+/**
+ * Root properties for a Puck page
+ */
+interface PuckRootProps {
+    title?: string;
+    pageLayout?: string;
+    [key: string]: unknown;
+}
+/**
+ * Complete Puck page data structure
+ */
+interface PuckPageData extends Data {
+    root: {
+        props: PuckRootProps;
+    };
+}
+/**
+ * SEO/Meta configuration for a page.
+ * Uses the official @payloadcms/plugin-seo convention.
+ */
+interface PageMeta {
+    title?: string;
+    description?: string;
+    image?: string | {
+        id: string;
+        url: string;
+        alt?: string;
+    };
+    noindex?: boolean;
+    nofollow?: boolean;
+    excludeFromSitemap?: boolean;
+}
+/**
+ * @deprecated Use PageMeta instead. This alias is kept for backwards compatibility.
+ */
+type PageSEO = PageMeta;
+/**
+ * Conversion type options
+ */
+type ConversionType = 'lead' | 'registration' | 'purchase' | 'donation' | 'newsletter' | 'contact' | 'custom';
+/**
+ * Conversion tracking configuration for a page
+ */
+interface PageConversionTracking {
+    isConversionPage?: boolean;
+    conversionType?: ConversionType;
+    conversionValue?: number;
+}
+/**
+ * Editor version options
+ */
+type EditorVersion = 'legacy' | 'puck';
+/**
+ * Page document from Payload
+ */
+interface PageDocument {
+    id: string;
+    title: string;
+    slug: string;
+    pageLayout: string;
+    editorVersion?: EditorVersion;
+    isHomepage: boolean;
+    puckData: PuckPageData | null;
+    meta?: PageMeta;
+    conversionTracking?: PageConversionTracking;
+    createdAt: string;
+    updatedAt: string;
+    _status?: 'draft' | 'published';
+}
+/**
+ * Shared props for all Puck components
+ */
+interface SharedComponentProps {
+    id?: string;
+    maxWidth?: 'narrow' | 'medium' | 'wide' | 'full';
+    verticalPadding?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    visibility?: 'always' | 'authenticated' | 'guest';
+}
+/**
+ * Media object from Payload
+ */
+interface MediaObject {
+    id: string;
+    url: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    filename?: string;
+    mimeType?: string;
+    sizes?: {
+        thumbnail?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        medium?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        large?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+    };
+}
+/**
+ * Options for merging Puck configurations
+ */
+interface MergeConfigOptions {
+    /**
+     * Base config to extend
+     */
+    base: Config;
+    /**
+     * Additional components to add
+     */
+    components?: Config['components'];
+    /**
+     * Additional categories to add/merge
+     */
+    categories?: Config['categories'];
+    /**
+     * Root config overrides
+     */
+    root?: Partial<Config['root']>;
+    /**
+     * Components to exclude from base
+     */
+    exclude?: string[];
+}
+/**
+ * Props for the MediaField custom field
+ */
+interface MediaFieldProps {
+    value: MediaObject | string | null;
+    onChange: (value: MediaObject | string | null) => void;
+    label?: string;
+    allowedTypes?: string[];
+}
+/**
+ * Props for the ColorPickerField custom field
+ */
+interface ColorPickerFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    label?: string;
+    showOpacity?: boolean;
+}
+/**
+ * Props for the TiptapField custom field
+ */
+interface TiptapFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    label?: string;
+    readOnly?: boolean;
+}
+
+export type { ConversionType as C, EditorVersion as E, MediaObject as M, PuckPageData as P, SharedComponentProps as S, TiptapFieldProps as T, PuckRootProps as a, MergeConfigOptions as b, PuckPluginOptions as c, PuckAdminConfig as d, PageMeta as e, PageSEO as f, PageConversionTracking as g, PageDocument as h, MediaFieldProps as i, ColorPickerFieldProps as j, ThemeConfig as k };

package/dist/index-CoUQnyC3.d.ts

@@ -0,0 +1,327 @@
+import { CollectionConfig, Access, Field } from 'payload';
+import { Data, Config } from '@measured/puck';
+import { L as LayoutDefinition } from './types-D7D3rZ1J.js';
+
+/**
+ * Theme Type Definitions
+ *
+ * Defines all theme-related TypeScript interfaces for the payload-puck plugin.
+ * These types enable consuming applications to customize button variants,
+ * color presets, and other visual styles.
+ */
+/**
+ * Configuration for a single button variant
+ */
+interface ButtonVariantConfig {
+    /** Tailwind classes for the variant */
+    classes: string;
+    /** Optional CSS variable reference for dynamic theming */
+    cssVariable?: string;
+}
+/**
+ * Map of button variant names to their configurations
+ */
+interface ButtonVariantStyles {
+    default?: ButtonVariantConfig;
+    primary?: ButtonVariantConfig;
+    secondary?: ButtonVariantConfig;
+    outline?: ButtonVariantConfig;
+    ghost?: ButtonVariantConfig;
+    destructive?: ButtonVariantConfig;
+    link?: ButtonVariantConfig;
+    [key: string]: ButtonVariantConfig | undefined;
+}
+/**
+ * Color preset for the color picker
+ */
+interface ColorPreset {
+    /** Hex color value (e.g., '#3b82f6') */
+    hex: string;
+    /** Display label for the preset */
+    label: string;
+    /** Optional CSS variable reference (e.g., 'var(--color-primary)') */
+    cssVariable?: string;
+}
+/**
+ * Background style configurations for CTA components
+ */
+interface BackgroundStyles {
+    default?: string;
+    dark?: string;
+    light?: string;
+    [key: string]: string | undefined;
+}
+/**
+ * Theme configuration provided by consuming applications
+ * All properties are optional and will be merged with defaults
+ */
+interface ThemeConfig {
+    /**
+     * Button variant styles
+     * Merged with default button variants
+     */
+    buttonVariants?: Partial<ButtonVariantStyles>;
+    /**
+     * CTA button variant styles
+     * Merged with default CTA button variants
+     */
+    ctaButtonVariants?: Partial<ButtonVariantStyles>;
+    /**
+     * CTA background styles
+     * Merged with default background styles
+     */
+    ctaBackgroundStyles?: Partial<BackgroundStyles>;
+    /**
+     * Color picker preset colors
+     * If provided, replaces defaults unless extendColorPresets is true
+     */
+    colorPresets?: ColorPreset[];
+    /**
+     * Whether to extend default color presets (true) or replace them (false)
+     * @default false
+     */
+    extendColorPresets?: boolean;
+    /**
+     * Focus ring color class (e.g., 'focus:ring-primary')
+     * @default 'focus:ring-blue-500'
+     */
+    focusRingColor?: string;
+}
+
+/**
+ * Admin UI configuration for the Puck plugin
+ */
+interface PuckAdminConfig {
+    /**
+     * Whether to add the visual editor button to the collection
+     * @default true
+     */
+    addEditButton?: boolean;
+    /**
+     * URL pattern for the Puck editor page (outside of Payload admin)
+     * Use {id} as placeholder for document ID
+     * @default '/pages/{id}/edit'
+     */
+    editorPathPattern?: string;
+    /**
+     * Button label text
+     * @default 'Edit with Puck'
+     */
+    buttonLabel?: string;
+    /**
+     * Position of the edit button in admin sidebar
+     * @default 'sidebar'
+     */
+    buttonPosition?: 'sidebar' | 'main';
+}
+/**
+ * Configuration options for the Puck plugin
+ */
+interface PuckPluginOptions {
+    /**
+     * Collection slug for pages
+     * @default 'pages'
+     */
+    pagesCollection?: string;
+    /**
+     * Whether to auto-generate the Pages collection
+     * Set to false if you want to define your own collection
+     * @default true
+     */
+    autoGenerateCollection?: boolean;
+    /**
+     * Custom collection config to merge with defaults
+     */
+    collectionOverrides?: Partial<CollectionConfig>;
+    /**
+     * Access control for Puck operations
+     * Uses Payload's Access type for full compatibility
+     */
+    access?: {
+        read?: Access;
+        create?: Access;
+        update?: Access;
+        delete?: Access;
+    };
+    /**
+     * Page layout configuration
+     * Define custom layouts that affect how page content is rendered
+     * @default DEFAULT_LAYOUTS
+     */
+    layouts?: LayoutDefinition[];
+    /**
+     * Additional fields to add to the Pages collection
+     */
+    additionalFields?: Field[];
+    /**
+     * Admin UI configuration
+     * Configure how the visual editor integrates with Payload admin
+     */
+    admin?: PuckAdminConfig;
+    /**
+     * Theme configuration for customizing button styles, colors, and presets
+     * All values are optional and will fall back to defaults
+     */
+    theme?: ThemeConfig;
+}
+/**
+ * Root properties for a Puck page
+ */
+interface PuckRootProps {
+    title?: string;
+    pageLayout?: string;
+    [key: string]: unknown;
+}
+/**
+ * Complete Puck page data structure
+ */
+interface PuckPageData extends Data {
+    root: {
+        props: PuckRootProps;
+    };
+}
+/**
+ * SEO/Meta configuration for a page.
+ * Uses the official @payloadcms/plugin-seo convention.
+ */
+interface PageMeta {
+    title?: string;
+    description?: string;
+    image?: string | {
+        id: string;
+        url: string;
+        alt?: string;
+    };
+    noindex?: boolean;
+    nofollow?: boolean;
+    excludeFromSitemap?: boolean;
+}
+/**
+ * @deprecated Use PageMeta instead. This alias is kept for backwards compatibility.
+ */
+type PageSEO = PageMeta;
+/**
+ * Conversion type options
+ */
+type ConversionType = 'lead' | 'registration' | 'purchase' | 'donation' | 'newsletter' | 'contact' | 'custom';
+/**
+ * Conversion tracking configuration for a page
+ */
+interface PageConversionTracking {
+    isConversionPage?: boolean;
+    conversionType?: ConversionType;
+    conversionValue?: number;
+}
+/**
+ * Editor version options
+ */
+type EditorVersion = 'legacy' | 'puck';
+/**
+ * Page document from Payload
+ */
+interface PageDocument {
+    id: string;
+    title: string;
+    slug: string;
+    pageLayout: string;
+    editorVersion?: EditorVersion;
+    isHomepage: boolean;
+    puckData: PuckPageData | null;
+    meta?: PageMeta;
+    conversionTracking?: PageConversionTracking;
+    createdAt: string;
+    updatedAt: string;
+    _status?: 'draft' | 'published';
+}
+/**
+ * Shared props for all Puck components
+ */
+interface SharedComponentProps {
+    id?: string;
+    maxWidth?: 'narrow' | 'medium' | 'wide' | 'full';
+    verticalPadding?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    visibility?: 'always' | 'authenticated' | 'guest';
+}
+/**
+ * Media object from Payload
+ */
+interface MediaObject {
+    id: string;
+    url: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    filename?: string;
+    mimeType?: string;
+    sizes?: {
+        thumbnail?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        medium?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+        large?: {
+            url: string;
+            width: number;
+            height: number;
+        };
+    };
+}
+/**
+ * Options for merging Puck configurations
+ */
+interface MergeConfigOptions {
+    /**
+     * Base config to extend
+     */
+    base: Config;
+    /**
+     * Additional components to add
+     */
+    components?: Config['components'];
+    /**
+     * Additional categories to add/merge
+     */
+    categories?: Config['categories'];
+    /**
+     * Root config overrides
+     */
+    root?: Partial<Config['root']>;
+    /**
+     * Components to exclude from base
+     */
+    exclude?: string[];
+}
+/**
+ * Props for the MediaField custom field
+ */
+interface MediaFieldProps {
+    value: MediaObject | string | null;
+    onChange: (value: MediaObject | string | null) => void;
+    label?: string;
+    allowedTypes?: string[];
+}
+/**
+ * Props for the ColorPickerField custom field
+ */
+interface ColorPickerFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    label?: string;
+    showOpacity?: boolean;
+}
+/**
+ * Props for the TiptapField custom field
+ */
+interface TiptapFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    label?: string;
+    readOnly?: boolean;
+}
+
+export type { ConversionType as C, EditorVersion as E, MediaObject as M, PuckPageData as P, SharedComponentProps as S, TiptapFieldProps as T, PuckRootProps as a, MergeConfigOptions as b, PuckPluginOptions as c, PuckAdminConfig as d, PageMeta as e, PageSEO as f, PageConversionTracking as g, PageDocument as h, MediaFieldProps as i, ColorPickerFieldProps as j, ThemeConfig as k };

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export { j as ColorPickerFieldProps, C as ConversionType, E as EditorVersion, i as MediaFieldProps, M as MediaObject, b as MergeConfigOptions, g as PageConversionTracking, h as PageDocument, e as PageMeta, f as PageSEO, d as PuckAdminConfig, P as PuckPageData, c as PuckPluginOptions, a as PuckRootProps, S as SharedComponentProps, k as ThemeConfig, T as TiptapFieldProps } from './index-CQu6SzDg.mjs';
+export { GetPuckFieldsOptions, TemplatesCollection, conversionFieldGroup, createEditorVersionField, createPageLayoutField, createPuckPlugin, editorVersionField, generatePagesCollection, generatePuckEditField, getPuckFields, isHomepageField, pageLayoutField, puckDataField, seoFieldGroup } from './plugin/index.mjs';
+export { Config as PuckConfig, Data as PuckData } from '@measured/puck';
+import 'payload';
+import './types-D7D3rZ1J.mjs';
+import 'react';

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { j as ColorPickerFieldProps, C as ConversionType, E as EditorVersion, i as MediaFieldProps, M as MediaObject, b as MergeConfigOptions, g as PageConversionTracking, h as PageDocument, e as PageMeta, f as PageSEO, d as PuckAdminConfig, P as PuckPageData, c as PuckPluginOptions, a as PuckRootProps, S as SharedComponentProps, k as ThemeConfig, T as TiptapFieldProps } from './index-CoUQnyC3.js';
+export { GetPuckFieldsOptions, TemplatesCollection, conversionFieldGroup, createEditorVersionField, createPageLayoutField, createPuckPlugin, editorVersionField, generatePagesCollection, generatePuckEditField, getPuckFields, isHomepageField, pageLayoutField, puckDataField, seoFieldGroup } from './plugin/index.js';
+export { Config as PuckConfig, Data as PuckData } from '@measured/puck';
+import 'payload';
+import './types-D7D3rZ1J.js';
+import 'react';