@refineui/react 0.0.12 → 0.1.1

package/dist/authoring-manifest.d.cts

@@ -0,0 +1,120 @@
+import { ReactElement } from 'react';
+
+/** A value that an editor can safely persist in a document. */
+type SerializableValue = null | string | number | boolean | SerializableValue[] | {
+    [key: string]: SerializableValue;
+};
+type AuthoringProp = {
+    name: string;
+    label: string;
+    valueType: "string" | "number" | "boolean" | "enum" | "url" | "icon" | "string-array" | "number-array" | "object" | "json";
+    control: "text" | "textarea" | "number" | "toggle" | "select" | "segmented" | "url" | "icon-picker" | "collection" | "json";
+    defaultValue?: SerializableValue;
+    options?: SerializableValue[];
+    required?: boolean;
+    bindable?: boolean;
+    section?: "properties" | "variants" | "state" | "accessibility";
+};
+type AuthoringNode = {
+    component: string;
+    props?: Record<string, SerializableValue>;
+    slots?: Record<string, AuthoringNode[]>;
+    /** Text is structural child content, never a serialized React children prop. */
+    text?: string;
+};
+type AuthoringSlot = {
+    name: string;
+    /** Where the rendered slot value is supplied to the React export. */
+    target?: "children" | "prop";
+    /** Required when target is prop; names the ReactNode prop to receive it. */
+    prop?: string;
+    accepts: string[];
+    required?: boolean;
+    repeatable?: boolean;
+    min?: number;
+    max?: number;
+    order?: number;
+    allowAnyComponent?: boolean;
+    allowText?: boolean;
+    recursive?: boolean;
+    defaultChildren?: AuthoringNode[];
+};
+type ParentConstraint = {
+    component: string;
+    slot: string;
+};
+type StateBinding = {
+    name: string;
+    valueProp: string;
+    defaultValueProp?: string;
+    changeEvent: string;
+    valueType: AuthoringProp["valueType"];
+};
+type AuthoringEvent = {
+    name: string;
+    payload: "void" | "boolean" | "number" | "string" | "string-array" | "object";
+    description?: string;
+};
+type IconSlot = {
+    name: string;
+    optional: boolean;
+    accepts: ["refineui-icon", "svg", "image"];
+};
+type PortalContract = {
+    strategy: "screen-root" | "themed-overlay-root" | "document-body";
+    inheritsTheme: boolean;
+    /** Component and prop that accept an editor-owned portal container at render time. */
+    containerComponent?: string;
+    containerProp?: string;
+};
+type AuthoringRenderOptions = {
+    /**
+     * An editor-owned themed overlay element. It is injected only at render
+     * time, so no DOM reference is persisted in an AuthoringNode.
+     */
+    portalContainer?: Element | DocumentFragment | null;
+};
+type AuthoringComponent = {
+    id: string;
+    exportPath: string;
+    exportName: string;
+    kind: "root" | "part" | "provider" | "portal";
+    category: string;
+    label: string;
+    description?: string;
+    props: AuthoringProp[];
+    slots?: AuthoringSlot[];
+    parents?: ParentConstraint[];
+    presets?: {
+        id: string;
+        label: string;
+        description?: string;
+        root: AuthoringNode;
+    }[];
+    stateBindings?: StateBinding[];
+    events?: AuthoringEvent[];
+    iconSlots?: IconSlot[];
+    portal?: PortalContract;
+    preview: {
+        mode: "full" | "limited";
+        unsupported?: string[];
+    };
+};
+type AuthoringManifest = {
+    schema: "refineui.authoring/1";
+    packageName: "@refineui/react";
+    packageVersion: string;
+    css: string[];
+    components: AuthoringComponent[];
+};
+
+/** The stable, editor-neutral metadata contract for @refineui/react. */
+declare const manifest: AuthoringManifest;
+/**
+ * Consumer fixture: turns a preset tree into real React elements.  Editors can
+ * replace this tiny resolver with their own canvas runtime without changing the
+ * persisted document format.
+ */
+declare function renderAuthoringNode(node: AuthoringNode, exports: Record<string, React.ElementType>, options?: AuthoringRenderOptions): ReactElement;
+
+export { type AuthoringComponent, type AuthoringEvent, type AuthoringManifest, type AuthoringNode, type AuthoringProp, type AuthoringRenderOptions, type AuthoringSlot, type IconSlot, type ParentConstraint, type PortalContract, type SerializableValue, type StateBinding, manifest as default, renderAuthoringNode };

