# nostrbase

> A Supabase-style TypeScript SDK over Nostr, built on Applesauce. SDK 0.2.0; ESM; Node 22.12+ and modern browsers. Not published to npm.

## Documentation

- [Engineering baseline](/nostrbase/content/engineering.md): Commands, controls, Git flow, and external setup.
- [Release policy](/nostrbase/content/releasing.md): Compatibility, verified artifacts, approval, and recovery.
- [Ownership and review](/nostrbase/content/maintainers.md): Component responsibilities and review requirements.
- [Security policy](/nostrbase/content/security.md): Private reporting and repository checks.
- [Independent relay checks](/nostrbase/content/integration/relay.md): Pinned relay setup and contract evidence.
- [Real browser checks](/nostrbase/content/integration/browser.md): IndexedDB and browser lifecycle contracts.
- [NIP-46 provider checks](/nostrbase/content/integration/signer.md): A separate signer process and approval boundaries.
- [Real extension checks](/nostrbase/content/integration/extension.md): Pinned nos2x installation and permissions.
- [Independent Blossom checks](/nostrbase/content/integration/blossom.md): Upstream file service, ownership, and CORS.
- [Network fault checks](/nostrbase/content/integration/network.md): Interrupted operations and recovery.
- [Browser crash checks](/nostrbase/content/integration/crash.md): Abrupt process termination and durable recovery.
- [Bounded load checks](/nostrbase/content/integration/load.md): Workload metrics and lifecycle limits.
- [Live deployment checks](/nostrbase/content/integration/live.md): Explicit endpoints, public findings, and cleanup evidence.
- [Integration CI](/nostrbase/content/integration/ci.md): Hosted job setup, artifacts, and verification limits.
- [Fieldwork application](/nostrbase/content/fieldwork.md): Packaged SDK setup and meaningful app checks.
- [Fieldwork developer experience](/nostrbase/content/fieldwork-experience.md): Implementation findings and known limits.
- [Marmot engine provenance](/nostrbase/content/marmot-engine.md): Pinned experimental engine source and build.
- [Quickstart](/nostrbase/content/quickstart.md): Connect a signer and publish your first record.
- [How it works](/nostrbase/content/architecture.md): From table calls to signed Nostr events.
- [From Supabase](/nostrbase/content/supabase.md): Map APIs and understand the differences.
- [Configure the client](/nostrbase/content/client.md): Relays, schemas, and write acceptance.
- [Read and write](/nostrbase/content/crud.md): Typed CRUD and author-owned writes.
- [Filters and ordering](/nostrbase/content/filters.md): Select, compare, sort, and limit rows.
- [Cursor pagination](/nostrbase/content/pagination.md): Newest-first pages over canonical records.
- [Schemas and types](/nostrbase/content/schemas.md): Zod validation and TypeScript inference.
- [Search](/nostrbase/content/search.md): Client text search and relay-dependent NIP-50.
- [Record references](/nostrbase/content/references.md): Resolve author-scoped links between records.
- [Richer queries](/nostrbase/content/queries.md): Logical filters, JSON paths, collection filters, counts, and null ordering.
- [Connect a signer](/nostrbase/content/authentication.md): Extensions, private keys, and remote signers.
- [Identity and access](/nostrbase/content/ownership.md): Authors, public data, and trust rules.
- [Private tables](/nostrbase/content/private-tables.md): Personal NIP-44 encrypted records.
- [Shared private collections](/nostrbase/content/groups.md): Experimental Marmot groups, encrypted records, and recovery.
- [Key backup and recovery](/nostrbase/content/key-backup.md): Password-encrypted NIP-49 identity backups.
- [Database changes](/nostrbase/content/live-changes.md): Listen for inserts, updates, and deletes.
- [Broadcast](/nostrbase/content/broadcast.md): Signed, public ephemeral messages.
- [Presence](/nostrbase/content/presence.md): Session state, heartbeats, and expiry.
- [File storage](/nostrbase/content/storage.md): Blossom upload, download, list, and delete.
- [Persistent cache](/nostrbase/content/persistence.md): Verified events and tombstones in IndexedDB.
- [Offline writes](/nostrbase/content/offline-writes.md): Sign now and replay exact events later.
- [Negentropy sync](/nostrbase/content/synchronization.md): Pull missing stored events with NIP-77.
- [Image processing](/nostrbase/content/images.md): Local raster transformations in browsers and Node.
- [Automatic queue replay](/nostrbase/content/automatic-replay.md): Opt-in retries with account isolation and durable exact-event replay.
- [Native Nostr events](/nostrbase/content/native-events.md): Use standard kinds and Applesauce instances.
- [Migrations](/nostrbase/content/migrations.md): Preview and validate author-owned rewrites.
- [Backups](/nostrbase/content/backups.md): Export and import cached signed history.
- [Diagnostics](/nostrbase/content/diagnostics.md): Bounded, content-free local logs.
- [Local dashboard](/nostrbase/content/dashboard.md): Inspect cache, queue, and relay state.
- [Browser](/nostrbase/content/browser.md): NIP-07 sign-in and UI lifecycle.
- [React and Next.js](/nostrbase/content/react.md): Browser signer calls and effect cleanup.
- [Node.js](/nostrbase/content/node.md): An ESM script with an Applesauce signer.
- [Errors and receipts](/nostrbase/content/errors.md): Handle partial writes and relay failures.
- [Relays and deployment](/nostrbase/content/relays.md): Choose capabilities and host a client app.
- [Record protocol](/nostrbase/content/protocol.md): Wire format, versions, and deletion rules.
- [Troubleshooting](/nostrbase/content/troubleshooting.md): Diagnose common signer, relay, and cache issues.
- [Testing](/nostrbase/content/testing.md): Test commands, contract coverage, fixtures, and limits.
- [Environment integration](/nostrbase/content/environment-integration.md): External service and browser test setup, commands, and limits.
- [Verification](/nostrbase/content/verification.md): What was checked and what remains unverified.
- [Changelog](/nostrbase/content/changelog.md): SDK changes by release.
- [Contributing](/nostrbase/content/contributing.md): Build, verify, and maintain the SDK and its documentation.
- [Client](/nostrbase/content/reference/client.md): createClient and client lifecycle.
- [Query builder](/nostrbase/content/reference/query.md): All query methods and result cardinality.
- [Records and results](/nostrbase/content/reference/types.md): Client options, rows, metadata, and transport.
- [Authentication](/nostrbase/content/reference/auth.md): Signer sessions and auth state listeners.
- [Channels](/nostrbase/content/reference/channel.md): Live changes, Broadcast, and Presence.
- [Private tables](/nostrbase/content/reference/private.md): Personal queries and decrypted subscriptions.
- [File storage](/nostrbase/content/reference/storage.md): Blossom methods and request options.
- [Persistence](/nostrbase/content/reference/persistence.md): Cache lifecycle and adapter contracts.
- [Offline queue](/nostrbase/content/reference/offline.md): Signed entries and exact-event replay.
- [Synchronization](/nostrbase/content/reference/sync.md): Pull strategies and per-relay recovery results.
- [Schema helpers](/nostrbase/content/reference/schema.md): Zod validation and inferred database types.
- [References](/nostrbase/content/reference/relations.md): Author-scoped record resolution.
- [Migrations](/nostrbase/content/reference/migrations.md): Transform options and partial results.
- [Backups](/nostrbase/content/reference/backup.md): Archive format and verified import.
- [Native events](/nostrbase/content/reference/events.md): Standard event query, search, and publish.
- [Diagnostics](/nostrbase/content/reference/diagnostics.md): Log entries, capacity, and subscriptions.
- [Dashboard](/nostrbase/content/reference/dashboard.md): Snapshots, HTML rendering, and browser mount.
- [Errors](/nostrbase/content/reference/errors.md): Error codes and structured error details.
- [Protocol helpers](/nostrbase/content/reference/protocol.md): Constants and record addressing.
- [Applesauce transport](/nostrbase/content/reference/transport.md): Relay requests, publications, and subscriptions.
- [Private groups](/nostrbase/content/reference/groups.md): Marmot membership, collections, and device lifecycle.
- [Group storage](/nostrbase/content/reference/group-store.md): Encrypted private device state adapters.
- [Group state backup](/nostrbase/content/reference/group-backup.md): Export and restore encrypted private group device state.
- [Key backup](/nostrbase/content/reference/key-backup.md): Public types and methods for key backup.
- [Automatic replay](/nostrbase/content/reference/auto-replay.md): Public types and methods for automatic replay.
- [Image processing](/nostrbase/content/reference/images.md): Public types and methods for image processing.
- [Node images](/nostrbase/content/reference/node-images.md): Public types and methods for node images.
- [Filter types](/nostrbase/content/reference/query-filters.md): Public types and methods for filter types.
- [Applesauce exports](/nostrbase/content/reference/applesauce.md): Signer, pool, and event-store exports from Applesauce.

## Complete text

- [All documentation](/nostrbase/llms-full.txt)