@tanstack/trailbase-db-collection 0.0.3 → 0.0.5

package/dist/cjs/errors.cjs

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const db = require("@tanstack/db");
+class TrailBaseDBCollectionError extends db.TanStackDBError {
+  constructor(message) {
+    super(message);
+    this.name = `TrailBaseDBCollectionError`;
+  }
+}
+class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {
+  constructor(ids) {
+    super(`Timeout waiting for ids: ${ids}`);
+    this.name = `TimeoutWaitingForIdsError`;
+  }
+}
+class ExpectedInsertTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'insert', got: ${actualType}`);
+    this.name = `ExpectedInsertTypeError`;
+  }
+}
+class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'update', got: ${actualType}`);
+    this.name = `ExpectedUpdateTypeError`;
+  }
+}
+class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'delete', got: ${actualType}`);
+    this.name = `ExpectedDeleteTypeError`;
+  }
+}
+exports.ExpectedDeleteTypeError = ExpectedDeleteTypeError;
+exports.ExpectedInsertTypeError = ExpectedInsertTypeError;
+exports.ExpectedUpdateTypeError = ExpectedUpdateTypeError;
+exports.TimeoutWaitingForIdsError = TimeoutWaitingForIdsError;
+exports.TrailBaseDBCollectionError = TrailBaseDBCollectionError;
+//# sourceMappingURL=errors.cjs.map

package/dist/cjs/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs","sources":["../../src/errors.ts"],"sourcesContent":["import { TanStackDBError } from \"@tanstack/db\"\n\n// TrailBase DB Collection Errors\nexport class TrailBaseDBCollectionError extends TanStackDBError {\n  constructor(message: string) {\n    super(message)\n    this.name = `TrailBaseDBCollectionError`\n  }\n}\n\nexport class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {\n  constructor(ids: string) {\n    super(`Timeout waiting for ids: ${ids}`)\n    this.name = `TimeoutWaitingForIdsError`\n  }\n}\n\nexport class ExpectedInsertTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'insert', got: ${actualType}`)\n    this.name = `ExpectedInsertTypeError`\n  }\n}\n\nexport class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'update', got: ${actualType}`)\n    this.name = `ExpectedUpdateTypeError`\n  }\n}\n\nexport class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'delete', got: ${actualType}`)\n    this.name = `ExpectedDeleteTypeError`\n  }\n}\n"],"names":["TanStackDBError"],"mappings":";;;AAGO,MAAM,mCAAmCA,GAAAA,gBAAgB;AAAA,EAC9D,YAAY,SAAiB;AAC3B,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,kCAAkC,2BAA2B;AAAA,EACxE,YAAY,KAAa;AACvB,UAAM,4BAA4B,GAAG,EAAE;AACvC,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;;;;;;"}

package/dist/cjs/errors.d.cts

@@ -0,0 +1,16 @@
+import { TanStackDBError } from '@tanstack/db';
+export declare class TrailBaseDBCollectionError extends TanStackDBError {
+    constructor(message: string);
+}
+export declare class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {
+    constructor(ids: string);
+}
+export declare class ExpectedInsertTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}
+export declare class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}
+export declare class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}

package/dist/cjs/index.cjs

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const trailbase = require("./trailbase.cjs");
+const errors = require("./errors.cjs");
 exports.trailBaseCollectionOptions = trailbase.trailBaseCollectionOptions;
+exports.ExpectedDeleteTypeError = errors.ExpectedDeleteTypeError;
+exports.ExpectedInsertTypeError = errors.ExpectedInsertTypeError;
+exports.ExpectedUpdateTypeError = errors.ExpectedUpdateTypeError;
+exports.TimeoutWaitingForIdsError = errors.TimeoutWaitingForIdsError;
+exports.TrailBaseDBCollectionError = errors.TrailBaseDBCollectionError;
 //# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

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

package/dist/cjs/index.d.cts

@@ -1 +1,2 @@
 export { trailBaseCollectionOptions, type TrailBaseCollectionConfig, type TrailBaseCollectionUtils, } from './trailbase.cjs';
+export * from './errors.cjs';

