@tanstack/offline-transactions 0.0.0 → 0.1.0

package/src/storage/LocalStorageAdapter.ts

@@ -8,6 +8,44 @@ export class LocalStorageAdapter extends BaseStorageAdapter {
     this.prefix = prefix
   }
 
+  /**
+   * Probe localStorage availability by attempting a test write.
+   * This catches private mode and other restrictions that block localStorage.
+   */
+  static probe(): { available: boolean; error?: Error } {
+    // Check if localStorage exists
+    if (typeof localStorage === `undefined`) {
+      return {
+        available: false,
+        error: new Error(`localStorage is not available in this environment`),
+      }
+    }
+
+    // Try to actually write/read/delete to verify it works
+    try {
+      const testKey = `__offline-tx-probe__`
+      const testValue = `test`
+
+      localStorage.setItem(testKey, testValue)
+      const retrieved = localStorage.getItem(testKey)
+      localStorage.removeItem(testKey)
+
+      if (retrieved !== testValue) {
+        return {
+          available: false,
+          error: new Error(`localStorage read/write verification failed`),
+        }
+      }
+
+      return { available: true }
+    } catch (error) {
+      return {
+        available: false,
+        error: error instanceof Error ? error : new Error(String(error)),
+      }
+    }
+  }
+
   private getKey(key: string): string {
     return `${this.prefix}${key}`
   }

package/src/telemetry/tracer.ts

@@ -1,12 +1,7 @@
-import {
-  trace,
-  type Span,
-  SpanStatusCode,
-  context,
-  type SpanContext,
-} from "@opentelemetry/api"
-
-const TRACER = trace.getTracer("@tanstack/offline-transactions", "0.0.1")
+import { SpanStatusCode, context, trace } from "@opentelemetry/api"
+import type { Span, SpanContext } from "@opentelemetry/api"
+
+const TRACER = trace.getTracer(`@tanstack/offline-transactions`, `0.0.1`)
 
 export interface SpanAttrs {
   [key: string]: string | number | boolean | undefined

package/src/types.ts

@@ -69,6 +69,24 @@ export interface SerializedOfflineTransaction {
   version: 1
 }
 
+// Storage diagnostics and mode
+export type OfflineMode = `offline` | `online-only`
+
+export type StorageDiagnosticCode =
+  | `STORAGE_AVAILABLE`
+  | `INDEXEDDB_UNAVAILABLE`
+  | `LOCALSTORAGE_UNAVAILABLE`
+  | `STORAGE_BLOCKED`
+  | `QUOTA_EXCEEDED`
+  | `UNKNOWN_ERROR`
+
+export interface StorageDiagnostic {
+  code: StorageDiagnosticCode
+  mode: OfflineMode
+  message: string
+  error?: Error
+}
+
 export interface OfflineConfig {
   collections: Record<string, Collection>
   mutationFns: Record<string, OfflineMutationFn>
@@ -80,11 +98,8 @@ export interface OfflineConfig {
   ) => Array<OfflineTransaction>
   onUnknownMutationFn?: (name: string, tx: OfflineTransaction) => void
   onLeadershipChange?: (isLeader: boolean) => void
+  onStorageFailure?: (diagnostic: StorageDiagnostic) => void
   leaderElection?: LeaderElection
-  otel?: {
-    endpoint: string
-    headers?: Record<string, string>
-  }
 }
 
 export interface StorageAdapter {