@tanstack/cloudflare-durable-objects-db-sqlite-persistence 0.1.2

package/README.md

@@ -0,0 +1,48 @@
+# @tanstack/cloudflare-durable-objects-db-sqlite-persistence
+
+Thin SQLite persistence for Cloudflare Durable Objects.
+
+## Public API
+
+- `createCloudflareDOSQLitePersistence(...)`
+- `persistedCollectionOptions(...)` (re-exported from core)
+
+## Quick start
+
+```ts
+import { createCollection } from '@tanstack/db'
+import {
+  createCloudflareDOSQLitePersistence,
+  persistedCollectionOptions,
+} from '@tanstack/cloudflare-durable-objects-db-sqlite-persistence'
+
+type Todo = {
+  id: string
+  title: string
+  completed: boolean
+}
+
+export class TodosObject extends DurableObject {
+  persistence = createCloudflareDOSQLitePersistence({
+    // Pass full storage to use native DO transaction support.
+    storage: this.ctx.storage,
+  })
+
+  todos = createCollection(
+    persistedCollectionOptions<Todo, string>({
+      id: `todos`,
+      getKey: (todo) => todo.id,
+      persistence: this.persistence,
+      schemaVersion: 1, // Per-collection schema version
+    }),
+  )
+}
+```
+
+## Notes
+
+- One shared persistence instance can serve multiple collections.
+- Mode defaults are inferred from collection usage:
+  - sync config present => `sync-present-reset`
+  - no sync config => `sync-absent-error`
+- You can still override with `schemaMismatchPolicy` if needed.

