@reddb-io/browser 0.0.0-stage → 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,111 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             RedDB.io <hello@reddb.io>
+
+Licensed Work:        RedDB
+                      The Licensed Work is (c) 2026 RedDB.io
+
+Additional Use Grant: You may make use of the Licensed Work, provided that
+                      you do not use the Licensed Work for a Database
+                      Service.
+
+                      A "Database Service" is a commercial offering that
+                      allows third parties (other than your employees and
+                      individual contractors) to access the functionality
+                      of the Licensed Work by creating tables, documents,
+                      graphs, vectors, key-value entries, queues, or
+                      time-series whose schemas and/or data are determined
+                      by those third parties, or by querying, storing, or
+                      retrieving data determined by those third parties,
+                      whether as a hosted, managed, "as-a-service",
+                      database-as-a-service (DBaaS), platform-as-a-service
+                      (PaaS), software-as-a-service (SaaS), or cloud
+                      database product.
+
+                      For clarity, the Additional Use Grant permits, among
+                      other things, the following uses, none of which
+                      constitute a Database Service: personal use; internal
+                      use within your own organization; research and
+                      educational use; development and testing; use in
+                      open source projects; and self-hosting the Licensed
+                      Work for your own organization's own data.
+
+Change Date:          2030-06-22
+
+Change License:       GNU Affero General Public License version 3.0
+
+For information about alternative licensing arrangements for the Licensed
+Work, please contact hello@reddb.io.
+
+Notice
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/README.md