package/dist/authoring-manifest.d.ts

@@ -0,0 +1,120 @@
+import { ReactElement } from 'react';
+
+/** A value that an editor can safely persist in a document. */
+type SerializableValue = null | string | number | boolean | SerializableValue[] | {
+    [key: string]: SerializableValue;
+};
+type AuthoringProp = {
+    name: string;
+    label: string;
+    valueType: "string" | "number" | "boolean" | "enum" | "url" | "icon" | "string-array" | "number-array" | "object" | "json";
+    control: "text" | "textarea" | "number" | "toggle" | "select" | "segmented" | "url" | "icon-picker" | "collection" | "json";
+    defaultValue?: SerializableValue;
+    options?: SerializableValue[];
+    required?: boolean;
+    bindable?: boolean;
+    section?: "properties" | "variants" | "state" | "accessibility";
+};
+type AuthoringNode = {
+    component: string;
+    props?: Record<string, SerializableValue>;
+    slots?: Record<string, AuthoringNode[]>;
+    /** Text is structural child content, never a serialized React children prop. */
+    text?: string;
+};
+type AuthoringSlot = {
+    name: string;
+    /** Where the rendered slot value is supplied to the React export. */
+    target?: "children" | "prop";
+    /** Required when target is prop; names the ReactNode prop to receive it. */
+    prop?: string;
+    accepts: string[];
+    required?: boolean;
+    repeatable?: boolean;
+    min?: number;
+    max?: number;
+    order?: number;
+    allowAnyComponent?: boolean;
+    allowText?: boolean;
+    recursive?: boolean;
+    defaultChildren?: AuthoringNode[];
+};
+type ParentConstraint = {
+    component: string;
+    slot: string;
+};
+type StateBinding = {
+    name: string;
+    valueProp: string;
+    defaultValueProp?: string;
+    changeEvent: string;
+    valueType: AuthoringProp["valueType"];
+};
+type AuthoringEvent = {
+    name: string;
+    payload: "void" | "boolean" | "number" | "string" | "string-array" | "object";
+    description?: string;
+};
+type IconSlot = {
+    name: string;
+    optional: boolean;
+    accepts: ["refineui-icon", "svg", "image"];
+};
+type PortalContract = {
+    strategy: "screen-root" | "themed-overlay-root" | "document-body";
+    inheritsTheme: boolean;
+    /** Component and prop that accept an editor-owned portal container at render time. */
+    containerComponent?: string;
+    containerProp?: string;
+};
+type AuthoringRenderOptions = {
+    /**
+     * An editor-owned themed overlay element. It is injected only at render
+     * time, so no DOM reference is persisted in an AuthoringNode.
+     */
+    portalContainer?: Element | DocumentFragment | null;
+};
+type AuthoringComponent = {
+    id: string;
+    exportPath: string;
+    exportName: string;
+    kind: "root" | "part" | "provider" | "portal";
+    category: string;
+    label: string;
+    description?: string;
+    props: AuthoringProp[];
+    slots?: AuthoringSlot[];
+    parents?: ParentConstraint[];
+    presets?: {
+        id: string;
+        label: string;
+        description?: string;
+        root: AuthoringNode;
+    }[];
+    stateBindings?: StateBinding[];
+    events?: AuthoringEvent[];
+    iconSlots?: IconSlot[];
+    portal?: PortalContract;
+    preview: {
+        mode: "full" | "limited";
+        unsupported?: string[];
+    };
+};
+type AuthoringManifest = {
+    schema: "refineui.authoring/1";
+    packageName: "@refineui/react";
+    packageVersion: string;
+    css: string[];
+    components: AuthoringComponent[];
+};
+
+/** The stable, editor-neutral metadata contract for @refineui/react. */
+declare const manifest: AuthoringManifest;
+/**
+ * Consumer fixture: turns a preset tree into real React elements.  Editors can
+ * replace this tiny resolver with their own canvas runtime without changing the
+ * persisted document format.
+ */
+declare function renderAuthoringNode(node: AuthoringNode, exports: Record<string, React.ElementType>, options?: AuthoringRenderOptions): ReactElement;
+
+export { type AuthoringComponent, type AuthoringEvent, type AuthoringManifest, type AuthoringNode, type AuthoringProp, type AuthoringRenderOptions, type AuthoringSlot, type IconSlot, type ParentConstraint, type PortalContract, type SerializableValue, type StateBinding, manifest as default, renderAuthoringNode };