@tanstack/offline-transactions 0.0.0

package/README.md

@@ -0,0 +1,219 @@
+# @tanstack/offline-transactions
+
+Offline-first transaction capabilities for TanStack DB that provides durable persistence of mutations with automatic retry when connectivity is restored.
+
+## Features
+
+- **Outbox Pattern**: Persist mutations before dispatch for zero data loss
+- **Automatic Retry**: Exponential backoff with jitter for failed transactions
+- **Multi-tab Coordination**: Leader election ensures safe storage access
+- **FIFO Sequential Processing**: Transactions execute one at a time in creation order
+- **Flexible Storage**: IndexedDB with localStorage fallback
+- **Type Safe**: Full TypeScript support with TanStack DB integration
+
+## Installation
+
+```bash
+npm install @tanstack/offline-transactions
+```
+
+## Quick Start
+
+```typescript
+import { startOfflineExecutor } from "@tanstack/offline-transactions"
+
+// Setup offline executor
+const offline = startOfflineExecutor({
+  collections: { todos: todoCollection },
+  mutationFns: {
+    syncTodos: async ({ transaction, idempotencyKey }) => {
+      await api.saveBatch(transaction.mutations, { idempotencyKey })
+    },
+  },
+  onLeadershipChange: (isLeader) => {
+    if (!isLeader) {
+      console.warn("Running in online-only mode (another tab is the leader)")
+    }
+  },
+})
+
+// Create offline transactions
+const offlineTx = offline.createOfflineTransaction({
+  mutationFnName: "syncTodos",
+  autoCommit: false,
+})
+
+offlineTx.mutate(() => {
+  todoCollection.insert({
+    id: crypto.randomUUID(),
+    text: "Buy milk",
+    completed: false,
+  })
+})
+
+// Execute with automatic offline support
+await offlineTx.commit()
+```
+
+## Core Concepts
+
+### Outbox-First Persistence
+
+Mutations are persisted to a durable outbox before being applied, ensuring zero data loss during offline periods:
+
+1. Mutation is persisted to IndexedDB/localStorage
+2. Optimistic update is applied locally
+3. When online, mutation is sent to server
+4. On success, mutation is removed from outbox
+
+### Multi-tab Coordination
+
+Only one tab acts as the "leader" to safely manage the outbox:
+
+- **Leader tab**: Full offline support with outbox persistence
+- **Non-leader tabs**: Online-only mode for safety
+- **Leadership transfer**: Automatic failover when leader tab closes
+
+### FIFO Sequential Processing
+
+Transactions are processed one at a time in the order they were created:
+
+- **Sequential execution**: All transactions execute in FIFO order
+- **Dependency safety**: Avoids conflicts between transactions that may reference each other
+- **Predictable behavior**: Transactions complete in the exact order they were created
+
+## API Reference
+
+### startOfflineExecutor(config)
+
+Creates and starts an offline executor instance.
+
+```typescript
+interface OfflineConfig {
+  collections: Record<string, Collection>
+  mutationFns: Record<string, MutationFn>
+  storage?: StorageAdapter
+  maxConcurrency?: number
+  jitter?: boolean
+  beforeRetry?: (transactions: OfflineTransaction[]) => OfflineTransaction[]
+  onUnknownMutationFn?: (name: string, tx: OfflineTransaction) => void
+  onLeadershipChange?: (isLeader: boolean) => void
+}
+```
+
+### OfflineExecutor
+
+#### Properties
+
+- `isOfflineEnabled: boolean` - Whether this tab can persist offline transactions
+
+#### Methods
+
+- `createOfflineTransaction(options)` - Create a manual offline transaction
+- `waitForTransactionCompletion(id)` - Wait for a specific transaction to complete
+- `removeFromOutbox(id)` - Manually remove transaction from outbox
+- `peekOutbox()` - View all pending transactions
+- `notifyOnline()` - Manually trigger retry execution
+- `dispose()` - Clean up resources
+
+### Error Handling
+
+Use `NonRetriableError` for permanent failures:
+
+```typescript
+import { NonRetriableError } from "@tanstack/offline-transactions"
+
+const mutationFn = async ({ transaction }) => {
+  try {
+    await api.save(transaction.mutations)
+  } catch (error) {
+    if (error.status === 422) {
+      throw new NonRetriableError("Invalid data - will not retry")
+    }
+    throw error // Will retry with backoff
+  }
+}
+```
+
+## Advanced Usage
+
+### Custom Storage Adapter
+
+```typescript
+import {
+  IndexedDBAdapter,
+  LocalStorageAdapter,
+} from "@tanstack/offline-transactions"
+
+const executor = startOfflineExecutor({
+  // Use custom storage
+  storage: new IndexedDBAdapter("my-app", "transactions"),
+  // ... other config
+})
+```
+
+### Custom Retry Policy
+
+```typescript
+const executor = startOfflineExecutor({
+  maxConcurrency: 5,
+  jitter: true,
+  beforeRetry: (transactions) => {
+    // Filter out old transactions
+    const cutoff = Date.now() - 24 * 60 * 60 * 1000 // 24 hours
+    return transactions.filter((tx) => tx.createdAt.getTime() > cutoff)
+  },
+  // ... other config
+})
+```
+
+### Manual Transaction Control
+
+```typescript
+const tx = executor.createOfflineTransaction({
+  mutationFnName: "syncData",
+  autoCommit: false,
+})
+
+tx.mutate(() => {
+  collection.insert({ id: "1", text: "Item 1" })
+  collection.insert({ id: "2", text: "Item 2" })
+})
+
+// Commit when ready
+await tx.commit()
+```
+
+## Migration from TanStack DB
+
+This package uses explicit offline transactions to provide offline capabilities:
+
+```typescript
+// Before: Standard TanStack DB (online only)
+todoCollection.insert({ id: "1", text: "Buy milk" })
+
+// After: Explicit offline transactions
+const offline = startOfflineExecutor({
+  collections: { todos: todoCollection },
+  mutationFns: {
+    syncTodos: async ({ transaction }) => {
+      await api.sync(transaction.mutations)
+    },
+  },
+})
+
+const tx = offline.createOfflineTransaction({ mutationFnName: "syncTodos" })
+tx.mutate(() => todoCollection.insert({ id: "1", text: "Buy milk" }))
+await tx.commit() // Works offline!
+```
+
+## Browser Support
+
+- **IndexedDB**: Modern browsers (primary storage)
+- **localStorage**: Fallback for limited environments
+- **Web Locks API**: Chrome 69+, Firefox 96+ (preferred leader election)
+- **BroadcastChannel**: All modern browsers (fallback leader election)
+
+## License
+
+MIT

