event-sourced-collection 0.0.1

package/dist/react-native.mjs

@@ -0,0 +1,12 @@
+//#region src/platforms/react-native.ts
+function createReactNativePlatform(deps, config) {
+	const persistence = deps.createReactNativeSQLitePersistence({ database: config.database });
+	return {
+		driver: config.database,
+		persistence
+	};
+}
+//#endregion
+export { createReactNativePlatform };
+
+//# sourceMappingURL=react-native.mjs.map

package/dist/react-native.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-native.mjs","names":[],"sources":["../src/platforms/react-native.ts"],"sourcesContent":["import type { PersistedCollectionPersistence, SQLiteDriver } from \"../types\";\n\nexport type ReactNativePlatformDeps = {\n  createReactNativeSQLitePersistence: (options: {\n    database: SQLiteDriver;\n  }) => PersistedCollectionPersistence;\n};\n\nexport type ReactNativePlatformConfig = {\n  database: SQLiteDriver;\n};\n\nexport type ReactNativePlatformResult = {\n  driver: SQLiteDriver;\n  persistence: PersistedCollectionPersistence;\n};\n\nexport function createReactNativePlatform(\n  deps: ReactNativePlatformDeps,\n  config: ReactNativePlatformConfig,\n): ReactNativePlatformResult {\n  const persistence = deps.createReactNativeSQLitePersistence({\n    database: config.database,\n  });\n\n  return {\n    driver: config.database,\n    persistence,\n  };\n}\n"],"mappings":";AAiBA,SAAgB,0BACd,MACA,QAC2B;CAC3B,MAAM,cAAc,KAAK,mCAAmC,EAC1D,UAAU,OAAO,SACnB,CAAC;CAED,OAAO;EACL,QAAQ,OAAO;EACf;CACF;AACF"}

package/dist/types-CAT14Tbj.d.mts

