vesant-sdk 1.7.2 → 1.8.0-dev.00f6233

package/dist/react.d.mts

@@ -1,8 +1,8 @@
-import { D as DeviceFingerprintRequest, G as GeolocationClient, i as CipherTextOptions, l as CipherTextResult, Y as UseGeolocationOptions, Z as UseGeolocationResult, _ as UseLocationCaptureOptions, $ as UseLocationCaptureResult, a0 as UseLocationRequestsOptions, a1 as UseLocationRequestsResult } from './client-BwXMQA2a.mjs';
-import { e as LoginVerificationResponse, L as LoginVerificationRequest, f as RegistrationVerificationResponse, R as RegistrationVerificationRequest, h as TransactionVerificationResponse, g as TransactionVerificationRequest, C as ComplianceClient } from './client-D23KhWeh.mjs';
+import { D as DeviceFingerprintRequest, G as GeolocationClient, i as CipherTextOptions, l as CipherTextResult, Y as UseGeolocationOptions, Z as UseGeolocationResult, _ as UseLocationCaptureOptions, $ as UseLocationCaptureResult, a0 as UseLocationRequestsOptions, a1 as UseLocationRequestsResult } from './client-XDEhh9VN.mjs';
+import { e as LoginVerificationResponse, L as LoginVerificationRequest, f as RegistrationVerificationResponse, R as RegistrationVerificationRequest, h as TransactionVerificationResponse, g as TransactionVerificationRequest, C as ComplianceClient } from './client-_OhkfnyJ.mjs';
 import { RiskProfileClient } from './risk-profile/index.mjs';
-import { C as CustomerProfile } from './types-BOFaMQxI.mjs';
-import { CreateEventBasedFaceVerificationSessionResponse, EventBasedFaceVerificationCallback, KycClient, CreateEventBasedFaceVerificationSessionRequest, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult } from './kyc/index.mjs';
+import { C as CustomerProfile, j as UpdateProfileResult } from './types-DbvVph_0.mjs';
+import { CreateEventBasedFaceVerificationSessionResponse, EventBasedFaceVerificationCallback, KycClient, CreateEventBasedFaceVerificationSessionRequest, UseKycAlertsOptions, UseKycAlertsResult, UseKycSubmissionOptions, UseKycSubmissionResult } from './kyc/index.mjs';
 import React$1 from 'react';
 import './client-q9fN8Hhf.mjs';
 import './types-CBQRNL-l.mjs';
@@ -64,6 +64,12 @@ declare function createDeviceFingerprint(): DeviceFingerprintRequest;
 /**
  * React hook for generating cipherText
  *
+ * The tenant's GPS requirements are read from the client before each generation.
+ * The client reuses a fetched copy for a short period, so this does not add a
+ * request per event, and a requirement changed in the compliance console takes
+ * effect without reloading the page. Call `refreshConfig` to apply a change
+ * immediately.
+ *
  * @example
  * ```tsx
  * function LoginForm() {
@@ -80,6 +86,7 @@ declare function createDeviceFingerprint(): DeviceFingerprintRequest;
  */
 declare function useCipherText(client?: GeolocationClient): {
     generate: (options: CipherTextOptions) => Promise<CipherTextResult | null>;
+    refreshConfig: () => Promise<void>;
     configLoading: boolean;
     configError: Error | null;
 };
@@ -214,7 +221,13 @@ interface UseCustomerProfileResult {
     loading: boolean;
     error: Error | null;
     fetchProfile: () => Promise<CustomerProfile>;
-    updateProfile: (updates: Partial<CustomerProfile>) => Promise<CustomerProfile>;
+    /**
+     * Update the loaded profile. Resolves to the updated profile, or to a
+     * `ProfileUpdateHeldResponse` when the tenant holds a name / date of birth /
+     * address change behind KYC — narrow with `isProfileUpdateHeld`. The hook's
+     * `profile` state is updated either way (with the profile as stored).
+     */
+    updateProfile: (updates: Partial<CustomerProfile>) => Promise<UpdateProfileResult>;
     refresh: () => Promise<CustomerProfile>;
 }
 /**
@@ -293,45 +306,6 @@ declare function useCustomerProfile(client: RiskProfileClient, customerId: strin
  * ```
  */
 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
  *
