@yydb/light-db 0.0.12 → 0.0.15

package/package.json

@@ -1,18 +1,23 @@
 {
-  "name": "@yydb/light-db",
-  "version": "0.0.12",
+  "author": "YYDB Contributors",
+  "bugs": {
+    "url": "https://github.com/yy-database/yydb.rs/issues"
+  },
+  "dependencies": {
+    "@voml/vos": "^0.0.1",
+    "@yydb/yydb-unknown-wasm32": "0.0.15"
+  },
   "description": "Light DB — browser-native YYDB database written in pure TypeScript",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/node": "^20.19.43",
+    "playwright-core": "^1.64.1",
+    "tsx": "^4.23.15",
+    "typescript": "^5.3.0"
+  },
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc",
-    "typecheck": "tsc --noEmit",
-    "test": "tsx tests/index.ts",
-    "test:browser": "tsx tests/browser/run.ts"
-  },
+  "homepage": "https://github.com/yy-database/yydb.rs/tree/dev/projects/packages/light-db#readme",
   "keywords": [
     "yydb",
     "light-db",
@@ -23,27 +28,22 @@
     "typescript"
   ],
   "license": "MPL-2.0",
-  "author": "YYDB Contributors",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yy-database/yydb.git",
-    "directory": "projects/packages/light-db"
-  },
-  "homepage": "https://github.com/yy-database/yydb/tree/dev/projects/packages/light-db#readme",
-  "bugs": {
-    "url": "https://github.com/yy-database/yydb/issues"
-  },
+  "main": "dist/index.js",
+  "name": "@yydb/light-db",
   "publishConfig": {
     "access": "public"
   },
-  "devDependencies": {
-    "@types/node": "^20.19.43",
-    "playwright-core": "^1.64.1",
-    "tsx": "^4.23.15",
-    "typescript": "^5.3.0"
+  "repository": {
+    "directory": "projects/packages/light-db",
+    "type": "git",
+    "url": "git+https://github.com/yy-database/yydb.rs.git"
   },
-  "dependencies": {
-    "@voml/vos": "^0.0.1",
-    "@yydb/yydb-unknown-wasm32": "workspace:*"
-  }
+  "scripts": {
+    "build": "tsc",
+    "test": "tsx tests/index.ts",
+    "test:browser": "tsx tests/browser/run.ts",
+    "typecheck": "tsc --noEmit"
+  },
+  "types": "dist/index.d.ts",
+  "version": "0.0.15"
 }

package/readme.md

