@tanstack/browser-db-sqlite-persistence 0.2.23 → 0.2.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +75 -1
  2. package/dist/assets/{opfs-worker-uyjx5Rus.js → opfs-worker-accoEoax.js} +17 -6
  3. package/dist/assets/{opfs-worker-uyjx5Rus.js.map → opfs-worker-accoEoax.js.map} +1 -1
  4. package/dist/cjs/browser-coordinator.cjs +5 -534
  5. package/dist/cjs/browser-coordinator.cjs.map +1 -1
  6. package/dist/cjs/browser-coordinator.d.cts +3 -65
  7. package/dist/cjs/browser-persistence.cjs +19 -8
  8. package/dist/cjs/browser-persistence.cjs.map +1 -1
  9. package/dist/cjs/index.cjs +16 -0
  10. package/dist/cjs/index.cjs.map +1 -1
  11. package/dist/cjs/index.d.cts +2 -2
  12. package/dist/cjs/opfs-database.cjs +58 -1
  13. package/dist/cjs/opfs-database.cjs.map +1 -1
  14. package/dist/cjs/opfs-database.d.cts +4 -0
  15. package/dist/cjs/opfs-worker.cjs +1 -1
  16. package/dist/cjs/wa-sqlite-driver.cjs +38 -14
  17. package/dist/cjs/wa-sqlite-driver.cjs.map +1 -1
  18. package/dist/cjs/wa-sqlite-driver.d.cts +3 -3
  19. package/dist/esm/browser-coordinator.d.ts +3 -65
  20. package/dist/esm/browser-coordinator.js +5 -534
  21. package/dist/esm/browser-coordinator.js.map +1 -1
  22. package/dist/esm/browser-persistence.js +19 -8
  23. package/dist/esm/browser-persistence.js.map +1 -1
  24. package/dist/esm/index.d.ts +2 -2
  25. package/dist/esm/index.js +5 -1
  26. package/dist/esm/opfs-database.d.ts +4 -0
  27. package/dist/esm/opfs-database.js +58 -1
  28. package/dist/esm/opfs-database.js.map +1 -1
  29. package/dist/esm/opfs-worker.js +1 -1
  30. package/dist/esm/wa-sqlite-driver.d.ts +3 -3
  31. package/dist/esm/wa-sqlite-driver.js +39 -15
  32. package/dist/esm/wa-sqlite-driver.js.map +1 -1
  33. package/package.json +9 -3
  34. package/src/browser-coordinator.ts +10 -834
  35. package/src/browser-persistence.ts +22 -14
  36. package/src/index.ts +9 -0
  37. package/src/opfs-database.ts +76 -1
  38. package/src/opfs-worker.ts +16 -5
  39. package/src/wa-sqlite-driver.ts +57 -15
  40. package/src/wa-sqlite-examples.d.ts +1 -0
