@nibssplc/cams-sdk-react 0.0.1-beta.10

package/README.md

@@ -0,0 +1,160 @@
+# NIBSS CAMS SDK - React
+
+React hooks and components for NIBSS CAMS SDK with support for both popup and redirect authentication flows.
+
+## Installation
+
+```bash
+npm install @nibssplc/cams-sdk-react
+
+# For MSAL redirect support (optional)
+npm install @azure/msal-browser @azure/msal-react
+```
+
+## Usage
+
+### Popup Authentication (Default)
+
+```tsx
+import { CAMSProvider, useCAMSAuth } from '@nibssplc/cams-sdk-react';
+
+function App() {
+  return (
+    <CAMSProvider>
+      <LoginComponent />
+    </CAMSProvider>
+  );
+}
+
+function LoginComponent() {
+  const { login, logout, isAuthenticated, isLoading } = useCAMSAuth();
+
+  const handleLogin = () => {
+    login({
+      camsUrl: 'https://your-cams-instance.com/auth',
+      messageOrigin: 'your-cams-instance.com',
+      windowWidth: 500,
+      windowHeight: 600,
+    });
+  };
+
+  if (isAuthenticated) {
+    return <button onClick={logout}>Logout</button>;
+  }
+
+  return (
+    <button onClick={handleLogin} disabled={isLoading}>
+      {isLoading ? 'Logging in...' : 'Login'}
+    </button>
+  );
+}
+```
+
+### MSAL Redirect Authentication with MFA
+
+```tsx
+import { CAMSMSALProvider, useCAMSMSALAuth } from '@nibssplc/cams-sdk-react';
+
+const msalConfig = {
+  auth: {
+    clientId: 'your-client-id',
+    authority: 'https://login.microsoftonline.com/your-tenant-id',
+    redirectUri: window.location.origin,
+  },
+};
+
+function App() {
+  return (
+    <CAMSMSALProvider msalConfig={msalConfig}>
+      <LoginComponent />
+    </CAMSMSALProvider>
+  );
+}
+
+function LoginComponent() {
+  const { 
+    login, 
+    logout, 
+    completeMFA,
+    isAuthenticated, 
+    isLoading, 
+    isMFAPending,
+    account 
+  } = useCAMSMSALAuth({
+    scopes: ['openid', 'profile', 'email'],
+    mfaUrl: 'https://your-mfa-page.com/verify',
+    onAuthSuccess: (token) => console.log('Auth complete:', token),
+    onMFARequired: (msalToken, account) => console.log('MFA required for:', account.name),
+  });
+
+  // Handle MFA completion (call this after MFA verification)
+  const handleMFAComplete = (mfaToken: string) => {
+    completeMFA(mfaToken);
+  };
+
+  if (isAuthenticated) {
+    return (
+      <div>
+        <p>Welcome, {account?.name}</p>
+        <button onClick={logout}>Logout</button>
+      </div>
+    );
+  }
+
+  if (isMFAPending) {
+    return <div>Completing MFA verification...</div>;
+  }
+
+  return (
+    <button onClick={login} disabled={isLoading}>
+      {isLoading ? 'Redirecting...' : 'Login with Azure AD'}
+    </button>
+  );
+}
+```
+
+## API Reference
+
+### useCAMSMSALAuth
+
+Hook for MSAL redirect authentication.
+
+```tsx
+const {
+  login,
+  logout,
+  isAuthenticated,
+  isLoading,
+  error,
+  token,
+  profile,
+  account
+} = useCAMSMSALAuth(options);
+```
+
+**Options:**
+- `scopes?: string[]` - OAuth scopes (default: `['openid', 'profile', 'email']`)
+- `mfaUrl?: string` - Custom MFA page URL for redirect after MSAL login
+- `onAuthSuccess?: (token: string) => void` - Success callback (after MFA completion)
+- `onAuthError?: (error: CAMSError) => void` - Error callback
+- `onTokenExpired?: () => void` - Token expiration callback
+- `onMFARequired?: (msalToken: string, account: AccountInfo) => void` - MFA required callback
+
+**Returns:**
+- `completeMFA: (mfaToken: string) => void` - Complete MFA verification
+- `isMFAPending: boolean` - Whether MFA verification is pending
+
+### CAMSMSALProvider
+
+Provider component for MSAL integration.
+
+```tsx
+<CAMSMSALProvider msalConfig={config} msalInstance={instance}>
+  {children}
+</CAMSMSALProvider>
+```
+
+**Props:**
+- `msalConfig: Configuration` - MSAL configuration object
+- `msalInstance?: PublicClientApplication` - Optional pre-configured MSAL instance
+- `children: ReactNode` - Child components

