@simonarcher/fika-types 1.0.43 → 1.0.45

package/dist/index.d.ts

@@ -7,3 +7,4 @@ export * from './coffeeEvents';
 export * from './quest';
 export * from './notificationChannels';
 export * from './userShopOrder';
+export * from './loyalty';

package/dist/index.js

@@ -32,3 +32,5 @@ __exportStar(require("./quest"), exports);
 __exportStar(require("./notificationChannels"), exports);
 // Export all user shop order-related types
 __exportStar(require("./userShopOrder"), exports);
+// Export all loyalty-related types
+__exportStar(require("./loyalty"), exports);

package/dist/loyalty.d.ts

@@ -0,0 +1,339 @@
+import { Timestamp as AdminTimestamp } from "firebase-admin/firestore";
+/**
+ * JWT payload structure for voucher QR codes
+ * Contains essential voucher information for secure redemption
+ */
+export interface QRTokenPayload {
+    /** Unique voucher identifier */
+    voucherId: string;
+    /** User who owns the voucher */
+    userId: string;
+    /** Shop where voucher can be redeemed */
+    shopId: string;
+    /** Token expiry timestamp (Unix time) */
+    exp: number;
+    /** Token issued at timestamp (Unix time) */
+    iat: number;
+    /** 6-digit backup verification code */
+    securityCode: string;
+}
+/**
+ * Enhanced voucher document with QR token support
+ * Extends the basic voucher with security and redemption tracking
+ */
+export interface LoyaltyVoucher {
+    /** Unique voucher identifier */
+    id: string;
+    /** User who earned the voucher */
+    userId: string;
+    /** Shop where voucher can be redeemed */
+    shopId: string;
+    /** Stamps used to create this voucher */
+    stamps: string[];
+    /** When voucher was created */
+    createdAt: AdminTimestamp;
+    /** Whether voucher is still valid */
+    valid: boolean;
+    /** Whether voucher has been redeemed */
+    redeemed: boolean;
+    /** When voucher was redeemed (if applicable) */
+    redeemedAt?: AdminTimestamp;
+    /** Staff member who processed redemption */
+    redeemedBy?: string;
+    /** Shop ID where redemption occurred */
+    redemptionLocation?: string;
+    /** Current QR token (if active) */
+    qrToken?: string;
+    /** When current QR token expires */
+    tokenExpiresAt?: AdminTimestamp;
+    /** Current 6-digit security code */
+    securityCode?: string;
+    /** Type of reward (e.g., 'free_coffee', 'discount') */
+    rewardType: string;
+    /** Human-readable reward description */
+    rewardDescription: string;
+}
+/**
+ * Request to generate a new QR token for a voucher
+ */
+export interface GenerateQRRequest {
+    /** Voucher to generate QR code for */
+    voucherId: string;
+    /** User requesting the QR code */
+    userId: string;
+}
+/**
+ * Response containing QR token information
+ */
+export interface GenerateQRResponse {
+    /** JWT token for QR code */
+    qrToken: string;
+    /** When token expires (ISO string) */
+    expiresAt: string;
+    /** 6-digit backup code */
+    securityCode: string;
+    /** Success status */
+    success: boolean;
+}
+/**
+ * Request to redeem a voucher via QR scan
+ */
+export interface RedeemVoucherRequest {
+    /** JWT token from QR code */
+    qrToken: string;
+    /** Staff member processing redemption */
+    staffId: string;
+    /** Shop where redemption is happening */
+    shopId: string;
+}
+/**
+ * Request to validate a voucher without redeeming
+ */
+export interface ValidateVoucherRequest {
+    /** JWT token from QR code */
+    qrToken: string;
+    /** Shop validating the voucher */
+    shopId: string;
+}
+/**
+ * User information for voucher redemption display
+ */
+export interface VoucherUserInfo {
+    /** User's display name */
+    name?: string;
+    /** User's email */
+    email?: string;
+    /** User's profile picture URL */
+    profilePicture?: string;
+    /** User ID */
+    userId: string;
+}
+/**
+ * Response for voucher redemption
+ */
+export interface RedeemVoucherResponse {
+    /** Whether redemption was successful */
+    success: boolean;
+    /** Error message if redemption failed */
+    message?: string;
+    /** Redeemed voucher details */
+    voucher?: LoyaltyVoucher;
+    /** User information */
+    user?: VoucherUserInfo;
+}
+/**
+ * Response for voucher validation
+ */
+export interface ValidateVoucherResponse {
+    /** Whether voucher is valid */
+    valid: boolean;
+    /** Error message if validation failed */
+    message?: string;
+    /** Voucher details (if valid) */
+    voucher?: LoyaltyVoucher;
+    /** User information (if valid) */
+    user?: VoucherUserInfo;
+}
+/**
+ * Configuration for QR token generation
+ */
+export interface QRTokenConfig {
+    /** JWT secret for signing tokens */
+    secret: string;
+    /** Token expiry time in minutes */
+    expiryMinutes: number;
+}
+/**
+ * Request to refresh a QR token
+ */
+export interface RefreshQRTokenRequest {
+    /** Current QR token (can be expired) */
+    qrToken: string;
+    /** User ID for verification */
+    userId: string;
+    /** Optional custom expiry time in minutes */
+    customExpiryMinutes?: number;
+}
+/**
+ * Response from QR token refresh
+ */
+export interface RefreshQRTokenResponse {
+    /** Success status */
+    success: boolean;
+    /** New QR token (if successful) */
+    qrToken?: string;
+    /** New expiry time (if successful) */
+    expiresAt?: string;
+    /** New security code (if successful) */
+    securityCode?: string;
+    /** Error message (if failed) */
+    message?: string;
+    /** Time remaining on old token (if any) */
+    oldTokenTimeRemaining?: {
+        totalMs: number;
+        minutes: number;
+        seconds: number;
+        isExpired: boolean;
+    };
+}
+/**
+ * Request to check QR token expiry status
+ */
+export interface CheckTokenExpiryRequest {
+    /** QR token to check */
+    qrToken: string;
+    /** User ID for verification */
+    userId: string;
+}
+/**
+ * Response from token expiry check
+ */
+export interface CheckTokenExpiryResponse {
+    /** Success status */
+    success: boolean;
+    /** Whether token is expired */
+    isExpired: boolean;
+    /** Expiry time */
+    expiresAt?: string;
+    /** Time remaining until expiry */
+    timeRemaining?: {
+        totalMs: number;
+        minutes: number;
+        seconds: number;
+    };
+    /** Voucher information */
+    voucherInfo?: {
+        voucherId: string;
+        shopId: string;
+    };
+    /** Error message (if failed) */
+    message?: string;
+}
+/**
+ * User QR code payload for stamp collection
+ * Simple user identification for business scanning
+ */
+export interface UserQRPayload {
+    /** User ID for identification */
+    userId: string;
+    /** User's name for display */
+    userName?: string;
+    /** QR generation timestamp */
+    generatedAt: number;
+    /** QR code type identifier */
+    type: 'user_identification';
+}
+/**
+ * Request to validate a user QR code
+ */
+export interface ValidateUserQRRequest {
+    /** User QR code content */
+    userQR: string;
+    /** Shop ID where validation is happening */
+    shopId: string;
+    /** Staff ID performing the validation */
+    staffId?: string;
+}
+/**
+ * Response from user QR validation
+ */
+export interface ValidateUserQRResponse {
+    /** Whether validation was successful */
+    success: boolean;
+    /** Whether the QR code is valid */
+    valid: boolean;
+    /** Error message if validation failed */
+    message?: string;
+    /** User information if valid */
+    user?: {
+        userId: string;
+        name?: string;
+        email?: string;
+        profilePicture?: string;
+    };
+    /** Current stamp count for this shop */
+    currentStamps?: number;
+    /** Stamps required for voucher */
+    stampsRequired?: number;
+    /** Whether user can create a voucher */
+    canCreateVoucher?: boolean;
+}
+/**
+ * Request to reward stamps to a user
+ */
+export interface RewardStampsRequest {
+    /** User to reward stamps to */
+    userId: string;
+    /** Shop awarding the stamps */
+    shopId: string;
+    /** Number of stamps to award */
+    stampCount: number;
+    /** Staff member awarding the stamps */
+    staffId: string;
+    /** Method of stamp award */
+    issueMethod: 'app' | 'nfc';
+    /** Type of stamp */
+    type?: string;
+}
+/**
+ * Response from stamp reward
+ */
+export interface RewardStampsResponse {
+    /** Whether reward was successful */
+    success: boolean;
+    /** Error message if failed */
+    message?: string;
+    /** New total stamp count for user at shop */
+    newStampCount?: number;
+    /** Stamps awarded in this transaction */
+    stampsAwarded?: number;
+    /** User information */
+    user?: {
+        userId: string;
+        name?: string;
+        email?: string;
+    };
+    /** Whether user can now create a voucher */
+    canCreateVoucher?: boolean;
+    /** Stamps required for voucher */
+    stampsRequired?: number;
+    /** Action ID for the stamp reward transaction */
+    actionId?: string;
+}
+/**
+ * Request to get user stamp progress
+ */
+export interface UserStampProgressRequest {
+    /** User ID */
+    userId: string;
+    /** Shop ID */
+    shopId: string;
+}
+/**
+ * Response with user stamp progress
+ */
+export interface UserStampProgressResponse {
+    /** Success status */
+    success: boolean;
+    /** Current number of stamps */
+    currentStamps: number;
+    /** Stamps required for voucher */
+    stampsRequired: number;
+    /** Whether user can create voucher */
+    canCreateVoucher: boolean;
+    /** User information */
+    user?: {
+        userId: string;
+        name?: string;
+        email?: string;
+    };
+    /** Shop information */
+    shop?: {
+        shopId: string;
+        name?: string;
+        rewardType?: string;
+        rewardDescription?: string;
+    };
+    /** Error message if failed */
+    message?: string;
+}

package/dist/loyalty.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/userShopOrder.d.ts

@@ -1,3 +1,11 @@
+export interface SaveUserShopOrderRequest {
+    userId: string;
+    shopId: string;
+    orderDate: Date;
+    loyaltyRewardActionId?: string;
+    items: UserShopOrderItem[];
+    servedByStaffId?: string;
+}
 export interface UserShopOrder {
     id: string;
     userId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@simonarcher/fika-types",
-    "version": "1.0.43",
+    "version": "1.0.45",
     "description": "Shared TypeScript types for Fika projects",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",