@tanstack/trailbase-db-collection 0.0.1

package/dist/cjs/index.cjs

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const trailbase = require("./trailbase.cjs");
+exports.trailBaseCollectionOptions = trailbase.trailBaseCollectionOptions;
+//# 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 @@
+export { trailBaseCollectionOptions, type TrailBaseCollectionConfig, type TrailBaseCollectionUtils, } from './trailbase.cjs';

package/dist/cjs/trailbase.cjs

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const store = require("@tanstack/store");
+function convert(conversions, input) {
+  const c = conversions;
+  return Object.fromEntries(
+    Object.keys(input).map((k) => {
+      var _a;
+      const value = input[k];
+      return [k, ((_a = c[k]) == null ? void 0 : _a.call(c, value)) ?? value];
+    })
+  );
+}
+function convertPartial(conversions, input) {
+  const c = conversions;
+  return Object.fromEntries(
+    Object.keys(input).map((k) => {
+      var _a;
+      const value = input[k];
+      return [k, ((_a = c[k]) == null ? void 0 : _a.call(c, value)) ?? value];
+    })
+  );
+}
+function trailBaseCollectionOptions(config) {
+  const getKey = config.getKey;
+  const parse = (record) => convert(config.parse, record);
+  const serialUpd = (item) => convertPartial(config.serialize, item);
+  const serialIns = (item) => convert(config.serialize, item);
+  const seenIds = new store.Store(/* @__PURE__ */ new Map());
+  const awaitIds = (ids, timeout = 120 * 1e3) => {
+    const completed = (value) => ids.every((id) => value.has(id));
+    if (completed(seenIds.state)) {
+      return Promise.resolve();
+    }
+    return new Promise((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        unsubscribe();
+        reject(new Error(`Timeout waiting for ids: ${ids}`));
+      }, timeout);
+      const unsubscribe = seenIds.subscribe((value) => {
+        if (completed(value.currentVal)) {
+          clearTimeout(timeoutId);
+          unsubscribe();
+          resolve();
+        }
+      });
+    });
+  };
+  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 = () => {
+    if (eventReader) {
+      eventReader.cancel();
+      eventReader.releaseLock();
+      eventReader = void 0;
+    }
+  };
+  const sync = {
+    sync: (params) => {
+      const { begin, write, commit, markReady } = params;
+      async function initialFetch() {
+        const limit = 256;
+        let response = await config.recordApi.list({
+          pagination: {
+            limit
+          }
+        });
+        let cursor = response.cursor;
+        let got = 0;
+        begin();
+        while (true) {
+          const length = response.records.length;
+          if (length === 0) break;
+          got = got + length;
+          for (const item of response.records) {
+            write({
+              type: `insert`,
+              value: parse(item)
+            });
+          }
+          if (length < limit) break;
+          response = await config.recordApi.list({
+            pagination: {
+              limit,
+              cursor,
+              offset: cursor === void 0 ? got : void 0
+            }
+          });
+          cursor = response.cursor;
+        }
+        commit();
+        markReady();
+      }
+      async function listen(reader) {
+        while (true) {
+          const { done, value: event } = await reader.read();
+          if (done || !event) {
+            reader.releaseLock();
+            eventReader = void 0;
+            return;
+          }
+          begin();
+          let value;
+          if (`Insert` in event) {
+            value = parse(event.Insert);
+            write({ type: `insert`, value });
+          } else if (`Delete` in event) {
+            value = parse(event.Delete);
+            write({ type: `delete`, value });
+          } else if (`Update` in event) {
+            value = parse(event.Update);
+            write({ type: `update`, value });
+          } else {
+            console.error(`Error: ${event.Error}`);
+          }
+          commit();
+          if (value) {
+            seenIds.setState((curr) => {
+              const newIds = new Map(curr);
+              newIds.set(String(getKey(value)), Date.now());
+              return newIds;
+            });
+          }
+        }
+      }
+      async function start() {
+        const eventStream = await config.recordApi.subscribe(`*`);
+        const reader = eventReader = eventStream.getReader();
+        listen(reader);
+        try {
+          await initialFetch();
+        } catch (e) {
+          cancel();
+          markReady();
+          throw e;
+        }
+      }
+      start();
+    },
+    // Expose the getSyncMetadata function
+    getSyncMetadata: void 0
+  };
+  return {
+    ...config,
+    sync,
+    getKey,
+    onInsert: async (params) => {
+      const ids = await config.recordApi.createBulk(
+        params.transaction.mutations.map((tx) => {
+          const { type, modified } = tx;
+          if (type !== `insert`) {
+            throw new Error(`Expected 'insert', got: ${type}`);
+          }
+          return serialIns(modified);
+        })
+      );
+      await awaitIds(ids.map((id) => String(id)));
+      return ids;
+    },
+    onUpdate: async (params) => {
+      const ids = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, changes, key } = tx;
+          if (type !== `update`) {
+            throw new Error(`Expected 'update', got: ${type}`);
+          }
+          await config.recordApi.update(key, serialUpd(changes));
+          return String(key);
+        })
+      );
+      await awaitIds(ids);
+    },
+    onDelete: async (params) => {
+      const ids = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, key } = tx;
+          if (type !== `delete`) {
+            throw new Error(`Expected 'delete', got: ${type}`);
+          }
+          await config.recordApi.delete(key);
+          return String(key);
+        })
+      );
+      await awaitIds(ids);
+    },
+    utils: {
+      cancel
+    }
+  };
+}
+exports.trailBaseCollectionOptions = trailBaseCollectionOptions;
+//# sourceMappingURL=trailbase.cjs.map

