@esheet/renderer 0.0.4-0 → 0.0.4-2

package/dist/index.d.ts

@@ -1,291 +1,8 @@
-import { default as default_2 } from 'react';
-import { FhirQuestionnaireResponse } from '@esheet/adapters';
-import { FieldDefinition } from '@esheet/core';
-import { FormDefinition } from '@esheet/core';
-import { FormResponse } from '@esheet/core';
-import { FormResponseEnvelope } from '@esheet/core';
-import { FormStore } from '@esheet/core';
-import { JSX } from 'react/jsx-runtime';
-import { ResponseExportOptions } from '@esheet/adapters';
-import { UIStore } from '@esheet/core';
-import { ValidationError } from '@esheet/core';
-
-/**
- * EsheetRenderer - Read-only questionnaire form renderer
- *
- * Renders a form in fill-out mode with conditional visibility logic.
- * Reuses all field components from @esheet/fields.
- *
- * @example
- * ```tsx
- * const rendererRef = useRef<EsheetRendererHandle>(null);
- *
- * <EsheetRenderer
- *   formData={myFormDefinition}
- *   initialResponses={{ field1: 'answer' }}
- *   ref={rendererRef}
- * />
- *
- * // Later: get responses
- * const responses = rendererRef.current?.getRawResponse();
- * ```
- */
-export declare const EsheetRenderer: default_2.ForwardRefExoticComponent<EsheetRendererProps & default_2.RefAttributes<EsheetRendererHandle>>;
-
-export declare interface EsheetRendererHandle {
-    /** Get current form responses */
-    getRawResponse: () => FormResponse;
-    /**
-     * Get form responses in the specified format.
-     *
-     * @param options - Format and export options
-     * @returns Native FormResponse or FHIR QuestionnaireResponse
-     *
-     * @example
-     * ```ts
-     * // Native format (default)
-     * const native = ref.current.getResponse();
-     *
-     * // FHIR QuestionnaireResponse
-     * const fhir = ref.current.getResponse({
-     *   format: 'fhir',
-     *   fhir: {
-     *     questionnaireUrl: 'http://example.org/Questionnaire/my-form',
-     *     status: 'completed',
-     *   }
-     * });
-     * ```
-     */
-    getResponse: <T extends ResponseFormat = 'native'>(options?: GetResponseOptions & {
-        format?: T;
-    }) => GetResponseResult<T>;
-    /** Get form store instance */
-    getFormStore: () => FormStore;
-    /** Get UI store instance */
-    getUIStore: () => UIStore;
-    /** Get validated form responses (returns null if invalid) */
-    getValidResponse: () => {
-        response: FormResponse | null;
-        errors: ValidationError[];
-    };
-    /** Returns true if touch mode is currently enabled */
-    isTouchModeEnabled: () => boolean;
-    /** Toggle touch mode on/off. Only works when touchMode prop is 'auto' or undefined. Overrides auto-detection. */
-    setTouchMode: (enabled: boolean) => void;
-    /** Reset to auto-detection mode (clears manual override). Only works when touchMode='auto'. */
-    resetTouchMode: () => void;
-}
-
-export declare interface EsheetRendererProps {
-    /** Form definition — accepts FormDefinition, SurveyJS schema, MCP elicitation envelope,
-     *  or any of the above as a JSON/YAML string. Auto-detected and converted internally.
-     *  Set `strict` to disable auto-conversion and require a valid FormDefinition directly. */
-    formDataInput: unknown;
-    /** Additional CSS classes for root container */
-    className?: string;
-    /** Initial form responses (pre-fill data) */
-    initialResponses?: FormResponse;
-    /** When true, disables auto-detection of MCP/SurveyJS formats.
-     *  Only accepts a valid eSheet FormDefinition (or JSON/YAML string thereof). */
-    strict?: boolean;
-    /** Called after the form definition has been parsed and loaded into the store. */
-    onReady?: () => void;
-    /**
-     * Called once after the renderer mounts, providing a narrow `RendererTools`
-     * facade for MCP / AI tool integrations.
-     */
-    onRendererToolsReady?: (tools: RendererTools) => void;
-    /**
-     * Enable touch-optimized mode with larger touch targets.
-     * - `true`: Always enable touch mode
-     * - `false`: Never enable touch mode (CSS media query still applies)
-     * - `'auto'`: Enable based on viewport width (<980px) via JavaScript
-     * - `undefined`: Rely on CSS media query only (default)
-     */
-    touchMode?: boolean | 'auto';
-    /**
-     * Called when touch mode changes (via auto-detection or programmatic toggle).
-     * Useful for syncing external UI with the renderer's touch state.
-     */
-    onTouchModeChange?: (enabled: boolean) => void;
-}
-
-export declare function executeToolCall(toolName: string, args: ToolArgs, tools: RendererTools): string | Record<string, unknown>;
-
-/**
- * FieldNode - Renders a single field or section with recursive children
- *
- * Looks up the field component from the registry and passes field props.
- * For sections, recursively renders visible children.
- */
-export declare const FieldNode: default_2.NamedExoticComponent<FieldNodeProps>;
-
-declare interface FieldNodeProps {
-    id: string;
-    form: FormStore;
-    ui: UIStore;
-    /** Nesting depth for visual styling (default: 0) */
-    depth?: number;
-}
-
-export { FormDefinition }
-
-export { FormResponseEnvelope }
-
-/** Options for getResponse() */
-export declare interface GetResponseOptions {
-    /** Output format: 'native' (default) or 'fhir' (FHIR QuestionnaireResponse) */
-    format?: ResponseFormat;
-    /** FHIR export options (required when format is 'fhir') */
-    fhir?: Omit<ResponseExportOptions, 'questionnaireUrl'> & {
-        /** Canonical URL of the questionnaire. Falls back to form._sourceData metadata if available. */
-        questionnaireUrl?: string;
-    };
-}
-
-/** Return type for getResponse() — varies by format */
-export declare type GetResponseResult<T extends ResponseFormat = 'native'> = T extends 'fhir' ? FhirQuestionnaireResponse : FormResponse;
-
-export declare const RENDERER_SYSTEM_PROMPT: string;
-
-export declare const RENDERER_TOOL_DEFINITIONS: readonly ToolDefinition[];
-
-/**
- * RendererBody - Iterates over visible root fields and renders them
- *
- * Respects conditional visibility logic from form store.
- * Only renders fields where isVisible() returns true.
- * Sections recursively render their visible children.
- */
-export declare function RendererBody({ form, ui }: RendererBodyProps): JSX.Element;
-
-declare interface RendererBodyProps {
-    form: FormStore;
-    ui: UIStore;
-}
-
-/** Summary of a single field, suitable for AI context. */
-declare interface RendererFieldSummary {
-    id: string;
-    fieldType: string;
-    /** For text fields: the HTML input type (e.g. 'date', 'datetime-local', 'month', 'time', 'email', 'number'). Use the correct format when filling this field. */
-    inputType?: string;
-    /** Required value format for structured input types. Use this exact format when calling fill_field. */
-    valueFormat?: string;
-    question: string | undefined;
-    required: boolean;
-    /** True if this field already has a response value. False means it is still empty and needs to be filled. */
-    hasValue: boolean;
-    /** Available option values for selection fields (radio, check, dropdown, etc.). Only present when the field has options. */
-    options?: string[];
-    /** Available row labels for matrix fields. Only present for singlematrix / multimatrix. */
-    rows?: string[];
-    /** Available column labels for matrix fields. Only present for singlematrix / multimatrix. */
-    columns?: string[];
-}
-
-/**
- * Narrow interface exposed to MCP / AI tools via `onRendererToolsReady`.
- * Read-oriented: inspect responses, fill responses, and query the render tree.
- */
-export declare interface RendererTools {
-    /** Currently visible, fillable fields with their available options. */
-    getForm: () => {
-        formId: string;
-        fieldCount: number;
-        fields: RendererFieldSummary[];
-    };
-    /** All fields in the form regardless of visibility, rules, or enabled state. */
-    getFormRaw: () => {
-        formId: string;
-        fieldCount: number;
-        fields: RendererFieldSummary[];
-    };
-    /** Get current raw responses keyed by field ID. */
-    getResponses: () => Record<string, unknown>;
-    /** Get validated responses — returns null if validation fails. */
-    getValidResponse: () => {
-        response: Record<string, unknown> | null;
-        errors: ValidationError[];
-    };
-    /** Set a response value for one visible field. Returns true on success, false if field not found/visible, or an error string if the value format is invalid. */
-    fillField: (fieldId: string, value: unknown) => boolean | string;
-    /** Clear all responses. */
-    clearResponses: () => void;
-    /** Full render tree with visibility/enabled/required per field. */
-    getFormTree: () => RenderFieldNode[];
-    /** Find a field ID by exact ID or partial question match. */
-    resolveFieldId: (fieldId?: string, fieldQuestion?: string) => string | undefined;
-}
-
-declare interface RenderFieldNode {
-    /** Field identifier. */
-    id: string;
-    /** Field definition without nested children. */
-    definition: Omit<FieldDefinition, 'fields'>;
-    /** Computed visible state. */
-    visible: boolean;
-    /** Computed enabled state. */
-    enabled: boolean;
-    /** Computed required state. */
-    required: boolean;
-    /** Renderable child nodes (sections only). */
-    children: RenderFieldNode[];
-}
-
-/** Response format options for getResponse() */
-export declare type ResponseFormat = 'native' | 'fhir';
-
-declare type ToolArgs = Record<string, unknown>;
-
-export declare interface ToolDefinition {
-    type: string;
-    function: {
-        name: string;
-        description: string;
-        parameters: Record<string, unknown>;
-    };
-}
-
-/**
- * Initialize renderer with form definition.
- *
- * Auto-detects and converts the following input formats:
- * - eSheet FormDefinition (object or JSON/YAML string)
- * - FHIR R4 Questionnaire resource
- * - MCP elicitation/create envelope
- * - SurveyJS schema (has top-level `pages` or `elements` array)
- */
-export declare function useRendererInit(form: FormStore, ui: UIStore, formData: unknown, initialResponses?: FormResponse, onValidationError?: (errors: string[]) => void, strict?: boolean, onReady?: () => void): void;
-
-/**
- * Listens for AI tool-call events on a target element and dispatches them to
- * the renderer's MCP tool executor. Returns the `onRendererToolsReady` callback
- * to pass to `<EsheetRenderer>`.
- *
- * @example – default (listens on document)
- * const onRendererToolsReady = useRendererMcpToolHandler({ eventName: 'ozwell-tool-call' });
- * <EsheetRenderer onRendererToolsReady={onRendererToolsReady} ... />
- *
- * @example – scoped to a container element
- * const ref = React.useRef<HTMLDivElement>(null);
- * const onRendererToolsReady = useRendererMcpToolHandler({ target: ref.current ?? undefined, eventName: 'ozwell-tool-call' });
- * <div ref={ref}><EsheetRenderer onRendererToolsReady={onRendererToolsReady} ... /></div>
- */
-export declare function useRendererMcpToolHandler(options: UseRendererMcpToolHandlerOptions): (tools: RendererTools) => void;
-
-export declare interface UseRendererMcpToolHandlerOptions {
-    /**
-     * The DOM element to listen on for tool-call events.
-     * Pass `document` to listen globally, or a specific element to scope it.
-     */
-    target?: EventTarget;
-    /**
-     * The event name to listen for, e.g. `'ozwell-tool-call'`.
-     */
-    eventName: string;
-}
-
-export { ValidationError }
-
-export { }
+export { EsheetRenderer, type EsheetRendererProps, type EsheetRendererHandle, type GetResponseOptions, type GetResponseResult, type ResponseFormat, } from './lib/EsheetRenderer.js';
+export { renderer, buildRenderTree, type RenderTreeOptions, } from './lib/renderer.js';
+export type { FormDefinition, FormResponseEnvelope, ValidationError, } from '@esheet/core';
+export { RendererBody, FieldNode } from './lib/components/index.js';
+export { useRendererInit } from './lib/hooks/index.js';
+export { executeToolCall, RENDERER_TOOL_DEFINITIONS, RENDERER_SYSTEM_PROMPT, useRendererMcpToolHandler, type ToolDefinition, type UseRendererMcpToolHandlerOptions, } from './lib/mcp/index.js';
+export type { RendererTools } from './lib/renderer-tools.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAG5B,OAAO,EACL,cAAc,EACd,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,QAAQ,EACR,eAAe,EACf,KAAK,iBAAiB,GACvB,MAAM,mBAAmB,CAAC;AAG3B,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,eAAe,GAChB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGpE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,KAAK,cAAc,EACnB,KAAK,gCAAgC,GACtC,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC"}