package/dist/cjs/do-driver.cjs

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const dbSqlitePersistenceCore = require("@tanstack/db-sqlite-persistence-core");
+function assertTransactionCallbackHasDriverArg(fn) {
+  if (fn.length > 0) {
+    return;
+  }
+  throw new dbSqlitePersistenceCore.InvalidPersistedCollectionConfigError(
+    `SQLiteDriver.transaction callback must accept the transaction driver argument`
+  );
+}
+function isIterableRecord(value) {
+  if (!value || typeof value !== `object`) {
+    return false;
+  }
+  const iterator = value[Symbol.iterator];
+  return typeof iterator === `function`;
+}
+function toRowArray(result, sql) {
+  if (result == null) {
+    return [];
+  }
+  if (Array.isArray(result)) {
+    return result;
+  }
+  const cursorResult = result;
+  if (typeof cursorResult.toArray === `function`) {
+    return cursorResult.toArray();
+  }
+  if (isIterableRecord(cursorResult)) {
+    return Array.from(cursorResult);
+  }
+  throw new dbSqlitePersistenceCore.InvalidPersistedCollectionConfigError(
+    `Unsupported Durable Object SQL result shape for query "${sql}"`
+  );
+}
+class CloudflareDOSQLiteDriver {
+  constructor(options) {
+    this.queue = Promise.resolve();
+    this.nextSavepointId = 1;
+    const resolvedStorage = `storage` in options ? options.storage : {
+      sql: options.sql,
+      ...typeof options.transaction === `function` ? { transaction: options.transaction } : {}
+    };
+    const resolvedSqlStorage = resolvedStorage.sql;
+    if (typeof resolvedSqlStorage.exec !== `function`) {
+      throw new dbSqlitePersistenceCore.InvalidPersistedCollectionConfigError(
+        `Cloudflare DO SQL driver requires a sql.exec function`
+      );
+    }
+    this.storage = resolvedStorage;
+    this.sqlStorage = resolvedSqlStorage;
+    if (typeof resolvedStorage.transaction === `function`) {
+      const transactionMethod = resolvedStorage.transaction;
+      this.transactionExecutor = (fn) => Promise.resolve(
+        transactionMethod.call(resolvedStorage, fn)
+      );
+    } else {
+      this.transactionExecutor = null;
+    }
+  }
+  async exec(sql) {
+    await this.enqueue(() => {
+      this.execute(sql);
+    });
+  }
+  async query(sql, params = []) {
+    return this.enqueue(() => this.executeQuery(sql, params));
+  }
+  async run(sql, params = []) {
+    await this.enqueue(() => {
+      this.execute(sql, params);
+    });
+  }
+  async transaction(fn) {
+    assertTransactionCallbackHasDriverArg(fn);
+    return this.enqueue(async () => {
+      const transactionDriver = this.createTransactionDriver();
+      if (this.transactionExecutor) {
+        return this.transactionExecutor(() => fn(transactionDriver));
+      }
+      this.execute(`BEGIN IMMEDIATE`);
+      try {
+        const result = await fn(transactionDriver);
+        this.execute(`COMMIT`);
+        return result;
+      } catch (error) {
+        try {
+          this.execute(`ROLLBACK`);
+        } catch {
+        }
+        throw error;
+      }
+    });
+  }
+  async transactionWithDriver(fn) {
+    return this.transaction(fn);
+  }
+  getStorage() {
+    return this.storage;
+  }
+  execute(sql, params = []) {
+    return this.sqlStorage.exec(sql, ...params);
+  }
+  executeQuery(sql, params) {
+    const result = this.execute(sql, params);
+    return toRowArray(
+      result,
+      sql
+    );
+  }
+  enqueue(operation) {
+    const queuedOperation = this.queue.then(operation, operation);
+    this.queue = queuedOperation.then(
+      () => void 0,
+      () => void 0
+    );
+    return queuedOperation;
+  }
+  createTransactionDriver() {
+    const transactionDriver = {
+      exec: (sql) => {
+        this.execute(sql);
+        return Promise.resolve();
+      },
+      query: (sql, params = []) => Promise.resolve(this.executeQuery(sql, params)),
+      run: (sql, params = []) => {
+        this.execute(sql, params);
+        return Promise.resolve();
+      },
+      transaction: (fn) => {
+        assertTransactionCallbackHasDriverArg(fn);
+        return this.runNestedTransaction(transactionDriver, fn);
+      },
+      transactionWithDriver: (fn) => this.runNestedTransaction(transactionDriver, fn)
+    };
+    return transactionDriver;
+  }
+  async runNestedTransaction(transactionDriver, fn) {
+    if (this.transactionExecutor) {
+      throw new dbSqlitePersistenceCore.InvalidPersistedCollectionConfigError(
+        `Nested SQL savepoints are not supported when using Durable Object transaction API`
+      );
+    }
+    const savepointName = `tsdb_sp_${this.nextSavepointId}`;
+    this.nextSavepointId++;
+    this.execute(`SAVEPOINT ${savepointName}`);
+    try {
+      const result = await fn(transactionDriver);
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`);
+      return result;
+    } catch (error) {
+      this.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`);
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`);
+      throw error;
+    }
+  }
+}
+exports.CloudflareDOSQLiteDriver = CloudflareDOSQLiteDriver;
+//# sourceMappingURL=do-driver.cjs.map

package/dist/cjs/do-driver.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-driver.cjs","sources":["../../src/do-driver.ts"],"sourcesContent":["import { InvalidPersistedCollectionConfigError } from '@tanstack/db-sqlite-persistence-core'\nimport type { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core'\n\ntype DurableObjectSqlRow = Record<string, unknown>\n\ntype DurableObjectSqlCursorLike = Iterable<DurableObjectSqlRow> & {\n  toArray?: () => Array<DurableObjectSqlRow>\n}\n\nexport type DurableObjectSqlStorageLike = {\n  exec: (\n    sql: string,\n    ...params: ReadonlyArray<unknown>\n  ) => DurableObjectSqlCursorLike | ReadonlyArray<DurableObjectSqlRow> | null\n}\n\nexport type DurableObjectTransactionExecutor = <T>(\n  fn: () => Promise<T>,\n) => Promise<T>\n\nexport type DurableObjectStorageLike = {\n  sql: DurableObjectSqlStorageLike\n  transaction?: DurableObjectTransactionExecutor\n}\n\ntype CloudflareDOProvidedSqlOptions = {\n  sql: DurableObjectSqlStorageLike\n  transaction?: DurableObjectTransactionExecutor\n}\n\ntype CloudflareDOProvidedStorageOptions = {\n  storage: DurableObjectStorageLike\n}\n\nexport type CloudflareDOSQLiteDriverOptions =\n  | CloudflareDOProvidedSqlOptions\n  | CloudflareDOProvidedStorageOptions\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 isIterableRecord(\n  value: unknown,\n): value is Iterable<DurableObjectSqlRow> {\n  if (!value || typeof value !== `object`) {\n    return false\n  }\n\n  const iterator = (value as { [Symbol.iterator]?: unknown })[Symbol.iterator]\n  return typeof iterator === `function`\n}\n\nfunction toRowArray<T>(\n  result: ReturnType<DurableObjectSqlStorageLike[`exec`]>,\n  sql: string,\n): ReadonlyArray<T> {\n  if (result == null) {\n    return []\n  }\n\n  if (Array.isArray(result)) {\n    return result as ReadonlyArray<T>\n  }\n\n  const cursorResult = result as DurableObjectSqlCursorLike\n  if (typeof cursorResult.toArray === `function`) {\n    return cursorResult.toArray() as ReadonlyArray<T>\n  }\n\n  if (isIterableRecord(cursorResult)) {\n    return Array.from(cursorResult as Iterable<T>)\n  }\n\n  throw new InvalidPersistedCollectionConfigError(\n    `Unsupported Durable Object SQL result shape for query \"${sql}\"`,\n  )\n}\n\nexport class CloudflareDOSQLiteDriver implements SQLiteDriver {\n  private readonly sqlStorage: DurableObjectSqlStorageLike\n  private readonly storage: DurableObjectStorageLike\n  private readonly transactionExecutor: DurableObjectTransactionExecutor | null\n  private queue: Promise<void> = Promise.resolve()\n  private nextSavepointId = 1\n\n  constructor(options: CloudflareDOSQLiteDriverOptions) {\n    const resolvedStorage: DurableObjectStorageLike =\n      `storage` in options\n        ? options.storage\n        : {\n            sql: options.sql,\n            ...(typeof options.transaction === `function`\n              ? { transaction: options.transaction }\n              : {}),\n          }\n    const resolvedSqlStorage = resolvedStorage.sql\n    if (typeof resolvedSqlStorage.exec !== `function`) {\n      throw new InvalidPersistedCollectionConfigError(\n        `Cloudflare DO SQL driver requires a sql.exec function`,\n      )\n    }\n    this.storage = resolvedStorage\n    this.sqlStorage = resolvedSqlStorage\n    if (typeof resolvedStorage.transaction === `function`) {\n      const transactionMethod = resolvedStorage.transaction\n      this.transactionExecutor = <T>(fn: () => Promise<T>) =>\n        Promise.resolve(\n          transactionMethod.call(resolvedStorage, fn) as Promise<T> | T,\n        )\n    } else {\n      this.transactionExecutor = null\n    }\n  }\n\n  async exec(sql: string): Promise<void> {\n    await this.enqueue(() => {\n      this.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.executeQuery<T>(sql, params))\n  }\n\n  async run(sql: string, params: ReadonlyArray<unknown> = []): Promise<void> {\n    await this.enqueue(() => {\n      this.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      const transactionDriver = this.createTransactionDriver()\n      if (this.transactionExecutor) {\n        return this.transactionExecutor(() => fn(transactionDriver))\n      }\n\n      this.execute(`BEGIN IMMEDIATE`)\n      try {\n        const result = await fn(transactionDriver)\n        this.execute(`COMMIT`)\n        return result\n      } catch (error) {\n        try {\n          this.execute(`ROLLBACK`)\n        } catch {\n          // Keep the original transaction error as the primary failure.\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  getStorage(): DurableObjectStorageLike {\n    return this.storage\n  }\n\n  private execute(sql: string, params: ReadonlyArray<unknown> = []): unknown {\n    return this.sqlStorage.exec(sql, ...params)\n  }\n\n  private executeQuery<T>(\n    sql: string,\n    params: ReadonlyArray<unknown>,\n  ): ReadonlyArray<T> {\n    const result = this.execute(sql, params)\n    return toRowArray<T>(\n      result as ReturnType<DurableObjectSqlStorageLike[`exec`]>,\n      sql,\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  private createTransactionDriver(): SQLiteDriver {\n    const transactionDriver: SQLiteDriver = {\n      exec: (sql) => {\n        this.execute(sql)\n        return Promise.resolve()\n      },\n      query: <T>(\n        sql: string,\n        params: ReadonlyArray<unknown> = [],\n      ): Promise<ReadonlyArray<T>> =>\n        Promise.resolve(this.executeQuery<T>(sql, params)),\n      run: (sql, params = []) => {\n        this.execute(sql, params)\n        return Promise.resolve()\n      },\n      transaction: <T>(\n        fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n      ): Promise<T> => {\n        assertTransactionCallbackHasDriverArg(fn)\n        return this.runNestedTransaction(transactionDriver, fn)\n      },\n      transactionWithDriver: <T>(\n        fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n      ): Promise<T> => this.runNestedTransaction(transactionDriver, fn),\n    }\n\n    return transactionDriver\n  }\n\n  private async runNestedTransaction<T>(\n    transactionDriver: SQLiteDriver,\n    fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n  ): Promise<T> {\n    if (this.transactionExecutor) {\n      throw new InvalidPersistedCollectionConfigError(\n        `Nested SQL savepoints are not supported when using Durable Object transaction API`,\n      )\n    }\n\n    const savepointName = `tsdb_sp_${this.nextSavepointId}`\n    this.nextSavepointId++\n    this.execute(`SAVEPOINT ${savepointName}`)\n\n    try {\n      const result = await fn(transactionDriver)\n      this.execute(`RELEASE SAVEPOINT ${savepointName}`)\n      return result\n    } catch (error) {\n      this.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`)\n      this.execute(`RELEASE SAVEPOINT ${savepointName}`)\n      throw error\n    }\n  }\n}\n\nexport function createCloudflareDOSQLiteDriver(\n  options: CloudflareDOSQLiteDriverOptions,\n): CloudflareDOSQLiteDriver {\n  return new CloudflareDOSQLiteDriver(options)\n}\n"],"names":["InvalidPersistedCollectionConfigError"],"mappings":";;;AAsCA,SAAS,sCACP,IACM;AACN,MAAI,GAAG,SAAS,GAAG;AACjB;AAAA,EACF;AAEA,QAAM,IAAIA,wBAAAA;AAAAA,IACR;AAAA,EAAA;AAEJ;AAEA,SAAS,iBACP,OACwC;AACxC,MAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,WAAO;AAAA,EACT;AAEA,QAAM,WAAY,MAA0C,OAAO,QAAQ;AAC3E,SAAO,OAAO,aAAa;AAC7B;AAEA,SAAS,WACP,QACA,KACkB;AAClB,MAAI,UAAU,MAAM;AAClB,WAAO,CAAA;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,WAAO;AAAA,EACT;AAEA,QAAM,eAAe;AACrB,MAAI,OAAO,aAAa,YAAY,YAAY;AAC9C,WAAO,aAAa,QAAA;AAAA,EACtB;AAEA,MAAI,iBAAiB,YAAY,GAAG;AAClC,WAAO,MAAM,KAAK,YAA2B;AAAA,EAC/C;AAEA,QAAM,IAAIA,wBAAAA;AAAAA,IACR,0DAA0D,GAAG;AAAA,EAAA;AAEjE;AAEO,MAAM,yBAAiD;AAAA,EAO5D,YAAY,SAA0C;AAHtD,SAAQ,QAAuB,QAAQ,QAAA;AACvC,SAAQ,kBAAkB;AAGxB,UAAM,kBACJ,aAAa,UACT,QAAQ,UACR;AAAA,MACE,KAAK,QAAQ;AAAA,MACb,GAAI,OAAO,QAAQ,gBAAgB,aAC/B,EAAE,aAAa,QAAQ,gBACvB,CAAA;AAAA,IAAC;AAEb,UAAM,qBAAqB,gBAAgB;AAC3C,QAAI,OAAO,mBAAmB,SAAS,YAAY;AACjD,YAAM,IAAIA,wBAAAA;AAAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AACA,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,QAAI,OAAO,gBAAgB,gBAAgB,YAAY;AACrD,YAAM,oBAAoB,gBAAgB;AAC1C,WAAK,sBAAsB,CAAI,OAC7B,QAAQ;AAAA,QACN,kBAAkB,KAAK,iBAAiB,EAAE;AAAA,MAAA;AAAA,IAEhD,OAAO;AACL,WAAK,sBAAsB;AAAA,IAC7B;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,KAA4B;AACrC,UAAM,KAAK,QAAQ,MAAM;AACvB,WAAK,QAAQ,GAAG;AAAA,IAClB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,MACJ,KACA,SAAiC,IACN;AAC3B,WAAO,KAAK,QAAQ,MAAM,KAAK,aAAgB,KAAK,MAAM,CAAC;AAAA,EAC7D;AAAA,EAEA,MAAM,IAAI,KAAa,SAAiC,IAAmB;AACzE,UAAM,KAAK,QAAQ,MAAM;AACvB,WAAK,QAAQ,KAAK,MAAM;AAAA,IAC1B,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,YACJ,IACY;AACZ,0CAAsC,EAAE;AAExC,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,oBAAoB,KAAK,wBAAA;AAC/B,UAAI,KAAK,qBAAqB;AAC5B,eAAO,KAAK,oBAAoB,MAAM,GAAG,iBAAiB,CAAC;AAAA,MAC7D;AAEA,WAAK,QAAQ,iBAAiB;AAC9B,UAAI;AACF,cAAM,SAAS,MAAM,GAAG,iBAAiB;AACzC,aAAK,QAAQ,QAAQ;AACrB,eAAO;AAAA,MACT,SAAS,OAAO;AACd,YAAI;AACF,eAAK,QAAQ,UAAU;AAAA,QACzB,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,aAAuC;AACrC,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,QAAQ,KAAa,SAAiC,IAAa;AACzE,WAAO,KAAK,WAAW,KAAK,KAAK,GAAG,MAAM;AAAA,EAC5C;AAAA,EAEQ,aACN,KACA,QACkB;AAClB,UAAM,SAAS,KAAK,QAAQ,KAAK,MAAM;AACvC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;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;AAAA,EAEQ,0BAAwC;AAC9C,UAAM,oBAAkC;AAAA,MACtC,MAAM,CAAC,QAAQ;AACb,aAAK,QAAQ,GAAG;AAChB,eAAO,QAAQ,QAAA;AAAA,MACjB;AAAA,MACA,OAAO,CACL,KACA,SAAiC,OAEjC,QAAQ,QAAQ,KAAK,aAAgB,KAAK,MAAM,CAAC;AAAA,MACnD,KAAK,CAAC,KAAK,SAAS,OAAO;AACzB,aAAK,QAAQ,KAAK,MAAM;AACxB,eAAO,QAAQ,QAAA;AAAA,MACjB;AAAA,MACA,aAAa,CACX,OACe;AACf,8CAAsC,EAAE;AACxC,eAAO,KAAK,qBAAqB,mBAAmB,EAAE;AAAA,MACxD;AAAA,MACA,uBAAuB,CACrB,OACe,KAAK,qBAAqB,mBAAmB,EAAE;AAAA,IAAA;AAGlE,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,qBACZ,mBACA,IACY;AACZ,QAAI,KAAK,qBAAqB;AAC5B,YAAM,IAAIA,wBAAAA;AAAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AAEA,UAAM,gBAAgB,WAAW,KAAK,eAAe;AACrD,SAAK;AACL,SAAK,QAAQ,aAAa,aAAa,EAAE;AAEzC,QAAI;AACF,YAAM,SAAS,MAAM,GAAG,iBAAiB;AACzC,WAAK,QAAQ,qBAAqB,aAAa,EAAE;AACjD,aAAO;AAAA,IACT,SAAS,OAAO;AACd,WAAK,QAAQ,yBAAyB,aAAa,EAAE;AACrD,WAAK,QAAQ,qBAAqB,aAAa,EAAE;AACjD,YAAM;AAAA,IACR;AAAA,EACF;AACF;;"}

package/dist/cjs/do-driver.d.cts

