@measured/puck 0.19.0-canary.ad78e98 → 0.19.0-canary.af1dc891

package/dist/rsc.mjs

@@ -1,113 +1,18 @@
 import {
-  __spreadProps,
-  __spreadValues,
+  Render,
   init_react_import,
+  migrate,
   resolveAllData,
-  rootAreaId,
-  rootDroppableId,
-  rootZone,
-  setupZone
-} from "./chunk-T6VJEBJD.mjs";
+  transformProps,
+  walkTree
+} from "./chunk-HGAPIQP5.mjs";
 
 // rsc.tsx
 init_react_import();
-
-// components/ServerRender/index.tsx
-init_react_import();
-import { Fragment, jsx } from "react/jsx-runtime";
-function DropZoneRender({
-  zone,
-  data,
-  areaId = "root",
-  config,
-  metadata = {}
-}) {
-  let zoneCompound = rootDroppableId;
-  let content = (data == null ? void 0 : data.content) || [];
-  if (!data || !config) {
-    return null;
-  }
-  if (areaId !== rootAreaId && zone !== rootZone) {
-    zoneCompound = `${areaId}:${zone}`;
-    content = setupZone(data, zoneCompound).zones[zoneCompound];
-  }
-  return /* @__PURE__ */ jsx(Fragment, { children: content.map((item) => {
-    const Component = config.components[item.type];
-    if (Component) {
-      return /* @__PURE__ */ jsx(
-        Component.render,
-        __spreadProps(__spreadValues({}, item.props), {
-          puck: {
-            renderDropZone: ({ zone: zone2 }) => /* @__PURE__ */ jsx(
-              DropZoneRender,
-              {
-                zone: zone2,
-                data,
-                areaId: item.props.id,
-                config,
-                metadata
-              }
-            ),
-            metadata
-          }
-        }),
-        item.props.id
-      );
-    }
-    return null;
-  }) });
-}
-function Render({
-  config,
-  data,
-  metadata
-}) {
-  var _a;
-  if ((_a = config.root) == null ? void 0 : _a.render) {
-    const rootProps = data.root.props || data.root;
-    const title = rootProps.title || "";
-    return /* @__PURE__ */ jsx(
-      config.root.render,
-      __spreadProps(__spreadValues({}, rootProps), {
-        puck: {
-          renderDropZone: ({ zone }) => /* @__PURE__ */ jsx(
-            DropZoneRender,
-            {
-              zone,
-              data,
-              config,
-              metadata
-            }
-          ),
-          isEditing: false,
-          dragRef: null
-        },
-        title,
-        editMode: false,
-        id: "puck-root",
-        children: /* @__PURE__ */ jsx(
-          DropZoneRender,
-          {
-            config,
-            data,
-            zone: rootZone,
-            metadata
-          }
-        )
-      })
-    );
-  }
-  return /* @__PURE__ */ jsx(
-    DropZoneRender,
-    {
-      config,
-      data,
-      zone: rootZone,
-      metadata
-    }
-  );
-}
 export {
   Render,
-  resolveAllData
+  migrate,
+  resolveAllData,
+  transformProps,
+  walkTree
 };

package/dist/{resolve-all-data-wwgDuTnC.d.mts → walk-tree-DBd3aQ_5.d.mts}