package/dist/cjs/OfflineExecutor.cjs

@@ -0,0 +1,266 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const db = require("@tanstack/db");
+const IndexedDBAdapter = require("./storage/IndexedDBAdapter.cjs");
+const LocalStorageAdapter = require("./storage/LocalStorageAdapter.cjs");
+const OutboxManager = require("./outbox/OutboxManager.cjs");
+const KeyScheduler = require("./executor/KeyScheduler.cjs");
+const TransactionExecutor = require("./executor/TransactionExecutor.cjs");
+const WebLocksLeader = require("./coordination/WebLocksLeader.cjs");
+const BroadcastChannelLeader = require("./coordination/BroadcastChannelLeader.cjs");
+const OnlineDetector = require("./connectivity/OnlineDetector.cjs");
+const OfflineTransaction = require("./api/OfflineTransaction.cjs");
+const OfflineAction = require("./api/OfflineAction.cjs");
+const tracer = require("./telemetry/tracer.cjs");
+class OfflineExecutor {
+  constructor(config) {
+    this.isLeaderState = false;
+    this.unsubscribeOnline = null;
+    this.unsubscribeLeadership = null;
+    this.pendingTransactionPromises = /* @__PURE__ */ new Map();
+    this.config = config;
+    this.storage = this.createStorage();
+    this.outbox = new OutboxManager.OutboxManager(this.storage, this.config.collections);
+    this.scheduler = new KeyScheduler.KeyScheduler();
+    this.executor = new TransactionExecutor.TransactionExecutor(
+      this.scheduler,
+      this.outbox,
+      this.config,
+      this
+    );
+    this.leaderElection = this.createLeaderElection();
+    this.onlineDetector = new OnlineDetector.DefaultOnlineDetector();
+    this.setupEventListeners();
+    this.initialize();
+  }
+  createStorage() {
+    if (this.config.storage) {
+      return this.config.storage;
+    }
+    try {
+      return new IndexedDBAdapter.IndexedDBAdapter();
+    } catch (error) {
+      console.warn(
+        `IndexedDB not available, falling back to localStorage:`,
+        error
+      );
+      return new LocalStorageAdapter.LocalStorageAdapter();
+    }
+  }
+  createLeaderElection() {
+    if (this.config.leaderElection) {
+      return this.config.leaderElection;
+    }
+    if (WebLocksLeader.WebLocksLeader.isSupported()) {
+      return new WebLocksLeader.WebLocksLeader();
+    } else if (BroadcastChannelLeader.BroadcastChannelLeader.isSupported()) {
+      return new BroadcastChannelLeader.BroadcastChannelLeader();
+    } else {
+      return {
+        requestLeadership: () => Promise.resolve(true),
+        releaseLeadership: () => {
+        },
+        isLeader: () => true,
+        onLeadershipChange: () => () => {
+        }
+      };
+    }
+  }
+  setupEventListeners() {
+    this.unsubscribeLeadership = this.leaderElection.onLeadershipChange(
+      (isLeader) => {
+        this.isLeaderState = isLeader;
+        if (this.config.onLeadershipChange) {
+          this.config.onLeadershipChange(isLeader);
+        }
+        if (isLeader) {
+          this.loadAndReplayTransactions();
+        }
+      }
+    );
+    this.unsubscribeOnline = this.onlineDetector.subscribe(() => {
+      if (this.isOfflineEnabled) {
+        this.executor.resetRetryDelays();
+        this.executor.executeAll().catch((error) => {
+          console.warn(
+            `Failed to execute transactions on connectivity change:`,
+            error
+          );
+        });
+      }
+    });
+  }
+  async initialize() {
+    return tracer.withSpan(`executor.initialize`, {}, async (span) => {
+      try {
+        const isLeader = await this.leaderElection.requestLeadership();
+        span.setAttribute(`isLeader`, isLeader);
+        if (isLeader) {
+          await this.loadAndReplayTransactions();
+        }
+      } catch (error) {
+        console.warn(`Failed to initialize offline executor:`, error);
+      }
+    });
+  }
+  async loadAndReplayTransactions() {
+    try {
+      await this.executor.loadPendingTransactions();
+      await this.executor.executeAll();
+    } catch (error) {
+      console.warn(`Failed to load and replay transactions:`, error);
+    }
+  }
+  get isOfflineEnabled() {
+    return this.isLeaderState;
+  }
+  createOfflineTransaction(options) {
+    const mutationFn = this.config.mutationFns[options.mutationFnName];
+    if (!mutationFn) {
+      throw new Error(`Unknown mutation function: ${options.mutationFnName}`);
+    }
+    if (!this.isOfflineEnabled) {
+      return db.createTransaction({
+        autoCommit: options.autoCommit ?? true,
+        mutationFn: (params) => mutationFn({
+          ...params,
+          idempotencyKey: options.idempotencyKey || crypto.randomUUID()
+        }),
+        metadata: options.metadata
+      });
+    }
+    return new OfflineTransaction.OfflineTransaction(
+      options,
+      mutationFn,
+      this.persistTransaction.bind(this),
+      this
+    );
+  }
+  createOfflineAction(options) {
+    const mutationFn = this.config.mutationFns[options.mutationFnName];
+    if (!mutationFn) {
+      throw new Error(`Unknown mutation function: ${options.mutationFnName}`);
+    }
+    return (variables) => {
+      if (!this.isOfflineEnabled) {
+        const action2 = db.createOptimisticAction({
+          mutationFn: (vars, params) => mutationFn({
+            ...vars,
+            ...params,
+            idempotencyKey: crypto.randomUUID()
+          }),
+          onMutate: options.onMutate
+        });
+        return action2(variables);
+      }
+      const action = OfflineAction.createOfflineAction(
+        options,
+        mutationFn,
+        this.persistTransaction.bind(this),
+        this
+      );
+      return action(variables);
+    };
+  }
+  async persistTransaction(transaction) {
+    return tracer.withNestedSpan(
+      `executor.persistTransaction`,
+      {
+        "transaction.id": transaction.id,
+        "transaction.mutationFnName": transaction.mutationFnName
+      },
+      async (span) => {
+        if (!this.isOfflineEnabled) {
+          span.setAttribute(`result`, `skipped_not_leader`);
+          this.resolveTransaction(transaction.id, void 0);
+          return;
+        }
+        try {
+          await this.outbox.add(transaction);
+          await this.executor.execute(transaction);
+          span.setAttribute(`result`, `persisted`);
+        } catch (error) {
+          console.error(
+            `Failed to persist offline transaction ${transaction.id}:`,
+            error
+          );
+          span.setAttribute(`result`, `failed`);
+          throw error;
+        }
+      }
+    );
+  }
+  // Method for OfflineTransaction to wait for completion
+  async waitForTransactionCompletion(transactionId) {
+    const existing = this.pendingTransactionPromises.get(transactionId);
+    if (existing) {
+      return existing.promise;
+    }
+    const deferred = {};
+    deferred.promise = new Promise((resolve, reject) => {
+      deferred.resolve = resolve;
+      deferred.reject = reject;
+    });
+    this.pendingTransactionPromises.set(transactionId, deferred);
+    return deferred.promise;
+  }
+  // Method for TransactionExecutor to signal completion
+  resolveTransaction(transactionId, result) {
+    const deferred = this.pendingTransactionPromises.get(transactionId);
+    if (deferred) {
+      deferred.resolve(result);
+      this.pendingTransactionPromises.delete(transactionId);
+    }
+  }
+  // Method for TransactionExecutor to signal failure
+  rejectTransaction(transactionId, error) {
+    const deferred = this.pendingTransactionPromises.get(transactionId);
+    if (deferred) {
+      deferred.reject(error);
+      this.pendingTransactionPromises.delete(transactionId);
+    }
+  }
+  async removeFromOutbox(id) {
+    await this.outbox.remove(id);
+  }
+  async peekOutbox() {
+    return this.outbox.getAll();
+  }
+  async clearOutbox() {
+    await this.outbox.clear();
+    this.executor.clear();
+  }
+  notifyOnline() {
+    this.onlineDetector.notifyOnline();
+  }
+  getPendingCount() {
+    return this.executor.getPendingCount();
+  }
+  getRunningCount() {
+    return this.executor.getRunningCount();
+  }
+  getOnlineDetector() {
+    return this.onlineDetector;
+  }
+  dispose() {
+    if (this.unsubscribeOnline) {
+      this.unsubscribeOnline();
+      this.unsubscribeOnline = null;
+    }
+    if (this.unsubscribeLeadership) {
+      this.unsubscribeLeadership();
+      this.unsubscribeLeadership = null;
+    }
+    this.leaderElection.releaseLeadership();
+    this.onlineDetector.dispose();
+    if (`dispose` in this.leaderElection) {
+      this.leaderElection.dispose();
+    }
+  }
+}
+function startOfflineExecutor(config) {
+  return new OfflineExecutor(config);
+}
+exports.OfflineExecutor = OfflineExecutor;
+exports.startOfflineExecutor = startOfflineExecutor;
+//# sourceMappingURL=OfflineExecutor.cjs.map

