@measured/puck 0.20.0-canary.f768aab9 → 0.20.1-canary.d7404af9

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { H as History, P as Permissions, C as ComponentData, a as Config, U as UserGenerics, F as Fields, b as PuckAction, R as RootDataWithProps, c as ResolveDataTrigger, d as Plugin, O as Overrides, V as Viewports, I as IframeConfig, e as UiState, f as ComponentConfig, A as AppState, M as Metadata, g as Field, h as FieldProps, D as DropZoneProps, i as Data, j as OnAction, k as InitialHistory, l as ItemSelector } from './walk-tree-BOSl1o0G.mjs';
-export { _ as Adaptor, Y as ArrayField, t as ArrayState, ab as AsFieldProps, B as BaseData, K as BaseField, G as ComponentDataMap, z as ComponentDataOptionalId, J as Content, a2 as CustomField, a1 as CustomFieldRender, a8 as DefaultComponentProps, a5 as DefaultRootFieldProps, a7 as DefaultRootProps, a6 as DefaultRootRenderProps, m as Direction, n as DragAxis, a0 as ExternalField, $ as ExternalFieldWithAdaptor, ad as ExtractPropsFromConfig, ae as ExtractRootPropsFromConfig, r as FieldRenderFunctions, s as ItemWithId, E as MappedItem, N as NumberField, Z as ObjectField, q as OverrideKey, u as PuckComponent, a4 as PuckContext, X as RadioField, v as RootConfig, y as RootData, x as RootDataWithoutProps, Q as SelectField, S as Slot, a3 as SlotField, T as TextField, L as TextareaField, o as Viewport, ac as WithChildren, a9 as WithId, aa as WithPuckProps, W as WithSlotProps, af as migrate, p as overrideKeys, ah as resolveAllData, ag as transformProps, w as walkTree } from './walk-tree-BOSl1o0G.mjs';
+import { H as History, P as Permissions, a as ComponentData, C as Config, U as UserGenerics, F as Fields, b as PuckAction, R as RootDataWithProps, c as ResolveDataTrigger, d as Plugin, O as Overrides, V as Viewports, I as IframeConfig, e as UiState, f as ComponentConfig, A as AppState, M as Metadata, g as FieldTransforms, h as Field, i as FieldProps, D as DropZoneProps, j as Data, k as OnAction, l as InitialHistory, n as ItemSelector } from './walk-tree-CiAkCQEp.mjs';
+export { a7 as Adaptor, a5 as ArrayField, B as ArrayState, ak as AsFieldProps, N as BaseData, $ as BaseField, Z as ComponentDataMap, X as ComponentDataOptionalId, _ as Content, ab as CustomField, aa as CustomFieldRender, ah as DefaultComponentProps, K as DefaultComponents, ae as DefaultRootFieldProps, ag as DefaultRootProps, af as DefaultRootRenderProps, o as Direction, p as DragAxis, a9 as ExternalField, a8 as ExternalFieldWithAdaptor, L as ExtractConfigParams, am as ExtractField, y as FieldRenderFunctions, u as FieldTransformFn, s as FieldTransformFnParams, z as ItemWithId, Y as MappedItem, a1 as NumberField, a6 as ObjectField, x as OverrideKey, G as PuckComponent, ad as PuckContext, a4 as RadioField, J as RootConfig, T as RootData, Q as RootDataWithoutProps, a3 as SelectField, S as Slot, E as SlotComponent, ac as SlotField, a0 as TextField, a2 as TextareaField, q as Viewport, al as WithChildren, ai as WithId, aj as WithPuckProps, W as WithSlotProps, m as migrate, v as overrideKeys, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-CiAkCQEp.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
@@ -105,6 +105,7 @@ type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserCon
     history: HistorySlice;
     nodes: NodesSlice;
     permissions: PermissionsSlice;
+    fieldTransforms: FieldTransforms;
 };
 
 declare const ActionBar: {
@@ -205,8 +206,9 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     onPublish?: (data: G["UserData"]) => void;
     onAction?: OnAction<G["UserData"]>;
     permissions?: Partial<Permissions>;
-    plugins?: Plugin[];
-    overrides?: Partial<Overrides>;
+    plugins?: Plugin<UserConfig>[];
+    overrides?: Partial<Overrides<UserConfig>>;
+    fieldTransforms?: FieldTransforms<UserConfig>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
@@ -249,18 +251,25 @@ declare function Render<UserConfig extends Config = Config, G extends UserGeneri
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-type WithGet<T> = T & {
-    get: () => T;
-};
+declare const registerOverlayPortal: (el: HTMLElement | null | undefined, opts?: {
+    disableDrag?: boolean;
+    disableDragOnFocus?: boolean;
+}) => (() => void) | undefined;
+
+/**
+ * Helper function to set a value based on a dot-notated path
+ */
+declare function setDeep<T extends Record<string, any>>(node: T, path: string, newVal: any): T;
+
 type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
-    appState: AppState;
+    appState: G["UserPublicAppState"];
     config: UserConfig;
     dispatch: AppStore["dispatch"];
     getPermissions: GetPermissions<UserConfig>;
     refreshPermissions: RefreshPermissions<UserConfig>;
     selectedItem: G["UserComponentData"] | null;
-    getItemBySelector: (selector: ItemSelector) => ComponentData | undefined;
-    getItemById: (id: string) => ComponentData | undefined;
+    getItemBySelector: (selector: ItemSelector) => G["UserComponentData"] | undefined;
+    getItemById: (id: string) => G["UserComponentData"] | undefined;
     getSelectorForId: (id: string) => Required<ItemSelector> | undefined;
     history: {
         back: HistorySlice["back"];
@@ -274,7 +283,7 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
     };
 };
 type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