@@ -1 +1 @@
1
- {"version":3,"file":"browser-persistence.js","sources":["../../src/browser-persistence.ts"],"sourcesContent":["import {\n DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,\n DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,\n SingleProcessCoordinator,\n createSQLiteCorePersistenceAdapter,\n} from '@tanstack/db-sqlite-persistence-core'\nimport { BrowserCollectionCoordinator } from './browser-coordinator'\nimport { BrowserWASQLiteDriver } from './wa-sqlite-driver'\nimport type {\n PersistedCollectionCoordinator,\n PersistedCollectionMode,\n PersistedCollectionPersistence,\n SQLiteCoreAdapterOptions,\n SQLiteDriver,\n} from '@tanstack/db-sqlite-persistence-core'\nimport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\n\nexport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\n\ntype BrowserSQLiteCoreSchemaMismatchPolicy =\n | `sync-present-reset`\n | `sync-absent-error`\n | `reset`\n\nexport type BrowserWASQLiteSchemaMismatchPolicy =\n | BrowserSQLiteCoreSchemaMismatchPolicy\n | `throw`\n\nexport type BrowserWASQLitePersistenceOptions = Omit<\n SQLiteCoreAdapterOptions,\n `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> & {\n database: BrowserWASQLiteDatabase\n coordinator?: PersistedCollectionCoordinator\n schemaMismatchPolicy?: BrowserWASQLiteSchemaMismatchPolicy\n}\n\nfunction normalizeSchemaMismatchPolicy(\n policy: BrowserWASQLiteSchemaMismatchPolicy,\n): BrowserSQLiteCoreSchemaMismatchPolicy {\n if (policy === `throw`) {\n return `sync-absent-error`\n }\n\n return policy\n}\n\nfunction resolveSchemaMismatchPolicy(\n explicitPolicy: BrowserWASQLiteSchemaMismatchPolicy | undefined,\n mode: PersistedCollectionMode,\n): BrowserSQLiteCoreSchemaMismatchPolicy {\n if (explicitPolicy) {\n return normalizeSchemaMismatchPolicy(explicitPolicy)\n }\n\n return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`\n}\n\nfunction createAdapterCacheKey(\n schemaMismatchPolicy: BrowserSQLiteCoreSchemaMismatchPolicy,\n schemaVersion: number | undefined,\n): string {\n const schemaVersionKey =\n schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`\n return `${schemaMismatchPolicy}|${schemaVersionKey}`\n}\n\nfunction createInternalSQLiteDriver(\n options: BrowserWASQLitePersistenceOptions,\n): SQLiteDriver {\n return new BrowserWASQLiteDriver({\n database: options.database,\n })\n}\n\nfunction resolveAdapterBaseOptions(\n options: BrowserWASQLitePersistenceOptions,\n): Omit<\n SQLiteCoreAdapterOptions,\n `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> {\n return {\n appliedTxPruneMaxRows:\n options.appliedTxPruneMaxRows ?? DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,\n appliedTxPruneMaxAgeSeconds:\n options.appliedTxPruneMaxAgeSeconds ??\n DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,\n pullSinceReloadThreshold: options.pullSinceReloadThreshold,\n }\n}\n\n/**\n * Creates a shared browser wa-sqlite persistence instance that can be reused by\n * many collections on the same database. This is single-tab wiring using\n * SingleProcessCoordinator semantics (no election required).\n */\nexport function createBrowserWASQLitePersistence(\n options: BrowserWASQLitePersistenceOptions,\n): PersistedCollectionPersistence {\n const { coordinator, schemaMismatchPolicy } = options\n const driver = createInternalSQLiteDriver(options)\n const adapterBaseOptions = resolveAdapterBaseOptions(options)\n const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()\n const adapterCache = new Map<\n string,\n ReturnType<typeof createSQLiteCorePersistenceAdapter>\n >()\n\n const getAdapterForCollection = (\n mode: PersistedCollectionMode,\n schemaVersion: number | undefined,\n ) => {\n const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(\n schemaMismatchPolicy,\n mode,\n )\n const cacheKey = createAdapterCacheKey(\n resolvedSchemaMismatchPolicy,\n schemaVersion,\n )\n const cachedAdapter = adapterCache.get(cacheKey)\n if (cachedAdapter) {\n return cachedAdapter\n }\n\n const adapter = createSQLiteCorePersistenceAdapter({\n ...adapterBaseOptions,\n driver,\n schemaMismatchPolicy: resolvedSchemaMismatchPolicy,\n ...(schemaVersion === undefined ? {} : { schemaVersion }),\n })\n adapterCache.set(cacheKey, adapter)\n\n // Wire the adapter into the multi-tab coordinator so it can handle\n // leader-side RPCs (applyCommittedTx, pullSince, ensureIndex, etc.)\n if (resolvedCoordinator instanceof BrowserCollectionCoordinator) {\n resolvedCoordinator.setAdapter(adapter)\n }\n\n return adapter\n }\n\n const createCollectionPersistence = (\n mode: PersistedCollectionMode,\n schemaVersion: number | undefined,\n ): PersistedCollectionPersistence => ({\n adapter: getAdapterForCollection(mode, schemaVersion),\n coordinator: resolvedCoordinator,\n })\n\n const defaultPersistence = createCollectionPersistence(\n `sync-absent`,\n undefined,\n )\n\n return {\n ...defaultPersistence,\n resolvePersistenceForCollection: ({ mode, schemaVersion }) =>\n createCollectionPersistence(mode, schemaVersion),\n resolvePersistenceForMode: (mode) =>\n createCollectionPersistence(mode, undefined),\n }\n}\n"],"names":[],"mappings":";;;AAqCA,SAAS,8BACP,QACuC;AACvC,MAAI,WAAW,SAAS;AACtB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEA,SAAS,4BACP,gBACA,MACuC;AACvC,MAAI,gBAAgB;AAClB,WAAO,8BAA8B,cAAc;AAAA,EACrD;AAEA,SAAO,SAAS,iBAAiB,uBAAuB;AAC1D;AAEA,SAAS,sBACP,sBACA,eACQ;AACR,QAAM,mBACJ,kBAAkB,SAAY,mBAAmB,UAAU,aAAa;AAC1E,SAAO,GAAG,oBAAoB,IAAI,gBAAgB;AACpD;AAEA,SAAS,2BACP,SACc;AACd,SAAO,IAAI,sBAAsB;AAAA,IAC/B,UAAU,QAAQ;AAAA,EAAA,CACnB;AACH;AAEA,SAAS,0BACP,SAIA;AACA,SAAO;AAAA,IACL,uBACE,QAAQ,yBAAyB;AAAA,IACnC,6BACE,QAAQ,+BACR;AAAA,IACF,0BAA0B,QAAQ;AAAA,EAAA;AAEtC;AAOO,SAAS,iCACd,SACgC;AAChC,QAAM,EAAE,aAAa,qBAAA,IAAyB;AAC9C,QAAM,SAAS,2BAA2B,OAAO;AACjD,QAAM,qBAAqB,0BAA0B,OAAO;AAC5D,QAAM,sBAAsB,eAAe,IAAI,yBAAA;AAC/C,QAAM,mCAAmB,IAAA;AAKzB,QAAM,0BAA0B,CAC9B,MACA,kBACG;AACH,UAAM,+BAA+B;AAAA,MACnC;AAAA,MACA;AAAA,IAAA;AAEF,UAAM,WAAW;AAAA,MACf;AAAA,MACA;AAAA,IAAA;AAEF,UAAM,gBAAgB,aAAa,IAAI,QAAQ;AAC/C,QAAI,eAAe;AACjB,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,mCAAmC;AAAA,MACjD,GAAG;AAAA,MACH;AAAA,MACA,sBAAsB;AAAA,MACtB,GAAI,kBAAkB,SAAY,CAAA,IAAK,EAAE,cAAA;AAAA,IAAc,CACxD;AACD,iBAAa,IAAI,UAAU,OAAO;AAIlC,QAAI,+BAA+B,8BAA8B;AAC/D,0BAAoB,WAAW,OAAO;AAAA,IACxC;AAEA,WAAO;AAAA,EACT;AAEA,QAAM,8BAA8B,CAClC,MACA,mBACoC;AAAA,IACpC,SAAS,wBAAwB,MAAM,aAAa;AAAA,IACpD,aAAa;AAAA,EAAA;AAGf,QAAM,qBAAqB;AAAA,IACzB;AAAA,IACA;AAAA,EAAA;AAGF,SAAO;AAAA,IACL,GAAG;AAAA,IACH,iCAAiC,CAAC,EAAE,MAAM,oBACxC,4BAA4B,MAAM,aAAa;AAAA,IACjD,2BAA2B,CAAC,SAC1B,4BAA4B,MAAM,MAAS;AAAA,EAAA;AAEjD;"}
1
+ {"version":3,"file":"browser-persistence.js","sources":["../../src/browser-persistence.ts"],"sourcesContent":["import {\n DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,\n DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,\n SingleProcessCoordinator,\n createSQLiteCorePersistenceAdapter,\n} from '@tanstack/db-sqlite-persistence-core'\nimport { BrowserCollectionCoordinator } from './browser-coordinator'\nimport { BrowserWASQLiteDriver } from './wa-sqlite-driver'\nimport type {\n PersistedCollectionCoordinator,\n PersistedCollectionMode,\n PersistedCollectionPersistence,\n SQLiteCoreAdapterOptions,\n SQLiteDriver,\n} from '@tanstack/db-sqlite-persistence-core'\nimport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\n\nexport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\n\ntype BrowserSQLiteCoreSchemaMismatchPolicy =\n | `sync-present-reset`\n | `sync-absent-error`\n | `reset`\n\nexport type BrowserWASQLiteSchemaMismatchPolicy =\n | BrowserSQLiteCoreSchemaMismatchPolicy\n | `throw`\n\nexport type BrowserWASQLitePersistenceOptions = Omit<\n SQLiteCoreAdapterOptions,\n `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> & {\n database: BrowserWASQLiteDatabase\n coordinator?: PersistedCollectionCoordinator\n schemaMismatchPolicy?: BrowserWASQLiteSchemaMismatchPolicy\n}\n\nfunction normalizeSchemaMismatchPolicy(\n policy: BrowserWASQLiteSchemaMismatchPolicy,\n): BrowserSQLiteCoreSchemaMismatchPolicy {\n if (policy === `throw`) {\n return `sync-absent-error`\n }\n\n return policy\n}\n\nfunction resolveSchemaMismatchPolicy(\n explicitPolicy: BrowserWASQLiteSchemaMismatchPolicy | undefined,\n mode: PersistedCollectionMode,\n): BrowserSQLiteCoreSchemaMismatchPolicy {\n if (explicitPolicy) {\n return normalizeSchemaMismatchPolicy(explicitPolicy)\n }\n\n return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`\n}\n\nfunction createAdapterCacheKey(\n schemaMismatchPolicy: BrowserSQLiteCoreSchemaMismatchPolicy,\n schemaVersion: number | undefined,\n): string {\n const schemaVersionKey =\n schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`\n return `${schemaMismatchPolicy}|${schemaVersionKey}`\n}\n\nfunction createInternalSQLiteDriver(\n options: BrowserWASQLitePersistenceOptions,\n): SQLiteDriver {\n return new BrowserWASQLiteDriver({\n database: options.database,\n })\n}\n\nfunction resolveAdapterBaseOptions(\n options: BrowserWASQLitePersistenceOptions,\n): Omit<\n SQLiteCoreAdapterOptions,\n `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> {\n return {\n appliedTxPruneMaxRows:\n options.appliedTxPruneMaxRows ?? DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,\n appliedTxPruneMaxAgeSeconds:\n options.appliedTxPruneMaxAgeSeconds ??\n DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,\n pullSinceReloadThreshold: options.pullSinceReloadThreshold,\n }\n}\n\n/**\n * Creates a shared browser wa-sqlite persistence instance that can be reused by\n * many collections on the same database. This is single-tab wiring using\n * SingleProcessCoordinator semantics (no election required).\n */\nexport function createBrowserWASQLitePersistence(\n options: BrowserWASQLitePersistenceOptions,\n): PersistedCollectionPersistence {\n const { coordinator, schemaMismatchPolicy } = options\n const driver = createInternalSQLiteDriver(options)\n const adapterBaseOptions = resolveAdapterBaseOptions(options)\n const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()\n const adapterCache = new Map<\n string,\n ReturnType<typeof createSQLiteCorePersistenceAdapter>\n >()\n\n const getAdapterForCollection = (\n mode: PersistedCollectionMode,\n schemaVersion: number | undefined,\n ) => {\n const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(\n schemaMismatchPolicy,\n mode,\n )\n const cacheKey = createAdapterCacheKey(\n resolvedSchemaMismatchPolicy,\n schemaVersion,\n )\n const cachedAdapter = adapterCache.get(cacheKey)\n if (cachedAdapter) {\n return cachedAdapter\n }\n\n const adapter = createSQLiteCorePersistenceAdapter({\n ...adapterBaseOptions,\n driver,\n schemaMismatchPolicy: resolvedSchemaMismatchPolicy,\n ...(schemaVersion === undefined ? {} : { schemaVersion }),\n })\n adapterCache.set(cacheKey, adapter)\n return adapter\n }\n\n const createCollectionPersistence = (\n collectionId: string | undefined,\n mode: PersistedCollectionMode,\n schemaVersion: number | undefined,\n ): PersistedCollectionPersistence => {\n const adapter = getAdapterForCollection(mode, schemaVersion)\n if (resolvedCoordinator instanceof BrowserCollectionCoordinator) {\n if (collectionId === undefined) {\n resolvedCoordinator.setAdapter(adapter)\n } else {\n resolvedCoordinator.setAdapterForCollection(collectionId, adapter)\n }\n }\n return {\n adapter,\n coordinator: resolvedCoordinator,\n }\n }\n\n const defaultPersistence = createCollectionPersistence(\n undefined,\n `sync-absent`,\n undefined,\n )\n if (resolvedCoordinator instanceof BrowserCollectionCoordinator) {\n resolvedCoordinator.setAdapter(defaultPersistence.adapter)\n }\n\n return {\n ...defaultPersistence,\n resolvePersistenceForCollection: ({ collectionId, mode, schemaVersion }) =>\n createCollectionPersistence(collectionId, mode, schemaVersion),\n resolvePersistenceForMode: (mode) =>\n createCollectionPersistence(undefined, mode, undefined),\n }\n}\n"],"names":[],"mappings":";;;AAqCA,SAAS,8BACP,QACuC;AACvC,MAAI,WAAW,SAAS;AACtB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAEA,SAAS,4BACP,gBACA,MACuC;AACvC,MAAI,gBAAgB;AAClB,WAAO,8BAA8B,cAAc;AAAA,EACrD;AAEA,SAAO,SAAS,iBAAiB,uBAAuB;AAC1D;AAEA,SAAS,sBACP,sBACA,eACQ;AACR,QAAM,mBACJ,kBAAkB,SAAY,mBAAmB,UAAU,aAAa;AAC1E,SAAO,GAAG,oBAAoB,IAAI,gBAAgB;AACpD;AAEA,SAAS,2BACP,SACc;AACd,SAAO,IAAI,sBAAsB;AAAA,IAC/B,UAAU,QAAQ;AAAA,EAAA,CACnB;AACH;AAEA,SAAS,0BACP,SAIA;AACA,SAAO;AAAA,IACL,uBACE,QAAQ,yBAAyB;AAAA,IACnC,6BACE,QAAQ,+BACR;AAAA,IACF,0BAA0B,QAAQ;AAAA,EAAA;AAEtC;AAOO,SAAS,iCACd,SACgC;AAChC,QAAM,EAAE,aAAa,qBAAA,IAAyB;AAC9C,QAAM,SAAS,2BAA2B,OAAO;AACjD,QAAM,qBAAqB,0BAA0B,OAAO;AAC5D,QAAM,sBAAsB,eAAe,IAAI,yBAAA;AAC/C,QAAM,mCAAmB,IAAA;AAKzB,QAAM,0BAA0B,CAC9B,MACA,kBACG;AACH,UAAM,+BAA+B;AAAA,MACnC;AAAA,MACA;AAAA,IAAA;AAEF,UAAM,WAAW;AAAA,MACf;AAAA,MACA;AAAA,IAAA;AAEF,UAAM,gBAAgB,aAAa,IAAI,QAAQ;AAC/C,QAAI,eAAe;AACjB,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,mCAAmC;AAAA,MACjD,GAAG;AAAA,MACH;AAAA,MACA,sBAAsB;AAAA,MACtB,GAAI,kBAAkB,SAAY,CAAA,IAAK,EAAE,cAAA;AAAA,IAAc,CACxD;AACD,iBAAa,IAAI,UAAU,OAAO;AAClC,WAAO;AAAA,EACT;AAEA,QAAM,8BAA8B,CAClC,cACA,MACA,kBACmC;AACnC,UAAM,UAAU,wBAAwB,MAAM,aAAa;AAC3D,QAAI,+BAA+B,8BAA8B;AAC/D,UAAI,iBAAiB,QAAW;AAC9B,4BAAoB,WAAW,OAAO;AAAA,MACxC,OAAO;AACL,4BAAoB,wBAAwB,cAAc,OAAO;AAAA,MACnE;AAAA,IACF;AACA,WAAO;AAAA,MACL;AAAA,MACA,aAAa;AAAA,IAAA;AAAA,EAEjB;AAEA,QAAM,qBAAqB;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAEF,MAAI,+BAA+B,8BAA8B;AAC/D,wBAAoB,WAAW,mBAAmB,OAAO;AAAA,EAC3D;AAEA,SAAO;AAAA,IACL,GAAG;AAAA,IACH,iCAAiC,CAAC,EAAE,cAAc,MAAM,oBACtD,4BAA4B,cAAc,MAAM,aAAa;AAAA,IAC/D,2BAA2B,CAAC,SAC1B,4BAA4B,QAAW,MAAM,MAAS;AAAA,EAAA;AAE5D;"}
@@ -4,5 +4,5 @@ export { BrowserCollectionCoordinator } from './browser-coordinator.js';
4
4
  export type { BrowserWASQLiteDatabase, BrowserWASQLitePersistenceOptions, BrowserWASQLiteSchemaMismatchPolicy, } from './browser-persistence.js';
5
5
  export type { OpenBrowserWASQLiteOPFSDatabaseOptions } from './opfs-database.js';
6
6
  export type { BrowserCollectionCoordinatorOptions } from './browser-coordinator.js';
7
- export { DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS, DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS, persistedCollectionOptions, } from '@tanstack/db-sqlite-persistence-core';
8
- export type { PersistedCollectionCoordinator, PersistedCollectionPersistence, } from '@tanstack/db-sqlite-persistence-core';
7
+ export { DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS, DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS, DuplicateRemoteSubsetOwnerError, IndeterminateCommitError, PersistedCollectionDurabilityError, RemoteSubsetWireValueError, persistedCollectionOptions, } from '@tanstack/db-sqlite-persistence-core';
8
+ export type { PersistedCollectionCoordinator, PersistedCollectionPersistence, IndeterminateCommitRequestType, RemoteSubsetOwner, RemoteSubsetWireExpression, RemoteSubsetWireValue, TransportedLoadSubsetOptions, } from '@tanstack/db-sqlite-persistence-core';
package/dist/esm/index.js CHANGED
@@ -1,11 +1,15 @@
1
1
  import { createBrowserWASQLitePersistence } from "./browser-persistence.js";
2
2
  import { openBrowserWASQLiteOPFSDatabase } from "./opfs-database.js";
