@measured/puck 0.16.0-canary.7cac376 → 0.16.0-canary.88c5ab6

package/dist/actions-DDAd8cys.d.mts

@@ -0,0 +1,418 @@
+import { CSSProperties, ReactElement, ReactNode } from 'react';
+
+type ItemSelector = {
+    index: number;
+    zone?: string;
+};
+
+type DropZoneProps = {
+    zone: string;
+    allow?: string[];
+    disallow?: string[];
+    style?: CSSProperties;
+};
+
+type FieldOption = {
+    label: string;
+    value: string | number | boolean;
+};
+type FieldOptions = Array<FieldOption> | ReadonlyArray<FieldOption>;
+type BaseField = {
+    label?: string;
+};
+type TextField = BaseField & {
+    type: "text";
+};
+type NumberField = BaseField & {
+    type: "number";
+    min?: number;
+    max?: number;
+};
+type TextareaField = BaseField & {
+    type: "textarea";
+};
+type SelectField = BaseField & {
+    type: "select";
+    options: FieldOptions;
+};
+type RadioField = BaseField & {
+    type: "radio";
+    options: FieldOptions;
+};
+type ArrayField<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "array";
+    arrayFields: {
+        [SubPropName in keyof Props[0]]: Field<Props[0][SubPropName]>;
+    };
+    defaultItemProps?: Props[0];
+    getItemSummary?: (item: Props[0], index?: number) => string;
+    max?: number;
+    min?: number;
+};
+type ObjectField<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "object";
+    objectFields: Props extends any[] ? never : {
+        [SubPropName in keyof Props]: Field<Props[SubPropName]>;
+    };
+};
+type Adaptor<AdaptorParams = {}, TableShape extends Record<string, any> = {}, PropShape = TableShape> = {
+    name: string;
+    fetchList: (adaptorParams?: AdaptorParams) => Promise<TableShape[] | null>;
+    mapProp?: (value: TableShape) => PropShape;
+};
+type ExternalFieldWithAdaptor<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "external";
+    placeholder?: string;
+    adaptor: Adaptor<any, any, Props>;
+    adaptorParams?: object;
+    getItemSummary: (item: Props, index?: number) => string;
+};
+type ExternalField<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = BaseField & {
+    type: "external";
+    placeholder?: string;
+    fetchList: (params: {
+        query: string;
+        filters: Record<string, any>;
+    }) => Promise<any[] | null>;
+    mapProp?: (value: any) => Props;
+    mapRow?: (value: any) => Record<string, string | number>;
+    getItemSummary?: (item: Props, index?: number) => string;
+    showSearch?: boolean;
+    initialQuery?: string;
+    filterFields?: Record<string, Field>;
+    initialFilters?: Record<string, any>;
+};
+type CustomField<Props extends any = {}> = BaseField & {
+    type: "custom";
+    render: (props: {
+        field: CustomField<Props>;
+        name: string;
+        id: string;
+        value: Props;
+        onChange: (value: Props) => void;
+        readOnly?: boolean;
+    }) => ReactElement;
+};
+type Field<Props extends any = any> = TextField | NumberField | TextareaField | SelectField | RadioField | ArrayField<Props extends {
+    [key: string]: any;
+} ? Props : any> | ObjectField<Props extends {
+    [key: string]: any;
+} ? Props : any> | ExternalField<Props extends {
+    [key: string]: any;
+} ? Props : any> | ExternalFieldWithAdaptor<Props extends {
+    [key: string]: any;
+} ? Props : any> | CustomField<Props>;
+type Fields<ComponentProps extends DefaultComponentProps = DefaultComponentProps> = {
+    [PropName in keyof Omit<ComponentProps, "editMode">]: Field<ComponentProps[PropName]>;
+};
+type FieldProps<ValueType = any, F = Field<any>> = {
+    field: F;
+    value: ValueType;
+    id?: string;
+    onChange: (value: ValueType, uiState?: Partial<UiState>) => void;
+    readOnly?: boolean;
+};
+
+type PuckComponent<Props> = (props: WithId<WithPuckProps<Props>>) => JSX.Element;
+type ComponentConfig<RenderProps extends DefaultComponentProps = DefaultComponentProps, FieldProps extends DefaultComponentProps = RenderProps, DataShape = Omit<ComponentData<FieldProps>, "type">> = {
+    render: PuckComponent<RenderProps>;
+    label?: string;
+    defaultProps?: FieldProps;
+    fields?: Fields<FieldProps>;
+    permissions?: Partial<Permissions>;
+    resolveFields?: (data: DataShape, params: {
+        changed: Partial<Record<keyof FieldProps, boolean>>;
+        fields: Fields<FieldProps>;
+        lastFields: Fields<FieldProps>;
+        lastData: DataShape;
+        appState: AppState;
+    }) => Promise<Fields<FieldProps>> | Fields<FieldProps>;
+    resolveData?: (data: DataShape, params: {
+        changed: Partial<Record<keyof FieldProps, boolean>>;
+        lastData: DataShape;
+    }) => Promise<{
+        props?: Partial<FieldProps>;
+        readOnly?: Partial<Record<keyof FieldProps, boolean>>;
+    }> | {
+        props?: Partial<FieldProps>;
+        readOnly?: Partial<Record<keyof FieldProps, boolean>>;
+    };
+    resolvePermissions?: (data: DataShape, params: {
+        changed: Partial<Record<keyof FieldProps, boolean>>;
+        lastPermissions: Partial<Permissions> | undefined;
+        initialPermissions: Partial<Permissions>;
+        appState: AppState;
+    }) => Partial<Permissions>;
+};
+type Category<ComponentName> = {
+    components?: ComponentName[];
+    title?: string;
+    visible?: boolean;
+    defaultExpanded?: boolean;
+};
+type Config<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = any, CategoryName extends string = string> = {
+    categories?: Record<CategoryName, Category<keyof Props>> & {
+        other?: Category<keyof Props>;
+    };
+    components: {
+        [ComponentName in keyof Props]: Omit<ComponentConfig<Props[ComponentName], Props[ComponentName]>, "type">;
+    };
+    root?: Partial<ComponentConfig<DefaultRootRenderProps<RootProps>, AsFieldProps<RootProps>, RootData>>;
+};
+
+type WithId<Props> = Props & {
+    id: string;
+};
+type WithPuckProps<Props> = Props & {
+    puck: PuckContext;
+    editMode?: boolean;
+};
+type AsFieldProps<Props> = Omit<Props, "children" | "puck" | "editMode">;
+type WithChildren<Props> = Props & {
+    children: ReactNode;
+};
+type ExtractPropsFromConfig<UserConfig> = UserConfig extends Config<infer P, any, any> ? P : never;
+type ExtractRootPropsFromConfig<UserConfig> = UserConfig extends Config<any, infer P, any> ? P : never;
+
+type PuckContext = {
+    renderDropZone: React.FC<DropZoneProps>;
+    isEditing: boolean;
+};
+type DefaultRootFieldProps = {
+    title?: string;
+};
+type DefaultRootRenderProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = WithPuckProps<WithChildren<Props>>;
+type DefaultRootProps = DefaultRootRenderProps;
+type DefaultComponentProps = {
+    [key: string]: any;
+};
+
+type BaseData<Props extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = {
+    readOnly?: Partial<Record<keyof Props, boolean>>;
+};
+type RootDataWithProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = BaseData<Props> & {
+    props: Props;
+};
+type RootDataWithoutProps<Props extends DefaultComponentProps = DefaultRootFieldProps> = Props;
+type RootData<Props extends DefaultComponentProps = DefaultRootFieldProps> = Partial<RootDataWithProps<AsFieldProps<Props>>> & Partial<RootDataWithoutProps<Props>>;
+type ComponentData<Props extends DefaultComponentProps = DefaultComponentProps, Name = string> = {
+    type: Name;
+    props: WithId<Props>;
+} & BaseData<Props>;
+type MappedItem = ComponentData;
+type ComponentDataMap<Props extends Record<string, DefaultComponentProps> = DefaultComponentProps> = {
+    [K in keyof Props]: ComponentData<Props[K], K extends string ? K : never>;
+}[keyof Props];
+type Content<PropsMap extends {
+    [key: string]: any;
+} = {
+    [key: string]: any;
+}> = ComponentDataMap<PropsMap>[];
+type Data<Props extends DefaultComponentProps = DefaultComponentProps, RootProps extends DefaultComponentProps = DefaultRootFieldProps> = {
+    root: RootData<RootProps>;
+    content: Content<Props>;
+    zones?: Record<string, Content<Props>>;
+};
+
+type ItemWithId = {
+    _arrayId: string;
+    _originalIndex: number;
+};
+type ArrayState = {
+    items: ItemWithId[];
+    openId: string;
+};
+type UiState = {
+    leftSideBarVisible: boolean;
+    rightSideBarVisible: boolean;
+    itemSelector: ItemSelector | null;
+    arrayState: Record<string, ArrayState | undefined>;
+    componentList: Record<string, {
+        components?: string[];
+        title?: string;
+        visible?: boolean;
+        expanded?: boolean;
+    }>;
+    isDragging: boolean;
+    viewports: {
+        current: {
+            width: number;
+            height: number | "auto";
+        };
+        controlsVisible: boolean;
+        options: Viewport[];
+    };
+};
+type AppState<UserData extends Data = Data> = {
+    data: UserData;
+    ui: UiState;
+};
+
+type RenderFunc<Props extends {
+    [key: string]: any;
+} = {
+    children: ReactNode;
+}> = (props: Props) => ReactElement;
+declare const overrideKeys: readonly ["header", "headerActions", "fields", "fieldLabel", "components", "componentItem", "outline", "puck", "preview"];
+type OverrideKey = (typeof overrideKeys)[number];
+type OverridesGeneric<Shape extends {
+    [key in OverrideKey]: any;
+}> = Shape;
+type Overrides = OverridesGeneric<{
+    fieldTypes: Partial<FieldRenderFunctions>;
+    header: RenderFunc<{
+        actions: ReactNode;
+        children: ReactNode;
+    }>;
+    actionBar: RenderFunc<{
+        label?: string;
+        children: ReactNode;
+    }>;
+    headerActions: RenderFunc<{
+        children: ReactNode;
+    }>;
+    preview: RenderFunc;
+    fields: RenderFunc<{
+        children: ReactNode;
+        isLoading: boolean;
+        itemSelector?: ItemSelector | null;
+    }>;
+    fieldLabel: RenderFunc<{
+        children?: ReactNode;
+        icon?: ReactNode;
+        label: string;
+        el?: "label" | "div";
+        readOnly?: boolean;
+        className?: string;
+    }>;
+    components: RenderFunc;
+    componentItem: RenderFunc<{
+        children: ReactNode;
+        name: string;
+    }>;
+    iframe: RenderFunc<{
+        children: ReactNode;
+        document?: Document;
+    }>;
+    outline: RenderFunc;
+    puck: RenderFunc;
+}>;
+type FieldRenderFunctions = Omit<{
+    [Type in Field["type"]]: React.FunctionComponent<FieldProps<Extract<Field, {
+        type: Type;
+    }>> & {
+        children: ReactNode;
+        name: string;
+    }>;
+}, "custom"> & {
+    [key: string]: React.FunctionComponent<FieldProps<any> & {
+        children: ReactNode;
+        name: string;
+    }>;
+};
+
+type iconTypes = "Smartphone" | "Monitor" | "Tablet";
+type Viewport = {
+    width: number;
+    height?: number | "auto";
+    label?: string;
+    icon?: iconTypes | ReactNode;
+};
+type Viewports = Viewport[];
+
+type Permissions = {
+    drag: boolean;
+    duplicate: boolean;
+    delete: boolean;
+    edit: boolean;
+    insert: boolean;
+} & Record<string, boolean>;
+type IframeConfig = {
+    enabled?: boolean;
+};
+type OnAction<UserData extends Data = Data> = (action: PuckAction, appState: AppState<UserData>, prevAppState: AppState<UserData>) => void;
+type Plugin = {
+    overrides: Partial<Overrides>;
+};
+
+type InsertAction = {
+    type: "insert";
+    componentType: string;
+    destinationIndex: number;
+    destinationZone: string;
+    id?: string;
+};
+type DuplicateAction = {
+    type: "duplicate";
+    sourceIndex: number;
+    sourceZone: string;
+};
+type ReplaceAction = {
+    type: "replace";
+    destinationIndex: number;
+    destinationZone: string;
+    data: any;
+};
+type ReorderAction = {
+    type: "reorder";
+    sourceIndex: number;
+    destinationIndex: number;
+    destinationZone: string;
+};
+type MoveAction = {
+    type: "move";
+    sourceIndex: number;
+    sourceZone: string;
+    destinationIndex: number;
+    destinationZone: string;
+};
+type RemoveAction = {
+    type: "remove";
+    index: number;
+    zone: string;
+};
+type SetUiAction = {
+    type: "setUi";
+    ui: Partial<UiState> | ((previous: UiState) => Partial<UiState>);
+};
+type SetDataAction = {
+    type: "setData";
+    data: Partial<Data> | ((previous: Data) => Partial<Data>);
+};
+type SetAction<UserData extends Data = Data> = {
+    type: "set";
+    state: Partial<AppState<UserData>> | ((previous: AppState<UserData>) => Partial<AppState<UserData>>);
+};
+type RegisterZoneAction = {
+    type: "registerZone";
+    zone: string;
+};
+type UnregisterZoneAction = {
+    type: "unregisterZone";
+    zone: string;
+};
+type PuckAction = {
+    recordHistory?: boolean;
+} & (ReorderAction | InsertAction | MoveAction | ReplaceAction | RemoveAction | DuplicateAction | SetAction | SetDataAction | SetUiAction | RegisterZoneAction | UnregisterZoneAction);
+
+export { type AsFieldProps as $, type AppState as A, type BaseData as B, type Config as C, type Data as D, type ExtractPropsFromConfig as E, type Field as F, type ObjectField as G, type Adaptor as H, type ItemSelector as I, type ExternalFieldWithAdaptor as J, type ExternalField as K, type CustomField as L, type MappedItem as M, type NumberField as N, type OnAction as O, type PuckAction as P, type Fields as Q, type RootDataWithProps as R, type SelectField as S, type TextField as T, type UiState as U, type Viewports as V, type PuckContext as W, type DefaultRootRenderProps as X, type DefaultRootProps as Y, type WithId as Z, type WithPuckProps as _, type FieldProps as a, type WithChildren as a0, type DropZoneProps as b, type ExtractRootPropsFromConfig as c, type Permissions as d, type Plugin as e, type Overrides as f, type IframeConfig as g, type DefaultComponentProps as h, type DefaultRootFieldProps as i, type ComponentData as j, type Viewport as k, type OverrideKey as l, type FieldRenderFunctions as m, type ItemWithId as n, overrideKeys as o, type ArrayState as p, type PuckComponent as q, type ComponentConfig as r, type RootDataWithoutProps as s, type RootData as t, type ComponentDataMap as u, type Content as v, type BaseField as w, type TextareaField as x, type RadioField as y, type ArrayField as z };