@stamprally/core 0.14.0 → 0.15.0

package/README.md

@@ -1,4 +1,4 @@
-# @stamprally/core
+# @stamprally/core v0.15.0
 
 Dependency-free domain models, immutable state transitions, storage adapters, browser detectors, and safe configuration parsers.
 
@@ -7,7 +7,7 @@ import { InMemoryStorage, StampRallyClient, type PublicRallyConfig } from "@stam
 
 const config: PublicRallyConfig = {
   id: "city-tour",
-  version: "0.9.1",
+  version: "0.15.0",
   title: "City Tour",
   spots: [{ id: "station", orderIndex: 0, name: "Central Station", conditions: [{ type: "passcode" }] }],
   rewards: [],
@@ -23,7 +23,7 @@ The browser detectors `getCurrentGeoContext`, `readNfcContext`, and `readQrConte
 
 `InMemoryStorage`, `LocalStorageAdapter`, and `IndexedDBAdapter` implement `StampStorage`. `updateLocalizedField` updates one locale without dropping existing translations.
 
-## v0.13 offline synchronization
+## v0.15.0 offline synchronization
 
 Configure `OfflineQueue` with `rallyId` and `userId` to persist pending work under
 `stamprally:queue:<rallyId>:<userId-or-anonymous>`. `switchUser` loads the other
@@ -32,6 +32,10 @@ timestamps, and gives `CONSUMED` reward states priority; `server_wins` uses the
 server state unchanged. Sync adapters may return `ACCEPTED`, `REJECTED_PERMANENT`,
 or `RETRYABLE_ERROR`; only the first two remove an operation.
 
+When no authenticated user is supplied, the client creates a persistent UUID v4
+`anonymousSessionId` and includes it in sync requests. Queue replay uses Web Locks
+when available and supports bounded exponential backoff through `retryOptions`.
+
 `evaluateSpotStatus` derives `UNCLAIMED`, `CLAIMED`, `LOCKED`, or `VERIFYING`
 without mutating state. A spot with incomplete `prerequisites` is `LOCKED` and
 must not be verified by a client or viewer.

package/dist/index.cjs

@@ -617,7 +617,13 @@ function cloneState(state) {
   return {
     ...state,
     records: state.records.map(cloneRecord),
-    ...state.rewards === void 0 ? {} : { rewards: state.rewards.map(cloneRewardState) }
+    ...state.rewards === void 0 ? {} : { rewards: state.rewards.map(cloneRewardState) },
+    ...state.inventory === void 0 ? {} : {
+      inventory: {
+        ...state.inventory,
+        ...state.inventory.rewardRemaining === void 0 ? {} : { rewardRemaining: { ...state.inventory.rewardRemaining } }
+      }
+    }
   };
 }
 function isRecord(value) {
@@ -637,7 +643,7 @@ function isRewardState(value) {
 function isStampRallyState(value) {
   if (typeof value !== "object" || value === null) return false;
   const state = value;
-  return typeof state.rallyId === "string" && (typeof state.userId === "string" || state.userId === null) && typeof state.updatedAt === "string" && Array.isArray(state.records) && state.records.every(isRecord) && (state.rewards === void 0 || Array.isArray(state.rewards) && state.rewards.every(isRewardState));
+  return typeof state.rallyId === "string" && (typeof state.userId === "string" || state.userId === null) && typeof state.updatedAt === "string" && Array.isArray(state.records) && state.records.every(isRecord) && (state.rewards === void 0 || Array.isArray(state.rewards) && state.rewards.every(isRewardState)) && (state.inventory === void 0 || typeof state.inventory === "object" && state.inventory !== null && !Array.isArray(state.inventory) && (state.inventory.sharedRemaining === void 0 || typeof state.inventory.sharedRemaining === "number" && Number.isInteger(state.inventory.sharedRemaining) && state.inventory.sharedRemaining >= 0) && (state.inventory.rewardRemaining === void 0 || typeof state.inventory.rewardRemaining === "object" && state.inventory.rewardRemaining !== null && !Array.isArray(state.inventory.rewardRemaining)));
 }
 function isValidDate(value) {
   return typeof value === "string" && !Number.isNaN(Date.parse(value));
@@ -682,6 +688,35 @@ var InMemoryStorage = class {
 function storageKey(rallyId, userId) {
   return `stamprally:${rallyId}:${userId ?? "anonymous"}`;
 }
+function createAnonymousSessionId(storage) {
+  const key = "stamprally:anonymous-session-id";
+  try {
+    const browserStorage = typeof window === "undefined" ? null : window.localStorage;
+    const value = storage?.getItem(key) ?? browserStorage?.getItem(key);
+    if (value !== null && value !== void 0 && isUuidV4(value)) return value;
+    const generated = randomUuidV4();
+    (storage ?? browserStorage)?.setItem(key, generated);
+    return generated;
+  } catch {
+    return randomUuidV4();
+  }
+}
+function isUuidV4(value) {
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value);
+}
+function randomUuidV4() {
+  const cryptoApi3 = globalThis.crypto;
+  if (cryptoApi3?.randomUUID !== void 0) return cryptoApi3.randomUUID();
+  if (cryptoApi3?.getRandomValues !== void 0) {
+    const bytes2 = cryptoApi3.getRandomValues(new Uint8Array(16));
+    bytes2[6] = (bytes2[6] ?? 0) & 15 | 64;
+    bytes2[8] = (bytes2[8] ?? 0) & 63 | 128;
+    const hex = Array.from(bytes2, (byte) => byte.toString(16).padStart(2, "0")).join("");
+    return `${hex.slice(0, 8)}-${hex.slice(8, 12)}-${hex.slice(12, 16)}-${hex.slice(16, 20)}-${hex.slice(20)}`;
+  }
+  const random = `${Date.now().toString(16)}${Math.random().toString(16).slice(2)}`.padEnd(32, "0").slice(0, 32);
+  return `${random.slice(0, 8)}-${random.slice(8, 12)}-4${random.slice(13, 16)}-8${random.slice(17, 20)}-${random.slice(20)}`;
+}
 var defaultStorageWarningHandler = (error) => {
   console.warn(`[@stamprally/core] ${error.message}`, error);
 };
@@ -1071,6 +1106,7 @@ var StampRallyClient = class {
   #config;
   #offlineQueue;
   #userId;
+  #anonymousSessionId;
   #state = null;
   #initialization = null;
   #queue = Promise.resolve();
@@ -1078,7 +1114,8 @@ var StampRallyClient = class {
     this.#config = config;
     this.#options = isStorage(storageOrOptions) ? { storage: storageOrOptions } : storageOrOptions;
     this.#storage = this.#options.storage ?? new InMemoryStorage();
-    this.#userId = this.#options.userId ?? null;
+    this.#anonymousSessionId = this.#options.anonymousSessionId ?? createAnonymousSessionId();
+    this.#userId = this.#options.userId ?? this.#anonymousSessionId;
     this.#offlineQueue = this.#options.offlineQueue;
     this.#offlineQueue?.setSyncResultListener((event) => this.#handleOfflineSyncResult(event));
   }
@@ -1091,6 +1128,9 @@ var StampRallyClient = class {
   getUserId() {
     return this.#userId;
   }
+  getAnonymousSessionId() {
+    return this.#anonymousSessionId;
+  }
   get syncState() {
     return this.#offlineQueue?.syncState ?? "idle";
   }
@@ -1128,11 +1168,12 @@ var StampRallyClient = class {
   }
   switchUser(newUserId) {
     return this.#enqueue(async () => {
-      if (this.#userId === newUserId && this.#state !== null) return this.#state;
-      this.#userId = newUserId;
+      const nextUserId = newUserId ?? this.#anonymousSessionId;
+      if (this.#userId === nextUserId && this.#state !== null) return this.#state;
+      this.#userId = nextUserId;
       this.#state = null;
       this.#initialization = null;
-      await this.#offlineQueue?.switchUser(newUserId);
+      await this.#offlineQueue?.switchUser(nextUserId);
       return this.initialize();
     });
   }
@@ -1200,7 +1241,8 @@ var StampRallyClient = class {
         proofData,
         idempotencyKey: options.idempotencyKey ?? id("check-in"),
         now,
-        state: current
+        state: current,
+        ...this.#userId === this.#anonymousSessionId ? { anonymousSessionId: this.#anonymousSessionId } : {}
       };
       const remote = this.#options.syncAdapter?.checkIn;
       if (options.sync !== false && remote !== void 0) {
@@ -1256,7 +1298,8 @@ var StampRallyClient = class {
         idempotencyKey: options.idempotencyKey ?? id("claim"),
         now,
         options,
-        state: current
+        state: current,
+        ...this.#userId === this.#anonymousSessionId ? { anonymousSessionId: this.#anonymousSessionId } : {}
       };
       const remote = this.#options.syncAdapter?.claimReward;
       if (options.sync !== false && remote !== void 0) {
@@ -1308,13 +1351,10 @@ var StampRallyClient = class {
       const serverState = await adapter.sync({
         rallyId: this.#config.id,
         userId: this.#userId,
-        state: this.#state ?? current
-      });
-      const localState = this.#state ?? current;
-      const merged = this.#offlineQueue === void 0 ? serverState : resolveRallyStateConflict(serverState, localState, {
-        policy: this.#offlineQueue.conflictPolicy
+        state: this.#state ?? current,
+        ...this.#userId === this.#anonymousSessionId ? { anonymousSessionId: this.#anonymousSessionId } : {}
       });
-      const next = this.#reconcile(merged);
+      const next = this.#reconcile(serverState);
       await this.#storage.save(next);
       this.#state = next;
       this.#emit(next);
@@ -1528,6 +1568,11 @@ function errorValue(value, fallbackCode) {
 }
 var syncLocks = /* @__PURE__ */ new Map();
 var SYNC_LOCK_TTL_MS = 3e4;
+var DEFAULT_RETRY_OPTIONS = {
+  maxRetries: 0,
+  initialIntervalMs: 250,
+  backoffMultiplier: 2
+};
 function randomId() {
   return globalThis.crypto?.randomUUID?.() ?? `${Date.now()}-${Math.random().toString(36).slice(2)}`;
 }
@@ -1546,6 +1591,7 @@ var OfflineQueue = class {
   #syncPromise = null;
   #syncResultListener;
   #synchronizeInstances;
+  #retryOptions;
   #instanceId = randomId();
   #lockStorage;
   #storageListener;
@@ -1561,6 +1607,15 @@ var OfflineQueue = class {
     this.#conflictPolicy = options.conflictPolicy ?? "server_wins";
     this.#onSyncConflict = options.onSyncConflict;
     this.#synchronizeInstances = options.synchronizeInstances ?? true;
+    const retryOptions = {
+      ...DEFAULT_RETRY_OPTIONS,
+      ...options.retryOptions ?? options.syncRetryOptions ?? options.retry ?? {}
+    };
+    this.#retryOptions = {
+      maxRetries: Math.max(0, Math.floor(retryOptions.maxRetries)),
+      initialIntervalMs: Math.max(0, retryOptions.initialIntervalMs),
+      backoffMultiplier: Math.max(1, retryOptions.backoffMultiplier)
+    };
     this.#lockStorage = options.storageLike ?? globalThis.localStorage ?? null;
     if (this.#synchronizeInstances) this.#subscribeToExternalChanges();
   }
@@ -1593,7 +1648,7 @@ var OfflineQueue = class {
   }
   async initialize() {
     if (this.#loaded) return;
-    this.#operations = [...await this.#storage.load(this.#storageKey())];
+    this.#operations = (await this.#storage.load(this.#storageKey())).map(normalizeOperation);
     this.#loaded = true;
   }
   /** Releases browser listeners when the queue is no longer used. */
@@ -1638,7 +1693,7 @@ var OfflineQueue = class {
     await this.initialize();
     const id2 = operationId(operation);
     if (this.#operations.some((item) => operationId(item) === id2)) return;
-    this.#operations = [...this.#operations, operation];
+    this.#operations = [...this.#operations, { ...operation, status: "PENDING", attempts: 0 }];
     await this.#storage.save(this.#storageKey(), this.#operations);
     this.#announceChange();
   }
@@ -1668,6 +1723,33 @@ var OfflineQueue = class {
     return this.sync(sender);
   }
   async #run(sender) {
+    const locks = globalThis.navigator?.locks;
+    if (locks !== void 0) {
+      let callbackStarted = false;
+      try {
+        const acquired = await locks.request(
+          `stamprally:${this.#storageKey()}:sync`,
+          { ifAvailable: true },
+          async (lock) => {
+            if (lock === null) {
+              await this.#reloadFromStorage();
+              this.#state = "idle";
+              return false;
+            }
+            callbackStarted = true;
+            await this.#runWithStorageLock(sender);
+            return true;
+          }
+        );
+        if (!acquired) return;
+        return;
+      } catch (error) {
+        if (callbackStarted) throw error;
+      }
+    }
+    await this.#runWithStorageLock(sender);
+  }
+  async #runWithStorageLock(sender) {
     this.#state = "syncing";
     this.#error = null;
     if (!this.#acquireSyncLock()) {
@@ -1679,21 +1761,36 @@ var OfflineQueue = class {
       while (this.#operations.length > 0) {
         const operation = this.#operations[0];
         if (operation === void 0) break;
-        let rawResult;
-        try {
-          rawResult = await sender(operation);
-        } catch (cause) {
-          throw new Error(errorValue(cause, "RETRYABLE_ERROR").message);
-        }
-        const response = this.#normalizeResponse(rawResult);
-        if (response.status === "RETRYABLE_ERROR") {
+        let attempt = 0;
+        let response;
+        while (true) {
+          await this.#updateOperationStatus("IN_FLIGHT", attempt);
+          try {
+            response = this.#normalizeResponse(await sender(operation));
+          } catch (cause) {
+            response = {
+              status: "RETRYABLE_ERROR",
+              error: errorValue(cause, "RETRYABLE_ERROR")
+            };
+          }
+          if (response.status !== "RETRYABLE_ERROR") break;
           const error2 = errorValue(response.error ?? response.reason, "RETRYABLE_ERROR");
+          await this.#updateOperationStatus("PENDING", attempt + 1);
           await this.#syncResultListener?.({ operation, status: response.status, error: error2 });
-          throw new Error(error2.message);
+          if (attempt >= this.#retryOptions.maxRetries) throw new Error(error2.message);
+          const interval = this.#retryOptions.initialIntervalMs * this.#retryOptions.backoffMultiplier ** attempt;
+          await new Promise((resolve) => setTimeout(resolve, Math.max(0, interval)));
+          attempt += 1;
         }
         const result = response.result;
         const state = response.state ?? (result !== void 0 && "conflict" in result && result.conflict === true ? await this.resolveConflict(operation, result.localState, result.serverState) : result !== void 0 && "ok" in result && result.ok ? result.value.state : void 0);
         const error = response.status === "REJECTED_PERMANENT" ? errorValue(response.error ?? response.reason, "REJECTED_PERMANENT") : void 0;
+        await this.#updateOperationStatus(
+          response.status === "ACCEPTED" ? "ACCEPTED" : "REJECTED",
+          attempt + 1
+        );
+        const fallbackState = response.status === "REJECTED_PERMANENT" ? operation.request.state : void 0;
+        const eventState = state ?? fallbackState;
         this.#operations = this.#operations.slice(1);
         await this.#storage.save(this.#storageKey(), this.#operations);
         this.#announceChange();
@@ -1702,7 +1799,7 @@ var OfflineQueue = class {
           ...result === void 0 ? {} : { result },
           status: response.status,
           ...error === void 0 ? {} : { error },
-          ...state === void 0 ? {} : { state }
+          ...eventState === void 0 ? {} : { state: eventState }
         });
       }
       this.#state = "idle";
@@ -1714,6 +1811,13 @@ var OfflineQueue = class {
       this.#releaseSyncLock();
     }
   }
+  async #updateOperationStatus(status, attempts) {
+    const operation = this.#operations[0];
+    if (operation === void 0) return;
+    this.#operations = [{ ...operation, status, attempts }, ...this.#operations.slice(1)];
+    await this.#storage.save(this.#storageKey(), this.#operations);
+    this.#announceChange();
+  }
   #subscribeToExternalChanges() {
     const windowLike = globalThis.window;
     if (windowLike !== void 0) {
@@ -1741,7 +1845,7 @@ var OfflineQueue = class {
   async #reloadFromStorage() {
     if (this.#state === "syncing") return;
     try {
-      this.#operations = [...await this.#storage.load(this.#storageKey())];
+      this.#operations = (await this.#storage.load(this.#storageKey())).map(normalizeOperation);
       this.#loaded = true;
     } catch {
     }
@@ -1811,6 +1915,13 @@ var OfflineQueue = class {
     return resolveRallyStateConflict(serverState, localState, { policy });
   }
 };
+function normalizeOperation(operation) {
+  return {
+    ...operation,
+    status: operation.status === "IN_FLIGHT" ? "PENDING" : operation.status ?? "PENDING",
+    attempts: operation.attempts ?? 0
+  };
+}
 
 // src/crypto/token.ts
 var encoder = new TextEncoder();
@@ -2379,6 +2490,8 @@ function condition(value, path, errors, isPublic) {
     finiteNumber(value, "latitude", path, errors);
     finiteNumber(value, "longitude", path, errors);
     finiteNumber(value, "radiusMeters", path, errors, 0);
+    if (typeof value.radiusMeters === "number" && value.radiusMeters <= 0)
+      add(errors, `${path}.radiusMeters`, "Expected a radius greater than 0.", "out_of_range");
     if (typeof value.latitude === "number" && (value.latitude < -90 || value.latitude > 90))
       add(errors, `${path}.latitude`, "Expected a latitude between -90 and 90.", "out_of_range");
     if (typeof value.longitude === "number" && (value.longitude < -180 || value.longitude > 180))
@@ -2804,6 +2917,7 @@ exports.assertPublicConfig = assertPublicConfig;
 exports.calculateDistanceMeters = calculateDistanceMeters;
 exports.calculateProgress = calculateProgress;
 exports.consumeReward = consumeReward;
+exports.createAnonymousSessionId = createAnonymousSessionId;
 exports.createClaimTicketNumber = createClaimTicketNumber;
 exports.createSecureToken = createSecureToken;
 exports.createSignedSnapshotToken = createSignedSnapshotToken;