package/dist/cjs/OfflineExecutor.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"OfflineExecutor.cjs","sources":["../../src/OfflineExecutor.ts"],"sourcesContent":["// Storage adapters\nimport { createOptimisticAction, createTransaction } from \"@tanstack/db\"\nimport { IndexedDBAdapter } from \"./storage/IndexedDBAdapter\"\nimport { LocalStorageAdapter } from \"./storage/LocalStorageAdapter\"\n\n// Core components\nimport { OutboxManager } from \"./outbox/OutboxManager\"\nimport { KeyScheduler } from \"./executor/KeyScheduler\"\nimport { TransactionExecutor } from \"./executor/TransactionExecutor\"\n\n// Coordination\nimport { WebLocksLeader } from \"./coordination/WebLocksLeader\"\nimport { BroadcastChannelLeader } from \"./coordination/BroadcastChannelLeader\"\n\n// Connectivity\nimport { DefaultOnlineDetector } from \"./connectivity/OnlineDetector\"\n\n// API\nimport { OfflineTransaction as OfflineTransactionAPI } from \"./api/OfflineTransaction\"\nimport { createOfflineAction } from \"./api/OfflineAction\"\n\n// TanStack DB primitives\n\n// Replay\nimport { withNestedSpan, withSpan } from \"./telemetry/tracer\"\nimport type {\n  CreateOfflineActionOptions,\n  CreateOfflineTransactionOptions,\n  LeaderElection,\n  OfflineConfig,\n  OfflineTransaction,\n  StorageAdapter,\n} from \"./types\"\nimport type { Transaction } from \"@tanstack/db\"\n\nexport class OfflineExecutor {\n  private config: OfflineConfig\n  private storage: StorageAdapter\n  private outbox: OutboxManager\n  private scheduler: KeyScheduler\n  private executor: TransactionExecutor\n  private leaderElection: LeaderElection\n  private onlineDetector: DefaultOnlineDetector\n  private isLeaderState = false\n  private unsubscribeOnline: (() => void) | null = null\n  private unsubscribeLeadership: (() => void) | null = null\n\n  // Coordination mechanism for blocking transactions\n  private pendingTransactionPromises: Map<\n    string,\n    {\n      promise: Promise<any>\n      resolve: (result: any) => void\n      reject: (error: Error) => void\n    }\n  > = new Map()\n\n  constructor(config: OfflineConfig) {\n    this.config = config\n    this.storage = this.createStorage()\n    this.outbox = new OutboxManager(this.storage, this.config.collections)\n    this.scheduler = new KeyScheduler()\n    this.executor = new TransactionExecutor(\n      this.scheduler,\n      this.outbox,\n      this.config,\n      this\n    )\n    this.leaderElection = this.createLeaderElection()\n    this.onlineDetector = new DefaultOnlineDetector()\n\n    this.setupEventListeners()\n    this.initialize()\n  }\n\n  private createStorage(): StorageAdapter {\n    if (this.config.storage) {\n      return this.config.storage\n    }\n\n    try {\n      return new IndexedDBAdapter()\n    } catch (error) {\n      console.warn(\n        `IndexedDB not available, falling back to localStorage:`,\n        error\n      )\n      return new LocalStorageAdapter()\n    }\n  }\n\n  private createLeaderElection(): LeaderElection {\n    if (this.config.leaderElection) {\n      return this.config.leaderElection\n    }\n\n    if (WebLocksLeader.isSupported()) {\n      return new WebLocksLeader()\n    } else if (BroadcastChannelLeader.isSupported()) {\n      return new BroadcastChannelLeader()\n    } else {\n      // Fallback: always be leader in environments without multi-tab support\n      return {\n        requestLeadership: () => Promise.resolve(true),\n        releaseLeadership: () => {},\n        isLeader: () => true,\n        onLeadershipChange: () => () => {},\n      }\n    }\n  }\n\n  private setupEventListeners(): void {\n    this.unsubscribeLeadership = this.leaderElection.onLeadershipChange(\n      (isLeader) => {\n        this.isLeaderState = isLeader\n\n        if (this.config.onLeadershipChange) {\n          this.config.onLeadershipChange(isLeader)\n        }\n\n        if (isLeader) {\n          this.loadAndReplayTransactions()\n        }\n      }\n    )\n\n    this.unsubscribeOnline = this.onlineDetector.subscribe(() => {\n      if (this.isOfflineEnabled) {\n        // Reset retry delays so transactions can execute immediately when back online\n        this.executor.resetRetryDelays()\n        this.executor.executeAll().catch((error) => {\n          console.warn(\n            `Failed to execute transactions on connectivity change:`,\n            error\n          )\n        })\n      }\n    })\n  }\n\n  private async initialize(): Promise<void> {\n    return withSpan(`executor.initialize`, {}, async (span) => {\n      try {\n        const isLeader = await this.leaderElection.requestLeadership()\n        span.setAttribute(`isLeader`, isLeader)\n\n        if (isLeader) {\n          await this.loadAndReplayTransactions()\n        }\n      } catch (error) {\n        console.warn(`Failed to initialize offline executor:`, error)\n      }\n    })\n  }\n\n  private async loadAndReplayTransactions(): Promise<void> {\n    try {\n      await this.executor.loadPendingTransactions()\n      await this.executor.executeAll()\n    } catch (error) {\n      console.warn(`Failed to load and replay transactions:`, error)\n    }\n  }\n\n  get isOfflineEnabled(): boolean {\n    return this.isLeaderState\n  }\n\n  createOfflineTransaction(\n    options: CreateOfflineTransactionOptions\n  ): Transaction | OfflineTransactionAPI {\n    const mutationFn = this.config.mutationFns[options.mutationFnName]\n\n    if (!mutationFn) {\n      throw new Error(`Unknown mutation function: ${options.mutationFnName}`)\n    }\n\n    // Check leadership immediately and use the appropriate primitive\n    if (!this.isOfflineEnabled) {\n      // Non-leader: use createTransaction directly with the resolved mutation function\n      // We need to wrap it to add the idempotency key\n      return createTransaction({\n        autoCommit: options.autoCommit ?? true,\n        mutationFn: (params) =>\n          mutationFn({\n            ...params,\n            idempotencyKey: options.idempotencyKey || crypto.randomUUID(),\n          }),\n        metadata: options.metadata,\n      })\n    }\n\n    // Leader: use OfflineTransaction wrapper for offline persistence\n    return new OfflineTransactionAPI(\n      options,\n      mutationFn,\n      this.persistTransaction.bind(this),\n      this\n    )\n  }\n\n  createOfflineAction<T>(options: CreateOfflineActionOptions<T>) {\n    const mutationFn = this.config.mutationFns[options.mutationFnName]\n\n    if (!mutationFn) {\n      throw new Error(`Unknown mutation function: ${options.mutationFnName}`)\n    }\n\n    // Return a wrapper that checks leadership status at call time\n    return (variables: T) => {\n      // Check leadership when action is called, not when it's created\n      if (!this.isOfflineEnabled) {\n        // Non-leader: use createOptimisticAction directly\n        const action = createOptimisticAction({\n          mutationFn: (vars, params) =>\n            mutationFn({\n              ...vars,\n              ...params,\n              idempotencyKey: crypto.randomUUID(),\n            }),\n          onMutate: options.onMutate,\n        })\n        return action(variables)\n      }\n\n      // Leader: use the offline action wrapper\n      const action = createOfflineAction(\n        options,\n        mutationFn,\n        this.persistTransaction.bind(this),\n        this\n      )\n      return action(variables)\n    }\n  }\n\n  private async persistTransaction(\n    transaction: OfflineTransaction\n  ): Promise<void> {\n    return withNestedSpan(\n      `executor.persistTransaction`,\n      {\n        \"transaction.id\": transaction.id,\n        \"transaction.mutationFnName\": transaction.mutationFnName,\n      },\n      async (span) => {\n        if (!this.isOfflineEnabled) {\n          span.setAttribute(`result`, `skipped_not_leader`)\n          this.resolveTransaction(transaction.id, undefined)\n          return\n        }\n\n        try {\n          await this.outbox.add(transaction)\n          await this.executor.execute(transaction)\n          span.setAttribute(`result`, `persisted`)\n        } catch (error) {\n          console.error(\n            `Failed to persist offline transaction ${transaction.id}:`,\n            error\n          )\n          span.setAttribute(`result`, `failed`)\n          throw error\n        }\n      }\n    )\n  }\n\n  // Method for OfflineTransaction to wait for completion\n  async waitForTransactionCompletion(transactionId: string): Promise<any> {\n    const existing = this.pendingTransactionPromises.get(transactionId)\n    if (existing) {\n      return existing.promise\n    }\n\n    const deferred: {\n      promise: Promise<any>\n      resolve: (result: any) => void\n      reject: (error: Error) => void\n    } = {} as any\n\n    deferred.promise = new Promise((resolve, reject) => {\n      deferred.resolve = resolve\n      deferred.reject = reject\n    })\n\n    this.pendingTransactionPromises.set(transactionId, deferred)\n    return deferred.promise\n  }\n\n  // Method for TransactionExecutor to signal completion\n  resolveTransaction(transactionId: string, result: any): void {\n    const deferred = this.pendingTransactionPromises.get(transactionId)\n    if (deferred) {\n      deferred.resolve(result)\n      this.pendingTransactionPromises.delete(transactionId)\n    }\n  }\n\n  // Method for TransactionExecutor to signal failure\n  rejectTransaction(transactionId: string, error: Error): void {\n    const deferred = this.pendingTransactionPromises.get(transactionId)\n    if (deferred) {\n      deferred.reject(error)\n      this.pendingTransactionPromises.delete(transactionId)\n    }\n  }\n\n  async removeFromOutbox(id: string): Promise<void> {\n    await this.outbox.remove(id)\n  }\n\n  async peekOutbox(): Promise<Array<OfflineTransaction>> {\n    return this.outbox.getAll()\n  }\n\n  async clearOutbox(): Promise<void> {\n    await this.outbox.clear()\n    this.executor.clear()\n  }\n\n  notifyOnline(): void {\n    this.onlineDetector.notifyOnline()\n  }\n\n  getPendingCount(): number {\n    return this.executor.getPendingCount()\n  }\n\n  getRunningCount(): number {\n    return this.executor.getRunningCount()\n  }\n\n  getOnlineDetector(): DefaultOnlineDetector {\n    return this.onlineDetector\n  }\n\n  dispose(): void {\n    if (this.unsubscribeOnline) {\n      this.unsubscribeOnline()\n      this.unsubscribeOnline = null\n    }\n\n    if (this.unsubscribeLeadership) {\n      this.unsubscribeLeadership()\n      this.unsubscribeLeadership = null\n    }\n\n    this.leaderElection.releaseLeadership()\n    this.onlineDetector.dispose()\n\n    if (`dispose` in this.leaderElection) {\n      ;(this.leaderElection as any).dispose()\n    }\n  }\n}\n\nexport function startOfflineExecutor(config: OfflineConfig): OfflineExecutor {\n  return new OfflineExecutor(config)\n}\n"],"names":["OutboxManager","KeyScheduler","TransactionExecutor","DefaultOnlineDetector","IndexedDBAdapter","LocalStorageAdapter","WebLocksLeader","BroadcastChannelLeader","withSpan","createTransaction","OfflineTransactionAPI","action","createOptimisticAction","createOfflineAction","withNestedSpan"],"mappings":";;;;;;;;;;;;;;AAmCO,MAAM,gBAAgB;AAAA,EAsB3B,YAAY,QAAuB;AAdnC,SAAQ,gBAAgB;AACxB,SAAQ,oBAAyC;AACjD,SAAQ,wBAA6C;AAGrD,SAAQ,iDAOA,IAAA;AAGN,SAAK,SAAS;AACd,SAAK,UAAU,KAAK,cAAA;AACpB,SAAK,SAAS,IAAIA,4BAAc,KAAK,SAAS,KAAK,OAAO,WAAW;AACrE,SAAK,YAAY,IAAIC,0BAAA;AACrB,SAAK,WAAW,IAAIC,oBAAAA;AAAAA,MAClB,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,MACL;AAAA,IAAA;AAEF,SAAK,iBAAiB,KAAK,qBAAA;AAC3B,SAAK,iBAAiB,IAAIC,qCAAA;AAE1B,SAAK,oBAAA;AACL,SAAK,WAAA;AAAA,EACP;AAAA,EAEQ,gBAAgC;AACtC,QAAI,KAAK,OAAO,SAAS;AACvB,aAAO,KAAK,OAAO;AAAA,IACrB;AAEA,QAAI;AACF,aAAO,IAAIC,iBAAAA,iBAAA;AAAA,IACb,SAAS,OAAO;AACd,cAAQ;AAAA,QACN;AAAA,QACA;AAAA,MAAA;AAEF,aAAO,IAAIC,oBAAAA,oBAAA;AAAA,IACb;AAAA,EACF;AAAA,EAEQ,uBAAuC;AAC7C,QAAI,KAAK,OAAO,gBAAgB;AAC9B,aAAO,KAAK,OAAO;AAAA,IACrB;AAEA,QAAIC,eAAAA,eAAe,eAAe;AAChC,aAAO,IAAIA,eAAAA,eAAA;AAAA,IACb,WAAWC,8CAAuB,eAAe;AAC/C,aAAO,IAAIA,uBAAAA,uBAAA;AAAA,IACb,OAAO;AAEL,aAAO;AAAA,QACL,mBAAmB,MAAM,QAAQ,QAAQ,IAAI;AAAA,QAC7C,mBAAmB,MAAM;AAAA,QAAC;AAAA,QAC1B,UAAU,MAAM;AAAA,QAChB,oBAAoB,MAAM,MAAM;AAAA,QAAC;AAAA,MAAA;AAAA,IAErC;AAAA,EACF;AAAA,EAEQ,sBAA4B;AAClC,SAAK,wBAAwB,KAAK,eAAe;AAAA,MAC/C,CAAC,aAAa;AACZ,aAAK,gBAAgB;AAErB,YAAI,KAAK,OAAO,oBAAoB;AAClC,eAAK,OAAO,mBAAmB,QAAQ;AAAA,QACzC;AAEA,YAAI,UAAU;AACZ,eAAK,0BAAA;AAAA,QACP;AAAA,MACF;AAAA,IAAA;AAGF,SAAK,oBAAoB,KAAK,eAAe,UAAU,MAAM;AAC3D,UAAI,KAAK,kBAAkB;AAEzB,aAAK,SAAS,iBAAA;AACd,aAAK,SAAS,WAAA,EAAa,MAAM,CAAC,UAAU;AAC1C,kBAAQ;AAAA,YACN;AAAA,YACA;AAAA,UAAA;AAAA,QAEJ,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,aAA4B;AACxC,WAAOC,OAAAA,SAAS,uBAAuB,CAAA,GAAI,OAAO,SAAS;AACzD,UAAI;AACF,cAAM,WAAW,MAAM,KAAK,eAAe,kBAAA;AAC3C,aAAK,aAAa,YAAY,QAAQ;AAEtC,YAAI,UAAU;AACZ,gBAAM,KAAK,0BAAA;AAAA,QACb;AAAA,MACF,SAAS,OAAO;AACd,gBAAQ,KAAK,0CAA0C,KAAK;AAAA,MAC9D;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,4BAA2C;AACvD,QAAI;AACF,YAAM,KAAK,SAAS,wBAAA;AACpB,YAAM,KAAK,SAAS,WAAA;AAAA,IACtB,SAAS,OAAO;AACd,cAAQ,KAAK,2CAA2C,KAAK;AAAA,IAC/D;AAAA,EACF;AAAA,EAEA,IAAI,mBAA4B;AAC9B,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,yBACE,SACqC;AACrC,UAAM,aAAa,KAAK,OAAO,YAAY,QAAQ,cAAc;AAEjE,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,8BAA8B,QAAQ,cAAc,EAAE;AAAA,IACxE;AAGA,QAAI,CAAC,KAAK,kBAAkB;AAG1B,aAAOC,qBAAkB;AAAA,QACvB,YAAY,QAAQ,cAAc;AAAA,QAClC,YAAY,CAAC,WACX,WAAW;AAAA,UACT,GAAG;AAAA,UACH,gBAAgB,QAAQ,kBAAkB,OAAO,WAAA;AAAA,QAAW,CAC7D;AAAA,QACH,UAAU,QAAQ;AAAA,MAAA,CACnB;AAAA,IACH;AAGA,WAAO,IAAIC,mBAAAA;AAAAA,MACT;AAAA,MACA;AAAA,MACA,KAAK,mBAAmB,KAAK,IAAI;AAAA,MACjC;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,oBAAuB,SAAwC;AAC7D,UAAM,aAAa,KAAK,OAAO,YAAY,QAAQ,cAAc;AAEjE,QAAI,CAAC,YAAY;AACf,YAAM,IAAI,MAAM,8BAA8B,QAAQ,cAAc,EAAE;AAAA,IACxE;AAGA,WAAO,CAAC,cAAiB;AAEvB,UAAI,CAAC,KAAK,kBAAkB;AAE1B,cAAMC,UAASC,GAAAA,uBAAuB;AAAA,UACpC,YAAY,CAAC,MAAM,WACjB,WAAW;AAAA,YACT,GAAG;AAAA,YACH,GAAG;AAAA,YACH,gBAAgB,OAAO,WAAA;AAAA,UAAW,CACnC;AAAA,UACH,UAAU,QAAQ;AAAA,QAAA,CACnB;AACD,eAAOD,QAAO,SAAS;AAAA,MACzB;AAGA,YAAM,SAASE,cAAAA;AAAAA,QACb;AAAA,QACA;AAAA,QACA,KAAK,mBAAmB,KAAK,IAAI;AAAA,QACjC;AAAA,MAAA;AAEF,aAAO,OAAO,SAAS;AAAA,IACzB;AAAA,EACF;AAAA,EAEA,MAAc,mBACZ,aACe;AACf,WAAOC,OAAAA;AAAAA,MACL;AAAA,MACA;AAAA,QACE,kBAAkB,YAAY;AAAA,QAC9B,8BAA8B,YAAY;AAAA,MAAA;AAAA,MAE5C,OAAO,SAAS;AACd,YAAI,CAAC,KAAK,kBAAkB;AAC1B,eAAK,aAAa,UAAU,oBAAoB;AAChD,eAAK,mBAAmB,YAAY,IAAI,MAAS;AACjD;AAAA,QACF;AAEA,YAAI;AACF,gBAAM,KAAK,OAAO,IAAI,WAAW;AACjC,gBAAM,KAAK,SAAS,QAAQ,WAAW;AACvC,eAAK,aAAa,UAAU,WAAW;AAAA,QACzC,SAAS,OAAO;AACd,kBAAQ;AAAA,YACN,yCAAyC,YAAY,EAAE;AAAA,YACvD;AAAA,UAAA;AAEF,eAAK,aAAa,UAAU,QAAQ;AACpC,gBAAM;AAAA,QACR;AAAA,MACF;AAAA,IAAA;AAAA,EAEJ;AAAA;AAAA,EAGA,MAAM,6BAA6B,eAAqC;AACtE,UAAM,WAAW,KAAK,2BAA2B,IAAI,aAAa;AAClE,QAAI,UAAU;AACZ,aAAO,SAAS;AAAA,IAClB;AAEA,UAAM,WAIF,CAAA;AAEJ,aAAS,UAAU,IAAI,QAAQ,CAAC,SAAS,WAAW;AAClD,eAAS,UAAU;AACnB,eAAS,SAAS;AAAA,IACpB,CAAC;AAED,SAAK,2BAA2B,IAAI,eAAe,QAAQ;AAC3D,WAAO,SAAS;AAAA,EAClB;AAAA;AAAA,EAGA,mBAAmB,eAAuB,QAAmB;AAC3D,UAAM,WAAW,KAAK,2BAA2B,IAAI,aAAa;AAClE,QAAI,UAAU;AACZ,eAAS,QAAQ,MAAM;AACvB,WAAK,2BAA2B,OAAO,aAAa;AAAA,IACtD;AAAA,EACF;AAAA;AAAA,EAGA,kBAAkB,eAAuB,OAAoB;AAC3D,UAAM,WAAW,KAAK,2BAA2B,IAAI,aAAa;AAClE,QAAI,UAAU;AACZ,eAAS,OAAO,KAAK;AACrB,WAAK,2BAA2B,OAAO,aAAa;AAAA,IACtD;AAAA,EACF;AAAA,EAEA,MAAM,iBAAiB,IAA2B;AAChD,UAAM,KAAK,OAAO,OAAO,EAAE;AAAA,EAC7B;AAAA,EAEA,MAAM,aAAiD;AACrD,WAAO,KAAK,OAAO,OAAA;AAAA,EACrB;AAAA,EAEA,MAAM,cAA6B;AACjC,UAAM,KAAK,OAAO,MAAA;AAClB,SAAK,SAAS,MAAA;AAAA,EAChB;AAAA,EAEA,eAAqB;AACnB,SAAK,eAAe,aAAA;AAAA,EACtB;AAAA,EAEA,kBAA0B;AACxB,WAAO,KAAK,SAAS,gBAAA;AAAA,EACvB;AAAA,EAEA,kBAA0B;AACxB,WAAO,KAAK,SAAS,gBAAA;AAAA,EACvB;AAAA,EAEA,oBAA2C;AACzC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAgB;AACd,QAAI,KAAK,mBAAmB;AAC1B,WAAK,kBAAA;AACL,WAAK,oBAAoB;AAAA,IAC3B;AAEA,QAAI,KAAK,uBAAuB;AAC9B,WAAK,sBAAA;AACL,WAAK,wBAAwB;AAAA,IAC/B;AAEA,SAAK,eAAe,kBAAA;AACpB,SAAK,eAAe,QAAA;AAEpB,QAAI,aAAa,KAAK,gBAAgB;AAClC,WAAK,eAAuB,QAAA;AAAA,IAChC;AAAA,EACF;AACF;AAEO,SAAS,qBAAqB,QAAwC;AAC3E,SAAO,IAAI,gBAAgB,MAAM;AACnC;;;"}

