web-idb-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sergey Azarov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,230 @@
+# IndexedDbClient
+
+Typed IndexedDB client for the **browser** (`web-idb-client`) with a Prisma-like store API, schema-in-TypeScript factories, and explicit migrations.
+
+> 🇷🇺 [Читать на русском языке](README_RU.md)
+
+## Features
+
+- Schema via `defineStore` / `field.*` — `InferSelect` / `InferInsert` without codegen
+- Store API: `insert`, `find`, `findMany`, `findUnique`, `update`, `delete`, `count`, `clear`
+- Index-only `where` (equality + ranges) and `orderBy` / `take` / `skip`
+- Multi-store `transaction('r' | 'rw', stores, fn)`
+- Versioned `open` with schema diff + optional `upgrade` hooks
+- Opt-in [`liveQuery`](docs/liveQuery.md) plugin for same/cross-tab UI invalidation
+
+## When to use / When not to use
+
+**Use this library** when you need a typed, Prisma-shaped API over real IndexedDB in the **browser** — typically for **private or corporate web** apps: internal SPAs, account cabinets, form drafts, client-side caches, multi-step wizards with local state. Such cases exist, but they are **relatively uncommon**; pick this library deliberately, not as a default “better localStorage”.
+
+**Do not use this library** when you need:
+
+- **Mobile / React Native** as the primary platform — use mature options there (e.g. WatermelonDB, RxDB)
+- **Offline-first sync / replication** across devices — that is a different product category (e.g. RxDB)
+- A battle-tested IndexedDB ecosystem with plugins, liveQuery, and years of production hardening — prefer **Dexie**
+- A minimal get/put/cursor wrapper with no ORM surface — prefer **idb**
+- SQL in the browser (WASM SQLite/Postgres) — prefer Drizzle/Kysely-style stacks
+
+**Platform:** browser IndexedDB only. Not aimed at Node (unless you polyfill IndexedDB) and **not** planned as a mobile SDK.
+
+## Installation
+
+```bash
+npm install web-idb-client
+```
+
+## Quick start
+
+```typescript
+import {
+  createClient,
+  defineStore,
+  field,
+  type InferSelect,
+} from 'web-idb-client';
+
+const tasks = defineStore('tasks', {
+  id: field.number().primaryKey({ autoIncrement: true }),
+  name: field.string().index('byName'),
+  isDone: field.boolean().index('byDone'),
+  createdAt: field.date().index('byCreatedAt'),
+});
+
+type Task = InferSelect<typeof tasks>;
+
+const db = createClient({
+  name: 'myApp',
+  version: 1,
+  stores: { tasks },
+});
+
+await db.open();
+
+const id = await db.tasks.insert({
+  name: 'Learn IndexedDB',
+  isDone: false,
+  createdAt: new Date(),
+});
+
+const task: Task | null = await db.tasks.find({ where: { id } });
+
+const byName = await db.tasks.findMany({
+  where: { name: 'Learn IndexedDB' },
+});
+
+const newest = await db.tasks.findMany({
+  orderBy: { createdAt: 'desc' },
+  take: 10,
+});
+
+await db.tasks.update({
+  where: { id },
+  data: { isDone: true },
+});
+
+await db.transaction('rw', ['tasks'], async (tx) => {
+  await tx.tasks.insert({
+    name: 'In a transaction',
+    isDone: false,
+    createdAt: new Date(),
+  });
+});
+```
+
+## Schema
+
+```typescript
+import { defineStore, compoundIndex, field } from 'web-idb-client';
+
+const tasks = defineStore(
+  'tasks',
+  {
+    id: field.number().primaryKey({ autoIncrement: true }),
+    title: field.string(),
+    status: field.string().index('byStatus'),
+    tags: field.array(field.string()).multiEntry('byTags'),
+    userId: field.string(),
+    dueAt: field.date().optional(),
+  },
+  () => [compoundIndex('byUserDue', ['userId', 'dueAt'])],
+);
+```
+
+Field helpers: `field.string`, `field.number`, `field.boolean`, `field.date`, `field.json`, `field.array`.  
+Chain: `.optional()`, `.primaryKey({ autoIncrement? })`, `.ref(store)`, `.index(name)`, `.uniqueIndex(name)`, `.multiEntry(name)`.
+
+Only PK and fields with `.index()` / `.uniqueIndex()` / `.multiEntry()` / `compoundIndex()` become IndexedDB indexes. Other fields are typed for insert/select only.
+
+FK fields: prefer `.ref(users).index('byUserId')` (or `.ref('users')`) then `loadMany` / `loadOne`; relation endpoints via `end(users, 'id')` — see [docs/relations.md](docs/relations.md). There is **no** Prisma-style `include`.
+
+### Boolean fields and indexes
+
+IndexedDB keys **cannot** be `true` / `false`. For every `field.boolean()` (indexed or not) the client:
+
+- accepts and returns **`boolean`** in the TypeScript API (`insert`, `where`, `findMany`, …);
+- stores **`0 | 1`** in the object store so indexes like `.index('byDone')` work.
+
+**In DevTools / Application → IndexedDB you will see numbers (`0` / `1`), not booleans.** The app still gets `boolean`. Legacy rows that already contain `true`/`false` are decoded on read; rewrite them to `0|1` on upgrade if you add a boolean index later.
+
+## Store methods
+
+| Method | Returns | Notes |
+| --- | --- | --- |
+| `insert(data)` | `IDBValidKey` | `add`; autoIncrement PK optional on insert |
+| `insertMany(data[])` | `IDBValidKey[]` | Sequential adds on one store tx |
+| `find({ where, orderBy? })` | `T \| null` | First match (Prisma `findFirst` style) |
+| `findMany({ where?, orderBy?, take?, skip?, sortInMemory? })` | `T[]` | List |
+| `findUnique({ where })` | `T \| null` | PK or unique index only |
+| `update({ where, data })` / `updateMany` | `number` | Rows modified |
+| `delete({ where })` / `deleteMany` | `number` | Rows deleted |
+| `count({ where? })` | `number` | |
+| `clear()` | `void` | Clears the store |
+
+`where` must target the primary key or a declared index (field name or index name).
+
+Range operators (map to `IDBKeyRange`): `equals`, `gt` / `gte` / `lt` / `lte`, aliases `above` / `aboveOrEqual` / `below` / `belowOrEqual`, `startsWith` (string prefix), `between: [lo, hi]` (optional open flags).
+
+Compound indexes:
+
+```typescript
+// exact key
+where: { byUserDue: [userId, dueAt] }
+// exact prefix + range on the last part only
+where: { byUserDue: [userId, { gte: dueAt }] }
+// or object form matching the compound keyPath fields
+where: { userId, dueAt: { between: [a, b] } }
+```
+
+If `where` and `orderBy` use different indexes, pass `sortInMemory: true` (fetches the `where` set, then sorts in JS — can be expensive). Otherwise the client throws `QUERY_INVALID`.
+
+Bulk helpers: `insertMany`, `updateMany`, `deleteMany` (the last two are aliases of multi-row `update` / `delete`).
+
+## Client methods
+
+| Method | Notes |
+| --- | --- |
+| `open()` / `init()` | Opens DB; creates/upgrades stores & indexes |
+| `close()` | Closes connection |
+| `deleteDatabase()` | Deletes the whole DB |
+| `transaction(mode, storeNames, fn)` | `mode`: `'r'` \| `'rw'`; `fn` receives typed stores on one `IDBTransaction` |
+
+Also available: `new IndexedDbClient({ name, version, stores })` (same config as `createClient`).
+
+Upgrade hooks (keyed by target version):
+
+```typescript
+const db = createClient({
+  name: 'myApp',
+  version: 2,
+  stores: { tasks },
+  upgrade: {
+    2: (tx) => {
+      // data transforms during versionchange on `tx`
+    },
+  },
+});
+```
+
+Changing a store `keyPath` in place is rejected with `SCHEMA_MISMATCH` unless you recreate the store in an upgrade hook via `copyStoreAndDrop` — see [docs/upgrades.md](docs/upgrades.md).
+
+## Errors
+
+Thrown as `IndexedDbError` with `code`: `NOT_OPEN`, `SCHEMA_INVALID`, `SCHEMA_MISMATCH`, `QUERY_INVALID`, `TRANSACTION_FAILED`, `OPEN_FAILED`, `BLOCKED`.  
+Optional context fields: `store`, `index`, `field` (also appended to `message`).
+
+```typescript
+const db = createClient({
+  name: 'myApp',
+  version: 1,
+  stores: { tasks },
+  // Reject unknown keys on insert (helpful in corp TS codebases)
+  strictInsert: true,
+});
+```
+
+## Breaking changes from `@azarov-serge/indexed-db-client`
+
+- Install / import **`web-idb-client`** (this package)
+- Removed `from().select` / string-based config (`dbName`, `storageNames`, `storeNameToIndexes`)
+- Use `defineStore` + `createClient` / `new IndexedDbClient({ name, version, stores })`
+- Prefer `find` / `findMany` instead of `select`
+
+## Docs
+
+- [Upgrades / migrations](docs/upgrades.md) · [RU](docs/upgrades.ru.md)
+- [Relations (FK helpers)](docs/relations.md) · [RU](docs/relations.ru.md)
+- [liveQuery (opt-in)](docs/liveQuery.md) · [RU](docs/liveQuery.ru.md)
+- Internal notes: [API design (v2)](.docs/indexeddb-client-v2-api-design.md) · [ORM research](.docs/indexeddb-orm-research.md) · [PLAN](.docs/PLAN.md)
+
+## Examples
+
+- **UI demo:** [examples/todo](examples/todo) — Vite + Tailwind CSS  
+  Local: `npm run demo:dev` → open the URL Vite prints (base path `/indexed-db-client/`)  
+  Overview: [examples/README.md](examples/README.md)
+- **Relations demo:** [examples/relations](examples/relations) — users + tasks (`npm run relations:dev`)
+- **Upgrade recipes:** [docs/upgrades.md](docs/upgrades.md)
+- **Relations guide:** [docs/relations.md](docs/relations.md)
+
+## License
+
+MIT

