vesant-sdk 1.0.8 → 1.1.1

package/dist/{client-D0xQUtlw.d.ts → client-BfeDYmrZ.d.mts}

@@ -1,13 +1,4 @@
-import { P as PaginationParams, B as BaseClient } from './types-Bnsnejor.js';
-
-/**
- * TypeScript type definitions for CGS Geolocation Service API
- *
- * These types match the Go API structures in:
- * - services/geolocation-service/internal/domain/
- * - services/geolocation-service/internal/service/
- * - services/geolocation-service/internal/handler/
- */
+import { b as Logger, P as PaginationParams, B as BaseClient, R as RequestOptions } from './types-BpKxSXGF.mjs';
 
 interface DeviceFingerprintRequest {
     device_id: string;
@@ -203,6 +194,10 @@ interface ValidateCipherTextResponse {
         is_blocked: boolean;
         /** Reasons for blocking (only present if is_blocked is true) */
         block_reasons?: string[];
+        /** GPS-vs-IP location mismatch detected (possible spoofing) */
+        location_mismatch?: boolean;
+        /** Distance in km between GPS and IP-derived location */
+        location_mismatch_distance_km?: number;
     };
     errors?: string[];
 }
@@ -445,6 +440,16 @@ interface APIError {
     message?: string;
     details?: Record<string, unknown>;
 }
