@measured/puck 0.20.0-canary.93d525c5 → 0.20.0-canary.aee5fc96

package/dist/index.d.mts

@@ -1,8 +1,8 @@
-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, o as PluginInternal } from './walk-tree-CU8Fq-KC.mjs';
+export { a6 as Adaptor, a4 as ArrayField, E as ArrayState, aj as AsFieldProps, L as BaseData, _ as BaseField, Y as ComponentDataMap, T as ComponentDataOptionalId, Z as Content, aa as CustomField, a9 as CustomFieldRender, ag as DefaultComponentProps, ad as DefaultRootFieldProps, af as DefaultRootProps, ae as DefaultRootRenderProps, p as Direction, q as DragAxis, a8 as ExternalField, a7 as ExternalFieldWithAdaptor, an as ExtractField, al as ExtractPropsFromConfig, am as ExtractRootPropsFromConfig, z as FieldRenderFunctions, v as FieldTransformFn, u as FieldTransformFnParams, B as ItemWithId, X as MappedItem, a0 as NumberField, a5 as ObjectField, y as OverrideKey, J as PuckComponent, ac as PuckContext, a3 as RadioField, K as RootConfig, Q as RootData, N as RootDataWithoutProps, a2 as SelectField, S as Slot, G as SlotComponent, ab as SlotField, $ as TextField, a1 as TextareaField, s as Viewport, ak as WithChildren, ah as WithId, ai as WithPuckProps, W as WithSlotProps, m as migrate, x as overrideKeys, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-CU8Fq-KC.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
+import react__default, { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
 
 type HistorySlice<D = any> = {
     index: number;
@@ -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: {
@@ -207,6 +208,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
+    fieldTransforms?: FieldTransforms;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
@@ -225,6 +227,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     };
     initialHistory?: InitialHistory;
     metadata?: Metadata;
+    height?: CSSProperties["height"];
 };
 declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(props: PuckProps<UserConfig>): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
@@ -249,18 +252,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 +284,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 +303,12 @@ 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 };
+declare const blocksPlugin: () => Plugin;
+
+declare const fieldsPlugin: (params?: {
+    mobileOnly?: boolean;
+}) => PluginInternal;
+
+declare const outlinePlugin: () => Plugin;
+
+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, blocksPlugin, createUsePuck, fieldsPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-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, o as PluginInternal } from './walk-tree-CU8Fq-KC.js';
+export { a6 as Adaptor, a4 as ArrayField, E as ArrayState, aj as AsFieldProps, L as BaseData, _ as BaseField, Y as ComponentDataMap, T as ComponentDataOptionalId, Z as Content, aa as CustomField, a9 as CustomFieldRender, ag as DefaultComponentProps, ad as DefaultRootFieldProps, af as DefaultRootProps, ae as DefaultRootRenderProps, p as Direction, q as DragAxis, a8 as ExternalField, a7 as ExternalFieldWithAdaptor, an as ExtractField, al as ExtractPropsFromConfig, am as ExtractRootPropsFromConfig, z as FieldRenderFunctions, v as FieldTransformFn, u as FieldTransformFnParams, B as ItemWithId, X as MappedItem, a0 as NumberField, a5 as ObjectField, y as OverrideKey, J as PuckComponent, ac as PuckContext, a3 as RadioField, K as RootConfig, Q as RootData, N as RootDataWithoutProps, a2 as SelectField, S as Slot, G as SlotComponent, ab as SlotField, $ as TextField, a1 as TextareaField, s as Viewport, ak as WithChildren, ah as WithId, ai as WithPuckProps, W as WithSlotProps, m as migrate, x as overrideKeys, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-CU8Fq-KC.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
+import react__default, { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
 
 type HistorySlice<D = any> = {
     index: number;
@@ -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: {
@@ -207,6 +208,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     permissions?: Partial<Permissions>;
     plugins?: Plugin[];
     overrides?: Partial<Overrides>;
+    fieldTransforms?: FieldTransforms;
     renderHeader?: (props: {
         children: ReactNode;
         dispatch: (action: PuckAction) => void;
@@ -225,6 +227,7 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
     };
     initialHistory?: InitialHistory;
     metadata?: Metadata;
+    height?: CSSProperties["height"];
 };
 declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(props: PuckProps<UserConfig>): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
@@ -249,18 +252,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 +284,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 +303,12 @@ 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 };
+declare const blocksPlugin: () => Plugin;
+
+declare const fieldsPlugin: (params?: {
+    mobileOnly?: boolean;
+}) => PluginInternal;
+
+declare const outlinePlugin: () => Plugin;
+
+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, blocksPlugin, createUsePuck, fieldsPlugin, outlinePlugin, registerOverlayPortal, renderContext, setDeep, useGetPuck, usePuck };