package/dist/cjs/OfflineExecutor.d.cts

@@ -0,0 +1,39 @@
+import { DefaultOnlineDetector } from './connectivity/OnlineDetector.cjs';
+import { OfflineTransaction as OfflineTransactionAPI } from './api/OfflineTransaction.cjs';
+import { CreateOfflineActionOptions, CreateOfflineTransactionOptions, OfflineConfig, OfflineTransaction } from './types.cjs';
+import { Transaction } from '@tanstack/db';
+export declare class OfflineExecutor {
+    private config;
+    private storage;
+    private outbox;
+    private scheduler;
+    private executor;
+    private leaderElection;
+    private onlineDetector;
+    private isLeaderState;
+    private unsubscribeOnline;
+    private unsubscribeLeadership;
+    private pendingTransactionPromises;
+    constructor(config: OfflineConfig);
+    private createStorage;
+    private createLeaderElection;
+    private setupEventListeners;
+    private initialize;
+    private loadAndReplayTransactions;
+    get isOfflineEnabled(): boolean;
+    createOfflineTransaction(options: CreateOfflineTransactionOptions): Transaction | OfflineTransactionAPI;
+    createOfflineAction<T>(options: CreateOfflineActionOptions<T>): (variables: T) => Transaction<Record<string, unknown>>;
+    private persistTransaction;
+    waitForTransactionCompletion(transactionId: string): Promise<any>;
+    resolveTransaction(transactionId: string, result: any): void;
+    rejectTransaction(transactionId: string, error: Error): void;
+    removeFromOutbox(id: string): Promise<void>;
+    peekOutbox(): Promise<Array<OfflineTransaction>>;
+    clearOutbox(): Promise<void>;
+    notifyOnline(): void;
+    getPendingCount(): number;
+    getRunningCount(): number;
+    getOnlineDetector(): DefaultOnlineDetector;
+    dispose(): void;
+}
+export declare function startOfflineExecutor(config: OfflineConfig): OfflineExecutor;

