@reacteditor/core 0.0.1-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,396 @@
+import { o as Field, p as FieldProps, q as DropZoneProps, C as Config, U as UserGenerics, D as Data, k as UiState, O as OnAction, f as Permissions, i as Plugin, j as Overrides, m as FieldTransforms, E as EditorAction, V as Viewports, I as IframeConfig, r as InitialHistory, M as Metadata, h as ResolveDataTrigger, s as ItemSelector, b as ComponentData, t as PluginInternal } from './actions-BCDhqbeL.js';
+export { u as Adaptor, A as AppState, v as ArrayField, w as ArrayState, x as AsFieldProps, B as BaseData, y as BaseField, z as CacheOpts, l as ComponentConfig, G as ComponentConfigExtensions, J as ComponentConfigParams, K as ComponentDataMap, L as ComponentDataOptionalId, N as ComponentMetadata, Q as ConfigParams, a as Content, S as CustomField, T as CustomFieldRender, d as DefaultComponentProps, c as DefaultComponents, e as DefaultRootFieldProps, X as DefaultRootProps, Y as DefaultRootRenderProps, Z as Direction, _ as DragAxis, $ as EditorComponent, a0 as EditorContext, a1 as EditorMetadata, a2 as ExternalField, a3 as ExternalFieldWithAdaptor, a4 as ExtractConfigParams, a5 as ExtractField, a6 as FieldMetadata, a7 as FieldRenderFunctions, a8 as FieldTransformFn, a9 as FieldTransformFnParams, F as Fields, H as History, aa as ItemWithId, ab as MappedItem, ac as NumberField, ad as ObjectField, ae as OverrideKey, af as RadioField, ag as RichText, n as RichtextField, ah as RootConfig, R as RootData, g as RootDataWithProps, ai as RootDataWithoutProps, aj as SelectField, ak as Slot, al as SlotComponent, am as SlotField, an as TextField, ao as TextareaField, ap as Viewport, aq as WithChildren, ar as WithEditorProps, W as WithId, as as WithSlotProps, at as overrideKeys } from './actions-BCDhqbeL.js';
+export { m as migrate, r as resolveAllData, t as transformProps, w as walkTree } from './walk-tree-BZq1CPCH.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import react__default, { ReactNode, SyntheticEvent, ReactElement, CSSProperties } from 'react';
+import { A as AppStore, G as GetPermissions, R as RefreshPermissions, H as HistorySlice } from './index-ComBHfdn.js';
+import '@tiptap/react';
+import '@tiptap/extension-blockquote';
+import '@tiptap/extension-bold';
+import '@tiptap/extension-code';
+import '@tiptap/extension-code-block';
+import '@tiptap/extension-hard-break';
+import '@tiptap/extension-heading';
+import '@tiptap/extension-horizontal-rule';
+import '@tiptap/extension-italic';
+import '@tiptap/extension-link';
+import '@tiptap/extension-list';
+import '@tiptap/extension-paragraph';
+import '@tiptap/extension-strike';
+import '@tiptap/extension-text-align';
+import '@tiptap/extension-underline';
+
+/**
+ * Shared state for components whose config has `global: true`. Keyed by
+ * component type. Every instance of a global-marked component renders from
+ * its entry in this map instead of its own props (except `children`, which
+ * is always extrinsic).
+ *
+ * There is exactly one entry per component type. Multiple named variants of
+ * the same component type are not supported in this shape — deliberately, to
+ * avoid introducing references / IDs.
+ */
+type GlobalData = Record<string, {
+    props: Record<string, any>;
+}>;
+
+/**
+ * A concrete page destination surfaced in the editor's page switcher.
+ * `path` is the stable identifier AND the URL; `title` is the display
+ * label. Keep this type light — full page content lives in separate
+ * per-page data blobs owned by the consumer. When Editor eventually
+ * introduces a richer `Page` type (data + metadata + path + title),
+ * `Route` can stay as the summary / reference projection of it.
+ */
+type Route = {
+    path: string;
+    title: string;
+};
+
+declare const ActionBar: {
+    ({ label, children, }: {
+        label?: string;
+        children?: ReactNode;
+    }): react_jsx_runtime.JSX.Element;
+    Action: ({ children, label, onClick, active, disabled, }: {
+        children: ReactNode;
+        label?: string;
+        onClick: (e: SyntheticEvent) => void;
+        active?: boolean;
+        disabled?: boolean;
+    }) => react_jsx_runtime.JSX.Element;
+    Label: ({ label }: {
+        label: string;
+    }) => react_jsx_runtime.JSX.Element;
+    Group: ({ children }: {
+        children: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    Separator: () => react_jsx_runtime.JSX.Element;
+};
+declare const Action: ({ children, label, onClick, active, disabled, }: {
+    children: ReactNode;
+    label?: string;
+    onClick: (e: SyntheticEvent) => void;
+    active?: boolean;
+    disabled?: boolean;
+}) => react_jsx_runtime.JSX.Element;
+declare const Group: ({ children }: {
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+declare const Label: ({ label }: {
+    label: string;
+}) => react_jsx_runtime.JSX.Element;
+declare const Separator: () => react_jsx_runtime.JSX.Element;
+
+declare const FieldLabel: ({ children, icon, label, el, readOnly, className, }: {
+    children?: ReactNode;
+    icon?: ReactNode;
+    label: string;
+    el?: "label" | "div";
+    readOnly?: boolean;
+    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> & {
+    value: any;
+}): 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;
+    href?: string;
+    onClick?: (e: any) => void | Promise<void>;
+    variant?: "primary" | "secondary";
+    type?: "button" | "submit" | "reset";
+    disabled?: boolean;
+    tabIndex?: number;
+    newTab?: boolean;
+    fullWidth?: boolean;
+    icon?: ReactNode;
+    size?: "medium" | "large";
+    loading?: boolean;
+}) => react_jsx_runtime.JSX.Element;
+
+declare const ComponentList: {
+    ({ children, title, id, }: {
+        id: string;
+        children?: ReactNode;
+        title?: string;
+    }): react_jsx_runtime.JSX.Element;
+    Item: ({ name, label, icon, }: {
+        name: string;
+        label?: string;
+        icon?: ReactNode;
+        index?: number;
+    }) => react_jsx_runtime.JSX.Element;
+};
+
+declare const Drawer: {
+    ({ children, droppableId, direction, variant, }: {
+        children: ReactNode;
+        droppableId?: string;
+        direction?: "vertical" | "horizontal";
+        variant?: "list" | "tile";
+    }): react_jsx_runtime.JSX.Element;
+    Item: ({ name, children, id, label, icon, index, isDragDisabled, }: {
+        name: string;
+        children?: (props: {
+            children: ReactNode;
+            name: string;
+        }) => ReactElement;
+        id?: string;
+        label?: string;
+        icon?: ReactNode;
+        index?: number;
+        isDragDisabled?: boolean;
+    }) => react_jsx_runtime.JSX.Element;
+};
+
+declare const DropZone: react.ForwardRefExoticComponent<Omit<DropZoneProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
+
+declare const IconButton: ({ active, children, href, onClick, type, disabled, tabIndex, newTab, fullWidth, title, suppressHydrationWarning, }: {
+    active?: boolean;
+    children: ReactNode;
+    href?: string;
+    onClick?: (e: SyntheticEvent) => void | Promise<void>;
+    type?: "button" | "submit" | "reset";
+    disabled?: boolean;
+    tabIndex?: number;
+    newTab?: boolean;
+    fullWidth?: boolean;
+    title: string;
+    suppressHydrationWarning?: boolean;
+}) => react_jsx_runtime.JSX.Element;
+
+type EditorProps<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    children?: ReactNode;
+    config: UserConfig;
+    data: Partial<G["UserData"] | Data>;
+    globalData?: GlobalData;
+    ui?: Partial<UiState>;
+    onChange?: (data: G["UserData"]) => void;
+    onGlobalsChange?: (globalData: GlobalData) => void;
+    onPublish?: (data: G["UserData"]) => void;
+    onAction?: OnAction<G["UserData"]>;
+    permissions?: Partial<Permissions>;
+    plugins?: Plugin<UserConfig>[];
+    overrides?: Partial<Overrides<UserConfig>>;
+    fieldTransforms?: FieldTransforms<UserConfig>;
+    renderHeader?: (props: {
+        children: ReactNode;
+        dispatch: (action: EditorAction) => void;
+        state: G["UserAppState"];
+    }) => ReactElement;
+    renderHeaderActions?: (props: {
+        state: G["UserAppState"];
+        dispatch: (action: EditorAction) => void;
+    }) => ReactElement;
+    headerTitle?: string;
+    headerPath?: string;
+    title?: ReactNode;
+    routes?: Route[];
+    currentPath?: string;
+    onRouteChange?: (path: string) => void | Promise<void>;
+    viewports?: Viewports;
+    iframe?: IframeConfig;
+    dnd?: {
+        disableAutoScroll?: boolean;
+    };
+    initialHistory?: InitialHistory;
+    metadata?: Metadata;
+    height?: CSSProperties["height"];
+    fullScreenCanvas?: boolean;
+    _experimentalVirtualization?: boolean;
+};
+declare function Editor<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>>(props: EditorProps<UserConfig>): react_jsx_runtime.JSX.Element;
+declare namespace Editor {
+    var Components: () => react_jsx_runtime.JSX.Element;
+    var Fields: react.MemoExoticComponent<({ wrapFields }: {
+        wrapFields?: boolean;
+    }) => react_jsx_runtime.JSX.Element>;
+    var Layout: ({ children }: {
+        children?: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    var Outline: () => react_jsx_runtime.JSX.Element;
+    var Preview: ({ id }: {
+        id?: string;
+    }) => 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, globalData, metadata, }: {
+    config: UserConfig;
+    data: Partial<G["UserData"] | Data>;
+    globalData?: GlobalData;
+    metadata?: Metadata;
+}): react_jsx_runtime.JSX.Element;
+
+declare function AlignLeft(): react_jsx_runtime.JSX.Element;
+
+declare function AlignCenter(): react_jsx_runtime.JSX.Element;
+
+declare function AlignRight(): react_jsx_runtime.JSX.Element;
+
+declare function AlignJustify(): react_jsx_runtime.JSX.Element;
+
+declare function Bold(): react_jsx_runtime.JSX.Element;
+
+declare function Italic(): react_jsx_runtime.JSX.Element;
+
+declare function Underline(): react_jsx_runtime.JSX.Element;
+
+declare function Strikethrough(): react_jsx_runtime.JSX.Element;
+
+declare function InlineCode(): react_jsx_runtime.JSX.Element;
+
+declare function BulletList(): react_jsx_runtime.JSX.Element;
+
+declare function OrderedList(): react_jsx_runtime.JSX.Element;
+
+declare function CodeBlock(): react_jsx_runtime.JSX.Element;
+
+declare function Blockquote(): react_jsx_runtime.JSX.Element;
+
+declare function HorizontalRule(): react_jsx_runtime.JSX.Element;
+
+declare function Control({ icon, disabled, active, onClick, title, }: {
+    icon: ReactNode;
+    disabled?: boolean;
+    active?: boolean;
+    onClick: (e: SyntheticEvent) => any;
+    title: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare const RichTextMenu: {
+    ({ children }: {
+        children: ReactNode;
+    }): react_jsx_runtime.JSX.Element;
+    Group: ({ children }: {
+        children: ReactNode;
+    }) => react_jsx_runtime.JSX.Element;
+    Control: typeof Control;
+    AlignCenter: typeof AlignCenter;
+    AlignJustify: typeof AlignJustify;
+    AlignLeft: typeof AlignLeft;
+    AlignRight: typeof AlignRight;
+    AlignSelect: () => react_jsx_runtime.JSX.Element;
+    Blockquote: typeof Blockquote;
+    Bold: typeof Bold;
+    BulletList: typeof BulletList;
+    CodeBlock: typeof CodeBlock;
+    HeadingSelect: () => react_jsx_runtime.JSX.Element;
+    HorizontalRule: typeof HorizontalRule;
+    InlineCode: typeof InlineCode;
+    Italic: typeof Italic;
+    ListSelect: () => react_jsx_runtime.JSX.Element;
+    OrderedList: typeof OrderedList;
+    Strikethrough: typeof Strikethrough;
+    Underline: typeof Underline;
+};
+
+/**
+ * Framework-agnostic SEO output shape. Mirrors the subset of Next.js's
+ * Metadata type that most page builders care about — title, description,
+ * Open Graph, canonical. Consumers can feed this directly into Next's
+ * generateMetadata or adapt it for other frameworks.
+ */
+type PageMetadata = {
+    title?: string;
+    description?: string;
+    openGraph?: {
+        title?: string;
+        description?: string;
+        images?: Array<{
+            url: string;
+        }>;
+    };
+    alternates?: {
+        canonical?: string;
+    };
+};
+/**
+ * Extracts SEO fields from a page's Root props. The convention: authors add
+ * `title`, `description`, `ogTitle`, `ogDescription`, `ogImage`, `canonical`
+ * fields to their root config. This helper maps them into a metadata shape
+ * you can return from Next's generateMetadata (or equivalent).
+ *
+ *   export async function generateMetadata({ params }) {
+ *     const data = await loadPage(params.slug);
+ *     return pageMetadata(data);
+ *   }
+ *
+ * Returns an empty object when no fields are set — safe to call on any
+ * data, including missing-page fallbacks.
+ */
+declare function pageMetadata(data: Data | undefined | null): PageMetadata;
+
+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 UseEditorData<UserConfig extends Config = Config, G extends UserGenerics<UserConfig> = UserGenerics<UserConfig>> = {
+    appState: G["UserPublicAppState"];
+    config: UserConfig;
+    dispatch: AppStore["dispatch"];
+    getPermissions: GetPermissions<UserConfig>;
+    refreshPermissions: RefreshPermissions<UserConfig>;
+    resolveDataById: (id: string, trigger?: ResolveDataTrigger) => void;
+    resolveDataBySelector: (selector: ItemSelector, trigger?: ResolveDataTrigger) => void;
+    selectedItem: G["UserComponentData"] | null;
+    getItemBySelector: (selector: ItemSelector) => G["UserComponentData"] | undefined;
+    getItemById: (id: string) => G["UserComponentData"] | undefined;
+    getSelectorForId: (id: string) => Required<ItemSelector> | undefined;
+    getParentById: (id: string) => ComponentData | undefined;
+    history: {
+        back: HistorySlice["back"];
+        forward: HistorySlice["forward"];
+        setHistories: HistorySlice["setHistories"];
+        setHistoryIndex: HistorySlice["setHistoryIndex"];
+        histories: HistorySlice["histories"];
+        index: HistorySlice["index"];
+        hasPast: boolean;
+        hasFuture: boolean;
+    };
+};
+type EditorApi<UserConfig extends Config = Config> = UseEditorData<UserConfig>;
+type UseEditorStore<UserConfig extends Config = Config> = EditorApi<UserConfig>;
+/**
+ * createUseEditor
+ *
+ * Create a typed useEditor 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 useEditor function
+ */
+declare function createUseEditor<UserConfig extends Config = Config>(): <T = EditorApi<UserConfig>>(selector: (state: UseEditorStore<UserConfig>) => T) => T;
+declare function useEditor<UserConfig extends Config = Config>(): UseEditorStore<UserConfig>;
+/**
+ * Get the latest state without relying on a render
+ *
+ * @returns EditorApi
+ */
+declare function useGetEditor(): () => UseEditorStore<Config>;
+
+declare const blocksPlugin: () => Plugin;
+
+declare const fieldsPlugin: (params?: {
+    desktopSideBar?: "left" | "right";
+}) => PluginInternal;
+
+declare const outlinePlugin: () => Plugin;
+
+declare const legacySideBarPlugin: () => Plugin;
+
+export { Action, ActionBar, AutoField, Button, ComponentData, ComponentList, Config, Data, Drawer, DropZone, Editor, EditorAction, type EditorApi, Field, FieldLabel, FieldProps, FieldTransforms, type GlobalData, Group, IconButton, IframeConfig, InitialHistory, Label, Metadata, OnAction, Overrides, type PageMetadata, Permissions, Plugin, Render, ResolveDataTrigger, RichTextMenu, type Route, Separator, UiState, type UseEditorData, UserGenerics, Viewports, blocksPlugin, createUseEditor, fieldsPlugin, legacySideBarPlugin, outlinePlugin, pageMetadata, registerOverlayPortal, renderContext, setDeep, useEditor, useGetEditor };