@@ -1,110 +1,110 @@
-# `@yydb/light-db`
-
-**Light DB** is the browser edition of YYDB: a database written in pure TypeScript that stores `.yydb`-style
-snapshots, WAL records and checkpoints in browser storage. It has no Node built-ins, no N-API bindings and no WASM in
-its runtime path.
-
-## Product relationship
-
-| Package | Role |
-|---------|------|
-| `@yydb/yydb` | Node product: native Rust engine, N-API, local `.yydb` / `.yydx` files and CLI |
-| `@yydb/light-db` | Browser product: pure TypeScript, OPFS / IndexedDB storage, Web APIs, same author surface |
-| `@yydb/yydb-client` | Remote wire client for a running `yydb serve` |
-
-## Status
-
-Light DB is a migration of the original `LightDB.ts` engine, rebuilt around a browser-native architecture. The package
-ships as a pre-1.0 release of the browser product, so the author surface may still change between patch releases.
-
-Current coverage:
-
-- `pnpm test` runs the Node-side runner over codec, adapter and database logic (29 cases).
-- `pnpm test:browser` runs the conformance suite in an installed Chrome (16 cases): OPFS persistence across reopen, WAL
-  recovery, checkpoint truncation, corruption detection, single-writer exclusion, transaction rollback and commit,
-  schema and close notifications, and two-tab lease and broadcast behaviour.
-
-## Usage
-
-```ts
-import { LightDbError, openLightDatabase } from '@yydb/light-db';
-
-const db = await openLightDatabase('app');
-
-await db.ensureSchema('// @yydb-schema-version: 1\nkv users');
-await db.put('user:1', new TextEncoder().encode('Ada'));
-
-const value = await db.get('user:1');
-await db.checkpoint();
-await db.close();
-```
-
-Public data types are browser-native: keys and values use `Uint8Array`, databases are addressed by name rather than by
-file path, and every lifecycle call is asynchronous.
-
-## Author surface
-
-```ts
-const db: LightDatabase = await openLightDatabase('app', options);
-
-await db.schema();
-await db.ensureSchema(document);
-await db.get(key);
-await db.put(key, value);
-await db.delete(key);
-await db.begin();
-await db.commit();
-await db.rollback();
-await db.checkpoint();
-db.stats();
-await db.close();
-```
-
-`schema()` returns the persisted schema version and document. The document is the single source of truth: a second
-`ensureSchema` call must pass the identical document, otherwise it fails with `yydb.schema.conflict`. Keys starting with
-`__yydb__/` are reserved for the database.
-
-## Storage backends
-
-| Adapter | Use |
-|---------|-----|
-| `OpfsStorageAdapterFactory` | Default. Origin Private File System, positional reads and writes, atomic snapshot publication |
-| `IndexedDbStorageAdapterFactory` | Compatibility backend for hosts without OPFS |
-| `MemoryStorageBackend` | Tests and throwaway sessions |
-
-`StorageAdapter` is the only platform boundary. Transactions, recovery and checkpoint semantics live in `core`, so
-backends implement files, not database behaviour.
-
-## Concurrency
-
-A writer holds a session-scoped `Web Locks` lease. A second tab that opens the same database fails with
-`yydb.lease.unavailable` and `retryable: true` instead of silently writing alongside the first one. When a lock manager
-is missing the call fails the same way; it never degrades to multiple writers.
-
-`BroadcastChannel` carries `commit`, `schema` and `close` events so other same-origin contexts can discard stale views
-and retry after the lease is released. `listenDatabaseEvents(name, handler)` subscribes without opening the database.
-
-## Layout
-
-| Path | Role |
-|------|------|
-| `src/api/` | Public database, transaction, schema and shared types |
-| `src/core/` | Records, WAL, checkpoint, recovery, writer lease and broadcast |
-| `src/storage/` | `StorageAdapter` plus OPFS, IndexedDB and memory backends |
-| `src/codec/` | Page, snapshot and WAL record encoding over `Uint8Array` |
-| `src/errors/` | Stable `yydb.*` error codes |
-
-## Errors
-
-| Code | Meaning |
-|------|---------|
-| `yydb.io` | Storage operation failed |
-| `yydb.corrupt` | Persisted bytes failed validation |
-| `yydb.schema.conflict` | Schema document differs from the stored one |
-| `yydb.schema.invalid` | Schema document is not usable |
-| `yydb.unsupported` | Host or operation is not supported |
-| `yydb.session.closed` | Database or handle is closed |
-| `yydb.lease.unavailable` | Writer lease is held elsewhere or Web Locks is missing (retryable) |
-| `yydb.quota.exceeded` | Browser storage quota is exhausted |
-
-[YYDB overview](https://github.com/yy-database/yydb.rs)
+# `@yydb/light-db`
+
+**Light DB** is the browser edition of YYDB: a database written in pure TypeScript that stores `.yydb`-style
+snapshots, WAL records and checkpoints in browser storage. It has no Node built-ins, no N-API bindings and no WASM in
+its runtime path.
+
+## Product relationship
+
+| Package | Role |
+|---------|------|
+| `@yydb/yydb` | Node product: native Rust engine, N-API, local `.yydb` / `.yydx` files and CLI |
+| `@yydb/light-db` | Browser product: pure TypeScript, OPFS / IndexedDB storage, Web APIs, same author surface |
+| `@yydb/yydb-client` | Remote wire client for a running `yydb serve` |
+
+## Status
+
+Light DB is a migration of the original `LightDB.ts` engine, rebuilt around a browser-native architecture. The package
+ships as a pre-1.0 release of the browser product, so the author surface may still change between patch releases.
+
+Current coverage:
+
+- `pnpm test` runs the Node-side runner over codec, adapter and database logic (29 cases).
+- `pnpm test:browser` runs the conformance suite in an installed Chrome (16 cases): OPFS persistence across reopen, WAL
+  recovery, checkpoint truncation, corruption detection, single-writer exclusion, transaction rollback and commit,
+  schema and close notifications, and two-tab lease and broadcast behaviour.
+
+## Usage
+
+```ts
+import { LightDbError, openLightDatabase } from '@yydb/light-db';
+
+const db = await openLightDatabase('app');
+
+await db.ensureSchema('// @yydb-schema-version: 1\nkv users');
+await db.put('user:1', new TextEncoder().encode('Ada'));
+
+const value = await db.get('user:1');
+await db.checkpoint();
+await db.close();
+```
+
+Public data types are browser-native: keys and values use `Uint8Array`, databases are addressed by name rather than by
+file path, and every lifecycle call is asynchronous.
+
+## Author surface
+
+```ts
+const db: LightDatabase = await openLightDatabase('app', options);
+
+await db.schema();
+await db.ensureSchema(document);
+await db.get(key);
+await db.put(key, value);
+await db.delete(key);
+await db.begin();
+await db.commit();
+await db.rollback();
+await db.checkpoint();
+db.stats();
+await db.close();
+```
+
+`schema()` returns the persisted schema version and document. The document is the single source of truth: a second
+`ensureSchema` call must pass the identical document, otherwise it fails with `yydb.schema.conflict`. Keys starting with
+`__yydb__/` are reserved for the database.
+
+## Storage backends
+
+| Adapter | Use |
+|---------|-----|
+| `OpfsStorageAdapterFactory` | Default. Origin Private File System, positional reads and writes, atomic snapshot publication |
+| `IndexedDbStorageAdapterFactory` | Compatibility backend for hosts without OPFS |
+| `MemoryStorageBackend` | Tests and throwaway sessions |
+
+`StorageAdapter` is the only platform boundary. Transactions, recovery and checkpoint semantics live in `core`, so
+backends implement files, not database behaviour.
+
+## Concurrency
+
+A writer holds a session-scoped `Web Locks` lease. A second tab that opens the same database fails with
+`yydb.lease.unavailable` and `retryable: true` instead of silently writing alongside the first one. When a lock manager
+is missing the call fails the same way; it never degrades to multiple writers.
+
+`BroadcastChannel` carries `commit`, `schema` and `close` events so other same-origin contexts can discard stale views
+and retry after the lease is released. `listenDatabaseEvents(name, handler)` subscribes without opening the database.
+
+## Layout
+
+| Path | Role |
+|------|------|
+| `src/api/` | Public database, transaction, schema and shared types |
+| `src/core/` | Records, WAL, checkpoint, recovery, writer lease and broadcast |
+| `src/storage/` | `StorageAdapter` plus OPFS, IndexedDB and memory backends |
+| `src/codec/` | Page, snapshot and WAL record encoding over `Uint8Array` |
+| `src/errors/` | Stable `yydb.*` error codes |
+
+## Errors
+
+| Code | Meaning |
+|------|---------|
+| `yydb.io` | Storage operation failed |
+| `yydb.corrupt` | Persisted bytes failed validation |
+| `yydb.schema.conflict` | Schema document differs from the stored one |
+| `yydb.schema.invalid` | Schema document is not usable |
+| `yydb.unsupported` | Host or operation is not supported |
+| `yydb.session.closed` | Database or handle is closed |
+| `yydb.lease.unavailable` | Writer lease is held elsewhere or Web Locks is missing (retryable) |
+| `yydb.quota.exceeded` | Browser storage quota is exhausted |
+
+[YYDB overview](https://github.com/yy-database/yydb.rs)