@passgage/sdk-react-native 1.0.3 → 1.0.4

package/README.md

@@ -1,13 +1,13 @@
-# @passgage-sdk/react-native
+# @passgage/sdk-react-native
 
-React Native wrapper for Passgage Access SDK with ready-to-use components and hooks.
+Complete Passgage Access SDK for React Native with authentication, QR/NFC scanning, check-in, and remote work features.
 
 ## Installation
 
 ```bash
-npm install @passgage-sdk/react-native @passgage-sdk/core
+npm install @passgage/sdk-react-native
 # or
-yarn add @passgage-sdk/react-native @passgage-sdk/core
+yarn add @passgage/sdk-react-native
 ```
 
 ### Peer Dependencies
@@ -15,13 +15,14 @@ yarn add @passgage-sdk/react-native @passgage-sdk/core
 You also need to install these peer dependencies:
 
 ```bash
-npm install react-native-vision-camera react-native-nfc-manager @react-native-community/geolocation
+npm install react-native-vision-camera react-native-nfc-manager @react-native-community/geolocation react-native-keychain
 ```
 
 Follow the installation instructions for each native library:
 - [react-native-vision-camera](https://react-native-vision-camera.com/docs/guides)
 - [react-native-nfc-manager](https://github.com/revtel/react-native-nfc-manager)
 - [@react-native-community/geolocation](https://github.com/react-native-geolocation/react-native-geolocation)
+- [react-native-keychain](https://github.com/oblador/react-native-keychain)
 
 ## Usage
 
@@ -30,13 +31,16 @@ Follow the installation instructions for each native library:
 Wrap your app with `PassgageAccessProvider`:
 
 ```typescript
-import { PassgageAccessProvider } from '@passgage-sdk/react-native';
+import { PassgageAccessProvider } from '@passgage/sdk-react-native';
 
 function App() {
   return (
     <PassgageAccessProvider
       baseURL="https://your-api.passgage.com"
-      token="your-jwt-token"
+      onUnauthorized={() => {
+        // Handle session expiration
+        console.log('Session expired');
+      }}
     >
       <YourApp />
     </PassgageAccessProvider>
@@ -44,13 +48,47 @@ function App() {
 }
 ```
 
-### QR Scanner Hook
+### Authentication
 
 ```typescript
-import { useQRScanner } from '@passgage-sdk/react-native';
+import { usePassgageAuth } from '@passgage/sdk-react-native';
+
+function LoginScreen() {
+  const { login, logout, user, isLoading, isAuthenticated } = usePassgageAuth({
+    onLoginSuccess: (user) => {
+      console.log('Logged in:', user?.fullName);
+    },
+    onLoginError: (error) => {
+      console.error('Login failed:', error);
+    },
+  });
+
+  const handleLogin = async () => {
+    await login({
+      login: 'user@example.com',
+      password: 'password123',
+    });
+  };
+
+  return (
+    <View>
+      {isAuthenticated ? (
+        <Text>Welcome, {user?.fullName}!</Text>
+      ) : (
+        <Button title="Login" onPress={handleLogin} disabled={isLoading} />
+      )}
+    </View>
+  );
+}
+```
+
+### QR Scanner
+
+```typescript
+import { usePassgageQRScanner } from '@passgage/sdk-react-native';
 
 function QRScanScreen() {
-  const { scan, isLoading, error } = useQRScanner({
+  const { scan, isLoading, error } = usePassgageQRScanner({
     onSuccess: (entrance) => {
       console.log('QR scan successful:', entrance);
     },
@@ -61,20 +99,22 @@ function QRScanScreen() {
 
   return (
     <View>
-      {/* Your camera view */}
-      <Camera onCodeScanned={(code) => scan(code)} />
+      <Camera
+        onCodeScanned={(code) => scan(code)}
+        isActive={!isLoading}
+      />
     </View>
   );
 }
 ```
 
-### NFC Scanner Hook
+### NFC Scanner
 
 ```typescript
-import { useNFCScanner } from '@passgage-sdk/react-native';
+import { usePassgageNFCScanner } from '@passgage/sdk-react-native';
 
 function NFCScanScreen() {
-  const { startScanning, stopScanning, isScanning } = useNFCScanner({
+  const { startScanning, stopScanning, isScanning } = usePassgageNFCScanner({
     onSuccess: (entrance) => {
       console.log('NFC scan successful:', entrance);
     },
@@ -88,28 +128,48 @@ function NFCScanScreen() {
     return () => stopScanning();
   }, []);
 
-  return <View>{/* Your NFC scan UI */}</View>;
+  return (
+    <View>
+      <Text>{isScanning ? 'Scanning...' : 'Tap to scan'}</Text>
+    </View>
+  );
 }
 ```
 
-### Check-In Hook
+### Check-In
 
 ```typescript
-import { useCheckIn } from '@passgage-sdk/react-native';
+import { usePassgageCheckIn, usePassgageAuth } from '@passgage/sdk-react-native';
 
 function CheckInScreen() {
-  const { nearbyBranches, checkIn, isLoading } = useCheckIn();
+  const { user } = usePassgageAuth();
+  const { getNearbyBranches, checkInEntry, checkInExit, isLoading } = usePassgageCheckIn();
+  const [branches, setBranches] = useState([]);
+
+  useEffect(() => {
+    const loadBranches = async () => {
+      const result = await getNearbyBranches({ radius: 5000 });
+      if (result.success) {
+        setBranches(result.data);
+      }
+    };
+    loadBranches();
+  }, []);
 
   const handleCheckIn = async (branchId: string) => {
-    await checkIn({
+    const result = await checkInEntry({
       branchId,
-      entranceType: 0, // 0 = ENTRY, 1 = EXIT
+      userId: user.id,
     });
+
+    if (result.success) {
+      console.log('Checked in successfully');
+    }
   };
 
   return (
     <View>
-      {nearbyBranches.map((branch) => (
+      {branches.map((branch) => (
         <TouchableOpacity key={branch.id} onPress={() => handleCheckIn(branch.id)}>
           <Text>{branch.title}</Text>
         </TouchableOpacity>
@@ -119,18 +179,41 @@ function CheckInScreen() {
 }
 ```
 
-### Remote Work Hook
+### Remote Work
 
 ```typescript
-import { useRemoteWork } from '@passgage-sdk/react-native';
+import { usePassgageRemoteWork, usePassgageAuth } from '@passgage/sdk-react-native';
 
 function RemoteWorkScreen() {
-  const { logEntry, logExit, isLoading } = useRemoteWork();
+  const { user } = usePassgageAuth();
+  const { logEntry, logExit, isLoading } = usePassgageRemoteWork();
+
+  const handleStartWork = async () => {
+    const result = await logEntry({
+      userId: user.id,
+      description: 'Working from home',
+    });
+
+    if (result.success) {
+      console.log('Work entry logged');
+    }
+  };
+
+  const handleEndWork = async () => {
+    const result = await logExit({
+      userId: user.id,
+      description: 'Finished work',
+    });
+
+    if (result.success) {
+      console.log('Work exit logged');
+    }
+  };
 
   return (
     <View>
-      <Button title="Log Entry" onPress={() => logEntry()} />
-      <Button title="Log Exit" onPress={() => logExit()} />
+      <Button title="Start Work" onPress={handleStartWork} disabled={isLoading} />
+      <Button title="End Work" onPress={handleEndWork} disabled={isLoading} />
     </View>
   );
 }
@@ -140,17 +223,66 @@ function RemoteWorkScreen() {
 
 ### Hooks
 
-- `useQRScanner()` - QR code scanning with validation
-- `useNFCScanner()` - NFC card scanning with validation
-- `useCheckIn()` - GPS-based check-in
-- `useRemoteWork()` - Remote work logging
-- `useLocation()` - Location tracking
-- `usePassgageAccess()` - Access SDK context
+All hooks use the `usePassgage*` prefix to avoid naming conflicts:
+
+- `usePassgageAuth()` - Authentication and user management
+- `usePassgageQRScanner()` - QR code scanning with validation
+- `usePassgageNFCScanner()` - NFC card scanning with validation
+- `usePassgageCheckIn()` - GPS-based check-in with nearby branches
+- `usePassgageRemoteWork()` - Remote work entry/exit logging
+- `useLocation()` - Location tracking and permissions
+- `usePassgageAccess()` - Access SDK context and services
 
 ### Components
 
 - `<PassgageAccessProvider>` - SDK configuration provider
 
+### Services
+
+Low-level services are also available through `usePassgageAccess()`:
+
+- `authService` - Authentication operations
+- `qrAccessService` - QR code validation
+- `nfcAccessService` - NFC card validation
+- `checkInService` - Check-in operations
+- `remoteWorkService` - Remote work logging
+- `locationService` - Location management
+- `deviceAccessService` - Device operations
+
+## Security Features
+
+- **JWT Authentication**: Secure token-based authentication
+- **Automatic Token Refresh**: Tokens are automatically refreshed when expired
+- **Secure Storage**: Tokens stored securely using platform-specific secure storage
+- **TLS 1.2+**: All network communications encrypted
+- **Location Verification**: Automatic location validation with range checking
+- **Anti-Passback**: Support for anti-passback rules
+
+## Token Flow
+
+The SDK automatically handles authentication tokens:
+
+1. User logs in → JWT tokens stored securely
+2. API client automatically adds `Authorization: Bearer {token}` to all requests
+3. Tokens are automatically refreshed when they expire
+4. On logout, all tokens are cleared
+
+**You don't need to manually manage tokens!** Just use the hooks and the SDK handles everything.
+
+## Example Application
+
+A complete example React Native app demonstrating all SDK features:
+
+👉 [Passgage SDK Example App](https://github.com/passgage/passgage-sdk-example-react-native)
+
+## TypeScript Support
+
+The SDK is written in TypeScript and includes full type definitions for all APIs, hooks, and models.
+
 ## License
 
 Proprietary - Passgage © 2025
+
+## Support
+
+For support, contact devops@passgage.com

package/dist/index.d.mts

@@ -1264,6 +1264,6 @@ declare function useLocation(options?: UseLocationOptions): UseLocationReturn;
  * Complete SDK with core functionality and React Native integration
  */
 
-declare const SDK_VERSION = "1.0.3";
+declare const SDK_VERSION = "1.0.4";
 
 export { type APIError, ApiClient, type ApiClientConfig, AuthService, type AuthState, type AuthTokens, type BaseResponse, type Branch, type CheckInEntryParams, type CheckInExitParams, type CheckInOptions, type CheckInResult, CheckInService, type CompanyInfo, type Coordinates, type CreateEntranceFromQRRequest, type CreateEntranceRequest, type Device, type DeviceAccessRequest, DeviceAccessService, DeviceDirection, DeviceUsage, endpoints as Endpoints, type Entrance, type EntranceQueryParams, EntranceType, type GetNearbyBranchesParams, LocationService, type LocationVerificationLog, type LoginCredentials, type LoginRequest, type LoginResponse, type LoginResult, NFCAccessService, type NFCValidationOptions, type NFCValidationResult, type NearbyBranchesRequest, type PaginationMeta, type PassgageAccessConfig, type PassgageAccessContextValue, PassgageAccessProvider, type PassgageAccessProviderProps, QRAccessService, type QRValidationOptions, type QRValidationResult, type QrAccessResponse, type QrDevice, type RefreshTokenRequest, type RefreshTokenResponse, type RefreshTokenResult, type RemoteWorkEntryOptions, type RemoteWorkEntryParams, type RemoteWorkExitParams, type RemoteWorkResult, RemoteWorkService, type RequestOptions, SDK_VERSION, type TokenInfo, type TokenStorage, type UseLocationOptions, type UseLocationReturn, type UsePassgageAuthOptions, type UsePassgageAuthReturn, type UsePassgageCheckInOptions, type UsePassgageCheckInReturn, type UsePassgageNFCScannerOptions, type UsePassgageNFCScannerReturn, type UsePassgageQRScannerOptions, type UsePassgageQRScannerReturn, type UsePassgageRemoteWorkReturn, type User, calculateDistance, checkOnLocation, checkRepetitiveRead, clearReadRecords, createApiClient, formatDate, formatDateTime, formatISO, formatTime, parseISO, useLocation, usePassgageAccess, usePassgageAuth, usePassgageCheckIn, usePassgageNFCScanner, usePassgageQRScanner, usePassgageRemoteWork, validateCoordinates, validateDeviceId, validateNFCCode, validateQRCode };

package/dist/index.d.ts

@@ -1264,6 +1264,6 @@ declare function useLocation(options?: UseLocationOptions): UseLocationReturn;
  * Complete SDK with core functionality and React Native integration
  */
 
-declare const SDK_VERSION = "1.0.3";
+declare const SDK_VERSION = "1.0.4";
 
 export { type APIError, ApiClient, type ApiClientConfig, AuthService, type AuthState, type AuthTokens, type BaseResponse, type Branch, type CheckInEntryParams, type CheckInExitParams, type CheckInOptions, type CheckInResult, CheckInService, type CompanyInfo, type Coordinates, type CreateEntranceFromQRRequest, type CreateEntranceRequest, type Device, type DeviceAccessRequest, DeviceAccessService, DeviceDirection, DeviceUsage, endpoints as Endpoints, type Entrance, type EntranceQueryParams, EntranceType, type GetNearbyBranchesParams, LocationService, type LocationVerificationLog, type LoginCredentials, type LoginRequest, type LoginResponse, type LoginResult, NFCAccessService, type NFCValidationOptions, type NFCValidationResult, type NearbyBranchesRequest, type PaginationMeta, type PassgageAccessConfig, type PassgageAccessContextValue, PassgageAccessProvider, type PassgageAccessProviderProps, QRAccessService, type QRValidationOptions, type QRValidationResult, type QrAccessResponse, type QrDevice, type RefreshTokenRequest, type RefreshTokenResponse, type RefreshTokenResult, type RemoteWorkEntryOptions, type RemoteWorkEntryParams, type RemoteWorkExitParams, type RemoteWorkResult, RemoteWorkService, type RequestOptions, SDK_VERSION, type TokenInfo, type TokenStorage, type UseLocationOptions, type UseLocationReturn, type UsePassgageAuthOptions, type UsePassgageAuthReturn, type UsePassgageCheckInOptions, type UsePassgageCheckInReturn, type UsePassgageNFCScannerOptions, type UsePassgageNFCScannerReturn, type UsePassgageQRScannerOptions, type UsePassgageQRScannerReturn, type UsePassgageRemoteWorkReturn, type User, calculateDistance, checkOnLocation, checkRepetitiveRead, clearReadRecords, createApiClient, formatDate, formatDateTime, formatISO, formatTime, parseISO, useLocation, usePassgageAccess, usePassgageAuth, usePassgageCheckIn, usePassgageNFCScanner, usePassgageQRScanner, usePassgageRemoteWork, validateCoordinates, validateDeviceId, validateNFCCode, validateQRCode };

package/dist/index.js

@@ -1965,7 +1965,7 @@ function usePassgageRemoteWork() {
 }
 
 // src/index.ts
-var SDK_VERSION = "1.0.3";
+var SDK_VERSION = "1.0.4";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApiClient,

package/dist/index.mjs

@@ -1901,7 +1901,7 @@ function usePassgageRemoteWork() {
 }
 
 // src/index.ts
-var SDK_VERSION = "1.0.3";
+var SDK_VERSION = "1.0.4";
 export {
   ApiClient,
   AuthService,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@passgage/sdk-react-native",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Passgage Access SDK - React Native wrapper with components and hooks",
   "main": "dist/index.js",
   "module": "dist/index.mjs",