package/dist/client/index.d.ts

@@ -0,0 +1,7 @@
+export { IndexedDbClient, createClient } from './indexed-db-client';
+export type { IndexedDbClientWithStores } from './indexed-db-client';
+export { Store } from './store';
+export type { StoreContextInterface } from './store';
+export { Transaction, toIndexedDbTransactionMode } from './transaction';
+export type { TransactionMode, TxStores } from './transaction';
+export type { MutationBatch, MutationListener, MutationOp, StoreMutationEvent, } from './mutations';

package/dist/client/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toIndexedDbTransactionMode = exports.Transaction = exports.Store = exports.createClient = exports.IndexedDbClient = void 0;
+var indexed_db_client_1 = require("./indexed-db-client");
+Object.defineProperty(exports, "IndexedDbClient", { enumerable: true, get: function () { return indexed_db_client_1.IndexedDbClient; } });
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return indexed_db_client_1.createClient; } });
+var store_1 = require("./store");
+Object.defineProperty(exports, "Store", { enumerable: true, get: function () { return store_1.Store; } });
+var transaction_1 = require("./transaction");
+Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return transaction_1.Transaction; } });
+Object.defineProperty(exports, "toIndexedDbTransactionMode", { enumerable: true, get: function () { return transaction_1.toIndexedDbTransactionMode; } });
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":";;;AAAA,yDAAoE;AAA3D,oHAAA,eAAe,OAAA;AAAE,iHAAA,YAAY,OAAA;AAEtC,iCAAgC;AAAvB,8FAAA,KAAK,OAAA;AAEd,6CAAwE;AAA/D,0GAAA,WAAW,OAAA;AAAE,yHAAA,0BAA0B,OAAA"}

