@explorins/pers-sdk-react-native 1.5.18 → 1.5.21

package/dist/index.d.ts

@@ -1,9 +1,219 @@
+/**
+ * @fileoverview PERS SDK for React Native - Tourism Loyalty System
+ *
+ * A comprehensive React Native SDK for integrating with the PERS (Phygital Experience Rewards System)
+ * platform. Provides complete functionality for tourism loyalty applications including user management,
+ * token operations, business integrations, campaign management, and blockchain transaction signing.
+ *
+ * **Key Features:**
+ * - Secure authentication with React Native Keychain integration
+ * - Token management (earn, redeem, transfer, balance checking)
+ * - Business and campaign management
+ * - Blockchain transaction signing with WebAuthn
+ * - React Native optimized with automatic polyfills
+ * - Type-safe interfaces with comprehensive TypeScript support
+ * - Analytics and reporting capabilities
+ * - Donation and charitable giving features
+ *
+ * @example
+ * **Quick Start:**
+ * ```typescript
+ * import { PersSDKProvider, usePersSDK, useTransactionSigner } from '@explorins/pers-sdk-react-native';
+ *
+ * // 1. Wrap your app with the provider
+ * function App() {
+ *   return (
+ *     <PersSDKProvider config={{ apiUrl: 'https://api.pers.ninja' }}>
+ *       <YourApp />
+ *     </PersSDKProvider>
+ *   );
+ * }
+ *
+ * // 2. Use hooks in your components
+ * function RewardScreen() {
+ *   const { user, isAuthenticated, earnTokens } = usePersSDK();
+ *   const { signAndSubmitTransactionWithJWT } = useTransactionSigner();
+ *
+ *   // Your reward logic here...
+ * }
+ * ```
+ *
+ * @version 1.5.19
+ * @author eXplorins
+ * @license MIT
+ */
 import './polyfills';
-export { ReactNativeAuthProvider, type ReactNativeAuthConfig } from './providers/react-native-auth-provider';
+/**
+ * React Native-specific authentication provider with secure keychain integration
+ *
+ * Provides secure token storage using React Native Keychain, biometric authentication,
+ * and automatic token refresh capabilities.
+ *
+ * @see {@link createReactNativeAuthProvider} - Factory function for auth provider
+ * @see {@link ReactNativeAuthConfig} - Configuration interface
+ */
+export { createReactNativeAuthProvider, type ReactNativeAuthConfig } from './providers/react-native-auth-provider';
+/**
+ * Secure token storage using React Native AsyncStorage
+ *
+ * Provides encrypted token storage with automatic cleanup and secure key management.
+ * Integrates with React Native Keychain for enhanced security on supported devices.
+ *
+ * @see {@link AsyncStorageTokenStorage} - Secure storage implementation
+ */
+export { AsyncStorageTokenStorage, } from './storage/async-storage-token-storage';
+/**
+ * Main PERS SDK provider and context for React Native applications
+ *
+ * The PersSDKProvider should wrap your entire app to provide PERS functionality
+ * throughout your component tree. Use usePersSDK hook to access SDK features.
+ *
+ * @example
+ * ```typescript
+ * import { PersSDKProvider, usePersSDK } from '@explorins/pers-sdk-react-native';
+ *
+ * function App() {
+ *   return (
+ *     <PersSDKProvider config={{
+ *       apiUrl: 'https://api.pers.ninja',
+ *       tenantId: 'your-tenant-id'
+ *     }}>
+ *       <NavigationContainer>
+ *         <YourAppContent />
+ *       </NavigationContainer>
+ *     </PersSDKProvider>
+ *   );
+ * }
+ *
+ * function YourComponent() {
+ *   const { user, isAuthenticated, earnTokens } = usePersSDK();
+ *   // Use PERS functionality here...
+ * }
+ * ```
+ *
+ * @see {@link PersSDKProvider} - Main provider component
+ * @see {@link usePersSDK} - Hook to access SDK functionality
+ * @see {@link PersConfig} - Provider configuration interface
+ * @see {@link PersSDKContext} - Context type definition
+ */
 export { PersSDKProvider, usePersSDK, type PersConfig, type PersSDKContext } from './providers/PersSDKProvider';