package/dist/cjs/trailbase.cjs.map

@@ -0,0 +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 { CollectionConfig, SyncConfig, UtilsRecord } 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) => {\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 (params): 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) => {\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) => {\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":";;;AAmCA,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,SAAS;AACzB,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,OAAO,WAA4C;AAC3D,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,WAAW;AAC1B,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,WAAW;AAC1B,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;;"}

package/dist/cjs/trailbase.d.cts

@@ -0,0 +1,30 @@
+import { RecordApi } from 'trailbase';
+import { CollectionConfig, UtilsRecord } from '@tanstack/db';
+type ShapeOf<T> = Record<keyof T, unknown>;
+type Conversion<I, O> = (value: I) => O;
+type OptionalConversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = {
+    [K in keyof InputType as InputType[K] extends OutputType[K] ? K : never]?: Conversion<InputType[K], OutputType[K]>;
+};
+type RequiredConversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = {
+    [K in keyof InputType as InputType[K] extends OutputType[K] ? never : K]: Conversion<InputType[K], OutputType[K]>;
+};
+type Conversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = OptionalConversions<InputType, OutputType> & RequiredConversions<InputType, OutputType>;
+/**
+ * Configuration interface for Trailbase Collection
+ */
+export interface TrailBaseCollectionConfig<TItem extends ShapeOf<TRecord>, TRecord extends ShapeOf<TItem> = TItem, TKey extends string | number = string | number> extends Omit<CollectionConfig<TItem, TKey>, `sync` | `onInsert` | `onUpdate` | `onDelete`> {
+    /**
+     * Record API name
+     */
+    recordApi: RecordApi<TRecord>;
+    parse: Conversions<TRecord, TItem>;
+    serialize: Conversions<TItem, TRecord>;
+}
+export type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>;
+export interface TrailBaseCollectionUtils extends UtilsRecord {
+    cancel: () => void;
+}
+export declare function trailBaseCollectionOptions<TItem extends ShapeOf<TRecord>, TRecord extends ShapeOf<TItem> = TItem, TKey extends string | number = string | number>(config: TrailBaseCollectionConfig<TItem, TRecord, TKey>): CollectionConfig<TItem, TKey> & {
+    utils: TrailBaseCollectionUtils;
+};
+export {};

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+import { trailBaseCollectionOptions } from "./trailbase.js";
+export {
+  trailBaseCollectionOptions
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

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

package/dist/esm/trailbase.d.ts

@@ -0,0 +1,30 @@
+import { RecordApi } from 'trailbase';
+import { CollectionConfig, UtilsRecord } from '@tanstack/db';
+type ShapeOf<T> = Record<keyof T, unknown>;
+type Conversion<I, O> = (value: I) => O;
+type OptionalConversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = {
+    [K in keyof InputType as InputType[K] extends OutputType[K] ? K : never]?: Conversion<InputType[K], OutputType[K]>;
+};
+type RequiredConversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = {
+    [K in keyof InputType as InputType[K] extends OutputType[K] ? never : K]: Conversion<InputType[K], OutputType[K]>;
+};
+type Conversions<InputType extends ShapeOf<OutputType>, OutputType extends ShapeOf<InputType>> = OptionalConversions<InputType, OutputType> & RequiredConversions<InputType, OutputType>;
+/**
+ * Configuration interface for Trailbase Collection
+ */
+export interface TrailBaseCollectionConfig<TItem extends ShapeOf<TRecord>, TRecord extends ShapeOf<TItem> = TItem, TKey extends string | number = string | number> extends Omit<CollectionConfig<TItem, TKey>, `sync` | `onInsert` | `onUpdate` | `onDelete`> {
+    /**
+     * Record API name
+     */
+    recordApi: RecordApi<TRecord>;
+    parse: Conversions<TRecord, TItem>;
+    serialize: Conversions<TItem, TRecord>;
+}
+export type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>;
+export interface TrailBaseCollectionUtils extends UtilsRecord {
+    cancel: () => void;
+}
+export declare function trailBaseCollectionOptions<TItem extends ShapeOf<TRecord>, TRecord extends ShapeOf<TItem> = TItem, TKey extends string | number = string | number>(config: TrailBaseCollectionConfig<TItem, TRecord, TKey>): CollectionConfig<TItem, TKey> & {
+    utils: TrailBaseCollectionUtils;
+};
+export {};

package/dist/esm/trailbase.js

@@ -0,0 +1,212 @@
+import { Store } from "@tanstack/store";
+function convert(conversions, input) {
+  const c = conversions;
+  return Object.fromEntries(
+    Object.keys(input).map((k) => {
+      var _a;
+      const value = input[k];
+      return [k, ((_a = c[k]) == null ? void 0 : _a.call(c, value)) ?? value];
+    })
+  );
+}
+function convertPartial(conversions, input) {
+  const c = conversions;
+  return Object.fromEntries(
+    Object.keys(input).map((k) => {
+      var _a;
+      const value = input[k];
+      return [k, ((_a = c[k]) == null ? void 0 : _a.call(c, value)) ?? value];
+    })
+  );
+}
+function trailBaseCollectionOptions(config) {
+  const getKey = config.getKey;
+  const parse = (record) => convert(config.parse, record);
+  const serialUpd = (item) => convertPartial(config.serialize, item);
+  const serialIns = (item) => convert(config.serialize, item);
+  const seenIds = new Store(/* @__PURE__ */ new Map());
+  const awaitIds = (ids, timeout = 120 * 1e3) => {
+    const completed = (value) => ids.every((id) => value.has(id));
+    if (completed(seenIds.state)) {
+      return Promise.resolve();
+    }
+    return new Promise((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        unsubscribe();
+        reject(new Error(`Timeout waiting for ids: ${ids}`));
+      }, timeout);
+      const unsubscribe = seenIds.subscribe((value) => {
+        if (completed(value.currentVal)) {
+          clearTimeout(timeoutId);
+          unsubscribe();
+          resolve();
+        }
+      });
+    });
+  };
+  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 = () => {
+    if (eventReader) {
+      eventReader.cancel();
+      eventReader.releaseLock();
+      eventReader = void 0;
+    }
+  };
+  const sync = {
+    sync: (params) => {
+      const { begin, write, commit, markReady } = params;
+      async function initialFetch() {
+        const limit = 256;
+        let response = await config.recordApi.list({
+          pagination: {
+            limit
+          }
+        });
+        let cursor = response.cursor;
+        let got = 0;
+        begin();
+        while (true) {
+          const length = response.records.length;
+          if (length === 0) break;
+          got = got + length;
+          for (const item of response.records) {
+            write({
+              type: `insert`,
+              value: parse(item)
+            });
+          }
+          if (length < limit) break;
+          response = await config.recordApi.list({
+            pagination: {
+              limit,
+              cursor,
+              offset: cursor === void 0 ? got : void 0
+            }
+          });
+          cursor = response.cursor;
+        }
+        commit();
+        markReady();
+      }
+      async function listen(reader) {
+        while (true) {
+          const { done, value: event } = await reader.read();
+          if (done || !event) {
+            reader.releaseLock();
+            eventReader = void 0;
+            return;
+          }
+          begin();
+          let value;
+          if (`Insert` in event) {
+            value = parse(event.Insert);
+            write({ type: `insert`, value });
+          } else if (`Delete` in event) {
+            value = parse(event.Delete);
+            write({ type: `delete`, value });
+          } else if (`Update` in event) {
+            value = parse(event.Update);
+            write({ type: `update`, value });
+          } else {
+            console.error(`Error: ${event.Error}`);
+          }
+          commit();
+          if (value) {
+            seenIds.setState((curr) => {
+              const newIds = new Map(curr);
+              newIds.set(String(getKey(value)), Date.now());
+              return newIds;
+            });
+          }
+        }
+      }
+      async function start() {
+        const eventStream = await config.recordApi.subscribe(`*`);
+        const reader = eventReader = eventStream.getReader();
+        listen(reader);
+        try {
+          await initialFetch();
+        } catch (e) {
+          cancel();
+          markReady();
+          throw e;
+        }
+      }
+      start();
+    },
+    // Expose the getSyncMetadata function
+    getSyncMetadata: void 0
+  };
+  return {
+    ...config,
+    sync,
+    getKey,
+    onInsert: async (params) => {
+      const ids = await config.recordApi.createBulk(
+        params.transaction.mutations.map((tx) => {
+          const { type, modified } = tx;
+          if (type !== `insert`) {
+            throw new Error(`Expected 'insert', got: ${type}`);
+          }
+          return serialIns(modified);
+        })
+      );
+      await awaitIds(ids.map((id) => String(id)));
+      return ids;
+    },
+    onUpdate: async (params) => {
+      const ids = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, changes, key } = tx;
+          if (type !== `update`) {
+            throw new Error(`Expected 'update', got: ${type}`);
+          }
+          await config.recordApi.update(key, serialUpd(changes));
+          return String(key);
+        })
+      );
+      await awaitIds(ids);
+    },
+    onDelete: async (params) => {
+      const ids = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, key } = tx;
+          if (type !== `delete`) {
+            throw new Error(`Expected 'delete', got: ${type}`);
+          }
+          await config.recordApi.delete(key);
+          return String(key);
+        })
+      );
+      await awaitIds(ids);
+    },
+    utils: {
+      cancel
+    }
+  };
+}
+export {
+  trailBaseCollectionOptions
+};
+//# sourceMappingURL=trailbase.js.map

