@stamprally/core 0.11.0 → 0.13.0

package/README.md

@@ -23,6 +23,19 @@ 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
+
+Configure `OfflineQueue` with `rallyId` and `userId` to persist pending work under
+`stamprally:queue:<rallyId>:<userId-or-anonymous>`. `switchUser` loads the other
+user's queue. Conflict policy `merge` unions stamp records, keeps the latest
+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.
+
+`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.
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -41,6 +41,14 @@ function evaluateConditionDetailed(condition2, context) {
 function evaluateCondition(condition2, context) {
   return evaluateConditionDetailed(condition2, context).ok;
 }
+function evaluateSpotStatus(spot2, state, options = {}) {
+  if (options.verifying === true) return "VERIFYING";
+  if (state.records.some((record) => record.stampId === spot2.id)) return "CLAIMED";
+  const acquired = new Set(state.records.map((record) => record.stampId));
+  if (spot2.prerequisites?.some((prerequisite) => !acquired.has(prerequisite))) return "LOCKED";
+  return "UNCLAIMED";
+}
+var getSpotStatus = evaluateSpotStatus;
 
 // src/engine/order.ts
 function getOrderedSpots(spots) {
@@ -99,6 +107,76 @@ function issueClaimTicketNumber(reward2, currentState, options = {}) {
   return { ...currentState, claimTicketNumber };
 }
 
+// src/engine/sync.ts
+function latestTimestamp(serverTimestamp, localTimestamp) {
+  const serverTime = Date.parse(serverTimestamp);
+  const localTime = Date.parse(localTimestamp);
+  if (!Number.isNaN(serverTime) && !Number.isNaN(localTime))
+    return serverTime >= localTime ? serverTimestamp : localTimestamp;
+  if (!Number.isNaN(serverTime)) return serverTimestamp;
+  if (!Number.isNaN(localTime)) return localTimestamp;
+  return serverTimestamp >= localTimestamp ? serverTimestamp : localTimestamp;
+}
+function mergeRewardStates(serverRewards, localRewards) {
+  const merged = new Map(serverRewards.map((reward2) => [reward2.rewardId, reward2]));
+  for (const localReward of localRewards) {
+    const serverReward = merged.get(localReward.rewardId);
+    if (serverReward === void 0) {
+      merged.set(localReward.rewardId, localReward);
+      continue;
+    }
+    const winner = localReward.status === "CONSUMED" && serverReward.status !== "CONSUMED" ? localReward : serverReward;
+    merged.set(localReward.rewardId, {
+      ...winner,
+      ...serverReward.unlockedAt === void 0 && localReward.unlockedAt === void 0 ? {} : {
+        unlockedAt: serverReward.unlockedAt === void 0 ? localReward.unlockedAt : localReward.unlockedAt === void 0 ? serverReward.unlockedAt : latestTimestamp(serverReward.unlockedAt, localReward.unlockedAt)
+      },
+      ...serverReward.consumedAt === void 0 && localReward.consumedAt === void 0 ? {} : {
+        consumedAt: serverReward.consumedAt === void 0 ? localReward.consumedAt : localReward.consumedAt === void 0 ? serverReward.consumedAt : latestTimestamp(serverReward.consumedAt, localReward.consumedAt)
+      },
+      ...serverReward.redeemedCount === void 0 && localReward.redeemedCount === void 0 ? {} : {
+        redeemedCount: Math.max(
+          serverReward.redeemedCount ?? 0,
+          localReward.redeemedCount ?? 0
+        )
+      },
+      ...serverReward.userRedemptionCount === void 0 && localReward.userRedemptionCount === void 0 ? {} : {
+        userRedemptionCount: Math.max(
+          serverReward.userRedemptionCount ?? 0,
+          localReward.userRedemptionCount ?? 0
+        )
+      }
+    });
+  }
+  return [...merged.values()];
+}
+function mergeStampRecords(serverRecords, localRecords) {
+  const merged = /* @__PURE__ */ new Map();
+  for (const record of [...serverRecords, ...localRecords]) {
+    const current = merged.get(record.stampId);
+    if (current === void 0) {
+      merged.set(record.stampId, record);
+      continue;
+    }
+    const acquiredAt = latestTimestamp(current.acquiredAt, record.acquiredAt);
+    merged.set(record.stampId, {
+      ...current,
+      ...acquiredAt === current.acquiredAt ? {} : { acquiredAt },
+      ...current.metadata === void 0 && record.metadata !== void 0 ? { metadata: record.metadata } : {}
+    });
+  }
+  return [...merged.values()];
+}
+function resolveRallyStateConflict(serverState, localState, options = { policy: "merge" }) {
+  if (options.policy === "server_wins") return serverState;
+  return {
+    ...serverState,
+    records: mergeStampRecords(serverState.records, localState.records),
+    rewards: mergeRewardStates(serverState.rewards, localState.rewards),
+    updatedAt: latestTimestamp(serverState.updatedAt, localState.updatedAt)
+  };
+}
+
 // src/detectors/types.ts
 function createDetectorError(detector, code, message, cause) {
   return cause === void 0 ? { detector, code, message } : { detector, code, message, cause };
@@ -1000,6 +1078,7 @@ var StampRallyClient = class {
     this.#storage = this.#options.storage ?? new InMemoryStorage();
     this.#userId = this.#options.userId ?? null;
     this.#offlineQueue = this.#options.offlineQueue;
+    this.#offlineQueue?.setSyncResultListener((event) => this.#handleOfflineSyncResult(event));
   }
   getConfig() {
     return this.#config;
@@ -1030,7 +1109,10 @@ var StampRallyClient = class {
   initialize() {
     if (this.#state !== null) return Promise.resolve(this.#state);
     if (this.#initialization === null) {
-      this.#initialization = this.#storage.load(this.#config.id, this.#userId).then((state) => {
+      this.#initialization = (async () => {
+        await this.#offlineQueue?.setScope(this.#config.id, this.#userId);
+        return this.#storage.load(this.#config.id, this.#userId);
+      })().then((state) => {
         const next = state === null ? emptyState(this.#config, this.#userId, this.#now()) : this.#reconcile(state);
         this.#state = next;
         this.#emit(next);
@@ -1048,6 +1130,7 @@ var StampRallyClient = class {
       this.#userId = newUserId;
       this.#state = null;
       this.#initialization = null;
+      await this.#offlineQueue?.switchUser(newUserId);
       return this.initialize();
     });
   }
@@ -1217,12 +1300,19 @@ var StampRallyClient = class {
         });
       }
       if (adapter?.sync === void 0) {
-        this.#emitEvent({ type: "sync", state: current });
+        this.#emitEvent({ type: "sync", state: this.#state ?? current });
         return;
       }
-      const next = this.#reconcile(
-        await adapter.sync({ rallyId: this.#config.id, userId: this.#userId, state: current })
-      );
+      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
+      });
+      const next = this.#reconcile(merged);
       await this.#storage.save(next);
       this.#state = next;
       this.#emit(next);
@@ -1282,6 +1372,17 @@ var StampRallyClient = class {
       )
     };
   }
+  async #handleOfflineSyncResult(event) {
+    if (event.state !== void 0) {
+      const next = this.#reconcile(event.state);
+      await this.#storage.save(next);
+      this.#state = next;
+      this.#emit(next);
+    }
+    if (event.error !== void 0) this.#emitEvent({ type: "error", error: event.error });
+    else if (event.result !== void 0 && "ok" in event.result && !event.result.ok)
+      this.#emitEvent({ type: "error", error: event.result.error });
+  }
   #now() {
     return this.#options.clock?.() ?? (/* @__PURE__ */ new Date()).toISOString();
   }
@@ -1407,9 +1508,27 @@ function defaultStorage(databaseName) {
 function operationId(operation) {
   return operation.kind === "checkIn" ? `checkIn:${operation.request.rallyId}:${operation.request.userId ?? "anonymous"}:${operation.request.idempotencyKey}` : `claimReward:${operation.request.rallyId}:${operation.request.userId ?? "anonymous"}:${operation.request.idempotencyKey}`;
 }
+function requestScope(operation) {
+  return {
+    rallyId: operation.request.rallyId,
+    userId: operation.request.userId
+  };
+}
+function errorValue(value, fallbackCode) {
+  if (typeof value === "object" && value !== null) {
+    const candidate = value;
+    if (typeof candidate.code === "string" && typeof candidate.message === "string")
+      return { ...candidate, code: candidate.code, message: candidate.message };
+  }
+  if (value instanceof Error) return { code: fallbackCode, message: value.message };
+  if (typeof value === "string") return { code: fallbackCode, message: value };
+  return { code: fallbackCode, message: "Offline operation was rejected." };
+}
 var OfflineQueue = class {
   #storage;
-  #key;
+  #configuredKey;
+  #rallyId;
+  #userId;
   #conflictPolicy;
   #onSyncConflict;
   #operations = [];
@@ -1418,12 +1537,15 @@ var OfflineQueue = class {
   #error = null;
   #sender;
   #syncPromise = null;
+  #syncResultListener;
   constructor(options = {}) {
     if (options.storage !== void 0) this.#storage = options.storage;
     else if (options.storageLike !== void 0 && options.storageLike !== null)
       this.#storage = new LocalStorageQueueStorage(options.storageLike);
     else this.#storage = defaultStorage(options.databaseName);
-    this.#key = options.key ?? "stamprally:offline-queue";
+    this.#configuredKey = options.key;
+    this.#rallyId = options.rallyId;
+    this.#userId = options.userId ?? null;
     this.#conflictPolicy = options.conflictPolicy ?? "server_wins";
     this.#onSyncConflict = options.onSyncConflict;
   }
@@ -1439,20 +1561,60 @@ var OfflineQueue = class {
   get operations() {
     return this.#operations;
   }
+  get conflictPolicy() {
+    return this.#conflictPolicy;
+  }
+  get storageKey() {
+    return this.#storageKey();
+  }
+  get rallyId() {
+    return this.#rallyId;
+  }
+  get userId() {
+    return this.#userId;
+  }
+  setSyncResultListener(listener) {
+    this.#syncResultListener = listener;
+  }
   async initialize() {
     if (this.#loaded) return;
-    this.#operations = [...await this.#storage.load(this.#key)];
+    this.#operations = [...await this.#storage.load(this.#storageKey())];
     this.#loaded = true;
   }
+  /** Selects a rally/user queue scope and loads its pending operations. */
+  async setScope(rallyId, userId) {
+    if (this.#configuredKey !== void 0) {
+      this.#rallyId = rallyId;
+      this.#userId = userId;
+      return this.initialize();
+    }
+    if (this.#rallyId === rallyId && this.#userId === userId && this.#loaded) return;
+    this.#rallyId = rallyId;
+    this.#userId = userId;
+    this.#operations = [];
+    this.#loaded = false;
+    await this.initialize();
+  }
+  async switchUser(newUserId) {
+    if (this.#rallyId === void 0)
+      throw new Error("OfflineQueue.switchUser requires a rally scope.");
+    await this.setScope(this.#rallyId, newUserId);
+  }
   setSender(sender) {
     this.#sender = sender;
   }
   async enqueue(operation) {
+    if (this.#configuredKey === void 0) {
+      const scope = requestScope(operation);
+      if (this.#rallyId === void 0) await this.setScope(scope.rallyId, scope.userId);
+      if (this.#rallyId !== scope.rallyId || this.#userId !== scope.userId)
+        throw new Error("Offline operation belongs to another rally or user queue.");
+    }
     await this.initialize();
     const id2 = operationId(operation);
     if (this.#operations.some((item) => operationId(item) === id2)) return;
     this.#operations = [...this.#operations, operation];
-    await this.#storage.save(this.#key, this.#operations);
+    await this.#storage.save(this.#storageKey(), this.#operations);
   }
   async enqueueCheckIn(request) {
     return this.enqueue({ kind: "checkIn", request });
@@ -1463,7 +1625,7 @@ var OfflineQueue = class {
   async clear() {
     await this.initialize();
     this.#operations = [];
-    await this.#storage.save(this.#key, this.#operations);
+    await this.#storage.save(this.#storageKey(), this.#operations);
   }
   async sync(sender = this.#sender) {
     await this.initialize();
@@ -1485,16 +1647,30 @@ var OfflineQueue = class {
       while (this.#operations.length > 0) {
         const operation = this.#operations[0];
         if (operation === void 0) break;
-        let result;
+        let rawResult;
         try {
-          result = await sender(operation);
+          rawResult = await sender(operation);
         } catch (cause) {
-          throw cause instanceof Error ? cause : new Error(String(cause));
+          throw new Error(errorValue(cause, "RETRYABLE_ERROR").message);
         }
-        if ("conflict" in result && result.conflict === true)
-          await this.resolveConflict(operation, result.localState, result.serverState);
+        const response = this.#normalizeResponse(rawResult);
+        if (response.status === "RETRYABLE_ERROR") {
+          const error2 = errorValue(response.error ?? response.reason, "RETRYABLE_ERROR");
+          await this.#syncResultListener?.({ operation, status: response.status, error: error2 });
+          throw new Error(error2.message);
+        }
+        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;
         this.#operations = this.#operations.slice(1);
-        await this.#storage.save(this.#key, this.#operations);
+        await this.#storage.save(this.#storageKey(), this.#operations);
+        await this.#syncResultListener?.({
+          operation,
+          ...result === void 0 ? {} : { result },
+          status: response.status,
+          ...error === void 0 ? {} : { error },
+          ...state === void 0 ? {} : { state }
+        });
       }
       this.#state = "idle";
     } catch (cause) {
@@ -1503,12 +1679,29 @@ var OfflineQueue = class {
       throw this.#error;
     }
   }
+  #storageKey() {
+    if (this.#configuredKey !== void 0) return this.#configuredKey;
+    return `stamprally:queue:${this.#rallyId ?? "unscoped"}:${this.#userId ?? "anonymous"}`;
+  }
+  #normalizeResponse(value) {
+    if ("ok" in value) {
+      if (value.ok === false) {
+        if ("status" in value && value.status === "RETRYABLE_ERROR")
+          return { status: "RETRYABLE_ERROR", error: errorValue(value.error, "RETRYABLE_ERROR") };
+        return { status: "REJECTED_PERMANENT", result: value };
+      }
+      return { status: "ACCEPTED", result: value };
+    }
+    if ("status" in value) {
+      if (value.status === "ACCEPTED") return value;
+      return value;
+    }
+    return { status: "ACCEPTED", result: value };
+  }
   async resolveConflict(operation, localState, serverState) {
     const configured = this.#onSyncConflict;
     const policy = (typeof configured === "function" ? await configured({ operation, localState, serverState }) : configured) ?? this.#conflictPolicy;
-    if (policy === "merge") {
-      return;
-    }
+    return resolveRallyStateConflict(serverState, localState, { policy });
   }
 };
 