+/**
+ * Comprehensive React hooks for PERS platform integration
+ *
+ * These hooks provide the primary interface for interacting with the PERS platform
+ * in React Native applications. Each hook is optimized for specific functionality
+ * and includes automatic error handling, loading states, and real-time updates.
+ *
+ * **Authentication & User Management:**
+ * - `useAuth` - User authentication, login, logout, registration
+ * - `useUsers` - User profile management and data operations
+ * - `useUserStatus` - Real-time user status and activity monitoring
+ *
+ * **Token & Financial Operations:**
+ * - `useTokens` - Token balance, earning, and management
+ * - `useTransactions` - Transaction history and monitoring
+ * - `useTransactionSigner` - **⭐ Blockchain transaction signing**
+ * - `usePurchases` - Purchase history and payment processing
+ * - `useDonations` - Charitable giving and donation management
+ *
+ * **Business & Campaign Management:**
+ * - `useBusiness` - Business profile and operations
+ * - `useCampaigns` - Marketing campaigns and promotions
+ * - `useRedemptions` - Reward redemption and fulfillment
+ *
+ * **Platform & Analytics:**
+ * - `useTenants` - Multi-tenant configuration and management
+ * - `useAnalytics` - Usage analytics and reporting
+ * - `useFiles` - File upload and management
+ * - `useWeb3` - Blockchain integration and wallet operations
+ *
+ * @example
+ * **Token Operations:**
+ * ```typescript
+ * import { useTokens, useTransactionSigner } from '@explorins/pers-sdk-react-native';
+ *
+ * function TokenScreen() {
+ *   const { balance, earnTokens, redeemTokens } = useTokens();
+ *   const { signAndSubmitTransactionWithJWT } = useTransactionSigner();
+ *
+ *   const handleEarn = async (amount: number) => {
+ *     const result = await earnTokens({ amount, source: 'reward' });
+ *     console.log('Earned tokens:', result);
+ *   };
+ *
+ *   const handleRedeem = async (amount: number) => {
+ *     const redemption = await redeemTokens({ amount });
+ *     const txResult = await signAndSubmitTransactionWithJWT(redemption.jwtToken);
+ *     console.log('Redemption completed:', txResult.transactionHash);
+ *   };
+ * }
+ * ```
+ *
+ * @example
+ * **Campaign Integration:**
+ * ```typescript
+ * import { useCampaigns, useAuth } from '@explorins/pers-sdk-react-native';
+ *
+ * function CampaignScreen() {
+ *   const { activeCampaigns, participateInCampaign } = useCampaigns();
+ *   const { user } = useAuth();
+ *
+ *   const handleParticipate = async (campaignId: string) => {
+ *     const result = await participateInCampaign(campaignId, {
+ *       userId: user?.id,
+ *       participationData: { source: 'mobile_app' }
+ *     });
+ *   };
+ * }
+ * ```
+ */
 export { useAuth, useTokens, useTransactions, useTransactionSigner, useBusiness, useCampaigns, useRedemptions, useWeb3, usePurchases, useTenants, useUsers, useUserStatus, useFiles, useAnalytics, useDonations } from './hooks';
+/**
+ * React Native-optimized HTTP client with automatic request/response handling
+ *
+ * Provides platform-specific networking with proper error handling, timeout management,
+ * and React Native compatibility. Automatically handles headers, authentication tokens,
+ * and response parsing.
+ */
 export { ReactNativeHttpClient } from './providers/react-native-http-client';
+/**
+ * React Native polyfill utilities for web compatibility
+ *
+ * Automatically initializes required polyfills for crypto, URL, and other web APIs
+ * that may not be available in React Native environments. These are typically
+ * loaded automatically, but manual initialization is available for advanced use cases.
+ *
+ * @see {@link initializeReactNativePolyfills} - Manual polyfill initialization
+ */
 export { initializeReactNativePolyfills } from './polyfills';
+/**
+ * Re-export all types and utilities from the shared PERS library
+ *
+ * This includes all core types, DTOs, enums, and utility functions used across
+ * the PERS platform. These types ensure consistency between different SDK versions
+ * and platform implementations.
+ *
+ * **Included Types:**
+ * - User and authentication types (UserDTO, AuthenticationResult, etc.)
+ * - Token and transaction types (TokenDTO, TransactionDTO, etc.)
+ * - Business and campaign types (BusinessDTO, CampaignDTO, etc.)
+ * - API request/response types for all endpoints
+ * - Error types and status enums
+ *
+ * @see {@link https://github.com/eXplorins/pers-shared} - Shared library documentation
+ */
 export * from '@explorins/pers-shared';
+/**
+ * Re-export Web3 and blockchain-related types from base SDK
+ *
+ * Provides TypeScript definitions for Web3 operations, token management,
+ * and blockchain interactions. These types are used by the transaction
+ * signing hooks and Web3 integration features.
+ *
+ * @see {@link TokenBalanceRequest} - Request structure for token balance queries
+ * @see {@link TokenBalance} - Token balance response data
+ * @see {@link TokenMetadata} - Token metadata and details
+ * @see {@link TokenCollection} - Collection of tokens for batch operations
+ */
 export type { TokenBalanceRequest, TokenBalance, TokenMetadata, TokenCollection, TokenCollectionRequest } from '@explorins/pers-sdk/web3';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,CAAC;AAGrB,OAAO,EACL,uBAAuB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,wCAAwC,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,UAAU,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,OAAO,EACP,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,YAAY,EACZ,cAAc,EACd,OAAO,EACP,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACL,8BAA8B,EAC/B,MAAM,aAAa,CAAC;AAGrB,cAAc,wBAAwB,CAAC;AAGvC,YAAY,EACV,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,sBAAsB,EACvB,MAAM,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAGH,OAAO,aAAa,CAAC;AAMrB;;;;;;;;GAQG;AACH,OAAO,EACL,6BAA6B,EAC7B,KAAK,qBAAqB,EAC3B,MAAM,wCAAwC,CAAC;AAMhD;;;;;;;GAOG;AACH,OAAO,EACL,wBAAwB,GACzB,MAAM,uCAAuC,CAAC;AAM/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,OAAO,EACL,eAAe,EACf,UAAU,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,6BAA6B,CAAC;AAMrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,OAAO,EACL,OAAO,EACP,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,YAAY,EACZ,cAAc,EACd,OAAO,EACP,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,EACb,MAAM,SAAS,CAAC;AAMjB;;;;;;GAMG;AACH,OAAO,EACL,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAM9C;;;;;;;;GAQG;AACH,OAAO,EACL,8BAA8B,EAC/B,MAAM,aAAa,CAAC;AAMrB;;;;;;;;;;;;;;;GAeG;AACH,cAAc,wBAAwB,CAAC;AAEvC;;;;;;;;;;;GAWG;AACH,YAAY,EACV,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,sBAAsB,EACvB,MAAM,0BAA0B,CAAC"}