@explorins/pers-sdk-react-native 2.1.10 → 2.1.12

package/dist/hooks/useRedemptions.d.ts

@@ -1,12 +1,13 @@
 import { OnStatusUpdateFn } from './useTransactionSigner';
 import type { RedemptionCreateRequestDTO, RedemptionDTO, RedemptionRedeemDTO, RedemptionRedeemRequestResponseDTO, RedemptionTypeDTO, PaginatedResponseDTO, RedemptionRedeemIncludeRelation } from '@explorins/pers-shared';
 import type { RedemptionRedeemFilters } from '@explorins/pers-sdk/redemption';
+import type { PaginationOptions } from '@explorins/pers-sdk';
 export type { RedemptionRedeemFilters } from '@explorins/pers-sdk/redemption';
 export declare const useRedemptions: () => {
     getRedemptions: (options?: {
         active?: boolean;
     }) => Promise<PaginatedResponseDTO<RedemptionDTO>>;
-    getUserRedemptions: (include?: RedemptionRedeemIncludeRelation[]) => Promise<PaginatedResponseDTO<RedemptionRedeemDTO>>;
+    getUserRedemptions: (options?: PaginationOptions, include?: RedemptionRedeemIncludeRelation[]) => Promise<PaginatedResponseDTO<RedemptionRedeemDTO>>;
     redeem: (redemptionId: string, onStatusUpdate?: OnStatusUpdateFn) => Promise<RedemptionRedeemRequestResponseDTO>;
     getRedemptionTypes: () => Promise<PaginatedResponseDTO<RedemptionTypeDTO>>;
     getRedemptionRedeems: (filters?: RedemptionRedeemFilters, include?: RedemptionRedeemIncludeRelation[]) => Promise<PaginatedResponseDTO<RedemptionRedeemDTO>>;

package/dist/hooks/useRedemptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useRedemptions.d.ts","sourceRoot":"","sources":["../../src/hooks/useRedemptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0C,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAClG,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,iBAAiB,EACjB,oBAAoB,EACpB,+BAA+B,EAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAG9E,YAAY,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAE9E,eAAO,MAAM,cAAc;+BAY2B;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAAG,QAAQ,qBAAqB,aAAa,CAAC,CAAC;mCA+B3G,+BAA+B,EAAE,KAC1C,QAAQ,qBAAqB,mBAAmB,CAAC,CAAC;2BAkBL,MAAM,mBAAmB,gBAAgB,KAAG,QAAQ,kCAAkC,CAAC;8BAmGtF,QAAQ,qBAAqB,iBAAiB,CAAC,CAAC;qCA9BrF,uBAAuB,YACvB,+BAA+B,EAAE,KAC1C,QAAQ,qBAAqB,mBAAmB,CAAC,CAAC;uCAcO,0BAA0B,KAAG,QAAQ,aAAa,CAAC;qCA4BrD,MAAM,kBAAkB,0BAA0B,KAAG,QAAQ,aAAa,CAAC;2CAcrE,MAAM,KAAG,QAAQ,aAAa,CAAC;;;;CA4BhG,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC"}
+{"version":3,"file":"useRedemptions.d.ts","sourceRoot":"","sources":["../../src/hooks/useRedemptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0C,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAClG,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACb,mBAAmB,EACnB,kCAAkC,EAClC,iBAAiB,EACjB,oBAAoB,EACpB,+BAA+B,EAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAG7D,YAAY,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAE9E,eAAO,MAAM,cAAc;+BAY2B;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAAG,QAAQ,qBAAqB,aAAa,CAAC,CAAC;mCAoC3G,iBAAiB,YACjB,+BAA+B,EAAE,KAC1C,QAAQ,qBAAqB,mBAAmB,CAAC,CAAC;2BAkBL,MAAM,mBAAmB,gBAAgB,KAAG,QAAQ,kCAAkC,CAAC;8BAmGtF,QAAQ,qBAAqB,iBAAiB,CAAC,CAAC;qCA9BrF,uBAAuB,YACvB,+BAA+B,EAAE,KAC1C,QAAQ,qBAAqB,mBAAmB,CAAC,CAAC;uCAcO,0BAA0B,KAAG,QAAQ,aAAa,CAAC;qCA4BrD,MAAM,kBAAkB,0BAA0B,KAAG,QAAQ,aAAa,CAAC;2CAcrE,MAAM,KAAG,QAAQ,aAAa,CAAC;;;;CA4BhG,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/hooks/useRedemptions.js

@@ -26,22 +26,27 @@ export const useRedemptions = () => {
         }
     }, [sdk, isInitialized]);
     /**
-     * Get user's redemption history with optional include relations
+     * Get user's redemption history with optional pagination and include relations
      *
+     * @param options - Pagination options (page, limit, sortBy, sortOrder)
      * @param include - Relations to include: 'redemption', 'user', 'business'
      * @returns Promise resolving to paginated redemption history
      *
      * @example
      * ```typescript
+     * // Get first page of user redemptions
+     * const { data: redeems, pagination } = await getUserRedemptions({ page: 1, limit: 10 });
+     * console.log(`Page ${pagination.page} of ${pagination.pages}`);
+     *
      * // Get user redemptions with full redemption details
-     * const { data: redeems } = await getUserRedemptions(['redemption', 'business']);
+     * const { data: redeems } = await getUserRedemptions({}, ['redemption', 'business']);
      * redeems.forEach(redeem => {
      *   console.log('Redemption:', redeem.included?.redemption?.title);
      *   console.log('Business:', redeem.included?.business?.displayName);
      * });
      * ```
      */
-    const getUserRedemptions = useCallback(async (include) => {
+    const getUserRedemptions = useCallback(async (options, include) => {
         if (!isInitialized || !sdk) {
             throw new Error('SDK not initialized. Call initialize() first.');
         }
@@ -50,7 +55,7 @@ export const useRedemptions = () => {
             return { data: [], pagination: { page: 1, limit: 0, total: 0, pages: 0, hasNext: false, hasPrev: false } };
         }
         try {
-            const result = await sdk.redemptions.getUserRedemptions(undefined, include);
+            const result = await sdk.redemptions.getUserRedemptions(options, include);
             return result;
         }
         catch (error) {

package/dist/index.js

@@ -2933,15 +2933,42 @@ exports.PurchaseCurrency = void 0;
 })(exports.PurchaseCurrency || (exports.PurchaseCurrency = {}));
 
 /**
- * Trigger Source Types
- * Defines the different types of triggers that can activate a campaign flow
+ * Trigger Source Types - HOW a claim is triggered (the touchpoint mechanism)
+ *
+ * This defines the physical/digital interaction method for triggering claims.
+ * NOT to be confused with CampaignTriggerType which defines WHO can claim.
+ *
+ * Relationship:
+ * - campaign.trigger.triggerType → WHO can claim (CLAIM_BY_USER, CLAIM_BY_BUSINESS, CLAIM_BY_SYSTEM)
+ * - campaign.triggerSources[].type → HOW to claim (QR_CODE, NFC_TAG, GPS_GEOFENCE, etc.)
+ *
+ * Access via: campaign.included?.triggerSources?.map(ts => ts.type)
+ *
+ * App Integration Guide:
+ * - QR_CODE: Open camera/scanner, decode QR, extract triggerSourceId
+ * - NFC_TAG: Activate NFC reader, read tag data, extract triggerSourceId
+ * - GPS_GEOFENCE: Get user location, send latitude/longitude with claim
+ * - API_WEBHOOK: Server-to-server, external system triggers claim
+ * - TRANSACTION: Triggered by purchase events (Stripe, POS, etc.)
+ *
+ * NOTE: A campaign can have MULTIPLE trigger sources of different types.
+ * Example: Same campaign claimable via QR_CODE OR NFC_TAG at different locations.
+ *
  * Using const object pattern for better extensibility without requiring deploys
+ *
+ * @see CampaignTriggerType for WHO can initiate claims
+ * @see CampaignClaimRequestDTO for the claim payload structure
  */
 const TRIGGER_SOURCE_TYPES = {
+    /** Physical QR code scan. App opens camera, decodes QR, extracts triggerSourceId */
     QR_CODE: 'QR_CODE',
+    /** NFC tag tap. App activates NFC reader, reads tag data, extracts triggerSourceId */
     NFC_TAG: 'NFC_TAG',
+    /** Server-to-server webhook. External system triggers claim via API */
     API_WEBHOOK: 'API_WEBHOOK',
+    /** GPS-based geofence entry. App sends user coordinates for proximity validation */
     GPS_GEOFENCE: 'GPS_GEOFENCE',
+    /** Purchase/transaction triggered. Claim activated by payment events */
     TRANSACTION: 'TRANSACTION',
 };
 // Export values array for validation
@@ -2967,10 +2994,46 @@ exports.CampaignConditionType = void 0;
     CampaignConditionType["IS_PART_OF"] = "IS_PART_OF";
 })(exports.CampaignConditionType || (exports.CampaignConditionType = {}));
 
+/**
+ * Campaign Trigger Type - WHO can initiate a claim
+ *
+ * This defines the authentication/authorization context for claiming rewards.
+ * NOT to be confused with TriggerSourceType which defines HOW to claim (QR, NFC, etc.)
+ *
+ * Relationship:
+ * - campaign.trigger.triggerType → WHO can claim (CLAIM_BY_USER, CLAIM_BY_BUSINESS, CLAIM_BY_SYSTEM)
+ * - campaign.triggerSources[].type → HOW to claim (QR_CODE, NFC_TAG, GPS_GEOFENCE, etc.)
+ *
+ * Example Flow:
+ * 1. Campaign has triggerType=CLAIM_BY_USER (users initiate claims)
+ * 2. Campaign has triggerSources with type=QR_CODE (via QR scan)
+ * 3. User scans QR code → App calls claimCampaign with triggerSourceId
+ *
+ * @see TriggerSourceType for HOW claims are triggered
+ * @see CampaignClaimRequestDTO for the claim payload structure
+ */
 exports.CampaignTriggerType = void 0;
 (function (CampaignTriggerType) {
+    /**
+     * User-initiated claims. The end user triggers the claim action.
+     * App determines HOW via campaign.triggerSources[].type:
+     * - QR_CODE: Open camera/scanner
+     * - NFC_TAG: Activate NFC reader
+     * - GPS_GEOFENCE: Send user location
+     * - TRANSACTION: Triggered by purchase
+     */
     CampaignTriggerType["CLAIM_BY_USER"] = "CLAIM_BY_USER";
+    /**
+     * System/server-initiated claims. Automated processes trigger claims.
+     * Use cases: webhooks, scheduled jobs, backend integrations.
+     * Requires tenant API key authentication.
+     */
     CampaignTriggerType["CLAIM_BY_SYSTEM"] = "CLAIM_BY_SYSTEM";
+    /**
+     * Business-initiated claims. A business claims on behalf of users.
+     * Use cases: POS systems, staff-assisted redemptions, kiosks.
+     * Requires business authentication + user identifier.
+     */
     CampaignTriggerType["CLAIM_BY_BUSINESS"] = "CLAIM_BY_BUSINESS";
 })(exports.CampaignTriggerType || (exports.CampaignTriggerType = {}));
 
@@ -7703,15 +7766,26 @@ class TenantApi {
     // ==========================================
     // PUBLIC OPERATIONS
     // ==========================================
+    /**
+     * API KEY + ADMIN JWT: Get full tenant information including sensitive config
+     * Uses /tenants/me endpoint with Admin JWT authentication
+     *
+     * Requires: X-API-Key header + Authorization Bearer token (Admin JWT)
+     * Returns: Full tenant information including allowedTokenIssuers and sensitive config
+     */
+    async getRemoteTenant() {
+        const timestamp = Date.now().toString();
+        const url = `${this.basePath}/me?date=${timestamp}`;
+        return this.apiClient.get(url);
+    }
     /**
      * API KEY: Get current tenant public information
-     * UPDATED: Uses /tenants/me endpoint with API key authentication
+     * Uses /tenants/me endpoint with API key authentication
      *
      * Requires: X-API-Key header (handled by PersApiClient)
-     * Returns: Enhanced public tenant information for the authenticated project
+     * Returns: Public tenant information (no sensitive config)
      */
-    async getRemoteTenant() {
-        // Remove cache busting - not needed for authenticated endpoint
+    async getRemoteTenantPublic() {
         const timestamp = Date.now().toString();
         const url = `${this.basePath}/me?date=${timestamp}`;
         return this.apiClient.get(url);
@@ -7748,7 +7822,8 @@ class TenantApi {
     // ==========================================
     /**
      * ADMIN: Update tenant information
-     *  UPDATED: Uses PUT /tenants (admin endpoint)
+     * UPDATED: Uses PUT /tenants (admin endpoint)
+     * Returns full TenantDTO including sensitive config
      */
     async updateRemoteTenant(tenantData) {
         return this.apiClient.put(`${this.basePath}`, tenantData);
@@ -7793,11 +7868,17 @@ class TenantService {
     // PUBLIC OPERATIONS
     // ==========================================
     /**
-     * PUBLIC: Get tenant public information
+     * Get full tenant information (Admin JWT required)
      */
     async getRemoteTenant() {
         return this.tenantApi.getRemoteTenant();
     }
+    /**
+     * PUBLIC: Get tenant public information (API key only)
+     */
+    async getRemoteTenantPublic() {
+        return this.tenantApi.getRemoteTenantPublic();
+    }
     /**
      * PUBLIC: Get remote login token
      */
@@ -7815,7 +7896,7 @@ class TenantService {
     // ==========================================
     /**
      * ADMIN: Update tenant information
-     * ✅ FIXED: Uses TenantPublicDTO directly like framework
+     * Returns full TenantDTO including sensitive config
      */
     async updateRemoteTenant(tenantData) {
         return this.tenantApi.updateRemoteTenant(tenantData);
@@ -7859,9 +7940,20 @@ class TenantManager {
         this.tenantService = new TenantService(tenantApi);
     }
     /**
-     * Get current tenant information
+     * Get current tenant public information (API key only)
      *
-     * @returns Promise resolving to tenant data
+     * @returns Promise resolving to public tenant data
+     */
+    async getTenantPublicInfo() {
+        return this.tenantService.getRemoteTenantPublic();
+    }
+    /**
+     * Get full tenant information including sensitive config (Admin JWT required)
+     *
+     * Returns additional fields like allowedTokenIssuers that are only
+     * available to authenticated tenant admins.
+     *
+     * @returns Promise resolving to full tenant data
      */
     async getTenantInfo() {
         return this.tenantService.getRemoteTenant();
@@ -7944,7 +8036,7 @@ class TenantManager {
      * Admin: Update tenant data
      *
      * @param tenantData - Updated tenant data
-     * @returns Promise resolving to updated tenant
+     * @returns Promise resolving to full updated tenant (includes sensitive config)
      */
     async updateTenant(tenantData) {
         return this.tenantService.updateRemoteTenant(tenantData);
@@ -41600,22 +41692,27 @@ const useRedemptions = () => {
         }
     }, [sdk, isInitialized]);
     /**
-     * Get user's redemption history with optional include relations
+     * Get user's redemption history with optional pagination and include relations
      *
+     * @param options - Pagination options (page, limit, sortBy, sortOrder)
      * @param include - Relations to include: 'redemption', 'user', 'business'
      * @returns Promise resolving to paginated redemption history
      *
      * @example
      * ```typescript
+     * // Get first page of user redemptions
+     * const { data: redeems, pagination } = await getUserRedemptions({ page: 1, limit: 10 });
+     * console.log(`Page ${pagination.page} of ${pagination.pages}`);
+     *
      * // Get user redemptions with full redemption details
-     * const { data: redeems } = await getUserRedemptions(['redemption', 'business']);
+     * const { data: redeems } = await getUserRedemptions({}, ['redemption', 'business']);
      * redeems.forEach(redeem => {
      *   console.log('Redemption:', redeem.included?.redemption?.title);
      *   console.log('Business:', redeem.included?.business?.displayName);
      * });
      * ```
      */
-    const getUserRedemptions = react.useCallback(async (include) => {
+    const getUserRedemptions = react.useCallback(async (options, include) => {
         if (!isInitialized || !sdk) {
             throw new Error('SDK not initialized. Call initialize() first.');
         }
@@ -41624,7 +41721,7 @@ const useRedemptions = () => {
             return { data: [], pagination: { page: 1, limit: 0, total: 0, pages: 0, hasNext: false, hasPrev: false } };
         }
         try {
-            const result = await sdk.redemptions.getUserRedemptions(undefined, include);
+            const result = await sdk.redemptions.getUserRedemptions(options, include);
             return result;
         }
         catch (error) {