Skip to content

TOPOLOGY.adoc

Latest commit

 

History

History
101 lines (86 loc) · 6 KB

TOPOLOGY.adoc

File metadata and controls

101 lines (86 loc) · 6 KB
Raw

SuperNorma — Project Topology

System Architecture

        ┌─────────────────────────────────────────┐
        │                  USER                   │
        │   (web form / Power BI / future chat)   │
        └───────┬───────────────┬─────────────────┘
                │               │
                ▼               ▼
    ┌───────────────────┐  ┌──────────────────────┐
    │  ui/webform.html  │  │  Power BI workbook   │
    │  + src/UI.res     │  │  (dax/ measures over │
    │  (form hook)      │  │   workbook/ CSVs)    │
    └────────┬──────────┘  └──────────┬───────────┘
             │ (not wired yet)        │
             ▼                        ▼
    ┌─────────────────────────────────────────────┐
    │       CALCULATION CORE (src/Mod.res)        │
    │  net income · surplus · total savings ·     │
    │  pension projection (DB/DC/SIPP/ISA/State)  │
    └────────────────────┬────────────────────────┘
                         │ (future)
                         ▼
    ┌─────────────────────────────────────────────┐
    │   ADVISOR (advisor/system_prompt.txt)       │
    │   LLM persona: Bookkeeper / Forensic        │
    │   Analyst / Empowered Advocate — UNWIRED    │
    └─────────────────────────────────────────────┘

Completion Dashboard

COMPONENT                          STATUS              NOTES
─────────────────────────────────  ──────────────────  ─────────────────────────────────
CALCULATION CORE (RESCRIPT)
  Mod.res (finance kernels)        ████████░░  80%    Compiles; unit tests specify API
  UI.res (form hook)               ███░░░░░░░  30%    Submits to alert(); not wired to core
  Runtime/Assert/Testing/Csv       █████████░  90%    Bun-native bindings (bun:test,
  (src/bindings/)                                     Bun.file, node:fs/promises); no
                                                       external JS deps

CONTENT
  DAX measures (dax/)              ██████░░░░  60%    3 measures mirroring the core
  CSV templates (workbook/, data/) ██████░░░░  60%    Sample income + pension models
  Web form (ui/webform.html)       █████░░░░░  50%    Static form, no persistence
  Advisor prompt (advisor/)        ███░░░░░░░  30%    Persona text only; no model wiring

TESTS
  Unit (Mod/Data/Dax/Ui)           █████████░  90%    39 tests / 71 expect() calls,
                                                       verified passing via `bun run test:unit`
  Integration (Config/Html_form)   █████████░  90%    28 tests / 49 expect() calls,
                                                       verified passing via
                                                       `bun run test:integration`

REPO INFRASTRUCTURE
  package.json + bun.lock          █████████░  90%    build/test scripts defined; rescript
                                                       is a real devDependency (no more
                                                       npx-fetch-on-every-build)
  Justfile                         ███████░░░  70%    Delegates to bun scripts
  CI workflows (15)                ██████░░░░  60%    Heavy for repo size; external deps

─────────────────────────────────────────────────────────────────────────────
OVERALL:                            ████░░░░░░  ~35%   Build + full test suite (67 tests)
                                                       verified green end-to-end for the
                                                       first time

Previous versions of this dashboard described an AI developer-tools suite (AiCore, DataFramework, CLI, WebApp, DevTools) at ~90% completion. Those modules were never present in this repository; the dashboard now tracks what actually exists.

Path to a usable v0.1

  1. ☒ Compile ReScript so src/Mod.res.js exists and the *_test.res.js files run — done: bun run test passes 67/67 (see TESTS row above)

  2. Wire the web form to the calculation core and render results

  3. Wire the advisor persona to a local LLM (e.g. LM Studio’s OpenAI-compatible localhost API) with the calculation core supplying every number

  4. CSV import: parse workbook/ templates via src/bindings/Csv.res (pure ReScript, no external dependency) into financialRecord/pensionRecord values

Update Protocol

This file is maintained by both humans and AI agents. When updating:

  1. After completing a component: Change its bar and percentage

  2. After adding a component: Add a new row in the appropriate section

  3. After architectural changes: Update the ASCII diagram

  4. Date: Update the Last updated comment at the top of this file

Progress bars use: █ (filled) and ░ (empty), 10 characters wide. Percentages: 0%, 10%, 20%, … 100% (in 10% increments).