@@ -1,3 +1,335 @@
-# Temporary Holding Version
+# RedDB Browser — experimental persistence and query engine
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This experimental package is the first distribution of RedDB Browser. It runs the
+canonical Rust `.rdb` artifact publication/recovery code, RQL parser and shared
+scalar evaluator in a dedicated WebAssembly worker, persisting through a real
+OPFS sync access handle.
+Artifact storage requires a secure context, module workers, OPFS and Web Locks.
+The storage-independent runtime only needs module workers and WebAssembly.
+
+The target is a fully offline local database with a JavaScript/TypeScript API.
+The Rust/WASM engine ships with the package; local operation must not require a
+RedDB server, account, CDN or external API. Applications bundle the JS, worker
+and WASM assets and make them available locally or through their own offline
+application cache. Sync is optional and must never gate local reads or writes.
+
+**It is not a database SDK yet.** It executes storage-free scalar SELECTs;
+queries over stored data, five-model local transactions, synchronization,
+conflict resolution and forwarding between tabs remain pending. It is published on the `experimental` npm channel and does not replace the remote `@reddb-io/client`.
+
+## Use from JS/TS
+
+See the [application guide](https://github.com/reddb-io/reddb/blob/main/docs/clients/browser.md) for installation,
+Vite/React/Vue/Svelte, plain JavaScript, Worker ownership and offline assets.
+
+```sh
+npm add @reddb-io/browser@experimental
+```
+
+```ts
+import { openArtifact } from '@reddb-io/browser'
+import RedDBWorker from '@reddb-io/browser/worker?worker'
+
+const artifact = await openArtifact({ name: 'my-app', worker: new RedDBWorker() })
+try {
+  console.log(await artifact.executeScalar('SELECT 42 AS answer'))
+} finally {
+  await artifact.close()
+}
+```
+
+Consumers receive built JS/Worker/WASM assets and TypeScript declarations; they
+need no Rust toolchain. The commands below are for engine/package contributors.
+
+## Shared runtime and language interop
+
+`createRuntime({ worker? })` opens no file and requires neither OPFS nor Web
+Locks. It exposes `info`, `validateQuery`, `executeScalar` and `close`:
+
+```ts
+import { createRuntime } from '@reddb-io/browser'
+import RedDBWorker from '@reddb-io/browser/worker?worker'
+const runtime = await createRuntime({ worker: new RedDBWorker() })
+try {
+  console.log(await runtime.info())
+  console.log(await runtime.executeScalar('SELECT 6 * 7 AS answer'))
+} finally { await runtime.close() }
+```
+
+The versioned Worker/WASM contract reports `abiVersion: 1`,
+`valueEncoding: 'reddb-json-v1'` and capabilities. Currently `queryValidation`
+and `scalarQueries` are true; `storedQueries`, `transactions` and `sync` are
+false. Mismatched SDK/Worker/WASM versions fail with `VERSION_MISMATCH` before
+opening storage. Cache the JS, Worker and WASM as one versioned unit.
+
+`createInteropRuntime({ worker? })` returns a synchronous bridge object with
+`invoke(method, params?)` and `close()`. `invoke` accepts `info`, `validateQuery`
+and `executeScalar` (queries take `{ sql }`) and resolves JSON-safe envelopes:
+`{ ok: true, result }` or `{ ok: false, error: { code, message } }`.
+A void result is `null`; exact integer/decimal tags are unchanged. `close()` is
+idempotent and cancels pending initialization/operations. Calls after close
+return `CLOSED`. Each bridge owns a dedicated Worker.
+
+Source adapters use this same bridge for
+[Dart/Flutter Web](https://github.com/reddb-io/reddb/blob/main/drivers/dart/BROWSER.md) and
+[C#/Blazor](https://github.com/reddb-io/reddb/blob/main/drivers/dotnet/src/Reddb.Browser/README.md). They are not yet
+published on pub.dev/NuGet. Their real compiled browser probes exercise scalar
+execution, exact values, errors and disposal online and offline. Full offline
+browser restarts are verified on Chromium/Firefox; Playwright WPE persistent
+profiles lack working CacheStorage, so Safari/iOS qualification remains pending. Run `pnpm --filter @reddb-io/browser build:interop` followed by
+`pnpm --filter @reddb-io/browser test:interop` with Dart 3.13.7 and .NET 8.0.426.
+These adapters do not expose artifact storage or qualify complete offline apps.
+
+## Build and verify
+
+Install the repository-pinned Rust toolchain, its `wasm32-unknown-unknown` target,
+and `wasm-bindgen-cli` **0.2.120**. Install workspace dependencies with pnpm.
+
+```sh
+pnpm --filter @reddb-io/browser build
+pnpm --filter @reddb-io/browser exec playwright install --with-deps chromium firefox webkit
+pnpm --filter @reddb-io/browser test
+cargo test --locked -p reddb-io-file
+cargo test --locked -p reddb-io-engine
+```
+
+The `WASM_BINDGEN` environment variable can point at the pinned CLI executable.
+`REDDB_BROWSER_BROWSERS=chromium` restricts the local browser test matrix; CI runs all
+three engines. Generated JS/WASM bindings are ignored and rebuilt from Rust.
+
+The tests probe the browser's actual native APIs. If a port lacks synchronous
+OPFS (currently Playwright's WPE WebKit runner), its persistence tests explicitly
+report skips; the unsupported-browser error path still runs. I/O or format
+failures never cause a skip. Chromium and Firefox exercise persistence and
+cross-tab ownership. WebKit persistence and real Safari/iOS qualification remain
+pending; a green CI run does not imply that coverage.
+
+The conformance tests compile a separate test-only WASM artifact and execute the same
+assertions as the native engine tests: scalar goldens/errors, compiled row
+filtering/sorting/projection, joins, aggregation, windows, set operations and
+cancellation. These do not require OPFS, so they run even on browser ports
+without synchronous storage. The same worker also checks the shared 16 KiB page
+layout, checksum corruption detection, freelist trunk recovery, pinned-page
+eviction and dirty writeback. Native unit tests for these primitives run from
+`reddb-engine`; native module paths retain the same types, with pager restart
+coverage. The native pager now shares byte I/O, sealed superblock writes and
+in-file double-write staging/recovery over `VfsFile` with WASM. Shared fixtures
+interrupt each write/flush in page publication, root publication and recovery,
+and check short reads, checksums and bounded frames. A test-only OPFS worker
+recovers a torn page after a full browser restart with networking disabled
+and the HTTP host disconnected.
+Those fixtures are excluded from the production SDK. Pager orchestration now
+also lives in `reddb-engine`: cached I/O, deferred reclamation, freelist and
+allocation fences, physical-tail reservation and checkpoint markers. The native
+adapter supplies file locks, encryption and its WAL writer through a synchronous
+barrier; portable pagers without a WAL reject nonzero page LSNs. Shared native/WASM
+fixtures cover failed allocation fences and WAL barriers. The OPFS restart fixture
+uses this complete pager and verifies checkpoint completion through another fresh
+pager. The production JS/TS API is unchanged: storage-backed queries, local
+transactions, runtime WAL/MVCC integration and encryption qualification remain pending.
+Native differential tests additionally compare
+the scalar corpus to actual `RedDBRuntime` query results.
+
+The shared core also owns the native B-tree/cursor, compressed value layout and
+overflow chains. Native APIs alias these implementations through a page-access
+contract; the browser executes them in test-only WASM fixtures. Conformance covers
+splits, scans, seeks, updates/deletes, large values and reclamation. An additional
+OPFS test mutates a native-created tree, restarts the browser with the HTTP host
+stopped, and reopens the exported file natively. The fixture includes native
+encoded entities as well as opaque B-tree values. These lower-level records do
+not supply runtime collection schemas or atomic database transactions. No raw
+tree API is added to the production SDK.
+
+## Current query contract
+
+```js
+const artifact = await openArtifact({ name: 'example' })
+await artifact.executeScalar('SELECT 2 + 3 * 4 AS answer')
+// { columns: ['answer'], rows: [[14]] }
+await artifact.close()
+```
+
+`executeScalar` uses the shared Rust evaluator, built-in type/operator/function
+catalogs and output labels. It accepts storage-free scalar SELECT expressions
+and literal LIMIT/OFFSET; unsupported clauses and stored-data queries fail
+explicitly. It never reads or changes the artifact. Integer values outside JS's
+safe range retain canonical `$int`/`$uint` tags instead of rounding. This small
+entrypoint is an execution milestone, not the full RQL/storage runtime.
+
+## Current storage contract
+
+`openArtifact({ name })` opens or creates `reddb-browser/<name>.rdb` inside the
+origin's private filesystem. It exposes `append`, `readWal`, `checkpoint`,
+`readSnapshot`, `generation`, `validateQuery` and `close`. These are artifact
+primitives: WAL payloads are native binary records, and checkpoint images are
+complete native store snapshots. Passing arbitrary SQL as a payload does not
+execute it. The caller must incorporate committed WAL into a checkpoint image.
+
+The browser and native file authority share the same format codecs and write
+ordering. Acknowledgement follows both the WAL flush and root publication flush.
+After a storage operation fails, that Rust handle rejects further I/O until it
+is reopened and recovered. Existing corrupt files are preserved and reported;
+they are never silently replaced. A second open returns `FILE_BUSY`; closing or
+terminating the owning worker releases the lock. Invalid input and parse errors
+do not invalidate the storage handle.
+
+The host must provide exclusive ownership when using Rust's `EmbeddedRdbFile`
+directly. The browser wrapper enforces this with Web Locks and OPFS's default
+exclusive access handle. The prototype does not use relaxed/read-write-unsafe
+access, emulate file locks, or require `SharedArrayBuffer` or isolation headers.
+
+OPFS is subject to origin quota, storage eviction and explicit site-data clearing.
+Applications can request persistent storage through `navigator.storage.persist()`;
+these primitives do not promise that a browser will grant it or sync after closing.
+
+## Offline asset loading
+
+The SDK does not register a service worker or control application updates. A
+PWA should include `index.js`, `protocol.js`, `worker.js`, `wasm/reddb_wasm.js` and
+`wasm/reddb_wasm_bg.wasm` from `src/` in its own versioned application cache,
+along with its application shell. Those assets must remain available together
+after installation. A locally packaged host can serve the same assets locally.
+HTTPS or a trusted localhost context is required for OPFS and Web Locks.
+
+The browser suite includes a test host's service worker and restarts the entire
+browser with networking disabled. It reloads the JS/worker/WASM assets, recovers
+OPFS data, writes again and executes a scalar query without reaching the HTTP
+host. This verifies the current artifact/scalar surface offline; storage-backed
+queries and application transactions still require the engine work below.
+
+## Shared transaction state
+
+The canonical native MVCC snapshot manager, visibility predicate, serializable
+read/write conflict tracking and per-connection transaction state now live in
+`reddb-engine::transaction`. The server uses the same types and algorithms.
+Native/WASM fixtures cover snapshot versus read-committed reads, aborted writers,
+savepoint sub-XIDs, failed commit preparation, publication-guard lifetime,
+retained vacuum horizons, checkpoint exclusions, unique-key reservations and
+serializable row/vault predicates with tenant separation. On Chromium/Firefox,
+the test host also caches this separate conformance artifact and reruns the suite
+after a full offline browser restart with the HTTP listener stopped.
+
+These are volatile engine assertions in a test-only WASM artifact. They do not
+expose transactions through the JS/TS SDK or qualify durable browser transaction
+recovery. Storage-backed dispatch, write conflict validation, WAL publication and
+recovery still require the runtime integration below.
+
+## Shared entities and read visibility
+
+The native `UnifiedEntity` model (rows/documents, graph, vectors, time series,
+queues and auxiliary references/embeddings) now lives in
+`reddb-engine::storage::entity`. Native paths re-export those same types.
+Entity timestamps retain Unix **seconds**; WASM obtains the host wall clock from
+`Date.now`, while query timing continues to use the monotonic performance clock.
+The browser test worker independently checks entity/embedding/reference timestamps
+against JS time, including after the offline restart.
+
+`SnapshotContext`, own/aborted subtransaction visibility, logical-ID SSI read
+tracking and table-row version selection are also shared. The native store
+supplies candidates through `TableRowVersionStore`; its existing dispatch,
+auth/tenant/moderation gates and statement-frame lifetime remain in the host.
+Native persisted-row tests cover both dump and paged reopen through the shared
+entity/visibility selector. Six new native/WASM cases exercise the representation
+and read rules, repeated offline on Chromium/Firefox. They use in-memory fixtures
+in WASM, not browser-persisted collections.
+
+Native value tags, checked decoding and Zstd compression now have one owner in
+`reddb-file::native_value`; the logical entity adapter lives in
+`reddb-engine::storage::entity_codec`. Native dump, paged-record and WAL paths
+use that same adapter. A frozen corpus produced by the original native writer
+checks all store versions V1–V12 and all value variants, including exact integers,
+compressed text/blob values, document bodies, MVCC fields and auxiliary data.
+Four native/WASM conformance cases compare the original bytes and reject
+truncated values, invalid lengths/tags, inconsistent compressed lengths and
+excessive array nesting. Arrays use a checked cursor and an explicit decoding
+stack bounded by the existing JSON nesting limit. This is not a general
+browser memory-budget qualification.
+
+The OPFS tree fixture now imports eight encoded native entities, decodes and
+updates their sequence/timestamps in WASM, restarts the browser offline with the
+HTTP host stopped, and exports for native verification. It retains opaque
+metadata bytes without interpreting native metadata policy. A separate native
+dump test checks the complete entity corpus and actual native metadata. These
+remain test-only records without application collection schemas or transactional
+publication. Storage-backed execution and durable runtime transaction/WAL
+integration are still needed before JS/TS can query collections. No file bytes,
+format versions or public application APIs change.
+
+## Shared query records and materialization
+
+`reddb-engine::query::unified` now owns the native `UnifiedRecord`/`UnifiedResult`
+representation, interned system keys, matched graph records/paths and query
+statistics. Native module paths re-export the exact same types. Native stored
+graph nodes retain their conversion through `From<&StoredNode>`; their storage
+and graph executor remain native.
+
+`reddb-engine::query::records` owns the existing full/lean/projected/universal
+entity materializers, by value and by reference, including catalog-schema
+fallback, binary-document field promotion, managed timestamps, logical `rid`,
+KV/document capabilities, graph endpoints, typed time-series tags and identity
+hints. The native runtime calls these same functions. Representation does not
+supply authorization, tenancy, visibility, secret handling, catalog discovery or
+transaction publication; those policies remain with the caller/runtime.
+
+A frozen pre-extraction native oracle checks 112 results (eight paths over
+14 entity shapes), preserving existing differences between materialization
+paths. Six relocated native record-layout property tests and four shared
+native/WASM cases cover schema overwrite/overflow, projections, document bodies,
+typed tags, graph representation and identities. The offline OPFS fixture now
+materializes full/projected records from its persisted entities after restart
+and verifies their fields before native export. Native integration compares
+shared records with actual stored-data query results after dump and paged reopen.
+
+These are internal/test-only engine paths. The public JS/TS API still exposes
+artifact operations and storage-free scalar SELECTs; stored-data dispatch,
+durable runtime transactions/WAL and application collection catalogs remain
+unfinished. No file format, wire envelope or public browser API changes here.
+
+## Shared resident collection storage
+
+The growing/sealed segment, typed metadata, key/unique-key and physical graph
+candidate indexes, and resident payload accounting now live in
+`reddb-engine::storage`. Native paths re-export the same implementations. The
+native segment manager retains lifecycle, consolidation, explicit snapshot and
+moderation gates. Storage clocks use Unix seconds on both native and WASM hosts.
+Four shared conformance cases exercise all original record-oracle entity shapes,
+key-version lookup and raw mutation, bounded/cancelled scans, metadata and sealing;
+the browser worker repeats them after the existing offline restart.
+
+These are canonical resident storage operations, not durable application
+transactions. WAL publication, catalog dispatch and the application SDK still
+need integration before JS/TS can query and mutate persisted collections. The
+production artifact/scalar API and all file formats remain unchanged.
+
+## Shared snapshot recovery
+
+Native and WASM now use the same typed metadata/entity-record codecs and streaming
+V1–V12 dump reader. Recovery preserves empty collection registration, record
+metadata, cross-references and the optional V10+ catalog blob. The shared file
+layer verifies the checksum before any restore callback and lends the payload
+without copying the entire snapshot. Hosts must restore into private state and
+publish it only after successful recovery.
+
+Frozen pre-extraction native metadata bytes and entity fixtures check compatible
+encoding and decoding. Shared native/WASM cases also cover truncated metadata,
+invalid counts/tags/UTF-8, nesting at the RQL depth limit, checksum failures,
+legacy optional tails and host callback errors. Metadata nesting above the existing
+RQL JSON limit is now rejected; previously the native metadata reader was unbounded.
+The native host retains collection/index restoration, ID allocation and WAL policy.
+These internal recovery primitives do not yet expose stored-data queries or
+application transactions through the browser SDK.
+
+## Remaining work toward the approved Browser design
+
+1. Extract the remaining storage-coupled executor/runtime into the shared portable engine and
+   preserve native query/transaction semantics for tables, documents, KV, graph
+   and vectors. Port clocks, crypto randomness and task scheduling.
+2. Build the application-facing SDK, local transaction/outbox atomicity, change
+   observation, and one-owner request forwarding between tabs.
+3. Implement versioned, policy-filtered snapshot and resumable change protocols
+   in `reddb-wire` and the server. Revalidate normal authorization/RLS on upload;
+   preserve transaction grouping, idempotency, stable graph references and deletes.
+4. Add explicit conflict resolution, expired-cursor rebootstrap without losing
+   pending intent, identity separation, offline assets and the storage-status UI.
+5. Validate two-device sync and engine conformance, Safari/iOS on real devices,
+   quota/failure cases, bundle size, startup, memory and query performance.

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@reddb-io/browser",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.1",
+  "private": false,
+  "type": "module",
+  "description": "Experimental RedDB browser persistence and shared scalar execution; stored-data queries and sync remain pending.",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./worker": "./src/worker.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "test": "node scripts/build-test.mjs && node --test test/runtime.test.mjs test/browser.test.mjs",
+    "prepack": "node scripts/verify-dist.mjs",
+    "test:distribution": "node --test test/distribution.test.mjs",
+    "build:interop": "node scripts/build-interop.mjs",
+    "test:interop": "node --test test/interop.test.mjs"
+  },
+  "devDependencies": {
+    "playwright": "1.61.1",
+    "vite": "8.3.5",
+    "typescript": "7.0.2"
+  },
+  "license": "BUSL-1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/reddb-io/reddb.git",
+    "directory": "packages/browser"
+  },
+  "homepage": "https://github.com/reddb-io/reddb/tree/main/packages/browser",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/",
+    "scripts/verify-dist.mjs",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "experimental"
+  }
+}

