@forming/react 0.0.0-stage → 0.1.0-dev.2.2

package/dist/index.d.ts

@@ -0,0 +1,223 @@
+import React from 'react';
+import { JsonNumber, type JsonValue } from '@forming/integrations/lossless-json';
+import type { ChoicePresentation, Extension, Extensions } from '@forming/integrations/extensions';
+import { editorText } from './editors.js';
+export interface Runtime {
+    view(): string;
+    document(): string;
+    dispatch(eventJson: string): string | null;
+}
+type Snapshot = {
+    viewJson: string;
+    view: View;
+    editorErrors: ReadonlySet<string>;
+    error: string | null;
+    reset: number;
+};
+export interface UploadHost {
+    select(owner: string, files: File[]): string;
+    retry(owner: string, slot: string): string | null;
+}
+export declare function createController(runtime: Runtime, dispatch?: Runtime['dispatch'], uploads?: UploadHost): {
+    document: () => string;
+    getSnapshot: () => Snapshot;
+    subscribe(listener: () => void): () => void;
+    dispose(): void;
+    refresh: () => void;
+    uploadsAvailable: boolean;
+    selectFiles(owner: string, files: File[]): void;
+    retryFile(owner: string, slot: string): void;
+    editor(id: string, invalid: boolean): void;
+    send(event: Record<string, unknown>): boolean;
+};
+export type Controller = ReturnType<typeof createController>;
+interface Node {
+    id: string;
+    type: string;
+    annotations?: {
+        package: string;
+        export: string;
+        values: JsonValue[];
+    }[];
+    title?: string;
+    description?: string;
+    placeholder?: string;
+    content?: string;
+    children?: Node[];
+    bind?: string;
+    schemaPath?: string;
+    structure?: string;
+    control?: string;
+    itemId?: string;
+    columns?: JsonNumber;
+    providers?: {
+        id: string;
+        kind: string;
+    }[];
+    file?: {
+        multiple: boolean;
+        accept: string[];
+    };
+    implicit?: boolean;
+    options?: Option[];
+}
+interface State {
+    nodeId: string;
+    visible: boolean;
+    enabled: boolean;
+    readonly: boolean;
+    required: boolean;
+}
+interface Issue {
+    nodeId: string;
+    message: string;
+    pointer: string;
+    code?: string;
+}
+interface Option {
+    value: JsonValue;
+    label?: string;
+    disabled?: boolean;
+    status?: string;
+}
+interface Slot {
+    site: string;
+    operation: string;
+    state: string;
+    message?: string;
+    errorMessage?: string;
+    result?: {
+        items?: Option[];
+        nextCursor?: string | null;
+    };
+    error?: {
+        retryable: boolean;
+    };
+}
+interface View {
+    status: string;
+    data: JsonValue;
+    form?: Node;
+    errorsRevealed: boolean;
+    navigation: {
+        currentPage: string | null;
+        route?: string[];
+        history?: string[];
+    };
+    texts?: Record<string, {
+        content?: string;
+        title?: string;
+    }>;
+    localization?: {
+        locale: string;
+        direction: 'ltr' | 'rtl';
+        renderer?: Partial<RendererText>;
+    };
+    validation: {
+        fieldStates: State[];
+        viewStates?: State[];
+        issues: Issue[];
+    };
+    actions: {
+        id: string;
+        type: string;
+        label: string;
+        enabled: boolean;
+    }[];
+    providerState?: {
+        slots: Slot[];
+    };
+    submissionIntent?: {
+        state: string;
+    };
+    uploadState?: {
+        fields: {
+            owner: string;
+            node: string;
+            retired: boolean;
+            ready: boolean;
+            reselect: JsonNumber;
+            engine: {
+                slots: {
+                    id: string;
+                    file: {
+                        name: string;
+                    };
+                    committed: boolean;
+                    state: string;
+                    error?: {
+                        retryable?: boolean;
+                    };
+                }[];
+            };
+        }[];
+    };
+}
+declare const defaultText: {
+    clear: string;
+    setNull: string;
+    create: string;
+    add: string;
+    remove: string;
+    up: string;
+    down: string;
+    search: string;
+    more: string;
+    retry: string;
+    waiting: string;
+    unavailable: string;
+    choose: string;
+    chooseMany: string;
+    invalid: string;
+    unsupported: string;
+    nullValue: string;
+    shownAs: string;
+    reselect: string;
+    dismiss: string;
+    uploading: string;
+    verified: string;
+    uploadFailed: string;
+    uploadNotReady: string;
+    issueSingle: string;
+    issueCount: string;
+    issueFirst: string;
+    step: string;
+    next: string;
+    back: string;
+    pressEnter: string;
+    counter: string;
+};
+declare const additionalText: {
+    trueValue: string;
+    falseValue: string;
+    accept: string;
+    formUnavailable: string;
+};
+export type RendererText = typeof defaultText & typeof additionalText & typeof editorText;
+export type { ChoiceContext, ChoicePresentation, FieldDrawing, Presentation } from '@forming/integrations/extensions';
+/** A ready-made plugin for selectable sections with a heading and body text.
+ * Field keys are answer pointers (e.g. /plan); values stay exact JSON values.
+ * Register it with createExtensions like any other plugin.
+ */
+export declare function choiceCards({ identity, fields, }: {
+    identity: string;
+    fields: Record<string, readonly (ChoicePresentation & {
+        value: JsonValue;
+    })[]>;
+}): Extension;
+export interface FormingFormProps {
+    controller: Controller;
+    /** The same createExtensions registry used for the runtime; renderers read its presentation hooks. */
+    extensions?: Pick<Extensions, 'presentation'>;
+    text?: Partial<RendererText>;
+    className?: string;
+    /** Presentation only. Authored pages and runtime navigation remain authoritative. */
+    presentation?: 'embedded' | 'focused';
+    /**
+     * 'standard' (default) shows respondent-facing controls only. 'exact' adds the
+     * data-level controls: explicit null, empty lists, the portable date/time text
+     * and locale echoes of values that already read the same.
+     */
+    detail?: 'standard' | 'exact';
+}
+export declare function FormingForm({ controller, text: overrides, className, presentation, detail, extensions, }: FormingFormProps): React.JSX.Element;