@@ -0,0 +1,42 @@
+import { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core';
+type DurableObjectSqlRow = Record<string, unknown>;
+type DurableObjectSqlCursorLike = Iterable<DurableObjectSqlRow> & {
+    toArray?: () => Array<DurableObjectSqlRow>;
+};
+export type DurableObjectSqlStorageLike = {
+    exec: (sql: string, ...params: ReadonlyArray<unknown>) => DurableObjectSqlCursorLike | ReadonlyArray<DurableObjectSqlRow> | null;
+};
+export type DurableObjectTransactionExecutor = <T>(fn: () => Promise<T>) => Promise<T>;
+export type DurableObjectStorageLike = {
+    sql: DurableObjectSqlStorageLike;
+    transaction?: DurableObjectTransactionExecutor;
+};
+type CloudflareDOProvidedSqlOptions = {
+    sql: DurableObjectSqlStorageLike;
+    transaction?: DurableObjectTransactionExecutor;
+};
+type CloudflareDOProvidedStorageOptions = {
+    storage: DurableObjectStorageLike;
+};
+export type CloudflareDOSQLiteDriverOptions = CloudflareDOProvidedSqlOptions | CloudflareDOProvidedStorageOptions;
+export declare class CloudflareDOSQLiteDriver implements SQLiteDriver {
+    private readonly sqlStorage;
+    private readonly storage;
+    private readonly transactionExecutor;
+    private queue;
+    private nextSavepointId;
+    constructor(options: CloudflareDOSQLiteDriverOptions);
+    exec(sql: string): Promise<void>;
+    query<T>(sql: string, params?: ReadonlyArray<unknown>): Promise<ReadonlyArray<T>>;
+    run(sql: string, params?: ReadonlyArray<unknown>): Promise<void>;
+    transaction<T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>): Promise<T>;
+    transactionWithDriver<T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>): Promise<T>;
+    getStorage(): DurableObjectStorageLike;
+    private execute;
+    private executeQuery;
+    private enqueue;
+    private createTransactionDriver;
+    private runNestedTransaction;
+}
+export declare function createCloudflareDOSQLiteDriver(options: CloudflareDOSQLiteDriverOptions): CloudflareDOSQLiteDriver;
+export {};