package/dist/client/indexed-db-client.d.ts

@@ -0,0 +1,40 @@
+import type { DbConfigInterface, DbStoresInterface } from '../schema/types';
+import { Store } from './store';
+import { type TransactionMode, type TxStores } from './transaction';
+import type { MutationListener } from './mutations';
+type ClientStores<TStores extends DbStoresInterface> = {
+    [K in keyof TStores]: Store<TStores[K]>;
+};
+export declare class IndexedDbClient<TStores extends DbStoresInterface = DbStoresInterface> {
+    private readonly config;
+    private db;
+    private readonly _stores;
+    private readonly mutationListeners;
+    constructor(config: DbConfigInterface<TStores>);
+    /** Typed store accessors (also available as `db.<storeName>`). */
+    get stores(): ClientStores<TStores>;
+    get isOpen(): boolean;
+    get name(): string;
+    get version(): number;
+    /**
+     * Subscribe to store mutations (same-tab). Used by the liveQuery plugin;
+     * also useful for custom UI invalidation.
+     */
+    subscribeMutations(listener: MutationListener): () => void;
+    /** @internal Notify mutation listeners (and liveQuery / cross-tab bridges). */
+    emitMutations(stores: string[], remote?: boolean): void;
+    open(): Promise<this>;
+    /** Alias for open() for familiarity with v1 `init`. */
+    init(): Promise<this>;
+    close(): void;
+    deleteDatabase(): Promise<void>;
+    transaction<T>(mode: TransactionMode, storeNames: (keyof TStores & string)[], fn: (tx: TxStores<TStores>) => Promise<T> | T): Promise<T>;
+    private openDatabase;
+    private deleteDatabaseRequest;
+    private requireDb;
+    private requireStore;
+}
+export type IndexedDbClientWithStores<TStores extends DbStoresInterface> = IndexedDbClient<TStores> & ClientStores<TStores>;
+/** Construct a client with store properties typed on the instance. */
+export declare function createClient<TStores extends DbStoresInterface>(config: DbConfigInterface<TStores>): IndexedDbClientWithStores<TStores>;
+export {};

