@passgage/sdk-react-native 1.0.1

package/README.md

@@ -0,0 +1,156 @@
+# @passgage-sdk/react-native
+
+React Native wrapper for Passgage Access SDK with ready-to-use components and hooks.
+
+## Installation
+
+```bash
+npm install @passgage-sdk/react-native @passgage-sdk/core
+# or
+yarn add @passgage-sdk/react-native @passgage-sdk/core
+```
+
+### Peer Dependencies
+
+You also need to install these peer dependencies:
+
+```bash
+npm install react-native-vision-camera react-native-nfc-manager @react-native-community/geolocation
+```
+
+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)
+
+## Usage
+
+### Provider Setup
+
+Wrap your app with `PassgageAccessProvider`:
+
+```typescript
+import { PassgageAccessProvider } from '@passgage-sdk/react-native';
+
+function App() {
+  return (
+    <PassgageAccessProvider
+      baseURL="https://your-api.passgage.com"
+      token="your-jwt-token"
+    >
+      <YourApp />
+    </PassgageAccessProvider>
+  );
+}
+```
+
+### QR Scanner Hook
+
+```typescript
+import { useQRScanner } from '@passgage-sdk/react-native';
+
+function QRScanScreen() {
+  const { scan, isLoading, error } = useQRScanner({
+    onSuccess: (entrance) => {
+      console.log('QR scan successful:', entrance);
+    },
+    onError: (error) => {
+      console.error('QR scan failed:', error);
+    },
+  });
+
+  return (
+    <View>
+      {/* Your camera view */}
+      <Camera onCodeScanned={(code) => scan(code)} />
+    </View>
+  );
+}
+```
+
+### NFC Scanner Hook
+
+```typescript
+import { useNFCScanner } from '@passgage-sdk/react-native';
+
+function NFCScanScreen() {
+  const { startScanning, stopScanning, isScanning } = useNFCScanner({
+    onSuccess: (entrance) => {
+      console.log('NFC scan successful:', entrance);
+    },
+    onError: (error) => {
+      console.error('NFC scan failed:', error);
+    },
+  });
+
+  useEffect(() => {
+    startScanning();
+    return () => stopScanning();
+  }, []);
+
+  return <View>{/* Your NFC scan UI */}</View>;
+}
+```
+
+### Check-In Hook
+
+```typescript
+import { useCheckIn } from '@passgage-sdk/react-native';
+
+function CheckInScreen() {
+  const { nearbyBranches, checkIn, isLoading } = useCheckIn();
+
+  const handleCheckIn = async (branchId: string) => {
+    await checkIn({
+      branchId,
+      entranceType: 0, // 0 = ENTRY, 1 = EXIT
+    });
+  };
+
+  return (
+    <View>
+      {nearbyBranches.map((branch) => (
+        <TouchableOpacity key={branch.id} onPress={() => handleCheckIn(branch.id)}>
+          <Text>{branch.title}</Text>
+        </TouchableOpacity>
+      ))}
+    </View>
+  );
+}
+```
+
+### Remote Work Hook
+
+```typescript
+import { useRemoteWork } from '@passgage-sdk/react-native';
+
+function RemoteWorkScreen() {
+  const { logEntry, logExit, isLoading } = useRemoteWork();
+
+  return (
+    <View>
+      <Button title="Log Entry" onPress={() => logEntry()} />
+      <Button title="Log Exit" onPress={() => logExit()} />
+    </View>
+  );
+}
+```
+
+## API
+
+### 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
+
+### Components
+
+- `<PassgageAccessProvider>` - SDK configuration provider
+
+## License
+
+Proprietary - Passgage © 2025

package/dist/index.d.mts

