@measured/puck 0.19.0-canary.32a6f78 → 0.19.0-canary.4b545576

package/dist/index.d.ts

@@ -1,8 +1,108 @@
-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 DefaultComponentProps, i as DefaultRootFieldProps, H as History, A as AppState, E as ExtractPropsFromConfig, j as ExtractRootPropsFromConfig, k as ComponentDataMap } from './resolve-all-data-D43Z4niC.js';
-export { W as Adaptor, L as ArrayField, s as ArrayState, a4 as AsFieldProps, B as BaseData, G as BaseField, u as ComponentConfig, x as ComponentData, z as Content, Z as CustomField, a1 as DefaultRootProps, a0 as DefaultRootRenderProps, l as Direction, m as DragAxis, Y as ExternalField, X as ExternalFieldWithAdaptor, q as FieldRenderFunctions, _ as Fields, r as ItemWithId, y as MappedItem, N as NumberField, Q as ObjectField, p as OverrideKey, t as PuckComponent, $ as PuckContext, K as RadioField, w as RootData, R as RootDataWithProps, v as RootDataWithoutProps, S as SelectField, T as TextField, J as TextareaField, n as Viewport, a5 as WithChildren, a2 as WithId, a3 as WithPuckProps, o as overrideKeys, a6 as resolveAllData } from './resolve-all-data-D43Z4niC.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 RootData, m as Content, n as ItemSelector } from './resolve-all-data-BFRAghCj.js';
+export { X as Adaptor, Q as ArrayField, v as ArrayState, a7 as AsFieldProps, B as BaseData, G as BaseField, E as ComponentDataMap, _ as CustomField, a4 as DefaultComponentProps, a1 as DefaultRootFieldProps, a3 as DefaultRootProps, a2 as DefaultRootRenderProps, o as Direction, p as DragAxis, Z as ExternalField, Y as ExternalFieldWithAdaptor, a9 as ExtractPropsFromConfig, aa as ExtractRootPropsFromConfig, t as FieldRenderFunctions, u as ItemWithId, z as MappedItem, N as NumberField, W as ObjectField, s as OverrideKey, w as PuckComponent, a0 as PuckContext, L as RadioField, x as RootConfig, y as RootDataWithoutProps, K as SelectField, S as Slot, $ as SlotField, T as TextField, J as TextareaField, q as Viewport, a8 as WithChildren, a5 as WithId, a6 as WithPuckProps, r as overrideKeys, ac as resolveAllData, ab as transformProps } from './resolve-all-data-BFRAghCj.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { ReactNode, SyntheticEvent, ReactElement } 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, }: {
@@ -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;
@@ -93,7 +193,7 @@ declare const IconButton: ({ children, href, onClick, variant, type, disabled, t
     title: string;
 }) => react_jsx_runtime.JSX.Element;
 
-declare function Puck<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ children, config, data: initialData, ui: initialUi, onChange, onPublish, onAction, permissions, plugins, overrides, renderHeader, renderHeaderActions, headerTitle, headerPath, viewports, iframe: _iframe, dnd, initialHistory: _initialHistory, metadata, }: {
+type PuckProps<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
     children?: ReactNode;
     config: UserConfig;
     data: Partial<G["UserData"] | Data>;
@@ -122,7 +222,8 @@ declare function Puck<UserConfig extends Config = Config, G extends UserGenerics
     };
     initialHistory?: InitialHistory;
     metadata?: Metadata;
-}): react_jsx_runtime.JSX.Element;
+};
+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 }: {
@@ -134,66 +235,61 @@ declare namespace Puck {
     }) => react_jsx_runtime.JSX.Element;
 }
 
+declare const renderContext: react__default.Context<{
+    config: Config;
+    data: Data;
+    metadata: Metadata;
+}>;
 declare function Render<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>({ config, data, metadata, }: {
     config: UserConfig;
     data: Partial<G["UserData"] | Data>;
     metadata?: Metadata;
 }): react_jsx_runtime.JSX.Element;
 
-declare function migrate(data: Data): 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>): Data;
+declare function migrate(data: Data, config?: Config): Data;
 
-type HistoryStore<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;
+type MapSlotOptions = {
+    parentId: string;
+    propName: string;
 };
+declare function mapSlotsPublic<T extends ComponentData | RootData>(item: T, config: Config, map: (data: Content, options: MapSlotOptions) => Content): T;
 
-type PermissionsArgs<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
-    item?: G["UserComponentData"];
-    type?: keyof G["UserProps"];
-    root?: boolean;
+type WithGet<T> = T & {
+    get: () => T;
 };
-type GetPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>) => Partial<Permissions>;
-type RefreshPermissions<UserConfig extends Config = Config> = (params?: PermissionsArgs<UserConfig>, force?: boolean) => void;
-
-declare const usePuck: <UserConfig extends Config = Config>() => {
-    appState: AppState<Data<ExtractPropsFromConfig<UserConfig>, ExtractRootPropsFromConfig<UserConfig>>>;
-    config: UserConfig;
-    dispatch: (action: PuckAction) => void;
+type UsePuckData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    appState: AppState;
+    config: Config;
+    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: VoidFunction;
-        forward: VoidFunction;
-        setHistories: (histories: History[]) => void;
-        setHistoryIndex: (index: number) => void;
+        back: HistorySlice["back"];
+        forward: HistorySlice["forward"];
+        setHistories: HistorySlice["setHistories"];
+        setHistoryIndex: HistorySlice["setHistoryIndex"];
+        histories: HistorySlice["histories"];
+        index: HistorySlice["index"];
         hasPast: boolean;
         hasFuture: boolean;
-        histories: History<any>[];
-        index: number;
-        historyStore: HistoryStore | undefined;
     };
-    selectedItem: ComponentDataMap<ExtractPropsFromConfig<UserConfig>> | null;
 };
+type PuckApi<UserConfig extends Config = Config> = UsePuckData<UserConfig>;
+type UsePuckStore<UserConfig extends Config = Config> = WithGet<PuckApi<UserConfig>>;
+/**
+ * createUsePuck
+ *
+ * Create a typed usePuck hook, which is necessary because the user may provide a generic type but not
+ * a selector type, and TS does not currently support partial inference.
+ * Related: https://github.com/microsoft/TypeScript/issues/26242
+ *
+ * @returns a typed usePuck function
+ */
+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, ComponentDataMap, Config, Data, DefaultComponentProps, DefaultRootFieldProps, Drawer, DropZone, ExtractPropsFromConfig, ExtractRootPropsFromConfig, Field, FieldLabel, FieldProps, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, Render, UiState, UserGenerics, Viewports, migrate, transformProps, usePuck };
+export { Action, ActionBar, AppState, AutoField, Button, ComponentConfig, ComponentData, Config, Content, Data, Drawer, DropZone, Field, FieldLabel, FieldProps, Fields, Group, History, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, Permissions, Plugin, Puck, PuckAction, type PuckApi, Render, ResolveDataTrigger, RootData, RootDataWithProps, UiState, type UsePuckData, UserGenerics, Viewports, createUsePuck, mapSlotsPublic as mapSlots, migrate, renderContext, usePuck };