@measured/puck 0.19.0-canary.f96dc87b → 0.19.0-canary.fb0e8e24

package/dist/index.d.ts

@@ -1,9 +1,109 @@
-import { F as FieldProps, a as Field, D as DropZoneProps, C as Config, U as UserGenerics, b as Data, c as UiState, O as OnAction, P as Permissions, d as Plugin, e as Overrides, f as PuckAction, V as Viewports, I as IframeConfig, g as InitialHistory, M as Metadata, H as History, h as ComponentData, i as Fields, A as AppState, j as ComponentConfig } from './resolve-all-data-3XjIPfNh.js';
-export { K as Adaptor, G as ArrayField, r as ArrayState, a2 as AsFieldProps, B as BaseData, y as BaseField, w as ComponentDataMap, x as Content, W as CustomField, $ as DefaultComponentProps, Y as DefaultRootFieldProps, _ as DefaultRootProps, Z as DefaultRootRenderProps, k as Direction, l as DragAxis, Q as ExternalField, L as ExternalFieldWithAdaptor, a4 as ExtractPropsFromConfig, a5 as ExtractRootPropsFromConfig, p as FieldRenderFunctions, q as ItemWithId, v as MappedItem, N as NumberField, J as ObjectField, n as OverrideKey, s as PuckComponent, X as PuckContext, E as RadioField, u as RootData, R as RootDataWithProps, t as RootDataWithoutProps, S as SelectField, T as TextField, z as TextareaField, m as Viewport, a3 as WithChildren, a0 as WithId, a1 as WithPuckProps, o as overrideKeys, a7 as resolveAllData, a6 as transformProps } from './resolve-all-data-3XjIPfNh.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-CM-cu7GU.js';
+export { Z as Adaptor, X as ArrayField, t as ArrayState, aa as AsFieldProps, B as BaseData, K as BaseField, G as ComponentDataMap, z as ComponentDataOptionalId, J as Content, a1 as CustomField, a0 as CustomFieldRender, a7 as DefaultComponentProps, a4 as DefaultRootFieldProps, a6 as DefaultRootProps, a5 as DefaultRootRenderProps, m as Direction, n as DragAxis, $ as ExternalField, _ as ExternalFieldWithAdaptor, ac as ExtractPropsFromConfig, ad as ExtractRootPropsFromConfig, r as FieldRenderFunctions, s as ItemWithId, E as MappedItem, N as NumberField, Y as ObjectField, q as OverrideKey, u as PuckComponent, a3 as PuckContext, W as RadioField, v as RootConfig, y as RootData, x as RootDataWithoutProps, Q as SelectField, S as Slot, a2 as SlotField, T as TextField, L as TextareaField, o as Viewport, ab as WithChildren, a8 as WithId, a9 as WithPuckProps, p as overrideKeys, af as resolveAllData, ae as transformProps, w as walkTree } from './walk-tree-CM-cu7GU.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, SyntheticEvent, ReactElement } from 'react';
 
+type HistorySlice<D = any> = {
+    index: number;
+    hasPast: () => boolean;
+    hasFuture: () => boolean;
+    histories: History<D>[];
+    record: (data: D) => void;
+    back: VoidFunction;
+    forward: VoidFunction;
+    currentHistory: () => History;
+    nextHistory: () => History<D> | null;
+    prevHistory: () => History<D> | null;
+    setHistories: (histories: History[]) => void;
+    setHistoryIndex: (index: number) => void;
+    initialAppState: D;
+};
+
+type NodeMethods = {
+    sync: () => void;
+};
+type PuckNodeInstance = {
+    id: string;
+    methods: NodeMethods;
+    element: HTMLElement | null;
+};
+type NodesSlice = {
+    nodes: Record<string, PuckNodeInstance | undefined>;
+    registerNode: (id: string, node: Partial<PuckNodeInstance>) => void;
+    unregisterNode: (id: string, node?: Partial<PuckNodeInstance>) => void;
+};
+
+type PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    item?: G["UserComponentData"] | null;
+    type?: keyof G["UserProps"];
+    root?: boolean;
+};
+type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Permissions;
+type ResolvePermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
+type Cache = Record<string, {
+    lastPermissions: Partial<Permissions>;
+    lastData: ComponentData | null;
+}>;
+type PermissionsSlice = {
+    cache: Cache;
+    globalPermissions: Permissions;
+    resolvedPermissions: Record<string, Partial<Permissions> | undefined>;
+    getPermissions: GetPermissions<Config>;
+    resolvePermissions: ResolvePermissions<Config>;
+    refreshPermissions: RefreshPermissions<Config>;
+};
+
+type ComponentOrRootData = Omit<ComponentData<any>, "type">;
+type FieldsSlice = {
+    fields: Fields | Partial<Fields>;
+    loading: boolean;
+    lastResolvedData: Partial<ComponentOrRootData>;
+};
+
+type Status = "LOADING" | "MOUNTED" | "READY";
+type ZoomConfig = {
+    autoZoom: number;
+    rootHeight: number;
+    zoom: number;
+};
+type ComponentState = Record<string, {
+    loadingCount: number;
+}>;
+type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    state: G["UserAppState"];
+    dispatch: (action: PuckAction) => void;
+    config: UserConfig;
+    componentState: ComponentState;
+    setComponentState: (componentState: ComponentState) => void;
+    setComponentLoading: (id: string, loading?: boolean, defer?: number) => () => void;
+    unsetComponentLoading: (id: string) => void;
+    pendingLoadTimeouts: Record<string, NodeJS.Timeout>;
+    resolveComponentData: <T extends ComponentData | RootDataWithProps>(componentData: T, trigger: ResolveDataTrigger) => Promise<{
+        node: T;
+        didChange: boolean;
+    }>;
+    resolveAndCommitData: () => void;
+    plugins: Plugin[];
+    overrides: Partial<Overrides>;
+    viewports: Viewports;
+    zoomConfig: ZoomConfig;
+    setZoomConfig: (zoomConfig: ZoomConfig) => void;
+    status: Status;
+    setStatus: (status: Status) => void;
+    iframe: IframeConfig;
+    selectedItem?: G["UserData"]["content"][0] | null;
+    setUi: (ui: Partial<UiState>, recordHistory?: boolean) => void;
+    getComponentConfig: (type?: string) => ComponentConfig | null | undefined;
+    onAction?: (action: PuckAction, newState: AppState, state: AppState) => void;
+    metadata: Metadata;
+    fields: FieldsSlice;
+    history: HistorySlice;
+    nodes: NodesSlice;
+    permissions: PermissionsSlice;
+};
+
 declare const ActionBar: {
     ({ label, children, }: {
         label?: string;
@@ -42,7 +142,7 @@ declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }:
     className?: string;
 }) => react_jsx_runtime.JSX.Element;
 type FieldNoLabel<Props extends any = any> = Omit<Field<Props>, "label">;