3
3
  import { BrowserCollectionCoordinator } from "./browser-coordinator.js";
4
- import { DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS, DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS, persistedCollectionOptions } from "@tanstack/db-sqlite-persistence-core";
4
+ import { DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS, DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS, DuplicateRemoteSubsetOwnerError, IndeterminateCommitError, PersistedCollectionDurabilityError, RemoteSubsetWireValueError, persistedCollectionOptions } from "@tanstack/db-sqlite-persistence-core";
5
5
  export {
6
6
  BrowserCollectionCoordinator,
7
7
  DEFAULT_APPLIED_TX_PRUNE_MAX_AGE_SECONDS,
8
8
  DEFAULT_APPLIED_TX_PRUNE_MAX_ROWS,
9
+ DuplicateRemoteSubsetOwnerError,
10
+ IndeterminateCommitError,
11
+ PersistedCollectionDurabilityError,
12
+ RemoteSubsetWireValueError,
9
13
  createBrowserWASQLitePersistence,
10
14
  openBrowserWASQLiteOPFSDatabase,
11
15
  persistedCollectionOptions
@@ -2,6 +2,10 @@ import { BrowserWASQLiteDatabase } from './wa-sqlite-driver.js';
2
2
  export type OpenBrowserWASQLiteOPFSDatabaseOptions = {
3
3
  databaseName: string;
4
4
  vfsName?: string;
5
+ /** Defaults to 30 seconds. Set to 0 to wait without a deadline. */
6
+ timeoutMs?: number;
7
+ /** Cancels only the database open, not an established connection. */
8
+ signal?: AbortSignal;
5
9
  };
6
10
  /**
7
11
  * Creates a browser wa-sqlite database handle backed by OPFS and
@@ -1,6 +1,8 @@
1
1
  import { InvalidPersistedCollectionConfigError, PersistenceUnavailableError } from "@tanstack/db-sqlite-persistence-core";
2
2
  import WorkerWrapper from "./opfs-worker.js";
3
3
  const DEFAULT_VFS_NAME = `opfs`;
4
+ const DEFAULT_OPEN_TIMEOUT_MS = 3e4;
5
+ const MAX_OPEN_TIMEOUT_MS = 2147483647;
4
6
  class OPFSWorkerRequestError extends Error {
5
7
  constructor(code, message) {
6
8
  super(message);
@@ -40,6 +42,13 @@ function createOPFSWorkerInstance() {
40
42
  }
41
43
  return new WorkerWrapper();
42
44
  }
45
+ function getOpenAbortError(signal) {
46
+ const reason = signal.reason;
47
+ return reason instanceof Error ? reason : new DOMException(
48
+ `Opening browser OPFS database was aborted`,
49
+ `AbortError`
50
+ );
51
+ }
43
52
  async function openBrowserWASQLiteOPFSDatabase(options) {
44
53
  const databaseName = options.databaseName.trim();
45
54
  if (databaseName.length === 0) {
@@ -47,6 +56,16 @@ async function openBrowserWASQLiteOPFSDatabase(options) {
47
56
  `Browser wa-sqlite databaseName cannot be empty`
48
57
  );
49
58
  }
59
+ const timeoutMs = options.timeoutMs ?? DEFAULT_OPEN_TIMEOUT_MS;
60
+ if (!Number.isSafeInteger(timeoutMs) || timeoutMs < 0 || timeoutMs > MAX_OPEN_TIMEOUT_MS) {
61
+ throw new InvalidPersistedCollectionConfigError(
62
+ `Browser wa-sqlite timeoutMs must be an integer between 0 and ${MAX_OPEN_TIMEOUT_MS}`
63
+ );
64
+ }
65
+ const signal = options.signal;
66
+ if (signal?.aborted) {
67
+ throw getOpenAbortError(signal);
68
+ }
50
69
  if (!hasOPFSBrowserPrerequisites(globalThis)) {
51
70
  throw new PersistenceUnavailableError(
52
71
  `Browser OPFS prerequisites are not available in this runtime`
@@ -62,6 +81,7 @@ async function openBrowserWASQLiteOPFSDatabase(options) {
62
81
  return;
63
82
  }
64
83
  disposed = true;
84
+ globalThis.removeEventListener(`pagehide`, onPageHide);
65
85
  worker.removeEventListener(`message`, onMessage);
66
86
  worker.removeEventListener(`error`, onError);
67
87
  worker.removeEventListener(`messageerror`, onMessageError);
@@ -101,9 +121,19 @@ async function openBrowserWASQLiteOPFSDatabase(options) {
101
121
  );
102
122
  disposeWorker();
103
123
  };
124
+ const onPageHide = () => {
125
+ rejectAllPendingRequests(
126
+ new DOMException(
127
+ `The page is closing its SQLite connection`,
128
+ `AbortError`
129
+ )
130
+ );
131
+ disposeWorker();
132
+ };
104
133
  worker.addEventListener(`message`, onMessage);
105
134
  worker.addEventListener(`error`, onError);
106
135
  worker.addEventListener(`messageerror`, onMessageError);
136
+ globalThis.addEventListener(`pagehide`, onPageHide);
107
137
  const sendWorkerRequest = (request) => {
108
138
  if (disposed) {
109
139
  return Promise.reject(
@@ -136,15 +166,39 @@ async function openBrowserWASQLiteOPFSDatabase(options) {
136
166
  }
137
167
  });
138
168
  };
169
+ let openTimeout;
170
+ const onAbort = () => {
171
+ if (!signal) return;
172
+ rejectAllPendingRequests(getOpenAbortError(signal));
173
+ disposeWorker();
174
+ };
175
+ const onTimeout = () => {
176
+ rejectAllPendingRequests(
177
+ new DOMException(
178
+ `Opening browser OPFS database timed out after ${timeoutMs} ms`,
179
+ `TimeoutError`
180
+ )
181
+ );
182
+ disposeWorker();
183
+ };
139
184
  try {
140
- await sendWorkerRequest({
185
+ const initialization = sendWorkerRequest({
141
186
  type: `init`,
142
187
  databaseName,
143
188
  vfsName
144
189
  });
190
+ signal?.addEventListener(`abort`, onAbort, { once: true });
191
+ if (signal?.aborted) onAbort();
192
+ if (timeoutMs > 0) {
193
+ openTimeout = setTimeout(onTimeout, timeoutMs);
194
+ }
195
+ await initialization;
145
196
  } catch (error) {
146
197
  disposeWorker();
147
198
  throw error;
199
+ } finally {
200
+ if (openTimeout !== void 0) clearTimeout(openTimeout);
201
+ signal?.removeEventListener(`abort`, onAbort);
148
202
  }
149
203
  return {
150
204
  execute: (sql, params = []) => sendWorkerRequest({
@@ -153,6 +207,9 @@ async function openBrowserWASQLiteOPFSDatabase(options) {
153
207
  params
154
208
  }),
155
209
  close: async () => {
210
+ if (disposed) {
211
+ return;
212
+ }
156
213
  let closeError;
157
214
  try {
158
215
  await sendWorkerRequest({
@@ -1 +1 @@
1
- {"version":3,"file":"opfs-database.js","sources":["../../src/opfs-database.ts"],"sourcesContent":["import {\n InvalidPersistedCollectionConfigError,\n PersistenceUnavailableError,\n} from '@tanstack/db-sqlite-persistence-core'\nimport OPFSWorkerConstructor from './opfs-worker?worker'\nimport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\nimport type {\n BrowserOPFSWorkerErrorCode,\n BrowserOPFSWorkerRequest,\n BrowserOPFSWorkerResponse,\n} from './opfs-worker-protocol'\n\nconst DEFAULT_VFS_NAME = `opfs`\ntype BrowserOPFSFeatureGlobal = {\n navigator?: {\n storage?: {\n getDirectory?: () => Promise<unknown>\n }\n }\n Worker?: typeof Worker\n}\n\nexport type OpenBrowserWASQLiteOPFSDatabaseOptions = {\n databaseName: string\n vfsName?: string\n}\n\ntype BrowserOPFSWorkerLike = Pick<\n Worker,\n `postMessage` | `terminate` | `addEventListener` | `removeEventListener`\n>\n\ntype PendingWorkerRequest = {\n resolve: (value: unknown) => void\n reject: (error: Error) => void\n}\n\ntype BrowserOPFSWorkerRequestWithoutId =\n BrowserOPFSWorkerRequest extends infer TRequest\n ? TRequest extends { requestId: string }\n ? Omit<TRequest, `requestId`>\n : never\n : never\n\nclass OPFSWorkerRequestError extends Error {\n constructor(\n readonly code: BrowserOPFSWorkerErrorCode,\n message: string,\n ) {\n super(message)\n this.name = `OPFSWorkerRequestError`\n }\n}\n\nfunction hasOPFSBrowserPrerequisites(globalObject: unknown): boolean {\n const candidate = globalObject as BrowserOPFSFeatureGlobal\n const getDirectory = candidate.navigator?.storage?.getDirectory\n const WorkerConstructor = candidate.Worker\n\n return (\n typeof getDirectory === `function` &&\n typeof WorkerConstructor === `function`\n )\n}\n\nfunction createWorkerError(\n code: BrowserOPFSWorkerErrorCode,\n message: string,\n): Error {\n if (code === `PERSISTENCE_UNAVAILABLE`) {\n return new PersistenceUnavailableError(message)\n }\n if (code === `INVALID_CONFIG`) {\n return new InvalidPersistedCollectionConfigError(message)\n }\n return new OPFSWorkerRequestError(code, message)\n}\n\nfunction createWorkerRequestIdFactory(): () => string {\n let sequence = 0\n const prefix = `opfs-${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`\n\n return () => {\n sequence++\n return `${prefix}-${sequence}`\n }\n}\n\nfunction createOPFSWorkerInstance(): BrowserOPFSWorkerLike {\n const WorkerConstructor = (\n globalThis as typeof globalThis & { Worker?: typeof Worker }\n ).Worker\n if (typeof WorkerConstructor !== `function`) {\n throw new PersistenceUnavailableError(\n `Web Worker support is required for browser OPFS persistence`,\n )\n }\n\n return new (OPFSWorkerConstructor as unknown as new () => BrowserOPFSWorkerLike)()\n}\n\n/**\n * Creates a browser wa-sqlite database handle backed by OPFS and\n * OPFSCoopSyncVFS.\n */\nexport async function openBrowserWASQLiteOPFSDatabase(\n options: OpenBrowserWASQLiteOPFSDatabaseOptions,\n): Promise<BrowserWASQLiteDatabase> {\n const databaseName = options.databaseName.trim()\n if (databaseName.length === 0) {\n throw new InvalidPersistedCollectionConfigError(\n `Browser wa-sqlite databaseName cannot be empty`,\n )\n }\n\n if (!hasOPFSBrowserPrerequisites(globalThis)) {\n throw new PersistenceUnavailableError(\n `Browser OPFS prerequisites are not available in this runtime`,\n )\n }\n\n const vfsName = options.vfsName ?? DEFAULT_VFS_NAME\n const worker = createOPFSWorkerInstance()\n const nextRequestId = createWorkerRequestIdFactory()\n const pendingRequests = new Map<string, PendingWorkerRequest>()\n let disposed = false\n\n const disposeWorker = (): void => {\n if (disposed) {\n return\n }\n disposed = true\n worker.removeEventListener(`message`, onMessage)\n worker.removeEventListener(`error`, onError)\n worker.removeEventListener(`messageerror`, onMessageError)\n worker.terminate()\n }\n\n const rejectAllPendingRequests = (error: Error): void => {\n for (const pendingRequest of pendingRequests.values()) {\n pendingRequest.reject(error)\n }\n pendingRequests.clear()\n }\n\n const onMessage = (event: Event): void => {\n const messageEvent = event as MessageEvent<BrowserOPFSWorkerResponse>\n const response = messageEvent.data\n\n const pendingRequest = pendingRequests.get(response.requestId)\n if (!pendingRequest) {\n return\n }\n pendingRequests.delete(response.requestId)\n\n if (response.ok) {\n pendingRequest.resolve(response.rows ?? [])\n return\n }\n\n pendingRequest.reject(createWorkerError(response.code, response.error))\n }\n\n const onError = (): void => {\n rejectAllPendingRequests(\n new PersistenceUnavailableError(`OPFS worker terminated unexpectedly`),\n )\n disposeWorker()\n }\n\n const onMessageError = (): void => {\n rejectAllPendingRequests(\n new PersistenceUnavailableError(\n `OPFS worker message serialization failed`,\n ),\n )\n disposeWorker()\n }\n\n worker.addEventListener(`message`, onMessage)\n worker.addEventListener(`error`, onError)\n worker.addEventListener(`messageerror`, onMessageError)\n\n const sendWorkerRequest = <T>(\n request: BrowserOPFSWorkerRequestWithoutId,\n ): Promise<T> => {\n if (disposed) {\n return Promise.reject(\n new InvalidPersistedCollectionConfigError(\n `Browser OPFS worker connection is closed`,\n ),\n )\n }\n\n const requestId = nextRequestId()\n return new Promise<T>((resolve, reject) => {\n pendingRequests.set(requestId, {\n resolve: (value) => {\n resolve(value as T)\n },\n reject,\n })\n try {\n const payload = {\n ...request,\n requestId,\n } as BrowserOPFSWorkerRequest\n worker.postMessage(payload)\n } catch (error) {\n pendingRequests.delete(requestId)\n reject(\n new PersistenceUnavailableError(\n `Failed to send message to OPFS worker: ${(error as Error).message}`,\n ),\n )\n }\n })\n }\n\n try {\n await sendWorkerRequest<void>({\n type: `init`,\n databaseName,\n vfsName,\n })\n } catch (error) {\n disposeWorker()\n throw error\n }\n\n return {\n execute: <TRow = unknown>(\n sql: string,\n params: ReadonlyArray<unknown> = [],\n ) =>\n sendWorkerRequest<ReadonlyArray<TRow>>({\n type: `execute`,\n sql,\n params,\n }),\n close: async () => {\n let closeError: unknown\n try {\n await sendWorkerRequest<void>({\n type: `close`,\n })\n } catch (error) {\n closeError = error\n } finally {\n disposeWorker()\n }\n\n if (closeError) {\n throw closeError\n }\n },\n }\n}\n"],"names":["OPFSWorkerConstructor"],"mappings":";;AAYA,MAAM,mBAAmB;AAgCzB,MAAM,+BAA+B,MAAM;AAAA,EACzC,YACW,MACT,SACA;AACA,UAAM,OAAO;AAHJ,SAAA,OAAA;AAIT,SAAK,OAAO;AAAA,EACd;AACF;AAEA,SAAS,4BAA4B,cAAgC;AACnE,QAAM,YAAY;AAClB,QAAM,eAAe,UAAU,WAAW,SAAS;AACnD,QAAM,oBAAoB,UAAU;AAEpC,SACE,OAAO,iBAAiB,cACxB,OAAO,sBAAsB;AAEjC;AAEA,SAAS,kBACP,MACA,SACO;AACP,MAAI,SAAS,2BAA2B;AACtC,WAAO,IAAI,4BAA4B,OAAO;AAAA,EAChD;AACA,MAAI,SAAS,kBAAkB;AAC7B,WAAO,IAAI,sCAAsC,OAAO;AAAA,EAC1D;AACA,SAAO,IAAI,uBAAuB,MAAM,OAAO;AACjD;AAEA,SAAS,+BAA6C;AACpD,MAAI,WAAW;AACf,QAAM,SAAS,QAAQ,KAAK,IAAA,EAAM,SAAS,EAAE,CAAC,IAAI,KAAK,SAAS,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;AAErF,SAAO,MAAM;AACX;AACA,WAAO,GAAG,MAAM,IAAI,QAAQ;AAAA,EAC9B;AACF;AAEA,SAAS,2BAAkD;AACzD,QAAM,oBACJ,WACA;AACF,MAAI,OAAO,sBAAsB,YAAY;AAC3C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO,IAAKA,cAAA;AACd;AAMA,eAAsB,gCACpB,SACkC;AAClC,QAAM,eAAe,QAAQ,aAAa,KAAA;AAC1C,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,MAAI,CAAC,4BAA4B,UAAU,GAAG;AAC5C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,SAAS,yBAAA;AACf,QAAM,gBAAgB,6BAAA;AACtB,QAAM,sCAAsB,IAAA;AAC5B,MAAI,WAAW;AAEf,QAAM,gBAAgB,MAAY;AAChC,QAAI,UAAU;AACZ;AAAA,IACF;AACA,eAAW;AACX,WAAO,oBAAoB,WAAW,SAAS;AAC/C,WAAO,oBAAoB,SAAS,OAAO;AAC3C,WAAO,oBAAoB,gBAAgB,cAAc;AACzD,WAAO,UAAA;AAAA,EACT;AAEA,QAAM,2BAA2B,CAAC,UAAuB;AACvD,eAAW,kBAAkB,gBAAgB,UAAU;AACrD,qBAAe,OAAO,KAAK;AAAA,IAC7B;AACA,oBAAgB,MAAA;AAAA,EAClB;AAEA,QAAM,YAAY,CAAC,UAAuB;AACxC,UAAM,eAAe;AACrB,UAAM,WAAW,aAAa;AAE9B,UAAM,iBAAiB,gBAAgB,IAAI,SAAS,SAAS;AAC7D,QAAI,CAAC,gBAAgB;AACnB;AAAA,IACF;AACA,oBAAgB,OAAO,SAAS,SAAS;AAEzC,QAAI,SAAS,IAAI;AACf,qBAAe,QAAQ,SAAS,QAAQ,CAAA,CAAE;AAC1C;AAAA,IACF;AAEA,mBAAe,OAAO,kBAAkB,SAAS,MAAM,SAAS,KAAK,CAAC;AAAA,EACxE;AAEA,QAAM,UAAU,MAAY;AAC1B;AAAA,MACE,IAAI,4BAA4B,qCAAqC;AAAA,IAAA;AAEvE,kBAAA;AAAA,EACF;AAEA,QAAM,iBAAiB,MAAY;AACjC;AAAA,MACE,IAAI;AAAA,QACF;AAAA,MAAA;AAAA,IACF;AAEF,kBAAA;AAAA,EACF;AAEA,SAAO,iBAAiB,WAAW,SAAS;AAC5C,SAAO,iBAAiB,SAAS,OAAO;AACxC,SAAO,iBAAiB,gBAAgB,cAAc;AAEtD,QAAM,oBAAoB,CACxB,YACe;AACf,QAAI,UAAU;AACZ,aAAO,QAAQ;AAAA,QACb,IAAI;AAAA,UACF;AAAA,QAAA;AAAA,MACF;AAAA,IAEJ;AAEA,UAAM,YAAY,cAAA;AAClB,WAAO,IAAI,QAAW,CAAC,SAAS,WAAW;AACzC,sBAAgB,IAAI,WAAW;AAAA,QAC7B,SAAS,CAAC,UAAU;AAClB,kBAAQ,KAAU;AAAA,QACpB;AAAA,QACA;AAAA,MAAA,CACD;AACD,UAAI;AACF,cAAM,UAAU;AAAA,UACd,GAAG;AAAA,UACH;AAAA,QAAA;AAEF,eAAO,YAAY,OAAO;AAAA,MAC5B,SAAS,OAAO;AACd,wBAAgB,OAAO,SAAS;AAChC;AAAA,UACE,IAAI;AAAA,YACF,0CAA2C,MAAgB,OAAO;AAAA,UAAA;AAAA,QACpE;AAAA,MAEJ;AAAA,IACF,CAAC;AAAA,EACH;AAEA,MAAI;AACF,UAAM,kBAAwB;AAAA,MAC5B,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA,CACD;AAAA,EACH,SAAS,OAAO;AACd,kBAAA;AACA,UAAM;AAAA,EACR;AAEA,SAAO;AAAA,IACL,SAAS,CACP,KACA,SAAiC,CAAA,MAEjC,kBAAuC;AAAA,MACrC,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA,CACD;AAAA,IACH,OAAO,YAAY;AACjB,UAAI;AACJ,UAAI;AACF,cAAM,kBAAwB;AAAA,UAC5B,MAAM;AAAA,QAAA,CACP;AAAA,MACH,SAAS,OAAO;AACd,qBAAa;AAAA,MACf,UAAA;AACE,sBAAA;AAAA,MACF;AAEA,UAAI,YAAY;AACd,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EAAA;AAEJ;"}
1
+ {"version":3,"file":"opfs-database.js","sources":["../../src/opfs-database.ts"],"sourcesContent":["import {\n InvalidPersistedCollectionConfigError,\n PersistenceUnavailableError,\n} from '@tanstack/db-sqlite-persistence-core'\nimport OPFSWorkerConstructor from './opfs-worker?worker'\nimport type { BrowserWASQLiteDatabase } from './wa-sqlite-driver'\nimport type {\n BrowserOPFSWorkerErrorCode,\n BrowserOPFSWorkerRequest,\n BrowserOPFSWorkerResponse,\n} from './opfs-worker-protocol'\n\nconst DEFAULT_VFS_NAME = `opfs`\nconst DEFAULT_OPEN_TIMEOUT_MS = 30_000\nconst MAX_OPEN_TIMEOUT_MS = 2_147_483_647\ntype BrowserOPFSFeatureGlobal = {\n navigator?: {\n storage?: {\n getDirectory?: () => Promise<unknown>\n }\n }\n Worker?: typeof Worker\n}\n\nexport type OpenBrowserWASQLiteOPFSDatabaseOptions = {\n databaseName: string\n vfsName?: string\n /** Defaults to 30 seconds. Set to 0 to wait without a deadline. */\n timeoutMs?: number\n /** Cancels only the database open, not an established connection. */\n signal?: AbortSignal\n}\n\ntype BrowserOPFSWorkerLike = Pick<\n Worker,\n `postMessage` | `terminate` | `addEventListener` | `removeEventListener`\n>\n\ntype PendingWorkerRequest = {\n resolve: (value: unknown) => void\n reject: (error: Error) => void\n}\n\ntype BrowserOPFSWorkerRequestWithoutId =\n BrowserOPFSWorkerRequest extends infer TRequest\n ? TRequest extends { requestId: string }\n ? Omit<TRequest, `requestId`>\n : never\n : never\n\nclass OPFSWorkerRequestError extends Error {\n constructor(\n readonly code: BrowserOPFSWorkerErrorCode,\n message: string,\n ) {\n super(message)\n this.name = `OPFSWorkerRequestError`\n }\n}\n\nfunction hasOPFSBrowserPrerequisites(globalObject: unknown): boolean {\n const candidate = globalObject as BrowserOPFSFeatureGlobal\n const getDirectory = candidate.navigator?.storage?.getDirectory\n const WorkerConstructor = candidate.Worker\n\n return (\n typeof getDirectory === `function` &&\n typeof WorkerConstructor === `function`\n )\n}\n\nfunction createWorkerError(\n code: BrowserOPFSWorkerErrorCode,\n message: string,\n): Error {\n if (code === `PERSISTENCE_UNAVAILABLE`) {\n return new PersistenceUnavailableError(message)\n }\n if (code === `INVALID_CONFIG`) {\n return new InvalidPersistedCollectionConfigError(message)\n }\n return new OPFSWorkerRequestError(code, message)\n}\n\nfunction createWorkerRequestIdFactory(): () => string {\n let sequence = 0\n const prefix = `opfs-${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`\n\n return () => {\n sequence++\n return `${prefix}-${sequence}`\n }\n}\n\nfunction createOPFSWorkerInstance(): BrowserOPFSWorkerLike {\n const WorkerConstructor = (\n globalThis as typeof globalThis & { Worker?: typeof Worker }\n ).Worker\n if (typeof WorkerConstructor !== `function`) {\n throw new PersistenceUnavailableError(\n `Web Worker support is required for browser OPFS persistence`,\n )\n }\n\n return new (OPFSWorkerConstructor as unknown as new () => BrowserOPFSWorkerLike)()\n}\n\nfunction getOpenAbortError(signal: AbortSignal): Error {\n const reason: unknown = signal.reason\n return reason instanceof Error\n ? reason\n : new DOMException(\n `Opening browser OPFS database was aborted`,\n `AbortError`,\n )\n}\n\n/**\n * Creates a browser wa-sqlite database handle backed by OPFS and\n * OPFSCoopSyncVFS.\n */\nexport async function openBrowserWASQLiteOPFSDatabase(\n options: OpenBrowserWASQLiteOPFSDatabaseOptions,\n): Promise<BrowserWASQLiteDatabase> {\n const databaseName = options.databaseName.trim()\n if (databaseName.length === 0) {\n throw new InvalidPersistedCollectionConfigError(\n `Browser wa-sqlite databaseName cannot be empty`,\n )\n }\n\n const timeoutMs = options.timeoutMs ?? DEFAULT_OPEN_TIMEOUT_MS\n if (\n !Number.isSafeInteger(timeoutMs) ||\n timeoutMs < 0 ||\n timeoutMs > MAX_OPEN_TIMEOUT_MS\n ) {\n throw new InvalidPersistedCollectionConfigError(\n `Browser wa-sqlite timeoutMs must be an integer between 0 and ${MAX_OPEN_TIMEOUT_MS}`,\n )\n }\n\n const signal = options.signal\n if (signal?.aborted) {\n throw getOpenAbortError(signal)\n }\n\n if (!hasOPFSBrowserPrerequisites(globalThis)) {\n throw new PersistenceUnavailableError(\n `Browser OPFS prerequisites are not available in this runtime`,\n )\n }\n\n const vfsName = options.vfsName ?? DEFAULT_VFS_NAME\n const worker = createOPFSWorkerInstance()\n const nextRequestId = createWorkerRequestIdFactory()\n const pendingRequests = new Map<string, PendingWorkerRequest>()\n let disposed = false\n\n const disposeWorker = (): void => {\n if (disposed) {\n return\n }\n disposed = true\n globalThis.removeEventListener(`pagehide`, onPageHide)\n worker.removeEventListener(`message`, onMessage)\n worker.removeEventListener(`error`, onError)\n worker.removeEventListener(`messageerror`, onMessageError)\n worker.terminate()\n }\n\n const rejectAllPendingRequests = (error: Error): void => {\n for (const pendingRequest of pendingRequests.values()) {\n pendingRequest.reject(error)\n }\n pendingRequests.clear()\n }\n\n const onMessage = (event: Event): void => {\n const messageEvent = event as MessageEvent<BrowserOPFSWorkerResponse>\n const response = messageEvent.data\n\n const pendingRequest = pendingRequests.get(response.requestId)\n if (!pendingRequest) {\n return\n }\n pendingRequests.delete(response.requestId)\n\n if (response.ok) {\n pendingRequest.resolve(response.rows ?? [])\n return\n }\n\n pendingRequest.reject(createWorkerError(response.code, response.error))\n }\n\n const onError = (): void => {\n rejectAllPendingRequests(\n new PersistenceUnavailableError(`OPFS worker terminated unexpectedly`),\n )\n disposeWorker()\n }\n\n const onMessageError = (): void => {\n rejectAllPendingRequests(\n new PersistenceUnavailableError(\n `OPFS worker message serialization failed`,\n ),\n )\n disposeWorker()\n }\n\n const onPageHide = (): void => {\n // A document entering the back/forward cache can be frozen before an\n // asynchronous close completes, including while initialization is pending.\n rejectAllPendingRequests(\n new DOMException(\n `The page is closing its SQLite connection`,\n `AbortError`,\n ),\n )\n disposeWorker()\n }\n\n worker.addEventListener(`message`, onMessage)\n worker.addEventListener(`error`, onError)\n worker.addEventListener(`messageerror`, onMessageError)\n globalThis.addEventListener(`pagehide`, onPageHide)\n\n const sendWorkerRequest = <T>(\n request: BrowserOPFSWorkerRequestWithoutId,\n ): Promise<T> => {\n if (disposed) {\n return Promise.reject(\n new InvalidPersistedCollectionConfigError(\n `Browser OPFS worker connection is closed`,\n ),\n )\n }\n\n const requestId = nextRequestId()\n return new Promise<T>((resolve, reject) => {\n pendingRequests.set(requestId, {\n resolve: (value) => {\n resolve(value as T)\n },\n reject,\n })\n try {\n const payload = {\n ...request,\n requestId,\n } as BrowserOPFSWorkerRequest\n worker.postMessage(payload)\n } catch (error) {\n pendingRequests.delete(requestId)\n reject(\n new PersistenceUnavailableError(\n `Failed to send message to OPFS worker: ${(error as Error).message}`,\n ),\n )\n }\n })\n }\n\n let openTimeout: ReturnType<typeof setTimeout> | undefined\n const onAbort = (): void => {\n if (!signal) return\n rejectAllPendingRequests(getOpenAbortError(signal))\n disposeWorker()\n }\n const onTimeout = (): void => {\n rejectAllPendingRequests(\n new DOMException(\n `Opening browser OPFS database timed out after ${timeoutMs} ms`,\n `TimeoutError`,\n ),\n )\n disposeWorker()\n }\n\n try {\n const initialization = sendWorkerRequest<void>({\n type: `init`,\n databaseName,\n vfsName,\n })\n signal?.addEventListener(`abort`, onAbort, { once: true })\n if (signal?.aborted) onAbort()\n if (timeoutMs > 0) {\n openTimeout = setTimeout(onTimeout, timeoutMs)\n }\n await initialization\n } catch (error) {\n disposeWorker()\n throw error\n } finally {\n if (openTimeout !== undefined) clearTimeout(openTimeout)\n signal?.removeEventListener(`abort`, onAbort)\n }\n\n return {\n execute: <TRow = unknown>(\n sql: string,\n params: ReadonlyArray<unknown> = [],\n ) =>\n sendWorkerRequest<ReadonlyArray<TRow>>({\n type: `execute`,\n sql,\n params,\n }),\n close: async () => {\n if (disposed) {\n return\n }\n\n let closeError: unknown\n try {\n await sendWorkerRequest<void>({\n type: `close`,\n })\n } catch (error) {\n closeError = error\n } finally {\n disposeWorker()\n }\n\n if (closeError) {\n throw closeError\n }\n },\n }\n}\n"],"names":["OPFSWorkerConstructor"],"mappings":";;AAYA,MAAM,mBAAmB;AACzB,MAAM,0BAA0B;AAChC,MAAM,sBAAsB;AAoC5B,MAAM,+BAA+B,MAAM;AAAA,EACzC,YACW,MACT,SACA;AACA,UAAM,OAAO;AAHJ,SAAA,OAAA;AAIT,SAAK,OAAO;AAAA,EACd;AACF;AAEA,SAAS,4BAA4B,cAAgC;AACnE,QAAM,YAAY;AAClB,QAAM,eAAe,UAAU,WAAW,SAAS;AACnD,QAAM,oBAAoB,UAAU;AAEpC,SACE,OAAO,iBAAiB,cACxB,OAAO,sBAAsB;AAEjC;AAEA,SAAS,kBACP,MACA,SACO;AACP,MAAI,SAAS,2BAA2B;AACtC,WAAO,IAAI,4BAA4B,OAAO;AAAA,EAChD;AACA,MAAI,SAAS,kBAAkB;AAC7B,WAAO,IAAI,sCAAsC,OAAO;AAAA,EAC1D;AACA,SAAO,IAAI,uBAAuB,MAAM,OAAO;AACjD;AAEA,SAAS,+BAA6C;AACpD,MAAI,WAAW;AACf,QAAM,SAAS,QAAQ,KAAK,IAAA,EAAM,SAAS,EAAE,CAAC,IAAI,KAAK,SAAS,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;AAErF,SAAO,MAAM;AACX;AACA,WAAO,GAAG,MAAM,IAAI,QAAQ;AAAA,EAC9B;AACF;AAEA,SAAS,2BAAkD;AACzD,QAAM,oBACJ,WACA;AACF,MAAI,OAAO,sBAAsB,YAAY;AAC3C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,SAAO,IAAKA,cAAA;AACd;AAEA,SAAS,kBAAkB,QAA4B;AACrD,QAAM,SAAkB,OAAO;AAC/B,SAAO,kBAAkB,QACrB,SACA,IAAI;AAAA,IACF;AAAA,IACA;AAAA,EAAA;AAER;AAMA,eAAsB,gCACpB,SACkC;AAClC,QAAM,eAAe,QAAQ,aAAa,KAAA;AAC1C,MAAI,aAAa,WAAW,GAAG;AAC7B,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,QAAM,YAAY,QAAQ,aAAa;AACvC,MACE,CAAC,OAAO,cAAc,SAAS,KAC/B,YAAY,KACZ,YAAY,qBACZ;AACA,UAAM,IAAI;AAAA,MACR,gEAAgE,mBAAmB;AAAA,IAAA;AAAA,EAEvF;AAEA,QAAM,SAAS,QAAQ;AACvB,MAAI,QAAQ,SAAS;AACnB,UAAM,kBAAkB,MAAM;AAAA,EAChC;AAEA,MAAI,CAAC,4BAA4B,UAAU,GAAG;AAC5C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AAEA,QAAM,UAAU,QAAQ,WAAW;AACnC,QAAM,SAAS,yBAAA;AACf,QAAM,gBAAgB,6BAAA;AACtB,QAAM,sCAAsB,IAAA;AAC5B,MAAI,WAAW;AAEf,QAAM,gBAAgB,MAAY;AAChC,QAAI,UAAU;AACZ;AAAA,IACF;AACA,eAAW;AACX,eAAW,oBAAoB,YAAY,UAAU;AACrD,WAAO,oBAAoB,WAAW,SAAS;AAC/C,WAAO,oBAAoB,SAAS,OAAO;AAC3C,WAAO,oBAAoB,gBAAgB,cAAc;AACzD,WAAO,UAAA;AAAA,EACT;AAEA,QAAM,2BAA2B,CAAC,UAAuB;AACvD,eAAW,kBAAkB,gBAAgB,UAAU;AACrD,qBAAe,OAAO,KAAK;AAAA,IAC7B;AACA,oBAAgB,MAAA;AAAA,EAClB;AAEA,QAAM,YAAY,CAAC,UAAuB;AACxC,UAAM,eAAe;AACrB,UAAM,WAAW,aAAa;AAE9B,UAAM,iBAAiB,gBAAgB,IAAI,SAAS,SAAS;AAC7D,QAAI,CAAC,gBAAgB;AACnB;AAAA,IACF;AACA,oBAAgB,OAAO,SAAS,SAAS;AAEzC,QAAI,SAAS,IAAI;AACf,qBAAe,QAAQ,SAAS,QAAQ,CAAA,CAAE;AAC1C;AAAA,IACF;AAEA,mBAAe,OAAO,kBAAkB,SAAS,MAAM,SAAS,KAAK,CAAC;AAAA,EACxE;AAEA,QAAM,UAAU,MAAY;AAC1B;AAAA,MACE,IAAI,4BAA4B,qCAAqC;AAAA,IAAA;AAEvE,kBAAA;AAAA,EACF;AAEA,QAAM,iBAAiB,MAAY;AACjC;AAAA,MACE,IAAI;AAAA,QACF;AAAA,MAAA;AAAA,IACF;AAEF,kBAAA;AAAA,EACF;AAEA,QAAM,aAAa,MAAY;AAG7B;AAAA,MACE,IAAI;AAAA,QACF;AAAA,QACA;AAAA,MAAA;AAAA,IACF;AAEF,kBAAA;AAAA,EACF;AAEA,SAAO,iBAAiB,WAAW,SAAS;AAC5C,SAAO,iBAAiB,SAAS,OAAO;AACxC,SAAO,iBAAiB,gBAAgB,cAAc;AACtD,aAAW,iBAAiB,YAAY,UAAU;AAElD,QAAM,oBAAoB,CACxB,YACe;AACf,QAAI,UAAU;AACZ,aAAO,QAAQ;AAAA,QACb,IAAI;AAAA,UACF;AAAA,QAAA;AAAA,MACF;AAAA,IAEJ;AAEA,UAAM,YAAY,cAAA;AAClB,WAAO,IAAI,QAAW,CAAC,SAAS,WAAW;AACzC,sBAAgB,IAAI,WAAW;AAAA,QAC7B,SAAS,CAAC,UAAU;AAClB,kBAAQ,KAAU;AAAA,QACpB;AAAA,QACA;AAAA,MAAA,CACD;AACD,UAAI;AACF,cAAM,UAAU;AAAA,UACd,GAAG;AAAA,UACH;AAAA,QAAA;AAEF,eAAO,YAAY,OAAO;AAAA,MAC5B,SAAS,OAAO;AACd,wBAAgB,OAAO,SAAS;AAChC;AAAA,UACE,IAAI;AAAA,YACF,0CAA2C,MAAgB,OAAO;AAAA,UAAA;AAAA,QACpE;AAAA,MAEJ;AAAA,IACF,CAAC;AAAA,EACH;AAEA,MAAI;AACJ,QAAM,UAAU,MAAY;AAC1B,QAAI,CAAC,OAAQ;AACb,6BAAyB,kBAAkB,MAAM,CAAC;AAClD,kBAAA;AAAA,EACF;AACA,QAAM,YAAY,MAAY;AAC5B;AAAA,MACE,IAAI;AAAA,QACF,iDAAiD,SAAS;AAAA,QAC1D;AAAA,MAAA;AAAA,IACF;AAEF,kBAAA;AAAA,EACF;AAEA,MAAI;AACF,UAAM,iBAAiB,kBAAwB;AAAA,MAC7C,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA,CACD;AACD,YAAQ,iBAAiB,SAAS,SAAS,EAAE,MAAM,MAAM;AACzD,QAAI,QAAQ,QAAS,SAAA;AACrB,QAAI,YAAY,GAAG;AACjB,oBAAc,WAAW,WAAW,SAAS;AAAA,IAC/C;AACA,UAAM;AAAA,EACR,SAAS,OAAO;AACd,kBAAA;AACA,UAAM;AAAA,EACR,UAAA;AACE,QAAI,gBAAgB,OAAW,cAAa,WAAW;AACvD,YAAQ,oBAAoB,SAAS,OAAO;AAAA,EAC9C;AAEA,SAAO;AAAA,IACL,SAAS,CACP,KACA,SAAiC,CAAA,MAEjC,kBAAuC;AAAA,MACrC,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IAAA,CACD;AAAA,IACH,OAAO,YAAY;AACjB,UAAI,UAAU;AACZ;AAAA,MACF;AAEA,UAAI;AACJ,UAAI;AACF,cAAM,kBAAwB;AAAA,UAC5B,MAAM;AAAA,QAAA,CACP;AAAA,MACH,SAAS,OAAO;AACd,qBAAa;AAAA,MACf,UAAA;AACE,sBAAA;AAAA,MACF;AAEA,UAAI,YAAY;AACd,cAAM;AAAA,MACR;AAAA,IACF;AAAA,EAAA;AAEJ;"}
@@ -1,6 +1,6 @@
1
1
  function WorkerWrapper(options) {
2
2
  return new Worker(
3
- "" + new URL("../assets/opfs-worker-uyjx5Rus.js", import.meta.url).href,
3
+ "" + new URL("../assets/opfs-worker-accoEoax.js", import.meta.url).href,
4
4
  {
5
5
  name: options?.name
6
6
  }
@@ -1,4 +1,4 @@
1
- import { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core';
1
+ import { SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY, SQLiteDriver } from '@tanstack/db-sqlite-persistence-core';
2
2
  export type BrowserWASQLiteDatabase = {
3
3
  execute: <TRow = unknown>(sql: string, params?: ReadonlyArray<unknown>) => Promise<ReadonlyArray<TRow>>;
4
4
  close?: () => Promise<void> | void;
@@ -7,9 +7,9 @@ export type BrowserWASQLiteDriverOptions = {
7
7
  database: BrowserWASQLiteDatabase;
8
8
  };
9
9
  export declare class BrowserWASQLiteDriver implements SQLiteDriver {
10
+ readonly [SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY]: {};
10
11
  private readonly database;
11
- private queue;
12
- private nextSavepointId;
12
+ private readonly executionState;
13
13
  private closed;
14
14
  constructor(options: BrowserWASQLiteDriverOptions);
15
15
  exec(sql: string): Promise<void>;
@@ -1,4 +1,18 @@
1
- import { InvalidPersistedCollectionConfigError } from "@tanstack/db-sqlite-persistence-core";
1
+ import { SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY, InvalidPersistedCollectionConfigError } from "@tanstack/db-sqlite-persistence-core";
2
+ var _a;
3
+ const databaseExecutionStates = /* @__PURE__ */ new WeakMap();
4
+ function getDatabaseExecutionState(database) {
5
+ const existing = databaseExecutionStates.get(database);
6
+ if (existing) {
7
+ return existing;
8
+ }
9
+ const state = {
10
+ queue: Promise.resolve(),
11
+ nextSavepointId: 1
12
+ };
13
+ databaseExecutionStates.set(database, state);
14
+ return state;
15
+ }
2
16
  function assertTransactionCallbackHasDriverArg(fn) {
3
17
  if (fn.length > 0) {
4
18
  return;
@@ -14,29 +28,34 @@ function assertDatabaseShape(database) {
14
28
  );
15
29
  }
16
30
  }
31
+ _a = SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY;
17
32
  class BrowserWASQLiteDriver {
18
33
  constructor(options) {
19
- this.queue = Promise.resolve();
20
- this.nextSavepointId = 1;
34
+ this[_a] = {};
21
35
  this.closed = false;
22
36
  assertDatabaseShape(options.database);
23
37
  this.database = options.database;
38
+ this.executionState = getDatabaseExecutionState(this.database);
24
39
  }
25
- async exec(sql) {
26
- await this.enqueue(async () => {
40
+ exec(sql) {
41
+ return this.enqueue(async () => {
27
42
  await this.database.execute(sql);
28
43
  });
29
44
  }
30
- async query(sql, params = []) {
45
+ query(sql, params = []) {
31
46
  return this.enqueue(() => this.database.execute(sql, params));
32
47
  }
33
- async run(sql, params = []) {
34
- await this.enqueue(async () => {
48
+ run(sql, params = []) {
49
+ return this.enqueue(async () => {
35
50
  await this.database.execute(sql, params);
36
51
  });
37
52
  }
38
- async transaction(fn) {
39
- assertTransactionCallbackHasDriverArg(fn);
53
+ transaction(fn) {
54
+ try {
55
+ assertTransactionCallbackHasDriverArg(fn);
56
+ } catch (error) {
57
+ return Promise.reject(error);
58
+ }
40
59
  return this.enqueue(async () => {
41
60
  await this.database.execute(`BEGIN IMMEDIATE`);
42
61
  try {
@@ -52,7 +71,7 @@ class BrowserWASQLiteDriver {
52
71
  }
53
72
  });
54
73
  }
55
- async transactionWithDriver(fn) {
74
+ transactionWithDriver(fn) {
56
75
  return this.transaction(fn);
57
76
  }
58
77
  async close() {
@@ -78,8 +97,8 @@ class BrowserWASQLiteDriver {
78
97
  }
79
98
  async runNestedTransaction(fn) {
80
99
  assertTransactionCallbackHasDriverArg(fn);
81
- const savepointName = `tsdb_sp_${this.nextSavepointId}`;
82
- this.nextSavepointId++;
100
+ const savepointName = `tsdb_sp_${this.executionState.nextSavepointId}`;
101
+ this.executionState.nextSavepointId++;
83
102
  await this.database.execute(`SAVEPOINT ${savepointName}`);
84
103
  try {
85
104
  const result = await fn(this.createTransactionDriver());
@@ -92,8 +111,13 @@ class BrowserWASQLiteDriver {
92
111
  }
93
112
  }
94
113
  enqueue(operation) {
95
- const queuedOperation = this.queue.then(operation, operation);
96
- this.queue = queuedOperation.then(
114
+ const queuedOperation = this.executionState.queue.then(operation, operation);
115
+ Object.defineProperty(
116
+ queuedOperation,
117
+ SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY,
118
+ { value: this[SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY] }
119
+ );
120
+ this.executionState.queue = queuedOperation.then(
97
121
  () => void 0,
98
122
  () => void 0
99
123
  );
@@ -1 +1 @@
1
- {"version":3,"file":"wa-sqlite-driver.js","sources":["../../src/wa-sqlite-driver.ts"],"sourcesContent":["import { InvalidPersistedCollectionConfigError } from '@tanstack/db-sqlite-persistence-core'\nimport type { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core'\n\nexport type BrowserWASQLiteDatabase = {\n execute: <TRow = unknown>(\n sql: string,\n params?: ReadonlyArray<unknown>,\n ) => Promise<ReadonlyArray<TRow>>\n close?: () => Promise<void> | void\n}\n\nexport type BrowserWASQLiteDriverOptions = {\n database: BrowserWASQLiteDatabase\n}\n\nfunction assertTransactionCallbackHasDriverArg(\n fn: (transactionDriver: SQLiteDriver) => Promise<unknown>,\n): void {\n if (fn.length > 0) {\n return\n }\n\n throw new InvalidPersistedCollectionConfigError(\n `SQLiteDriver.transaction callback must accept the transaction driver argument`,\n )\n}\n\nfunction assertDatabaseShape(\n database: BrowserWASQLiteDatabase,\n): asserts database is BrowserWASQLiteDatabase {\n if (typeof database.execute !== `function`) {\n throw new InvalidPersistedCollectionConfigError(\n `Browser wa-sqlite database handle must provide execute(sql, params?)`,\n )\n }\n}\n\nexport class BrowserWASQLiteDriver implements SQLiteDriver {\n private readonly database: BrowserWASQLiteDatabase\n private queue: Promise<void> = Promise.resolve()\n private nextSavepointId = 1\n private closed = false\n\n constructor(options: BrowserWASQLiteDriverOptions) {\n assertDatabaseShape(options.database)\n this.database = options.database\n }\n\n async exec(sql: string): Promise<void> {\n await this.enqueue(async () => {\n await this.database.execute(sql)\n })\n }\n\n async query<T>(\n sql: string,\n params: ReadonlyArray<unknown> = [],\n ): Promise<ReadonlyArray<T>> {\n return this.enqueue(() => this.database.execute<T>(sql, params))\n }\n\n async run(sql: string, params: ReadonlyArray<unknown> = []): Promise<void> {\n await this.enqueue(async () => {\n await this.database.execute(sql, params)\n })\n }\n\n async transaction<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n assertTransactionCallbackHasDriverArg(fn)\n\n return this.enqueue(async () => {\n await this.database.execute(`BEGIN IMMEDIATE`)\n try {\n const result = await fn(this.createTransactionDriver())\n await this.database.execute(`COMMIT`)\n return result\n } catch (error) {\n try {\n await this.database.execute(`ROLLBACK`)\n } catch {\n // Preserve original transaction error.\n }\n throw error\n }\n })\n }\n\n async transactionWithDriver<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n return this.transaction(fn)\n }\n\n async close(): Promise<void> {\n if (this.closed) {\n return\n }\n this.closed = true\n\n if (typeof this.database.close === `function`) {\n await Promise.resolve(this.database.close())\n }\n }\n\n getDatabase(): BrowserWASQLiteDatabase {\n return this.database\n }\n\n private createTransactionDriver(): SQLiteDriver {\n return {\n exec: (sql) => this.database.execute(sql).then(() => undefined),\n query: <T>(sql: string, params: ReadonlyArray<unknown> = []) =>\n this.database.execute<T>(sql, params),\n run: (sql: string, params: ReadonlyArray<unknown> = []) =>\n this.database.execute(sql, params).then(() => undefined),\n transaction: <T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>) =>\n this.runNestedTransaction(fn),\n transactionWithDriver: <T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ) => this.runNestedTransaction(fn),\n }\n }\n\n private async runNestedTransaction<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n assertTransactionCallbackHasDriverArg(fn)\n\n const savepointName = `tsdb_sp_${this.nextSavepointId}`\n this.nextSavepointId++\n await this.database.execute(`SAVEPOINT ${savepointName}`)\n try {\n const result = await fn(this.createTransactionDriver())\n await this.database.execute(`RELEASE SAVEPOINT ${savepointName}`)\n return result\n } catch (error) {\n await this.database.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`)\n await this.database.execute(`RELEASE SAVEPOINT ${savepointName}`)\n throw error\n }\n }\n\n private enqueue<T>(operation: () => Promise<T> | T): Promise<T> {\n const queuedOperation = this.queue.then(operation, operation)\n this.queue = queuedOperation.then(\n () => undefined,\n () => undefined,\n )\n return queuedOperation\n }\n}\n"],"names":[],"mappings":";AAeA,SAAS,sCACP,IACM;AACN,MAAI,GAAG,SAAS,GAAG;AACjB;AAAA,EACF;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EAAA;AAEJ;AAEA,SAAS,oBACP,UAC6C;AAC7C,MAAI,OAAO,SAAS,YAAY,YAAY;AAC1C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACF;AAEO,MAAM,sBAA8C;AAAA,EAMzD,YAAY,SAAuC;AAJnD,SAAQ,QAAuB,QAAQ,QAAA;AACvC,SAAQ,kBAAkB;AAC1B,SAAQ,SAAS;AAGf,wBAAoB,QAAQ,QAAQ;AACpC,SAAK,WAAW,QAAQ;AAAA,EAC1B;AAAA,EAEA,MAAM,KAAK,KAA4B;AACrC,UAAM,KAAK,QAAQ,YAAY;AAC7B,YAAM,KAAK,SAAS,QAAQ,GAAG;AAAA,IACjC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,MACJ,KACA,SAAiC,IACN;AAC3B,WAAO,KAAK,QAAQ,MAAM,KAAK,SAAS,QAAW,KAAK,MAAM,CAAC;AAAA,EACjE;AAAA,EAEA,MAAM,IAAI,KAAa,SAAiC,IAAmB;AACzE,UAAM,KAAK,QAAQ,YAAY;AAC7B,YAAM,KAAK,SAAS,QAAQ,KAAK,MAAM;AAAA,IACzC,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,YACJ,IACY;AACZ,0CAAsC,EAAE;AAExC,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,KAAK,SAAS,QAAQ,iBAAiB;AAC7C,UAAI;AACF,cAAM,SAAS,MAAM,GAAG,KAAK,yBAAyB;AACtD,cAAM,KAAK,SAAS,QAAQ,QAAQ;AACpC,eAAO;AAAA,MACT,SAAS,OAAO;AACd,YAAI;AACF,gBAAM,KAAK,SAAS,QAAQ,UAAU;AAAA,QACxC,QAAQ;AAAA,QAER;AACA,cAAM;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,sBACJ,IACY;AACZ,WAAO,KAAK,YAAY,EAAE;AAAA,EAC5B;AAAA,EAEA,MAAM,QAAuB;AAC3B,QAAI,KAAK,QAAQ;AACf;AAAA,IACF;AACA,SAAK,SAAS;AAEd,QAAI,OAAO,KAAK,SAAS,UAAU,YAAY;AAC7C,YAAM,QAAQ,QAAQ,KAAK,SAAS,OAAO;AAAA,IAC7C;AAAA,EACF;AAAA,EAEA,cAAuC;AACrC,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,0BAAwC;AAC9C,WAAO;AAAA,MACL,MAAM,CAAC,QAAQ,KAAK,SAAS,QAAQ,GAAG,EAAE,KAAK,MAAM,MAAS;AAAA,MAC9D,OAAO,CAAI,KAAa,SAAiC,CAAA,MACvD,KAAK,SAAS,QAAW,KAAK,MAAM;AAAA,MACtC,KAAK,CAAC,KAAa,SAAiC,CAAA,MAClD,KAAK,SAAS,QAAQ,KAAK,MAAM,EAAE,KAAK,MAAM,MAAS;AAAA,MACzD,aAAa,CAAI,OACf,KAAK,qBAAqB,EAAE;AAAA,MAC9B,uBAAuB,CACrB,OACG,KAAK,qBAAqB,EAAE;AAAA,IAAA;AAAA,EAErC;AAAA,EAEA,MAAc,qBACZ,IACY;AACZ,0CAAsC,EAAE;AAExC,UAAM,gBAAgB,WAAW,KAAK,eAAe;AACrD,SAAK;AACL,UAAM,KAAK,SAAS,QAAQ,aAAa,aAAa,EAAE;AACxD,QAAI;AACF,YAAM,SAAS,MAAM,GAAG,KAAK,yBAAyB;AACtD,YAAM,KAAK,SAAS,QAAQ,qBAAqB,aAAa,EAAE;AAChE,aAAO;AAAA,IACT,SAAS,OAAO;AACd,YAAM,KAAK,SAAS,QAAQ,yBAAyB,aAAa,EAAE;AACpE,YAAM,KAAK,SAAS,QAAQ,qBAAqB,aAAa,EAAE;AAChE,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,QAAW,WAA6C;AAC9D,UAAM,kBAAkB,KAAK,MAAM,KAAK,WAAW,SAAS;AAC5D,SAAK,QAAQ,gBAAgB;AAAA,MAC3B,MAAM;AAAA,MACN,MAAM;AAAA,IAAA;AAER,WAAO;AAAA,EACT;AACF;"}
1
+ {"version":3,"file":"wa-sqlite-driver.js","sources":["../../src/wa-sqlite-driver.ts"],"sourcesContent":["import {\n InvalidPersistedCollectionConfigError,\n SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY,\n} from '@tanstack/db-sqlite-persistence-core'\nimport type { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core'\n\nexport type BrowserWASQLiteDatabase = {\n execute: <TRow = unknown>(\n sql: string,\n params?: ReadonlyArray<unknown>,\n ) => Promise<ReadonlyArray<TRow>>\n close?: () => Promise<void> | void\n}\n\nexport type BrowserWASQLiteDriverOptions = {\n database: BrowserWASQLiteDatabase\n}\n\ntype DatabaseExecutionState = {\n queue: Promise<void>\n nextSavepointId: number\n}\n\nconst databaseExecutionStates = new WeakMap<\n BrowserWASQLiteDatabase,\n DatabaseExecutionState\n>()\n\nfunction getDatabaseExecutionState(\n database: BrowserWASQLiteDatabase,\n): DatabaseExecutionState {\n const existing = databaseExecutionStates.get(database)\n if (existing) {\n return existing\n }\n\n const state: DatabaseExecutionState = {\n queue: Promise.resolve(),\n nextSavepointId: 1,\n }\n databaseExecutionStates.set(database, state)\n return state\n}\n\nfunction assertTransactionCallbackHasDriverArg(\n fn: (transactionDriver: SQLiteDriver) => Promise<unknown>,\n): void {\n if (fn.length > 0) {\n return\n }\n\n throw new InvalidPersistedCollectionConfigError(\n `SQLiteDriver.transaction callback must accept the transaction driver argument`,\n )\n}\n\nfunction assertDatabaseShape(\n database: BrowserWASQLiteDatabase,\n): asserts database is BrowserWASQLiteDatabase {\n if (typeof database.execute !== `function`) {\n throw new InvalidPersistedCollectionConfigError(\n `Browser wa-sqlite database handle must provide execute(sql, params?)`,\n )\n }\n}\n\nexport class BrowserWASQLiteDriver implements SQLiteDriver {\n readonly [SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY] = {}\n private readonly database: BrowserWASQLiteDatabase\n private readonly executionState: DatabaseExecutionState\n private closed = false\n\n constructor(options: BrowserWASQLiteDriverOptions) {\n assertDatabaseShape(options.database)\n this.database = options.database\n this.executionState = getDatabaseExecutionState(this.database)\n }\n\n exec(sql: string): Promise<void> {\n return this.enqueue(async () => {\n await this.database.execute(sql)\n })\n }\n\n query<T>(\n sql: string,\n params: ReadonlyArray<unknown> = [],\n ): Promise<ReadonlyArray<T>> {\n return this.enqueue(() => this.database.execute<T>(sql, params))\n }\n\n run(sql: string, params: ReadonlyArray<unknown> = []): Promise<void> {\n return this.enqueue(async () => {\n await this.database.execute(sql, params)\n })\n }\n\n transaction<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n try {\n assertTransactionCallbackHasDriverArg(fn)\n } catch (error) {\n return Promise.reject(error)\n }\n\n return this.enqueue(async () => {\n await this.database.execute(`BEGIN IMMEDIATE`)\n try {\n const result = await fn(this.createTransactionDriver())\n await this.database.execute(`COMMIT`)\n return result\n } catch (error) {\n try {\n await this.database.execute(`ROLLBACK`)\n } catch {\n // Preserve original transaction error.\n }\n throw error\n }\n })\n }\n\n transactionWithDriver<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n return this.transaction(fn)\n }\n\n async close(): Promise<void> {\n if (this.closed) {\n return\n }\n this.closed = true\n\n if (typeof this.database.close === `function`) {\n await Promise.resolve(this.database.close())\n }\n }\n\n getDatabase(): BrowserWASQLiteDatabase {\n return this.database\n }\n\n private createTransactionDriver(): SQLiteDriver {\n return {\n exec: (sql) => this.database.execute(sql).then(() => undefined),\n query: <T>(sql: string, params: ReadonlyArray<unknown> = []) =>\n this.database.execute<T>(sql, params),\n run: (sql: string, params: ReadonlyArray<unknown> = []) =>\n this.database.execute(sql, params).then(() => undefined),\n transaction: <T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>) =>\n this.runNestedTransaction(fn),\n transactionWithDriver: <T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ) => this.runNestedTransaction(fn),\n }\n }\n\n private async runNestedTransaction<T>(\n fn: (transactionDriver: SQLiteDriver) => Promise<T>,\n ): Promise<T> {\n assertTransactionCallbackHasDriverArg(fn)\n\n const savepointName = `tsdb_sp_${this.executionState.nextSavepointId}`\n this.executionState.nextSavepointId++\n await this.database.execute(`SAVEPOINT ${savepointName}`)\n try {\n const result = await fn(this.createTransactionDriver())\n await this.database.execute(`RELEASE SAVEPOINT ${savepointName}`)\n return result\n } catch (error) {\n await this.database.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`)\n await this.database.execute(`RELEASE SAVEPOINT ${savepointName}`)\n throw error\n }\n }\n\n private enqueue<T>(operation: () => Promise<T> | T): Promise<T> {\n const queuedOperation = this.executionState.queue.then(operation, operation)\n // Brand the exact Promise returned to callers. Transparent wrappers may\n // preserve this identity for late discovery; wrappers that create a new\n // Promise must forward the driver key before adapter construction.\n Object.defineProperty(\n queuedOperation,\n SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY,\n { value: this[SQLITE_DRIVER_SHARED_LOGICAL_SCHEDULING_KEY] },\n )\n this.executionState.queue = queuedOperation.then(\n () => undefined,\n () => undefined,\n )\n return queuedOperation\n }\n}\n"],"names":[],"mappings":";AAAA,IAAA;AAuBA,MAAM,8CAA8B,QAAA;AAKpC,SAAS,0BACP,UACwB;AACxB,QAAM,WAAW,wBAAwB,IAAI,QAAQ;AACrD,MAAI,UAAU;AACZ,WAAO;AAAA,EACT;AAEA,QAAM,QAAgC;AAAA,IACpC,OAAO,QAAQ,QAAA;AAAA,IACf,iBAAiB;AAAA,EAAA;AAEnB,0BAAwB,IAAI,UAAU,KAAK;AAC3C,SAAO;AACT;AAEA,SAAS,sCACP,IACM;AACN,MAAI,GAAG,SAAS,GAAG;AACjB;AAAA,EACF;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EAAA;AAEJ;AAEA,SAAS,oBACP,UAC6C;AAC7C,MAAI,OAAO,SAAS,YAAY,YAAY;AAC1C,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAAA,EAEJ;AACF;AAGY,KAAA;AADL,MAAM,sBAA8C;AAAA,EAMzD,YAAY,SAAuC;AALnD,SAAU,MAA+C,CAAA;AAGzD,SAAQ,SAAS;AAGf,wBAAoB,QAAQ,QAAQ;AACpC,SAAK,WAAW,QAAQ;AACxB,SAAK,iBAAiB,0BAA0B,KAAK,QAAQ;AAAA,EAC/D;AAAA,EAEA,KAAK,KAA4B;AAC/B,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,KAAK,SAAS,QAAQ,GAAG;AAAA,IACjC,CAAC;AAAA,EACH;AAAA,EAEA,MACE,KACA,SAAiC,IACN;AAC3B,WAAO,KAAK,QAAQ,MAAM,KAAK,SAAS,QAAW,KAAK,MAAM,CAAC;AAAA,EACjE;AAAA,EAEA,IAAI,KAAa,SAAiC,IAAmB;AACnE,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,KAAK,SAAS,QAAQ,KAAK,MAAM;AAAA,IACzC,CAAC;AAAA,EACH;AAAA,EAEA,YACE,IACY;AACZ,QAAI;AACF,4CAAsC,EAAE;AAAA,IAC1C,SAAS,OAAO;AACd,aAAO,QAAQ,OAAO,KAAK;AAAA,IAC7B;AAEA,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,KAAK,SAAS,QAAQ,iBAAiB;AAC7C,UAAI;AACF,cAAM,SAAS,MAAM,GAAG,KAAK,yBAAyB;AACtD,cAAM,KAAK,SAAS,QAAQ,QAAQ;AACpC,eAAO;AAAA,MACT,SAAS,OAAO;AACd,YAAI;AACF,gBAAM,KAAK,SAAS,QAAQ,UAAU;AAAA,QACxC,QAAQ;AAAA,QAER;AACA,cAAM;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,sBACE,IACY;AACZ,WAAO,KAAK,YAAY,EAAE;AAAA,EAC5B;AAAA,EAEA,MAAM,QAAuB;AAC3B,QAAI,KAAK,QAAQ;AACf;AAAA,IACF;AACA,SAAK,SAAS;AAEd,QAAI,OAAO,KAAK,SAAS,UAAU,YAAY;AAC7C,YAAM,QAAQ,QAAQ,KAAK,SAAS,OAAO;AAAA,IAC7C;AAAA,EACF;AAAA,EAEA,cAAuC;AACrC,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,0BAAwC;AAC9C,WAAO;AAAA,MACL,MAAM,CAAC,QAAQ,KAAK,SAAS,QAAQ,GAAG,EAAE,KAAK,MAAM,MAAS;AAAA,MAC9D,OAAO,CAAI,KAAa,SAAiC,CAAA,MACvD,KAAK,SAAS,QAAW,KAAK,MAAM;AAAA,MACtC,KAAK,CAAC,KAAa,SAAiC,CAAA,MAClD,KAAK,SAAS,QAAQ,KAAK,MAAM,EAAE,KAAK,MAAM,MAAS;AAAA,MACzD,aAAa,CAAI,OACf,KAAK,qBAAqB,EAAE;AAAA,MAC9B,uBAAuB,CACrB,OACG,KAAK,qBAAqB,EAAE;AAAA,IAAA;AAAA,EAErC;AAAA,EAEA,MAAc,qBACZ,IACY;AACZ,0CAAsC,EAAE;AAExC,UAAM,gBAAgB,WAAW,KAAK,eAAe,eAAe;AACpE,SAAK,eAAe;AACpB,UAAM,KAAK,SAAS,QAAQ,aAAa,aAAa,EAAE;AACxD,QAAI;AACF,YAAM,SAAS,MAAM,GAAG,KAAK,yBAAyB;AACtD,YAAM,KAAK,SAAS,QAAQ,qBAAqB,aAAa,EAAE;AAChE,aAAO;AAAA,IACT,SAAS,OAAO;AACd,YAAM,KAAK,SAAS,QAAQ,yBAAyB,aAAa,EAAE;AACpE,YAAM,KAAK,SAAS,QAAQ,qBAAqB,aAAa,EAAE;AAChE,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,QAAW,WAA6C;AAC9D,UAAM,kBAAkB,KAAK,eAAe,MAAM,KAAK,WAAW,SAAS;AAI3E,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,EAAE,OAAO,KAAK,2CAA2C,EAAA;AAAA,IAAE;AAE7D,SAAK,eAAe,QAAQ,gBAAgB;AAAA,MAC1C,MAAM;AAAA,MACN,MAAM;AAAA,IAAA;AAER,WAAO;AAAA,EACT;AACF;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/browser-db-sqlite-persistence",
3
- "version": "0.2.23",
3
+ "version": "0.2.26",
4
4
  "description": "Browser wa-sqlite persisted collection adapter for TanStack DB",
5
5
  "author": "TanStack Team",
6
6
  "license": "MIT",
@@ -41,7 +41,7 @@
41
41
  "src"
42
42
  ],
43
43
  "dependencies": {
44
- "@tanstack/db-sqlite-persistence-core": "0.2.23"
44
+ "@tanstack/db-sqlite-persistence-core": "0.4.1"
45
45
  },
46
46
  "peerDependencies": {
47
47
  "@journeyapps/wa-sqlite": "^1.4.1",
@@ -49,15 +49,21 @@
49
49
  },
50
50
  "devDependencies": {
51
51
  "@journeyapps/wa-sqlite": "^1.4.1",
52
+ "@playwright/test": "^1.60.0",
53
+ "@tanstack/query-core": "^5.90.20",
52
54
  "@types/better-sqlite3": "^7.6.13",
53
55
  "@vitest/coverage-istanbul": "^3.2.4",
54
- "better-sqlite3": "^12.6.2"
56
+ "better-sqlite3": "^12.6.2",
57
+ "@tanstack/query-db-collection": "1.3.2"
55
58
  },
56
59
  "scripts": {
57
60
  "build": "vite build",
58
61
  "dev": "vite build --watch",
59
62
  "lint": "eslint . --fix",
60
63
  "test": "vitest --run",
64
+ "test:oracles": "vitest --run --coverage.enabled=false tests/shared-driver-fairness-oracle.test.ts tests/opfs-page-lifecycle-oracle.test.ts tests/opfs-worker-diagnostics-oracle.test.ts tests/per-collection-coordinator-oracle.test.ts",
65
+ "test:opfs-fairness": "playwright test --config playwright.opfs.config.ts",
66
+ "test:opfs-electric": "playwright test --config playwright.opfs-electric.config.ts",
61
67
  "test:e2e": "pnpm --filter @tanstack/db-ivm build && pnpm --filter @tanstack/db build && pnpm --filter @tanstack/db-sqlite-persistence-core build && pnpm --filter @tanstack/browser-db-sqlite-persistence build && vitest --config vitest.e2e.config.ts --run"
62
68
  }
63
69
  }