formanitor 0.0.27 → 0.0.29

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import React from 'react';
 
-type FieldType = 'text' | 'number' | 'textarea' | 'richtext' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | 'medications' | 'investigations' | 'procedures' | 'vitals' | 'hidden_vitals' | 'referral' | 'followup' | string;
+type FieldType = 'text' | 'number' | 'textarea' | 'diagnosis_textarea' | 'richtext' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | 'medications' | 'investigations' | 'procedures' | 'vitals' | 'hidden_vitals' | 'referral' | 'followup' | string;
 interface ValidationRule {
     min?: number;
     max?: number;
@@ -63,6 +63,12 @@ interface BaseFieldDef {
      */
     theme?: string;
     meta?: Record<string, unknown>;
+    /**
+     * When true, a microphone button is rendered alongside this field so the
+     * user can dictate its value via speech.  Requires `StoreConfig.voice` to
+     * be wired up with an `onTranscribe` callback.
+     */
+    voice?: boolean;
 }
 interface TextFieldDef extends BaseFieldDef {
     type: 'text' | 'textarea';
@@ -209,6 +215,20 @@ interface SmartTextareaValue {
     text: string;
     extractedKeywords: ExtractedKeywordMatch[];
 }
+/** Selected diagnosis grade chip (single-selection). */
+interface DiagnosisGradeSelection {
+    condition: string;
+    grade: string;
+}
+/**
+ * Structured value for diagnosis_textarea fields.
+ * - `text` is the textarea content (what will be submitted).
+ * - `selectedGradesByCondition` stores one selected chip per condition for later metadata/preview use.
+ */
+interface DiagnosisTextareaValue {
+    text: string;
+    selectedGradesByCondition: Record<string, string>;
+}
 /**
  * Smart textarea that performs client-side NLP keyword extraction and searches
  * matched terms against backend master tables via `fieldHandlers[fieldId].onSearch`.
@@ -223,6 +243,19 @@ interface SmartTextareaFieldDef extends BaseFieldDef {
     /** Debounce delay in ms before NLP + search triggers. Default: 1000. */
     debounceDelay?: number;
 }
+/**
+ * Diagnosis textarea that can display condition-wise grade chips based on
+ * asynchronous API response.
+ *
+ * Value shape in form state can be plain text (legacy) or `DiagnosisTextareaValue`.
+ */
+interface DiagnosisTextareaFieldDef extends BaseFieldDef {
+    type: 'diagnosis_textarea';
+    /** Height in pixels. If omitted, uses default min height (80px). */
+    height?: number;
+    /** Debounce delay in ms before API call triggers. Default: 700. */
+    debounceDelay?: number;
+}
 interface MedicationFrequentItem {
     id: string;
     name: string;
@@ -269,7 +302,7 @@ interface DoctorFrequentItems {
     investigations?: InvestigationFrequentItem[];
     procedures?: ProcedureFrequentItem[];
 }
-type FieldDef = TextFieldDef | RichTextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | MedicationsFieldDef | InvestigationsFieldDef | ProceduresFieldDef | DifferentialDiagnosisFieldDef | VitalsFieldDef | ReferralFieldDef | FollowupFieldDef | SmartTextareaFieldDef | BaseFieldDef;
+type FieldDef = TextFieldDef | RichTextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | MedicationsFieldDef | InvestigationsFieldDef | ProceduresFieldDef | DifferentialDiagnosisFieldDef | VitalsFieldDef | ReferralFieldDef | FollowupFieldDef | SmartTextareaFieldDef | DiagnosisTextareaFieldDef | BaseFieldDef;
 interface Condition {
     field?: string;
     op: '==' | '!=' | '>' | '<' | '>=' | '<=' | 'in' | 'contains';
@@ -421,6 +454,17 @@ interface StoreConfig {
     onEvent?: EventListener;
     onUpload?: UploadHandler;
     onDraftChange?: DraftChangeHandler;
+    /**
+     * Voice dictation support.  When provided, fields marked with `voice: true`
+     * in the schema will display a microphone button.
+     * The host app owns all recording logic and supplies two callbacks:
+     * - `startRecording` — begin capturing audio
+     * - `stopRecording`  — stop capturing, transcribe, and return the transcript
+     */
+    voice?: {
+        startRecording: () => Promise<void>;
+        stopRecording: () => Promise<string>;
+    };
 }
 declare class FormStore {
     private state;
@@ -444,6 +488,7 @@ declare class FormStore {
     };
     getSchema(): FormDef;
     getFieldDef(fieldId: string): FieldDef | undefined;
+    getVoice(): StoreConfig['voice'];
     hasPersistence(): boolean;
     setValue(fieldId: string, value: any): void;
     /**
@@ -542,6 +587,11 @@ type FieldHandler = {
         label: string;
         value: any;
     }[]>;
+    /**
+     * Called by diagnosis_textarea widgets to fetch condition-wise grades
+     * from diagnosis text input.
+     */
+    onFetchDiagnosisGrades?: (query: string) => Promise<any>;
 };
 type FieldHandlersMap = Record<string, FieldHandler>;
 declare function useFieldHandlers(fieldId: string): FieldHandler;
@@ -860,4 +910,4 @@ 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, type DoctorFrequentItems, 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 InvestigationFrequentItem, type InvestigationSearchResult, type InvestigationsFieldDef, type LayoutNode, type MatchedCondition, type Medication, type MedicationFrequentItem, type MedicationSearchResult, type MedicationsFieldDef, type NumberFieldDef, type Permission, type PresignedUploadResponse, type ProcedureFrequentItem, type ProceduresFieldDef, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type ReferralFieldDef, type ReferralItem, type RepeatableFieldDef, type RichTextFieldDef, RichTextWidget, 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, useFrequentItems, useSmartKeywords, validateField, validateForm };
+export { type AIDifferentialDiagnosisItem, AddInvestigationField, type AddInvestigationFieldProps, AddMedicationField, type AddMedicationFieldProps, type BaseFieldDef, type CheckboxFieldDef, type ColumnLayout, type Computation, type Condition, type CreateUploadHandlerOptions, type DataSource, type DiagnosisGradeSelection, type DiagnosisTextareaFieldDef, type DiagnosisTextareaValue, DifferentialDiagnosis, type DifferentialDiagnosisFieldDef, type DifferentialDiagnosisItem, type DifferentialDiagnosisProps, type DoctorFrequentItems, 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 InvestigationFrequentItem, type InvestigationSearchResult, type InvestigationsFieldDef, type LayoutNode, type MatchedCondition, type Medication, type MedicationFrequentItem, type MedicationSearchResult, type MedicationsFieldDef, type NumberFieldDef, type Permission, type PresignedUploadResponse, type ProcedureFrequentItem, type ProceduresFieldDef, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type ReferralFieldDef, type ReferralItem, type RepeatableFieldDef, type RichTextFieldDef, RichTextWidget, 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, useFrequentItems, useSmartKeywords, validateField, validateForm };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 
-type FieldType = 'text' | 'number' | 'textarea' | 'richtext' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | 'medications' | 'investigations' | 'procedures' | 'vitals' | 'hidden_vitals' | 'referral' | 'followup' | string;
+type FieldType = 'text' | 'number' | 'textarea' | 'diagnosis_textarea' | 'richtext' | 'select' | 'multiselect' | 'radio' | 'repeatable' | 'checkbox' | 'image_upload' | 'signature' | 'date' | 'datetime' | 'editable_table' | 'static_text' | 'medications' | 'investigations' | 'procedures' | 'vitals' | 'hidden_vitals' | 'referral' | 'followup' | string;
 interface ValidationRule {
     min?: number;
     max?: number;
@@ -63,6 +63,12 @@ interface BaseFieldDef {
      */
     theme?: string;
     meta?: Record<string, unknown>;
+    /**
+     * When true, a microphone button is rendered alongside this field so the
+     * user can dictate its value via speech.  Requires `StoreConfig.voice` to
+     * be wired up with an `onTranscribe` callback.
+     */
+    voice?: boolean;
 }
 interface TextFieldDef extends BaseFieldDef {
     type: 'text' | 'textarea';
@@ -209,6 +215,20 @@ interface SmartTextareaValue {
     text: string;
     extractedKeywords: ExtractedKeywordMatch[];
 }
+/** Selected diagnosis grade chip (single-selection). */
+interface DiagnosisGradeSelection {
+    condition: string;
+    grade: string;
+}
+/**
+ * Structured value for diagnosis_textarea fields.
+ * - `text` is the textarea content (what will be submitted).
+ * - `selectedGradesByCondition` stores one selected chip per condition for later metadata/preview use.
+ */
+interface DiagnosisTextareaValue {
+    text: string;
+    selectedGradesByCondition: Record<string, string>;
+}
 /**
  * Smart textarea that performs client-side NLP keyword extraction and searches
  * matched terms against backend master tables via `fieldHandlers[fieldId].onSearch`.
@@ -223,6 +243,19 @@ interface SmartTextareaFieldDef extends BaseFieldDef {
     /** Debounce delay in ms before NLP + search triggers. Default: 1000. */
     debounceDelay?: number;
 }
+/**
+ * Diagnosis textarea that can display condition-wise grade chips based on
+ * asynchronous API response.
+ *
+ * Value shape in form state can be plain text (legacy) or `DiagnosisTextareaValue`.
+ */
+interface DiagnosisTextareaFieldDef extends BaseFieldDef {
+    type: 'diagnosis_textarea';
+    /** Height in pixels. If omitted, uses default min height (80px). */
+    height?: number;
+    /** Debounce delay in ms before API call triggers. Default: 700. */
+    debounceDelay?: number;
+}
 interface MedicationFrequentItem {
     id: string;
     name: string;
@@ -269,7 +302,7 @@ interface DoctorFrequentItems {
     investigations?: InvestigationFrequentItem[];
     procedures?: ProcedureFrequentItem[];
 }
-type FieldDef = TextFieldDef | RichTextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | MedicationsFieldDef | InvestigationsFieldDef | ProceduresFieldDef | DifferentialDiagnosisFieldDef | VitalsFieldDef | ReferralFieldDef | FollowupFieldDef | SmartTextareaFieldDef | BaseFieldDef;
+type FieldDef = TextFieldDef | RichTextFieldDef | NumberFieldDef | SelectFieldDef | RadioFieldDef | CheckboxFieldDef | RepeatableFieldDef | ImageUploadFieldDef | SignatureFieldDef | EditableTableFieldDef | StaticTextFieldDef | MedicationsFieldDef | InvestigationsFieldDef | ProceduresFieldDef | DifferentialDiagnosisFieldDef | VitalsFieldDef | ReferralFieldDef | FollowupFieldDef | SmartTextareaFieldDef | DiagnosisTextareaFieldDef | BaseFieldDef;
 interface Condition {
     field?: string;
     op: '==' | '!=' | '>' | '<' | '>=' | '<=' | 'in' | 'contains';
@@ -421,6 +454,17 @@ interface StoreConfig {
     onEvent?: EventListener;
     onUpload?: UploadHandler;
     onDraftChange?: DraftChangeHandler;
+    /**
+     * Voice dictation support.  When provided, fields marked with `voice: true`
+     * in the schema will display a microphone button.
+     * The host app owns all recording logic and supplies two callbacks:
+     * - `startRecording` — begin capturing audio
+     * - `stopRecording`  — stop capturing, transcribe, and return the transcript
+     */
+    voice?: {
+        startRecording: () => Promise<void>;
+        stopRecording: () => Promise<string>;
+    };
 }
 declare class FormStore {
     private state;
@@ -444,6 +488,7 @@ declare class FormStore {
     };
     getSchema(): FormDef;
     getFieldDef(fieldId: string): FieldDef | undefined;
+    getVoice(): StoreConfig['voice'];
     hasPersistence(): boolean;
     setValue(fieldId: string, value: any): void;
     /**
@@ -542,6 +587,11 @@ type FieldHandler = {
         label: string;
         value: any;
     }[]>;
+    /**
+     * Called by diagnosis_textarea widgets to fetch condition-wise grades
+     * from diagnosis text input.
+     */
+    onFetchDiagnosisGrades?: (query: string) => Promise<any>;
 };
 type FieldHandlersMap = Record<string, FieldHandler>;
 declare function useFieldHandlers(fieldId: string): FieldHandler;
@@ -860,4 +910,4 @@ 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, type DoctorFrequentItems, 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 InvestigationFrequentItem, type InvestigationSearchResult, type InvestigationsFieldDef, type LayoutNode, type MatchedCondition, type Medication, type MedicationFrequentItem, type MedicationSearchResult, type MedicationsFieldDef, type NumberFieldDef, type Permission, type PresignedUploadResponse, type ProcedureFrequentItem, type ProceduresFieldDef, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type ReferralFieldDef, type ReferralItem, type RepeatableFieldDef, type RichTextFieldDef, RichTextWidget, 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, useFrequentItems, useSmartKeywords, validateField, validateForm };
+export { type AIDifferentialDiagnosisItem, AddInvestigationField, type AddInvestigationFieldProps, AddMedicationField, type AddMedicationFieldProps, type BaseFieldDef, type CheckboxFieldDef, type ColumnLayout, type Computation, type Condition, type CreateUploadHandlerOptions, type DataSource, type DiagnosisGradeSelection, type DiagnosisTextareaFieldDef, type DiagnosisTextareaValue, DifferentialDiagnosis, type DifferentialDiagnosisFieldDef, type DifferentialDiagnosisItem, type DifferentialDiagnosisProps, type DoctorFrequentItems, 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 InvestigationFrequentItem, type InvestigationSearchResult, type InvestigationsFieldDef, type LayoutNode, type MatchedCondition, type Medication, type MedicationFrequentItem, type MedicationSearchResult, type MedicationsFieldDef, type NumberFieldDef, type Permission, type PresignedUploadResponse, type ProcedureFrequentItem, type ProceduresFieldDef, type RadioFieldDef, ReadOnlyForm, ReadOnlyImageUpload, ReadOnlySignature, ReadOnlyTable, type ReferralFieldDef, type ReferralItem, type RepeatableFieldDef, type RichTextFieldDef, RichTextWidget, 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, useFrequentItems, useSmartKeywords, validateField, validateForm };