package/dist/esm/trailbase.js.map

@@ -0,0 +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 { CollectionConfig, SyncConfig, UtilsRecord } 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) => {\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 (params): 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) => {\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) => {\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":";AAmCA,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,SAAS;AACzB,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,OAAO,WAA4C;AAC3D,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,WAAW;AAC1B,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,WAAW;AAC1B,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;"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@tanstack/trailbase-db-collection",
+  "description": "TrailBase collection for TanStack DB",
+  "version": "0.0.1",
+  "dependencies": {
+    "@standard-schema/spec": "^1.0.0",
+    "@tanstack/db": "workspace:*",
+    "@tanstack/store": "^0.7.0",
+    "debug": "^4.4.1",
+    "trailbase": "^0.7.1"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@vitest/coverage-istanbul": "^3.0.9"
+  },
+  "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"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "packageManager": "pnpm@10.6.3",
+  "peerDependencies": {
+    "typescript": ">=4.7"
+  },
+  "author": "Sebastian Jeltsch",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/db.git",
+    "directory": "packages/trailbase-db-collection"
+  },
+  "homepage": "https://tanstack.com/db",
+  "keywords": [
+    "trailbase",
+    "sql",
+    "optimistic",
+    "typescript"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "lint": "eslint . --fix",
+    "test": "npx vitest --run"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "types": "dist/esm/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export {
+  trailBaseCollectionOptions,
+  type TrailBaseCollectionConfig,
+  type TrailBaseCollectionUtils,
+} from "./trailbase"