@@ -2418,9 +2611,11 @@ exports.createSignedSnapshotToken = createSignedSnapshotToken;
 exports.createUniqueClaimTicketNumber = createUniqueClaimTicketNumber;
 exports.evaluateCondition = evaluateCondition;
 exports.evaluateConditionDetailed = evaluateConditionDetailed;
+exports.evaluateSpotStatus = evaluateSpotStatus;
 exports.exportProgressToken = exportProgressToken;
 exports.getCurrentGeoContext = getCurrentGeoContext;
 exports.getOrderedSpots = getOrderedSpots;
+exports.getSpotStatus = getSpotStatus;
 exports.importProgressToken = importProgressToken;
 exports.isGeolocationSupported = isGeolocationSupported;
 exports.isNfcSupported = isNfcSupported;
@@ -2437,6 +2632,7 @@ exports.readNfcContext = readNfcContext;
 exports.readQrContext = readQrContext;
 exports.reconcileRewardStates = reconcileRewardStates;
 exports.resolveLocalizedText = resolveLocalizedText;
+exports.resolveRallyStateConflict = resolveRallyStateConflict;
 exports.safeParseAdminConfig = safeParseAdminConfig;
 exports.safeParsePublicConfig = safeParsePublicConfig;
 exports.sanitizeAdminConfig = sanitizeAdminConfig;