@@ -0,0 +1,148 @@
+import { Collection, CollectionConfig, UtilsRecord } from "@tanstack/db";
+import { PersistedCollectionPersistence as PersistedCollectionPersistence$1, PersistedCollectionUtils, SQLiteDriver, persistedCollectionOptions } from "@tanstack/db-sqlite-persistence-core";
+
+//#region src/persisted-collection.d.ts
+type PersistedCollectionOptionsFn = typeof persistedCollectionOptions;
+type CreateCollectionFn = <T extends object, TKey extends string | number>(options: CollectionConfig<T, TKey, never, UtilsRecord & PersistedCollectionUtils>) => Collection<T, TKey>;
+//#endregion
+//#region src/utils/logger.d.ts
+type EventSourcedLogger = {
+  debug: (message: string, data?: Record<string, unknown>) => void;
+  info: (message: string, data?: Record<string, unknown>) => void;
+  warn: (message: string, data?: Record<string, unknown>) => void;
+  error: (message: string, data?: Record<string, unknown>) => void;
+};
+declare function createEventSourcedLogger(debug?: boolean | EventSourcedLogger): EventSourcedLogger;
+//#endregion
+//#region src/types.d.ts
+type MutationType = "insert" | "update" | "delete";
+type OutboxSyncStatus = "pending" | "synced" | "failed";
+type OutboxEntry = {
+  eventId: string;
+  collectionId: string;
+  type: MutationType;
+  key: string | number;
+  payload: Record<string, unknown>;
+  timestamp: number;
+  localSeq: number;
+  globalSeq: number | null;
+  sync: boolean;
+  syncStatus: OutboxSyncStatus;
+  attemptCount: number;
+  lastAttemptAt: number | null;
+  lastError: string | null;
+  lastErrorCode: string | null;
+  retryable: boolean | null;
+};
+type InboxEntry = {
+  eventId: string;
+  globalSeq: number;
+  collectionId: string;
+  type: MutationType;
+  key: string | number;
+  payload: Record<string, unknown>;
+  timestamp: number;
+  sync: boolean;
+};
+type ServerEvent = {
+  globalSeq: number;
+  eventId: string;
+  collectionId: string;
+  type: MutationType;
+  key: string | number;
+  payload: Record<string, unknown>;
+  timestamp: number;
+  cursor: string;
+};
+type PushConfirmation = {
+  eventId: string;
+  globalSeq: number;
+};
+type PushFailure = {
+  eventId: string;
+  message: string;
+  code?: string;
+  retryable?: boolean;
+};
+type PushResponse = {
+  confirmed: ReadonlyArray<PushConfirmation>;
+  failed?: ReadonlyArray<PushFailure>;
+};
+type PullResponse = {
+  events: ReadonlyArray<ServerEvent>;
+  cursor: string;
+  hasMore: boolean;
+};
+type PushEventsFn = (events: ReadonlyArray<OutboundEvent>) => Promise<PushResponse | ReadonlyArray<PushConfirmation>>;
+type PullEventsFn = (params: {
+  since: number;
+}) => Promise<PullResponse>;
+type SyncTransport = {
+  push: PushEventsFn;
+  pull: (since: number) => Promise<PullResponse>;
+};
+type OutboundEvent = {
+  eventId: string;
+  collectionId: string;
+  type: MutationType;
+  key: string | number;
+  payload: Record<string, unknown>;
+  timestamp: number;
+};
+type SyncUrlConfig = {
+  push: string;
+  pull: string;
+  headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
+};
+type SyncHandlersConfig = {
+  pushEvents?: PushEventsFn;
+  pullEvents?: PullEventsFn;
+  pushUrl?: string;
+  pullUrl?: string;
+  headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
+};
+type CollectionDef<TState = object, TKey extends string | number = string> = {
+  getKey: (state: TState) => TKey;
+  schemaVersion?: number;
+};
+type InferState<T> = T extends {
+  getKey: (state: infer S) => string | number;
+} ? [S] extends [never] ? object : S extends object ? S : object : object;
+type InferKey<T> = T extends {
+  getKey: (state: never) => infer K;
+} ? K extends string | number ? K : string : string;
+type CollectionDefConstraint = {
+  getKey: (state: never) => string | number;
+  schemaVersion?: number;
+};
+type CollectionMap<TDefs extends Record<string, CollectionDefConstraint>> = { [K in keyof TDefs]: Collection<InferState<TDefs[K]>, InferKey<TDefs[K]>> };
+type ReservedCollections = {
+  outbox: Collection<OutboxEntry, string>;
+  inbox: Collection<InboxEntry, string>;
+};
+type EventSourcedDBConfig<TDefs extends Record<string, CollectionDefConstraint>> = {
+  persistence: PersistedCollectionPersistence$1;
+  collections: TDefs;
+  sync?: SyncHandlersConfig | SyncUrlConfig | SyncTransport;
+  schemaVersion?: number;
+  debug?: boolean | EventSourcedLogger;
+  createCollection: CreateCollectionFn;
+  persistedCollectionOptions: PersistedCollectionOptionsFn;
+};
+type EventSourcedDB<TDefs extends Record<string, CollectionDefConstraint>> = {
+  collections: CollectionMap<TDefs> & ReservedCollections;
+  sync: () => Promise<SyncResult>;
+  manualSync: () => Promise<ManualSyncResult>;
+  dispose: () => void;
+};
+type SyncResult = {
+  pushed: number;
+  pulled: number;
+  errors: ReadonlyArray<Error>;
+};
+type ManualSyncResult = SyncResult & {
+  replayed: number;
+};
+//#endregion
+export { PersistedCollectionOptionsFn as A, SyncHandlersConfig as C, EventSourcedLogger as D, SyncUrlConfig as E, createEventSourcedLogger as O, ServerEvent as S, SyncTransport as T, PushEventsFn as _, InboxEntry as a, ReservedCollections as b, ManualSyncResult as c, OutboxEntry as d, OutboxSyncStatus as f, PushConfirmation as g, PullResponse as h, EventSourcedDBConfig as i, CreateCollectionFn as k, MutationType as l, PullEventsFn as m, CollectionMap as n, InferKey as o, PersistedCollectionPersistence$1 as p, EventSourcedDB as r, InferState as s, CollectionDef as t, OutboundEvent as u, PushFailure as v, SyncResult as w, SQLiteDriver as x, PushResponse as y };
+//# sourceMappingURL=types-CAT14Tbj.d.mts.map

