marcandClaude Opus 5
608da16ac2
Four things that were built for a mouse on a desk and quietly did nothing useful on a phone. The last one is the serious one. **A note made offline lost everything written into it.** Its create reached the server, the server named it something else, and every edit still queued behind it went on addressing the name only that device ever knew — 404, five retries, thrown away. The note arrived empty and untitled, with nothing to say that anything had been lost. The database was repointed at the new id all along; the queue was not. It is now, by replacing the id across the whole queued payload rather than in a list of named fields, because a list of fields is a list to forget to add to. The same held for a notebook made offline and everything filed into it. **The order of notes could not be changed on a phone**, because the list went through the HTML5 drag API, which mobile browsers never fire from touch. Pointer events instead, which mouse, pen and finger all produce. A mouse still drags a row from anywhere; a finger drags from a grip, because pressing the row has to go on scrolling and holding it has to go on opening the menu. The row under the finger is found with elementFromPoint — a finger raises no pointerover on anything it did not press. **"Move to..." opened off the side of the screen**, and could not be opened at all without a hover. It is a tap now, unfolding in place where there is no room beside the menu and flipping sides where there is. The menu itself is placed by measuring rather than by assuming it is 220px wide, its rows are tall enough to hit with a thumb, and Escape closes it. **Installing said nothing when it could not be done.** The entry appeared only when the browser had offered a prompt, so where installing was impossible there was no button and no reason. It is always there now and names the cause — most usefully that a browser will only install a site served over HTTPS, which is also why the service worker would not have registered, so one cause was showing up as two mysteries. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1256 lines
60 KiB
Markdown
1256 lines
60 KiB
Markdown
# ✏️ InkNote
|
||
|
||
A self-hosted note-taking application with rich text editing, freehand drawing, full-text search and encrypted sync — inspired by Samsung Notes.
|
||
|
||
---
|
||
|
||
## Features
|
||
|
||
### Core
|
||
- **Rich Text Notes** — Bold, italic, underline, headings, bullet/numbered lists, task lists, quotes, code blocks
|
||
- **Tables** — Insert, resize columns, add/remove rows and columns, merge cells, toggle header row
|
||
- **Note Links** — Type `@` to link to another note or notebook; every note shows what links back to it
|
||
- **Version History** — Past states of every note, restorable; restoring is itself reversible
|
||
- **Full-Text Search** — Searches note bodies, not just titles, and works offline
|
||
- **Image Attachments** — Pasted images are stored as deduplicated blobs, not inlined into the note
|
||
- **Freehand Drawing** — Pen, highlighter, eraser with adjustable thickness and color palette (20 colors, 7 pen sizes)
|
||
- **Undo/Redo** — Full history stack for drawing operations
|
||
- **Notebooks & Folders** — Covers in colour or pattern — ruled paper, graph paper, stripes, dots, weave — drawn in CSS, no image files
|
||
- **Star/Favorite** — Quick access to important notes
|
||
- **PDF Reading & Annotation** — Import a PDF, read it, select its text, draw on it, pin notes to individual passages, write notes beside it, and export it with or without your marks
|
||
- **Export** — Any note, notebook or the whole account as Markdown or PDF, entirely in the browser
|
||
- **Import** — Markdown files, or a ZIP this app exported, come back as notes with their images
|
||
- **Sorting** — Each notebook remembers how its notes are ordered, including an arrangement made by hand
|
||
- **Dark & Light Mode** — Full theme support with refined color schemes
|
||
|
||
### Sync & Storage
|
||
- **Offline-First** — Works fully offline, syncs when connection returns
|
||
- **Conflict-Aware Sync** — A write from a device that missed another's changes keeps the state it replaces as a version, rather than burying it
|
||
- **WebSocket Real-Time Push** — Changes appear on other devices instantly
|
||
- **Encrypted at Rest** — AES-256-GCM for note content *and* uploaded files on the server
|
||
- **JWT Authentication** — Username + password accounts with bcrypt password hashing. No public
|
||
sign-up: an administrator creates the accounts
|
||
- **Vector Drawings** — Strokes are stored as vectors in one canonical page space, so a drawing looks identical on every screen and stays sharp at any pixel density
|
||
|
||
### Architecture
|
||
- **Self-Hosted Backend** — Node.js + Express + SQLite (or PostgreSQL)
|
||
- **Docker Ready** — docker-compose up and you're running
|
||
- **Client Sync Engine** — Portable JS library for any frontend (React Native, Flutter JS bridge, Electron, web)
|
||
|
||
---
|
||
|
||
## Project Structure
|
||
|
||
```
|
||
inknote/
|
||
├── docker-compose.yml # Deploy from the Gitea registry
|
||
├── docker-compose.dev.yml # Build from source for local work
|
||
├── .env.example # Copy to .env — Compose reads it from here
|
||
├── build.sh # Build & push images to Gitea
|
||
├── CHANGELOG.md # What changed per released image, with digests
|
||
├── CLAUDE.md # Conventions and standing decisions for this repo
|
||
├── backend/
|
||
│ ├── server.js # Express API + WebSocket server
|
||
│ ├── sync-client.js # Client-side sync engine library
|
||
│ ├── package.json # Node dependencies
|
||
│ └── Dockerfile # Server container
|
||
├── frontend/
|
||
│ ├── src/
|
||
│ │ ├── App.jsx # Root: where the user is, which dialog is open
|
||
│ │ ├── types.ts # Shapes shared by server, IndexedDB and UI
|
||
│ │ ├── syncEngine.ts # Offline-first sync + API client
|
||
│ │ ├── offlineStore.ts # IndexedDB wrapper
|
||
│ │ ├── search.ts # Local full-text index
|
||
│ │ ├── hooks/ # Note data, search, layout, history, drag
|
||
│ │ ├── export/ # Markdown, ZIP and print-to-PDF
|
||
│ │ ├── ui/ # Sidebar, dialogs, icons, palette
|
||
│ │ ├── features/notes/ # List, editor pane, version history
|
||
│ │ ├── features/notebooks/ # Dashboard
|
||
│ │ ├── features/drawing/ # Canonical stroke model + render layer
|
||
│ │ └── editor/ # TipTap schema, toolbar, note links, attachments
|
||
│ ├── public/sw.js # PWA service worker
|
||
│ ├── nginx.conf # Static serving + API/WS proxy
|
||
│ └── dockerfile # Web container
|
||
├── e2e/ # Browser suites — run with ./e2e/run.sh
|
||
└── readme.md # This file
|
||
```
|
||
|
||
---
|
||
|
||
## Quick Start
|
||
|
||
### Where the data lives
|
||
|
||
Both compose files use **bind mounts**, not named volumes, so everything sits in
|
||
a plain directory on the Docker host and is picked up by whatever backs that
|
||
host up:
|
||
|
||
```
|
||
$INKNOTE_DATA_DIR/
|
||
├── db/ # inknote.db — notes, drawings, version history
|
||
└── uploads/ # image attachments, legacy raster drawings
|
||
```
|
||
|
||
Default is `./data` for development and `/srv/inknote` in production; override
|
||
with `INKNOTE_DATA_DIR`. It is a default, not an extra path — set it and the
|
||
default location is never touched.
|
||
|
||
**Create the directory before the first start.** Docker will happily create a
|
||
missing bind-mount source itself, but it creates it as `root:root`, and the
|
||
container runs as uid 1000 and then cannot write:
|
||
|
||
```bash
|
||
mkdir -p /srv/inknote/{db,uploads} && chown -R 1000:1000 /srv/inknote
|
||
```
|
||
|
||
The path has to start with `/` or `./`. Anything else Docker reads as the name
|
||
of a named volume, and a name containing a slash fails outright.
|
||
|
||
#### Keeping it under `/root`
|
||
|
||
`/root` is mode `0700`, so uid 1000 cannot pass through it — the server fails to
|
||
write no matter who owns the directory underneath. Two ways out:
|
||
|
||
```bash
|
||
# A) let uid 1000 traverse /root, without making it readable
|
||
mkdir -p /root/inknote/{db,uploads}
|
||
chown -R 1000:1000 /root/inknote
|
||
chmod o+x /root # traverse only — `ls /root` is still refused
|
||
# .env: INKNOTE_DATA_DIR=/root/inknote
|
||
|
||
# B) run the container as root instead — no chown, no chmod, but a break-out
|
||
# lands on root rather than on an unprivileged user
|
||
# .env: INKNOTE_DATA_DIR=/root/inknote
|
||
# INKNOTE_UID=0
|
||
# INKNOTE_GID=0
|
||
```
|
||
|
||
A is the better trade: it keeps the unprivileged container, which is the layer
|
||
that matters if the app is ever exploited. Neither is needed under `/srv` or
|
||
`/opt`, which is why those are the default.
|
||
|
||
> Back up the `.env` holding `ENCRYPTION_KEY` too. Note content is encrypted at
|
||
> rest, so a copy of the database without that key cannot be read.
|
||
|
||
### 1. Local development (Docker)
|
||
|
||
```bash
|
||
# Generate secrets once
|
||
printf 'JWT_SECRET=%s\nENCRYPTION_KEY=%s\n' "$(openssl rand -base64 32)" "$(openssl rand -hex 32)" > .env
|
||
|
||
# Build and run backend + nginx-served frontend
|
||
docker compose -f docker-compose.dev.yml up -d --build # → http://localhost:3000
|
||
|
||
# Same, plus a Vite dev server with hot reload
|
||
docker compose -f docker-compose.dev.yml --profile dev up -d --build # → http://localhost:5173
|
||
```
|
||
|
||
`docker-compose.dev.yml` builds from source and uses its own volumes, so it never
|
||
touches production data.
|
||
|
||
### 2. Docker Deployment
|
||
|
||
```bash
|
||
mkdir -p /srv/inknote/{db,uploads} && chown -R 1000:1000 /srv/inknote
|
||
cp .env.example .env # then fill it in, see below
|
||
docker login gitea.honeyy.duckdns.org
|
||
docker compose pull && docker compose up -d
|
||
docker compose logs inknote-server | head # says which account became admin
|
||
```
|
||
|
||
`.env` needs `JWT_SECRET`, `ENCRYPTION_KEY` and — on a fresh install —
|
||
`INKNOTE_ADMIN_USER` plus `INKNOTE_ADMIN_PASSWORD`, since there is no sign-up to
|
||
create the first account with. On an install that already has accounts,
|
||
`INKNOTE_ADMIN_USER` alone decides which of them is promoted; without it the
|
||
oldest one is, which is rarely the one you meant.
|
||
|
||
The web UI listens on port `3000`, the API only inside the compose network. If a
|
||
reverse proxy sits in front, bind the port to localhost (`"127.0.0.1:3000:80"`),
|
||
otherwise the app is reachable on the host's address without TLS.
|
||
|
||
---
|
||
|
||
## API Reference
|
||
|
||
### Authentication
|
||
|
||
| Method | Endpoint | Body | Response |
|
||
|--------|-----------------------|-------------------------------|---------------------|
|
||
| POST | `/api/auth/login` | `{username, password}` | `{token, user}` |
|
||
| GET | `/api/auth/me` | — | `{id, username, displayName, isAdmin}` |
|
||
| PUT | `/api/auth/username` | `{newUsername, password}` | updated user |
|
||
| PUT | `/api/auth/password` | `{currentPassword, newPassword}` | `{success}` |
|
||
|
||
**There is no registration endpoint.** This is a private instance: accounts are created by an
|
||
administrator, and nothing on the login screen suggests otherwise.
|
||
|
||
Usernames are 3–32 characters of letters, digits, `.`, `_` or `-`, and match case-insensitively.
|
||
Servers created before this carried e-mail logins; on first start they migrate automatically,
|
||
deriving each username from the local part of the address (logged to the console).
|
||
|
||
### Administration
|
||
|
||
| Method | Endpoint | Body | Response |
|
||
|--------|-----------------------------------|-----------------------------|----------|
|
||
| GET | `/api/admin/users` | — | user list with note counts |
|
||
| POST | `/api/admin/users` | `{username, password, displayName}` | created user |
|
||
| PUT | `/api/admin/users/:id/password` | `{newPassword}` | `{success}` |
|
||
| DELETE | `/api/admin/users/:id` | — | `{success}` |
|
||
|
||
All four require an account flagged `is_admin`; the server checks this itself, so hiding the menu
|
||
entry is presentation, not access control. An admin may not delete their own account.
|
||
|
||
**Where the first admin comes from.** `INKNOTE_ADMIN_USER` and `INKNOTE_ADMIN_PASSWORD` in `.env`:
|
||
|
||
| Database state | What happens at start |
|
||
| --- | --- |
|
||
| no users at all | the account is created from both values |
|
||
| users, but no admin | `INKNOTE_ADMIN_USER` picks which one is promoted; without it, the oldest |
|
||
| an admin exists | both are ignored |
|
||
|
||
So the variables can never reset an existing password or take rights away — on a running
|
||
instance the worst they can do is nothing. Set `INKNOTE_ADMIN_USER` *before* upgrading an older
|
||
installation if the oldest account is not the one that should hold the keys.
|
||
|
||
Deleting an account destroys its notes, notebooks, drawings and version history through
|
||
`ON DELETE CASCADE`; the files behind attachments are collected by the hourly orphan sweep. The
|
||
deleted person's session stops working immediately: tokens are signed rather than stored, so
|
||
`authMiddleware` checks on every request that the account still exists.
|
||
|
||
### Notebooks
|
||
|
||
| Method | Endpoint | Description |
|
||
|--------|-----------------------|--------------------------|
|
||
| GET | `/api/notebooks` | List all notebooks |
|
||
| POST | `/api/notebooks` | Create notebook |
|
||
| PUT | `/api/notebooks/:id` | Update notebook |
|
||
| DELETE | `/api/notebooks/:id` | Soft-delete notebook |
|
||
|
||
### Notes
|
||
|
||
| Method | Endpoint | Description |
|
||
|--------|---------------------------|-------------------------------|
|
||
| GET | `/api/notes` | List all notes (metadata) |
|
||
| GET | `/api/notes/:id` | Get note with decrypted content |
|
||
| POST | `/api/notes` | Create note |
|
||
| PUT | `/api/notes/:id` | Update note (`{content, links}`) |
|
||
| GET | `/api/notes/:id/backlinks`| Notes linking to this one |
|
||
| GET | `/api/links` | Every link, for backlink counts |
|
||
| DELETE | `/api/notes/:id` | Soft-delete note |
|
||
| PUT | `/api/notes/:id/drawing` | Save vector strokes |
|
||
|
||
### Sync
|
||
|
||
| Method | Endpoint | Description |
|
||
|--------|------------- |------------------------------------------|
|
||
|
||
### WebSocket
|
||
|
||
Connect to `ws://localhost:4000/ws`, then send:
|
||
```json
|
||
{"type": "auth", "token": "JWT_TOKEN", "deviceId": "device-123"}
|
||
```
|
||
|
||
Receive real-time events: `note_created`, `note_updated`, `note_deleted`, `notebook_created`, etc.
|
||
|
||
---
|
||
|
||
## Sync Engine (Client)
|
||
|
||
```javascript
|
||
import { SyncEngine } from './sync-client';
|
||
|
||
const sync = new SyncEngine('https://your-server.com', 'device-abc');
|
||
|
||
// Authenticate
|
||
await sync.authenticate('username', 'password');
|
||
|
||
// Listen for events
|
||
sync.on('status', (status) => console.log('Sync:', status));
|
||
sync.on('conflict', (conflict) => {
|
||
// Present both versions to user, let them choose
|
||
console.log('Conflict:', conflict);
|
||
});
|
||
sync.on('remote_change', (change) => {
|
||
// Update local state with remote changes
|
||
console.log('Remote change:', change);
|
||
});
|
||
|
||
// Start syncing (every 30s + WebSocket push)
|
||
sync.start();
|
||
|
||
// CRUD operations auto-queue for sync
|
||
await sync.createNote({ type: 'text', title: 'Hello', content: '<p>World</p>' });
|
||
await sync.updateNote('note-id', { title: 'Updated' });
|
||
await sync.deleteNote('note-id');
|
||
await sync.uploadPDF(fileBlob);
|
||
await sync.saveDrawing('note-id', strokeDoc);
|
||
```
|
||
|
||
---
|
||
|
||
## Working on the frontend
|
||
|
||
```bash
|
||
npm run test # Vitest — store, search and content migration
|
||
npm run typecheck # tsc --noEmit
|
||
npm run format # Prettier
|
||
npm run build # production bundle
|
||
```
|
||
|
||
TypeScript is enabled with `allowJs`, so `.js` and `.ts` coexist and modules can
|
||
be converted one at a time. The whole data layer is typed — `types`,
|
||
`offlineStore`, `search`, `editor/content` and `syncEngine` — because that is
|
||
where the bugs have been: every serious one so far has been a shape bug, or a
|
||
failure distinguished by comparing an error's `.message` to a magic string.
|
||
Failures now carry a typed `SyncError.code`; `.message` still holds the same
|
||
string, so the remaining JavaScript callers are unaffected.
|
||
|
||
The 218 unit tests concentrate on the same places, and several exist because the
|
||
bug they cover actually happened:
|
||
|
||
- a queue entry that fails must stay queued, with an attempt counter
|
||
- `fullSync` must not drop notes created offline
|
||
- `hasPendingWrites` must cover the debounce window, not just requests in flight
|
||
- v1 note bodies must migrate without losing task state or smuggling in markup
|
||
|
||
### Reordering, and menus, with a finger
|
||
|
||
Both were built for a mouse and quietly did nothing on a phone.
|
||
|
||
**Dragging** went through the HTML5 drag-and-drop API, which mobile browsers
|
||
never fire from touch — so the arrangement could not be changed at all, with
|
||
nothing on screen to say why. [`useReorderDrag`](frontend/src/hooks/useReorderDrag.ts)
|
||
uses pointer events instead, which mouse, pen and finger all produce. The two
|
||
devices get different starts, because they want different things:
|
||
|
||
- **A mouse** begins a drag by pressing anywhere on a row and moving a few pixels.
|
||
- **A finger** begins one only from the grip. Pressing the row has to go on
|
||
scrolling the list, and holding it has to go on opening the menu; a drag that
|
||
started from anywhere would take both.
|
||
|
||
The row under the finger is found with `elementFromPoint`, not with enter/leave
|
||
handlers — a finger generates no `pointerover` on anything it did not press.
|
||
|
||
**The context menu** was placed with `innerWidth - 220`, a stand-in for a width
|
||
nobody had measured, and its submenu was pinned to `left: 100%` and opened only
|
||
on hover. On a phone the parent already sits against the right edge, so the list
|
||
of notebooks under *Move to…* appeared past the edge of the display — and with no
|
||
hover, there was no way to open it in the first place. It is now placed by
|
||
measuring, opens on a tap, unfolds in place on a narrow screen, and flips to the
|
||
other side on a wide one when the right would not fit.
|
||
|
||
### Installing it
|
||
|
||
The install entry used to appear only when the browser had offered a prompt
|
||
(`beforeinstallprompt`). Where installing was impossible there was nothing on
|
||
screen at all — no button, no reason, and no way to find out short of knowing how
|
||
PWAs work.
|
||
|
||
It is always there now, and when there is no prompt it says which of the fixable
|
||
causes applies. The common one is worth naming: **a browser will only install a
|
||
site served over HTTPS**, and on plain HTTP the service worker never registers
|
||
either — so one cause takes the install *and* offline with it, which otherwise
|
||
looks like two unrelated mysteries.
|
||
|
||
### Notebook covers
|
||
|
||
A cover is stored as an **index** into `COVERS` in
|
||
[`ui/constants.jsx`](frontend/src/ui/constants.jsx). Entries are therefore only
|
||
ever appended, never reordered: renumbering them would silently repaint every
|
||
notebook anyone already has.
|
||
|
||
The patterned ones are drawn entirely with CSS gradient layers — no image files,
|
||
nothing to upload, nothing to fetch. They stay crisp at any size and work offline
|
||
like the rest of the app. `background` takes a stack of layers, topmost first, so
|
||
each is a pattern laid over the colour beneath it.
|
||
|
||
They are deliberately faint: a cover is read at the size of a thumb with a title
|
||
across it, and anything louder fights the title. One idea per cover, too — two
|
||
crossed diagonals meant as a chevron came out as noisy plaid at that size and
|
||
were replaced with plain bands.
|
||
|
||
The grid scrolls. Without that the dialog runs past the bottom of a laptop screen
|
||
and takes the *Create* button with it, which a test now checks at 1440×800.
|
||
|
||
### Browser suites
|
||
|
||
The unit tests cover the data layer; these drive a real browser against a real
|
||
server, because the failures that hurt most in this app were never visible in a
|
||
unit test — a stale response overwriting fresh strokes, a note link surviving in
|
||
memory but not through a reload.
|
||
|
||
```bash
|
||
docker compose -f docker-compose.dev.yml up -d --build # must be running
|
||
./e2e/run.sh # all suites
|
||
./e2e/run.sh editor drawing # only these
|
||
```
|
||
|
||
| Suite | Checks | What it holds down |
|
||
| --- | --- | --- |
|
||
| `admin` | 15 | no sign-up anywhere; `/api/admin/*` refused for non-admins even when called directly |
|
||
| `editor` | 36 | tables and their right-click menu, task lists, note links, backlinks — and that each survives a reload |
|
||
| `search-attachments` | 12 | body-only matches, ranking, umlauts; images as blob URLs, not inline bytes |
|
||
| `history` | 10 | a large deletion is snapshotted, restoring works, restoring is itself undoable |
|
||
| `drawing` | 18 | strokes survive the poller, match across four viewport widths, and stay on the page they were drawn on |
|
||
| `pdf` | 91 | import, page proportions, lazy loading, and reading with the network off |
|
||
| `attachments-lifecycle` | 10 | a picture is kept while any version shows it, and freed once none does |
|
||
| `conflict` | 10 | a late write wins but the state it buries survives as a version |
|
||
| `export` | 21 | the downloaded bytes are real Markdown, ZIP and PNG, unpacked and read back |
|
||
| `organise` | 50 | a hand-made order survives a search; separators hold their place; a note exported and imported comes back whole |
|
||
| `offline` | 17 | a cold page load with the network off still opens notes and searches them — and a note made, written and drawn on offline arrives whole once there is a connection |
|
||
| `sync` | 7 | a PDF written on one device — document, drawing and pinned notes — reaches a second one, which can find it by its contents without opening it |
|
||
|
||
Each suite creates a throwaway account through the admin API and deletes it
|
||
afterwards, so runs leave the database as they found it. They need an admin to
|
||
do that with — `marc`/`geheim123` by default, override with `INKNOTE_ADMIN` and
|
||
`INKNOTE_ADMIN_PASS`.
|
||
|
||
Screenshots land in `e2e/shots/`, which is worth a look when a check fails.
|
||
|
||
### How the frontend is arranged
|
||
|
||
`App.jsx` holds only *where the user is* — the open notebook, the open note, the
|
||
search box, whichever dialog is up — and hands each of the three panes what it
|
||
needs. Everything else lives behind a hook:
|
||
|
||
| Hook | Owns |
|
||
| --- | --- |
|
||
| `useNoteData` | notes, notebooks, bodies, every mutation, background sync |
|
||
| `useSearchIndex` | the local index and the background backfill that fills it |
|
||
| `useResponsive` | phone vs desktop, sidebar and which pane a phone shows |
|
||
| `useNavigationHistory` | mapping the current location onto browser history |
|
||
| `useNotebookDnd` | drag-to-reorder, shared by the sidebar, the dashboard and the note list |
|
||
| `usePwaInstall` | the browser's install offer |
|
||
|
||
`useNoteData` deliberately has no confirmation prompts in it: whether to ask
|
||
before deleting something is a question for the interface, not the store. The
|
||
panes (`Sidebar`, `Dashboard`, `NoteList`, `EditorPane`) take props and hold no
|
||
state of their own, so they can be read on their own.
|
||
|
||
---
|
||
|
||
## Setting a note
|
||
|
||
**A centred column, about 80 characters to the line** — measured, not guessed.
|
||
Past roughly 84 the eye stops reliably finding the start of the next line, so the
|
||
column is capped a little short of that. It leaves roughly 8% of the sheet as
|
||
margin down either side: a document's margin, not a picture frame. At 73
|
||
characters it left 117px of empty paper down each edge and the writing looked
|
||
lost on the page.
|
||
|
||
It was pinned to the left margin for a while, on the reasoning that a column
|
||
which floats in the middle moves as the window is resized. True, but it traded
|
||
that for something worse: on a wide window the entire right half of the pane
|
||
became one dead block. A page surface was then drawn behind the text to give that
|
||
block a meaning, which only moved the problem — the whole sheet sat hard against
|
||
the left edge. Centred, the same leftover space reads as two margins and needs no
|
||
explaining.
|
||
|
||
**The typeface is a per-account setting** (Account → Profile): serif, sans or
|
||
mono. On the account rather than in the browser, because a choice about how your
|
||
own notes are set should follow you to the phone rather than be made again on
|
||
every device. The server accepts those three values and drops anything else —
|
||
that column is written by a browser, so it is an input like any other.
|
||
|
||
**You write on paper.** Each page is a sheet of its own, centred, with a gap
|
||
after it — the same way the PDF reader draws its pages, because a page in a note
|
||
and a page in a document should read as the same kind of thing. It also answers
|
||
what a bare column of text could not: the space either side of the writing is the
|
||
sheet's margin, rather than an unexplained void.
|
||
|
||
The sheet used to appear only once you started drawing, which made the writing
|
||
mode look like text floating in an empty pane.
|
||
|
||
**Pages are counted, not stored.** The toolbar says *Page 2 of 4* in the same
|
||
words the PDF reader uses. A page is the same 3:4 the canvas uses, so "page 2"
|
||
means the same thing writing or drawing. The note itself stays one continuous
|
||
document — Markdown has no page, and a test asserts none ever reaches the stored
|
||
body. The current page is the one under the *middle* of the window: measuring
|
||
from the top said "page 1" while you stood at the foot of a two-page note,
|
||
because a window is shorter than a page.
|
||
|
||
### Holding the gap open
|
||
|
||
The browser knows nothing about the sheets. Left alone it lays the text out as
|
||
one continuous flow and puts a line straight across the gap, cut in half by it.
|
||
|
||
So [`editor/pagination.js`](frontend/src/editor/pagination.js) measures the flow
|
||
and pushes any block that would straddle a gap onto the next page, by inserting a
|
||
spacer of exactly the right height in front of it. The spacers are **decorations,
|
||
not content**: they never enter the document, never reach the server and never
|
||
appear in an export. Two tests hold that down — one asks whether any block sits
|
||
in a gap, the other reads the stored body back and looks for them.
|
||
|
||
The unit is a whole block. A paragraph that would be split moves down entire,
|
||
which is what a page break means on paper. A single block taller than a page — a
|
||
long table, a tall image — is left where it is and runs over the gap: splitting
|
||
one would mean laying out its insides ourselves.
|
||
|
||
Two details that are easy to get wrong and were:
|
||
|
||
- **The spacer's height is not the distance the text moves.** Margins that used
|
||
to collapse into each other no longer do once something sits between them, so
|
||
the layout gains `min(marginBottom, marginTop)` for free and the spacer is made
|
||
exactly that much shorter. The spacer carries the intended shift in a data
|
||
attribute, because the next measurement has to subtract it again to recover
|
||
where the text would sit with no spacers at all.
|
||
- **Heights change without a transaction to announce it** — a webfont finishing
|
||
loading, an image arriving, the window resizing. A `ResizeObserver` on the
|
||
editor element catches all three.
|
||
|
||
Each page can be drawn on — see [One drawing, as many pages as the
|
||
note](#one-drawing-as-many-pages-as-the-note).
|
||
|
||
### Alignment
|
||
|
||
Markdown is often said to "basically be HTML". It is not — it allows *embedded*
|
||
HTML, and has no alignment of its own. So alignment works fully in the app, in
|
||
print and in the PDF, and in a `.md` file it can only travel as a tag:
|
||
|
||
- Non-left blocks are wrapped in `<div align="…">`, the one form GitHub and most
|
||
other readers still honour. A reader that does not know it shows the text,
|
||
which is the right way to fail.
|
||
- Left is never written. It is the default, and wrapping every paragraph in a div
|
||
would turn an ordinary note into markup for nothing.
|
||
- The importer reads the wrapper back and puts the alignment **on the
|
||
paragraphs**, which is where the editor keeps it — not on a container.
|
||
|
||
## Interface language
|
||
|
||
English throughout. It had drifted into two languages — the frame in English,
|
||
everything added later in German — which is worse than either: the same idea
|
||
appeared under two names depending on when that part was written.
|
||
|
||
The one place German is deliberately kept is sorting by title, which compares
|
||
with the German collation so that *Übung 2* comes before *Übung 10* and umlauts
|
||
sort where a German reader expects. That is about the notes, not the chrome.
|
||
|
||
Two archive folders were renamed with the interface (`bilder/` → `images/`,
|
||
`zeichnungen/` → `drawings/`). **The importer still reads both**, along with the
|
||
old German marker line for a drawing — archives exported before the change are
|
||
on people's disks, and an import that quietly dropped their drawings would be the
|
||
worst kind of tidy-up.
|
||
|
||
---
|
||
|
||
## Note Content
|
||
|
||
The body of a note is a **TipTap/ProseMirror document** stored as JSON:
|
||
|
||
```json
|
||
{ "v": 2, "doc": { "type": "doc", "content": [ … ] } }
|
||
```
|
||
|
||
Tables, task lists and note links are real nodes rather than HTML that happened
|
||
to survive `document.execCommand`. Notes written before this were
|
||
`{ html, tasks }`; they are converted to a document the first time they are
|
||
opened and rewritten in the new format on the next save, so nothing needs
|
||
migrating up front.
|
||
|
||
### Note links and backlinks
|
||
|
||
Typing `@` opens a search over notes and notebooks and inserts a `noteLink`
|
||
node holding the target's id — so a link survives the target being renamed, and
|
||
the label is refreshed from the current title whenever the note is opened.
|
||
|
||
The server cannot read encrypted note bodies, so it cannot discover links
|
||
itself. The client sends the ids it references alongside the content, and the
|
||
server maintains a `note_links` index from them. That index is what powers
|
||
`GET /api/notes/:id/backlinks` and the "Linked from N notes" bar under the
|
||
editor.
|
||
|
||
---
|
||
|
||
## Full-Text Search
|
||
|
||
Search runs entirely on the client. The server stores note bodies encrypted and
|
||
deliberately keeps no plaintext index, so it cannot search them — and a
|
||
server-side index would undo the point of encrypting at rest.
|
||
|
||
Bodies are normally fetched only when a note is opened, which would leave a
|
||
fresh device with nothing to search. After login a background pass backfills the
|
||
missing ones into IndexedDB, slowly enough to stay out of the way, indexing each
|
||
as it lands. Searching therefore also works offline.
|
||
|
||
The box sits above the note list, always, with nothing to open first. It was
|
||
behind a magnifying glass, which cost a click and having to remember that
|
||
searching was possible at all; a search box is one line and says for itself what
|
||
it does.
|
||
|
||
PDFs come after the notes in that pass. Their text is not derived from a note
|
||
body but stored with the file, by the device that imported it — see [The reading
|
||
happens on a device, never on the
|
||
server](#the-reading-happens-on-a-device-never-on-the-server).
|
||
|
||
Matching is AND across terms, case- and diacritic-insensitive (`kuhlschrank`
|
||
finds *Kühlschrank*), with title matches ranked above body matches. Results show
|
||
a snippet around the first match.
|
||
|
||
> Bodies of notes edited on another device are refreshed when that note is
|
||
> opened, so search results for untouched notes can lag behind until then.
|
||
|
||
---
|
||
|
||
## Reading PDFs
|
||
|
||
An imported PDF becomes a note of type `pdf` and is shown by a viewer instead of
|
||
the text editor. Pages are laid out at their true proportions before anything is
|
||
drawn, so the scrollbar is honest from the first frame; a document mixing
|
||
portrait and landscape keeps both, rather than stretching the narrow pages.
|
||
|
||
Only pages near the viewport are rendered, and each keeps its own canvas — a PDF
|
||
page is expensive to draw and cheap to hold, so scrolling back up repaints
|
||
nothing. Canvases are sized in device pixels and scaled down by CSS, which is
|
||
what keeps text sharp on a high-density screen.
|
||
|
||
**pdf.js is not in the main bundle.** It is larger than the rest of the
|
||
application put together, so it sits behind a dynamic import: a session that
|
||
never opens a PDF never downloads it. The worker is bundled too, not fetched
|
||
from a CDN — a viewer that stops working during someone else's outage is not one
|
||
you can rely on offline.
|
||
|
||
The **legacy** pdf.js build is used deliberately. Version 6 calls
|
||
`Uint8Array.prototype.toHex`, which only very recent browsers have; anything
|
||
older fails to parse the document with a message that says nothing about why.
|
||
|
||
Bytes are read through the authenticated attachment route and cached in
|
||
IndexedDB, so a document opened once stays readable with no connection. Because
|
||
storage is content-addressed, a cached copy can never go stale.
|
||
|
||
> nginx needs a MIME type for `.mjs` — without one it serves the worker as
|
||
> `application/octet-stream` and the browser refuses to run it as a module.
|
||
|
||
---
|
||
|
||
## Exporting an annotated PDF
|
||
|
||
A PDF note offers three things rather than the note formats: the document with
|
||
your drawings written into it, the untouched original, or just the notes you
|
||
wrote beside it as Markdown.
|
||
|
||
pdf.js can only read, so producing a file needs a second library — `pdf-lib`,
|
||
loaded the same way, behind a dynamic import, so the bundle everyone downloads
|
||
carries no PDF writer for the sake of the people who never export one.
|
||
|
||
This is where the coordinate decision pays off. Strokes were stored in page
|
||
points from the start, which is the only space a PDF understands: nothing has to
|
||
be guessed back from screen pixels, and the stamping is a direct translation
|
||
apart from flipping the origin, which PDF puts at the bottom-left.
|
||
|
||
**The stored file is never modified.** `pdf-lib` builds a new document, so a
|
||
clean copy of the original stays available however often it has been drawn on —
|
||
checked by the suite, which re-fetches the stored bytes after exporting and
|
||
compares them.
|
||
|
||
Erased areas cannot come along. On screen an eraser removes ink by drawing in
|
||
`destination-out`; a PDF content stream has no equivalent, so those strokes are
|
||
dropped rather than stamped as visible grey scribbles where something was rubbed
|
||
out.
|
||
|
||
The suite renders both files and counts dark pixels — 1633 against 2557 — because
|
||
a larger file proves bytes were added, not that any ink can be seen.
|
||
|
||
---
|
||
|
||
## Notes beside a PDF
|
||
|
||
A PDF note is a note that happens to have a document attached, not a separate
|
||
kind of thing: what you write beside it goes into the note's ordinary `content`,
|
||
so it is encrypted, versioned, linkable and searchable like any other note.
|
||
|
||
The panel is composed from the editor pieces directly rather than reusing
|
||
`NoteEditor`, which carries a whole drawing mode with its own canvas and undo
|
||
stack — the PDF has its own drawing layer, and a second one hidden behind the
|
||
panel would be two places to draw with one of them invisible.
|
||
|
||
Side by side on a wide screen, two tabs on a narrow one. Both halves can be
|
||
hidden: reading the original without one's own marks in the way is a normal
|
||
thing to want, and so is writing without the document taking two thirds of the
|
||
screen.
|
||
|
||
**One trap this uncovered.** A PDF note has two sources of searchable text —
|
||
what the reader typed and what the document says — written at different moments
|
||
by different code. Both called `setEntry`, so whichever ran last was the only
|
||
half you could search: typing a note dropped the document's text, and re-reading
|
||
the document dropped the note. The index now keeps them apart and only replaces
|
||
the half it was given.
|
||
|
||
---
|
||
|
||
## Selecting and searching PDF text
|
||
|
||
pdf.js draws pages as pictures, so selecting means laying transparent spans over
|
||
them exactly where each word was painted. The layer carries the same scale as the
|
||
canvas — the two drift apart otherwise and a selection lands on the wrong words.
|
||
While drawing it stops taking pointer events entirely, or a stroke would come out
|
||
as a text selection.
|
||
|
||
The text is also pulled out and handed to the same index that holds the notes, so
|
||
one search box finds a sentence whether it was typed or imported. Extraction runs
|
||
*after* the document is on screen and yields between pages: it must never stand
|
||
between the reader and the first page.
|
||
|
||
### The reading happens on a device, never on the server
|
||
|
||
The server has no PDF library and no way to open one: the bytes arrive encrypted
|
||
and are stored that way. **The device that imports the file reads it**, at import
|
||
rather than at first open, and the result is stored beside the file in
|
||
`attachments.text_index` — encrypted at rest like everything else, and opaque to
|
||
the server.
|
||
|
||
That is what lets a device search a document it has never opened. It is the
|
||
precondition for filing scanned invoices: they are imported, and then never
|
||
opened again, so waiting for someone to open one would mean waiting forever.
|
||
|
||
```
|
||
PUT /api/attachments/:id/text { "pages": ["page one text", "page two text"] }
|
||
GET /api/attachments/:id/text → { "pages": [...] } or { "pages": null }
|
||
```
|
||
|
||
`null` is not an error — it means nobody has read this file yet, and whichever
|
||
device holds the bytes should. After login the search backfill asks for the text
|
||
of every PDF the account holds, after the note bodies, and skips the ones nobody
|
||
has read: downloading every document just to index it is not a thing to do in the
|
||
background.
|
||
|
||
This was deliberately *not* stored for a while, on the reasoning that text
|
||
derivable from bytes the server already has should not be kept twice. True, and
|
||
useless: a PDF imported on the desktop was invisible to a search on the phone
|
||
until the phone had opened it. A few hundred kilobytes of text against a file
|
||
measured in megabytes is a trade worth making.
|
||
|
||
The minimal text-layer CSS is written out in `textLayer.css` rather than
|
||
importing `pdfjs-dist/web/pdf_viewer.css`, which carries the whole reference
|
||
viewer's toolbars and dialogs.
|
||
|
||
---
|
||
|
||
## Drawing on a PDF
|
||
|
||
Strokes are stored **per page, in that page's own coordinate space** — PDF
|
||
points at scale 1, exactly what pdf.js reports — rather than in the fixed
|
||
1200×1600 space a note's drawing uses. A PDF cannot use one space: every page
|
||
has its own size, and a stroke belongs to the page it was drawn on.
|
||
|
||
That choice is what keeps a mark on the word it was drawn over at any zoom, on
|
||
any screen, and it is the only form that can be stamped back into the file later,
|
||
where page points are the only coordinates that mean anything. The suite measures
|
||
it: zooming in moves a stroke by 0.001 of the page.
|
||
|
||
```jsonc
|
||
{ "v": 2, "pages": { "1": { "w": 595, "h": 842, "strokes": [...] } } }
|
||
```
|
||
|
||
Only pages that carry ink get an entry. Pen sizes are scaled from the note page
|
||
width, or the same number would draw twice as thick on an A4 page half as wide.
|
||
|
||
Reading and drawing are separate modes. While reading, the ink layer takes no
|
||
pointer events at all, so scrolling and selecting text reach the page beneath;
|
||
while drawing, a finger still scrolls and only a pen or mouse leaves a mark. The
|
||
drawing can be hidden without being erased, for reading the original clean.
|
||
|
||
---
|
||
|
||
## PDF storage
|
||
|
||
An imported PDF is stored as an attachment: encrypted, named by the hash of its
|
||
contents, and shared by any note holding the same file. The note points at it
|
||
through `notes.pdf_attachment_id`.
|
||
|
||
It goes up as a raw body rather than the base64 JSON images use — a scanned book
|
||
runs to tens of megabytes and base64 would add a third to that for nothing. The
|
||
bytes are checked for the `%PDF-` signature before anything is stored, so the
|
||
declared content type is never taken on trust.
|
||
|
||
Images and PDFs are limited separately, because a 25 MB picture is nearly always
|
||
a mistake while a 25 MB document is not: `INKNOTE_MAX_IMAGE_MB` (25) and
|
||
`INKNOTE_MAX_PDF_MB` (200). The limits are there so a runaway upload cannot fill
|
||
the disk, not to ration anything.
|
||
|
||
> An earlier `POST /api/notes/pdf` stored a *filesystem path* in the note, which
|
||
> is why it never survived a container rebuild. That route is gone.
|
||
|
||
---
|
||
|
||
## Encryption at rest
|
||
|
||
Note bodies and uploaded files are both encrypted with AES-256-GCM under
|
||
`ENCRYPTION_KEY`. Losing that key loses the notes — back it up with the database,
|
||
not next to it.
|
||
|
||
Files carry an 8-byte `INKENC01` header, so a file says for itself whether it is
|
||
encrypted. That is what lets the startup sweep run on every boot and encrypt only
|
||
what is still in the clear: files are shared between users by content hash, so a
|
||
flag on a database row could not have answered the question.
|
||
|
||
Two consequences worth knowing:
|
||
|
||
- **Deduplication still works.** Files are named by the hash of the *plaintext*,
|
||
so two identical uploads share one copy — encrypting each with a fresh IV would
|
||
otherwise produce two different files from the same picture.
|
||
- **Reads are not streamed.** GCM only proves a file is intact once the final
|
||
block is in, so an attachment is read whole and verified before anything is
|
||
sent. Half of a corrupt image is worse than an error.
|
||
|
||
Uploads are written to a temporary name and renamed into place. A rename is
|
||
atomic on one filesystem, so a crash mid-write leaves the old file or the new
|
||
one, never a half-written one that would fail its tag forever after.
|
||
|
||
---
|
||
|
||
## Freeing attachments
|
||
|
||
Take a picture out of a note and the file cannot simply be deleted: the versions
|
||
from before still show it, and restoring one would find a hole where the image
|
||
was. So an attachment is released only once **no current note and no kept
|
||
version** refers to it — which, with retention by count, is the moment the last
|
||
version holding it is pushed out by newer ones.
|
||
|
||
The server cannot look for itself: bodies are encrypted. So the client reports
|
||
which attachments a note uses on every save, exactly as it already does for note
|
||
links, and a version inherits whatever the note held at the moment it was
|
||
snapshotted — which is by definition what that version contains.
|
||
|
||
Two things make this safe rather than merely plausible:
|
||
|
||
- **Silence is not "uses nothing".** A note written before references existed has
|
||
no rows, which looks identical to a note with no pictures. Nothing is released
|
||
for a user while any of their notes has yet to report; the background prefetch
|
||
that fills the search index reports for them on its first pass.
|
||
- **An upload in flight has a row before the note that uses it does.** Attachments
|
||
younger than the grace period are left alone.
|
||
|
||
`POST /api/admin/housekeeping` runs the sweep on demand instead of waiting for
|
||
its timer — admin only, and it accepts `graceSeconds` to shorten that wait.
|
||
|
||
---
|
||
|
||
## Attachments
|
||
|
||
Images used to be inlined into the note body as base64 data URIs — a few
|
||
screenshots turned one note into megabytes that were re-encrypted and re-uploaded
|
||
on every keystroke. They are now separate blobs; the body only keeps an id.
|
||
|
||
- Stored on disk under the SHA-256 of their bytes, so the same image pasted into
|
||
ten notes is kept once
|
||
- Uploads are type-checked against the actual bytes, not the declared MIME type
|
||
- Downloads require the owner's token, so `<img>` cannot fetch them directly —
|
||
the client fetches with its token, caches the blob in IndexedDB and renders a
|
||
blob URL, which also makes images work offline
|
||
- Files with no database row are swept up daily, one hour after last write
|
||
|
||
| Method | Endpoint | Description |
|
||
|--------|-------------------------|------------------------------------|
|
||
| POST | `/api/attachments/pdf` | raw PDF body, `?filename=` | `{id, mime, size, deduplicated}` |
|
||
| POST | `/api/attachments` | Upload a base64 data URL |
|
||
| GET | `/api/attachments/:id` | Fetch the bytes (owner only) |
|
||
|
||
> Removing an image from a note does not yet delete its blob: the body is
|
||
> encrypted, so the server cannot tell what is still referenced. Unused blobs
|
||
> cost disk space, nothing else.
|
||
|
||
---
|
||
|
||
## Version History
|
||
|
||
Every write snapshots the state it is about to replace into `note_versions`,
|
||
encrypted the same way the note itself is.
|
||
|
||
Saves arrive about once a second while typing, so snapshots **coalesce**: within
|
||
a 5-minute window the existing newest version already represents "before this
|
||
editing session". Two cases bypass the window, because they are exactly the ones
|
||
worth undoing:
|
||
|
||
- a write that shrinks a note to under half its size (`large-deletion`)
|
||
- clearing a drawing (`drawing-cleared`)
|
||
|
||
Restoring snapshots the current state first (`before-restore`), so picking the
|
||
wrong version is not a one-way door. A restored body also rebuilds its entries
|
||
in the backlink index.
|
||
|
||
**Retention is by count, not by age.** The newest N versions of a note are kept
|
||
and trimmed on every write; nothing expires merely for being old.
|
||
|
||
There used to be a second rule dropping anything past 90 days, and it was a bad
|
||
one: the count already bounds how much a note can accumulate, so age only ever
|
||
deleted history that nothing had replaced — and it bit hardest exactly where
|
||
history is most wanted. A note left alone for a quarter of a year lost its whole
|
||
past for having done nothing at all. `VERSION_RETENTION_DAYS` still exists and
|
||
still works, but it is off unless set.
|
||
|
||
**How many is decided per notebook.** Edit a notebook to give it its own number;
|
||
leave the field empty and it follows the server's default. A reference notebook
|
||
can keep fifty versions of everything while a scratch one keeps three.
|
||
|
||
| Variable | Default | Meaning |
|
||
|----------------------------|---------|------------------------------------------|
|
||
| `MAX_VERSIONS_PER_NOTE` | `50` | Default for notebooks with no setting |
|
||
| `VERSION_RETENTION_DAYS` | *off* | Optional age limit; unset means never |
|
||
| `VERSION_COALESCE_MINUTES` | `5` | Window in which saves share one snapshot |
|
||
|
||
**Deleting a note** — moving one to the trash keeps its history, because the
|
||
note can still be restored. Deleting it permanently, or emptying the trash,
|
||
removes its versions along with it (`ON DELETE CASCADE`), leaving no orphaned
|
||
rows behind.
|
||
|
||
| Method | Endpoint | Description |
|
||
|--------|-------------------------------------------|----------------------------|
|
||
| GET | `/api/notes/:id/versions` | List (metadata only) |
|
||
| GET | `/api/notes/:id/versions/:versionId` | One version, decrypted |
|
||
| POST | `/api/notes/:id/versions/:versionId/restore` | Restore it |
|
||
|
||
> Version history protects against **overwritten** data. It does not protect
|
||
> against a lost disk, because it lives in the same database — that is what
|
||
> backing up the data directory is for.
|
||
|
||
---
|
||
|
||
## Sorting a notebook
|
||
|
||
Each notebook remembers how its notes are ordered, and remembers it on the
|
||
server rather than per device — the order is a property of the notebook, and
|
||
finding one sorted differently on the phone than on the desktop is its own small
|
||
annoyance. A reference book can stay alphabetical while a journal stays
|
||
newest-first.
|
||
|
||
| Mode | Order |
|
||
| --- | --- |
|
||
| `manual` | the user's own arrangement, dragged into place — notebooks only |
|
||
| `updated` | most recently changed first *(the default)* |
|
||
| `oldest` | least recently changed first |
|
||
| `created` | most recently created first |
|
||
| `title` | A–Z, case- and umlaut-aware, with numbers read as numbers |
|
||
|
||
**The manual order has to survive being looked away from.** Searching imposes
|
||
its own order — relevance — and switching back has to show exactly what was
|
||
arranged. That is only keepable if the arrangement lives in the notes and is
|
||
never re-derived from what is on screen, so two rules hold it up:
|
||
|
||
- `reindex` renumbers **every note in the notebook**, taken from the store, not
|
||
the list being displayed. Renumbering a filtered subset would give a hidden
|
||
note the same position as a visible one and quietly scramble the rest.
|
||
- Dragging is switched off while a search is narrowing the list, and the list
|
||
says so rather than silently ignoring the drag.
|
||
|
||
"All Notes" and "Starred" are not offered a manual order at all. They are
|
||
questions asked of every notebook at once, so there is nothing for an
|
||
arrangement to belong to and nowhere to keep it.
|
||
|
||
**Separators** are lines drawn between notes, optionally named, stored on the
|
||
notebook beside the sort mode. Renaming and removing are both right-click, which
|
||
is how everything else in that list is acted on: a left-click on the label used
|
||
to start renaming, so the row could not be clicked at all without falling into an
|
||
edit, and the × for removal sat a few pixels from that same target. Removal asks
|
||
first, and says the notes are not affected. They move by dragging like a note does — a
|
||
divider that cannot move with what it divides is worse than none — and their
|
||
position is recorded as "how many notes come before me", so they stay put as the
|
||
notes around them are renamed, edited or opened. They are shown only in the
|
||
manual order: in "newest first" the notes would slide past the line on every
|
||
edit.
|
||
|
||
Reordering also has its own route, `POST /api/notes/reorder`. Going through
|
||
`PUT /api/notes/:id` would bump `updated_at` and snapshot a version — so
|
||
dragging a note would move it to the top of "last changed" and spend a slot of
|
||
its history on a change that is not to the note at all.
|
||
|
||
---
|
||
|
||
## Notes pinned to a passage
|
||
|
||
The panel beside a PDF is for notes about the document. A note that belongs to
|
||
*one paragraph* is a different thing — and a note that has to begin "on page 14,
|
||
third paragraph" has already lost its place. So a note can be pinned to a spot:
|
||
click **Pin note**, click the passage, write.
|
||
|
||
**The note is written beside the page, not on it.** Only a small numbered marker
|
||
sits on the document, with a hairline out to a card in the margin, level with the
|
||
passage. Writing onto the page would cover the sentence the note is about, which
|
||
is the one thing it must not do. Cards keep one height, so two notes close
|
||
together are laid out by pushing the second down until they no longer overlap;
|
||
the one being written in grows and rises above the rest.
|
||
|
||
The column is 288px wide and a card holds about five lines. It was 208 by 74 —
|
||
three short lines, which is a caption, not a remark — while the space beside the
|
||
page sat mostly empty.
|
||
|
||
**On a phone there is no margin.** A page narrow enough to read leaves no white
|
||
space beside it, and taking a column that wide would make the document itself
|
||
unreadable. There, tapping a marker brings the note up from the bottom — over the
|
||
page, but only while it is open, within reach of a thumb, and with the passage
|
||
still visible above it.
|
||
|
||
The column is kept as soon as the document has one pinned note, or while one is
|
||
being placed, so the page does not jump sideways at the moment of writing the
|
||
first. Reserving it also exposed a loop worth remembering: a flex item is as wide
|
||
as its content unless told otherwise, so the column made the viewer wider, which
|
||
made there be room for the column — the page ended up at 254px inside a 420px
|
||
phone while the layout insisted it had 611px.
|
||
|
||
Positions are stored in **PDF points**, the same space as the drawings, so a
|
||
marker stays on its sentence at every zoom and on every screen. Being in the
|
||
overlay rather than in the note body has three consequences, each of which needed
|
||
handling rather than assuming:
|
||
|
||
- **Search.** Nothing else would index them, so the viewer feeds them to the
|
||
local index itself, with their page numbers — finding the words is only half of
|
||
finding the note.
|
||
- **Clearing the ink.** "Seite leeren" empties the drawing. It must not take the
|
||
notes pinned to that page: same page, different thing.
|
||
- **"Is this overlay empty?"** The client and the server each held their own
|
||
answer, and both counted strokes only. An overlay carrying nothing but pinned
|
||
notes was therefore stored as `NULL` — every note on it lost on the next save.
|
||
Both now ask about strokes *and* pins.
|
||
|
||
**The margin notes can be linked from the notes.** A remark in the margin is
|
||
short by design; when there is more to say about that passage it belongs in the
|
||
notes beside the document — and it has to be possible to say *which* passage. So
|
||
the pins are offered to the editor's `@` menu exactly like notes and notebooks
|
||
are, labelled with their page, and following one scrolls the document to the spot
|
||
and opens the remark. They are unhidden first: a link that led to something
|
||
invisible would read as broken.
|
||
|
||
A pin link is the same node with `kind: "pin"`, and is deliberately left out of
|
||
the links reported to the server. Its target is a marker inside this note's own
|
||
overlay, so no note has that id, and reporting it would fill the backlink table
|
||
with rows that match nothing.
|
||
|
||
**They can be hidden**, and so can the drawings — by a pair of switches at the
|
||
right-hand end of the toolbar. They are two halves of one question, *how much of
|
||
my own work do I want to see right now*, and they used to sit at opposite ends of
|
||
the bar, each beside the tool that made them. Each appears only once there is
|
||
something of its kind to hide. Hiding the margin notes takes the markers and the
|
||
column together, and the page takes the width back while they are away.
|
||
|
||
The drawing tools sit directly after the button that turns them on. They had
|
||
drifted to the far side of two other controls, so switching to Zeichnen made them
|
||
appear somewhere other than where the eye already was.
|
||
|
||
They come along when the document is exported with annotations: each becomes a
|
||
numbered marker plus a small box with its text, placed on whichever side of the
|
||
pin has room. Only Latin-1 survives — the standard PDF fonts cannot encode more,
|
||
and one em dash must not cost the whole export, so anything else is replaced.
|
||
|
||
---
|
||
|
||
## Import
|
||
|
||
The other half of the promise that notes are not hostage to this program. A
|
||
`.md` file becomes a note; a `.zip` this app exported comes back nearly whole —
|
||
text, tables, task boxes, and the images, re-uploaded as attachments so they are
|
||
encrypted at rest again like anything else.
|
||
|
||
The parser is a deliberate subset: what the exporter emits, plus what a
|
||
hand-written note is likely to use. It is not CommonMark and does not try to be.
|
||
A full parser is thousands of lines and a permanent maintenance surface, and the
|
||
failure mode here is mild — an unrecognised construct arrives as the literal
|
||
text that was written, which is still the user's words in the user's order.
|
||
|
||
Two things do not come back, and the import says so afterwards rather than
|
||
leaving them to be discovered:
|
||
|
||
- **A drawing returns as a picture, not as strokes.** It was exported as a PNG,
|
||
and vectors cannot be recovered from pixels. It stays visible, printable and
|
||
exportable, but the pen can no longer edit it.
|
||
- **An image the archive does not contain cannot be restored.** The place it sat
|
||
in the note is kept, so what used to be there is at least recorded.
|
||
|
||
Writing the exporter also turned up a real bug in it: blocks were emitted
|
||
without a blank line between them, so a list written straight after another list
|
||
became more items of the first, and a quote or code fence on the next line was
|
||
read as part of the item above. That is not one reader's quirk — it is what the
|
||
format says — so the file rendered wrongly everywhere, not only here.
|
||
|
||
---
|
||
|
||
## Export
|
||
|
||
Notes should not be hostage to this program, so everything can leave it — from a
|
||
single note up to every note in the account, reachable from the note's toolbar,
|
||
a notebook's context menu, and Account → *Alle Notizen exportieren*.
|
||
|
||
A single note is asked two questions rather than one, because the answers are
|
||
not independent — Markdown holds text only, a PNG holds the drawing only, and
|
||
PDF is the one format that holds both:
|
||
|
||
| Was soll mit? | In welcher Form? |
|
||
| --- | --- |
|
||
| Notiz mit Zeichnung | PDF *(Markdown puts the drawing in a PNG beside it)* |
|
||
| Nur den Notiztext | PDF · Markdown |
|
||
| Nur die Zeichnung | PNG · PDF |
|
||
|
||
A note without a drawing skips the first question instead of showing it with two
|
||
thirds greyed out.
|
||
|
||
**Markdown** keeps the notes editable elsewhere. Headings, lists, quotes, code,
|
||
tables and task state all have equivalents and are carried over; a link to
|
||
another exported note becomes a relative link to its file, and a link to a note
|
||
outside the export degrades to its plain title rather than a dead reference.
|
||
A note with images or a drawing arrives as a ZIP so the files travel with it,
|
||
and a whole notebook gets a `README.md` index grouped by notebook.
|
||
|
||
**PDF** goes through the browser's own print dialog rather than a bundled PDF
|
||
library — every browser already has a good one behind *Save as PDF*, and it
|
||
handles fonts and page breaks better than anything that would fit in here. This
|
||
is the format that keeps drawings inside the document.
|
||
|
||
Two things Markdown cannot represent, and what happens instead:
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| drawings | rendered to PNG beside the note, with a line in the text saying so |
|
||
| underline | written as `<u>`, which every Markdown renderer passes through |
|
||
|
||
The ZIP writer is [`export/zip.ts`](frontend/src/export/zip.ts) — about eighty
|
||
lines for stored (uncompressed) entries, rather than a dependency. Note text is
|
||
small and images are already compressed, so there was nothing to gain by
|
||
compressing, and this is one fewer thing to keep updated.
|
||
|
||
Everything runs in the browser. Nothing is uploaded anywhere to produce a file.
|
||
|
||
---
|
||
|
||
## Drawings
|
||
|
||
Drawings are **vector strokes**, not bitmaps. Every stroke is recorded in one canonical
|
||
page space of 1200 × 1600 units:
|
||
|
||
```json
|
||
{ "v": 1, "w": 1200, "h": 1600, "strokes": [
|
||
{ "t": "pen", "c": "#e94560", "s": 5.5, "p": [100,100, 200,180, 300,140] }
|
||
]}
|
||
```
|
||
|
||
`t` is the tool (`pen` | `highlighter` | `eraser`), `c` the colour, `s` the width in
|
||
canonical units, and `p` a flat `x,y` point list. Each viewer scales that page to the
|
||
room it has and rasterizes at its own device pixel ratio, which is what makes a note
|
||
look the same on a phone and on a desktop — and stay crisp on both. Stroke data is
|
||
encrypted at rest like note content.
|
||
|
||
Notes drawn before this format still carry a PNG in `drawing_data_path`; it renders
|
||
underneath any newer strokes so nothing is lost.
|
||
|
||
### One drawing, as many pages as the note
|
||
|
||
A note used to have exactly one sheet to draw on, which stopped making sense once
|
||
the writing could run to four pages: the ink was stuck on the first one while the
|
||
text carried on without it. Every page is exported anyway, so every page can be
|
||
drawn on. Pages are numbered the way the PDF reader numbers them:
|
||
|
||
```json
|
||
{ "v": 2, "w": 1200, "h": 1600, "sheets": {
|
||
"1": [ { "t": "pen", "c": "#e94560", "s": 5.5, "p": [100,100, 200,180] } ],
|
||
"3": [ { "t": "highlighter", "c": "#f5c518", "s": 27, "p": [80,900, 900,910] } ]
|
||
}}
|
||
```
|
||
|
||
A page nobody has drawn on is not stored, so the keys *are* the drawn pages.
|
||
|
||
**A drawing that lives entirely on page one is still written in the old shape**,
|
||
with a plain `strokes` list and no `sheets` at all. Nothing requires that — it
|
||
means an ordinary note's drawing is stored exactly as it always was, and a device
|
||
running an older build still shows it.
|
||
|
||
While drawing there is always one blank page past the end. Pages otherwise come
|
||
from how far the writing runs, which would leave a drawing with nowhere to go: to
|
||
draw on page three you would first have to write three pages. Drawing on the
|
||
spare page makes it a real one, and the page count in the toolbar counts it.
|
||
|
||
The bin clears **the page being looked at**, not the whole drawing. Undo and redo
|
||
work on the drawing as a whole, because one Undo button that means four different
|
||
things depending on where you scrolled is not a button anyone can use.
|
||
|
||
In an export, page one keeps the name a drawing has always had —
|
||
`drawings/<note>.png`, or `<note>-drawing.png` beside a single note — and the
|
||
rest are numbered after it. A drawing of several pages exported on its own comes
|
||
out as a ZIP rather than as its first page alone.
|
||
|
||
---
|
||
|
||
## Made offline, and what it is called
|
||
|
||
Something created with no connection carries an id this device invented —
|
||
`local_x9k2…`. When its create finally reaches the server, the server names it
|
||
something else, and the local database is repointed at the new name.
|
||
|
||
**The queue has to be repointed too**, and for a long time it was not. The create
|
||
arrived; every edit still queued behind it went on addressing the name only this
|
||
device ever knew; the server answered 404; the entry was retried five times and
|
||
thrown away. A note written and drawn on offline reached the server *empty and
|
||
untitled*, with nothing to say that anything had been lost. The same held for a
|
||
notebook made offline and everything filed into it.
|
||
|
||
`repointQueue(oldId, newId)` in [`offlineStore.ts`](frontend/src/offlineStore.ts)
|
||
now rewrites the waiting entries alongside the database. It replaces the id as a
|
||
plain string across the whole queued payload rather than in a list of named
|
||
fields — ids are long random strings, so a false match is not a practical worry,
|
||
and a list of fields is a list to forget to add to.
|
||
|
||
The `offline` suite makes a note with the network off, titles it, writes in it,
|
||
draws on it, reconnects, and then asks the *server* for all three.
|
||
|
||
---
|
||
|
||
## Conflict Resolution
|
||
|
||
Two devices can edit the same note without knowing about each other — a phone
|
||
that was offline all day, a laptop that was not. When the phone reconnects, its
|
||
save arrives last, and without care it would simply bury the newer work.
|
||
|
||
Each write carries `baseUpdatedAt`: the revision the editing device had when it
|
||
started. The server compares it with the note's current revision:
|
||
|
||
1. **Same** — an ordinary save, nothing to think about.
|
||
2. **Server is newer** — someone else saved in between. The incoming edit still
|
||
wins, because rejecting it would throw away whatever was just typed, and on a
|
||
phone that has been offline for a day that is the worse loss. But the state
|
||
it replaces is kept as a version marked `conflict`, so both exist, and the
|
||
history dialog is where you pick which one to keep.
|
||
|
||
This replaced vector clocks, which sat in the server unused: no client ever sent
|
||
one. They can tell a genuine conflict from a device merely catching up, which is
|
||
strictly more accurate — but that accuracy only pays for itself with a merge
|
||
interface to spend it on, and comparing revisions needs one field and reuses the
|
||
version history that already exists.
|
||
|
||
**What this does not do:** it will not tell you at the moment it happens. The
|
||
conflicting version appears in the history, labelled, and that is where you find
|
||
it. A notification is worth adding if it ever actually bites.
|
||
|
||
---
|
||
|
||
## Extending to Native Platforms
|
||
|
||
### React Native
|
||
Use `note-app.jsx` components with React Native adaptations (replace HTML canvas with `react-native-canvas` or `@shopify/react-native-skia` for drawing). The sync engine works as-is.
|
||
|
||
### Flutter
|
||
Use the sync engine via a JavaScript bridge, or port the API calls to Dart. For drawing, use Flutter's `CustomPainter`.
|
||
|
||
### Electron
|
||
Wrap the React app directly in Electron for desktop. Add native file system access for export.
|
||
|
||
---
|
||
|
||
## Security Notes
|
||
|
||
- All note content is encrypted with AES-256-CBC before database storage
|
||
- Passwords are hashed with bcrypt (12 rounds)
|
||
- JWT tokens expire after 30 days
|
||
- HTTPS should be enforced in production (use a reverse proxy like Nginx or Pangolin)
|
||
- The encryption key should be stored securely (e.g., environment variable, secrets manager)
|
||
|
||
---
|
||
|
||
## Tech Stack
|
||
|
||
| Layer | Technology |
|
||
|-----------|-------------------------------------|
|
||
| Frontend | React 18 + Vite |
|
||
| Editor | TipTap (ProseMirror) |
|
||
| Backend | Node.js, Express |
|
||
| Database | SQLite (dev), PostgreSQL (prod) |
|
||
| Real-time | WebSocket (ws library) |
|
||
| Auth | JWT + bcrypt |
|
||
| Encryption| AES-256-CBC |
|
||
| Container | Docker + docker-compose | |