package/dist/cjs/trailbase.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const store = require("@tanstack/store");
+const errors = require("./errors.cjs");
 function convert(conversions, input) {
   const c = conversions;
   return Object.fromEntries(
@@ -35,7 +36,7 @@ function trailBaseCollectionOptions(config) {
     return new Promise((resolve, reject) => {
       const timeoutId = setTimeout(() => {
         unsubscribe();
-        reject(new Error(`Timeout waiting for ids: ${ids}`));
+        reject(new errors.TimeoutWaitingForIdsError(ids.toString()));
       }, timeout);
       const unsubscribe = seenIds.subscribe((value) => {
         if (completed(value.currentVal)) {
@@ -46,29 +47,8 @@ function trailBaseCollectionOptions(config) {
       });
     });
   };
-  const weakSeenIds = new WeakRef(seenIds);
-  const cleanupTimer = setInterval(() => {
-    const seen = weakSeenIds.deref();
-    if (seen) {
-      seen.setState((curr) => {
-        const now = Date.now();
-        let anyExpired = false;
-        const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
-          const expired = now - v > 300 * 1e3;
-          anyExpired = anyExpired || expired;
-          return !expired;
-        });
-        if (anyExpired) {
-          return new Map(notExpired);
-        }
-        return curr;
-      });
-    } else {
-      clearInterval(cleanupTimer);
-    }
-  }, 120 * 1e3);
   let eventReader;
-  const cancel = () => {
+  const cancelEventReader = () => {
     if (eventReader) {
       eventReader.cancel();
       eventReader.releaseLock();
@@ -109,7 +89,6 @@ function trailBaseCollectionOptions(config) {
           cursor = response.cursor;
         }
         commit();
-        markReady();
       }
       async function listen(reader) {
         while (true) {
@@ -150,10 +129,27 @@ function trailBaseCollectionOptions(config) {
         try {
           await initialFetch();
         } catch (e) {
-          cancel();
-          markReady();
+          cancelEventReader();
           throw e;
+        } finally {
+          markReady();
         }
+        const periodicCleanupTask = setInterval(() => {
+          seenIds.setState((curr) => {
+            const now = Date.now();
+            let anyExpired = false;
+            const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
+              const expired = now - v > 300 * 1e3;
+              anyExpired = anyExpired || expired;
+              return !expired;
+            });
+            if (anyExpired) {
+              return new Map(notExpired);
+            }
+            return curr;
+          });
+        }, 120 * 1e3);
+        reader.closed.finally(() => clearInterval(periodicCleanupTask));
       }
       start();
     },
@@ -169,7 +165,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map((tx) => {
           const { type, modified } = tx;
           if (type !== `insert`) {
-            throw new Error(`Expected 'insert', got: ${type}`);
+            throw new errors.ExpectedInsertTypeError(type);
           }
           return serialIns(modified);
         })
@@ -182,7 +178,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map(async (tx) => {
           const { type, changes, key } = tx;
           if (type !== `update`) {
-            throw new Error(`Expected 'update', got: ${type}`);
+            throw new errors.ExpectedUpdateTypeError(type);
           }
           await config.recordApi.update(key, serialUpd(changes));
           return String(key);
@@ -195,7 +191,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map(async (tx) => {
           const { type, key } = tx;
           if (type !== `delete`) {
-            throw new Error(`Expected 'delete', got: ${type}`);
+            throw new errors.ExpectedDeleteTypeError(type);
           }
           await config.recordApi.delete(key);
           return String(key);
@@ -204,7 +200,7 @@ function trailBaseCollectionOptions(config) {
       await awaitIds(ids);
     },
     utils: {
-      cancel
+      cancel: cancelEventReader
     }
   };
 }

package/dist/cjs/trailbase.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"trailbase.cjs","sources":["../../src/trailbase.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unnecessary-condition */\nimport { Store } from \"@tanstack/store\"\nimport type { Event, RecordApi } from \"trailbase\"\n\nimport type {\n  CollectionConfig,\n  DeleteMutationFnParams,\n  InsertMutationFnParams,\n  SyncConfig,\n  UpdateMutationFnParams,\n  UtilsRecord,\n} from \"@tanstack/db\"\n\ntype ShapeOf<T> = Record<keyof T, unknown>\ntype Conversion<I, O> = (value: I) => O\n\ntype OptionalConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? K\n    : never]?: Conversion<InputType[K], OutputType[K]>\n}\n\ntype RequiredConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that do not strictly require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? never\n    : K]: Conversion<InputType[K], OutputType[K]>\n}\n\ntype Conversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = OptionalConversions<InputType, OutputType> &\n  RequiredConversions<InputType, OutputType>\n\nfunction convert<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: InputType\n): OutputType {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\nfunction convertPartial<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: Partial<InputType>\n): Partial<OutputType> {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\n/**\n * Configuration interface for Trailbase Collection\n */\nexport interface TrailBaseCollectionConfig<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n> extends Omit<\n    CollectionConfig<TItem, TKey>,\n    `sync` | `onInsert` | `onUpdate` | `onDelete`\n  > {\n  /**\n   * Record API name\n   */\n  recordApi: RecordApi<TRecord>\n\n  parse: Conversions<TRecord, TItem>\n  serialize: Conversions<TItem, TRecord>\n}\n\nexport type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>\n\nexport interface TrailBaseCollectionUtils extends UtilsRecord {\n  cancel: () => void\n}\n\nexport function trailBaseCollectionOptions<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n>(\n  config: TrailBaseCollectionConfig<TItem, TRecord, TKey>\n): CollectionConfig<TItem, TKey> & { utils: TrailBaseCollectionUtils } {\n  const getKey = config.getKey\n\n  const parse = (record: TRecord) =>\n    convert<TRecord, TItem>(config.parse, record)\n  const serialUpd = (item: Partial<TItem>) =>\n    convertPartial<TItem, TRecord>(config.serialize, item)\n  const serialIns = (item: TItem) =>\n    convert<TItem, TRecord>(config.serialize, item)\n\n  const seenIds = new Store(new Map<string, number>())\n\n  const awaitIds = (\n    ids: Array<string>,\n    timeout: number = 120 * 1000\n  ): Promise<void> => {\n    const completed = (value: Map<string, number>) =>\n      ids.every((id) => value.has(id))\n    if (completed(seenIds.state)) {\n      return Promise.resolve()\n    }\n\n    return new Promise<void>((resolve, reject) => {\n      const timeoutId = setTimeout(() => {\n        unsubscribe()\n        reject(new Error(`Timeout waiting for ids: ${ids}`))\n      }, timeout)\n\n      const unsubscribe = seenIds.subscribe((value) => {\n        if (completed(value.currentVal)) {\n          clearTimeout(timeoutId)\n          unsubscribe()\n          resolve()\n        }\n      })\n    })\n  }\n\n  const weakSeenIds = new WeakRef(seenIds)\n  const cleanupTimer = setInterval(() => {\n    const seen = weakSeenIds.deref()\n    if (seen) {\n      seen.setState((curr) => {\n        const now = Date.now()\n        let anyExpired = false\n\n        const notExpired = Array.from(curr.entries()).filter(([_, v]) => {\n          const expired = now - v > 300 * 1000\n          anyExpired = anyExpired || expired\n          return !expired\n        })\n\n        if (anyExpired) {\n          return new Map(notExpired)\n        }\n        return curr\n      })\n    } else {\n      clearInterval(cleanupTimer)\n    }\n  }, 120 * 1000)\n\n  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]\n\n  let eventReader: ReadableStreamDefaultReader<Event> | undefined\n  const cancel = () => {\n    if (eventReader) {\n      eventReader.cancel()\n      eventReader.releaseLock()\n      eventReader = undefined\n    }\n  }\n\n  const sync = {\n    sync: (params: SyncParams) => {\n      const { begin, write, commit, markReady } = params\n\n      // Initial fetch.\n      async function initialFetch() {\n        const limit = 256\n        let response = await config.recordApi.list({\n          pagination: {\n            limit,\n          },\n        })\n        let cursor = response.cursor\n        let got = 0\n\n        begin()\n\n        while (true) {\n          const length = response.records.length\n          if (length === 0) break\n\n          got = got + length\n          for (const item of response.records) {\n            write({\n              type: `insert`,\n              value: parse(item),\n            })\n          }\n\n          if (length < limit) break\n\n          response = await config.recordApi.list({\n            pagination: {\n              limit,\n              cursor,\n              offset: cursor === undefined ? got : undefined,\n            },\n          })\n          cursor = response.cursor\n        }\n\n        commit()\n        markReady()\n      }\n\n      // Afterwards subscribe.\n      async function listen(reader: ReadableStreamDefaultReader<Event>) {\n        while (true) {\n          const { done, value: event } = await reader.read()\n\n          if (done || !event) {\n            reader.releaseLock()\n            eventReader = undefined\n            return\n          }\n\n          begin()\n          let value: TItem | undefined\n          if (`Insert` in event) {\n            value = parse(event.Insert as TRecord)\n            write({ type: `insert`, value })\n          } else if (`Delete` in event) {\n            value = parse(event.Delete as TRecord)\n            write({ type: `delete`, value })\n          } else if (`Update` in event) {\n            value = parse(event.Update as TRecord)\n            write({ type: `update`, value })\n          } else {\n            console.error(`Error: ${event.Error}`)\n          }\n          commit()\n\n          if (value) {\n            seenIds.setState((curr: Map<string, number>) => {\n              const newIds = new Map(curr)\n              newIds.set(String(getKey(value)), Date.now())\n              return newIds\n            })\n          }\n        }\n      }\n\n      async function start() {\n        const eventStream = await config.recordApi.subscribe(`*`)\n        const reader = (eventReader = eventStream.getReader())\n\n        // Start listening for subscriptions first. Otherwise, we'd risk a gap\n        // between the initial fetch and starting to listen.\n        listen(reader)\n\n        try {\n          await initialFetch()\n        } catch (e) {\n          cancel()\n          markReady()\n          throw e\n        }\n      }\n\n      start()\n    },\n    // Expose the getSyncMetadata function\n    getSyncMetadata: undefined,\n  }\n\n  return {\n    ...config,\n    sync,\n    getKey,\n    onInsert: async (\n      params: InsertMutationFnParams<TItem, TKey>\n    ): Promise<Array<number | string>> => {\n      const ids = await config.recordApi.createBulk(\n        params.transaction.mutations.map((tx) => {\n          const { type, modified } = tx\n          if (type !== `insert`) {\n            throw new Error(`Expected 'insert', got: ${type}`)\n          }\n          return serialIns(modified)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly added to the local\n      // DB by the subscription.\n      await awaitIds(ids.map((id) => String(id)))\n\n      return ids\n    },\n    onUpdate: async (params: UpdateMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, changes, key } = tx\n          if (type !== `update`) {\n            throw new Error(`Expected 'update', got: ${type}`)\n          }\n\n          await config.recordApi.update(key, serialUpd(changes))\n\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    onDelete: async (params: DeleteMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, key } = tx\n          if (type !== `delete`) {\n            throw new Error(`Expected 'delete', got: ${type}`)\n          }\n\n          await config.recordApi.delete(key)\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    utils: {\n      cancel,\n    },\n  }\n}\n"],"names":["Store"],"mappings":";;;AA0CA,SAAS,QAIP,aACA,OACY;AACZ,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AAEA,SAAS,eAIP,aACA,OACqB;AACrB,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AA4BO,SAAS,2BAKd,QACqE;AACrE,QAAM,SAAS,OAAO;AAEtB,QAAM,QAAQ,CAAC,WACb,QAAwB,OAAO,OAAO,MAAM;AAC9C,QAAM,YAAY,CAAC,SACjB,eAA+B,OAAO,WAAW,IAAI;AACvD,QAAM,YAAY,CAAC,SACjB,QAAwB,OAAO,WAAW,IAAI;AAEhD,QAAM,UAAU,IAAIA,YAAM,oBAAI,KAAqB;AAEnD,QAAM,WAAW,CACf,KACA,UAAkB,MAAM,QACN;AAClB,UAAM,YAAY,CAAC,UACjB,IAAI,MAAM,CAAC,OAAO,MAAM,IAAI,EAAE,CAAC;AACjC,QAAI,UAAU,QAAQ,KAAK,GAAG;AAC5B,aAAO,QAAQ,QAAA;AAAA,IACjB;AAEA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,YAAM,YAAY,WAAW,MAAM;AACjC,oBAAA;AACA,eAAO,IAAI,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAAA,MACrD,GAAG,OAAO;AAEV,YAAM,cAAc,QAAQ,UAAU,CAAC,UAAU;AAC/C,YAAI,UAAU,MAAM,UAAU,GAAG;AAC/B,uBAAa,SAAS;AACtB,sBAAA;AACA,kBAAA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAEA,QAAM,cAAc,IAAI,QAAQ,OAAO;AACvC,QAAM,eAAe,YAAY,MAAM;AACrC,UAAM,OAAO,YAAY,MAAA;AACzB,QAAI,MAAM;AACR,WAAK,SAAS,CAAC,SAAS;AACtB,cAAM,MAAM,KAAK,IAAA;AACjB,YAAI,aAAa;AAEjB,cAAM,aAAa,MAAM,KAAK,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM;AAC/D,gBAAM,UAAU,MAAM,IAAI,MAAM;AAChC,uBAAa,cAAc;AAC3B,iBAAO,CAAC;AAAA,QACV,CAAC;AAED,YAAI,YAAY;AACd,iBAAO,IAAI,IAAI,UAAU;AAAA,QAC3B;AACA,eAAO;AAAA,MACT,CAAC;AAAA,IACH,OAAO;AACL,oBAAc,YAAY;AAAA,IAC5B;AAAA,EACF,GAAG,MAAM,GAAI;AAIb,MAAI;AACJ,QAAM,SAAS,MAAM;AACnB,QAAI,aAAa;AACf,kBAAY,OAAA;AACZ,kBAAY,YAAA;AACZ,oBAAc;AAAA,IAChB;AAAA,EACF;AAEA,QAAM,OAAO;AAAA,IACX,MAAM,CAAC,WAAuB;AAC5B,YAAM,EAAE,OAAO,OAAO,QAAQ,cAAc;AAG5C,qBAAe,eAAe;AAC5B,cAAM,QAAQ;AACd,YAAI,WAAW,MAAM,OAAO,UAAU,KAAK;AAAA,UACzC,YAAY;AAAA,YACV;AAAA,UAAA;AAAA,QACF,CACD;AACD,YAAI,SAAS,SAAS;AACtB,YAAI,MAAM;AAEV,cAAA;AAEA,eAAO,MAAM;AACX,gBAAM,SAAS,SAAS,QAAQ;AAChC,cAAI,WAAW,EAAG;AAElB,gBAAM,MAAM;AACZ,qBAAW,QAAQ,SAAS,SAAS;AACnC,kBAAM;AAAA,cACJ,MAAM;AAAA,cACN,OAAO,MAAM,IAAI;AAAA,YAAA,CAClB;AAAA,UACH;AAEA,cAAI,SAAS,MAAO;AAEpB,qBAAW,MAAM,OAAO,UAAU,KAAK;AAAA,YACrC,YAAY;AAAA,cACV;AAAA,cACA;AAAA,cACA,QAAQ,WAAW,SAAY,MAAM;AAAA,YAAA;AAAA,UACvC,CACD;AACD,mBAAS,SAAS;AAAA,QACpB;AAEA,eAAA;AACA,kBAAA;AAAA,MACF;AAGA,qBAAe,OAAO,QAA4C;AAChE,eAAO,MAAM;AACX,gBAAM,EAAE,MAAM,OAAO,UAAU,MAAM,OAAO,KAAA;AAE5C,cAAI,QAAQ,CAAC,OAAO;AAClB,mBAAO,YAAA;AACP,0BAAc;AACd;AAAA,UACF;AAEA,gBAAA;AACA,cAAI;AACJ,cAAI,YAAY,OAAO;AACrB,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,UAAU,MAAM,KAAK,EAAE;AAAA,UACvC;AACA,iBAAA;AAEA,cAAI,OAAO;AACT,oBAAQ,SAAS,CAAC,SAA8B;AAC9C,oBAAM,SAAS,IAAI,IAAI,IAAI;AAC3B,qBAAO,IAAI,OAAO,OAAO,KAAK,CAAC,GAAG,KAAK,KAAK;AAC5C,qBAAO;AAAA,YACT,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAEA,qBAAe,QAAQ;AACrB,cAAM,cAAc,MAAM,OAAO,UAAU,UAAU,GAAG;AACxD,cAAM,SAAU,cAAc,YAAY,UAAA;AAI1C,eAAO,MAAM;AAEb,YAAI;AACF,gBAAM,aAAA;AAAA,QACR,SAAS,GAAG;AACV,iBAAA;AACA,oBAAA;AACA,gBAAM;AAAA,QACR;AAAA,MACF;AAEA,YAAA;AAAA,IACF;AAAA;AAAA,IAEA,iBAAiB;AAAA,EAAA;AAGnB,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,UAAU,OACR,WACoC;AACpC,YAAM,MAAM,MAAM,OAAO,UAAU;AAAA,QACjC,OAAO,YAAY,UAAU,IAAI,CAAC,OAAO;AACvC,gBAAM,EAAE,MAAM,SAAA,IAAa;AAC3B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AACA,iBAAO,UAAU,QAAQ;AAAA,QAC3B,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,IAAI,IAAI,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;AAE1C,aAAO;AAAA,IACT;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,SAAS,IAAA,IAAQ;AAC/B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AAEA,gBAAM,OAAO,UAAU,OAAO,KAAK,UAAU,OAAO,CAAC;AAErD,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,IAAA,IAAQ;AACtB,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AAEA,gBAAM,OAAO,UAAU,OAAO,GAAG;AACjC,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,OAAO;AAAA,MACL;AAAA,IAAA;AAAA,EACF;AAEJ;;"}
+{"version":3,"file":"trailbase.cjs","sources":["../../src/trailbase.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unnecessary-condition */\nimport { Store } from \"@tanstack/store\"\nimport {\n  ExpectedDeleteTypeError,\n  ExpectedInsertTypeError,\n  ExpectedUpdateTypeError,\n  TimeoutWaitingForIdsError,\n} from \"./errors\"\nimport type { Event, RecordApi } from \"trailbase\"\n\nimport type {\n  CollectionConfig,\n  DeleteMutationFnParams,\n  InsertMutationFnParams,\n  SyncConfig,\n  UpdateMutationFnParams,\n  UtilsRecord,\n} from \"@tanstack/db\"\n\ntype ShapeOf<T> = Record<keyof T, unknown>\ntype Conversion<I, O> = (value: I) => O\n\ntype OptionalConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? K\n    : never]?: Conversion<InputType[K], OutputType[K]>\n}\n\ntype RequiredConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that do not strictly require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? never\n    : K]: Conversion<InputType[K], OutputType[K]>\n}\n\ntype Conversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = OptionalConversions<InputType, OutputType> &\n  RequiredConversions<InputType, OutputType>\n\nfunction convert<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: InputType\n): OutputType {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\nfunction convertPartial<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: Partial<InputType>\n): Partial<OutputType> {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\n/**\n * Configuration interface for Trailbase Collection\n */\nexport interface TrailBaseCollectionConfig<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n> extends Omit<\n    CollectionConfig<TItem, TKey>,\n    `sync` | `onInsert` | `onUpdate` | `onDelete`\n  > {\n  /**\n   * Record API name\n   */\n  recordApi: RecordApi<TRecord>\n\n  parse: Conversions<TRecord, TItem>\n  serialize: Conversions<TItem, TRecord>\n}\n\nexport type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>\n\nexport interface TrailBaseCollectionUtils extends UtilsRecord {\n  cancel: () => void\n}\n\nexport function trailBaseCollectionOptions<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n>(\n  config: TrailBaseCollectionConfig<TItem, TRecord, TKey>\n): CollectionConfig<TItem, TKey> & { utils: TrailBaseCollectionUtils } {\n  const getKey = config.getKey\n\n  const parse = (record: TRecord) =>\n    convert<TRecord, TItem>(config.parse, record)\n  const serialUpd = (item: Partial<TItem>) =>\n    convertPartial<TItem, TRecord>(config.serialize, item)\n  const serialIns = (item: TItem) =>\n    convert<TItem, TRecord>(config.serialize, item)\n\n  const seenIds = new Store(new Map<string, number>())\n\n  const awaitIds = (\n    ids: Array<string>,\n    timeout: number = 120 * 1000\n  ): Promise<void> => {\n    const completed = (value: Map<string, number>) =>\n      ids.every((id) => value.has(id))\n    if (completed(seenIds.state)) {\n      return Promise.resolve()\n    }\n\n    return new Promise<void>((resolve, reject) => {\n      const timeoutId = setTimeout(() => {\n        unsubscribe()\n        reject(new TimeoutWaitingForIdsError(ids.toString()))\n      }, timeout)\n\n      const unsubscribe = seenIds.subscribe((value) => {\n        if (completed(value.currentVal)) {\n          clearTimeout(timeoutId)\n          unsubscribe()\n          resolve()\n        }\n      })\n    })\n  }\n\n  let eventReader: ReadableStreamDefaultReader<Event> | undefined\n  const cancelEventReader = () => {\n    if (eventReader) {\n      eventReader.cancel()\n      eventReader.releaseLock()\n      eventReader = undefined\n    }\n  }\n\n  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]\n  const sync = {\n    sync: (params: SyncParams) => {\n      const { begin, write, commit, markReady } = params\n\n      // Initial fetch.\n      async function initialFetch() {\n        const limit = 256\n        let response = await config.recordApi.list({\n          pagination: {\n            limit,\n          },\n        })\n        let cursor = response.cursor\n        let got = 0\n\n        begin()\n\n        while (true) {\n          const length = response.records.length\n          if (length === 0) break\n\n          got = got + length\n          for (const item of response.records) {\n            write({\n              type: `insert`,\n              value: parse(item),\n            })\n          }\n\n          if (length < limit) break\n\n          response = await config.recordApi.list({\n            pagination: {\n              limit,\n              cursor,\n              offset: cursor === undefined ? got : undefined,\n            },\n          })\n          cursor = response.cursor\n        }\n\n        commit()\n      }\n\n      // Afterwards subscribe.\n      async function listen(reader: ReadableStreamDefaultReader<Event>) {\n        while (true) {\n          const { done, value: event } = await reader.read()\n\n          if (done || !event) {\n            reader.releaseLock()\n            eventReader = undefined\n            return\n          }\n\n          begin()\n          let value: TItem | undefined\n          if (`Insert` in event) {\n            value = parse(event.Insert as TRecord)\n            write({ type: `insert`, value })\n          } else if (`Delete` in event) {\n            value = parse(event.Delete as TRecord)\n            write({ type: `delete`, value })\n          } else if (`Update` in event) {\n            value = parse(event.Update as TRecord)\n            write({ type: `update`, value })\n          } else {\n            console.error(`Error: ${event.Error}`)\n          }\n          commit()\n\n          if (value) {\n            seenIds.setState((curr: Map<string, number>) => {\n              const newIds = new Map(curr)\n              newIds.set(String(getKey(value)), Date.now())\n              return newIds\n            })\n          }\n        }\n      }\n\n      async function start() {\n        const eventStream = await config.recordApi.subscribe(`*`)\n        const reader = (eventReader = eventStream.getReader())\n\n        // Start listening for subscriptions first. Otherwise, we'd risk a gap\n        // between the initial fetch and starting to listen.\n        listen(reader)\n\n        try {\n          await initialFetch()\n        } catch (e) {\n          cancelEventReader()\n          throw e\n        } finally {\n          // Mark ready both if everything went well or if there's an error to\n          // avoid blocking apps waiting for `.preload()` to finish.\n          markReady()\n        }\n\n        // Lastly, start a periodic cleanup task that will be removed when the\n        // reader closes.\n        const periodicCleanupTask = setInterval(() => {\n          seenIds.setState((curr) => {\n            const now = Date.now()\n            let anyExpired = false\n\n            const notExpired = Array.from(curr.entries()).filter(([_, v]) => {\n              const expired = now - v > 300 * 1000\n              anyExpired = anyExpired || expired\n              return !expired\n            })\n\n            if (anyExpired) {\n              return new Map(notExpired)\n            }\n            return curr\n          })\n        }, 120 * 1000)\n\n        reader.closed.finally(() => clearInterval(periodicCleanupTask))\n      }\n\n      start()\n    },\n    // Expose the getSyncMetadata function\n    getSyncMetadata: undefined,\n  }\n\n  return {\n    ...config,\n    sync,\n    getKey,\n    onInsert: async (\n      params: InsertMutationFnParams<TItem, TKey>\n    ): Promise<Array<number | string>> => {\n      const ids = await config.recordApi.createBulk(\n        params.transaction.mutations.map((tx) => {\n          const { type, modified } = tx\n          if (type !== `insert`) {\n            throw new ExpectedInsertTypeError(type)\n          }\n          return serialIns(modified)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly added to the local\n      // DB by the subscription.\n      await awaitIds(ids.map((id) => String(id)))\n\n      return ids\n    },\n    onUpdate: async (params: UpdateMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, changes, key } = tx\n          if (type !== `update`) {\n            throw new ExpectedUpdateTypeError(type)\n          }\n\n          await config.recordApi.update(key, serialUpd(changes))\n\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    onDelete: async (params: DeleteMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, key } = tx\n          if (type !== `delete`) {\n            throw new ExpectedDeleteTypeError(type)\n          }\n\n          await config.recordApi.delete(key)\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    utils: {\n      cancel: cancelEventReader,\n    },\n  }\n}\n"],"names":["Store","TimeoutWaitingForIdsError","ExpectedInsertTypeError","ExpectedUpdateTypeError","ExpectedDeleteTypeError"],"mappings":";;;;AAgDA,SAAS,QAIP,aACA,OACY;AACZ,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AAEA,SAAS,eAIP,aACA,OACqB;AACrB,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AA4BO,SAAS,2BAKd,QACqE;AACrE,QAAM,SAAS,OAAO;AAEtB,QAAM,QAAQ,CAAC,WACb,QAAwB,OAAO,OAAO,MAAM;AAC9C,QAAM,YAAY,CAAC,SACjB,eAA+B,OAAO,WAAW,IAAI;AACvD,QAAM,YAAY,CAAC,SACjB,QAAwB,OAAO,WAAW,IAAI;AAEhD,QAAM,UAAU,IAAIA,YAAM,oBAAI,KAAqB;AAEnD,QAAM,WAAW,CACf,KACA,UAAkB,MAAM,QACN;AAClB,UAAM,YAAY,CAAC,UACjB,IAAI,MAAM,CAAC,OAAO,MAAM,IAAI,EAAE,CAAC;AACjC,QAAI,UAAU,QAAQ,KAAK,GAAG;AAC5B,aAAO,QAAQ,QAAA;AAAA,IACjB;AAEA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,YAAM,YAAY,WAAW,MAAM;AACjC,oBAAA;AACA,eAAO,IAAIC,OAAAA,0BAA0B,IAAI,SAAA,CAAU,CAAC;AAAA,MACtD,GAAG,OAAO;AAEV,YAAM,cAAc,QAAQ,UAAU,CAAC,UAAU;AAC/C,YAAI,UAAU,MAAM,UAAU,GAAG;AAC/B,uBAAa,SAAS;AACtB,sBAAA;AACA,kBAAA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAEA,MAAI;AACJ,QAAM,oBAAoB,MAAM;AAC9B,QAAI,aAAa;AACf,kBAAY,OAAA;AACZ,kBAAY,YAAA;AACZ,oBAAc;AAAA,IAChB;AAAA,EACF;AAGA,QAAM,OAAO;AAAA,IACX,MAAM,CAAC,WAAuB;AAC5B,YAAM,EAAE,OAAO,OAAO,QAAQ,cAAc;AAG5C,qBAAe,eAAe;AAC5B,cAAM,QAAQ;AACd,YAAI,WAAW,MAAM,OAAO,UAAU,KAAK;AAAA,UACzC,YAAY;AAAA,YACV;AAAA,UAAA;AAAA,QACF,CACD;AACD,YAAI,SAAS,SAAS;AACtB,YAAI,MAAM;AAEV,cAAA;AAEA,eAAO,MAAM;AACX,gBAAM,SAAS,SAAS,QAAQ;AAChC,cAAI,WAAW,EAAG;AAElB,gBAAM,MAAM;AACZ,qBAAW,QAAQ,SAAS,SAAS;AACnC,kBAAM;AAAA,cACJ,MAAM;AAAA,cACN,OAAO,MAAM,IAAI;AAAA,YAAA,CAClB;AAAA,UACH;AAEA,cAAI,SAAS,MAAO;AAEpB,qBAAW,MAAM,OAAO,UAAU,KAAK;AAAA,YACrC,YAAY;AAAA,cACV;AAAA,cACA;AAAA,cACA,QAAQ,WAAW,SAAY,MAAM;AAAA,YAAA;AAAA,UACvC,CACD;AACD,mBAAS,SAAS;AAAA,QACpB;AAEA,eAAA;AAAA,MACF;AAGA,qBAAe,OAAO,QAA4C;AAChE,eAAO,MAAM;AACX,gBAAM,EAAE,MAAM,OAAO,UAAU,MAAM,OAAO,KAAA;AAE5C,cAAI,QAAQ,CAAC,OAAO;AAClB,mBAAO,YAAA;AACP,0BAAc;AACd;AAAA,UACF;AAEA,gBAAA;AACA,cAAI;AACJ,cAAI,YAAY,OAAO;AACrB,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,UAAU,MAAM,KAAK,EAAE;AAAA,UACvC;AACA,iBAAA;AAEA,cAAI,OAAO;AACT,oBAAQ,SAAS,CAAC,SAA8B;AAC9C,oBAAM,SAAS,IAAI,IAAI,IAAI;AAC3B,qBAAO,IAAI,OAAO,OAAO,KAAK,CAAC,GAAG,KAAK,KAAK;AAC5C,qBAAO;AAAA,YACT,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAEA,qBAAe,QAAQ;AACrB,cAAM,cAAc,MAAM,OAAO,UAAU,UAAU,GAAG;AACxD,cAAM,SAAU,cAAc,YAAY,UAAA;AAI1C,eAAO,MAAM;AAEb,YAAI;AACF,gBAAM,aAAA;AAAA,QACR,SAAS,GAAG;AACV,4BAAA;AACA,gBAAM;AAAA,QACR,UAAA;AAGE,oBAAA;AAAA,QACF;AAIA,cAAM,sBAAsB,YAAY,MAAM;AAC5C,kBAAQ,SAAS,CAAC,SAAS;AACzB,kBAAM,MAAM,KAAK,IAAA;AACjB,gBAAI,aAAa;AAEjB,kBAAM,aAAa,MAAM,KAAK,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM;AAC/D,oBAAM,UAAU,MAAM,IAAI,MAAM;AAChC,2BAAa,cAAc;AAC3B,qBAAO,CAAC;AAAA,YACV,CAAC;AAED,gBAAI,YAAY;AACd,qBAAO,IAAI,IAAI,UAAU;AAAA,YAC3B;AACA,mBAAO;AAAA,UACT,CAAC;AAAA,QACH,GAAG,MAAM,GAAI;AAEb,eAAO,OAAO,QAAQ,MAAM,cAAc,mBAAmB,CAAC;AAAA,MAChE;AAEA,YAAA;AAAA,IACF;AAAA;AAAA,IAEA,iBAAiB;AAAA,EAAA;AAGnB,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,UAAU,OACR,WACoC;AACpC,YAAM,MAAM,MAAM,OAAO,UAAU;AAAA,QACjC,OAAO,YAAY,UAAU,IAAI,CAAC,OAAO;AACvC,gBAAM,EAAE,MAAM,SAAA,IAAa;AAC3B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAIC,OAAAA,wBAAwB,IAAI;AAAA,UACxC;AACA,iBAAO,UAAU,QAAQ;AAAA,QAC3B,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,IAAI,IAAI,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;AAE1C,aAAO;AAAA,IACT;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,SAAS,IAAA,IAAQ;AAC/B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAIC,OAAAA,wBAAwB,IAAI;AAAA,UACxC;AAEA,gBAAM,OAAO,UAAU,OAAO,KAAK,UAAU,OAAO,CAAC;AAErD,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,IAAA,IAAQ;AACtB,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAIC,OAAAA,wBAAwB,IAAI;AAAA,UACxC;AAEA,gBAAM,OAAO,UAAU,OAAO,GAAG;AACjC,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,OAAO;AAAA,MACL,QAAQ;AAAA,IAAA;AAAA,EACV;AAEJ;;"}

package/dist/esm/errors.d.ts

@@ -0,0 +1,16 @@
+import { TanStackDBError } from '@tanstack/db';
+export declare class TrailBaseDBCollectionError extends TanStackDBError {
+    constructor(message: string);
+}
+export declare class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {
+    constructor(ids: string);
+}
+export declare class ExpectedInsertTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}
+export declare class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}
+export declare class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {
+    constructor(actualType: string);
+}

package/dist/esm/errors.js

@@ -0,0 +1,39 @@
+import { TanStackDBError } from "@tanstack/db";
+class TrailBaseDBCollectionError extends TanStackDBError {
+  constructor(message) {
+    super(message);
+    this.name = `TrailBaseDBCollectionError`;
+  }
+}
+class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {
+  constructor(ids) {
+    super(`Timeout waiting for ids: ${ids}`);
+    this.name = `TimeoutWaitingForIdsError`;
+  }
+}
+class ExpectedInsertTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'insert', got: ${actualType}`);
+    this.name = `ExpectedInsertTypeError`;
+  }
+}
+class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'update', got: ${actualType}`);
+    this.name = `ExpectedUpdateTypeError`;
+  }
+}
+class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType) {
+    super(`Expected 'delete', got: ${actualType}`);
+    this.name = `ExpectedDeleteTypeError`;
+  }
+}
+export {
+  ExpectedDeleteTypeError,
+  ExpectedInsertTypeError,
+  ExpectedUpdateTypeError,
+  TimeoutWaitingForIdsError,
+  TrailBaseDBCollectionError
+};
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sources":["../../src/errors.ts"],"sourcesContent":["import { TanStackDBError } from \"@tanstack/db\"\n\n// TrailBase DB Collection Errors\nexport class TrailBaseDBCollectionError extends TanStackDBError {\n  constructor(message: string) {\n    super(message)\n    this.name = `TrailBaseDBCollectionError`\n  }\n}\n\nexport class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {\n  constructor(ids: string) {\n    super(`Timeout waiting for ids: ${ids}`)\n    this.name = `TimeoutWaitingForIdsError`\n  }\n}\n\nexport class ExpectedInsertTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'insert', got: ${actualType}`)\n    this.name = `ExpectedInsertTypeError`\n  }\n}\n\nexport class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'update', got: ${actualType}`)\n    this.name = `ExpectedUpdateTypeError`\n  }\n}\n\nexport class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {\n  constructor(actualType: string) {\n    super(`Expected 'delete', got: ${actualType}`)\n    this.name = `ExpectedDeleteTypeError`\n  }\n}\n"],"names":[],"mappings":";AAGO,MAAM,mCAAmC,gBAAgB;AAAA,EAC9D,YAAY,SAAiB;AAC3B,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,kCAAkC,2BAA2B;AAAA,EACxE,YAAY,KAAa;AACvB,UAAM,4BAA4B,GAAG,EAAE;AACvC,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;AAEO,MAAM,gCAAgC,2BAA2B;AAAA,EACtE,YAAY,YAAoB;AAC9B,UAAM,2BAA2B,UAAU,EAAE;AAC7C,SAAK,OAAO;AAAA,EACd;AACF;"}

