Form Field Extractor

The Form Field Extractor is a utility package designed to extract, validate, and fill form fields using text input, voice commands, or API-based data extraction. It leverages AI to parse input text and populate form fields accurately, ensuring a seamless user experience for developers and end-users alike.

Features

• Extract form field IDs and values dynamically from an HTML form.
• Populate form fields using text or voice inputs.
• Perform AI-based data extraction and validation via OpenAI API.
• Supports multiple input types: text, radio buttons, checkboxes, select fields, etc.
• Offers integration with text-to-speech (TTS) and speech recognition for hands-free form interaction.
• Error handling for missing fields with visual and auditory feedback.
• Customizable prompts and multilingual support (English and German).

Installation

You can install the package via npm:

npm install form-field-extractor

Or include it directly from the .tgz files in this repository:

npm install ./form-field-extractor-1.0.2.tgz

Usage

1. Extract and Populate Form Fields via Text

import { fillFormByText } from "form-field-extractor";

const formId = "myForm";
const sourceText = "My name is John Doe, I am 30 years old, born on May 15, 1993.";

fillFormByText(formId, sourceText)
    .then((extractedData) => {
        console.log("Extracted Data:", extractedData);
    })
    .catch((error) => {
        console.error("Error:", error);
    });

2. Populate Form Fields Using Voice Commands

import { fillFormByVoice } from "form-field-extractor";

const formId = "myForm";
const userPrompt = "Please provide your personal details.";
const languageCode = "en"; // 'en' for English, 'de' for German

fillFormByVoice(formId, userPrompt, languageCode, (status) => {
    console.log("Status Update:", status);
})
    .then((mergedData) => {
        console.log("Merged Data:", mergedData);
    })
    .catch((error) => {
        console.error("Error:", error);
    });

API Methods

fillFormByText(formId: string, sourceText: string)

Extracts and populates form fields based on the provided text.

• Parameters:
  • formId: The ID of the form element.
  • sourceText: The input text containing field data.
• Returns: An array of extracted form field objects.

fillFormByVoice(formId: string, userPrompt?: string, languageCode?: string, statusCallback?: (status: { isPlaying: boolean; isRecording: boolean }) => void)

Populates form fields via voice input.

• Parameters:
  • formId: The ID of the form to be filled.
  • userPrompt: A custom prompt for voice input.
  • languageCode: Language for speech recognition (en or de).
  • statusCallback: Callback to receive status updates of the mircrophone to add sound waves in the frontend.
• Returns: A promise resolving to the merged form data.

Dependencies

• react-toastify for notifications.

File Structure

├── helper.js          # Core logic for form field extraction and validation
├── index.js           # Entry point for text and voice-based form population
├── index.d.ts         # TypeScript definitions for exported methods
├── package.json       # Package metadata and dependencies
├── .npmignore         # Ignored files for npm packaging
├── form-field-extractor-1.0.1.tgz
└── form-field-extractor-1.0.2.tgz

Development

1. Clone the repository:

   git clone https://github.com/your-repo/form-field-extractor.git
   cd form-field-extractor

2. Install dependencies:

   npm install

3. Run your project or make changes.

License

This project is licensed under the ISC License.