-
Notifications
You must be signed in to change notification settings - Fork 0
architecture
SaiLoR is a single-codebase React app that runs as both an Electron desktop application and a static web SPA. The key architectural seam is the PlatformAdapter interface, which abstracts all file I/O and PDF loading so the React UI is identical in both runtimes.
The entire file-system and PDF-loading layer is abstracted behind a single interface:
src/platform/adapter.ts → PlatformAdapter interface
src/platform/index.ts → getPlatform() singleton factory
src/platform/electron.ts → ElectronAdapter
src/platform/browser.ts → BrowserAdapter
PlatformAdapter (src/platform/adapter.ts) defines nine operations:
-
getRecents()— return the list of recently opened projects (RecentEntry[]withid+name) -
openRecent(id)— re-open a project by its recent-entry id (path on Electron, IndexedDB handle key on browser) -
openProject()— show an open dialog/picker, return JSON text + aSaveHandle -
saveProject(text, handle)— write back to the handle's location -
rebasePdfPaths(pdfPaths, from, to)— re-express PDF paths that were relative tofrom's directory as relative toto's. "Save as" depends on this: a paper'spdfis stored relative to the project file, so writing the old paths to a new location left every PDF pointing at nothing.store.saveAs()therefore picks the destination first (pickProjectLocation), rebases, and only then serializes and writes. Electron does the real path math via apaths:rebaseIPC (relative(dirname(to), resolve(dirname(from), rel))); the browser has no paths and returns the input unchanged. -
getPdfSource(pdfPath, projectHandle)— resolve a paper's relative PDF path into a URL react-pdf can load. On Electron it re-asserts the main process's project directory fromprojectHandlefirst, so PDFs always resolve against the project actually being rendered (the project editor repoints that directory when picking a location).
Three more exist for the project editor (see below):
-
pickProjectLocation(suggestedName)— ask where the project JSON should live; writes nothing. Returns aProjectLocation(handle,name, and — Electron only — an absolutepath). -
pickPdfs()— pick PDFs to reference; returnsPickedPdf[](name, plus an absolutepathon Electron). -
pickPdfFolder()— pick a folder and return every PDF inside it, recursively, asPickedPdf[]. Electron walks the filesystem via IPC (pdf:pickFolder); the browser reuses the samewebkitdirectory<input>the PDF-viewer's one-time folder grant uses (seepickPdfFolderViaInputbelow), filtered to.pdfnames. -
pickReferenceFile()— pick a single.bib/.ris/.jsonreference-manager export; returns{ text, name }or null if cancelled. Parsed bysrc/model/references.ts. -
relativePdfPaths(pdfs, location)— thepdfvalues to store, relative to the JSON's directory. Electron computes real relative paths via IPC; the browser returns bare file names (the File System Access API exposes no paths).
Project title. A project JSON may set a top-level title; the app shows it wherever it would otherwise show the file name (toolbar, recents list, Open menu), falling back to the file name when absent. It is a first-class key on Project (not swallowed into extra, which would duplicate it on save) and is only written when non-empty. The project editor exposes it as a Project title field next to the JSON location.
Recents are re-read from disk, not trusted. The title shown for a recent is stored on the entry, but that copy goes stale the moment the project is renamed elsewhere — most obviously by changing the Project title in the editor, where the old name would otherwise still be sitting in the list after closing it. So checkRecents() re-reads each project's current title from the file: on Electron a project:peek IPC returns { exists, title } per path in one round trip (parse failures are contained per file); in the browser it reads through the retained handle, but only when read permission is already granted — startup must never throw a permission prompt at the user just to refresh a label, so without permission the stored title is kept. The refreshed list is written back (replaceRecents, order preserved) so the fresh titles survive a restart, and editorStore.save() triggers a refresh so a rename shows up as soon as the editor is closed. A title removed from a file correctly reverts the entry to showing its file name.
A recent whose file has gone is kept, not forgotten. checkRecents() (run on startup via refreshRecents()) re-tests each entry — fs:exists on Electron, "do we still hold the IndexedDB handle" in the browser — and sets a runtime-only available flag (never persisted). A missing project stays in the list, faded, badged not found, and unselectable, because the drive may come back; the user can still dismiss it with the ×. Opening one that has since vanished marks it unavailable rather than pruning it. Note the flag is deliberately tri-state: undefined means not checked yet, and only an explicit false greys an entry out, so nothing flickers on first paint.
Closing a project (requestCloseProject) returns to the start screen, and when there are unsaved changes it first asks via ClosePrompt — the same three choices and wording as Electron's native quit dialog (Save / Don't Save / Cancel). A failed save keeps the project open rather than closing and losing the work.
Recents entries carry path and title beyond id/name. The path is what lets a user tell two projects called review.json apart: the start screen shows it under the title (truncated from the left, since the tail is what differs — direction: rtl + unicode-bidi: plaintext, the latter so the leading / isn't reordered to the end), and the Open menu shows it as a hover tooltip. On the start screen each entry also carries a ✎ pen (useEditorStore().startEditRecent(id)) that opens the project straight into the schema editor instead of the annotation view — the same edit path as Edit annotation JSON…, but for a known recent rather than a file picker. Both places offer an × to drop an entry (forgetRecent), which in the menu deliberately does not close it, so several can be cleared in a row. The title is only known once the JSON is parsed, so loadFromText re-pushes the entry via rememberProject() — pushRecent dedupes by id, so this enriches the existing entry rather than duplicating it.
Recent projects are managed by src/platform/recents.ts — a platform-opaque module that stores up to 5 entries in localStorage (separate keys for Electron and browser). On Electron, the entry id is the absolute file path; on browser it is a key into the IndexedDB handle store.
getPlatform() (src/platform/index.ts) returns a singleton: ElectronAdapter if window.slr exists (preload bridge), otherwise BrowserAdapter. Detection uses isElectron() which checks for the preload-bridged window.slr object.
Delegates to window.slr (the preload bridge). File operations use IPC to the main process. PDFs are served via the custom slr-file://project/<encoded-path> protocol — the main process resolves paths relative to the project directory. setProjectDir is called on open/save-as so the protocol knows the base directory. On open and save-as, the adapter pushes an entry to the recents list (slr.recents.electron localStorage key). openRecent(id) calls bridge().openPath(id) to read a file by absolute path; if the file no longer exists the entry is pruned from recents.
Has three tiers of capability:
| Capability | Chromium (FSAPI) | Other browsers | Server mode |
|---|---|---|---|
| Open |
showOpenFilePicker — in-place handle retained |
Hidden <input type=file>
|
fetch(url) via ?project=
|
| Save |
createWritable on retained handle |
Download blob | Download blob |
| Save as | showSaveFilePicker |
Download blob | Download blob |
| PDF loading | One-time folder grant via showDirectoryPicker, blob URL |
One-time folder grant via a webkitdirectory <input>, blob URL |
fetch relative to project URL |
setServerBase(url) records the URL a project was fetched from so sibling PDFs resolve correctly in server mode. The adapter stores FileSystemFileHandle references in an internal map keyed by generated IDs.
Every locally opened project — FSAPI handle or <input> fallback alike — resolves its PDFs through a folder the reviewer grants access to once, never a fetch. A local project has no URL for its PDFs to live at, so getPdfSource branches purely on whether serverBase is set: unset means "resolve locally", full stop, regardless of how the JSON itself was opened. resolveLocalPdf calls the shared ensureLocalPdfGrant() (prompts only if neither pdfDir nor pdfFileMap is set yet — a no-op once one is), then dispatches to whichever grant it produced: resolveViaDir walks getDirectoryHandle/getFileHandle per path segment on the FSAPI directory handle; resolveViaFileMap looks the path up in the map ensureLocalPdfGrant built from a folder-picking <input>'s webkitdirectory attribute (non-standard name, but implemented everywhere that matters — Firefox, Safari, Chromium), which reads an entire folder tree in one go and keys each file by its webkitRelativePath with the picked folder's own name stripped (that name isn't part of the project-relative paths stored in the JSON). Either mechanism prompts once per session.
needsPdfFolderGrant() / grantPdfFolderAccess() are PlatformAdapter methods that expose that same grant explicitly, so a caller can ask for it from a real click instead of letting getPdfSource pop the native picker unannounced. PdfViewer.tsx checks needsPdfFolderGrant() before ever calling getPdfSource for the first PDF of a locally opened project; if true, it renders an in-app explanation with a Choose folder… button instead, and only calls getPdfSource after the button's click has driven grantPdfFolderAccess() (which just calls the same ensureLocalPdfGrant()) to completion. getPdfSource itself still auto-prompts via ensureLocalPdfGrant() if called directly without this check — a caller like aiStore.ts's run(), which reads a paper's PDF bytes for the AI-annotation flow and doesn't go through PdfViewer's gate, still gets a working (if unannounced) prompt rather than an error. ElectronAdapter implements both methods as false/no-op — there is no such prompt on the desktop build, PDFs are read straight off disk via slr-file://.
pickPdfFolderViaInput's "did the user cancel" detection uses the cancel event, not a focus-return guess — and this isn't a stylistic choice. A focus-based guess (the pattern the older pickFileViaInput/pickFilesViaInput still use, for a plain — non-directory — file pick) is unsafe here specifically: Firefox inserts its own "Upload N files from this folder?" confirmation after the OS folder dialog closes, and that OS dialog closing already returns window focus — well before the user has answered Firefox's prompt. A short focus-based timeout reads that in-between moment as a cancel and resolves empty while the real selection is still on its way, which is indistinguishable from a genuine cancel to the caller. The dedicated cancel event (Chrome 113+, Firefox 106+, Safari 16.4+) fires only when the picker was actually dismissed with nothing chosen, so it doesn't have this problem; a focus-based fallback still exists for an engine with neither event, but at a much longer delay (2s, up from the old 300ms) specifically to give a pending confirmation step like Firefox's room to resolve first.
This used to only run for an FSAPI handle — every other local-open path (Firefox/Safari, or Chromium without the FSAPI grant) fell straight through to a fetch against the app's own page URL, which obviously never contains the reviewer's PDFs. That fetch didn't even fail cleanly: on a dev server or any SPA-style static host it 200s with index.html instead of 404ing, so the failure surfaced three layers away as pdf.js's opaque InvalidPDFException: Invalid PDF structure — indistinguishable from an actually-corrupt file. The byte-level check described below catches that case when it's genuinely a server-mode misconfiguration; this local-resolution fix is what stops it from happening at all for the (very common) case of a reviewer just opening their own project file.
When the File System Access API is available, the BrowserAdapter also persists handles in IndexedDB (src/platform/idb.ts) so they survive page reloads. openProject() and saveProject() (via the FSAPI Save As flow) call rememberHandle() which stores the handle under a recent:<name> key and pushes an entry to slr.recents.browser. openRecent(id) retrieves the handle from IndexedDB, re-requests read permission (via ensureReadPermission), and re-reads the file. If the handle is missing or permission is denied, the entry is pruned from recents.
Opening any new project — local or server-mode — clears whatever the previous project's PDFs resolved through, via clearLocalPdfGrants() (drops pdfDir/pdfFileMap) alongside resetting serverBase, from all three project-load paths plus setServerBase() itself. Without this, switching from Project A (with a granted folder or a set server base) to Project B would silently keep resolving PDFs through A's leftover grant — at best a confusing "not found", at worst the wrong PDF's bytes for a path that happens to collide between the two projects.
getPdfSource's server-mode fetch branch validates the response bytes, not just the HTTP status. A dev server's SPA fallback, a static host's catch-all rewrite, or a reverse-proxy login page can all answer 200 with HTML for a PDF path that doesn't actually exist — res.ok alone can't tell that apart from a real PDF. Handing pdf.js those bytes produces its own genuine InvalidPDFException: Invalid PDF structure, which reads as a corrupt file when the real problem is upstream (wrong base, missing file, wrong deploy config). So before trusting a fetched body, hasPdfMagic() checks it actually starts with PDF's own magic number (%PDF-) — read from res.arrayBuffer(), not Content-Type (plenty of static hosts serve everything as application/octet-stream, so a header check alone would reject real PDFs) — and throws a specific "the server answered, but not with a PDF" error naming the URL it tried, instead of letting the failure surface three layers away in pdf.js.
The entire app state lives in a single Zustand store with immer middleware:
src/state/store.ts → useStore
| Field | Type | Purpose |
|---|---|---|
project |
Project | null |
The loaded, normalized project (schema + papers) |
currentPaperId |
string | null |
Currently selected paper |
saveHandle |
SaveHandle | null |
Where to write back (path, FSAPI handle id, or download) |
projectName |
string |
Display name for title bar |
dirty |
boolean |
Unsaved changes flag; gates beforeunload guard |
loadError |
LoadError | null |
Error overlay data |
busy |
boolean |
Disables toolbar buttons during async operations |
sidebarCollapsed |
boolean |
Paper list visibility. Driven by SidebarToggle, which renders inside the paper list's own header while it is open and in the toolbar once collapsed — otherwise the button would disappear with the pane it reopens. |
pdfSelection |
string |
Latest text selected in the PDF viewer (for "grab from PDF") |
theme |
Theme ('light' | 'dark') |
Current app theme (persisted in localStorage via src/state/settings.ts) |
fontScale |
number |
Current font scale factor (0.7–2.0, persisted in localStorage) |
pdfZoom |
number |
PDF zoom multiplier (0.4–3.0, session-only, default 1) |
recents |
RecentEntry[] |
Recently opened projects (max 5, from platform.getRecents()) |
helpOpen |
boolean |
Help dialog visibility |
past / future
|
HistoryEntry[] |
Undo/redo stacks for annotation edits (session-only, capped at 100). Each entry is { project, paperId }; thanks to immer's structural sharing, snapshots are cheap references |
aiMarks |
Record<string, true> |
Fields the AI filled and the reviewer has not looked at yet, keyed `${paperId}::${canonicalPath}` for a single-reviewer project, or `${paperId}::${reviewer}::${canonicalPath}` for a multi-reviewer one (see "AI marks" below). Session-only: it lives beside the project, so serializeProject cannot see it |
currentReviewer |
string | null |
Which reviewer's tree is shown/edited — "1".."N", "consolidation", or null. Always null for a single-reviewer project; also starts null for a multi-reviewer one until picked (see "Multiple reviewers & Consolidation" below). Persisted per project in localStorage; not an undo step, does not set dirty
|
consolidationTarget |
{ path, name, index } | null |
The field the Consolidation "compare" popup (ConsolidationDialog) is showing, or null when closed. Session-only |
-
openProject()— delegates toplatform.openProject(), thenloadFromText(), refreshesrecents -
openRecent(id)— delegates toplatform.openRecent(id); on success →loadFromText+ refreshesrecents; on null → prunes recents and setsloadError -
loadFromUrl(url)—fetchthe project JSON, setserverBaseon browser adapter, thenloadFromText() -
loadFromText(text, handle, name)— callsloadProject(text)from the model layer, sets state, selects first paper -
save()/saveAs()—serializeProject(project)→ delegate to platform, clearsdirty, refreshesrecents -
selectPaper(id)— switches paper, clearspdfSelection -
setFieldValue(path, name, index, value)— navigates the annotation tree viacontainerAt(), setsinst.value, marks dirty -
addInstance(path, def)/removeInstance(path, name, index)— manages repeatable annotation instances, respectsmax/min -
toggleTheme()/setTheme(theme)— flips or sets the app theme, applies viaapplyTheme()(setsdata-themeattribute on<html>) -
increaseFont()/decreaseFont()/resetFont()— adjustsfontScaleby ±0.1 (clamped to 0.7–2.0), applies viaapplyFontScale()(sets--app-font-scaleCSS variable) -
zoomInPdf()/zoomOutPdf()/resetPdfZoom()— adjustspdfZoomby ±0.2 (clamped to 0.4–3.0, rounded to 2 decimals) or resets to 1; session-only, not persisted -
applyAiSuggestions(suggestions)— writes the reviewer-approved AI proposals into the current paper as one undo step, and marks every field it wrote (see "AI-assisted annotation" below) -
confirmAiMark(paperId, canonicalPath)— drops one AI mark; the reviewer clicked into that field (or its label) -
undo()/redo()— swap the current project snapshot with one from thepast/futurestack (and switch to the affected paper). The mutating actions push a snapshot before applying; consecutive edits to the same field coalesce into one undo step (a module-levellastFieldKeytracks this), while add/remove/paper-switch reset it. History is cleared on project load. -
setHelpOpen(open)— shows/hides the help dialog -
selectReviewer(reviewer)— switchescurrentReviewerand persists the choice per project. A view switch: no undo step, nodirty -
openConsolidation(path, name, index)/closeConsolidation()— open/close the compare popup for one field -
alignConsolidationNode(paperId, nodeName, coalesce)— match the reviewers' repeated entries under one node and write the result in (reorder + grow); see "Matching the reviewers' repeated entries" below -
adoptUnanimousValues(paperId, coalesce)— fill the consolidated fields every reviewer answered the same way, marking each viaaiMarks; runs after the matching for a paper
The containerAt(root, path) helper walks the annotation tree following PathSeg[] (name + index pairs) to reach the container for a given path. currentTree(project, currentReviewer, paper, create?) decides which tree that walk starts from — see "Multiple reviewers & Consolidation" below; setFieldValue, addInstance, removeInstance, and applyAiSuggestions all call it before touching anything.
App (src/App.tsx)
├── Toolbar (src/components/Toolbar.tsx)
│ Open ▾ dropdown (Open file… + recent projects) + Save ▾ dropdown (Save / Save as…)
│ Font controls (A− A A+), theme toggle (☾/☀), help (?)
│ Reviewer switch (multi-reviewer projects only), centered on the toolbar — Reviewer 1..N + Consolidation, hidden entirely for a single-reviewer project; pills at ≤5 reviewers, a dropdown above that; see "Multiple reviewers & Consolidation" below
├── [if project loaded: workspace — a CSS grid whose column widths come from resizable panes]
│ ├── PaperList (src/components/PaperList.tsx)
│ │ List of papers with search box (META / TAGS modes, see below); green dot if the active reviewer has annotations; click to select
│ ├── Splitter (src/components/Splitter.tsx) ×2 — drag handles between the panes
│ ├── PdfViewer (src/components/PdfViewer.tsx)
│ │ react-pdf Document+Page; ResizeObserver for width; zoom controls; multi-page navigation; jump history (back/forward); in-PDF search (Ctrl+F); text selection capture
│ └── AnnotationPanel (src/components/AnnotationPanel.tsx)
│ ✦ AI button in the column header (opens AiDialog; disabled while busy, when the paper has no PDF, when the project forbids it, when no reviewer is picked yet, or — by default — always, until the hidden unlock; see "AI-assisted annotation" below)
│ renders the tree `currentTree()` routes to for the active reviewer; prompts to pick a reviewer instead of the form when a multi-reviewer project has none selected yet
│ └── AnnotationNode (src/components/AnnotationNode.tsx) [recursive]
│ └── Field (src/components/Field.tsx)
│ Input control (text/number/checkbox/enum ComboBox) + ⧉ grab-from-PDF button + (Consolidation mode only) ⇄ compare button → opens ConsolidationDialog for that field
├── [if no project: welcome screen with "Open project…" button + recent projects list]
├── AiDialog (src/components/AiDialog.tsx)
│ Modal driven by useAiStore's phase: pick a target → Start → review table → Apply
│ └── LlmSettingsDialog (src/components/LlmSettingsDialog.tsx) — manage LLM targets (stacks on top)
├── HelpDialog (src/components/HelpDialog.tsx)
│ Modal overlay with app intro + keyboard shortcuts table
├── ValidationDialog (src/components/ValidationDialog.tsx)
│ Modal overlay showing the results of "Validate", scoped to the active reviewer's own tree (or the consolidated one, for Consolidation) — see below
├── ConsolidationDialog (src/components/ConsolidationDialog.tsx)
│ Modal overlay reachable only from Consolidation mode's ⇄ button: every reviewer's answer for one field, side by side; picking one writes it into the consolidated tree
└── ErrorPanel (src/components/ErrorPanel.tsx)
Modal overlay for load/save errors
Dropdown (src/components/Dropdown.tsx) is a reusable click-to-open menu. Items are a union of item (label, optional shortcut, disabled, onSelect), separator, or header. It closes on outside-mousedown, Escape, or item selection. The Toolbar uses two Dropdown instances: Open ▾ (with recent projects list) and Save ▾ (with shortcut labels).
AnnotationNode is the core recursive component. Given a ResolvedDef and a container (AnnotationValueTree), it:
- For a single non-repeatable leaf — renders one
Fieldon a single row (the common case). - For repeatable or group nodes — renders a header with "+ Add" button (if repeatable), then iterates instances. Each instance shows a remove ("×") control (if repeatable), an optional field, and recursively renders children with an extended
path.
The path (PathSeg[]) is extended at each nesting level: [...path, { name: def.name, index: i }]. This path is passed to store actions to navigate the tree.
Field renders the appropriate input based on def.type:
-
boolean→ checkbox -
number→<input type=number> -
stringwithoptions(enum) →ComboBox(src/components/ComboBox.tsx) — a filterable dropdown of allowed values; no free-text grab button -
stringwithoutoptions→ auto-expanding<textarea>(single line when idle, grows on focus up to 240px, max 500 chars)
The grab-from-PDF button (⧉) reads useStore.getState().pdfSelection and inserts it. It is shown for string (non-enum) and number fields. For number fields, it extracts the first numeric token via parseNumber() (handles comma decimals).
src/components/NodeName.tsx renders schema node names. When a definition has a description, the UI adds an ⓘ marker, shows the description as a hover/focus tooltip, and renders that tooltip in a portal so it is not clipped by the annotation panel scroll container. The wrapper also includes an aria-label that combines the name and description for assistive technology.
The start screen shows the running version at the bottom (SaiLoR v0.1.0) and, when a newer release exists, a notice linking to it. src/model/version.ts fetches api.github.com/repos/Gram21/SaiLoR/releases/latest and compares the tag with __APP_VERSION__ — injected from package.json by vite.config.ts, so package.json stays the single source of truth for the version.
This only works while the repository is public. GitHub answers 404 to an unauthenticated request for a private repo's releases, and the app is distributed — embedding a token to get around that would ship a credential to every user, so we don't. The check is therefore written to fail silently: a 404 (private), 403 (rate-limited), network error, draft release, or unparseable version all yield null, and the app simply shows no notice. It starts working the moment the repo is made public, with no code change.
When a newer release exists, the notice offers a direct download of the installer for this machine rather than dumping the user on the releases page: pickInstaller matches the release's assets against the OS/arch reported by getOsInfo() (Electron exposes process.platform/process.arch through the preload bridge; the browser returns null, since a web deployment has no installer and updates by redeploying). Matching keys off the OS/arch we bake into the artifact names (SaiLoR-0.2.0-macos-arm64.dmg), so it stays correct as long as package.json's artifactName patterns do. When nothing matches it offers nothing rather than the wrong binary, and the release-notes link is always there as a fallback.
isNewerVersion compares numeric components, not strings (0.10.0 > 0.9.0, which a string compare gets wrong), strips a leading v, and sorts a pre-release below its release (1.0.0-beta < 1.0.0). It never claims an update from a version it cannot parse.
The result — including a null — is cached in localStorage (slr.updateCheck) for 24 h, so a private repo or an offline launch doesn't re-request on every startup, and the 60-requests-per-hour unauthenticated rate limit is never a concern.
The paper-list search box (src/components/PaperList.tsx) has two modes, toggled by a trigger sitting inside the input's right-hand edge, labelled META (title + authors + DOI, the default) and TAGS (the annotation values recorded in the active reviewer's tree; see currentTree above). The trigger is given a fixed width rather than relying on its two labels being the same length: the active state is bold, and bold vs. regular text of equal character count still measures a few px apart, which would reintroduce exactly the reflow the fixed width exists to prevent. It replaced a 🔎/🏷 emoji pair whose differing glyph widths visibly resized the control on every toggle. Both modes share one ranking: filter to papers where every query word matches, then sort by distinct words matched, then total matched characters, then original order — only the haystack differs per mode.
Both haystacks are precomputed once per paper in a useMemo keyed on [papers, schema], not re-walked on every keystroke. papers is a safe key for annotation content too: the store's immer set produces a new paper object — and therefore a new papers array — on every field edit, so the memo is invalidated exactly when annotation content actually changes, never stale.
The annotation haystack comes from annotationText(schema, tree) (src/model/annotations.ts), which mirrors hasAnnotations's recursive walk: it collects every field value that is a non-empty string or a number, joined and lowercased. Booleans are skipped — every paper has one per boolean field (defaulting to false, never absent), so including "true"/"false" would make almost every paper match. Like the rest of that module, it never throws on a tree that doesn't match the schema's shape.
src/model/validate.ts checks a reviewer's annotations against the schema; the Validate button in the toolbar runs validateProject(project) and ValidationDialog shows the result grouped by paper (click a paper to jump to it). Four issue kinds: required (a field marked required is empty), type (the stored value doesn't match the field's type — the JSON is hand-editable), enum (a value outside the field's options), and cardinality (an instance count outside [min, max]).
Only papers with at least one annotation are actually validated. validateProject returns { issues, unannotated }, not a bare array: a paper nobody has touched yet fails every required field for the single reason that it hasn't been started, which would drown the results in noise that says nothing a reviewer doesn't already know from the paper list's own "not annotated yet" dot. Such a paper is skipped from issues entirely and instead added to unannotated — the check is hasAnnotations(schema, paper.annotations) (src/model/annotations.ts, the same primitive that drives that paper-list dot, see below), so "annotated" means exactly the same thing in both places: on the first field genuinely filled in, not merely present in the tree. This matters for booleans specifically, since hasAnnotations disagrees with isEmptyValue on purpose — a boolean left at its untouched false does not count as an answer here (only an explicit true does), whereas isEmptyValue treats a boolean as never empty for the required check. The two functions are answering different questions ("has this paper been started at all" vs. "is this one required field answered") and are not meant to agree. ValidationDialog renders unannotated as a separate, plain "not annotated yet" checklist below the issues — clickable like everything else, but with no kind badge or message, since there is nothing to report beyond "this one hasn't been started."
Emptiness is the load-bearing definition, and booleans are the special case: a boolean field is never empty. An unticked box is a real answer (false), and a missing/null boolean reads as false — so a required boolean can never raise a required issue. 0 is likewise a real number, and ''/whitespace is empty only for strings. A type mismatch suppresses the required/enum checks for that field, so one broken value yields one issue rather than a cascade. Everything is defensive: a malformed tree produces issues rather than throwing.
Fields are marked required by required: true in the schema (ResolvedDef.required, defaulting to false; rejected on a group, which holds no value). The schema editor exposes it as a Required checkbox on non-group rows, and the annotation form marks such fields with a red *.
Note that loadProject normalizes the tree to each node's min/max, so in practice cardinality issues only arise from a project that bypasses the loader.
On a multi-reviewer project, Validate checks the active reviewer's own tree, not the consolidated one — unless the active reviewer is Consolidation, in which case it checks the tree that actually ships. runValidation (store.ts) builds this by mapping each paper's annotations through currentTree() before calling validateProject, so validate.ts itself needs no reviewer awareness. The Validate button is disabled until a reviewer is picked, for the same reason the annotation form is withheld then: there is no "the reviewer" to validate yet.
A second screen (src/components/ProjectEditor.tsx, shown instead of the workspace while useEditorStore().open) lets users create or edit a project JSON — its annotation schema and the PDFs it references — without hand-writing JSON. It is entered from the welcome screen's New annotation JSON… / Edit annotation JSON… buttons, or from the ✎ pen on a recent project (startEditRecent, which loads that recent by id rather than prompting a file picker; startEdit and startEditRecent share editorStateFromOpened).
The help dialog is mode-aware. HelpDialog derives a mode from useEditorStore().open and whether a project is loaded, then renders one of three guides, each with only the shortcuts that actually do something there, plus a badge in the title naming the mode:
- Getting started (start screen, nothing open) — what an SLR project JSON is, and what the three buttons do (open / new / edit).
- Annotating (a project is open) — pick a paper, read the PDF, fill the fields, save.
- Editing the annotation JSON (the editor is open) — schema building, drag-to-nest, adding PDFs, the two save buttons.
Shared sections (appearance, license) render in all three.
Two ways out of the editor: Save JSON writes the file and stays put (so you can keep building), while Save JSON & Begin Annotating writes it and hands it to the annotation view (loadFromText) — that split is save() vs saveAndAnnotate(). Both validate first, so an invalid draft neither writes nor closes. The editor has its own undo/redo history (past/future snapshots, same shape as the annotation store, with consecutive keystrokes in one input coalesced into a single step), and useKeybindings / useElectronCloseGuard route Ctrl+S / Ctrl+Z / Ctrl+Shift+Z / Ctrl+Y to it whenever it is open.
-
src/state/editorStore.ts— a separate Zustand+immer store holding the draft. It deliberately works on the raw JSON shape, not the loadedProject: each paper'sannotationsobject is carried through verbatim while the schema is edited, so editing the schema never prunes existing annotation data (it is normalized against the new schema the next time the project is opened for annotating). Key pieces:EditorNode(a schema node with a client-sideuid, wherekind: 'group'means "notype" — a name-only sub-tree),EditorPaper(which also keeps the PDF's absolutesourcePath),toAnnotationDefs/fromAnnotationDefs(conversion to/from the compact on-diskAnnotationDef),moveNodeIn(tree move that refuses to drop a node into itself or its own subtree),buildProjectJson, andvalidateDraft— which runs the realprojectSchema+resolveSchemavalidators, so the editor cannot produce a file the loader would reject. On save it writes the JSON and hands it straight to the main store vialoadFromText. -
SchemaTreeEditor.tsx— recursive tree exposing the schema's full expressiveness: name, kind (Group / Text / Number / Yes-no),min,max(with an ∞ checkbox formax: null= unbounded repeats), description, enumoptions(string fields only), nesting, add/remove. Native HTML5 drag-and-drop reorders rows and builds nesting: the drop position comes from the pointer's Y within the target row — top 25% →before, bottom 25% →after, middle →inside(nest as a child). -
PapersEditor.tsx— add PDFs one at a time, a whole folder at once, or import a reference-manager export (three buttons next to each other in the header/empty state), edit each paper's id/title/authors/DOI and itspdfpath, reorder by drag, remove.
Adding PDFs (addPdfs) does two things beyond appending rows:
-
Duplicate rejection. A PDF already referenced is skipped rather than added twice, and the skipped names are reported in a dismissible notice. Identity is
pdfKeys(): the absolute path when known (Electron) and the stored relative path — so re-picking the same file, picking it twice in one dialog, or picking one already listed in an opened project all collapse to one entry. Same-named PDFs in different folders stay distinct. -
Title/author auto-fill.
src/model/pdfMeta.tsreads each added PDF (PickedPdf.read()— an IPC in Electron,File.arrayBuffer()in the browser) and pre-fills the fields. It tries the PDF's embeddedTitle/Authormetadata first, validating it (isPlausibleTitlerejects artefacts like "Microsoft Word - paper_final_v3.doc"), then falls back to a layout heuristic on page 1: the largest text near the top is the title (joined across wrapped lines), and the lines under it are the authors. A line is not a flat string but a list of segments, split wherever two runs on the same baseline sit more thanCOLUMN_GAP_RATIOfont-sizes apart — a word space is a fraction of the font size even in justified text, a column gutter is several times it. This matters because the common two-column author block puts each author on the same baseline with nothing between them but the gutter: joined first,Jan KeimandAngelika Kaplanread as the single name "Jan KeimAngelika Kaplan", and no amount of later parsing can recover the boundary, since there is no punctuation at it. So authors are parsed per segment. A run whosewidthpdf.js does not report never starts a segment: without it there is no way to know where a run ends, and guessing could cut mid-phrase.parseAuthorListstrips affiliation superscripts, footnote daggers, emails and an "Authors:" label; instrictmode (used only for the heuristic, which is a guess) it also requires each entry to look like a person's name, so a body sentence can't become an author list. Everything is best-effort and only ever pre-fills — rows appear immediately with a name-derived placeholder, extraction patches them in the background, and it never overwrites a value the user has already typed. The pdf.js worker is configured once insrc/platform/pdfjs.ts, shared by the viewer and the extractor.
Adding a whole folder of PDFs (addPdfFolder) is addPdfs with a different picker: both funnel into a shared addPickedPdfs(picked) closure in editorStore.ts that does the duplicate rejection, row creation, and background title/author extraction described above. Only pickPdfs() vs pickPdfFolder() differs. pickPdfFolder() returns every .pdf found recursively under the chosen folder — Electron via a plain recursive readdir walk over the real filesystem, the browser via the same webkitdirectory <input> mechanism ensureLocalPdfGrant() uses for the PDF-viewer's one-time folder grant (see pickPdfFolderViaInput above) — filtered to file names ending in .pdf. Reusing that input, rather than writing a second one, keeps the one careful piece of cross-browser logic (the cancel-event-not-focus-guess cancellation detection, needed because Firefox's own "Upload N files?" confirmation appears after the OS dialog already returns focus) in one place.
Importing references (importReferences) reads a BibTeX/RIS/CSL-JSON export from a reference manager (Zotero, Mendeley, JabRef, EndNote) and turns each entry into a paper row, without requiring a PDF to already be attached. src/model/references.ts (parseReferences(text, filename)) is a pure, defensive parser — the format is picked from the extension, content-sniffed as a fallback — that never throws: a malformed entry (unbalanced braces, a missing field, an entry with no title) is skipped rather than failing the whole file. For each parsed RefEntry, editorStore.ts dedupes against existing rows: a DOI match (case-insensitive, exact) wins first, else a normalized-title match (lowercased, whitespace-collapsed, punctuation-stripped) — a match fills in that row's empty fields only (never overwriting something the reviewer already typed) and counts as "updated" or "already complete" in the summary notice; a non-match adds a new row with pdf: '' (or the imported pdfHint's file name as a placeholder, if the reference file named one) for the reviewer to attach a PDF to afterward. The whole import is one undo step. Because pdf: '' is something addPdfs/addPdfFolder never produce, validateDraft reports it as a named per-paper issue ("Paper N has no PDF attached") rather than letting it reach buildProjectJson/save(), which still requires the on-disk pdf to be non-empty (paperSchema in src/model/schema.ts is unchanged — this tolerance is draft-only).
Highlighting newly added papers. Every row added by addPdfs, addPdfFolder, or importReferences gets a light-blue border so the reviewer notices the addition and checks the (possibly guessed) metadata — the same idea, and the same --ai-mark CSS variable, as the AI-annotation "unconfirmed" marks below. editorStore.ts tracks this the same way aiMarks does in the main store: a session-only justAdded: Record<uid, true>, not part of EditorSnapshot/undo (an add already has its own undo step) and never written to the file. It is cleared wholesale on save, on opening a project into the editor, and on closing the editor (openEditorSession, close, save). PapersEditor.tsx clears one row's mark (confirmAdded) the moment the reviewer focuses any of its fields, mirroring how Field.tsx clears an AI mark on focus/click.
Relative PDF paths. The JSON's location is chosen up front (and changeable any time via Change…), because a paper's pdf is stored relative to the JSON file. Each picked PDF keeps its absolute sourcePath, so when the location changes changeLocation() re-derives every pdf against the new directory (/reviews/x.json + /reviews/pdfs/a.pdf → pdfs/a.pdf; move the JSON up a level and it becomes reviews/pdfs/a.pdf). This only works in Electron, where real filesystem paths exist: the platform methods pickProjectLocation / pickPdfs / relativePdfPaths (see below) compute it via a paths:relative IPC (path.relative(dirname(json), pdf), POSIX-separated). In the browser the File System Access API exposes no paths, so a picked PDF is stored as its bare file name and the user places it next to the JSON or edits the relative path by hand — the papers editor says so. A row added by importReferences with no PDF yet (pdf: '') has no path to rederive either way, and is left alone until the reviewer attaches one.
parseReferences(text, filename) turns a BibTeX/RIS/CSL-JSON export from a reference manager (Zotero, Mendeley, JabRef, EndNote) into RefEntry[] (title, authors, doi?, year?, pdfHint?). The format is picked from the file extension, content-sniffed as a fallback (@ → BibTeX, a TY - line → RIS, leading [/{ → CSL-JSON). It is a pure, defensive parser — a malformed entry is skipped rather than failing the whole file, and parseReferences itself never throws.
LaTeX escapes. BibTeX (and RIS, when it originated from a .bib round-tripped through a converter) routinely spells non-ASCII letters as LaTeX escapes rather than UTF-8 — an accent command on a base letter (\"o, \'e, \c{c}) or a handful of standalone letters that aren't "letter + accent" at all (\ss, \o, \ae, \i, ...). unescapeLatex resolves both via lookup tables (LATEX_ACCENTS, LATEX_LETTERS) rather than a chain of per-letter replacements, and handles all three shapes a command can appear in — bare (\"o), its own braced argument (\"{o}), or wrapped in an extra capitalization-protecting brace pair ({\"o}) — as one case: it only ever matches backslash-led sequences, so surrounding braces are inert to it either way. This is why cleanBibValue runs it before stripping braces — {\"o}'s braces need to still be there for the bare-letter branch to see past them, and are gone by the time the generic {} strip (still needed for plain capitalization protection like {DNA}) runs afterward. A bare control word also consumes the single space that terminates it — S\o ren is "Søren", because TeX ends a control word at that space and does not treat it as text; getting this wrong mangles most Nordic names. That is safe only because the author list is split on " and " before any unescaping (parseBibEntry), which is the order BibTeX itself works in: the separator belongs to the field, not to any one name. Unescape first and a name-final control word (Hans Wei\ss and Sven) would swallow the separator's space and glue the two names together. An unrecognized escape degrades gracefully: the backslash is dropped and the rest is left as-is, never a crash or a stray backslash. This unescaping does not apply to the BibTeX file field or RIS L1/UR (cleanBibPathSegment, kept deliberately narrower than cleanBibValue) — a Windows path like C:\Users\name\file.pdf is mostly backslashes, and the graceful-degradation fallback would otherwise mangle it. CSL-JSON is real JSON, already UTF-8, so none of this runs there.
Merged author names. Some exports lose the and separator between BibTeX authors entirely ("Jan KeimAngelika Kaplan") or partially ("Jan Keimand Angelika Kaplan", "Jan Keim andAngelika Kaplan"). splitAuthorList repairs the unambiguous half-loss (andX with no space and a capital right after — never legitimate text) unconditionally, then repairMergedAuthorNames looks for a lowercase→uppercase seam either inside a bare "and"-suffixed token or inside a single fused token, and only commits to a split when both halves come out as plausible multi-token "First Last" names. This is a deliberately conservative heuristic — a wrong split silently corrupts a real name, which is worse than leaving two names glued together — so a Mc/Mac/De/Di/La/Van/Du prefix allowlist protects McDonald-style surnames, an apostrophe or hyphen at the capital (O'Brien, Smith-Jones) is never even seen as a seam (the check requires direct lowercase→uppercase adjacency), and the both-sides-multi-token requirement is what keeps genuine names ending in "and" (Roland, Armand, Ferdinand) from being torn apart when nothing follows them worth calling a second name. RIS and CSL-JSON don't get this treatment: their authors are already structurally one-per-entry (AU/A1 lines, author[] array), so the separator-loss problem this heuristic exists for cannot occur there.
Uses react-pdf's Document + Page components. The pdf.js worker is loaded from the bundled dependency URL. A ResizeObserver tracks container width so pages scale to fit; the final render width is the fit-to-width size multiplied by the store-level pdfZoom factor. The PDF header shows the paper title, authors, and DOI, plus zoom controls (−, percentage, +) wired to zoomOutPdf / resetPdfZoom / zoomInPdf. For multi-page PDFs, the header also shows page navigation (prev/next buttons, a page-number input, and a total page count). The current page is tracked from scroll position via onScroll — the last page whose top has scrolled past 30% of the viewport height — and typing a page number jumps to that page. The PDF text and annotation layers are both rendered. Pages are align-items: safe center so horizontal scrolling remains reachable when zoomed wider than the pane. Text selection is captured via onMouseUp/onKeyUp → window.getSelection() → setPdfSelection().
External links. The <Document> is given externalLinkTarget="_blank" and externalLinkRel="noopener noreferrer", so link annotations pointing at a website render as target="_blank" anchors and open in a new browser tab rather than navigating the SPA away. Internal (in-PDF) destinations are unaffected — pdf.js renders them without a target and its LinkService scrolls to them. In Electron, main.ts intercepts the resulting window.open with webContents.setWindowOpenHandler, hands the URL to shell.openExternal (the user's default browser), and returns { action: 'deny' } so no Electron window is created. A will-navigate listener is a safety net that prevents anything from navigating the app window away, routing off-app URLs to the browser too. Both paths go through openExternalUrl, which only opens http:/https:/mailto: — never file: or other schemes, which the OS could use to launch programs.
Jump history (back/forward). Clicking an internal PDF link (e.g. a reference) lets the pdf.js LinkService scroll to the destination. An onClickCapture on the scroll container notices clicks on <a> elements and, after polling briefly, records the pre-jump scrollTop on a back stack only if the view actually moved (so external links, which don't scroll, are ignored). Two header buttons (↩ / ↪, shown once history exists) then move between positions like a browser: jumpBack pops the back stack, pushes the live position onto the forward stack, and scrolls there instantly (scrollTo with default behavior — reliable under prefers-reduced-motion); jumpForward is symmetric. The stacks are refs (with canJumpBack/canJumpForward state mirroring their lengths) and are cleared when the paper changes.
In-PDF search. A 🔍 button in the header (and Ctrl/Cmd+F) toggles a find bar below the header; opening it focuses the input so the user can type immediately (via a searchOpen effect, since the input isn't mounted on the open transition). findMatches walks the text nodes of each rendered text layer (.react-pdf__Page__textContent), concatenating them per layer so a query can span multiple spans, and returns DOM Ranges. Matches are painted with the CSS Custom Highlight API (CSS.highlights + ::highlight(slr-pdf-search) / ::highlight(slr-pdf-search-active)) — this tints the transparent text-layer glyphs without mutating react-pdf's DOM, and degrades gracefully where the API is unavailable. The active match is centered in the scroll container; Enter / Shift+Enter (and the ‹ › buttons) cycle matches. Crucially, the <Page> elements are memoized (useMemo on [numPages, renderWidth, onTextLayerRendered]) with a stable onRenderTextLayerSuccess callback, so typing in the search box reuses the same element references and React skips re-rendering the pages — otherwise every keystroke would tear down and re-render the text layers (a "TextLayer task cancelled" flood) and matches would never resolve.
PDF source resolution is async: getPlatform().getPdfSource(paper.pdf, saveHandle) returns a { url, revoke? }. The effect cleans up (revokes blob URLs) on paper/handle change or unmount.
An SLR is normally annotated by ≥2 reviewers independently, then reconciled into one final
answer. config.reviewers (2–10) turns this on for a project; see data-model.md for the file
format and Paper.reviews shape. This section covers the store/UI wiring.
currentTree(project, currentReviewer, paper, create?) (src/state/store.ts) is the single
routing decision every mutating action and every reader goes through: single-reviewer →
paper.annotations (unchanged from before this feature); Consolidation → paper.annotations
(the tree that ships); a numbered reviewer → paper.reviews[N]; nobody picked yet on a
multi-reviewer project → null. create (default false) controls whether a numbered
reviewer's missing tree is lazily initialised and normalized in place (only safe inside an immer
set() producer — the mutating store actions pass true) or a fresh throwaway default is
returned for display/validation without touching the project (selectors and read-only
computations pass nothing). setFieldValue, addInstance, removeInstance, and
applyAiSuggestions all resolve their target tree this way before doing anything else, and bail
out — no write, no undo entry — if a multi-reviewer project has no reviewer selected yet.
Two reviewers who both record three Findings need not record them in the same order: Reviewer 1's
Finding #1 may be Reviewer 2's Finding #3. Comparing them position by position would then report
disagreement that isn't there. Whenever Consolidation is the active seat,
useConsolidationAlignment (src/hooks/) works out which of each reviewer's entries are the same
entry and lines them up.
| Module | Does |
|---|---|
similarity.ts |
How alike two answers are, as {score, weight}. weight is what makes "agrees on five fields" outrank "agrees on one" — averaging scores alone cannot tell those apart, as both average to 1.0. Weight 0 means the pair said nothing (a field only one reviewer filled abstains rather than voting against). Text is max(levenshtein ratio, token Dice); enums compare as labels, never as characters ("High"/"Low" overlap and mean the opposite); a false boolean carries no evidence, since every untouched boolean reads false
|
assign.ts |
Hungarian max-weight assignment. Greedy is not merely worse but wrong here: one locally good pair can force two later entries into a much worse one, and greedy cannot trade the first against the second |
align.ts |
The recursion. alignNode returns slots per repeatable node; alignableNodes lists what is worth doing |
apply.ts |
Writes an alignment into the data |
unanimous.ts |
Finds the fields every reviewer answered identically, for adoptUnanimousValues to fill. Owns comparable() — the one rule for "did they say the same answer", shared with disagreements.ts and the compare popup so the three cannot drift into different verdicts |
disagreements.ts |
The per-field cross-reviewer verdict (FieldVerdict): who answered, which category their answer falls in, whether that is agreement. What both the overview and the statistics read |
metrics.ts |
Cohen's κ, Fleiss' κ, Krippendorff's α over abstract units × raters, each with an applicability check that explains refusal in a sentence. Knows nothing about papers or schemas, so it can be checked against published worked examples |
agreement.ts |
Turns projectVerdicts into a MetricInput
|
Matching cannot cross, which is a requirement of the feature: a group's sub-entries are only ever matched inside an already-matched pair of parents, because the recursion never offers a candidate from another group. It is structural, not a rule applied afterwards.
The mapping is stored as the ordering itself — there is no mapping field in the file. Every
reviewer's entries are reordered so position N means the same entry for everyone, and the
consolidated tree is grown to one entry per slot (the feature's "add the maximum number
automatically" rule). This is why pruneTree keeps interior gaps and drops only trailing
empties: a reviewer with no entry for slot 2 holds an empty one there, and closing that gap would
slide every later entry down a slot and silently re-point the alignment on the next load.
It runs a node at a time, off the paint path. Matching is not cheap — a large paper measures in
the hundreds of milliseconds — so the hook yields to the browser between nodes rather than freezing
the window as it opens. Whatever the reviewer opens the ⇄ compare popup on jumps the queue.
alignConsolidationNode(paperId, nodeName, coalesce) is the store action; coalesce folds later
nodes into the undo entry the run's first node pushed, so lining a paper up is one undo press.
A node the consolidator has already answered is never re-matched. Their entry N means a particular thing to them; re-matching could move a different entry into slot N, leaving their recorded answer describing something it was never about. The cost is that entries added after consolidation began are not auto-matched for that node — the safe side of the trade, since a stale match is visible and a silently re-pointed answer is not.
Once the matching for a paper is done, the scheduler runs adoptUnanimousValues, which fills every
still-unanswered consolidated field on which all reviewers gave the same answer, and marks each
one via aiMarks — the same light-blue border an AI fill gets, meaning "the app did this, you have
not looked at it yet". There is nothing to reconcile where everyone already agrees, and copying
those across by hand is the kind of task done on autopilot, which is when the real disagreement two
rows down gets missed.
It runs after matching, necessarily: it reads every reviewer at a fixed index, which only means anything once their entries line up. The rules:
-
Comparison folds case and whitespace only (
"Controlled experiment"=="controlled experiment "). Not punctuation, and no fuzzy matching — the matcher's job is to pair entries, where near-enough is right; writing a value into the shipping tree unasked is a higher bar. The lowest-numbered reviewer's wording is kept, trimmed, so the choice is deterministic. -
Every reviewer must have answered. Two agreeing and a third blank is not unanimous — silence is
not assent. This is also what keeps booleans honest:
isUnanswered(src/llm/fields.ts) counts a boolean as answered only once ticked, so untouched checkboxes — which all readfalse— do not count as a unanimous "no" and mark every checkbox in the project. - A field the consolidator already answered is left alone, per field (unlike the matching guard, which is per node).
A multi-reviewer project opens with currentReviewer === null — never Reviewer 1, since an
unattributed edit is worse than a prompt. ReviewerPrompt renders over the app in exactly that
state: it explains what multi-review means (independent annotation, one reconciling pass) and makes
the reviewer choose. There is no dismiss — the form is withheld without a seat anyway, so a dismiss
button would only offer a state in which nothing can be done — but it yields to Help (helpOpen),
which is otherwise unreachable behind it.
Because the selection is persisted per project, "prompt shows" means "first open of this file". The
exception is a project with no stable path — a ?project= URL, or a browser download-only save —
where reviewerStorageKey deliberately persists nothing rather than risk restoring a seat under the
wrong project. Those ask on every load. That is honest (the app genuinely cannot tell who you
are) but it is the one case where the prompt is not a once-per-project event.
readyToConsolidate(schema, paper, reviewerCount) — every numbered reviewer has recorded something
on this paper, by hasAnnotations (so a ticked box counts as work; an unticked one never does, since
every boolean reads false whether or not anyone looked).
The Consolidation seat itself is not gated — a consolidator may legitimately start on the papers that are ready while the rest are still being reviewed. The gate is per paper instead, and one rule drives both places it shows, so they cannot disagree:
- the paper list's dot (
paperIsMarkedDone) reads "ready to consolidate" in that seat; - a field's ⇄ compare button is disabled on a paper not every reviewer has annotated. That reviewer's column would otherwise render empty, which reads as "they found nothing here" when the truth is "they have not looked yet" — inviting a decision on evidence that does not exist.
Alignment and unanimous adoption already decline such papers on their own (alignConsolidationNode
needs two reviewer trees; adoptUnanimousValues needs every reviewer to have answered), so no extra
guard is needed there.
Two buttons sit in .annotations-head-row in the Consolidation seat only — the slot the ✦ AI button
occupies elsewhere.
⚖ Agreement (AgreementDialog) computes the coefficients the reviewer ticks. A unit is one
annotation field on one paper; agreement.ts includes only the fields at least two reviewers
answered, since a field with one answer carries no agreement information (disagreements.ts says
so, and warns that callers must gate on answeredBy.length >= 2 rather than trust agree, which is
vacuously true for a single answer). The dialog states the unit count and how many were skipped, so
the reader can see what was measured rather than guess.
A metric that cannot honestly be computed is disabled, at half opacity, with its Applicability.reason
verbatim on hover — those strings are written as complete user-facing sentences for exactly that
("Cohen's κ compares exactly two reviewers; this project has 3"). Cohen's needs exactly 2 raters;
Fleiss' needs every reviewer to have rated every unit; Krippendorff's α survives both, which is why
it is worth having all three.
⚠ Disagreements (DisagreementOverview) lists every field where the answering reviewers gave
different categories, grouped by paper; a row jumps to it (selectPaper → openConsolidation), which
is the point — finding a disagreement is useless if you then have to hunt for it.
Reviewers write the same thing differently ("RCT" / "randomized controlled trial"). Nothing captured
that, so every statistic understated agreement. The compare popup carries a tick — "these answers mean
the same thing" — persisted as Paper.equal, a list of canonical field paths. disagreements.ts then
gives those reviewers one shared category, so the field reads as agreement everywhere: the badge, the
overview, and the coefficients. Measured on a two-reviewer demo, marking one such pair moved Cohen's κ
from 0.533 to 0.682.
The box only appears where there is something to declare — when the answers already match after
comparable(), there is nothing to add.
The mark alone is not a resolution, and the popup will not let it pass for one. It settles that
the reviewers agreed, which is enough to drop the field out of the disagreement list and count it as
agreement — but it says nothing about what they agreed on, so the consolidated value stays blank.
Marked-but-blank is the worst state available: resolved everywhere, holding no answer, and never
surfaced again. closingWouldStrand catches it on every exit (×, Escape, backdrop, and taking a
reviewer's blank answer, which records nothing and leaves the same hole). Leaving anyway un-marks
the field, so it returns to the disagreement list rather than disappearing quietly. Escape backs out
of that warning rather than through it — discarding the mark should take a deliberate click.
A boolean can never strand: isEmptyValue says a boolean is never empty, and rightly — an unticked
box is a real false, not a gap, so there is no value left to pick and the warning would be one the
reviewer could not clear.
Known limit, documented at the field: it is one boolean for the whole field, i.e. "all the answering reviewers here are equivalent". Exact for two reviewers; with three or more it cannot say "these two agree but that one does not".
AnnotationPanel does not render the ✦ AI button in this seat at all (not disabled, not the
transparent treatment the locked state uses — absent), and applyAiSuggestions refuses when
currentReviewer === 'consolidation', so opening the dialog as a reviewer and then switching seats
cannot get round it. Consolidation decides between what the reviewers actually said; a model's answer
would be a fresh opinion invented after the fact, written into the tree that ships and dressed as a
reconciliation of the others.
Matching is lexical only. Bundling a local embedding model (nomic-embed-text and similar) was
evaluated and rejected: ~185 MB installed at best and plausibly several hundred MB of RAM, against
peer-reviewed evidence (VLDB 2023 entity-resolution, DeepMatcher, fuzzylink) that on short,
structured strings — which annotation values are — good lexical methods match or beat embeddings,
which win on long dirty text, paraphrase and multilingual instead. onnxruntime-node has also
dropped Intel-Mac support. If semantic matching is ever wanted, the shape is an opt-in call to a
local Ollama (/api/embed) layered on top of lexical scoring, not replacing it.
currentReviewer is a view selection, not project data: switching it is not an undo step
and does not set dirty. It defaults to null (unselected) whenever a multi-reviewer project is
opened — never silently to Reviewer 1, since an unattributed edit is worse than a prompt — unless
a previous selection for this project was persisted. Persistence is per project, keyed by the
save handle's path (slr.currentReviewer.<path> via safeGet/safeSet/safeRemove in
src/state/settings.ts); a project with no stable path (server mode, or a browser download-only
save) simply doesn't persist a selection. It resets to null on closeProject/loadFromText,
same as validation/aiMarks.
Toolbar (src/components/Toolbar.tsx) renders a reviewer switch — buttons for Reviewer
1..N plus a visually distinct Consolidation pill — only when the open project is multi-reviewer;
hidden entirely otherwise. The active seat is highlighted; an unselected state gets a warning
border and a "Pick a reviewer:" prompt. Validate is additionally disabled until a reviewer is
picked (see "Validation" above). Note this shares the toolbar with the hidden AI-unlock click
gesture on the app title — the two are unrelated and don't interact.
The switch sits in a dedicated center track of the toolbar (.toolbar-left / .toolbar-center /
.toolbar-right in index.css, a 3-column grid with 1fr auto 1fr) so it's centered on the
toolbar itself rather than merely between its flanking groups — a plain margin: auto would drift
as the project title (.toolbar-status, on the right) changes length. The two outer tracks are
bare 1fr (not minmax(0, 1fr)), so each floors at its own min-content width and can never be
squeezed into overlapping the center; only .toolbar-right is allowed to shrink further, because
.project-name beneath it already truncates with an ellipsis. Under real space pressure the row
simply asks for more width than the window has (or the title truncates harder), never overlapping
text.
Above REVIEWER_DROPDOWN_THRESHOLD (5) reviewers, the pill row would crowd the toolbar, so the
same choice renders as a Dropdown (reusing src/components/Dropdown.tsx, extended with an
optional className for the warning/Consolidation styling hooks) instead of one button per
reviewer. The closed trigger always names the active seat ("Reviewer 3", "Consolidation", or
"Pick a reviewer" while unselected) rather than a bare caret — the whole point of the switch is
that the active seat reads at a glance without opening anything. The open menu marks the current
selection with a checkmark and keeps Consolidation visually distinct (its own label styling,
matching the pill form's colors) rather than listing it as "reviewer N+1". At 5 or fewer reviewers
the pill row is unchanged.
AnnotationPanel withholds the annotation form (showing a prompt instead) whenever a
multi-reviewer project has no reviewer selected, and otherwise renders the tree currentTree()
routes to for the active reviewer — falling back to a schema-shaped empty tree (not creating
anything) when that reviewer hasn't written on this paper yet. A small badge next to the paper
title echoes which seat is active, redundant with the toolbar switch on purpose: this is the one
piece of state that must never be ambiguous, since it decides which tree every edit lands in.
Consolidation compare popup. When currentReviewer === 'consolidation', Field.tsx shows an
extra ⇄ button next to the existing ⧉ grab-from-PDF button (and, for a boolean field, next to the
checkbox) that opens ConsolidationDialog for that exact field path. The dialog lists every
reviewer's raw value for the path (via the same peekValue/fieldPath machinery store.ts
already uses, and resolvePath from src/llm/paths.ts to resolve the ResolvedDef for display),
including reviewers who left it empty, and flags whether the answered reviewers agree. Clicking a
row calls the ordinary setFieldValue — Consolidation is the active reviewer while the dialog
is open, so that write already lands in paper.annotations via currentTree()'s routing; nothing
dialog-specific exists on the store side beyond consolidationTarget/openConsolidation/
closeConsolidation. Closing without picking changes nothing. Follows the same modal pattern as
ValidationDialog (.modal-overlay → .modal → .modal-head + .modal-body, Escape-to-close,
backdrop click).
AI marks and AI-assisted annotation are reviewer-scoped too — see "AI marks" below and
unansweredFields's call site in aiStore.ts's openDialog(), which now proposes values for the
active reviewer's empty fields via currentTree(), not unconditionally paper.annotations.
PaperList follows the same rule on both of its reads: the "annotated" dot and the annotation
search mode each go through currentTree(), so as Reviewer 2 the sidebar tracks your progress and
answers "which papers did I record this in" — the same tree the form and validation show. When the
project is multi-reviewer and nobody has picked a seat yet, currentTree() returns null and both
degrade to "nothing annotated / nothing to match" rather than falling back to the consolidated tree,
which would attribute someone else's work to the unselected reviewer.
A ✦ AI button in the annotation column's header asks an LLM to read the current paper and propose values for the fields that are still empty. The reviewer gets a table — field, proposed value, the supporting quote from the paper, the model's confidence, and a checkbox per row — and nothing is written until they press Apply.
The button being clickable requires both of two independent things to be true — Project.aiEnabled && useStore().aiUnlocked — and either one being false disables it identically:
-
Project.aiEnabled(config.aiin the file, defaulttrue) — the project's say. A provider of a project file can setconfig.ai: falseto forbid AI use on that file outright; seedocs/annotation-schema.md. -
useStore().aiUnlocked(defaultfalse, in-memory only, never persisted) — the app's say, for now: AI-assisted annotation ships in the app but is off by default regardless of whatconfig.aisays.config.ai: true(or omitting it) is necessary but no longer sufficient. The only way to flip this for the running session is the hidden gesture inToolbar.tsx:UNLOCK_CLICK_COUNT(12) clicks on the "SaiLoR" title withinUNLOCK_CLICK_WINDOW_MS(2500ms) of each other, counted by the purenextTitleClickState()(deliberately kept out of the component and unit-tested inToolbar.test.ts, since the "N clicks within a window, else the run resets" rule is exactly the kind of off-by-one/timing logic worth pinning down). The title itself carries notitleattribute, no pointer cursor, and no other affordance hinting that it does anything — nothing changes even mid-run, since the click count lives in auseRefspecifically so counting does not trigger a re-render.aiStore.openDialog()re-checks both flags as a second line of defense in case the dialog is ever reached another way; the disabled button is the primary gate.
Whenever the button is disabled — for any reason (busy, no PDF, aiEnabled false, or not aiUnlocked) — its tooltip is the uninformative "Coming soon" rather than a reason, so the button reads as an ordinary disabled control rather than one hinting it can be unlocked. Reaching for a specific one of these reasons in a new codepath is a sign the tooltip logic needs revisiting, not extending — see AnnotationPanel.tsx.
Not-yet-unlocked (!aiUnlocked) goes one step further than the other disabled reasons: the button is fully invisible, not merely dimmed. AnnotationPanel.tsx computes aiHidden = !aiUnlocked separately from aiDisabled, and applies an ai-btn-hidden class (opacity: 0 in index.css, overriding the ordinary .ai-btn:disabled dimming via the higher-specificity .ai-btn:disabled.ai-btn-hidden selector) plus aria-hidden="true" and a title of undefined — no visual presence, no accessibility-tree presence, no tooltip, nothing for a reviewer who hasn't found the click gesture to notice. The button is still in the DOM at opacity: 0 (not display: none), so unlocking mid-session doesn't shift the header's layout; it is also already disabled in this state (aiHidden implies aiDisabled), so it was never actually clickable regardless of visibility. Once unlocked, the other disabled reasons — busy, no PDF, and in particular a project that explicitly sets config.ai: false — go back to the ordinary dimmed-but-visible treatment: a reviewer who already knows the feature exists benefits from seeing that this specific project has turned it off, which hiding the button again would only obscure.
If a later product decision makes AI available by default again, aiUnlocked and the whole gesture can simply be deleted and Project.aiEnabled alone regains control — the two checks are additive (both must hold), not layered logic that needs untangling.
| Module | Job |
|---|---|
src/llm/types.ts |
The shared shapes: LlmConfig (one configured target — provider, base URL, model, attach, reasoningEffort?), ModelInfo/ReasoningProfile/ModelsPage (the model-listing shapes, see below), LlmHttpRequest/LlmHttpResponse, Suggestion, SkippedField, RejectedSuggestion, and the API_KEY_SENTINEL ({{apiKey}}). |
src/llm/fields.ts |
unansweredFields(schema, tree) — every field the AI will be asked about, in schema order. Its isUnanswered() is validate.ts's notion of empty for strings/numbers; a boolean is offered unless it is already ticked, since the data model cannot represent an unanswered boolean and the archetypal AI field ("Relevant") is one. |
src/llm/prompt.ts |
The system prompt: the schema format description (SCHEMA_FORMAT_DOC), the path syntax, the schema itself (dehydrateSchema, i.e. exactly as it appears on disk), one line per field to fill, the rules, and the output shape. Plus buildUserText / buildUserPdfCaption for the user turn. |
src/llm/paths.ts |
The path language of the LLM contract — "Findings[1]/Evidence[0]/Metric". parsePath / formatPath / displayPath, and resolvePath(schema, raw), which checks a path against the schema (not the current data), so the model may name the next free index of a repeatable node to record a further entry. |
src/llm/providers.ts |
Everything that differs per vendor for the annotation call: PROVIDERS (base URL, whether the URL is editable, whether the provider can take a PDF, which output-length parameter it wants — see below), buildRequest (Anthropic /v1/messages, Google /v1beta/models/{model}:generateContent, or OpenAI-style /v1/chat/completions for the rest — plus, when cfg.reasoningEffort is set, each provider's own reasoning-effort field, see below), extractText and extractError. join() tolerates a user-typed base URL that already ends in /v1 or the full chat path. Also exports baseOf/join for models.ts to reuse, and googleThinkingMechanism/GOOGLE_BUDGET_BY_LEVEL for Gemini's level-vs-budget split. |
src/llm/models.ts |
The model-listing call: buildModelsRequest(cfg, cursor?) (a GET, per-provider endpoint/auth/pagination) and parseModelsResponse(provider, json) (→ ModelsPage, defensive against every shape above). Also where reasoning-effort support is detected per model — see below. |
src/llm/parse.ts |
parseAnswer(schema, raw) — the trust boundary. Digs the JSON object out of whatever the model sent (fences, prose, stray braces), then validates every proposal against its ResolvedDef. |
src/model/pdfText.ts |
extractPdfText(bytes) — the paper as plain text, one [page N] block per page, using the same reading-order heuristic as pdfMeta.ts. Reports empty: true when a document yields almost no characters (a scan). |
src/state/aiStore.ts (a separate Zustand+immer store, kept out of the main store for the same reason the project editor is) owns the flow; src/components/AiDialog.tsx and LlmSettingsDialog.tsx are views over it.
-
openDialog()computestargets = unansweredFields(schema, paper.annotations)and loads the configured targets from the platform. The dialog names how many empty fields will be proposed and — before anything is sent — states what leaves the machine, and to whom. -
run()fetches the paper's bytes from the same URL the viewer renders (getPdfSource, soslr-file://in Electron andblob:/httpin the browser), then:-
attach: 'text'(the default, and the only option for anopenai-compatibletarget) →extractPdfText. If the extraction isemptythe run stops with an error rather than sending a title and inviting the model to invent a paper from it. -
attach: 'pdf'→ the PDF is base64'd and sent as an attachment (Anthropic / OpenAI / Google / OpenRouter only — the others have no way to take one inline in a single request). A target set topdfagainst a provider that cannot take one silently falls back to text, and the dialog's consent line mirrors that fallback rather than promising the PDF.
-
-
buildSystemPrompt(schema, targets, delivery)+buildRequest(config, …)→ anLlmHttpRequest. Thedeliverymatters: with extracted text the model is told the extraction is lossy, or it will confidently reconstruct a mangled table into numbers. -
platform.callLlm(request, signal)sends it (see below) and returns the raw body. -
parseAnswervalidates it; the survivingSuggestion[]become review rows, all pre-ticked — the reviewer's job is to remove what is wrong. -
apply()hands the ticked suggestions touseStore.applyAiSuggestions.
The store keeps an AbortController outside the state (it is not serializable), so Cancel aborts a call in flight; an elapsed-seconds ticker drives the progress line.
The model field in LlmSettingsDialog.tsx is not free-typed against nothing: aiStore.fetchModels(config, apiKey?, opts?) asks the provider itself what models exist, via the same platform.callLlm transport the annotation call uses — buildModelsRequest (src/llm/models.ts) builds a GET (the one place LlmHttpRequest.method is ever 'GET'; everything else is 'POST'), and parseModelsResponse turns whatever comes back into ModelInfo[]. Results are cached in aiStore's models/modelsLoading/modelsError/modelsFetchedAt, keyed by LlmConfig.id, for MODELS_TTL_MS (1h) unless opts.force bypasses it. Fetching still requires a stored key — same requirement, and same "save first" pattern, as verifyConfig.
ModelPicker.tsx renders the fetched list as a searchable dropdown, but — unlike ComboBox.tsx (used for closed enum fields elsewhere) — it never reverts what the reviewer typed. A provider's catalog can be incomplete (a brand-new model, a private fine-tune) or simply not fetched yet, so the model field always accepts free text; once the field has been left with text that doesn't match any fetched model, ModelPicker marks itself invalid (red border, a tooltip naming the provider) rather than silently discarding it. An empty/unfetched list is never "invalid" — only "unknown".
Reasoning-effort detection is per-model, not per-provider, because it depends on which model, not which vendor: models.ts attaches a ReasoningProfile | null ({ levels, defaultLevel }) to each ModelInfo, from two different sources depending on the provider:
-
Read from the response itself, where the provider says so: Anthropic's
capabilities.effort.{level}.supported(/v1/models— the exact levels a model takes, no guessing), Google'sthinking: booleanflag, OpenRouter's per-modelreasoning.supported_efforts. These need no maintenance as new models ship. -
A model-ID pattern, where the provider's list endpoint says nothing about it (OpenAI:
o[0-9]/gpt-5*minus-chatvariants; Groq:openai/gpt-oss*only; xAI:grok-4.5only; Mistral:mistral-(small|medium)*). These are best-effort allowlists, verified against each provider's docs at the time they were written, and will go stale as new models ship — revisit them the same waytokenParaminproviders.tsalready has to be revisited (see Change Guidance below). -
Deliberately
nullfor every model on two providers: DeepSeek (itsreasoning_effortcontract for the newer V4 models could not be confirmed against primary docs) andopenai-compatible(no single agreed-upon shape across llama.cpp/vLLM/LM Studio — llama.cpp is actively removing its per-request toggle in favor of a server-startup flag). Offering a control that silently does nothing on some servers is worse than not offering one.
LlmSettingsDialog.tsx shows the reasoning-effort <select> only when the currently selected model has a profile, defaults it to defaultLevel ("medium" when the model offers it, else the level in the middle of its range — "if reasoning effort is available, default to medium or the nearest equivalent") the moment such a model is picked, and clears LlmConfig.reasoningEffort the moment a non-reasoning model is picked instead — a stale effort level must never outlive the model it was chosen for. buildRequest (providers.ts) then injects it in whatever shape that provider's chat-completions call actually wants: Anthropic gets thinking: {type:'adaptive'}, output_config: {effort}; Google gets generationConfig.thinkingConfig.thinkingLevel (Gemini 3.x) or a token-count .thinkingBudget translated via GOOGLE_BUDGET_BY_LEVEL (Gemini 2.5.x — the two shapes are mutually exclusive on one request, so a model only ever gets one); OpenRouter gets a nested reasoning: {effort}; everyone else (OpenAI, Groq, Mistral, xAI) gets a flat reasoning_effort field.
Switching provider mid-edit clears both the typed model and the cached model list for that draft (clearModels(id)) — the list answered "what does the old provider have", which is not an answer to "what does the new one have", even though the draft's id (and so the cache key) stays the same across the switch.
A request to an LLM API is a POST with Content-Type: application/json and an auth header — which makes it a preflighted cross-origin request, sent from the renderer's origin (file:// in a packaged app). It is the same CORS wall that forced corsEnabled on the slr-file:// protocol (documented under Electron Main Process below): Chromium rejects the request before it ever reaches the network, and the failure surfaces as an opaque TypeError with no detail. So on the desktop the renderer never sends the request itself — ElectronAdapter.callLlm hands it to llm:call, and the main process sends it with net.fetch, where no origin and no CORS check apply.
The second reason is the one the whole layer is built around: the API key never enters the renderer.
-
LlmConfighas noapiKeyfield — onlyhasKey: boolean. A stored key can never be read back, not even by the settings dialog that wrote it (so leaving the key box blank on an edit keeps the stored key; that is the only way to edit a target without retyping it). - The renderer builds the entire request, but can only put
API_KEY_SENTINEL({{apiKey}}) where the key goes.electron/main.tssubstitutes the real key into the headers immediately before sending. - Before it does, it checks the origin:
new URL(request.url).originmust equalnew URL(config.baseUrl).origin, or it refuses. The renderer names the URL, so a compromised renderer must not be able to post the key to a host of its choosing. - Keys are stored in
userData/llm-config.json, encrypted withsafeStorage(mode0600). IfsafeStorage.isEncryptionAvailable()is false the app refuses to save rather than silently writing the key in the clear.
llm:call also takes a requestId and keeps the AbortController in an inFlight map, because an AbortSignal cannot cross IPC — Cancel sends a separate llm:abort message that main matches against the id.
The same channel carries the list-models requests from models.ts: LlmHttpRequest.method ('GET' or 'POST', defaulting to 'POST') tells both electron/main.ts and src/platform/browser.ts whether to send a body at all — a GET carries none, and passing one is a fetch error on some runtimes. The origin check and sentinel substitution apply identically either way.
The browser build cannot make those promises, and says so instead of pretending otherwise (src/platform/browser.ts): the key lives unencrypted in localStorage (slr.llm.configs), the request goes out from the page, so the provider must be willing to answer a cross-origin call (Anthropic needs the explicit anthropic-dangerous-direct-browser-access header, which the adapter adds; a self-hosted OpenAI-compatible endpoint usually sends no CORS headers at all and simply fails), and a cross-origin block is caught and re-thrown with an error that names the likely cause rather than reading as "the provider is down". The settings dialog shows a red notice in that runtime and points at the desktop app.
Two gates, and both are unconditional:
-
parse.tsvalidates every proposal against the schema.resolvePathrejects unknown names, group paths (a group holds no value), non-final segments that have no children, and any index at or beyond a node'smax; then the value must typecheck against itsResolvedDef. It bends only where models misbehave in a way with exactly one honest reading ("2021"→2021,"True"→true, a case-off enum value snapped onto its option). Everything else —"about 20", a value outside the enum, a duplicate answer for the same field — is rejected, never guessed at, and rejections are shown to the reviewer, because a silently dropped answer looks like the model never said anything.parseAnswernever throws: it sits on a network response, where garbage is a normal outcome. -
applyAiSuggestions(src/state/store.ts) is one undo step. It decides what to write before touching anything — a suggestion is dropped if its path no longer resolves, or if the field has been answered since the model was asked, so the reviewer's own work is never overwritten — and if nothing survives, it leaves no empty entry on the undo stack. It then snapshots once and mutates, creating any instances of repeatable nodes the model addressed but that did not exist yet.lastFieldKeyis reset so the reviewer's next keystroke is not coalesced into the AI's step.Ctrl/Cmd+Ztherefore undoes the whole fill in one go. It returns anAiApplyResult(filled/skipped) for the summary the dialog shows.
A field the model filled gets a light-blue border (--ai-mark, .ai-marked in src/styles/index.css) so the reviewer can see at a glance which values are not their own. Clicking into the control — or on its label (NodeName) — clears it: that click is the confirmation. Field and AnnotationNode read the flag through the useAiMark(path, name, index) hook and clear it via confirmAiMark.
Two properties make the marks safe:
-
They are session-only, by construction.
aiMarksis aRecord<string, true>in the store, not a field ofProject, soserializeProjecthas nothing to write even by accident — a saved file is byte-identical to one saved without the feature (pinned bysrc/state/store.aimarks.test.ts). Loading or closing a project clears them. -
They only ever point at real AI values.
applyAiSuggestionsmarks the suggestions it wrote, never the ones it skipped.undo/redoclear all marks: undoing an AI run empties exactly the fields the marks point at, and a blue border on a now-empty field would be a lie. History restores values, not marks.
The key is `${paperId}::${formatPath([...path, { name, index }])}` — paper-scoped because every paper shares the same paths, and canonical (src/llm/paths.ts) so a mark set from a model suggestion and one looked up by the UI meet on the same string. Index 0 stays implicit, which is what keeps Findings[1]/Claim a different field from Findings/Claim.
On a multi-reviewer project, the key also folds in the active reviewer (`${paperId}::${reviewer}::${canonicalPath}`, via aiMarkKey's third argument) — otherwise Reviewer 1 running the AI would leave marks that appear to belong to Reviewer 2's identical field paths. A single-reviewer project's keys are exactly the two-part form above (the reviewer argument defaults to null, which reproduces it), so nothing about single-reviewer behavior changes.
Deliberately the opposite design from AI marks: where a mark is session-only and never reaches the
file, Paper.aiUsage (src/model/project.ts) is a permanent, append-only log — { provider, model, appliedAt } — meant to survive into the saved file so a co-reviewer (or the reviewer
themself, later) can see that, and how, AI was used on a paper.
-
Written by
applyAiSuggestions(src/state/store.ts), inside the sameset()mutation — and therefore the same undo step — as the field writes themselves, only when the run actually filled something (filled > 0). This is a deliberate coupling: undoing the AI fill that produced a disclosure entry undoes the entry with it, consistent with how AI marks are already tied to the data they describe. There is no cheap way to make a field "survive" an undo of the action that created it under this app's whole-project-tree undo/redo (see State management above), so rather than fight that, the entry rides along with the fill it discloses. -
Parsed defensively (
parseAiUsageinproject.ts): the file is hand-editable, so a malformed entry — wrong types, a non-arrayaiUsage, missing fields — is dropped, never thrown over (aiUsage: z.unknown().optional()inschema.tsintentionally does not typecheck the shape at the zod layer, for the same reasonannotationsdoesn't: "loosely typed here, validated/normalized structurally in project.ts"). -
Written only when non-empty (
serializeProject): a paper AI was never used on carries noaiUsagekey at all, so a normal, hand-annotated project's file stays exactly as it always was. -
Array order is the ordering guarantee ("the order of use should be apparent"): entries are
pushed oldest-first, and
appliedAt(an ISO 8601 timestamp) makes that order explicit even if the array is ever hand-edited or reordered.
electron/main.ts is a thin main process:
-
Window:
BrowserWindowdefaulting to 1920×1080, context isolation enabled, node integration disabled, preload script loaded. The taskbar/dock icon is set frombuild/icon.pngvianativeImage(andapp.dock.setIconon macOS so it shows in dev, not just the packaged bundle). -
Window-state persistence: size, position, and maximized state are saved to
window-state.jsoninapp.getPath('userData')and restored on the next launch. Writes are debounced onresize/move/maximize/unmaximize(400 ms) and flushed synchronously onclose; maximized/fullscreen windows store theirgetNormalBounds()so restore returns to the user's chosen size. A saved position is only reused if it still overlaps a connected display (screen.getAllDisplays()), so a disconnected monitor can't strand the window off-screen; otherwise only the size is applied and the window is centered. Absent/corrupt state falls back to the 1920×1080 default. -
Dev vs prod: loads
VITE_DEV_SERVER_URLin dev,dist/index.htmlin production. -
External links:
setWindowOpenHandlersendstarget="_blank"links (external links in PDFs) to the system browser viashell.openExternaland denies the popup;will-navigateprevents any off-app navigation of the window itself. Onlyhttp:/https:/mailto:URLs are passed to the OS. -
slr-file://protocol: registered as privileged (secure, stream, fetch API, CORS-enabled). Handler resolves paths relative toprojectDirwith traversal guard (path.resolve+ prefix check). Returns 403 for traversal attempts, 404 for missing files.corsEnabledis required, not cosmetic: the renderer's origin (dev server, orfile://when packaged) differs fromslr-file://, so loading a PDF is a cross-origin request. Without it Chromium rejects the request beforeprotocol.handleruns, and pdf.js surfaces the opaque failure asUnexpected server response (0). -
IPC handlers:
-
project:open—dialog.showOpenDialog→readFile -
project:openPath— reads a file by absolute path (for re-opening recent projects); returnsnullif the file is missing or unreadable -
project:save—writeFileto given path -
project:saveAs—dialog.showSaveDialog→writeFile -
project:setDir— setsprojectDirfrom the project file's directory -
project:pickSavePath—dialog.showSaveDialogto choose where a project JSON should live; writes nothing (the project editor picks a location before there is a file) -
pdf:pick—dialog.showOpenDialogwithmultiSelectionsto add PDFs; returns absolute paths -
pdf:pickFolder—dialog.showOpenDialogwithproperties: ['openDirectory'], then a recursivereaddirwalk collecting every.pdf(a directory that can't be read is skipped, not fatal); returns absolute paths -
reference:pick—dialog.showOpenDialogfiltered to.bib/.ris/.json; returns{ text, name }forsrc/model/references.tsto parse, or null if cancelled -
pdf:read— raw bytes of a PDF by absolute path, so the editor can read its title/authors. Deliberately not confined to the project directory (unlikeslr-file://): the user may add PDFs from anywhere and picked them through a native dialog. -
paths:relative—path.relative(dirname(fromFile), to)for each target, POSIX-separated. This is what makes a paper'spdfrelative to the JSON, and what re-derives the paths when the JSON moves. -
app:setDirty— the renderer reports its unsaved-changes state (drives the quit dialog) -
app:saveComplete— the renderer reports the result of a save it was asked to run before quitting -
llm:configs/llm:saveConfig/llm:deleteConfig— the LLM targets inuserData/llm-config.json. The renderer is handedpublicConfigs(): everything except the key, plushasKey. -
llm:call/llm:abort— send a renderer-built request withnet.fetchafter substituting the real key and checking the target origin against the config'sbaseUrl(see AI-assisted annotation above).llm:abortaborts an in-flight call by itsrequestId, since anAbortSignalcannot cross IPC.
-
-
Menu: custom template with File, Edit, View, Window menus.
- The Edit menu is hand-built: Undo/Redo send
app:undo/app:redoto the renderer (routing to the store's history) rather than the native text-undo role, so undo works app-wide; cut/copy/paste/selectAll keep their native roles. - The View menu is hand-built (not the default
{ role: 'viewMenu' }) and deliberately omits zoom roles so thatCtrl +/-/0reach the renderer for PDF zoom (andCtrl+Shift +/-/0for app font scaling) instead of triggering native browser/Electron zoom.
- The Edit menu is hand-built: Undo/Redo send
-
Unsaved-changes quit flow: a window
closehandler (promptUnsavedChanges) intercepts the close/quit whenisDirtyis set, and shows a native Save / Don't Save / Cancel dialog. "Save" asks the renderer to save (app:requestSave) and closes once it reports back; "Don't Save" closes discarding changes. Abefore-quitflag lets the guard resumeapp.quit()after confirmation (so Cmd+Q fully quits on macOS, where destroying the window alone would not).
electron/preload.ts uses contextBridge.exposeInMainWorld('slr', ...) to expose IPC-backed methods: openProject, openPath (read file by absolute path), saveProject, saveProjectAs, setProjectDir, plus the quit/menu coordination — setDirty, onRequestSave, saveComplete, onUndo, onRedo. This window.slr object is the detection signal for isElectron().
-
useKeybindings(src/hooks/useKeybindings.ts): Global keyboard shortcuts registered onwindow.keydown. Handles open (Ctrl/Cmd+O), save (Ctrl/Cmd+S), save-as (Ctrl/Cmd+Shift+S), paper navigation (Alt+↓/↑,[/]), zoom/font (Ctrl/Cmd ++/=/-/0→ PDF zoom; add Shift → app font size), and help (F1). Paper navigation skips when typing in a field (unless Alt is held). Zoom/font detection matchese.keyande.codeto handle numpad and international layouts; reset is detected by the digit-0e.code(Shift-independent) to avoid the German Shift+0 →=clash. Copy/cut/paste/undo are left to the browser/Electron Edit menu. -
useDirtyGuard(src/hooks/useDirtyGuard.ts): Browser only. Registers abeforeunloadlistener that callse.preventDefault()when either the project or the editor's draft is dirty, triggering the browser's "unsaved changes" confirmation. Both, for the same reasonuseElectronCloseGuard'sisDirty()checks both: an unsaved schema draft is no less lost on a tab close than an unsaved annotation, and while the editor is open it is the only thing on screen. It is skipped under Electron (isElectron()), because abeforeunloadthat returns a value there silently cancels the quit with no dialog — Electron handles unsaved changes via a native dialog in the main process instead (seeuseElectronCloseGuardand the quit flow below). -
useElectronCloseGuard(src/hooks/useElectronCloseGuard.ts): Electron only. Wires the renderer to the main process for a clean quit and for the Edit menu: it pushes the currentdirtystate to main (slr.setDirty), runs a save when main asks after the user picks "Save" in the native close dialog (slr.onRequestSave→save()→slr.saveComplete(ok)), and routes the Edit-menu Undo/Redo (slr.onUndo/slr.onRedo) to the store'sundo()/redo().
App appearance is controlled by a settings module that persists to localStorage:
-
Theme:
'light' | 'dark'— defaults to OS preference (prefers-color-scheme) on first load.applyTheme()setsdocument.documentElement.dataset.theme. CSS uses:root[data-theme='dark']selectors so the theme is user-controlled, not OS-only. -
Font scale: float from 0.7 to 2.0 (step 0.1).
applyFontScale()sets the--app-font-scaleCSS variable on<html>. The base font size iscalc(14px * var(--app-font-scale))and most text sizes useremunits so they scale proportionally. The PDF paper itself is always rendered on a white background regardless of theme. -
Pane widths: the left (paper list) and right (annotations) pane widths are persisted via
loadPaneWidths()/savePaneWidths()(localStorage, clamped).App.tsxholds them in state, applies them as the workspace grid template, and updates them as theSplitterdrag handles are dragged.
src/main.tsx calls applyTheme(loadTheme()) and applyFontScale(loadFontScale()) before rendering React to avoid a flash of unstyled or wrong-theme content on startup.
-
useKeybindings()anduseDirtyGuard()are called at the top level. - On mount, checks
?project=<url>query parameter — if present, callsloadFromUrl(url)for server-deployment auto-loading. - Renders
Toolbaralways. If a project is loaded, renders the three-pane workspace; otherwise shows a welcome screen with an "Open project…" button and, if there are recent projects, a clickable list of them wired toopenRecent(id). -
ErrorPanelis always rendered (renders null when no error).
vite.config.ts uses base: './' so the built SPA works from both a server subpath and file:// (for Electron). The ELECTRON=1 environment variable conditionally adds the vite-plugin-electron plugin which builds electron/main.ts and electron/preload.ts (preload emitted as .cjs since the package is type: module).
-
Adding a new platform operation: Add it to
PlatformAdapter, implement in bothElectronAdapterandBrowserAdapter, then call from the store or components. -
Adding a new annotation field type: Update
FieldTypeinschema.ts,emptyValue()inannotations.ts, andField.tsxrendering. Consider validation in the zod schema. Also teach the AI layer about it:isUnanswered()insrc/llm/fields.ts,coerce()insrc/llm/parse.ts, and the type rules insrc/llm/prompt.ts. -
Adding a new LLM provider: Add it to
Providerinsrc/llm/types.tsand toPROVIDERSinsrc/llm/providers.ts(base URL, whether it is editable, whether it can take a PDF,tokenParam), then handle its request shape inbuildRequestand its response shape inextractText/extractError. Also add a branch tobuildModelsRequest/parseModelsResponseinsrc/llm/models.ts— its list-models endpoint, auth, and pagination scheme are almost never identical to another provider's chat endpoint even when the chat shape is "OpenAI-compatible" (Mistral's/v1/modelsreturns a bare array, not{data:[...]}; OpenRouter paginates, Groq doesn't). Decide reasoning-effort support last, and only from what you can confirm — a model-ID pattern if the provider's own docs name specific models, or nothing at all (null) if you can't confirm the field/values, per the DeepSeek/openai-compatibleprecedent above. Nothing else needs to change —PROVIDER_LISTdrives the settings dropdown and the "which providers can take a PDF" hint automatically, so the platform and UI layers are provider-agnostic.Verify against the provider's own current docs before writing
buildRequest, not against another provider's shape. The bug that madetokenParama field in the first place: this app originally sentmax_tokensto every OpenAI-shaped provider, and OpenAI's own API now rejects that on current models —"Unsupported parameter: 'max_tokens' is not supported with this model. Use 'max_completion_tokens' instead."xAI and Groq have followed the same rename (both have reasoning-model variants, which is what drove OpenAI's original change); OpenRouter, Mistral, DeepSeek and generic self-hosted OpenAI-compatible servers still documentmax_tokensand do not confirm the newer name. Four vendors that all claim "OpenAI-compatible" disagreed on one required parameter — assume the same is possible for endpoint paths, PDF support, auth header names, list-models shapes, and reasoning-effort contracts, and check each freshly.supportsPdfin particular is not "does the vendor support PDFs at all" but "can a single request carry the bytes inline the way this app'sPaperPartdoes" — Mistral's PDF support needs a fetchable URL (no inline-base64 form in chat completions), and xAI's needs an upload-then-reference flow across two requests, so both arefalsehere despite the vendor supporting PDFs some other way. -
Changing the schema format: it is described to the model in
SCHEMA_FORMAT_DOC(src/llm/prompt.ts), which mirrorsdocs/annotation-schema.md§3 by hand. Both must move together, or the model reads an unfamiliar schema against a stale description. -
Adding a new keyboard shortcut: Add to
useKeybindings.ts. CheckisEditable()if it should be ignored inside input fields. -
Changing the Electron IPC surface: Update
preload.ts(theSlrBridgeinterface),electron/main.ts(IPC handler), andsrc/platform/electron.ts(adapter method). All three must stay in sync. -
Adding a new settings/appearance option: Add to
src/state/settings.ts(load/apply functions), add state + actions to the store, add UI controls toToolbar.tsx, and add keybindings if needed. -
Touching anything that reads or writes the current paper's annotation data: route it through
currentTree()(src/state/store.ts) rather thanpaper.annotationsdirectly, or it will silently ignore reviewer selection on a multi-reviewer project. Grep for.annotationsacrosssrc/and check each hit against "should this see the active reviewer's tree or always the consolidated one". The direct reads that remain outsidesrc/model/are deliberate:currentTree()'s own body;ConsolidationDialog, which reads the consolidated tree on purpose (it is showing you what the final answer currently is);editorStore, which edits the file's papers and has no reviewer concept; and null-project fallbacks.
These pages are a mirror. They are maintained in
openwiki/ in the repository and published
here automatically. Editing a page here is fine — the change is committed back to that folder — but
the folder is the source of truth. See Operations → Wiki sync.
Repository · README · Issues · Releases · Annotation schema guide
SaiLoR is free software under the GNU General Public License v3.0.
- Things to know
- Getting started
- Screening
- Working with several reviewers
- Setting up a project
- Git support
Developer documentation