@@ -346,8 +320,7 @@ declare function useKycRequests(client: KycClient, options?: UseKycRequestsOptio
  *     alerts,
  *     total,
  *     loading,
- *     fetchAlerts,
- *     updateAlert
+ *     fetchAlerts
  *   } = useKycAlerts(client, {
  *     autoFetch: true,
  *     filters: { status: ["pending", "in_progress"], risk: "critical" },
@@ -358,81 +331,17 @@ declare function useKycRequests(client: KycClient, options?: UseKycRequestsOptio
  *     <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" })}
- *         />
+ *         <AlertCard key={alert.id} alert={alert} />
  *       ))}
  *     </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 reading KYC preferences
- *
- * Preferences are managed in the Vesant console. The returned
- * `updatePreferences` is deprecated: the platform exposes no update
- * operation, so it always fails.
- *
- * @param client - KycClient instance
- * @param autoFetch - Auto-fetch preferences on mount (default: true)
- * @returns KYC preferences state and methods
- *
- * @example
- * ```tsx
- * function PreferencesSummary() {
- *   const { preferences, loading, refresh } = useKycPreferences(client);
- *
- *   if (loading) return <Spinner />;
- *
- *   return (
- *     <dl>
- *       <dt>Face verification required</dt>
- *       <dd>{String(preferences?.is_face_verification_required)}</dd>
- *       <dt>Required documents</dt>
- *       <dd>{preferences?.required_document_count}</dd>
- *       <button onClick={refresh}>Refresh</button>
- *     </dl>
- *   );
- * }
- * ```
+ * @remarks Console session only: the alert endpoints need a dashboard login
+ * token and fail with a tenant API key.
  */