package/scripts/verify-dist.mjs

@@ -0,0 +1,12 @@
+import { readFileSync } from 'node:fs'
+import { dirname, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const directory = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+for (const path of ['src/index.js', 'src/index.d.ts', 'src/protocol.js', 'src/worker.js', 'src/wasm/reddb_wasm.js', 'LICENSE']) {
+  if (!readFileSync(resolve(directory, path)).length) throw new Error(`Missing browser distribution file: ${path}`)
+}
+const wasm = readFileSync(resolve(directory, 'src/wasm/reddb_wasm_bg.wasm'))
+if (wasm.length < 8 || !wasm.subarray(0, 8).equals(Buffer.from([0, 97, 115, 109, 1, 0, 0, 0]))) {
+  throw new Error('Build the browser WASM before packing: pnpm --filter @reddb-io/browser build')
+}

package/src/index.d.ts

@@ -0,0 +1,63 @@
+/** Experimental persistence and scalar execution; stored-data queries and sync remain pending. */
+export class BrowserError extends Error {
+  readonly code: string
+  constructor(code: string, message: string)
+}
+
+export interface RuntimeInfo {
+  readonly abiVersion: 1
+  readonly valueEncoding: 'reddb-json-v1'
+  readonly capabilities: {
+    readonly queryValidation: boolean
+    readonly scalarQueries: boolean
+    readonly storedQueries: boolean
+    readonly transactions: boolean
+    readonly sync: boolean
+  }
+}
+
+export interface Runtime {
+  /** Compiled engine capabilities; does not imply OPFS availability on this host. */
+  info(): Promise<RuntimeInfo>
+  /** Parse with the canonical RQL front-end; does not execute the statement. */
+  validateQuery(sql: string): Promise<void>
+  /** Storage-free scalar SELECT only; does not read or mutate the artifact. */
+  executeScalar(sql: string): Promise<{ columns: string[]; rows: unknown[][] }>
+  /** Terminate the storage-independent worker, rejecting pending operations. */
+  close(): Promise<void>
+}
+
+export type InteropResult =
+  | { ok: true; result: unknown }
+  | { ok: false; error: { code: string; message: string } }
+
+export interface RuntimeBridge {
+  /** info, validateQuery or executeScalar. Failures resolve as structured envelopes. */
+  invoke(method: string, params?: Record<string, unknown>): Promise<InteropResult>
+  /** Synchronous, idempotent cancellation, including during initialization. */
+  close(): void
+}
+
+/** No OPFS or Web Locks required; scalar execution only. */
+export function createRuntime(options?: { worker?: Worker }): Promise<Runtime>
+/** JSON-safe adapter boundary; does not expose artifact mutation or stored-data queries. */
+export function createInteropRuntime(options?: { worker?: Worker }): RuntimeBridge
+
+export interface Artifact extends Runtime {
+  generation(): Promise<string>
+  readWal(): Promise<Uint8Array[]>
+  readSnapshot(): Promise<Uint8Array | undefined>
+  /** Low-level native WAL payloads, not SQL commands. */
+  append(payloads: Uint8Array[]): Promise<void>
+  /** Complete native store snapshot; the caller must fold in the committed WAL. */
+  checkpoint(snapshot: Uint8Array, minWalBytes?: number): Promise<void>
+  /** Flush/close through the owner before terminating the worker. */
+  close(): Promise<void>
+}
+
+/** Open/create an exclusively owned OPFS .rdb file. Another owner returns FILE_BUSY. */
+export function openArtifact(options: {
+  name: string
+  /** Fresh module Worker supplied by a bundler (e.g. Vite ?worker). The artifact owns its lifetime. */
+  worker?: Worker
+}): Promise<Artifact>