package/dist/client/indexed-db-client.js

@@ -0,0 +1,211 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = exports.IndexedDbClient = void 0;
+const define_db_1 = require("../schema/define-db");
+const upgrade_1 = require("../migrate/upgrade");
+const store_1 = require("./store");
+const transaction_1 = require("./transaction");
+const errors_1 = require("../errors");
+class IndexedDbClient {
+    constructor(config) {
+        this.db = null;
+        this.mutationListeners = new Set();
+        this.config = config;
+        const stores = {};
+        for (const key of Object.keys(config.stores)) {
+            const def = config.stores[key];
+            stores[key] = new store_1.Store(def, {
+                getObjectStore: (mode) => this.requireStore(def.name, mode),
+                strictInsert: Boolean(config.strictInsert),
+                onMutate: (event) => this.emitMutations([event.store]),
+            });
+        }
+        this._stores = stores;
+        // Expose stores as enumerable properties: db.tasks
+        for (const key of Object.keys(stores)) {
+            Object.defineProperty(this, key, {
+                get: () => this._stores[key],
+                enumerable: true,
+            });
+        }
+    }
+    /** Typed store accessors (also available as `db.<storeName>`). */
+    get stores() {
+        return this._stores;
+    }
+    get isOpen() {
+        return this.db !== null;
+    }
+    get name() {
+        return this.config.name;
+    }
+    get version() {
+        return this.config.version;
+    }
+    /**
+     * Subscribe to store mutations (same-tab). Used by the liveQuery plugin;
+     * also useful for custom UI invalidation.
+     */
+    subscribeMutations(listener) {
+        this.mutationListeners.add(listener);
+        return () => {
+            this.mutationListeners.delete(listener);
+        };
+    }
+    /** @internal Notify mutation listeners (and liveQuery / cross-tab bridges). */
+    emitMutations(stores, remote = false) {
+        const unique = [...new Set(stores.filter(Boolean))];
+        if (unique.length === 0 || this.mutationListeners.size === 0) {
+            return;
+        }
+        const batch = { stores: unique, remote };
+        for (const listener of this.mutationListeners) {
+            listener(batch);
+        }
+    }
+    open() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.db) {
+                return this;
+            }
+            const schema = (0, define_db_1.toDeclaredDbSchema)(this.config);
+            this.db = yield this.openDatabase(schema);
+            return this;
+        });
+    }
+    /** Alias for open() for familiarity with v1 `init`. */
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.open();
+        });
+    }
+    close() {
+        if (this.db) {
+            this.db.close();
+            this.db = null;
+        }
+    }
+    deleteDatabase() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.close();
+            yield this.deleteDatabaseRequest(this.config.name);
+        });
+    }
+    transaction(mode, storeNames, fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const db = this.requireDb();
+            if (storeNames.length === 0) {
+                throw new errors_1.IndexedDbError('QUERY_INVALID', 'transaction() requires at least one store');
+            }
+            const idbTx = db.transaction(storeNames, (0, transaction_1.toIndexedDbTransactionMode)(mode));
+            const pending = new Set();
+            const tx = new transaction_1.Transaction(idbTx, this.config.stores, storeNames, Boolean(this.config.strictInsert), (event) => {
+                pending.add(event.store);
+            });
+            try {
+                const result = yield fn(tx.stores);
+                yield tx.done();
+                if (pending.size > 0) {
+                    this.emitMutations([...pending]);
+                }
+                return result;
+            }
+            catch (error) {
+                try {
+                    idbTx.abort();
+                }
+                catch (_a) {
+                    // ignore
+                }
+                throw error;
+            }
+        });
+    }
+    openDatabase(schema) {
+        return new Promise((resolve, reject) => {
+            const request = indexedDB.open(schema.name, schema.version);
+            request.onblocked = () => {
+                reject(new errors_1.IndexedDbError('BLOCKED', `Opening database "${schema.name}" is blocked by another connection`));
+            };
+            request.onerror = () => {
+                var _a, _b;
+                reject(new errors_1.IndexedDbError('OPEN_FAILED', (_b = (_a = request.error) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : `Failed to open database "${schema.name}"`));
+            };
+            request.onupgradeneeded = (event) => {
+                var _a;
+                const db = request.result;
+                const tx = request.transaction;
+                if (!tx) {
+                    reject(new errors_1.IndexedDbError('OPEN_FAILED', 'Missing versionchange transaction during upgrade'));
+                    return;
+                }
+                try {
+                    (0, upgrade_1.applySchemaUpgrade)({
+                        db,
+                        tx,
+                        schema,
+                        oldVersion: event.oldVersion,
+                        newVersion: (_a = event.newVersion) !== null && _a !== void 0 ? _a : schema.version,
+                        upgradeHooks: this.config.upgrade,
+                    });
+                }
+                catch (error) {
+                    reject(error);
+                }
+            };
+            request.onsuccess = () => {
+                const db = request.result;
+                try {
+                    (0, upgrade_1.assertKeyPathsMatchSchema)(db, schema);
+                }
+                catch (error) {
+                    db.close();
+                    reject(error);
+                    return;
+                }
+                db.onversionchange = () => {
+                    db.close();
+                };
+                resolve(db);
+            };
+        });
+    }
+    deleteDatabaseRequest(name) {
+        return new Promise((resolve, reject) => {
+            const request = indexedDB.deleteDatabase(name);
+            request.onsuccess = () => resolve();
+            request.onerror = () => {
+                var _a, _b;
+                return reject(new errors_1.IndexedDbError('OPEN_FAILED', (_b = (_a = request.error) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : `Failed to delete database "${name}"`));
+            };
+            request.onblocked = () => reject(new errors_1.IndexedDbError('BLOCKED', `Deleting database "${name}" is blocked by another connection`));
+        });
+    }
+    requireDb() {
+        if (!this.db) {
+            throw new errors_1.IndexedDbError('NOT_OPEN', 'Database is not open. Call open() first.');
+        }
+        return this.db;
+    }
+    requireStore(name, mode) {
+        const db = this.requireDb();
+        const tx = db.transaction(name, mode);
+        return tx.objectStore(name);
+    }
+}
+exports.IndexedDbClient = IndexedDbClient;
+/** Construct a client with store properties typed on the instance. */
+function createClient(config) {
+    return new IndexedDbClient(config);
+}
+exports.createClient = createClient;
+//# sourceMappingURL=indexed-db-client.js.map

package/dist/client/indexed-db-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexed-db-client.js","sourceRoot":"","sources":["../../src/client/indexed-db-client.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,mDAAyD;AACzD,gDAAmF;AACnF,mCAAgC;AAChC,+CAKuB;AAEvB,sCAA2C;AAM3C,MAAa,eAAe;IAM1B,YAAY,MAAkC;QAJtC,OAAE,GAAuB,IAAI,CAAC;QAErB,sBAAiB,GAAG,IAAI,GAAG,EAAoB,CAAC;QAG/D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,MAAM,GAAG,EAA2B,CAAC;QAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAA+B,EAAE;YAC1E,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAmB,CAAC;YACjD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,aAAK,CAAC,GAAG,EAAE;gBAC3B,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC;gBAC3D,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC1C,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACvD,CAAsC,CAAC;SACzC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,mDAAmD;QACnD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAA+B,EAAE;YACnE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,EAAE;gBAC/B,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC5B,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;SACJ;IACH,CAAC;IAED,kEAAkE;IAClE,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC;IAC1B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,QAA0B;QAC3C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC,CAAC;IACJ,CAAC;IAED,+EAA+E;IAC/E,aAAa,CAAC,MAAgB,EAAE,MAAM,GAAG,KAAK;QAC5C,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,EAAE;YAC5D,OAAO;SACR;QACD,MAAM,KAAK,GAAkB,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACxD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC7C,QAAQ,CAAC,KAAK,CAAC,CAAC;SACjB;IACH,CAAC;IAEK,IAAI;;YACR,IAAI,IAAI,CAAC,EAAE,EAAE;gBACX,OAAO,IAAI,CAAC;aACb;YACD,MAAM,MAAM,GAAG,IAAA,8BAAkB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/C,IAAI,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAED,uDAAuD;IACjD,IAAI;;YACR,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC;KAAA;IAED,KAAK;QACH,IAAI,IAAI,CAAC,EAAE,EAAE;YACX,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;SAChB;IACH,CAAC;IAEK,cAAc;;YAClB,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;IAEK,WAAW,CACf,IAAqB,EACrB,UAAsC,EACtC,EAA6C;;YAE7C,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,MAAM,IAAI,uBAAc,CACtB,eAAe,EACf,2CAA2C,CAC5C,CAAC;aACH;YACD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,IAAA,wCAA0B,EAAC,IAAI,CAAC,CAAC,CAAC;YAC3E,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;YAClC,MAAM,EAAE,GAAG,IAAI,yBAAW,CACxB,KAAK,EACL,IAAI,CAAC,MAAM,CAAC,MAAM,EAClB,UAAU,EACV,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EACjC,CAAC,KAAK,EAAE,EAAE;gBACR,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC,CACF,CAAC;YACF,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;gBACnC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;gBAChB,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;oBACpB,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;iBAClC;gBACD,OAAO,MAAM,CAAC;aACf;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI;oBACF,KAAK,CAAC,KAAK,EAAE,CAAC;iBACf;gBAAC,WAAM;oBACN,SAAS;iBACV;gBACD,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAEO,YAAY,CAAC,MAA2B;QAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;YAE5D,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE;gBACvB,MAAM,CACJ,IAAI,uBAAc,CAChB,SAAS,EACT,qBAAqB,MAAM,CAAC,IAAI,oCAAoC,CACrE,CACF,CAAC;YACJ,CAAC,CAAC;YAEF,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE;;gBACrB,MAAM,CACJ,IAAI,uBAAc,CAChB,aAAa,EACb,MAAA,MAAA,OAAO,CAAC,KAAK,0CAAE,OAAO,mCAAI,4BAA4B,MAAM,CAAC,IAAI,GAAG,CACrE,CACF,CAAC;YACJ,CAAC,CAAC;YAEF,OAAO,CAAC,eAAe,GAAG,CAAC,KAAK,EAAE,EAAE;;gBAClC,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC1B,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC/B,IAAI,CAAC,EAAE,EAAE;oBACP,MAAM,CACJ,IAAI,uBAAc,CAChB,aAAa,EACb,kDAAkD,CACnD,CACF,CAAC;oBACF,OAAO;iBACR;gBAED,IAAI;oBACF,IAAA,4BAAkB,EAAC;wBACjB,EAAE;wBACF,EAAE;wBACF,MAAM;wBACN,UAAU,EAAE,KAAK,CAAC,UAAU;wBAC5B,UAAU,EAAE,MAAA,KAAK,CAAC,UAAU,mCAAI,MAAM,CAAC,OAAO;wBAC9C,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;qBAClC,CAAC,CAAC;iBACJ;gBAAC,OAAO,KAAK,EAAE;oBACd,MAAM,CAAC,KAAK,CAAC,CAAC;iBACf;YACH,CAAC,CAAC;YAEF,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE;gBACvB,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC1B,IAAI;oBACF,IAAA,mCAAyB,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC;iBACvC;gBAAC,OAAO,KAAK,EAAE;oBACd,EAAE,CAAC,KAAK,EAAE,CAAC;oBACX,MAAM,CAAC,KAAK,CAAC,CAAC;oBACd,OAAO;iBACR;gBACD,EAAE,CAAC,eAAe,GAAG,GAAG,EAAE;oBACxB,EAAE,CAAC,KAAK,EAAE,CAAC;gBACb,CAAC,CAAC;gBACF,OAAO,CAAC,EAAE,CAAC,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,qBAAqB,CAAC,IAAY;QACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;YACpC,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE;;gBACrB,OAAA,MAAM,CACJ,IAAI,uBAAc,CAChB,aAAa,EACb,MAAA,MAAA,OAAO,CAAC,KAAK,0CAAE,OAAO,mCAAI,8BAA8B,IAAI,GAAG,CAChE,CACF,CAAA;aAAA,CAAC;YACJ,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE,CACvB,MAAM,CACJ,IAAI,uBAAc,CAChB,SAAS,EACT,sBAAsB,IAAI,oCAAoC,CAC/D,CACF,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,uBAAc,CACtB,UAAU,EACV,0CAA0C,CAC3C,CAAC;SACH;QACD,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAEO,YAAY,CAAC,IAAY,EAAE,IAAwB;QACzD,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACtC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AA5OD,0CA4OC;AAKD,sEAAsE;AACtE,SAAgB,YAAY,CAC1B,MAAkC;IAElC,OAAO,IAAI,eAAe,CAAC,MAAM,CAAuC,CAAC;AAC3E,CAAC;AAJD,oCAIC"}

package/dist/client/mutations.d.ts

@@ -0,0 +1,12 @@
+export type MutationOp = 'insert' | 'insertMany' | 'update' | 'delete' | 'clear';
+export interface StoreMutationEvent {
+    store: string;
+    op: MutationOp;
+}
+/** One or more store mutations (coalesced for multi-store transactions). */
+export interface MutationBatch {
+    stores: string[];
+    /** True when the batch came from another browser tab. */
+    remote?: boolean;
+}
+export type MutationListener = (batch: MutationBatch) => void;

package/dist/client/mutations.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mutations.js.map

package/dist/client/mutations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.js","sourceRoot":"","sources":["../../src/client/mutations.ts"],"names":[],"mappings":""}

package/dist/client/store.d.ts

@@ -0,0 +1,42 @@
+import type { StoreInterface } from '../schema/types';
+import type { CountParamsInterface, DeleteParamsInterface, FindManyParamsInterface, FindParamsInterface, InferInsert, InferSelect, UniqueWhereInputInterface, UpdateParamsInterface } from '../schema/infer';
+import type { StoreMutationEvent } from './mutations';
+export interface StoreContextInterface {
+    getObjectStore: (mode: IDBTransactionMode) => IDBObjectStore;
+    /** See DbConfigInterface.strictInsert */
+    strictInsert?: boolean;
+    /** Optional mutation hook (used by liveQuery plugin / tests). */
+    onMutate?: (event: StoreMutationEvent) => void;
+}
+export declare class Store<TStore extends StoreInterface> {
+    readonly def: TStore;
+    private readonly ctx;
+    constructor(def: TStore, ctx: StoreContextInterface);
+    get name(): string;
+    private encodeWhere;
+    private decodeRow;
+    private decodeRows;
+    private notify;
+    insert(data: InferInsert<TStore>): Promise<IDBValidKey>;
+    insertMany(data: InferInsert<TStore>[]): Promise<IDBValidKey[]>;
+    find(params: FindParamsInterface<TStore>): Promise<InferSelect<TStore> | null>;
+    findUnique(params: {
+        where: UniqueWhereInputInterface<TStore>;
+    }): Promise<InferSelect<TStore> | null>;
+    findMany(params?: FindManyParamsInterface<TStore>): Promise<InferSelect<TStore>[]>;
+    count(params?: CountParamsInterface<TStore>): Promise<number>;
+    update(params: UpdateParamsInterface<TStore>): Promise<number>;
+    /** Alias of `update` — updates all rows matching `where`. */
+    updateMany(params: UpdateParamsInterface<TStore>): Promise<number>;
+    delete(params: DeleteParamsInterface<TStore>): Promise<number>;
+    /** Alias of `delete` — deletes all rows matching `where`. */
+    deleteMany(params: DeleteParamsInterface<TStore>): Promise<number>;
+    clear(): Promise<void>;
+    /**
+     * Transform each record (typically inside an upgrade transaction).
+     * Return `null` to delete the record.
+     * Callback receives / returns app-level types (boolean, not 0|1).
+     */
+    migrate(map: (row: InferSelect<TStore>) => InferSelect<TStore> | null | Promise<InferSelect<TStore> | null>): Promise<void>;
+    private collectWithCursor;
+}