@stamprally/core 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -113,6 +113,7 @@ type Result<T, E> = {
 type SupportedLocale = "ja" | "en";
 type LocalizedString<TLocale extends string = SupportedLocale> = Record<TLocale, string>;
 type LocalizedText<TLocale extends string = string> = string | Partial<Record<TLocale, string>>;
+type LocaleDictionary<TLocale extends string = string> = Readonly<Record<TLocale, Readonly<Record<string, string>>>>;
 type SlotShape = "circle" | "square" | "rounded";
 type FontFamily = "system-ui" | "serif" | "rounded-sans" | "monospace" | "handwritten";
 interface SheetTheme {
@@ -141,6 +142,7 @@ interface SpotItem<TLocale extends string = SupportedLocale, TMeta extends Recor
     readonly description?: LocalizedText<TLocale>;
     readonly hint?: LocalizedText<TLocale>;
     readonly condition: StampCondition;
+    readonly orderIndex?: number;
     readonly order?: number;
     readonly deckId?: string;
     readonly groupId?: string;
@@ -161,7 +163,20 @@ interface StampRecord {
     readonly metadata?: Readonly<Record<string, unknown>>;
 }
 type RewardType = "digital" | "in_person";
-type RedemptionMethod = "manual_slide" | "staff_passcode" | "view_only";
+type RedemptionMethod = "manual_slide" | "staff_passcode" | "view_only" | "server_claim";
+type RewardUnlockCondition = {
+    readonly type: "stamp_count";
+    readonly count: number;
+} | {
+    readonly type: "stamps";
+    readonly stampIds: ReadonlyArray<string>;
+} | {
+    readonly type: "group_complete";
+    readonly groupId: string;
+} | {
+    readonly type: "all" | "any";
+    readonly conditions: ReadonlyArray<RewardUnlockCondition>;
+};
 type RewardStatus = "LOCKED" | "AVAILABLE" | "CONSUMED" | "EXPIRED";
 interface RewardItem<TLocale extends string = SupportedLocale> {
     readonly id: string;
@@ -170,9 +185,12 @@ interface RewardItem<TLocale extends string = SupportedLocale> {
     readonly type: RewardType;
     readonly redemptionMethod: RedemptionMethod;
     readonly requiredStampCount: number;
+    readonly conditions?: ReadonlyArray<RewardUnlockCondition>;
     readonly digitalContentUrl?: string;
     readonly staffPasscode?: string;
     readonly validUntil?: string;
+    readonly stockLimit?: number;
+    readonly userClaimLimit?: number;
     readonly maxStock?: number;
     readonly limitPerUser?: number;
     readonly claimTicketNumber?: string;
@@ -210,7 +228,7 @@ declare function resolveLocalizedText<TLocale extends string = SupportedLocale>(
 declare function toLocalizedString(text: LocalizedText | undefined): LocalizedString;
 declare function toLocalizedString<TLocale extends string>(text: LocalizedText<TLocale> | undefined): LocalizedString<TLocale>;
 
-declare function migrateRallyConfig(raw: unknown): RallyConfig;
+declare function migrateRallyConfig<TLocale extends string = SupportedLocale>(raw: unknown): RallyConfig<TLocale>;
 
 type PublicRewardItem<TLocale extends string = string> = Omit<RewardItem<TLocale>, "staffPasscode">;
 type PublicRallyConfig<TLocale extends string = string, TMeta extends Record<string, unknown> = Record<string, unknown>> = Omit<RallyConfig<TLocale, TMeta>, "rewards"> & {
@@ -404,6 +422,22 @@ declare class IndexedDBAdapter implements StampStorage {
 }
 
 type StampRallyListener = (state: StampRallyState) => void;
+type StampRallyClientEvent = {
+    readonly type: "checkIn";
+    readonly stampId: string;
+    readonly state: StampRallyState;
+} | {
+    readonly type: "rewardClaimed";
+    readonly rewardId: string;
+    readonly state: StampRallyState;
+} | {
+    readonly type: "syncCompleted";
+    readonly state: StampRallyState;
+} | {
+    readonly type: "error";
+    readonly error: unknown;
+};
+type StampRallyEventListener = (event: StampRallyClientEvent) => void;
 type Clock = () => string;
 declare class StampRallyClient {
     #private;
@@ -411,6 +445,13 @@ declare class StampRallyClient {
     getState(): StampRallyState | null;
     getConfig(): RallyConfig;
     subscribe(listener: StampRallyListener): () => void;
+    subscribe(listener: StampRallyEventListener, options: {
+        readonly events: true;
+    }): () => void;
+    subscribeEvents(listener: StampRallyEventListener): () => void;
+    updateConfig(newConfig: PublicRallyConfig): Promise<StampRallyState>;
+    notifyRewardClaimed(rewardId: string, state?: StampRallyState | null): void;
+    notifySyncCompleted(state?: StampRallyState | null): void;
     init(): Promise<StampRallyState>;
     initialize(): Promise<StampRallyState>;
     acquire(stampId: string, context: VerificationContext, now?: string): Promise<Result<ProcessStampValue, StampError>>;
@@ -418,6 +459,32 @@ declare class StampRallyClient {
     restore(state: StampRallyState): Promise<StampRallyState>;
 }
 
+type SecureTokenSecretKey = string | Uint8Array;
+interface SecureTokenOptions {
+    readonly encrypt?: boolean;
+    readonly expiresInSeconds?: number;
+}
+interface SecureTokenPayload {
+    readonly [key: string]: unknown;
+    readonly exp?: number;
+}
+type SecureTokenErrorCode = "MALFORMED" | "INVALID_SIGNATURE" | "DECRYPTION_FAILED" | "INVALID_PAYLOAD" | "EXPIRED";
+interface SecureTokenError {
+    readonly code: SecureTokenErrorCode;
+    readonly message: string;
+}
+type SecureTokenVerification<T extends SecureTokenPayload = SecureTokenPayload> = {
+    readonly ok: true;
+    readonly valid: true;
+    readonly payload: T;
+} | {
+    readonly ok: false;
+    readonly valid: false;
+    readonly error: SecureTokenError;
+};
+declare function createSecureToken<T extends SecureTokenPayload>(payload: T, secretKey: SecureTokenSecretKey, options?: SecureTokenOptions): Promise<string>;
+declare function verifySecureToken<T extends SecureTokenPayload = SecureTokenPayload>(token: string, secretKey: SecureTokenSecretKey, now?: number): Promise<SecureTokenVerification<T>>;
+
 type DetectorKind = "geolocation" | "nfc" | "qr";
 type DetectorErrorCode = "UNSUPPORTED" | "PERMISSION_DENIED" | "POSITION_UNAVAILABLE" | "TIMEOUT" | "ABORTED" | "READ_FAILED" | "INVALID_DATA" | "NO_TOKEN";
 interface DetectorError {
@@ -493,4 +560,4 @@ type SnapshotTokenVerification<T extends SnapshotTokenPayload = SnapshotTokenPay
 declare function createSignedSnapshotToken<T extends SnapshotTokenPayload>(payload: T, secretKey: SnapshotSecretKey): Promise<string>;
 declare function verifySnapshotToken<T extends SnapshotTokenPayload = SnapshotTokenPayload>(token: string, secretKey: SnapshotSecretKey, now?: number): Promise<SnapshotTokenVerification<T>>;
 
-export { CURRENT_RALLY_CONFIG_VERSION, type CheckInContext, type CheckInErrorCode, type CheckInInput, type CheckInResult$1 as CheckInResult, type ClaimTicketOptions, type Clock, type CompositeConditionFailure, type ConditionMatch, type ConditionMismatch, type ConsumeResult, type ConsumeRewardParams, DEFAULT_SHEET_THEME, type DetectorError, type DetectorErrorCode, type DetectorKind, type DetectorResult, type FontFamily, type GeoDetectorOptions, type GeoVerificationContext, InMemoryStorage, IndexedDBAdapter, type IndexedDBAdapterOptions, LocalStorageAdapter, type LocalStorageAdapterOptions, type LocalStorageFailureMode, type LocalizedString, type LocalizedText, type NfcDetectorOptions, type PasscodeCondition, type ProcessStampValue, type PublicRallyConfig, type PublicRewardItem, type QrDetectorOptions, type RallyConfig, type RallyConfigValidationResult, type RallySnapshot, type RedemptionMethod, type Result, type RewardConsumeError, type RewardItem, type RewardState, type RewardStatus, type RewardType, type SheetTheme, type SlotShape, type SnapshotSecretKey, type SnapshotTokenError, type SnapshotTokenErrorCode, type SnapshotTokenPayload, type SnapshotTokenVerification, type SpotItem, type StampCondition, type StampDefinition, type StampError, StampRallyClient, type StampRallyEvent, type StampRallyListener, type StampRallyProgress, type StampRallyState, type StampRecord, type StampStorage, StorageAdapterError, type StorageAdapterErrorCode, type StorageLike, type StorageOperation, type StorageWarningHandler, type SupportedLocale, THEME_PRESETS, type ThemePreset, type ThemePresetId, type TokenVerificationContext, type ValidationError, type VerificationContext, calculateDistanceMeters, calculateProgress, consumeReward, createClaimTicketNumber, createSignedSnapshotToken, createUniqueClaimTicketNumber, evaluateCheckIn, evaluateCondition, evaluateConditionDetailed, exportProgressToken, getCurrentGeoContext, importProgressToken, isGeolocationSupported, isNfcSupported, isQrSupported, isRewardState, isStampRallyState, issueClaimTicketNumber, migrateRallyConfig, normalizePasscode, processStamp, readNfcContext, readQrContext, reconcileRewardStates, resolveLocalizedText, stripSensitiveConfig, toLocalizedString, validateRallyConfig, verifyPasscode, verifySnapshotToken };
+export { CURRENT_RALLY_CONFIG_VERSION, type CheckInContext, type CheckInErrorCode, type CheckInInput, type CheckInResult$1 as CheckInResult, type ClaimTicketOptions, type Clock, type CompositeConditionFailure, type ConditionMatch, type ConditionMismatch, type ConsumeResult, type ConsumeRewardParams, DEFAULT_SHEET_THEME, type DetectorError, type DetectorErrorCode, type DetectorKind, type DetectorResult, type FontFamily, type GeoDetectorOptions, type GeoVerificationContext, InMemoryStorage, IndexedDBAdapter, type IndexedDBAdapterOptions, LocalStorageAdapter, type LocalStorageAdapterOptions, type LocalStorageFailureMode, type LocaleDictionary, type LocalizedString, type LocalizedText, type NfcDetectorOptions, type PasscodeCondition, type ProcessStampValue, type PublicRallyConfig, type PublicRewardItem, type QrDetectorOptions, type RallyConfig, type RallyConfigValidationResult, type RallySnapshot, type RedemptionMethod, type Result, type RewardConsumeError, type RewardItem, type RewardState, type RewardStatus, type RewardType, type RewardUnlockCondition, type SecureTokenError, type SecureTokenErrorCode, type SecureTokenOptions, type SecureTokenPayload, type SecureTokenSecretKey, type SecureTokenVerification, type SheetTheme, type SlotShape, type SnapshotSecretKey, type SnapshotTokenError, type SnapshotTokenErrorCode, type SnapshotTokenPayload, type SnapshotTokenVerification, type SpotItem, type StampCondition, type StampDefinition, type StampError, StampRallyClient, type StampRallyClientEvent, type StampRallyEvent, type StampRallyEventListener, type StampRallyListener, type StampRallyProgress, type StampRallyState, type StampRecord, type StampStorage, StorageAdapterError, type StorageAdapterErrorCode, type StorageLike, type StorageOperation, type StorageWarningHandler, type SupportedLocale, THEME_PRESETS, type ThemePreset, type ThemePresetId, type TokenVerificationContext, type ValidationError, type VerificationContext, calculateDistanceMeters, calculateProgress, consumeReward, createClaimTicketNumber, createSecureToken, createSignedSnapshotToken, createUniqueClaimTicketNumber, evaluateCheckIn, evaluateCondition, evaluateConditionDetailed, exportProgressToken, getCurrentGeoContext, importProgressToken, isGeolocationSupported, isNfcSupported, isQrSupported, isRewardState, isStampRallyState, issueClaimTicketNumber, migrateRallyConfig, normalizePasscode, processStamp, readNfcContext, readQrContext, reconcileRewardStates, resolveLocalizedText, stripSensitiveConfig, toLocalizedString, validateRallyConfig, verifyPasscode, verifySecureToken, verifySnapshotToken };

package/dist/index.d.ts

@@ -113,6 +113,7 @@ type Result<T, E> = {
 type SupportedLocale = "ja" | "en";
 type LocalizedString<TLocale extends string = SupportedLocale> = Record<TLocale, string>;
 type LocalizedText<TLocale extends string = string> = string | Partial<Record<TLocale, string>>;
+type LocaleDictionary<TLocale extends string = string> = Readonly<Record<TLocale, Readonly<Record<string, string>>>>;
 type SlotShape = "circle" | "square" | "rounded";
 type FontFamily = "system-ui" | "serif" | "rounded-sans" | "monospace" | "handwritten";
 interface SheetTheme {
@@ -141,6 +142,7 @@ interface SpotItem<TLocale extends string = SupportedLocale, TMeta extends Recor
     readonly description?: LocalizedText<TLocale>;
     readonly hint?: LocalizedText<TLocale>;
     readonly condition: StampCondition;
+    readonly orderIndex?: number;
     readonly order?: number;
     readonly deckId?: string;
     readonly groupId?: string;
@@ -161,7 +163,20 @@ interface StampRecord {
     readonly metadata?: Readonly<Record<string, unknown>>;
 }
 type RewardType = "digital" | "in_person";
-type RedemptionMethod = "manual_slide" | "staff_passcode" | "view_only";
+type RedemptionMethod = "manual_slide" | "staff_passcode" | "view_only" | "server_claim";
+type RewardUnlockCondition = {
+    readonly type: "stamp_count";
+    readonly count: number;
+} | {
+    readonly type: "stamps";
+    readonly stampIds: ReadonlyArray<string>;
+} | {
+    readonly type: "group_complete";
+    readonly groupId: string;
+} | {
+    readonly type: "all" | "any";
+    readonly conditions: ReadonlyArray<RewardUnlockCondition>;
+};
 type RewardStatus = "LOCKED" | "AVAILABLE" | "CONSUMED" | "EXPIRED";
 interface RewardItem<TLocale extends string = SupportedLocale> {
     readonly id: string;
@@ -170,9 +185,12 @@ interface RewardItem<TLocale extends string = SupportedLocale> {
     readonly type: RewardType;
     readonly redemptionMethod: RedemptionMethod;
     readonly requiredStampCount: number;
+    readonly conditions?: ReadonlyArray<RewardUnlockCondition>;
     readonly digitalContentUrl?: string;
     readonly staffPasscode?: string;
     readonly validUntil?: string;
+    readonly stockLimit?: number;
+    readonly userClaimLimit?: number;
     readonly maxStock?: number;
     readonly limitPerUser?: number;
     readonly claimTicketNumber?: string;
@@ -210,7 +228,7 @@ declare function resolveLocalizedText<TLocale extends string = SupportedLocale>(
 declare function toLocalizedString(text: LocalizedText | undefined): LocalizedString;
 declare function toLocalizedString<TLocale extends string>(text: LocalizedText<TLocale> | undefined): LocalizedString<TLocale>;
 
-declare function migrateRallyConfig(raw: unknown): RallyConfig;
+declare function migrateRallyConfig<TLocale extends string = SupportedLocale>(raw: unknown): RallyConfig<TLocale>;
 
 type PublicRewardItem<TLocale extends string = string> = Omit<RewardItem<TLocale>, "staffPasscode">;
 type PublicRallyConfig<TLocale extends string = string, TMeta extends Record<string, unknown> = Record<string, unknown>> = Omit<RallyConfig<TLocale, TMeta>, "rewards"> & {
@@ -404,6 +422,22 @@ declare class IndexedDBAdapter implements StampStorage {
 }
 
 type StampRallyListener = (state: StampRallyState) => void;
+type StampRallyClientEvent = {
+    readonly type: "checkIn";
+    readonly stampId: string;
+    readonly state: StampRallyState;
+} | {
+    readonly type: "rewardClaimed";
+    readonly rewardId: string;
+    readonly state: StampRallyState;
+} | {
+    readonly type: "syncCompleted";
+    readonly state: StampRallyState;
+} | {
+    readonly type: "error";
+    readonly error: unknown;
+};
+type StampRallyEventListener = (event: StampRallyClientEvent) => void;
 type Clock = () => string;
 declare class StampRallyClient {
     #private;
@@ -411,6 +445,13 @@ declare class StampRallyClient {
     getState(): StampRallyState | null;
     getConfig(): RallyConfig;
     subscribe(listener: StampRallyListener): () => void;
+    subscribe(listener: StampRallyEventListener, options: {
+        readonly events: true;
+    }): () => void;
+    subscribeEvents(listener: StampRallyEventListener): () => void;
+    updateConfig(newConfig: PublicRallyConfig): Promise<StampRallyState>;
+    notifyRewardClaimed(rewardId: string, state?: StampRallyState | null): void;
+    notifySyncCompleted(state?: StampRallyState | null): void;
     init(): Promise<StampRallyState>;
     initialize(): Promise<StampRallyState>;
     acquire(stampId: string, context: VerificationContext, now?: string): Promise<Result<ProcessStampValue, StampError>>;
@@ -418,6 +459,32 @@ declare class StampRallyClient {
     restore(state: StampRallyState): Promise<StampRallyState>;
 }
 
+type SecureTokenSecretKey = string | Uint8Array;
+interface SecureTokenOptions {
+    readonly encrypt?: boolean;
+    readonly expiresInSeconds?: number;
+}
+interface SecureTokenPayload {
+    readonly [key: string]: unknown;
+    readonly exp?: number;
+}
+type SecureTokenErrorCode = "MALFORMED" | "INVALID_SIGNATURE" | "DECRYPTION_FAILED" | "INVALID_PAYLOAD" | "EXPIRED";
+interface SecureTokenError {
+    readonly code: SecureTokenErrorCode;
+    readonly message: string;
+}
+type SecureTokenVerification<T extends SecureTokenPayload = SecureTokenPayload> = {
+    readonly ok: true;
+    readonly valid: true;
+    readonly payload: T;
+} | {
+    readonly ok: false;
+    readonly valid: false;
+    readonly error: SecureTokenError;
+};
+declare function createSecureToken<T extends SecureTokenPayload>(payload: T, secretKey: SecureTokenSecretKey, options?: SecureTokenOptions): Promise<string>;
+declare function verifySecureToken<T extends SecureTokenPayload = SecureTokenPayload>(token: string, secretKey: SecureTokenSecretKey, now?: number): Promise<SecureTokenVerification<T>>;
+
 type DetectorKind = "geolocation" | "nfc" | "qr";
 type DetectorErrorCode = "UNSUPPORTED" | "PERMISSION_DENIED" | "POSITION_UNAVAILABLE" | "TIMEOUT" | "ABORTED" | "READ_FAILED" | "INVALID_DATA" | "NO_TOKEN";
 interface DetectorError {
@@ -493,4 +560,4 @@ type SnapshotTokenVerification<T extends SnapshotTokenPayload = SnapshotTokenPay
 declare function createSignedSnapshotToken<T extends SnapshotTokenPayload>(payload: T, secretKey: SnapshotSecretKey): Promise<string>;
 declare function verifySnapshotToken<T extends SnapshotTokenPayload = SnapshotTokenPayload>(token: string, secretKey: SnapshotSecretKey, now?: number): Promise<SnapshotTokenVerification<T>>;
 
-export { CURRENT_RALLY_CONFIG_VERSION, type CheckInContext, type CheckInErrorCode, type CheckInInput, type CheckInResult$1 as CheckInResult, type ClaimTicketOptions, type Clock, type CompositeConditionFailure, type ConditionMatch, type ConditionMismatch, type ConsumeResult, type ConsumeRewardParams, DEFAULT_SHEET_THEME, type DetectorError, type DetectorErrorCode, type DetectorKind, type DetectorResult, type FontFamily, type GeoDetectorOptions, type GeoVerificationContext, InMemoryStorage, IndexedDBAdapter, type IndexedDBAdapterOptions, LocalStorageAdapter, type LocalStorageAdapterOptions, type LocalStorageFailureMode, type LocalizedString, type LocalizedText, type NfcDetectorOptions, type PasscodeCondition, type ProcessStampValue, type PublicRallyConfig, type PublicRewardItem, type QrDetectorOptions, type RallyConfig, type RallyConfigValidationResult, type RallySnapshot, type RedemptionMethod, type Result, type RewardConsumeError, type RewardItem, type RewardState, type RewardStatus, type RewardType, type SheetTheme, type SlotShape, type SnapshotSecretKey, type SnapshotTokenError, type SnapshotTokenErrorCode, type SnapshotTokenPayload, type SnapshotTokenVerification, type SpotItem, type StampCondition, type StampDefinition, type StampError, StampRallyClient, type StampRallyEvent, type StampRallyListener, type StampRallyProgress, type StampRallyState, type StampRecord, type StampStorage, StorageAdapterError, type StorageAdapterErrorCode, type StorageLike, type StorageOperation, type StorageWarningHandler, type SupportedLocale, THEME_PRESETS, type ThemePreset, type ThemePresetId, type TokenVerificationContext, type ValidationError, type VerificationContext, calculateDistanceMeters, calculateProgress, consumeReward, createClaimTicketNumber, createSignedSnapshotToken, createUniqueClaimTicketNumber, evaluateCheckIn, evaluateCondition, evaluateConditionDetailed, exportProgressToken, getCurrentGeoContext, importProgressToken, isGeolocationSupported, isNfcSupported, isQrSupported, isRewardState, isStampRallyState, issueClaimTicketNumber, migrateRallyConfig, normalizePasscode, processStamp, readNfcContext, readQrContext, reconcileRewardStates, resolveLocalizedText, stripSensitiveConfig, toLocalizedString, validateRallyConfig, verifyPasscode, verifySnapshotToken };
+export { CURRENT_RALLY_CONFIG_VERSION, type CheckInContext, type CheckInErrorCode, type CheckInInput, type CheckInResult$1 as CheckInResult, type ClaimTicketOptions, type Clock, type CompositeConditionFailure, type ConditionMatch, type ConditionMismatch, type ConsumeResult, type ConsumeRewardParams, DEFAULT_SHEET_THEME, type DetectorError, type DetectorErrorCode, type DetectorKind, type DetectorResult, type FontFamily, type GeoDetectorOptions, type GeoVerificationContext, InMemoryStorage, IndexedDBAdapter, type IndexedDBAdapterOptions, LocalStorageAdapter, type LocalStorageAdapterOptions, type LocalStorageFailureMode, type LocaleDictionary, type LocalizedString, type LocalizedText, type NfcDetectorOptions, type PasscodeCondition, type ProcessStampValue, type PublicRallyConfig, type PublicRewardItem, type QrDetectorOptions, type RallyConfig, type RallyConfigValidationResult, type RallySnapshot, type RedemptionMethod, type Result, type RewardConsumeError, type RewardItem, type RewardState, type RewardStatus, type RewardType, type RewardUnlockCondition, type SecureTokenError, type SecureTokenErrorCode, type SecureTokenOptions, type SecureTokenPayload, type SecureTokenSecretKey, type SecureTokenVerification, type SheetTheme, type SlotShape, type SnapshotSecretKey, type SnapshotTokenError, type SnapshotTokenErrorCode, type SnapshotTokenPayload, type SnapshotTokenVerification, type SpotItem, type StampCondition, type StampDefinition, type StampError, StampRallyClient, type StampRallyClientEvent, type StampRallyEvent, type StampRallyEventListener, type StampRallyListener, type StampRallyProgress, type StampRallyState, type StampRecord, type StampStorage, StorageAdapterError, type StorageAdapterErrorCode, type StorageLike, type StorageOperation, type StorageWarningHandler, type SupportedLocale, THEME_PRESETS, type ThemePreset, type ThemePresetId, type TokenVerificationContext, type ValidationError, type VerificationContext, calculateDistanceMeters, calculateProgress, consumeReward, createClaimTicketNumber, createSecureToken, createSignedSnapshotToken, createUniqueClaimTicketNumber, evaluateCheckIn, evaluateCondition, evaluateConditionDetailed, exportProgressToken, getCurrentGeoContext, importProgressToken, isGeolocationSupported, isNfcSupported, isQrSupported, isRewardState, isStampRallyState, issueClaimTicketNumber, migrateRallyConfig, normalizePasscode, processStamp, readNfcContext, readQrContext, reconcileRewardStates, resolveLocalizedText, stripSensitiveConfig, toLocalizedString, validateRallyConfig, verifyPasscode, verifySecureToken, verifySnapshotToken };