package/dist/cjs/api/OfflineAction.cjs

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api = require("@opentelemetry/api");
+const OfflineTransaction = require("./OfflineTransaction.cjs");
+function createOfflineAction(options, mutationFn, persistTransaction, executor) {
+  const { mutationFnName, onMutate } = options;
+  console.log(`createOfflineAction 2`, options);
+  return (variables) => {
+    const offlineTransaction = new OfflineTransaction.OfflineTransaction(
+      {
+        mutationFnName,
+        autoCommit: false
+      },
+      mutationFn,
+      persistTransaction,
+      executor
+    );
+    const transaction = offlineTransaction.mutate(() => {
+      console.log(`mutate`);
+      onMutate(variables);
+    });
+    const tracer = api.trace.getTracer(`@tanstack/offline-transactions`, `0.0.1`);
+    const span = tracer.startSpan(`offlineAction.${mutationFnName}`);
+    const ctx = api.trace.setSpan(api.context.active(), span);
+    console.log(`starting offlineAction span`, { tracer, span, ctx });
+    const commitPromise = api.context.with(ctx, () => {
+      return (async () => {
+        try {
+          await transaction.commit();
+          span.setStatus({ code: api.SpanStatusCode.OK });
+          span.end();
+          console.log(`ended offlineAction span - success`);
+        } catch (error) {
+          span.recordException(error);
+          span.setStatus({ code: api.SpanStatusCode.ERROR });
+          span.end();
+          console.log(`ended offlineAction span - error`);
+        }
+      })();
+    });
+    commitPromise.catch(() => {
+    });
+    return transaction;
+  };
+}
+exports.createOfflineAction = createOfflineAction;
+//# sourceMappingURL=OfflineAction.cjs.map