package/dist/cjs/do-persistence.cjs

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const dbSqlitePersistenceCore = require("@tanstack/db-sqlite-persistence-core");
+const doDriver = require("./do-driver.cjs");
+function normalizeSchemaMismatchPolicy(policy) {
+  if (policy === `throw`) {
+    return `sync-absent-error`;
+  }
+  return policy;
+}
+function resolveSchemaMismatchPolicy(explicitPolicy, mode) {
+  if (explicitPolicy) {
+    return normalizeSchemaMismatchPolicy(explicitPolicy);
+  }
+  return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`;
+}
+function createAdapterCacheKey(schemaMismatchPolicy, schemaVersion) {
+  const schemaVersionKey = schemaVersion === void 0 ? `schema:default` : `schema:${schemaVersion}`;
+  return `${schemaMismatchPolicy}|${schemaVersionKey}`;
+}
+function resolveSQLiteDriver(options) {
+  return new doDriver.CloudflareDOSQLiteDriver({
+    storage: options.storage
+  });
+}
+function resolveAdapterBaseOptions(options) {
+  return {
+    appliedTxPruneMaxRows: options.appliedTxPruneMaxRows,
+    appliedTxPruneMaxAgeSeconds: options.appliedTxPruneMaxAgeSeconds,
+    pullSinceReloadThreshold: options.pullSinceReloadThreshold
+  };
+}
+function createCloudflareDOSQLitePersistence(options) {
+  const { coordinator, schemaMismatchPolicy } = options;
+  const driver = resolveSQLiteDriver(options);
+  const adapterBaseOptions = resolveAdapterBaseOptions(options);
+  const resolvedCoordinator = coordinator ?? new dbSqlitePersistenceCore.SingleProcessCoordinator();
+  const adapterCache = /* @__PURE__ */ new Map();
+  const getAdapterForCollection = (mode, schemaVersion) => {
+    const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(
+      schemaMismatchPolicy,
+      mode
+    );
+    const cacheKey = createAdapterCacheKey(
+      resolvedSchemaMismatchPolicy,
+      schemaVersion
+    );
+    const cachedAdapter = adapterCache.get(cacheKey);
+    if (cachedAdapter) {
+      return cachedAdapter;
+    }
+    const adapter = dbSqlitePersistenceCore.createSQLiteCorePersistenceAdapter({
+      ...adapterBaseOptions,
+      driver,
+      schemaMismatchPolicy: resolvedSchemaMismatchPolicy,
+      ...schemaVersion === void 0 ? {} : { schemaVersion }
+    });
+    adapterCache.set(cacheKey, adapter);
+    return adapter;
+  };
+  const createCollectionPersistence = (mode, schemaVersion) => ({
+    adapter: getAdapterForCollection(
+      mode,
+      schemaVersion
+    ),
+    coordinator: resolvedCoordinator
+  });
+  const defaultPersistence = createCollectionPersistence(
+    `sync-absent`,
+    void 0
+  );
+  return {
+    ...defaultPersistence,
+    resolvePersistenceForCollection: ({ mode, schemaVersion }) => createCollectionPersistence(mode, schemaVersion),
+    // Backward compatible fallback for older callers.
+    resolvePersistenceForMode: (mode) => createCollectionPersistence(mode, void 0)
+  };
+}
+exports.createCloudflareDOSQLitePersistence = createCloudflareDOSQLitePersistence;
+//# sourceMappingURL=do-persistence.cjs.map

package/dist/cjs/do-persistence.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-persistence.cjs","sources":["../../src/do-persistence.ts"],"sourcesContent":["import {\n  SingleProcessCoordinator,\n  createSQLiteCorePersistenceAdapter,\n} from '@tanstack/db-sqlite-persistence-core'\nimport { CloudflareDOSQLiteDriver } from './do-driver'\nimport type {\n  PersistedCollectionCoordinator,\n  PersistedCollectionMode,\n  PersistedCollectionPersistence,\n  SQLiteCoreAdapterOptions,\n  SQLiteDriver,\n} from '@tanstack/db-sqlite-persistence-core'\nimport type { DurableObjectStorageLike } from './do-driver'\n\nexport type { DurableObjectStorageLike } from './do-driver'\n\ntype CloudflareDOCoreSchemaMismatchPolicy =\n  | `sync-present-reset`\n  | `sync-absent-error`\n  | `reset`\n\nexport type CloudflareDOSchemaMismatchPolicy =\n  | CloudflareDOCoreSchemaMismatchPolicy\n  | `throw`\n\ntype CloudflareDOSQLitePersistenceBaseOptions = Omit<\n  SQLiteCoreAdapterOptions,\n  `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> & {\n  storage: DurableObjectStorageLike\n  coordinator?: PersistedCollectionCoordinator\n  schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy\n}\n\nexport type CloudflareDOSQLitePersistenceOptions =\n  CloudflareDOSQLitePersistenceBaseOptions\n\nfunction normalizeSchemaMismatchPolicy(\n  policy: CloudflareDOSchemaMismatchPolicy,\n): CloudflareDOCoreSchemaMismatchPolicy {\n  if (policy === `throw`) {\n    return `sync-absent-error`\n  }\n  return policy\n}\n\nfunction resolveSchemaMismatchPolicy(\n  explicitPolicy: CloudflareDOSchemaMismatchPolicy | undefined,\n  mode: PersistedCollectionMode,\n): CloudflareDOCoreSchemaMismatchPolicy {\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: CloudflareDOCoreSchemaMismatchPolicy,\n  schemaVersion: number | undefined,\n): string {\n  const schemaVersionKey =\n    schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`\n  return `${schemaMismatchPolicy}|${schemaVersionKey}`\n}\n\nfunction resolveSQLiteDriver(\n  options: CloudflareDOSQLitePersistenceOptions,\n): SQLiteDriver {\n  return new CloudflareDOSQLiteDriver({\n    storage: options.storage,\n  })\n}\n\nfunction resolveAdapterBaseOptions(\n  options: CloudflareDOSQLitePersistenceOptions,\n): Omit<\n  SQLiteCoreAdapterOptions,\n  `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> {\n  return {\n    appliedTxPruneMaxRows: options.appliedTxPruneMaxRows,\n    appliedTxPruneMaxAgeSeconds: options.appliedTxPruneMaxAgeSeconds,\n    pullSinceReloadThreshold: options.pullSinceReloadThreshold,\n  }\n}\n\n/**\n * Creates a shared Durable Object SQLite persistence instance that can be reused\n * by many collections in a single Durable Object storage.\n */\nexport function createCloudflareDOSQLitePersistence<\n  T extends object,\n  TKey extends string | number = string | number,\n>(\n  options: CloudflareDOSQLitePersistenceOptions,\n): PersistedCollectionPersistence<T, TKey> {\n  const { coordinator, schemaMismatchPolicy } = options\n  const driver = resolveSQLiteDriver(options)\n  const adapterBaseOptions = resolveAdapterBaseOptions(options)\n  const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()\n  const adapterCache = new Map<\n    string,\n    ReturnType<\n      typeof createSQLiteCorePersistenceAdapter<\n        Record<string, unknown>,\n        string | number\n      >\n    >\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      Record<string, unknown>,\n      string | number\n    >({\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    mode: PersistedCollectionMode,\n    schemaVersion: number | undefined,\n  ): PersistedCollectionPersistence<T, TKey> => ({\n    adapter: getAdapterForCollection(\n      mode,\n      schemaVersion,\n    ) as unknown as PersistedCollectionPersistence<T, TKey>[`adapter`],\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    // Backward compatible fallback for older callers.\n    resolvePersistenceForMode: (mode) =>\n      createCollectionPersistence(mode, undefined),\n  }\n}\n"],"names":["CloudflareDOSQLiteDriver","SingleProcessCoordinator","createSQLiteCorePersistenceAdapter"],"mappings":";;;;AAqCA,SAAS,8BACP,QACsC;AACtC,MAAI,WAAW,SAAS;AACtB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEA,SAAS,4BACP,gBACA,MACsC;AACtC,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,oBACP,SACc;AACd,SAAO,IAAIA,SAAAA,yBAAyB;AAAA,IAClC,SAAS,QAAQ;AAAA,EAAA,CAClB;AACH;AAEA,SAAS,0BACP,SAIA;AACA,SAAO;AAAA,IACL,uBAAuB,QAAQ;AAAA,IAC/B,6BAA6B,QAAQ;AAAA,IACrC,0BAA0B,QAAQ;AAAA,EAAA;AAEtC;AAMO,SAAS,oCAId,SACyC;AACzC,QAAM,EAAE,aAAa,qBAAA,IAAyB;AAC9C,QAAM,SAAS,oBAAoB,OAAO;AAC1C,QAAM,qBAAqB,0BAA0B,OAAO;AAC5D,QAAM,sBAAsB,eAAe,IAAIC,iDAAA;AAC/C,QAAM,mCAAmB,IAAA;AAUzB,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,UAAUC,wBAAAA,mCAGd;AAAA,MACA,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,MACA,mBAC6C;AAAA,IAC7C,SAAS;AAAA,MACP;AAAA,MACA;AAAA,IAAA;AAAA,IAEF,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;AAAA,IAEjD,2BAA2B,CAAC,SAC1B,4BAA4B,MAAM,MAAS;AAAA,EAAA;AAEjD;;"}

package/dist/cjs/do-persistence.d.cts

@@ -0,0 +1,16 @@
+import { PersistedCollectionCoordinator, PersistedCollectionPersistence, SQLiteCoreAdapterOptions } from '@tanstack/db-sqlite-persistence-core';
+import { DurableObjectStorageLike } from './do-driver.cjs';
+export type { DurableObjectStorageLike } from './do-driver.cjs';
+type CloudflareDOCoreSchemaMismatchPolicy = `sync-present-reset` | `sync-absent-error` | `reset`;
+export type CloudflareDOSchemaMismatchPolicy = CloudflareDOCoreSchemaMismatchPolicy | `throw`;
+type CloudflareDOSQLitePersistenceBaseOptions = Omit<SQLiteCoreAdapterOptions, `driver` | `schemaVersion` | `schemaMismatchPolicy`> & {
+    storage: DurableObjectStorageLike;
+    coordinator?: PersistedCollectionCoordinator;
+    schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy;
+};
+export type CloudflareDOSQLitePersistenceOptions = CloudflareDOSQLitePersistenceBaseOptions;
+/**
+ * Creates a shared Durable Object SQLite persistence instance that can be reused
+ * by many collections in a single Durable Object storage.
+ */
+export declare function createCloudflareDOSQLitePersistence<T extends object, TKey extends string | number = string | number>(options: CloudflareDOSQLitePersistenceOptions): PersistedCollectionPersistence<T, TKey>;

package/dist/cjs/index.cjs

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const doPersistence = require("./do-persistence.cjs");
+const dbSqlitePersistenceCore = require("@tanstack/db-sqlite-persistence-core");
+exports.createCloudflareDOSQLitePersistence = doPersistence.createCloudflareDOSQLitePersistence;
+Object.defineProperty(exports, "persistedCollectionOptions", {
+  enumerable: true,
+  get: () => dbSqlitePersistenceCore.persistedCollectionOptions
+});
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,4 @@
+export { createCloudflareDOSQLitePersistence } from './do-persistence.cjs';
+export type { CloudflareDOSchemaMismatchPolicy, CloudflareDOSQLitePersistenceOptions, DurableObjectStorageLike, } from './do-persistence.cjs';
+export { persistedCollectionOptions } from '@tanstack/db-sqlite-persistence-core';
+export type { PersistedCollectionCoordinator, PersistedCollectionPersistence, } from '@tanstack/db-sqlite-persistence-core';

package/dist/esm/do-driver.d.ts

@@ -0,0 +1,42 @@
+import { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core';
+type DurableObjectSqlRow = Record<string, unknown>;
+type DurableObjectSqlCursorLike = Iterable<DurableObjectSqlRow> & {
+    toArray?: () => Array<DurableObjectSqlRow>;
+};
+export type DurableObjectSqlStorageLike = {
+    exec: (sql: string, ...params: ReadonlyArray<unknown>) => DurableObjectSqlCursorLike | ReadonlyArray<DurableObjectSqlRow> | null;
+};
+export type DurableObjectTransactionExecutor = <T>(fn: () => Promise<T>) => Promise<T>;
+export type DurableObjectStorageLike = {
+    sql: DurableObjectSqlStorageLike;
+    transaction?: DurableObjectTransactionExecutor;
+};
+type CloudflareDOProvidedSqlOptions = {
+    sql: DurableObjectSqlStorageLike;
+    transaction?: DurableObjectTransactionExecutor;
+};
+type CloudflareDOProvidedStorageOptions = {
+    storage: DurableObjectStorageLike;
+};
+export type CloudflareDOSQLiteDriverOptions = CloudflareDOProvidedSqlOptions | CloudflareDOProvidedStorageOptions;
+export declare class CloudflareDOSQLiteDriver implements SQLiteDriver {
+    private readonly sqlStorage;
+    private readonly storage;
+    private readonly transactionExecutor;
+    private queue;
+    private nextSavepointId;
+    constructor(options: CloudflareDOSQLiteDriverOptions);
+    exec(sql: string): Promise<void>;
+    query<T>(sql: string, params?: ReadonlyArray<unknown>): Promise<ReadonlyArray<T>>;
+    run(sql: string, params?: ReadonlyArray<unknown>): Promise<void>;
+    transaction<T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>): Promise<T>;
+    transactionWithDriver<T>(fn: (transactionDriver: SQLiteDriver) => Promise<T>): Promise<T>;
+    getStorage(): DurableObjectStorageLike;
+    private execute;
+    private executeQuery;
+    private enqueue;
+    private createTransactionDriver;
+    private runNestedTransaction;
+}
+export declare function createCloudflareDOSQLiteDriver(options: CloudflareDOSQLiteDriverOptions): CloudflareDOSQLiteDriver;
+export {};

package/dist/esm/do-driver.js

@@ -0,0 +1,160 @@
+import { InvalidPersistedCollectionConfigError } from "@tanstack/db-sqlite-persistence-core";
+function assertTransactionCallbackHasDriverArg(fn) {
+  if (fn.length > 0) {
+    return;
+  }
+  throw new InvalidPersistedCollectionConfigError(
+    `SQLiteDriver.transaction callback must accept the transaction driver argument`
+  );
+}
+function isIterableRecord(value) {
+  if (!value || typeof value !== `object`) {
+    return false;
+  }
+  const iterator = value[Symbol.iterator];
+  return typeof iterator === `function`;
+}
+function toRowArray(result, sql) {
+  if (result == null) {
+    return [];
+  }
+  if (Array.isArray(result)) {
+    return result;
+  }
+  const cursorResult = result;
+  if (typeof cursorResult.toArray === `function`) {
+    return cursorResult.toArray();
+  }
+  if (isIterableRecord(cursorResult)) {
+    return Array.from(cursorResult);
+  }
+  throw new InvalidPersistedCollectionConfigError(
+    `Unsupported Durable Object SQL result shape for query "${sql}"`
+  );
+}
+class CloudflareDOSQLiteDriver {
+  constructor(options) {
+    this.queue = Promise.resolve();
+    this.nextSavepointId = 1;
+    const resolvedStorage = `storage` in options ? options.storage : {
+      sql: options.sql,
+      ...typeof options.transaction === `function` ? { transaction: options.transaction } : {}
+    };
+    const resolvedSqlStorage = resolvedStorage.sql;
+    if (typeof resolvedSqlStorage.exec !== `function`) {
+      throw new InvalidPersistedCollectionConfigError(
+        `Cloudflare DO SQL driver requires a sql.exec function`
+      );
+    }
+    this.storage = resolvedStorage;
+    this.sqlStorage = resolvedSqlStorage;
+    if (typeof resolvedStorage.transaction === `function`) {
+      const transactionMethod = resolvedStorage.transaction;
+      this.transactionExecutor = (fn) => Promise.resolve(
+        transactionMethod.call(resolvedStorage, fn)
+      );
+    } else {
+      this.transactionExecutor = null;
+    }
+  }
+  async exec(sql) {
+    await this.enqueue(() => {
+      this.execute(sql);
+    });
+  }
+  async query(sql, params = []) {
+    return this.enqueue(() => this.executeQuery(sql, params));
+  }
+  async run(sql, params = []) {
+    await this.enqueue(() => {
+      this.execute(sql, params);
+    });
+  }
+  async transaction(fn) {
+    assertTransactionCallbackHasDriverArg(fn);
+    return this.enqueue(async () => {
+      const transactionDriver = this.createTransactionDriver();
+      if (this.transactionExecutor) {
+        return this.transactionExecutor(() => fn(transactionDriver));
+      }
+      this.execute(`BEGIN IMMEDIATE`);
+      try {
+        const result = await fn(transactionDriver);
+        this.execute(`COMMIT`);
+        return result;
+      } catch (error) {
+        try {
+          this.execute(`ROLLBACK`);
+        } catch {
+        }
+        throw error;
+      }
+    });
+  }
+  async transactionWithDriver(fn) {
+    return this.transaction(fn);
+  }
+  getStorage() {
+    return this.storage;
+  }
+  execute(sql, params = []) {
+    return this.sqlStorage.exec(sql, ...params);
+  }
+  executeQuery(sql, params) {
+    const result = this.execute(sql, params);
+    return toRowArray(
+      result,
+      sql
+    );
+  }
+  enqueue(operation) {
+    const queuedOperation = this.queue.then(operation, operation);
+    this.queue = queuedOperation.then(
+      () => void 0,
+      () => void 0
+    );
+    return queuedOperation;
+  }
+  createTransactionDriver() {
+    const transactionDriver = {
+      exec: (sql) => {
+        this.execute(sql);
+        return Promise.resolve();
+      },
+      query: (sql, params = []) => Promise.resolve(this.executeQuery(sql, params)),
+      run: (sql, params = []) => {
+        this.execute(sql, params);
+        return Promise.resolve();
+      },
+      transaction: (fn) => {
+        assertTransactionCallbackHasDriverArg(fn);
+        return this.runNestedTransaction(transactionDriver, fn);
+      },
+      transactionWithDriver: (fn) => this.runNestedTransaction(transactionDriver, fn)
+    };
+    return transactionDriver;
+  }
+  async runNestedTransaction(transactionDriver, fn) {
+    if (this.transactionExecutor) {
+      throw new InvalidPersistedCollectionConfigError(
+        `Nested SQL savepoints are not supported when using Durable Object transaction API`
+      );
+    }
+    const savepointName = `tsdb_sp_${this.nextSavepointId}`;
+    this.nextSavepointId++;
+    this.execute(`SAVEPOINT ${savepointName}`);
+    try {
+      const result = await fn(transactionDriver);
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`);
+      return result;
+    } catch (error) {
+      this.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`);
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`);
+      throw error;
+    }
+  }
+}
+export {
+  CloudflareDOSQLiteDriver
+};
+//# sourceMappingURL=do-driver.js.map

package/dist/esm/do-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-driver.js","sources":["../../src/do-driver.ts"],"sourcesContent":["import { InvalidPersistedCollectionConfigError } from '@tanstack/db-sqlite-persistence-core'\nimport type { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core'\n\ntype DurableObjectSqlRow = Record<string, unknown>\n\ntype DurableObjectSqlCursorLike = Iterable<DurableObjectSqlRow> & {\n  toArray?: () => Array<DurableObjectSqlRow>\n}\n\nexport type DurableObjectSqlStorageLike = {\n  exec: (\n    sql: string,\n    ...params: ReadonlyArray<unknown>\n  ) => DurableObjectSqlCursorLike | ReadonlyArray<DurableObjectSqlRow> | null\n}\n\nexport type DurableObjectTransactionExecutor = <T>(\n  fn: () => Promise<T>,\n) => Promise<T>\n\nexport type DurableObjectStorageLike = {\n  sql: DurableObjectSqlStorageLike\n  transaction?: DurableObjectTransactionExecutor\n}\n\ntype CloudflareDOProvidedSqlOptions = {\n  sql: DurableObjectSqlStorageLike\n  transaction?: DurableObjectTransactionExecutor\n}\n\ntype CloudflareDOProvidedStorageOptions = {\n  storage: DurableObjectStorageLike\n}\n\nexport type CloudflareDOSQLiteDriverOptions =\n  | CloudflareDOProvidedSqlOptions\n  | CloudflareDOProvidedStorageOptions\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 isIterableRecord(\n  value: unknown,\n): value is Iterable<DurableObjectSqlRow> {\n  if (!value || typeof value !== `object`) {\n    return false\n  }\n\n  const iterator = (value as { [Symbol.iterator]?: unknown })[Symbol.iterator]\n  return typeof iterator === `function`\n}\n\nfunction toRowArray<T>(\n  result: ReturnType<DurableObjectSqlStorageLike[`exec`]>,\n  sql: string,\n): ReadonlyArray<T> {\n  if (result == null) {\n    return []\n  }\n\n  if (Array.isArray(result)) {\n    return result as ReadonlyArray<T>\n  }\n\n  const cursorResult = result as DurableObjectSqlCursorLike\n  if (typeof cursorResult.toArray === `function`) {\n    return cursorResult.toArray() as ReadonlyArray<T>\n  }\n\n  if (isIterableRecord(cursorResult)) {\n    return Array.from(cursorResult as Iterable<T>)\n  }\n\n  throw new InvalidPersistedCollectionConfigError(\n    `Unsupported Durable Object SQL result shape for query \"${sql}\"`,\n  )\n}\n\nexport class CloudflareDOSQLiteDriver implements SQLiteDriver {\n  private readonly sqlStorage: DurableObjectSqlStorageLike\n  private readonly storage: DurableObjectStorageLike\n  private readonly transactionExecutor: DurableObjectTransactionExecutor | null\n  private queue: Promise<void> = Promise.resolve()\n  private nextSavepointId = 1\n\n  constructor(options: CloudflareDOSQLiteDriverOptions) {\n    const resolvedStorage: DurableObjectStorageLike =\n      `storage` in options\n        ? options.storage\n        : {\n            sql: options.sql,\n            ...(typeof options.transaction === `function`\n              ? { transaction: options.transaction }\n              : {}),\n          }\n    const resolvedSqlStorage = resolvedStorage.sql\n    if (typeof resolvedSqlStorage.exec !== `function`) {\n      throw new InvalidPersistedCollectionConfigError(\n        `Cloudflare DO SQL driver requires a sql.exec function`,\n      )\n    }\n    this.storage = resolvedStorage\n    this.sqlStorage = resolvedSqlStorage\n    if (typeof resolvedStorage.transaction === `function`) {\n      const transactionMethod = resolvedStorage.transaction\n      this.transactionExecutor = <T>(fn: () => Promise<T>) =>\n        Promise.resolve(\n          transactionMethod.call(resolvedStorage, fn) as Promise<T> | T,\n        )\n    } else {\n      this.transactionExecutor = null\n    }\n  }\n\n  async exec(sql: string): Promise<void> {\n    await this.enqueue(() => {\n      this.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.executeQuery<T>(sql, params))\n  }\n\n  async run(sql: string, params: ReadonlyArray<unknown> = []): Promise<void> {\n    await this.enqueue(() => {\n      this.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      const transactionDriver = this.createTransactionDriver()\n      if (this.transactionExecutor) {\n        return this.transactionExecutor(() => fn(transactionDriver))\n      }\n\n      this.execute(`BEGIN IMMEDIATE`)\n      try {\n        const result = await fn(transactionDriver)\n        this.execute(`COMMIT`)\n        return result\n      } catch (error) {\n        try {\n          this.execute(`ROLLBACK`)\n        } catch {\n          // Keep the original transaction error as the primary failure.\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  getStorage(): DurableObjectStorageLike {\n    return this.storage\n  }\n\n  private execute(sql: string, params: ReadonlyArray<unknown> = []): unknown {\n    return this.sqlStorage.exec(sql, ...params)\n  }\n\n  private executeQuery<T>(\n    sql: string,\n    params: ReadonlyArray<unknown>,\n  ): ReadonlyArray<T> {\n    const result = this.execute(sql, params)\n    return toRowArray<T>(\n      result as ReturnType<DurableObjectSqlStorageLike[`exec`]>,\n      sql,\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  private createTransactionDriver(): SQLiteDriver {\n    const transactionDriver: SQLiteDriver = {\n      exec: (sql) => {\n        this.execute(sql)\n        return Promise.resolve()\n      },\n      query: <T>(\n        sql: string,\n        params: ReadonlyArray<unknown> = [],\n      ): Promise<ReadonlyArray<T>> =>\n        Promise.resolve(this.executeQuery<T>(sql, params)),\n      run: (sql, params = []) => {\n        this.execute(sql, params)\n        return Promise.resolve()\n      },\n      transaction: <T>(\n        fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n      ): Promise<T> => {\n        assertTransactionCallbackHasDriverArg(fn)\n        return this.runNestedTransaction(transactionDriver, fn)\n      },\n      transactionWithDriver: <T>(\n        fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n      ): Promise<T> => this.runNestedTransaction(transactionDriver, fn),\n    }\n\n    return transactionDriver\n  }\n\n  private async runNestedTransaction<T>(\n    transactionDriver: SQLiteDriver,\n    fn: (nestedDriver: SQLiteDriver) => Promise<T>,\n  ): Promise<T> {\n    if (this.transactionExecutor) {\n      throw new InvalidPersistedCollectionConfigError(\n        `Nested SQL savepoints are not supported when using Durable Object transaction API`,\n      )\n    }\n\n    const savepointName = `tsdb_sp_${this.nextSavepointId}`\n    this.nextSavepointId++\n    this.execute(`SAVEPOINT ${savepointName}`)\n\n    try {\n      const result = await fn(transactionDriver)\n      this.execute(`RELEASE SAVEPOINT ${savepointName}`)\n      return result\n    } catch (error) {\n      this.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`)\n      this.execute(`RELEASE SAVEPOINT ${savepointName}`)\n      throw error\n    }\n  }\n}\n\nexport function createCloudflareDOSQLiteDriver(\n  options: CloudflareDOSQLiteDriverOptions,\n): CloudflareDOSQLiteDriver {\n  return new CloudflareDOSQLiteDriver(options)\n}\n"],"names":[],"mappings":";AAsCA,SAAS,sCACP,IACM;AACN,MAAI,GAAG,SAAS,GAAG;AACjB;AAAA,EACF;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EAAA;AAEJ;AAEA,SAAS,iBACP,OACwC;AACxC,MAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,WAAO;AAAA,EACT;AAEA,QAAM,WAAY,MAA0C,OAAO,QAAQ;AAC3E,SAAO,OAAO,aAAa;AAC7B;AAEA,SAAS,WACP,QACA,KACkB;AAClB,MAAI,UAAU,MAAM;AAClB,WAAO,CAAA;AAAA,EACT;AAEA,MAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,WAAO;AAAA,EACT;AAEA,QAAM,eAAe;AACrB,MAAI,OAAO,aAAa,YAAY,YAAY;AAC9C,WAAO,aAAa,QAAA;AAAA,EACtB;AAEA,MAAI,iBAAiB,YAAY,GAAG;AAClC,WAAO,MAAM,KAAK,YAA2B;AAAA,EAC/C;AAEA,QAAM,IAAI;AAAA,IACR,0DAA0D,GAAG;AAAA,EAAA;AAEjE;AAEO,MAAM,yBAAiD;AAAA,EAO5D,YAAY,SAA0C;AAHtD,SAAQ,QAAuB,QAAQ,QAAA;AACvC,SAAQ,kBAAkB;AAGxB,UAAM,kBACJ,aAAa,UACT,QAAQ,UACR;AAAA,MACE,KAAK,QAAQ;AAAA,MACb,GAAI,OAAO,QAAQ,gBAAgB,aAC/B,EAAE,aAAa,QAAQ,gBACvB,CAAA;AAAA,IAAC;AAEb,UAAM,qBAAqB,gBAAgB;AAC3C,QAAI,OAAO,mBAAmB,SAAS,YAAY;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AACA,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,QAAI,OAAO,gBAAgB,gBAAgB,YAAY;AACrD,YAAM,oBAAoB,gBAAgB;AAC1C,WAAK,sBAAsB,CAAI,OAC7B,QAAQ;AAAA,QACN,kBAAkB,KAAK,iBAAiB,EAAE;AAAA,MAAA;AAAA,IAEhD,OAAO;AACL,WAAK,sBAAsB;AAAA,IAC7B;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,KAA4B;AACrC,UAAM,KAAK,QAAQ,MAAM;AACvB,WAAK,QAAQ,GAAG;AAAA,IAClB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,MACJ,KACA,SAAiC,IACN;AAC3B,WAAO,KAAK,QAAQ,MAAM,KAAK,aAAgB,KAAK,MAAM,CAAC;AAAA,EAC7D;AAAA,EAEA,MAAM,IAAI,KAAa,SAAiC,IAAmB;AACzE,UAAM,KAAK,QAAQ,MAAM;AACvB,WAAK,QAAQ,KAAK,MAAM;AAAA,IAC1B,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,YACJ,IACY;AACZ,0CAAsC,EAAE;AAExC,WAAO,KAAK,QAAQ,YAAY;AAC9B,YAAM,oBAAoB,KAAK,wBAAA;AAC/B,UAAI,KAAK,qBAAqB;AAC5B,eAAO,KAAK,oBAAoB,MAAM,GAAG,iBAAiB,CAAC;AAAA,MAC7D;AAEA,WAAK,QAAQ,iBAAiB;AAC9B,UAAI;AACF,cAAM,SAAS,MAAM,GAAG,iBAAiB;AACzC,aAAK,QAAQ,QAAQ;AACrB,eAAO;AAAA,MACT,SAAS,OAAO;AACd,YAAI;AACF,eAAK,QAAQ,UAAU;AAAA,QACzB,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,aAAuC;AACrC,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,QAAQ,KAAa,SAAiC,IAAa;AACzE,WAAO,KAAK,WAAW,KAAK,KAAK,GAAG,MAAM;AAAA,EAC5C;AAAA,EAEQ,aACN,KACA,QACkB;AAClB,UAAM,SAAS,KAAK,QAAQ,KAAK,MAAM;AACvC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;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;AAAA,EAEQ,0BAAwC;AAC9C,UAAM,oBAAkC;AAAA,MACtC,MAAM,CAAC,QAAQ;AACb,aAAK,QAAQ,GAAG;AAChB,eAAO,QAAQ,QAAA;AAAA,MACjB;AAAA,MACA,OAAO,CACL,KACA,SAAiC,OAEjC,QAAQ,QAAQ,KAAK,aAAgB,KAAK,MAAM,CAAC;AAAA,MACnD,KAAK,CAAC,KAAK,SAAS,OAAO;AACzB,aAAK,QAAQ,KAAK,MAAM;AACxB,eAAO,QAAQ,QAAA;AAAA,MACjB;AAAA,MACA,aAAa,CACX,OACe;AACf,8CAAsC,EAAE;AACxC,eAAO,KAAK,qBAAqB,mBAAmB,EAAE;AAAA,MACxD;AAAA,MACA,uBAAuB,CACrB,OACe,KAAK,qBAAqB,mBAAmB,EAAE;AAAA,IAAA;AAGlE,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,qBACZ,mBACA,IACY;AACZ,QAAI,KAAK,qBAAqB;AAC5B,YAAM,IAAI;AAAA,QACR;AAAA,MAAA;AAAA,IAEJ;AAEA,UAAM,gBAAgB,WAAW,KAAK,eAAe;AACrD,SAAK;AACL,SAAK,QAAQ,aAAa,aAAa,EAAE;AAEzC,QAAI;AACF,YAAM,SAAS,MAAM,GAAG,iBAAiB;AACzC,WAAK,QAAQ,qBAAqB,aAAa,EAAE;AACjD,aAAO;AAAA,IACT,SAAS,OAAO;AACd,WAAK,QAAQ,yBAAyB,aAAa,EAAE;AACrD,WAAK,QAAQ,qBAAqB,aAAa,EAAE;AACjD,YAAM;AAAA,IACR;AAAA,EACF;AACF;"}

package/dist/esm/do-persistence.d.ts

@@ -0,0 +1,16 @@
+import { PersistedCollectionCoordinator, PersistedCollectionPersistence, SQLiteCoreAdapterOptions } from '@tanstack/db-sqlite-persistence-core';
+import { DurableObjectStorageLike } from './do-driver.js';
+export type { DurableObjectStorageLike } from './do-driver.js';
+type CloudflareDOCoreSchemaMismatchPolicy = `sync-present-reset` | `sync-absent-error` | `reset`;
+export type CloudflareDOSchemaMismatchPolicy = CloudflareDOCoreSchemaMismatchPolicy | `throw`;
+type CloudflareDOSQLitePersistenceBaseOptions = Omit<SQLiteCoreAdapterOptions, `driver` | `schemaVersion` | `schemaMismatchPolicy`> & {
+    storage: DurableObjectStorageLike;
+    coordinator?: PersistedCollectionCoordinator;
+    schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy;
+};
+export type CloudflareDOSQLitePersistenceOptions = CloudflareDOSQLitePersistenceBaseOptions;
+/**
+ * Creates a shared Durable Object SQLite persistence instance that can be reused
+ * by many collections in a single Durable Object storage.
+ */
+export declare function createCloudflareDOSQLitePersistence<T extends object, TKey extends string | number = string | number>(options: CloudflareDOSQLitePersistenceOptions): PersistedCollectionPersistence<T, TKey>;

package/dist/esm/do-persistence.js

@@ -0,0 +1,80 @@
+import { SingleProcessCoordinator, createSQLiteCorePersistenceAdapter } from "@tanstack/db-sqlite-persistence-core";
+import { CloudflareDOSQLiteDriver } from "./do-driver.js";
+function normalizeSchemaMismatchPolicy(policy) {
+  if (policy === `throw`) {
+    return `sync-absent-error`;
+  }
+  return policy;
+}
+function resolveSchemaMismatchPolicy(explicitPolicy, mode) {
+  if (explicitPolicy) {
+    return normalizeSchemaMismatchPolicy(explicitPolicy);
+  }
+  return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`;
+}
+function createAdapterCacheKey(schemaMismatchPolicy, schemaVersion) {
+  const schemaVersionKey = schemaVersion === void 0 ? `schema:default` : `schema:${schemaVersion}`;
+  return `${schemaMismatchPolicy}|${schemaVersionKey}`;
+}
+function resolveSQLiteDriver(options) {
+  return new CloudflareDOSQLiteDriver({
+    storage: options.storage
+  });
+}
+function resolveAdapterBaseOptions(options) {
+  return {
+    appliedTxPruneMaxRows: options.appliedTxPruneMaxRows,
+    appliedTxPruneMaxAgeSeconds: options.appliedTxPruneMaxAgeSeconds,
+    pullSinceReloadThreshold: options.pullSinceReloadThreshold
+  };
+}
+function createCloudflareDOSQLitePersistence(options) {
+  const { coordinator, schemaMismatchPolicy } = options;
+  const driver = resolveSQLiteDriver(options);
+  const adapterBaseOptions = resolveAdapterBaseOptions(options);
+  const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator();
+  const adapterCache = /* @__PURE__ */ new Map();
+  const getAdapterForCollection = (mode, schemaVersion) => {
+    const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(
+      schemaMismatchPolicy,
+      mode
+    );
+    const cacheKey = createAdapterCacheKey(
+      resolvedSchemaMismatchPolicy,
+      schemaVersion
+    );
+    const cachedAdapter = adapterCache.get(cacheKey);
+    if (cachedAdapter) {
+      return cachedAdapter;
+    }
+    const adapter = createSQLiteCorePersistenceAdapter({
+      ...adapterBaseOptions,
+      driver,
+      schemaMismatchPolicy: resolvedSchemaMismatchPolicy,
+      ...schemaVersion === void 0 ? {} : { schemaVersion }
+    });
+    adapterCache.set(cacheKey, adapter);
+    return adapter;
+  };
+  const createCollectionPersistence = (mode, schemaVersion) => ({
+    adapter: getAdapterForCollection(
+      mode,
+      schemaVersion
+    ),
+    coordinator: resolvedCoordinator
+  });
+  const defaultPersistence = createCollectionPersistence(
+    `sync-absent`,
+    void 0
+  );
+  return {
+    ...defaultPersistence,
+    resolvePersistenceForCollection: ({ mode, schemaVersion }) => createCollectionPersistence(mode, schemaVersion),
+    // Backward compatible fallback for older callers.
+    resolvePersistenceForMode: (mode) => createCollectionPersistence(mode, void 0)
+  };
+}
+export {
+  createCloudflareDOSQLitePersistence
+};
+//# sourceMappingURL=do-persistence.js.map

package/dist/esm/do-persistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-persistence.js","sources":["../../src/do-persistence.ts"],"sourcesContent":["import {\n  SingleProcessCoordinator,\n  createSQLiteCorePersistenceAdapter,\n} from '@tanstack/db-sqlite-persistence-core'\nimport { CloudflareDOSQLiteDriver } from './do-driver'\nimport type {\n  PersistedCollectionCoordinator,\n  PersistedCollectionMode,\n  PersistedCollectionPersistence,\n  SQLiteCoreAdapterOptions,\n  SQLiteDriver,\n} from '@tanstack/db-sqlite-persistence-core'\nimport type { DurableObjectStorageLike } from './do-driver'\n\nexport type { DurableObjectStorageLike } from './do-driver'\n\ntype CloudflareDOCoreSchemaMismatchPolicy =\n  | `sync-present-reset`\n  | `sync-absent-error`\n  | `reset`\n\nexport type CloudflareDOSchemaMismatchPolicy =\n  | CloudflareDOCoreSchemaMismatchPolicy\n  | `throw`\n\ntype CloudflareDOSQLitePersistenceBaseOptions = Omit<\n  SQLiteCoreAdapterOptions,\n  `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> & {\n  storage: DurableObjectStorageLike\n  coordinator?: PersistedCollectionCoordinator\n  schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy\n}\n\nexport type CloudflareDOSQLitePersistenceOptions =\n  CloudflareDOSQLitePersistenceBaseOptions\n\nfunction normalizeSchemaMismatchPolicy(\n  policy: CloudflareDOSchemaMismatchPolicy,\n): CloudflareDOCoreSchemaMismatchPolicy {\n  if (policy === `throw`) {\n    return `sync-absent-error`\n  }\n  return policy\n}\n\nfunction resolveSchemaMismatchPolicy(\n  explicitPolicy: CloudflareDOSchemaMismatchPolicy | undefined,\n  mode: PersistedCollectionMode,\n): CloudflareDOCoreSchemaMismatchPolicy {\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: CloudflareDOCoreSchemaMismatchPolicy,\n  schemaVersion: number | undefined,\n): string {\n  const schemaVersionKey =\n    schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`\n  return `${schemaMismatchPolicy}|${schemaVersionKey}`\n}\n\nfunction resolveSQLiteDriver(\n  options: CloudflareDOSQLitePersistenceOptions,\n): SQLiteDriver {\n  return new CloudflareDOSQLiteDriver({\n    storage: options.storage,\n  })\n}\n\nfunction resolveAdapterBaseOptions(\n  options: CloudflareDOSQLitePersistenceOptions,\n): Omit<\n  SQLiteCoreAdapterOptions,\n  `driver` | `schemaVersion` | `schemaMismatchPolicy`\n> {\n  return {\n    appliedTxPruneMaxRows: options.appliedTxPruneMaxRows,\n    appliedTxPruneMaxAgeSeconds: options.appliedTxPruneMaxAgeSeconds,\n    pullSinceReloadThreshold: options.pullSinceReloadThreshold,\n  }\n}\n\n/**\n * Creates a shared Durable Object SQLite persistence instance that can be reused\n * by many collections in a single Durable Object storage.\n */\nexport function createCloudflareDOSQLitePersistence<\n  T extends object,\n  TKey extends string | number = string | number,\n>(\n  options: CloudflareDOSQLitePersistenceOptions,\n): PersistedCollectionPersistence<T, TKey> {\n  const { coordinator, schemaMismatchPolicy } = options\n  const driver = resolveSQLiteDriver(options)\n  const adapterBaseOptions = resolveAdapterBaseOptions(options)\n  const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()\n  const adapterCache = new Map<\n    string,\n    ReturnType<\n      typeof createSQLiteCorePersistenceAdapter<\n        Record<string, unknown>,\n        string | number\n      >\n    >\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      Record<string, unknown>,\n      string | number\n    >({\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    mode: PersistedCollectionMode,\n    schemaVersion: number | undefined,\n  ): PersistedCollectionPersistence<T, TKey> => ({\n    adapter: getAdapterForCollection(\n      mode,\n      schemaVersion,\n    ) as unknown as PersistedCollectionPersistence<T, TKey>[`adapter`],\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    // Backward compatible fallback for older callers.\n    resolvePersistenceForMode: (mode) =>\n      createCollectionPersistence(mode, undefined),\n  }\n}\n"],"names":[],"mappings":";;AAqCA,SAAS,8BACP,QACsC;AACtC,MAAI,WAAW,SAAS;AACtB,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEA,SAAS,4BACP,gBACA,MACsC;AACtC,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,oBACP,SACc;AACd,SAAO,IAAI,yBAAyB;AAAA,IAClC,SAAS,QAAQ;AAAA,EAAA,CAClB;AACH;AAEA,SAAS,0BACP,SAIA;AACA,SAAO;AAAA,IACL,uBAAuB,QAAQ;AAAA,IAC/B,6BAA6B,QAAQ;AAAA,IACrC,0BAA0B,QAAQ;AAAA,EAAA;AAEtC;AAMO,SAAS,oCAId,SACyC;AACzC,QAAM,EAAE,aAAa,qBAAA,IAAyB;AAC9C,QAAM,SAAS,oBAAoB,OAAO;AAC1C,QAAM,qBAAqB,0BAA0B,OAAO;AAC5D,QAAM,sBAAsB,eAAe,IAAI,yBAAA;AAC/C,QAAM,mCAAmB,IAAA;AAUzB,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,mCAGd;AAAA,MACA,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,MACA,mBAC6C;AAAA,IAC7C,SAAS;AAAA,MACP;AAAA,MACA;AAAA,IAAA;AAAA,IAEF,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;AAAA,IAEjD,2BAA2B,CAAC,SAC1B,4BAA4B,MAAM,MAAS;AAAA,EAAA;AAEjD;"}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { createCloudflareDOSQLitePersistence } from './do-persistence.js';
+export type { CloudflareDOSchemaMismatchPolicy, CloudflareDOSQLitePersistenceOptions, DurableObjectStorageLike, } from './do-persistence.js';
+export { persistedCollectionOptions } from '@tanstack/db-sqlite-persistence-core';
+export type { PersistedCollectionCoordinator, PersistedCollectionPersistence, } from '@tanstack/db-sqlite-persistence-core';

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { createCloudflareDOSQLitePersistence } from "./do-persistence.js";
+import { persistedCollectionOptions } from "@tanstack/db-sqlite-persistence-core";
+export {
+  createCloudflareDOSQLitePersistence,
+  persistedCollectionOptions
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@tanstack/cloudflare-durable-objects-db-sqlite-persistence",
+  "version": "0.1.2",
+  "description": "Cloudflare Durable Object SQLite persisted collection adapter for TanStack DB",
+  "author": "TanStack Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/db.git",
+    "directory": "packages/cloudflare-durable-objects-db-sqlite-persistence"
+  },
+  "homepage": "https://tanstack.com/db",
+  "keywords": [
+    "sqlite",
+    "cloudflare",
+    "durable-objects",
+    "persistence",
+    "typescript"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "lint": "eslint . --fix",
+    "test": "vitest --run",
+    "test:e2e": "pnpm --filter @tanstack/db-ivm build && pnpm --filter @tanstack/db build && pnpm --filter @tanstack/db-sqlite-persistence-core build && pnpm --filter @tanstack/cloudflare-durable-objects-db-sqlite-persistence build && vitest --config vitest.e2e.config.ts --run"
+  },
+  "type": "module",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@tanstack/db-sqlite-persistence-core": "workspace:*"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.13",
+    "@vitest/coverage-istanbul": "^3.2.4",
+    "better-sqlite3": "^12.6.2",
+    "wrangler": "^4.64.0"
+  }
+}

package/src/do-driver.ts

@@ -0,0 +1,263 @@
+import { InvalidPersistedCollectionConfigError } from '@tanstack/db-sqlite-persistence-core'
+import type { SQLiteDriver } from '@tanstack/db-sqlite-persistence-core'
+
+type DurableObjectSqlRow = Record<string, unknown>
+
+type DurableObjectSqlCursorLike = Iterable<DurableObjectSqlRow> & {
+  toArray?: () => Array<DurableObjectSqlRow>
+}
+
+export type DurableObjectSqlStorageLike = {
+  exec: (
+    sql: string,
+    ...params: ReadonlyArray<unknown>
+  ) => DurableObjectSqlCursorLike | ReadonlyArray<DurableObjectSqlRow> | null
+}
+
+export type DurableObjectTransactionExecutor = <T>(
+  fn: () => Promise<T>,
+) => Promise<T>
+
+export type DurableObjectStorageLike = {
+  sql: DurableObjectSqlStorageLike
+  transaction?: DurableObjectTransactionExecutor
+}
+
+type CloudflareDOProvidedSqlOptions = {
+  sql: DurableObjectSqlStorageLike
+  transaction?: DurableObjectTransactionExecutor
+}
+
+type CloudflareDOProvidedStorageOptions = {
+  storage: DurableObjectStorageLike
+}
+
+export type CloudflareDOSQLiteDriverOptions =
+  | CloudflareDOProvidedSqlOptions
+  | CloudflareDOProvidedStorageOptions
+
+function assertTransactionCallbackHasDriverArg(
+  fn: (transactionDriver: SQLiteDriver) => Promise<unknown>,
+): void {
+  if (fn.length > 0) {
+    return
+  }
+
+  throw new InvalidPersistedCollectionConfigError(
+    `SQLiteDriver.transaction callback must accept the transaction driver argument`,
+  )
+}
+
+function isIterableRecord(
+  value: unknown,
+): value is Iterable<DurableObjectSqlRow> {
+  if (!value || typeof value !== `object`) {
+    return false
+  }
+
+  const iterator = (value as { [Symbol.iterator]?: unknown })[Symbol.iterator]
+  return typeof iterator === `function`
+}
+
+function toRowArray<T>(
+  result: ReturnType<DurableObjectSqlStorageLike[`exec`]>,
+  sql: string,
+): ReadonlyArray<T> {
+  if (result == null) {
+    return []
+  }
+
+  if (Array.isArray(result)) {
+    return result as ReadonlyArray<T>
+  }
+
+  const cursorResult = result as DurableObjectSqlCursorLike
+  if (typeof cursorResult.toArray === `function`) {
+    return cursorResult.toArray() as ReadonlyArray<T>
+  }
+
+  if (isIterableRecord(cursorResult)) {
+    return Array.from(cursorResult as Iterable<T>)
+  }
+
+  throw new InvalidPersistedCollectionConfigError(
+    `Unsupported Durable Object SQL result shape for query "${sql}"`,
+  )
+}
+
+export class CloudflareDOSQLiteDriver implements SQLiteDriver {
+  private readonly sqlStorage: DurableObjectSqlStorageLike
+  private readonly storage: DurableObjectStorageLike
+  private readonly transactionExecutor: DurableObjectTransactionExecutor | null
+  private queue: Promise<void> = Promise.resolve()
+  private nextSavepointId = 1
+
+  constructor(options: CloudflareDOSQLiteDriverOptions) {
+    const resolvedStorage: DurableObjectStorageLike =
+      `storage` in options
+        ? options.storage
+        : {
+            sql: options.sql,
+            ...(typeof options.transaction === `function`
+              ? { transaction: options.transaction }
+              : {}),
+          }
+    const resolvedSqlStorage = resolvedStorage.sql
+    if (typeof resolvedSqlStorage.exec !== `function`) {
+      throw new InvalidPersistedCollectionConfigError(
+        `Cloudflare DO SQL driver requires a sql.exec function`,
+      )
+    }
+    this.storage = resolvedStorage
+    this.sqlStorage = resolvedSqlStorage
+    if (typeof resolvedStorage.transaction === `function`) {
+      const transactionMethod = resolvedStorage.transaction
+      this.transactionExecutor = <T>(fn: () => Promise<T>) =>
+        Promise.resolve(
+          transactionMethod.call(resolvedStorage, fn) as Promise<T> | T,
+        )
+    } else {
+      this.transactionExecutor = null
+    }
+  }
+
+  async exec(sql: string): Promise<void> {
+    await this.enqueue(() => {
+      this.execute(sql)
+    })
+  }
+
+  async query<T>(
+    sql: string,
+    params: ReadonlyArray<unknown> = [],
+  ): Promise<ReadonlyArray<T>> {
+    return this.enqueue(() => this.executeQuery<T>(sql, params))
+  }
+
+  async run(sql: string, params: ReadonlyArray<unknown> = []): Promise<void> {
+    await this.enqueue(() => {
+      this.execute(sql, params)
+    })
+  }
+
+  async transaction<T>(
+    fn: (transactionDriver: SQLiteDriver) => Promise<T>,
+  ): Promise<T> {
+    assertTransactionCallbackHasDriverArg(fn)
+
+    return this.enqueue(async () => {
+      const transactionDriver = this.createTransactionDriver()
+      if (this.transactionExecutor) {
+        return this.transactionExecutor(() => fn(transactionDriver))
+      }
+
+      this.execute(`BEGIN IMMEDIATE`)
+      try {
+        const result = await fn(transactionDriver)
+        this.execute(`COMMIT`)
+        return result
+      } catch (error) {
+        try {
+          this.execute(`ROLLBACK`)
+        } catch {
+          // Keep the original transaction error as the primary failure.
+        }
+        throw error
+      }
+    })
+  }
+
+  async transactionWithDriver<T>(
+    fn: (transactionDriver: SQLiteDriver) => Promise<T>,
+  ): Promise<T> {
+    return this.transaction(fn)
+  }
+
+  getStorage(): DurableObjectStorageLike {
+    return this.storage
+  }
+
+  private execute(sql: string, params: ReadonlyArray<unknown> = []): unknown {
+    return this.sqlStorage.exec(sql, ...params)
+  }
+
+  private executeQuery<T>(
+    sql: string,
+    params: ReadonlyArray<unknown>,
+  ): ReadonlyArray<T> {
+    const result = this.execute(sql, params)
+    return toRowArray<T>(
+      result as ReturnType<DurableObjectSqlStorageLike[`exec`]>,
+      sql,
+    )
+  }
+
+  private enqueue<T>(operation: () => Promise<T> | T): Promise<T> {
+    const queuedOperation = this.queue.then(operation, operation)
+    this.queue = queuedOperation.then(
+      () => undefined,
+      () => undefined,
+    )
+    return queuedOperation
+  }
+
+  private createTransactionDriver(): SQLiteDriver {
+    const transactionDriver: SQLiteDriver = {
+      exec: (sql) => {
+        this.execute(sql)
+        return Promise.resolve()
+      },
+      query: <T>(
+        sql: string,
+        params: ReadonlyArray<unknown> = [],
+      ): Promise<ReadonlyArray<T>> =>
+        Promise.resolve(this.executeQuery<T>(sql, params)),
+      run: (sql, params = []) => {
+        this.execute(sql, params)
+        return Promise.resolve()
+      },
+      transaction: <T>(
+        fn: (nestedDriver: SQLiteDriver) => Promise<T>,
+      ): Promise<T> => {
+        assertTransactionCallbackHasDriverArg(fn)
+        return this.runNestedTransaction(transactionDriver, fn)
+      },
+      transactionWithDriver: <T>(
+        fn: (nestedDriver: SQLiteDriver) => Promise<T>,
+      ): Promise<T> => this.runNestedTransaction(transactionDriver, fn),
+    }
+
+    return transactionDriver
+  }
+
+  private async runNestedTransaction<T>(
+    transactionDriver: SQLiteDriver,
+    fn: (nestedDriver: SQLiteDriver) => Promise<T>,
+  ): Promise<T> {
+    if (this.transactionExecutor) {
+      throw new InvalidPersistedCollectionConfigError(
+        `Nested SQL savepoints are not supported when using Durable Object transaction API`,
+      )
+    }
+
+    const savepointName = `tsdb_sp_${this.nextSavepointId}`
+    this.nextSavepointId++
+    this.execute(`SAVEPOINT ${savepointName}`)
+
+    try {
+      const result = await fn(transactionDriver)
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`)
+      return result
+    } catch (error) {
+      this.execute(`ROLLBACK TO SAVEPOINT ${savepointName}`)
+      this.execute(`RELEASE SAVEPOINT ${savepointName}`)
+      throw error
+    }
+  }
+}
+
+export function createCloudflareDOSQLiteDriver(
+  options: CloudflareDOSQLiteDriverOptions,
+): CloudflareDOSQLiteDriver {
+  return new CloudflareDOSQLiteDriver(options)
+}

package/src/do-persistence.ts

@@ -0,0 +1,166 @@
+import {
+  SingleProcessCoordinator,
+  createSQLiteCorePersistenceAdapter,
+} from '@tanstack/db-sqlite-persistence-core'
+import { CloudflareDOSQLiteDriver } from './do-driver'
+import type {
+  PersistedCollectionCoordinator,
+  PersistedCollectionMode,
+  PersistedCollectionPersistence,
+  SQLiteCoreAdapterOptions,
+  SQLiteDriver,
+} from '@tanstack/db-sqlite-persistence-core'
+import type { DurableObjectStorageLike } from './do-driver'
+
+export type { DurableObjectStorageLike } from './do-driver'
+
+type CloudflareDOCoreSchemaMismatchPolicy =
+  | `sync-present-reset`
+  | `sync-absent-error`
+  | `reset`
+
+export type CloudflareDOSchemaMismatchPolicy =
+  | CloudflareDOCoreSchemaMismatchPolicy
+  | `throw`
+
+type CloudflareDOSQLitePersistenceBaseOptions = Omit<
+  SQLiteCoreAdapterOptions,
+  `driver` | `schemaVersion` | `schemaMismatchPolicy`
+> & {
+  storage: DurableObjectStorageLike
+  coordinator?: PersistedCollectionCoordinator
+  schemaMismatchPolicy?: CloudflareDOSchemaMismatchPolicy
+}
+
+export type CloudflareDOSQLitePersistenceOptions =
+  CloudflareDOSQLitePersistenceBaseOptions
+
+function normalizeSchemaMismatchPolicy(
+  policy: CloudflareDOSchemaMismatchPolicy,
+): CloudflareDOCoreSchemaMismatchPolicy {
+  if (policy === `throw`) {
+    return `sync-absent-error`
+  }
+  return policy
+}
+
+function resolveSchemaMismatchPolicy(
+  explicitPolicy: CloudflareDOSchemaMismatchPolicy | undefined,
+  mode: PersistedCollectionMode,
+): CloudflareDOCoreSchemaMismatchPolicy {
+  if (explicitPolicy) {
+    return normalizeSchemaMismatchPolicy(explicitPolicy)
+  }
+
+  return mode === `sync-present` ? `sync-present-reset` : `sync-absent-error`
+}
+
+function createAdapterCacheKey(
+  schemaMismatchPolicy: CloudflareDOCoreSchemaMismatchPolicy,
+  schemaVersion: number | undefined,
+): string {
+  const schemaVersionKey =
+    schemaVersion === undefined ? `schema:default` : `schema:${schemaVersion}`
+  return `${schemaMismatchPolicy}|${schemaVersionKey}`
+}
+
+function resolveSQLiteDriver(
+  options: CloudflareDOSQLitePersistenceOptions,
+): SQLiteDriver {
+  return new CloudflareDOSQLiteDriver({
+    storage: options.storage,
+  })
+}
+
+function resolveAdapterBaseOptions(
+  options: CloudflareDOSQLitePersistenceOptions,
+): Omit<
+  SQLiteCoreAdapterOptions,
+  `driver` | `schemaVersion` | `schemaMismatchPolicy`
+> {
+  return {
+    appliedTxPruneMaxRows: options.appliedTxPruneMaxRows,
+    appliedTxPruneMaxAgeSeconds: options.appliedTxPruneMaxAgeSeconds,
+    pullSinceReloadThreshold: options.pullSinceReloadThreshold,
+  }
+}
+
+/**
+ * Creates a shared Durable Object SQLite persistence instance that can be reused
+ * by many collections in a single Durable Object storage.
+ */
+export function createCloudflareDOSQLitePersistence<
+  T extends object,
+  TKey extends string | number = string | number,
+>(
+  options: CloudflareDOSQLitePersistenceOptions,
+): PersistedCollectionPersistence<T, TKey> {
+  const { coordinator, schemaMismatchPolicy } = options
+  const driver = resolveSQLiteDriver(options)
+  const adapterBaseOptions = resolveAdapterBaseOptions(options)
+  const resolvedCoordinator = coordinator ?? new SingleProcessCoordinator()
+  const adapterCache = new Map<
+    string,
+    ReturnType<
+      typeof createSQLiteCorePersistenceAdapter<
+        Record<string, unknown>,
+        string | number
+      >
+    >
+  >()
+
+  const getAdapterForCollection = (
+    mode: PersistedCollectionMode,
+    schemaVersion: number | undefined,
+  ) => {
+    const resolvedSchemaMismatchPolicy = resolveSchemaMismatchPolicy(
+      schemaMismatchPolicy,
+      mode,
+    )
+    const cacheKey = createAdapterCacheKey(
+      resolvedSchemaMismatchPolicy,
+      schemaVersion,
+    )
+    const cachedAdapter = adapterCache.get(cacheKey)
+    if (cachedAdapter) {
+      return cachedAdapter
+    }
+
+    const adapter = createSQLiteCorePersistenceAdapter<
+      Record<string, unknown>,
+      string | number
+    >({
+      ...adapterBaseOptions,
+      driver,
+      schemaMismatchPolicy: resolvedSchemaMismatchPolicy,
+      ...(schemaVersion === undefined ? {} : { schemaVersion }),
+    })
+    adapterCache.set(cacheKey, adapter)
+    return adapter
+  }
+
+  const createCollectionPersistence = (
+    mode: PersistedCollectionMode,
+    schemaVersion: number | undefined,
+  ): PersistedCollectionPersistence<T, TKey> => ({
+    adapter: getAdapterForCollection(
+      mode,
+      schemaVersion,
+    ) as unknown as PersistedCollectionPersistence<T, TKey>[`adapter`],
+    coordinator: resolvedCoordinator,
+  })
+
+  const defaultPersistence = createCollectionPersistence(
+    `sync-absent`,
+    undefined,
+  )
+
+  return {
+    ...defaultPersistence,
+    resolvePersistenceForCollection: ({ mode, schemaVersion }) =>
+      createCollectionPersistence(mode, schemaVersion),
+    // Backward compatible fallback for older callers.
+    resolvePersistenceForMode: (mode) =>
+      createCollectionPersistence(mode, undefined),
+  }
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+export { createCloudflareDOSQLitePersistence } from './do-persistence'
+export type {
+  CloudflareDOSchemaMismatchPolicy,
+  CloudflareDOSQLitePersistenceOptions,
+  DurableObjectStorageLike,
+} from './do-persistence'
+export { persistedCollectionOptions } from '@tanstack/db-sqlite-persistence-core'
+export type {
+  PersistedCollectionCoordinator,
+  PersistedCollectionPersistence,
+} from '@tanstack/db-sqlite-persistence-core'