-declare function useKycPreferences(client: KycClient, autoFetch?: boolean): UseKycPreferencesResult;
+declare function useKycAlerts(client: KycClient, options?: UseKycAlertsOptions): UseKycAlertsResult;
 /**
  * Convert a File to base64 string for document upload
  *
@@ -625,4 +534,4 @@ interface FaceCaptureModalProps {
 }
 declare function FaceCaptureModal({ client, session, onComplete, onCancel, defaultDevice, renderQR, mediapipeAssetBasePath, }: Readonly<FaceCaptureModalProps>): React$1.ReactElement;
 
-export { FaceCaptureModal, type FaceCaptureModalProps, type RunFlowResult, type UseCustomerProfileOptions, type UseCustomerProfileResult, UseGeolocationOptions, UseGeolocationResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult, UseLocationCaptureOptions, UseLocationCaptureResult, UseLocationRequestsOptions, UseLocationRequestsResult, type UseLoginVerificationOptions, type UseLoginVerificationResult, type UseRegistrationOptions, type UseRegistrationResult, type UseTransactionVerificationOptions, type UseTransactionVerificationResult, type VerifyFaceOptions, buildEventBasedFaceVerificationQrPayload, createDeviceFingerprint, fileToBase64, formatKycStatus, getBrowserInfo, getRiskColor, getStatusColor, isMobileDevice, isValidFileSize, isValidFileType, useCipherText, useCustomerProfile, useEventBasedFaceVerificationSubmission, useGeolocation, useKycAlerts, useKycOverview, useKycPreferences, useKycRequests, useKycSubmission, useLocationCapture, useLocationRequests, useLoginVerification, useRegistration, useTransactionVerification };
+export { FaceCaptureModal, type FaceCaptureModalProps, type RunFlowResult, type UseCustomerProfileOptions, type UseCustomerProfileResult, UseGeolocationOptions, UseGeolocationResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycSubmissionOptions, UseKycSubmissionResult, UseLocationCaptureOptions, UseLocationCaptureResult, UseLocationRequestsOptions, UseLocationRequestsResult, type UseLoginVerificationOptions, type UseLoginVerificationResult, type UseRegistrationOptions, type UseRegistrationResult, type UseTransactionVerificationOptions, type UseTransactionVerificationResult, type VerifyFaceOptions, buildEventBasedFaceVerificationQrPayload, createDeviceFingerprint, fileToBase64, formatKycStatus, getBrowserInfo, getRiskColor, getStatusColor, isMobileDevice, isValidFileSize, isValidFileType, useCipherText, useCustomerProfile, useEventBasedFaceVerificationSubmission, useGeolocation, useKycAlerts, useKycSubmission, useLocationCapture, useLocationRequests, useLoginVerification, useRegistration, useTransactionVerification };

package/dist/react.d.ts

@@ -1,8 +1,8 @@
-import { D as DeviceFingerprintRequest, G as GeolocationClient, i as CipherTextOptions, l as CipherTextResult, Y as UseGeolocationOptions, Z as UseGeolocationResult, _ as UseLocationCaptureOptions, $ as UseLocationCaptureResult, a0 as UseLocationRequestsOptions, a1 as UseLocationRequestsResult } from './client-fy3trF2K.js';
-import { e as LoginVerificationResponse, L as LoginVerificationRequest, f as RegistrationVerificationResponse, R as RegistrationVerificationRequest, h as TransactionVerificationResponse, g as TransactionVerificationRequest, C as ComplianceClient } from './client-B3DCAHlg.js';
+import { D as DeviceFingerprintRequest, G as GeolocationClient, i as CipherTextOptions, l as CipherTextResult, Y as UseGeolocationOptions, Z as UseGeolocationResult, _ as UseLocationCaptureOptions, $ as UseLocationCaptureResult, a0 as UseLocationRequestsOptions, a1 as UseLocationRequestsResult } from './client-BaUekQT8.js';
+import { e as LoginVerificationResponse, L as LoginVerificationRequest, f as RegistrationVerificationResponse, R as RegistrationVerificationRequest, h as TransactionVerificationResponse, g as TransactionVerificationRequest, C as ComplianceClient } from './client-BPALLldd.js';
 import { RiskProfileClient } from './risk-profile/index.js';
-import { C as CustomerProfile } from './types-UGyDl1fd.js';
-import { CreateEventBasedFaceVerificationSessionResponse, EventBasedFaceVerificationCallback, KycClient, CreateEventBasedFaceVerificationSessionRequest, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult } from './kyc/index.js';
+import { C as CustomerProfile, j as UpdateProfileResult } from './types-qXamJr2q.js';
+import { CreateEventBasedFaceVerificationSessionResponse, EventBasedFaceVerificationCallback, KycClient, CreateEventBasedFaceVerificationSessionRequest, UseKycAlertsOptions, UseKycAlertsResult, UseKycSubmissionOptions, UseKycSubmissionResult } from './kyc/index.js';
 import React$1 from 'react';
 import './client-q9fN8Hhf.js';
 import './types-CBQRNL-l.js';
@@ -64,6 +64,12 @@ declare function createDeviceFingerprint(): DeviceFingerprintRequest;
 /**
  * React hook for generating cipherText
  *
+ * The tenant's GPS requirements are read from the client before each generation.
+ * The client reuses a fetched copy for a short period, so this does not add a
+ * request per event, and a requirement changed in the compliance console takes
+ * effect without reloading the page. Call `refreshConfig` to apply a change
+ * immediately.
+ *
  * @example
  * ```tsx
  * function LoginForm() {
@@ -80,6 +86,7 @@ declare function createDeviceFingerprint(): DeviceFingerprintRequest;
  */
 declare function useCipherText(client?: GeolocationClient): {
     generate: (options: CipherTextOptions) => Promise<CipherTextResult | null>;
+    refreshConfig: () => Promise<void>;
     configLoading: boolean;
     configError: Error | null;
 };
@@ -214,7 +221,13 @@ interface UseCustomerProfileResult {
     loading: boolean;
     error: Error | null;
     fetchProfile: () => Promise<CustomerProfile>;
-    updateProfile: (updates: Partial<CustomerProfile>) => Promise<CustomerProfile>;
+    /**
+     * Update the loaded profile. Resolves to the updated profile, or to a
+     * `ProfileUpdateHeldResponse` when the tenant holds a name / date of birth /
+     * address change behind KYC — narrow with `isProfileUpdateHeld`. The hook's
+     * `profile` state is updated either way (with the profile as stored).
+     */
+    updateProfile: (updates: Partial<CustomerProfile>) => Promise<UpdateProfileResult>;
     refresh: () => Promise<CustomerProfile>;
 }
 /**
@@ -293,45 +306,6 @@ declare function useCustomerProfile(client: RiskProfileClient, customerId: strin
  * ```
  */
 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
  *