package/dist/cjs/api/OfflineAction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"OfflineAction.cjs","sources":["../../../src/api/OfflineAction.ts"],"sourcesContent":["import { SpanStatusCode, context, trace } from \"@opentelemetry/api\"\nimport { OfflineTransaction } from \"./OfflineTransaction\"\nimport type { Transaction } from \"@tanstack/db\"\nimport type {\n  CreateOfflineActionOptions,\n  OfflineMutationFn,\n  OfflineTransaction as OfflineTransactionType,\n} from \"../types\"\n\nexport function createOfflineAction<T>(\n  options: CreateOfflineActionOptions<T>,\n  mutationFn: OfflineMutationFn,\n  persistTransaction: (tx: OfflineTransactionType) => Promise<void>,\n  executor: any\n): (variables: T) => Transaction {\n  const { mutationFnName, onMutate } = options\n  console.log(`createOfflineAction 2`, options)\n\n  return (variables: T): Transaction => {\n    const offlineTransaction = new OfflineTransaction(\n      {\n        mutationFnName,\n        autoCommit: false,\n      },\n      mutationFn,\n      persistTransaction,\n      executor\n    )\n\n    const transaction = offlineTransaction.mutate(() => {\n      console.log(`mutate`)\n      onMutate(variables)\n    })\n\n    // Immediately commit with span instrumentation\n    const tracer = trace.getTracer(`@tanstack/offline-transactions`, `0.0.1`)\n    const span = tracer.startSpan(`offlineAction.${mutationFnName}`)\n    const ctx = trace.setSpan(context.active(), span)\n    console.log(`starting offlineAction span`, { tracer, span, ctx })\n\n    // Execute the commit within the span context\n    // The key is to return the promise synchronously from context.with() so context binds to it\n    const commitPromise = context.with(ctx, () => {\n      // Return the promise synchronously - this is critical for context propagation in browsers\n      return (async () => {\n        try {\n          await transaction.commit()\n          span.setStatus({ code: SpanStatusCode.OK })\n          span.end()\n          console.log(`ended offlineAction span - success`)\n        } catch (error) {\n          span.recordException(error as Error)\n          span.setStatus({ code: SpanStatusCode.ERROR })\n          span.end()\n          console.log(`ended offlineAction span - error`)\n        }\n      })()\n    })\n\n    // Don't await - this is fire-and-forget for optimistic actions\n    // But catch to prevent unhandled rejection\n    commitPromise.catch(() => {\n      // Already handled in try/catch above\n    })\n\n    return transaction\n  }\n}\n"],"names":["OfflineTransaction","trace","context","SpanStatusCode"],"mappings":";;;;AASO,SAAS,oBACd,SACA,YACA,oBACA,UAC+B;AAC/B,QAAM,EAAE,gBAAgB,SAAA,IAAa;AACrC,UAAQ,IAAI,yBAAyB,OAAO;AAE5C,SAAO,CAAC,cAA8B;AACpC,UAAM,qBAAqB,IAAIA,mBAAAA;AAAAA,MAC7B;AAAA,QACE;AAAA,QACA,YAAY;AAAA,MAAA;AAAA,MAEd;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAGF,UAAM,cAAc,mBAAmB,OAAO,MAAM;AAClD,cAAQ,IAAI,QAAQ;AACpB,eAAS,SAAS;AAAA,IACpB,CAAC;AAGD,UAAM,SAASC,IAAAA,MAAM,UAAU,kCAAkC,OAAO;AACxE,UAAM,OAAO,OAAO,UAAU,iBAAiB,cAAc,EAAE;AAC/D,UAAM,MAAMA,IAAAA,MAAM,QAAQC,IAAAA,QAAQ,OAAA,GAAU,IAAI;AAChD,YAAQ,IAAI,+BAA+B,EAAE,QAAQ,MAAM,KAAK;AAIhE,UAAM,gBAAgBA,IAAAA,QAAQ,KAAK,KAAK,MAAM;AAE5C,cAAQ,YAAY;AAClB,YAAI;AACF,gBAAM,YAAY,OAAA;AAClB,eAAK,UAAU,EAAE,MAAMC,IAAAA,eAAe,IAAI;AAC1C,eAAK,IAAA;AACL,kBAAQ,IAAI,oCAAoC;AAAA,QAClD,SAAS,OAAO;AACd,eAAK,gBAAgB,KAAc;AACnC,eAAK,UAAU,EAAE,MAAMA,IAAAA,eAAe,OAAO;AAC7C,eAAK,IAAA;AACL,kBAAQ,IAAI,kCAAkC;AAAA,QAChD;AAAA,MACF,GAAA;AAAA,IACF,CAAC;AAID,kBAAc,MAAM,MAAM;AAAA,IAE1B,CAAC;AAED,WAAO;AAAA,EACT;AACF;;"}

package/dist/cjs/api/OfflineAction.d.cts

@@ -0,0 +1,3 @@
+import { Transaction } from '@tanstack/db';
+import { CreateOfflineActionOptions, OfflineMutationFn, OfflineTransaction as OfflineTransactionType } from '../types.cjs';
+export declare function createOfflineAction<T>(options: CreateOfflineActionOptions<T>, mutationFn: OfflineMutationFn, persistTransaction: (tx: OfflineTransactionType) => Promise<void>, executor: any): (variables: T) => Transaction;