@@ -1,4 +1,4 @@
-import { CSSProperties, ReactElement, JSX, ReactNode } from 'react';
+import { CSSProperties, ReactElement, ReactNode, JSX } from 'react';
 
 type ItemSelector = {
     index: number;
@@ -22,6 +22,9 @@ type FieldOption = {
 type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
 type BaseField = {
     label?: string;
+    labelIcon?: ReactElement;
+    metadata?: Metadata;
+    visible?: boolean;
 };
 type TextField = BaseField & {
     type: "text";
@@ -108,16 +111,22 @@ type ExternalField<Props extends {
     filterFields?: Record<string, Field>;
     initialFilters?: Record<string, any>;
 };
-type CustomField<Props extends any = {}> = BaseField & {
+type CustomFieldRender<Value extends any> = (props: {
+    field: CustomField<Value>;
+    name: string;
+    id: string;
+    value: Value;
+    onChange: (value: Value) => void;
+    readOnly?: boolean;
+}) => ReactElement;
+type CustomField<Value extends any> = BaseField & {
     type: "custom";
-    render: (props: {
-        field: CustomField<Props>;
-        name: string;
-        id: string;
-        value: Props;
-        onChange: (value: Props) => void;
-        readOnly?: boolean;
-    }) => ReactElement;
+    render: CustomFieldRender<Value>;
+};
+type SlotField = BaseField & {
+    type: "slot";
+    allow?: string[];
+    disallow?: string[];
 };
 type Field<Props extends any = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<Props extends {
     [key: string]: any;
@@ -127,7 +136,7 @@ type Field<Props extends any = any> = TextField | NumberField | TextareaField |
     [key: string]: any;
 } ? Props : any> | ExternalFieldWithAdaptor<Props extends {
     [key: string]: any;
-} ? Props : any> | CustomField<Props>;
+} ? Props : any> | CustomField<Props> | SlotField;
 type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps> = {
     [PropName in keyof Omit<ComponentProps, "editMode">]: Field<ComponentProps[PropName]>;
 };
@@ -139,7 +148,14 @@ type FieldProps<F = Field<any>, ValueType = any> = {
     readOnly?: boolean;
 };
 
-type PuckComponent<Props> = (props: WithId<WithPuckProps<Props>>) => JSX.Element;
+type SlotComponent = (props?: Omit<DropZoneProps, "zone">) => ReactNode;
+type PuckComponent<Props> = (props: WithId<WithPuckProps<{
+    [K in keyof Props]: WithDeepSlots<Props[K], SlotComponent>;
+}>>) => JSX.Element;
+type ResolveDataTrigger = "insert" | "replace" | "load" | "force";
+type WithPartialProps<T, Props extends DefaultComponentProps> = Omit<T, "props"> & {
+    props?: Partial<Props>;
+};
 type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderProps, DataShape = Omit<ComponentData<FieldProps>, "type">> = {
     render: PuckComponent<RenderProps>;
     label?: string;
@@ -148,7 +164,9 @@ type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponen
     permissions?: Partial<Permissions>;
     inline?: boolean;
     resolveFields?: (data: DataShape, params: {
-        changed: Partial<Record<keyof FieldProps, boolean>>;
+        changed: Partial<Record<keyof FieldProps, boolean> & {
+            id: string;
+        }>;
         fields: Fields<FieldProps>;
         lastFields: Fields<FieldProps>;
         lastData: DataShape | null;
@@ -156,24 +174,25 @@ type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponen
         parent: ComponentData | null;
     }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
     resolveData?: (data: DataShape, params: {
-        changed: Partial<Record<keyof FieldProps, boolean>>;
+        changed: Partial<Record<keyof FieldProps, boolean> & {
+            id: string;
+        }>;
         lastData: DataShape | null;
         metadata: Metadata;
-    }) => Promise<{
-        props?: Partial<FieldProps>;
-        readOnly?: Partial<Record<keyof FieldProps, boolean>>;
-    }> | {
-        props?: Partial<FieldProps>;
-        readOnly?: Partial<Record<keyof FieldProps, boolean>>;
-    };
+        trigger: ResolveDataTrigger;
+    }) => Promise<WithPartialProps<DataShape, FieldProps>> | WithPartialProps<DataShape, FieldProps>;
     resolvePermissions?: (data: DataShape, params: {
-        changed: Partial<Record<keyof FieldProps, boolean>>;
+        changed: Partial<Record<keyof FieldProps, boolean> & {
+            id: string;
+        }>;
         lastPermissions: Partial<Permissions>;
         permissions: Partial<Permissions>;
         appState: AppState;
         lastData: DataShape | null;
     }) => Promise<Partial<Permissions>> | Partial<Permissions>;
+    metadata?: Metadata;
 };
+type RootConfig<RootProps extends DefaultComponentProps = any> = Partial<ComponentConfig<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>>>;
 type Category<ComponentName> = {
     components?: ComponentName[];
     title?: string;
@@ -187,7 +206,7 @@ type Config<Props extends DefaultComponentProps = DefaultComponentProps, RootPro
     components: {
         [ComponentName in keyof Props]: Omit<ComponentConfig<Props[ComponentName], Props[ComponentName]>, "type">;
     };
-    root?: Partial<ComponentConfig<WithChildren<RootProps>, AsFieldProps<RootProps>, RootData<AsFieldProps<RootProps>>>>;
+    root?: RootConfig<RootProps>;
 };
 
 type WithId<Props> = Props & {
@@ -203,7 +222,7 @@ type WithChildren<Props> = Props & {
 };
 type ExtractPropsFromConfig<UserConfig> = UserConfig extends Config<infer P, any, any> ? P : never;
 type ExtractRootPropsFromConfig<UserConfig> = UserConfig extends Config<any, infer P, any> ? P : never;
-type UserGenerics<UserConfig extends Config = Config, UserProps extends ExtractPropsFromConfig<UserConfig> = ExtractPropsFromConfig<UserConfig>, UserRootProps extends ExtractRootPropsFromConfig<UserConfig> = ExtractRootPropsFromConfig<UserConfig>, UserData extends Data<UserProps, UserRootProps> | Data = Data<UserProps, UserRootProps>, UserAppState extends AppState<UserData> = AppState<UserData>, UserComponentData extends ComponentData = UserData["content"][0]> = {
+type UserGenerics<UserConfig extends Config = Config, UserProps extends ExtractPropsFromConfig<UserConfig> = ExtractPropsFromConfig<UserConfig>, UserRootProps extends ExtractRootPropsFromConfig<UserConfig> = ExtractRootPropsFromConfig<UserConfig>, UserData extends Data<UserProps, UserRootProps> | Data = Data<UserProps, UserRootProps>, UserAppState extends PrivateAppState<UserData> = PrivateAppState<UserData>, UserComponentData extends ComponentData = UserData["content"][0]> = {
     UserConfig: UserConfig;
     UserProps: UserProps;
     UserRootProps: UserRootProps;
@@ -219,6 +238,7 @@ type PuckContext = {
     dragRef: ((element: Element | null) => void) | null;
 };
 type DefaultRootFieldProps = {
+    [key: string]: any;
     title?: string;
 };
 type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
@@ -239,23 +259,29 @@ type RootDataWithProps<Props extends DefaultComponentProps = DefaultRootFieldPro
 };
 type RootDataWithoutProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = Props;
 type RootData<Props extends DefaultComponentProps = DefaultRootFieldProps> = Partial<RootDataWithProps<AsFieldProps<Props>>> & Partial<RootDataWithoutProps<Props>>;
-type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
+type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string, AllProps extends Record<string, DefaultComponentProps> = Record<string, DefaultComponentProps>> = {
+    type: Name;
+    props: WithDeepSlots<WithId<Props>, Content<AllProps>>;
+} & BaseData<Props>;
+type ComponentDataOptionalId<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
     type: Name;
-    props: WithId<Props>;
+    props: Props & {
+        id?: string;
+    };
 } & BaseData<Props>;
 type MappedItem = ComponentData;
-type ComponentDataMap<Props extends Record<string, DefaultComponentProps> = DefaultComponentProps> = {
-    [K in keyof Props]: ComponentData<Props[K], K extends string ? K : never>;
-}[keyof Props];
+type ComponentDataMap<AllProps extends DefaultAllProps = DefaultAllProps> = {
+    [K in keyof AllProps]: ComponentData<AllProps[K], K extends string ? K : never, AllProps>;
+}[keyof AllProps];
 type Content<PropsMap extends {
-    [key: string]: any;
+    [key: string]: DefaultComponentProps;
 } = {
-    [key: string]: any;
+    [key: string]: DefaultComponentProps;
 }> = ComponentDataMap<PropsMap>[];
-type Data<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
-    root: RootData<RootProps>;
-    content: Content<Props>;
-    zones?: Record<string, Content<Props>>;
+type Data<AllProps extends DefaultAllProps = DefaultAllProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
+    root: WithDeepSlots<RootData<RootProps>, Content<AllProps>>;
+    content: Content<AllProps>;
+    zones?: Record<string, Content<AllProps>>;
 };
 type Metadata = {
     [key: string]: any;
@@ -299,6 +325,34 @@ type AppState<UserData extends Data = Data> = {
     ui: UiState;
 };
 
+type ZoneType = "root" | "dropzone" | "slot";
+type PuckNodeData = {
+    data: ComponentData;
+    flatData: ComponentData;
+    parentId: string | null;
+    zone: string;
+    path: string[];
+};
+type PuckZoneData = {
+    contentIds: string[];
+    type: ZoneType;
+};
+type NodeIndex = Record<string, PuckNodeData>;
+type ZoneIndex = Record<string, PuckZoneData>;
+type PrivateAppState<UserData extends Data = Data> = AppState<UserData> & {
+    indexes: {
+        nodes: NodeIndex;
+        zones: ZoneIndex;
+    };
+};
+type DefaultAllProps = Record<string, DefaultComponentProps>;
+/**
+ * Recursively walk T and replace Slots with SlotComponents
+ */
+type WithDeepSlots<T, SlotType = T> = T extends Slot ? SlotType : T extends (infer U)[] ? Array<WithDeepSlots<U, SlotType>> : T extends (infer U)[] ? WithDeepSlots<U, SlotType>[] : T extends object ? {
+    [K in keyof T]: WithDeepSlots<T[K], SlotType>;
+} : T;
+
 type RenderFunc<Props extends {
     [key: string]: any;
 } = {
@@ -405,6 +459,14 @@ type InitialHistoryNoAppend<AS = Partial<AppState>> = {
     appendData?: false;
 };
 type InitialHistory<AS = Partial<AppState>> = InitialHistoryAppend<AS> | InitialHistoryNoAppend<AS>;
+type Slot<Props extends {
+    [key: string]: DefaultComponentProps;
+} = {
+    [key: string]: DefaultComponentProps;
+}> = {
+    [K in keyof Props]: ComponentDataOptionalId<Props[K], K extends string ? K : never>;
+}[keyof Props][];
+type WithSlotProps<Target extends Record<string, any>, AllProps extends DefaultAllProps = DefaultAllProps, SlotType extends Content<AllProps> = Content<AllProps>> = WithDeepSlots<Target, SlotType>;
 
 type InsertAction = {
     type: "insert";
@@ -418,11 +480,17 @@ type DuplicateAction = {
     sourceIndex: number;
     sourceZone: string;
 };
-type ReplaceAction = {
+type ReplaceAction<UserData extends Data = Data> = {
     type: "replace";
     destinationIndex: number;
     destinationZone: string;
-    data: any;
+    data: ComponentData;
+    ui?: Partial<AppState<UserData>["ui"]>;
+};
+type ReplaceRootAction<UserData extends Data = Data> = {
+    type: "replaceRoot";
+    root: RootData;
+    ui?: Partial<AppState<UserData>["ui"]>;
 };
 type ReorderAction = {
     type: "reorder";
@@ -452,7 +520,7 @@ type SetDataAction = {
 };
 type SetAction<UserData extends Data = Data> = {
     type: "set";
-    state: Partial<AppState<UserData>> | ((previous: AppState<UserData>) => Partial<AppState<UserData>>);
+    state: Partial<PrivateAppState<UserData>> | ((previous: PrivateAppState<UserData>) => Partial<PrivateAppState<UserData>>);
 };
 type RegisterZoneAction = {
     type: "registerZone";
@@ -464,8 +532,27 @@ type UnregisterZoneAction = {
 };
 type PuckAction = {
     recordHistory?: boolean;
-} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
+} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | ReplaceRootAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
+
+declare function migrate(data: Data, config?: Config): Data;
+
+type PropTransform<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = Partial<{
+    [ComponentName in keyof Props]: (props: Props[ComponentName] & {
+        [key: string]: any;
+    }) => Props[ComponentName];
+} & {
+    root: (props: RootProps & {
+        [key: string]: any;
+    }) => RootProps;
+}>;
+declare function transformProps<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps>(data: Partial<Data>, propTransforms: PropTransform<Props, RootProps>, config?: Config): Data;
 
 declare function resolveAllData<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends Record<string, any> = DefaultRootFieldProps>(data: Partial<Data>, config: Config, metadata?: Metadata, onResolveStart?: (item: ComponentData) => void, onResolveEnd?: (item: ComponentData) => void): Promise<Data<Props, RootProps>>;
 
-export { type DefaultRootProps as $, type AppState as A, type BaseData as B, type Config as C, type DropZoneProps as D, type BaseField as E, type FieldProps as F, type TextareaField as G, type History as H, type IframeConfig as I, type RadioField as J, type ArrayField as K, type ObjectField as L, type Metadata as M, type NumberField as N, type OnAction as O, type Permissions as P, type Adaptor as Q, type RootDataWithProps as R, type SelectField as S, type TextField as T, type UserGenerics as U, type Viewports as V, type ExternalFieldWithAdaptor as W, type ExternalField as X, type CustomField as Y, type PuckContext as Z, type DefaultRootRenderProps as _, type Field as a, type WithId as a0, type WithPuckProps as a1, type AsFieldProps as a2, type WithChildren as a3, type ExtractPropsFromConfig as a4, type ExtractRootPropsFromConfig as a5, resolveAllData as a6, type Data as b, type UiState as c, type Plugin as d, type Overrides as e, type PuckAction as f, type InitialHistory as g, type DefaultComponentProps as h, type DefaultRootFieldProps as i, type ComponentData as j, type Fields as k, type ComponentConfig as l, type Direction as m, type DragAxis as n, type Viewport as o, overrideKeys as p, type OverrideKey as q, type FieldRenderFunctions as r, type ItemWithId as s, type ArrayState as t, type PuckComponent as u, type RootDataWithoutProps as v, type RootData as w, type MappedItem as x, type ComponentDataMap as y, type Content as z };
+type WalkTreeOptions = {
+    parentId: string;
+    propName: string;
+};
+declare function walkTree<T extends ComponentData | RootData | G["UserData"], UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(data: T, config: UserConfig, callbackFn: (data: Content, options: WalkTreeOptions) => Content | null | void): T;
+
+export { type ExternalFieldWithAdaptor as $, type AppState as A, type BaseData as B, type ComponentData as C, type DropZoneProps as D, type MappedItem as E, type Fields as F, type ComponentDataMap as G, type History as H, type IframeConfig as I, type Content as J, type BaseField as K, type TextareaField as L, type Metadata as M, type NumberField as N, type Overrides as O, type Permissions as P, type SelectField as Q, type RootDataWithProps as R, type Slot as S, type TextField as T, type UserGenerics as U, type Viewports as V, type WithSlotProps as W, type RadioField as X, type ArrayField as Y, type ObjectField as Z, type Adaptor as _, type Config as a, type ExternalField as a0, type CustomFieldRender as a1, type CustomField as a2, type SlotField as a3, type PuckContext as a4, type DefaultRootFieldProps as a5, type DefaultRootRenderProps as a6, type DefaultRootProps as a7, type DefaultComponentProps as a8, type WithId as a9, type WithPuckProps as aa, type AsFieldProps as ab, type WithChildren as ac, type ExtractPropsFromConfig as ad, type ExtractRootPropsFromConfig as ae, migrate as af, transformProps as ag, resolveAllData as ah, type PuckAction as b, type ResolveDataTrigger as c, type Plugin as d, type UiState as e, type ComponentConfig as f, type Field as g, type FieldProps as h, type Data as i, type OnAction as j, type InitialHistory as k, type ItemSelector as l, type Direction as m, type DragAxis as n, type Viewport as o, overrideKeys as p, type OverrideKey as q, type FieldRenderFunctions as r, type ItemWithId as s, type ArrayState as t, type PuckComponent as u, type RootConfig as v, walkTree as w, type RootDataWithoutProps as x, type RootData as y, type ComponentDataOptionalId as z };