vesant-sdk 1.0.4

package/dist/react.d.ts

@@ -0,0 +1,487 @@
+import { G as GeolocationClient, E as UseGeolocationOptions, F as UseGeolocationResult, H as UseAlertsOptions, I as UseAlertsResult, q as DashboardMetrics, Z as UseLocationRequestsOptions, _ as UseLocationRequestsResult, $ as UseLocationCaptureOptions, a0 as UseLocationCaptureResult, D as DeviceFingerprintRequest } from './client-CA9Wr_qb.js';
+export { useCipherText } from './geolocation/index.js';
+import { KycClient, UseKycSubmissionOptions, UseKycSubmissionResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult } from './kyc/index.js';
+import './types-Bnsnejor.js';
+import './types-CFupjwi8.js';
+
+/**
+ * React Hooks for CGS Geolocation SDK
+ *
+ * Provides convenient React hooks for using the geolocation service in Next.js applications.
+ */
+
+/**
+ * React hook for IP verification and compliance checking
+ *
+ * @param client - GeolocationClient instance
+ * @param options - Hook options
+ * @returns Geolocation verification state and methods
+ *
+ * @example
+ * ```tsx
+ * function LoginPage() {
+ *   const { verification, loading, error, verifyIP } = useGeolocation(client, {
+ *     autoVerify: true,
+ *     eventType: "login",
+ *     includeDeviceFingerprint: true
+ *   });
+ *
+ *   useEffect(() => {
+ *     if (verification?.is_blocked) {
+ *       alert("Access blocked: " + verification.risk_reasons.join(", "));
+ *     }
+ *   }, [verification]);
+ *
+ *   return <div>Risk Level: {verification?.risk_level}</div>;
+ * }
+ * ```
+ */
+declare function useGeolocation(client: GeolocationClient, options?: UseGeolocationOptions): UseGeolocationResult;
+/**
+ * React hook for alert management
+ *
+ * @param client - GeolocationClient instance
+ * @param options - Hook options
+ * @returns Alert state and management methods
+ *
+ * @example
+ * ```tsx
+ * function AlertDashboard() {
+ *   const {
+ *     alerts,
+ *     total,
+ *     loading,
+ *     fetchAlerts,
+ *     updateStatus,
+ *     resolveAlert
+ *   } = useAlerts(client, {
+ *     autoFetch: true,
+ *     filters: { status: "active", severity: "critical" },
+ *     pollInterval: 30000 // Poll every 30 seconds
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <h2>{total} Alerts</h2>
+ *       {alerts.map(alert => (
+ *         <AlertCard
+ *           key={alert.id}
+ *           alert={alert}
+ *           onResolve={() => resolveAlert(alert.id, "resolved", "Fixed")}
+ *         />
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useAlerts(client: GeolocationClient, options?: UseAlertsOptions): UseAlertsResult;
+/**
+ * React hook for dashboard metrics
+ *
+ * @param client - GeolocationClient instance
+ * @param timeRangeHours - Time range in hours (default: 24)
+ * @param autoFetch - Auto-fetch metrics on mount (default: true)
+ * @returns Dashboard metrics state
+ *
+ * @example
+ * ```tsx
+ * function Dashboard() {
+ *   const { metrics, loading, refresh } = useDashboardMetrics(client, 168); // Last 7 days
+ *
+ *   if (loading) return <Spinner />;
+ *
+ *   return (
+ *     <div>
+ *       <h2>Dashboard</h2>
+ *       <MetricCard label="Total Alerts" value={metrics.total_alerts} />
+ *       <MetricCard label="Critical" value={metrics.critical_alerts} />
+ *       <MetricCard label="Active" value={metrics.active_alerts} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useDashboardMetrics(client: GeolocationClient, timeRangeHours?: number, autoFetch?: boolean): {
+    metrics: DashboardMetrics | null;
+    loading: boolean;
+    error: Error | null;
+    refresh: () => Promise<void>;
+};
+/**
+ * Get browser information
+ */
+declare function getBrowserInfo(): {
+    browser?: string;
+    browser_version?: string;
+    os?: string;
+};
+/**
+ * Create a complete device fingerprint for the current browser
+ */
+declare function createDeviceFingerprint(): DeviceFingerprintRequest;
+/**
+ * React hook for managing location requests (admin/compliance officer)
+ *
+ * @param client - GeolocationClient instance
+ * @param options - Hook options
+ * @returns Location request state and management methods
+ *
+ * @example
+ * ```tsx
+ * function LocationRequestDashboard() {
+ *   const {
+ *     requests,
+ *     total,
+ *     loading,
+ *     createRequest,
+ *     cancelRequest,
+ *     refresh
+ *   } = useLocationRequests(client, {
+ *     autoFetch: true,
+ *     filters: { status: 'pending' },
+ *     pollInterval: 30000
+ *   });
+ *
+ *   const handleCreate = async () => {
+ *     const result = await createRequest({
+ *       user_id: 'customer_123',
+ *       channel: 'sms',
+ *       phone: '+1234567890',
+ *       reason: 'Transaction verification'
+ *     });
+ *     console.log('Share link:', result.share_link);
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <h2>{total} Location Requests</h2>
+ *       <button onClick={handleCreate}>Create Request</button>
+ *       {requests.map(req => (
+ *         <LocationRequestCard
+ *           key={req.id}
+ *           request={req}
+ *           onCancel={() => cancelRequest(req.id)}
+ *         />
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useLocationRequests(client: GeolocationClient, options?: UseLocationRequestsOptions): UseLocationRequestsResult;
+/**
+ * React hook for location capture (customer-facing)
+ *
+ * Use this hook in the customer's browser to capture and submit their location.
+ * The token is obtained from the share link sent via SMS/email.
+ *
+ * @param client - GeolocationClient instance
+ * @param options - Hook options with token
+ * @returns Location capture state and methods
+ *
+ * @example
+ * ```tsx
+ * function LocationSharePage({ token }: { token: string }) {
+ *   const {
+ *     shareInfo,
+ *     loading,
+ *     submitting,
+ *     error,
+ *     isExpired,
+ *     isCompleted,
+ *     captureAndSubmitGPS
+ *   } = useLocationCapture(client, {
+ *     token,
+ *     autoFetch: true
+ *   });
+ *
+ *   if (loading) return <Spinner />;
+ *   if (isExpired) return <ExpiredMessage />;
+ *   if (isCompleted) return <ThankYouMessage />;
+ *
+ *   return (
+ *     <div>
+ *       <p>Reason: {shareInfo?.reason}</p>
+ *       <button
+ *         onClick={captureAndSubmitGPS}
+ *         disabled={submitting}
+ *       >
+ *         {submitting ? 'Submitting...' : 'Share My Location'}
+ *       </button>
+ *       {error && <ErrorMessage error={error} />}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useLocationCapture(client: GeolocationClient, options: UseLocationCaptureOptions): UseLocationCaptureResult;
+
+/**
+ * React Hooks for CGS KYC SDK
+ *
+ * Provides convenient React hooks for using the KYC service in Next.js applications.
+ */
+
+/**
+ * React hook for submitting KYC document verification
+ *
+ * @param client - KycClient instance
+ * @param options - Hook options
+ * @returns KYC submission state and methods
+ *
+ * @example
+ * ```tsx
+ * function KycForm() {
+ *   const { submit, submission, loading, error, reset } = useKycSubmission(client, {
+ *     onComplete: (result) => {
+ *       console.log("Verification submitted:", result.reference);
+ *     },
+ *     onError: (err) => {
+ *       console.error("Submission failed:", err.message);
+ *     }
+ *   });
+ *
+ *   const handleSubmit = async (formData: FormData) => {
+ *     await submit({
+ *       reference: formData.get("customerId"),
+ *       email: formData.get("email"),
+ *       document: {
+ *         proof: formData.get("documentImage"),
+ *         selected_type: ["id_card", "passport"]
+ *       }
+ *     });
+ *   };
+ *
+ *   return (
+ *     <form onSubmit={handleSubmit}>
+ *       {loading && <Spinner />}
+ *       {error && <ErrorMessage>{error.message}</ErrorMessage>}
+ *       {submission && <SuccessMessage>Submitted: {submission.reference}</SuccessMessage>}
+ *     </form>
+ *   );
+ * }
+ * ```
+ */
+declare function useKycSubmission(client: KycClient, options?: UseKycSubmissionOptions): UseKycSubmissionResult;
+/**
+ * React hook for managing KYC requests
+ *
+ * @param client - KycClient instance
+ * @param options - Hook options
+ * @returns KYC requests state and management methods
+ *
+ * @example
+ * ```tsx
+ * function KycDashboard() {
+ *   const {
+ *     requests,
+ *     total,
+ *     loading,
+ *     fetchRequests,
+ *     updateStatus
+ *   } = useKycRequests(client, {
+ *     autoFetch: true,
+ *     filters: { status: "pending" },
+ *     pagination: { page: 1, page_size: 20 }
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <h2>{total} Pending KYC Requests</h2>
+ *       {requests.map(req => (
+ *         <KycCard
+ *           key={req.id}
+ *           request={req}
+ *           onApprove={() => updateStatus(req.reference, "accepted", "Verified")}
+ *           onReject={() => updateStatus(req.reference, "declined", "Invalid document")}
+ *         />
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useKycRequests(client: KycClient, options?: UseKycRequestsOptions): UseKycRequestsResult;
+/**
+ * React hook for managing KYC alerts
+ *
+ * @param client - KycClient instance
+ * @param options - Hook options
+ * @returns KYC alerts state and management methods
+ *
+ * @example
+ * ```tsx
+ * function AlertsPanel() {
+ *   const {
+ *     alerts,
+ *     total,
+ *     loading,
+ *     fetchAlerts,
+ *     updateAlert
+ *   } = useKycAlerts(client, {
+ *     autoFetch: true,
+ *     filters: { status: ["pending", "in_progress"], risk: "critical" },
+ *     pollInterval: 30000
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <h2>{total} Critical Alerts</h2>
+ *       {alerts.map(alert => (
+ *         <AlertCard
+ *           key={alert.id}
+ *           alert={alert}
+ *           onAssign={(userId) => updateAlert(alert.id, { assigned_for: userId, status: "in_progress" })}
+ *           onResolve={() => updateAlert(alert.id, { status: "resolved", reason: "Verified" })}
+ *         />
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useKycAlerts(client: KycClient, options?: UseKycAlertsOptions): UseKycAlertsResult;
+/**
+ * React hook for KYC overview statistics
+ *
+ * @param client - KycClient instance
+ * @param options - Hook options
+ * @returns KYC overview state
+ *
+ * @example
+ * ```tsx
+ * function KycStats() {
+ *   const { overview, loading, refresh } = useKycOverview(client, {
+ *     autoFetch: true,
+ *     fromDate: "2024-01-01T00:00:00Z",
+ *     toDate: "2024-12-31T23:59:59Z"
+ *   });
+ *
+ *   if (loading) return <Spinner />;
+ *
+ *   return (
+ *     <div>
+ *       <StatCard label="Total" value={overview?.total} />
+ *       <StatCard label="Pending" value={overview?.pending} />
+ *       <StatCard label="Approved" value={overview?.approved} />
+ *       <StatCard label="Rejected" value={overview?.rejected} />
+ *       <StatCard label="High Risk" value={overview?.high_risk} />
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useKycOverview(client: KycClient, options?: UseKycOverviewOptions): UseKycOverviewResult;
+/**
+ * React hook for managing KYC preferences
+ *
+ * @param client - KycClient instance
+ * @param autoFetch - Auto-fetch preferences on mount (default: true)
+ * @returns KYC preferences state and methods
+ *
+ * @example
+ * ```tsx
+ * function PreferencesForm() {
+ *   const { preferences, loading, updatePreferences, refresh } = useKycPreferences(client);
+ *
+ *   const handleUpdate = async (e: FormEvent) => {
+ *     e.preventDefault();
+ *     await updatePreferences({
+ *       is_face_verification_required: true,
+ *       required_document_count: 2
+ *     });
+ *   };
+ *
+ *   if (loading) return <Spinner />;
+ *
+ *   return (
+ *     <form onSubmit={handleUpdate}>
+ *       <Checkbox
+ *         label="Require Face Verification"
+ *         checked={preferences?.is_face_verification_required}
+ *       />
+ *       <NumberInput
+ *         label="Required Documents"
+ *         value={preferences?.required_document_count}
+ *       />
+ *       <Button type="submit">Save</Button>
+ *     </form>
+ *   );
+ * }
+ * ```
+ */
+declare function useKycPreferences(client: KycClient, autoFetch?: boolean): UseKycPreferencesResult;
+/**
+ * Convert a File to base64 string for document upload
+ *
+ * @param file - File object from input or drag-drop
+ * @returns Base64 encoded string
+ *
+ * @example
+ * ```typescript
+ * const handleFileSelect = async (e: ChangeEvent<HTMLInputElement>) => {
+ *   const file = e.target.files?.[0];
+ *   if (file) {
+ *     const base64 = await fileToBase64(file);
+ *     setDocumentProof(base64);
+ *   }
+ * };
+ * ```
+ */
+declare function fileToBase64(file: File): Promise<string>;
+/**
+ * Validate file type for document upload
+ *
+ * @param file - File object to validate
+ * @param allowedTypes - Array of allowed MIME types
+ * @returns boolean indicating if file type is valid
+ *
+ * @example
+ * ```typescript
+ * const validTypes = ['image/jpeg', 'image/png', 'application/pdf'];
+ * if (!isValidFileType(file, validTypes)) {
+ *   alert('Invalid file type. Please upload a JPG, PNG, or PDF.');
+ * }
+ * ```
+ */
+declare function isValidFileType(file: File, allowedTypes?: string[]): boolean;
+/**
+ * Validate file size for document upload
+ *
+ * @param file - File object to validate
+ * @param maxSizeBytes - Maximum file size in bytes (default: 10MB)
+ * @returns boolean indicating if file size is valid
+ *
+ * @example
+ * ```typescript
+ * const maxSize = 5 * 1024 * 1024; // 5MB
+ * if (!isValidFileSize(file, maxSize)) {
+ *   alert('File too large. Maximum size is 5MB.');
+ * }
+ * ```
+ */
+declare function isValidFileSize(file: File, maxSizeBytes?: number): boolean;
+/**
+ * Format KYC status for display
+ *
+ * @param status - KYC status
+ * @returns Human-readable status string
+ */
+declare function formatKycStatus(status: string): string;
+/**
+ * Get status color for UI display
+ *
+ * @param status - KYC status
+ * @returns CSS color class or hex color
+ */
+declare function getStatusColor(status: string): string;
+/**
+ * Get risk level color for UI display
+ *
+ * @param risk - Risk level
+ * @returns CSS color class or hex color
+ */
+declare function getRiskColor(risk: string): string;
+
+export { UseAlertsOptions, UseAlertsResult, UseGeolocationOptions, UseGeolocationResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult, UseLocationCaptureOptions, UseLocationCaptureResult, UseLocationRequestsOptions, UseLocationRequestsResult, createDeviceFingerprint, fileToBase64, formatKycStatus, getBrowserInfo, getRiskColor, getStatusColor, isValidFileSize, isValidFileType, useAlerts, useDashboardMetrics, useGeolocation, useKycAlerts, useKycOverview, useKycPreferences, useKycRequests, useKycSubmission, useLocationCapture, useLocationRequests };