+/**
+ * GPS requirement configuration per event type, returned by GET /api/v1/geo/config
+ */
+interface GeolocationConfigResponse {
+    require_gps: {
+        login: boolean;
+        registration: boolean;
+        transaction: boolean;
+    };
+}
 interface GeolocationClientConfig {
     /** Base URL of the API Gateway (e.g., "https://api.example.com") */
     baseURL: string;
@@ -458,6 +463,8 @@ interface GeolocationClientConfig {
     timeout?: number;
     /** Enable debug logging */
     debug?: boolean;
+    /** Custom logger instance */
+    logger?: Logger;
 }
 interface UseGeolocationOptions {
     /** Auto-detect and verify user's IP on mount */
@@ -466,6 +473,8 @@ interface UseGeolocationOptions {
     eventType?: string;
     /** Include device fingerprint in verification */
     includeDeviceFingerprint?: boolean;
+    /** User ID to include in verification requests */
+    userId?: string;
 }
 interface UseGeolocationResult {
     /** Current verification result */
@@ -624,6 +633,18 @@ interface LocationCaptureResponse {
     latitude?: number;
     longitude?: number;
     accuracy?: number;
+    /** Resolved country name (from Nominatim or MaxMind fallback) */
+    country?: string;
+    /** ISO country code */
+    country_iso?: string;
+    /** Resolved city name */
+    city?: string;
+    /** Resolved region/state name */
+    region?: string;
+    /** GPS-vs-IP location mismatch detected (possible spoofing) */
+    location_mismatch?: boolean;
+    /** Distance in km between GPS and IP-derived location */
+    mismatch_distance_km?: number;
 }
 interface UseLocationRequestsOptions {
     /** Auto-fetch location requests on mount */
@@ -742,7 +763,7 @@ declare class GeolocationClient extends BaseClient {
      * }
      * ```
      */
-    verifyIP(request: VerifyIPRequest): Promise<LocationVerification>;
+    verifyIP(request: VerifyIPRequest, requestOptions?: RequestOptions): Promise<LocationVerification>;
     /**
      * Check compliance for a specific country
      *
@@ -757,7 +778,24 @@ declare class GeolocationClient extends BaseClient {
      * }
      * ```
      */
-    checkCompliance(countryISO: string): Promise<ComplianceCheckResponse>;
+    checkCompliance(countryISO: string, requestOptions?: RequestOptions): Promise<ComplianceCheckResponse>;
+    /**
+     * Get the tenant's GPS requirement configuration
+     *
+     * Returns which event types require GPS location to be collected.
+     * Use this to auto-enable GPS collection in generateCipherText when required.
+     *
+     * @returns GPS requirement config per event type
+     *
+     * @example
+     * ```typescript
+     * const config = await client.getGPSConfig();
+     * if (config.require_gps.login) {
+     *   // GPS is required for login — auto-enable location
+     * }
+     * ```
+     */
+    getGPSConfig(requestOptions?: RequestOptions): Promise<GeolocationConfigResponse>;
     /**
      * Validate a cipherText generated by the frontend SDK
      *
@@ -799,7 +837,7 @@ declare class GeolocationClient extends BaseClient {
      * }
      * ```
      */
-    validateCipherText(cipherText: string, userId: string, eventType: CipherTextReason, expectedIP?: string, customerData?: CipherTextCustomerData): Promise<ValidateCipherTextResponse>;
+    validateCipherText(cipherText: string, userId: string, eventType: CipherTextReason, expectedIP?: string, customerData?: CipherTextCustomerData, requestOptions?: RequestOptions): Promise<ValidateCipherTextResponse>;
     /**
      * Validate cipherText and verify IP in a single call
      *
@@ -830,226 +868,11 @@ declare class GeolocationClient extends BaseClient {
      * }
      * ```
      */
-    validateAndVerify(cipherText: string, ipAddress: string, userId: string, eventType: CipherTextReason): Promise<{
+    validateAndVerify(cipherText: string, ipAddress: string, userId: string, eventType: CipherTextReason, requestOptions?: RequestOptions): Promise<{
         ciphertext_valid: boolean;
         ciphertext_result: ValidateCipherTextResponse;
         location: LocationVerification;
     }>;
-    /**
-     * Get location history for a user
-     *
-     * @param userId - User ID to retrieve history for
-     * @param limit - Maximum number of records to return (default: 100)
-     * @returns Array of geolocation records
-     */
-    getUserLocationHistory(userId: string, limit?: number): Promise<GeolocationRecord[]>;
-    /**
-     * Get a specific alert by ID
-     *
-     * @param alertId - Alert ID
-     * @returns Alert details
-     */
-    getAlert(alertId: string): Promise<GeolocationAlert>;
-    /**
-     * List alerts with filters and pagination
-     *
-     * @param filters - Optional filters (status, severity, type, user, dates)
-     * @param pagination - Optional pagination (page, page_size)
-     * @returns Paginated list of alerts
-     *
-     * @example
-     * ```typescript
-     * const alerts = await client.listAlerts(
-     *   { status: "active", severity: "critical" },
-     *   { page: 1, page_size: 20 }
-     * );
-     * console.log(`Found ${alerts.total} critical alerts`);
-     * ```
-     */
-    listAlerts(filters?: AlertFilters, pagination?: PaginationParams): Promise<AlertListResponse>;
-    /**
-     * Update alert status
-     *
-     * @param alertId - Alert ID
-     * @param status - New status
-     */
-    updateAlertStatus(alertId: string, status: AlertStatus): Promise<void>;
-    /**
-     * Assign an alert to an analyst
-     *
-     * @param alertId - Alert ID
-     * @param assignedTo - User ID to assign to
-     */
-    assignAlert(alertId: string, assignedTo: string): Promise<void>;
-    /**
-     * Resolve an alert
-     *
-     * @param alertId - Alert ID
-     * @param resolution - Resolution type
-     * @param notes - Optional notes
-     */
-    resolveAlert(alertId: string, resolution: string, notes?: string): Promise<void>;
-    /**
-     * Dismiss an alert as false positive
-     *
-     * @param alertId - Alert ID
-     * @param notes - Optional notes explaining why it's a false positive
-     */
-    dismissAlert(alertId: string, notes?: string): Promise<void>;
-    /**
-     * Escalate an alert to higher severity or different assignee
-     *
-     * @param alertId - Alert ID
-     * @param assignedTo - New assignee user ID
-     * @param severity - New severity level
-     * @param notes - Escalation notes
-     */
-    escalateAlert(alertId: string, assignedTo: string, severity: string, notes: string): Promise<void>;
-    /**
-     * Block an alert (mark as blocked)
-     *
-     * @param alertId - Alert ID
-     * @param notes - Optional notes
-     */
-    blockAlert(alertId: string, notes?: string): Promise<void>;
-    /**
-     * Get dashboard metrics
-     *
-     * @param timeRangeHours - Time range in hours (default: 24)
-     * @returns Dashboard metrics and statistics
-     *
-     * @example
-     * ```typescript
-     * const metrics = await client.getDashboardMetrics(168); // Last 7 days
-     * console.log(`${metrics.critical_alerts} critical alerts in last week`);
-     * ```
-     */
-    getDashboardMetrics(timeRangeHours?: number): Promise<DashboardMetrics>;
-    /**
-     * List all jurisdiction configurations
-     *
-     * @returns Array of jurisdiction configurations
-     */
-    listJurisdictions(): Promise<JurisdictionConfig[]>;
-    /**
-     * Get a jurisdiction configuration by ID
-     *
-     * @param jurisdictionId - Jurisdiction ID
-     * @returns Jurisdiction configuration
-     */
-    getJurisdiction(jurisdictionId: string): Promise<JurisdictionConfig>;
-    /**
-     * Create a new jurisdiction configuration
-     *
-     * @param request - Jurisdiction configuration data
-     * @returns Created jurisdiction
-     *
-     * @example
-     * ```typescript
-     * const jurisdiction = await client.createJurisdiction({
-     *   country_iso: "US",
-     *   country_name: "United States",
-     *   status: "allowed",
-     *   risk_level: "low",
-     *   allow_login: true,
-     *   allow_registration: true,
-     *   allow_transactions: true,
-     *   require_kyc: false,
-     *   require_enhanced_verification: false
-     * });
-     * ```
-     */
-    createJurisdiction(request: CreateJurisdictionRequest): Promise<JurisdictionConfig>;
-    /**
-     * Update a jurisdiction configuration
-     *
-     * @param jurisdictionId - Jurisdiction ID
-     * @param request - Updated fields
-     * @returns Updated jurisdiction
-     */
-    updateJurisdiction(jurisdictionId: string, request: UpdateJurisdictionRequest): Promise<JurisdictionConfig>;
-    /**
-     * Delete a jurisdiction configuration
-     *
-     * @param jurisdictionId - Jurisdiction ID
-     */
-    deleteJurisdiction(jurisdictionId: string): Promise<void>;
-    /**
-     * List all geofence rules
-     *
-     * @returns Array of geofence rules
-     */
-    listGeofenceRules(): Promise<GeofenceRule[]>;
-    /**
-     * Get a geofence rule by ID
-     *
-     * @param ruleId - Geofence rule ID
-     * @returns Geofence rule
-     */
-    getGeofenceRule(ruleId: string): Promise<GeofenceRule>;
-    /**
-     * Create a new geofence rule
-     *
-     * @param request - Geofence rule data
-     * @returns Created geofence rule
-     *
-     * @example
-     * ```typescript
-     * const rule = await client.createGeofenceRule({
-     *   name: "Block High Risk Countries",
-     *   rule_type: "block_list",
-     *   action: "block",
-     *   countries: ["KP", "IR", "SY"],
-     *   event_types: ["login", "transaction"],
-     *   priority: 100
-     * });
-     * ```
-     */
-    createGeofenceRule(request: CreateGeofenceRuleRequest): Promise<GeofenceRule>;
-    /**
-     * Update a geofence rule
-     *
-     * @param ruleId - Geofence rule ID
-     * @param request - Updated fields
-     * @returns Updated geofence rule
-     */
-    updateGeofenceRule(ruleId: string, request: UpdateGeofenceRuleRequest): Promise<GeofenceRule>;
-    /**
-     * Delete a geofence rule
-     *
-     * @param ruleId - Geofence rule ID
-     */
-    deleteGeofenceRule(ruleId: string): Promise<void>;
-    /**
-     * Get all devices for a user
-     *
-     * @param userId - User ID
-     * @returns Array of device fingerprints
-     */
-    getUserDevices(userId: string): Promise<DeviceFingerprint[]>;
-    /**
-     * Get a specific device by device ID
-     *
-     * @param deviceId - Device ID
-     * @returns Device fingerprint
-     */
-    getDevice(deviceId: string): Promise<DeviceFingerprint>;
-    /**
-     * Update device trust status
-     *
-     * @param deviceId - Device ID
-     * @param action - "trust" or "untrust"
-     *
-     * @example
-     * ```typescript
-     * // Mark a device as trusted
-     * await client.updateDeviceTrust("device_abc", "trust");
-     *
-     * // Mark a device as untrusted
-     * await client.updateDeviceTrust("device_xyz", "untrust");
-     * ```
-     */
-    updateDeviceTrust(deviceId: string, action: 'trust' | 'untrust'): Promise<void>;
     /**
      * Create a location request to get customer's live location
      *
@@ -1069,14 +892,14 @@ declare class GeolocationClient extends BaseClient {
      * console.log(`Expires at: ${result.token_expiry}`);
      * ```
      */
-    createLocationRequest(request: CreateLocationRequestRequest): Promise<LocationRequestResult>;
+    createLocationRequest(request: CreateLocationRequestRequest, requestOptions?: RequestOptions): Promise<LocationRequestResult>;
     /**
      * Get a location request by ID
      *
      * @param requestId - Location request ID
      * @returns Location request details
      */
-    getLocationRequest(requestId: string): Promise<LocationRequest>;
+    getLocationRequest(requestId: string, requestOptions?: RequestOptions): Promise<LocationRequest>;
     /**
      * List location requests with filters and pagination
      *
@@ -1092,20 +915,20 @@ declare class GeolocationClient extends BaseClient {
      * );
      * ```
      */
-    listLocationRequests(filters?: LocationRequestFilters, pagination?: PaginationParams): Promise<LocationRequestListResponse>;
+    listLocationRequests(filters?: LocationRequestFilters, pagination?: PaginationParams, requestOptions?: RequestOptions): Promise<LocationRequestListResponse>;
     /**
      * Cancel a pending location request
      *
      * @param requestId - Location request ID
      */
-    cancelLocationRequest(requestId: string): Promise<void>;
+    cancelLocationRequest(requestId: string, requestOptions?: RequestOptions): Promise<void>;
     /**
      * Resend notification for a location request
      *
      * @param requestId - Location request ID
      * @param contact - Email or phone to send to
      */
-    resendLocationRequest(requestId: string, contact: ResendLocationRequestRequest): Promise<void>;
+    resendLocationRequest(requestId: string, contact: ResendLocationRequestRequest, requestOptions?: RequestOptions): Promise<void>;
     /**
      * Get location share info (customer-facing)
      * This is called from the customer's device to get request details
@@ -1113,7 +936,7 @@ declare class GeolocationClient extends BaseClient {
      * @param token - Secure token from share link
      * @returns Location share info
      */
-    getLocationShareInfo(token: string): Promise<LocationShareInfo>;
+    getLocationShareInfo(token: string, requestOptions?: RequestOptions): Promise<LocationShareInfo>;
     /**
      * Submit location capture (customer-facing)
      * This is called from the customer's device to submit their location
@@ -1140,7 +963,7 @@ declare class GeolocationClient extends BaseClient {
      * });
      * ```
      */
-    captureLocation(token: string, capture: LocationCaptureRequest): Promise<LocationCaptureResponse>;
+    captureLocation(token: string, capture: LocationCaptureRequest, requestOptions?: RequestOptions): Promise<LocationCaptureResponse>;
 }
 
-export { type UseLocationRequestsResult as $, type AlertStatus as A, type APIError as B, type CipherTextPayload as C, type DeviceFingerprintRequest as D, type GeolocationClientConfig as E, type UseGeolocationOptions as F, GeolocationClient as G, type UseGeolocationResult as H, type UseAlertsOptions as I, type JurisdictionConfig as J, type UseAlertsResult as K, type LocationVerification as L, type LocationRequestStatus as M, type LocationRequestChannel as N, type LocationRequest as O, type CreateLocationRequestRequest as P, type LocationRequestResult as Q, type LocationRequestFilters as R, type LocationRequestListResponse as S, type ResendLocationRequestRequest as T, type UpdateJurisdictionRequest as U, type ValidateCipherTextRequest as V, type WiFiNetwork as W, type LocationCaptureRequest as X, type LocationShareInfo as Y, type LocationCaptureResponse as Z, type UseLocationRequestsOptions as _, type CipherTextReason as a, type UseLocationCaptureOptions as a0, type UseLocationCaptureResult as a1, type CipherTextOptions as b, type CipherTextResult as c, type DecryptedCipherText as d, type CipherTextCustomerData as e, type ValidateCipherTextResponse as f, type VerifyIPRequest as g, type GeoIPResult as h, type GeofenceEvaluation as i, type DeviceFingerprint as j, type DeviceTrustResult as k, type ComplianceCheckResponse as l, type AlertSeverity as m, type AlertType as n, type GeolocationAlert as o, type AlertFilters as p, type AlertListResponse as q, type DashboardMetrics as r, type CreateJurisdictionRequest as s, type GeofenceRuleType as t, type GeofenceAction as u, type GeofenceRule as v, type CreateGeofenceRuleRequest as w, type UpdateGeofenceRuleRequest as x, type UpdateDeviceTrustRequest as y, type GeolocationRecord as z };
+export { type UseLocationRequestsOptions as $, type AlertStatus as A, type APIError as B, type CipherTextPayload as C, type DeviceFingerprintRequest as D, type GeolocationConfigResponse as E, type GeolocationClientConfig as F, GeolocationClient as G, type UseGeolocationOptions as H, type UseGeolocationResult as I, type JurisdictionConfig as J, type UseAlertsOptions as K, type LocationVerification as L, type UseAlertsResult as M, type LocationRequestStatus as N, type LocationRequestChannel as O, type LocationRequest as P, type CreateLocationRequestRequest as Q, type LocationRequestResult as R, type LocationRequestFilters as S, type LocationRequestListResponse as T, type UpdateJurisdictionRequest as U, type ValidateCipherTextRequest as V, type ResendLocationRequestRequest as W, type WiFiNetwork as X, type LocationCaptureRequest as Y, type LocationShareInfo as Z, type LocationCaptureResponse as _, type CipherTextReason as a, type UseLocationRequestsResult as a0, type UseLocationCaptureOptions as a1, type UseLocationCaptureResult as a2, type CipherTextOptions as b, type CipherTextResult as c, type DecryptedCipherText as d, type CipherTextCustomerData as e, type ValidateCipherTextResponse as f, type VerifyIPRequest as g, type GeoIPResult as h, type GeofenceEvaluation as i, type DeviceFingerprint as j, type DeviceTrustResult as k, type ComplianceCheckResponse as l, type AlertSeverity as m, type AlertType as n, type GeolocationAlert as o, type AlertFilters as p, type AlertListResponse as q, type DashboardMetrics as r, type CreateJurisdictionRequest as s, type GeofenceRuleType as t, type GeofenceAction as u, type GeofenceRule as v, type CreateGeofenceRuleRequest as w, type UpdateGeofenceRuleRequest as x, type UpdateDeviceTrustRequest as y, type GeolocationRecord as z };