@neuraform/core

The Brain of Your Forms. Framework-agnostic graph-based form engine that eliminates "condition hell" in complex multi-step flows.

🚀 Why Graph-Based?

Traditional linear forms ([Step1, Step2, Step3]) break when logic gets complex. NeuraForm treats your form as a Directed Acyclic Graph (DAG).

graph LR
  Start((Start)) --> UserType{User Type?}
  UserType -->|Business| Biz[Business Details]
  UserType -->|Individual| Pers[Personal Details]
  Biz --> Tax[Tax Info]
  Pers --> Complete((Complete))
  Tax --> Complete
  style Start fill:#f9f,stroke:#333,stroke-width:2px
  style Complete fill:#9f9,stroke:#333,stroke-width:2px

| Feature | ❌ Linear Forms | ✅ NeuraForm (Graph) | | :--- | :--- | :--- | | Logic | Nested if/else spaghetti | Declarative Edges | | Navigation | Hardcoded implementation | Auto-computed Paths | | Progress | Step / Total (Inaccurate) | Weighted Path Calculation | | Validation | Field-level only | Predictive Path Validation |

📦 Installation

npm install @neuraform/core

⚡ Quick Start

import { NeuraFormEngine } from '@neuraform/core';

// 1. Define your map (Schema)
const schema = {
  id: 'onboarding-flow',
  initial: 'welcome',
  states: {
    welcome: {
      on: { NEXT: 'userType' }
    },
    userType: {
      on: {
        BUSINESS: 'businessDetails',
        INDIVIDUAL: 'personalDetails'
      }
    },
    businessDetails: { on: { NEXT: 'complete' } },
    personalDetails: { on: { NEXT: 'complete' } },
    complete: { type: 'final' }
  }
};

// 2. Initialize the engine
const engine = new NeuraFormEngine({
  schema,
  autoSave: true, // Auto-saves to IndexedDB
  onComplete: (data) => console.log('🎉 Form Completed:', data)
});

await engine.start();

// 3. Drive!
console.log(engine.getCurrentState()); // 'welcome'
await engine.transition('NEXT'); 
console.log(engine.getCurrentState()); // 'userType'

📚 Documentation

• Core Concepts - Learn about Nodes, Edges, and Travelers.
• API Reference - Full method documentation.
• Examples - Real-world usage.

📄 License

MIT © Mehul Birare