vesant-sdk 1.7.2-next.ec7157c → 1.8.0-dev.00f6233

package/README.md

@@ -352,9 +352,13 @@ interface ComplianceClientConfig {
 | `requestKycSubmitLink(request)` | Generate a KYC submission link |
 | `checkKycStatus(request)` | Check KYC verification status |
 | `submitVerification(request)` | Submit document verification |
-| `listKycRequests(filters)` | List KYC requests |
-| `getPreferences()` | Get KYC preferences |
-| `listAlerts(filters)` | List KYC alerts |
+| `getKycRequest(id)` | Get a KYC record with proof download links |
+| `getProofDownloadURLs(id)` | Download links for a record's proofs |
+| `listAlerts(filters)` | List KYC alerts (console session only) |
+| `createEventBasedFaceVerificationSession(request)` | Start a face re-verification session (backend) |
+| `submitEventBasedFaceVerificationSession(request)` | Submit a face capture for a session |
+| `getEventBasedFaceVerificationSessionStatus(token)` | Look up a session's current result |
+| `retryEventBasedFaceVerificationJourney(token)` | Mint the next hosted journey after a decline |
 
 ## Documentation
 

package/dist/{client-B3DCAHlg.d.ts → client-BPALLldd.d.ts}

@@ -1,7 +1,7 @@
-import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-fy3trF2K.js';
+import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-BaUekQT8.js';
 import { RiskProfileClient } from './risk-profile/index.js';
 import { V as VesantConfig, R as RequestOptions } from './client-q9fN8Hhf.js';
-import { C as CustomerProfile } from './types-UGyDl1fd.js';
+import { C as CustomerProfile } from './types-qXamJr2q.js';
 import { E as EntityType, B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.js';
 
 interface RegistrationVerificationRequest {

package/dist/{client-fy3trF2K.d.ts → client-BaUekQT8.d.ts}

@@ -534,6 +534,15 @@ interface GeolocationClientConfig {
     logger?: Logger;
     /** Environment mode - 'sandbox' uses isolated sandbox data */
     environment?: 'production' | 'sandbox';
+    /**
+     * How long a fetched GPS requirement config is reused before it is read again,
+     * in milliseconds (default: 300000, i.e. 5 minutes).
+     *
+     * These requirements are edited in the compliance console while your
+     * application is running, so a lower value makes changes take effect sooner at
+     * the cost of more requests. Use `refreshGPSConfig()` to re-read immediately.
+     */
+    gpsConfigTtlMs?: number;
 }
 interface UseGeolocationOptions {
     /** Auto-detect and verify user's IP on mount */
@@ -786,17 +795,9 @@ interface UseLocationCaptureResult {
  * Extends BaseClient for consistent retry logic, timeout handling, and error management.
  */
 
-/**
- * GeolocationClient extends BaseClient for:
- * - Consistent retry logic with exponential backoff
- * - Unified error handling (VesantError, NetworkError, TimeoutError, etc.)
- * - Automatic timeout management
- * - Debug logging
- *
- * All geolocation verification calls use requestWithRetry() to handle
- * transient failures gracefully.
- */
 declare class GeolocationClient extends BaseClient {
+    private readonly gpsConfigTtlMs;
+    private gpsConfigCache;
     constructor(config: GeolocationClientConfig);
     /**
      * Verify an IP address and check compliance
@@ -857,6 +858,27 @@ declare class GeolocationClient extends BaseClient {
      * ```
      */
     getGPSConfig(requestOptions?: RequestOptions): Promise<GeolocationConfigResponse>;
+    /**
+     * Re-read the tenant's GPS requirement configuration, ignoring any copy held
+     * from an earlier read.
+     *
+     * These requirements are edited in the compliance console while your
+     * application is running. `getGPSConfig` reuses a fetched copy for a short
+     * period so a long-lived session does not call the API on every event; call
+     * this when you need a change to take effect immediately — for example right
+     * after an administrator saves new settings.
+     *
+     * @returns The current GPS requirement config per event type
+     *
+     * @example
+     * ```typescript
+     * const config = await client.refreshGPSConfig();
+     * if (config.require_gps.login) {
+     *   // GPS is now required for login
+     * }
+     * ```
+     */
+    refreshGPSConfig(requestOptions?: RequestOptions): Promise<GeolocationConfigResponse>;
     /**
      * Mint a short-lived, single-use device-signals nonce.
      *

package/dist/{client-BwXMQA2a.d.mts → client-XDEhh9VN.d.mts}

@@ -534,6 +534,15 @@ interface GeolocationClientConfig {
     logger?: Logger;
     /** Environment mode - 'sandbox' uses isolated sandbox data */
     environment?: 'production' | 'sandbox';
+    /**
+     * How long a fetched GPS requirement config is reused before it is read again,
+     * in milliseconds (default: 300000, i.e. 5 minutes).
+     *
+     * These requirements are edited in the compliance console while your
+     * application is running, so a lower value makes changes take effect sooner at
+     * the cost of more requests. Use `refreshGPSConfig()` to re-read immediately.
+     */
+    gpsConfigTtlMs?: number;
 }
 interface UseGeolocationOptions {
     /** Auto-detect and verify user's IP on mount */
@@ -786,17 +795,9 @@ interface UseLocationCaptureResult {
  * Extends BaseClient for consistent retry logic, timeout handling, and error management.
  */
 
-/**
- * GeolocationClient extends BaseClient for:
- * - Consistent retry logic with exponential backoff
- * - Unified error handling (VesantError, NetworkError, TimeoutError, etc.)
- * - Automatic timeout management
- * - Debug logging
- *
- * All geolocation verification calls use requestWithRetry() to handle
- * transient failures gracefully.
- */
 declare class GeolocationClient extends BaseClient {
+    private readonly gpsConfigTtlMs;
+    private gpsConfigCache;
     constructor(config: GeolocationClientConfig);
     /**
      * Verify an IP address and check compliance
@@ -857,6 +858,27 @@ declare class GeolocationClient extends BaseClient {
      * ```
      */
     getGPSConfig(requestOptions?: RequestOptions): Promise<GeolocationConfigResponse>;
+    /**
+     * Re-read the tenant's GPS requirement configuration, ignoring any copy held
+     * from an earlier read.
+     *
+     * These requirements are edited in the compliance console while your
+     * application is running. `getGPSConfig` reuses a fetched copy for a short
+     * period so a long-lived session does not call the API on every event; call
+     * this when you need a change to take effect immediately — for example right
+     * after an administrator saves new settings.
+     *
+     * @returns The current GPS requirement config per event type
+     *
+     * @example
+     * ```typescript
+     * const config = await client.refreshGPSConfig();
+     * if (config.require_gps.login) {
+     *   // GPS is now required for login
+     * }
+     * ```
+     */
+    refreshGPSConfig(requestOptions?: RequestOptions): Promise<GeolocationConfigResponse>;
     /**
      * Mint a short-lived, single-use device-signals nonce.
      *

package/dist/{client-D23KhWeh.d.mts → client-_OhkfnyJ.d.mts}

@@ -1,7 +1,7 @@
-import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-BwXMQA2a.mjs';
+import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-XDEhh9VN.mjs';
 import { RiskProfileClient } from './risk-profile/index.mjs';
 import { V as VesantConfig, R as RequestOptions } from './client-q9fN8Hhf.mjs';
-import { C as CustomerProfile } from './types-BOFaMQxI.mjs';
+import { C as CustomerProfile } from './types-DbvVph_0.mjs';
 import { E as EntityType, B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.mjs';
 
 interface RegistrationVerificationRequest {

package/dist/compliance/index.d.mts

@@ -1,9 +1,9 @@
 import { B as BlockReason } from '../types-CBQRNL-l.mjs';
-export { C as ComplianceClient, a as ComplianceLocationRequestInput, b as ComplianceLocationRequestResult, c as CurrencyRates, D as DEFAULT_CURRENCY_RATES, E as EventVerificationRequest, d as EventVerificationResponse, L as LoginVerificationRequest, e as LoginVerificationResponse, R as RegistrationVerificationRequest, f as RegistrationVerificationResponse, T as TransactionRiskResult, g as TransactionVerificationRequest, h as TransactionVerificationResponse } from '../client-D23KhWeh.mjs';
-export { p as CreateLocationRequestRequest, I as LocationCaptureRequest, K as LocationCaptureResponse, a as LocationRequest, M as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, N as LocationRequestResult, O as LocationRequestStatus, P as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-BwXMQA2a.mjs';
+export { C as ComplianceClient, a as ComplianceLocationRequestInput, b as ComplianceLocationRequestResult, c as CurrencyRates, D as DEFAULT_CURRENCY_RATES, E as EventVerificationRequest, d as EventVerificationResponse, L as LoginVerificationRequest, e as LoginVerificationResponse, R as RegistrationVerificationRequest, f as RegistrationVerificationResponse, T as TransactionRiskResult, g as TransactionVerificationRequest, h as TransactionVerificationResponse } from '../client-_OhkfnyJ.mjs';
+export { p as CreateLocationRequestRequest, I as LocationCaptureRequest, K as LocationCaptureResponse, a as LocationRequest, M as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, N as LocationRequestResult, O as LocationRequestStatus, P as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-XDEhh9VN.mjs';
 import '../risk-profile/index.mjs';
 import '../client-q9fN8Hhf.mjs';
-import '../types-BOFaMQxI.mjs';
+import '../types-DbvVph_0.mjs';
 
 declare const sdkReasons: {
     jurisdictionBlocked: (country: string, countryISO: string) => BlockReason;

package/dist/compliance/index.d.ts

@@ -1,9 +1,9 @@
 import { B as BlockReason } from '../types-CBQRNL-l.js';
-export { C as ComplianceClient, a as ComplianceLocationRequestInput, b as ComplianceLocationRequestResult, c as CurrencyRates, D as DEFAULT_CURRENCY_RATES, E as EventVerificationRequest, d as EventVerificationResponse, L as LoginVerificationRequest, e as LoginVerificationResponse, R as RegistrationVerificationRequest, f as RegistrationVerificationResponse, T as TransactionRiskResult, g as TransactionVerificationRequest, h as TransactionVerificationResponse } from '../client-B3DCAHlg.js';
-export { p as CreateLocationRequestRequest, I as LocationCaptureRequest, K as LocationCaptureResponse, a as LocationRequest, M as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, N as LocationRequestResult, O as LocationRequestStatus, P as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-fy3trF2K.js';
+export { C as ComplianceClient, a as ComplianceLocationRequestInput, b as ComplianceLocationRequestResult, c as CurrencyRates, D as DEFAULT_CURRENCY_RATES, E as EventVerificationRequest, d as EventVerificationResponse, L as LoginVerificationRequest, e as LoginVerificationResponse, R as RegistrationVerificationRequest, f as RegistrationVerificationResponse, T as TransactionRiskResult, g as TransactionVerificationRequest, h as TransactionVerificationResponse } from '../client-BPALLldd.js';
+export { p as CreateLocationRequestRequest, I as LocationCaptureRequest, K as LocationCaptureResponse, a as LocationRequest, M as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, N as LocationRequestResult, O as LocationRequestStatus, P as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-BaUekQT8.js';
 import '../risk-profile/index.js';
 import '../client-q9fN8Hhf.js';
-import '../types-UGyDl1fd.js';
+import '../types-qXamJr2q.js';
 
 declare const sdkReasons: {
     jurisdictionBlocked: (country: string, countryISO: string) => BlockReason;

package/dist/compliance/index.js

@@ -312,7 +312,7 @@ function createConsoleLogger() {
 }
 
 // src/core/version.ts
-var SDK_VERSION = "1.7.2";
+var SDK_VERSION = "1.8.0";
 
 // src/shared/browser-utils.ts
 function generateUUID() {
@@ -647,19 +647,20 @@ var BaseClient = class {
    * Handle error responses from API
    */
   handleErrorResponse(status, data, requestId) {
-    const message = data.error || data.message || `HTTP ${status}`;
+    const structured = data.error && typeof data.error === "object" && !Array.isArray(data.error) ? data.error : void 0;
+    const message = typeof data.error === "string" && data.error || typeof structured?.message === "string" && structured.message || typeof data.message === "string" && data.message || `HTTP ${status}`;
     const createError = () => {
       switch (status) {
         case 400:
-          return new VesantError(message, "BAD_REQUEST", 400);
+          return new VesantError(message, "BAD_REQUEST", 400, structured);
         case 401:
           return new AuthenticationError(message);
         case 403:
-          return new VesantError(message, "FORBIDDEN", 403);
+          return new VesantError(message, "FORBIDDEN", 403, structured);
         case 404:
-          return new VesantError(message, "NOT_FOUND", 404);
+          return new VesantError(message, "NOT_FOUND", 404, structured);
         case 409:
-          return new VesantError(message, "DUPLICATE_PROFILE", 409);
+          return new VesantError(message, "DUPLICATE_PROFILE", 409, structured);
         case 429: {
           const retryAfter = data.retry_after || data.retryAfter;
           return new RateLimitError(retryAfter);
@@ -670,7 +671,7 @@ var BaseClient = class {
         case 504:
           return new ServiceUnavailableError(message);
         default:
-          return new VesantError(message, "UNKNOWN_ERROR", status);
+          return new VesantError(message, "UNKNOWN_ERROR", status, structured);
       }
     };
     const error = createError();
@@ -969,6 +970,7 @@ async function generateCipherText(options, config) {
 }
 
 // src/geolocation/client.ts
+var DEFAULT_GPS_CONFIG_TTL_MS = 5 * 60 * 1e3;
 var GeolocationClient = class extends BaseClient {
   constructor(config) {
     const baseConfig = {
@@ -984,6 +986,8 @@ var GeolocationClient = class extends BaseClient {
       environment: config.environment
     };
     super(baseConfig);
+    this.gpsConfigCache = null;
+    this.gpsConfigTtlMs = config.gpsConfigTtlMs ?? DEFAULT_GPS_CONFIG_TTL_MS;
   }
   // ============================================================================
   // IP Verification & Compliance
@@ -1069,7 +1073,42 @@ var GeolocationClient = class extends BaseClient {
    * ```
    */
   async getGPSConfig(requestOptions) {
-    return this.requestWithRetry("/api/v1/geo/config", void 0, void 0, void 0, requestOptions);
+    const cached = this.gpsConfigCache;
+    if (cached && cached.expiresAt > Date.now()) {
+      return cached.value;
+    }
+    return this.refreshGPSConfig(requestOptions);
+  }
+  /**
+   * Re-read the tenant's GPS requirement configuration, ignoring any copy held
+   * from an earlier read.
+   *
+   * These requirements are edited in the compliance console while your
+   * application is running. `getGPSConfig` reuses a fetched copy for a short
+   * period so a long-lived session does not call the API on every event; call
+   * this when you need a change to take effect immediately — for example right
+   * after an administrator saves new settings.
+   *
+   * @returns The current GPS requirement config per event type
+   *
+   * @example
+   * ```typescript
+   * const config = await client.refreshGPSConfig();
+   * if (config.require_gps.login) {
+   *   // GPS is now required for login
+   * }
+   * ```
+   */
+  async refreshGPSConfig(requestOptions) {
+    const value = await this.requestWithRetry(
+      "/api/v1/geo/config",
+      void 0,
+      void 0,
+      void 0,
+      requestOptions
+    );
+    this.gpsConfigCache = { value, expiresAt: Date.now() + this.gpsConfigTtlMs };
+    return value;
   }
   /**
    * Mint a short-lived, single-use device-signals nonce.
@@ -1486,17 +1525,27 @@ var RiskProfileClient = class extends BaseClient {
   /**
    * Update customer profile
    *
+   * Omitted fields keep their stored values. When the tenant has the
+   * **On Account Sensitive Action** KYC trigger enabled and the update changes
+   * the customer's name, date of birth or residential address, Vesant applies
+   * the other fields, holds the sensitive ones and answers `202` with a
+   * {@link ProfileUpdateHeldResponse} instead of the profile. Narrow with
+   * {@link isProfileUpdateHeld}, then request a `profile_change` submit link.
+   *
    * @param profileId - Profile UUID
    * @param updates - Fields to update
-   * @returns Updated customer profile
+   * @returns Updated customer profile, or the held change
    *
    * @example
    * ```typescript
-   * const updated = await client.updateProfile(profileId, {
+   * const result = await client.updateProfile(profileId, {
    *   location: 'New York, USA',
    *   location_compliance: 'compliant',
    *   last_recorded_activity: new Date().toISOString()
    * });
+   * if (isProfileUpdateHeld(result)) {
+   *   // name / DOB / address held: start KYC with trigger_event 'profile_change'
+   * }
    * ```
    */
   async updateProfile(profileId, updates, requestOptions) {
@@ -1536,6 +1585,11 @@ var RiskProfileClient = class extends BaseClient {
   }
 };
 
+// src/risk-profile/types.ts
+function isProfileUpdateHeld(result) {
+  return typeof result === "object" && result !== null && result.status === "kyc_required" && result.kyc_required === true;
+}
+
 // src/compliance/types.ts
 var DEFAULT_CURRENCY_RATES = {
   USD: 1,
@@ -1991,11 +2045,12 @@ var ComplianceClient = class {
       if (profileResult) {
         profile = profileResult;
         if (!isBlocked && this.shouldUpdateProfile(profile, geoVerification.location.city)) {
-          profile = await this.riskClient.updateProfile(profile.id, {
+          const updated = await this.riskClient.updateProfile(profile.id, {
             last_recorded_activity: (/* @__PURE__ */ new Date()).toISOString(),
             location: `${geoVerification.location.city}, ${geoVerification.location.country}`,
             location_compliance: geoVerification.is_compliant ? "compliant" : "non-compliant"
           }, requestOptions);
+          profile = isProfileUpdateHeld(updated) ? updated.profile : updated;
         }
       } else {
         if (this.config.autoCreateProfiles && this.config.debug) {