API reference
Generated from the JSDoc of @nzip/lofi v0.4.0.
A local-first Deno PWA framework with durable local data, recoverable accounts, optional Jazz sync, and private, direct-share, or group access templates.
| Export | Summary |
|---|---|
@nzip/lofi | Build local-first browser applications with durable storage, reactive tables, optional Jazz sync, recoverable accounts, and an installable PWA lifecycle. |
@nzip/lofi/astro | Astro and Vite integration used by generated lofi applications. |
@nzip/lofi/access | Narrow private, direct-share, and fixed-role group access templates over raw Jazz schemas. |
@nzip/lofi/preact | Optional Preact bindings for lofi device capabilities and PWA controls. |
@nzip/lofi/testing | The @nzip/lofi/testing public surface: Playwright-backed helpers for testing local-first behavior, including two-client fixtures, concurrent offline convergence, app-owned readiness waits, value-free failure artifacts, and a CDP virtual authenticator for headless WebAuthn flows. |
@nzip/lofi/create | The deno run -A jsr:@nzip/lofi/create <name> command: scaffolds a new local-first PWA project from the validated starter template. Pass --sync to also provision a managed Jazz app and write it into the project's .env, so the app can offer synced, backed-up accounts from the first boot. |
@nzip/lofi/build | The deno task build command: builds the static PWA into dist/ with a source-hash build id, a service-worker precache manifest, and a scan that fails the build if server secrets leak into client output. |
@nzip/lofi/dev | The deno task dev command: runs the Astro development server after lofi preflight checks and diagnostics. |
@nzip/lofi/doctor | The deno task doctor command: prints a value-free readiness report covering the package, Deno, project layout, environment, storage, identity, sync, and PWA, and exits non-zero when the project is blocked. |
@nzip/lofi/preview | The deno task preview command: serves the built dist/ output locally over HTTP for previewing the production PWA. |
@nzip/lofi/provision | The deno task jazz:provision command: generates a managed Jazz app and writes its configuration into .env, so the project can offer synced, backed-up accounts. Prints the new app id and how to claim it — never the secrets, which live only in the git-ignored .env. |
@nzip/lofi/test | The deno task test command: runs the generated project's local-first test suite, retaining browser artifacts under test-results/. |
@nzip/lofi/recipes/file-handler | Opt-in helpers for turning file launches or ordinary picker files into bounded, validated import drafts. |
@nzip/lofi/recipes/launch-handler | Opt-in helpers for installed-app launch handling and safe client reuse. |
@nzip/lofi/recipes/protocol-handler | Opt-in parser for a narrow custom-protocol collaborative-list deep link. |
@nzip/lofi/recipes/related-app-discovery | Opt-in presentation-only discovery for verified related applications. |
@nzip/lofi/recipes/scope-extension | Opt-in deployment helpers for reciprocal PWA scope extensions. |
@nzip/lofi/recipes/web-share | Opt-in helpers for outbound Web Share and inbound text/link share targets. |
@nzip/lofi/recipes/window-controls-overlay | Opt-in geometry observation for desktop Window Controls Overlay layouts. |