-declare function AutoField<ValueType = any, FieldType extends FieldNoLabel<ValueType> = FieldNoLabel<ValueType>>(props: FieldProps<FieldType, ValueType>): react_jsx_runtime.JSX.Element;
+declare function AutoField<ValueType = any, FieldType extends FieldNoLabel<ValueType> = FieldNoLabel<ValueType>>(props: FieldProps<FieldType, ValueType>): react_jsx_runtime.JSX.Element | null;
 
 declare const Button: ({ children, href, onClick, variant, type, disabled, tabIndex, newTab, fullWidth, icon, size, loading: loadingProp, ...props }: {
     children: ReactNode;
@@ -146,119 +246,21 @@ declare function Render<UserConfig extends Config = Config, G extends UserGeneri
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-declare function migrate(data: Data): Data;
-
-type HistorySlice<D = any> = {
-    index: number;
-    hasPast: () => boolean;
-    hasFuture: () => boolean;
-    histories: History<D>[];
-    record: (data: D) => void;
-    back: VoidFunction;
-    forward: VoidFunction;
-    currentHistory: () => History;
-    nextHistory: () => History<D> | null;
-    prevHistory: () => History<D> | null;
-    setHistories: (histories: History[]) => void;
-    setHistoryIndex: (index: number) => void;
-    initialAppState: D;
-};
-
-type NodeMethods = {
-    sync: () => void;
-};
-type PuckNode = {
-    id: string;
-    methods: NodeMethods;
-    data: ComponentData;
-    parentId: string | null;
-    zone: string;
-    path: string[];
-    index: number;
-    element: HTMLElement | null;
-};
-type NodesSlice = {
-    nodes: Record<string, PuckNode | undefined>;
-    registerNode: (id: string, node: Partial<PuckNode>) => void;
-    unregisterNode: (id: string, node?: Partial<PuckNode>) => void;
-};
-
-type PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
-    item?: G["UserComponentData"] | null;
-    type?: keyof G["UserProps"];
-    root?: boolean;
-};
-type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Permissions;
-type ResolvePermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
-type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
-type Cache = Record<string, {
-    lastPermissions: Partial<Permissions>;
-    lastData: ComponentData | null;
-}>;
-type PermissionsSlice = {
-    cache: Cache;
-    globalPermissions: Permissions;
-    resolvedPermissions: Record<string, Partial<Permissions> | undefined>;
-    getPermissions: GetPermissions<Config>;
-    resolvePermissions: ResolvePermissions<Config>;
-    refreshPermissions: RefreshPermissions<Config>;
-};
-
-type ComponentOrRootData = Omit<ComponentData<any>, "type">;
-type FieldsSlice = {
-    fields: Fields | Partial<Fields>;
-    loading: boolean;
-    lastResolvedData: Partial<ComponentOrRootData>;
-};
-
-type Status = "LOADING" | "MOUNTED" | "READY";
-type ZoomConfig = {
-    autoZoom: number;
-    rootHeight: number;
-    zoom: number;
-};
-type ComponentState = Record<string, {
-    loadingCount: number;
-}>;
-type AppStore<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
-    state: G["UserAppState"];
-    dispatch: (action: PuckAction) => void;
-    config: UserConfig;
-    componentState: ComponentState;
-    setComponentState: (componentState: ComponentState) => void;
-    setComponentLoading: (id: string) => void;
-    unsetComponentLoading: (id: string) => void;
-    resolveDataRuns: number;
-    resolveData: (newAppState: AppState) => void;
-    plugins: Plugin[];
-    overrides: Partial<Overrides>;
-    viewports: Viewports;
-    zoomConfig: ZoomConfig;
-    setZoomConfig: (zoomConfig: ZoomConfig) => void;
-    status: Status;
-    setStatus: (status: Status) => void;
-    iframe: IframeConfig;
-    selectedItem?: G["UserData"]["content"][0] | null;
-    setUi: (ui: Partial<UiState>, recordHistory?: boolean) => void;
-    getComponentConfig: (type?: string) => ComponentConfig | null | undefined;
-    onAction?: (action: PuckAction, newState: AppState, state: AppState) => void;
-    metadata: Metadata;
-    fields: FieldsSlice;
-    history: HistorySlice;
-    nodes: NodesSlice;
-    permissions: PermissionsSlice;
-};
+declare function migrate(data: Data, config?: Config): 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"];
@@ -270,7 +272,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
  *
@@ -280,7 +283,7 @@ 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>;
 
-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, 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, migrate, renderContext, usePuck };