@@ -346,8 +320,7 @@ declare function useKycRequests(client: KycClient, options?: UseKycRequestsOptio
  *     alerts,
  *     total,
  *     loading,
- *     fetchAlerts,
- *     updateAlert
+ *     fetchAlerts
  *   } = useKycAlerts(client, {
  *     autoFetch: true,
  *     filters: { status: ["pending", "in_progress"], risk: "critical" },
@@ -358,81 +331,17 @@ declare function useKycRequests(client: KycClient, options?: UseKycRequestsOptio
  *     <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" })}
- *         />
+ *         <AlertCard key={alert.id} alert={alert} />
  *       ))}
  *     </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 reading KYC preferences
- *
- * Preferences are managed in the Vesant console. The returned
- * `updatePreferences` is deprecated: the platform exposes no update
- * operation, so it always fails.
- *
- * @param client - KycClient instance
- * @param autoFetch - Auto-fetch preferences on mount (default: true)
- * @returns KYC preferences state and methods
- *
- * @example
- * ```tsx
- * function PreferencesSummary() {
- *   const { preferences, loading, refresh } = useKycPreferences(client);
- *
- *   if (loading) return <Spinner />;
- *
- *   return (
- *     <dl>
- *       <dt>Face verification required</dt>
- *       <dd>{String(preferences?.is_face_verification_required)}</dd>
- *       <dt>Required documents</dt>
- *       <dd>{preferences?.required_document_count}</dd>
- *       <button onClick={refresh}>Refresh</button>
- *     </dl>
- *   );
- * }
- * ```
+ * @remarks Console session only: the alert endpoints need a dashboard login
+ * token and fail with a tenant API key.
  */
-declare function useKycPreferences(client: KycClient, autoFetch?: boolean): UseKycPreferencesResult;
+declare function useKycAlerts(client: KycClient, options?: UseKycAlertsOptions): UseKycAlertsResult;
 /**
  * Convert a File to base64 string for document upload
  *
@@ -625,4 +534,4 @@ interface FaceCaptureModalProps {
 }
 declare function FaceCaptureModal({ client, session, onComplete, onCancel, defaultDevice, renderQR, mediapipeAssetBasePath, }: Readonly<FaceCaptureModalProps>): React$1.ReactElement;
 
-export { FaceCaptureModal, type FaceCaptureModalProps, type RunFlowResult, type UseCustomerProfileOptions, type UseCustomerProfileResult, UseGeolocationOptions, UseGeolocationResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycOverviewOptions, UseKycOverviewResult, UseKycPreferencesResult, UseKycRequestsOptions, UseKycRequestsResult, UseKycSubmissionOptions, UseKycSubmissionResult, UseLocationCaptureOptions, UseLocationCaptureResult, UseLocationRequestsOptions, UseLocationRequestsResult, type UseLoginVerificationOptions, type UseLoginVerificationResult, type UseRegistrationOptions, type UseRegistrationResult, type UseTransactionVerificationOptions, type UseTransactionVerificationResult, type VerifyFaceOptions, buildEventBasedFaceVerificationQrPayload, createDeviceFingerprint, fileToBase64, formatKycStatus, getBrowserInfo, getRiskColor, getStatusColor, isMobileDevice, isValidFileSize, isValidFileType, useCipherText, useCustomerProfile, useEventBasedFaceVerificationSubmission, useGeolocation, useKycAlerts, useKycOverview, useKycPreferences, useKycRequests, useKycSubmission, useLocationCapture, useLocationRequests, useLoginVerification, useRegistration, useTransactionVerification };
+export { FaceCaptureModal, type FaceCaptureModalProps, type RunFlowResult, type UseCustomerProfileOptions, type UseCustomerProfileResult, UseGeolocationOptions, UseGeolocationResult, UseKycAlertsOptions, UseKycAlertsResult, UseKycSubmissionOptions, UseKycSubmissionResult, UseLocationCaptureOptions, UseLocationCaptureResult, UseLocationRequestsOptions, UseLocationRequestsResult, type UseLoginVerificationOptions, type UseLoginVerificationResult, type UseRegistrationOptions, type UseRegistrationResult, type UseTransactionVerificationOptions, type UseTransactionVerificationResult, type VerifyFaceOptions, buildEventBasedFaceVerificationQrPayload, createDeviceFingerprint, fileToBase64, formatKycStatus, getBrowserInfo, getRiskColor, getStatusColor, isMobileDevice, isValidFileSize, isValidFileType, useCipherText, useCustomerProfile, useEventBasedFaceVerificationSubmission, useGeolocation, useKycAlerts, useKycSubmission, useLocationCapture, useLocationRequests, useLoginVerification, useRegistration, useTransactionVerification };