@stamprally/server 0.14.0 → 0.16.0

package/dist/index.d.cts

@@ -18,11 +18,20 @@ interface ClaimRewardTransactionParams {
     readonly idempotencyKey?: string;
     readonly proofData?: unknown;
     readonly idempotencyTtlMs?: number;
+    /** The configured per-reward stock limit, or null for unlimited stock. */
+    readonly rewardStockLimit: number | null;
+    /** The configured shared stock limit, or null when shared inventory is disabled. */
+    readonly sharedStockLimit: number | null;
     /** Used when the first claim is made before a user state has been stored. */
     readonly initialUserState?: UserRallyState;
+    readonly stockKey?: string;
+    readonly secondaryStockKey?: string;
+    readonly initialStock?: number | null;
+    readonly initialSecondaryStock?: number | null;
 }
 interface ClaimRewardTransactionMutation {
     readonly nextStock: number | null;
+    readonly nextSecondaryStock?: number | null;
     readonly nextUserState: UserRallyState;
     readonly auditLog: AuditLog;
     /** The server response is persisted by the adapter with the idempotency key. */
@@ -60,12 +69,15 @@ interface ServerPersistenceAdapter {
      */
     executeClaimRewardTransaction(params: ClaimRewardTransactionParams, mutation: (current: {
         readonly stock: number | null;
+        readonly secondaryStock: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }) => ClaimRewardTransactionMutation): Promise<{
         readonly success: boolean;
         readonly error?: string;
     }>;
+    /** Set false when the adapter cannot persist per-reward inventory atomically. */
+    readonly supportsRewardStock?: boolean;
     acquireLock(rallyId: string, lockKey: string, ttlMs: number): Promise<boolean>;
     releaseLock(rallyId: string, lockKey: string): Promise<void>;
     getRewardStock(rallyId: string, rewardId: string): Promise<number | null>;
@@ -89,6 +101,7 @@ interface InMemoryServerPersistenceOptions {
 }
 declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapter {
     #private;
+    readonly supportsRewardStock = true;
     constructor(options?: InMemoryServerPersistenceOptions);
     acquireLock(rallyId: string, key: string, ttlMs: number): Promise<boolean>;
     releaseLock(rallyId: string, key: string): Promise<void>;
@@ -100,6 +113,7 @@ declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapt
     restoreRewardStock(rallyId: string, rewardId: string, count?: number): Promise<void>;
     executeClaimRewardTransaction(params: ClaimRewardTransactionParams, mutation: (current: {
         readonly stock: number | null;
+        readonly secondaryStock: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }) => ClaimRewardTransactionMutation): Promise<{
@@ -128,7 +142,7 @@ declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapt
     /** @deprecated Use recordUserClaim with a ticket number and timestamp. */
     recordClaim(params: UserClaimRecord): Promise<void>;
     recordClaim(rallyId: string, userId: string, rewardId: string): Promise<void>;
-    runTransaction<T>(_rallyId: string, operation: (transaction: ServerPersistenceAdapter) => Promise<T>): Promise<T>;
+    runTransaction<T>(rallyId: string, operation: (transaction: ServerPersistenceAdapter) => Promise<T>): Promise<T>;
 }
 
 /**
@@ -144,10 +158,12 @@ interface SqlTransactionDatabase<Tx> {
 interface SqlClaimRewardStore<Tx> {
     readContext(transaction: Tx, params: ClaimRewardTransactionParams): Promise<{
         readonly stock: number | null;
+        readonly secondaryStock?: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }>;
     writeStock(transaction: Tx, params: ClaimRewardTransactionParams, nextStock: number): Promise<void>;
+    writeSecondaryStock?(transaction: Tx, params: ClaimRewardTransactionParams, nextStock: number): Promise<void>;
     writeUserState(transaction: Tx, params: ClaimRewardTransactionParams, state: UserRallyState): Promise<void>;
     writeClaimRecord(transaction: Tx, params: ClaimRewardTransactionParams, state: UserRallyState): Promise<void>;
     writeAudit(transaction: Tx, log: AuditLog): Promise<void>;
@@ -167,11 +183,33 @@ declare function executeClaimRewardTransaction<Tx>(database: SqlTransactionDatab
     readonly success: boolean;
     readonly error?: string;
 }>;
+interface SqlCheckInStore<Tx> {
+    readUserState?(transaction: Tx, params: CheckInTransactionParams): Promise<UserRallyState>;
+    writeUserState(transaction: Tx, params: CheckInTransactionParams, state: UserRallyState): Promise<void>;
+    writeAudit(transaction: Tx, log: AuditLog): Promise<void>;
+    writeIdempotency(transaction: Tx, params: CheckInTransactionParams, result: unknown): Promise<void>;
+}
+/** Reference transaction block for a check-in state, audit, and idempotency write. */
+declare function executeCheckInTransaction<Tx>(database: SqlTransactionDatabase<Tx>, store: SqlCheckInStore<Tx>, params: CheckInTransactionParams, mutation: (current: {
+    readonly userState: UserRallyState;
+}) => CheckInTransactionMutation, current?: UserRallyState): Promise<{
+    readonly success: boolean;
+    readonly error?: string;
+}>;
+interface RedisMultiExecutor<TMulti> {
+    multi(): TMulti;
+    exec(multi: TMulti): Promise<ReadonlyArray<unknown> | null>;
+}
+/** Reference for Redis MULTI/EXEC adapters: all queued commands commit together. */
+declare function executeRedisTransaction<TMulti>(redis: RedisMultiExecutor<TMulti>, queue: (multi: TMulti) => void): Promise<{
+    readonly success: boolean;
+    readonly error?: string;
+}>;
 
 interface RequestValidationError {
     readonly path: string;
     readonly message: string;
-    readonly code: "invalid_request";
+    readonly code: string;
 }
 type RequestValidationResult<T> = {
     readonly success: true;
@@ -180,11 +218,27 @@ type RequestValidationResult<T> = {
     readonly success: false;
     readonly errors: ReadonlyArray<RequestValidationError>;
 };
+declare class RequestValidationException extends Error {
+    readonly code = "VALIDATION_FAILED";
+    readonly errors: ReadonlyArray<RequestValidationError>;
+    constructor(errors: ReadonlyArray<RequestValidationError>);
+}
 declare function validateCheckInRequest(value: unknown): RequestValidationResult<CheckInRequest>;
 declare function validateClaimRewardRequest(value: unknown): RequestValidationResult<ClaimRewardRequest>;
+declare function assertValidCheckInParams(value: unknown, config: AdminRallyConfig): asserts value is CheckInRequest & {
+    readonly userId: string;
+};
+declare function assertValidClaimParams(value: unknown, config: AdminRallyConfig): asserts value is ClaimRewardRequest & {
+    readonly userId: string;
+};
+declare function assertValidSyncParams(value: unknown, config: AdminRallyConfig): asserts value is {
+    readonly rallyId: string;
+    readonly userId: string;
+};
 declare function validateSyncRequest(value: unknown): RequestValidationResult<{
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
 }>;
 
 type ErrorResponse = {
@@ -196,7 +250,12 @@ type ClaimResponse = {
     readonly ok: true;
     readonly state: UserRallyState;
     readonly claimTicketNumber?: string;
+    readonly inventory?: InventoryStatus;
 } | ErrorResponse;
+interface InventoryStatus {
+    readonly sharedRemaining?: number;
+    readonly rewardRemaining?: number;
+}
 declare class StampRallyServer {
     #private;
     constructor(config: AdminRallyConfig, persistence: ServerPersistenceAdapter, options?: ServerOptions);
@@ -204,15 +263,22 @@ declare class StampRallyServer {
     handleCheckIn(request: Request): Promise<Response>;
     handleClaimReward(request: Request): Promise<Response>;
     handleSync(request: Request): Promise<Response>;
-    checkIn(request: CheckInRequest & {
-        readonly userId: string;
-    }): Promise<CheckInResponse>;
-    claimReward(request: ClaimRewardRequest & {
-        readonly userId: string;
-    }): Promise<ClaimResponse>;
+    checkIn(request: CheckInRequest): Promise<CheckInResponse>;
+    claimReward(request: ClaimRewardRequest): Promise<ClaimResponse>;
     sync(rallyId: string, userId: string): Promise<UserRallyState>;
+    syncProgress(request: {
+        readonly rallyId: string;
+        readonly userId?: string;
+        readonly anonymousSessionId?: string;
+    }): Promise<UserRallyState>;
 }
 
+/**
+ * Runs the minimum atomicity and idempotency contract against a persistence adapter.
+ * The function throws a descriptive error when the adapter violates the contract.
+ */
+declare function runPersistenceAdapterComplianceTests(createAdapter: () => Promise<ServerPersistenceAdapter>): Promise<void>;
+
 interface AuditLog {
     readonly id: string;
     readonly timestamp: string;
@@ -228,19 +294,21 @@ type SyncOperationStatus = "ACCEPTED" | "REJECTED_PERMANENT" | "RETRYABLE_ERROR"
 interface CheckInRequest {
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
     readonly spotId: string;
     readonly context: _stamprally_core.VerificationContext;
     readonly idempotencyKey: string;
-    readonly now?: string;
+    readonly now?: string | number;
 }
 interface ClaimRewardRequest {
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
     readonly rewardId: string;
     readonly idempotencyKey: string;
     readonly staffPasscode?: string;
     readonly staffId?: string;
-    readonly now?: string;
+    readonly now?: string | number;
 }
 type CheckInResponse = {
     readonly ok: true;
@@ -258,9 +326,10 @@ interface ServerOptions {
     readonly authenticate?: (request: Request) => Promise<string | AuthenticationContext | null> | string | AuthenticationContext | null;
     readonly customValidators?: Readonly<Record<string, _stamprally_core.Validator>>;
     readonly now?: () => string;
+    readonly anonymousPolicy?: "session_scoped" | "reject" | "shared_global_opt_in_insecure";
 }
 interface AuthenticationContext {
     readonly authenticatedUserId: string;
 }
 
-export { type AuditLog, type AuthenticationContext, type CheckInRequest, type CheckInResponse, type CheckInTransactionMutation, type CheckInTransactionParams, type ClaimRewardRequest, type ClaimRewardTransactionMutation, type ClaimRewardTransactionParams, InMemoryServerPersistenceAdapter, type InMemoryServerPersistenceOptions, type RequestValidationError, type RequestValidationResult, type ServerOptions, type ServerPersistenceAdapter, type SqlClaimRewardStore, type SqlTransactionDatabase, StampRallyServer, type SyncOperationStatus, type UserClaimRecord, executeClaimRewardTransaction, validateCheckInRequest, validateClaimRewardRequest, validateSyncRequest };
+export { type AuditLog, type AuthenticationContext, type CheckInRequest, type CheckInResponse, type CheckInTransactionMutation, type CheckInTransactionParams, type ClaimRewardRequest, type ClaimRewardTransactionMutation, type ClaimRewardTransactionParams, InMemoryServerPersistenceAdapter, type InMemoryServerPersistenceOptions, type RedisMultiExecutor, type RequestValidationError, RequestValidationException, type RequestValidationResult, type ServerOptions, type ServerPersistenceAdapter, type SqlCheckInStore, type SqlClaimRewardStore, type SqlTransactionDatabase, StampRallyServer, type SyncOperationStatus, type UserClaimRecord, assertValidCheckInParams, assertValidClaimParams, assertValidSyncParams, executeCheckInTransaction, executeClaimRewardTransaction, executeRedisTransaction, runPersistenceAdapterComplianceTests, validateCheckInRequest, validateClaimRewardRequest, validateSyncRequest };

package/dist/index.d.ts

@@ -18,11 +18,20 @@ interface ClaimRewardTransactionParams {
     readonly idempotencyKey?: string;
     readonly proofData?: unknown;
     readonly idempotencyTtlMs?: number;
+    /** The configured per-reward stock limit, or null for unlimited stock. */
+    readonly rewardStockLimit: number | null;
+    /** The configured shared stock limit, or null when shared inventory is disabled. */
+    readonly sharedStockLimit: number | null;
     /** Used when the first claim is made before a user state has been stored. */
     readonly initialUserState?: UserRallyState;
+    readonly stockKey?: string;
+    readonly secondaryStockKey?: string;
+    readonly initialStock?: number | null;
+    readonly initialSecondaryStock?: number | null;
 }
 interface ClaimRewardTransactionMutation {
     readonly nextStock: number | null;
+    readonly nextSecondaryStock?: number | null;
     readonly nextUserState: UserRallyState;
     readonly auditLog: AuditLog;
     /** The server response is persisted by the adapter with the idempotency key. */
@@ -60,12 +69,15 @@ interface ServerPersistenceAdapter {
      */
     executeClaimRewardTransaction(params: ClaimRewardTransactionParams, mutation: (current: {
         readonly stock: number | null;
+        readonly secondaryStock: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }) => ClaimRewardTransactionMutation): Promise<{
         readonly success: boolean;
         readonly error?: string;
     }>;
+    /** Set false when the adapter cannot persist per-reward inventory atomically. */
+    readonly supportsRewardStock?: boolean;
     acquireLock(rallyId: string, lockKey: string, ttlMs: number): Promise<boolean>;
     releaseLock(rallyId: string, lockKey: string): Promise<void>;
     getRewardStock(rallyId: string, rewardId: string): Promise<number | null>;
@@ -89,6 +101,7 @@ interface InMemoryServerPersistenceOptions {
 }
 declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapter {
     #private;
+    readonly supportsRewardStock = true;
     constructor(options?: InMemoryServerPersistenceOptions);
     acquireLock(rallyId: string, key: string, ttlMs: number): Promise<boolean>;
     releaseLock(rallyId: string, key: string): Promise<void>;
@@ -100,6 +113,7 @@ declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapt
     restoreRewardStock(rallyId: string, rewardId: string, count?: number): Promise<void>;
     executeClaimRewardTransaction(params: ClaimRewardTransactionParams, mutation: (current: {
         readonly stock: number | null;
+        readonly secondaryStock: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }) => ClaimRewardTransactionMutation): Promise<{
@@ -128,7 +142,7 @@ declare class InMemoryServerPersistenceAdapter implements ServerPersistenceAdapt
     /** @deprecated Use recordUserClaim with a ticket number and timestamp. */
     recordClaim(params: UserClaimRecord): Promise<void>;
     recordClaim(rallyId: string, userId: string, rewardId: string): Promise<void>;
-    runTransaction<T>(_rallyId: string, operation: (transaction: ServerPersistenceAdapter) => Promise<T>): Promise<T>;
+    runTransaction<T>(rallyId: string, operation: (transaction: ServerPersistenceAdapter) => Promise<T>): Promise<T>;
 }
 
 /**
@@ -144,10 +158,12 @@ interface SqlTransactionDatabase<Tx> {
 interface SqlClaimRewardStore<Tx> {
     readContext(transaction: Tx, params: ClaimRewardTransactionParams): Promise<{
         readonly stock: number | null;
+        readonly secondaryStock?: number | null;
         readonly claimCount: number;
         readonly userState: UserRallyState;
     }>;
     writeStock(transaction: Tx, params: ClaimRewardTransactionParams, nextStock: number): Promise<void>;
+    writeSecondaryStock?(transaction: Tx, params: ClaimRewardTransactionParams, nextStock: number): Promise<void>;
     writeUserState(transaction: Tx, params: ClaimRewardTransactionParams, state: UserRallyState): Promise<void>;
     writeClaimRecord(transaction: Tx, params: ClaimRewardTransactionParams, state: UserRallyState): Promise<void>;
     writeAudit(transaction: Tx, log: AuditLog): Promise<void>;
@@ -167,11 +183,33 @@ declare function executeClaimRewardTransaction<Tx>(database: SqlTransactionDatab
     readonly success: boolean;
     readonly error?: string;
 }>;
+interface SqlCheckInStore<Tx> {
+    readUserState?(transaction: Tx, params: CheckInTransactionParams): Promise<UserRallyState>;
+    writeUserState(transaction: Tx, params: CheckInTransactionParams, state: UserRallyState): Promise<void>;
+    writeAudit(transaction: Tx, log: AuditLog): Promise<void>;
+    writeIdempotency(transaction: Tx, params: CheckInTransactionParams, result: unknown): Promise<void>;
+}
+/** Reference transaction block for a check-in state, audit, and idempotency write. */
+declare function executeCheckInTransaction<Tx>(database: SqlTransactionDatabase<Tx>, store: SqlCheckInStore<Tx>, params: CheckInTransactionParams, mutation: (current: {
+    readonly userState: UserRallyState;
+}) => CheckInTransactionMutation, current?: UserRallyState): Promise<{
+    readonly success: boolean;
+    readonly error?: string;
+}>;
+interface RedisMultiExecutor<TMulti> {
+    multi(): TMulti;
+    exec(multi: TMulti): Promise<ReadonlyArray<unknown> | null>;
+}
+/** Reference for Redis MULTI/EXEC adapters: all queued commands commit together. */
+declare function executeRedisTransaction<TMulti>(redis: RedisMultiExecutor<TMulti>, queue: (multi: TMulti) => void): Promise<{
+    readonly success: boolean;
+    readonly error?: string;
+}>;
 
 interface RequestValidationError {
     readonly path: string;
     readonly message: string;
-    readonly code: "invalid_request";
+    readonly code: string;
 }
 type RequestValidationResult<T> = {
     readonly success: true;
@@ -180,11 +218,27 @@ type RequestValidationResult<T> = {
     readonly success: false;
     readonly errors: ReadonlyArray<RequestValidationError>;
 };
+declare class RequestValidationException extends Error {
+    readonly code = "VALIDATION_FAILED";
+    readonly errors: ReadonlyArray<RequestValidationError>;
+    constructor(errors: ReadonlyArray<RequestValidationError>);
+}
 declare function validateCheckInRequest(value: unknown): RequestValidationResult<CheckInRequest>;
 declare function validateClaimRewardRequest(value: unknown): RequestValidationResult<ClaimRewardRequest>;
+declare function assertValidCheckInParams(value: unknown, config: AdminRallyConfig): asserts value is CheckInRequest & {
+    readonly userId: string;
+};
+declare function assertValidClaimParams(value: unknown, config: AdminRallyConfig): asserts value is ClaimRewardRequest & {
+    readonly userId: string;
+};
+declare function assertValidSyncParams(value: unknown, config: AdminRallyConfig): asserts value is {
+    readonly rallyId: string;
+    readonly userId: string;
+};
 declare function validateSyncRequest(value: unknown): RequestValidationResult<{
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
 }>;
 
 type ErrorResponse = {
@@ -196,7 +250,12 @@ type ClaimResponse = {
     readonly ok: true;
     readonly state: UserRallyState;
     readonly claimTicketNumber?: string;
+    readonly inventory?: InventoryStatus;
 } | ErrorResponse;
+interface InventoryStatus {
+    readonly sharedRemaining?: number;
+    readonly rewardRemaining?: number;
+}
 declare class StampRallyServer {
     #private;
     constructor(config: AdminRallyConfig, persistence: ServerPersistenceAdapter, options?: ServerOptions);
@@ -204,15 +263,22 @@ declare class StampRallyServer {
     handleCheckIn(request: Request): Promise<Response>;
     handleClaimReward(request: Request): Promise<Response>;
     handleSync(request: Request): Promise<Response>;
-    checkIn(request: CheckInRequest & {
-        readonly userId: string;
-    }): Promise<CheckInResponse>;
-    claimReward(request: ClaimRewardRequest & {
-        readonly userId: string;
-    }): Promise<ClaimResponse>;
+    checkIn(request: CheckInRequest): Promise<CheckInResponse>;
+    claimReward(request: ClaimRewardRequest): Promise<ClaimResponse>;
     sync(rallyId: string, userId: string): Promise<UserRallyState>;
+    syncProgress(request: {
+        readonly rallyId: string;
+        readonly userId?: string;
+        readonly anonymousSessionId?: string;
+    }): Promise<UserRallyState>;
 }
 
+/**
+ * Runs the minimum atomicity and idempotency contract against a persistence adapter.
+ * The function throws a descriptive error when the adapter violates the contract.
+ */
+declare function runPersistenceAdapterComplianceTests(createAdapter: () => Promise<ServerPersistenceAdapter>): Promise<void>;
+
 interface AuditLog {
     readonly id: string;
     readonly timestamp: string;
@@ -228,19 +294,21 @@ type SyncOperationStatus = "ACCEPTED" | "REJECTED_PERMANENT" | "RETRYABLE_ERROR"
 interface CheckInRequest {
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
     readonly spotId: string;
     readonly context: _stamprally_core.VerificationContext;
     readonly idempotencyKey: string;
-    readonly now?: string;
+    readonly now?: string | number;
 }
 interface ClaimRewardRequest {
     readonly rallyId: string;
     readonly userId?: string;
+    readonly anonymousSessionId?: string;
     readonly rewardId: string;
     readonly idempotencyKey: string;
     readonly staffPasscode?: string;
     readonly staffId?: string;
-    readonly now?: string;
+    readonly now?: string | number;
 }
 type CheckInResponse = {
     readonly ok: true;
@@ -258,9 +326,10 @@ interface ServerOptions {
     readonly authenticate?: (request: Request) => Promise<string | AuthenticationContext | null> | string | AuthenticationContext | null;
     readonly customValidators?: Readonly<Record<string, _stamprally_core.Validator>>;
     readonly now?: () => string;
+    readonly anonymousPolicy?: "session_scoped" | "reject" | "shared_global_opt_in_insecure";
 }
 interface AuthenticationContext {
     readonly authenticatedUserId: string;
 }
 
-export { type AuditLog, type AuthenticationContext, type CheckInRequest, type CheckInResponse, type CheckInTransactionMutation, type CheckInTransactionParams, type ClaimRewardRequest, type ClaimRewardTransactionMutation, type ClaimRewardTransactionParams, InMemoryServerPersistenceAdapter, type InMemoryServerPersistenceOptions, type RequestValidationError, type RequestValidationResult, type ServerOptions, type ServerPersistenceAdapter, type SqlClaimRewardStore, type SqlTransactionDatabase, StampRallyServer, type SyncOperationStatus, type UserClaimRecord, executeClaimRewardTransaction, validateCheckInRequest, validateClaimRewardRequest, validateSyncRequest };
+export { type AuditLog, type AuthenticationContext, type CheckInRequest, type CheckInResponse, type CheckInTransactionMutation, type CheckInTransactionParams, type ClaimRewardRequest, type ClaimRewardTransactionMutation, type ClaimRewardTransactionParams, InMemoryServerPersistenceAdapter, type InMemoryServerPersistenceOptions, type RedisMultiExecutor, type RequestValidationError, RequestValidationException, type RequestValidationResult, type ServerOptions, type ServerPersistenceAdapter, type SqlCheckInStore, type SqlClaimRewardStore, type SqlTransactionDatabase, StampRallyServer, type SyncOperationStatus, type UserClaimRecord, assertValidCheckInParams, assertValidClaimParams, assertValidSyncParams, executeCheckInTransaction, executeClaimRewardTransaction, executeRedisTransaction, runPersistenceAdapterComplianceTests, validateCheckInRequest, validateClaimRewardRequest, validateSyncRequest };