@@ -0,0 +1,251 @@
+import React, { ReactNode } from 'react';
+import { ApiClient, AuthService, QRAccessService, NFCAccessService, CheckInService, RemoteWorkService, DeviceAccessService, LocationService, User, LoginCredentials, LoginResult, Entrance, QrDevice, EntranceType, Branch, Coordinates } from '@passgage/sdk-core';
+export { BaseResponse, Branch, Coordinates, Device, Entrance, EntranceType, QrDevice } from '@passgage/sdk-core';
+
+/**
+ * Passgage Access Provider
+ * Main provider component for SDK configuration
+ */
+
+interface PassgageAccessConfig {
+    baseURL: string;
+    token?: string;
+    apiVersion?: string;
+    timeout?: number;
+    onUnauthorized?: () => void;
+    onError?: (error: Error) => void;
+}
+interface PassgageAccessContextValue {
+    apiClient: ApiClient;
+    authService: AuthService;
+    qrAccessService: QRAccessService;
+    nfcAccessService: NFCAccessService;
+    checkInService: CheckInService;
+    remoteWorkService: RemoteWorkService;
+    deviceAccessService: DeviceAccessService;
+    locationService: LocationService;
+    config: PassgageAccessConfig;
+    setToken: (token: string | null) => void;
+    clearToken: () => void;
+}
+interface PassgageAccessProviderProps {
+    children: ReactNode;
+    baseURL: string;
+    token?: string;
+    apiVersion?: string;
+    timeout?: number;
+    onUnauthorized?: () => void;
+    onError?: (error: Error) => void;
+}
+declare function PassgageAccessProvider({ children, baseURL, token, apiVersion, timeout, onUnauthorized, onError, }: PassgageAccessProviderProps): React.JSX.Element;
+/**
+ * Hook to access Passgage SDK context
+ */
+declare function usePassgageAccess(): PassgageAccessContextValue;
+
+/**
+ * Authentication Hook
+ *
+ * Provides authentication functionality including login, logout, and user state management.
+ */
+
+interface UsePassgageAuthOptions {
+    /**
+     * Callback called when login is successful
+     */
+    onLoginSuccess?: (user?: User) => void;
+    /**
+     * Callback called when login fails
+     */
+    onLoginError?: (error: string) => void;
+    /**
+     * Callback called when logout is successful
+     */
+    onLogoutSuccess?: () => void;
+    /**
+     * Automatically check for stored tokens on mount
+     * @default true
+     */
+    autoRestore?: boolean;
+}
+interface UsePassgageAuthReturn {
+    /**
+     * Login with credentials
+     */
+    login: (credentials: LoginCredentials) => Promise<LoginResult>;
+    /**
+     * Logout current user
+     */
+    logout: () => Promise<void>;
+    /**
+     * Refresh access token
+     */
+    refreshToken: () => Promise<boolean>;
+    /**
+     * Whether user is authenticated
+     */
+    isAuthenticated: boolean;
+    /**
+     * Current user information
+     */
+    user: User | null;
+    /**
+     * Whether an auth operation is in progress
+     */
+    isLoading: boolean;
+    /**
+     * Last error message
+     */
+    error: string | null;
+    /**
+     * Clear error message
+     */
+    clearError: () => void;
+}
+/**
+ * Authentication hook
+ *
+ * @example
+ * ```typescript
+ * function LoginScreen() {
+ *   const { login, isLoading, error, isAuthenticated } = usePassgageAuth({
+ *     onLoginSuccess: (user) => {
+ *       console.log('Logged in:', user);
+ *       navigation.navigate('Home');
+ *     },
+ *     onLoginError: (error) => {
+ *       Alert.alert('Login Failed', error);
+ *     }
+ *   });
+ *
+ *   const handleLogin = async () => {
+ *     await login({
+ *       login: 'user@example.com',
+ *       password: 'password123'
+ *     });
+ *   };
+ *
+ *   if (isAuthenticated) {
+ *     return <Text>Already logged in!</Text>;
+ *   }
+ *
+ *   return (
+ *     <View>
+ *       <Button
+ *         title="Login"
+ *         onPress={handleLogin}
+ *         disabled={isLoading}
+ *       />
+ *       {error && <Text>{error}</Text>}
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+declare function usePassgageAuth(options?: UsePassgageAuthOptions): UsePassgageAuthReturn;
+
+/**
+ * useQRScanner hook
+ * QR code scanning with validation
+ */
+
+interface UseQRScannerOptions {
+    onSuccess?: (entrance?: Entrance) => void;
+    onError?: (error: Error) => void;
+    skipLocationCheck?: boolean;
+    skipRepetitiveCheck?: boolean;
+}
+interface UseQRScannerReturn {
+    scan: (qrCode: string, device?: QrDevice) => Promise<void>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useQRScanner(options?: UseQRScannerOptions): UseQRScannerReturn;
+
+/**
+ * useNFCScanner hook
+ * NFC card scanning with validation
+ */
+
+interface UseNFCScannerOptions {
+    onSuccess?: (entrance?: Entrance) => void;
+    onError?: (error: Error) => void;
+    skipLocationCheck?: boolean;
+    skipRepetitiveCheck?: boolean;
+    autoStart?: boolean;
+}
+interface UseNFCScannerReturn {
+    startScanning: () => Promise<void>;
+    stopScanning: () => Promise<void>;
+    isScanning: boolean;
+    error: Error | null;
+}
+declare function useNFCScanner(options?: UseNFCScannerOptions): UseNFCScannerReturn;
+
+/**
+ * useCheckIn hook
+ * GPS-based check-in to nearby branches
+ */
+
+interface UseCheckInOptions {
+    radius?: number;
+    autoFetch?: boolean;
+}
+interface CheckInParams {
+    branchId: string;
+    entranceType: EntranceType;
+}
+interface UseCheckInReturn {
+    nearbyBranches: Branch[];
+    fetchNearbyBranches: () => Promise<void>;
+    checkIn: (params: CheckInParams) => Promise<Entrance | undefined>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useCheckIn(options?: UseCheckInOptions): UseCheckInReturn;
+
+/**
+ * useRemoteWork hook
+ * Remote work entry/exit logging
+ */
+
+interface RemoteWorkOptions {
+    timestamp?: Date | string;
+    description?: string;
+}
+interface UseRemoteWorkReturn {
+    logEntry: (options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    logExit: (options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    logRemoteWork: (entranceType: EntranceType, options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useRemoteWork(): UseRemoteWorkReturn;
+
+/**
+ * useLocation hook
+ * Location tracking using React Native Geolocation
+ */
+
+interface UseLocationOptions {
+    enableHighAccuracy?: boolean;
+    timeout?: number;
+    maximumAge?: number;
+    watchPosition?: boolean;
+}
+interface UseLocationReturn {
+    location: Coordinates | null;
+    error: Error | null;
+    isLoading: boolean;
+    refreshLocation: () => Promise<void>;
+}
+declare function useLocation(options?: UseLocationOptions): UseLocationReturn;
+
+/**
+ * Passgage Access SDK - React Native Package
+ * React Native wrapper with components and hooks
+ */
+
+declare const SDK_VERSION = "1.0.0";
+
+export { type CheckInParams, type PassgageAccessConfig, type PassgageAccessContextValue, PassgageAccessProvider, type PassgageAccessProviderProps, type RemoteWorkOptions, SDK_VERSION, type UseCheckInOptions, type UseCheckInReturn, type UseLocationOptions, type UseLocationReturn, type UseNFCScannerOptions, type UseNFCScannerReturn, type UsePassgageAuthOptions, type UsePassgageAuthReturn, type UseQRScannerOptions, type UseQRScannerReturn, type UseRemoteWorkReturn, useCheckIn, useLocation, useNFCScanner, usePassgageAccess, usePassgageAuth, useQRScanner, useRemoteWork };

package/dist/index.d.ts

@@ -0,0 +1,251 @@
+import React, { ReactNode } from 'react';
+import { ApiClient, AuthService, QRAccessService, NFCAccessService, CheckInService, RemoteWorkService, DeviceAccessService, LocationService, User, LoginCredentials, LoginResult, Entrance, QrDevice, EntranceType, Branch, Coordinates } from '@passgage/sdk-core';
+export { BaseResponse, Branch, Coordinates, Device, Entrance, EntranceType, QrDevice } from '@passgage/sdk-core';
+
+/**
+ * Passgage Access Provider
+ * Main provider component for SDK configuration
+ */
+
+interface PassgageAccessConfig {
+    baseURL: string;
+    token?: string;
+    apiVersion?: string;
+    timeout?: number;
+    onUnauthorized?: () => void;
+    onError?: (error: Error) => void;
+}
+interface PassgageAccessContextValue {
+    apiClient: ApiClient;
+    authService: AuthService;
+    qrAccessService: QRAccessService;
+    nfcAccessService: NFCAccessService;
+    checkInService: CheckInService;
+    remoteWorkService: RemoteWorkService;
+    deviceAccessService: DeviceAccessService;
+    locationService: LocationService;
+    config: PassgageAccessConfig;
+    setToken: (token: string | null) => void;
+    clearToken: () => void;
+}
+interface PassgageAccessProviderProps {
+    children: ReactNode;
+    baseURL: string;
+    token?: string;
+    apiVersion?: string;
+    timeout?: number;
+    onUnauthorized?: () => void;
+    onError?: (error: Error) => void;
+}
+declare function PassgageAccessProvider({ children, baseURL, token, apiVersion, timeout, onUnauthorized, onError, }: PassgageAccessProviderProps): React.JSX.Element;
+/**
+ * Hook to access Passgage SDK context
+ */
+declare function usePassgageAccess(): PassgageAccessContextValue;
+
+/**
+ * Authentication Hook
+ *
+ * Provides authentication functionality including login, logout, and user state management.
+ */
+
+interface UsePassgageAuthOptions {
+    /**
+     * Callback called when login is successful
+     */
+    onLoginSuccess?: (user?: User) => void;
+    /**
+     * Callback called when login fails
+     */
+    onLoginError?: (error: string) => void;
+    /**
+     * Callback called when logout is successful
+     */
+    onLogoutSuccess?: () => void;
+    /**
+     * Automatically check for stored tokens on mount
+     * @default true
+     */
+    autoRestore?: boolean;
+}
+interface UsePassgageAuthReturn {
+    /**
+     * Login with credentials
+     */
+    login: (credentials: LoginCredentials) => Promise<LoginResult>;
+    /**
+     * Logout current user
+     */
+    logout: () => Promise<void>;
+    /**
+     * Refresh access token
+     */
+    refreshToken: () => Promise<boolean>;
+    /**
+     * Whether user is authenticated
+     */
+    isAuthenticated: boolean;
+    /**
+     * Current user information
+     */
+    user: User | null;
+    /**
+     * Whether an auth operation is in progress
+     */
+    isLoading: boolean;
+    /**
+     * Last error message
+     */
+    error: string | null;
+    /**
+     * Clear error message
+     */
+    clearError: () => void;
+}
+/**
+ * Authentication hook
+ *
+ * @example
+ * ```typescript
+ * function LoginScreen() {
+ *   const { login, isLoading, error, isAuthenticated } = usePassgageAuth({
+ *     onLoginSuccess: (user) => {
+ *       console.log('Logged in:', user);
+ *       navigation.navigate('Home');
+ *     },
+ *     onLoginError: (error) => {
+ *       Alert.alert('Login Failed', error);
+ *     }
+ *   });
+ *
+ *   const handleLogin = async () => {
+ *     await login({
+ *       login: 'user@example.com',
+ *       password: 'password123'
+ *     });
+ *   };
+ *
+ *   if (isAuthenticated) {
+ *     return <Text>Already logged in!</Text>;
+ *   }
+ *
+ *   return (
+ *     <View>
+ *       <Button
+ *         title="Login"
+ *         onPress={handleLogin}
+ *         disabled={isLoading}
+ *       />
+ *       {error && <Text>{error}</Text>}
+ *     </View>
+ *   );
+ * }
+ * ```
+ */
+declare function usePassgageAuth(options?: UsePassgageAuthOptions): UsePassgageAuthReturn;
+
+/**
+ * useQRScanner hook
+ * QR code scanning with validation
+ */
+
+interface UseQRScannerOptions {
+    onSuccess?: (entrance?: Entrance) => void;
+    onError?: (error: Error) => void;
+    skipLocationCheck?: boolean;
+    skipRepetitiveCheck?: boolean;
+}
+interface UseQRScannerReturn {
+    scan: (qrCode: string, device?: QrDevice) => Promise<void>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useQRScanner(options?: UseQRScannerOptions): UseQRScannerReturn;
+
+/**
+ * useNFCScanner hook
+ * NFC card scanning with validation
+ */
+
+interface UseNFCScannerOptions {
+    onSuccess?: (entrance?: Entrance) => void;
+    onError?: (error: Error) => void;
+    skipLocationCheck?: boolean;
+    skipRepetitiveCheck?: boolean;
+    autoStart?: boolean;
+}
+interface UseNFCScannerReturn {
+    startScanning: () => Promise<void>;
+    stopScanning: () => Promise<void>;
+    isScanning: boolean;
+    error: Error | null;
+}
+declare function useNFCScanner(options?: UseNFCScannerOptions): UseNFCScannerReturn;
+
+/**
+ * useCheckIn hook
+ * GPS-based check-in to nearby branches
+ */
+
+interface UseCheckInOptions {
+    radius?: number;
+    autoFetch?: boolean;
+}
+interface CheckInParams {
+    branchId: string;
+    entranceType: EntranceType;
+}
+interface UseCheckInReturn {
+    nearbyBranches: Branch[];
+    fetchNearbyBranches: () => Promise<void>;
+    checkIn: (params: CheckInParams) => Promise<Entrance | undefined>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useCheckIn(options?: UseCheckInOptions): UseCheckInReturn;
+
+/**
+ * useRemoteWork hook
+ * Remote work entry/exit logging
+ */
+
+interface RemoteWorkOptions {
+    timestamp?: Date | string;
+    description?: string;
+}
+interface UseRemoteWorkReturn {
+    logEntry: (options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    logExit: (options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    logRemoteWork: (entranceType: EntranceType, options?: RemoteWorkOptions) => Promise<Entrance | undefined>;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useRemoteWork(): UseRemoteWorkReturn;
+
+/**
+ * useLocation hook
+ * Location tracking using React Native Geolocation
+ */
+
+interface UseLocationOptions {
+    enableHighAccuracy?: boolean;
+    timeout?: number;
+    maximumAge?: number;
+    watchPosition?: boolean;
+}
+interface UseLocationReturn {
+    location: Coordinates | null;
+    error: Error | null;
+    isLoading: boolean;
+    refreshLocation: () => Promise<void>;
+}
+declare function useLocation(options?: UseLocationOptions): UseLocationReturn;
+
+/**
+ * Passgage Access SDK - React Native Package
+ * React Native wrapper with components and hooks
+ */
+
+declare const SDK_VERSION = "1.0.0";
+
+export { type CheckInParams, type PassgageAccessConfig, type PassgageAccessContextValue, PassgageAccessProvider, type PassgageAccessProviderProps, type RemoteWorkOptions, SDK_VERSION, type UseCheckInOptions, type UseCheckInReturn, type UseLocationOptions, type UseLocationReturn, type UseNFCScannerOptions, type UseNFCScannerReturn, type UsePassgageAuthOptions, type UsePassgageAuthReturn, type UseQRScannerOptions, type UseQRScannerReturn, type UseRemoteWorkReturn, useCheckIn, useLocation, useNFCScanner, usePassgageAccess, usePassgageAuth, useQRScanner, useRemoteWork };