@delmaredigital/payload-puck 0.1.3 → 0.3.0

package/dist/{index-CQu6SzDg.d.mts → types/index.d.ts}

@@ -1,106 +1,21 @@
-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;
-}
-
+import type { Access, CollectionConfig, Field } from 'payload';
+import type { Config as PuckConfig, Data as PuckData } from '@measured/puck';
+import type { ThemeConfig } from '../theme/types';
+import type { LayoutDefinition } from '../layouts/types';
 /**
  * Admin UI configuration for the Puck plugin
  */
-interface PuckAdminConfig {
+export 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'
+     * Custom URL pattern for the Puck editor (for backwards compatibility)
+     * By default, the plugin uses the integrated admin view at /admin/puck-editor/:collection/:id
+     * Use {id} as placeholder for document ID, {collection} for collection slug
+     * @deprecated The editor is now integrated into Payload admin. Only use this for custom external editors.
      */
     editorPathPattern?: string;
     /**
@@ -117,7 +32,7 @@ interface PuckAdminConfig {
 /**
  * Configuration options for the Puck plugin
  */
-interface PuckPluginOptions {
+export interface PuckPluginOptions {
     /**
      * Collection slug for pages
      * @default 'pages'
@@ -163,11 +78,86 @@ interface PuckPluginOptions {
      * All values are optional and will fall back to defaults
      */
     theme?: ThemeConfig;
+    /**
+     * Whether to enable the integrated admin view
+     * When enabled, the Puck editor is accessible at /admin/puck-editor/:collection/:id
+     * @default true
+     */
+    enableAdminView?: boolean;
+    /**
+     * Custom path for the admin view (without /admin prefix)
+     * @default '/puck-editor'
+     */
+    adminViewPath?: string;
+    /**
+     * Whether to enable built-in API endpoints
+     * When enabled, endpoints are registered at /api/puck/:collection/:id
+     * @default true
+     */
+    enableEndpoints?: boolean;
+    /**
+     * Integration with @delmaredigital/payload-page-tree plugin
+     *
+     * **Auto-detection:** The Puck editor automatically detects if page-tree is active
+     * by checking for the `pageSegment` field on the collection. No configuration needed
+     * in most cases.
+     *
+     * Use this option only if you need to:
+     * - Explicitly disable page-tree integration: `pageTreeIntegration: false`
+     * - Override default field names if you customized page-tree config
+     *
+     * @example
+     * ```typescript
+     * // Usually not needed - auto-detected!
+     * createPuckPlugin({
+     *   pagesCollection: 'pages',
+     * })
+     *
+     * // Override field names if customized:
+     * createPuckPlugin({
+     *   pageTreeIntegration: {
+     *     folderSlug: 'my-folders',
+     *     pageSegmentFieldName: 'urlSegment',
+     *   },
+     * })
+     *
+     * // Explicitly disable even if page-tree is present:
+     * createPuckPlugin({
+     *   pageTreeIntegration: false,
+     * })
+     * ```
+     */
+    pageTreeIntegration?: boolean | PageTreeIntegrationOptions;
+}
+/**
+ * Configuration options for page-tree integration
+ */
+export interface PageTreeIntegrationOptions {
+    /**
+     * Collection slug for folders
+     * @default 'payload-folders'
+     */
+    folderSlug?: string;
+    /**
+     * Field name for folder path segments
+     * @default 'pathSegment'
+     */
+    segmentFieldName?: string;
+    /**
+     * Field name for page segments
+     * @default 'pageSegment'
+     */
+    pageSegmentFieldName?: string;
+    /**
+     * Field name for the folder relationship
+     * @default 'folder'
+     */
+    folderFieldName?: string;
 }
 /**
  * Root properties for a Puck page
  */
-interface PuckRootProps {
+export interface PuckRootProps {
     title?: string;
     pageLayout?: string;
     [key: string]: unknown;
@@ -175,7 +165,7 @@ interface PuckRootProps {
 /**
  * Complete Puck page data structure
  */
-interface PuckPageData extends Data {
+export interface PuckPageData extends PuckData {
     root: {
         props: PuckRootProps;
     };
@@ -184,7 +174,7 @@ interface PuckPageData extends Data {
  * SEO/Meta configuration for a page.
  * Uses the official @payloadcms/plugin-seo convention.
  */
-interface PageMeta {
+export interface PageMeta {
     title?: string;
     description?: string;
     image?: string | {
@@ -199,15 +189,15 @@ interface PageMeta {
 /**
  * @deprecated Use PageMeta instead. This alias is kept for backwards compatibility.
  */
-type PageSEO = PageMeta;
+export type PageSEO = PageMeta;
 /**
  * Conversion type options
  */
-type ConversionType = 'lead' | 'registration' | 'purchase' | 'donation' | 'newsletter' | 'contact' | 'custom';
+export type ConversionType = 'lead' | 'registration' | 'purchase' | 'donation' | 'newsletter' | 'contact' | 'custom';
 /**
  * Conversion tracking configuration for a page
  */
-interface PageConversionTracking {
+export interface PageConversionTracking {
     isConversionPage?: boolean;
     conversionType?: ConversionType;
     conversionValue?: number;
@@ -215,11 +205,11 @@ interface PageConversionTracking {
 /**
  * Editor version options
  */
-type EditorVersion = 'legacy' | 'puck';
+export type EditorVersion = 'legacy' | 'puck';
 /**
  * Page document from Payload
  */
-interface PageDocument {
+export interface PageDocument {
     id: string;
     title: string;
     slug: string;
@@ -232,11 +222,24 @@ interface PageDocument {
     createdAt: string;
     updatedAt: string;
     _status?: 'draft' | 'published';
+    folder?: string | {
+        id: string;
+        name?: string;
+        pathSegment?: string;
+    };
+    pageSegment?: string;
+}
+/**
+ * Puck root props when page-tree integration is enabled
+ */
+export interface PageTreeRootProps extends PuckRootProps {
+    folder?: string | null;
+    pageSegment?: string;
 }
 /**
  * Shared props for all Puck components
  */
-interface SharedComponentProps {
+export interface SharedComponentProps {
     id?: string;
     maxWidth?: 'narrow' | 'medium' | 'wide' | 'full';
     verticalPadding?: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl';
@@ -245,7 +248,7 @@ interface SharedComponentProps {
 /**
  * Media object from Payload
  */
-interface MediaObject {
+export interface MediaObject {
     id: string;
     url: string;
     alt?: string;
@@ -274,23 +277,23 @@ interface MediaObject {
 /**
  * Options for merging Puck configurations
  */
-interface MergeConfigOptions {
+export interface MergeConfigOptions {
     /**
      * Base config to extend
      */
-    base: Config;
+    base: PuckConfig;
     /**
      * Additional components to add
      */
-    components?: Config['components'];
+    components?: PuckConfig['components'];
     /**
      * Additional categories to add/merge
      */
-    categories?: Config['categories'];
+    categories?: PuckConfig['categories'];
     /**
      * Root config overrides
      */
-    root?: Partial<Config['root']>;
+    root?: Partial<PuckConfig['root']>;
     /**
      * Components to exclude from base
      */
@@ -299,7 +302,7 @@ interface MergeConfigOptions {
 /**
  * Props for the MediaField custom field
  */
-interface MediaFieldProps {
+export interface MediaFieldProps {
     value: MediaObject | string | null;
     onChange: (value: MediaObject | string | null) => void;
     label?: string;
@@ -308,7 +311,7 @@ interface MediaFieldProps {
 /**
  * Props for the ColorPickerField custom field
  */
-interface ColorPickerFieldProps {
+export interface ColorPickerFieldProps {
     value: string;
     onChange: (value: string) => void;
     label?: string;
@@ -317,11 +320,13 @@ interface ColorPickerFieldProps {
 /**
  * Props for the TiptapField custom field
  */
-interface TiptapFieldProps {
+export 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 };
+export type { Config as PuckConfig, Data as PuckData } from '@measured/puck';
+export type { ThemeConfig } from '../theme/types';
+export type { GetPuckFieldsOptions } from '../plugin/fields/types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAA2B,KAAK,EAAE,MAAM,SAAS,CAAA;AACvF,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAgB,MAAM,kBAAkB,CAAA;AAMtE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE/C;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IAED;;;;OAIG;IACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAA;IAE1B;;;OAGG;IACH,KAAK,CAAC,EAAE,eAAe,CAAA;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,CAAA;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,0BAA0B,CAAA;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,IAAI,EAAE;QACJ,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAA;AAE9B;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,cAAc,GACd,UAAU,GACV,UAAU,GACV,YAAY,GACZ,SAAS,GACT,QAAQ,CAAA;AAEZ;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE7C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,UAAU,EAAE,OAAO,CAAA;IACnB,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAA;IAC7B,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,kBAAkB,CAAC,EAAE,sBAAsB,CAAA;IAC3C,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;IAE/B,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACrE,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAA;IAChD,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;IAC3D,UAAU,CAAC,EAAE,QAAQ,GAAG,eAAe,GAAG,OAAO,CAAA;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE;QACN,SAAS,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;QAC1D,MAAM,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;QACvD,KAAK,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KACvD,CAAA;CACF;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IAErC;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,KAAK,IAAI,CAAA;IACtD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAMD,YAAY,EAAE,MAAM,IAAI,UAAU,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC5E,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAMjD,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/types/index.js

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

package/dist/types/index.js.map

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

package/dist/utils/index.d.ts

@@ -1,267 +1,33 @@
-import { P as PuckPageData, M as MediaObject, a as PuckRootProps } from '../index-CoUQnyC3.js';
-import 'payload';
-import '@measured/puck';
-import '../types-D7D3rZ1J.js';
-import 'react';
-
 /**
- * Migration Utility for Converting Legacy Payload CMS Pages to Puck Format
+ * Migration and Validation Utilities
  *
- * This utility converts legacy Payload CMS page block structures to the
- * Puck visual editor format, enabling seamless migration of existing content.
- */
-
-/**
- * Legacy block from Payload CMS pages.
- * Each block has a blockType discriminator and various props.
- */
-interface LegacyBlock {
-    blockType: string;
-    id?: string | null;
-    blockName?: string | null;
-    [key: string]: unknown;
-}
-/**
- * Subset of Page type used for migration.
- * Only includes fields relevant to content migration.
- */
-interface LegacyPage {
-    title: string;
-    slug: string;
-    pageLayout?: string;
-    layout?: LegacyBlock[] | null;
-    [key: string]: unknown;
-}
-/**
- * Media reference in Puck format
- */
-interface MediaReference {
-    id: string | number;
-    url?: string;
-    alt?: string;
-    width?: number;
-    height?: number;
-}
-/**
- * Puck content item structure
- */
-interface PuckContentItem {
-    type: string;
-    props: {
-        id: string;
-        [key: string]: unknown;
-    };
-}
-/**
- * Maps legacy Payload block types (camelCase) to Puck component types (PascalCase).
- * Extend this map to support additional custom block types.
- */
-declare const blockTypeMap: Record<string, string>;
-/**
- * Generates a unique ID for Puck content items.
- * Uses a format compatible with Puck's internal ID scheme.
- */
-declare function generatePuckId(legacyId?: string | null): string;
-/**
- * Transforms a Payload media reference (ID or Media object) to Puck MediaReference format.
- * Handles both ID-only references and full Media objects.
- */
-declare function transformMediaReference(media: string | number | {
-    id: string | number;
-    url?: string;
-    alt?: string;
-    width?: number;
-    height?: number;
-} | MediaObject | null | undefined): MediaReference | null;
-/**
- * Transforms Lexical rich text content to a serialized string format.
- * Puck stores rich text as JSON strings for the custom editors.
- */
-declare function transformRichText(richText: unknown): string | undefined;
-/**
- * Transforms an array of relationships to Puck format.
- */
-declare function transformRelationshipArray<T extends {
-    id: string | number;
-    title?: string;
-    slug?: string;
-}>(relations: (string | number | T)[] | null | undefined): Array<{
-    id: string | number;
-    title: string;
-    slug?: string;
-}> | undefined;
-/**
- * Transform props for a specific block type.
- * Handles any block-specific transformations needed.
- */
-declare function transformBlockProps(block: LegacyBlock, options?: {
-    richTextFields?: string[];
-    mediaFields?: string[];
-    customTransformers?: Record<string, (value: unknown) => unknown>;
-}): Record<string, unknown>;
-/**
- * Options for the migration function
- */
-interface MigrateLegacyOptions {
-    /**
-     * Custom block type mapping to extend or override defaults
-     */
-    blockTypeMap?: Record<string, string>;
-    /**
-     * Additional rich text field names to transform
-     */
-    richTextFields?: string[];
-    /**
-     * Additional media field names to transform
-     */
-    mediaFields?: string[];
-    /**
-     * Custom prop transformers for specific field names
-     */
-    customTransformers?: Record<string, (value: unknown) => unknown>;
-    /**
-     * Whether to skip unknown block types (default: true)
-     * If false, unknown blocks will throw an error
-     */
-    skipUnknownBlocks?: boolean;
-    /**
-     * Callback for handling unknown block types
-     */
-    onUnknownBlock?: (block: LegacyBlock) => PuckContentItem | null;
-}
-/**
- * Migrates a legacy Payload CMS page to Puck format.
- *
- * This function:
- * 1. Extracts root props (title, pageLayout, etc.)
- * 2. Converts each block in the layout array to a Puck content item
- * 3. Maps block types from camelCase to PascalCase using blockTypeMap
- * 4. Transforms block props appropriately
- *
- * @param page - The legacy Page object from Payload CMS
- * @param options - Migration options
- * @returns PuckPageData ready for use with the Puck editor
+ * This module provides utilities for migrating legacy Payload CMS pages
+ * to Puck format and validating Puck data structures.
  *
  * @example
  * ```ts
- * const legacyPage = await payload.findByID({ collection: 'pages', id: pageId })
+ * import {
+ *   migrateLegacyToPuck,
+ *   validatePuckData,
+ *   getMigrationPreview,
+ *   blockTypeMap,
+ * } from '@delmaredigital/payload-puck/utils'
+ *
+ * // Preview migration
+ * const preview = getMigrationPreview(legacyPage)
+ * console.log('Blocks to migrate:', preview.blockCount)
+ * console.log('Warnings:', preview.warnings)
+ *
+ * // Perform migration
  * const puckData = migrateLegacyToPuck(legacyPage)
- * await payload.update({
- *   collection: 'pages',
- *   id: pageId,
- *   data: { puckData },
- * })
- * ```
- */
-declare function migrateLegacyToPuck(page: LegacyPage, options?: MigrateLegacyOptions): PuckPageData;
-/**
- * Migration preview result
- */
-interface MigrationPreview {
-    title: string;
-    slug: string;
-    blockCount: number;
-    blockTypes: string[];
-    warnings: string[];
-    unmappedBlockTypes: string[];
-}
-/**
- * Gets a summary of a legacy page for migration preview.
- * Useful for showing users what will be migrated before committing.
- *
- * @param page - The legacy page to preview
- * @param customBlockTypeMap - Optional custom block type mapping
- * @returns Preview information about the migration
- */
-declare function getMigrationPreview(page: LegacyPage, customBlockTypeMap?: Record<string, string>): MigrationPreview;
-
-/**
- * Puck Data Validation Utilities
  *
- * Provides validation functions for ensuring Puck data structures are well-formed.
- */
-
-/**
- * Result of a validation operation
- */
-interface ValidationResult {
-    valid: boolean;
-    errors: string[];
-    warnings: string[];
-}
-/**
- * Options for validation
- */
-interface ValidationOptions {
-    /**
-     * Whether to validate that all content items have IDs
-     * @default true
-     */
-    requireContentIds?: boolean;
-    /**
-     * Whether to validate root props
-     * @default true
-     */
-    validateRoot?: boolean;
-    /**
-     * Required root prop fields
-     * @default ['title']
-     */
-    requiredRootProps?: string[];
-    /**
-     * Allowed component types (if specified, unknown types will be flagged)
-     */
-    allowedComponentTypes?: string[];
-    /**
-     * Whether to treat unknown component types as errors (vs warnings)
-     * @default false
-     */
-    strictComponentTypes?: boolean;
-}
-/**
- * Type guard to check if a value is a valid PuckPageData structure.
- * Performs basic structural validation.
- */
-declare function isPuckData(data: unknown): data is PuckPageData;
-/**
- * Type guard for PuckRootProps
- */
-declare function isPuckRootProps(props: unknown): props is PuckRootProps;
-/**
- * Validates that a PuckPageData structure is well-formed.
- * Useful for testing and debugging migration issues.
- *
- * @param data - The data to validate
- * @param options - Validation options
- * @returns Validation result with errors and warnings
- *
- * @example
- * ```ts
- * const result = validatePuckData(puckData)
- * if (!result.valid) {
- *   console.error('Validation errors:', result.errors)
+ * // Validate result
+ * const validation = validatePuckData(puckData)
+ * if (validation.valid) {
+ *   await payload.update({ collection: 'pages', id: pageId, data: { puckData } })
  * }
  * ```
  */
-declare function validatePuckData(data: unknown, options?: ValidationOptions): ValidationResult;
-/**
- * Validates and returns typed PuckPageData, throwing if invalid.
- *
- * @param data - The data to validate
- * @param options - Validation options
- * @returns The validated PuckPageData
- * @throws Error if validation fails
- */
-declare function assertPuckData(data: unknown, options?: ValidationOptions): PuckPageData;
-/**
- * Safely parses JSON and validates as PuckPageData.
- *
- * @param json - JSON string to parse
- * @param options - Validation options
- * @returns Validation result with parsed data if valid
- */
-declare function parsePuckDataJson(json: string, options?: ValidationOptions): ValidationResult & {
-    data?: PuckPageData;
-};
-
-export { type LegacyBlock, type LegacyPage, type MediaReference, type MigrateLegacyOptions, type MigrationPreview, type PuckContentItem, type ValidationOptions, type ValidationResult, assertPuckData, blockTypeMap, generatePuckId, getMigrationPreview, isPuckData, isPuckRootProps, migrateLegacyToPuck, parsePuckDataJson, transformBlockProps, transformMediaReference, transformRelationshipArray, transformRichText, validatePuckData };
+export { migrateLegacyToPuck, getMigrationPreview, blockTypeMap, generatePuckId, transformBlockProps, transformMediaReference, transformRichText, transformRelationshipArray, type LegacyBlock, type LegacyPage, type MediaReference, type PuckContentItem, type MigrateLegacyOptions, type MigrationPreview, } from './migration';
+export { validatePuckData, isPuckData, isPuckRootProps, assertPuckData, parsePuckDataJson, type ValidationResult, type ValidationOptions, } from './validation';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAMH,OAAO,EAEL,mBAAmB,EAEnB,mBAAmB,EAEnB,YAAY,EAEZ,cAAc,EAEd,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAE1B,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAA;AAMpB,OAAO,EAEL,gBAAgB,EAEhB,UAAU,EACV,eAAe,EAEf,cAAc,EAEd,iBAAiB,EAEjB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,GACvB,MAAM,cAAc,CAAA"}