Three concurrent themes from this session:
═══════════════════════════════════════════════════════════════════
ED ENCOUNTERS — per-stage cards + consolidate→MDM finalize
═══════════════════════════════════════════════════════════════════
UX redesign per Daniel's feedback ("every stage note should be shown,
if AI is told to modify that particular note then the modified version
is used in final mdm"):
- Each generated stage stays on screen as its own editable card with
its own embedded "Don't Miss" panel. No more single rolling note
element that gets replaced on each generation.
- gatherCurrentNotes() reads contenteditable text from each stage card
before any operation (advance, finalize, persist) so inline edits
flow into the next AI call and the final consolidate.
- Stage badge is now state-accurate. "Stage N (recording)" with yellow
background after Add-more before generation; "Stage N" with gray
after generation. Fixes the bug where the badge flipped to Stage 2
the moment Add-more was clicked.
- Save & Done now runs TWO server-side AI calls in /finalize:
1. edConsolidate (new prompt) → polished single final note that
integrates every stage chronologically (HPI / ROS / PE / ED Course /
A&P with disposition).
2. edFinalize (rewritten with full inline 2023 AMA E/M element
rubric — problems / data / risk definitions, level mapping with
concrete examples) → MDM JSON.
- Two new cards render after finalize: blue-bordered Final Consolidated
Note + green-bordered MDM. Stage cards become read-only.
- partial_data on the saved row now stores {stages, finalNote, mdm,
finalized} so resume re-renders the full state.
Why two-call finalize: a single combined prompt makes the model cut
corners on one task. Two focused calls cost ~2× latency at the very end
of an encounter — acceptable since finalize is a one-time terminal
action, not a per-stage hot path.
Files: public/components/ed-encounter.html, public/js/ed-encounters.js,
src/routes/edEncounters.js, src/utils/prompts.js (edConsolidate added,
edFinalize rewritten).
═══════════════════════════════════════════════════════════════════
EXTENSIONS / PAGERS — visual polish
═══════════════════════════════════════════════════════════════════
Multiple iterations based on Daniel's feedback:
- Layout: align-items:flex-start so action buttons stay pinned top-right
when long numbers wrap (was align-items:center → buttons drifted into
the text area, causing visible overlap).
- Number: word-break:break-all + min-width:0 + font-feature-settings:tnum
so long numbers wrap within their column instead of pushing under the
buttons. Click-to-copy with a 0.55s green flash + ✓ copied badge.
- Phone/pager Font Awesome icon next to the number in the type color —
at-a-glance type signal (replacing an earlier 3px left stripe that
Daniel found visually bulky).
- Name: font-weight 700, font-size 14.5px, color g900, letter-spacing
-0.012em — scan-target headline typography for long lists.
- Alternating subtle backgrounds by index (white vs #fafbfc) so a long
list reads as distinct rows.
- Hover: card lifts 1px with a soft shadow; action buttons fade from
55% to 100% opacity. Cubic-bezier transition on transform.
- Entrance: staggered fade-up animation per card (35ms × index, capped
at 12). prefers-reduced-motion media query disables motion.
- Empty state: 48px FA icon + heading instead of plain gray text.
Files: public/js/extensions.js, public/css/styles.css.
═══════════════════════════════════════════════════════════════════
DOCS REORGANIZATION + APPLICATION-LOGIC DOCS + ADMIN VIEWER
═══════════════════════════════════════════════════════════════════
Document moves (preserving git history via git mv):
BROWSER_WHISPER_SETUP.md → docs/browser-whisper-setup.md
BROWSER_WHISPER_TROUBLESHOOTING.md → docs/browser-whisper-troubleshooting.md
DEVELOPER_GUIDE.md → docs/developer-guide-extended.md
EMBEDDINGS_SETUP.md → docs/embeddings-setup.md
FEATURES_EXPLAINED.md → docs/features-explained.md
IMPROVEMENTS.md → docs/improvements.md
OPENID_SETUP.md → docs/openid-setup.md
TRANSCRIPTION_OPTIONS.md → docs/transcription-options.md
README.md updated with the new paths + a Documentation section that
links to docs/logic/ at the top.
New application-logic doc series (~8,300 lines total) at docs/logic/.
Built with 5 parallel doc-writing agents per Daniel's "use multiple
agents" directive. Each doc explains how a part of the app actually
works — application logic, data flow, design decisions, sacred zones,
how-to-extend recipes — at a depth that lets a new dev (or an AI
assistant) modify the code confidently.
docs/logic/README.md — index + recommended reading order
docs/logic/architecture.md (2166 L) — frontend IIFE pattern, lazy tab
load, backend route convention,
schema, encryption, deployment
docs/logic/clinical-notes.md (1546L) — every note tab + helper trio
docs/logic/bedside-and-calculators.md (1373L) — bedside ES module
pocket + calculators + PE Guide
+ suture selector
docs/logic/auth-admin-learning.md (1281L) — auth (local+OIDC+2FA) +
admin panel + Learning Hub
(Quiz engine logic at sub-detail
only — TODO follow-up)
docs/logic/ai-and-voice.md (1128 L) — callAI 5-provider routing,
prompts, voice/STT, helper trio
docs/logic/ed-encounters.md (821 L) — multi-stage ED + MDM (this
session's worked example)
Admin-only docs viewer:
- New route /api/admin/docs/{tree,file}: recursively walks docs/, returns
the tree as JSON; /file?path=X validates path stays inside docs/ and
renders markdown via marked. Both gated by req.user.role==='admin'.
- New tab "Docs" (book icon) in the sidebar, hidden by default and
revealed in auth.js when user.role==='admin' (same pattern as the
existing Admin and CMS tabs).
- New component public/components/admin-docs.html: split-pane layout
with a tree sidebar + filter input + a markdown reader pane.
- New module public/js/admin-docs.js: lazy-loads the tree on first tab
activation, renders collapsible folders, persists expanded state and
last-opened path via UIState. Server-rendered HTML so no client
markdown parser needed.
- CSS for the viewer (responsive split-pane, code-block styling, table
scrolling, etc.).
- Mounted at /api/admin/docs (NOT /api) — important: mounting a router
with router.use(authMiddleware) at /api accidentally 401s every other
/api/* path (caught and fixed during testing — /api/health was 401'ing).
Files: docs/* (moved + new), README.md, public/components/admin-docs.html
(new), public/js/admin-docs.js (new), src/routes/adminDocs.js (new),
public/index.html (tab + section + script), public/js/auth.js (admin
gate + logout cleanup), public/css/styles.css (viewer styles), server.js
(mount).
═══════════════════════════════════════════════════════════════════
KNOWN GAPS (TODO follow-ups)
═══════════════════════════════════════════════════════════════════
- Learning Hub quiz engine (MCQ / multi-select / T-F scoring + attempt
tracking + progress dashboard) is covered at the architectural level
in docs/logic/auth-admin-learning.md but not drilled into the quiz
data model and scoring flow. Worth a focused follow-up doc.
- ED finalize: if MDM step JSON parse fails, server returns 502 with
the consolidated finalNote in the error payload, but client doesn't
surface the partial result. Add a "MDM failed, retry" affordance.
- No e2e Playwright coverage for ED encounters or the new docs viewer.
124 lines
4.8 KiB
JavaScript
124 lines
4.8 KiB
JavaScript
// ============================================================
|
|
// ADMIN DOCS ROUTE — serves the project docs/ folder as a
|
|
// browseable, admin-only site inside the app.
|
|
//
|
|
// Endpoints (both require req.user.role === 'admin'):
|
|
// GET /api/admin/docs/tree — returns nested JSON of docs/
|
|
// GET /api/admin/docs/file?path=X — returns rendered HTML for one .md
|
|
//
|
|
// Path safety: every requested path is normalised + forced to live
|
|
// under /app/docs (or wherever DOCS_ROOT resolves). Any attempt to
|
|
// traverse out (../, absolute paths, symlinks pointing elsewhere) is
|
|
// rejected with 400.
|
|
// ============================================================
|
|
|
|
var express = require('express');
|
|
var router = express.Router();
|
|
var fs = require('fs');
|
|
var path = require('path');
|
|
var { authMiddleware } = require('../middleware/auth');
|
|
var logger = require('../utils/logger');
|
|
var { marked } = require('marked');
|
|
|
|
router.use(authMiddleware);
|
|
|
|
// Admin gate. Returns 403 with a generic message — does not leak
|
|
// whether the path exists or not.
|
|
function requireAdmin(req, res, next) {
|
|
if (!req.user || req.user.role !== 'admin') {
|
|
return res.status(403).json({ error: 'Admin only' });
|
|
}
|
|
next();
|
|
}
|
|
|
|
// Resolve the docs folder relative to the project root. server.js lives
|
|
// at the repo root and __dirname here is src/routes, so go up two.
|
|
var DOCS_ROOT = path.resolve(__dirname, '..', '..', 'docs');
|
|
|
|
// Resolve a user-supplied path safely. Returns null if the path tries
|
|
// to escape DOCS_ROOT or doesn't exist.
|
|
function safeResolve(relPath) {
|
|
if (typeof relPath !== 'string' || !relPath) return null;
|
|
// Strip any leading slashes so path.join can't be tricked into an
|
|
// absolute path on POSIX.
|
|
var trimmed = relPath.replace(/^[\/\\]+/, '');
|
|
var abs = path.resolve(DOCS_ROOT, trimmed);
|
|
// Must stay inside DOCS_ROOT after resolution (defends against
|
|
// ../ traversal and on Windows backslash variants).
|
|
if (abs !== DOCS_ROOT && !abs.startsWith(DOCS_ROOT + path.sep)) return null;
|
|
if (!fs.existsSync(abs)) return null;
|
|
return abs;
|
|
}
|
|
|
|
// Recursively walk DOCS_ROOT into a JSON tree the client can render
|
|
// as a sidebar. Skips dotfiles and non-.md files inside leaf nodes.
|
|
function buildTree(dir, baseRel) {
|
|
var entries = fs.readdirSync(dir, { withFileTypes: true })
|
|
.filter(function (d) { return !d.name.startsWith('.'); })
|
|
.sort(function (a, b) {
|
|
// README always first inside its folder so the index is the obvious landing.
|
|
if (a.name.toLowerCase() === 'readme.md') return -1;
|
|
if (b.name.toLowerCase() === 'readme.md') return 1;
|
|
// Folders before files within the same level.
|
|
if (a.isDirectory() && !b.isDirectory()) return -1;
|
|
if (!a.isDirectory() && b.isDirectory()) return 1;
|
|
return a.name.localeCompare(b.name);
|
|
});
|
|
var out = [];
|
|
entries.forEach(function (e) {
|
|
var rel = baseRel ? (baseRel + '/' + e.name) : e.name;
|
|
if (e.isDirectory()) {
|
|
out.push({
|
|
type: 'dir',
|
|
name: e.name,
|
|
path: rel,
|
|
children: buildTree(path.join(dir, e.name), rel)
|
|
});
|
|
} else if (/\.md$/i.test(e.name)) {
|
|
out.push({
|
|
type: 'file',
|
|
name: e.name,
|
|
path: rel
|
|
});
|
|
}
|
|
});
|
|
return out;
|
|
}
|
|
|
|
// ── GET /tree (mounted at /api/admin/docs) ─────────────────────────
|
|
router.get('/tree', requireAdmin, function (req, res) {
|
|
try {
|
|
if (!fs.existsSync(DOCS_ROOT)) {
|
|
return res.json({ success: true, tree: [], root: 'docs' });
|
|
}
|
|
var tree = buildTree(DOCS_ROOT, '');
|
|
res.json({ success: true, tree: tree, root: 'docs' });
|
|
} catch (e) {
|
|
logger.error('[adminDocs] tree failed', e.message);
|
|
res.status(500).json({ error: 'Tree build failed' });
|
|
}
|
|
});
|
|
|
|
// ── GET /file?path=X (mounted at /api/admin/docs) ──────────────────
|
|
router.get('/file', requireAdmin, function (req, res) {
|
|
try {
|
|
var raw = req.query.path;
|
|
var abs = safeResolve(raw);
|
|
if (!abs) return res.status(400).json({ error: 'Invalid path' });
|
|
var stat = fs.statSync(abs);
|
|
if (!stat.isFile()) return res.status(400).json({ error: 'Not a file' });
|
|
if (!/\.md$/i.test(abs)) return res.status(400).json({ error: 'Only .md files served' });
|
|
|
|
var src = fs.readFileSync(abs, 'utf8');
|
|
// marked: GitHub-flavoured rendering with automatic line breaks off
|
|
// (so authors can wrap prose without inserting <br> everywhere) and
|
|
// header IDs on so the client can deep-link via #anchor.
|
|
var html = marked.parse(src, { gfm: true, breaks: false, headerIds: true });
|
|
res.json({ success: true, html: html, path: raw, bytes: stat.size });
|
|
} catch (e) {
|
|
logger.error('[adminDocs] file failed', e.message);
|
|
res.status(500).json({ error: 'Read failed' });
|
|
}
|
|
});
|
|
|
|
module.exports = router;
|