Files
Connor Yoh f5a1c7b235 Do not treat "have not asked yet" as "not linked"
A linked self-hosted instance was still shown the connect prompt, the sidebar
button and the feature gates.

linkState has three values and none of them is "unknown", so LinkProvider opens
at "unlinked" and a separate status call corrects it. The gate read !isLinked
and its loading flag covered only the app-config query, so between app-config
landing and the status arriving a linked instance looked unlinked: the prompt
fired, the gates closed, and markPrompted() burned the once-a-session marker on
a prompt that should never have opened.

Worse, the status call swallows its failures into { linked: false }. A 401 from
a lapsed admin session, a 5xx, a dropped connection, and nothing retries: the
instance then looked unlinked for the rest of the session. That is the version
users hit, because it does not correct itself.

So the context now carries whether the status has actually been read back.
Anything that blocks waits for it; the gate holds open until then and stays
open if the call never succeeds. A gate that cannot read its own precondition
should not be the thing standing in the way, and the real enforcement for these
features belongs on the server regardless.

The prop defaults to true so a pinned state in a story or test is still
believed as given. Only the app passes false, because only the app has to go
and ask.

Tests cover the three answers that were being conflated: not yet known, never
knowable, and genuinely unlinked, that last one so this cannot quietly become
"never gate".
2026-09-02 11:38:16 +01:00
..
2026-04-27 11:35:50 +01:00

Frontend

All frontend commands are run from the repository root using Task:

  • task frontend:dev — start Vite dev server (localhost:5173)
  • task frontend:build — production build
  • task frontend:test — run tests
  • task frontend:test:watch — run tests in watch mode
  • task frontend:lint — run linting
  • task frontend:typecheck — run TypeScript type checking
  • task frontend:check — run typecheck + lint + test
  • task frontend:install — install npm dependencies

For desktop app development, see the Tauri section below.

Layout

frontend/ is a workspace containing one or more apps. Today it holds the PDF editor under frontend/editor/; new apps (the developer portal, etc.) will sit alongside it as siblings. Shared tooling — package.json, node_modules, .storybook/, oxlint, Prettier — lives at frontend/ so every app installs once and lints with the same config.

Environment Variables

The editor's environment variables live in committed .env files at frontend/editor/:

  • .env — used by all builds (core, proprietary, and as the base for desktop/SaaS)
  • .env.desktop — additional vars loaded in desktop (Tauri) mode
  • .env.saas — additional vars loaded in SaaS mode

These files contain non-secret defaults and are checked into Git, so most dev work needs no further setup.

To override values locally (API keys, machine-specific settings), create an uncommitted sibling editor/.env.local / editor/.env.desktop.local / editor/.env.saas.local. Vite automatically layers these on top of the committed files.

Docker Setup

For Docker deployments and configuration, see the Docker README.

Tauri

All desktop tasks are available via Task. From the root of the repo:

Dev

task desktop:dev

This ensures the JLink runtime and backend JAR exist (skipping if already built), then starts Tauri in dev mode.

Build

task desktop:build

This does a full clean rebuild of the backend JAR and JLink runtime, then builds the Tauri app for production.

Platform-specific dev builds are also available:

task desktop:build:dev           # No bundling
task desktop:build:dev:mac       # macOS .app bundle
task desktop:build:dev:windows   # Windows NSIS installer
task desktop:build:dev:linux     # Linux AppImage

You can also run JLink steps individually:

task desktop:jlink          # Build JAR + create JLink runtime
task desktop:jlink:jar      # Build backend JAR only
task desktop:jlink:runtime  # Create JLink custom JRE only
task desktop:jlink:clean    # Remove JLink artifacts

Clean

task desktop:clean

Removes all desktop build artifacts including JLink runtime, bundled JARs, Cargo build, and dist/build directories.