package/src/trailbase.ts

@@ -0,0 +1,343 @@
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
+import { Store } from "@tanstack/store"
+import type { Event, RecordApi } from "trailbase"
+
+import type { CollectionConfig, SyncConfig, UtilsRecord } from "@tanstack/db"
+
+type ShapeOf<T> = Record<keyof T, unknown>
+type Conversion<I, O> = (value: I) => O
+
+type OptionalConversions<
+  InputType extends ShapeOf<OutputType>,
+  OutputType extends ShapeOf<InputType>,
+> = {
+  // Excludes all keys that require a conversation.
+  [K in keyof InputType as InputType[K] extends OutputType[K]
+    ? K
+    : never]?: Conversion<InputType[K], OutputType[K]>
+}
+
+type RequiredConversions<
+  InputType extends ShapeOf<OutputType>,
+  OutputType extends ShapeOf<InputType>,
+> = {
+  // Excludes all keys that do not strictly require a conversation.
+  [K in keyof InputType as InputType[K] extends OutputType[K]
+    ? never
+    : K]: Conversion<InputType[K], OutputType[K]>
+}
+
+type Conversions<
+  InputType extends ShapeOf<OutputType>,
+  OutputType extends ShapeOf<InputType>,
+> = OptionalConversions<InputType, OutputType> &
+  RequiredConversions<InputType, OutputType>
+
+function convert<
+  InputType extends ShapeOf<OutputType> & Record<string, unknown>,
+  OutputType extends ShapeOf<InputType>,
+>(
+  conversions: Conversions<InputType, OutputType>,
+  input: InputType
+): OutputType {
+  const c = conversions as Record<string, Conversion<InputType, OutputType>>
+
+  return Object.fromEntries(
+    Object.keys(input).map((k: string) => {
+      const value = input[k]
+      return [k, c[k]?.(value as any) ?? value]
+    })
+  ) as OutputType
+}
+
+function convertPartial<
+  InputType extends ShapeOf<OutputType> & Record<string, unknown>,
+  OutputType extends ShapeOf<InputType>,
+>(
+  conversions: Conversions<InputType, OutputType>,
+  input: Partial<InputType>
+): Partial<OutputType> {
+  const c = conversions as Record<string, Conversion<InputType, OutputType>>
+
+  return Object.fromEntries(
+    Object.keys(input).map((k: string) => {
+      const value = input[k]
+      return [k, c[k]?.(value as any) ?? value]
+    })
+  ) as OutputType
+}
+
+/**
+ * Configuration interface for Trailbase Collection
+ */
+export interface TrailBaseCollectionConfig<
+  TItem extends ShapeOf<TRecord>,
+  TRecord extends ShapeOf<TItem> = TItem,
+  TKey extends string | number = string | number,
+> extends Omit<
+    CollectionConfig<TItem, TKey>,
+    `sync` | `onInsert` | `onUpdate` | `onDelete`
+  > {
+  /**
+   * Record API name
+   */
+  recordApi: RecordApi<TRecord>
+
+  parse: Conversions<TRecord, TItem>
+  serialize: Conversions<TItem, TRecord>
+}
+
+export type AwaitTxIdFn = (txId: string, timeout?: number) => Promise<boolean>
+
+export interface TrailBaseCollectionUtils extends UtilsRecord {
+  cancel: () => void
+}
+
+export function trailBaseCollectionOptions<
+  TItem extends ShapeOf<TRecord>,
+  TRecord extends ShapeOf<TItem> = TItem,
+  TKey extends string | number = string | number,
+>(
+  config: TrailBaseCollectionConfig<TItem, TRecord, TKey>
+): CollectionConfig<TItem, TKey> & { utils: TrailBaseCollectionUtils } {
+  const getKey = config.getKey
+
+  const parse = (record: TRecord) =>
+    convert<TRecord, TItem>(config.parse, record)
+  const serialUpd = (item: Partial<TItem>) =>
+    convertPartial<TItem, TRecord>(config.serialize, item)
+  const serialIns = (item: TItem) =>
+    convert<TItem, TRecord>(config.serialize, item)
+
+  const seenIds = new Store(new Map<string, number>())
+
+  const awaitIds = (
+    ids: Array<string>,
+    timeout: number = 120 * 1000
+  ): Promise<void> => {
+    const completed = (value: Map<string, number>) =>
+      ids.every((id) => value.has(id))
+    if (completed(seenIds.state)) {
+      return Promise.resolve()
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        unsubscribe()
+        reject(new Error(`Timeout waiting for ids: ${ids}`))
+      }, timeout)
+
+      const unsubscribe = seenIds.subscribe((value) => {
+        if (completed(value.currentVal)) {
+          clearTimeout(timeoutId)
+          unsubscribe()
+          resolve()
+        }
+      })
+    })
+  }
+
+  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 = () => {
+    if (eventReader) {
+      eventReader.cancel()
+      eventReader.releaseLock()
+      eventReader = undefined
+    }
+  }
+
+  const sync = {
+    sync: (params: SyncParams) => {
+      const { begin, write, commit, markReady } = params
+
+      // Initial fetch.
+      async function initialFetch() {
+        const limit = 256
+        let response = await config.recordApi.list({
+          pagination: {
+            limit,
+          },
+        })
+        let cursor = response.cursor
+        let got = 0
+
+        begin()
+
+        while (true) {
+          const length = response.records.length
+          if (length === 0) break
+
+          got = got + length
+          for (const item of response.records) {
+            write({
+              type: `insert`,
+              value: parse(item),
+            })
+          }
+
+          if (length < limit) break
+
+          response = await config.recordApi.list({
+            pagination: {
+              limit,
+              cursor,
+              offset: cursor === undefined ? got : undefined,
+            },
+          })
+          cursor = response.cursor
+        }
+
+        commit()
+        markReady()
+      }
+
+      // Afterwards subscribe.
+      async function listen(reader: ReadableStreamDefaultReader<Event>) {
+        while (true) {
+          const { done, value: event } = await reader.read()
+
+          if (done || !event) {
+            reader.releaseLock()
+            eventReader = undefined
+            return
+          }
+
+          begin()
+          let value: TItem | undefined
+          if (`Insert` in event) {
+            value = parse(event.Insert as TRecord)
+            write({ type: `insert`, value })
+          } else if (`Delete` in event) {
+            value = parse(event.Delete as TRecord)
+            write({ type: `delete`, value })
+          } else if (`Update` in event) {
+            value = parse(event.Update as TRecord)
+            write({ type: `update`, value })
+          } else {
+            console.error(`Error: ${event.Error}`)
+          }
+          commit()
+
+          if (value) {
+            seenIds.setState((curr) => {
+              const newIds = new Map(curr)
+              newIds.set(String(getKey(value)), Date.now())
+              return newIds
+            })
+          }
+        }
+      }
+
+      async function start() {
+        const eventStream = await config.recordApi.subscribe(`*`)
+        const reader = (eventReader = eventStream.getReader())
+
+        // Start listening for subscriptions first. Otherwise, we'd risk a gap
+        // between the initial fetch and starting to listen.
+        listen(reader)
+
+        try {
+          await initialFetch()
+        } catch (e) {
+          cancel()
+          markReady()
+          throw e
+        }
+      }
+
+      start()
+    },
+    // Expose the getSyncMetadata function
+    getSyncMetadata: undefined,
+  }
+
+  return {
+    ...config,
+    sync,
+    getKey,
+    onInsert: async (params): Promise<Array<number | string>> => {
+      const ids = await config.recordApi.createBulk(
+        params.transaction.mutations.map((tx) => {
+          const { type, modified } = tx
+          if (type !== `insert`) {
+            throw new Error(`Expected 'insert', got: ${type}`)
+          }
+          return serialIns(modified)
+        })
+      )
+
+      // The optimistic mutation overlay is removed on return, so at this point
+      // we have to ensure that the new record was properly added to the local
+      // DB by the subscription.
+      await awaitIds(ids.map((id) => String(id)))
+
+      return ids
+    },
+    onUpdate: async (params) => {
+      const ids: Array<string> = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, changes, key } = tx
+          if (type !== `update`) {
+            throw new Error(`Expected 'update', got: ${type}`)
+          }
+
+          await config.recordApi.update(key, serialUpd(changes))
+
+          return String(key)
+        })
+      )
+
+      // The optimistic mutation overlay is removed on return, so at this point
+      // we have to ensure that the new record was properly updated in the local
+      // DB by the subscription.
+      await awaitIds(ids)
+    },
+    onDelete: async (params) => {
+      const ids: Array<string> = await Promise.all(
+        params.transaction.mutations.map(async (tx) => {
+          const { type, key } = tx
+          if (type !== `delete`) {
+            throw new Error(`Expected 'delete', got: ${type}`)
+          }
+
+          await config.recordApi.delete(key)
+          return String(key)
+        })
+      )
+
+      // The optimistic mutation overlay is removed on return, so at this point
+      // we have to ensure that the new record was properly updated in the local
+      // DB by the subscription.
+      await awaitIds(ids)
+    },
+    utils: {
+      cancel,
+    },
+  }
+}