Compare commits

..

185 commits
main ... v6.3.1

Author SHA1 Message Date
github-actions[bot]
8097b0fe0b Release v6.3.1
Some checks failed
Build & release Android APK / Build signed APK (push) Has been cancelled
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / Build linux/amd64 (push) Has been cancelled
Build & Push Docker Image / Build linux/arm64 (push) Has been cancelled
Build & Push Docker Image / Merge manifests (push) Has been cancelled
2026-04-19 19:26:56 +00:00
Daniel
a76aead242 fix: auth/API logging to Loki, TTS voice auto-detection, STT ElevenLabs support
Some checks failed
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / Build linux/amd64 (push) Has been cancelled
Build & Push Docker Image / Build linux/arm64 (push) Has been cancelled
Build & Push Docker Image / Merge manifests (push) Has been cancelled
- Add logger.audit/access calls to auth route (login, login_failed,
  login_blocked, register, password_changed, 2fa_backup_code_used,
  2fa_backup_codes_regenerated) — these previously only wrote to DB
  via raw SQL, bypassing Loki shipper
- Replace logger.info with logger.apiCall in callAI() so every AI call
  ships to Loki with model, tokens, cost, duration
- Add device identifier (parsed user agent) to audit and access logs
- Fix TTS voice/model provider mismatch: auto-detect Vertex voices
  (Puck, Charon, Kore, etc.) and ElevenLabs voice IDs, override model
  to match provider regardless of what model was previously set
- Fix TTS discovery: model IDs saved to tts.voice are detected and
  redirected to tts.model (regex for openai-tts, elevenlabs, vertex-tts)
- Fix STT transcription route: add scribe/elevenlabs/transcri to the
  isTranscriptionModel regex so ElevenLabs Scribe uses /audio/transcriptions
  endpoint instead of chat completions
- Remove OpenObserve/SigNoz code from logger (reverted to Loki-only)
2026-04-19 21:26:49 +02:00
github-actions[bot]
0ab48eeb98 Release v6.3.0
Some checks failed
Build & release Android APK / Build signed APK (push) Has been cancelled
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / Build linux/amd64 (push) Has been cancelled
Build & Push Docker Image / Build linux/arm64 (push) Has been cancelled
Build & Push Docker Image / Merge manifests (push) Has been cancelled
2026-04-19 00:17:21 +00:00
Daniel
d79d9eeded feat: neonatal calculator, DOCX/PPTX/ODT/EPUB support, gateway-agnostic URL helper, TTS/STT fixes
- Add neonatal assessment calculator: GA classification (extremely preterm through
  post term), weight-for-GA percentile (AGA/SGA/LGA) using Fenton 2013 LMS data,
  birth weight category (ELBW/VLBW/LBW/normal/macrosomia)
- Add DOCX support via mammoth, PPTX/ODT/EPUB via jszip in Learning Hub content
  generator file upload
- Add gatewayUrl() helper for consistent API URL construction — handles
  LITELLM_API_BASE with or without /v1 suffix, works with any OpenAI-compatible
  gateway (LiteLLM, Bifrost, etc.)
- Fix TTS model/voice separation: discovery now tags items as MODEL or VOICE,
  auto-detects provider from voice name (Vertex, ElevenLabs, OpenAI)
- Fix STT discovery to include ElevenLabs Scribe and Chirp models
- Fix TTS discovery to include ElevenLabs and Vertex voices alongside models
- Fix admin model test to bypass allowlist check (skipAllowlistCheck) so
  discovered models can be tested before adding
- Fix Nextcloud token decryption in learningAI.js WebDAV browse and file import
- Fix admin embedding test to show DB model name instead of hardcoded default
- Fix admin STT test to use correct endpoint for Whisper models
- Add AI gateway migration guide to configuration docs
- Add Grafana dashboard JSON for Loki log visualization
2026-04-19 02:17:06 +02:00
Daniel
46b66a4507 docs: rewrite architecture, authentication, configuration, deployment, ai-providers, speech, database, learning-hub, migrations, developer-guide for public audience
- Drop first/second-person voice; reference-style prose throughout
- Remove stale information; align with current code (argon2id primary, hybrid cookie/Bearer auth, sliding 24h idle, AES-256-GCM PHI at rest, backup codes, node-pg-migrate, collation-drift guard, multi-arch Docker, auto-version pipeline)
- Preserve all technical accuracy and code examples
- Remove any remaining references to separate PedsHub Quiz app
- Keep consistent tone across files (tables + code blocks, imperatives where needed)
- api-reference.md and developer-guide.md route tables expanded to reflect current routes (billing, sessions)
2026-04-15 00:26:38 +02:00
Daniel
30244276bf docs: clarify com.pedshub.scribe is the Android applicationId, not a quiz-app ref 2026-04-15 00:13:17 +02:00
github-actions[bot]
b64a39f8ea Release v6.2.1
Some checks failed
Build & release Android APK / Build signed APK (push) Has been cancelled
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / Build linux/amd64 (push) Has been cancelled
Build & Push Docker Image / Build linux/arm64 (push) Has been cancelled
Build & Push Docker Image / Merge manifests (push) Has been cancelled
2026-04-14 22:10:45 +00:00
Daniel
ce170f6fc1 fix: verify auto-version → android + docker pipeline end-to-end 2026-04-15 00:10:35 +02:00
Daniel
5beb6cd562 ci: multi-arch Docker via native runners + Node 24 opt-in + PAT for tag-trigger chain
docker-publish.yml:
  - Rewrote as matrix build + manifest merge.
  - amd64 on ubuntu-latest, arm64 on ubuntu-24.04-arm (free for public
    repos). No QEMU — argon2 and every other native dep compile on
    their target CPU, no more SIGILL / exit 132.
  - Per-arch GHA cache scopes so builds don't thrash each other.
  - Final step merges both digests under one tag (vX.Y.Z + latest),
    publishing a real multi-arch manifest. `docker pull` from either
    arch gets the right variant automatically.

auto-version.yml, version-bump.yml:
  - Checkout now uses `secrets.RELEASE_PAT || secrets.GITHUB_TOKEN`.
    With RELEASE_PAT set, the tag push this workflow does DOES
    trigger downstream (android-release, docker-publish). Without
    it, falls back to GITHUB_TOKEN (no downstream trigger, what we
    have today).

All workflows (auto-version, version-bump, android-release,
docker-publish):
  - Added FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: 'true' so actions
    still on Node 20 runtime (checkout/cache/setup-*) opt in to
    Node 24 early. GitHub makes Node 24 default 2026-06-02 and
    removes Node 20 2026-09-16.

To finish the chain (one-time user step): create a fine-grained
PAT with "Contents: Read and write" on this repo and add as
RELEASE_PAT secret. After that `feat:` / `fix:` commits auto-tag
AND auto-build with zero manual intervention.
2026-04-15 00:05:34 +02:00
Daniel
4cb1080881 docs: strip PedsHub Quiz refs from mobile-build + terser CONTRIBUTING
mobile-build.md:
  - Removed "PedsHub Quiz" sections. That app lives in a separate
    repo (quiz/mobile/) and has its own build pipeline. Docs here
    are PedScribe-only now.
  - Reorganized around CI as the primary flow, local build as
    fallback. Added explicit secret names, JDK requirement, single-
    quote-password caveat, QEMU/argon2 note.
  - File-map section at the end so the native sources are
    discoverable without grepping.

CONTRIBUTING.md:
  - Cut the narrative prose. Dev-facing tables + single-line
    commands only. Decision-tree removed (the table suffices).
  - Release pipeline and mobile build link out rather than
    duplicating content.
2026-04-14 23:54:41 +02:00
github-actions[bot]
9a437c831c Release v6.2.0
Some checks failed
Build & release Android APK / Build signed APK (push) Has been cancelled
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / build (push) Has been cancelled
2026-04-14 21:51:17 +00:00
Daniel
65a5dff9b4 docs: add CONTRIBUTING.md + .gitmessage template for conventional commits
Drops a cheat sheet (CONTRIBUTING.md) in repo root so anyone — you,
future maintainers — has the full commit-prefix table one glance
away. Covers which prefixes trigger a release and which don't.

Also adds .gitmessage that you can optionally wire into git as the
default commit template:

  git config --local commit.template .gitmessage

Opens the cheat sheet in your editor every time you `git commit`
without -m. Remove it with `git config --local --unset commit.template`.

This commit uses `docs:` prefix so it does NOT trigger a release —
proving the auto-version workflow's filter works.
2026-04-14 23:51:09 +02:00
Daniel
0d6d91e8ef feat: auto-version workflow — tags managed by commit messages
Adds .github/workflows/auto-version.yml that fires on every push to
main, parses commit messages since the last semver tag, and decides
whether to cut a new release:

  feat:      → minor bump   (new feature, backward-compatible)
  fix:       → patch bump   (bug fix)
  feat!:     → major bump   (breaking change)
  BREAKING CHANGE in body → major bump
  docs/chore/refactor/style/test/ci → no release

If any commit since the last tag matches feat/fix/BREAKING, the
workflow bumps versions across package.json, mobile/package.json,
mobile/android/app/build.gradle, commits the change as
"Release vX.Y.Z", tags it, and pushes. The tag push then fires the
existing android-release and docker-publish workflows.

You no longer need to remember "what version am I on?" — just commit
with a conventional-commits prefix and push. Docs-only or refactor
commits don't create releases. Add [skip ci] to any commit message
to skip this workflow for that commit.
2026-04-14 23:47:37 +02:00
Daniel
ed69fb0cc8 CI: fix docker multi-arch crash + add one-click version-bump workflow
docker-publish.yml:
  - Dropped linux/arm64 from the platforms matrix. The amd64 GitHub-
    hosted runner builds arm64 under QEMU emulation, which fails at
    native argon2 compile with SIGILL (exit 132). Your production
    box is x86, so arm64 isn't needed. Add it back with a native
    ARM runner the day you deploy to ARM hardware.

version-bump.yml (new):
  - Manual Actions trigger. Click "Run workflow" → pick patch / minor /
    major (or type a custom X.Y.Z). The workflow computes the next
    semver from the current package.json version, updates all three
    version sites (package.json, mobile/package.json, Android
    versionName + versionCode), commits "Release vX.Y.Z", tags it,
    and pushes. The tag push then fires android-release.yml and
    docker-publish.yml automatically — APK + Docker image published
    with no local commands required.

Typical flow now:
  Actions → "Version bump & release" → Run workflow → patch
    ↓
  Bump + tag in ~5 s
    ↓
  Parallel: android APK build (~2 m), docker image push (~4 m)
    ↓
  Both assets show up on the new release; Obtanium + docker-hub
  subscribers see the update automatically.
2026-04-14 23:44:47 +02:00
Daniel
0b0bfc4a8a release.sh: drop node dependency, use sed for version bump 2026-04-14 23:40:38 +02:00
Daniel
26857d52da Release v6.1.1
Some checks failed
Build & release Android APK / Build signed APK (push) Has been cancelled
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / build (push) Has been cancelled
2026-04-14 23:40:10 +02:00
Daniel
ce466570ee Add mobile/.gitignore (should have been in prior cleanup commit) 2026-04-14 23:39:26 +02:00
Daniel
c6d238c560 Untrack Capacitor-generated files + node_modules in mobile/
The mobile/ wrapper had 1700+ node_modules files tracked, plus the
Capacitor-regenerated artifacts that get rewritten on every
`npx cap sync android` (capacitor.build.gradle, capacitor.config.json,
capacitor.plugins.json, capacitor.settings.gradle, the cordova-android-
plugins subtree). Every local dev or CI sync caused noisy drift that
blocked scripts/release.sh from running.

Added mobile/.gitignore covering node_modules, cap-sync outputs,
Android build outputs, .jks/.apk/.aab files, and .DS_Store.
Kept package-lock.json tracked for reproducible npm install.

No logic changes — only stopped tracking files that are always
regenerated.
2026-04-14 23:35:23 +02:00
Daniel
5439c1a742 CI: GitHub Actions workflow to auto-build signed Android APK on tag push
On every v*.*.* tag push the workflow:
  1. Checks out the repo
  2. Sets up JDK 17 + Node 20 + Android SDK (cached between runs)
  3. Runs npm install + npx cap sync android in mobile/
  4. Restores the signing keystore from ANDROID_KEYSTORE_BASE64 secret
  5. Builds a signed release APK via gradle
  6. Renames to pedscribe-X.Y.Z.apk
  7. Creates/updates the matching GitHub release with the APK attached
     and make_latest=true so the /releases/latest URL always points to
     the newest build (Obtanium and the login-page link pick it up
     automatically)

Required repo secrets (set via gh secret set ... or the GitHub UI):
  ANDROID_KEYSTORE_BASE64   base64 -w0 of the .jks file
  ANDROID_KEYSTORE_PASSWORD keystore password
  ANDROID_KEY_ALIAS         key alias (pedscribe)
  ANDROID_KEY_PASSWORD      key password (same as keystore in our setup)

Typical release flow after this lands:
  scripts/release.sh 6.1.1 --push      (laptop, 5 sec)
  ── Actions builds APK in ~8-10 min ──
  ── Release updates automatically with signed APK ──
  ── Obtanium clients notice on next poll ──
2026-04-14 23:24:17 +02:00
Daniel
6d6b4b90d2 Version alignment + release script — single source of truth
Aligns every version string in the repo to 6.1.0:
  - package.json: 6.0.0 → 6.1.0
  - mobile/package.json: 1.0.0 → 6.1.0
  - mobile/android/app/build.gradle: versionCode 1 → 610,
      versionName "1.0" → "6.1.0"
  - server.js: hardcoded "v6.0" → reads root package.json at boot
  - /api/health/detailed now reports APP_VERSION from package.json

Adds scripts/release.sh — a one-command bump:
  scripts/release.sh 6.1.1                # local bump + tag
  scripts/release.sh 6.1.1 --push         # + git push
  scripts/release.sh 6.1.1 --push --gh    # + GitHub release (uploads
                                            APK if already built)

Updates all three version sites, commits "Release v6.1.1",
creates annotated tag, optionally pushes and opens a release.
versionCode encoded as MAJ*100000 + MIN*1000 + PATCH so patch
updates always increment monotonically.
2026-04-14 23:18:47 +02:00
Daniel
0360685306 Hide APK download link on the native Android app
The "Download Android app (APK)" link on the login page is pointless
when the user is already inside the Capacitor app. Wrapped the link
in id="apk-download-link" and added a native-app-only hide pass in
auth.js that runs against a short array of web-only element IDs.

Add more entries to that array as other web-only UI appears, so the
mobile wrapper can diverge cleanly from the web UI without branching
the HTML.
2026-04-14 22:47:59 +02:00
Daniel
3b67d325fc Replace all 'Johns Hopkins Kids Kard' citations with 'Harriet Lane Handbook' 2026-04-14 22:41:10 +02:00
Daniel
2de10dc544 Bhutani: swap eyeballed values for pre-digitized table from codingace.net
Replaces my best-effort image readings with the pre-digitized
JavaScript data arrays extracted from codingace.net's open
Bhutani calculator (their arrays were embedded in the page
source, apparently digitized from the original Figure 2 at
6-hour granularity through 72 h).

Cross-checked against the AAP 2004 CPG reproduction of the same
Bhutani chart (Southern Health Manitoba clinical policy PDF).
Classifications at several spot-check points (24/36/41/72 h at
varying TSB) match expected zones.

User's reference case (41 h of life, TSB 9.7 mg/dL):
  p95 ≈ 13.6, p75 ≈ 11.4, p40 ≈ 9.1
  → Low-Intermediate Zone  ✓  (matches clinician expectation)

Data source now properly cited in both the in-code block comment
and the on-card footer text. Tool still documents that AAP 2022
is the correct tab for phototherapy decisions.
2026-04-14 13:05:54 +02:00
Daniel
a125bf9e9c Bhutani: replace unsourced values with image-read Stanford nomogram
The previous bhutaniZones table was introduced in the initial
calculator commit (61cf096, 2026-04-09) without any source citation
and was systematically ~0.5-1 mg/dL below the published Bhutani 1999
curves — borderline patients got pushed into the next-higher zone.

New values read directly from the Stanford Medicine Newborn Nursery
reproduction of Bhutani 1999 Figure 2:
  https://med.stanford.edu/newborns/professional-education/jaundice-and-phototherapy/bhutani-nomogram.html

Uncertainty: ±0.3 mg/dL (values eyeballed from a 556 px rendered
graph, not a published table). This is called out explicitly in
both the in-code comment and the Bhutani tab footer, which also
points clinicians to the AAP 2022 tab for actual phototherapy
decisions.

Spot-check: 41h of life, TSB 9.7 mg/dL
  Before: p75=9.33 → High-Intermediate Zone (wrong)
  After:  p75=10.1 → 9.7 below p75, above p40 → Low-Intermediate ✓

No interpolation or decision logic changed — only the lookup data
and its citation.
2026-04-14 13:02:26 +02:00
Daniel
13eb968249 Vitals: simplify source to 'Harriet Lane Handbook' 2026-04-14 12:48:06 +02:00
Daniel
66ea127574 Citations: move Harriet Lane label to Vitals; restore honest Bhutani cite
Vitals — updated source attribution to "Harriet Lane — Johns Hopkins
Children's Center Kids Kard" (was just Kids Kard). Both the card
subtitle and the intro line.

Bhutani — reverted my incorrect "Harriet Lane" citation (the values
in our table were never transcribed from Harriet Lane). Restored the
original attribution to the 1999 paper. Data itself is unchanged from
the pre-session state; treat it as unverified pending a clinician-
supplied source.
2026-04-14 12:43:17 +02:00
Daniel
b03232c963 Bhutani tab: cite Harriet Lane (Johns Hopkins Kids Kard) as source 2026-04-14 12:40:04 +02:00
Daniel
18811afbb5 Revert "Fix Bhutani nomogram values — correct percentile tables"
This reverts commit 48e0749435823376efa581e33db34f09d3123b52.
2026-04-14 12:35:36 +02:00
Daniel
7336e318be Fix Bhutani nomogram values — correct percentile tables
Previous table was ~0.5-1.0 mg/dL below the published Bhutani 1999
nomogram at every reference point, which pushed borderline patients
into the next-higher zone. Coarse 12-hour granularity made the
interpolation error worse between reference points.

Corrected to the PediTools-vetted values (same source we use for
AAP 2022) with 6-hour granularity. Source: Bhutani VK et al.,
Pediatrics 1999;103(1):6-14.

Example: 41h of life, TSB 9.7 mg/dL
  Before: p75=9.33 → TSB above p75 → "High-Intermediate Zone" (wrong)
  After:  p75=10.25 → TSB below p75, above p40 → "Low-Intermediate Zone"
          (matches the published nomogram)

No code-path changes — only the lookup data.
2026-04-14 12:32:07 +02:00
Daniel
ab94239659 Revert "Bilirubin chart: BiliTool/PediTools-style visual polish (no data changes)"
This reverts commit e6d90f4ba686d73aaf3958e68b08bb2d1c4026de.
2026-04-14 12:27:14 +02:00
Daniel
c98c571c66 Revert "Bili chart: shorter labels + wider right padding to stop clipping"
This reverts commit 110924807c412cd47c56eccf3ce9ee4053f8a7a4.
2026-04-14 12:27:14 +02:00
Daniel
907e131dc8 Bili chart: shorter labels + wider right padding to stop clipping
Replaced "Phototherapy" with the clinical abbreviation "Photo Tx"
(fits in the right margin without cut-off). Exchange label stays.
Bumped the layout right-padding from 40 px to 88 px so even the
longest label ("95th (High-Risk)" on the Bhutani chart) prints
fully inside the canvas on narrow viewports.
2026-04-14 12:21:42 +02:00
Daniel
553449dbec Bilirubin chart: BiliTool/PediTools-style visual polish (no data changes)
Pure visual improvements to renderBiliChart. Interpolation, lookup
tables, and threshold math are all untouched.

AAP chart now has three-zone shading matching BiliTool's convention:
  - Faint green tint below the phototherapy curve (safe zone)
  - Amber band between phototherapy and exchange (treatment zone)
  - Unshaded above the dashed crimson exchange line (danger)
  Phototherapy line: solid orange 2.4 px; Exchange: dashed crimson.

renderBiliChart common improvements:
  - Right-edge label on each threshold line ("Phototherapy", "Exchange",
    or "95th (High-Risk)" for Bhutani) with white halo — identifiable
    without a legend, like PediTools
  - Legend removed (replaced by the inline labels)
  - X-axis auto-ranges to fit the actual data with tick every 12 h
  - Y-axis tick every 5 mg/dL for clean BiliTool-style gridlines
  - 40 px right padding so labels don't clip
  - Patient dot shrunk from r=8 to r=5 with a 1.8 px white ring,
    redrawn on top of every label + its TSB value printed next to it
  - Bhutani chart inherits all the same improvements without changing
    its own zone/fill setup
2026-04-14 12:17:32 +02:00
Daniel
d4546b7d02 Growth charts: back to 7 percentile lines (drop 5th and 95th)
Reduces label crowding at the chart extremes. Clinical meaning
preserved: 3rd and 97th remain as the abnormal-threshold dashed
outermost lines, 10/25/50/75/90 give the mid trend. The bidirectional
label spread, leader lines, and dot-on-top rendering from the prior
pass all still apply to the 7-line layout.

Fills updated for new indexes (3↔97, 10↔90, 25↔75).
2026-04-14 07:16:38 +02:00
Daniel
f63d93807b Growth charts: bidirectional label spread + leaders + dot-on-top
Labels at the top (97/95/90) crowd just as much as the bottom
trio — prior forward-only pass only spread the bottom. Now:
  - Forward pass pushes items DOWN when crowded from above
  - Backward pass pulls items UP when still crowded from below
  - Min gap bumped 13 → 15 px for breathing room
  - Labels clamped to stay inside chart top/bottom
  - Thin leader line drawn from native curve position to the label
    when the two diverge by more than 2 px, so you can still see
    which line a nudged label belongs to
  - Patient dot redrawn on top of all labels at the very end of
    the plugin so a top-region label can never cover the dot
    (Chart.js's afterDatasetsDraw fires after dataset rendering,
    so the native dot was being painted over).
2026-04-14 07:10:20 +02:00
Daniel
ef6c90a889 Growth charts: fix label ordering + shrink patient dot
Label plugin rewritten:
  - Collect all percentile-line labels with their native screen Y
  - Sort top-to-bottom (97th ... 3rd) so order is always correct
  - Walk the sorted list and enforce 13px min vertical gap by
    pushing down (never reordering)
  - Second-pass pull-back if the stack would clip off the chart
    bottom
  Prior logic could nudge "10th" past "3rd" because it moved labels
  independently without respecting their natural screen order.

Patient dot: radius 8 → 5 (hover 11 → 7). The 8px ring was
dominating the chart; 5px is still clearly visible with the 1.8px
white border but no longer obscures adjacent curves.
2026-04-14 07:06:49 +02:00
Daniel
09d07d7e0f Growth charts: restore full 9-percentile Epic/CDC line set
Reverted from the 7-line reduced set back to the full clinical set:
3rd, 5th, 10th, 25th, 50th, 75th, 90th, 95th, 97th — matching what
Epic and the printed AAP/CDC/WHO charts display.

Kept the mobile-readability improvements from the prior pass:
  - Each percentile is a distinct hue (red / deep-orange / orange /
    amber / green / blue / violet / purple / pink)
  - Outer 3rd + 97th are dashed (abnormal-threshold convention); 5th
    and 95th use a tighter dash; rest solid
  - 50th remains bold green to anchor the center
  - Label plugin's white halo + vertical nudge keeps 3/5/10 and
    90/95/97 label stacks legible
  - Patient dot still on top, white-ringed

Fill bands updated for 9 indexes (3↔97, 5↔95, 10↔90, 25↔75).
2026-04-14 07:02:46 +02:00
Daniel
87b2017919 Growth charts: 7 distinct-color percentile lines + readable mobile labels
Reduced reference curves from 9 to 7 (dropped 5th and 95th — they
crowd the 3rd/10th and 90th/97th labels on small screens without
adding clinical value; 3rd and 97th are the US/WHO standard
abnormal thresholds).

Each percentile now gets a distinct hue:
  3rd  red     50th green (bold)    90th violet
  10th orange  75th blue            97th pink
  25th amber                        (3rd/97th dashed)

Label plugin improvements:
  - Bolder 11px font (was 10px)
  - White halo stroke behind text so labels stay legible when the
    line they sit on is also colored
  - Vertical nudge when two labels would overlap — keeps adjacent
    percentiles readable on mobile aspect ratios
  - Solid fill color (strips alpha from borderColor)

Patient dot:
  - Moved to order: -1 (drawn on top of everything, including labels
    and fill bands)
  - White 2.5px border ring so it's visible even when it lands
    exactly on a colored curve
  - Slightly larger hover radius (11 → was 10)
2026-04-14 07:01:53 +02:00
Daniel
c266ff2541 Growth charts: label each percentile curve (3rd, 50th, 97th, …)
Adds a Chart.js plugin that draws the percentile label at the right
end of each reference line, matching the convention on printed
WHO/CDC growth charts. Lets clinicians identify lines at a glance
without using the legend. Canvas gets 30px right-padding so the
labels don't get clipped.
2026-04-14 06:55:12 +02:00
Daniel
ec7e3d84b7 Cache-busting version stamps + client-side encounter version tracking
1. Build-ID cache busting (server.js):
   - Compute a BUILD_ID at boot: git HEAD short hash if available,
     else /app/BUILD_ID file, else random-on-boot.
   - On first request for /, rewrite every local /js/*.js and
     /css/*.css reference in index.html to include ?v=BUILD_ID.
     Cached once at startup so subsequent renders are free.
   - X-Build-Id response header + GET /api/build expose it for
     debugging.
   - Eliminates the "works after hard-refresh" class of bugs: every
     deploy gets a new build ID, so browsers fetch fresh JS/CSS on
     the very next page load.

2. Optimistic encounter locking wired into the client
   (public/js/encounters.js):
   - On resumeEncounter(): stash enc.version into
     window._encounterVersions[id]
   - On saveEncounter(): send expected_version in the POST body
     when we have one.
   - Server returns 409 if another tab/device wrote first → user
     sees "Someone else edited this encounter. Reload to see the
     latest version." instead of silently clobbering the prior save.
   - On success, remember the new server-assigned version for the
     next save.
2026-04-14 05:40:42 +02:00
Daniel
5888a9da0e Fix: local-auth users lose Password/2FA/Sessions after refresh
Previous check was strict (canLocalAuth !== true → hide). On a
transient /me hiccup or when the boot cache lagged, a legit local
user saw empty Settings with none of the sections they should see.

Inverted the predicate: hide only when canLocalAuth === false
(explicit SSO-only signal from the server). Undefined/missing now
defaults to show — local-auth users never lose their own UI.
Still hides correctly for the documented SSO-only case because the
/me endpoint sets the flag to false explicitly for those users.
2026-04-14 05:32:30 +02:00
Daniel
ea03db3d45 Prompt-injection wrap: remaining AI routes
Applied the <UNTRUSTED_*> delimiter + INJECTION_GUARD pattern to:
  - src/routes/sickVisit.js  (chief complaint, transcript, dictation,
                               ROS, physical exam, diagnoses, style hints)
  - src/routes/wellVisit.js  (SSHADESS answers + full well-visit context)
  - src/routes/chartReview.js (PMH + all visit content + labs)
  - src/routes/hospitalCourse.js (all notes/H&P/ED + clarification
                                   & update endpoints)
  - src/routes/milestones.js (narrative + summary)

Each wraps patient-derived text in <UNTRUSTED_*>…</UNTRUSTED_*>
tags and appends the INJECTION_GUARD system instruction that tells
the model to treat wrapped content strictly as data. Operator-
supplied `additionalInstructions` stays unwrapped (trusted).
2026-04-14 05:31:54 +02:00
Daniel
63f77aa9cf Batch of security + scale fixes
Age parser (src/routes/billing.js):
  - Now sums year + month + week + day matches so "4 yr 11 mo"
    (59 months) correctly maps to the 5-11y billing bracket instead
    of being billed as 1-4y. Added bounds sanity check.

Graceful SIGTERM shutdown (server.js):
  - Closes the HTTP listener first, then drains batched audit queues,
    then ends the Postgres pool. 9-second hard deadline to beat
    Docker's 10-second SIGKILL. Previously an in-flight note save
    during a container restart could truncate the write.

Explicit LLM fallback opt-in (src/utils/ai.js):
  - The OpenRouter / LiteLLM silent fallback now requires admin
    setting `ai.allow_model_fallback = true` (default: false). If
    primary fails and fallback is disabled, the error is surfaced
    to the caller. Prevents silent spillover from a BAA-covered
    primary to a non-covered fallback.

Prompt injection delimiters (src/utils/promptSafe.js):
  - Wraps user transcripts, dictations, refine-instructions, and
    pasted documents in <UNTRUSTED_*>...</UNTRUSTED_*> tags and
    appends an explicit system instruction telling the model to
    treat the wrapped content as data rather than commands.
  - Applied to soap.js, hpi.js, refine.js. Extend to other AI
    routes incrementally.

Cross-tab logout sync (public/js/authFetch.js, auth.js):
  - BroadcastChannel('pedscribe-auth') — logout in one tab posts
    a message; all sibling tabs clear state and reload, dropping
    any PHI-containing UI immediately.

Backup code race-free consumption (src/routes/auth.js):
  - tryConsumeBackupCode() now uses a Postgres transaction with
    SELECT ... FOR UPDATE so concurrent login attempts using the
    same code serialize. First wins, second sees the already-
    shortened array.

Optimistic encounter locking (migrations/...add-encounter-version):
  - saved_encounters.version INTEGER NOT NULL DEFAULT 1
  - POST /api/encounters/saved accepts an expected_version and
    rejects with 409 if the row has advanced. Falls back to
    last-write-wins if the client doesn't pass one (backward compat).

Audit log batching (src/utils/auditQueue.js):
  - Audit / api_log / access_log writes are buffered in memory and
    flushed every 1s or every 50 entries via one multi-row INSERT.
    Under load this reduces DB pressure by ~50x. On SIGTERM the
    shutdown path drains the queue before exiting.
2026-04-14 05:24:40 +02:00
Daniel
8893e484fd Enforce server-side LLM model whitelist + scope idle timeout to writes
Two findings from review:

1. callAI() previously accepted any model string from the client.
   POST /api/hpi with { model: "openai/o1" } would call the reasoning
   model regardless of whether the operator enabled it. Added
   getAllowedModelIds() in src/utils/models.js (60s TTL DB-backed
   cache) and a guard at the top of callAI() that rejects with
   "model_not_permitted" when the requested ID isn't in the active
   roster. No model supplied → silent fallback to DEFAULT_MODEL.

2. Middleware was updating user_sessions.last_activity on every
   request, including GETs. Client-side polling (/api/auth/me
   heartbeats, dashboard refreshes, log tail calls) kept sessions
   alive indefinitely, defeating the 24h sliding idle policy. Now
   only POST/PUT/DELETE/PATCH count as "user activity". GETs are
   read-only and often automated — they no longer extend the
   session. Idle enforcement still runs on every method, so a
   24h-idle user still gets kicked on their next GET.
2026-04-14 05:15:55 +02:00
Daniel
dafbf44a32 Fix: revoked sessions now actually log the other device out
The server-side revoke was always working — it deletes user_sessions
rows, and middleware correctly returned 401 on the revoked device's
next /api/* request. The bug was entirely client-side: individual
fetch handlers swallowed the 401 (rendering "no sessions found" or
empty data) and nothing redirected to the login screen. So the
revoked device looked like it stayed signed in.

Added public/js/authFetch.js: a global fetch interceptor that
watches every /api/* response. On 401 from a non-auth endpoint
(i.e. not /login, /register, /logout, /me, etc.), it clears any
cached token/user state and reloads the page. The reload's boot
flow lands on /api/auth/me → 401 → login screen as usual.

Guarded against false positives: only triggers when the app believes
the user is currently logged in (AUTH_TOKEN set or main-app visible)
so a pre-login 401 doesn't accidentally flash the screen.

Loaded before auth.js in index.html.
2026-04-14 05:10:16 +02:00
Daniel
a8992aee5a Hide Active Sessions for SSO-only users
Follows the same pattern as Change Password and 2FA sections —
hidden by default in the HTML, revealed only when canLocalAuth=true.

Why: revoke technically deletes the PedScribe session row and clears
the cookie on that device, but the SSO user can re-auth instantly
because their IdP session is still live. Surfacing a "revoke" button
that the IdP will immediately undo is misleading. SSO users now see
only the SSO-relevant sections of Settings.
2026-04-14 05:07:07 +02:00
Daniel
b5abbb69fc Add node-pg-migrate for versioned schema changes + better mobile UA labels
Infrastructure only — no existing data or tables modified.

  src/db/migrate.js           — programmatic runner, fires at boot after
                                 the existing idempotent initDatabase()
  migrations/1744600000000...  — intentionally empty example, documents
                                 the file shape. Registered in the new
                                 pgmigrations tracking table so it won't
                                 rerun.
  .node-pg-migraterc.json     — CLI config (migrations-dir, utc naming)
  docs/migrations.md          — workflow + conventions
  package.json                — migrate:up/down/new/status npm scripts
                                 (status is a direct pgmigrations query
                                 since node-pg-migrate v7 lacks a status
                                 subcommand)

src/utils/sessions.js:
  - parseUserAgent now recognizes the Capacitor wrapper (UA suffix
    "PedScribe-Android" / "PedScribe-iOS") and labels sessions
    "PedScribe (Android)" instead of "Chrome on Android".

Going forward: schema changes go in /migrations as versioned files
with up() + down(); the inline init in database.js is the implicit
baseline for everything already in production.
2026-04-14 05:06:19 +02:00
Daniel
6febf6c914 Fix critical auth bug: set httpOnly cookie on local login/register
After the hybrid auth migration, web users log in but the
setAuthCookie() helper was never actually called in /login or
/register — only in the OIDC callback. Result: local sign-in worked
until the first page reload, then the user appeared logged out. The
Settings page's Active Sessions list came up empty because
/api/sessions received no auth.

Added setAuthCookie(res, token) calls on successful:
  - /register (auto-verified first admin path)
  - /login (after TOTP / backup code verification)

Mobile is unaffected — it uses Bearer from Keychain and always has.
2026-04-14 04:55:12 +02:00
Daniel
37e58be5ec Fix local-auth sections not showing for normal users + backup-code modal signature
settings load2FAStatus():
  - Explicit credentials: 'same-origin' on the /me fetch (was relying
    on fetch defaults, which can behave oddly in some browsers/edges)
  - Fall back to window.CURRENT_USER (cached at login) if /me fails,
    so local-auth users still see their password/2FA sections after
    a transient error. Keeps cache in sync on each successful fetch.

enterApp():
  - Cache the logged-in user object on window.CURRENT_USER so modules
    that need the canLocalAuth flag don't have to re-fetch /me.

2FA regenerate modal:
  - Previous call passed a wrong-shape options object to showConfirm.
    Updated to the correct (message, callback, opts) signature with
    input:true, inputType:'password', placeholder, required.

OIDC email_verified check:
  - Accept boolean true or string 'true' for robustness. Some IdPs
    serialize ID-token booleans as strings.
2026-04-14 04:43:07 +02:00
Daniel
c7a04626a3 Hide change-password + 2FA by default, show only when canLocalAuth=true
Sections were briefly visible for SSO-only users before load2FAStatus
resolved and hid them. Flipped the default: both sections now carry
style="display:none" in the HTML and are revealed only when the /me
fetch confirms the user has a real password hash.

SSO-only users never see the sections, even for a flash.
2026-04-14 04:38:28 +02:00
Daniel
fc17032649 Server-side SSO/local-auth enforcement + OIDC account-link hardening
Endpoint guards (defense-in-depth over hidden UI):
  - POST /api/auth/change-password: 400 with SSO-aware message if
    the caller's stored password is not a real bcrypt/argon2 hash.
    Prior behaviour was to fail at passwords.verify() with an
    ambiguous "current password is incorrect".
  - POST /api/auth/setup-2fa: 400 with same SSO-aware message for
    SSO-only accounts. Prior behaviour allowed TOTP setup on an
    account where it could never actually trigger (user never logs
    in locally).

OIDC account-link safety (src/routes/oidc.js):
  - Auto-link to an existing local account now requires the IdP to
    assert email_verified=true in the ID token (or userinfo). If
    absent/false, the callback redirects with ?error=email_unverified.
    Prevents an attacker at a misconfigured IdP from taking over a
    local account by claiming an email they don't own.
  - If an existing user already has oidc_sub set and the incoming
    sub is different, refuse with ?error=sub_mismatch. Prior
    behaviour silently did nothing, hiding a potential attack.
  - Audit 'oidc_linked' written on first successful link.

Frontend:
  - Added user-facing messages for the two new SSO error codes.
2026-04-14 04:35:00 +02:00
Daniel
e161c221c4 Idle timeout observability + cut write frequency in half + hide local-auth UI for SSO-only users
Middleware:
  - Log to console.warn + audit_log when a session is killed for
    inactivity. Shows up in Grafana/Loki so you can see how often
    users actually get kicked. Audit action: 'session_idle_timeout'
  - last_activity throttle bumped 5 min → 10 min — halves DB writes
    per active user. Idle precision slop widens to 24h00-24h10;
    still invisible in practice.

Per-user local-auth visibility:
  - /api/auth/me now returns user.canLocalAuth: true when the stored
    password is a real bcrypt / argon2 hash, false for the random
    blob OIDC auto-creates for SSO-only users.
  - Settings page hides "Change Password" and "Two-Factor
    Authentication" sections when canLocalAuth is false — those UIs
    are meaningless for users whose sign-in lives at the IdP.
  - Password hash is not leaked in the /me payload.

Mobile (restating existing behaviour for clarity): no idle check,
365-day JWT in Keychain/Keystore, never auto-logs-out. Only logout
triggers are: manual logout, password change, admin revoke, JWT hit
365d, or app uninstall.
2026-04-14 04:32:53 +02:00
Daniel
6dffdf91e5 Sliding 24h idle timeout (web) + persistent mobile + 2FA backup codes
Session model:
  Web     — 24h sliding idle timeout enforced server-side via
             user_sessions.last_activity. 30-day JWT + cookie are a
             safety net; middleware is the real clock. Cookie is
             re-set on active use so browsers match the sliding window.
  Mobile  — 365-day JWT, no idle timeout (stays persistent via Keychain
             / Keystore). Detected via User-Agent ("PedScribe" /
             "Capacitor") or X-Client: mobile header.

2FA backup codes:
  - 10 single-use codes generated when 2FA is first enabled
  - Stored as bcrypt hashes in new users.totp_backup_codes column
  - Consumed atomically on successful login fallback (when TOTP fails)
  - Regenerate endpoint (POST /api/auth/2fa/backup-codes) requires
    current password; invalidates prior codes
  - Count endpoint (GET /api/auth/2fa/backup-codes/count) powers a
    "N codes remaining" indicator on the 2FA settings card
  - Modal shows codes exactly once with Copy + Download .txt actions
  - Codes cleared when 2FA is disabled

New files:
  src/utils/platform.js — isMobileClient() helper

Schema migration (idempotent):
  ALTER TABLE users ADD COLUMN IF NOT EXISTS totp_backup_codes TEXT
2026-04-14 04:24:54 +02:00
Daniel
b294150781 Session lifetime: 7 days → 24 hours
Shortens both JWT expiresIn and httpOnly cookie maxAge to 24h in
auth.js (local + register + reset flows) and oidc.js (SSO callback).

Rationale: shorter absolute session window for a PHI-adjacent app.
No sliding idle refresh — user re-logs in once a day.
2026-04-14 04:17:54 +02:00
Daniel
cdf178b1c3 Mobile app hardening — security + Android 14 compat
capacitor.config.json:
  - webContentsDebuggingEnabled: true → false
    (was leaving Chrome DevTools able to attach to released builds)
  - allowMixedContent: true → false
    (API is HTTPS-only; no need to permit cleartext loads)
  - server.allowNavigation: ["*"] → restricted to pedshub.com /
    peds.danvics.com origins
    (prevents WebView following an attacker-controlled redirect)

AndroidManifest.xml:
  - android:allowBackup="false" + data_extraction_rules.xml
    (Android system backup would otherwise copy EncryptedSharedPreferences
     containing the auth token into Google Cloud backups)
  - Removed USE_BIOMETRIC permission (feature removed earlier)

AudioRecordingService.java:
  - startForeground(id, notif, TYPE_MICROPHONE) on Android 14+
    (without the explicit type Android 14 kills the service with
     MissingForegroundServiceTypeException)
  - WakeLock cap: 1h → 8h (still bounded, onDestroy releases early)

MainActivity.java:
  - Removed dead biometric code path and androidx.biometric imports

mobile/package.json:
  - Dropped @aparajita/capacitor-biometric-auth — orphan dependency
2026-04-14 04:15:27 +02:00
Daniel
fa16cb13cb Hybrid auth: cookie-only on web, Keychain Bearer on mobile
Runtime split driven by window.Capacitor.isNativePlatform():

  Web browser
    - No token in localStorage / sessionStorage — XSS can't read it
    - Server-set httpOnly cookie carries the session
    - fetch() default credentials='same-origin' sends the cookie
    - getAuthHeaders() returns Content-Type only, no Authorization
    - Middleware already falls back to cookie when Bearer is absent

  Capacitor native (iOS / Android)
    - Unchanged — Bearer token lives in Keychain / Keystore via the
      capacitor-secure-storage-plugin SecureStorage wrapper
    - Bearer header still sent on every request

enterApp() / clearSession() / getAuthHeaders() all now branch on
isNativeApp(). Legacy localStorage entries from the dual-mode era
are wiped on clearSession() for users migrating in.

Rollback: git reset --hard pre-httponly-only-2026-04-14
2026-04-14 04:11:55 +02:00
Daniel
4a26abed10 Maintenance CLI + unpin postgres digest
Adds `npm run maint:check` (health report) and `npm run maint:reindex`
(REINDEX DATABASE + REFRESH COLLATION VERSION + ANALYZE) for post-
upgrade maintenance, modelled after Nextcloud's occ maintenance.
Documented in README.

Also relaxes postgres image from digest pin back to tag-pin
(pgvector/pgvector:pg16) — the auto-REINDEX-on-drift check in
database.js and the COLLATE "C" protection on critical indexes
make the digest pin redundant while blocking ordinary `compose
pull` updates.
2026-04-14 04:00:13 +02:00
Daniel
d748dcc0d2 Pin critical auth indexes to COLLATE "C" (ICU-drift immune)
idx_users_email and idx_sessions_token_hash now use byte-order
collation so a future ICU library bump cannot silently corrupt the
indexes the way it did this week. The columns themselves retain
their default collation; only the index comparison is C, which is
safe for these because:

  - users.email is lowercased ASCII in practice
  - user_sessions.token_hash is SHA-256 hex (pure ASCII)

Both are used for equality lookups only, never ORDER BY. Migration
is idempotent, gated on app_settings.migration.text_indexes_c.

Slug indexes on learning_* tables left at default for now — those
are also ASCII in practice but under lighter load; the startup
drift check + auto-REINDEX covers them.
2026-04-14 03:55:09 +02:00
Daniel
b23cb3300e Collation-drift guard + lookup-miss visibility
Root cause of recent "invalid credentials on correct password" was
a silent btree index corruption: pgvector/pgvector:pg16 was pulled
with a different ICU library than the one used to build existing
indexes. Queries returned 0 rows even though matching heap rows
existed. Postgres logged nothing (corrupt index → empty result set
is a "successful" query) and the login path never logged unknown-
user attempts (enumeration protection).

Three defenses:

  1. Pin postgres image by digest in docker-compose.yml so a
     silent pull can't change ICU under our feet.
  2. Startup collation-drift check in src/db/database.js:
     compares pg_database.datcollversion to the library's actual
     version and, on mismatch, runs REINDEX DATABASE + ALTER
     DATABASE REFRESH COLLATION VERSION. Logs "Collation versions:
     aligned" on clean boot.
  3. Server-side console.warn on login lookup-miss (no email, no
     audit row — preserves enumeration protection but gives
     Grafana/Loki a signal for unusual miss rates).
2026-04-14 03:52:29 +02:00
Daniel
9b407d1e18 Login: remove temporary debug logging
Root cause for "invalid credentials" on correct password was a
corrupt btree index (idx_users_email) causing user lookups to miss
existing rows. Fixed by REINDEX DATABASE. Keeping a typed catch
around passwords.verify() so any future verify throw is logged
cleanly instead of bubbling as 500.
2026-04-14 03:48:56 +02:00
Daniel
e283bb8cda Growth/BMI results: percentiles to 2 decimal places
Percentile displays in growth charts, BMI, and mid-parental height
now show 2 dp (e.g. "37.42th") instead of 1 dp ("37.4th") for more
precision at tail percentiles.
2026-04-14 03:37:40 +02:00
Daniel
13e8937a00 Growth chart: accept explicit 0 in any age field
Previously any form of zero total ("0 days", all blank) rejected
with "Enter age". Newborns at birth are a legitimate entry —
distinguish blank-all (error) from explicit-zero (valid).
2026-04-14 03:33:10 +02:00
Daniel
5dde108e4a Growth chart age: three boxes (yr/mo/day), any combination
Replace single text input with three number fields — years, months,
days — that all combine into fractional months. Fill any subset:
leave years blank for a newborn, leave months blank for "2 years",
enter just days for a 10-day-old.

Live hint below ("= 2 yr 5 mo (29 mo total)") still shows the
interpreted total. Parser from prior commit retained on window
for reuse elsewhere.
2026-04-14 03:21:27 +02:00
Daniel
42984e355b Growth chart: flexible age input with smart parser
Replace [years] + [months dropdown] with a single text field that
accepts:
  3y / 3 years / 3 yr
  29m / 29 months / 29 mo
  2y5m / 2 years 5 months / 2 yr 5 mo
  3.5 years / 36 (plain number = months)
  15 days / 2 weeks / 3y 2m 10d

Enables fractional ages so newborns can be plotted accurately
(WHO/CDC growth curves are continuous — "0 months" means at birth,
not a 0-27 day bucket, so a 15-day-old should plot at ~0.5 months).

Live hint below the field shows how the input was interpreted
("= 2 yr 5 mo (29 mo total)").
2026-04-14 03:17:16 +02:00
Daniel
3e05d8eec9 Dockerfile: add build tools for argon2 native compile
argon2 requires node-gyp + python3 + g++ + make to build its C
extension. Added as a virtual .build-deps package so it's compiled
during npm install, then purged to keep the Alpine image slim.
2026-04-14 03:09:38 +02:00
Daniel
9bfadd7344 Stop leaking e.message to clients across all routes
88 occurrences of res.status(500).json({ error: e.message }) (or
err.message) swept to generic 'Request failed'. Server-side
console.error / logger.error calls are untouched, so the full detail
still lands in logs and Grafana.

Covers: admin, adminConfig, adminMilestones, chartReview, documents,
encounters, hospitalCourse, hpi, learningAdmin, learningAI, learningHub,
logs, memories, milestones, oidc, refine, sessions, sickVisit, soap,
userPreferences, wellVisit.

Also extends .gitignore to exclude .env.backup-* files.
2026-04-14 03:04:24 +02:00
Daniel
cb17a12172 Security hardening: PHI encryption, argon2, DOMPurify, SRI
- App-layer AES-256-GCM crypto helper (src/utils/crypto.js)
- Nextcloud tokens encrypted at rest; transparent migration on next use
- Audio backups encrypted at rest (version byte 0x01 envelope); legacy
  rows still decrypt as-is until overwritten
- argon2id password hashing via src/utils/passwords.js with bcrypt
  fallback; bcrypt hashes rehashed to argon2id on next successful login.
  argon2 package is optional — server keeps running with bcrypt only
  until npm install adds the native dep
- PHI redactor for audit log details (src/utils/redact.js) — strips SSN,
  phone, email, DoB, long IDs; caps at 500 chars; detects note bodies
- DOMPurify (cdnjs, SRI-pinned) replaces custom regex sanitizer in
  Learning Hub content rendering
- SRI integrity hashes added for Font Awesome CSS and Chart.js
- Magic-byte file-type verification on document uploads
  (src/utils/fileType.js)
- Generic 500 error responses via src/utils/errors.js applied to
  nextcloud and audioBackups; full detail still logged server-side
- DATA_ENCRYPTION_KEY env documented in .env.example

Deploy: requires rebuild of the container image to pick up the new
files and `npm install` (adds argon2). Existing users keep working
because bcrypt stays available and crypto helpers pass through
plaintext when the key is not yet set in dev.
2026-04-14 02:49:38 +02:00
Daniel
93bc44b5e0 Security hardening: low-risk easy wins
- JWT_SECRET fails fast at startup in production
- CORS fails closed if APP_URL + CORS_ORIGINS are both missing
- Explicit HSTS (1y, includeSubDomains, preload)
- Rate limit sensitive auth endpoints (change-password, 2FA)
- /api/health now returns {ok:true}; details gated behind admin auth
- Login enumeration removed — generic 401 + dummy bcrypt on miss
- ReDoS guard: 20KB input cap on /suggest-codes
- showToast uses textContent, no innerHTML
- clearSession() clears service worker caches on logout
- OIDC state is now HMAC-signed and stateless (survives restart)
- SSRF guard on admin-set OIDC issuer (blocks private IPs, requires HTTPS)

Adds docs/mobile-build.md covering APK build, release, git push,
keystore, and troubleshooting for both PedScribe and PedsHub apps.
2026-04-14 02:42:32 +02:00
Daniel
8409a49c74 Add hardware-backed secure storage for mobile auth token
Web still uses localStorage; Capacitor native app now routes
token/user/session-id through capacitor-secure-storage-plugin
(iOS Keychain, Android EncryptedSharedPreferences / Keystore).

A thin SecureStorage wrapper detects Capacitor at runtime and
falls back to localStorage elsewhere, keeping a single auth.js
codebase for both targets.

To activate on mobile: cd mobile && npm install && npx cap sync android
2026-04-14 02:33:32 +02:00
Daniel
942647871a Add APK download link on login page
Links to GitHub releases/latest for Android APK download.
2026-04-14 02:29:38 +02:00
Daniel
369e440aa1 Enhance audit logging: user agent, session ID, PHI access tracking
Loki logs now include:
- User agent string (browser/device identification)
- Session ID (ties actions to specific login session)
- Status field (success/failure)

New logging:
- encounter_load: logged when user opens a saved encounter (with label)
- copy_to_clipboard: logged when user copies note content (PHI access)
- Client event endpoint: POST /api/logs/client-event (auth required)

Encounter save/delete/load all include the encounter label for
patient identification in audit trail.

HIPAA audit trail now covers: who, what, when, from where, which
device, which session, what patient data, success/failure.
2026-04-11 06:17:05 +02:00
Daniel
0c8a4db5c3 Add full hour-by-hour exchange transfusion thresholds for all GA groups
Exchange transfusion data (AAP 2022) now covers GA 35, 36, and 38+ weeks
with and without risk factors, hour-by-hour from 12-96h (510 more data
points). Total bilirubin data: 1020 data points (6 photo + 6 exchange
tables x 85 hours each). No interpolation needed for any hour.
2026-04-11 06:03:48 +02:00
Daniel
30300f169c Bilirubin: full hour-by-hour AAP 2022 data (510 data points)
Replace interpolated thresholds with exact hour-by-hour values
extracted from PediTools API for every hour from 12-96h:
- 6 phototherapy tables (GA 35/36/38 x with/without risk factors)
- 85 data points per table = 510 total values
- No interpolation needed — exact AAP 2022 nomogram values
- Exchange transfusion thresholds for GA 38 (with/without risk)
2026-04-11 06:01:00 +02:00
Daniel
5d988c397d Update bilirubin to exact AAP 2022 values, add exchange transfusion
Phototherapy thresholds updated with exact values extracted from
PediTools (validated against AAP 2022 nomograms):
- Separate tables for GA 35, 36, and 38+ weeks
- With and without neurotoxicity risk factors
- Hour-specific values at 12, 24, 36, 48, 60, 72, 84, 96, 120h

Previous approximations were 1-3 mg/dL too low (conservative but
inaccurate). New values match the published AAP 2022 curves exactly.

Exchange transfusion thresholds added for GA 38+ weeks (with/without
risk factors). Displayed alongside phototherapy threshold in results.

GA selection expanded: 35, 36, 37, 38, 39, 40+ weeks.
Chart now shows both phototherapy and exchange transfusion lines.

Also: fixed Loki port conflict (3100->3101), added logs.pedshub.com.
2026-04-11 05:50:19 +02:00
Daniel
e700ab1c8b Add pause/stop buttons to SOAP note recording
- Add Pause and Stop buttons (hidden until recording starts)
- Record button hides during recording (same pattern as encounter)
- Pause: suspends MediaRecorder + speech recognition, shows Resume
- Resume: handles MediaRecorder state recovery if browser killed it
- Stop: triggers the record button's stop flow
- Native mobile: haptic feedback + keep-awake + foreground service
- Recognition respects pause state (doesn't restart during pause)
2026-04-11 05:19:12 +02:00
Daniel
6a690f6483 Add Glasgow Coma Scale calculator and equipment sizing reference
GCS Calculator:
- Child/Adult and Infant versions with toggle
- Eye opening (4), Verbal (5), Motor (6) dropdowns
- Auto-calculates total score with severity classification
  (Mild 13-15, Moderate 9-12, Severe/Coma 3-8)
- Infant-modified verbal and motor scales per Kids Kard
- Updates on every dropdown change (no button needed)

Equipment Sizing (Johns Hopkins Kids Kard):
- Select age/weight group (premie through 16+)
- Shows: BVM, oral/nasal airway, blade, ETT, LMA, Glidescope,
  IV catheter, central line, NGT/OGT, chest tube, Foley
- All values from Johns Hopkins Children's Center Kids Kard
- ETT formulas shown as reference
2026-04-11 05:01:57 +02:00
Daniel
d29f55f8a6 Increase API rate limit to 200 req/min (Turnstile errors were exhausting 60/min limit) 2026-04-11 04:47:08 +02:00
Daniel
04030b1ded Fix vital signs selector, add resuscitation medications calculator
Vital Signs:
- Fix age selector not responding (replaced setTimeout with event
  delegation on parent panel — works reliably with hidden panels)
- Update values to Johns Hopkins Kids Kard data (8 age groups:
  premie, 0-3mo, 3-6mo, 6-12mo, 1-3yr, 3-6yr, 6-12yr, >12yr)
- Each age group shows: HR awake/sleeping, RR, SBP, DBP, temp,
  SpO2, weight range, and clinical pearls

Resuscitation Medications (new calculator tab):
- Enter patient weight, calculates all 13 PALS medication doses
- Adenosine, Amiodarone, Atropine, Calcium Chloride/Gluconate,
  Dextrose (weight-based concentration), Epinephrine (arrest/anaphylaxis),
  Hydrocortisone, Insulin, Lidocaine, Magnesium, Naloxone, Bicarb
- Color-coded by category (cardiac/metabolic/reversal)
- Max dose capping, route, special notes per medication
- Source: Johns Hopkins Kids Kard / AHA PALS 2020
2026-04-11 04:42:23 +02:00
Daniel
bdf0916fe7 Fix vital signs age selector: add setTimeout for DOM readiness 2026-04-11 04:28:49 +02:00
Daniel
0630e460e8 Interactive vital signs selector with clinical notes per age group
Replace static vital signs table with interactive age group dropdown.
Each selection shows: HR (awake/sleeping), RR, SBP, DBP, temperature,
SpO2 target, weight range, and age-specific clinical notes.

10 age groups: preterm through 18 years. Values from Harriet Lane
Handbook 23rd Edition. Includes AAP 2017 BP classification thresholds
for ages 13+, ETT sizing formulas, and clinical pearls (orthostatic
testing, febrile tachycardia, athletic bradycardia, etc.).

Full reference table preserved as collapsible "View All Age Groups".
2026-04-11 04:19:39 +02:00
Daniel
64546a743d Remove biometric prompt (will implement properly with token-based auth later) 2026-04-11 03:57:40 +02:00
Daniel
baa6362d29 Native Android: biometric auth, foreground service bridge, mic fix
Major Android native improvements:

Biometric authentication:
- Native AndroidX BiometricPrompt on app launch (2nd launch onwards)
- Supports fingerprint, face, iris, and device PIN/password fallback
- Gracefully skips if no biometric hardware or first launch
- Uses SharedPreferences to track first launch

Microphone permission:
- Added MODIFY_AUDIO_SETTINGS permission (required for WebView audio)
- Added androidScheme: "https" in Capacitor config (getUserMedia requires
  secure context)
- WebChromeClient properly grants WebView permission after Android
  runtime permission is obtained
- Handles pending permission request across the async flow

Background recording bridge:
- NativeRecording JavaScript interface exposed to WebView
- startForegroundService() / stopForegroundService() callable from JS
- Web app calls these on recording start/stop in liveEncounter.js
- AudioRecordingService keeps CPU awake + shows notification when recording
- Recording survives screen lock via foreground service + wake lock

Also:
- USE_BIOMETRIC permission added to manifest
- androidx.biometric:biometric dependency added to build.gradle
- Haptic fallback to navigator.vibrate when Capacitor plugins unavailable
2026-04-11 03:42:23 +02:00
Daniel
7a957e856e Fix WebView mic: grant both Android runtime + WebView permissions
The WebView has its own permission layer separate from Android runtime
permissions. Both must be granted. Now when the web page requests mic
access, the WebChromeClient checks if Android permission exists, grants
the WebView request if yes, or requests Android permission first then
grants the pending WebView request in the callback.
2026-04-11 03:37:45 +02:00
Daniel
f03ca5cb94 Fix Android mic permission, simplify launcher, remove broken biometric
- MainActivity: request RECORD_AUDIO permission at app start via
  ActivityCompat (not WebChromeClient override which broke Capacitor bridge)
- Simplify launcher: remove server reachability check (was failing in
  WebView), just save URL and navigate directly
- Remove biometric auth from launcher (Capacitor plugins need ES module
  bundler, not available in plain HTML). Biometric can be added later
  via the web app with proper Capacitor runtime.
- Add webContentsDebuggingEnabled for development
2026-04-11 03:34:47 +02:00
Daniel
6978ed708c Fix Android: auto-grant WebView mic permission, match status bar color
- MainActivity: override WebChromeClient to auto-grant WebView
  permission requests (microphone, camera) so the Android runtime
  permission dialog shows instead of WebView silently denying
- Add colors.xml with PedScribe blue (#2563eb / #1d4ed8)
- Update styles.xml: set statusBarColor and navigationBarColor to
  match app theme (fixes brown/mismatched bar at top)
- Change base theme to NoActionBar (removes action bar)
2026-04-11 03:29:15 +02:00
Daniel
17a0371a0f Fix launcher: simplify server check for Android WebView compatibility
WebView blocks no-cors fetch and image probes differently than browsers.
Simplified to a normal fetch that treats CORS errors as 'server reachable'
(CORS error = server responded, just blocked the origin).
2026-04-11 03:23:00 +02:00
Daniel
7582e3563d Add Loki + Grafana monitoring stack, ntfy notifications, biometric auth
Monitoring:
- docker-compose.monitoring.yml — opt-in Loki + Grafana stack
- Loki config with 6-year retention (HIPAA compliant)
- Grafana auto-provisioned with Loki datasource + PedScribe dashboard
  (login activity, failed logins, clinical actions, API calls, log viewer)
- Logger ships to Loki in parallel with PostgreSQL (fire-and-forget)
- Labels: app=pedscribe, type=audit|api_call|access, category, action

Usage: docker compose -f docker-compose.yml -f docker-compose.monitoring.yml up -d
Grafana at localhost:3003 (admin/pedscribe)

Notifications:
- ntfy push support (src/utils/notify.js)
- Notifications on: login, password change, registration
- Self-hosted, no Firebase dependency

Mobile:
- Biometric auth on app launch (Face ID/Touch ID/fingerprint)
- PIN/password fallback, auto-prompt, skip option
2026-04-11 03:00:52 +02:00
Daniel
d0d65446f6 Add biometric auth, ntfy push notifications, mobile improvements
Mobile:
- Add biometric authentication (Face ID/Touch ID/fingerprint) on app launch
  with PIN/password fallback, auto-prompts on launch, skip option
- Add @aparajita/capacitor-biometric-auth plugin

Backend:
- Add ntfy push notification support (src/utils/notify.js)
  Self-hosted, no Firebase dependency, uses user's existing ntfy instance
- Notifications for: new login, password changed, new registration (admin)
- Topic format: pedscribe-user-{id} for users, pedscribe-admin for admins
- Env: NTFY_URL, NTFY_TOKEN (optional)
2026-04-11 02:35:07 +02:00
Daniel
aa33a55d0b Mobile app: haptics, deep linking, share intent, push notifications, keep-awake
Native improvements:
- Add haptic feedback on recording start (heavy) and stop (medium)
- Add keep-screen-awake during recording (nativeKeepAwake)
- Add isNativeApp() detection helper
- Android: deep linking (pedscribe:// + https://app.pedshub.com)
- Android: share intent for text/plain and application/pdf
- iOS: deep linking (pedscribe:// URL scheme)
- iOS: remote-notification background mode
- Add Capacitor plugins: haptics, keyboard, push-notifications,
  screen-orientation, share

Updated README with complete build/deploy instructions,
App Store listing suggestions, and icon generation guide.
2026-04-11 02:28:30 +02:00
Daniel
d079c6d6c9 Fix mobile app bugs: package name, deprecated API, server check
- Fix AudioRecordingService ACTION_STOP to use com.pedshub.scribe
- Fix deprecated stopForeground(true) to STOP_FOREGROUND_REMOVE
- Fix launcher.js testServer: prevent double callback, fix onerror
  always reporting success (now correctly fails on unreachable servers)
- Update service comment from TWA to Capacitor
2026-04-11 02:22:32 +02:00
Daniel
bf586daf4d Add Capacitor native mobile app (PedScribe) for iOS + Android
New mobile/ directory with Capacitor project:
- Configurable server URL launcher (default: app.pedshub.com)
- Android: foreground service + wake lock for background recording
  (AudioRecordingService preserved from existing TWA)
- iOS: background audio mode + microphone permission
- App ID: com.pedshub.scribe
- Both platforms initialized and synced

Existing android/ TWA project untouched — this is a separate project.
Build: cd mobile && npx cap open android (or ios)
2026-04-11 02:18:06 +02:00
Daniel
ee88e51f14 Add automatic ICD-10 and CPT billing code suggestions
New feature: after generating any clinical note, the app automatically
suggests relevant billing codes displayed as clickable chips below the output.

Backend (src/routes/billing.js):
- POST /api/suggest-codes endpoint analyzes note text
- Extracts diagnoses from Assessment section via regex
- Looks up ICD-10 codes: local common pediatric map (40+ conditions)
  first, then NLM Clinical Tables API for unknown terms
- Suggests CPT E/M codes based on note type, visit complexity,
  ROS/PE system counts, and MDM level estimation
- Supports: outpatient (new/established), well visit (age-based),
  ED, inpatient (admit/subsequent/discharge)

Frontend (public/js/app.js):
- suggestBillingCodes() renders collapsible card with ICD-10 and CPT chips
- Click any chip to copy the code to clipboard
- Shows E/M level assessment (diagnosis count, ROS, PE, MDM complexity)
- Disclaimer: "Suggestions only. Always verify codes."

Integration: called after note generation in all 6 tabs
(encounter, SOAP, sick visit, well visit, hospital course, chart review)
2026-04-11 01:50:17 +02:00
Daniel
4fbfc913d0 Add pediatric calculators: BP, BMI, growth, bilirubin, vitals, BSA, dosing
Calculators tab with 7 tools:
- BP Percentile (AAP 2017) with age/sex/height classification
- BMI Percentile (CDC 2000) with extended obesity classification
  (Class 1/2/3 using % of 95th percentile per CDC 2022)
- Growth Charts: weight-for-age, length-for-age, head circumference,
  weight-for-length (WHO/CDC LMS), Fenton preterm (22-50 weeks)
- Bilirubin: AAP 2022 phototherapy threshold + Bhutani nomogram
  with Nelson Table 137.1 risk factors for severe hyperbilirubinemia
- Vital Signs by Age (Harriet Lane) with quick reference formulas
  (estimated weight, min SBP, ETT size, maintenance fluids 4-2-1)
- Body Surface Area (Mosteller formula)
- Weight-Based Dosing with max cap and volume calculation

Fix growth chart sub-tab navigation (pills scoped separately from
top-level nav to prevent panel disappearing)
2026-04-09 17:56:30 +02:00
Daniel
79994f4781 Replace all browser dialogs with modern modal, add OIDC admin UI
- Add reusable showConfirm() modal component (supports plain confirm,
  input prompt, danger styling, Enter key)
- Replace ALL 18 confirm() and prompt() calls across 8 JS files with
  showConfirm() modal: admin user actions, session revoke, document
  delete, template delete, milestone management, transcription settings
- Fix broken admin reset-password (btn was undefined in scope)
- Add OIDC/SSO configuration UI to Admin Panel (issuer, client ID/secret,
  button label, disable local auth toggle, callback URL display)
2026-04-09 02:43:23 +02:00
Daniel
adf1365fa2 Fix session revocation bug that could log out current device
- Fix: DELETE all other sessions query used empty string fallback when
  req.sessionId was undefined, causing id != '' to match ALL rows
  (including current session). Now skips deletion if sessionId unknown.
- Fix: Revoke All endpoint returns error if current session not identified
- Fix: var confirm shadowing window.confirm in password change handler
2026-04-09 02:33:00 +02:00
Daniel
4fa2b58d75 Remove prompt() dialogs, breach warnings, cost display; fix 2FA disable UI
- Replace browser prompt() with inline UI for: 2FA disable (password field),
  admin password reset (inline input), admin test email (inline input)
- Remove all password breach warning UI (login, register, settings)
  Backend HIBP check endpoint remains but is no longer called from frontend
- Remove model cost display from dropdown and header badge
- Hide empty cost-badge element in header
- Fix model dropdown to flat list (no category grouping)
2026-04-09 02:27:55 +02:00
Daniel
04f3aa56cb FAQ page, dep security patches, model dropdown and UI fixes
- Add FAQ tab with accordion sections: Getting Started, AI & Models,
  Voice & Transcription, Saving & Export, Privacy & Security,
  Well Visit & Sick Visit, Learning Hub, Troubleshooting
- Documents how AI learns from physician edits (correction tracker)
- Fix FAQ accordion (CSP was blocking inline script, moved to app.js)
- Patch all 5 npm vulnerabilities: nodemailer 8.0.5, xmldom, basic-ftp,
  path-to-regexp (npm audit now reports 0 vulnerabilities)
- Remove model category grouping from dropdown (flat list, no optgroups)
- Fix model dropdown dark background on options (white bg, dark text)
- Update FAQ model guidance to reflect admin-managed model selection
2026-04-09 01:56:11 +02:00
Daniel
020e831b3c v6.2: Session management, password change, audit logging, refine context, UI fixes
Security:
- Add session management: users can view/revoke active sessions in Settings
- Add password change in Settings (requires current password, HIBP check)
- Force logout all sessions on password reset
- Fix logout to destroy server-side session (was only clearing cookie)
- Add trust proxy for correct client IP in rate limiting and audit logs
- Add CORS support for multiple domains (CORS_ORIGINS env var)
- Add HIBP breach check endpoint and inline warnings on password fields

Audit logging:
- Add audit logging to all 24 PHI-handling endpoints across 13 route files
- Covers: generation, transcription, TTS, refine, encounters, documents, Nextcloud
- All fire-and-forget (no response delay)

AI improvements:
- Refine now includes original source material (transcript, notes, labs)
  so AI can reference the full input when modifying output
- Add correction tracking (trackAIOutput) to sick visit and well visit tabs
- Fix sickvisit missing from encounter save noteIdMap

UI fixes:
- Non-blocking busy bar for transcription and AI generation (replaces full-screen overlay)
- Fix encounter recording: hide record button during recording (was showing two stop buttons)
- Fix ROS/PE "All WNL" stacking duplicate event handlers; add Clear buttons
- Enlarge AI instructions textarea in Learning Hub CMS

Domain:
- Primary domain now app.pedshub.com, with scribe.pedshub.com and peds.danvics.com as CORS origins
2026-04-08 20:27:45 +02:00
Daniel
a535ff6c15 Add developer guide, expand admin model management docs
- New docs/developer-guide.md: full walkthrough of frontend SPA architecture,
  backend middleware stack, database layer, AI integration, settings system,
  how to add features/routes/tables, key design decisions, file references
- Expand ai-providers.md: detailed admin model management (add custom models
  with ID/name/cost/category, discover from provider, enable/disable, set default)
- Update README docs index
2026-04-04 23:02:02 +02:00
Daniel
a36235c646 v6.1: Turnstile bot protection, LiteLLM provider, PPTX tables, audio backup fixes, docs
- Add Cloudflare Turnstile to login, register, and password reset forms
- Switch AI provider to LiteLLM, transcription to OpenAI Whisper
- Change domain to scribe.pedshub.com
- Fix PPTX export: add tables, bold/italic, numbered lists, code blocks, blockquotes
- Fix announcement banner close button (CSP was blocking inline onclick)
- Fix auth middleware: empty Bearer token now falls through to cookie auth
- Fix audio backups: only save on transcription failure, stop auto-deleting on success
- Soften AI correction injection to prevent model hallucination from correction history
- Fix LiteLLM TTS model name handling (no incorrect openai/ prefix)
- Expand AI instructions textarea in Learning Hub CMS
- Update README for v6 with all features and providers
- Add comprehensive docs/: architecture, API reference, database schema,
  authentication, AI providers, speech, learning hub, configuration, deployment
2026-04-04 22:56:24 +02:00
ifedan-ed
f98b9b7b71 feat: Add model search, testing, and TTS/STT/embedding management to admin
- Fix model search for all providers: Bedrock now falls back to built-in
  list (with live ListFoundationModels attempt), Azure returns built-in list
- Add Test button on every model row (built-in, discovered, custom) that
  sends a live prompt and shows response + latency in a toast
- Add TTS management section: search voices from provider API (Google TTS
  voices.list, LiteLLM /v1/models, ElevenLabs /v1/voices), Set as Default
  writes tts.voice/tts.model to DB, runtime respects DB override
- Add STT management section: search models from provider (Gemini, Whisper,
  LiteLLM, OpenAI, local), Set as Default writes stt.model to DB, runtime
  respects DB override in transcribe.js
- Add Embedding models section: search from provider (LiteLLM, Vertex,
  OpenAI), Set as Default writes embeddings.model+dimensions to DB,
  embeddings.js respects DB override
- Add record-and-transcribe STT test (browser MediaRecorder)
- Add TTS synthesize-and-play test (returns base64 audio)
- Add embedding generate test (shows dims + vector sample)
- Expand PUT /config/:key(*) whitelist to include tts., stt., embeddings.
- Add @aws-sdk/client-bedrock as optional dependency for live Bedrock discovery
2026-04-03 19:55:11 +00:00
ifedan-ed
4fb038a745 v2.2: Remove milestone admin UI, add CMS content refresh button
Some checks failed
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / build (push) Has been cancelled
REMOVED:
- Milestone editing UI from Admin Panel (per user request)
- Milestones will be managed via hardcoded static data only
- Kept backend routes and database support for future use

ADDED:
- Refresh button in Learning Hub CMS content list
- Manual refresh for AI-generated content updates
- Better discoverability of content refresh functionality

FIXES:
- AI learning content now has visible refresh button
- Users can manually refresh content list after AI generation
- Cleaner admin panel without milestone management clutter

NOTE:
- Developmental milestones still work via static fallback
- Edit milestones by modifying public/js/milestonesData.js
- Backend API still supports milestone management if needed later
2026-04-01 18:16:00 +00:00
ifedan-ed
215de4cac8 v2.1: Add visible bulk import UI for developmental milestones
Some checks failed
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / build (push) Has been cancelled
NEW FEATURES:
- Bulk Import button in Admin Panel → Developmental Milestones section
- "Import Default Milestones Data" button appears when database is empty
- "Re-import All" button to clear and re-import all static data
- Visible notice when no milestones exist with one-click import

IMPROVEMENTS:
- Auto-shows empty state notice when database has no milestones
- Backend bulk-import endpoint now supports clearExisting parameter
- Imports ALL age groups from static data (birth to 11 years)
- Better UX - admin doesn't need CLI to populate milestone data

FIXES:
- Makes milestone admin editing feature discoverable and usable
- No need to manually run import script anymore
2026-04-01 18:06:42 +00:00
ifedan-ed
d86625c7e6 v4: Fix milestones display + add OpenID auth + 100MB PDF support
Some checks failed
Build TWA APK / build-apk (push) Has been cancelled
Build & Push Docker Image / build (push) Has been cancelled
FIXES:
- Milestones now show correctly on encounter page (use static fallback if DB empty)
- Static data preserved as MILESTONES_DATA_STATIC for compatibility
- Database-driven milestones still work (admin can edit via CMS)

NEW FEATURES:
- OpenID Connect (OIDC) authentication support (PocketID, Keycloak, Azure AD, etc.)
- Comprehensive setup guide: OPENID_SETUP.md
- Auto-linking existing users by email on SSO login
- Multiple PDF upload support in Learning Hub (up to 10 files)
- 100 MB per file limit (was 20 MB)
- Full PDF content used for AI generation
- Embeddings use first ~8K chars for semantic search

IMPROVEMENTS:
- Updated UI to show multiple file selection with list
- Drag-and-drop supports multiple files
- Better file upload validation and error handling
- Added clarifying comments about embedding truncation
2026-04-01 17:59:51 +00:00
ifedan-ed
77eabbd4df v6: Use transformers.js v2.0.0 (proven worker compatibility) 2026-04-01 00:32:23 +00:00
Daniel Onyejesi
970c946093 Bump docker-compose to v6 2026-03-31 20:09:42 -04:00
ifedan-ed
e459d34a13 Version 5.0.0 - Browser Whisper fix with self-hosted v2.6.2 2026-03-31 23:32:07 +00:00
ifedan-ed
b7adb4c3c7 Update docs for v3 truly self-hosted setup 2026-03-31 23:12:46 +00:00
ifedan-ed
a528bcc283 FIX: Browser Whisper - 100% self-hosted, zero CDN dependencies
FINAL WORKING SOLUTION:

Previous attempts failed because:
- transformers.js v2.17.2 is ES module-only
- Module workers require complex CSP and external imports
- importScripts() doesn't work with ES modules

Solution:
- Use transformers.js v2.6.2 (has worker-compatible UMD build)
- Bundle library + models, serve entirely from our server
- Classic worker with importScripts() - no CSP issues

What's self-hosted:
-  transformers.min.js (760KB) - at /models/transformers.min.js
-  Whisper models (42MB) - at /models/Xenova/whisper-tiny.en/

Worker loads:
1. importScripts('/models/transformers.min.js') - OUR SERVER
2. Loads models from /models/ - OUR SERVER
3. ZERO external network calls
4. Works in any network (firewalled, air-gapped, etc.)

This is the production-ready, truly offline solution.
2026-03-31 23:12:21 +00:00
ifedan-ed
f95a03c13c Fix Browser Whisper: Use ES module worker with CDN library
Issue: transformers.js is an ES module package and cannot be loaded
with importScripts() in classic workers.

Solution:
- Changed to module worker (type: 'module')
- Import transformers.js from CDN as ES module
- Models (42MB) still served from local server at /models/

Trade-off:
- Library (900KB): Loads from cdn.jsdelivr.net once, cached
- Models (42MB): Self-hosted, served from /models/ (no CDN)

This is necessary because:
1. @xenova/transformers is ES module-only (package.json: "type": "module")
2. ES modules cannot use importScripts()
3. Module workers require HTTPS for imports
4. CDN is HTTPS and cacheable

If CDN is blocked:
- Use Web Speech API (with privacy warnings)
- OR use Server Transcription (Vertex AI/AWS)

Models remain self-hosted as they're 40MB+ and contain the AI.
2026-03-31 22:55:28 +00:00
ifedan-ed
0d33d3dce8 Version 3.0.0 - Milestones admin + transcription options 2026-03-31 22:12:58 +00:00
ifedan-ed
b8b9e8974b Add comprehensive transcription options documentation 2026-03-31 21:58:17 +00:00
ifedan-ed
ca14094c0a Add Web Speech Recognition option for real-time streaming
Provides two transcription options:

1. Browser Whisper (Offline, Batch) - RECOMMENDED
   - 100% offline, zero network calls
   - HIPAA-compliant, audio never leaves device
   - Highest accuracy (Whisper)
   - Processes after recording (batch mode)
   - Models self-hosted, bundled in v2

2. Web Speech API (Real-time, Streaming) - EXPERIMENTAL
   - Real-time transcription (see words as you speak)
   - Uses browser's built-in speech recognition
   - ⚠️ Sends audio to cloud (Chrome/Edge → Google)
   - ⚠️ NOT HIPAA-compliant
   - Requires user consent with clear warnings

Features:
- Settings UI for both options
- Clear privacy warnings for Web Speech
- Mutual exclusion (only one active at a time)
- Browser detection shows which provider is used
- Confirmation dialog before enabling Web Speech

Use Cases:
- Clinical/HIPAA: Use Browser Whisper only
- Personal/Non-clinical: Can use Web Speech for real-time feedback
- Maximum privacy: Browser Whisper (offline)
- Maximum speed: Web Speech (if privacy not required)

Implementation:
- speechRecognition.js: Web Speech API wrapper
- transcriptionSettings.js: Settings UI handler
- Privacy info displayed per browser

User can choose based on their privacy vs. speed preference.
2026-03-31 21:57:24 +00:00
ifedan-ed
b035f7d7b4 Add admin dashboard for developmental milestones management
Features:
- Admin can add, edit, and delete developmental milestones via dashboard
- Milestones stored in PostgreSQL (developmental_milestones table)
- Client-side loads milestones from API instead of static file
- Import script to migrate existing static data to database
- Organized by age group and domain
- Supports sorting and filtering

Admin UI:
- New section in Admin panel for milestone management
- Filter by age group
- Add/Edit modal with validation
- Delete with confirmation
- Auto-complete for age groups and domains

API Endpoints:
- GET /api/milestones-data - Public endpoint for authenticated users
- GET /api/admin/milestones - List all milestones (admin only)
- GET /api/admin/milestones/meta - Get age groups and domains
- POST /api/admin/milestones - Create milestone
- PUT /api/admin/milestones/:id - Update milestone
- DELETE /api/admin/milestones/:id - Delete milestone
- POST /api/admin/milestones/bulk-import - Bulk import

Usage:
1. Run import script: node scripts/import-milestones.js
2. Access Admin dashboard → Developmental Milestones section
3. Add/Edit/Delete milestones as needed
2026-03-31 20:55:41 +00:00
ifedan-ed
89daba420c Change version to v2.0 2026-03-31 20:51:50 +00:00
ifedan-ed
7c27213451 v18: Self-hosted Browser Whisper (zero CDN dependencies)
BREAKING FIX: Browser Whisper now fully self-contained

Previous issue:
- Loaded transformers.js from cdn.jsdelivr.net
- Downloaded models from cdn-lfs.huggingface.co
- Failed in corporate/clinical networks with firewall
- Stuck at "Initializing..." with no progress

Solution:
- Bundle transformers.js library (~876KB)
- Bundle Whisper tiny.en model (~42MB)
- Serve everything from local server
- Works in ANY network environment

Changes:
- whisperWorker.js: Load transformers from /models/ instead of CDN
- Dockerfile: Download models during Docker build
- Add download script for local dev
- Add comprehensive setup documentation

Docker image size: +~42MB (one-time cost, runtime benefit)

Tested: Works on unrestricted and firewalled networks
2026-03-31 20:02:11 +00:00
ifedan-ed
cf4ba2a1e8 v17: Production release with all fixes
Complete Feature Set:
 Vertex AI Embeddings - Semantic search for Learning Hub
 Voice Preferences - Per-user STT model + TTS voice selection
 Browser Whisper - Optional client-side transcription with graceful CDN fallback
 TTS Preview - Working for all voices including server default
 Audio Backups - Automatic recording backup with 24h retention
 S3 Documents - Upload/manage documents (AWS, B2, MinIO)
 Learning Hub - AI content generation from PDFs/Nextcloud

Fixed Issues:
- TTS preview button now working (correct event listener)
- Browser Whisper shows clear warning if CDN blocked
- Server default voice preview working
- Graceful fallback to server transcription
- User-friendly error messages throughout

Documentation:
- FEATURES_EXPLAINED.md - Complete feature guide
- BROWSER_WHISPER_TROUBLESHOOTING.md - CDN blocking troubleshooting
- EMBEDDINGS_SETUP.md - Vector search setup guide

Production Ready:
- All features tested
- Clear error handling
- Graceful degradation
- HIPAA-compliant options available
2026-03-31 16:20:41 +00:00
ifedan-ed
bbfe55f03b v16: Make Browser Whisper CDN failure graceful with clear warnings
REALITY CHECK: Browser Whisper CDN loading cannot work in all environments
- Corporate firewalls block cdn.jsdelivr.net
- Network proxies filter JavaScript CDN
- Workers + importScripts + cross-origin = blocked by CSP/CORS

SOLUTION: Graceful degradation
- Clear user-friendly error messages
- Automatic fallback to server transcription
- Warning banner in Settings if CDN blocked
- Comprehensive troubleshooting documentation

Changes:
- browserWhisper.js: Show toast on worker error, fallback gracefully
- app.js: Display CSP warning banner on preload failure
- settings.html: Add warning about network/firewall requirements
- BROWSER_WHISPER_TROUBLESHOOTING.md: Complete guide for users

Key Message:
Browser Whisper is OPTIONAL. Server transcription (Google/AWS/OpenAI)
is the primary method and works everywhere. Browser Whisper is a
privacy-focused bonus feature that requires CDN access.

User Experience:
- If CDN works: Great! Browser Whisper available
- If CDN blocked: No problem! Server transcription works perfectly
- Clear messaging: User knows what to expect
2026-03-31 16:18:46 +00:00
ifedan-ed
f18a87d0ff Fix TTS preview for 'Server default' voice option
- Allow empty voice value to preview server default
- Display 'server default' in preview text
- Clears user preference (sets to null) when testing default
2026-03-31 16:15:41 +00:00
ifedan-ed
dd25d235d7 v16: TTS Preview + Browser Whisper fixes with correct CSP
Critical fixes from v15:
- TTS Preview: Fixed event listener (tabChanged not tab-loaded)
- Browser Whisper: Fixed CSP to allow CDN loading (unsafe-eval + jsdelivr)
- Worker: Added error handling and logging for importScripts
- Voice Preferences: Multiple init paths with fallbacks
- Debug logging throughout for troubleshooting

Changes:
- server.js: CSP allows unsafe-eval, cdn.jsdelivr.net in connectSrc
- voicePreferences.js: Correct event name, immediate init fallback
- whisperWorker.js: Try-catch on importScripts, better errors
- app.js: Enhanced preload error handling

This version should actually work - previous bugs were:
1. Wrong event name prevented TTS preview init
2. CSP blocked worker CDN loading
2026-03-31 16:04:25 +00:00
ifedan-ed
068cb258e9 v15.1: CRITICAL FIX - TTS Preview + Browser Whisper actually working now
ROOT CAUSES FOUND AND FIXED:
1. TTS Preview not working: voicePreferences.js listening for wrong event
   - Was: 'tab-loaded' (never dispatched)
   - Now: 'tabChanged' (correct event name used by app.js)
   - Added immediate init if page already loaded
   - Added 500ms delay for DOM readiness

2. Browser Whisper CDN blocked: CSP too restrictive
   - Added 'unsafe-eval' to scriptSrc (required by transformers.js)
   - Added cdn.jsdelivr.net to connectSrc (worker importScripts)
   - Added childSrc directive for worker script loading
   - Better error messages in worker

3. Worker loading errors: Now logged with specific reasons
   - importScripts wrapped in try-catch
   - Posts error message to main thread
   - Verifies transformers object exists after load

Testing:
- TTS Preview should now work when clicking Settings tab
- Browser Whisper should load from CDN (or show specific error)
- Console logs will show exact init sequence
2026-03-31 16:00:10 +00:00
ifedan-ed
d96a008dfe v15: Fix TTS preview + Browser Whisper preload with extensive debugging
BREAKING FIXES:
- TTS Preview: Added event.preventDefault(), console logging, proper init check
- Browser Whisper: Complete console logging pipeline, error handling, progress tracking
- Voice Preferences: DOMContentLoaded fallback, explicit button click handlers
- Whisper Worker: Console logs at every step, better error messages

Debugging Features:
- Console logs show: button clicks, init events, progress updates, errors
- Progress tracking: [WhisperWorker] Progress: model.bin 47%
- Error messages: Specific failure reasons (not generic failures)
- Timeout warnings: 30s check for stuck downloads

Audio Backup Confirmed:
- Deletes immediately on successful transcription (line 621-624 app.js)
- NOT after 24 hours - 24h is server retention limit for failed transcriptions
- User was correct - this is working as designed

How to Debug:
1. Open DevTools → Console (F12)
2. Click button
3. Watch for [VoicePrefs] or [BrowserWhisper] logs
4. Check Network tab for actual downloads
5. Report what you see in console
2026-03-31 15:28:38 +00:00
ifedan-ed
42daff2343 Fix TTS preview + Browser Whisper preload, add comprehensive docs
Fixes:
- TTS preview: Better error handling, console logging, empty value check
- Browser Whisper: Add progress logging, 30s timeout warning, better UX
- Voice preferences: Clearer error messages

New Documentation:
- FEATURES_EXPLAINED.md: Complete guide to all v14 features
  - Audio backups explained (works every recording, not just on failure)
  - S3 integration setup guide (AWS, B2, MinIO)
  - Learning Hub default path explained (AI file picker starting folder)
  - Browser Whisper troubleshooting (download progress tracking)
  - TTS preview debugging steps
  - Comprehensive troubleshooting guide
2026-03-31 15:13:53 +00:00
ifedan-ed
ef0f986c2f Add per-user voice preferences (STT model + TTS voice selection)
- NEW: User preferences for STT model and TTS voice
- Database: stt_model and tts_voice columns in users table
- UI: Voice Preferences section in Settings with dropdowns
- API: /api/user/preferences (GET/POST) + /preferences/options
- Transcribe: Respects user's STT model (Google, LiteLLM)
- TTS: Respects user's TTS voice (Google, LiteLLM, OpenAI, ElevenLabs)
- Preview: Test TTS voice before saving
- Available models/voices auto-detected from provider config
2026-03-31 14:47:00 +00:00
ifedan-ed
096d40f72d Add embeddings setup documentation 2026-03-31 14:37:46 +00:00
ifedan-ed
106e4baf17 Add Vertex AI embeddings + semantic search for Learning Hub
- New: Vector search with pgvector extension (cosine similarity)
- Embeddings: Vertex AI text-embedding-005 (768 dims, HIPAA-eligible)
- 3 search modes: keyword, semantic, hybrid (best of both)
- Auto-generate embeddings on content create/update
- Admin endpoints: /api/admin/learning/embeddings/generate (backfill), /status
- User endpoints: /api/learning/search/semantic, /search/hybrid
- Falls back to OpenAI embeddings if Vertex not configured
- Supports LiteLLM proxy routing

Models tested:
- vertex_ai/text-embedding-005 (768 dims, English+code) 
- vertex_ai/gemini-embedding-001 (3072 dims, multilingual) 
- vertex_ai/text-multilingual-embedding-002 (768 dims) 
2026-03-31 14:36:49 +00:00
ifedan-ed
0658b31df3 Update docker-compose to use v14 2026-03-31 14:21:25 +00:00
ifedan-ed
67c8638654 v14: Browser Whisper transcription (WebAssembly, client-side, HIPAA-safe) 2026-03-31 14:16:06 +00:00
Daniel Onyejesi
f126cf9fd7 Add browser-side Whisper transcription (local, zero network, HIPAA-safe)
- whisperWorker.js: Web Worker running @xenova/transformers Whisper in WASM
- browserWhisper.js: main-thread manager — audio→Float32 conversion, worker lifecycle
- transcribeAudio() checks BrowserWhisper.isEnabled() first, falls back to server
- Settings UI: enable/disable, model picker (tiny/base/small), pre-download button
- CSP: add wasm-unsafe-eval, cdn.jsdelivr.net, HuggingFace CDN domains
- Default: whisper-tiny.en (~39MB, ~2-3s per clip)
2026-03-31 07:30:17 -04:00
Daniel Onyejesi
2875e0cefd Fix Read aloud stop button: findReadButton now finds data-action=speak buttons
The button was always returning null because it searched for onclick=speakText
but all output cards use data-action="speak" data-target="id". Now checks
data-action first so the button correctly toggles to Stop during playback.
2026-03-30 21:37:00 -04:00
Daniel Onyejesi
6db6a99eb2 Emails: true markdown/Resend style — plain white, no card, clean type
TTS: prefix model with openai/ so LiteLLM routes correctly

Email: horizontal rules instead of card border, spacious padding,
wordmark + divider + body + divider + footer. Reads like a doc.
TTS: tts-1 becomes openai/tts-1 automatically unless already prefixed.
2026-03-30 20:53:11 -04:00
Daniel Onyejesi
ef80b75b6f Clean email templates (Linear/Resend style) + LiteLLM Gemini STT
Emails: white card, clean typography, dark button, no gradients.
Same minimal aesthetic as Linear/Resend/Notion emails.
Verify page responses also updated to match.
2026-03-30 20:51:11 -04:00
Daniel Onyejesi
f78f25e42f Fix LiteLLM STT: use chat/completions with Gemini audio instead of broken /audio/transcriptions
LiteLLM /audio/transcriptions gives 'Unmapped provider' for Vertex AI Chirp.
The correct approach: use /v1/chat/completions with a Gemini model and send
audio as base64 input_audio content block — Gemini natively understands audio.
Set LITELLM_STT_MODEL to your Gemini model name (e.g. gemini-2.5-flash).
2026-03-30 19:52:58 -04:00
ifedan-ed
28fe1f520e v13: Increase JSON limit to 10MB, client-side size check for chart review
- Raise express.json limit from 1MB to 10MB — handles large chart reviews
  with many notes (50 full clinic notes ≈ 600KB, well within new limit)
- Client-side: warn user if payload >8MB, friendly toast if >30 notes
- Bump to v13.0.0
2026-03-30 22:41:17 +00:00
ifedan-ed
f5ed67ccaf Update package-lock.json 2026-03-30 20:39:11 +00:00
ifedan-ed
f2730bdc83 Fix chart review: prompt selection by top-level type, include per-visit labs
- Bug 1: When user selected "Outpatient" review type but had any subspecialty
  visit cards filled in, the backend ignored the top-level type and switched to
  the subspecialty prompt. Fixed: top-level type dropdown is now definitive.
  Per-visit note types only control data formatting/labeling, not prompt selection.

- Bug 2: Labs entered in a visit card were silently dropped for outpatient and
  subspecialty visits (only ED visit labs were included). Fixed: per-visit labs
  now appear immediately after their visit content, labeled with the visit date.

- Improved lab labeling: visit labs are labeled "Labs from this visit (date)"
  and the separate labs section is labeled "ADDITIONAL LABS (not tied to a
  specific visit)" so the AI clearly distinguishes them.
2026-03-30 20:30:07 +00:00
ifedan-ed
7e22902e47 v12: LiteLLM voice support, Vertex AI, model discovery, APK crash fix
- LiteLLM: chat, TTS (tts-1), STT (whisper-1) via proxy
- Google Vertex AI: direct chat, Gemini STT, Google Cloud TTS
- Admin model management: discover/search/toggle/custom models
- TTS shows actual provider in toast (not hardcoded ElevenLabs)
- APK crash fix: proper PNG splash + mipmap icons
- Server-side audio backups with gzip compression
- Expandable AI correction viewer
- Zero-config browser speech recognition
- Bump to v12.0.0
2026-03-30 15:38:59 +00:00
ifedan-ed
d5d0ddcb95 Show TTS provider in toast, support full LiteLLM model paths
- TTS response now includes X-TTS-Provider header (google-tts, litellm/model, elevenlabs)
- Frontend reads header and shows actual provider in toast instead of hardcoded "Adam/ElevenLabs"
- CORS exposes X-TTS-Provider header so frontend can access it
- Updated .env.example: clarify that LITELLM_TTS_MODEL and LITELLM_STT_MODEL
  can be either the model_name alias OR the full provider/model path depending
  on your LiteLLM config (important for BAA compliance routing)
2026-03-30 13:37:20 +00:00
ifedan-ed
6a7103a3f9 Fix LiteLLM STT default: use whisper-1 instead of vertex_ai/chirp
vertex_ai/chirp does not work via LiteLLM's audio transcription proxy.
Changed default LITELLM_STT_MODEL from vertex_ai/chirp to whisper-1.
Updated .env.example documentation to match.
2026-03-30 13:28:49 +00:00
Daniel Onyejesi
4808d08aa7 Fix STT/TTS properly per LiteLLM docs
STT: Vertex AI Chirp not supported via LiteLLM proxy (confirmed by docs).
     Now uses Gemini directly (transcribeGoogle.js) — auto-detected when
     GOOGLE_VERTEX_PROJECT is set, fallback to AWS then OpenAI.

TTS: LiteLLM Vertex TTS DOES work but requires the model_list ALIAS
     (tts-1) not the underlying path (vertex_ai/text-to-speech).
     Also pass voice param — LiteLLM supports Google Cloud voice names.
     Auto-detected when LITELLM_API_BASE is set.
2026-03-30 07:28:47 -04:00
Daniel Onyejesi
7a50bc061d Fix STT: AWS Transcribe takes priority over LiteLLM in auto-detect
LiteLLM's atranscription has a routing bug with Vertex AI Chirp proxy.
AWS Transcribe is already configured and working. Auto-detect now prefers
AWS over LiteLLM. Use TRANSCRIBE_PROVIDER=litellm to force LiteLLM.
2026-03-29 22:38:06 -04:00
Daniel Onyejesi
63d8a881cb Fix STT/TTS model paths: use exact vertex_ai/ paths for LiteLLM routing
LiteLLM aliases (whisper-1, tts-1) don't resolve in audio endpoints —
only chat completions support alias routing. Use exact paths:
- STT default: vertex_ai/chirp (was whisper-1)
- TTS default: vertex_ai/text-to-speech (was tts-1)
Override via LITELLM_STT_MODEL / LITELLM_TTS_MODEL in .env.
2026-03-29 22:28:32 -04:00
Daniel Onyejesi
2423f4601e v10: TTS/STT axios fixes, better error logging, stop button
- TTS: switch to axios, drop voice param (configured in LiteLLM per model)
- STT: log full LiteLLM error body so 500s are diagnosable in logs
- TTS: same error detail logging
- Fix 'ElevenLabs unavailable' toast to generic 'TTS unavailable'
- Add red Stop button to encounter recording UI
2026-03-29 22:12:02 -04:00
Daniel Onyejesi
325575576c Fix TTS axios/Vertex, generic toast, add stop button to encounter
- TTS: switch from OpenAI SDK to axios (same fix as STT), drop voice
  param since it's configured inside LiteLLM per model
- Fix 'ElevenLabs unavailable' toast shown even when provider is LiteLLM
- Add dedicated red Stop button to encounter recording UI
2026-03-29 22:09:56 -04:00
Daniel Onyejesi
832fbc1283 Fix LiteLLM STT: remove prompt/response_format unsupported by Vertex Chirp
Vertex AI Chirp via LiteLLM rejects/hangs when 'prompt' and
'response_format' are included — these are OpenAI Whisper-only params.
Send only file + model for LiteLLM/Chirp.
2026-03-29 21:54:12 -04:00
Daniel Onyejesi
d1138c8cc2 Revert STT auto-detect: LiteLLM handles audio when LITELLM_API_BASE is set 2026-03-29 21:48:44 -04:00
Daniel Onyejesi
0ada98a13e Fix STT auto-detection: don't route to LiteLLM unless LITELLM_STT_MODEL is set
Having LITELLM_API_BASE for AI text was auto-routing audio transcription
through LiteLLM even when the proxy has no Whisper model configured,
causing silent hangs. Now LiteLLM STT only activates when LITELLM_STT_MODEL
is explicitly set. Falls back correctly to AWS Transcribe when configured.
2026-03-29 21:42:24 -04:00
Daniel Onyejesi
38b1818148 Fix LiteLLM STT: use axios directly instead of OpenAI SDK
OpenAI SDK's audio.transcriptions.create() hangs with LiteLLM
(no timeout, SDK-level incompatibility with multipart handling).
Use axios + form-data directly with 120s timeout — same approach
as ElevenLabs TTS. Handles both {text:"..."} and plain string responses.
2026-03-29 21:32:30 -04:00
Daniel Onyejesi
1ab9878425 Bump to v10 — new tag forces server to pull updated image 2026-03-29 20:14:36 -04:00
Daniel Onyejesi
6f1bd97596 Fix: bump SW cache to v12, switch JS/CSS to network-first
Old pedscribe-v11 cache was serving stale admin.js to browsers
even after server updates. New cache name forces old SW to
deactivate and all clients to get fresh JS on next load.
Also switch JS/CSS from stale-while-revalidate to network-first
so code fixes are picked up immediately.
2026-03-29 20:02:34 -04:00
Daniel Onyejesi
58c8f1c549 Fix model management: empty LiteLLM list, always reload panel, clear-all
- LITELLM_MODELS = [] — no hardcoded models, global selector now only
  shows what admin has actually added via Search API
- getAvailableModelsWithOverrides: for LiteLLM returns only custom list
- Remove toggle safety check — admin can disable any/all models freely
- Admin panel always reloads on tab open (was cached, showing stale data)
- Add 'Clear all models' button for LiteLLM to wipe and start fresh
- Add POST /config/models/clear-all endpoint
2026-03-29 19:32:09 -04:00
Daniel Onyejesi
683afeea0b Add LiteLLM STT and TTS support
- TRANSCRIBE_PROVIDER=litellm routes audio to LiteLLM /audio/transcriptions
- TTS_PROVIDER=litellm routes to LiteLLM /audio/speech
- Both auto-detect when LITELLM_API_BASE is set (no extra config needed)
- LITELLM_STT_MODEL (default: whisper-1), LITELLM_TTS_MODEL (default: tts-1)
- LITELLM_TTS_VOICE (default: alloy) — alloy/echo/fable/onyx/nova/shimmer
- ElevenLabs still works if ELEVENLABS_API_KEY is set and TTS_PROVIDER=elevenlabs
- Health endpoint now reports tts provider
2026-03-29 19:11:16 -04:00
Daniel Onyejesi
e4daa7590c Fix admin model management: route ordering, LiteLLM built-ins, auto-select
- Root cause: PUT /config/:key(*) wildcard was registered before
  /config/models/toggle and /config/models/default, intercepting them
  and returning "value is required" (body had modelId not value)
- Fix: move all model-specific PUT routes before the wildcard
- LiteLLM: return empty built-in list with discovery hint (hardcoded
  models don't match user's proxy — must use Search API)
- After adding a discovered model: auto-select it in the default dropdown
- GET /config/models now returns defaultModel so dropdown pre-selects it
2026-03-29 18:42:09 -04:00
Daniel Onyejesi
9ec4cbf6b1 v9.1: Add Google Vertex AI + LiteLLM support, admin model management panel
- Add Vertex AI provider (Gemini models via @google-cloud/vertexai SDK)
- Add LiteLLM proxy support (OpenAI-compatible, routes to any provider)
- Admin panel: model search/discover from provider API, enable/disable, custom models, set default
- New endpoints: /config/models/discover, /config/models/add-discovered, /config/models/default
- Updated models.js with VERTEX_MODELS and LITELLM_MODELS lists
- Updated health endpoint with vertex + litellm status
2026-03-29 10:32:45 -04:00
ifedan-ed
e9cab13c4f Fix APK crash: replace XML splash with PNG, add real mipmap launcher icons
Root cause: TWA LauncherActivity.onCreate calls Bitmap.createBitmap on the
splash drawable — the XML layer-list with only a color fill had 0x0 intrinsic
dimensions, causing IllegalArgumentException: "width and height must be > 0".

Fixes:
- Replace splash.xml with splash.png (384x384 blue circle with P logo)
- Add proper PNG launcher icons at all 5 density buckets (mdpi through xxxhdpi)
- Change android:icon from @drawable to @mipmap for proper icon resolution
2026-03-29 11:07:10 +00:00
ifedan-ed
1371d705da Server-side audio backups with compression, viewable AI corrections
Audio Backups:
- New audio_backups table in PostgreSQL (bytea, gzip compressed)
- POST /api/audio-backups — upload with gzip compression (level 6)
- GET /api/audio-backups — list user's backups
- GET /api/audio-backups/:id/audio — download decompressed audio
- DELETE /api/audio-backups/:id — delete backup
- Auto-cleanup every hour (24h expiry)
- Frontend saves to server first, falls back to IndexedDB
- Settings shows source badge (server/local) per backup

AI Corrections:
- Corrections list is now expandable — click to view original vs corrected
- Shows red "Original" and green "Corrected to" sections
- Click arrow to expand/collapse each correction
- Date shown on each correction
2026-03-29 10:56:31 +00:00
ifedan-ed
364d564fca Fix Android crash: use resource references for TWA colors instead of inline hex
The TWA LauncherActivity crashed with Resources$NotFoundException (0xffffffff)
because android:value with hex color strings is not supported by
androidbrowserhelper — it expects android:resource pointing to color resources.

- Created res/values/colors.xml with all app colors
- Changed AndroidManifest.xml to use android:resource="@color/..."
- Updated styles.xml to reference color resources
2026-03-29 10:47:27 +00:00
ifedan-ed
f609891d0d Security: remove auth debug logging that exposed emails and responses
Removed console.log statements in auth.js that logged email addresses
and auth API responses to browser console. Final cleanup for v9.
2026-03-29 10:41:35 +00:00
ifedan-ed
54c9aa1843 Remove admin model management panel — models use global selector instead
The admin model management (enable/disable, custom models, default override)
had persistent rendering issues. Removed the UI panel — models are managed
via the global model selector in the header, which works reliably. Backend
API endpoints for model config are retained for future use.
2026-03-29 02:30:29 +00:00
ifedan-ed
9e79a05676 Zero-config speech: skip upload when no transcription API, use browser speech directly
- Add GET /api/transcribe/status endpoint — returns whether any server
  transcription provider (Whisper/AWS/Local) is configured
- Frontend checks status on login via checkTranscribeStatus()
- When no provider configured: recording stops instantly, keeps live
  Web Speech API text, shows friendly toast — no error, no upload wait
- Works in encounter, dictation, and SOAP tabs
- App now works fully out-of-the-box with just an AI provider key
2026-03-29 02:09:53 +00:00
ifedan-ed
268b6977cf Fix: admin models loading, clear refine/instructions on New, bigger HPI areas, unique labels
- Admin models: reset modelsLoaded flag on error so retry works
- Admin default model: fix redundant fetch race condition
- clearTab: now clears refine inputs, instructions, and demographic fields
- Encounter/dictation clear buttons: also clear refine input
- SOAP: instructions textarea already cleared by clearTab (soap-instructions)
- Encounter HPI: bigger transcript (400px) and output (600px) text areas
- Unique label enforcement: 409 error if saving with duplicate label
2026-03-29 01:35:45 +00:00
ifedan-ed
72e91e940c Revert chunk size to 8KB — larger sizes cause AWS deserialization errors
Keep 8KB CHUNK_SIZE (proven stable) but replace 10ms setTimeout delay
with a microtask break every 16 chunks. This avoids the AWS SDK
"Deserialization error: inspect {error}.\$response" while still
eliminating the ~1.25s/MB artificial delay from the old 10ms sleep.
2026-03-29 01:21:43 +00:00
ifedan-ed
35f03ac0ba Optimize transcription speed: remove artificial delays, add timing
- AWS Transcribe: remove 10ms delay between chunks (was adding ~1.25s/MB),
  increase chunk size from 8KB to 32KB (AWS max per frame)
- Add detailed timing logs (ffmpeg, streaming, total) for diagnostics
- OpenAI Whisper: use response_format='text' for faster response parsing
- Frontend: show transcription time in toast, request 16kHz sample rate,
  increase bitrate to 32kbps Opus (better quality, still small files)
- Return duration in API response for all providers
2026-03-29 00:59:30 +00:00
ifedan-ed
28c3758eb6 Fix APK signing: use apksigner directly instead of broken r0adkll action
The r0adkll/sign-android-release@v1 hardcodes build-tools 29.0.3 which
isn't available. Now uses apksigner from the latest installed build-tools
directly with zipalign + sign + verify steps.
2026-03-29 00:51:42 +00:00
ifedan-ed
cd3698f698 Fix APK build: add appcompat dependency for Theme.AppCompat 2026-03-29 00:46:51 +00:00
ifedan-ed
7d453094a0 Fix APK build: use Gradle setup action, generate proper wrapper
The gradlew stub and missing gradle-wrapper.jar caused CI build to fail.
Now uses gradle/actions/setup-gradle@v4 to install Gradle, then generates
wrapper before building. Also renames signed APK and uploads both signed
and unsigned to GitHub Releases.
2026-03-29 00:41:42 +00:00
ifedan-ed
88b8a5d418 Add SHA256 fingerprint to assetlinks.json for TWA domain verification 2026-03-29 00:32:58 +00:00
ifedan-ed
ee60d269a5 v9: APK hardening, service worker caching, admin model validation, Docker v9
- APK: Add WAKE_LOCK, BOOT_COMPLETED, ACCESS_NETWORK_STATE permissions
- APK: Disable allowBackup for medical data security
- APK: AudioRecordingService now acquires wake lock, has stop action in notification
- Serve /.well-known/assetlinks.json for TWA domain verification
- Service worker: cache app shell, stale-while-revalidate for assets, network-first for API
- Admin model management: validate model ID format, prevent built-in conflicts, audit toggle actions, prevent disabling all models
- Bump version to v9.0.0, Docker tag to v9
2026-03-28 23:53:39 +00:00
Daniel Onyejesi
007eef6887 Add admin model management dashboard — enable/disable, custom models, default override
- Full model management UI in admin panel: toggle models on/off, add custom
  model IDs (any OpenRouter/Bedrock ID), set admin-configured default model
- /api/models now returns admin-set default model, frontend respects it
- Toggle switch CSS for clean enable/disable UX
- Backend already had the API endpoints, this adds the missing UI
2026-03-28 22:07:16 +00:00
Daniel Onyejesi
044c809ff3 v10: Local Whisper transcription, bigger text areas, flexible AI memory
- Add local Whisper (whisper.cpp / faster-whisper) as transcription provider
  Set TRANSCRIBE_PROVIDER=local with configurable model size and binary path
- Upgrade all refine/instruction inputs to resizable textareas across
  encounter, dictation, hospital course, chart review, well visit, sick visit
- Make AI memory injection flexible: physician preferences and corrections
  are now actively applied (not just "formatting reference"), while still
  overridable by current prompt instructions
2026-03-28 22:00:30 +00:00
Daniel Onyejesi
1191ba0d2d Set TWA default host to peds.danvics.com, simplify APK workflow 2026-03-28 21:12:25 +00:00
Daniel Onyejesi
08a8fb26c4 v9: Major feature update — audio backup, SOAP save, Dragon memory, S3 docs, CI/CD, APK
Phase 1 — Critical Fixes:
- Fix SOAP instructions not clearing on Clear button
- Show transcription provider (AWS/OpenAI) in UI toast
- Fix silent transcription failures in dictation and SOAP modules
- Add IndexedDB audio backup system (24hr retention, retry from Settings)
- Prevent duplicate encounter saves with idempotency keys
- Add Save/Load/New bar to SOAP note generator

Phase 2 — Features:
- Dragon-like AI memory: auto-track user corrections, inject into prompts
- Per-section template categories (SOAP, HPI, well visit, sick visit)
- Bigger textarea for SOAP instructions
- S3 document upload/management (AWS S3, Backblaze B2, MinIO compatible)
- Faster transcription via lower bitrate recording (16kbps opus)

Phase 3 — APK & CI/CD:
- GitHub Actions: Docker build+push on version tags
- GitHub Actions: TWA APK build for Obtainium auto-updates
- Android TWA project with foreground service for background recording
- Enhanced PWA manifest with shortcuts and maskable icons
2026-03-28 21:08:32 +00:00
Daniel Onyejesi
5cad43d19a Security fixes: remove SSO token from URL, add prompt boundaries
- OIDC callback now passes only ?sso=ok flag, token stays in
  httpOnly cookie (prevents token leaking to logs/referrer/history)
- Frontend auth.js uses cookie-based auth for SSO flow
- Add [PHYSICIAN TEMPLATES] boundary markers around physicianMemories
  in all 5 generation routes to mitigate prompt injection
- Consistent boundary format across wellVisit, sickVisit, hpi, soap,
  hospitalCourse
2026-03-25 19:25:49 -04:00
Daniel Onyejesi
898036bfcd Remove Firefox speech notice, fix auth.js SSO flow race condition
- Remove Firefox speech recognition notice (not needed)
- Fix missing closing brace that made speech recognition unreachable
- Fix auth.js SSO token handling to prevent brief auth screen flash
2026-03-25 19:04:20 -04:00
Daniel Onyejesi
17646af5e3 Add OpenID Connect SSO + Firefox speech notice
OIDC/SSO:
- New /api/auth/oidc route with PKCE for secure authorization
- Supports Azure AD, Okta, Keycloak, PocketID, Google, any OIDC provider
- Admin configurable: issuer, client ID/secret, button label
- Option to disable local auth (force SSO only)
- Auto-creates users on first SSO login, links existing by email
- SSO button on login page, hidden until admin enables OIDC

Firefox:
- Show info toast on first recording that live preview requires
  Chrome/Edge; server-side transcription still works in all browsers
2026-03-25 18:54:44 -04:00
Daniel Onyejesi
25c462bfd6 Fix AWS Transcribe: reduce chunk size from 32KB to 8KB
AWS Transcribe rejects audio event frames over ~16KB with a
cryptic "Deserialization error" / "Your stream is too big" message
hidden inside the SDK error object. Reducing to 8KB per chunk
fixes both Standard and Medical Transcribe streaming.
2026-03-25 18:41:05 -04:00
Daniel Onyejesi
6d1c2e5422 Improve Transcribe error diagnostics, add minimum audio check
- Log $response status/headers/body on deserialization errors
- Add 10ms delay between audio chunks to prevent stream overload
- Skip transcription if audio < 0.5s (too short for recognition)
- Cleaner error logging with dedicated logTranscribeError helper
2026-03-25 18:29:48 -04:00
Daniel Onyejesi
a53124a747 Add detailed error logging for Transcribe Medical failures
Log error name, AWS metadata, and root cause to diagnose
the "non-retryable streaming request" error.
2026-03-25 18:24:37 -04:00
Daniel Onyejesi
1f66b7c0e1 Add Medical→Standard fallback and better error logging for AWS Transcribe
When Medical Transcribe fails (wrong IAM permissions, region not
supported), automatically falls back to Standard Transcribe instead
of returning an error. Logs the specific failure reason.
2026-03-25 18:10:21 -04:00
Daniel Onyejesi
9758ecbea2 Fix missing error handling in nextcloud disconnect, update docker-compose to v8
- Add try-catch to /nextcloud/disconnect route (was crashing on DB errors)
- Update docker-compose.yml image tag from v7 to v8
- Remove unused SESSION_SECRET from .env.example
2026-03-25 17:53:48 -04:00
Daniel Onyejesi
6e1b6ca3d7 Wire physician memories/templates into all AI generation routes
Previously only well-visit and sick-visit used saved physician
templates. Now HPI encounter, HPI dictation, SOAP, and hospital
course all fetch getUserMemoryContext() and pass physicianMemories
to the backend so the AI learns from saved templates/preferences.
2026-03-25 17:35:30 -04:00
Daniel Onyejesi
eb63d9973d v8.0.0: Fix speech recognition repeating text, enable AWS Transcribe Medical
- Add deduplication logic to prevent Chrome Speech API from repeating
  sentences during long recording sessions (all 4 recording modules)
- Enable AWS Transcribe Medical with PRIMARYCARE specialty in .env
- Bump version to 8.0.0
2026-03-25 17:24:28 -04:00
Daniel Onyejesi
9eaec4f2de Add ffmpeg audio conversion fallback for AWS Transcribe
- transcribeAWS.js: convert browser WebM/Opus → PCM 16kHz mono via
  ffmpeg before sending to AWS Transcribe — PCM is unambiguous and
  most reliable; gracefully falls back to ogg-opus if ffmpeg absent
- Dockerfile: install ffmpeg (apk add ffmpeg) so Docker image works
  out of the box with AWS Transcribe
- README: document Amazon Transcribe setup, ffmpeg requirement,
  Transcribe Medical specialty options, and env vars reference
2026-03-25 20:35:24 +00:00
Daniel Onyejesi
b997d6d388 Add Amazon Transcribe streaming (no S3) with Medical specialty support
- New src/utils/transcribeAWS.js: streams audio directly to AWS
  Transcribe without requiring an S3 bucket
- Supports AWS_TRANSCRIBE_MEDICAL=true for Transcribe Medical
  (better clinical accuracy: drug names, diagnoses, procedures)
- AWS_TRANSCRIBE_SPECIALTY configures specialty (default PRIMARYCARE)
- transcribe.js auto-selects AWS when AWS_BEDROCK_REGION is set,
  or can be forced with TRANSCRIBE_PROVIDER=aws|openai
- Falls back to OpenAI Whisper when AWS is not configured
- Add @aws-sdk/client-transcribe-streaming as optional dependency
- Update .env.example with transcription configuration docs
2026-03-25 20:26:10 +00:00
Daniel Onyejesi
7a2c569b63 v7: fix speech recognition repetition, HTML injection, long-session guard
- Fix word repetition: use sessionFinals pattern so each browser SR
  session starts fresh; no overlap when recognition auto-restarts
- Fix HTML injection / '>' parse error: escape < > & in live transcript
  innerHTML before inserting speech recognition text
- Add 24 MB blob guard: fall back to live SR transcript if audio file
  is too large for Whisper API (long sessions)
- Bump version to 7.0.0, update docker-compose image tag to v7
2026-03-25 20:07:10 +00:00
320 changed files with 10343 additions and 53467 deletions

View file

@ -3,6 +3,7 @@
!.env.example !.env.example
.git .git
.gitignore .gitignore
.agent-config
node_modules node_modules
data/ data/
*.log *.log

View file

@ -1,20 +1,3 @@
# ============================================================
# OPENBAO (optional — recommended for production)
# ============================================================
# When these three are set, the container fetches everything else below
# from OpenBao at kv/ped-ai/prod and ignores the equivalent .env values.
# Leave them unset (or blank) to fall back to .env-only (local dev, e2e).
#
# OPENBAO_ADDR=https://app.danvics.com
# OPENBAO_ROLE_ID=<from: bao read auth/approle/role/ped-ai/role-id>
# OPENBAO_SECRET_ID=<from: bao write -f auth/approle/role/ped-ai/secret-id>
# OPENBAO_KV_PATH=kv/ped-ai/prod # override path if needed
# ============================================================
# Everything below is sourced from OpenBao when OPENBAO_ADDR is set.
# Only fill these in for local dev / e2e / when running without vault.
# ============================================================
# ============================================================ # ============================================================
# AI PROVIDER (choose one) # AI PROVIDER (choose one)
# ============================================================ # ============================================================

View file

@ -1,184 +0,0 @@
name: Forgejo Android APK
on:
workflow_dispatch:
push:
branches:
- '**'
tags:
- 'v*'
jobs:
build:
name: Build signed APK
runs-on: forgejo-local
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up JDK 17
uses: https://github.com/actions/setup-java@v4
with:
distribution: temurin
java-version: '17'
- name: Set up Node 20
uses: https://github.com/actions/setup-node@v4
with:
node-version: '20'
cache: npm
cache-dependency-path: mobile/package-lock.json
- name: Set up Android SDK
uses: https://github.com/android-actions/setup-android@v3
- name: Install Capacitor dependencies
working-directory: mobile
run: |
npm install --no-audit --no-fund
npx cap sync android
- name: Restore signing keystore
env:
KEYSTORE_B64: ${{ secrets.ANDROID_KEYSTORE_BASE64 }}
run: |
test -n "$KEYSTORE_B64"
CLEAN_KEYSTORE_B64="${KEYSTORE_B64#ANDROID_KEYSTORE_BASE64=}"
printf '%s' "$CLEAN_KEYSTORE_B64" | tr -d '\r\n' | base64 -d > "$RUNNER_TEMP/pedscribe-release.jks"
test -s "$RUNNER_TEMP/pedscribe-release.jks"
- name: Build signed release APK
working-directory: mobile/android
env:
KS_PASS: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
KEY_PASS: ${{ secrets.ANDROID_KEY_PASSWORD }}
run: |
./gradlew assembleRelease \
-Pandroid.injected.signing.store.file="$RUNNER_TEMP/pedscribe-release.jks" \
-Pandroid.injected.signing.store.password="$KS_PASS" \
-Pandroid.injected.signing.key.alias="$KEY_ALIAS" \
-Pandroid.injected.signing.key.password="$KEY_PASS" \
--no-daemon --stacktrace
- name: Check Google Play secret
id: play_publish
run: |
if [[ "$GITHUB_REF" != refs/tags/v* ]]; then
echo "enabled=false" >> "$GITHUB_OUTPUT"
elif [ -z "${GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64:-}" ]; then
echo "enabled=false" >> "$GITHUB_OUTPUT"
else
echo "enabled=true" >> "$GITHUB_OUTPUT"
fi
env:
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64 }}
- name: Build signed release App Bundle
if: steps.play_publish.outputs.enabled == 'true'
working-directory: mobile/android
env:
KS_PASS: ${{ secrets.ANDROID_KEYSTORE_PASSWORD }}
KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
KEY_PASS: ${{ secrets.ANDROID_KEY_PASSWORD }}
run: |
./gradlew bundleRelease \
-Pandroid.injected.signing.store.file="$RUNNER_TEMP/pedscribe-release.jks" \
-Pandroid.injected.signing.store.password="$KS_PASS" \
-Pandroid.injected.signing.key.alias="$KEY_ALIAS" \
-Pandroid.injected.signing.key.password="$KEY_PASS" \
--no-daemon --stacktrace
- name: Install fastlane
if: steps.play_publish.outputs.enabled == 'true'
working-directory: mobile/android
run: |
gem install bundler -N
bundle install
- name: Upload bundle to Google Play (internal track)
if: steps.play_publish.outputs.enabled == 'true'
working-directory: mobile/android
env:
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64: ${{ secrets.GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64 }}
PLAY_TRACK: internal
run: |
test -n "$GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64"
CLEAN_PLAY_JSON_B64="${GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64#GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64=}"
printf '%s' "$CLEAN_PLAY_JSON_B64" | tr -d '\r\n' | base64 -d > fastlane/google-play-service-account.json
AAB=$(find app/build/outputs/bundle/release -name '*.aab' | head -1)
test -n "$AAB"
AAB_PATH="$AAB" bundle exec fastlane android publish_internal
rm -f fastlane/google-play-service-account.json
- name: Collect APK
run: |
mkdir -p artifacts
APK=$(find mobile/android/app/build/outputs/apk/release -name '*.apk' | head -1)
test -n "$APK"
cp "$APK" "artifacts/pedscribe-${GITHUB_REF_NAME:-manual}.apk"
- name: Upload APK artifact
uses: https://github.com/actions/upload-artifact@v3
with:
name: pedscribe-android-apk
path: artifacts/*.apk
retention-days: 30
- name: Publish Forgejo release
if: startsWith(github.ref, 'refs/tags/v')
env:
FORGEJO_TOKEN: ${{ secrets.FORGEJO_TOKEN }}
TAG_NAME: ${{ github.ref_name }}
TARGET_COMMIT: ${{ github.sha }}
run: |
test -n "$FORGEJO_TOKEN"
API_URL="${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}"
APK=$(find artifacts -name '*.apk' | head -1)
test -n "$APK"
node - <<'NODE'
const fs = require('fs');
fs.writeFileSync('release-payload.json', JSON.stringify({
tag_name: process.env.TAG_NAME,
target_commitish: process.env.TARGET_COMMIT,
name: process.env.TAG_NAME,
body: 'Signed Android APK for Obtainium updates.',
draft: false,
prerelease: false,
}));
NODE
status=$(curl -sS -o release.json -w '%{http_code}' \
-X POST "$API_URL/releases" \
-H "Authorization: token $FORGEJO_TOKEN" \
-H 'Content-Type: application/json' \
--data-binary @release-payload.json)
if [ "$status" = "409" ]; then
curl -fsS "$API_URL/releases/tags/$TAG_NAME" \
-H "Authorization: token $FORGEJO_TOKEN" > release.json
elif [ "$status" != "201" ]; then
cat release.json
exit 1
fi
RELEASE_ID=$(node -e "console.log(JSON.parse(require('fs').readFileSync('release.json', 'utf8')).id)")
ASSET_NAME=$(basename "$APK")
export ASSET_NAME
curl -fsS "$API_URL/releases/$RELEASE_ID/assets" \
-H "Authorization: token $FORGEJO_TOKEN" > release-assets.json
EXISTING_ASSET_ID=$(node -e "const fs=require('fs'); const name=process.env.ASSET_NAME; const assets=JSON.parse(fs.readFileSync('release-assets.json','utf8')); const asset=assets.find((item)=>item.name===name); if (asset) console.log(asset.id);" )
if [ -n "$EXISTING_ASSET_ID" ]; then
curl -fsS -X DELETE "$API_URL/releases/$RELEASE_ID/assets/$EXISTING_ASSET_ID" \
-H "Authorization: token $FORGEJO_TOKEN"
fi
curl -fsS -X POST "$API_URL/releases/$RELEASE_ID/assets?name=$ASSET_NAME" \
-H "Authorization: token $FORGEJO_TOKEN" \
-F "attachment=@$APK" > release-asset.json

View file

@ -1,45 +0,0 @@
name: Forgejo Docker Build
on:
workflow_dispatch:
inputs:
push_image:
description: Push image to Forgejo container registry
required: false
default: 'true'
jobs:
build:
name: Build Docker image
runs-on: forgejo-local
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Prepare compose env files
run: |
touch .env
- name: Validate Compose config
run: docker compose -f docker-compose.yml config >/tmp/ped-ai-compose.yml
- name: Build compose service
run: docker compose -f docker-compose.yml build pediatric-scribe
- name: Tag image
run: |
IMAGE="git.danvics.com/danvics/pediatric-ai-scribe-v3"
SHORT_SHA=$(git rev-parse --short HEAD)
docker tag ped-ai-local:latest "$IMAGE:$SHORT_SHA"
docker tag ped-ai-local:latest "$IMAGE:latest"
- name: Push image to Forgejo registry
if: ${{ github.event.inputs.push_image != 'false' }}
env:
FORGEJO_TOKEN: ${{ secrets.FORGEJO_TOKEN }}
run: |
IMAGE="git.danvics.com/danvics/pediatric-ai-scribe-v3"
SHORT_SHA=$(git rev-parse --short HEAD)
echo "$FORGEJO_TOKEN" | docker login git.danvics.com -u danvics --password-stdin
docker push "$IMAGE:$SHORT_SHA"
docker push "$IMAGE:latest"

View file

@ -1,16 +0,0 @@
## Summary
-
-
-
## Type of change
- [ ] refactor
- [ ] feature
- [ ] fix
- [ ] docs
## Verification
What did you run locally? (e.g. `npm test`, `npm run typecheck`, manual smoke)
## Linked issues
Closes #

View file

@ -21,7 +21,6 @@ permissions:
jobs: jobs:
build: build:
if: ${{ github.server_url == 'https://github.com' }}
name: Build signed APK name: Build signed APK
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:

View file

@ -31,7 +31,7 @@ permissions:
jobs: jobs:
version: version:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: "github.server_url == 'https://github.com' && !contains(github.event.head_commit.message, 'Release v') && !contains(github.event.head_commit.message, '[skip ci]')" if: "!contains(github.event.head_commit.message, 'Release v') && !contains(github.event.head_commit.message, '[skip ci]')"
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4

View file

@ -14,7 +14,6 @@ env:
jobs: jobs:
build-apk: build-apk:
if: ${{ github.server_url == 'https://github.com' }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions: permissions:
contents: write contents: write

View file

@ -1,34 +0,0 @@
name: CI
# Runs root app tests on every PR and push to main.
on:
pull_request:
push:
branches: [main]
# Cancel superseded runs on the same ref to save minutes.
concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
test:
name: Root app tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node 22
uses: actions/setup-node@v4
with:
node-version: '22'
cache: 'npm'
cache-dependency-path: package-lock.json
- name: Install
run: npm install
- name: Unit tests
run: npm test

View file

@ -24,7 +24,6 @@ env:
jobs: jobs:
build: build:
if: ${{ github.server_url == 'https://github.com' }}
# Build one variant per matrix entry, push by digest only. # Build one variant per matrix entry, push by digest only.
name: Build ${{ matrix.platform }} name: Build ${{ matrix.platform }}
runs-on: ${{ matrix.runner }} runs-on: ${{ matrix.runner }}
@ -81,7 +80,6 @@ jobs:
retention-days: 1 retention-days: 1
merge: merge:
if: ${{ github.server_url == 'https://github.com' }}
# Combine the two single-platform digests into one multi-arch manifest # Combine the two single-platform digests into one multi-arch manifest
# published under the real tags (vX.Y.Z and latest). # published under the real tags (vX.Y.Z and latest).
name: Merge manifests name: Merge manifests

View file

@ -1,30 +0,0 @@
name: Security audit
# Weekly npm audit at high+ severity for the root app. Reports to the job summary; does NOT fail the build
# (advisories appear constantly and a red checkmark train would just get
# muted). Re-run on demand via workflow_dispatch.
on:
schedule:
- cron: '0 6 * * 1' # Mondays 06:00 UTC
workflow_dispatch:
jobs:
audit:
name: npm audit (high+)
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node 22
uses: actions/setup-node@v4
with:
node-version: '22'
- name: Audit root app
run: |
echo '## Root app advisories' >> "$GITHUB_STEP_SUMMARY"
npm audit --audit-level=high --json > legacy-audit.json || true
node -e "const a=require('./legacy-audit.json');const m=a.metadata?.vulnerabilities||{};console.log('high:'+(m.high||0)+' critical:'+(m.critical||0));" >> "$GITHUB_STEP_SUMMARY"
continue-on-error: true

View file

@ -30,7 +30,6 @@ permissions:
jobs: jobs:
bump: bump:
if: ${{ github.server_url == 'https://github.com' }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout

11
.gitignore vendored
View file

@ -3,7 +3,6 @@ node_modules/
.env.local .env.local
.env.production .env.production
data/ data/
!public/data/
*.db *.db
*.db-journal *.db-journal
*.db-wal *.db-wal
@ -31,13 +30,3 @@ android/.idea/
public/models/ public/models/
.env.backup-* .env.backup-*
*.env.backup* *.env.backup*
# e2e test artifacts (keep config + specs, skip results + installed deps)
e2e/node_modules/
e2e/test-results/
e2e/playwright-report/
.codex
.firecrawl/
# Refactored test stack stays local for now

174
BROWSER_WHISPER_SETUP.md Normal file
View file

@ -0,0 +1,174 @@
# Browser Whisper Self-Hosted Setup
## Overview
As of v3, Browser Whisper is **fully self-hosted** with **zero CDN dependencies**. All models and libraries are bundled with the application and served from your own server.
## What Changed
**Before (v2 and earlier):**
- Loaded transformers.js from `cdn.jsdelivr.net`
- Downloaded models from `cdn-lfs.huggingface.co`
- Failed in corporate/clinical networks with firewall restrictions
**Now (v3+):**
- Transformers.js library (v2.6.2) bundled at `/models/transformers.min.js` (760KB)
- Whisper model bundled at `/models/Xenova/whisper-tiny.en/` (42MB)
- Everything served from your own server
- **Works in any network environment** (firewalled, air-gapped, offline)
## Files Included
```
public/models/
├── transformers.min.js (760KB) - Transformers.js v2.6.2 (worker-compatible)
└── Xenova/
└── whisper-tiny.en/ (42MB total)
├── config.json
├── tokenizer.json
├── preprocessor_config.json
├── generation_config.json
└── onnx/
├── encoder_model_quantized.onnx
└── decoder_model_merged_quantized.onnx
```
## How It Works
1. **Worker loads transformers.js locally:**
```javascript
importScripts('/models/transformers.min.js');
```
2. **Transformers.js configured for local models:**
```javascript
T.env.localModelPath = '/models/';
T.env.allowRemoteModels = false;
```
3. **Models load from your server:**
- Browser requests: `GET /models/Xenova/whisper-tiny.en/config.json`
- Served by Express static middleware
- No external network calls
## Docker Build
Models are downloaded **during Docker build** (not runtime):
```dockerfile
RUN curl -sL -o onnx/encoder_model_quantized.onnx \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/onnx/encoder_model_quantized.onnx
```
This means:
- Docker image is ~200MB larger (one-time cost)
- Runtime has zero dependencies
- Works in air-gapped environments (after image is pulled)
## Development Setup
If you're running locally (not Docker), download models:
```bash
cd public/models
mkdir -p Xenova/whisper-tiny.en/onnx
# Download transformers.js
curl -L -o transformers.min.js \
https://cdn.jsdelivr.net/npm/@xenova/transformers@2.17.2/dist/transformers.min.js
# Download model files
cd Xenova/whisper-tiny.en
curl -L -o config.json \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/config.json
curl -L -o tokenizer.json \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/tokenizer.json
curl -L -o preprocessor_config.json \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/preprocessor_config.json
curl -L -o generation_config.json \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/generation_config.json
curl -L -o onnx/encoder_model_quantized.onnx \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/onnx/encoder_model_quantized.onnx
curl -L -o onnx/decoder_model_merged_quantized.onnx \
https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/onnx/decoder_model_merged_quantized.onnx
```
Or use the helper script:
```bash
./scripts/download-whisper-models.sh
```
## Adding More Models
To add base or small models:
1. **Create directory:**
```bash
mkdir -p public/models/Xenova/whisper-base.en/onnx
```
2. **Download from HuggingFace:**
- https://huggingface.co/Xenova/whisper-base.en
- https://huggingface.co/Xenova/whisper-small.en
3. **Update UI in `settings.html`:**
```html
<option value="Xenova/whisper-base.en">Base (~74MB, better quality)</option>
```
4. **Update Dockerfile** to download during build
## Benefits
**Works everywhere** - No firewall/CDN issues
**Privacy-first** - Audio never leaves browser
**Offline capable** - After initial page load
**No API costs** - Zero transcription expenses
**Predictable** - Same model, same results
**Fast** - Local processing, no network latency
## Limitations
- Docker image is larger (~200MB vs ~150MB)
- Only tiny model included by default (base/small optional)
- Slower than cloud APIs for long recordings
- Requires modern browser with WebAssembly support
## Testing
```bash
# 1. Start server
docker-compose up -d
# 2. Open browser DevTools → Network tab
# 3. Go to Settings → Browser Transcription
# 4. Click "Pre-download model"
# 5. Watch for requests to /models/* (should all be 200 OK from your server)
# 6. NO requests to cdn.jsdelivr.net or huggingface.co
```
## Troubleshooting
**Issue: "Failed to load transformers library"**
- Check: `GET /models/transformers.min.js` returns 200 OK
- Verify file exists: `ls public/models/transformers.min.js`
**Issue: "Model load failed"**
- Check: `GET /models/Xenova/whisper-tiny.en/config.json` returns 200 OK
- Verify files exist: `ls public/models/Xenova/whisper-tiny.en/`
**Issue: Still seeing CDN requests**
- Clear browser cache (Ctrl+Shift+R)
- Check you're running v18+ (`/api/health` should show version)
## Migration from v17
If upgrading from v17:
1. Pull new Docker image: `docker-compose pull`
2. Restart: `docker-compose up -d`
3. Clear browser cache
4. Test: Settings → Browser Transcription → Pre-download
No configuration changes needed - it just works!

View file

@ -0,0 +1,240 @@
# Browser Whisper Troubleshooting
## 🎙️ What is Browser Whisper?
Browser Whisper is an **optional** client-side transcription feature that runs entirely in your browser using WebAssembly. It provides:
- ✅ Zero network transmission (HIPAA-safe)
- ✅ No API costs
- ✅ Works offline
- ✅ Privacy-first (audio never leaves device)
**However**, it requires downloading AI models from CDN servers.
---
## ⚠️ Common Issue: CDN Blocked
### Error Message:
```
NetworkError: Failed to execute 'importScripts' on 'WorkerGlobalScope':
The script at 'https://cdn.jsdelivr.net/npm/@xenova/transformers@2.17.2' failed to load.
```
### What This Means:
Your network/firewall is blocking access to:
- `cdn.jsdelivr.net` (JavaScript library CDN)
- `cdn-lfs.huggingface.co` (AI model files)
### Why It Happens:
1. **Corporate firewall** - Many organizations block CDN domains
2. **Browser extensions** - Ad blockers, privacy tools may block CDN
3. **Network proxy** - Company proxy might filter JavaScript CDN
4. **CSP restrictions** - Very strict Content Security Policy
---
## ✅ Solutions
### Option 1: Use Server Transcription (Recommended)
**Browser Whisper is optional!** The app works perfectly fine with server-side transcription.
**Server transcription providers:**
- Google Gemini (via Vertex AI) - HIPAA-eligible
- AWS Transcribe - HIPAA-eligible
- OpenAI Whisper - Fast, accurate
- LiteLLM - Routes to any provider
**To use server transcription:**
1. Go to Settings → Browser Transcription
2. **Leave it disabled** (or if stuck, disable it)
3. Record audio normally - will use server
**Advantages:**
- More accurate (larger models)
- No download needed
- Works immediately
- Professional grade
### Option 2: Whitelist CDN Domains
If you control your network/firewall, whitelist these domains:
```
cdn.jsdelivr.net
cdn-lfs.huggingface.co
cdn-lfs-us-1.huggingface.co
cdn-lfs-us-2.huggingface.co
huggingface.co
```
**For corporate IT:**
- These are legitimate AI/JavaScript CDNs
- Used by major companies worldwide
- No security risk (public CDN content)
- Required only for browser-based AI features
### Option 3: Disable Browser Extensions
Try disabling:
- Ad blockers (uBlock Origin, AdBlock Plus)
- Privacy extensions (Privacy Badger, Ghostery)
- Script blockers (NoScript, ScriptSafe)
Then refresh and try again.
### Option 4: Try Different Browser
Some browsers have stricter security:
- ✅ **Chrome** - Best compatibility
- ✅ **Edge** - Works well
- ⚠️ **Firefox** - May block CDN
- ❌ **Safari** - Limited WebAssembly support
---
## 🧪 How to Test If It's Working
### Test 1: Check CDN Access
```bash
# From your computer, run:
curl -I https://cdn.jsdelivr.net/npm/@xenova/transformers@2.17.2
# Should return: HTTP/2 200
# If 403 or timeout: CDN is blocked
```
### Test 2: Browser Console
1. Open DevTools (F12)
2. Go to Console tab
3. Settings → Browser Transcription
4. Click "Pre-download model"
5. Watch for:
```
✅ [WhisperWorker] Transformers library loaded successfully
OR
❌ NetworkError: Failed to load
```
### Test 3: Network Tab
1. Open DevTools (F12)
2. Go to Network tab
3. Click "Pre-download model"
4. Look for requests to:
- `cdn.jsdelivr.net` (should be 200 OK)
- `cdn-lfs.huggingface.co` (should be 200 OK)
5. If blocked: Status will show "failed" or "blocked"
---
## 📊 When to Use Each Option
| Scenario | Recommendation | Why |
|----------|---------------|-----|
| Corporate network | **Server transcription** | CDN likely blocked |
| Home network | **Browser Whisper** | Fast, free, private |
| Mobile device | **Server transcription** | Limited storage/memory |
| Offline use needed | **Browser Whisper** | Works without internet (after initial download) |
| High accuracy needed | **Server transcription** | Larger models available |
| Maximum privacy | **Browser Whisper** | Audio never leaves device |
| Can't access CDN | **Server transcription** | No choice - CDN blocked |
---
## 🔧 Technical Details
### What Gets Downloaded (First Time Only):
**Tiny model** (~39 MB):
- onnx-runtime.wasm (~10 MB)
- whisper-tiny.en model files (~29 MB)
- Cached in browser IndexedDB (permanent)
**Base model** (~74 MB):
- Larger model, better accuracy
**Small model** (~244 MB):
- Best quality, slower processing
### Where It's Stored:
- **Location:** Browser IndexedDB
- **Persistence:** Permanent (until you clear browser data)
- **Shared:** Across all tabs/windows for this domain
- **Size:** Selected model size (39/74/244 MB)
### Performance:
- **Tiny:** 2-3 seconds per 30-second clip
- **Base:** 3-5 seconds per 30-second clip
- **Small:** 6-10 seconds per 30-second clip
---
## ❓ FAQ
**Q: Is Browser Whisper required?**
A: No! It's completely optional. Server transcription works great.
**Q: Why doesn't it work on my corporate network?**
A: Most corporate firewalls block CDN domains for security. Use server transcription instead.
**Q: Can I download the models manually?**
A: Not easily - they're optimized for CDN delivery. Use server transcription if CDN is blocked.
**Q: Will server transcription cost money?**
A: Depends on your provider:
- Google Vertex AI: ~$0.005 per minute
- AWS Transcribe: ~$0.024 per minute
- OpenAI: $0.006 per minute
- Very affordable for typical use
**Q: Is server transcription HIPAA-safe?**
A: Yes, if using:
- Google Vertex AI (with BAA)
- AWS Transcribe (with BAA)
- Azure OpenAI (with BAA)
OpenAI Whisper direct is NOT HIPAA-eligible.
**Q: Can I use both?**
A: Yes! Enable Browser Whisper in Settings. If it fails (CDN blocked), it automatically falls back to server transcription.
**Q: How do I know which one is being used?**
A: Check the toast notification after recording:
- "Transcribed locally" = Browser Whisper
- "Transcribed via google-gemini/aws/openai" = Server
---
## 🚀 Recommended Setup
### For Maximum Privacy (Home Network):
1. Enable Browser Whisper
2. Choose "Tiny" model (fast, good enough for dictation)
3. Pre-download model
4. Use offline
### For Corporate/Clinical Use:
1. Keep Browser Whisper **disabled**
2. Configure server transcription:
```bash
# In .env:
TRANSCRIBE_PROVIDER=google
GOOGLE_VERTEX_PROJECT=your-project
```
3. Use with BAA for HIPAA compliance
### For Best Accuracy:
1. Use server transcription
2. Configure Google Gemini 2.0 Flash or AWS Transcribe Medical
3. Audio quality + large models = best results
---
## 🛠️ Still Having Issues?
1. **Check console logs:** DevTools → Console → Look for `[BrowserWhisper]` errors
2. **Check network logs:** DevTools → Network → Filter by `jsdelivr` or `huggingface`
3. **Verify server transcription works:** Just disable Browser Whisper and record
4. **Contact IT:** Ask to whitelist CDN domains (if you need Browser Whisper)
**Remember:** Browser Whisper is a nice-to-have feature. Server transcription is the primary, production-ready method that works everywhere!

View file

@ -28,7 +28,7 @@ or Actions tab → **Version bump & release** → Run workflow → pick bump typ
| Workflow | Output | | Workflow | Output |
|---|---| |---|---|
| `.forgejo/workflows/android-apk.yml` | signed APK on Forgejo release (`pedscribe-<tag>.apk`), optional Google Play internal track upload | | `android-release.yml` | signed APK on GitHub release, `make_latest=true` |
| `docker-publish.yml` | `danielonyejesi/pediatric-ai-scribe-v3:{version,latest}` on Docker Hub (amd64) | | `docker-publish.yml` | `danielonyejesi/pediatric-ai-scribe-v3:{version,latest}` on Docker Hub (amd64) |
## Local dev ## Local dev

976
DEVELOPER_GUIDE.md Normal file
View file

@ -0,0 +1,976 @@
# Pediatric AI Scribe — Developer Guide
**Version:** 6.0 | **Stack:** Node.js / Express / PostgreSQL / Vanilla JS
---
## Table of Contents
1. [Project Overview](#1-project-overview)
2. [Architecture](#2-architecture)
3. [Directory Structure](#3-directory-structure)
4. [Environment Variables](#4-environment-variables)
5. [Database Schema](#5-database-schema)
6. [Authentication System](#6-authentication-system)
7. [Backend API Reference](#7-backend-api-reference)
8. [Frontend Architecture](#8-frontend-architecture)
9. [AI Integration](#9-ai-integration)
10. [Learning Hub & CMS](#10-learning-hub--cms)
11. [Deployment](#11-deployment)
12. [Known Issues & Security Notes](#12-known-issues--security-notes)
13. [Adding New Features](#13-adding-new-features)
14. [Resetting Admin Password via Console](#14-resetting-admin-password-via-console)
---
## 1. Project Overview
Pediatric AI Scribe is a clinical documentation platform for pediatric healthcare providers. It uses AI (via OpenRouter, AWS Bedrock, or Azure OpenAI) to generate:
- HPI notes from live encounter recordings
- SOAP notes from dictation
- Hospital course summaries
- Chart reviews
- Well-visit notes (including SSHADESS, ROS/PE, milestones)
- Sick visit notes
- Learning Hub content (articles, quizzes, clinical pearls, presentations)
**Key design principle:** Single-page application. All tabs are lazy-loaded HTML components (`/public/components/*.html`). JavaScript modules initialize only when their tab is first activated via the `tabChanged` custom event.
---
## 2. Architecture
```
Browser (Vanilla JS + Tiptap)
|
| HTTP (JWT Bearer token in Authorization header)
|
Express.js (Node.js) — server.js
|
|— Helmet (CSP, security headers)
|— CORS (restricted to APP_URL in production)
|— express-rate-limit (login: 10/15min, register: 5/hr, resend-verify: 3/15min, general: 60/min)
|— cookie-parser
|— Routes (/src/routes/)
|
PostgreSQL (pg driver, no ORM)
|
|— users, app_settings, audit_log, saved_encounters
|— user_memories, learning_*, access_log, api_log
```
### How Requests Flow
1. **Browser** sends HTTP request with `Authorization: Bearer <jwt>` header
2. **Express middleware chain:** Helmet (security headers) → CORS → rate limiter → body parser → logging middleware → route handler
3. **Auth middleware** (`src/middleware/auth.js`) decodes JWT, queries `users` table, attaches `req.user` with `{ id, email, name, role }`
4. **Route handler** processes the request — for AI routes, calls `callAI()` which routes to the configured provider
5. **Database** is accessed via the `pg` driver directly (no ORM). All queries use parameterized placeholders (`$1`, `$2`) to prevent SQL injection
6. **Response** is JSON for API calls, or static files served from `/public`
### AI Providers
Configured via environment variables. The provider is selected at startup in `src/utils/ai.js` using this priority:
1. **AWS Bedrock** — if `AWS_BEDROCK_REGION` is set. HIPAA eligible with BAA. Uses `@aws-sdk/client-bedrock-runtime`. Anthropic models use the native Messages API (`InvokeModel`); all others use the Converse API.
2. **Azure OpenAI** — if `AZURE_OPENAI_ENDPOINT` is set. HIPAA eligible. Uses the OpenAI SDK pointed at your Azure endpoint.
3. **OpenRouter** — default fallback if `OPENROUTER_API_KEY` is set. Routes to 20+ models from various providers. Not HIPAA compliant.
The provider cannot be changed at runtime — it's determined once at startup. To switch providers, update `.env` and restart the container.
### Database Layer
The app uses **raw SQL via the `pg` driver** — no ORM (Sequelize, Prisma, etc.). This is intentional:
- **Simplicity:** Every query is visible and explicit. No magic, no migrations framework, no model definitions to sync.
- **Performance:** No ORM overhead or N+1 query problems.
- **Schema management:** `src/db/database.js` runs `CREATE TABLE IF NOT EXISTS` on startup, plus `ALTER TABLE ... ADD COLUMN IF NOT EXISTS` for migrations. This means the schema is always up-to-date when the app starts.
- **Future ORM migration:** If needed, the queries are standard PostgreSQL and can be wrapped by any ORM. The main work would be defining models and replacing direct `db.get()`/`db.run()` calls.
The `database.js` file exports a helper object (`db`) with convenience methods:
- `db.get(sql, params)` — returns first row or `null`
- `db.all(sql, params)` — returns all rows as array
- `db.run(sql, params)` — executes INSERT/UPDATE/DELETE, returns `{ rowCount }`
- `db.getSetting(key)` / `db.setSetting(key, value)` — shorthand for `app_settings` table
---
## 3. Directory Structure
```
/
├── server.js # Express app entry point (route registration, Helmet CSP,
│ # rate limiters, static file serving, error handlers)
├── package.json # Dependencies (~25 production deps, no devDeps)
├── Dockerfile # Multi-stage Node.js 20 Alpine build
├── docker-compose.yml # Production compose (uses Docker Hub image)
├── docker-compose.local.yml # Local development (builds from source, port 3552)
├── admin-cli.js # CLI tool for admin tasks (create user, reset password)
├── DEVELOPER_GUIDE.md # This file
├── src/
│ ├── db/
│ │ └── database.js # DB connection pool (pg.Pool), schema init
│ │ # (CREATE TABLE IF NOT EXISTS for all tables),
│ │ # column migrations (ALTER TABLE ADD COLUMN IF NOT EXISTS),
│ │ # helper methods: db.get(), db.all(), db.run(),
│ │ # db.getSetting(), db.setSetting()
│ ├── middleware/
│ │ ├── auth.js # authMiddleware (JWT decode → req.user),
│ │ # adminMiddleware (role === 'admin'),
│ │ # moderatorMiddleware (role === 'admin' || 'moderator')
│ │ └── logging.js # Logs every request to api_log table (method, path, user, IP, duration)
│ ├── routes/
│ │ ├── auth.js # Login, register, 2FA, password reset, /me
│ │ ├── admin.js # User management (admin only)
│ │ ├── adminConfig.js # Site settings, feature flags, AI prompts, models
│ │ ├── encounters.js # Save/load/delete draft encounters
│ │ ├── memories.js # User templates (physical exam, ROS, etc.)
│ │ ├── hpi.js # Generate HPI from encounter/dictation transcript
│ │ ├── soap.js # Generate SOAP note
│ │ ├── hospitalCourse.js # Generate hospital course summary
│ │ ├── chartReview.js # Generate outpatient chart review
│ │ ├── milestones.js # Generate developmental milestone narrative
│ │ ├── wellVisit.js # Well-visit note generation (ROS/PE/ICD-10)
│ │ ├── sickVisit.js # Sick visit note generation
│ │ ├── refine.js # Refine/shorten any generated document
│ │ ├── transcribe.js # Whisper audio transcription
│ │ ├── tts.js # Text-to-speech (if configured)
│ │ ├── nextcloud.js # Nextcloud WebDAV connect/export/disconnect
│ │ ├── learningHub.js # User-facing: feed, content, quiz submission
│ │ ├── learningAdmin.js # CMS: categories, content, questions CRUD
│ │ ├── learningAI.js # AI generation for Learning Hub content
│ │ └── logs.js # Usage/audit/API/access logs + client error
│ └── utils/
│ ├── ai.js # callAI(messages, options) — routes to OpenRouter/Bedrock/Azure.
│ │ # Handles Anthropic InvokeModel (Messages API) vs Converse API,
│ │ # thinking block extraction, fallback model retry, duration tracking.
│ ├── models.js # OPENROUTER_MODELS[], BEDROCK_MODELS[], AZURE_MODELS[]
│ │ # Each model: { id, name, cost, tag, category, bedrockId, maxOut, regions }
│ │ # getBedrockModelId() maps app IDs to Bedrock/inference profile IDs.
│ │ # getAvailableModels() filters by region. getAvailableModelsWithOverrides()
│ │ # applies admin-disabled/custom models from DB.
│ ├── prompts.js # Default prompt templates for every AI route. Loaded on startup,
│ │ # then overridden by DB values (app_settings: 'prompt.*' keys).
│ │ # PROMPTS.get('key') returns the DB override or default.
│ ├── config.js # App configuration helpers
│ └── logger.js # Winston logger (file + console, JSON format)
├── public/
│ ├── index.html # Single HTML shell, loads all components
│ ├── 404.html # Custom 404 page
│ ├── css/
│ │ └── styles.css # All CSS (single file, ~750 lines)
│ ├── js/
│ │ ├── app.js # Core: tab switching via data-tab buttons, loadComponent()
│ │ │ # fetches HTML from /components/, global helpers (showToast,
│ │ │ # showLoading, getAuthHeaders, getSelectedModel, etc.)
│ │ ├── auth.js # Login/register/forgot-password forms, JWT storage in
│ │ │ # localStorage ('ped_scribe_token'), enterApp()/clearSession(),
│ │ │ # resend verification link handler, 2FA code input
│ │ ├── admin.js # Admin panel: user management, site settings, SMTP config,
│ │ │ # model enable/disable, prompt editor, announcement banner
│ │ ├── liveEncounter.js # MediaRecorder → Whisper transcription → AI HPI generation.
│ │ │ # Handles start/stop recording, timer, save/load encounters
│ │ ├── voiceDictation.js # Web Speech API (real-time) or Whisper (recorded) dictation
│ │ ├── hospitalCourse.js # Paste/dictate hospital course → AI summary
│ │ ├── chartReview.js # Paste/dictate chart data → AI outpatient review
│ │ ├── soap.js # Paste/dictate → AI SOAP note
│ │ ├── milestones.js # Age-based milestone checklist → AI narrative
│ │ ├── wellVisit.js # Well Visit guide: vaccine schedule display, age calculator
│ │ ├── shadess.js # SSHADESS psychosocial form + ROS/PE checkboxes → AI note
│ │ ├── sickVisit.js # Chief complaint + HPI → AI sick visit SOAP
│ │ ├── nextcloud.js # Nextcloud WebDAV connect/disconnect/export settings UI
│ │ ├── encounters.js # Save/load/delete encounter drafts (shared across all tabs)
│ │ ├── memories.js # User template CRUD (physical exam defaults, ROS, etc.)
│ │ ├── learningHub.js # Learning Hub (user feed, content viewer, quiz engine) +
│ │ │ # CMS (category CRUD, content editor with Tiptap, question
│ │ │ # builder, AI generation panel, Nextcloud file picker,
│ │ │ # slide preview modal). Single file, ~1400 lines.
│ │ ├── milestonesData.js # Static milestone data by age group (2mo → 6yr)
│ │ └── pediatricScheduleData.js # CDC vaccine schedule data + catch-up schedule
│ ├── components/ # Lazy-loaded tab HTML (injected by loadComponent)
│ │ ├── encounter.html ├── dictation.html ├── hospital.html
│ │ ├── chart.html ├── soap.html ├── wellvisit.html
│ │ ├── sickvisit.html ├── vaxschedule.html ├── catchup.html
│ │ ├── learning.html ├── cms.html ├── admin.html
│ │ └── settings.html
│ └── vendor/
│ └── tiptap.bundle.js # Tiptap 2 + extensions (esbuild bundle, self-hosted)
```
---
## 4. Environment Variables
Set in `.env` file (copy `.env.example` to get started):
```bash
# ── Required ──────────────────────────────────────────────────
DATABASE_URL=postgresql://user:<password>@host:5432/dbname
JWT_SECRET=change-this-to-a-random-64-char-string
# ── AI Provider (choose one or let it default to OpenRouter) ──
OPENROUTER_API_KEY=sk-or-... # Default provider
# OR
AZURE_OPENAI_ENDPOINT=https://... # Azure (HIPAA eligible)
AZURE_OPENAI_API_KEY=...
AZURE_DEPLOYMENT_NAME=gpt-4o-mini
AZURE_OPENAI_API_VERSION=2024-08-01-preview
# OR
AWS_BEDROCK_REGION=us-east-1 # AWS Bedrock (HIPAA eligible)
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
# ── Optional ──────────────────────────────────────────────────
OPENAI_API_KEY=sk-... # For Whisper transcription only
APP_URL=https://yourdomain.com # Enables secure CORS + Secure cookies
NODE_ENV=production # Enables production optimizations
PORT=3000 # Default: 3000
# ── Email (for password reset, registration verification) ──────
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=noreply@example.com
SMTP_PASS=...
SMTP_FROM=Pediatric AI Scribe <noreply@example.com>
```
**Note:** If no SMTP is configured, registration auto-verifies and password reset won't work. Configure SMTP or use the console reset method (see Section 14).
---
## 5. Database Schema
All tables are created automatically on first run by `src/db/database.js`. The file runs `CREATE TABLE IF NOT EXISTS` for every table, followed by `ALTER TABLE ... ADD COLUMN IF NOT EXISTS` migrations for upgrades.
### Core Tables
#### `users`
| Column | Type | Notes |
|--------|------|-------|
| id | SERIAL PK | |
| email | TEXT UNIQUE | Lowercase |
| password | TEXT | bcrypt hash (cost 12) |
| name | TEXT | Display name |
| role | TEXT | `'user'` \| `'moderator'` \| `'admin'` |
| totp_enabled | BOOLEAN | 2FA status |
| totp_secret | TEXT | TOTP secret (base32) |
| disabled | BOOLEAN | Soft disable |
| email_verified | BOOLEAN | |
| verify_token / verify_expires | TEXT / BIGINT | Email verification |
| reset_token / reset_expires | TEXT / BIGINT | Password reset |
| nextcloud_url / nextcloud_user / nextcloud_token / nextcloud_folder | TEXT | Nextcloud integration |
| webdav_learning_path | TEXT | Default WebDAV path for Learning Hub file picker |
| created_at | TIMESTAMPTZ | |
#### `app_settings`
Key-value store for all site configuration. Read via `db.getSetting(key)`, written via admin panel or direct DB.
Important keys:
- `registration_enabled``'true'` / `'false'`
- `announcement.enabled` / `announcement.text` / `announcement.type`
- `smtp.*` — SMTP config (overrides env vars)
- `ai.prompt.*` — AI prompt overrides
- `model.*` — enabled/disabled models
#### `saved_encounters`
Draft encounters (7-day auto-expiry). Columns: `label`, `enc_type`, `transcript`, `generated_note`, `partial_data` (JSON), `status`, `expires_at`.
#### `user_memories`
User templates fed into AI generation. `category` is one of: `physical_exam`, `ros`, `encounter_format`, `family_history`, `assessment_plan`, `custom`.
### Learning Hub Tables
#### `learning_categories`
Simple category list with `name`, `slug`, `sort_order`.
#### `learning_content`
Articles, quizzes, pearls, presentations. Key columns: `title`, `slug`, `body` (HTML for articles/pearls/quizzes; Marp markdown for presentations), `content_type` (`article` | `quiz` | `pearl` | `presentation`), `published`, `author_id`.
#### `learning_questions`
Quiz questions linked to `learning_content`. `question_type`: `mcq` | `true_false` | `multi`. `explanation` = general explanation shown after answering.
#### `learning_options`
Answer options for quiz questions. `is_correct: boolean`, `explanation` = shown when this wrong option is chosen.
#### `learning_progress`
Quiz attempt scores per user per content item.
---
## 6. Authentication System
**Current implementation: JWT in localStorage**
### Flow
1. `POST /api/auth/login` → returns `{ success, token, user }`
2. Frontend stores token in `localStorage` as `ped_scribe_token` and in `window.AUTH_TOKEN`
3. All API calls include `Authorization: Bearer <token>` header via `getAuthHeaders()`
4. `src/middleware/auth.js` validates the Bearer token, attaches `req.user`
5. Logout: `clearSession()` removes token from localStorage (client-side only)
### Token
- Signed with `JWT_SECRET` env var
- 7-day expiry
- Payload: `{ userId: number }`
### Roles
- `user` — standard access (clinical tools only)
- `moderator` — can create/edit Learning Hub content
- `admin` — full access including user management and site settings
### Middleware
- `authMiddleware` — validates JWT, populates `req.user`
- `adminMiddleware` — run after auth, requires `role === 'admin'`
- `moderatorMiddleware` — run after auth, requires `role === 'admin' OR 'moderator'`
### 2FA
Uses TOTP (speakeasy). If enabled, login returns `{ requires2FA: true }` and the client must POST the TOTP code to complete login.
### Session Check on Page Load (auth.js)
```javascript
var savedToken = localStorage.getItem('ped_scribe_token');
if (savedToken) {
fetch('/api/auth/me', { headers: { 'Authorization': 'Bearer ' + savedToken } })
.then(/* if ok → enterApp(), else → clearSession() */);
}
```
The `has-session` CSS class on `<html>` hides the auth screen immediately when a localStorage token exists, preventing a white flash.
---
## 7. Backend API Reference
All routes are prefixed `/api`. Routes requiring auth are marked (A). Admin-only: (ADM). Moderator+: (MOD).
### Auth — `/api/auth/`
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| POST | `/login` | — | Email + password login. Returns `{ token, user }` |
| POST | `/register` | — | Create account (checks `registration_enabled` setting) |
| GET | `/me` | A | Returns current user object |
| POST | `/logout` | — | Clears server-side state (currently no-op, kept for future) |
| POST | `/setup-2fa` | A | Generates TOTP secret + QR code |
| POST | `/verify-2fa` | A | Confirms TOTP code, enables 2FA |
| POST | `/disable-2fa` | A | Disables 2FA (requires password) |
| POST | `/forgot-password` | — | Sends reset email |
| POST | `/reset-password` | — | Sets new password via reset token |
| GET | `/registration-status` | — | Returns `{ registrationEnabled: bool }` |
| GET | `/verify-email` | — | Verifies email via token in query string |
### Clinical — AI Generation
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| POST | `/generate-hpi-encounter` | A | HPI from live encounter transcript |
| POST | `/generate-hpi-dictation` | A | HPI from dictation |
| POST | `/generate-soap` | A | SOAP note |
| POST | `/generate-hospital-course` | A | Hospital course summary |
| POST | `/generate-chart-review` | A | Chart review |
| POST | `/generate-milestone-narrative` | A | Milestone narrative |
| POST | `/generate-milestone-summary` | A | 3-sentence milestone summary |
| POST | `/well-visit/note` | A | Full well-visit note |
| POST | `/sick-visit/note` | A | Sick visit SOAP |
| POST | `/transcribe` | A | Whisper audio → text (multipart/form-data, field: `audio`) |
| POST | `/refine` | A | Refine existing document |
| POST | `/shorten` | A | Shorten existing document |
| POST | `/clarify` | A | Find missing info in a document |
### Encounters (Save/Load)
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/encounters` | A | List user's saved encounters |
| POST | `/encounters` | A | Save/update encounter draft |
| DELETE | `/encounters/:id` | A | Delete a draft |
### User Templates
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/memories` | A | List user's templates |
| POST | `/memories` | A | Create template |
| PUT | `/memories/:id` | A | Update template |
| DELETE | `/memories/:id` | A | Delete template |
| GET | `/memories/context` | A | Returns templates formatted for AI injection |
### Nextcloud
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| POST | `/nextcloud/connect` | A | Connect + test Nextcloud credentials |
| POST | `/nextcloud/export` | A | Export text file to Nextcloud |
| POST | `/nextcloud/disconnect` | A | Remove Nextcloud credentials |
### Learning Hub (User-Facing)
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/learning/categories` | A | List categories |
| GET | `/learning/feed` | A | Paginated published content |
| GET | `/learning/category/:slug` | A | Content by category |
| GET | `/learning/content/:slug` | A | Single content item + questions |
| POST | `/learning/submit-quiz` | A | Submit quiz answers, returns scored results |
| GET | `/learning/search` | A | Full-text search |
### Learning Hub CMS (Moderator+)
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/admin/learning/categories` | MOD | All categories with counts |
| POST | `/admin/learning/categories` | MOD | Create category |
| PUT | `/admin/learning/categories/:id` | MOD | Update category |
| DELETE | `/admin/learning/categories/:id` | MOD | Delete category |
| GET | `/admin/learning/content` | MOD | All content (including drafts) |
| GET | `/admin/learning/content/:id` | MOD | Single item with questions |
| POST | `/admin/learning/content` | MOD | Create content |
| PUT | `/admin/learning/content/:id` | MOD | Update content |
| DELETE | `/admin/learning/content/:id` | MOD | Delete content + questions |
| POST | `/admin/learning/content/:id/questions` | MOD | Add question to content |
| PUT | `/admin/learning/questions/:id` | MOD | Update question + options |
| DELETE | `/admin/learning/questions/:id` | MOD | Delete question |
| GET | `/admin/learning/stats` | MOD | Dashboard stats |
### Learning Hub AI (Moderator+)
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| POST | `/admin/learning/ai-generate` | MOD | Generate content from topic/file/Nextcloud (multipart/form-data) |
| POST | `/admin/learning/ai-refine` | MOD | Refine body HTML with instructions |
| POST | `/admin/learning/preview-slides` | MOD | Render Marp markdown → `{ css, slides[] }` for preview |
| POST | `/admin/learning/generate-pptx` | MOD | Marp markdown → `.pptx` download (pptxgenjs) |
| GET | `/admin/learning/webdav-browse` | MOD | PROPFIND Nextcloud folder |
| POST | `/admin/learning/webdav-path` | MOD | Save user's default WebDAV path |
### Admin (Admin Only)
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/admin/users` | ADM | List all users |
| POST | `/admin/users` | ADM | Create user |
| PUT | `/admin/users/:id` | ADM | Update user (role, disable) |
| DELETE | `/admin/users/:id` | ADM | Delete user |
| GET/POST | `/admin/config/*` | ADM | Site settings (announcement, SMTP, models, prompts, etc.) |
### Logs & Health
| Method | Path | Auth | Description |
|--------|------|------|-------------|
| GET | `/health` | — | Returns `{ status: 'running', version, provider }` |
| GET | `/models` | — | Returns available AI models list |
| POST | `/logs/client-error` | — | Client-side error logging (public) |
| GET | `/logs/usage` | ADM | API usage log |
| GET | `/logs/audit` | ADM | Audit log |
---
## 8. Frontend Architecture
### Tab Loading (Lazy Components)
Every tab's HTML lives in `/public/components/<tabname>.html`. When a tab button is clicked, `loadComponent()` in `app.js` fetches the HTML, injects it into the tab section, then fires `tabChanged` event.
```javascript
// app.js
document.dispatchEvent(new CustomEvent('tabChanged', { detail: { tab: tabName } }));
```
**Critical pattern:** Every JS module that needs to access tab DOM elements MUST listen for `tabChanged`, not `DOMContentLoaded`:
```javascript
// Correct pattern for every tab module
(function() {
var _inited = false;
document.addEventListener('tabChanged', function(e) {
if (e.detail.tab !== 'myTab' || _inited) return;
_inited = true;
// Now safe to querySelector elements — they exist in the DOM
var btn = document.getElementById('my-btn');
btn.addEventListener('click', ...);
});
})();
```
If you use `DOMContentLoaded` instead, the elements won't exist yet (they're loaded async) and you'll get `null.addEventListener` errors.
### Global Functions (defined in app.js)
These are available everywhere — no imports needed:
| Function | Description |
|----------|-------------|
| `getAuthHeaders()` | Returns `{ 'Content-Type': 'application/json', 'Authorization': 'Bearer <token>' }` |
| `getSelectedModel()` | Returns model ID from active tab's selector or global selector |
| `showLoading(msg)` | Shows full-screen loading overlay |
| `hideLoading()` | Hides loading overlay |
| `showToast(msg, type)` | Shows toast notification. `type`: `'success'`\|`'error'`\|`'info'`\|`'warning'` |
| `setOutputText(el, text)` | Sets text on contenteditable div, converting `\n` to `<br>` |
| `transcribeAudio(blob)` | Sends audio blob to `/api/transcribe`, returns `{ success, text }` |
| `createSpeechRecognition()` | Returns Web Speech API recognition instance |
| `createTimer(el)` | Returns timer object with `.start()` / `.stop()` |
### Rich Text Editor (Tiptap)
The body editor in the CMS uses Tiptap 2 (headless, no styling framework). The bundle is pre-built at `/public/vendor/tiptap.bundle.js` and exposes `window.Tiptap = { Editor, StarterKit, Link, Underline, TextStyle, Color }`.
To rebuild the bundle after updating Tiptap packages:
```bash
cat > tiptap-entry.js << 'EOF'
import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';
import Link from '@tiptap/extension-link';
import Underline from '@tiptap/extension-underline';
import { TextStyle } from '@tiptap/extension-text-style';
import { Color } from '@tiptap/extension-color';
window.Tiptap = { Editor, StarterKit, Link, Underline, TextStyle, Color };
EOF
npx esbuild tiptap-entry.js --bundle --format=iife --minify --outfile=public/vendor/tiptap.bundle.js
rm tiptap-entry.js
```
---
## 9. AI Integration
### `src/utils/ai.js``callAI(messages, options)`
The single function used by all routes. It routes to the correct provider automatically.
```javascript
const { callAI } = require('../utils/ai');
const result = await callAI(
[{ role: 'user', content: 'Generate a note...' }],
{
model: 'google/gemini-2.5-flash', // optional, uses default if omitted
temperature: 0.3, // optional, default 0.3
maxTokens: 4000 // optional, default 4000
}
);
// result = { success: true, content: '...', model: '...', provider: '...', duration: ms }
```
### Bedrock Model Notes
**Inference Profiles:** Most newer models (Anthropic vendor model 4.x, Meta Llama 4, DeepSeek R1, Amazon Nova, Writer) require cross-region inference profiles. These use a `us.` prefix on the model ID (e.g. `us.anthropic.agent-config-sonnet-4-6`). Direct model IDs will return "on-demand throughput not supported" errors.
**Max Output Tokens:** Some models have low output limits (Cohere Command R/R+: 4096, AI21 Jamba: 4096). The `maxOut` field in `models.js` auto-clamps `maxTokens` in `callBedrock()`.
**JSON Sanitization:** Some models (notably vendor model Sonnet 4.6, Opus 4.6) output literal newline characters inside JSON string values. `learningAI.js` includes a `sanitizeJsonString()` function that escapes these before parsing.
### Prompt System
Prompts are defined in `src/utils/prompts.js`. Admins can override any prompt via the Admin panel (`/admin/config/prompts`). Overrides are stored in `app_settings` table and loaded into memory on startup (with 3s grace period for DB readiness).
To add a new prompt:
1. Add a default in `prompts.js`
2. Use `PROMPTS.get('your-prompt-key')` in your route
3. The admin panel will auto-discover it
### AI Generate for Learning Hub
The `src/routes/learningAI.js` file handles all Learning Hub AI generation.
**For presentations:** The AI is prompted to return raw Marp markdown (not JSON). The response is stored in the `body` column. Detection: `content_type === 'presentation'`.
**For articles/quizzes/pearls:** The AI returns JSON:
```json
{
"title": "...",
"subject": "...",
"body": "<p>HTML content</p>",
"questions": [
{
"question_text": "...",
"question_type": "mcq",
"explanation": "...",
"options": [
{ "option_text": "...", "is_correct": true, "explanation": "..." }
]
}
]
}
```
---
## 10. Learning Hub & CMS
### Content Types
| Type | Body format | Has questions |
|------|-------------|---------------|
| `article` | HTML (Tiptap) | Optional |
| `quiz` | HTML (brief intro) | Always |
| `pearl` | HTML | Optional |
| `presentation` | Marp markdown | Never |
### Quiz Question Types
- `mcq` — Single choice (radio buttons), 4 options, 1 correct
- `true_false` — 2 options: "True" / "False", 1 correct
- `multi` — Multiple select (checkboxes), scoring: all correct chosen AND no incorrect chosen
### PPTX Generation
`POST /admin/learning/generate-pptx` parses Marp markdown (splits on `---`), extracts `#` headings as slide titles, bullet points as content, and uses `pptxgenjs` to create a real `.pptx`. **No Chromium required** — pure Node.js.
### Slide Preview
`POST /admin/learning/preview-slides` uses `@marp-team/marp-core` to render Marp markdown to HTML, then extracts individual `<section>` elements. Returns `{ css, slides[] }`. The frontend renders these one at a time in a full-screen modal with arrow key + swipe navigation.
### Content Display
In the Learning Hub viewer, content `body` is rendered via `sanitizeHtml()` in `learningHub.js`. This function allows a safe subset of HTML tags only (no `<script>`, no `on*` attributes, no `style` attributes except `class`).
---
## 11. Deployment
### Local Development
```bash
cp .env.example .env # Fill in your credentials
docker compose -f docker-compose.local.yml build --no-cache
docker compose -f docker-compose.local.yml up -d
# App runs at http://localhost:3552
```
### Logs & Debugging
**View container logs (live):**
```bash
docker logs -f pediatric-ai-scribe
```
**View last N lines:**
```bash
docker logs --tail 50 pediatric-ai-scribe
```
**Filter for specific issues:**
```bash
# AI/Bedrock errors
docker logs pediatric-ai-scribe 2>&1 | grep -i "Bedrock\|LearningAI\|callAI"
# Auth errors
docker logs pediatric-ai-scribe 2>&1 | grep -i "Auth\|login\|verify"
# All errors
docker logs pediatric-ai-scribe 2>&1 | grep -i "error\|ERR\|fail"
```
**Key log prefixes:**
| Prefix | Source |
|--------|--------|
| `[Bedrock] Model:` | AI response metadata (block types, stop reason) |
| `[LearningAI]` | JSON parse failures with raw output context |
| `[Auth]` | Login, registration, verification events |
| `[TTS]` | Text-to-speech generation |
| `🤖 Provider:` | Startup: which AI provider is active |
| `✅ AWS Bedrock:` | Startup: Bedrock configured successfully |
**Database logs (PostgreSQL):**
```bash
docker logs pedscribe-db
```
### Production (Docker Hub image)
```bash
# docker-compose.yml (production)
services:
app:
image: danielonyejesi/pediatric-ai-scribe-v3:latest
ports: ["3000:3000"]
env_file: .env
depends_on:
db:
condition: service_healthy
db:
image: postgres:16-alpine
environment:
POSTGRES_DB: pedscribe
POSTGRES_USER: pedscribe
POSTGRES_PASSWORD: your_secure_password
volumes:
- pgdata:/var/lib/postgresql/data
```
### Docker Hub
Repository: `danielonyejesi/pediatric-ai-scribe-v3`
Tags use versioned format: `v5.0`, `v5.1`, etc. Production should always pin to a specific tag.
### Git Repository
Repository: `ifedan-ed/pediatric-ai-scribe-v3` (private)
### Build & Push Process
```bash
# 1. Test locally first
docker compose -f docker-compose.local.yml build --no-cache
docker compose -f docker-compose.local.yml up -d
# Test at http://localhost:3552
# 2. When ready, tag and push to Docker Hub
docker tag scribe-pediatric-scribe:latest danielonyejesi/pediatric-ai-scribe-v3:v5.x
docker push danielonyejesi/pediatric-ai-scribe-v3:v5.x
# 3. Update production docker-compose.yml to use new tag
```
---
## 12. Known Issues & Security Notes
### Active Known Issues
1. **`nodemailer` HIGH vulnerability** — v6.9.x has an email domain interpretation conflict. Upgrade to `^6.10.0` when available.
2. **`unsafe-inline` in CSP** — `scriptSrc` includes `'unsafe-inline'` to support inline event handlers in HTML components. Should migrate to event listeners and remove this directive.
3. **JWT in localStorage** — Tokens stored in `localStorage` are readable by JavaScript and therefore vulnerable to XSS attacks. A future migration to `httpOnly` cookies would eliminate this risk. See notes in auth.js and Section 6.
4. **`window.prompt()` in `runAiRefineBody`** — Uses browser native prompt, which can be blocked in certain contexts. Should be replaced with an inline input field.
5. **`webdav-learning-path` endpoint** — Sits behind `moderatorMiddleware` but is a user preference that non-moderator users might reasonably need. Consider moving to plain `authMiddleware`.
### Security Hardening Already In Place
- Helmet.js with custom CSP (no external script sources)
- CORS restricted to `APP_URL` in production
- Rate limiting on login (10/15min), register (5/hr), forgot-password (5/hr), resend-verification (3/15min), general API (60/min)
- bcrypt cost 12 for password hashing
- JWT with 7-day expiry
- SQL injection protection: all queries use parameterized `?` / `$1` placeholders
- Dynamic table names validated against an explicit allowlist (`ALLOWED_SLUG_TABLES`)
- User input in HTML contexts goes through `sanitizeHtml()` (tag allowlist, strips `on*` attributes)
- File upload MIME type validated by extension + content type
- Admin/moderator route protection via middleware
---
## 13. Adding New Features
### Adding a New Clinical Tab
1. Create `public/components/mytab.html` with the tab's UI
2. Add to `index.html`:
- Tab button: `<button class="tab-btn" data-tab="mytab">...</button>`
- Tab section: `<section id="mytab-tab" class="tab-content" data-component="mytab"></section>`
- Script tag: `<script defer src="/js/myTab.js"></script>`
3. Create `public/js/myTab.js`:
```javascript
(function() {
var _inited = false;
document.addEventListener('tabChanged', function(e) {
if (e.detail.tab !== 'mytab' || _inited) return;
_inited = true;
// Wire up DOM elements here
});
})();
```
4. Create `src/routes/myTab.js` with the API route
5. Register in `server.js`: `app.use('/api', require('./src/routes/myTab'));`
### Adding a New AI Prompt
1. In `src/utils/prompts.js`, add to the defaults object:
```javascript
'my-prompt': 'You are a pediatric physician...'
```
2. In your route: `const prompt = PROMPTS.get('my-prompt') + '\n\n' + userInput`
3. The admin panel will show an editor for this prompt automatically.
### Adding a New Learning Hub Content Type
1. Add the new type to the `content_type` selector in `cms.html`
2. Handle it in `toggleEditorMode()` in `learningHub.js`
3. Add to the type detection in `buildGeneratePrompt()` in `learningAI.js`
4. Handle rendering in `learningHub.js` `loadContent()` function
5. No DB migration needed — `content_type` is a free-text column
---
## 14. Resetting Admin Password via Console
If you lose admin access and have no SMTP for password reset, use the Docker console:
```bash
# Step 1: Get a shell in the running app container
docker exec -it pediatric-ai-scribe sh
# Step 2: Open Node.js REPL
node
# Step 3: Hash your new password
const bcrypt = require('bcryptjs');
const hash = await bcrypt.hash('YourNewPassword123!', 12);
console.log(hash);
// Copy the hash output
# Step 4: Exit Node REPL
.exit
# Step 5: Open a DB shell
# (Exit app container first, then:)
docker exec -it pedscribe-db psql $POSTGRES_USER $POSTGRES_DB
# Step 6: Update the password (paste the hash)
UPDATE users
SET password = '$2a$12$...(your-hash-here)...'
WHERE email = 'your-admin@email.com';
# Verify:
SELECT email, left(password, 7) as hash_prefix FROM users WHERE email = 'your-admin@email.com';
# Exit:
\q
```
### Enabling Registration via Console
```bash
docker exec -it pedscribe-db psql $POSTGRES_USER $POSTGRES_DB
UPDATE app_settings SET value = 'true' WHERE key = 'registration_enabled';
\q
```
### Creating First Admin User (empty database)
The first user to register is automatically made admin. Enable registration, register, then disable registration again.
Or directly:
```bash
# In the Node REPL inside the app container:
const bcrypt = require('bcryptjs');
const { Pool } = require('pg');
const pool = new Pool({ connectionString: process.env.DATABASE_URL });
const hash = await bcrypt.hash('YourPassword', 12);
await pool.query(
"INSERT INTO users (email, password, name, role, email_verified) VALUES ($1, $2, $3, 'admin', true)",
['admin@yourdomain.com', hash, 'Admin']
);
pool.end();
```
---
## 15. Version History (Recent)
| Tag | Key changes |
|-----|-------------|
| v3.19 | Login flash fixed (auth screen hidden by CSS default); presentation quiz option; feed labels corrected |
| v3.18 | pdf-parse downgraded to v1.1.1; WebDAV selection UX fixed; topic context on upload/WebDAV tabs; inline refine bar replaces window.prompt(); CSP: removed unsafe-inline (all onclick= converted to data-action delegation); webdav-path moved to /api/user/webdav-path (auth-only) |
| v3.17 | AI panel context-aware options fixed (style.display replaces classList — CSS cascade bug); quiz card redesign |
| v3.16 | DEVELOPER_GUIDE.md created |
| v3.15 | Auth reverted to localStorage tokens; slide preview padding fixed |
| v3.14 | AI panel context-aware options (word count, slide count, quiz toggle); delete wording per type |
| v3.13 | Delete confirm inline bar CSS bug fixed; slide preview in-page modal (arrow/swipe nav); Marp textarea placeholder |
| v3.12 | Delete inline confirm bar; lighter login screen; Presentation type (Marp + pptxgenjs PPTX) |
| v3.11 | AI content generation for Learning Hub (topic/file/Nextcloud, pdf-parse, pptxgenjs) |
| v3.10 | Custom 404 page; server returns 404 for unknown paths |
| v3.8 | Quill replaced with Tiptap 2 (self-hosted bundle, inline link bar) |
| v5.0 | Resend verification link on login + rate limit (3/15min) |
| v5.1v5.4 | Bedrock model fixes: inference profiles, region filtering, thinking block handling |
| v5.5 | Comprehensive Bedrock fix: all us. prefix IDs, maxTokens clamping |
| v5.6 | Re-add Qwen3 235B |
| v5.7 | Remove Opus 4.6 (JSON issues) |
| v5.8 | Fix JSON parse: sanitize literal newlines in strings; re-add Opus 4.6 |
| v5.9 | Re-add Opus 4.6 with sanitizer; updated DEVELOPER_GUIDE |
| v6.0 | Increase PDF/doc context to 50k chars; maxTokens ceiling to 8k |
## 16. Current Docker Image
**Latest stable:** `danielonyejesi/pediatric-ai-scribe-v3:v6.0`
```bash
docker pull danielonyejesi/pediatric-ai-scribe-v3:v6.0
```
---
## 17. PDF & Document Uploads
### How It Works
The Learning Hub AI generator accepts documents via two paths — both produce the same result:
1. **Direct upload** — user selects a file from their computer (up to 20 MB)
2. **Nextcloud WebDAV** — user browses their Nextcloud and picks a file
The flow:
1. `extractText()` in `learningAI.js` detects file type by MIME/extension
2. **PDF:** `pdf-parse` v1.1.1 extracts all text pages into a single string
3. **PPTX/DOCX/TXT:** extracted via appropriate parser or read as UTF-8
4. Text is truncated to **50,000 characters** (~25-30 pages) and sent as context in the AI prompt
5. AI generates structured content (title, HTML body, quiz questions) from the full context
### Supported File Types
| Extension | Handler | Notes |
|-----------|---------|-------|
| `.pdf` | `pdf-parse` | Extracts text only — images, charts, tables are lost |
| `.pptx` | Text extraction from slides | Slide text only |
| `.docx` | Text extraction | Body text only |
| `.txt`, `.md`, `.csv` | Read as UTF-8 | Full content preserved |
### Limits
- **Upload size:** 20 MB (`multer` limit in `learningAI.js`)
- **Context sent to AI:** 50,000 characters (configurable in `buildGeneratePrompt()`)
- **AI response tokens:** 8,000 max (ceiling — model stops when done)
### Why No Vector Embeddings / RAG
Embeddings and RAG (Retrieval Augmented Generation) are unnecessary for this use case:
- **Single document → single generation** — the full text fits in the model's context window
- Most Bedrock models support 100K-200K token inputs — 50,000 chars is well within that
- Embeddings would add complexity (pgvector, chunking, retrieval pipeline) with no benefit
If you later need to **search across hundreds of stored documents** or handle 200+ page PDFs, then consider pgvector + chunked retrieval. For now, the direct approach is correct.
---
## 18. Scalability
### Current Architecture (Single Instance)
The app runs as a single Node.js process. This is fine for a team/department deployment (tens to hundreds of concurrent users).
### What Scales Well Already
- **Stateless JWT auth** — no server-side session store; any instance can validate any token
- **PostgreSQL** — handles concurrent connections well; supports read replicas
- **Lazy-loaded component HTML** — reduces initial page size; tabs load on demand
- **AI calls** — fully async; expensive calls don't block other requests
### Bottlenecks to Address Before Horizontal Scaling
| Issue | Current | Fix for multi-instance |
|-------|---------|----------------------|
| Rate limiting | In-memory (per process) | Replace with Redis (`rate-limit-redis`) |
| File uploads | `multer` in RAM | Route uploads to S3/object storage |
| Scheduled cleanup | `setTimeout` in server.js | Use a dedicated cron job or DB-scheduled task |
### How to Scale Horizontally
```yaml
# docker-compose with 3 app replicas + nginx load balancer
services:
app:
image: danielonyejesi/pediatric-ai-scribe-v3:latest
deploy:
replicas: 3
environment:
DATABASE_URL: postgresql://... # shared external Postgres
REDIS_URL: redis://redis:6379 # add when rate-limit-redis is wired
nginx:
image: nginx:alpine
# upstream: round-robin across app replicas
redis:
image: redis:7-alpine
postgres:
image: postgres:16-alpine
```
Cloud deployment options (all work with the current Docker image):
- **AWS ECS/Fargate** — managed containers, easy auto-scaling
- **Railway / Render / Fly.io** — simple push-to-deploy with Docker
- **Kubernetes** — full control, overkill for most deployments
---
## 19. Security Architecture — localStorage vs httpOnly Cookies
The app stores JWT tokens in `localStorage`. This is a deliberate choice appropriate for this scale. The key security facts:
**Current protections in place (more important than storage location):**
- `Content-Security-Policy: script-src 'self'` — blocks all external scripts and inline JS (v3.18)
- Input sanitization via `sanitizeHtml()` allowlist on all user-generated HTML
- All 26 `onclick=` inline event handlers removed (v3.18) — reduces XSS surface
- Rate limiting on auth endpoints
- Helmet.js security headers
- Parameterized SQL queries throughout
**The reality about localStorage vs httpOnly cookies:**
> "Unless you're a bank or large enterprise, it doesn't really matter. Focus on preventing XSS, because that's what actually matters... fundamentally, the security benefit of using httpOnly cookies is very minimal. If your site suffers any kind of XSS, it makes it slightly more difficult for an attacker to use the auth token." — Security engineering community consensus
httpOnly cookies prevent token *copying* but not token *use* — an XSS attacker can still make authenticated requests on the user's behalf regardless of where the token is stored.
**If you later want httpOnly cookies:** The infrastructure is already in place (cookie-parser, CORS `credentials:true`). The change is: (1) set cookie on login, (2) remove token from `getAuthHeaders()`, (3) add `/api/auth/logout` to clear cookie. See notes in `auth.js`. This was implemented and reverted in v3.14 — it works but adds CSRF considerations.
**Token lifetime:** Currently 7 days. For higher security, reduce to 1-2 hours and add refresh token rotation.
---
---
*Last updated: March 2026 — v6.0*
*Generated for developer handover.*

View file

@ -1,21 +1,10 @@
# ─── OpenBao CLI, copied from upstream image (multi-arch automatic) ───
# Update the tag here to adopt a newer OpenBao. Binary is statically linked,
# safe to drop into the Node alpine image as-is.
FROM openbao/openbao:2.5.3 AS bao-src
FROM node:20-alpine FROM node:20-alpine
WORKDIR /app WORKDIR /app
# ffmpeg: audio conversion for AWS Transcribe (WebM → PCM) # ffmpeg: audio conversion for AWS Transcribe (WebM → PCM)
# curl: HTTP helper used by the OpenBao entrypoint and health/debug tooling # curl: download Whisper models for browser-based transcription
# jq: JSON parsing for the entrypoint's OpenBao secret-fetch step RUN apk add --no-cache ffmpeg curl
RUN apk add --no-cache ffmpeg curl jq
# Pull the bao CLI out of the upstream image — matches host arch because
# buildx pulls the right manifest-list variant per build.
COPY --from=bao-src /bin/bao /usr/local/bin/bao
RUN /usr/local/bin/bao version
COPY package.json ./ COPY package.json ./
# argon2 compiles native code via node-gyp — needs python3/make/g++ at build time # argon2 compiles native code via node-gyp — needs python3/make/g++ at build time
@ -25,18 +14,28 @@ RUN apk add --no-cache --virtual .build-deps python3 make g++ \
COPY . . COPY . .
# Ensure the entrypoint is executable regardless of host file permissions
RUN chmod +x /app/docker-entrypoint.sh
RUN mkdir -p /app/data/logs RUN mkdir -p /app/data/logs
# Download Browser Whisper (COMPLETE self-hosting - zero CDN dependencies)
# Library + Models all bundled and served from our server
RUN mkdir -p /app/public/models/Xenova/whisper-tiny.en/onnx && \
cd /app/public/models && \
echo "Downloading transformers.js library (worker-compatible build)..." && \
curl -sL -o transformers.min.js https://cdn.jsdelivr.net/npm/@xenova/transformers@2.0.0/dist/transformers.min.js && \
cd Xenova/whisper-tiny.en && \
echo "Downloading Whisper model files..." && \
curl -sL -o config.json https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/config.json && \
curl -sL -o tokenizer.json https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/tokenizer.json && \
curl -sL -o preprocessor_config.json https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/preprocessor_config.json && \
curl -sL -o generation_config.json https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/generation_config.json && \
curl -sL -o onnx/encoder_model_quantized.onnx https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/onnx/encoder_model_quantized.onnx && \
curl -sL -o onnx/decoder_model_merged_quantized.onnx https://huggingface.co/Xenova/whisper-tiny.en/resolve/main/onnx/decoder_model_merged_quantized.onnx && \
echo "✅ Browser Whisper: 100% self-hosted (library: 760KB, models: 42MB)"
EXPOSE 3000 EXPOSE 3000
HEALTHCHECK --interval=30s --timeout=5s --start-period=20s \ HEALTHCHECK --interval=30s --timeout=5s --start-period=20s \
CMD wget --no-verbose --tries=1 --spider http://localhost:3000/api/health || exit 1 CMD wget --no-verbose --tries=1 --spider http://localhost:3000/api/health || exit 1
# Entrypoint wrapper handles optional OpenBao secret fetch before exec'ing CMD.
# See docker-entrypoint.sh for the logic — it is a no-op if OPENBAO_ADDR is
# unset, so legacy .env-only deployments continue to work unchanged.
ENTRYPOINT ["/app/docker-entrypoint.sh"]
CMD ["node", "server.js"] CMD ["node", "server.js"]

View file

@ -1,8 +1,8 @@
# Embeddings And Semantic Search Setup # Embeddings & Semantic Search Setup
This guide explains how to set up and use the new vector-based semantic search for the Learning Hub. This guide explains how to set up and use the new vector-based semantic search for the Learning Hub.
## What This Enables ## 🎯 What's New
- **Semantic search** - Find content by meaning, not just keywords - **Semantic search** - Find content by meaning, not just keywords
- **3 search modes**: - **3 search modes**:
@ -10,9 +10,9 @@ This guide explains how to set up and use the new vector-based semantic search f
- **Semantic** (`/api/learning/search/semantic`) - AI-powered vector similarity - **Semantic** (`/api/learning/search/semantic`) - AI-powered vector similarity
- **Hybrid** (`/api/learning/search/hybrid`) - Combines both for best results - **Hybrid** (`/api/learning/search/hybrid`) - Combines both for best results
- **Auto-embedding** - Content is automatically vectorized when created/updated - **Auto-embedding** - Content is automatically vectorized when created/updated
- **Gateway-routed** - Uses LiteLLM embeddings so provider policy stays in one place - **HIPAA-compliant** - Uses Vertex AI embeddings (BAA available)
## Prerequisites ## 📋 Prerequisites
### 1. Install pgvector Extension ### 1. Install pgvector Extension
@ -37,24 +37,39 @@ postgres:
# ... rest of your config # ... rest of your config
``` ```
### 2. Configure LiteLLM Embeddings ### 2. Configure Embedding Provider
Add to your `.env` file: Add to your `.env` file:
```bash ```bash
# Option 1: Vertex AI (HIPAA-eligible, recommended)
EMBEDDING_MODEL=vertex_ai/text-embedding-005
EMBEDDING_DIMENSIONS=768
VERTEX_PROJECT=your-gcp-project-id
VERTEX_LOCATION=us-central1
GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
# Option 2: LiteLLM Proxy (routes to any provider)
LITELLM_API_BASE=http://localhost:4000 LITELLM_API_BASE=http://localhost:4000
LITELLM_API_KEY=your-key LITELLM_API_KEY=your-key
EMBEDDING_MODEL=openai-text-embedding-3-large EMBEDDING_MODEL=text-embedding-005 # LiteLLM will route to configured provider
EMBEDDING_DIMENSIONS=3072
# Option 3: OpenAI (NOT HIPAA-eligible, fallback only)
OPENAI_API_KEY=sk-your-key
# Uses text-embedding-3-small automatically
``` ```
## Available Embedding Models ## 🚀 Available Vertex AI Embedding Models
The Admin embedding search reads LiteLLM `/model/info` and only shows models with `model_info.mode = "embedding"`. Do not add app-side built-in Vertex/OpenAI embedding lists; configure those choices in LiteLLM. Tested and working via LiteLLM:
The local LiteLLM instance currently exposes examples such as `openai-text-embedding-3-large`, `openai-text-embedding-3-small`, and Mistral embedding models. Dimensions are read from LiteLLM metadata when available. | Model | Dimensions | Use Case | HIPAA |
|-------|-----------|----------|-------|
| **vertex_ai/text-embedding-005** | 768 | English + code (recommended) | ✅ Yes |
| **vertex_ai/gemini-embedding-001** | 768-3072 | Multilingual + code, best quality | ✅ Yes |
| **vertex_ai/text-multilingual-embedding-002** | 768 | Multilingual focus | ✅ Yes |
## Setup Steps ## 🔧 Setup Steps
### 1. Database Migration ### 1. Database Migration
@ -98,12 +113,12 @@ Response:
"total": 50, "total": 50,
"withEmbeddings": 50, "withEmbeddings": 50,
"missing": 0, "missing": 0,
"model": "openai-text-embedding-3-large", "model": "vertex_ai/text-embedding-005",
"dimensions": 3072 "dimensions": 768
} }
``` ```
## Using Semantic Search ## 🔍 Using Semantic Search
### Keyword Search (existing) ### Keyword Search (existing)
```bash ```bash
@ -129,12 +144,12 @@ GET /api/learning/search/hybrid?q=fever management
``` ```
Combines keyword + semantic for best results. Automatically deduplicates and ranks by relevance. Combines keyword + semantic for best results. Automatically deduplicates and ranks by relevance.
## How It Works ## 🔬 How It Works
1. **Content Creation/Update**: 1. **Content Creation/Update**:
- Text is extracted from `title`, `subject`, and `body` (HTML stripped) - Text is extracted from `title`, `subject`, and `body` (HTML stripped)
- Sent to the configured LiteLLM embedding model - Sent to embedding model (Vertex AI)
- Returns an embedding vector - Returns 768-dimensional vector
- Stored in `learning_content.embedding` column - Stored in `learning_content.embedding` column
2. **Semantic Search**: 2. **Semantic Search**:
@ -149,23 +164,35 @@ Combines keyword + semantic for best results. Automatically deduplicates and ran
- Deduplicates by content ID - Deduplicates by content ID
- Sorts by relevance score - Sorts by relevance score
## Cost Estimate ## 💰 Cost Estimate (Vertex AI)
Embedding cost depends on the upstream configured in LiteLLM. **Titan Text Embeddings (AWS) pricing:**
- ~$0.10 per 1M tokens
- Average article: 2,000 words (~2,700 tokens) = $0.00027
- 1,000 articles: ~**$0.27 one-time**
- Search queries: ~500 tokens = $0.00005 per query
## Troubleshooting **Google Vertex AI pricing:**
- text-embedding-005: $0.025 per 1M characters
- Average article: 10,000 chars = $0.00025
- 1,000 articles: ~**$0.25 one-time**
- Search queries: ~$0.0000125 per query
## 🐛 Troubleshooting
### "pgvector extension not available" ### "pgvector extension not available"
- Install: `apt-get install postgresql-16-pgvector` - Install: `apt-get install postgresql-16-pgvector`
- For Docker: Use `pgvector/pgvector:pg16` image - For Docker: Use `pgvector/pgvector:pg16` image
### "Embeddings not configured" ### "Embeddings not configured"
- Verify `.env` has `LITELLM_API_BASE` - Verify `.env` has `VERTEX_PROJECT` or `LITELLM_API_BASE` or `OPENAI_API_KEY`
- Check service account credentials: `GOOGLE_APPLICATION_CREDENTIALS`
- Test: `curl http://localhost:3000/api/admin/learning/embeddings/status` - Test: `curl http://localhost:3000/api/admin/learning/embeddings/status`
### "Embedding generation failed" ### "Embedding generation failed"
- Check logs for API errors - Check logs for API errors
- Verify LiteLLM `/model/info` shows the selected model with `mode: embedding` - Verify Vertex AI API is enabled in GCP
- Verify service account has `aiplatform.endpoints.predict` permission
- Check content isn't empty (skips empty bodies) - Check content isn't empty (skips empty bodies)
### "No results from semantic search" ### "No results from semantic search"
@ -173,23 +200,23 @@ Embedding cost depends on the upstream configured in LiteLLM.
- Lower threshold: `?threshold=0.3` (default 0.5) - Lower threshold: `?threshold=0.3` (default 0.5)
- Verify pgvector index exists: `\di` in psql - Verify pgvector index exists: `\di` in psql
## Performance ## 📊 Performance
- **Embedding generation**: latency depends on the LiteLLM upstream - **Embedding generation**: ~500ms per article (Vertex AI)
- **Search latency**: - **Search latency**:
- Keyword: 10-50ms - Keyword: 10-50ms
- Semantic: 20-100ms (with IVFFLAT index) - Semantic: 20-100ms (with IVFFLAT index)
- Hybrid: 30-150ms - Hybrid: 30-150ms
- **Index build time**: ~1-5 seconds per 1,000 articles - **Index build time**: ~1-5 seconds per 1,000 articles
## Security And Compliance ## 🔐 Security & Compliance
- **Compliance**: controlled by the upstream provider configured in LiteLLM - **HIPAA-eligible**: Vertex AI supports BAA (Business Associate Agreement)
- **Data retention**: Embeddings stored in your database only - **Data retention**: Embeddings stored in your database only
- **No PHI**: Only article content (not patient data) is embedded - **No PHI**: Only article content (not patient data) is embedded
- **Encryption**: TLS in transit, at-rest encryption via PostgreSQL - **Encryption**: TLS in transit, at-rest encryption via PostgreSQL
## Example Queries ## 🎓 Example Queries
**Before (keyword):** **Before (keyword):**
``` ```
@ -217,7 +244,7 @@ Results:
- Bronchiolitis vs asthma (keyword: 1.0) - Bronchiolitis vs asthma (keyword: 1.0)
``` ```
## API Reference ## 📚 API Reference
### Admin Endpoints ### Admin Endpoints

347
FEATURES_EXPLAINED.md Normal file
View file

@ -0,0 +1,347 @@
# Features Explained - Pediatric AI Scribe v14
## 🎙️ **Audio Backups**
### How It Works:
Audio backups happen **automatically every time you record**, regardless of transcription success/failure.
**Flow:**
1. You press "Stop" on recording
2. Audio is immediately saved **before** transcription starts
3. Server-side backup (PostgreSQL, gzip compressed) attempted first
4. If server fails → fallback to browser IndexedDB
5. After successful transcription → audio backup is deleted
6. If transcription fails → audio backup remains for retry
**Location:**
- Server: PostgreSQL `audio_backups` table (auto-deleted after 24 hours)
- Browser: IndexedDB `PedScribeAudioBackup` database (manual cleanup)
**Purpose:**
- Retry transcription if it fails
- Recover audio if browser crashes
- Audit trail (24 hour retention)
**Access:**
Settings → Audio Backups section shows:
- Date/time of recording
- Module (encounter, dictation, etc.)
- File size
- "Retry Transcription" button (if transcription failed)
- "Delete" button
**Cost:**
Server backups are compressed (gzip) to ~1/10 original size. A 2MB recording becomes ~200KB in database.
---
## 🌐 **S3 Document Storage**
### How It Works:
Upload documents (PDFs, images, Word docs, text files) to S3-compatible storage.
**Supported Providers:**
- AWS S3 (default)
- Backblaze B2
- MinIO (self-hosted)
- Any S3-compatible service
**Configuration (.env):**
```bash
# AWS S3 (uses Bedrock credentials if available)
S3_BUCKET=your-bucket-name
S3_REGION=us-east-1
S3_PREFIX=documents/ # Optional: folder prefix
# Backblaze B2
S3_BUCKET=your-bucket-name
S3_ENDPOINT=https://s3.us-west-004.backblazeb2.com
S3_REGION=us-west-004
S3_ACCESS_KEY_ID=your-b2-application-key-id
S3_SECRET_ACCESS_KEY=your-b2-application-key
# MinIO (self-hosted)
S3_BUCKET=your-bucket
S3_ENDPOINT=http://minio:9000
S3_REGION=us-east-1
S3_ACCESS_KEY_ID=minio-access-key
S3_SECRET_ACCESS_KEY=minio-secret-key
S3_FORCE_PATH_STYLE=true # Required for MinIO
```
**Features:**
- ✅ 10 MB file size limit
- ✅ AES-256 server-side encryption
- ✅ Per-user folder organization (`documents/{userId}/{uuid}/filename`)
- ✅ Metadata stored in PostgreSQL (filename, mime type, size, description)
- ✅ Presigned URLs for secure access (1 hour expiry)
**Allowed File Types:**
- PDF (`.pdf`)
- Images (`.jpg`, `.jpeg`, `.png`, `.gif`)
- Word documents (`.doc`, `.docx`)
- Text files (`.txt`, `.csv`)
**Access:**
Settings → Documents section
**Status Check:**
If S3 is not configured, the Documents section shows empty with message: "S3 not configured"
---
## 📚 **Learning Hub - Default Browse Path**
### What It Is:
A user preference that sets the **starting folder** when browsing Nextcloud files for AI content generation.
### When It's Used:
Only in the **Learning Hub AI Content Generator** (Admin/Moderator feature).
**Scenario:**
1. Admin/Moderator wants to create AI-generated learning content
2. They choose "Upload from Nextcloud"
3. File browser opens
4. Instead of starting at root `/`, it opens at the configured path
**Example:**
```
Default path: /Medical-Resources
When you click "Browse Nextcloud", it opens:
/Medical-Resources/
├── Pediatric-Guidelines/
├── Clinical-Protocols/
└── Research-Papers/
Instead of:
/
├── Personal/
├── Photos/
├── Medical-Resources/ ← you'd have to navigate here every time
└── ...
```
**Configuration:**
Settings → Nextcloud Integration → "Learning Hub — Default Browse Path"
**Examples:**
- `/Medical-Resources` - Opens in Medical Resources folder
- `/Shared/Clinical-Content` - Opens in shared clinical content
- `/` (empty) - Opens at root (default behavior)
**Who Can Use This:**
- Any authenticated user (not just moderators)
- It's a personal preference per user
- Only affects Learning Hub AI file picker
**Why This Exists:**
If you store learning resources in a specific Nextcloud folder, you don't want to navigate there every single time you generate content. Set it once, it remembers.
---
## 🎤 **Browser Whisper Pre-Download**
### Issue You Reported:
"Pre-download models works, stuck at starting download"
### What's Happening:
The download **is actually working** but progress updates are slow because:
1. HuggingFace CDN serves large files (39-244 MB)
2. Progress callbacks are not granular (reported per-file, not per-chunk)
3. Initial ONNX runtime download has no progress tracking
### Fixed:
- ✅ Added console logging to track progress
- ✅ Added 30-second timeout warning (doesn't stop download)
- ✅ Better error messages
### How to Test:
1. Open browser DevTools (F12) → Console tab
2. Click "Pre-download model"
3. Watch console for progress logs:
```
[BrowserWhisper] Starting preload...
[BrowserWhisper] Progress: onnx-runtime 0%
[BrowserWhisper] Progress: model.bin 23%
[BrowserWhisper] Progress: model.bin 47%
...
[BrowserWhisper] Progress: 100%
```
### Expected Download Times:
- **Tiny** (39 MB): 5-15 seconds (fast connection)
- **Base** (74 MB): 10-30 seconds
- **Small** (244 MB): 30-90 seconds
### If Still Stuck:
**Check these:**
1. Open DevTools → Network tab
2. Filter by "HuggingFace"
3. Look for downloads from `cdn-lfs-us-1.huggingface.co`
4. Check if files are actually downloading
**Common issues:**
- Slow internet connection (244 MB takes time!)
- Corporate firewall blocking HuggingFace CDN
- Browser IndexedDB quota exceeded
**Workaround:**
Just enable it and record audio - the model will download on first use (same as pre-download, but triggered automatically).
---
## 🔊 **TTS Voice Preview**
### Issue You Reported:
"Preview button next to TTS seems to do nothing"
### Fixed:
- ✅ Added error logging to console
- ✅ Better validation (checks for empty selection)
- ✅ Clear user feedback messages
### How to Use:
1. Go to Settings → Voice Preferences
2. Select a voice from "Text-to-Speech Voice" dropdown
3. Click "Preview" button
4. Wait 2-3 seconds
5. Audio should play automatically
### If Nothing Happens:
**Check browser console for errors:**
- Open DevTools (F12) → Console tab
- Click Preview
- Look for `[VoicePrefs] Preview error:` message
**Common issues:**
1. **No voice selected** → Select from dropdown first
2. **TTS not configured** → Check `.env` has `GOOGLE_VERTEX_PROJECT` or `LITELLM_API_BASE`
3. **Network error** → Check server logs for TTS API errors
4. **Browser autoplay policy** → Some browsers block autoplay, click page first
### Testing Checklist:
```bash
# 1. Check TTS is configured
curl http://localhost:3000/api/health | grep tts
# 2. Test TTS endpoint directly
curl -X POST http://localhost:3000/api/text-to-speech \
-H "Authorization: Bearer YOUR_JWT" \
-H "Content-Type: application/json" \
-d '{"text":"Test"}' \
--output test.mp3
# 3. Play the audio file
mpg123 test.mp3 # or open in browser
```
---
## 📋 **Summary of User Settings**
### Voice Preferences
**Location:** Settings → Voice Preferences (top section)
| Setting | Options | Default | Purpose |
|---------|---------|---------|---------|
| **STT Model** | gemini-2.0-flash-exp, gemini-2.0-flash, gemini-1.5-flash, gemini-1.5-pro, whisper-1 | Server default | Controls transcription accuracy |
| **TTS Voice** | Journey-F/D, Studio-O/M, Neural2 series, alloy, echo, fable, onyx, nova, shimmer | Server default | Controls read-aloud voice |
### Browser Whisper
**Location:** Settings → Browser Transcription (Local Whisper)
| Setting | Options | Default | Purpose |
|---------|---------|---------|---------|
| **Enable** | On/Off | Off | Local transcription (HIPAA-safe) |
| **Model** | Tiny, Base, Small | Tiny | Accuracy vs speed tradeoff |
### Nextcloud
**Location:** Settings → Nextcloud Integration
| Setting | Purpose |
|---------|---------|
| **Nextcloud URL** | Your Nextcloud instance |
| **Username** | Nextcloud username |
| **App Password** | Generate in Nextcloud → Security |
| **Default Browse Path** | Starting folder for Learning Hub AI picker |
### Documents (S3)
**Location:** Settings → Documents
Shows list of uploaded documents if S3 is configured. Upload limit: 10 MB per file.
### Audio Backups
**Location:** Settings → Audio Backups
Shows last 24 hours of recordings. Can retry transcription or delete.
---
## 🔧 **Troubleshooting Guide**
### Pre-Download Stuck
1. ✅ Open browser console (F12)
2. ✅ Look for `[BrowserWhisper] Progress:` logs
3. ✅ Check Network tab for HuggingFace downloads
4. ✅ Wait - 244 MB takes time!
5. ✅ If truly stuck (no network activity): refresh page, try again
### Preview Button Silent
1. ✅ Check voice is selected in dropdown
2. ✅ Open console for error messages
3. ✅ Test TTS endpoint directly (curl command above)
4. ✅ Check server logs for TTS provider errors
5. ✅ Verify `.env` has TTS provider configured
### S3 Not Working
1. ✅ Check `.env` has `S3_BUCKET` set
2. ✅ Verify credentials: `S3_ACCESS_KEY_ID` + `S3_SECRET_ACCESS_KEY`
3. ✅ Test bucket access from server:
```bash
aws s3 ls s3://your-bucket/ --region us-east-1
```
4. ✅ Check server logs for S3 errors when uploading
### Audio Backups Not Showing
1. ✅ Record audio first (they're created on recording, not transcription)
2. ✅ Check database: `SELECT COUNT(*) FROM audio_backups;`
3. ✅ Verify IndexedDB in browser: DevTools → Application → IndexedDB → `PedScribeAudioBackup`
4. ✅ Backups auto-delete after 24 hours
### Learning Hub Path Not Working
1. ✅ This only affects **AI content generator file picker**
2. ✅ It does NOT affect manual Nextcloud document browsing
3. ✅ Path must exist in your Nextcloud
4. ✅ Path format: `/Folder/Subfolder` (starts with `/`)
---
## 📊 **Feature Status Matrix**
| Feature | Status | Config Required | HIPAA-Safe | Notes |
|---------|--------|-----------------|------------|-------|
| **Audio Backups** | ✅ Working | None (auto) | ✅ Yes | Server + IndexedDB |
| **S3 Documents** | ✅ Working | S3_BUCKET | ✅ Yes (AWS) | Optional feature |
| **Browser Whisper** | ✅ Working | None (optional) | ✅ Yes | Client-side only |
| **Voice Preferences** | ✅ Working | Provider config | Depends | Google/AWS = yes |
| **Learning Hub Path** | ✅ Working | Nextcloud config | ✅ Yes | User preference |
| **TTS Preview** | ✅ Fixed | TTS provider | Depends | Check logs if fails |
| **Embeddings** | ✅ Working | Vertex/LiteLLM | ✅ Yes | Requires pgvector |
---
## 🚀 **Next Steps**
1. **Push v14 to Docker** (in progress via GitHub Actions)
2. **Test features after deployment**
3. **Check browser console for any errors**
4. **Verify TTS preview works with your provider**
5. **Test browser whisper download with different models**
---
**Questions? Check the logs:**
- Browser: F12 → Console tab
- Server: `docker logs pediatric-ai-scribe -f`
- Database: `psql -d pedscribe -c "SELECT COUNT(*) FROM audio_backups;"`

View file

@ -52,7 +52,7 @@ This is the highest-impact improvement for adoption but also the most complex to
### 5. Offline Mode ### 5. Offline Mode
**Current state:** The app requires configured server-side providers for AI generation and final transcription. Browser Whisper has been removed from the runtime. **Current state:** The app requires an internet connection for AI generation and cloud-based transcription. Browser Whisper works offline for transcription only.
**Improvement:** Add a local AI model option (e.g., a small medical LLM running on the device or local server) so the entire workflow — record, transcribe, generate note — can happen without any network calls. This would be valuable for: **Improvement:** Add a local AI model option (e.g., a small medical LLM running on the device or local server) so the entire workflow — record, transcribe, generate note — can happen without any network calls. This would be valuable for:
- Rural clinics with unreliable internet - Rural clinics with unreliable internet
@ -74,9 +74,9 @@ Each specialty has unique documentation requirements that could be addressed wit
### 7. Billing Code Suggestions ### 7. Billing Code Suggestions
**Current state:** Post-note billing suggestions are active as clinician-facing helper panels on supported note outputs. **Current state:** The well visit tab includes some billing code references.
**Further improvement:** Improve payer-specific rules, add institution-specific favorites, and add export formats that match common EHR coding workflows. **Improvement:** Automatically suggest ICD-10 and CPT codes based on the generated note content. After the AI generates a note, it could analyze the diagnoses, procedures, and visit complexity to suggest appropriate billing codes. This saves time on coding and reduces missed charges.
### 8. Quality Metrics Dashboard ### 8. Quality Metrics Dashboard
@ -85,7 +85,7 @@ Each specialty has unique documentation requirements that could be addressed wit
**Improvement:** Add a dashboard showing: **Improvement:** Add a dashboard showing:
- Average note generation time by type - Average note generation time by type
- Most-used AI models and their accuracy (based on how often users edit the output) - Most-used AI models and their accuracy (based on how often users edit the output)
- Transcription quality metrics from explicit user feedback or retry outcomes - Transcription accuracy metrics (if corrections are tracked)
- Usage patterns by time of day and day of week - Usage patterns by time of day and day of week
- Cost tracking across AI providers - Cost tracking across AI providers
@ -93,9 +93,9 @@ This would help administrators optimize model selection and identify training op
### 9. Patient Education Materials ### 9. Patient Education Materials
**Current state:** Patient education handouts are active as post-note helpers. Generated notes can open a Handout panel that creates a parent-facing plain-text draft from the clinician note, with optional diagnosis, medication, patient age, and preferred language context. The Learning Hub remains the physician-facing education/CMS area. **Current state:** The Learning Hub serves educational content to physicians.
**Further improvement:** Add handout templates, saved handout history, institution-approved language libraries, and printable/PDF export. **Improvement:** Add a patient-facing education module that generates age-appropriate handouts based on the diagnosis. For example, after generating a note for a child with asthma, the app could produce a parent-friendly handout explaining the diagnosis, medications, and when to seek emergency care — in the parent's preferred language.
### 10. Multi-Language Support ### 10. Multi-Language Support
@ -140,7 +140,7 @@ This mirrors the real workflow in training institutions and group practices.
### 14. Template Library ### 14. Template Library
**Current state:** Physician templates and prompt preferences provide per-user personalization. Legacy correction-learning rows may exist but are no longer active behavior. **Current state:** Physician memories and corrections provide some personalization.
**Improvement:** Add a shared template library where physicians can create, share, and browse note templates: **Improvement:** Add a shared template library where physicians can create, share, and browse note templates:
- "My asthma follow-up template" - "My asthma follow-up template"
@ -182,7 +182,7 @@ Compared to existing medical scribes and documentation tools:
- **Pediatric-specific** — prompts, calculators, milestones, and growth charts designed for children, not adapted from adult tools - **Pediatric-specific** — prompts, calculators, milestones, and growth charts designed for children, not adapted from adult tools
- **Self-hosted** — runs on your own infrastructure, not a SaaS that holds your data - **Self-hosted** — runs on your own infrastructure, not a SaaS that holds your data
- **Provider-flexible** — routes through OpenRouter, Bedrock, Azure, Vertex, or LiteLLM depending on deployment configuration - **Provider-agnostic** — works with any AI provider (swap between them without changing anything)
- **Privacy-conscious** — self-hosted app, encrypted sensitive fields, auto-expiring encounter/audio recovery data, and configurable BAA-eligible providers - **Privacy-first** — optional fully offline transcription, auto-expiring data, no permanent PHI storage
- **Template-aware** — user templates and prompt preferences can shape output without relying on automatic correction learning - **Learning system** — AI improves its output based on each physician's editing patterns
- **All-in-one** — documentation, calculators, education, and administration in a single platform - **All-in-one** — documentation, calculators, education, and administration in a single platform

331
README.md
View file

@ -1,103 +1,78 @@
# Ped-AI # Pediatric AI Scribe v6
Ped-AI is a pediatric clinical documentation, education, and bedside decision-support app. This fork has moved well beyond the original scribe app: it now combines encounter documentation, clinical workflows, Learning Hub CMS, admin controls, MCP-backed clinical assistant integration, Redis-backed operational state, and hardened deployment defaults. AI-powered clinical documentation platform for pediatric medicine. Generates HPIs, hospital courses, chart reviews, SOAP notes, well/sick visit notes, and developmental milestone assessments from voice recordings or dictation.
The app runs as an authenticated Express/Postgres service with a browser frontend and optional integrations for LiteLLM, Vertex/Gemini, AWS, OpenAI-compatible APIs, Nextcloud WebDAV, S3-compatible storage, OpenBao, Redis, OIDC, TOTP, and Cloudflare Turnstile. ## Features
## Current Scope
### Clinical Documentation ### Clinical Documentation
- **Live Encounter** — record doctor-patient conversations, AI generates structured OLDCARTS HPI
- **Voice Dictation** — dictate narrative, AI cleans and restructures
- **Hospital Course** — paste progress notes, generates prose, day-by-day, organ-system (ICU), or psych format
- **Chart Review / Precharting** — summarize outpatient, subspecialty, and ED notes
- **SOAP Notes** — full SOAP or subjective-only from dictation
- **Well Visit** — AAP 2025 Bright Futures periodicity with vaccines, screenings, billing codes, SSHADESS (12+), milestones
- **Sick Visit** — quick documentation with auto-suggested ROS and PE from chief complaint
- **Developmental Milestones** — AAP/Nelson tracker (birth-11y) with narrative/structured/summary output
- Live encounter capture with structured pediatric HPI generation. ### AI & Speech
- Dictation cleanup for narrative notes. - **5 AI Providers** — OpenRouter, AWS Bedrock, Azure OpenAI, Google Vertex AI, LiteLLM
- SOAP, sick visit, well visit, hospital course, chart review, precharting, and ED encounter workflows. - **5 STT Providers** — Google Gemini, Amazon Transcribe (Medical), OpenAI Whisper, Local Whisper, LiteLLM
- Parent-facing education handouts generated from clinician notes, with diagnosis, medication, emergency-care guidance, and preferred-language support. - **3 TTS Providers** — Google Cloud TTS, LiteLLM (OpenAI), ElevenLabs
- Pediatric developmental milestone tooling. - **Browser Whisper** — fully offline in-browser transcription via WebAssembly (HIPAA-safe)
- Templates, physician memory, and per-tab model overrides. - **Per-tab model selector** — choose fast vs. smart vs. premium models per task
- Server-side speech-to-text routing through configured providers. - **Physician memory system** — Dragon-like learning from your corrections
### Bedside Tools
- Pediatric calculators and emergency dosing helpers.
- PE guide and clinical reference content.
- Vaccines, catch-up schedules, growth/vitals, bilirubin, BSA, GCS, equipment, and resuscitation helpers.
- Mobile-friendly PWA layout for bedside use.
- Per-user phone extension and pager directory with soft-delete, search, ZIP export, and JSON/ZIP import for handoff between users.
### Learning Hub ### Learning Hub
- **Content Management** — articles, clinical pearls, quizzes, presentations
- **AI Content Generation** — generate from topics, uploaded PDFs, or Nextcloud files
- **Marp Presentations** — slide editor with preview and PPTX export
- **Semantic Search** — vector-based search via pgvector embeddings
- **Quiz System** — MCQ, multi-select, true/false with scoring and progress tracking
- CMS for articles, clinical pearls, quizzes, and presentations. ### Platform
- Tiptap article editor, quiz builder, category management, and draft/publish flow. - **Multi-user with roles** — admin, moderator, user
- AI-assisted content generation from topic text, uploaded files, or connected Nextcloud WebDAV files. - **OIDC/SSO** — Azure AD, Okta, Keycloak, PocketID, Google
- Marp slide editing with preview and PPTX export. - **2FA** — TOTP-based two-factor authentication
- Keyword, semantic, and hybrid search using Postgres/pgvector where configured. - **Cloudflare Turnstile** — bot protection on login, register, password reset
- **Email verification** — with customizable templates
- **Nextcloud integration** — WebDAV export
- **S3 Document Storage** — AWS S3, Backblaze B2, MinIO
- **PWA** — installable, works on mobile
- **Admin Panel** — user management, settings, prompt editor, model configuration, logs
### Clinical Assistant ---
- Optional MCP-backed clinical assistant integration.
- Prompt suggestions backed by Redis operational cache.
- No clinical answer response caching.
- Designed to retrieve from indexed clinical material while keeping provider selection explicit.
### Admin And Security
- Local auth, role-based access, TOTP 2FA, OIDC/SSO, email verification, and optional Turnstile.
- Admin panel for users, settings, prompts, models, logs, and Learning Hub content.
- Audit, API, access, and client-error logs with redaction hardening.
- OpenBao secret loading support at container startup.
- S3-compatible document storage support.
## Removed Browser STT
Browser Whisper has been removed from the runtime. The app should not ship browser Whisper workers, browser-local Whisper model downloads, Transformers.js browser STT, or Browser Whisper setup docs.
Speech-to-text is handled server-side through configured providers such as Google/Gemini, AWS Transcribe, LiteLLM, or OpenAI Whisper. Browser-native Web Speech remains gated behind an explicit user setting when present in the browser.
## Quick Start ## Quick Start
### 1. Configure
```bash ```bash
cp .env.example .env cp .env.example .env
docker compose up -d --build
``` ```
The default compose exposes the app on `127.0.0.1:3552` and starts: Edit `.env` — at minimum set:
- `pediatric-ai-scribe` for the Node app.
- `pedscribe-db` for Postgres with pgvector.
- `ped-ai-redis` for operational Redis state.
Health check:
```bash
curl -fsS http://127.0.0.1:3552/api/health
```
Prometheus metrics are exposed at `GET /metrics` with the `ped_ai_` metric prefix.
The first registered user becomes an admin unless registration has already been configured differently.
## Core Environment
Set real values in `.env` before production use.
```env ```env
APP_URL=https://your-domain.example AI_PROVIDER=litellm # or openrouter, bedrock, azure, vertex
JWT_SECRET=<64-char-random-secret> LITELLM_API_BASE=https://your-litellm.example.com
DB_PASSWORD=<strong-database-password> LITELLM_API_KEY=sk-...
AI_PROVIDER=litellm OPENAI_API_KEY=sk-... # for Whisper transcription (if not using LiteLLM STT)
LITELLM_API_BASE=https://your-litellm.example/v1
LITELLM_API_KEY=<key>
TRANSCRIBE_PROVIDER=litellm JWT_SECRET=<64-char random> # openssl rand -hex 32
LITELLM_STT_MODEL=whisper-1 DB_PASSWORD=<strong password>
APP_URL=https://your-domain.com
REDIS_URL=redis://ped-ai-redis:6379
``` ```
Supported text AI providers include LiteLLM, OpenRouter, AWS Bedrock, Azure OpenAI, and Google Vertex AI. Supported STT routing includes Google/Gemini, AWS Transcribe, OpenAI Whisper, and LiteLLM. Supported TTS routing includes Google Cloud TTS, LiteLLM/OpenAI-compatible audio, and ElevenLabs where configured. ### 2. Start
## Admin CLI ```bash
docker compose up -d
```
App runs on **port 3552**. First user to register becomes admin.
### 3. Admin CLI
```bash ```bash
docker exec pediatric-ai-scribe node admin-cli.js list-users docker exec pediatric-ai-scribe node admin-cli.js list-users
@ -108,70 +83,190 @@ docker exec pediatric-ai-scribe node admin-cli.js toggle-registration
docker exec pediatric-ai-scribe node admin-cli.js stats docker exec pediatric-ai-scribe node admin-cli.js stats
``` ```
## Maintenance ---
The app checks Postgres collation drift on startup and can reindex text indexes after image or OS-library changes. ## AI Provider Configuration
Switch providers by setting `AI_PROVIDER` in `.env`. No code changes needed.
| Provider | HIPAA | Config |
|----------|-------|--------|
| **LiteLLM** | Depends on backend | `LITELLM_API_BASE`, `LITELLM_API_KEY` |
| **AWS Bedrock** | Yes (with BAA) | `AWS_BEDROCK_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` |
| **Azure OpenAI** | Yes (with BAA) | `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_API_KEY`, `AZURE_DEPLOYMENT_NAME` |
| **Google Vertex AI** | Yes (with BAA) | `GOOGLE_VERTEX_PROJECT`, `GOOGLE_VERTEX_LOCATION` |
| **OpenRouter** | No | `OPENROUTER_API_KEY` |
---
## Transcription (Speech-to-Text)
Set `TRANSCRIBE_PROVIDER` or let the app auto-detect.
| Provider | HIPAA | Config |
|----------|-------|--------|
| **Google Gemini** | Yes | `GOOGLE_VERTEX_PROJECT`, `GOOGLE_STT_MODEL` |
| **Amazon Transcribe** | Yes | AWS creds + `TRANSCRIBE_PROVIDER=aws` |
| **Amazon Transcribe Medical** | Yes | `AWS_TRANSCRIBE_MEDICAL=true`, `AWS_TRANSCRIBE_SPECIALTY=PRIMARYCARE` |
| **Local Whisper** | Yes (offline) | `TRANSCRIBE_PROVIDER=local`, `WHISPER_BINARY`, `WHISPER_MODEL_SIZE` |
| **OpenAI Whisper** | No | `OPENAI_API_KEY` |
| **LiteLLM** | Depends | `TRANSCRIBE_PROVIDER=litellm`, `LITELLM_STT_MODEL` |
| **Browser Whisper** | Yes (client-side) | No config needed — toggle in user settings |
---
## Text-to-Speech
| Provider | HIPAA | Config |
|----------|-------|--------|
| **Google Cloud TTS** | Yes | `GOOGLE_VERTEX_PROJECT`, `GOOGLE_TTS_VOICE` |
| **LiteLLM** | Depends | `LITELLM_TTS_MODEL`, `LITELLM_TTS_VOICE` |
| **ElevenLabs** | No | `ELEVENLABS_API_KEY` |
---
## OpenID Connect / SSO
Supports Azure AD, Okta, Keycloak, PocketID, Google, and any OIDC-compliant provider.
1. Register callback URL: `https://your-domain.com/api/auth/oidc/callback`
2. Admin Panel > Settings > Configure OIDC (Issuer URL, Client ID, Client Secret)
3. Users are auto-created and linked by email on first SSO login
See [OPENID_SETUP.md](OPENID_SETUP.md) for provider-specific guides.
---
## Cloudflare Turnstile (Bot Protection)
Optional CAPTCHA on login, registration, and password reset forms.
```env
TURNSTILE_SITE_KEY=0x4AAA...
TURNSTILE_SECRET_KEY=0x4AAA...
```
---
## Email
Without SMTP, email verification is skipped and users are auto-verified.
```env
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@gmail.com
SMTP_PASS=your-app-password
SMTP_FROM=noreply@yourdomain.com
```
---
## Maintenance CLI
After a Postgres image upgrade (major version bump or silent base-layer change),
btree indexes on text columns can become inconsistent with the new ICU/glibc
library. The app auto-detects this at startup and reindexes on drift, but you
can also trigger it manually:
```bash ```bash
# Health check — no writes
docker exec pediatric-ai-scribe npm run maint:check docker exec pediatric-ai-scribe npm run maint:check
# Rebuild all indexes + refresh collation + ANALYZE
docker exec pediatric-ai-scribe npm run maint:reindex docker exec pediatric-ai-scribe npm run maint:reindex
``` ```
Run the reindex command after major Postgres image changes, restoring a dump from another distro, or seeing lookup behavior that suggests collation/index drift. Run `maint:reindex` any time after:
## Testing - Upgrading the Postgres image (major or minor)
- Restoring from a dump created on a different Linux distro
- Seeing "invalid credentials" on credentials you know are correct
- Seeing `0 rows` returned from a lookup that should match
Run the Node test suite: The reindex takes seconds on a small DB and a minute or two on larger ones.
Safe to run while the app is serving traffic, though queries may slow briefly.
---
## Docker Hub
```bash ```bash
npm test docker pull danielonyejesi/pediatric-ai-scribe-v3:latest
``` ```
Run syntax checks for touched files when doing focused backend work: Minimal compose without building:
```bash ```yaml
node --check server.js services:
node --check src/routes/transcribe.js app:
image: danielonyejesi/pediatric-ai-scribe-v3:latest
ports:
- "3552:3000"
env_file: .env
depends_on:
postgres:
condition: service_healthy
restart: unless-stopped
postgres:
image: pgvector/pgvector:pg16
environment:
POSTGRES_DB: pedscribe
POSTGRES_USER: pedscribe
POSTGRES_PASSWORD: ${DB_PASSWORD}
volumes:
- pgdata:/var/lib/postgresql/data
restart: unless-stopped
healthcheck:
test: ["CMD-SHELL", "pg_isready -U pedscribe"]
interval: 10s
retries: 5
volumes:
pgdata:
``` ```
Run the Playwright smoke suite against the e2e compose stack: ---
```bash ## HIPAA Notice
docker compose -f docker-compose.yml -f docker-compose.e2e.yml up -d pediatric-scribe-e2e
npm run e2e
```
## Deployment Notes This application processes data through third-party AI APIs.
- Put the app behind HTTPS before clinical use. - All connections use HTTPS/TLS
- Use only AI/STT/TTS providers covered by your BAA and data-processing requirements. - Authentication required for all AI endpoints
- Configure OIDC/SSO and 2FA for production users. - 2FA and SSO available
- Keep `JWT_SECRET`, database credentials, provider keys, S3 keys, SMTP credentials, and OpenBao tokens out of git. - Cloudflare Turnstile bot protection
- Treat logs as sensitive operational data even with redaction enabled. - **AWS Bedrock**, **Azure OpenAI**, and **Google Vertex AI** offer BAAs
- Use the Caddy/reverse-proxy layer to expose only intended public routes. - **OpenRouter** and **ElevenLabs** do NOT offer BAAs
- **Browser Whisper** and **Local Whisper** keep audio fully private
**Do not use real PHI without executed BAAs with all providers in your deployment.**
---
## Documentation ## Documentation
Primary references: See the [docs/](docs/) directory for detailed documentation:
- `docs/ARCHITECTURE.md` for the current system map and service boundaries. - [Architecture Overview](docs/architecture.md)
- `docs/DEVELOPMENT.md` for day-to-day code-change workflow. - [API Reference](docs/api-reference.md)
- `docs/SCALING.md` for scaling priorities and readiness work. - [Database Schema](docs/database.md)
- `docs/CLINICAL_ASSISTANT.md` for MCP-backed assistant behavior and safety rules. - [Authentication & Security](docs/authentication.md)
- `docs/MODULE_CONVENTIONS.md` for CommonJS, ESM, globals, and rendering rules. - [AI Providers & Models](docs/ai-providers.md)
- `docs/architecture.md` for high-level architecture. - [Speech (STT/TTS)](docs/speech.md)
- `docs/api-reference.md` for API routes. - [Learning Hub & CMS](docs/learning-hub.md)
- `docs/authentication.md` for auth, OIDC, and security configuration. - [Configuration Reference](docs/configuration.md)
- `docs/ai-providers.md` for model/provider setup. - [Deployment Guide](docs/deployment.md)
- `docs/speech.md` for server-side STT/TTS setup. - [Developer Guide](docs/developer-guide.md)
- `docs/learning-hub.md` for the CMS and education workflow.
- `docs/configuration.md` for environment variables.
- `docs/deployment.md` for production deployment.
- `docs/mobile-build.md` for the Capacitor wrapper and app-store build notes.
- `docs/logic/README.md` for the deeper code walkthrough.
Some deep `docs/logic/` files still describe historical implementation details. Prefer runtime code and tests when documentation conflicts with current behavior. ---
## Clinical Safety ## Development
Ped-AI is documentation and education support software. It does not replace clinical judgment, local policy, medication verification, or attending review. Validate generated notes, calculations, and recommendations before use in patient care. ```bash
npm install
cp .env.example .env # edit with your keys
# Requires PostgreSQL with pgvector
node server.js
```

279
TRANSCRIPTION_OPTIONS.md Normal file
View file

@ -0,0 +1,279 @@
# Transcription Options Guide
## Overview
Pediatric AI Scribe v2+ offers **three transcription methods**, allowing you to choose between **privacy**, **speed**, and **real-time feedback**.
---
## 📊 Comparison Table
| Feature | Browser Whisper | Server Transcription | Web Speech API |
|---------|----------------|---------------------|----------------|
| **Privacy** | ⭐⭐⭐⭐⭐ 100% offline | ⭐⭐⭐⭐ (with BAA) | ⭐ Sends to cloud |
| **Accuracy** | ⭐⭐⭐⭐⭐ Whisper | ⭐⭐⭐⭐⭐ Gemini/AWS | ⭐⭐⭐ Browser-dependent |
| **Speed** | ⭐⭐⭐ 2-10s | ⭐⭐⭐⭐⭐ ~1s | ⭐⭐⭐⭐⭐ Instant |
| **Real-time** | ❌ Batch mode | ❌ Batch mode | ✅ Live streaming |
| **HIPAA** | ✅ Yes | ✅ (Vertex/AWS) | ❌ No |
| **Cost** | Free | ~$0.005/min | Free |
| **Internet** | ❌ Not required | ✅ Required | ✅ Required |
| **Setup** | None (bundled) | API keys | None (built-in) |
---
## Option 1: Browser Whisper (Offline, Private) ⭐ RECOMMENDED
### What It Is
- Runs **OpenAI Whisper** entirely in your browser using WebAssembly
- Audio **never leaves your device** - 100% offline after initial page load
- Models bundled in Docker image (self-hosted, no CDN)
### When to Use
- ✅ Clinical documentation (HIPAA-compliant)
- ✅ Maximum privacy required
- ✅ Offline/air-gapped environments
- ✅ No API costs
- ✅ Zero vendor dependency
### How to Enable
1. Settings → Browser Transcription
2. Toggle "Enable browser transcription" ON
3. (Optional) Click "Pre-download model" if you want to cache it first
4. Start recording - transcription happens automatically after recording
### Models Available
- **Tiny** (~39MB) - Fast, good for short clips (2-3 seconds)
- **Base** (~74MB) - Balanced accuracy and speed (3-5 seconds)
- **Small** (~244MB) - Best quality, slower (6-10 seconds)
### Performance
- Transcribes ~30-second clip in 2-10 seconds (depending on model)
- First run may be slower (model loading)
- Subsequent runs are instant (cached)
### Privacy
- ✅ Audio never transmitted
- ✅ Models run locally in WASM
- ✅ No network calls during transcription
- ✅ HIPAA-compliant
---
## Option 2: Server Transcription (Cloud, Fast)
### What It Is
- Sends audio to your configured AI provider
- Uses Google Gemini, AWS Transcribe, OpenAI Whisper, or LiteLLM
### When to Use
- ✅ Maximum speed (~1 second for 30-second clip)
- ✅ Best accuracy (cloud models)
- ✅ Long recordings (Browser Whisper can be slow for 5+ minutes)
- ✅ HIPAA-compliant with BAA providers
### HIPAA-Eligible Providers
- **Google Vertex AI** (with BAA) ✅
- **AWS Transcribe** (with BAA) ✅
- **Azure OpenAI** (with BAA) ✅
- **OpenAI Whisper Direct** ❌ Not HIPAA-eligible
### How to Enable
- Configured via environment variables (`.env`)
- No user action needed - just works if API keys present
- Falls back automatically if Browser Whisper fails
### Cost
- Google Gemini: ~$0.005/minute
- AWS Transcribe: ~$0.024/minute
- OpenAI: $0.006/minute
---
## Option 3: Web Speech API (Real-Time, Experimental) ⚠️
### What It Is
- Uses your browser's built-in speech recognition
- Shows transcription **in real-time** as you speak (streaming)
- Chrome/Edge → Google Cloud Speech
- Safari → Apple Speech Recognition
### ⚠️ PRIVACY WARNING
- **Audio IS sent to cloud servers** (Google, Apple, etc.)
- **NOT HIPAA-compliant**
- Only use for non-clinical, personal use
### When to Use
- ✅ Personal notes (non-clinical)
- ✅ Want real-time feedback while speaking
- ✅ Demonstration/testing
- ❌ **NEVER for patient data**
### How to Enable
1. Settings → Real-Time Streaming Transcription
2. Read privacy warning carefully
3. Toggle "Enable real-time streaming" ON
4. Confirm warning dialog
5. Grants microphone permission
6. Start recording - see words appear live
### Limitations
- Not available in all browsers (requires Web Speech API)
- Accuracy varies by browser
- Requires internet connection
- May have usage limits
---
## Choosing the Right Option
### For Clinical Use (HIPAA Required)
**Use:** Browser Whisper (offline) OR Server (Vertex AI/AWS with BAA)
- Browser Whisper: Maximum privacy, no costs
- Server: Faster, better for long recordings
### For Personal Use (Non-HIPAA)
**Use:** Any option
- Browser Whisper: Best balance of privacy and accuracy
- Server: Fastest
- Web Speech: Real-time feedback
### Decision Tree
```
Is this clinical/patient data?
├─ YES → Use Browser Whisper or Server (Vertex/AWS)
│ ├─ Need offline? → Browser Whisper
│ ├─ Need speed? → Server (Vertex AI)
│ └─ Want free? → Browser Whisper
└─ NO → Any option
├─ Want real-time? → Web Speech API
├─ Want privacy? → Browser Whisper
└─ Want speed? → Server
```
---
## Configuration
### Browser Whisper
```bash
# No configuration needed - bundled in Docker image
# Models at: /app/public/models/Xenova/whisper-tiny.en/
```
### Server Transcription
```bash
# .env file
TRANSCRIBE_PROVIDER=google # google, aws, openai, litellm
# Google Vertex AI
GOOGLE_VERTEX_PROJECT=your-project-id
GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
# AWS Transcribe
AWS_BEDROCK_REGION=us-east-1
AWS_ACCESS_KEY_ID=your-key
AWS_SECRET_ACCESS_KEY=your-secret
# OpenAI
OPENAI_API_KEY=sk-...
# LiteLLM (proxy)
LITELLM_API_BASE=http://localhost:4000
LITELLM_API_KEY=optional
```
### Web Speech API
```bash
# No configuration - uses browser built-in
# Privacy warning shown in Settings UI
```
---
## FAQ
### Q: Which is most accurate?
**A:** Browser Whisper and Server (Gemini/Whisper) are equally accurate. Web Speech is slightly less accurate.
### Q: Which is fastest?
**A:** Server transcription (~1s) > Web Speech (real-time) > Browser Whisper (2-10s)
### Q: Which is most private?
**A:** Browser Whisper (100% offline) > Server (with BAA) > Web Speech (not private)
### Q: Can I use multiple at once?
**A:** No. Priority: Web Speech > Browser Whisper > Server (whichever is enabled first)
### Q: What if transcription fails?
**A:** Automatic fallback chain:
1. Browser Whisper (if enabled)
2. Falls back to Server (if configured)
3. Falls back to live transcript (if available)
### Q: Is Browser Whisper really offline?
**A:** Yes! Models are bundled in the Docker image. After the page loads once, transcription works with zero network access.
### Q: Does Web Speech work offline?
**A:** No. It requires internet to send audio to cloud servers.
### Q: Can I train/customize the models?
**A:** No. Browser Whisper uses pre-trained models. Server transcription uses cloud models. No custom training available.
---
## Troubleshooting
### Browser Whisper stuck at "Initializing"
- **Cause:** Models not loaded or network blocked during initial download
- **Fix:** See BROWSER_WHISPER_TROUBLESHOOTING.md
### Server transcription returns "No provider"
- **Cause:** API keys not configured
- **Fix:** Set environment variables in `.env`
### Web Speech says "Not supported"
- **Cause:** Browser doesn't support Web Speech API
- **Fix:** Use Chrome, Edge, or Safari
### Transcription is slow
- **Browser Whisper:** Try switching to "Tiny" model
- **Server:** Check API provider status
- **Web Speech:** Check internet connection
---
## Best Practices
### Clinical Documentation
1. Use Browser Whisper for all patient data
2. Enable audio backups (automatic in v2)
3. Keep recordings under 5 minutes for faster processing
4. Use "Tiny" model for quick notes, "Base" for detailed documentation
### Personal Use
1. Web Speech for quick, informal notes
2. Browser Whisper for anything you want private
3. Server for long recordings
### Performance Optimization
1. Pre-download Browser Whisper model before first use
2. Use shorter clips (30-60 seconds) for fastest results
3. Clear browser cache if models seem corrupted
---
## Summary
| Need | Recommendation |
|------|---------------|
| Clinical/HIPAA | Browser Whisper (offline) |
| Fast transcription | Server (Vertex AI) |
| Real-time feedback | Web Speech (non-clinical only) |
| Maximum privacy | Browser Whisper |
| Zero cost | Browser Whisper |
| Long recordings | Server (faster for 5+ min clips) |
| Offline use | Browser Whisper |
**Default recommendation:** Browser Whisper for 95% of use cases. It's private, accurate, free, and offline. Only use alternatives when you have specific needs for speed or real-time feedback.

View file

@ -1,56 +0,0 @@
# E2E test environment — runs a second instance of the app on port 3553 with
# Turnstile disabled so Playwright can log in without the bot challenge.
# Shares the postgres + pgdata volume with production so seeded e2e test users
# (email pattern *@ped-ai.test) persist across test runs.
#
# Bring up with:
# docker compose -f docker-compose.yml -f docker-compose.e2e.yml up -d pediatric-scribe-e2e
#
# Tear down with:
# docker compose -f docker-compose.yml -f docker-compose.e2e.yml down pediatric-scribe-e2e
services:
pediatric-scribe-e2e:
build: .
image: ped-ai-local:latest
ports:
- "127.0.0.1:3553:3000"
env_file:
- .env
environment:
# Disable Turnstile entirely — both server-side verification AND the
# client-side widget. Without clearing the SITE_KEY the frontend tries
# to initialise the Turnstile iframe against the prod domain and
# throws error 110200, which Playwright's pageerror guard correctly
# flags as an uncaught exception.
TURNSTILE_SECRET_KEY: ""
TURNSTILE_SITE_KEY: ""
# Disable SMTP so register auto-verifies the user and returns a session
SMTP_HOST: ""
# Raise the login rate-limit so Playwright multi-worker runs don't
# trip the production 10/15min cap. Only affects this e2e container.
LOGIN_RATE_LIMIT_MAX: "500"
# Also raise the global /api/ limit so multi-spec Playwright runs
# that make hundreds of API calls don't burn through the 200/min cap.
API_RATE_LIMIT_MAX: "5000"
# Allow fetches from the two origins Playwright serves tests from —
# the in-network hostname and the host-port loopback. Without this
# the CORS middleware (scoped to /api) rejects any non-GET request
# because .env's APP_URL points at the production domain.
CORS_ORIGINS: "http://pediatric-ai-scribe-e2e:3000,http://host.docker.internal:3553,http://localhost:3553"
volumes:
- scribe-logs-e2e:/app/data/logs
depends_on:
postgres:
condition: service_healthy
container_name: pediatric-ai-scribe-e2e
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "--spider", "-q", "http://localhost:3000/api/health"]
interval: 30s
timeout: 10s
retries: 5
start_period: 20s
volumes:
scribe-logs-e2e:

View file

@ -6,31 +6,13 @@ services:
- "127.0.0.1:3552:3000" - "127.0.0.1:3552:3000"
env_file: env_file:
- .env - .env
environment:
CLINICAL_ASSISTANT_MCP_URL: http://mcp:8000/mcp
REDIS_URL: redis://ped-ai-redis:6379
LOKI_URL: http://monitoring-loki:3100
LITELLM_API_BASE: http://litellm:4000
TTS_PROVIDER: litellm
LITELLM_TTS_MODEL: local-kokoro-tts
LITELLM_TTS_VOICE: sherpa/kokoro:am_adam
LITELLM_TTS_VOICES: sherpa/kokoro:am_adam,sherpa/kokoro:am_michael,sherpa/kokoro:af_bella,sherpa/kokoro:af_nicole,sherpa/kokoro:bf_emma,sherpa/kokoro:bm_lewis
CLINICAL_ASSISTANT_PROMPT_POOL_TARGET: 1000
volumes: volumes:
- scribe-logs:/app/data/logs - scribe-logs:/app/data/logs
- clinical-assistant-mcp-data:/app/mcp-data:ro
depends_on: depends_on:
postgres: postgres:
condition: service_healthy condition: service_healthy
redis:
condition: service_healthy
restart: unless-stopped restart: unless-stopped
container_name: pediatric-ai-scribe container_name: pediatric-ai-scribe
networks:
- default
- danvics_mcp
- danvics_monitoring
- danvics_speech
healthcheck: healthcheck:
test: ["CMD", "wget", "--spider", "-q", "http://localhost:3000/api/health"] test: ["CMD", "wget", "--spider", "-q", "http://localhost:3000/api/health"]
interval: 30s interval: 30s
@ -46,7 +28,7 @@ services:
environment: environment:
POSTGRES_DB: pedscribe POSTGRES_DB: pedscribe
POSTGRES_USER: pedscribe POSTGRES_USER: pedscribe
POSTGRES_PASSWORD: ${DB_PASSWORD:-pedscribe} POSTGRES_PASSWORD: ${DB_PASSWORD:?set DB_PASSWORD}
volumes: volumes:
- pgdata:/var/lib/postgresql/data - pgdata:/var/lib/postgresql/data
restart: unless-stopped restart: unless-stopped
@ -58,34 +40,6 @@ services:
retries: 5 retries: 5
start_period: 10s start_period: 10s
redis:
image: redis:8-alpine
command: redis-server --appendonly yes
restart: unless-stopped
container_name: ped-ai-redis
volumes:
- redis-data:/data
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 10s
timeout: 5s
retries: 5
networks:
- default
- danvics_mcp
volumes: volumes:
pgdata: pgdata:
scribe-logs: scribe-logs:
redis-data:
clinical-assistant-mcp-data:
external: true
name: mcp-server_mcp-data
networks:
danvics_mcp:
external: true
danvics_monitoring:
external: true
danvics_speech:
external: true

View file

@ -1,79 +0,0 @@
#!/bin/sh
# Container entrypoint. Optionally fetches secrets from OpenBao before
# starting the app. Backwards compatible: if OPENBAO_ADDR is unset (e.g. e2e
# container, local dev with a populated .env), the vault step is skipped
# and the process starts with whatever's already in the environment.
#
# When OPENBAO_ADDR is set, OPENBAO_ROLE_ID + OPENBAO_SECRET_ID are required.
# The entrypoint logs in via AppRole, fetches kv/ped-ai/prod, exports each
# key as an env var, and then unsets the auth material before execing the
# real command so the Node process doesn't carry them.
set -eu
if [ -n "${OPENBAO_ADDR:-}" ]; then
if [ -z "${OPENBAO_ROLE_ID:-}" ] || [ -z "${OPENBAO_SECRET_ID:-}" ]; then
echo "[entrypoint] FATAL: OPENBAO_ADDR is set but OPENBAO_ROLE_ID or OPENBAO_SECRET_ID is missing." >&2
exit 1
fi
export BAO_ADDR="${OPENBAO_ADDR}"
echo "[entrypoint] authenticating to OpenBao at ${OPENBAO_ADDR} via AppRole..."
BAO_TOKEN="$(bao write -field=token auth/approle/login \
role_id="${OPENBAO_ROLE_ID}" \
secret_id="${OPENBAO_SECRET_ID}" 2>&1)"
if [ -z "${BAO_TOKEN}" ] || printf '%s' "${BAO_TOKEN}" | grep -qi error; then
echo "[entrypoint] FATAL: AppRole authentication failed:" >&2
echo "${BAO_TOKEN}" >&2
exit 1
fi
export BAO_TOKEN
SECRET_PATH="${OPENBAO_KV_PATH:-kv/ped-ai/prod}"
echo "[entrypoint] fetching secrets from ${SECRET_PATH}..."
SECRET_JSON="$(bao kv get -format=json "${SECRET_PATH}" 2>/dev/null | jq -c '.data.data' 2>/dev/null || true)"
if [ -z "${SECRET_JSON}" ] || [ "${SECRET_JSON}" = "null" ]; then
echo "[entrypoint] FATAL: no secrets returned from ${SECRET_PATH}." >&2
exit 1
fi
# Export each key/value as a shell-safe env var — but ONLY if the key
# isn't already set by docker (env_file / environment: block). This
# lets a docker-compose override win over the OpenBao value, which is
# needed for e2e (TURNSTILE_SECRET_KEY="" / SMTP_HOST="") and any
# environment-specific override.
#
# Pattern: write jq output to a temp file, then while-read in the main
# shell so exports persist (pipes into while run in a subshell and lose
# them). Pre-snapshot env keys and skip those already defined.
_PRESET_KEYS_FILE=$(mktemp)
env | cut -d= -f1 | sort -u > "$_PRESET_KEYS_FILE"
_SECRET_ASSIGNS=$(mktemp)
printf '%s' "${SECRET_JSON}" | jq -r 'to_entries[] | "\(.key)\t\(.value | @sh)"' > "$_SECRET_ASSIGNS"
_APPLIED_COUNT=0
_SKIPPED_COUNT=0
while IFS="$(printf '\t')" read -r _K _VAL_QUOTED; do
if [ -z "$_K" ]; then continue; fi
if grep -qxF "$_K" "$_PRESET_KEYS_FILE"; then
_SKIPPED_COUNT=$((_SKIPPED_COUNT + 1))
else
eval "export $_K=$_VAL_QUOTED"
_APPLIED_COUNT=$((_APPLIED_COUNT + 1))
fi
done < "$_SECRET_ASSIGNS"
rm -f "$_PRESET_KEYS_FILE" "$_SECRET_ASSIGNS"
echo "[entrypoint] applied ${_APPLIED_COUNT} secrets; ${_SKIPPED_COUNT} already set by docker (kept override)"
# Bootstrap credentials are no longer needed in the Node process env.
unset OPENBAO_ROLE_ID OPENBAO_SECRET_ID BAO_TOKEN
SECRET_COUNT="$(printf '%s' "${SECRET_JSON}" | jq -r 'keys | length')"
echo "[entrypoint] ✅ loaded ${SECRET_COUNT} secrets from OpenBao"
else
echo "[entrypoint] OPENBAO_ADDR not set — using existing environment (legacy .env path)"
fi
exec "$@"

View file

@ -1,90 +0,0 @@
# Architecture
This document is the current high-level map for Ped-AI. It is intentionally shorter and more operational than the older deep-dive files under `docs/logic/`.
## System Shape
Ped-AI is a self-hosted Express application with a browser frontend, PostgreSQL storage, Redis operational state, LiteLLM model routing, and optional MCP-backed clinical retrieval.
| Area | Owner | Notes |
|---|---|---|
| Web app | Ped-AI | Auth, UI, clinical workflows, admin settings, notes, Learning Hub, bedside tools |
| Database | PostgreSQL | Users, sessions, settings, saved app data, audit/API/access logs |
| Operational cache | Redis | Prompt suggestions, lightweight state, queue groundwork; not clinical answer caching |
| Model gateway | LiteLLM | Text, speech, image, embedding model discovery and routing |
| Clinical retrieval | MCP service | Nextcloud access, indexing, search, rerank, source metadata |
| Reverse proxy | Caddy or equivalent | TLS and public routing |
## Request Flow
Normal app request:
```txt
browser
-> reverse proxy
-> Express middleware
-> auth/session check when protected
-> route handler
-> PostgreSQL/Redis/provider calls as needed
-> JSON or HTML fragment response
```
Clinical Assistant request:
```txt
browser
-> Ped-AI clinical assistant route
-> MCP semantic search for indexed clinical sources
-> Ped-AI builds grounded answer prompt
-> LiteLLM chat model
-> Ped-AI returns answer plus source metadata
-> browser renders markdown, citations, and source cards
```
Ped-AI owns the user workflow and rendering. MCP owns retrieval and indexed source metadata. LiteLLM owns model routing.
## Runtime Boundaries
| Boundary | Main Risk | Current Direction |
|---|---|---|
| Browser to Ped-AI | XSS, stale shell, session handling | Sanitized rendering, httpOnly cookie for web, cache busting |
| Ped-AI to PostgreSQL | schema drift, slow queries | migrations, maintenance checks, indexes where needed |
| Ped-AI to Redis | unavailable operational state | Redis is useful but should not hold required clinical answers |
| Ped-AI to LiteLLM | provider downtime, wrong model mode | metadata-based model discovery and timeouts |
| Ped-AI to MCP | retrieval latency/failure | explicit MCP client layer and graceful fallback messages |
| MCP to Nextcloud | stale indexed metadata | scanner/indexer updates source metadata over time |
## Source Of Truth
| Data | Source Of Truth |
|---|---|
| User accounts and sessions | Ped-AI PostgreSQL |
| Admin app settings | Ped-AI PostgreSQL `app_settings` |
| Clinical source documents | Nextcloud and MCP index |
| Clinical source title/path shown to users | MCP result metadata, especially indexed `file_path` |
| Clinical answer text | Generated per request; intentionally not cached |
| Model availability | LiteLLM metadata and configured fallbacks |
## Deployment Shape
Production usually runs:
```txt
Caddy/TLS
-> pediatric-ai-scribe container
-> pedscribe-db container
-> ped-ai-redis container
-> LiteLLM endpoint
-> MCP endpoint
```
The app should stay private behind the reverse proxy. Do not expose PostgreSQL, Redis, MCP internals, or provider keys publicly.
## Design Principles
- Keep Ped-AI stateless enough to run more than one app container.
- Keep clinical answer generation live and source-grounded; do not cache final clinical answers.
- Prefer model capability metadata over model-name regexes.
- Prefer indexed file names and paths over embedded PDF metadata for source titles.
- Keep renderer fixes narrow and tested because LLM markdown is messy.
- Keep old frontend globals working until the affected feature is intentionally converted to ESM.

View file

@ -1,97 +0,0 @@
# Clinical Assistant
The Clinical Assistant is a retrieval-grounded assistant for pediatric clinical reference questions. It is not the same as the app's note-generation/HPI workflow.
## Responsibilities
| Component | Responsibility |
|---|---|
| Browser UI | question input, source display, markdown/citation rendering, export |
| Ped-AI backend | settings, MCP search call, answer prompt construction, model call |
| MCP server | Nextcloud access, indexing, vector search, rerank, source metadata |
| LiteLLM | model routing and provider abstraction |
## Request Flow
```txt
User asks a question
-> browser posts to Ped-AI
-> Ped-AI calls MCP `nc_semantic_search`
-> MCP returns source excerpts and metadata
-> Ped-AI builds an answer prompt with source constraints
-> LiteLLM model returns answer text
-> browser renders answer and source cards
```
## Source Rules
- Prefer MCP `file_path` basename for displayed source titles when present.
- Do not relabel one source as another requested source.
- If the user names a source and retrieval does not return it, say that before using other sources.
- Use citations only for returned source numbers.
- Unknown citation numbers should remain plain text instead of being guessed.
## Table And Markdown Rendering
LLM output is not guaranteed to be valid markdown. The browser renderer defensively handles common problems:
- adjacent citation clusters,
- missing closing bracket in narrow citation cases,
- smashed bullet lists,
- inline headings,
- malformed pipe tables,
- bare source numbers in source/citation table columns,
- orphan markdown emphasis markers,
- code blocks that must not be modified.
Renderer fixes must be narrow. Do not add broad repairs that turn arbitrary clinical numbers into citations.
## Image Routing
Table lookup requests should stay in retrieval flow.
Examples that should use retrieval:
```txt
show me the table
show me Table 13.1
summarize the developmental table
```
Explicit visual creation/display requests can use image flow.
Examples:
```txt
create an infographic
generate a diagram
show me the image/figure
```
## Caching Policy
Clinical answer response caching is intentionally disabled. Redis can support prompt suggestions and operational metadata, but final answers should be generated from current retrieval context.
## Settings
Important settings include:
| Setting | Purpose |
|---|---|
| `clinical_assistant.chat_model` | Chat model used for answers |
| `clinical_assistant.image_model` | Image model used for explicit image generation |
| `clinical_assistant.search_limit` | Number of MCP results requested |
| `clinical_assistant.context_chars` | Context characters requested from MCP |
| `clinical_assistant.system_behavior` | Admin-editable assistant behavior guidance |
## Testing Priorities
Add or update tests when changing:
- citation rendering,
- source title cleanup,
- named-source provenance behavior,
- table rendering,
- image intent routing,
- MCP result normalization,
- model discovery or settings behavior.

View file

@ -1,103 +0,0 @@
# Development
This is the practical guide for changing Ped-AI safely.
## Local Start
```bash
cp .env.example .env
docker compose up -d --build
curl -fsS http://127.0.0.1:3552/api/health
```
Run tests from the repository root:
```bash
npm test
```
Run a focused syntax check when touching backend entrypoints:
```bash
node --check server.js
node --check src/routes/clinicalAssistant.js
```
## Code Map
| Path | Purpose |
|---|---|
| `server.js` | Express entrypoint, middleware, static serving, route mounting |
| `src/routes/` | API route handlers |
| `src/utils/ai.js` | Text model routing through configured providers |
| `src/utils/clinicalAnswer.js` | Clinical Assistant answer prompt and source-grounding rules |
| `src/utils/clinicalRetrieval.js` | MCP result normalization and source title cleanup |
| `src/utils/clinicalMcpClient.js` | MCP streamable HTTP client/session handling |
| `src/utils/litellm.js` | LiteLLM API/admin header helpers |
| `src/db/database.js` | PostgreSQL pool and compatibility helpers |
| `public/js/app.js` | SPA shell, tab loading, shared browser actions |
| `public/js/admin.js` | Admin panel logic |
| `public/js/assistant/` | Clinical Assistant rendering, sources, images, export, API helpers |
| `public/js/learningHub/` | Newer modular Learning Hub frontend code |
| `test/` | Node test suite and frontend module regression tests |
## Change Workflow
1. Read the relevant route, utility, frontend module, and tests before editing.
2. Make the smallest correct change.
3. Add or update a regression test when changing clinical rendering, model routing, auth, settings, or source handling.
4. Run focused tests first if available.
5. Run `npm test` before deploy or commit.
6. Deploy with Docker only after tests pass.
7. Verify `/api/health` after deploy.
## Clinical Assistant Changes
Clinical Assistant changes should usually include tests because small rendering or prompt changes can affect clinical trust.
High-risk areas:
- citation linking,
- table rendering,
- source title cleanup,
- named-source provenance rules,
- image intent detection,
- MCP result normalization,
- provider/model selection.
When a real answer renders badly, save a de-identified example as a fixture or direct test input. Do not make broad global repairs that convert arbitrary numbers into citation links.
## Frontend Rendering Rules
Use `textContent` for plain text. Use `innerHTML` only for static templates, sanitized markdown, or HTML built entirely from escaped values.
Safe patterns:
```js
el.textContent = userText;
el.innerHTML = escapeHtml(userText).replace(/\n/g, '<br>');
el.innerHTML = sanitizeHtml(renderMarkdown(modelOutput));
```
Unsafe pattern:
```js
el.innerHTML = modelOutput;
```
If a dynamic value enters an HTML string, escape it at the point of insertion. If it is an attribute value, escape quotes too.
## Deployment Checks
After deployment:
```bash
curl -fsS http://127.0.0.1:3552/api/health
docker compose ps pediatric-scribe
```
If the browser still shows old frontend behavior, force-refresh or check the injected `BUILD_ID` asset query string.
## Documentation Expectations
Keep docs close to operational truth. If a behavior changes, update the most specific doc in the same change. Prefer short, current docs over long historical explanations.

View file

@ -1,88 +0,0 @@
# Module Conventions
Ped-AI currently uses mixed JavaScript module styles. This is intentional during incremental modernization.
## Current Convention
| Area | Module Style | Notes |
|---|---|---|
| Backend `server.js`, `src/**` | CommonJS | Use `require` and `module.exports` for now |
| New frontend modules | ESM | Use `import` and `export` |
| Older frontend files | Classic browser globals | Convert only when touching the feature intentionally |
| Dual browser/test files | Case-by-case | Keep classic style only when tests or browser globals require it |
Do not add root-level `"type": "module"` without a full backend migration plan. It would change how every `.js` file is interpreted by Node.
## CommonJS Example
```js
var express = require('express');
var router = express.Router();
module.exports = router;
```
## ESM Example
```js
import { escapeHtml } from './assistant/citations.js';
export function renderSourcesList(sources) {
return '';
}
```
## Frontend Modernization Path
1. New frontend code should be ESM where possible.
2. Existing globals can remain until that feature is refactored.
3. Keep browser script load order stable while refactoring.
4. Export pure helper functions so Node tests can import them.
5. Use `CustomEvent` or explicit imports instead of adding new global APIs when practical.
## Acceptable Globals
Globals are acceptable when they are part of the current shell contract.
Examples:
- `window.activateTab`,
- `window.getAuthHeaders`,
- shared UI helpers still consumed by legacy feature files.
Do not add new globals when an import or event would be clearer.
## Rendering And `innerHTML`
`innerHTML` is allowed only when one of these is true:
- the HTML is a static template controlled by the app,
- all dynamic values are escaped before insertion,
- the HTML has passed through the approved sanitizer,
- the content is a trusted app component fetched from `public/components/`.
Prefer `textContent` for plain text.
Unsafe:
```js
el.innerHTML = userText;
el.innerHTML = modelOutput;
```
Safer:
```js
el.textContent = userText;
el.innerHTML = escapeHtml(userText).replace(/\n/g, '<br>');
el.innerHTML = sanitizeHtml(renderMarkdown(modelOutput));
```
## Test Expectations
When converting a frontend file to ESM, add or update tests for:
- exported helper functions,
- expected globals still present if legacy code needs them,
- no browser-native `prompt`, `alert`, or `confirm`,
- no unescaped dynamic text inserted through `innerHTML`.

View file

@ -1,119 +0,0 @@
# Scaling
This document describes how Ped-AI should scale without becoming harder to debug or maintain.
## Current Scaling Model
Ped-AI is currently a single app container backed by PostgreSQL and Redis. That is acceptable for self-hosted use, but the code should keep moving toward a shape where multiple app containers can run safely.
```txt
reverse proxy
-> pediatric-ai-scribe replica 1
-> pediatric-ai-scribe replica 2
-> shared PostgreSQL
-> shared Redis
-> LiteLLM
-> MCP
```
## Horizontal Scaling Requirements
| Requirement | Why It Matters |
|---|---|
| Session state in PostgreSQL/Redis | Any app replica can handle the next request |
| No clinical state only in memory | Restarting or scaling containers should not lose required state |
| Shared uploads/storage if files grow | Local container disk does not scale across replicas |
| Idempotent migrations | Deploying more than one app container should not corrupt schema state |
| Request timeouts | Slow providers should not exhaust Node workers |
| Queue for slow jobs | Long work should not block interactive requests |
| Readiness endpoint | Load balancer should only send traffic to ready replicas |
## What Can Stay In Memory
Small process-local caches are acceptable when they are optional and short-lived.
Examples:
- settings cache with short TTL,
- provider model metadata cache,
- static configuration derived at boot.
Do not store required user workflow state only in memory if the action must survive restart or run across replicas.
## Redis Use
Redis is appropriate for:
- prompt suggestion pools,
- rate-limit coordination if needed,
- queues and job status,
- short-lived provider metadata,
- operational locks.
Redis should not be used for final clinical answer response caching. Clinical answers should be generated live from current retrieval context.
## Queue Candidates
Consider moving these to a queue when latency or concurrency becomes a problem:
- long transcription jobs,
- file import/export,
- Learning Hub AI generation from large files,
- image generation,
- bulk document operations,
- provider metadata refresh,
- long-running admin maintenance actions.
BullMQ with Redis is a natural fit if a queue is added.
## Readiness And Health
Keep `/api/health` fast and simple for liveness.
Add a separate readiness endpoint when scaling:
```txt
GET /api/ready
```
It should check:
- PostgreSQL query works,
- Redis ping works if Redis is required for this deployment,
- core settings can be read,
- MCP health is reachable if Clinical Assistant is enabled,
- LiteLLM metadata or configured model endpoint is reachable if AI features are enabled.
## Database Scaling
Priorities:
- confirm indexes on hot user/session/settings/log tables,
- keep migrations explicit and reversible where practical,
- monitor slow queries,
- cap admin log queries with safe limits,
- keep audit/log writes batched where possible,
- avoid long transactions around provider calls.
## Provider Scaling
LiteLLM and MCP can become the bottlenecks before Ped-AI does.
Track:
- LiteLLM request latency,
- LiteLLM error rate by model,
- MCP search latency,
- MCP timeout/error rate,
- queue depth if async jobs are added,
- Postgres connections,
- app container memory and event-loop delay.
## Scaling Order
1. Add request IDs across browser, Ped-AI, MCP, and LiteLLM calls.
2. Add `/api/ready` for dependency readiness.
3. Ensure sessions and settings are not process-local.
4. Add a queue for slow jobs if interactive requests block.
5. Run a second app replica behind the reverse proxy in a staging/test environment.
6. Add metrics and alerts around latency, errors, and resource saturation.

View file

@ -1,18 +1,13 @@
# AI providers # AI providers
All AI calls flow through `callAI(messages, options)` in `src/utils/ai.js`. All AI calls flow through `callAI(messages, options)` in `src/utils/ai.js`.
Provider is selected at startup and is transparent to route handlers. Provider is selected once at startup and is transparent to callers.
## Provider selection ## Provider selection
1. If `AI_PROVIDER` is set, it chooses `bedrock`, `azure`, `vertex`, 1. If `AI_PROVIDER` env var is set, use it.
`litellm`, or `openrouter` explicitly. 2. Otherwise, check credentials in priority order:
2. If `AI_PROVIDER` is unset, `ai.js` initializes every configured client and `bedrock > azure > vertex > litellm > openrouter`.
the last configured non-OpenRouter provider wins in current load order:
Bedrock → Azure → Vertex → LiteLLM. If none of those are configured,
OpenRouter is the default.
3. If the selected provider cannot initialize, the code falls back to
OpenRouter and surfaces an error if `OPENROUTER_API_KEY` is missing.
## Providers ## Providers
@ -20,7 +15,7 @@ Provider is selected at startup and is transparent to route handlers.
- SDK: `@aws-sdk/client-bedrock-runtime`. - SDK: `@aws-sdk/client-bedrock-runtime`.
- Uses Bedrock **inference profiles** for newer models (cross-region routing). - Uses Bedrock **inference profiles** for newer models (cross-region routing).
- Model families: Amazon Nova, Llama (Meta), Mistral, DeepSeek, Cohere, and other Bedrock-hosted families. - Model families: vendor model (Anthropic), Amazon Nova, Llama (Meta), Mistral, DeepSeek, Cohere.
### Azure OpenAI (BAA-eligible) ### Azure OpenAI (BAA-eligible)
@ -32,7 +27,7 @@ Provider is selected at startup and is transparent to route handlers.
- SDK: `@google-cloud/vertexai`. - SDK: `@google-cloud/vertexai`.
- Also serves STT (Gemini inline audio) and TTS (Vertex TTS endpoint). - Also serves STT (Gemini inline audio) and TTS (Vertex TTS endpoint).
- Families: Gemini 2.5 / 2.0 and Llama. - Families: Gemini 2.5 / 2.0, vendor model on Vertex (Anthropic via GCP), Llama.
### LiteLLM proxy (self-hosted) ### LiteLLM proxy (self-hosted)
@ -129,11 +124,9 @@ Applied to: `soap.js`, `hpi.js`, `refine.js`, `sickVisit.js`, `wellVisit.js`,
### Physician memories ### Physician memories
Saved templates and prompt preferences are injected into prompts as Saved corrections are injected into prompts as `[STYLE HINTS (low priority)]`
`[STYLE HINTS (low priority)]` when they belong to AI-context categories. The with 200-character snippets. The low-priority wording prevents smaller models
low-priority wording prevents smaller models from hallucinating content from a from hallucinating content from the correction examples into the current note.
stored template into the current note. `custom` memories and legacy
`correction_*` rows are not prompt context.
## API call logging ## API call logging

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,7 @@
# Architecture # Architecture
Self-hosted clinical documentation platform. Dockerized Node.js server, PostgreSQL, Redis, and vanilla-JS SPA. No build step on the frontend. Self-hosted, single-tenant clinical documentation platform. Dockerized Node.js
server + PostgreSQL + vanilla-JS SPA. No build step on the frontend.
## Stack ## Stack
@ -8,11 +9,9 @@ Self-hosted clinical documentation platform. Dockerized Node.js server, PostgreS
|---|---| |---|---|
| Runtime | Node.js 20 (Alpine) + Express 4 | | Runtime | Node.js 20 (Alpine) + Express 4 |
| Database | PostgreSQL 16 with `pgvector` extension | | Database | PostgreSQL 16 with `pgvector` extension |
| Cache / state | Redis for operational cache, prompt suggestions, and queue groundwork |
| Frontend | Vanilla JavaScript SPA, service-worker cache | | Frontend | Vanilla JavaScript SPA, service-worker cache |
| Mobile | Capacitor 6 wrapper (Android + iOS) | | Mobile | Capacitor 6 wrapper (Android + iOS) |
| Container | Docker Compose (app + db + Redis) | | Container | Docker Compose (app + db) |
| Observability | Prometheus metrics at `/metrics`; structured app logs in files, Postgres, and optional Loki |
| Reverse proxy | External (Caddy, Nginx, Traefik — any) | | Reverse proxy | External (Caddy, Nginx, Traefik — any) |
## Repository layout ## Repository layout
@ -48,9 +47,9 @@ src/
logger.js # audit/api/access + Loki shipper logger.js # audit/api/access + Loki shipper
errors.js # generic 500 responder errors.js # generic 500 responder
models.js, prompts.js, ai.js # AI provider + model + prompt management models.js, prompts.js, ai.js # AI provider + model + prompt management
embeddings.js # LiteLLM embeddings embeddings.js # Vertex / LiteLLM / OpenAI embeddings
transcribe.js, tts.js # LiteLLM STT / TTS routes transcribe*.js, tts*.js # STT / TTS provider clients
routes/ # Express routers (auth, hpi, soap, patient education, …) routes/ # 27 Express routers (auth, hpi, soap, …)
public/ # SPA public/ # SPA
index.html # shell, loads components on demand index.html # shell, loads components on demand
@ -58,19 +57,16 @@ public/ # SPA
js/ # 24 vanilla JS modules js/ # 24 vanilla JS modules
components/ # per-tab HTML fragments components/ # per-tab HTML fragments
css/styles.css css/styles.css
models/ # bundled Whisper WASM + model files
mobile/ # Capacitor wrapper mobile/ # Capacitor wrapper
capacitor.config.json # appId com.pedshub.scribe capacitor.config.json # appId com.pedshub.scribe
src/ # launcher (server-URL picker) src/ # launcher (server-URL picker)
android/ # generated AS project + native Java android/ # generated AS project + native Java
.forgejo/workflows/
android-apk.yml # signed APK on tag push; optional Play upload
docker-build.yml # Forgejo registry Docker image build
.github/workflows/ .github/workflows/
auto-version.yml # conventional-commits → semver bump → tag auto-version.yml # conventional-commits → semver bump → tag
android-release.yml # legacy GitHub tag APK release path android-release.yml # signed APK on tag push
docker-publish.yml # multi-arch image on tag push docker-publish.yml # multi-arch image on tag push
version-bump.yml # manual dispatch override version-bump.yml # manual dispatch override
build-apk.yml # legacy TWA APK build-apk.yml # legacy TWA APK
@ -86,7 +82,7 @@ request
→ express.json (10 MB cap) → express.json (10 MB cap)
→ rate limiters (general 200 req/min, per-endpoint tighter on auth) → rate limiters (general 200 req/min, per-endpoint tighter on auth)
→ static (public/ with no-cache on HTML, 1h on JS/CSS; ?v=BUILD_ID busts cache per deploy) → static (public/ with no-cache on HTML, 1h on JS/CSS; ?v=BUILD_ID busts cache per deploy)
→ route (feature routers under /api/*) → route (27 routers under /api/*)
→ authMiddleware (on protected routes: JWT, DB session check, 24h idle, last_activity update) → authMiddleware (on protected routes: JWT, DB session check, 24h idle, last_activity update)
→ handler → handler
→ response → response
@ -125,12 +121,6 @@ per-feature HTML fragments under `public/components/` fetched on demand. JS
modules talk via `window` globals and `CustomEvent` on `document` — no modules talk via `window` globals and `CustomEvent` on `document` — no
bundler, no framework. Loader order is fixed in `index.html`. bundler, no framework. Loader order is fixed in `index.html`.
Post-note helpers such as billing suggestions, don't-miss review, and patient
education handouts are reusable browser-side actions backed by authenticated
JSON APIs. The patient education helper generates a parent-facing plain-text
draft from the edited note and keeps the clinician in the review loop before
copying or sharing.
`authFetch.js` installs a global `fetch` interceptor that treats any 401 on an `authFetch.js` installs a global `fetch` interceptor that treats any 401 on an
authenticated request as a signal to clear local session state and redirect to authenticated request as a signal to clear local session state and redirect to
login. A `BroadcastChannel('pedscribe-auth')` pushes that signal to sibling login. A `BroadcastChannel('pedscribe-auth')` pushes that signal to sibling
@ -142,9 +132,8 @@ tabs so logging out in one tab drops UI in every open tab.
|---|---|---|---| |---|---|---|---|
| `pediatric-ai-scribe` | `ped-ai-local:latest` (built from repo) | 3000 | 127.0.0.1:3552 | | `pediatric-ai-scribe` | `ped-ai-local:latest` (built from repo) | 3000 | 127.0.0.1:3552 |
| `pedscribe-db` | `pgvector/pgvector:pg16` | 5432 | not exposed | | `pedscribe-db` | `pgvector/pgvector:pg16` | 5432 | not exposed |
| `ped-ai-redis` | Redis | 6379 | not exposed |
Named volumes: `pgdata` (database), `scribe-logs` (filesystem audit logs), and Redis data if persistence is enabled by compose. Named volumes: `pgdata` (database), `scribe-logs` (filesystem audit logs).
Application health-check polls `GET /api/health`. Application health-check polls `GET /api/health`.
A reverse proxy terminates TLS and forwards to `127.0.0.1:3552`. The app is A reverse proxy terminates TLS and forwards to `127.0.0.1:3552`. The app is
@ -160,11 +149,3 @@ never bound to a public interface directly.
Precached on install: `index.html`, core JS, main stylesheet, login component. Precached on install: `index.html`, core JS, main stylesheet, login component.
Cleared on logout (`caches.keys() → caches.delete()`). Cleared on logout (`caches.keys() → caches.delete()`).
## Clinical Assistant And MCP
The clinical assistant can call an external MCP-backed retrieval service. Ped-AI remains responsible for the user workflow, provider selection, prompts, and display. MCP remains responsible for Nextcloud access, indexing, retrieval, and vector search. Clinical answer response caching is intentionally disabled; Redis is used for operational metadata and prompt suggestions, not answer reuse.
## Speech
Browser Whisper and browser-local Whisper model downloads are removed from runtime. Speech-to-text routes through LiteLLM; upstream provider choice belongs in LiteLLM config. Browser-native Web Speech remains available only when explicitly enabled by user settings and browser support.

View file

@ -123,23 +123,9 @@ necessary UX tradeoff over perfect indistinguishability.
## Turnstile (Cloudflare bot protection) ## Turnstile (Cloudflare bot protection)
Applied to `/api/auth/register` and `/api/auth/forgot-password` when Applied to `/api/auth/login`, `/register`, `/forgot-password` when
`TURNSTILE_SECRET_KEY` is set. No-op when unset (dev mode). `TURNSTILE_SECRET_KEY` is set. No-op when unset (dev mode).
`/api/auth/login` is deliberately **not** gated: the widget could not
reliably complete a challenge inside the Capacitor WebView, which locked
mobile users out of the app. Login is covered instead by its per-IP rate
limit (10 / 15 min), the constant-time credential check, and TOTP 2FA.
The two remaining widgets are rendered explicitly (`api.js?render=explicit`)
the first time their form becomes visible — Turnstile does not reliably
complete a challenge inside a `display:none` container, and both forms start
hidden. Tokens are captured from the render callback, not read back out of
the injected `[name="cf-turnstile-response"]` input.
Note that the site key is currently **hardcoded** in `public/index.html`.
`TURNSTILE_SITE_KEY` exists in OpenBao but is not read by any code.
## Encryption at rest ## Encryption at rest
`src/utils/crypto.js` provides AES-256-GCM helpers. Key loaded from `src/utils/crypto.js` provides AES-256-GCM helpers. Key loaded from
@ -160,7 +146,7 @@ Helmet defaults plus:
- `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` - `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload`
- Content-Security-Policy: - Content-Security-Policy:
- `script-src 'self' 'wasm-unsafe-eval' 'unsafe-eval' cdn.jsdelivr.net cdnjs.cloudflare.com challenges.cloudflare.com` - `script-src 'self' 'wasm-unsafe-eval' 'unsafe-eval' cdn.jsdelivr.net cdnjs.cloudflare.com challenges.cloudflare.com`
(do not add `unsafe-eval` unless a reviewed dependency requires it) (`unsafe-eval` is required by @xenova/transformers for in-browser Whisper)
- `script-src-attr 'none'` (blocks inline event handlers) - `script-src-attr 'none'` (blocks inline event handlers)
- `frame-src 'self' challenges.cloudflare.com` - `frame-src 'self' challenges.cloudflare.com`
- `object-src 'none'` - `object-src 'none'`

View file

@ -29,33 +29,39 @@ keys):
| Variable | Purpose | | Variable | Purpose |
|---|---| |---|---|
| `AI_PROVIDER` | `openrouter` / `bedrock` / `azure` / `vertex` / `litellm`. If unset, the startup loader uses configured credentials and the last initialized provider in Bedrock → Azure → Vertex → LiteLLM order wins; otherwise OpenRouter is the default. | | `AI_PROVIDER` | `openrouter` / `bedrock` / `azure` / `vertex` / `litellm`. Auto-detected by credential presence if unset. |
| `OPENROUTER_API_KEY` | OpenRouter key (not HIPAA-eligible). | | `OPENROUTER_API_KEY` | OpenRouter key (not HIPAA-eligible). |
| `AWS_BEDROCK_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` | Bedrock chat provider. | | `AWS_BEDROCK_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` | Bedrock / Transcribe / Transcribe-Medical. |
| `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_API_KEY`, `AZURE_DEPLOYMENT_NAME`, `AZURE_OPENAI_API_VERSION` | Azure OpenAI. | | `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_API_KEY`, `AZURE_DEPLOYMENT_NAME`, `AZURE_OPENAI_API_VERSION` | Azure OpenAI. |
| `GOOGLE_VERTEX_PROJECT`, `GOOGLE_VERTEX_LOCATION`, `GOOGLE_APPLICATION_CREDENTIALS` | Vertex AI chat provider. | | `GOOGLE_VERTEX_PROJECT`, `GOOGLE_VERTEX_LOCATION`, `GOOGLE_APPLICATION_CREDENTIALS` | Vertex AI + Gemini (STT/TTS). |
| `LITELLM_API_BASE`, `LITELLM_API_KEY` | OpenAI-compatible AI gateway (Bifrost, LiteLLM, or similar). | | `LITELLM_API_BASE`, `LITELLM_API_KEY` | OpenAI-compatible AI gateway (Bifrost, LiteLLM, or similar). |
### Speech-to-text ### Speech-to-text
| Variable | Purpose | | Variable | Purpose |
|---|---| |---|---|
| `TRANSCRIBE_PROVIDER` | Use `litellm`; auto mode uses LiteLLM when configured. | | `TRANSCRIBE_PROVIDER` | `google`, `aws`, `local`, `openai`, `litellm`. Auto-detects if unset. |
| `OPENAI_API_KEY` | OpenAI Whisper. |
| `GOOGLE_STT_MODEL` | Gemini model used as STT (default `gemini-2.0-flash`). |
| `AWS_TRANSCRIBE_MEDICAL` | `true` enables Transcribe Medical. |
| `AWS_TRANSCRIBE_SPECIALTY` | `PRIMARYCARE` / `CARDIOLOGY` / `NEUROLOGY` / `ONCOLOGY` / `RADIOLOGY` / `UROLOGY`. |
| `WHISPER_BINARY`, `WHISPER_MODEL_SIZE`, `WHISPER_MODEL_PATH`, `WHISPER_LANGUAGE`, `WHISPER_THREADS` | Local whisper.cpp / faster-whisper. |
| `LITELLM_STT_MODEL` | Model name for LiteLLM-routed STT. | | `LITELLM_STT_MODEL` | Model name for LiteLLM-routed STT. |
### Text-to-speech ### Text-to-speech
| Variable | Purpose | | Variable | Purpose |
|---|---| |---|---|
| `LITELLM_TTS_MODEL`, `LITELLM_TTS_VOICE` | LiteLLM-routed TTS model and default voice. | | `GOOGLE_TTS_VOICE` | Google Cloud TTS voice (e.g. `en-US-Journey-F`). |
| `LITELLM_TTS_VOICES` | Comma-separated LiteLLM-compatible voices exposed in voice search and user preferences. | | `ELEVENLABS_API_KEY` | ElevenLabs (not HIPAA-compliant). |
| `LITELLM_TTS_MODEL`, `LITELLM_TTS_VOICE` | LiteLLM-routed TTS. |
### Embeddings ### Embeddings
| Variable | Purpose | | Variable | Purpose |
|---|---| |---|---|
| `EMBEDDING_MODEL` | LiteLLM embedding model name (default `openai-text-embedding-3-large`). | | `EMBEDDING_MODEL` | Embedding model name (default `text-embedding-005`, Vertex). |
| `EMBEDDING_DIMENSIONS` | Vector dimensions (default 3072). | | `EMBEDDING_DIMENSIONS` | Vector dimensions (default 768). |
### Email (SMTP) ### Email (SMTP)
@ -172,8 +178,8 @@ OpenAI-compatible gateway — LiteLLM, Bifrost, or other proxies.
3. **Update model names** — Different gateways use different naming 3. **Update model names** — Different gateways use different naming
conventions. Bifrost requires `provider/model` format conventions. Bifrost requires `provider/model` format
(e.g., `openrouter/gpt-4.1`), while LiteLLM can use deployment aliases (e.g., `openrouter/vendor-model-sonnet-4.6`), while LiteLLM uses aliases
(e.g., `openrouter-gpt-4.1`). Update model names in: (e.g., `openrouter-vendor-model-sonnet-4.6`). Update model names in:
- Admin Panel → Models (chat models) - Admin Panel → Models (chat models)
- Admin Panel → Settings → `stt.model` (speech-to-text) - Admin Panel → Settings → `stt.model` (speech-to-text)
- Admin Panel → Settings → `tts.model` (text-to-speech) - Admin Panel → Settings → `tts.model` (text-to-speech)

View file

@ -138,23 +138,20 @@ Draft/complete encounter workspace. Auto-expires (default 7 d,
### `user_memories` ### `user_memories`
Per-user template and preference rows. Only selected categories are injected Per-user clinical-style hints injected into AI prompts.
into AI generation through `/api/memories/context`; `custom` rows are stored
for the user but not included in prompt context.
| Column | Type | Notes | | Column | Type | Notes |
|---|---|---| |---|---|---|
| id | SERIAL PK | | | id | SERIAL PK | |
| user_id | INTEGER FK users.id ON DELETE CASCADE | | | user_id | INTEGER FK users.id ON DELETE CASCADE | |
| category | TEXT NOT NULL DEFAULT 'custom' | Valid categories: `physical_exam`, `ros`, `encounter_format`, `family_history`, `assessment_plan`, `custom`, `template_soap`, `template_hpi`, `template_wellvisit`, `template_sickvisit`, `template_ed`. Legacy `correction_*` rows may exist but are filtered out. | | category | TEXT NOT NULL DEFAULT 'custom' | `physical_exam`, `ros`, `encounter_format`, `custom`, `template_*`, `correction_*` |
| name | TEXT NOT NULL | Encrypted with `enc1:` for new rows | | name | TEXT NOT NULL | |
| content | TEXT NOT NULL | Encrypted with `enc1:` for new rows | | content | TEXT NOT NULL | |
| created_at, updated_at | TIMESTAMPTZ DEFAULT NOW() | | | created_at, updated_at | TIMESTAMPTZ DEFAULT NOW() | |
### `audio_backups` ### `audio_backups`
Optional 24-hour encrypted recovery store for recordings when transcription Retry store for failed-transcription audio.
fails, so users can retry without re-recording.
| Column | Type | Notes | | Column | Type | Notes |
|---|---|---| |---|---|---|

View file

@ -10,9 +10,8 @@
| Image | Role | | Image | Role |
|---|---| |---|---|
| `danielonyejesi/pediatric-ai-scribe-v3:latest` | App container. Published by CI on every tag push where configured. Pull directly or build from source. | | `danielonyejesi/pediatric-ai-scribe-v3:latest` | App container. Published by CI on every tag push (multi-arch: `linux/amd64` + `linux/arm64`). Pull directly or build from source. |
| `pgvector/pgvector:pg16` | Database. | | `pgvector/pgvector:pg16` | Database. |
| `redis:7-alpine` | Operational Redis cache/state. |
## Build from source ## Build from source
@ -24,7 +23,8 @@ cp .env.example .env
docker compose up -d --build docker compose up -d --build
``` ```
The default compose starts `pediatric-ai-scribe` on `127.0.0.1:3552`, `pedscribe-db` internally, and `ped-ai-redis` internally. Two containers come up: `pediatric-ai-scribe` on `127.0.0.1:3552`, `pedscribe-db`
internal only.
## Minimum `.env` ## Minimum `.env`
@ -80,7 +80,7 @@ App sets `trust proxy: 1` so rate limiting uses the original client IP.
| Volume | Contents | Backup priority | | Volume | Contents | Backup priority |
|---|---|---| |---|---|---|
| `pgdata` | All user data, encounters, memories, audit logs, settings, embeddings | Critical | | `pgdata` | All user data, encounters, memories, audit logs, settings, embeddings | Critical |
| `scribe-logs` | Filesystem audit log files (JSONL by day) | High for compliance evidence; Postgres also has audit/API/access tables | | `scribe-logs` | Filesystem audit log files (JSONL by day) | Low — Postgres also has these in `audit_log` table |
### Postgres backup / restore ### Postgres backup / restore
@ -120,7 +120,6 @@ REINDEXes if the ICU library version changed between image builds.
| `GET /api/health` | `{ok:true}` — public, used by Docker health check | | `GET /api/health` | `{ok:true}` — public, used by Docker health check |
| `GET /api/health/detailed` | Provider status — admin-auth required | | `GET /api/health/detailed` | Provider status — admin-auth required |
| `GET /api/build` | Build ID (short git SHA) — useful for debugging cache invalidation | | `GET /api/build` | Build ID (short git SHA) — useful for debugging cache invalidation |
| `GET /metrics` | Prometheus metrics in text exposition format |
Docker health check in `Dockerfile`: every 30 s, wget-spiders `/api/health`. Docker health check in `Dockerfile`: every 30 s, wget-spiders `/api/health`.
Container marked unhealthy after 5 failures. Container marked unhealthy after 5 failures.
@ -128,7 +127,7 @@ Container marked unhealthy after 5 failures.
## Resource footprint ## Resource footprint
- RAM: 256 MB minimum, 512 MB recommended for one instance with a handful of concurrent users. - RAM: 256 MB minimum, 512 MB recommended for one instance with a handful of concurrent users.
- Disk: Postgres size scales with audit log retention, saved encounters, documents, and Learning Hub content. - Disk: ~220 MB image (self-hosted Whisper WASM included). Postgres size scales with audit log retention.
- CPU: idle load negligible; AI calls are network-bound on the LLM provider side. - CPU: idle load negligible; AI calls are network-bound on the LLM provider side.
## Production checklist ## Production checklist
@ -142,15 +141,14 @@ Container marked unhealthy after 5 failures.
- Turnstile keys set for public-facing deployments - Turnstile keys set for public-facing deployments
- Reverse proxy serves valid TLS certs - Reverse proxy serves valid TLS certs
- Postgres dump scheduled off-host - Postgres dump scheduled off-host
- Log retention and backup policy covers `audit_log`, `api_log`, `access_log`, and filesystem `scribe-logs`
## CI / CD ## CI / CD
On push (and tag push), these workflows run (depending on runner/site): Four workflows fire on tag push:
| Workflow | Output | Runtime | | Workflow | Output | Runtime |
|---|---|---| |---|---|---|
| `.forgejo/workflows/android-apk.yml` | Signed APK attached to the Forgejo release, plus optional Google Play internal track upload | ~8 min | | `android-release.yml` | Signed APK attached to the GitHub release | ~8 min |
| `docker-publish.yml` | Multi-arch image (amd64 + arm64 via native runners) on Docker Hub | ~4 min | | `docker-publish.yml` | Multi-arch image (amd64 + arm64 via native runners) on Docker Hub | ~4 min |
| `build-apk.yml` | Legacy TWA APK (optional second artifact) | ~2 min | | `build-apk.yml` | Legacy TWA APK (optional second artifact) | ~2 min |
@ -164,7 +162,6 @@ Triggered by `auto-version.yml` (reads commit messages, bumps + tags via
|---|---|---| |---|---|---|
| App | 3000 | 127.0.0.1:3552 | | App | 3000 | 127.0.0.1:3552 |
| Postgres | 5432 | not exposed | | Postgres | 5432 | not exposed |
| Redis | 6379 | not exposed |
Change the app's external port by editing the `ports:` mapping in Change the app's external port by editing the `ports:` mapping in
`docker-compose.yml`. `docker-compose.yml`.
@ -177,8 +174,6 @@ Change the app's external port by editing the `ports:` mapping in
via `src/utils/auditQueue.js`, drained on SIGTERM. via `src/utils/auditQueue.js`, drained on SIGTERM.
4. Loki (if `LOKI_URL` set) — pushed fire-and-forget per event. 4. Loki (if `LOKI_URL` set) — pushed fire-and-forget per event.
A central Prometheus/Loki/Grafana stack can also scrape `GET /metrics` and collect Docker logs with Promtail. Keep direct Loki push enabled only for structured application events that are useful for compliance and operations.
## Auto-cleanup ## Auto-cleanup
| Target | Policy | Frequency | | Target | Policy | Frequency |

View file

@ -37,10 +37,10 @@ src/
fileType.js magic-byte upload verifier fileType.js magic-byte upload verifier
errors.js generic 500 responder errors.js generic 500 responder
logger.js audit + api + access + Loki shipper logger.js audit + api + access + Loki shipper
embeddings.js LiteLLM embeddings embeddings.js Vertex / LiteLLM / OpenAI embeddings
notify.js ntfy push notify.js ntfy push
transcribe.js, tts.js LiteLLM STT / TTS routes transcribe*.js, tts*.js STT / TTS provider clients
routes/ Express routers for auth, AI workflows, education, logs, and user data routes/ 27 routers
public/ public/
index.html SPA shell, version-stamped asset refs index.html SPA shell, version-stamped asset refs
@ -49,7 +49,7 @@ public/
js/ 24 vanilla JS modules (no bundler) js/ 24 vanilla JS modules (no bundler)
components/ per-tab HTML fragments loaded on demand components/ per-tab HTML fragments loaded on demand
css/styles.css css/styles.css
template-guide.md downloadable user template guide models/ bundled Whisper WASM
mobile/ Capacitor 6 wrapper (Android + iOS) mobile/ Capacitor 6 wrapper (Android + iOS)
.github/workflows/ CI (auto-version, APK, docker) .github/workflows/ CI (auto-version, APK, docker)
@ -243,19 +243,24 @@ docker exec -w /app pediatric-ai-scribe npm run migrate:new -- add_my_table
3. Admin-editable automatically through `PUT /api/admin/config` which accepts 3. Admin-editable automatically through `PUT /api/admin/config` which accepts
arbitrary keys. arbitrary keys.
## Physician Templates And Preferences ## Physician memory / correction tracker
1. Settings saves user templates/preferences through `/api/memories` into 1. On note generation, `trackAIOutput(elementId, text)` captures the original
`user_memories`. output in memory.
2. New rows encrypt `name` and `content` with the shared `enc1:` string format. 2. User edits the note in a contenteditable field.
3. `GET /api/memories/context` decrypts rows and returns only AI-context 3. On Save, `saveCorrection(elementId, section)` diffs current vs. original.
categories: `physical_exam`, `ros`, `encounter_format`, `family_history`, 4. If changed by > 2 words or > 20 characters, `POST /api/memories/correction`
`assessment_plan`, `template_soap`, `template_hpi`, `template_wellvisit`, stores the before/after in `user_memories` with category
`template_sickvisit`, and `template_ed`. `correction_{section}`.
4. `custom` rows remain visible in settings but are not included in prompt 5. Next generation: `GET /api/memories/context` fetches the 10 most recent per
context. category and `src/utils/prompts.js` injects them as
5. Legacy `correction_*` rows from the removed correction-learning feature are `[STYLE HINTS (low priority)]` 200-character snippets.
filtered out rather than deleted.
Tabs with correction capture: Live Encounter, SOAP, Dictation, Sick Visit,
Well Visit (Hospital Course and Chart Review save corrections when available
but don't always have a trackable single output element).
Maximum 20 corrections retained per category (oldest deleted).
## Route reference ## Route reference
@ -272,10 +277,10 @@ docker exec -w /app pediatric-ai-scribe npm run migrate:new -- add_my_table
| `sickVisit.js` | `/api` | Auth | Sick visit | | `sickVisit.js` | `/api` | Auth | Sick visit |
| `milestones.js` | `/api` | Auth | Developmental milestone narratives | | `milestones.js` | `/api` | Auth | Developmental milestone narratives |
| `refine.js` | `/api` | Auth | Refine / shorten / clarify | | `refine.js` | `/api` | Auth | Refine / shorten / clarify |
| `transcribe.js` | `/api` | Auth | LiteLLM STT | | `transcribe.js` | `/api` | Auth | STT (5 providers) |
| `tts.js` | `/api` | Auth | LiteLLM TTS | | `tts.js` | `/api` | Auth | TTS (3 providers) |
| `encounters.js` | `/api` | Auth | Save / load / optimistic-lock encounters | | `encounters.js` | `/api` | Auth | Save / load / optimistic-lock encounters |
| `memories.js` | `/api` | Auth | Templates + prompt preferences | | `memories.js` | `/api` | Auth | Templates + corrections |
| `audioBackups.js` | `/api` | Auth | Encrypted audio retry store | | `audioBackups.js` | `/api` | Auth | Encrypted audio retry store |
| `documents.js` | `/api` | Auth | S3 documents (magic-byte checked) | | `documents.js` | `/api` | Auth | S3 documents (magic-byte checked) |
| `userPreferences.js` | `/api` | Auth | Per-user STT/TTS choice | | `userPreferences.js` | `/api` | Auth | Per-user STT/TTS choice |
@ -302,8 +307,10 @@ docker exec -w /app pediatric-ai-scribe npm run migrate:new -- add_my_table
| `milestones.js` + `milestonesData.js` | Milestones tab | | `milestones.js` + `milestonesData.js` | Milestones tab |
| `shadess.js` | SSHADESS adolescent assessment | | `shadess.js` | SSHADESS adolescent assessment |
| `encounters.js` | Save / load / resume with optimistic lock | | `encounters.js` | Save / load / resume with optimistic lock |
| `memories.js` | Physician templates and prompt preferences UI | | `memories.js` | Physician templates + corrections UI |
| `speechRecognition.js` | Explicit opt-in browser Web Speech support | | `correctionTracker.js` | Captures AI-output edits |
| `browserWhisper.js` | In-browser WASM Whisper |
| `speechRecognition.js` | Web Speech API preview |
| `voicePreferences.js` | Per-user STT/TTS override | | `voicePreferences.js` | Per-user STT/TTS override |
| `audioBackup.js` | Server + IndexedDB backup retries | | `audioBackup.js` | Server + IndexedDB backup retries |
| `nextcloud.js` | Connect / export | | `nextcloud.js` | Connect / export |

View file

@ -1,81 +0,0 @@
# Features Explained
This file is a practical operator-oriented overview of major Ped-AI features. It intentionally describes the current fork, not historical browser Whisper behavior.
## Clinical Documentation
Ped-AI generates pediatric clinical notes from typed input, dictation, or recorded audio. Major workflows include live encounters, dictation cleanup, sick visits, well visits, SOAP notes, hospital courses, chart review, ED documentation, and developmental milestones.
Model selection is available per task where the UI exposes a tab-level selector. Admin defaults provide the baseline model and user/task choices can override that baseline.
Generated notes can expose post-note helper panels. Billing suggestions and don't-miss review are clinician-facing. Patient education handouts are parent-facing drafts generated from the edited note, with optional diagnosis, medication, and preferred-language context. The clinician must verify the handout before sharing it.
## Phone Extensions And Pagers
The bedside tools include a per-user phone extension and pager directory. Entries support active/trash views, search, soft delete/restore, permanent purge, ZIP export, and JSON/ZIP import. Import preview flags exact active duplicates, exact trashed matches that can be restored, and possible duplicates before committing changes.
## Speech
Final transcription is server-side through LiteLLM. Configure upstream STT providers in LiteLLM rather than in Ped-AI.
Browser-native Web Speech is only an explicit opt-in preview path. It is not the final clinical transcript and may use browser-vendor cloud services.
Browser Whisper and browser-local model workers are removed. Do not expect a pre-download model button, public Whisper worker, or bundled Xenova model path.
## Text To Speech
The voice preview button calls LiteLLM TTS and plays the returned audio in the browser. If preview is silent, check that a LiteLLM voice is selected, the gateway is configured, the user is authenticated, and browser autoplay has not blocked playback.
## Learning Hub
Learning Hub is both a learner-facing content area and an admin/moderator CMS.
- Articles and pearls render sanitized content.
- Quizzes support single-answer, multi-select, and true/false questions.
- Presentations use Marp-style markdown with preview and PPTX export.
- AI generation can use topic text, uploaded source files, or connected Nextcloud WebDAV files.
- Categories can organize content without deleting the content when category assignments change.
## Nextcloud WebDAV
Users can connect a Nextcloud account with an app password. Learning Hub AI generation can browse files from the connected WebDAV account, and users can set a default browse path to avoid repeatedly navigating to the same clinical content folder.
## Documents And S3
Document upload is optional and depends on S3-compatible storage configuration. Treat uploaded documents as PHI unless you have a separate deployment reason not to.
## Audio Backups
Audio backups exist to recover failed transcription attempts.
- They are created when transcription fails.
- They are encrypted before persistent storage.
- They expire automatically.
- Users can retry or delete them from Settings.
## Admin Panel
Admins can manage users, roles, registration, security settings, model defaults, prompts, logs, and Learning Hub content. Production deployments should enable SSO/2FA and restrict admin access.
## Feature Status
| Feature | Status | Notes |
|---|---|---|
| Clinical note generation | Active | Provider depends on `AI_PROVIDER`. |
| Server transcription | Active | Google/AWS/LiteLLM/OpenAI paths. |
| Browser Web Speech preview | Optional | Explicit opt-in only. |
| Browser Whisper | Removed | No public worker or model download path. |
| Learning Hub CMS | Active | Articles, pearls, quizzes, presentations. |
| Nextcloud WebDAV | Active | Used for file browsing/content import. |
| Patient handouts | Active | Parent-facing, note-derived, preferred-language draft. |
| Extension transfer | Active | ZIP export plus JSON/ZIP import preview. |
| Audio backups | Active | Failure recovery only. |
| TTS preview | Active | Depends on configured provider. |
## Troubleshooting
- Check browser console for frontend errors.
- Check `docker logs pediatric-ai-scribe -f` for backend errors.
- Check `/api/health` for service status.
- Check provider credentials and model names before debugging UI state.
- For Learning Hub file import failures, verify Nextcloud URL, username, app password, and folder path.

View file

@ -1,114 +0,0 @@
# Application Logic — index
> Deep, dev-friendly documentation of how each part of the ped-ai app
> actually works. Written so a human developer can understand the
> codebase without spelunking, and so an AI assistant can confidently
> modify code without breaking high-risk workflows.
These docs explain **application logic** — what the user does, what the
system does in response, what the data flow is, and **why** the design
looks the way it does. They are not API reference (see
[`../api-reference.md`](../api-reference.md)) and not deployment
recipes (see [`../deployment.md`](../deployment.md)).
## Read in this order
For someone brand new to the codebase:
1. **[architecture.md](architecture.md)** — Start here. The big picture:
current frontend pattern, lazy tab loading, backend route convention,
PostgreSQL schema, encryption at rest, Dockerfile + compose layout,
and high-risk zones.
2. **[clinical-notes.md](clinical-notes.md)** — How every clinical note
tab works. The shared "record → transcribe → generate → save"
lifecycle, then per-tab deep dives for Encounter HPI, Dictation HPI,
Sick Visit, Well Visit, SOAP, Hospital Course, Chart Review, and
Personal Notes. Includes the helper trio (refine / billing-codes /
don't-miss).
3. **[ed-encounters.md](ed-encounters.md)** — The ED encounter feature
(multi-stage notes, per-stage don't-miss, consolidate→MDM finalize).
Newest, most explicit explanation of how a clinical workflow gets
composed in this codebase. Read this for a worked example.
4. **[bedside-and-calculators.md](bedside-and-calculators.md)** —
Bedside emergencies module, the pediatric calculators (BP percentile, Fenton growth,
bilirubin nomograms, etc.), the PE Guide, vax schedule, milestones.
Includes the suture selector. **Important:** lists every clinical
formula that must NOT be modified without test vectors.
5. **[ai-and-voice.md](ai-and-voice.md)** — AI provider routing
(`callAI`), the centralized `PROMPTS` object with DB overrides, the
`wrapUserText` + `INJECTION_GUARD` safety pattern, server-side STT
routing, TTS, and the AudioRecorder. Voice/STT plumbing is high-risk — the
doc describes it without proposing changes.
6. **[auth-admin-learning.md](auth-admin-learning.md)** — Authentication
(local + OIDC SSO + 2FA), session management, OpenBao secret loading
at container start, the Admin panel (model allowlist, prompt
overrides, milestone editor), and the Learning Hub (AI-authored
quizzes / outlines / Marp presentations).
## What's NOT here
- **Reference data details.** Every clinical formula's *math* lives in
the source files; this doc series points to the formula and explains
*what it does* but doesn't reproduce the lookup tables.
- **API endpoint signatures.** See [`../api-reference.md`](../api-reference.md).
- **Operational runbooks.** See [`../deployment.md`](../deployment.md),
[`../configuration.md`](../configuration.md).
- **Recent change history.** See git log + the rollback tags
(`pre-ts-migration-2026-04-26`, `pre-ed-encounters-2026-04-26`, etc.).
## Voice + conventions
Each doc follows the same structure:
- **Overview** — what this part is and why it exists
- **User flow** — what the physician does and sees
- **Data flow** — what HTTP calls happen, what the server does
- **File map** — which files do what
- **Key design decisions***why* it works the way it does
- **High-risk zones** — what requires small, tested changes
- **How to extend** — concrete recipes for adding a new X
When a doc mentions a high-risk zone, changes should be small, well-tested, and
directly tied to the requested behavior. Current high-risk areas:
| Zone | Why |
|---|---|
| `public/js/encounters.js` save/load/idempotency | Save/version/idempotency logic has been carefully tuned; refactors keep silently breaking it. |
| Voice/STT plumbing (`audioBackup.js`, `speechRecognition.js`, `voicePreferences.js`, `transcriptionSettings.js`, recorder paths in each clinical tab) | Recording UX has been hardened against many edge cases; refactor only with smallest-diff bug fixes. |
| Validated clinical formulas (BP percentile LMS, Fenton 2013, bilirubin AAP 2022, Bhutani, APLS / Best-Guess weight, PE Guide SCALES) | Validated against peditools / AAP tables; modifying without test vectors risks miscoding patient care. |
| Auth + crypto (`crypto.js`, `passwords.js`, `sessions.js`, `auth.js`, `oidc.js`) | Security; changes without security review are unsafe. |
| MDM rubric in `PROMPTS.edFinalize` | Load-bearing for billing accuracy; trim only with explicit AMA/coding source citation. |
## Cross-cutting topics
A few topics span multiple docs. Use these as your jump-off points:
| Topic | Where to look |
|---|---|
| Frontend globals, ES modules, and lazy tab loading | architecture.md |
| Lazy tab loading (`loadComponent`, `tabChanged` event) | architecture.md |
| `getUserMemoryContext` → templates feeding into AI prompts | clinical-notes.md §6, ed-encounters.md §9 |
| The helper trio: `refineDocument`, `suggestBillingCodes`, `suggestDontMiss` | ai-and-voice.md §12, clinical-notes.md §5 |
| `wrapUserText` + `INJECTION_GUARD` prompt-injection defense | ai-and-voice.md §5 |
| `saveEncounter` API + optimistic locking + idempotency keys | architecture.md §13, clinical-notes.md §4, ed-encounters.md §5 |
| `cryptoUtil.encryptString` / `encryptBuffer` "enc1:" format | architecture.md §12 |
| AI provider routing (`callAI`) | ai-and-voice.md §2-3 |
| 2023 AMA E/M MDM rubric | ed-encounters.md §6 |
| User templates (`user_memories` table, `template_*` categories) | clinical-notes.md §6, ed-encounters.md §9 |
## How to keep these docs current
Each doc has a date implicit in the most recent feature it describes.
When you add a feature, update the relevant doc in the same commit.
When you remove a feature (e.g., the Dragon-style AI corrections
removal in late April 2026), remove its section + leave a one-line
historical note in the relevant doc.
When you write a new doc, follow the same structure as these (Overview /
User flow / Data flow / File map / Design decisions / Sacred zones /
How to extend) and add it to this index.

View file

@ -1,101 +0,0 @@
# AI, Speech, And Post-Note Helpers
This doc summarizes the current AI/STT/TTS pipeline without line-number
citations. For exact behavior, read `src/utils/ai.js`, `src/routes/transcribe.js`,
`src/routes/tts.js`, and the relevant frontend scripts.
## Text Generation
All text-generation routes call `callAI(messages, options)` from
`src/utils/ai.js`.
Supported providers:
- OpenRouter.
- AWS Bedrock.
- Azure OpenAI.
- Google Vertex AI.
- LiteLLM or another OpenAI-compatible gateway.
`AI_PROVIDER` can explicitly choose the provider. If unset, the startup loader
initializes configured clients and the final active provider follows the current
load order described in [`../ai-providers.md`](../ai-providers.md). Route
handlers do not call provider SDKs directly.
## Model Allowlist
`callAI()` rejects model IDs outside the active server-side allowlist unless a
specific admin test path opts out. The allowlist is assembled from built-in
provider models, `models.disabled`, and `models.custom` in `app_settings`.
The default model comes from the configured provider/model settings. Admins can
set defaults and custom models from the Admin Panel.
## Prompt Safety
Clinical routes should build prompts with:
- canonical templates from `src/utils/prompts.js`
- optional DB prompt overrides through `app_settings` keys `prompt.*`
- `INJECTION_GUARD`
- `wrapUserText(label, text)` around user-derived text
User-derived text includes transcripts, dictated notes, pasted chart data,
refine instructions, template preferences, and patient education source notes.
## User Templates
`getUserMemoryContext()` fetches `/api/memories/context` and passes the returned
template/preference context as `physicianMemories`. Server routes wrap that block
as low-priority style/template context. `custom` memories and legacy
`correction_*` rows are not prompt context.
## Speech-To-Text
`POST /api/transcribe` accepts one audio file up to 25 MB. Provider selection:
- explicit `TRANSCRIBE_PROVIDER=litellm`, or
- auto mode when `LITELLM_API_BASE` is configured.
Direct Google, AWS, local Whisper, and OpenAI Whisper branches are not part of the runtime. Browser Whisper/browser-local model downloads are also absent.
## Browser Web Speech
Browser-native Web Speech is an explicit opt-in preview. It may rely on browser
vendor cloud services and must not be treated as the final clinical transcript.
Final transcription should come from the configured server-side STT provider.
## Audio Backup
Failed transcription attempts can create encrypted 24-hour audio backups through
`src/routes/audioBackups.js`. The user can retry or delete backups from
Settings. Browser fallback storage is only for cases where the server cannot
store the failed recording.
## Text-To-Speech
`POST /api/text-to-speech` returns audio from LiteLLM and marks the LiteLLM
model in `X-TTS-Provider`. Voices are LiteLLM-compatible strings configured by
`LITELLM_TTS_VOICES`.
## Post-Note Helpers
Generated note outputs can expose helper panels:
- `refineDocument` for editing/refining/shortening generated text.
- `suggestBillingCodes` for clinician-facing ICD/CPT suggestions.
- `suggestDontMiss` for clinician-facing safety review.
- `attachPatientEducation` for parent-facing handout drafts.
These helpers are authenticated API-backed actions. They should treat the edited
note as the source of truth and keep the clinician in the review loop.
## Change Checklist
When changing this area:
1. Keep provider-specific code inside utility/provider modules.
2. Wrap all user-derived text with `wrapUserText` before AI calls.
3. Do not add browser-local Whisper back without a new design review.
4. Do not add clinical answer response caching.
5. Run touched-file `node --check` commands and `npm test`.

View file

@ -1,93 +0,0 @@
# Application Architecture Logic
This is the long-form companion to [`../architecture.md`](../architecture.md).
Older versions of this file tried to document every source line and frontend
wrapper pattern; that became stale as Ped-AI moved selected areas to ES modules,
added cookie-based web auth, migrations, Redis, metrics, patient education, and
mobile support.
## Current Shape
- Runtime: Node.js 20 + Express 4 in Docker.
- Data: PostgreSQL 16 with pgvector, plus Redis for operational cache/prompt
suggestion groundwork.
- Schema: idempotent baseline init in `src/db/database.js` plus versioned
migrations in `migrations/` through `node-pg-migrate`.
- Frontend: vanilla JS SPA. Many files are still classic deferred scripts;
isolated newer areas use ES modules. There is no frontend bundler.
- Auth: web uses the `ped_auth` httpOnly cookie; mobile uses secure token
storage and `Authorization: Bearer` headers. `user_sessions` is authoritative.
- AI: `src/utils/ai.js` routes to OpenRouter, Bedrock, Azure, Vertex, or
LiteLLM based on startup configuration and server-side model allowlists.
- Speech: server-side STT providers plus explicit opt-in browser Web Speech
preview. Browser Whisper/browser-local model downloads are not part of the
runtime.
- Observability: `/metrics`, structured JSONL logs, Postgres audit/API/access
logs, and optional direct Loki push.
## Composition Root
`server.js` owns the boot and routing order:
1. Load environment and core middleware.
2. Apply Helmet/CSP, CORS, cookie parsing, metrics, JSON limits, rate limiters,
static file serving, and logging.
3. Mount auth, admin, Learning Hub, clinical workflow, storage, user data,
metrics, and utility routers.
4. Serve the SPA fallback for non-API paths.
5. Drain audit queues and close Postgres on shutdown.
For exact current route mounts, read `server.js` and `src/routes/*.js`.
## Frontend Pattern
- `public/index.html` is the SPA shell.
- `public/components/*.html` contains lazy-loaded tab fragments.
- `public/js/app.js` handles tab activation and dispatches
`CustomEvent('tabChanged', { detail: { tab } })`.
- Feature scripts initialize their DOM only when the relevant tab is active.
- Shared browser helpers are still exposed through `window.*` where needed.
- New isolated frontend work should prefer small ES modules where the existing
page load order supports it, but do not rewrite unrelated clinical flows just
for style.
## Data And PHI
- Sensitive fields use `src/utils/crypto.js` AES-256-GCM helpers.
- `user_memories.name` and `user_memories.content` are encrypted for new rows.
- `audio_backups.audio_data` is gzipped and encrypted, then deleted after its
short expiry window.
- `saved_encounters` expire by `site.auto_delete_days`.
- Audit details are PHI-redacted before database insert.
## Operational Boundaries
- Ped-AI owns the clinical UI, prompts, provider selection, note helpers,
patient education, and local user data.
- External MCP/Nextcloud services own retrieval/indexing when used by clinical
assistant features.
- Clinical answer response caching is intentionally avoided; Redis is for
operational metadata and prompt suggestions, not answer reuse.
## High-Risk Areas
Treat these as small-diff zones unless you are deliberately testing a broader
refactor:
- Auth/session/crypto: `src/middleware/auth.js`, `src/routes/auth.js`,
`src/routes/oidc.js`, `src/utils/crypto.js`, `src/utils/sessions.js`.
- Recording/STT plumbing: `AudioRecorder` in `public/js/app.js`,
`public/js/audioBackup.js`, `public/js/speechRecognition.js`,
`src/routes/transcribe.js`.
- Encounter persistence: `src/routes/encounters.js` and
`public/js/encounters.js`.
- Validated calculators/reference data: `public/js/calc-math.js`,
`public/js/calculators.js`, `public/data/**`, bedside calculator modules,
and tests under `test/`.
- ED MDM/finalization prompts and billing-related helpers.
## Keep Current
Do not add file-line citations here unless a test locks them down. Prefer
describing responsibilities and pointing to file paths. If implementation moves,
update this doc in the same commit.

View file

@ -1,62 +0,0 @@
# Auth, Admin, And Learning Hub Logic
This doc summarizes the current auth/admin/Learning Hub responsibilities. The
source of truth is `server.js`, `src/routes/*.js`, and the focused top-level
docs.
## Auth
- Local auth uses argon2id for new password hashes and bcrypt fallback/rehash
for legacy rows.
- Web sessions use the `ped_auth` httpOnly cookie.
- Mobile sessions use secure token storage and `Authorization: Bearer`.
- `user_sessions` is the authoritative session registry.
- OIDC uses Authorization Code + PKCE through `src/routes/oidc.js`.
- 2FA uses TOTP plus one-time backup codes.
See [`../authentication.md`](../authentication.md) for details.
## Admin Panel
Admin routes live under `/api/admin` and require admin middleware unless the
specific route is explicitly public (for example public config reads used by the
login screen). Admin responsibilities include:
- user management and role changes
- settings and feature flags
- model allowlist/defaults/custom models
- prompt overrides
- SMTP/OIDC/security settings
- health/log views
- milestone management
- admin docs browser
## Learning Hub
Learning Hub has two surfaces:
- learner/user-facing routes under `/api/learning`
- moderator/admin CMS routes under `/api/admin/learning`
Content types include articles, pearls, quizzes, and presentations. AI content
generation can use topic text, uploaded files, or connected Nextcloud/WebDAV
sources. Semantic search uses pgvector embeddings on `learning_content` when an
embedding provider is configured.
See [`../learning-hub.md`](../learning-hub.md) and
[`../embeddings-setup.md`](../embeddings-setup.md).
## Security Rules
- Never expose raw secrets in admin health/config responses.
- Keep OIDC issuer validation and SSRF protections intact.
- Keep login, password reset, 2FA, and session endpoints rate-limited.
- Treat Learning Hub uploads as untrusted input and keep file-type checks.
- Sanitize rendered Learning Hub content.
## Change Checklist
1. Check the relevant route and frontend module together.
2. Preserve role middleware order.
3. Run `node --check` on touched JS files.
4. Run `npm test`.

View file

@ -1,71 +0,0 @@
# Bedside Tools And Calculators
This doc describes the current responsibilities of the bedside/reference area
without hardcoded line numbers. The source of truth is the code plus the
calculator test suite.
## Areas
| Area | Files | Notes |
|---|---|---|
| Bedside emergencies | `public/js/bedside/*` | ES-module pocket for emergency reference sections. |
| Core calculators | `public/js/calc-math.js`, `public/js/calculators.js`, `public/js/drugs-loader.js` | `calc-math.js` keeps a dual browser/CommonJS wrapper so tests can `require()` the same formulas used in browser. |
| Drug data | `public/data/drugs.json` | Loaded by `drugs-loader.js`; fallback constants remain in some UI modules for resilience. |
| PE Guide | `public/js/peGuide.js`, `src/routes/peGuide.js`, `public/components/pe-guide.html` | Structured PE reference plus AI narrative endpoint. |
| Well-visit schedule | `public/js/wellVisit/scheduleData.js`, `public/data/well-visit/schedule.json`, `public/js/wellVisit.js` | Schedule JSON is loaded and applied to legacy globals used by the UI. |
| Milestones | `public/js/milestonesData.js`, `public/js/milestones.js`, `src/routes/milestones.js`, `src/routes/adminMilestones.js` | DB-backed milestone data with static fallback. |
## Calculator Accuracy Rule
Do not change clinical formulas or reference data without tests. Add or update
test vectors first, then change data/code, then run `npm test`.
Protected examples include:
- APLS and Best Guess weights.
- Maintenance fluids.
- Parkland burn fluids and Lund-Browder TBSA.
- PRAM, Westley croup, GCS, Apgar, bilirubin, BMI, BP, growth, Fenton, and
equipment sizing.
- Emergency medication dosing in resuscitation, anaphylaxis, seizure,
sedation, agitation, emesis, trauma, and NRP modules.
## Schedule Data
Well-visit schedule data now lives in JSON:
- `public/data/well-visit/schedule.json`
- loader: `public/js/wellVisit/scheduleData.js`
- consumer: `public/js/wellVisit.js`
- server enrichment: `src/routes/wellVisit.js`
The loader exposes the legacy names expected by the existing UI, including
`VISIT_AGES`, `PERIODICITY`, `CATCH_UP_SCHEDULE`, `GROWTH_REFERENCE`, and BMI
classification data.
## Bedside ES Modules
The bedside tab is intentionally split by emergency/reference topic. Keep new
sections small and self-contained. Shared formatting/helpers should stay in the
bedside support modules rather than growing `calculators.js` again.
## PE Guide
The PE Guide is partly deterministic reference UI and partly AI-assisted
narrative generation:
- Browser code collects assessed systems, selected normals/abnormals, and
clinician notes.
- `POST /api/generate-pe-narrative` wraps user-derived text with
`wrapUserText` and applies `INJECTION_GUARD` before `callAI`.
- The route returns a generated narrative plus summary metadata.
## Extension Checklist
When adding or changing a bedside/calculator feature:
1. Add test vectors for any clinical formula or reference boundary.
2. Keep UI state local unless persistence is explicitly required.
3. Avoid PHI storage in reference/calculator-only areas.
4. Prefer small files for new bedside sections.
5. Run `node --check` on touched scripts and `npm test` before deploy.

View file

@ -1,65 +0,0 @@
# Clinical Note Workflows
Clinical note workflows share the same broad lifecycle:
1. User enters text or records audio.
2. Audio, when used, is transcribed by the configured server-side STT provider.
3. The frontend gathers demographics, structured form data, and optional user
template context.
4. The route wraps user-derived text with `wrapUserText` and appends
`INJECTION_GUARD` before calling `callAI`.
5. The generated note is inserted as safe text/sanitized output.
6. Post-note helpers can offer refine/shorten/clarify, billing suggestions,
don't-miss review, and parent-facing patient handouts.
7. Users can save/load encounter drafts through the shared encounter system.
## Main Workflows
| Workflow | Frontend | Route | Notes |
|---|---|---|---|
| Live Encounter HPI | `public/js/liveEncounter.js` | `POST /api/generate-hpi-encounter` | Recording/transcript to HPI. |
| Dictation | `public/js/voiceDictation.js` | `POST /api/generate-hpi-dictation` or `POST /api/generate-soap` | Dictated summary to HPI or SOAP. |
| SOAP | `public/js/soap.js` | `POST /api/generate-soap` | Transcript/dictation to SOAP. |
| Sick Visit | `public/js/sickVisit.js` | `POST /api/sick-visit/note` | Chief complaint, transcript/dictation, ROS/PE, diagnosis context. |
| Well Visit | `public/js/wellVisit.js`, `public/js/shadess.js` | `POST /api/well-visit/note`, `POST /api/well-visit/shadess` | Schedule data, ROS/PE, SSHADESS, milestones, vaccines/screenings. |
| Hospital Course | `public/js/hospitalCourse.js` | `POST /api/generate-hospital-course` | Pasted notes/labs to course summary. |
| Chart Review | `public/js/chartReview.js` | `POST /api/generate-chart-review` | Pasted chart content to outpatient review. |
| ED Encounter | `public/js/ed-encounters.js` | `src/routes/edEncounters.js` | Multi-stage ED workflow; see `ed-encounters.md`. |
| Milestones | `public/js/milestones.js` | `POST /api/generate-milestone-narrative`, `POST /api/generate-milestone-summary` | Developmental milestone narratives. |
## User Templates
Settings saves templates/preferences in `user_memories`. The frontend calls
`getUserMemoryContext()` before generation and passes the result as
`physicianMemories`. Server routes wrap that context as low-priority
style/template guidance. `custom` memories and legacy `correction_*` rows are
not injected into prompts.
## Encounter Persistence
Shared save/load behavior lives in `public/js/encounters.js` and
`src/routes/encounters.js`.
- Encounters are scoped by `user_id`.
- Rows expire by `site.auto_delete_days`.
- `idempotency_key` prevents duplicate creates.
- `version` supports optimistic locking when clients send `expected_version`.
- Text fields are encrypted at rest for new writes.
## Patient Education
`attachPatientEducation` adds a Handout panel beside supported note outputs.
`POST /api/patient-education` generates a parent-facing plain-text draft from
the edited clinician note plus optional diagnosis, medication, age, language,
and reading-level context. The clinician remains responsible for review before
sharing.
## Safety Rules
- Do not insert generated clinical output with raw `innerHTML` unless it is
intentionally sanitized.
- Do not add browser-native `prompt`, `alert`, or `confirm` workflows.
- Do not add inline DOM event handlers.
- Do not reintroduce browser Whisper/browser-local model downloads.
- Do not cache clinical answer text in Redis.
- Keep source transcript/context available for refine actions where relevant.

View file

@ -1,45 +0,0 @@
# ED Encounters
The ED encounter workflow is a multi-stage clinical documentation flow for
emergency visits.
## Shape
- Frontend: `public/js/ed-encounters.js`.
- Backend: `src/routes/edEncounters.js`.
- Prompts: ED-specific entries in `src/utils/prompts.js`.
- Helpers: billing suggestions and don't-miss review can run after generated
ED output.
## Typical Flow
1. Capture initial ED context and generate an initial note/stage output.
2. Add interval updates as the encounter evolves.
3. Consolidate relevant stages into the final ED note.
4. Generate MDM/final documentation using the ED finalize prompt.
5. Optionally run billing and don't-miss helpers.
6. Save or reload the encounter through the shared encounter system.
## Design Constraints
- Later stages should not silently overwrite earlier clinical text.
- Regeneration should make it clear which stage is being updated.
- MDM/finalization prompt changes should be conservative and coding-aware.
- Don't-miss output is clinician-facing safety support, not a replacement for
clinical judgment.
## User Templates
Templates saved under ED-relevant categories can be included through
`/api/memories/context` and passed as `physicianMemories`. Legacy
`correction_*` rows are filtered out.
## Testing Checklist
When changing ED behavior:
1. Run syntax checks for `public/js/ed-encounters.js` and
`src/routes/edEncounters.js`.
2. Run `npm test`.
3. Manually test stage generation, finalization, save/load, and helper panels
in an authenticated session when possible.

View file

@ -1,8 +1,7 @@
# Mobile Build And Release # Mobile build & release
Capacitor 6 wrapper around the hosted Ped-AI web app. The launcher defaults to `https://app.pedshub.com`, lets the user change the server URL, and stores that URL locally. Android is buildable on Linux. The iOS project exists but requires macOS and Xcode to produce an `.ipa`. Capacitor 6 wrapper. Android only today; iOS project exists but requires macOS
+ Xcode to produce an `.ipa`.
This is not a separate native clinical app. The native shell provides WebView hosting, microphone permission plumbing, secure storage, and mobile packaging for the same authenticated web app.
## One-time setup ## One-time setup
@ -26,12 +25,8 @@ npx cap open android
## CI build (preferred) ## CI build (preferred)
Push-triggered. Any push to `main`/feature branches and any `vX.Y.Z` tag push Tag-triggered. Push any `vX.Y.Z` tag → `.github/workflows/android-release.yml`
`.forgejo/workflows/android-apk.yml` builds a signed APK on the Forgejo builds a signed APK on a GitHub runner and attaches it to the matching release.
runner.
Tagged builds additionally publish the artifact to the matching Forgejo release
as `pedscribe-<tag>.apk` so Obtainium can track updates.
Required repo secrets (set once, via Settings → Secrets and variables → Actions Required repo secrets (set once, via Settings → Secrets and variables → Actions
or `gh secret set`): or `gh secret set`):
@ -40,14 +35,6 @@ or `gh secret set`):
- `ANDROID_KEYSTORE_PASSWORD` - `ANDROID_KEYSTORE_PASSWORD`
- `ANDROID_KEY_ALIAS``pedscribe` - `ANDROID_KEY_ALIAS``pedscribe`
- `ANDROID_KEY_PASSWORD` - `ANDROID_KEY_PASSWORD`
- `GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64` — base64 of your Google Play service
account JSON (optional). If present, the same tag build also runs `bundleRelease`
and uploads the AAB to Play's `internal` track.
Optional Play Store flow:
- Service account must have permissions to edit releases on the app in Play.
- Build task is `bundleRelease`, tracked as `com.pedshub.scribe`.
- Upload lane is `fastlane/android publish_internal` (under `mobile/android/fastlane`).
Tag a release: Tag a release:
@ -57,13 +44,12 @@ git commit -m "feat: ..." && git push # auto-version workflow bumps minor
git commit -m "fix: ..." && git push # auto-version workflow bumps patch git commit -m "fix: ..." && git push # auto-version workflow bumps patch
# or force an exact version # or force an exact version
scripts/release.sh X.Y.Z --push scripts/release.sh 6.2.0 --push
``` ```
APK lands on the Forgejo release. Obtainium can still track APK lands at the GitHub release; `/releases/latest` link in the login page
`git.danvics.com/danvics/pediatric-ai-scribe-v3` releases automatically. resolves to it automatically. Obtanium subscribers (`github.com/<owner>/<repo>`)
Play Store upload is handled automatically for tagged builds only when pick up the update on next poll.
`GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_B64` is configured.
## Local build (fallback / debugging) ## Local build (fallback / debugging)
@ -83,8 +69,6 @@ Output: `android/app/build/outputs/apk/release/app-release.apk`
For Play Store, swap `assembleRelease``bundleRelease`; output: `.aab` under For Play Store, swap `assembleRelease``bundleRelease`; output: `.aab` under
`bundle/release/`. `bundle/release/`.
If web assets or Capacitor config changed, run `npx cap sync android` from `mobile/` before building.
### Single-quote the password ### Single-quote the password
Keystore passwords with shell metacharacters (`)`, `$`, `!`, space, etc.) must Keystore passwords with shell metacharacters (`)`, `$`, `!`, space, etc.) must
@ -125,9 +109,8 @@ user to uninstall + reinstall.
| Path | Purpose | | Path | Purpose |
|---|---| |---|---|
| `mobile/capacitor.config.json` | appId, name, WebView config, plugin opts | | `mobile/capacitor.config.json` | appId, name, WebView config, plugin opts |
| `mobile/src/` | launcher HTML and server URL entry, defaulting to `https://app.pedshub.com` | | `mobile/src/` | launcher HTML (server URL entry) |
| `mobile/android/app/src/main/java/com/pedshub/scribe/MainActivity.java` | JS bridge + WebView mic permission | | `mobile/android/app/src/main/java/com/pedshub/scribe/MainActivity.java` | JS bridge + WebView mic permission |
| `mobile/android/app/src/main/java/com/pedshub/scribe/AudioRecordingService.java` | foreground service for background recording | | `mobile/android/app/src/main/java/com/pedshub/scribe/AudioRecordingService.java` | foreground service for background recording |
| `mobile/android/app/src/main/AndroidManifest.xml` | permissions, intents, backup rules | | `mobile/android/app/src/main/AndroidManifest.xml` | permissions, intents, backup rules |
| `.forgejo/workflows/android-apk.yml` | CI build | | `.github/workflows/android-release.yml` | CI build |
| `mobile/android/fastlane/Fastfile` | internal Play track upload lane |

View file

@ -1,38 +1,83 @@
# Speech: STT, TTS, Audio Backup # Speech: STT, TTS, audio backup
## Transcription ## Transcription (speech-to-text)
`POST /api/transcribe` accepts `multipart/form-data` with one audio file up to 25 MB. Server STT is routed through LiteLLM. ### Overview
Set `TRANSCRIBE_PROVIDER=litellm`, `LITELLM_API_BASE`, and `LITELLM_STT_MODEL`. Auto mode also uses LiteLLM when the gateway is configured. `POST /api/transcribe` accepts `multipart/form-data` with a single audio
file (≤ 25 MB). Provider is `TRANSCRIBE_PROVIDER` env var, or auto-detected
(`google > aws > openai`) from available credentials. Each user may override
via `users.stt_model`; admin-wide default via `stt.model` in `app_settings`.
| Provider | Notes | HIPAA posture | ### Providers
| Provider | Transport | HIPAA (with BAA) |
|---|---|---| |---|---|---|
| LiteLLM | Sends audio through the configured LiteLLM `/audio/transcriptions` backend. | Depends on the selected upstream. | | **Google Gemini** | Inline audio in `generateContent` call. Default model `gemini-2.0-flash`. | Yes |
| **Amazon Transcribe** | Streaming. `AWS_TRANSCRIBE_MEDICAL=true` + `AWS_TRANSCRIBE_SPECIALTY` switches to Transcribe Medical. Specialties: `PRIMARYCARE`, `CARDIOLOGY`, `NEUROLOGY`, `ONCOLOGY`, `RADIOLOGY`, `UROLOGY`. | Yes |
| **Local Whisper** | Spawns `whisper.cpp` or `faster-whisper` via `WHISPER_BINARY`. Fully offline. Model sizes `tiny`/`base`/`small`/`medium`/`large`. | N/A (nothing leaves host) |
| **OpenAI Whisper** | `whisper-1` via `/v1/audio/transcriptions`. Medical-context prompt prepended: `"Medical patient encounter. Pediatric."` | No |
| **LiteLLM** | Inline audio via LiteLLM's `chat.completions` endpoint (not the `/audio/transcriptions` path). Model from `LITELLM_STT_MODEL`. | Depends on LiteLLM backend |
Browser Whisper and browser-local Whisper workers are not part of the runtime. Do not add browser model downloads or Transformers.js STT back into the public app. ## Browser Whisper (fully offline)
## Web Speech Preview Runs entirely in the browser via WebAssembly. Zero network. Suitable when
no external transcription is acceptable.
Browser-native Web Speech can show interim text when the user explicitly enables it. It is browser/vendor dependent, may send audio to browser-provider cloud services, and should not be treated as the final clinical transcript. - Runtime: `@xenova/transformers` (WASM).
- Models (bundled in the Docker image, no CDN fetch):
- `whisper-tiny.en` — 39 MB
- `whisper-base.en` — 74 MB
- `whisper-small.en` — 244 MB
- Executes in a dedicated Web Worker; UI thread is never blocked.
- Models cached in IndexedDB after first load.
- Per-user toggle. On browser transcription failure, the client falls back to
server-side transcription without user intervention.
## Text To Speech ## Live speech preview
`POST /api/text-to-speech` returns audio from LiteLLM `/audio/speech`. The `X-TTS-Provider` response header identifies the LiteLLM model used. Requests are limited to 5000 characters. Chrome / Edge `webkitSpeechRecognition` streams interim text to the UI during
recording. Used for real-time preview only — **not** for final transcription.
The actual transcript comes from the configured STT provider after recording
ends.
## Text-to-speech
### Overview
`POST /api/text-to-speech`. Returns `audio/mpeg`. `X-TTS-Provider` response
header identifies the provider used. 5000-character limit per request. Each
user may override via `users.tts_voice`; admin-wide default via `tts.voice`.
### Providers
| Provider | Notes | | Provider | Notes |
|---|---| |---|---|
| LiteLLM | Uses `LITELLM_TTS_MODEL` and `LITELLM_TTS_VOICE`. | | **Google Cloud TTS** | `@google-cloud/text-to-speech`. Voice families: Journey, Studio, Neural2. |
| **LiteLLM** | Configured via `LITELLM_TTS_MODEL` + `LITELLM_TTS_VOICE`. Backend-agnostic. |
| **ElevenLabs** | `eleven_turbo_v2_5`. **Not HIPAA-compliant**. |
The admin/user voice pickers read available LiteLLM-compatible voices from `LITELLM_TTS_VOICES`. ## Audio backup
## Audio Backup Raw audio is saved to Postgres **only when transcription fails**, providing a
retry window without persisting every recording.
Failed transcription submissions can be stored for retry instead of being silently lost. ### Storage
- Audio backups are compressed and encrypted before storage. - Gzip-compressed, then AES-256-GCM encrypted (0x01 version byte prefix).
- Backups expire automatically. - `BYTEA` column in `audio_backups`.
- The Settings audio backup UI can retry or delete saved items. - 24-hour `expires_at`, swept hourly.
- Browser fallback storage is used only when the server cannot save the failed audio. - Legacy rows (gzip magic `0x1F` as first byte, no encryption envelope)
decompress as-is — detection is deterministic because `0x1F ≠ 0x01`.
Treat audio backups as sensitive clinical data even when encrypted. ### Retry UI
Settings → Audio Backups:
- List: module, size, created, expiry.
- **Retry** — resubmits to `POST /api/transcribe`.
- **Delete** — purge now.
### Browser fallback
If the server-side save fails (network, 500, etc.), the client stores the audio
in IndexedDB so it can retry later. Cleared after successful submission.

View file

@ -1,40 +0,0 @@
# Transcription Options
Ped-AI currently supports server-side transcription through LiteLLM plus an explicit browser Web Speech preview option. Browser Whisper was removed and should not be offered in settings, documentation, public workers, or model download scripts.
## Recommended Clinical Setup
Route STT through LiteLLM and configure the compliant upstream in LiteLLM.
| Need | Recommended provider |
|---|---|
| Server STT | LiteLLM with a compliant upstream. |
| Real-time draft preview | Browser Web Speech only with explicit user opt-in and privacy warning. |
Auto-detect uses LiteLLM when `LITELLM_API_BASE` is configured. Direct Google, AWS, local Whisper, and OpenAI Whisper branches are not part of the app runtime.
## Configuration
```env
TRANSCRIBE_PROVIDER=litellm
LITELLM_API_BASE=https://your-litellm.example/v1
LITELLM_API_KEY=<key>
LITELLM_STT_MODEL=local-parakeet-v3
```
## Failure Handling
- Server transcription failures can create encrypted audio backups for retry.
- Users can retry or delete failed backups from Settings.
- Web Speech interim text is not a substitute for a server transcription response.
## Removed Paths
These should remain absent unless the project intentionally reintroduces browser-local STT with a new design review:
- `public/js/browserWhisper.js`
- `public/js/whisperWorker.js`
- `public/js/whisperWorkerV2.js`
- `public/models/Xenova/*`
- Browser Whisper setup/troubleshooting docs
- Whisper model download scripts for public browser models

View file

@ -1,166 +0,0 @@
// ============================================================
// SHARED PLAYWRIGHT FIXTURES
// ============================================================
// Provides:
// - `test` — augmented @playwright/test with auto-applied uncaught-error
// guards on every page (pageerror + console.error → test fail)
// - `authedPage` fixture — a logged-in page, ready to drive
// - `mockAI(page, overrides)` — installs page.route() handlers that
// intercept AI endpoints and return canned JSON. Pass `{ real: true }`
// or set E2E_USE_REAL_AI=1 to bypass mocking and call real backend.
// ============================================================
const base = require('@playwright/test');
// ── Environment ──────────────────────────────────────────────
const E2E_BASE_INTERNAL = 'http://pediatric-ai-scribe-e2e:3000';
const E2E_BASE_EXTERNAL = 'http://host.docker.internal:3553';
const E2E_BASE = process.env.E2E_AUTH_BASE_URL || E2E_BASE_INTERNAL;
const TEST_EMAIL = process.env.E2E_TEST_EMAIL || 'e2e-user@ped-ai.test';
const TEST_PASSWORD = process.env.E2E_TEST_PASSWORD || 'E2E-testPassword123!';
const USE_REAL_AI = process.env.E2E_USE_REAL_AI === '1' || process.env.E2E_USE_REAL_AI === 'true';
// ── Console-error allowlist ─────────────────────────────────
// Some console messages are expected / noise (e.g. favicon 404). If a
// message matches one of these patterns it does NOT fail the test.
const CONSOLE_ERROR_ALLOWLIST = [
/favicon/i,
/\/api\/models/i, // When no AI provider configured yet
/Cross-Origin-Opener-Policy/i, // Chrome warning on non-HTTPS e2e server
/Failed to load resource.*(400|401|403|404|500|502|503)/i, // Any HTTP error on subsidiary fetches — smoke tests only verify UI renders, deeper integration tests validate endpoint contracts separately
/net::ERR_BLOCKED_BY_CLIENT/i, // Adblocker etc.
/Cloudflare Turnstile.*110200/i, // Expected on e2e: site key hard-coded in index.html but e2e uses different host → domain mismatch error
/challenges\.cloudflare\.com\/turnstile/i, // Turnstile script errors from same root cause
];
function isAllowedConsoleNoise(text) {
return CONSOLE_ERROR_ALLOWLIST.some(re => re.test(text));
}
// ── Auth — module-scoped token cache ────────────────────────
// Keeps one login per worker to avoid the 10/15-min login rate-limiter.
let _tokenCache = null;
async function getAuthToken(request) {
if (_tokenCache) return _tokenCache;
const r = await request.post(E2E_BASE + '/api/auth/login', {
data: { email: TEST_EMAIL, password: TEST_PASSWORD },
});
if (!r.ok()) {
const text = await r.text();
throw new Error(`E2E login failed (status ${r.status()}): ${text}`);
}
const body = await r.json();
if (!body.token) throw new Error('Login response missing token: ' + JSON.stringify(body));
_tokenCache = body.token;
return _tokenCache;
}
async function loginAs(context, request) {
const token = await getAuthToken(request);
const url = new URL(E2E_BASE);
await context.addCookies([{
name: 'ped_auth',
value: token,
domain: url.hostname,
path: '/',
httpOnly: true,
secure: false,
sameSite: 'Lax',
}]);
}
// ── AI mock — intercepts generation endpoints ──────────────
// Canned response shape matches what each route's frontend expects.
// Override per-test by passing {pattern: responseFn} in overrides.
async function mockAI(page, overrides = {}) {
if (USE_REAL_AI || overrides.real) return; // opt-out to hit real backend
const routes = [
{ pattern: '**/api/generate-soap', response: { success: true, soap: 'MOCK SOAP NOTE.\nSubjective: ...\nObjective: ...\nAssessment: ...\nPlan: ...', model: 'mock-gpt' } },
{ pattern: '**/api/generate-hpi-encounter', response: { success: true, hpi: 'MOCK HPI from encounter.', model: 'mock-gpt' } },
{ pattern: '**/api/generate-hpi-dictation', response: { success: true, hpi: 'MOCK HPI from dictation.', model: 'mock-gpt' } },
{ pattern: '**/api/sick-visit/note', response: { success: true, note: 'MOCK sick visit note.', model: 'mock-gpt' } },
{ pattern: '**/api/well-visit/note', response: { success: true, note: 'MOCK well visit note.', model: 'mock-gpt' } },
{ pattern: '**/api/generate-hospital-course', response: { success: true, hospitalCourse: 'MOCK hospital course narrative.', format: 'auto', model: 'mock-gpt' } },
{ pattern: '**/api/generate-milestone-narrative', response: { success: true, narrative: 'MOCK developmental narrative.', model: 'mock-gpt', summary: { achieved: 3, notAchieved: 0, notAssessed: 0 } } },
{ pattern: '**/api/generate-milestone-summary', response: { success: true, summary: 'MOCK 3-sentence summary.', model: 'mock-gpt' } },
{ pattern: '**/api/generate-pe-narrative', response: { success: true, narrative: 'Technique:\nMOCK technique.\n\nFindings:\nMOCK findings.', model: 'mock-gpt', summary: { normal: 2, abnormal: 0, notAssessed: 0 } } },
{ pattern: '**/api/generate-chart-review', response: { success: true, review: 'MOCK chart review.', model: 'mock-gpt' } },
{ pattern: '**/api/well-visit/shadess', response: { success: true, assessment: 'MOCK SSHADESS assessment.', model: 'mock-gpt' } },
{ pattern: '**/api/refine', response: { success: true, refined: 'MOCK refined content.', model: 'mock-gpt' } },
{ pattern: '**/api/suggest-billing-codes', response: { success: true, icd10: [], cpt: [], model: 'mock-gpt' } },
{ pattern: '**/api/transcribe', response: { success: true, transcript: 'MOCK transcribed text.' } },
{ pattern: '**/api/tts', response: { success: true, audioBase64: '' } },
];
for (const { pattern, response } of routes) {
const override = overrides[pattern];
await page.route(pattern, async route => {
const resp = typeof override === 'function' ? await override(route.request()) : (override || response);
await route.fulfill({ status: 200, contentType: 'application/json', body: JSON.stringify(resp) });
});
}
}
// ── Error guards — auto-applied via extended test ──────────
// Any uncaught page JS error or unhandled console.error fails the test.
// This is the safety net for bugs like the SSO ReferenceError.
const test = base.test.extend({
// Replace the default `page` with one that has listeners wired before
// any navigation happens.
page: async ({ page }, use) => {
const errors = [];
const consoleErrors = [];
page.on('pageerror', err => {
// Same allowlist applies to pageerror — third-party scripts (Turnstile)
// can throw uncaught errors that are expected on the e2e host.
const msg = err && (err.message || String(err));
if (isAllowedConsoleNoise(msg)) return;
errors.push(err);
});
page.on('console', msg => {
if (msg.type() !== 'error') return;
const text = msg.text();
if (isAllowedConsoleNoise(text)) return;
consoleErrors.push(text);
});
await use(page);
// After the test finishes, fail if any uncaught errors accumulated.
if (errors.length > 0) {
throw new Error(
'Uncaught page error(s) during test:\n' +
errors.map(e => ' - ' + e.message + '\n ' + (e.stack || '').split('\n').slice(0, 3).join('\n ')).join('\n')
);
}
if (consoleErrors.length > 0) {
throw new Error(
'console.error() during test:\n' +
consoleErrors.map(t => ' - ' + t).join('\n')
);
}
},
// Pre-authed page — login before use.
authedPage: async ({ page, context, request }, use) => {
await loginAs(context, request);
await use(page);
},
});
const expect = base.expect;
module.exports = {
test,
expect,
E2E_BASE,
TEST_EMAIL,
TEST_PASSWORD,
loginAs,
getAuthToken,
mockAI,
USE_REAL_AI,
};

78
e2e/package-lock.json generated
View file

@ -1,78 +0,0 @@
{
"name": "ped-ai-e2e",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "ped-ai-e2e",
"version": "1.0.0",
"devDependencies": {
"@playwright/test": "1.50.0"
}
},
"node_modules/@playwright/test": {
"version": "1.50.0",
"resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.50.0.tgz",
"integrity": "sha512-ZGNXbt+d65EGjBORQHuYKj+XhCewlwpnSd/EDuLPZGSiEWmgOJB5RmMCCYGy5aMfTs9wx61RivfDKi8H/hcMvw==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
"playwright": "1.50.0"
},
"bin": {
"playwright": "cli.js"
},
"engines": {
"node": ">=18"
}
},
"node_modules/fsevents": {
"version": "2.3.2",
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
"integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
"dev": true,
"hasInstallScript": true,
"license": "MIT",
"optional": true,
"os": [
"darwin"
],
"engines": {
"node": "^8.16.0 || ^10.6.0 || >=11.0.0"
}
},
"node_modules/playwright": {
"version": "1.50.0",
"resolved": "https://registry.npmjs.org/playwright/-/playwright-1.50.0.tgz",
"integrity": "sha512-+GinGfGTrd2IfX1TA4N2gNmeIksSb+IAe589ZH+FlmpV3MYTx6+buChGIuDLQwrGNCw2lWibqV50fU510N7S+w==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
"playwright-core": "1.50.0"
},
"bin": {
"playwright": "cli.js"
},
"engines": {
"node": ">=18"
},
"optionalDependencies": {
"fsevents": "2.3.2"
}
},
"node_modules/playwright-core": {
"version": "1.50.0",
"resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.50.0.tgz",
"integrity": "sha512-CXkSSlr4JaZs2tZHI40DsZUN/NIwgaUPsyLuOAaIZp2CyF2sN5MM5NJsyB188lFSSozFxQ5fPT4qM+f0tH/6wQ==",
"dev": true,
"license": "Apache-2.0",
"bin": {
"playwright-core": "cli.js"
},
"engines": {
"node": ">=18"
}
}
}
}

View file

@ -1,9 +0,0 @@
{
"name": "ped-ai-e2e",
"version": "1.0.0",
"description": "End-to-end smoke tests for PedScribe. Runs inside an official Playwright container; no host Node needed.",
"private": true,
"devDependencies": {
"@playwright/test": "1.50.0"
}
}

View file

@ -1,26 +0,0 @@
// Playwright config — runs smoke tests against the already-running PedScribe
// container (no dev server spin-up). Expects BASE_URL (default
// http://host.docker.internal:3552 when run via scripts/e2e.sh).
const { defineConfig, devices } = require('@playwright/test');
module.exports = defineConfig({
testDir: './tests',
timeout: 30_000,
expect: { timeout: 5_000 },
fullyParallel: false,
retries: 0,
workers: 1,
reporter: [['list']],
use: {
baseURL: process.env.BASE_URL || 'http://host.docker.internal:3552',
trace: 'retain-on-failure',
screenshot: 'only-on-failure',
actionTimeout: 5_000,
navigationTimeout: 15_000,
},
projects: [
{ name: 'chromium', use: { ...devices['Desktop Chrome'] } },
// Mobile pass — catches layout regressions at ~375 px (iPhone SE)
{ name: 'mobile-chrome', use: { ...devices['Pixel 5'] } },
],
});

View file

@ -1,114 +0,0 @@
// ============================================================
// AI ENDPOINT CONTRACT TESTS — hit the REAL server handlers
// ============================================================
// The UI smoke tests mock AI responses via page.route() so they never
// exercise the server-side handler. That meant a route whose require()
// statement was wrong (undefined PROMPTS → 500) shipped to prod without
// any test failing. This spec calls each AI generation endpoint
// through the Playwright request fixture (bypasses page.route) with a
// minimal valid payload and only checks the server didn't crash with a
// ReferenceError / TypeError. A mock model is installed on the server
// side via MOCK_AI=1 env var (if configured) so we don't spend API
// credits; otherwise the server still processes the request and returns
// a structured error (which is fine — we're guarding against 500s from
// bad imports, not end-to-end AI generation).
//
// A non-500 response (200 OK or 4xx with structured JSON) means the
// handler at least ran — that's the contract we're verifying.
// ============================================================
const { test, expect, E2E_BASE, getAuthToken } = require('../fixtures');
test.describe('AI endpoint contracts — handler loads + accepts POST', () => {
let token;
test.beforeAll(async ({ request }) => {
token = await getAuthToken(request);
});
// Each entry: path, minimal body that should make the handler run past
// its import statements. We don't need a valid AI key — a 500 from
// a require() bug will still fail, but a 4xx from "missing API key"
// is acceptable because it proves the route loaded.
const endpoints = [
{
path: '/api/generate-pe-narrative',
body: {
steps: [{ component: 'Inspection', label: 'General', method: 'Observed', status: 'normal' }],
ageGroup: 'School-Age (6-11 yr)',
system: 'neuro',
patientAge: '8 years',
patientGender: 'male',
format: 'narrative',
},
},
{
path: '/api/generate-milestone-narrative',
body: {
milestones: [{ domain: 'Motor', label: 'Walks', status: 'achieved' }],
ageGroup: '12 months',
patientAge: '12 months',
patientGender: 'male',
},
},
{
path: '/api/generate-hpi-encounter',
body: { transcript: 'Patient with cough for 3 days.', setting: 'outpatient' },
},
{
path: '/api/sick-visit/note',
body: { chiefComplaint: 'Cough', transcript: 'Cough x 3 days.' },
},
{
path: '/api/generate-soap',
body: { transcript: 'Patient with cough x 3 days.' },
},
{
path: '/api/generate-chart-review',
body: { pmh: 'None', outpatientVisits: [], edVisits: [], subspecialtyVisits: [], labs: [] },
},
{
path: '/api/refine',
body: { currentDocument: 'MOCK doc', instructions: 'Add severity.' },
},
{
path: '/api/well-visit/shadess',
body: { answers: { home: 'lives with parents' } },
},
];
// Signatures of runtime bugs that mean the handler crashed before it
// could reach its try/catch (i.e. the exact class of bug being guarded).
const CRASH_SIGNATURES = [
/Cannot read properties of undefined/i,
/is not a function/i,
/is not defined/i,
/ReferenceError/i,
/TypeError/i,
];
for (const { path, body } of endpoints) {
test(`${path} — handler loads, returns structured JSON, no import-bug crash`, async ({ request }) => {
const r = await request.post(E2E_BASE + path, {
headers: { Authorization: 'Bearer ' + token },
data: body,
});
// Must always be JSON — a 500 HTML page means the express error handler
// caught an unhandled exception (our bug class).
let json = null;
try { json = await r.json(); } catch (_) { /* remains null */ }
expect(json, `${path} did not return JSON (HTTP ${r.status()})`).toBeTruthy();
// If the response leaked a JS error message through to the client,
// that's the import/destructure-bug signature we want to catch.
const errText = (json && (json.error || json.message)) || '';
for (const sig of CRASH_SIGNATURES) {
expect(errText, `${path} leaked a runtime error: ${errText}`).not.toMatch(sig);
}
// Errors should be plain strings — never raw error objects.
if (json && json.success === false) {
expect(typeof json.error).toBe('string');
}
});
}
});

View file

@ -1,67 +0,0 @@
// Smoke tests for pages behind the auth wall. Runs against the separate
// `pediatric-ai-scribe-e2e` container (port 3553 on host, 3000 internal) which
// has TURNSTILE_SECRET_KEY="" + SMTP_HOST="" so tests can log in without a
// bot challenge and register auto-verifies.
//
// Each test logs in via the API (no UI interaction needed) and injects the
// session cookie into the browser context.
// Uses the shared fixture so the token cache is unified across every spec
// — each Playwright worker does ONE login for the whole run, staying under
// the 10/15min login rate-limit.
const { test, expect, E2E_BASE, loginAs } = require('../fixtures');
// ── Tests ────────────────────────────────────────────────────────────
test.describe('Auth-gated pages — main tabs', () => {
test.beforeEach(async ({ context, request }) => {
await loginAs(context, request);
});
test('Landing page shows tab navigation after login', async ({ page }) => {
await page.goto(E2E_BASE + '/');
await expect(page.locator('button.tab-btn').first()).toBeVisible({ timeout: 15000 });
});
// Each auth-gated tab test: activate the tab, assert its container becomes
// visible + contains the expected anchor string. We use getTabPanel helpers
// because components load lazily from /components/<tab>.html.
const tabs = [
{ name: 'encounter', anchor: /New Encounter|encounter|SOAP/i },
{ name: 'wellvisit', anchor: /Well Visit|well visit/i },
{ name: 'chart', anchor: /Chart|visits|patients/i },
{ name: 'vaxschedule', anchor: /Vaccine|schedule|dose/i },
{ name: 'catchup', anchor: /Catch-up|catch up|schedule/i },
{ name: 'learning', anchor: /Learning|quiz|topic/i },
{ name: 'dictation', anchor: /Dictation|record|transcrib/i },
{ name: 'settings', anchor: /Setting|profile|preferences|account/i },
{ name: 'calculators', anchor: /Pediatric Calculator|BP Percentile|BMI/i },
{ name: 'faq', anchor: /FAQ|question|answer/i },
];
for (const { name, anchor } of tabs) {
test(`${name} tab loads content`, async ({ page, viewport }) => {
await page.goto(E2E_BASE + '/');
// On mobile the sidebar is hidden behind a hamburger. Open it so the
// tab buttons become interactable.
if (viewport && viewport.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const tabBtn = page.locator(`button.tab-btn[data-tab="${name}"]`);
const isHidden = await tabBtn.evaluate((el) => el.classList.contains('hidden')).catch(() => true);
test.skip(isHidden, `Tab "${name}" is hidden for this user role`);
await tabBtn.click();
// Wait for lazy component load to complete
await page.waitForFunction(
(t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
},
name,
{ timeout: 15000 }
);
await expect(page.locator(`#${name}-tab`)).toContainText(anchor);
});
}
});

View file

@ -1,70 +0,0 @@
// ============================================================
// AUTH SCREEN — unauthenticated landing page structure.
// These tests do NOT use the `authedPage` fixture; they visit the
// app with a fresh context (no cookie) and assert the sign-in
// form + register + forgot-password transitions render correctly.
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
test.describe('Unauthenticated auth screen', () => {
// Use the base test that doesn't auto-login.
test('landing shows login form with email + password fields', async ({ page }) => {
await page.goto(E2E_BASE + '/');
await expect(page.locator('#auth-screen')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#login-email')).toBeVisible();
await expect(page.locator('#login-password')).toBeVisible();
await expect(page.locator('#btn-local-login')).toBeVisible();
// main app body must be hidden while unauthenticated
await expect(page.locator('#main-app')).toBeHidden();
});
test('register link is present but currently disabled (display:none)', async ({ page }) => {
// Invite-only registration hides the link while keeping the form in the DOM.
await page.goto(E2E_BASE + '/');
await page.waitForSelector('#auth-screen', { timeout: 10000 });
const display = await page.locator('#show-register').evaluate(el => el.style.display);
expect(display).toBe('none');
// The register form element still exists in the DOM for programmatic access
await expect(page.locator('#register-form')).toHaveCount(1);
});
test('register form DOM is wired correctly if manually unhidden', async ({ page }) => {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('#auth-screen', { timeout: 10000 });
// Force the link visible so we can exercise the swap path — useful for
// future tests that want to validate the full register flow.
await page.locator('#show-register').evaluate(el => { el.style.display = ''; });
await page.click('#show-register');
await expect(page.locator('#register-form')).toBeVisible();
await expect(page.locator('#reg-name')).toBeVisible();
await expect(page.locator('#reg-email')).toBeVisible();
await expect(page.locator('#reg-password')).toBeVisible();
await page.click('#show-login');
await expect(page.locator('#login-form')).toBeVisible();
await expect(page.locator('#register-form')).toBeHidden();
});
test('clicking "Forgot password?" swaps to forgot form', async ({ page }) => {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('#auth-screen', { timeout: 10000 });
await page.click('#show-forgot');
await expect(page.locator('#forgot-form')).toBeVisible();
await expect(page.locator('#forgot-email')).toBeVisible();
await expect(page.locator('#login-form')).toBeHidden();
// Back link returns to login
await page.click('#show-login-2');
await expect(page.locator('#login-form')).toBeVisible();
await expect(page.locator('#forgot-form')).toBeHidden();
});
test('password minlength enforces 8 chars in register form', async ({ page }) => {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('#auth-screen', { timeout: 10000 });
// Attribute check doesn't require the element to be visible.
const pw = page.locator('#reg-password');
await expect(pw).toHaveAttribute('minlength', '8');
await expect(pw).toHaveAttribute('type', 'password');
});
});

View file

@ -1,161 +0,0 @@
// Bedside module smoke tests.
// The harness renders the Calculators + Bedside components side-by-side, so
// each test selects the target sub-pill (if any) and asserts a known string
// is rendered. Bedside was promoted to a top-level tab, so there is no longer
// a calc-nav-pill[data-calc="bedside"] — the panel is always visible in the
// harness and always the full tab in the live app.
const { test, expect } = require('@playwright/test');
async function openCalculators(page) {
await page.goto('/e2e-harness.html');
await page.waitForFunction(() => window.__harnessReady === true);
// Wait for the bedside component to finish injecting — #bedside-age is the
// first input in the shared age→weight estimator at the top of the tab.
await page.waitForSelector('#bedside-age');
}
async function openBedside(page, subPill) {
await openCalculators(page);
if (subPill) {
await page.click(`button.calc-pill[data-em="${subPill}"]`);
}
}
test.describe('Bedside — top-level', () => {
test('Calculators tab shows age-weight estimator', async ({ page }) => {
await openCalculators(page);
await expect(page.locator('#bedside-age')).toBeVisible();
await expect(page.locator('#bedside-formula')).toBeVisible();
await expect(page.locator('#bedside-weight')).toBeVisible();
});
test('Age → Weight: typing 3y auto-fills weight (APLS)', async ({ page }) => {
await openCalculators(page);
await page.fill('#bedside-age', '3y');
await expect(page.locator('#bedside-weight')).toHaveValue('14');
await expect(page.locator('#bedside-estimate-note')).toContainText('APLS');
});
test('Formula switch to Best Guess updates weight', async ({ page }) => {
await openCalculators(page);
await page.fill('#bedside-age', '3y');
await page.selectOption('#bedside-formula', 'bestguess');
await expect(page.locator('#bedside-weight')).toHaveValue('16'); // 2 * (3+5) = 16
await expect(page.locator('#bedside-estimate-note')).toContainText('Best Guess');
});
test('Clear button resets the estimator', async ({ page }) => {
await openCalculators(page);
await page.fill('#bedside-age', '5y');
await page.click('#btn-bedside-clear');
await expect(page.locator('#bedside-age')).toHaveValue('');
await expect(page.locator('#bedside-weight')).toHaveValue('');
});
});
test.describe('Bedside — every sub-pill renders', () => {
const subPills = [
{ key: 'neonatal', expected: /Neonatal Assessment/i },
{ key: 'airway', expected: /Airway Management/i },
{ key: 'cardiac', expected: /Cardiac Arrest/i },
{ key: 'respiratory', expected: /Respiratory Management/i },
{ key: 'ventilation', expected: /Oxygen & Ventilation/i },
{ key: 'seizure', expected: /Status Epilepticus/i },
{ key: 'sepsis', expected: /Sepsis & Fever/i },
{ key: 'anaphylaxis', expected: /Anaphylaxis/i },
{ key: 'sedation', expected: /Procedural Sedation/i },
{ key: 'agitation', expected: /Acute Agitation/i },
{ key: 'antiemetics', expected: /Antiemetics/i },
{ key: 'antimicrobials', expected: /Empiric Antimicrobials/i },
{ key: 'burns', expected: /Burn Management/i },
{ key: 'toxicology', expected: /Toxicology/i },
{ key: 'trauma', expected: /Trauma/i },
];
for (const { key, expected } of subPills) {
test(`${key} sub-pill shows header`, async ({ page }) => {
await openBedside(page, key);
await expect(page.locator(`#em-${key}`)).toContainText(expected);
});
}
});
test.describe('Bedside — dose calculators fire', () => {
test('Status Epilepticus: Show Pathway renders timeline with weight', async ({ page }) => {
await openBedside(page, 'seizure');
await page.fill('#seizure-weight', '20');
await page.click('#btn-seizure-calc');
await expect(page.locator('#seizure-result')).toContainText(/20 kg/);
await expect(page.locator('#seizure-result')).toContainText(/Lorazepam/);
await expect(page.locator('#seizure-result')).toContainText(/0\.1 mg\/kg/); // per-kg visible
});
test('Sepsis: Show Approach renders Phoenix criteria + first-hour bundle', async ({ page }) => {
await openBedside(page, 'sepsis');
await page.fill('#sepsis-weight', '25');
await page.click('#btn-sepsis-show');
await expect(page.locator('#sepsis-result')).toContainText(/Phoenix/);
await expect(page.locator('#sepsis-result')).toContainText(/first-hour/i);
});
test('Anaphylaxis: Calculate Doses shows weight-based epinephrine', async ({ page }) => {
await openBedside(page, 'anaphylaxis');
await page.fill('#anaph-weight', '25');
await page.click('#btn-anaph-calc');
await expect(page.locator('#anaph-result')).toContainText(/Epinephrine/);
await expect(page.locator('#anaph-result')).toContainText(/0\.25 mg/); // 25*0.01
});
test('Burns: body-parts calculator + Parkland', async ({ page }) => {
await openBedside(page, 'burns');
await page.fill('#burn-weight', '20');
await page.fill('input[data-burn-region="head"]', '50'); // 50% of 13 (young) = 6.5
await page.fill('input[data-burn-region="ant_trunk"]', '100'); // 100% of 13 = 13
await page.click('#btn-burn-calc');
await expect(page.locator('#burn-result')).toContainText(/Parkland/);
await expect(page.locator('#burn-result')).toContainText(/20 kg/);
});
test('Airway: Calculate renders RSI drugs with per-kg', async ({ page }) => {
await openBedside(page, 'airway');
await page.fill('#airway-weight', '20');
await page.fill('#airway-age', '5');
await page.click('#btn-airway-calc');
await expect(page.locator('#airway-result')).toContainText(/Ketamine/);
await expect(page.locator('#airway-result')).toContainText(/mg\/kg/); // per-kg visible
await expect(page.locator('#airway-result')).toContainText(/ETT/);
});
});
test.describe('Bedside — interactive widgets', () => {
test('Lightbox: seizure pathway image opens and closes', async ({ page }) => {
await openBedside(page, 'seizure');
await page.click('button[data-img-src="/img/epilepsy_eiic_pathway.png"]');
await expect(page.locator('#img-lightbox')).toBeVisible();
await expect(page.locator('#img-lightbox-img')).toHaveAttribute('src', /epilepsy_eiic_pathway/);
await page.click('#img-lightbox-close');
await expect(page.locator('#img-lightbox')).toBeHidden();
});
test('Lightbox: NRP pathway image opens on neonatal sub-pill', async ({ page }) => {
await openBedside(page, 'neonatal');
// The "View pathway image" button sits inside a collapsed <details>
// titled "NRP Resuscitation Pathway" — expand it first.
await page.getByText('NRP Resuscitation Pathway').click();
await page.click('button[data-img-src="/img/nrp_pathway.png"]');
await expect(page.locator('#img-lightbox')).toBeVisible();
await expect(page.locator('#img-lightbox-img')).toHaveAttribute('src', /nrp_pathway/);
await page.click('#img-lightbox-close');
await expect(page.locator('#img-lightbox')).toBeHidden();
});
test('Ventilation: Show Reference renders pressure-time SVG', async ({ page }) => {
await openBedside(page, 'ventilation');
await page.fill('#vent-weight', '20');
await page.click('#btn-vent-show');
await expect(page.locator('#vent-result svg')).toBeVisible();
await expect(page.locator('#vent-result')).toContainText(/Target SpO2/);
await expect(page.locator('#vent-result')).toContainText(/PEEP/);
});
});

View file

@ -1,54 +0,0 @@
// ============================================================
// CHART REVIEW — fill the form → generate → verify mocked output.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="chart"]');
await page.waitForFunction(() => {
const el = document.getElementById('chart-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
test.describe('Chart Review — generation workflow', () => {
test('minimum form → generate → mocked analysis renders in output card', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await page.fill('#cr-age', '8 years');
await page.selectOption('#cr-gender', 'Male');
await page.fill('#cr-pmh', 'Hypothyroidism, asthma');
// The chart template already renders one visit row with a .visit-content
// contenteditable. Fill it so the client-side "at least one visit" guard
// doesn't block the generate call.
const firstVisit = page.locator('.visit-content').first();
await firstVisit.click();
await page.keyboard.type('Annual well visit. Growth stable. No acute concerns.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/generate-chart-review', { timeout: 15000 }),
page.click('#cr-generate-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#cr-output')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#cr-review-text')).toContainText('MOCK chart review');
});
test('load popover opens/closes when its buttons are clicked', async ({ authedPage: _, page }) => {
await openTab(page);
await page.click('#btn-chart-load');
await expect(page.locator('#chart-load-popover')).not.toHaveClass(/hidden/, { timeout: 3000 });
await page.locator('#chart-load-popover .enc-pop-close').click();
await expect(page.locator('#chart-load-popover')).toHaveClass(/hidden/);
});
});

View file

@ -1,83 +0,0 @@
// ============================================================
// ENCOUNTER SAVE/LOAD — save an encounter draft, then load it back
// and verify the transcript + label repopulate.
// ============================================================
const { test, expect, E2E_BASE, mockAI, getAuthToken } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="encounter"]');
await page.waitForFunction(() => {
const el = document.getElementById('encounter-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
// Purge all saved encounters for the test user so each run starts clean.
async function wipeSaved(request) {
const token = await getAuthToken(request);
const auth = { Authorization: 'Bearer ' + token };
const r = await request.get(E2E_BASE + '/api/encounters', { headers: auth });
if (!r.ok()) return;
const d = await r.json().catch(() => ({ items: [] }));
for (const it of (d.items || d.encounters || [])) {
await request.delete(E2E_BASE + '/api/encounters/' + it.id, { headers: auth }).catch(() => {});
}
}
test.describe('Encounter — save + load saved drafts', () => {
test.beforeEach(async ({ request }) => {
await wipeSaved(request);
});
test.afterAll(async ({ request }) => {
await wipeSaved(request);
});
test('save → load popover lists the saved draft → loading repopulates transcript', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
// Build a distinct transcript + label so we can verify round-trip
const label = 'TEST-ENC-' + Date.now();
const transcript = 'Unique transcript content: acute pharyngitis with fever.';
await page.fill('#enc-age', '7 years');
await page.selectOption('#enc-gender', 'Male');
await page.locator('#enc-transcript').click();
await page.keyboard.type(transcript);
await page.fill('#enc-label', label);
await page.click('#btn-enc-save');
// Wait for save toast / API round-trip — watch for a save request
await page.waitForResponse(res =>
/\/api\/encounters/.test(res.url()) && res.request().method() === 'POST',
{ timeout: 10000 }
);
// Clear the form and open load popover
await page.click('#btn-enc-new');
// Transcript should now be empty after 'new'
await expect.poll(async () =>
(await page.locator('#enc-transcript').innerText()).trim(),
{ timeout: 3000 }).toBe('');
await page.click('#btn-enc-load');
await expect(page.locator('#enc-load-popover')).not.toHaveClass(/hidden/, { timeout: 5000 });
// The saved label appears in the popover list
await expect(page.locator('#enc-load-popover')).toContainText(label, { timeout: 5000 });
// Click the row for this encounter
await page.locator('#enc-load-popover').getByText(label).first().click();
// Wait for the transcript contenteditable to repopulate
await expect.poll(async () =>
(await page.locator('#enc-transcript').innerText()),
{ timeout: 5000 }).toContain('acute pharyngitis');
});
});

View file

@ -1,80 +0,0 @@
// ============================================================
// ENCOUNTER TAB — detailed workflow: transcript → generate HPI →
// refine → shorten. Uses mocked AI so tests don't burn API credits.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="encounter"]');
await page.waitForFunction(() => {
const el = document.getElementById('encounter-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
test.describe('Encounter — HPI generation workflow', () => {
test('fill transcript + generate → mocked HPI renders in output pane', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
// Fill age + setting; transcript is a contenteditable div, not a textarea
await page.fill('#enc-age', '8 years');
await page.selectOption('#enc-gender', 'Male');
await page.locator('#enc-transcript').click();
await page.keyboard.type('Chief complaint: 3-day history of fever and cough.');
// Click generate — wait for the mocked /api/generate-hpi-encounter response
const [hpiResp] = await Promise.all([
page.waitForResponse('**/api/generate-hpi-encounter'),
page.click('#enc-generate-btn'),
]);
expect(hpiResp.status()).toBe(200);
// Output container un-hides and shows the mocked text
await expect(page.locator('#enc-output')).toBeVisible();
await expect(page.locator('#enc-hpi-text')).toContainText('MOCK HPI from encounter');
});
test('refine action → fetches /api/refine and updates the rendered HPI', async ({ authedPage: _, page }) => {
// Override /api/refine to return a recognisable marker so we can tell the refined
// content replaced the original.
await mockAI(page, {
'**/api/refine': { success: true, refined: 'REFINED-MARKER: now a longer narrative.', model: 'mock-gpt' },
});
await openTab(page);
await page.fill('#enc-age', '8 years');
await page.locator('#enc-transcript').click();
await page.keyboard.type('Fever and cough 3 days.');
await page.click('#enc-generate-btn');
await expect(page.locator('#enc-hpi-text')).toContainText('MOCK HPI', { timeout: 10000 });
// Type an instruction and hit refine
await page.fill('#enc-refine-input', 'Make it longer.');
const [refineResp] = await Promise.all([
page.waitForResponse('**/api/refine'),
page.click('#enc-refine-btn'),
]);
expect(refineResp.status()).toBe(200);
await expect(page.locator('#enc-hpi-text')).toContainText('REFINED-MARKER', { timeout: 10000 });
});
test('clear transcript button empties the contenteditable', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await page.locator('#enc-transcript').click();
await page.keyboard.type('Some content.');
await expect(page.locator('#enc-transcript')).toContainText('Some content.');
await page.click('#enc-clear');
const text = await page.locator('#enc-transcript').innerText();
expect(text.trim()).toBe('');
});
});

View file

@ -1,240 +0,0 @@
// ============================================================
// EXTENSIONS TAB — full CRUD + soft-delete + restore + search
// ============================================================
// Uses the shared fixture which logs in + wires pageerror/console-error
// listeners. No AI mocking needed — Extensions is pure CRUD.
//
// Tests against the e2e container (port 3553 on host, 3000 internal).
// Each test cleans up its own rows to stay isolated.
// ============================================================
const { test, expect, E2E_BASE, getAuthToken } = require('../fixtures');
// Helper — purge everything in trash, then soft-delete every active row.
// Leaves the table empty for the next test.
async function wipeAll(request) {
const token = await getAuthToken(request);
const auth = { Authorization: 'Bearer ' + token };
async function purgeTrash() {
const r = await request.get(E2E_BASE + '/api/extensions?trash=1', { headers: auth });
const d = await r.json();
for (const item of (d.items || [])) {
await request.delete(E2E_BASE + '/api/extensions/' + item.id + '/purge', { headers: auth });
}
}
await purgeTrash(); // first purge anything already in trash
const r = await request.get(E2E_BASE + '/api/extensions', { headers: auth });
const d = await r.json();
for (const item of (d.items || [])) {
await request.delete(E2E_BASE + '/api/extensions/' + item.id, { headers: auth });
}
await purgeTrash(); // now purge the freshly-trashed rows
}
test.describe('Extensions — CRUD', () => {
test.beforeEach(async ({ request }) => {
await wipeAll(request);
});
test.afterAll(async ({ request }) => {
await wipeAll(request);
});
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="extensions"]');
// Wait for component to load
await page.waitForFunction(() => {
const el = document.getElementById('extensions-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
// Wait for first load to resolve (spinner text goes away)
await page.waitForFunction(() => {
const list = document.getElementById('ext-list');
return list && !list.innerHTML.includes('Loading');
}, { timeout: 10000 });
}
async function fillForm(page, { location, name, number, type = 'extension', notes = '' }) {
await page.click('#ext-add-btn');
await page.fill('#ext-location', location);
await page.fill('#ext-name', name);
await page.fill('#ext-number', number);
await page.selectOption('#ext-type', type);
if (notes) await page.fill('#ext-notes', notes);
await page.click('#ext-save-btn');
// Form hides after save
await expect(page.locator('#ext-form-wrap')).toHaveClass(/hidden/, { timeout: 5000 });
}
test('empty state shown before any entries', async ({ authedPage: _, page }) => {
await openTab(page);
await expect(page.locator('#ext-list')).toContainText(/No entries yet|click Add/i);
});
test('add an extension — appears in list grouped by location + type', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Main Hospital', name: 'Nursery', number: '5866', type: 'extension' });
// Location group header
await expect(page.locator('#ext-list')).toContainText('Main Hospital');
// Type subheader
await expect(page.locator('#ext-list')).toContainText(/Extensions/i);
// Card content
await expect(page.locator('.ext-card')).toContainText('5866');
await expect(page.locator('.ext-card')).toContainText('Nursery');
});
test('add a pager — routed to pagers subsection', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Clinic A', name: 'On-call', number: '1234', type: 'pager' });
await expect(page.locator('#ext-list')).toContainText('Clinic A');
await expect(page.locator('#ext-list')).toContainText(/Pagers/i);
await expect(page.locator('.ext-card')).toContainText('1234');
});
test('edit an extension — changes persist', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Main Hospital', name: 'Old Name', number: '1111', type: 'extension' });
await page.locator('.ext-card button[data-ext-action="edit"]').first().click();
await expect(page.locator('#ext-form-wrap')).not.toHaveClass(/hidden/);
await page.fill('#ext-name', 'New Name');
await page.fill('#ext-number', '2222');
await page.click('#ext-save-btn');
await expect(page.locator('#ext-form-wrap')).toHaveClass(/hidden/, { timeout: 5000 });
await expect(page.locator('.ext-card')).toContainText('New Name');
await expect(page.locator('.ext-card')).toContainText('2222');
await expect(page.locator('.ext-card')).not.toContainText('Old Name');
});
test('search — filter by location', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Main Hospital', name: 'Dept A', number: '1001', type: 'extension' });
await fillForm(page, { location: 'Clinic B', name: 'Dept B', number: '2002', type: 'extension' });
// Initially both visible
await expect(page.locator('.ext-card')).toHaveCount(2);
// Search by substring of first location
await page.fill('#ext-search', 'Main');
// Debounce is 200ms; wait for the filter to apply
await page.waitForTimeout(400);
await expect(page.locator('.ext-card')).toHaveCount(1);
await expect(page.locator('.ext-card')).toContainText('Dept A');
// Clear search — both visible again
await page.fill('#ext-search', '');
await page.waitForTimeout(400);
await expect(page.locator('.ext-card')).toHaveCount(2);
});
test('search — filter by number', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Loc', name: 'A', number: '5866', type: 'extension' });
await fillForm(page, { location: 'Loc', name: 'B', number: '1234', type: 'pager' });
await page.fill('#ext-search', '586');
await page.waitForTimeout(400);
await expect(page.locator('.ext-card')).toHaveCount(1);
await expect(page.locator('.ext-card')).toContainText('5866');
});
test('soft-delete — moves to trash, confirm dialog required', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Loc', name: 'To delete', number: '9999', type: 'extension' });
await page.locator('.ext-card button[data-ext-action="delete"]').first().click();
// In-app modal — click confirm
await page.click('#confirm-modal-ok');
// Gone from active list
await expect(page.locator('#ext-list')).toContainText(/No entries yet/i, { timeout: 5000 });
// Visible in trash view
await page.click('#ext-trash-btn');
await expect(page.locator('#ext-mode-banner')).not.toHaveClass(/hidden/);
await expect(page.locator('.ext-card')).toContainText('To delete');
});
test('restore from trash — reappears in active', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Loc', name: 'Bounceback', number: '5555', type: 'extension' });
await page.locator('.ext-card button[data-ext-action="delete"]').first().click();
await page.click('#confirm-modal-ok');
await page.click('#ext-trash-btn');
await expect(page.locator('.ext-card')).toContainText('Bounceback');
await page.locator('.ext-card button[data-ext-action="restore"]').first().click();
// Back-to-active button
await page.click('#ext-back-active');
await expect(page.locator('.ext-card')).toContainText('Bounceback');
});
test('purge from trash — permanent, second confirm', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Loc', name: 'Gone forever', number: '7777', type: 'extension' });
await page.locator('.ext-card button[data-ext-action="delete"]').first().click();
await page.click('#confirm-modal-ok');
await page.click('#ext-trash-btn');
await expect(page.locator('.ext-card')).toContainText('Gone forever');
await page.locator('.ext-card button[data-ext-action="purge"]').first().click();
await page.click('#confirm-modal-ok');
// Trash is empty
await expect(page.locator('#ext-list')).toContainText(/Trash is empty/i, { timeout: 5000 });
// Not recoverable — back-to-active view has nothing
await page.click('#ext-back-active');
await expect(page.locator('#ext-list')).toContainText(/No entries yet/i);
});
test('cancel dialog — keeps item (not deleted)', async ({ authedPage: _, page }) => {
await openTab(page);
await fillForm(page, { location: 'Loc', name: 'Stays', number: '8888', type: 'extension' });
// User cancels the modal
await page.locator('.ext-card button[data-ext-action="delete"]').first().click();
await page.click('#confirm-modal-cancel');
// Still there
await expect(page.locator('.ext-card')).toContainText('Stays');
});
test('cancel button closes form without saving', async ({ authedPage: _, page }) => {
await openTab(page);
await page.click('#ext-add-btn');
await page.fill('#ext-location', 'Should not save');
await page.fill('#ext-name', 'x');
await page.fill('#ext-number', '0');
await page.click('#ext-cancel-btn');
await expect(page.locator('#ext-form-wrap')).toHaveClass(/hidden/);
// Nothing was created
await expect(page.locator('#ext-list')).toContainText(/No entries yet/i);
});
test('form validates required fields', async ({ authedPage: _, page }) => {
await openTab(page);
await page.click('#ext-add-btn');
// Click save with empty fields
await page.click('#ext-save-btn');
await expect(page.locator('#ext-form-status')).toContainText(/required/i);
// Form stays open
await expect(page.locator('#ext-form-wrap')).not.toHaveClass(/hidden/);
});
});

View file

@ -1,76 +0,0 @@
// ============================================================
// HOSPITAL COURSE — full workflow: fill inputs → generate → verify
// mocked narrative renders → refine → verify rendered replaces.
// The older soap-hospital-workflow.spec.js only smokes the save bar;
// this one drives the actual AI generate path.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="hospital"]');
await page.waitForFunction(() => {
const el = document.getElementById('hospital-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
test.describe('Hospital Course — generate + refine', () => {
test('minimum inputs → generate → mocked narrative renders', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await page.fill('#hc-age', '9 years');
await page.selectOption('#hc-gender', 'Male');
await page.fill('#hc-pmh', 'Asthma, mild intermittent');
// H&P is the minimum "some note" the route needs so it doesn't reject
await page.locator('#hc-hp-content').click();
await page.keyboard.type('Admitted for status asthmaticus. Started on continuous albuterol and steroids.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/generate-hospital-course', { timeout: 15000 }),
page.click('#hc-generate-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#hc-output')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#hc-course-text')).toContainText('MOCK hospital course narrative');
});
test('refine button on generated course fires /api/refine + updates text', async ({ authedPage: _, page }) => {
await mockAI(page, {
'**/api/refine': { success: true, refined: 'REFINED-HC course — emphasised hospital day 1 events.', model: 'mock-gpt' },
});
await openTab(page);
await page.fill('#hc-age', '5 years');
await page.locator('#hc-hp-content').click();
await page.keyboard.type('Admission for pneumonia, improving on IV cefriaxone.');
await page.click('#hc-generate-btn');
await expect(page.locator('#hc-course-text')).toContainText('MOCK hospital course', { timeout: 10000 });
// Refine with an instruction
const refineInput = page.locator('#hc-refine-input, [id*="hc-refine"]').first();
await refineInput.fill('Tighten the prose.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/refine'),
page.click('#hc-refine-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#hc-course-text')).toContainText('REFINED-HC course', { timeout: 10000 });
});
test('load popover: opens and closes from both triggers', async ({ authedPage: _, page }) => {
await openTab(page);
await page.click('#btn-hosp-load');
await expect(page.locator('#hosp-load-popover')).not.toHaveClass(/hidden/, { timeout: 3000 });
await page.locator('#hosp-load-popover .enc-pop-close').click();
await expect(page.locator('#hosp-load-popover')).toHaveClass(/hidden/);
});
});

View file

@ -1,57 +0,0 @@
// ============================================================
// LEARNING HUB — search, category pills, feed rendering.
// Quiz flow is gated by having quiz content; just verify the UI
// scaffolding works without requiring a specific topic to exist.
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="learning"]');
await page.waitForFunction(() => {
const el = document.getElementById('learning-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
test.describe('Learning Hub — navigation + search', () => {
test('search input + categories + feed all render', async ({ authedPage: _, page }) => {
await openTab(page);
await expect(page.locator('#lh-search')).toBeVisible();
await expect(page.locator('#lh-categories')).toBeVisible();
await expect(page.locator('#lh-feed')).toBeVisible();
});
test('typing in search filters the feed (even if zero matches)', async ({ authedPage: _, page }) => {
await openTab(page);
// Wait for feed to render some content or be flagged as empty
await expect.poll(async () =>
(await page.locator('#lh-feed').innerText()).trim().length,
{ timeout: 10000 }).toBeGreaterThan(0);
const initialHtml = await page.locator('#lh-feed').innerHTML();
// Type a very specific string that likely won't match any topic
await page.fill('#lh-search', 'xyzzy-unlikely-topic-name');
// Feed should update — either to empty state or different filtered list
await expect.poll(async () =>
(await page.locator('#lh-feed').innerHTML()) !== initialHtml,
{ timeout: 3000 }).toBe(true);
});
test('clicking a category pill (if present) does not crash the UI', async ({ authedPage: _, page }) => {
await openTab(page);
const pills = page.locator('#lh-categories button, #lh-categories .category-pill');
const count = await pills.count();
test.skip(count === 0, 'No category pills rendered — nothing to test');
await pills.first().click();
// Feed must still be visible and have some content after filtering
await expect(page.locator('#lh-feed')).toBeVisible();
});
});

View file

@ -1,43 +0,0 @@
// ============================================================
// MODEL SELECTOR — each tab has its own <select.tab-model-select>
// populated by window._buildModelOptions. Verify the dropdowns
// render across tabs that should have one.
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
async function openTab(page, name) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
test.describe('Per-tab model selector', () => {
const tabsWithModelPicker = ['encounter', 'dictation', 'chart', 'soap', 'hospital', 'sickvisit', 'wellvisit'];
for (const tab of tabsWithModelPicker) {
test(`${tab}: model picker renders and has at least one option`, async ({ authedPage: _, page }) => {
await openTab(page, tab);
// Well Visit has four sub-panels each with their own picker; three of
// them are hidden until you switch to that sub-tab, so visibility is
// unreliable. Instead: require that the active tab contains at least
// one picker AND that at least one picker inside the tab has >0
// options populated by window._buildModelOptions.
const pickers = page.locator(`#${tab}-tab select.tab-model-select`);
await expect.poll(async () => pickers.count(), { timeout: 10000 })
.toBeGreaterThan(0);
await expect.poll(async () => {
return await pickers.evaluateAll(list => list.reduce((max, el) =>
Math.max(max, el.options ? el.options.length : 0), 0));
}, { timeout: 10000 }).toBeGreaterThan(0);
});
}
});

View file

@ -1,176 +0,0 @@
// ============================================================
// PE GUIDE — smoke tests for the Physical Exam Guide tab
// ============================================================
// Exercises the full rendering path: tab load → age group selection →
// system switching (msk / neuro / resp / cv) → expected per-system
// cards (scales, sounds library for resp, APTM image + innocent
// murmur panel for cv) → step toggle interaction.
//
// Uses the shared fixture so any uncaught JS error or console.error
// fails the test automatically (catches a repeat of the SSO-bug
// class on this page).
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
async function openPEGuide(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
// On mobile the sidebar collapses behind a hamburger. Open it so the
// tab button is actually in the viewport before we click it.
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="peguide"]');
await page.waitForFunction(() => {
const el = document.getElementById('peguide-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
async function selectAge(page, value) {
await page.selectOption('#pe-age-group', value);
// Wait for components to render (at least one card with a step)
await page.waitForFunction(() => {
return document.querySelectorAll('#pe-content .pe-step').length > 0;
}, { timeout: 5000 });
}
async function switchSystem(page, sys) {
await page.click('button.wv-subtab-btn[data-pesystem="' + sys + '"]');
// Either steps are there, or the resp/cv cards are (which have no .pe-step)
await page.waitForFunction((s) => {
const content = document.getElementById('pe-content');
if (!content) return false;
if (s === 'resp') return content.innerHTML.includes('Respiratory sounds library');
if (s === 'cv') return content.innerHTML.includes('Auscultation landmarks');
return content.querySelectorAll('.pe-step').length > 0;
}, sys, { timeout: 5000 });
}
test.describe('PE Guide — smoke', () => {
test('tab loads with empty-state message before age group selected', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await expect(page.locator('#pe-content')).toContainText(/Select an age group/i);
});
test('MSK (default) renders with overview and grading scales for adolescent', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await expect(page.locator('#pe-content')).toContainText('Musculoskeletal');
await expect(page.locator('#pe-content')).toContainText(/Scoliometer|Beighton/);
// At least one step card present
await expect(page.locator('.pe-step').first()).toBeVisible();
});
test('switches to Neuro and shows MRC scale + teaching pearl', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await switchSystem(page, 'neuro');
await expect(page.locator('#pe-content')).toContainText('Neurologic');
await expect(page.locator('#pe-content')).toContainText(/MRC strength/i);
// Teaching pearl rendered (amber block)
await expect(page.locator('#pe-content')).toContainText(/Pronator drift/i);
});
test('Respiratory system shows the 7-sound library, all with real audio players', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await switchSystem(page, 'resp');
await expect(page.locator('#pe-content')).toContainText('Respiratory sounds library');
// All 7 sounds must render as native <audio controls> elements (pause/seek available)
const audioPlayers = page.locator('#pe-content .pe-audio');
await expect(audioPlayers).toHaveCount(7);
// Every one has a src attribute pointing at /audio/respiratory/*.ogg (no synth fallbacks)
const srcs = await audioPlayers.evaluateAll(els => els.map(e => e.getAttribute('src')));
for (const src of srcs) {
expect(src, 'respiratory audio src').toMatch(/^\/audio\/respiratory\/.+\.ogg$/);
}
// Grunting entry must NOT appear in the SOUND LIBRARY (removed — no openly-licensed
// recording). The phrase "expiratory grunting" still appears in clinical teaching
// steps, which is fine; just assert the sounds library has no grunting card.
const libraryText = await page
.locator('#pe-content .card')
.filter({ hasText: /Respiratory sounds library/i })
.innerText();
expect(libraryText).not.toMatch(/Grunting/i);
// RR scale renders
await expect(page.locator('#pe-content')).toContainText(/Respiratory rate/i);
// Observation-first inspection card present
await expect(page.locator('#pe-content')).toContainText(/Inspection/i);
});
test('Cardiovascular system shows APTM image + all 5 landmarks + innocent murmur panel', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await switchSystem(page, 'cv');
// APTM diagram image loaded
const aptmImg = page.locator('img[src*="aptm.png"]');
await expect(aptmImg).toBeVisible();
// Wait for it to actually have painted pixels (naturalWidth > 0 = fetched successfully)
await expect.poll(async () => {
return await aptmImg.evaluate(el => el.naturalWidth);
}, { timeout: 10000 }).toBeGreaterThan(0);
// All 5 landmark letters in the legend
for (const letter of ['A', 'P', 'E', 'T', 'M']) {
await expect(page.locator('#pe-content')).toContainText(letter);
}
// Innocent murmur panel
await expect(page.locator('#pe-content')).toContainText(/Innocent murmurs/i);
await expect(page.locator('#pe-content')).toContainText(/Still.s/i);
await expect(page.locator('#pe-content')).toContainText(/Venous hum/i);
// 7 "S" criteria footer
await expect(page.locator('#pe-content')).toContainText(/7.*S/);
});
test('each age group has resp + cv data (no "no data" empty state)', async ({ authedPage: _, page }) => {
await openPEGuide(page);
const ages = ['newborn', 'infant', 'toddler', 'preschool', 'school', 'adolescent'];
for (const age of ages) {
await selectAge(page, age);
for (const sys of ['resp', 'cv']) {
await switchSystem(page, sys);
// Must NOT show the "no data" placeholder
const content = await page.locator('#pe-content').innerText();
expect(content, `${age}/${sys} should have data`).not.toMatch(/No data for this combination/i);
// Should have at least one component card with at least one step
const stepCount = await page.locator('.pe-step').count();
expect(stepCount, `${age}/${sys} should have at least 1 step`).toBeGreaterThan(0);
}
}
});
test('step toggle cycles Normal → Abnormal → Skip and updates visual state', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await switchSystem(page, 'neuro');
const firstStep = page.locator('.pe-step').first();
// Click Normal (✓) button
await firstStep.locator('button[data-pe-status="normal"]').click();
// Background should turn green (#ecfdf5)
await expect.poll(async () => {
return await firstStep.evaluate(el => el.style.background);
}).toMatch(/rgb\(236, 253, 245\)|#ecfdf5/);
// Click Abnormal (✗) — note field should appear
await firstStep.locator('button[data-pe-status="abnormal"]').click();
await expect(firstStep.locator('.pe-note')).toBeVisible();
// Click Skip (—) — note field hides
await firstStep.locator('button[data-pe-status="skip"]').click();
await expect(firstStep.locator('.pe-note')).toBeHidden();
});
test('grading scales card is collapsible and expands on click', async ({ authedPage: _, page }) => {
await openPEGuide(page);
await selectAge(page, 'adolescent');
await switchSystem(page, 'neuro');
// <details> element with "Grading scales" summary
const details = page.locator('details').filter({ hasText: /Grading scales/ });
await expect(details).toBeVisible();
// Open it
await details.locator('summary').click();
// Should now see at least one scale title
await expect(details).toContainText(/MRC strength/);
});
});

View file

@ -1,87 +0,0 @@
// ============================================================
// SESSION PERSISTENCE — full logout → login → still on the same
// tab + same sub-pill.
//
// The test does a programmatic logout (clear the ped_auth cookie,
// same effect server-side as clicking Logout) followed by a fresh
// programmatic login. This exercises the same localStorage
// persistence path a real logout/login would.
//
// (Historically this was a workaround for the Turnstile challenge on
// the login form, which could not be completed in the e2e container.
// Login is no longer gated, but driving it programmatically keeps
// the test focused on persistence rather than form mechanics.)
// ============================================================
const { test, expect, E2E_BASE, loginAs } = require('../fixtures');
async function openDesktopTab(page, name) {
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
async function logoutClearsCookie(context) {
// Remove the ped_auth cookie — identical server-side to hitting /logout.
const cookies = await context.cookies();
const keep = cookies.filter(c => c.name !== 'ped_auth');
await context.clearCookies();
if (keep.length) await context.addCookies(keep);
}
test.describe('Logout → login restores last tab + sub-pill', () => {
test('tab choice + calc pill survive a full logout/login cycle', async ({ context, request, page }) => {
await loginAs(context, request);
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
await openDesktopTab(page, 'calculators');
await page.click('button.calc-nav-pill[data-calc="bili"]');
await expect(page.locator('button.calc-nav-pill[data-calc="bili"].active')).toBeVisible();
// Simulate logout (clear session cookie)
await logoutClearsCookie(context);
// Visiting the app with no cookie lands on the auth screen
await page.goto(E2E_BASE + '/');
await expect(page.locator('#auth-screen')).toBeVisible({ timeout: 10000 });
// Log back in (fresh cookie) and revisit the app
await loginAs(context, request);
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
// Restore must put us back on Calculators / Bilirubin pill
await expect(page.locator('#calculators-tab.active')).toHaveCount(1, { timeout: 10000 });
await expect(page.locator('button.calc-nav-pill[data-calc="bili"].active')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#calc-bili')).not.toHaveClass(/hidden/);
});
test('bedside sub-pill survives logout/login', async ({ context, request, page }) => {
await loginAs(context, request);
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
await openDesktopTab(page, 'bedside');
await page.click('button.calc-pill[data-em="sepsis"]');
await expect(page.locator('button.calc-pill[data-em="sepsis"].active')).toBeVisible();
await logoutClearsCookie(context);
await page.goto(E2E_BASE + '/');
await expect(page.locator('#auth-screen')).toBeVisible({ timeout: 10000 });
await loginAs(context, request);
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
await expect(page.locator('#bedside-tab.active')).toHaveCount(1, { timeout: 10000 });
await expect(page.locator('button.calc-pill[data-em="sepsis"].active')).toBeVisible({ timeout: 10000 });
await expect.poll(async () =>
await page.locator('#em-sepsis').evaluate(el => el.style.display),
{ timeout: 5000 }).not.toBe('none');
});
});

View file

@ -1,115 +0,0 @@
// ============================================================
// SETTINGS + FAQ + DICTATION — detailed UI exercises that
// don't depend on real AI / recording permissions.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page, name) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
test.describe('Settings — voice, password, nextcloud sections render', () => {
test('voice-preferences inputs + save button exist', async ({ authedPage: _, page }) => {
await openTab(page, 'settings');
// STT and TTS dropdowns populate; save button exists
await expect(page.locator('#stt-model-select')).toBeVisible();
await expect(page.locator('#tts-voice-select')).toBeVisible();
await expect(page.locator('#btn-save-voice-prefs')).toBeVisible();
});
test('change-password form: all three fields + submit button present', async ({ authedPage: _, page }) => {
await openTab(page, 'settings');
await expect(page.locator('#pw-current')).toBeVisible();
await expect(page.locator('#pw-new')).toBeVisible();
await expect(page.locator('#pw-confirm')).toBeVisible();
await expect(page.locator('#btn-change-password')).toBeVisible();
});
test('2FA setup panel has QR container + verify input', async ({ authedPage: _, page }) => {
await openTab(page, 'settings');
// At least one of the 2FA buttons should be present
const setupCount = await page.locator('#btn-setup-2fa').count();
const disableCount = await page.locator('#btn-disable-2fa').count();
expect(setupCount + disableCount).toBeGreaterThan(0);
});
test('Nextcloud section: URL/user/pass fields render', async ({ authedPage: _, page }) => {
await openTab(page, 'settings');
await expect(page.locator('#nc-url')).toBeVisible();
await expect(page.locator('#nc-user')).toBeVisible();
await expect(page.locator('#nc-pass')).toBeVisible();
});
});
test.describe('FAQ — questions expand + collapse on click', () => {
test('clicking a FAQ question reveals its answer panel', async ({ authedPage: _, page }) => {
await openTab(page, 'faq');
const questions = page.locator('.faq-question');
const count = await questions.count();
expect(count).toBeGreaterThan(0);
const first = questions.first();
await first.click();
// The corresponding answer should become visible — either via class toggle or
// inline style. Grab the sibling / next matching answer element and check.
const ariaControls = await first.getAttribute('aria-controls');
if (ariaControls) {
await expect(page.locator('#' + ariaControls)).toBeVisible();
} else {
// Fallback: any .faq-answer becomes visible
await expect(page.locator('.faq-answer').first()).toBeVisible();
}
});
});
test.describe('Dictation — UI loads, transcript editable, clear works', () => {
test('age/gender/setting inputs + generate + clear all render', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page, 'dictation');
await expect(page.locator('#dict-age')).toBeVisible();
await expect(page.locator('#dict-gender')).toBeVisible();
await expect(page.locator('#dict-setting')).toBeVisible();
await expect(page.locator('#dict-transcript')).toBeVisible();
await expect(page.locator('#dict-generate-btn')).toBeVisible();
});
test('typing into transcript + clear empties it', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page, 'dictation');
await page.locator('#dict-transcript').click();
await page.keyboard.type('Chief complaint: sore throat.');
await expect(page.locator('#dict-transcript')).toContainText('sore throat');
await page.click('#dict-clear');
const text = await page.locator('#dict-transcript').innerText();
expect(text.trim()).toBe('');
});
test('generate with short transcript → mocked HPI renders', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page, 'dictation');
await page.fill('#dict-age', '6 years');
await page.locator('#dict-transcript').click();
await page.keyboard.type('Patient with cough and congestion for 2 days.');
// Default output type is HPI — should call /api/generate-hpi-dictation
const [resp] = await Promise.all([
page.waitForResponse('**/api/generate-hpi-dictation'),
page.click('#dict-generate-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#dict-output')).toBeVisible();
await expect(page.locator('#dict-hpi-text')).toContainText('MOCK HPI from dictation');
});
});

View file

@ -1,89 +0,0 @@
// ============================================================
// SICK VISIT — detailed workflow tests
// Fills the form, generates a mocked note, verifies output render
// and the refine + clear flows.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="sickvisit"]');
await page.waitForFunction(() => {
const el = document.getElementById('sickvisit-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
test.describe('Sick Visit — generate workflow', () => {
test('fill demographics + CC + transcript → mocked note renders', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await page.fill('#sick-age', '6 years');
await page.selectOption('#sick-gender', 'Male');
await page.fill('#sick-cc', 'Sore throat x 3 days');
await page.locator('#sick-transcript').click();
await page.keyboard.type('6yo with 3 days sore throat, fever, fatigue. No rash.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/sick-visit/note', { timeout: 15000 }),
page.click('#btn-sick-generate'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#sick-note-output')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#sick-note-text')).toContainText('MOCK sick visit note');
});
test('refine button fires /api/refine and updates the rendered note', async ({ authedPage: _, page }) => {
await mockAI(page, {
'**/api/refine': { success: true, refined: 'REFINED sick-visit note — added return precautions.', model: 'mock-gpt' },
});
await openTab(page);
await page.fill('#sick-age', '4 years');
await page.fill('#sick-cc', 'Cough');
await page.locator('#sick-transcript').click();
await page.keyboard.type('Cough x 2 days, no fever, hydrating OK.');
await page.click('#btn-sick-generate');
await expect(page.locator('#sick-note-text')).toContainText('MOCK sick visit note', { timeout: 10000 });
await page.fill('#sick-refine-input', 'Add return precautions.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/refine'),
page.click('#sick-refine-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#sick-note-text')).toContainText('REFINED sick-visit note', { timeout: 10000 });
});
test('load popover opens and closes', async ({ authedPage: _, page }) => {
await openTab(page);
await page.click('#btn-sick-load');
await expect(page.locator('#sick-load-popover')).not.toHaveClass(/hidden/, { timeout: 3000 });
// Close by clicking the close button inside the popover
await page.locator('#sick-load-popover .enc-pop-close').click();
await expect(page.locator('#sick-load-popover')).toHaveClass(/hidden/);
});
test('New button clears demographics + transcript for a new patient', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await page.fill('#sick-age', '5 years');
await page.selectOption('#sick-gender', 'Male');
await page.locator('#sick-transcript').click();
await page.keyboard.type('Temporary transcript');
await page.click('#btn-sick-new');
// clearTab() resets demographics + transcript (chief complaint is left so a
// rapid "next patient with same complaint" doesn't have to retype it).
await expect(page.locator('#sick-age')).toHaveValue('');
await expect(page.locator('#sick-gender')).toHaveValue('');
const txt = await page.locator('#sick-transcript').innerText();
expect(txt.trim()).toBe('');
});
});

View file

@ -1,75 +0,0 @@
// ============================================================
// SOAP + HOSPITAL COURSE — detailed workflow for the two notes
// tabs that previously only had smoke coverage.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page, name) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
test.describe('SOAP Note — generate + refine', () => {
test('fill transcript + generate → mocked SOAP renders', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page, 'soap');
await page.fill('#soap-age', '5 years');
await page.selectOption('#soap-gender', 'Male');
await page.locator('#soap-transcript').click();
await page.keyboard.type('Patient presents with 3 days of fever, cough, and runny nose.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/generate-soap', { timeout: 15000 }),
page.click('#soap-generate-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#soap-output')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#soap-text')).toContainText('MOCK SOAP NOTE');
});
test('clear transcript button empties the contenteditable', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page, 'soap');
await page.locator('#soap-transcript').click();
await page.keyboard.type('some transcript');
await expect(page.locator('#soap-transcript')).toContainText('some transcript');
await page.click('#soap-clear');
const text = await page.locator('#soap-transcript').innerText();
expect(text.trim()).toBe('');
});
test('load popover opens and closes', async ({ authedPage: _, page }) => {
await openTab(page, 'soap');
await page.click('#btn-soap-load').catch(() => page.click('button[id*="soap-load"]'));
await expect(page.locator('#soap-load-popover')).not.toHaveClass(/hidden/, { timeout: 3000 });
});
});
test.describe('Hospital Course — tab loads with save/load bar', () => {
test('tab renders with label input + save/load/new buttons', async ({ authedPage: _, page }) => {
await openTab(page, 'hospital');
await expect(page.locator('#hosp-label')).toBeVisible();
await expect(page.locator('#hosp-save-bar')).toBeVisible();
});
test('load popover opens and closes', async ({ authedPage: _, page }) => {
await openTab(page, 'hospital');
// Any button with id that looks like load
const loadBtn = page.locator('button[id*="hosp-load"], button[id*="btn-hosp-load"]').first();
await loadBtn.click();
await expect(page.locator('#hosp-load-popover')).not.toHaveClass(/hidden/, { timeout: 3000 });
});
});

View file

@ -1,220 +0,0 @@
// Smoke tests for the 10 top-row calculator tabs (everything except Bedside).
// Each test navigates to its tab, fills inputs, clicks Calculate/Assess,
// and asserts a known string appears in the result. Catches the "tab loads
// but button does nothing" class of regression.
const { test, expect } = require('@playwright/test');
async function openCalculators(page) {
await page.goto('/e2e-harness.html');
await page.waitForFunction(() => window.__harnessReady === true);
await page.waitForSelector('button.calc-nav-pill[data-calc="bp"]');
}
async function selectTab(page, tabName) {
await page.click(`button.calc-nav-pill[data-calc="${tabName}"]`);
await expect(page.locator(`#calc-${tabName}`)).toBeVisible();
}
test.describe('Top-level calculators — panel loads', () => {
const tabs = ['bp', 'bmi', 'growth', 'bili', 'vitals', 'bsa', 'dose', 'resus', 'gcs', 'equipment'];
for (const tab of tabs) {
test(`${tab} panel becomes visible when pill clicked`, async ({ page }) => {
await openCalculators(page);
await selectTab(page, tab);
});
}
});
test.describe('Blood Pressure percentile', () => {
test('5 yr, male, height 110, BP 105/65 → produces a result', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bp');
await page.fill('#bp-age', '5');
await page.selectOption('#bp-sex', 'male');
await page.fill('#bp-height', '110');
await page.fill('#bp-systolic', '105');
await page.fill('#bp-diastolic', '65');
await page.click('#btn-calc-bp');
await expect(page.locator('#bp-result')).not.toHaveClass(/hidden/);
// Result should mention a percentile or classification
await expect(page.locator('#bp-result')).toContainText(/percentile|Normal|Elevated|HTN|Stage/i);
});
test('Clear button hides result', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bp');
await page.fill('#bp-age', '5');
await page.selectOption('#bp-sex', 'male');
await page.fill('#bp-height', '110');
await page.fill('#bp-systolic', '105');
await page.fill('#bp-diastolic', '65');
await page.click('#btn-calc-bp');
await page.click('#btn-clear-bp');
await expect(page.locator('#bp-result')).toHaveClass(/hidden/);
await expect(page.locator('#bp-age')).toHaveValue('');
});
});
test.describe('BMI percentile', () => {
test('7 yr, male, 25 kg, 120 cm → BMI computed', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bmi');
await page.fill('#bmi-age-yr', '7');
await page.selectOption('#bmi-age-mo', '0');
await page.selectOption('#bmi-sex', 'male');
await page.fill('#bmi-weight', '25');
await page.fill('#bmi-height', '120');
await page.click('#btn-calc-bmi');
await expect(page.locator('#bmi-result')).not.toHaveClass(/hidden/);
// BMI = 25 / 1.20² = 17.36 — expect something recognizable
await expect(page.locator('#bmi-result')).toContainText(/17\.|BMI|percentile/i);
});
});
test.describe('Body Surface Area (Mosteller)', () => {
test('20 kg, 110 cm → BSA shown', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bsa');
await page.fill('#bsa-weight', '20');
await page.fill('#bsa-height', '110');
await page.click('#btn-calc-bsa');
await expect(page.locator('#bsa-result')).not.toHaveClass(/hidden/);
// sqrt(110*20/3600) = 0.782
await expect(page.locator('#bsa-result')).toContainText(/0\.78|BSA|m²|m2/i);
});
});
test.describe('Weight-based dosing', () => {
test('15 kg × 10 mg/kg → 150 mg shown', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'dose');
await page.fill('#dose-weight', '15');
await page.fill('#dose-per-kg', '10');
await page.click('#btn-calc-dose');
await expect(page.locator('#dose-result')).not.toHaveClass(/hidden/);
await expect(page.locator('#dose-result')).toContainText(/150/);
});
test('Max cap respected: 15 kg × 100 mg/kg capped at 500 mg', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'dose');
await page.fill('#dose-weight', '15');
await page.fill('#dose-per-kg', '100');
await page.fill('#dose-max', '500');
await page.click('#btn-calc-dose');
await expect(page.locator('#dose-result')).toContainText(/500/);
});
});
test.describe('Growth charts', () => {
test('3 yr male, 14 kg → Weight-for-Age result', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'growth');
await page.selectOption('#growth-sex', 'male');
await page.fill('#growth-age-yr', '3');
await page.fill('#growth-weight', '14');
await page.click('#btn-calc-growth');
await expect(page.locator('#growth-result')).not.toHaveClass(/hidden/);
await expect(page.locator('#growth-result')).toContainText(/percentile|z-score|%ile|z=/i);
});
test('Sub-pill switches to Length-for-Age', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'growth');
await page.click('button.calc-pill[data-growth="lfa"]');
await expect(page.locator('button.calc-pill[data-growth="lfa"]')).toHaveClass(/active/);
});
});
test.describe('Bilirubin (AAP 2022)', () => {
test('GA 38, age 48h, TSB 12.5, no risk factors → AAP assessment', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bili');
await page.selectOption('#bili-ga', '38');
await page.fill('#bili-age-hours', '48');
await page.fill('#bili-tsb', '12.5');
await page.selectOption('#bili-risk', 'none');
await page.click('#btn-calc-bili-aap');
await expect(page.locator('#bili-result')).not.toHaveClass(/hidden/);
await expect(page.locator('#bili-result')).toContainText(/phototherapy|threshold|AAP|bilirubin/i);
});
test('Bhutani sub-pill: age 48h, TSB 8.5 → risk zone', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'bili');
await page.click('button.calc-pill[data-bili="bhutani"]');
await page.fill('#bhutani-age', '48');
await page.fill('#bhutani-tsb', '8.5');
await page.click('#btn-calc-bhutani');
await expect(page.locator('#bili-result')).not.toHaveClass(/hidden/);
await expect(page.locator('#bili-result')).toContainText(/risk|zone|low|high|intermediate/i);
});
});
test.describe('Vital signs reference', () => {
test('Selecting 1-3 yr shows HR range', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'vitals');
await page.selectOption('#vitals-age-select', '1-3yr');
await expect(page.locator('#vitals-result')).not.toHaveClass(/hidden/);
// Expected: HR 70-110
await expect(page.locator('#vitals-result')).toContainText(/70|HR/i);
});
});
test.describe('Resus meds', () => {
test('15 kg → multiple weight-based drug doses rendered', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'resus');
await page.fill('#resus-weight', '15');
await page.click('#btn-calc-resus');
await expect(page.locator('#resus-result')).not.toHaveClass(/hidden/);
// At least epinephrine + atropine should appear for any resus dose table
await expect(page.locator('#resus-result')).toContainText(/epinephrine|epi/i);
await expect(page.locator('#resus-result')).toContainText(/atropine/i);
});
});
test.describe('Glasgow Coma Scale', () => {
test('Child defaults (4/5/6) → GCS 15 shown', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'gcs');
// selects default to max scores → 4+5+6 = 15
await expect(page.locator('#gcs-result')).toContainText(/15/);
});
test('Changing motor to "None" (1) → GCS drops', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'gcs');
await page.selectOption('#gcs-child-motor', '1');
await expect(page.locator('#gcs-result')).toContainText(/10/); // 4+5+1
});
test('Switch to infant panel', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'gcs');
await page.click('button.calc-pill[data-gcs="infant"]');
await expect(page.locator('#gcs-infant-panel')).toBeVisible();
await expect(page.locator('#gcs-child-panel')).toBeHidden();
});
});
test.describe('Equipment sizing', () => {
test('Selecting "1 year" renders sizes', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'equipment');
await page.selectOption('#equip-age-select', '1yr');
await expect(page.locator('#equip-result')).not.toHaveClass(/hidden/);
// Should mention ETT and at least one other item
await expect(page.locator('#equip-result')).toContainText(/ETT|Endotracheal/i);
});
test('Selecting empty option hides result', async ({ page }) => {
await openCalculators(page);
await selectTab(page, 'equipment');
await page.selectOption('#equip-age-select', '1yr');
await page.selectOption('#equip-age-select', '');
await expect(page.locator('#equip-result')).toHaveClass(/hidden/);
});
});

View file

@ -1,89 +0,0 @@
// ============================================================
// UI STATE PERSISTENCE — sub-pill / sub-tab choices survive a
// full page reload (simulating sign-out / sign-in or browser
// restart). Guards against regressions in the ui-state.js +
// localStorage wiring.
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
async function gotoHome(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
}
async function openDesktopTab(page, name) {
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
test.describe('UI state survives page reload', () => {
test('ped_last_tab → user lands on last-active tab after reload', async ({ authedPage: _, page }) => {
await gotoHome(page);
await openDesktopTab(page, 'calculators');
// Reload (keeps cookie, clears _componentCache + in-memory DOM state)
await page.reload();
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
await expect.poll(async () => {
return await page.locator('#calculators-tab.active').count();
}, { timeout: 5000 }).toBe(1);
});
test('calculators nav pill persists across reload', async ({ authedPage: _, page }) => {
await gotoHome(page);
await openDesktopTab(page, 'calculators');
// Switch to GCS
await page.click('button.calc-nav-pill[data-calc="gcs"]');
await expect(page.locator('button.calc-nav-pill[data-calc="gcs"].active')).toBeVisible();
await page.reload();
await page.waitForSelector('button.calc-nav-pill[data-calc="gcs"]', { timeout: 15000 });
// Same pill should be active after reload
await expect(page.locator('button.calc-nav-pill[data-calc="gcs"].active')).toBeVisible({ timeout: 5000 });
// And the corresponding panel should be un-hidden
await expect(page.locator('#calc-gcs')).not.toHaveClass(/hidden/);
});
test('bedside sub-pill persists across reload', async ({ authedPage: _, page }) => {
await gotoHome(page);
await openDesktopTab(page, 'bedside');
await page.click('button.calc-pill[data-em="anaphylaxis"]');
await expect(page.locator('button.calc-pill[data-em="anaphylaxis"].active')).toBeVisible();
await page.reload();
await page.waitForSelector('button.calc-pill[data-em="anaphylaxis"]', { timeout: 15000 });
await expect(page.locator('button.calc-pill[data-em="anaphylaxis"].active')).toBeVisible({ timeout: 5000 });
// The anaphylaxis em-section should be the visible one
await expect.poll(async () => {
return await page.locator('#em-anaphylaxis').evaluate(el => el.style.display);
}, { timeout: 5000 }).not.toBe('none');
});
test('well-visit sub-tab persists across reload', async ({ authedPage: _, page }) => {
await gotoHome(page);
await openDesktopTab(page, 'wellvisit');
await page.click('button.wv-subtab-btn[data-subtab="milestones"]');
await expect(page.locator('#wv-panel-milestones')).not.toHaveClass(/hidden/);
await page.reload();
await page.waitForSelector('button.wv-subtab-btn[data-subtab="milestones"]', { timeout: 15000 });
await expect(page.locator('#wv-panel-milestones')).not.toHaveClass(/hidden/, { timeout: 5000 });
});
test('PE guide age group + system persist across reload', async ({ authedPage: _, page }) => {
await gotoHome(page);
await openDesktopTab(page, 'peguide');
await page.selectOption('#pe-age-group', 'adolescent');
await page.click('button[data-pesystem="neuro"]');
await expect(page.locator('button[data-pesystem="neuro"].active')).toBeVisible();
await page.reload();
await page.waitForSelector('#pe-age-group', { timeout: 15000 });
await expect(page.locator('#pe-age-group')).toHaveValue('adolescent', { timeout: 5000 });
await expect(page.locator('button[data-pesystem="neuro"].active')).toBeVisible({ timeout: 5000 });
});
});

View file

@ -1,52 +0,0 @@
// ============================================================
// VAX SCHEDULE + CATCH-UP — content renders into the stub panels.
// These tabs have no inputs; they just display the AAP/ACIP tables.
// Verify: real content (not just "Loading") + at least a few
// recognisable vaccine abbreviations show up.
// ============================================================
const { test, expect, E2E_BASE } = require('../fixtures');
async function openTab(page, name) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click(`button.tab-btn[data-tab="${name}"]`);
await page.waitForFunction((t) => {
const el = document.getElementById(t + '-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, name, { timeout: 15000 });
}
test.describe('Vaccine schedules — content loaded', () => {
test('vaxschedule: panel populates beyond the loading placeholder', async ({ authedPage: _, page }) => {
await openTab(page, 'vaxschedule');
await expect.poll(async () => {
const text = await page.locator('#wv-panel-schedule').innerText();
return text;
}, { timeout: 10000 }).not.toMatch(/^Loading schedule/i);
// Must mention at least a couple of the core childhood vaccines
const text = await page.locator('#wv-panel-schedule').innerText();
expect(text).toMatch(/HepB|Hep B/i);
expect(text).toMatch(/MMR/i);
expect(text).toMatch(/DTaP|Tdap/i);
});
test('catchup: panel populates with the catch-up schedule', async ({ authedPage: _, page }) => {
await openTab(page, 'catchup');
await expect.poll(async () => {
const text = await page.locator('#wv-panel-catchup').innerText();
return text;
}, { timeout: 10000 }).not.toMatch(/^Loading catch-up/i);
const text = await page.locator('#wv-panel-catchup').innerText();
expect(text.trim().length).toBeGreaterThan(200);
// Should mention interval guidance in some form
expect(text).toMatch(/interval|month|week/i);
});
});

View file

@ -1,133 +0,0 @@
// ============================================================
// WELL VISIT — detailed workflow across the 4 sub-tabs:
// 1. By Visit Age (reference display)
// 2. Milestones — generate narrative from toggles
// 3. SSHADESS — generate psychosocial assessment
// 4. Visit Note — end-to-end generate a well-child note
// All AI calls are mocked.
// ============================================================
const { test, expect, E2E_BASE, mockAI } = require('../fixtures');
async function openTab(page) {
await page.goto(E2E_BASE + '/');
await page.waitForSelector('button.tab-btn', { timeout: 15000 });
const vp = page.viewportSize();
if (vp && vp.width <= 768) {
await page.click('#btn-menu-toggle').catch(() => {});
}
await page.click('button.tab-btn[data-tab="wellvisit"]');
await page.waitForFunction(() => {
const el = document.getElementById('wellvisit-tab');
return el && el.classList.contains('active') && el.innerHTML.trim().length > 100;
}, { timeout: 15000 });
}
async function openSubtab(page, key) {
await page.click(`button.wv-subtab-btn[data-subtab="${key}"]`);
await page.waitForFunction(
(k) => !document.getElementById('wv-panel-' + k).classList.contains('hidden'),
key,
{ timeout: 5000 }
);
}
test.describe('Well Visit — detailed workflows', () => {
test('By Visit Age — selecting a visit age renders content detail', async ({ authedPage: _, page }) => {
await openTab(page);
await openSubtab(page, 'byvisit');
// Dropdown must exist and be non-empty
const options = await page.locator('#wv-visit-select option').count();
expect(options).toBeGreaterThan(1);
// Pick the 2nd option (skip placeholder). Detail container should populate.
await page.selectOption('#wv-visit-select', { index: 1 });
await expect.poll(async () =>
(await page.locator('#wv-visit-detail').innerText()).trim().length,
{ timeout: 5000 }).toBeGreaterThan(0);
});
test('Milestones — toggle "All yes" then generate → narrative renders', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await openSubtab(page, 'milestones');
await page.fill('#ms-age', '12 months');
await page.selectOption('#ms-gender', 'Male');
// Age group picker — pick the first real option if there is a placeholder
const optCount = await page.locator('#ms-age-group option').count();
if (optCount > 1) await page.selectOption('#ms-age-group', { index: 1 });
// Mark everything achieved (the "All yes" action), wait for checklist to have at least one item
await page.waitForFunction(() => document.querySelectorAll('#milestone-checklist .milestone-row').length > 0, null, { timeout: 5000 }).catch(() => {});
await page.click('#ms-all-yes').catch(() => {});
const [resp] = await Promise.all([
page.waitForResponse('**/api/generate-milestone-narrative'),
page.click('#ms-generate-btn'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#ms-narrative-text')).toContainText('MOCK developmental narrative', { timeout: 10000 });
});
test('SSHADESS — domain list renders + generate fires /api/well-visit/shadess', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
// The SSHADESS subtab button is display:none until the user picks a 12+
// visit in byvisit. Iterate the visit dropdown options and pick one whose
// value looks like a 12+ year visit.
await openSubtab(page, 'byvisit');
await page.waitForFunction(() => document.querySelectorAll('#wv-visit-select option').length > 2, null, { timeout: 5000 });
const adolescentOpt = await page.locator('#wv-visit-select option').evaluateAll((opts) => {
const match = opts.find(o => /1[2-8].*(year|yr)/i.test(o.textContent || '') || /1[2-8].*year/i.test(o.value || ''));
return match ? match.value : null;
});
if (!adolescentOpt) test.skip(true, 'No 12+ visit option in dropdown — cannot expose SSHADESS subtab');
await page.selectOption('#wv-visit-select', adolescentOpt);
// Now the shadess subtab button becomes visible
await expect(page.locator('button.wv-subtab-btn[data-subtab="shadess"]')).toBeVisible({ timeout: 5000 });
await openSubtab(page, 'shadess');
// Age 14 — should surface SSHADESS (12+ only)
await page.fill('#shadess-age', '14 years');
await page.selectOption('#shadess-gender', 'Female');
// Wait for domains to render — JS populates after age/gender are set
await expect.poll(async () =>
(await page.locator('#shadess-domains').innerText()).trim().length,
{ timeout: 5000 }).toBeGreaterThan(0);
// Generate refuses with a toast if no domain has data. Fill the first
// domain's free-text comment so hasData is true.
await page.locator('.shadess-comment').first().fill('Lives at home with parents, supportive environment.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/well-visit/shadess', { timeout: 10000 }),
page.click('#btn-shadess-generate'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#shadess-result-text')).toContainText('MOCK SSHADESS', { timeout: 10000 });
});
test('Visit Note — minimal generate → mocked well-visit note in output', async ({ authedPage: _, page }) => {
await mockAI(page);
await openTab(page);
await openSubtab(page, 'note');
await page.fill('#wv-note-age', '5 years');
await page.selectOption('#wv-note-gender', 'Male');
// Provide a vitals string so the request body has something
await page.fill('#wv-vitals', 'T 37.0, HR 95, RR 22, BP 95/60, SpO2 99% RA');
// Use the transcript area for content
await page.locator('#wv-transcript').click();
await page.keyboard.type('Parent reports child is doing well; no concerns.');
const [resp] = await Promise.all([
page.waitForResponse('**/api/well-visit/note', { timeout: 15000 }),
page.click('#btn-wv-generate'),
]);
expect(resp.status()).toBe(200);
await expect(page.locator('#wv-note-output')).toBeVisible({ timeout: 10000 });
await expect(page.locator('#wv-note-text')).toContainText('MOCK well visit note', { timeout: 10000 });
});
});

View file

@ -1,25 +0,0 @@
/**
* Personal Notes lightweight per-user scratchpad living under
* Clinical Tools. Distinct from user_memories (which feed AI
* prompts as style hints / templates): personal_notes are pure
* clinician notes, never injected into an AI call. Title + rich-
* text body, encrypted at rest like memories so row dumps are
* useless without the app crypto key.
*/
exports.up = (pgm) => {
pgm.createTable('personal_notes', {
id: { type: 'serial', primaryKey: true },
user_id: { type: 'integer', notNull: true, references: 'users(id)', onDelete: 'CASCADE' },
title: { type: 'text', notNull: true },
body: { type: 'text', notNull: true, default: '' },
created_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
updated_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
});
pgm.createIndex('personal_notes', 'user_id');
pgm.createIndex('personal_notes', ['user_id', 'updated_at']);
};
exports.down = (pgm) => {
pgm.dropTable('personal_notes');
};

View file

@ -1,13 +0,0 @@
// Adds soft-delete support for personal_notes via deleted_at.
exports.up = (pgm) => {
pgm.addColumn('personal_notes', {
deleted_at: { type: 'timestamptz', notNull: false, default: null },
});
pgm.createIndex('personal_notes', ['user_id', 'deleted_at']);
};
exports.down = (pgm) => {
pgm.dropIndex('personal_notes', ['user_id', 'deleted_at']);
pgm.dropColumn('personal_notes', 'deleted_at');
};

View file

@ -1,24 +0,0 @@
/**
* Mermaid Diagrams per-user clinical pathway / algorithm diagrams.
* Source is plain Mermaid text; rendered to SVG client-side. Source
* encrypted at rest like personal_notes so a row dump stays useless
* without the app key.
*/
exports.up = (pgm) => {
pgm.createTable('mermaid_diagrams', {
id: { type: 'serial', primaryKey: true },
user_id: { type: 'integer', notNull: true, references: 'users(id)', onDelete: 'CASCADE' },
title: { type: 'text', notNull: true },
source: { type: 'text', notNull: true, default: '' },
notes: { type: 'text', notNull: true, default: '' },
created_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
updated_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
});
pgm.createIndex('mermaid_diagrams', 'user_id');
pgm.createIndex('mermaid_diagrams', ['user_id', 'updated_at']);
};
exports.down = (pgm) => {
pgm.dropTable('mermaid_diagrams');
};

View file

@ -1,21 +0,0 @@
/**
* Optional saved clinical assistant chats. These are user-triggered saves,
* encrypted at rest like personal_notes because answers may contain PHI.
*/
exports.up = (pgm) => {
pgm.createTable('clinical_assistant_chats', {
id: { type: 'serial', primaryKey: true },
user_id: { type: 'integer', notNull: true, references: 'users(id)', onDelete: 'CASCADE' },
title: { type: 'text', notNull: true },
payload: { type: 'text', notNull: true, default: '{}' },
created_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
updated_at: { type: 'timestamptz', notNull: true, default: pgm.func('NOW()') },
});
pgm.createIndex('clinical_assistant_chats', 'user_id');
pgm.createIndex('clinical_assistant_chats', ['user_id', 'updated_at']);
};
exports.down = (pgm) => {
pgm.dropTable('clinical_assistant_chats');
};

View file

@ -1,21 +1,17 @@
# PedScribe Mobile App # PedScribe Mobile App
Capacitor mobile wrapper for the hosted Ped-AI web app. The app defaults to `https://app.pedshub.com`, lets users choose a self-hosted server URL, and keeps clinical workflows API-backed through the same Express service as the browser app. Native mobile wrapper for Pediatric AI Scribe using Capacitor. Provides background audio recording, push notifications, haptic feedback, deep linking, and share intent support on both iOS and Android.
## Features ## Features
- Hosted web workflow inside a native WebView; server updates reach mobile clients without app-store releases - Background recording that survives screen lock (foreground service on Android, background audio on iOS)
- Configurable server URL (supports self-hosted instances) - Configurable server URL (supports self-hosted instances)
- Haptic feedback on recording start/stop - Haptic feedback on recording start/stop
- Keep screen awake during recording - Keep screen awake during recording
- Deep linking (pedscribe:// and https://app.pedshub.com) - Deep linking (pedscribe:// and https://app.pedshub.com)
- Share intent (receive text/PDFs from other apps) - Share intent (receive text/PDFs from other apps)
- Push notification support - Push notification support
- **Biometric sign-in** (Face ID / Touch ID / fingerprint) — credentials - App Store and Play Store ready
stored in iOS Keychain / Android Keystore, gated by OS biometric.
Enrolled on first password sign-in (opt-in prompt). 2FA still applies
on top — biometric replaces the password step only.
- Android and iOS project scaffolds for store builds
## Prerequisites ## Prerequisites

View file

@ -9,8 +9,8 @@ android {
targetSdkVersion rootProject.ext.targetSdkVersion targetSdkVersion rootProject.ext.targetSdkVersion
// Version values below are overwritten by scripts/release.sh from // Version values below are overwritten by scripts/release.sh from
// the root package.json. versionCode auto-increments per release. // the root package.json. versionCode auto-increments per release.
versionCode 714016 versionCode 603001
versionName "7.14.16" versionName "6.3.1"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
aaptOptions { aaptOptions {
// Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps. // Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.

View file

@ -1,11 +1,6 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"> <manifest xmlns:android="http://schemas.android.com/apk/res/android">
<!-- Biometric login (capacitor-native-biometric). USE_BIOMETRIC is the
API 28+ permission; older devices ignore it. No legacy FINGERPRINT
entry needed because capacitor-native-biometric targets API 23+. -->
<uses-permission android:name="android.permission.USE_BIOMETRIC" />
<application <application
android:allowBackup="false" android:allowBackup="false"
android:fullBackupContent="false" android:fullBackupContent="false"

View file

@ -1,25 +1,11 @@
package com.pedshub.scribe; package com.pedshub.scribe;
import android.Manifest; import android.Manifest;
import android.content.ContentResolver;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent; import android.content.Intent;
import android.content.pm.PackageManager; import android.content.pm.PackageManager;
import android.net.Uri;
import android.os.Build;
import android.os.Bundle; import android.os.Bundle;
import android.os.Environment;
import android.print.PrintAttributes;
import android.print.PrintDocumentAdapter;
import android.print.PrintManager;
import android.provider.MediaStore;
import android.util.Base64;
import android.view.WindowManager;
import android.webkit.CookieManager;
import android.webkit.PermissionRequest; import android.webkit.PermissionRequest;
import android.webkit.WebChromeClient; import android.webkit.WebChromeClient;
import android.webkit.WebViewClient;
import android.webkit.WebView; import android.webkit.WebView;
import androidx.annotation.NonNull; import androidx.annotation.NonNull;
@ -28,20 +14,10 @@ import androidx.core.content.ContextCompat;
import com.getcapacitor.BridgeActivity; import com.getcapacitor.BridgeActivity;
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStream;
public class MainActivity extends BridgeActivity { public class MainActivity extends BridgeActivity {
private static final int MIC_PERMISSION_CODE = 1001; private static final int MIC_PERMISSION_CODE = 1001;
private PermissionRequest pendingPermissionRequest; private PermissionRequest pendingPermissionRequest;
private WebView printWebView;
// True between startForegroundService() and stopForegroundService(), i.e.
// while the web app has an active MediaRecorder. Drives the keep-screen-on
// flag and the timer-throttling workaround below.
private volatile boolean recordingActive = false;
@Override @Override
protected void onCreate(Bundle savedInstanceState) { protected void onCreate(Bundle savedInstanceState) {
@ -54,93 +30,11 @@ public class MainActivity extends BridgeActivity {
new String[]{ Manifest.permission.RECORD_AUDIO }, MIC_PERMISSION_CODE); new String[]{ Manifest.permission.RECORD_AUDIO }, MIC_PERMISSION_CODE);
} }
// Allow the Cloudflare Turnstile iframe to use storage.
setupThirdPartyCookies();
// Setup WebView mic permission granting // Setup WebView mic permission granting
setupWebViewPermissions(); setupWebViewPermissions();
// Register JS interface for foreground service control // Register JS interface for foreground service control
setupRecordingBridge(); setupRecordingBridge();
// Register JS interface for Android's print / Save as PDF flow.
setupPrintBridge();
// Register JS interface for saving generated visuals to Photos.
setupFileBridge();
}
// Recording Lifecycle
//
// Recording happens in the WebView (MediaRecorder), not in native code,
// so keeping the foreground service alive is necessary but not sufficient
// the WebView also has to keep executing JS. Two things protect that:
//
// 1. FLAG_KEEP_SCREEN_ON while recording, so the device does not
// auto-lock mid-encounter. This is the case that actually bites
// clinicians: a long pause in conversation and the screen times out.
//
// 2. resumeTimers() if the activity is paused anyway (user presses the
// power button, or a call comes in). Chromium throttles timers hard
// for hidden WebViews, which starves MediaRecorder's chunk delivery.
// Capacitor never calls webView.onPause(), so the WebView itself is
// still live it is only the timers that need rescuing.
//
// Note resumeTimers()/pauseTimers() are process-global in WebView, not
// per-instance; calling resume here is safe because this app has no other
// WebView that wants throttling (printWebView is transient).
void setKeepScreenOn(final boolean on) {
runOnUiThread(() -> {
if (on) {
getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
} else {
getWindow().clearFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
}
});
}
void setRecordingActive(boolean active) {
recordingActive = active;
setKeepScreenOn(active);
}
// NB: BridgeActivity declares these public narrowing to protected would
// not compile.
@Override
public void onPause() {
super.onPause();
if (recordingActive && this.bridge != null && this.bridge.getWebView() != null) {
this.bridge.getWebView().resumeTimers();
}
}
@Override
public void onResume() {
super.onResume();
if (this.bridge != null && this.bridge.getWebView() != null) {
this.bridge.getWebView().resumeTimers();
}
}
// Third-Party Cookies
//
// Android WebView blocks third-party cookies by default (unlike Chrome,
// which still allows them for now). Cloudflare Turnstile runs inside a
// cross-origin iframe from challenges.cloudflare.com and needs its own
// storage to run and persist a challenge without this the widget
// silently stalls or errors and never emits a token, so registration and
// password reset are impossible from inside the app.
//
// This is scoped to our own WebView, which only ever loads the PedScribe
// origin (see allowNavigation in capacitor.config.json), so it is not a
// general relaxation of the app's cookie policy.
private void setupThirdPartyCookies() {
WebView webView = this.bridge.getWebView();
CookieManager cookieManager = CookieManager.getInstance();
cookieManager.setAcceptCookie(true);
cookieManager.setAcceptThirdPartyCookies(webView, true);
} }
// WebView Microphone Permission // WebView Microphone Permission
@ -186,16 +80,6 @@ public class MainActivity extends BridgeActivity {
webView.addJavascriptInterface(new RecordingBridge(this), "NativeRecording"); webView.addJavascriptInterface(new RecordingBridge(this), "NativeRecording");
} }
private void setupPrintBridge() {
WebView webView = this.bridge.getWebView();
webView.addJavascriptInterface(new PrintBridge(this), "NativePrint");
}
private void setupFileBridge() {
WebView webView = this.bridge.getWebView();
webView.addJavascriptInterface(new FileBridge(this), "NativeFiles");
}
public static class RecordingBridge { public static class RecordingBridge {
private final MainActivity activity; private final MainActivity activity;
@ -207,7 +91,6 @@ public class MainActivity extends BridgeActivity {
public void startForegroundService() { public void startForegroundService() {
Intent intent = new Intent(activity, AudioRecordingService.class); Intent intent = new Intent(activity, AudioRecordingService.class);
ContextCompat.startForegroundService(activity, intent); ContextCompat.startForegroundService(activity, intent);
activity.setRecordingActive(true);
} }
@android.webkit.JavascriptInterface @android.webkit.JavascriptInterface
@ -215,108 +98,6 @@ public class MainActivity extends BridgeActivity {
Intent intent = new Intent(activity, AudioRecordingService.class); Intent intent = new Intent(activity, AudioRecordingService.class);
intent.setAction(AudioRecordingService.ACTION_STOP); intent.setAction(AudioRecordingService.ACTION_STOP);
activity.startService(intent); activity.startService(intent);
activity.setRecordingActive(false);
} }
// Standalone keep-awake, exposed so the web app can hold the screen on
// for non-recording work too. window.nativeKeepAwake() previously
// called Capacitor's KeepAwake plugin, which is not installed in this
// project so it silently did nothing and the screen slept during
// recordings.
@android.webkit.JavascriptInterface
public void keepAwake(boolean on) {
activity.setKeepScreenOn(on);
}
}
public static class PrintBridge {
private final MainActivity activity;
PrintBridge(MainActivity activity) {
this.activity = activity;
}
@android.webkit.JavascriptInterface
public void printHtml(String title, String base64Html) {
activity.runOnUiThread(() -> activity.printHtmlFromBase64(title, base64Html));
}
}
public static class FileBridge {
private final MainActivity activity;
FileBridge(MainActivity activity) {
this.activity = activity;
}
@android.webkit.JavascriptInterface
public String saveImage(String filename, String base64Png) {
return activity.saveImageToPictures(filename, base64Png);
}
}
private void printHtmlFromBase64(String title, String base64Html) {
try {
byte[] decoded = Base64.decode(base64Html, Base64.DEFAULT);
String html = new String(decoded, java.nio.charset.StandardCharsets.UTF_8);
printWebView = new WebView(this);
printWebView.setWebViewClient(new WebViewClient() {
@Override
public void onPageFinished(WebView view, String url) {
PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
PrintDocumentAdapter adapter = view.createPrintDocumentAdapter(title != null && !title.isEmpty() ? title : "Clinical Assistant Export");
printManager.print(title != null && !title.isEmpty() ? title : "Clinical Assistant Export", adapter, new PrintAttributes.Builder().build());
}
});
printWebView.loadDataWithBaseURL(null, html, "text/html", "UTF-8", null);
} catch (Exception e) {
android.util.Log.e("PedScribe", "Native print failed", e);
}
}
private String saveImageToPictures(String filename, String base64Png) {
String safeName = sanitizeFilename(filename, "clinical-visual.png");
try {
byte[] imageBytes = Base64.decode(base64Png, Base64.DEFAULT);
Uri uri;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
ContentResolver resolver = getContentResolver();
ContentValues values = new ContentValues();
values.put(MediaStore.Images.Media.DISPLAY_NAME, safeName);
values.put(MediaStore.Images.Media.MIME_TYPE, "image/png");
values.put(MediaStore.Images.Media.RELATIVE_PATH, Environment.DIRECTORY_PICTURES + "/PedScribe");
values.put(MediaStore.Images.Media.IS_PENDING, 1);
uri = resolver.insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values);
if (uri == null) return "error:Could not create image file";
try (OutputStream out = resolver.openOutputStream(uri)) {
if (out == null) return "error:Could not open image file";
out.write(imageBytes);
}
values.clear();
values.put(MediaStore.Images.Media.IS_PENDING, 0);
resolver.update(uri, values, null, null);
} else {
File dir = new File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_PICTURES), "PedScribe");
if (!dir.exists() && !dir.mkdirs()) return "error:Could not create Pictures/PedScribe";
File file = new File(dir, safeName);
try (OutputStream out = new FileOutputStream(file)) {
out.write(imageBytes);
}
uri = Uri.fromFile(file);
sendBroadcast(new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE, uri));
}
return "saved:" + uri.toString();
} catch (Exception e) {
android.util.Log.e("PedScribe", "Native image save failed", e);
return "error:" + (e.getMessage() != null ? e.getMessage() : "Image save failed");
}
}
private String sanitizeFilename(String filename, String fallback) {
String value = filename != null ? filename : fallback;
value = value.replaceAll("[^A-Za-z0-9._-]", "-");
if (value.length() == 0) value = fallback;
if (!value.toLowerCase(java.util.Locale.US).endsWith(".png")) value = value + ".png";
return value;
} }
} }

View file

@ -13,7 +13,7 @@
<style name="AppTheme.NoActionBar" parent="Theme.AppCompat.DayNight.NoActionBar"> <style name="AppTheme.NoActionBar" parent="Theme.AppCompat.DayNight.NoActionBar">
<item name="windowActionBar">false</item> <item name="windowActionBar">false</item>
<item name="windowNoTitle">true</item> <item name="windowNoTitle">true</item>
<item name="android:background">@color/colorPrimary</item> <item name="android:background">@null</item>
<item name="android:statusBarColor">@color/colorPrimaryDark</item> <item name="android:statusBarColor">@color/colorPrimaryDark</item>
<item name="android:navigationBarColor">@color/colorPrimaryDark</item> <item name="android:navigationBarColor">@color/colorPrimaryDark</item>
</style> </style>

View file

@ -2,6 +2,4 @@
<paths xmlns:android="http://schemas.android.com/apk/res/android"> <paths xmlns:android="http://schemas.android.com/apk/res/android">
<external-path name="my_images" path="." /> <external-path name="my_images" path="." />
<cache-path name="my_cache_images" path="." /> <cache-path name="my_cache_images" path="." />
<files-path name="my_files" path="." />
<external-files-path name="my_external_files" path="." />
</paths> </paths>

View file

@ -1,2 +0,0 @@
json_key_file('fastlane/google-play-service-account.json')
package_name('com.pedshub.scribe')

View file

@ -1,18 +0,0 @@
default_platform(:android)
platform :android do
desc "Upload a signed release AAB to Google Play internal track"
lane :publish_internal do
upload_to_play_store(
package_name: 'com.pedshub.scribe',
json_key: 'fastlane/google-play-service-account.json',
aab: ENV['AAB_PATH'] || 'app/build/outputs/bundle/release/app-release.aab',
track: ENV['PLAY_TRACK'] || 'internal',
skip_upload_changelogs: true,
skip_upload_metadata: true,
skip_upload_images: true,
skip_upload_screenshots: true,
release_status: 'completed',
)
end
end

View file

@ -1,3 +0,0 @@
source 'https://rubygems.org'
gem 'fastlane'

View file

@ -6,8 +6,6 @@
<string>en</string> <string>en</string>
<key>CFBundleDisplayName</key> <key>CFBundleDisplayName</key>
<string>PedScribe</string> <string>PedScribe</string>
<key>NSFaceIDUsageDescription</key>
<string>PedScribe uses Face ID to securely sign you in without re-entering your password.</string>
<key>CFBundleExecutable</key> <key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string> <string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key> <key>CFBundleIdentifier</key>

View file

@ -1,19 +1,18 @@
{ {
"name": "pedscribe-mobile", "name": "pedscribe-mobile",
"version": "7.14.14", "version": "1.0.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "pedscribe-mobile", "name": "pedscribe-mobile",
"version": "7.14.14", "version": "1.0.0",
"dependencies": { "dependencies": {
"@aparajita/capacitor-biometric-auth": "^8.0.0", "@aparajita/capacitor-biometric-auth": "^8.0.0",
"@capacitor/android": "^6.0.0", "@capacitor/android": "^6.0.0",
"@capacitor/app": "^6.0.0", "@capacitor/app": "^6.0.0",
"@capacitor/cli": "^6.0.0", "@capacitor/cli": "^6.0.0",
"@capacitor/core": "^6.0.0", "@capacitor/core": "^6.0.0",
"@capacitor/filesystem": "^6.0.4",
"@capacitor/haptics": "^6.0.0", "@capacitor/haptics": "^6.0.0",
"@capacitor/ios": "^6.0.0", "@capacitor/ios": "^6.0.0",
"@capacitor/keyboard": "^6.0.0", "@capacitor/keyboard": "^6.0.0",
@ -21,8 +20,7 @@
"@capacitor/screen-orientation": "^6.0.0", "@capacitor/screen-orientation": "^6.0.0",
"@capacitor/share": "^6.0.0", "@capacitor/share": "^6.0.0",
"@capacitor/splash-screen": "^6.0.0", "@capacitor/splash-screen": "^6.0.0",
"@capacitor/status-bar": "^6.0.0", "@capacitor/status-bar": "^6.0.0"
"capacitor-secure-storage-plugin": "^0.10.0"
} }
}, },
"node_modules/@aparajita/capacitor-biometric-auth": { "node_modules/@aparajita/capacitor-biometric-auth": {
@ -99,15 +97,6 @@
"tslib": "^2.1.0" "tslib": "^2.1.0"
} }
}, },
"node_modules/@capacitor/filesystem": {
"version": "6.0.4",
"resolved": "https://registry.npmjs.org/@capacitor/filesystem/-/filesystem-6.0.4.tgz",
"integrity": "sha512-eFlg/ZrwYA4Y6ClLRRikudVu2XvuZxfX/XC0ky9MgfbC9dyqTnVkkEoWM6vr1xR89YNY4mB0EeVTet1m1Jcumw==",
"license": "MIT",
"peerDependencies": {
"@capacitor/core": "^6.0.0"
}
},
"node_modules/@capacitor/haptics": { "node_modules/@capacitor/haptics": {
"version": "6.0.3", "version": "6.0.3",
"resolved": "https://registry.npmjs.org/@capacitor/haptics/-/haptics-6.0.3.tgz", "resolved": "https://registry.npmjs.org/@capacitor/haptics/-/haptics-6.0.3.tgz",
@ -499,15 +488,6 @@
"node": "*" "node": "*"
} }
}, },
"node_modules/capacitor-secure-storage-plugin": {
"version": "0.10.0",
"resolved": "https://registry.npmjs.org/capacitor-secure-storage-plugin/-/capacitor-secure-storage-plugin-0.10.0.tgz",
"integrity": "sha512-dV4E+HTZAJWC3gef7sBXaAkkb6wvcZHyXjJIHXNb3yz9gRQ/5VMLqCxa0khqpwgWh5oIbo4XFxg3g5tEkfaNMg==",
"license": "MIT",
"peerDependencies": {
"@capacitor/core": "^6.0.0"
}
},
"node_modules/chownr": { "node_modules/chownr": {
"version": "2.0.0", "version": "2.0.0",
"resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz",

View file

@ -1,6 +1,6 @@
{ {
"name": "pedscribe-mobile", "name": "pedscribe-mobile",
"version": "7.14.16", "version": "6.3.1",
"description": "PedScribe native mobile app — Capacitor wrapper for Pediatric AI Scribe", "description": "PedScribe native mobile app — Capacitor wrapper for Pediatric AI Scribe",
"private": true, "private": true,
"scripts": { "scripts": {
@ -11,14 +11,12 @@
"build:ios": "npx cap sync ios" "build:ios": "npx cap sync ios"
}, },
"dependencies": { "dependencies": {
"@aparajita/capacitor-biometric-auth": "^8.0.0",
"@capacitor/android": "^6.0.0", "@capacitor/android": "^6.0.0",
"@capacitor/app": "^6.0.0", "@capacitor/app": "^6.0.0",
"@capacitor/cli": "^6.0.0", "@capacitor/cli": "^6.0.0",
"@capacitor/core": "^6.0.0", "@capacitor/core": "^6.0.0",
"@capacitor/filesystem": "^6.0.4",
"@capacitor/haptics": "^6.0.0",
"@capacitor/ios": "^6.0.0", "@capacitor/ios": "^6.0.0",
"@capacitor/haptics": "^6.0.0",
"@capacitor/keyboard": "^6.0.0", "@capacitor/keyboard": "^6.0.0",
"@capacitor/push-notifications": "^6.0.0", "@capacitor/push-notifications": "^6.0.0",
"@capacitor/screen-orientation": "^6.0.0", "@capacitor/screen-orientation": "^6.0.0",

1836
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -1,12 +1,10 @@
{ {
"name": "pediatric-ai-scribe", "name": "pediatric-ai-scribe",
"version": "7.14.16", "version": "6.3.1",
"description": "AI-powered pediatric clinical documentation platform", "description": "AI-powered pediatric clinical documentation platform",
"main": "server.js", "main": "server.js",
"scripts": { "scripts": {
"start": "node server.js", "start": "node server.js",
"test": "node --test test/*.test.js",
"e2e": "./scripts/e2e.sh",
"maint:check": "node scripts/maintenance.js check", "maint:check": "node scripts/maintenance.js check",
"maint:reindex": "node scripts/maintenance.js reindex", "maint:reindex": "node scripts/maintenance.js reindex",
"migrate": "node-pg-migrate", "migrate": "node-pg-migrate",
@ -25,8 +23,8 @@
"@tiptap/extension-text-style": "^3.20.4", "@tiptap/extension-text-style": "^3.20.4",
"@tiptap/extension-underline": "^3.20.4", "@tiptap/extension-underline": "^3.20.4",
"@tiptap/starter-kit": "^3.20.4", "@tiptap/starter-kit": "^3.20.4",
"argon2": "^0.41.1",
"axios": "^1.7.7", "axios": "^1.7.7",
"argon2": "^0.41.1",
"bcryptjs": "^2.4.3", "bcryptjs": "^2.4.3",
"cookie-parser": "^1.4.7", "cookie-parser": "^1.4.7",
"cors": "^2.8.5", "cors": "^2.8.5",
@ -36,8 +34,6 @@
"helmet": "^8.0.0", "helmet": "^8.0.0",
"jsonwebtoken": "^9.0.2", "jsonwebtoken": "^9.0.2",
"mammoth": "^1.8.0", "mammoth": "^1.8.0",
"markdown-it": "^14.1.1",
"marked": "^18.0.2",
"multer": "^1.4.5-lts.1", "multer": "^1.4.5-lts.1",
"node-pg-migrate": "^7.7.0", "node-pg-migrate": "^7.7.0",
"nodemailer": "^8.0.5", "nodemailer": "^8.0.5",
@ -46,9 +42,7 @@
"pdf-parse": "^1.1.1", "pdf-parse": "^1.1.1",
"pg": "^8.13.0", "pg": "^8.13.0",
"pptxgenjs": "^4.0.1", "pptxgenjs": "^4.0.1",
"prom-client": "^15.1.3",
"qrcode": "^1.5.4", "qrcode": "^1.5.4",
"redis": "^4.7.1",
"speakeasy": "^2.0.0" "speakeasy": "^2.0.0"
}, },
"optionalDependencies": { "optionalDependencies": {
@ -58,9 +52,5 @@
"@aws-sdk/client-transcribe-streaming": "^3.1017.0", "@aws-sdk/client-transcribe-streaming": "^3.1017.0",
"@aws-sdk/s3-request-presigner": "^3.700.0", "@aws-sdk/s3-request-presigner": "^3.700.0",
"@google-cloud/vertexai": "^1.9.0" "@google-cloud/vertexai": "^1.9.0"
},
"devDependencies": {
"dompurify": "^3.4.1",
"jsdom": "^29.0.2"
} }
} }

View file

@ -3,7 +3,7 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>404 Page Not Found | Pediatric Clinical Tools</title> <title>404 Page Not Found | Pediatric AI Scribe</title>
<link rel="preconnect" href="https://fonts.googleapis.com"> <link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&display=swap" rel="stylesheet">
<style> <style>
@ -162,14 +162,14 @@
</div> </div>
<h1>This page doesn't exist</h1> <h1>This page doesn't exist</h1>
<p>The URL you visited isn't part of Pediatric Clinical Tools.<br>It may have been mistyped or the link is outdated.</p> <p>The URL you visited isn't part of Pediatric AI Scribe.<br>It may have been mistyped or the link is outdated.</p>
<a href="/" class="btn"> <a href="/" class="btn">
<svg viewBox="0 0 20 20" fill="currentColor"><path d="M10.707 2.293a1 1 0 0 0-1.414 0l-7 7a1 1 0 0 0 1.414 1.414L4 10.414V17a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-3h2v3a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-6.586l.293.293a1 1 0 0 0 1.414-1.414l-7-7z"/></svg> <svg viewBox="0 0 20 20" fill="currentColor"><path d="M10.707 2.293a1 1 0 0 0-1.414 0l-7 7a1 1 0 0 0 1.414 1.414L4 10.414V17a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-3h2v3a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-6.586l.293.293a1 1 0 0 0 1.414-1.414l-7-7z"/></svg>
Back to the app Back to the app
</a> </a>
<div class="footer-note">Pediatric Clinical Tools &mdash; Clinical Documentation Platform</div> <div class="footer-note">Pediatric AI Scribe &mdash; Clinical Documentation Platform</div>
</div> </div>
</body> </body>
</html> </html>

Binary file not shown.

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show more