package/dist/types-CAT14Tbj.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-CAT14Tbj.d.mts","names":[],"sources":["../src/persisted-collection.ts","../src/utils/logger.ts","../src/types.ts"],"mappings":";;;;KAMY,4BAAA,UAAsC,0BAA0B;AAAA,KAEhE,kBAAA,oDACV,OAAA,EAAS,gBAAA,CAAiB,CAAA,EAAG,IAAA,SAAa,WAAA,GAAc,wBAAA,MACrD,UAAA,CAAW,CAAA,EAAG,IAAA;;;KCRP,kBAAA;EACV,KAAA,GAAQ,OAAA,UAAiB,IAAA,GAAO,MAAA;EAChC,IAAA,GAAO,OAAA,UAAiB,IAAA,GAAO,MAAA;EAC/B,IAAA,GAAO,OAAA,UAAiB,IAAA,GAAO,MAAA;EAC/B,KAAA,GAAQ,OAAA,UAAiB,IAAA,GAAO,MAAA;AAAA;AAAA,iBAYlB,wBAAA,CACd,KAAA,aAAkB,kBAAA,GACjB,kBAAkB;;;KCPT,YAAA;AAAA,KACA,gBAAA;AAAA,KAEA,WAAA;EACV,OAAA;EACA,YAAA;EACA,IAAA,EAAM,YAAA;EACN,GAAA;EACA,OAAA,EAAS,MAAA;EACT,SAAA;EACA,QAAA;EACA,SAAA;EACA,IAAA;EACA,UAAA,EAAY,gBAAA;EACZ,YAAA;EACA,aAAA;EACA,SAAA;EACA,aAAA;EACA,SAAA;AAAA;AAAA,KAGU,UAAA;EACV,OAAA;EACA,SAAA;EACA,YAAA;EACA,IAAA,EAAM,YAAA;EACN,GAAA;EACA,OAAA,EAAS,MAAM;EACf,SAAA;EACA,IAAA;AAAA;AAAA,KAGU,WAAA;EACV,SAAA;EACA,OAAA;EACA,YAAA;EACA,IAAA,EAAM,YAAA;EACN,GAAA;EACA,OAAA,EAAS,MAAM;EACf,SAAA;EACA,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,OAAA;EACA,SAAS;AAAA;AAAA,KAGC,WAAA;EACV,OAAA;EACA,OAAA;EACA,IAAA;EACA,SAAA;AAAA;AAAA,KAGU,YAAA;EACV,SAAA,EAAW,aAAA,CAAc,gBAAA;EACzB,MAAA,GAAS,aAAA,CAAc,WAAA;AAAA;AAAA,KAGb,YAAA;EACV,MAAA,EAAQ,aAAa,CAAC,WAAA;EACtB,MAAA;EACA,OAAA;AAAA;AAAA,KAGU,YAAA,IACV,MAAA,EAAQ,aAAA,CAAc,aAAA,MACnB,OAAA,CAAQ,YAAA,GAAe,aAAA,CAAc,gBAAA;AAAA,KAE9B,YAAA,IAAgB,MAAA;EAAU,KAAA;AAAA,MAAoB,OAAO,CAAC,YAAA;AAAA,KAEtD,aAAA;EACV,IAAA,EAAM,YAAA;EACN,IAAA,GAAO,KAAA,aAAkB,OAAA,CAAQ,YAAA;AAAA;AAAA,KAGvB,aAAA;EACV,OAAA;EACA,YAAA;EACA,IAAA,EAAM,YAAA;EACN,GAAA;EACA,OAAA,EAAS,MAAM;EACf,SAAA;AAAA;AAAA,KAGU,aAAA;EACV,IAAA;EACA,IAAA;EACA,OAAA,GACI,MAAA,0BACO,MAAA,mBAAyB,OAAA,CAAQ,MAAA;AAAA;AAAA,KAGlC,kBAAA;EACV,UAAA,GAAa,YAAA;EACb,UAAA,GAAa,YAAA;EACb,OAAA;EACA,OAAA;EACA,OAAA,GACI,MAAA,0BACO,MAAA,mBAAyB,OAAA,CAAQ,MAAA;AAAA;AAAA,KAGlC,aAAA;EAIV,MAAA,GAAS,KAAA,EAAO,MAAA,KAAW,IAAI;EAC/B,aAAA;AAAA;AAAA,KAGU,UAAA,MAAgB,CAAA;EAAY,MAAA,GAAS,KAAA;AAAA,KAC5C,CAAC,6BAEA,CAAA,kBACE,CAAA;AAAA,KAII,QAAA,MAAc,CAAC;EAAW,MAAA,GAAS,KAAA;AAAA,IAC3C,CAAA,2BACE,CAAA;AAAA,KAID,uBAAA;EACH,MAAA,GAAS,KAAA;EACT,aAAA;AAAA;AAAA,KAGU,aAAA,eAA4B,MAAA,SAAe,uBAAA,mBACzC,KAAA,GAAQ,UAAA,CAAW,UAAA,CAAW,KAAA,CAAM,CAAA,IAAK,QAAA,CAAS,KAAA,CAAM,CAAA;AAAA,KAG1D,mBAAA;EACV,MAAA,EAAQ,UAAA,CAAW,WAAA;EACnB,KAAA,EAAO,UAAA,CAAW,UAAA;AAAA;AAAA,KAGR,oBAAA,eAAmC,MAAA,SAAe,uBAAA;EAC5D,WAAA,EAAa,gCAAA;EACb,WAAA,EAAa,KAAA;EACb,IAAA,GAAO,kBAAA,GAAqB,aAAA,GAAgB,aAAA;EAC5C,aAAA;EACA,KAAA,aAAkB,kBAAA;EAClB,gBAAA,EAAkB,kBAAA;EAClB,0BAAA,EAA4B,4BAAA;AAAA;AAAA,KAGlB,cAAA,eAA6B,MAAA,SAAe,uBAAA;EACtD,WAAA,EAAa,aAAA,CAAc,KAAA,IAAS,mBAAA;EACpC,IAAA,QAAY,OAAA,CAAQ,UAAA;EACpB,UAAA,QAAkB,OAAA,CAAQ,gBAAA;EAC1B,OAAA;AAAA;AAAA,KAGU,UAAA;EACV,MAAA;EACA,MAAA;EACA,MAAA,EAAQ,aAAa,CAAC,KAAA;AAAA;AAAA,KAGZ,gBAAA,GAAmB,UAAU;EACvC,QAAQ;AAAA"}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "event-sourced-collection",
+  "version": "0.0.1",
+  "description": "Event-sourced local-first database built on TanStack DB persistence",
+  "keywords": [
+    "event-sourcing",
+    "local-first",
+    "offline",
+    "offline-first",
+    "sqlite",
+    "sync",
+    "tanstack",
+    "tanstack-db"
+  ],
+  "license": "MIT",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./browser": "./dist/browser.mjs",
+    "./react-native": "./dist/react-native.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "check-types": "tsgo --noEmit",
+    "prepublishOnly": "pnpm run build",
+    "check-exports": "attw --pack . --profile node16 --ignore-rules cjs-resolves-to-esm",
+    "postbuild": "npm run check-exports",
+    "release": "changeset publish --no-git-checks"
+  },
+  "dependencies": {
+    "uuidv7": "^1.2.1"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.4",
+    "@changesets/cli": "^2.31.0",
+    "@repo/typescript-config": "workspace:*",
+    "@tanstack/browser-db-sqlite-persistence": "^0.2.1",
+    "@tanstack/db": "^0.6.9",
+    "@tanstack/db-sqlite-persistence-core": "^0.2.1",
+    "tsdown": "^0.22.3",
+    "typescript": "catalog:"
+  },
+  "peerDependencies": {
+    "@tanstack/browser-db-sqlite-persistence": ">=0.2.0",
+    "@tanstack/db": ">=0.6.0",
+    "@tanstack/db-sqlite-persistence-core": ">=0.2.0",
+    "@tanstack/expo-db-sqlite-persistence": ">=0.2.0",
+    "@tanstack/node-db-sqlite-persistence": ">=0.2.0",
+    "@tanstack/react-native-db-sqlite-persistence": ">=0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@tanstack/browser-db-sqlite-persistence": {
+      "optional": true
+    },
+    "@tanstack/react-native-db-sqlite-persistence": {
+      "optional": true
+    },
+    "@tanstack/expo-db-sqlite-persistence": {
+      "optional": true
+    },
+    "@tanstack/node-db-sqlite-persistence": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}