package/dist/components/CAMSMSALProvider.d.ts

@@ -0,0 +1,8 @@
+import { ReactNode } from 'react';
+import { PublicClientApplication, Configuration } from '@azure/msal-browser';
+export interface CAMSMSALProviderProps {
+    children: ReactNode;
+    msalConfig: Configuration;
+    msalInstance?: PublicClientApplication;
+}
+export declare function CAMSMSALProvider({ children, msalConfig, msalInstance }: CAMSMSALProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/CAMSProvider.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+import { CAMSConfig } from '@nibssplc/cams-sdk';
+import { UseCAMSAuthReturn, UseCAMSAuthOptions } from '../hooks/useCAMSAuth';
+interface CAMSContextValue extends UseCAMSAuthReturn {
+    defaultConfig?: Partial<CAMSConfig>;
+}
+export interface CAMSProviderProps extends UseCAMSAuthOptions {
+    children: ReactNode;
+    defaultConfig?: Partial<CAMSConfig>;
+}
+export declare function CAMSProvider({ children, defaultConfig, ...authOptions }: CAMSProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useCAMSContext(): CAMSContextValue;
+export {};

package/dist/components/ProtectedRoute.d.ts

@@ -0,0 +1,7 @@
+import React, { ReactNode } from 'react';
+export interface ProtectedRouteProps {
+    children: ReactNode;
+    fallback?: ReactNode;
+    redirectTo?: string;
+}
+export declare function ProtectedRoute({ children, fallback, redirectTo }: ProtectedRouteProps): string | number | true | Iterable<React.ReactNode> | import("react/jsx-runtime").JSX.Element | null;

package/dist/hooks/useCAMSAuth.d.ts

@@ -0,0 +1,17 @@
+import { CAMSConfig, CAMSError, Profile } from '@nibssplc/cams-sdk';
+export interface UseCAMSAuthOptions {
+    storageKey?: string;
+    onAuthSuccess?: (token: string) => void;
+    onAuthError?: (error: CAMSError) => void;
+    onTokenExpired?: () => void;
+}
+export interface UseCAMSAuthReturn {
+    login: (config: CAMSConfig) => Promise<void>;
+    logout: () => Promise<void>;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    error: CAMSError | null;
+    token: string | null;
+    profile: Profile | null;
+}
+export declare function useCAMSAuth(options?: UseCAMSAuthOptions): UseCAMSAuthReturn;

package/dist/hooks/useCAMSMSALAuth.d.ts

@@ -0,0 +1,23 @@
+import { AccountInfo } from "@azure/msal-browser";
+import { CAMSError, Profile } from "@nibssplc/cams-sdk";
+export interface UseCAMSMSALAuthOptions {
+    onAuthSuccess?: (token: string) => void;
+    onAuthError?: (error: CAMSError) => void;
+    onTokenExpired?: () => void;
+    onMFARequired?: (msalToken: string, account: AccountInfo) => void;
+    scopes?: string[];
+    mfaUrl?: string;
+}
+export interface UseCAMSMSALAuthReturn {
+    login: () => Promise<void>;
+    logout: () => Promise<void>;
+    completeMFA: (mfaToken: string) => void;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    isMFAPending: boolean;
+    error: CAMSError | null;
+    token: string | null;
+    profile: Profile | null;
+    account: AccountInfo | null;
+}
+export declare function useCAMSMSALAuth(options?: UseCAMSMSALAuthOptions): UseCAMSMSALAuthReturn;