-type UsePuckStore<UserConfig extends Config = Config> = WithGet<PuckApi<UserConfig>>;
+type UsePuckStore<UserConfig extends Config = Config> = PuckApi<UserConfig>;
 /**
  * createUsePuck
  *
@@ -293,4 +302,4 @@ declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<Use
  */
 declare function useGetPuck(): () => UsePuckStore<Config>;
 
-export { Action, ActionBar, AppState, AutoField, Button, ComponentConfig, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, Fields, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, renderContext, useGetPuck, usePuck };
+export { Action, ActionBar, AppState, AutoField, Button, ComponentConfig, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Fields, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { H as History, P as Permissions, C as ComponentData, a as Config, U as UserGenerics, F as Fields, b as PuckAction, R as RootDataWithProps, c as ResolveDataTrigger, d as Plugin, O as Overrides, V as Viewports, I as IframeConfig, e as UiState, f as ComponentConfig, A as AppState, M as Metadata, g as Field, h as FieldProps, D as DropZoneProps, i as Data, j as OnAction, k as InitialHistory, l as ItemSelector } from './walk-tree-BOSl1o0G.js';
-export { _ as Adaptor, Y as ArrayField, t as ArrayState, ab as AsFieldProps, B as BaseData, K as BaseField, G as ComponentDataMap, z as ComponentDataOptionalId, J as Content, a2 as CustomField, a1 as CustomFieldRender, a8 as DefaultComponentProps, a5 as DefaultRootFieldProps, a7 as DefaultRootProps, a6 as DefaultRootRenderProps, m as Direction, n as DragAxis, a0 as ExternalField, $ as ExternalFieldWithAdaptor, ad as ExtractPropsFromConfig, ae as ExtractRootPropsFromConfig, r as FieldRenderFunctions, s as ItemWithId, E as MappedItem, N as NumberField, Z as ObjectField, q as OverrideKey, u as PuckComponent, a4 as PuckContext, X as RadioField, v as RootConfig, y as RootData, x as RootDataWithoutProps, Q as SelectField, S as Slot, a3 as SlotField, T as TextField, L as TextareaField, o as Viewport, ac as WithChildren, a9 as WithId, aa as WithPuckProps, W as WithSlotProps, af as migrate, p as overrideKeys, ah as resolveAllData, ag as transformProps, w as walkTree } from './walk-tree-BOSl1o0G.js';
+import { H as History, P as Permissions, a as ComponentData, C as Config, U as UserGenerics, F as Fields, b as PuckAction, R as RootDataWithProps, c as ResolveDataTrigger, d as Plugin, O as Overrides, V as Viewports, I as IframeConfig, e as UiState, f as ComponentConfig, A as AppState, M as Metadata, g as FieldTransforms, h as Field, i as FieldProps, D as DropZoneProps, j as Data, k as OnAction, l as InitialHistory, n as ItemSelector } from './walk-tree-CiAkCQEp.js';
+export { a7 as Adaptor, a5 as ArrayField, B as ArrayState, ak as AsFieldProps, N as BaseData, $ as BaseField, Z as ComponentDataMap, X as ComponentDataOptionalId, _ as Content, ab as CustomField, aa as CustomFieldRender, ah as DefaultComponentProps, K as DefaultComponents, ae as DefaultRootFieldProps, ag as DefaultRootProps, af as DefaultRootRenderProps, o as Direction, p as DragAxis, a9 as ExternalField, a8 as ExternalFieldWithAdaptor, L as ExtractConfigParams, am as ExtractField, y as FieldRenderFunctions, u as FieldTransformFn, s as FieldTransformFnParams, z as ItemWithId, Y as MappedItem, a1 as NumberField, a6 as ObjectField, x as OverrideKey, G as PuckComponent, ad as PuckContext, a4 as RadioField, J as RootConfig, T as RootData, Q as RootDataWithoutProps, a3 as SelectField, S as Slot, E as SlotComponent, ac as SlotField, a0 as TextField, a2 as TextareaField, q as Viewport, al as WithChildren, ai as WithId, aj as WithPuckProps, W as WithSlotProps, m as migrate, v as overrideKeys, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-CiAkCQEp.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
@@ -105,6 +105,7 @@ type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserCon
     history: HistorySlice;
     nodes: NodesSlice;
     permissions: PermissionsSlice;
+    fieldTransforms: FieldTransforms;
 };
 
 declare const ActionBar: {
@@ -205,8 +206,9 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     onPublish?: (data: G["UserData"]) => void;
     onAction?: OnAction<G["UserData"]>;
     permissions?: Partial<Permissions>;
-    plugins?: Plugin[];
-    overrides?: Partial<Overrides>;
+    plugins?: Plugin<UserConfig>[];
+    overrides?: Partial<Overrides<UserConfig>>;
+    fieldTransforms?: FieldTransforms<UserConfig>;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
@@ -249,18 +251,25 @@ declare function Render<UserConfig extends Config = Config, G extends UserGeneri
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-type WithGet<T> = T & {
-    get: () => T;
-};
+declare const registerOverlayPortal: (el: HTMLElement | null | undefined, opts?: {
+    disableDrag?: boolean;
+    disableDragOnFocus?: boolean;
+}) => (() => void) | undefined;
+
+/**
+ * Helper function to set a value based on a dot-notated path
+ */
+declare function setDeep<T extends Record<string, any>>(node: T, path: string, newVal: any): T;
+
 type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
-    appState: AppState;
+    appState: G["UserPublicAppState"];
     config: UserConfig;
     dispatch: AppStore["dispatch"];
     getPermissions: GetPermissions<UserConfig>;
     refreshPermissions: RefreshPermissions<UserConfig>;
     selectedItem: G["UserComponentData"] | null;
-    getItemBySelector: (selector: ItemSelector) => ComponentData | undefined;
-    getItemById: (id: string) => ComponentData | undefined;
+    getItemBySelector: (selector: ItemSelector) => G["UserComponentData"] | undefined;
+    getItemById: (id: string) => G["UserComponentData"] | undefined;
     getSelectorForId: (id: string) => Required<ItemSelector> | undefined;
     history: {
         back: HistorySlice["back"];
@@ -274,7 +283,7 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
     };
 };
 type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
-type UsePuckStore<UserConfig extends Config = Config> = WithGet<PuckApi<UserConfig>>;
+type UsePuckStore<UserConfig extends Config = Config> = PuckApi<UserConfig>;
 /**
  * createUsePuck
  *
@@ -293,4 +302,4 @@ declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<Use
  */
 declare function useGetPuck(): () => UsePuckStore<Config>;
 
-export { Action, ActionBar, AppState, AutoField, Button, ComponentConfig, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, Fields, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, renderContext, useGetPuck, usePuck };
+export { Action, ActionBar, AppState, AutoField, Button, ComponentConfig, ComponentData, Config, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, FieldTransforms, Fields, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };