formanitor 0.0.11 → 0.0.14

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import React from 'react';
 
-type FieldType = 'text' | 'number' | 'textarea' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | string;
+type FieldType = 'text' | 'number' | 'textarea' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | 'medications' | 'investigations' | 'procedures' | 'vitals' | 'referral' | 'followup' | string;
 interface ValidationRule {
     min?: number;
     max?: number;
@@ -42,6 +42,26 @@ interface BaseFieldDef {
     disabled?: boolean;
     hidden?: boolean;
     prefill?: FieldPrefill;
+    /**
+     * High-level column position in SmartForm layout.
+     * - "left" and "right" are narrow side columns.
+     * - "center" is the main content column and is 2× the width of side columns.
+     * Default: "center" when omitted.
+     */
+    position?: 'left' | 'center' | 'right';
+    /**
+     * How many layout columns this field spans horizontally.
+     * - 1 = occupies its own column (e.g. just "left", just "center", or just "right")
+     * - 2 = spans into an adjacent column (e.g. left+center or center+right)
+     * Default: 1.
+     */
+    colSpan?: 1 | 2;
+    /**
+     * Optional theme name for component styling.
+     * Renders the field with theme-specific styles (e.g. textarea with "highlight-label"
+     * shows the label in a colored block above the input).
+     */
+    theme?: string;
     meta?: Record<string, unknown>;
 }
 interface TextFieldDef extends BaseFieldDef {
@@ -118,7 +138,86 @@ interface StaticTextFieldDef extends BaseFieldDef {
     /** Display size. Default: 'regular'. */
     size?: 'regular' | 'large';
 }
-type FieldDef = TextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | BaseFieldDef;
+interface MedicationsFieldDef extends BaseFieldDef {
+    type: 'medications';
+}
+interface InvestigationsFieldDef extends BaseFieldDef {
+    type: 'investigations';
+}
+interface ProceduresFieldDef extends BaseFieldDef {
+    type: 'procedures';
+}
+interface DifferentialDiagnosisFieldDef extends BaseFieldDef {
+    type: 'differential_diagnosis';
+}
+/**
+ * A read-only vitals panel populated by an external API fetch.
+ * The consumer provides `onFetch` in `fieldHandlers` for this field ID.
+ * The fetched value (raw vitals object) is stored in form state and included in submission.
+ */
+interface VitalsFieldDef extends BaseFieldDef {
+    type: 'vitals';
+}
+/** One selected referral. Stored in form state as an array of these. */
+interface ReferralItem {
+    specialization: string;
+    is_urgent: boolean;
+}
+/**
+ * Referral field: label "Referral to" with a multiselect dropdown and chips.
+ * Value shape: ReferralItem[] e.g. [{ specialization: "Cardiology", is_urgent: false }, ...].
+ * Options via fieldHandlers[fieldId].onFetchOptions (e.g. { specializations: string[] }).
+ */
+interface ReferralFieldDef extends BaseFieldDef {
+    type: 'referral';
+    options?: SelectOption[];
+}
+/** Stored value for followup field: false/null = no followup; object = one-time followup as number of days from current date. */
+interface FollowupValue {
+    followupType: 'one time';
+    /** Number of days from (current) date when set; always stored as string. */
+    value: string;
+    unit: 'days';
+}
+/**
+ * Follow-up field: "No Follow-up" | "One Time" with schedule by duration (e.g. 7 days) or by date.
+ * Value shape: false | FollowupValue.
+ */
+interface FollowupFieldDef extends BaseFieldDef {
+    type: 'followup';
+}
+/** A matched master record returned from a backend search API. */
+interface MatchedCondition {
+    id: number | string;
+    name: string;
+    created_at?: string;
+    updated_at?: string;
+}
+/** A single keyword-to-master-record match produced by NLP extraction + search. */
+interface ExtractedKeywordMatch {
+    extractedKeyword: string;
+    matchedCondition: MatchedCondition;
+}
+/** Structured value stored in form state for smart_textarea fields. */
+interface SmartTextareaValue {
+    text: string;
+    extractedKeywords: ExtractedKeywordMatch[];
+}
+/**
+ * Smart textarea that performs client-side NLP keyword extraction and searches
+ * matched terms against backend master tables via `fieldHandlers[fieldId].onSearch`.
+ *
+ * Value shape: `SmartTextareaValue` — `{ text, extractedKeywords }`.
+ */
+interface SmartTextareaFieldDef extends BaseFieldDef {
+    type: 'smart_textarea';
+    height?: number;
+    /** Semantic label for the kind of content (e.g. 'allergies', 'chiefComplaints', 'symptoms'). */
+    componentType: string;
+    /** Debounce delay in ms before NLP + search triggers. Default: 1000. */
+    debounceDelay?: number;
+}
+type FieldDef = TextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | MedicationsFieldDef | InvestigationsFieldDef | ProceduresFieldDef | DifferentialDiagnosisFieldDef | VitalsFieldDef | ReferralFieldDef | FollowupFieldDef | SmartTextareaFieldDef | BaseFieldDef;
 interface Condition {
     field?: string;
     op: '==' | '!=' | '>' | '<' | '>=' | '<=' | 'in' | 'contains';
@@ -180,7 +279,25 @@ interface SumComputation {
     type: 'sum';
     fields: string[];
 }
-type Computation = SumComputation | ScoreComputation;
+/** Expression node for formula computation: field ref, number, or binary op. */
+type FormulaExpr = {
+    type: 'field';
+    field: string;
+} | {
+    type: 'number';
+    value: number;
+} | {
+    type: 'op';
+    op: '+' | '-' | '*' | '/' | '**';
+    left: FormulaExpr;
+    right: FormulaExpr;
+};
+interface FormulaComputation {
+    target: string;
+    type: 'formula';
+    expression: FormulaExpr;
+}
+type Computation = SumComputation | ScoreComputation | FormulaComputation;
 interface FormDef {
     id: string;
     version: number;
@@ -277,6 +394,15 @@ declare class FormStore {
     getFieldDef(fieldId: string): FieldDef | undefined;
     hasPersistence(): boolean;
     setValue(fieldId: string, value: any): void;
+    /**
+     * Set multiple values at once (e.g. from AI analysis). Only updates keys that
+     * exist in the schema. Runs evaluate/notify/save once.
+     * @param partial Map of fieldId -> value
+     * @param options.touch If false, do not mark fields as touched (e.g. for AI-suggested values)
+     */
+    setValues(partial: Record<string, any>, options?: {
+        touch?: boolean;
+    }): void;
     setTouched(fieldId: string): void;
     setRole(role: string): void;
     load(): Promise<void>;
@@ -297,6 +423,13 @@ declare class FormStore {
      *   }
      */
     getSerializedValuesForSubmission(): FormValues;
+    /**
+     * Raw form values as stored internally, without any serialization or
+     * transformation. Useful when consumers need access to richer structures
+     * (e.g. smart_textarea keyword metadata) alongside the flattened values
+     * returned by getSerializedValuesForSubmission.
+     */
+    getRawValues(): FormValues;
     private serializeValuesForSubmission;
     private evaluate;
     getAvailableTransitions(): WorkflowTransition[];
@@ -338,9 +471,32 @@ interface RuleResult {
 }
 declare function evaluateRules(values: FormValues, rules: Rule[], fields: Record<string, FieldDef>): RuleResult;
 
+type FieldHandler = {
+    onSearch: (query: string) => Promise<any[]>;
+    recentlyUsed?: any[];
+    /**
+     * Called by widgets that display externally-fetched data (e.g. vitals).
+     * Invoked once on mount and again when the user hits the refresh button.
+     * The resolved value is written directly into the field's form state.
+     */
+    onFetch?: () => Promise<any>;
+    /**
+     * Called by the referral widget to load dropdown options. May return
+     * { specializations: string[] } or { label: string; value: any }[].
+     */
+    onFetchOptions?: () => Promise<{
+        specializations?: string[];
+    } | {
+        label: string;
+        value: any;
+    }[]>;
+};
+type FieldHandlersMap = Record<string, FieldHandler>;
+declare function useFieldHandlers(fieldId: string): FieldHandler;
 interface FormProviderProps {
     schema: FormDef;
     config?: StoreConfig;
+    fieldHandlers?: FieldHandlersMap;
     children: React.ReactNode;
 }
 declare const FormProvider: React.FC<FormProviderProps>;
@@ -354,6 +510,7 @@ declare function useForm(): {
     availableTransitions: WorkflowTransition[];
     hasPersistence: boolean;
     getSerializedValues: () => FormValues;
+    getRawValues: () => FormValues;
     markSubmitAttempted: () => void;
     flushPendingUploads: () => Promise<void>;
 };
@@ -376,6 +533,35 @@ declare function useField(fieldId: string): {
 
 declare const DynamicForm: React.FC;
 
+/** Shape of one differential diagnosis item from AI (must match form field value) */
+type AIDifferentialDiagnosisItem = {
+    category: string;
+    condition: string;
+    likelihood: string;
+    severity: string;
+    treatability: string;
+    keyFeatures?: string[];
+    nextSteps?: string[];
+};
+interface SmartFormProps {
+    /**
+     * Structured result from AI analysis (e.g. patient-doctor conversation).
+     * When this is set or updated, values are applied to the form by field ID.
+     * Only keys that exist in the form schema are applied; unknown keys are ignored.
+     * Fields are not marked as "touched" so you can distinguish AI-suggested vs user-edited if needed.
+     * Listens to both reference and content changes (e.g. streaming updates to the same object).
+     */
+    aiAnalysisResult?: Record<string, any> | null;
+}
+/**
+ * Form view that supports applying AI analysis results after load. Use inside
+ * FormProvider like DynamicForm. When aiAnalysisResult is provided (e.g. when
+ * AI finishes analyzing conversation), its values are applied to the form in
+ * one batch without marking fields as touched. Re-applies when the result
+ * reference or content changes (e.g. streaming or incremental AI updates).
+ */
+declare const SmartForm: React.FC<SmartFormProps>;
+
 interface FieldRendererProps {
     fieldId: string;
 }
@@ -461,4 +647,119 @@ interface CreateUploadHandlerOptions {
  */
 declare function createUploadHandler(options: CreateUploadHandlerOptions): (file: File | Blob, filename: string) => Promise<string>;
 
-export { type BaseFieldDef, type CheckboxFieldDef, type ColumnLayout, type Computation, type Condition, type CreateUploadHandlerOptions, type DataSource, DynamicForm, EMAIL_REGEX, type EditableTableColumnDef, type EditableTableFieldDef, type EventDefinition, type FieldDef, type FieldPrefill, FieldRenderer, type FieldState, type FieldType, FormControls, type FormControlsProps, type FormDef, type FormErrors, FormProvider, type FormState, FormStore, type FormValues, type ImageUploadFieldDef, ImageUploadWidget, type LayoutNode, type NumberFieldDef, type Permission, type PresignedUploadResponse, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type RepeatableFieldDef, type Rule, type RuleAction, type RuleResult, type ScoreComputation, type ScoreRange, type Section, type SectionChild, type SelectFieldDef, type SelectOption, type SignatureFieldDef, SignatureUploadWidget, type StaticTextFieldDef, type StoreConfig, type SubmissionData, type SumComputation, type TextFieldDef, type ValidationRule, type WebhookDef, type Workflow, type WorkflowTransition, createUploadHandler, evaluateRules, useField, useForm, useFormStore, validateField, validateForm };
+/** Shape of a medication as returned by AI analysis */
+type AIMedication = {
+    id: string | number;
+    brand_name: string;
+    generic_name: string;
+    form?: string;
+    strength?: string;
+    reason?: string;
+};
+
+type MedicationSearchResult = {
+    id: number;
+    name: string;
+    generic_name?: string;
+    manufacturer?: string;
+    score?: number;
+};
+type Medication = {
+    id: number;
+    brand_name: string;
+    generic_name: string;
+    frequency: string;
+    is_custom: boolean;
+    duration_value: string;
+    duration_unit: 'days' | 'weeks' | 'months';
+    before_after: 'AFTER FOOD' | 'BEFORE FOOD';
+    morning: string;
+    afternoon: string;
+    night: string;
+    notes: string;
+};
+type AddMedicationFieldProps = {
+    label?: string;
+    value: Medication[];
+    onChange: (items: Medication[]) => void;
+    onSearch: (query: string) => Promise<MedicationSearchResult[]>;
+    recentlyUsed?: MedicationSearchResult[];
+    /** AI-suggested medications shown as badges; clicking adds to value */
+    suggestedMedications?: AIMedication[];
+};
+declare const AddMedicationField: React.FC<AddMedicationFieldProps>;
+
+type InvestigationSearchResult = {
+    id: string;
+    name: string;
+    code?: string;
+    description?: string;
+    categories?: string[];
+    synonyms?: string[];
+    sample_type?: string;
+    method?: string;
+    reference_range?: string;
+    sample_unit?: string;
+    sample_qty?: number;
+    turnaround_time?: number;
+    preparation?: string;
+    service_type?: string;
+    department?: string;
+    is_vip_enabled?: boolean;
+    is_pacs_enabled?: boolean;
+    score?: number;
+};
+type Investigation = InvestigationSearchResult & {
+    label: string;
+    is_custom: boolean;
+    fromAI: boolean;
+};
+type AddInvestigationFieldProps = {
+    label?: string;
+    value: Investigation[];
+    onChange: (items: Investigation[]) => void;
+    onSearch: (query: string) => Promise<InvestigationSearchResult[]>;
+    recentlyUsed?: InvestigationSearchResult[];
+};
+declare const AddInvestigationField: React.FC<AddInvestigationFieldProps>;
+
+type DifferentialDiagnosisItem = {
+    category: string;
+    condition: string;
+    likelihood: string;
+    severity: string;
+    treatability: string;
+    keyFeatures?: string[];
+    nextSteps?: string[];
+};
+type DifferentialDiagnosisProps = {
+    differentialDiagnosis: DifferentialDiagnosisItem[];
+    className?: string;
+    height?: string;
+};
+/**
+ * - Outer: rounded border [#D0D0D0], highlight label strip (#FEE8EC)
+ * - Body: scrollable list of diagnosis cards with accordion expand/collapse
+ */
+declare const DifferentialDiagnosis: React.FC<DifferentialDiagnosisProps>;
+
+interface SmartKeywordsResult {
+    extractedNouns: string[];
+    matchedConditions: ExtractedKeywordMatch[];
+    isProcessing: boolean;
+    error: string | null;
+}
+/**
+ * Extracts noun phrases from `text` using compromise, deduplicates, then
+ * searches each noun against a backend master table via `onSearch`. Returns
+ * the flattened list of keyword-to-master-record matches.
+ *
+ * All NLP runs client-side; the backend only receives simple query strings.
+ */
+declare function useSmartKeywords(text: string, onSearch: (query: string) => Promise<any[]>, debounceDelay?: number): SmartKeywordsResult;
+
+declare const SmartTextareaWidget: React.FC<{
+    fieldId: string;
+}>;
+
+export { type AIDifferentialDiagnosisItem, AddInvestigationField, type AddInvestigationFieldProps, AddMedicationField, type AddMedicationFieldProps, type BaseFieldDef, type CheckboxFieldDef, type ColumnLayout, type Computation, type Condition, type CreateUploadHandlerOptions, type DataSource, DifferentialDiagnosis, type DifferentialDiagnosisFieldDef, type DifferentialDiagnosisItem, type DifferentialDiagnosisProps, DynamicForm, EMAIL_REGEX, type EditableTableColumnDef, type EditableTableFieldDef, type EventDefinition, type ExtractedKeywordMatch, type FieldDef, type FieldHandler, type FieldHandlersMap, type FieldPrefill, FieldRenderer, type FieldState, type FieldType, type FollowupFieldDef, type FollowupValue, FormControls, type FormControlsProps, type FormDef, type FormErrors, FormProvider, type FormState, FormStore, type FormValues, type FormulaComputation, type FormulaExpr, type ImageUploadFieldDef, ImageUploadWidget, type Investigation, type InvestigationSearchResult, type InvestigationsFieldDef, type LayoutNode, type MatchedCondition, type Medication, type MedicationSearchResult, type MedicationsFieldDef, type NumberFieldDef, type Permission, type PresignedUploadResponse, type ProceduresFieldDef, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type ReferralFieldDef, type ReferralItem, type RepeatableFieldDef, type Rule, type RuleAction, type RuleResult, type ScoreComputation, type ScoreRange, type Section, type SectionChild, type SelectFieldDef, type SelectOption, type SignatureFieldDef, SignatureUploadWidget, SmartForm, type SmartFormProps, type SmartKeywordsResult, type SmartTextareaFieldDef, type SmartTextareaValue, SmartTextareaWidget, type StaticTextFieldDef, type StoreConfig, type SubmissionData, type SumComputation, type TextFieldDef, type ValidationRule, type VitalsFieldDef, type WebhookDef, type Workflow, type WorkflowTransition, createUploadHandler, evaluateRules, useField, useFieldHandlers, useForm, useFormStore, useSmartKeywords, validateField, validateForm };