@measured/puck 0.19.0-canary.896a6279 → 0.19.0-canary.8e1d7223

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { H as History, C as Config, P as Permissions, U as UserGenerics, a as ComponentData, 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 FieldProps, h as Field, D as DropZoneProps, i as Data, j as OnAction, k as InitialHistory } from './resolve-all-data-Cs8PfTrg.mjs';
-export { W as Adaptor, L as ArrayField, s as ArrayState, a6 as AsFieldProps, B as BaseData, E as BaseField, y as ComponentDataMap, z as Content, Z as CustomField, a3 as DefaultComponentProps, a0 as DefaultRootFieldProps, a2 as DefaultRootProps, a1 as DefaultRootRenderProps, l as Direction, m as DragAxis, Y as ExternalField, X as ExternalFieldWithAdaptor, a8 as ExtractPropsFromConfig, a9 as ExtractRootPropsFromConfig, q as FieldRenderFunctions, r as ItemWithId, x as MappedItem, N as NumberField, Q as ObjectField, p as OverrideKey, t as PuckComponent, $ as PuckContext, K as RadioField, u as RootConfig, w as RootData, v as RootDataWithoutProps, J as SelectField, S as Slot, _ as SlotField, T as TextField, G as TextareaField, n as Viewport, a7 as WithChildren, a4 as WithId, a5 as WithPuckProps, o as overrideKeys, ab as resolveAllData, aa as transformProps } from './resolve-all-data-Cs8PfTrg.mjs';
+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-DBd3aQ_5.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-DBd3aQ_5.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
@@ -22,6 +22,8 @@ type HistorySlice<D = any> = {
 
 type NodeMethods = {
     sync: () => void;
+    hideOverlay: () => void;
+    showOverlay: () => void;
 };
 type PuckNodeInstance = {
     id: string;
@@ -60,6 +62,7 @@ type FieldsSlice = {
     fields: Fields | Partial<Fields>;
     loading: boolean;
     lastResolvedData: Partial<ComponentOrRootData>;
+    id: string | undefined;
 };
 
 type Status = "LOADING" | "MOUNTED" | "READY";
@@ -226,9 +229,9 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
 declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(props: PuckProps<UserConfig>): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
     var Components: () => react_jsx_runtime.JSX.Element;
-    var Fields: ({ wrapFields }: {
+    var Fields: react.MemoExoticComponent<({ wrapFields }: {
         wrapFields?: boolean;
-    }) => react_jsx_runtime.JSX.Element;
+    }) => react_jsx_runtime.JSX.Element>;
     var Outline: () => react_jsx_runtime.JSX.Element;
     var Preview: ({ id }: {
         id?: string;
@@ -246,18 +249,19 @@ declare function Render<UserConfig extends Config = Config, G extends UserGeneri
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-declare function migrate(data: Data): Data;
-
 type WithGet<T> = T & {
     get: () => T;
 };
 type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
     appState: AppState;
-    config: Config;
+    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;
+    getSelectorForId: (id: string) => Required<ItemSelector> | undefined;
     history: {
         back: HistorySlice["back"];
         forward: HistorySlice["forward"];
@@ -269,7 +273,8 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
         hasFuture: boolean;
     };
 };
-type UsePuckStore<UserConfig extends Config = Config> = WithGet<UsePuckData<UserConfig>>;
+type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
+type UsePuckStore<UserConfig extends Config = Config> = WithGet<PuckApi<UserConfig>>;
 /**
  * createUsePuck
  *
@@ -279,7 +284,13 @@ type UsePuckStore<UserConfig extends Config = Config> = WithGet<UsePuckData<User
  *
  * @returns a typed usePuck function
  */
-declare function createUsePuck<UserConfig extends Config = Config>(): <T = UsePuckData<UserConfig, UserGenerics<UserConfig>>>(selector: (state: UsePuckStore<UserConfig>) => T) => T;
+declare function createUsePuck<UserConfig extends Config = Config>(): <T = PuckApi<UserConfig>>(selector: (state: UsePuckStore<UserConfig>) => T) => T;
 declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<UserConfig>;
+/**
+ * Get the latest state without relying on a render
+ *
+ * @returns PuckApi
+ */
+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, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, migrate, renderContext, usePuck };
+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 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { H as History, C as Config, P as Permissions, U as UserGenerics, a as ComponentData, 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 FieldProps, h as Field, D as DropZoneProps, i as Data, j as OnAction, k as InitialHistory } from './resolve-all-data-Cs8PfTrg.js';
-export { W as Adaptor, L as ArrayField, s as ArrayState, a6 as AsFieldProps, B as BaseData, E as BaseField, y as ComponentDataMap, z as Content, Z as CustomField, a3 as DefaultComponentProps, a0 as DefaultRootFieldProps, a2 as DefaultRootProps, a1 as DefaultRootRenderProps, l as Direction, m as DragAxis, Y as ExternalField, X as ExternalFieldWithAdaptor, a8 as ExtractPropsFromConfig, a9 as ExtractRootPropsFromConfig, q as FieldRenderFunctions, r as ItemWithId, x as MappedItem, N as NumberField, Q as ObjectField, p as OverrideKey, t as PuckComponent, $ as PuckContext, K as RadioField, u as RootConfig, w as RootData, v as RootDataWithoutProps, J as SelectField, S as Slot, _ as SlotField, T as TextField, G as TextareaField, n as Viewport, a7 as WithChildren, a4 as WithId, a5 as WithPuckProps, o as overrideKeys, ab as resolveAllData, aa as transformProps } from './resolve-all-data-Cs8PfTrg.js';
+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-DBd3aQ_5.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-DBd3aQ_5.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
@@ -22,6 +22,8 @@ type HistorySlice<D = any> = {
 
 type NodeMethods = {
     sync: () => void;
+    hideOverlay: () => void;
+    showOverlay: () => void;
 };
 type PuckNodeInstance = {
     id: string;
@@ -60,6 +62,7 @@ type FieldsSlice = {
     fields: Fields | Partial<Fields>;
     loading: boolean;
     lastResolvedData: Partial<ComponentOrRootData>;
+    id: string | undefined;
 };
 
 type Status = "LOADING" | "MOUNTED" | "READY";
@@ -226,9 +229,9 @@ type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserCo
 declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(props: PuckProps<UserConfig>): react_jsx_runtime.JSX.Element;
 declare namespace Puck {
     var Components: () => react_jsx_runtime.JSX.Element;
-    var Fields: ({ wrapFields }: {
+    var Fields: react.MemoExoticComponent<({ wrapFields }: {
         wrapFields?: boolean;
-    }) => react_jsx_runtime.JSX.Element;
+    }) => react_jsx_runtime.JSX.Element>;
     var Outline: () => react_jsx_runtime.JSX.Element;
     var Preview: ({ id }: {
         id?: string;
@@ -246,18 +249,19 @@ declare function Render<UserConfig extends Config = Config, G extends UserGeneri
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-declare function migrate(data: Data): Data;
-
 type WithGet<T> = T & {
     get: () => T;
 };
 type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
     appState: AppState;
-    config: Config;
+    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;
+    getSelectorForId: (id: string) => Required<ItemSelector> | undefined;
     history: {
         back: HistorySlice["back"];
         forward: HistorySlice["forward"];
@@ -269,7 +273,8 @@ type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<User
         hasFuture: boolean;
     };
 };
-type UsePuckStore<UserConfig extends Config = Config> = WithGet<UsePuckData<UserConfig>>;
+type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
+type UsePuckStore<UserConfig extends Config = Config> = WithGet<PuckApi<UserConfig>>;
 /**
  * createUsePuck
  *
@@ -279,7 +284,13 @@ type UsePuckStore<UserConfig extends Config = Config> = WithGet<UsePuckData<User
  *
  * @returns a typed usePuck function
  */
-declare function createUsePuck<UserConfig extends Config = Config>(): <T = UsePuckData<UserConfig, UserGenerics<UserConfig>>>(selector: (state: UsePuckStore<UserConfig>) => T) => T;
+declare function createUsePuck<UserConfig extends Config = Config>(): <T = PuckApi<UserConfig>>(selector: (state: UsePuckStore<UserConfig>) => T) => T;
 declare function usePuck<UserConfig extends Config = Config>(): UsePuckStore<UserConfig>;
+/**
+ * Get the latest state without relying on a render
+ *
+ * @returns PuckApi
+ */
+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, Render, ResolveDataTrigger, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, migrate, renderContext, usePuck };
+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 };