package/dist/esm/index.d.ts

@@ -1 +1,2 @@
 export { trailBaseCollectionOptions, type TrailBaseCollectionConfig, type TrailBaseCollectionUtils, } from './trailbase.js';
+export * from './errors.js';

package/dist/esm/index.js

@@ -1,5 +1,11 @@
 import { trailBaseCollectionOptions } from "./trailbase.js";
+import { ExpectedDeleteTypeError, ExpectedInsertTypeError, ExpectedUpdateTypeError, TimeoutWaitingForIdsError, TrailBaseDBCollectionError } from "./errors.js";
 export {
+  ExpectedDeleteTypeError,
+  ExpectedInsertTypeError,
+  ExpectedUpdateTypeError,
+  TimeoutWaitingForIdsError,
+  TrailBaseDBCollectionError,
   trailBaseCollectionOptions
 };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

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

package/dist/esm/trailbase.js

@@ -1,4 +1,5 @@
 import { Store } from "@tanstack/store";
+import { ExpectedDeleteTypeError, ExpectedUpdateTypeError, ExpectedInsertTypeError, TimeoutWaitingForIdsError } from "./errors.js";
 function convert(conversions, input) {
   const c = conversions;
   return Object.fromEntries(
@@ -33,7 +34,7 @@ function trailBaseCollectionOptions(config) {
     return new Promise((resolve, reject) => {
       const timeoutId = setTimeout(() => {
         unsubscribe();
-        reject(new Error(`Timeout waiting for ids: ${ids}`));
+        reject(new TimeoutWaitingForIdsError(ids.toString()));
       }, timeout);
       const unsubscribe = seenIds.subscribe((value) => {
         if (completed(value.currentVal)) {
@@ -44,29 +45,8 @@ function trailBaseCollectionOptions(config) {
       });
     });
   };
-  const weakSeenIds = new WeakRef(seenIds);
-  const cleanupTimer = setInterval(() => {
-    const seen = weakSeenIds.deref();
-    if (seen) {
-      seen.setState((curr) => {
-        const now = Date.now();
-        let anyExpired = false;
-        const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
-          const expired = now - v > 300 * 1e3;
-          anyExpired = anyExpired || expired;
-          return !expired;
-        });
-        if (anyExpired) {
-          return new Map(notExpired);
-        }
-        return curr;
-      });
-    } else {
-      clearInterval(cleanupTimer);
-    }
-  }, 120 * 1e3);
   let eventReader;
-  const cancel = () => {
+  const cancelEventReader = () => {
     if (eventReader) {
       eventReader.cancel();
       eventReader.releaseLock();
@@ -107,7 +87,6 @@ function trailBaseCollectionOptions(config) {
           cursor = response.cursor;
         }
         commit();
-        markReady();
       }
       async function listen(reader) {
         while (true) {
@@ -148,10 +127,27 @@ function trailBaseCollectionOptions(config) {
         try {
           await initialFetch();
         } catch (e) {
-          cancel();
-          markReady();
+          cancelEventReader();
           throw e;
+        } finally {
+          markReady();
         }
+        const periodicCleanupTask = setInterval(() => {
+          seenIds.setState((curr) => {
+            const now = Date.now();
+            let anyExpired = false;
+            const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
+              const expired = now - v > 300 * 1e3;
+              anyExpired = anyExpired || expired;
+              return !expired;
+            });
+            if (anyExpired) {
+              return new Map(notExpired);
+            }
+            return curr;
+          });
+        }, 120 * 1e3);
+        reader.closed.finally(() => clearInterval(periodicCleanupTask));
       }
       start();
     },
@@ -167,7 +163,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map((tx) => {
           const { type, modified } = tx;
           if (type !== `insert`) {
-            throw new Error(`Expected 'insert', got: ${type}`);
+            throw new ExpectedInsertTypeError(type);
           }
           return serialIns(modified);
         })
@@ -180,7 +176,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map(async (tx) => {
           const { type, changes, key } = tx;
           if (type !== `update`) {
-            throw new Error(`Expected 'update', got: ${type}`);
+            throw new ExpectedUpdateTypeError(type);
           }
           await config.recordApi.update(key, serialUpd(changes));
           return String(key);
@@ -193,7 +189,7 @@ function trailBaseCollectionOptions(config) {
         params.transaction.mutations.map(async (tx) => {
           const { type, key } = tx;
           if (type !== `delete`) {
-            throw new Error(`Expected 'delete', got: ${type}`);
+            throw new ExpectedDeleteTypeError(type);
           }
           await config.recordApi.delete(key);
           return String(key);
@@ -202,7 +198,7 @@ function trailBaseCollectionOptions(config) {
       await awaitIds(ids);
     },
     utils: {
-      cancel
+      cancel: cancelEventReader
     }
   };
 }

package/dist/esm/trailbase.js.map

@@ -1 +1 @@
-{"version":3,"file":"trailbase.js","sources":["../../src/trailbase.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unnecessary-condition */\nimport { Store } from \"@tanstack/store\"\nimport type { Event, RecordApi } from \"trailbase\"\n\nimport type {\n  CollectionConfig,\n  DeleteMutationFnParams,\n  InsertMutationFnParams,\n  SyncConfig,\n  UpdateMutationFnParams,\n  UtilsRecord,\n} from \"@tanstack/db\"\n\ntype ShapeOf<T> = Record<keyof T, unknown>\ntype Conversion<I, O> = (value: I) => O\n\ntype OptionalConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? K\n    : never]?: Conversion<InputType[K], OutputType[K]>\n}\n\ntype RequiredConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that do not strictly require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? never\n    : K]: Conversion<InputType[K], OutputType[K]>\n}\n\ntype Conversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = OptionalConversions<InputType, OutputType> &\n  RequiredConversions<InputType, OutputType>\n\nfunction convert<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: InputType\n): OutputType {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\nfunction convertPartial<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: Partial<InputType>\n): Partial<OutputType> {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\n/**\n * Configuration interface for Trailbase Collection\n */\nexport interface TrailBaseCollectionConfig<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n> extends Omit<\n    CollectionConfig<TItem, TKey>,\n    `sync` | `onInsert` | `onUpdate` | `onDelete`\n  > {\n  /**\n   * Record API name\n   */\n  recordApi: RecordApi<TRecord>\n\n  parse: Conversions<TRecord, TItem>\n  serialize: Conversions<TItem, TRecord>\n}\n\nexport type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>\n\nexport interface TrailBaseCollectionUtils extends UtilsRecord {\n  cancel: () => void\n}\n\nexport function trailBaseCollectionOptions<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n>(\n  config: TrailBaseCollectionConfig<TItem, TRecord, TKey>\n): CollectionConfig<TItem, TKey> & { utils: TrailBaseCollectionUtils } {\n  const getKey = config.getKey\n\n  const parse = (record: TRecord) =>\n    convert<TRecord, TItem>(config.parse, record)\n  const serialUpd = (item: Partial<TItem>) =>\n    convertPartial<TItem, TRecord>(config.serialize, item)\n  const serialIns = (item: TItem) =>\n    convert<TItem, TRecord>(config.serialize, item)\n\n  const seenIds = new Store(new Map<string, number>())\n\n  const awaitIds = (\n    ids: Array<string>,\n    timeout: number = 120 * 1000\n  ): Promise<void> => {\n    const completed = (value: Map<string, number>) =>\n      ids.every((id) => value.has(id))\n    if (completed(seenIds.state)) {\n      return Promise.resolve()\n    }\n\n    return new Promise<void>((resolve, reject) => {\n      const timeoutId = setTimeout(() => {\n        unsubscribe()\n        reject(new Error(`Timeout waiting for ids: ${ids}`))\n      }, timeout)\n\n      const unsubscribe = seenIds.subscribe((value) => {\n        if (completed(value.currentVal)) {\n          clearTimeout(timeoutId)\n          unsubscribe()\n          resolve()\n        }\n      })\n    })\n  }\n\n  const weakSeenIds = new WeakRef(seenIds)\n  const cleanupTimer = setInterval(() => {\n    const seen = weakSeenIds.deref()\n    if (seen) {\n      seen.setState((curr) => {\n        const now = Date.now()\n        let anyExpired = false\n\n        const notExpired = Array.from(curr.entries()).filter(([_, v]) => {\n          const expired = now - v > 300 * 1000\n          anyExpired = anyExpired || expired\n          return !expired\n        })\n\n        if (anyExpired) {\n          return new Map(notExpired)\n        }\n        return curr\n      })\n    } else {\n      clearInterval(cleanupTimer)\n    }\n  }, 120 * 1000)\n\n  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]\n\n  let eventReader: ReadableStreamDefaultReader<Event> | undefined\n  const cancel = () => {\n    if (eventReader) {\n      eventReader.cancel()\n      eventReader.releaseLock()\n      eventReader = undefined\n    }\n  }\n\n  const sync = {\n    sync: (params: SyncParams) => {\n      const { begin, write, commit, markReady } = params\n\n      // Initial fetch.\n      async function initialFetch() {\n        const limit = 256\n        let response = await config.recordApi.list({\n          pagination: {\n            limit,\n          },\n        })\n        let cursor = response.cursor\n        let got = 0\n\n        begin()\n\n        while (true) {\n          const length = response.records.length\n          if (length === 0) break\n\n          got = got + length\n          for (const item of response.records) {\n            write({\n              type: `insert`,\n              value: parse(item),\n            })\n          }\n\n          if (length < limit) break\n\n          response = await config.recordApi.list({\n            pagination: {\n              limit,\n              cursor,\n              offset: cursor === undefined ? got : undefined,\n            },\n          })\n          cursor = response.cursor\n        }\n\n        commit()\n        markReady()\n      }\n\n      // Afterwards subscribe.\n      async function listen(reader: ReadableStreamDefaultReader<Event>) {\n        while (true) {\n          const { done, value: event } = await reader.read()\n\n          if (done || !event) {\n            reader.releaseLock()\n            eventReader = undefined\n            return\n          }\n\n          begin()\n          let value: TItem | undefined\n          if (`Insert` in event) {\n            value = parse(event.Insert as TRecord)\n            write({ type: `insert`, value })\n          } else if (`Delete` in event) {\n            value = parse(event.Delete as TRecord)\n            write({ type: `delete`, value })\n          } else if (`Update` in event) {\n            value = parse(event.Update as TRecord)\n            write({ type: `update`, value })\n          } else {\n            console.error(`Error: ${event.Error}`)\n          }\n          commit()\n\n          if (value) {\n            seenIds.setState((curr: Map<string, number>) => {\n              const newIds = new Map(curr)\n              newIds.set(String(getKey(value)), Date.now())\n              return newIds\n            })\n          }\n        }\n      }\n\n      async function start() {\n        const eventStream = await config.recordApi.subscribe(`*`)\n        const reader = (eventReader = eventStream.getReader())\n\n        // Start listening for subscriptions first. Otherwise, we'd risk a gap\n        // between the initial fetch and starting to listen.\n        listen(reader)\n\n        try {\n          await initialFetch()\n        } catch (e) {\n          cancel()\n          markReady()\n          throw e\n        }\n      }\n\n      start()\n    },\n    // Expose the getSyncMetadata function\n    getSyncMetadata: undefined,\n  }\n\n  return {\n    ...config,\n    sync,\n    getKey,\n    onInsert: async (\n      params: InsertMutationFnParams<TItem, TKey>\n    ): Promise<Array<number | string>> => {\n      const ids = await config.recordApi.createBulk(\n        params.transaction.mutations.map((tx) => {\n          const { type, modified } = tx\n          if (type !== `insert`) {\n            throw new Error(`Expected 'insert', got: ${type}`)\n          }\n          return serialIns(modified)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly added to the local\n      // DB by the subscription.\n      await awaitIds(ids.map((id) => String(id)))\n\n      return ids\n    },\n    onUpdate: async (params: UpdateMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, changes, key } = tx\n          if (type !== `update`) {\n            throw new Error(`Expected 'update', got: ${type}`)\n          }\n\n          await config.recordApi.update(key, serialUpd(changes))\n\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    onDelete: async (params: DeleteMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, key } = tx\n          if (type !== `delete`) {\n            throw new Error(`Expected 'delete', got: ${type}`)\n          }\n\n          await config.recordApi.delete(key)\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    utils: {\n      cancel,\n    },\n  }\n}\n"],"names":[],"mappings":";AA0CA,SAAS,QAIP,aACA,OACY;AACZ,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AAEA,SAAS,eAIP,aACA,OACqB;AACrB,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AA4BO,SAAS,2BAKd,QACqE;AACrE,QAAM,SAAS,OAAO;AAEtB,QAAM,QAAQ,CAAC,WACb,QAAwB,OAAO,OAAO,MAAM;AAC9C,QAAM,YAAY,CAAC,SACjB,eAA+B,OAAO,WAAW,IAAI;AACvD,QAAM,YAAY,CAAC,SACjB,QAAwB,OAAO,WAAW,IAAI;AAEhD,QAAM,UAAU,IAAI,MAAM,oBAAI,KAAqB;AAEnD,QAAM,WAAW,CACf,KACA,UAAkB,MAAM,QACN;AAClB,UAAM,YAAY,CAAC,UACjB,IAAI,MAAM,CAAC,OAAO,MAAM,IAAI,EAAE,CAAC;AACjC,QAAI,UAAU,QAAQ,KAAK,GAAG;AAC5B,aAAO,QAAQ,QAAA;AAAA,IACjB;AAEA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,YAAM,YAAY,WAAW,MAAM;AACjC,oBAAA;AACA,eAAO,IAAI,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAAA,MACrD,GAAG,OAAO;AAEV,YAAM,cAAc,QAAQ,UAAU,CAAC,UAAU;AAC/C,YAAI,UAAU,MAAM,UAAU,GAAG;AAC/B,uBAAa,SAAS;AACtB,sBAAA;AACA,kBAAA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAEA,QAAM,cAAc,IAAI,QAAQ,OAAO;AACvC,QAAM,eAAe,YAAY,MAAM;AACrC,UAAM,OAAO,YAAY,MAAA;AACzB,QAAI,MAAM;AACR,WAAK,SAAS,CAAC,SAAS;AACtB,cAAM,MAAM,KAAK,IAAA;AACjB,YAAI,aAAa;AAEjB,cAAM,aAAa,MAAM,KAAK,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM;AAC/D,gBAAM,UAAU,MAAM,IAAI,MAAM;AAChC,uBAAa,cAAc;AAC3B,iBAAO,CAAC;AAAA,QACV,CAAC;AAED,YAAI,YAAY;AACd,iBAAO,IAAI,IAAI,UAAU;AAAA,QAC3B;AACA,eAAO;AAAA,MACT,CAAC;AAAA,IACH,OAAO;AACL,oBAAc,YAAY;AAAA,IAC5B;AAAA,EACF,GAAG,MAAM,GAAI;AAIb,MAAI;AACJ,QAAM,SAAS,MAAM;AACnB,QAAI,aAAa;AACf,kBAAY,OAAA;AACZ,kBAAY,YAAA;AACZ,oBAAc;AAAA,IAChB;AAAA,EACF;AAEA,QAAM,OAAO;AAAA,IACX,MAAM,CAAC,WAAuB;AAC5B,YAAM,EAAE,OAAO,OAAO,QAAQ,cAAc;AAG5C,qBAAe,eAAe;AAC5B,cAAM,QAAQ;AACd,YAAI,WAAW,MAAM,OAAO,UAAU,KAAK;AAAA,UACzC,YAAY;AAAA,YACV;AAAA,UAAA;AAAA,QACF,CACD;AACD,YAAI,SAAS,SAAS;AACtB,YAAI,MAAM;AAEV,cAAA;AAEA,eAAO,MAAM;AACX,gBAAM,SAAS,SAAS,QAAQ;AAChC,cAAI,WAAW,EAAG;AAElB,gBAAM,MAAM;AACZ,qBAAW,QAAQ,SAAS,SAAS;AACnC,kBAAM;AAAA,cACJ,MAAM;AAAA,cACN,OAAO,MAAM,IAAI;AAAA,YAAA,CAClB;AAAA,UACH;AAEA,cAAI,SAAS,MAAO;AAEpB,qBAAW,MAAM,OAAO,UAAU,KAAK;AAAA,YACrC,YAAY;AAAA,cACV;AAAA,cACA;AAAA,cACA,QAAQ,WAAW,SAAY,MAAM;AAAA,YAAA;AAAA,UACvC,CACD;AACD,mBAAS,SAAS;AAAA,QACpB;AAEA,eAAA;AACA,kBAAA;AAAA,MACF;AAGA,qBAAe,OAAO,QAA4C;AAChE,eAAO,MAAM;AACX,gBAAM,EAAE,MAAM,OAAO,UAAU,MAAM,OAAO,KAAA;AAE5C,cAAI,QAAQ,CAAC,OAAO;AAClB,mBAAO,YAAA;AACP,0BAAc;AACd;AAAA,UACF;AAEA,gBAAA;AACA,cAAI;AACJ,cAAI,YAAY,OAAO;AACrB,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,UAAU,MAAM,KAAK,EAAE;AAAA,UACvC;AACA,iBAAA;AAEA,cAAI,OAAO;AACT,oBAAQ,SAAS,CAAC,SAA8B;AAC9C,oBAAM,SAAS,IAAI,IAAI,IAAI;AAC3B,qBAAO,IAAI,OAAO,OAAO,KAAK,CAAC,GAAG,KAAK,KAAK;AAC5C,qBAAO;AAAA,YACT,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAEA,qBAAe,QAAQ;AACrB,cAAM,cAAc,MAAM,OAAO,UAAU,UAAU,GAAG;AACxD,cAAM,SAAU,cAAc,YAAY,UAAA;AAI1C,eAAO,MAAM;AAEb,YAAI;AACF,gBAAM,aAAA;AAAA,QACR,SAAS,GAAG;AACV,iBAAA;AACA,oBAAA;AACA,gBAAM;AAAA,QACR;AAAA,MACF;AAEA,YAAA;AAAA,IACF;AAAA;AAAA,IAEA,iBAAiB;AAAA,EAAA;AAGnB,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,UAAU,OACR,WACoC;AACpC,YAAM,MAAM,MAAM,OAAO,UAAU;AAAA,QACjC,OAAO,YAAY,UAAU,IAAI,CAAC,OAAO;AACvC,gBAAM,EAAE,MAAM,SAAA,IAAa;AAC3B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AACA,iBAAO,UAAU,QAAQ;AAAA,QAC3B,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,IAAI,IAAI,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;AAE1C,aAAO;AAAA,IACT;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,SAAS,IAAA,IAAQ;AAC/B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AAEA,gBAAM,OAAO,UAAU,OAAO,KAAK,UAAU,OAAO,CAAC;AAErD,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,IAAA,IAAQ;AACtB,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,MAAM,2BAA2B,IAAI,EAAE;AAAA,UACnD;AAEA,gBAAM,OAAO,UAAU,OAAO,GAAG;AACjC,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,OAAO;AAAA,MACL;AAAA,IAAA;AAAA,EACF;AAEJ;"}
+{"version":3,"file":"trailbase.js","sources":["../../src/trailbase.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unnecessary-condition */\nimport { Store } from \"@tanstack/store\"\nimport {\n  ExpectedDeleteTypeError,\n  ExpectedInsertTypeError,\n  ExpectedUpdateTypeError,\n  TimeoutWaitingForIdsError,\n} from \"./errors\"\nimport type { Event, RecordApi } from \"trailbase\"\n\nimport type {\n  CollectionConfig,\n  DeleteMutationFnParams,\n  InsertMutationFnParams,\n  SyncConfig,\n  UpdateMutationFnParams,\n  UtilsRecord,\n} from \"@tanstack/db\"\n\ntype ShapeOf<T> = Record<keyof T, unknown>\ntype Conversion<I, O> = (value: I) => O\n\ntype OptionalConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? K\n    : never]?: Conversion<InputType[K], OutputType[K]>\n}\n\ntype RequiredConversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = {\n  // Excludes all keys that do not strictly require a conversation.\n  [K in keyof InputType as InputType[K] extends OutputType[K]\n    ? never\n    : K]: Conversion<InputType[K], OutputType[K]>\n}\n\ntype Conversions<\n  InputType extends ShapeOf<OutputType>,\n  OutputType extends ShapeOf<InputType>,\n> = OptionalConversions<InputType, OutputType> &\n  RequiredConversions<InputType, OutputType>\n\nfunction convert<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: InputType\n): OutputType {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\nfunction convertPartial<\n  InputType extends ShapeOf<OutputType> & Record<string, unknown>,\n  OutputType extends ShapeOf<InputType>,\n>(\n  conversions: Conversions<InputType, OutputType>,\n  input: Partial<InputType>\n): Partial<OutputType> {\n  const c = conversions as Record<string, Conversion<InputType, OutputType>>\n\n  return Object.fromEntries(\n    Object.keys(input).map((k: string) => {\n      const value = input[k]\n      return [k, c[k]?.(value as any) ?? value]\n    })\n  ) as OutputType\n}\n\n/**\n * Configuration interface for Trailbase Collection\n */\nexport interface TrailBaseCollectionConfig<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n> extends Omit<\n    CollectionConfig<TItem, TKey>,\n    `sync` | `onInsert` | `onUpdate` | `onDelete`\n  > {\n  /**\n   * Record API name\n   */\n  recordApi: RecordApi<TRecord>\n\n  parse: Conversions<TRecord, TItem>\n  serialize: Conversions<TItem, TRecord>\n}\n\nexport type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>\n\nexport interface TrailBaseCollectionUtils extends UtilsRecord {\n  cancel: () => void\n}\n\nexport function trailBaseCollectionOptions<\n  TItem extends ShapeOf<TRecord>,\n  TRecord extends ShapeOf<TItem> = TItem,\n  TKey extends string | number = string | number,\n>(\n  config: TrailBaseCollectionConfig<TItem, TRecord, TKey>\n): CollectionConfig<TItem, TKey> & { utils: TrailBaseCollectionUtils } {\n  const getKey = config.getKey\n\n  const parse = (record: TRecord) =>\n    convert<TRecord, TItem>(config.parse, record)\n  const serialUpd = (item: Partial<TItem>) =>\n    convertPartial<TItem, TRecord>(config.serialize, item)\n  const serialIns = (item: TItem) =>\n    convert<TItem, TRecord>(config.serialize, item)\n\n  const seenIds = new Store(new Map<string, number>())\n\n  const awaitIds = (\n    ids: Array<string>,\n    timeout: number = 120 * 1000\n  ): Promise<void> => {\n    const completed = (value: Map<string, number>) =>\n      ids.every((id) => value.has(id))\n    if (completed(seenIds.state)) {\n      return Promise.resolve()\n    }\n\n    return new Promise<void>((resolve, reject) => {\n      const timeoutId = setTimeout(() => {\n        unsubscribe()\n        reject(new TimeoutWaitingForIdsError(ids.toString()))\n      }, timeout)\n\n      const unsubscribe = seenIds.subscribe((value) => {\n        if (completed(value.currentVal)) {\n          clearTimeout(timeoutId)\n          unsubscribe()\n          resolve()\n        }\n      })\n    })\n  }\n\n  let eventReader: ReadableStreamDefaultReader<Event> | undefined\n  const cancelEventReader = () => {\n    if (eventReader) {\n      eventReader.cancel()\n      eventReader.releaseLock()\n      eventReader = undefined\n    }\n  }\n\n  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]\n  const sync = {\n    sync: (params: SyncParams) => {\n      const { begin, write, commit, markReady } = params\n\n      // Initial fetch.\n      async function initialFetch() {\n        const limit = 256\n        let response = await config.recordApi.list({\n          pagination: {\n            limit,\n          },\n        })\n        let cursor = response.cursor\n        let got = 0\n\n        begin()\n\n        while (true) {\n          const length = response.records.length\n          if (length === 0) break\n\n          got = got + length\n          for (const item of response.records) {\n            write({\n              type: `insert`,\n              value: parse(item),\n            })\n          }\n\n          if (length < limit) break\n\n          response = await config.recordApi.list({\n            pagination: {\n              limit,\n              cursor,\n              offset: cursor === undefined ? got : undefined,\n            },\n          })\n          cursor = response.cursor\n        }\n\n        commit()\n      }\n\n      // Afterwards subscribe.\n      async function listen(reader: ReadableStreamDefaultReader<Event>) {\n        while (true) {\n          const { done, value: event } = await reader.read()\n\n          if (done || !event) {\n            reader.releaseLock()\n            eventReader = undefined\n            return\n          }\n\n          begin()\n          let value: TItem | undefined\n          if (`Insert` in event) {\n            value = parse(event.Insert as TRecord)\n            write({ type: `insert`, value })\n          } else if (`Delete` in event) {\n            value = parse(event.Delete as TRecord)\n            write({ type: `delete`, value })\n          } else if (`Update` in event) {\n            value = parse(event.Update as TRecord)\n            write({ type: `update`, value })\n          } else {\n            console.error(`Error: ${event.Error}`)\n          }\n          commit()\n\n          if (value) {\n            seenIds.setState((curr: Map<string, number>) => {\n              const newIds = new Map(curr)\n              newIds.set(String(getKey(value)), Date.now())\n              return newIds\n            })\n          }\n        }\n      }\n\n      async function start() {\n        const eventStream = await config.recordApi.subscribe(`*`)\n        const reader = (eventReader = eventStream.getReader())\n\n        // Start listening for subscriptions first. Otherwise, we'd risk a gap\n        // between the initial fetch and starting to listen.\n        listen(reader)\n\n        try {\n          await initialFetch()\n        } catch (e) {\n          cancelEventReader()\n          throw e\n        } finally {\n          // Mark ready both if everything went well or if there's an error to\n          // avoid blocking apps waiting for `.preload()` to finish.\n          markReady()\n        }\n\n        // Lastly, start a periodic cleanup task that will be removed when the\n        // reader closes.\n        const periodicCleanupTask = setInterval(() => {\n          seenIds.setState((curr) => {\n            const now = Date.now()\n            let anyExpired = false\n\n            const notExpired = Array.from(curr.entries()).filter(([_, v]) => {\n              const expired = now - v > 300 * 1000\n              anyExpired = anyExpired || expired\n              return !expired\n            })\n\n            if (anyExpired) {\n              return new Map(notExpired)\n            }\n            return curr\n          })\n        }, 120 * 1000)\n\n        reader.closed.finally(() => clearInterval(periodicCleanupTask))\n      }\n\n      start()\n    },\n    // Expose the getSyncMetadata function\n    getSyncMetadata: undefined,\n  }\n\n  return {\n    ...config,\n    sync,\n    getKey,\n    onInsert: async (\n      params: InsertMutationFnParams<TItem, TKey>\n    ): Promise<Array<number | string>> => {\n      const ids = await config.recordApi.createBulk(\n        params.transaction.mutations.map((tx) => {\n          const { type, modified } = tx\n          if (type !== `insert`) {\n            throw new ExpectedInsertTypeError(type)\n          }\n          return serialIns(modified)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly added to the local\n      // DB by the subscription.\n      await awaitIds(ids.map((id) => String(id)))\n\n      return ids\n    },\n    onUpdate: async (params: UpdateMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, changes, key } = tx\n          if (type !== `update`) {\n            throw new ExpectedUpdateTypeError(type)\n          }\n\n          await config.recordApi.update(key, serialUpd(changes))\n\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    onDelete: async (params: DeleteMutationFnParams<TItem, TKey>) => {\n      const ids: Array<string> = await Promise.all(\n        params.transaction.mutations.map(async (tx) => {\n          const { type, key } = tx\n          if (type !== `delete`) {\n            throw new ExpectedDeleteTypeError(type)\n          }\n\n          await config.recordApi.delete(key)\n          return String(key)\n        })\n      )\n\n      // The optimistic mutation overlay is removed on return, so at this point\n      // we have to ensure that the new record was properly updated in the local\n      // DB by the subscription.\n      await awaitIds(ids)\n    },\n    utils: {\n      cancel: cancelEventReader,\n    },\n  }\n}\n"],"names":[],"mappings":";;AAgDA,SAAS,QAIP,aACA,OACY;AACZ,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AAEA,SAAS,eAIP,aACA,OACqB;AACrB,QAAM,IAAI;AAEV,SAAO,OAAO;AAAA,IACZ,OAAO,KAAK,KAAK,EAAE,IAAI,CAAC,MAAc;;AACpC,YAAM,QAAQ,MAAM,CAAC;AACrB,aAAO,CAAC,KAAG,OAAE,OAAF,2BAAO,WAAiB,KAAK;AAAA,IAC1C,CAAC;AAAA,EAAA;AAEL;AA4BO,SAAS,2BAKd,QACqE;AACrE,QAAM,SAAS,OAAO;AAEtB,QAAM,QAAQ,CAAC,WACb,QAAwB,OAAO,OAAO,MAAM;AAC9C,QAAM,YAAY,CAAC,SACjB,eAA+B,OAAO,WAAW,IAAI;AACvD,QAAM,YAAY,CAAC,SACjB,QAAwB,OAAO,WAAW,IAAI;AAEhD,QAAM,UAAU,IAAI,MAAM,oBAAI,KAAqB;AAEnD,QAAM,WAAW,CACf,KACA,UAAkB,MAAM,QACN;AAClB,UAAM,YAAY,CAAC,UACjB,IAAI,MAAM,CAAC,OAAO,MAAM,IAAI,EAAE,CAAC;AACjC,QAAI,UAAU,QAAQ,KAAK,GAAG;AAC5B,aAAO,QAAQ,QAAA;AAAA,IACjB;AAEA,WAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,YAAM,YAAY,WAAW,MAAM;AACjC,oBAAA;AACA,eAAO,IAAI,0BAA0B,IAAI,SAAA,CAAU,CAAC;AAAA,MACtD,GAAG,OAAO;AAEV,YAAM,cAAc,QAAQ,UAAU,CAAC,UAAU;AAC/C,YAAI,UAAU,MAAM,UAAU,GAAG;AAC/B,uBAAa,SAAS;AACtB,sBAAA;AACA,kBAAA;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAEA,MAAI;AACJ,QAAM,oBAAoB,MAAM;AAC9B,QAAI,aAAa;AACf,kBAAY,OAAA;AACZ,kBAAY,YAAA;AACZ,oBAAc;AAAA,IAChB;AAAA,EACF;AAGA,QAAM,OAAO;AAAA,IACX,MAAM,CAAC,WAAuB;AAC5B,YAAM,EAAE,OAAO,OAAO,QAAQ,cAAc;AAG5C,qBAAe,eAAe;AAC5B,cAAM,QAAQ;AACd,YAAI,WAAW,MAAM,OAAO,UAAU,KAAK;AAAA,UACzC,YAAY;AAAA,YACV;AAAA,UAAA;AAAA,QACF,CACD;AACD,YAAI,SAAS,SAAS;AACtB,YAAI,MAAM;AAEV,cAAA;AAEA,eAAO,MAAM;AACX,gBAAM,SAAS,SAAS,QAAQ;AAChC,cAAI,WAAW,EAAG;AAElB,gBAAM,MAAM;AACZ,qBAAW,QAAQ,SAAS,SAAS;AACnC,kBAAM;AAAA,cACJ,MAAM;AAAA,cACN,OAAO,MAAM,IAAI;AAAA,YAAA,CAClB;AAAA,UACH;AAEA,cAAI,SAAS,MAAO;AAEpB,qBAAW,MAAM,OAAO,UAAU,KAAK;AAAA,YACrC,YAAY;AAAA,cACV;AAAA,cACA;AAAA,cACA,QAAQ,WAAW,SAAY,MAAM;AAAA,YAAA;AAAA,UACvC,CACD;AACD,mBAAS,SAAS;AAAA,QACpB;AAEA,eAAA;AAAA,MACF;AAGA,qBAAe,OAAO,QAA4C;AAChE,eAAO,MAAM;AACX,gBAAM,EAAE,MAAM,OAAO,UAAU,MAAM,OAAO,KAAA;AAE5C,cAAI,QAAQ,CAAC,OAAO;AAClB,mBAAO,YAAA;AACP,0BAAc;AACd;AAAA,UACF;AAEA,gBAAA;AACA,cAAI;AACJ,cAAI,YAAY,OAAO;AACrB,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,WAAW,YAAY,OAAO;AAC5B,oBAAQ,MAAM,MAAM,MAAiB;AACrC,kBAAM,EAAE,MAAM,UAAU,MAAA,CAAO;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,UAAU,MAAM,KAAK,EAAE;AAAA,UACvC;AACA,iBAAA;AAEA,cAAI,OAAO;AACT,oBAAQ,SAAS,CAAC,SAA8B;AAC9C,oBAAM,SAAS,IAAI,IAAI,IAAI;AAC3B,qBAAO,IAAI,OAAO,OAAO,KAAK,CAAC,GAAG,KAAK,KAAK;AAC5C,qBAAO;AAAA,YACT,CAAC;AAAA,UACH;AAAA,QACF;AAAA,MACF;AAEA,qBAAe,QAAQ;AACrB,cAAM,cAAc,MAAM,OAAO,UAAU,UAAU,GAAG;AACxD,cAAM,SAAU,cAAc,YAAY,UAAA;AAI1C,eAAO,MAAM;AAEb,YAAI;AACF,gBAAM,aAAA;AAAA,QACR,SAAS,GAAG;AACV,4BAAA;AACA,gBAAM;AAAA,QACR,UAAA;AAGE,oBAAA;AAAA,QACF;AAIA,cAAM,sBAAsB,YAAY,MAAM;AAC5C,kBAAQ,SAAS,CAAC,SAAS;AACzB,kBAAM,MAAM,KAAK,IAAA;AACjB,gBAAI,aAAa;AAEjB,kBAAM,aAAa,MAAM,KAAK,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM;AAC/D,oBAAM,UAAU,MAAM,IAAI,MAAM;AAChC,2BAAa,cAAc;AAC3B,qBAAO,CAAC;AAAA,YACV,CAAC;AAED,gBAAI,YAAY;AACd,qBAAO,IAAI,IAAI,UAAU;AAAA,YAC3B;AACA,mBAAO;AAAA,UACT,CAAC;AAAA,QACH,GAAG,MAAM,GAAI;AAEb,eAAO,OAAO,QAAQ,MAAM,cAAc,mBAAmB,CAAC;AAAA,MAChE;AAEA,YAAA;AAAA,IACF;AAAA;AAAA,IAEA,iBAAiB;AAAA,EAAA;AAGnB,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,UAAU,OACR,WACoC;AACpC,YAAM,MAAM,MAAM,OAAO,UAAU;AAAA,QACjC,OAAO,YAAY,UAAU,IAAI,CAAC,OAAO;AACvC,gBAAM,EAAE,MAAM,SAAA,IAAa;AAC3B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,wBAAwB,IAAI;AAAA,UACxC;AACA,iBAAO,UAAU,QAAQ;AAAA,QAC3B,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,IAAI,IAAI,CAAC,OAAO,OAAO,EAAE,CAAC,CAAC;AAE1C,aAAO;AAAA,IACT;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,SAAS,IAAA,IAAQ;AAC/B,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,wBAAwB,IAAI;AAAA,UACxC;AAEA,gBAAM,OAAO,UAAU,OAAO,KAAK,UAAU,OAAO,CAAC;AAErD,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,UAAU,OAAO,WAAgD;AAC/D,YAAM,MAAqB,MAAM,QAAQ;AAAA,QACvC,OAAO,YAAY,UAAU,IAAI,OAAO,OAAO;AAC7C,gBAAM,EAAE,MAAM,IAAA,IAAQ;AACtB,cAAI,SAAS,UAAU;AACrB,kBAAM,IAAI,wBAAwB,IAAI;AAAA,UACxC;AAEA,gBAAM,OAAO,UAAU,OAAO,GAAG;AACjC,iBAAO,OAAO,GAAG;AAAA,QACnB,CAAC;AAAA,MAAA;AAMH,YAAM,SAAS,GAAG;AAAA,IACpB;AAAA,IACA,OAAO;AAAA,MACL,QAAQ;AAAA,IAAA;AAAA,EACV;AAEJ;"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tanstack/trailbase-db-collection",
   "description": "TrailBase collection for TanStack DB",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
     "@tanstack/store": "^0.7.0",
     "debug": "^4.4.1",
     "trailbase": "^0.7.1",
-    "@tanstack/db": "0.0.27"
+    "@tanstack/db": "0.0.29"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",

package/src/errors.ts

@@ -0,0 +1,37 @@
+import { TanStackDBError } from "@tanstack/db"
+
+// TrailBase DB Collection Errors
+export class TrailBaseDBCollectionError extends TanStackDBError {
+  constructor(message: string) {
+    super(message)
+    this.name = `TrailBaseDBCollectionError`
+  }
+}
+
+export class TimeoutWaitingForIdsError extends TrailBaseDBCollectionError {
+  constructor(ids: string) {
+    super(`Timeout waiting for ids: ${ids}`)
+    this.name = `TimeoutWaitingForIdsError`
+  }
+}
+
+export class ExpectedInsertTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType: string) {
+    super(`Expected 'insert', got: ${actualType}`)
+    this.name = `ExpectedInsertTypeError`
+  }
+}
+
+export class ExpectedUpdateTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType: string) {
+    super(`Expected 'update', got: ${actualType}`)
+    this.name = `ExpectedUpdateTypeError`
+  }
+}
+
+export class ExpectedDeleteTypeError extends TrailBaseDBCollectionError {
+  constructor(actualType: string) {
+    super(`Expected 'delete', got: ${actualType}`)
+    this.name = `ExpectedDeleteTypeError`
+  }
+}

package/src/index.ts

@@ -3,3 +3,5 @@ export {
   type TrailBaseCollectionConfig,
   type TrailBaseCollectionUtils,
 } from "./trailbase"
+
+export * from "./errors"

package/src/trailbase.ts

@@ -1,5 +1,11 @@
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import { Store } from "@tanstack/store"
+import {
+  ExpectedDeleteTypeError,
+  ExpectedInsertTypeError,
+  ExpectedUpdateTypeError,
+  TimeoutWaitingForIdsError,
+} from "./errors"
 import type { Event, RecordApi } from "trailbase"
 
 import type {
@@ -131,7 +137,7 @@ export function trailBaseCollectionOptions<
     return new Promise<void>((resolve, reject) => {
       const timeoutId = setTimeout(() => {
         unsubscribe()
-        reject(new Error(`Timeout waiting for ids: ${ids}`))
+        reject(new TimeoutWaitingForIdsError(ids.toString()))
       }, timeout)
 
       const unsubscribe = seenIds.subscribe((value) => {
@@ -144,34 +150,8 @@ export function trailBaseCollectionOptions<
     })
   }
 
-  const weakSeenIds = new WeakRef(seenIds)
-  const cleanupTimer = setInterval(() => {
-    const seen = weakSeenIds.deref()
-    if (seen) {
-      seen.setState((curr) => {
-        const now = Date.now()
-        let anyExpired = false
-
-        const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
-          const expired = now - v > 300 * 1000
-          anyExpired = anyExpired || expired
-          return !expired
-        })
-
-        if (anyExpired) {
-          return new Map(notExpired)
-        }
-        return curr
-      })
-    } else {
-      clearInterval(cleanupTimer)
-    }
-  }, 120 * 1000)
-
-  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]
-
   let eventReader: ReadableStreamDefaultReader<Event> | undefined
-  const cancel = () => {
+  const cancelEventReader = () => {
     if (eventReader) {
       eventReader.cancel()
       eventReader.releaseLock()
@@ -179,6 +159,7 @@ export function trailBaseCollectionOptions<
     }
   }
 
+  type SyncParams = Parameters<SyncConfig<TItem, TKey>[`sync`]>[0]
   const sync = {
     sync: (params: SyncParams) => {
       const { begin, write, commit, markReady } = params
@@ -221,7 +202,6 @@ export function trailBaseCollectionOptions<
         }
 
         commit()
-        markReady()
       }
 
       // Afterwards subscribe.
@@ -272,10 +252,35 @@ export function trailBaseCollectionOptions<
         try {
           await initialFetch()
         } catch (e) {
-          cancel()
-          markReady()
+          cancelEventReader()
           throw e
+        } finally {
+          // Mark ready both if everything went well or if there's an error to
+          // avoid blocking apps waiting for `.preload()` to finish.
+          markReady()
         }
+
+        // Lastly, start a periodic cleanup task that will be removed when the
+        // reader closes.
+        const periodicCleanupTask = setInterval(() => {
+          seenIds.setState((curr) => {
+            const now = Date.now()
+            let anyExpired = false
+
+            const notExpired = Array.from(curr.entries()).filter(([_, v]) => {
+              const expired = now - v > 300 * 1000
+              anyExpired = anyExpired || expired
+              return !expired
+            })
+
+            if (anyExpired) {
+              return new Map(notExpired)
+            }
+            return curr
+          })
+        }, 120 * 1000)
+
+        reader.closed.finally(() => clearInterval(periodicCleanupTask))
       }
 
       start()
@@ -295,7 +300,7 @@ export function trailBaseCollectionOptions<
         params.transaction.mutations.map((tx) => {
           const { type, modified } = tx
           if (type !== `insert`) {
-            throw new Error(`Expected 'insert', got: ${type}`)
+            throw new ExpectedInsertTypeError(type)
           }
           return serialIns(modified)
         })
@@ -313,7 +318,7 @@ export function trailBaseCollectionOptions<
         params.transaction.mutations.map(async (tx) => {
           const { type, changes, key } = tx
           if (type !== `update`) {
-            throw new Error(`Expected 'update', got: ${type}`)
+            throw new ExpectedUpdateTypeError(type)
           }
 
           await config.recordApi.update(key, serialUpd(changes))
@@ -332,7 +337,7 @@ export function trailBaseCollectionOptions<
         params.transaction.mutations.map(async (tx) => {
           const { type, key } = tx
           if (type !== `delete`) {
-            throw new Error(`Expected 'delete', got: ${type}`)
+            throw new ExpectedDeleteTypeError(type)
           }
 
           await config.recordApi.delete(key)
@@ -346,7 +351,7 @@ export function trailBaseCollectionOptions<
       await awaitIds(ids)
     },
     utils: {
-      cancel,
+      cancel: cancelEventReader,
     },
   }
 }