vesant-sdk 1.7.0-dev.b2c9ecf → 1.7.0-dev.b4284ca
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{client-B32yBt1b.d.ts → client-0NOPDnT0.d.ts} +16 -26
- package/dist/{client-BqPVh5jH.d.mts → client-CvWNRwwg.d.mts} +16 -26
- package/dist/{client-CHPEgasE.d.mts → client-Dps40EtF.d.mts} +2 -2
- package/dist/{client-pKE_gii_.d.ts → client-SMxqod4j.d.ts} +2 -2
- package/dist/{client-6sSaxufk.d.mts → client-q9fN8Hhf.d.mts} +96 -1
- package/dist/{client-6sSaxufk.d.ts → client-q9fN8Hhf.d.ts} +96 -1
- package/dist/compliance/index.d.mts +3 -3
- package/dist/compliance/index.d.ts +3 -3
- package/dist/compliance/index.js +114 -16
- package/dist/compliance/index.js.map +1 -1
- package/dist/compliance/index.mjs +114 -16
- package/dist/compliance/index.mjs.map +1 -1
- package/dist/decisions/index.d.mts +1 -1
- package/dist/decisions/index.d.ts +1 -1
- package/dist/decisions/index.js +49 -4
- package/dist/decisions/index.js.map +1 -1
- package/dist/decisions/index.mjs +49 -4
- package/dist/decisions/index.mjs.map +1 -1
- package/dist/geolocation/index.d.mts +59 -4
- package/dist/geolocation/index.d.ts +59 -4
- package/dist/geolocation/index.js +117 -16
- package/dist/geolocation/index.js.map +1 -1
- package/dist/geolocation/index.mjs +115 -17
- package/dist/geolocation/index.mjs.map +1 -1
- package/dist/index-CPOrMRaH.d.ts +264 -0
- package/dist/index-CimDmgZb.d.mts +264 -0
- package/dist/index.d.mts +25 -8
- package/dist/index.d.ts +25 -8
- package/dist/index.js +274 -37
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +267 -38
- package/dist/index.mjs.map +1 -1
- package/dist/kyc/core.d.mts +1 -1
- package/dist/kyc/core.d.ts +1 -1
- package/dist/kyc/core.js +49 -4
- package/dist/kyc/core.js.map +1 -1
- package/dist/kyc/core.mjs +49 -4
- package/dist/kyc/core.mjs.map +1 -1
- package/dist/kyc/index.d.mts +1 -1
- package/dist/kyc/index.d.ts +1 -1
- package/dist/kyc/index.js +49 -4
- package/dist/kyc/index.js.map +1 -1
- package/dist/kyc/index.mjs +49 -4
- package/dist/kyc/index.mjs.map +1 -1
- package/dist/react.d.mts +7 -3
- package/dist/react.d.ts +7 -3
- package/dist/react.js +68 -4
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +68 -4
- package/dist/react.mjs.map +1 -1
- package/dist/risk-profile/index.d.mts +1 -1
- package/dist/risk-profile/index.d.ts +1 -1
- package/dist/risk-profile/index.js +49 -4
- package/dist/risk-profile/index.js.map +1 -1
- package/dist/risk-profile/index.mjs +49 -4
- package/dist/risk-profile/index.mjs.map +1 -1
- package/dist/scores/index.d.mts +1 -1
- package/dist/scores/index.d.ts +1 -1
- package/dist/scores/index.js +49 -4
- package/dist/scores/index.js.map +1 -1
- package/dist/scores/index.mjs +49 -4
- package/dist/scores/index.mjs.map +1 -1
- package/dist/tax/index.d.mts +1 -1
- package/dist/tax/index.d.ts +1 -1
- package/dist/tax/index.js +49 -4
- package/dist/tax/index.js.map +1 -1
- package/dist/tax/index.mjs +49 -4
- package/dist/tax/index.mjs.map +1 -1
- package/dist/webhooks/index.d.mts +2 -189
- package/dist/webhooks/index.d.ts +2 -189
- package/dist/webhooks/index.js +85 -21
- package/dist/webhooks/index.js.map +1 -1
- package/dist/webhooks/index.mjs +85 -22
- package/dist/webhooks/index.mjs.map +1 -1
- package/package.json +4 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { L as Logger, B as BaseClient, R as RequestOptions } from './client-
|
|
1
|
+
import { L as Logger, B as BaseClient, R as RequestOptions } from './client-q9fN8Hhf.js';
|
|
2
2
|
import { B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.js';
|
|
3
3
|
|
|
4
4
|
interface DeviceFingerprintRequest {
|
|
@@ -47,6 +47,8 @@ interface CipherTextPayload {
|
|
|
47
47
|
heading?: number;
|
|
48
48
|
speed?: number;
|
|
49
49
|
timestamp: number;
|
|
50
|
+
/** Advisory client-side GPS integrity flags; the server weighs these as risk factors. */
|
|
51
|
+
integrity_flags?: string[];
|
|
50
52
|
};
|
|
51
53
|
/** Network information */
|
|
52
54
|
network?: {
|
|
@@ -227,7 +229,11 @@ interface ValidateCipherTextResponse {
|
|
|
227
229
|
};
|
|
228
230
|
}
|
|
229
231
|
interface VerifyIPRequest {
|
|
230
|
-
|
|
232
|
+
/**
|
|
233
|
+
* Optional. Omit to let the server derive the connecting IP — the SDK never
|
|
234
|
+
* asserts the client IP (spoofable, and the server extracts it authoritatively).
|
|
235
|
+
*/
|
|
236
|
+
ip_address?: string;
|
|
231
237
|
user_id: string;
|
|
232
238
|
event_type: string;
|
|
233
239
|
device_fingerprint?: DeviceFingerprintRequest;
|
|
@@ -624,16 +630,6 @@ interface ResendLocationRequestRequest {
|
|
|
624
630
|
email?: string;
|
|
625
631
|
phone?: string;
|
|
626
632
|
}
|
|
627
|
-
interface WiFiNetwork {
|
|
628
|
-
/** MAC address (BSSID) */
|
|
629
|
-
macAddress: string;
|
|
630
|
-
/** Signal strength in dBm (negative number) */
|
|
631
|
-
signalStrength?: number;
|
|
632
|
-
/** WiFi channel */
|
|
633
|
-
channel?: number;
|
|
634
|
-
/** Network name (optional) */
|
|
635
|
-
ssid?: string;
|
|
636
|
-
}
|
|
637
633
|
interface LocationCaptureRequest {
|
|
638
634
|
/** GPS latitude (if available) */
|
|
639
635
|
latitude?: number;
|
|
@@ -641,8 +637,8 @@ interface LocationCaptureRequest {
|
|
|
641
637
|
longitude?: number;
|
|
642
638
|
/** GPS accuracy in meters */
|
|
643
639
|
accuracy?: number;
|
|
644
|
-
/**
|
|
645
|
-
|
|
640
|
+
/** Advisory client-side GPS integrity flags; the server weighs these as risk factors. */
|
|
641
|
+
integrity_flags?: string[];
|
|
646
642
|
/** User agent string */
|
|
647
643
|
user_agent?: string;
|
|
648
644
|
/** Device metadata */
|
|
@@ -662,6 +658,10 @@ interface LocationShareInfo {
|
|
|
662
658
|
status: string;
|
|
663
659
|
is_expired: boolean;
|
|
664
660
|
is_completed: boolean;
|
|
661
|
+
/**
|
|
662
|
+
* Server-only hint. The web SDK cannot enumerate WiFi networks (no browser API
|
|
663
|
+
* for BSSIDs); this flag is informational and never satisfied client-side.
|
|
664
|
+
*/
|
|
665
665
|
requires_wifi: boolean;
|
|
666
666
|
}
|
|
667
667
|
interface LocationCaptureResponse {
|
|
@@ -730,8 +730,6 @@ interface UseLocationCaptureOptions {
|
|
|
730
730
|
autoFetch?: boolean;
|
|
731
731
|
/** Auto-request GPS permission on mount */
|
|
732
732
|
autoRequestGPS?: boolean;
|
|
733
|
-
/** Collect WiFi data as fallback (requires explicit permission) */
|
|
734
|
-
collectWiFi?: boolean;
|
|
735
733
|
}
|
|
736
734
|
interface UseLocationCaptureResult {
|
|
737
735
|
/** Location share info */
|
|
@@ -995,20 +993,12 @@ declare class GeolocationClient extends BaseClient {
|
|
|
995
993
|
*
|
|
996
994
|
* @example
|
|
997
995
|
* ```typescript
|
|
998
|
-
* //
|
|
996
|
+
* // GPS (the web SDK is GPS + IP only; the server handles the IP fallback)
|
|
999
997
|
* const result = await client.captureLocation(token, {
|
|
1000
998
|
* latitude: 37.7749,
|
|
1001
999
|
* longitude: -122.4194,
|
|
1002
1000
|
* accuracy: 10
|
|
1003
1001
|
* });
|
|
1004
|
-
*
|
|
1005
|
-
* // Using WiFi positioning (fallback)
|
|
1006
|
-
* const result = await client.captureLocation(token, {
|
|
1007
|
-
* wifi_networks: [
|
|
1008
|
-
* { macAddress: "00:11:22:33:44:55", signalStrength: -50 },
|
|
1009
|
-
* { macAddress: "AA:BB:CC:DD:EE:FF", signalStrength: -70 }
|
|
1010
|
-
* ]
|
|
1011
|
-
* });
|
|
1012
1002
|
* ```
|
|
1013
1003
|
*/
|
|
1014
1004
|
captureLocation(token: string, capture: LocationCaptureRequest, requestOptions?: RequestOptions): Promise<LocationCaptureResponse>;
|
|
@@ -1031,4 +1021,4 @@ declare class GeolocationClient extends BaseClient {
|
|
|
1031
1021
|
generateCipherText(options: Omit<CipherTextOptions, 'apiKey' | 'signingKey'>, gpsConfig?: GeolocationConfigResponse): Promise<CipherTextResult>;
|
|
1032
1022
|
}
|
|
1033
1023
|
|
|
1034
|
-
export { type UseLocationRequestsResult as $, type APIError as A, type GeolocationClientConfig as B, type CipherTextCustomerData as C, type DeviceFingerprintRequest as D, type GeolocationConfigResponse as E, type GeolocationRecord as F, GeolocationClient as G, type LocationCaptureRequest as H, type LocationCaptureResponse as I, type JurisdictionConfig as J, type LocationRequestChannel as K, type LocationVerification as L, type LocationRequestResult as M, type LocationRequestStatus as N, type LocationShareInfo as O, type UpdateGeofenceRuleRequest as P, type UpdateJurisdictionRequest as Q, type ResendLocationRequestRequest as R, type UseAlertsOptions as S, type UseAlertsResult as T, type UpdateDeviceTrustRequest as U, type ValidateCipherTextResponse as V, type UseGeolocationOptions as W, type UseGeolocationResult as X, type UseLocationCaptureOptions as Y, type UseLocationCaptureResult as Z, type UseLocationRequestsOptions as _, type LocationRequest as a, type ValidateCipherTextRequest as a0, type VerifyIPRequest as a1, type
|
|
1024
|
+
export { type UseLocationRequestsResult as $, type APIError as A, type GeolocationClientConfig as B, type CipherTextCustomerData as C, type DeviceFingerprintRequest as D, type GeolocationConfigResponse as E, type GeolocationRecord as F, GeolocationClient as G, type LocationCaptureRequest as H, type LocationCaptureResponse as I, type JurisdictionConfig as J, type LocationRequestChannel as K, type LocationVerification as L, type LocationRequestResult as M, type LocationRequestStatus as N, type LocationShareInfo as O, type UpdateGeofenceRuleRequest as P, type UpdateJurisdictionRequest as Q, type ResendLocationRequestRequest as R, type UseAlertsOptions as S, type UseAlertsResult as T, type UpdateDeviceTrustRequest as U, type ValidateCipherTextResponse as V, type UseGeolocationOptions as W, type UseGeolocationResult as X, type UseLocationCaptureOptions as Y, type UseLocationCaptureResult as Z, type UseLocationRequestsOptions as _, type LocationRequest as a, type ValidateCipherTextRequest as a0, type VerifyIPRequest as a1, type LocationRequestFilters as b, type LocationRequestListResponse as c, type AlertFilters as d, type AlertListResponse as e, type AlertSeverity as f, type AlertStatus as g, type AlertType as h, type CipherTextOptions as i, type CipherTextPayload as j, type CipherTextReason as k, type CipherTextResult as l, type ComplianceCheckResponse as m, type CreateGeofenceRuleRequest as n, type CreateJurisdictionRequest as o, type CreateLocationRequestRequest as p, type DashboardMetrics as q, type DecryptedCipherText as r, type DeviceFingerprint as s, type DeviceTrustResult as t, type GeoIPResult as u, type GeofenceAction as v, type GeofenceEvaluation as w, type GeofenceRule as x, type GeofenceRuleType as y, type GeolocationAlert as z };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { L as Logger, B as BaseClient, R as RequestOptions } from './client-
|
|
1
|
+
import { L as Logger, B as BaseClient, R as RequestOptions } from './client-q9fN8Hhf.mjs';
|
|
2
2
|
import { B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.mjs';
|
|
3
3
|
|
|
4
4
|
interface DeviceFingerprintRequest {
|
|
@@ -47,6 +47,8 @@ interface CipherTextPayload {
|
|
|
47
47
|
heading?: number;
|
|
48
48
|
speed?: number;
|
|
49
49
|
timestamp: number;
|
|
50
|
+
/** Advisory client-side GPS integrity flags; the server weighs these as risk factors. */
|
|
51
|
+
integrity_flags?: string[];
|
|
50
52
|
};
|
|
51
53
|
/** Network information */
|
|
52
54
|
network?: {
|
|
@@ -227,7 +229,11 @@ interface ValidateCipherTextResponse {
|
|
|
227
229
|
};
|
|
228
230
|
}
|
|
229
231
|
interface VerifyIPRequest {
|
|
230
|
-
|
|
232
|
+
/**
|
|
233
|
+
* Optional. Omit to let the server derive the connecting IP — the SDK never
|
|
234
|
+
* asserts the client IP (spoofable, and the server extracts it authoritatively).
|
|
235
|
+
*/
|
|
236
|
+
ip_address?: string;
|
|
231
237
|
user_id: string;
|
|
232
238
|
event_type: string;
|
|
233
239
|
device_fingerprint?: DeviceFingerprintRequest;
|
|
@@ -624,16 +630,6 @@ interface ResendLocationRequestRequest {
|
|
|
624
630
|
email?: string;
|
|
625
631
|
phone?: string;
|
|
626
632
|
}
|
|
627
|
-
interface WiFiNetwork {
|
|
628
|
-
/** MAC address (BSSID) */
|
|
629
|
-
macAddress: string;
|
|
630
|
-
/** Signal strength in dBm (negative number) */
|
|
631
|
-
signalStrength?: number;
|
|
632
|
-
/** WiFi channel */
|
|
633
|
-
channel?: number;
|
|
634
|
-
/** Network name (optional) */
|
|
635
|
-
ssid?: string;
|
|
636
|
-
}
|
|
637
633
|
interface LocationCaptureRequest {
|
|
638
634
|
/** GPS latitude (if available) */
|
|
639
635
|
latitude?: number;
|
|
@@ -641,8 +637,8 @@ interface LocationCaptureRequest {
|
|
|
641
637
|
longitude?: number;
|
|
642
638
|
/** GPS accuracy in meters */
|
|
643
639
|
accuracy?: number;
|
|
644
|
-
/**
|
|
645
|
-
|
|
640
|
+
/** Advisory client-side GPS integrity flags; the server weighs these as risk factors. */
|
|
641
|
+
integrity_flags?: string[];
|
|
646
642
|
/** User agent string */
|
|
647
643
|
user_agent?: string;
|
|
648
644
|
/** Device metadata */
|
|
@@ -662,6 +658,10 @@ interface LocationShareInfo {
|
|
|
662
658
|
status: string;
|
|
663
659
|
is_expired: boolean;
|
|
664
660
|
is_completed: boolean;
|
|
661
|
+
/**
|
|
662
|
+
* Server-only hint. The web SDK cannot enumerate WiFi networks (no browser API
|
|
663
|
+
* for BSSIDs); this flag is informational and never satisfied client-side.
|
|
664
|
+
*/
|
|
665
665
|
requires_wifi: boolean;
|
|
666
666
|
}
|
|
667
667
|
interface LocationCaptureResponse {
|
|
@@ -730,8 +730,6 @@ interface UseLocationCaptureOptions {
|
|
|
730
730
|
autoFetch?: boolean;
|
|
731
731
|
/** Auto-request GPS permission on mount */
|
|
732
732
|
autoRequestGPS?: boolean;
|
|
733
|
-
/** Collect WiFi data as fallback (requires explicit permission) */
|
|
734
|
-
collectWiFi?: boolean;
|
|
735
733
|
}
|
|
736
734
|
interface UseLocationCaptureResult {
|
|
737
735
|
/** Location share info */
|
|
@@ -995,20 +993,12 @@ declare class GeolocationClient extends BaseClient {
|
|
|
995
993
|
*
|
|
996
994
|
* @example
|
|
997
995
|
* ```typescript
|
|
998
|
-
* //
|
|
996
|
+
* // GPS (the web SDK is GPS + IP only; the server handles the IP fallback)
|
|
999
997
|
* const result = await client.captureLocation(token, {
|
|
1000
998
|
* latitude: 37.7749,
|
|
1001
999
|
* longitude: -122.4194,
|
|
1002
1000
|
* accuracy: 10
|
|
1003
1001
|
* });
|
|
1004
|
-
*
|
|
1005
|
-
* // Using WiFi positioning (fallback)
|
|
1006
|
-
* const result = await client.captureLocation(token, {
|
|
1007
|
-
* wifi_networks: [
|
|
1008
|
-
* { macAddress: "00:11:22:33:44:55", signalStrength: -50 },
|
|
1009
|
-
* { macAddress: "AA:BB:CC:DD:EE:FF", signalStrength: -70 }
|
|
1010
|
-
* ]
|
|
1011
|
-
* });
|
|
1012
1002
|
* ```
|
|
1013
1003
|
*/
|
|
1014
1004
|
captureLocation(token: string, capture: LocationCaptureRequest, requestOptions?: RequestOptions): Promise<LocationCaptureResponse>;
|
|
@@ -1031,4 +1021,4 @@ declare class GeolocationClient extends BaseClient {
|
|
|
1031
1021
|
generateCipherText(options: Omit<CipherTextOptions, 'apiKey' | 'signingKey'>, gpsConfig?: GeolocationConfigResponse): Promise<CipherTextResult>;
|
|
1032
1022
|
}
|
|
1033
1023
|
|
|
1034
|
-
export { type UseLocationRequestsResult as $, type APIError as A, type GeolocationClientConfig as B, type CipherTextCustomerData as C, type DeviceFingerprintRequest as D, type GeolocationConfigResponse as E, type GeolocationRecord as F, GeolocationClient as G, type LocationCaptureRequest as H, type LocationCaptureResponse as I, type JurisdictionConfig as J, type LocationRequestChannel as K, type LocationVerification as L, type LocationRequestResult as M, type LocationRequestStatus as N, type LocationShareInfo as O, type UpdateGeofenceRuleRequest as P, type UpdateJurisdictionRequest as Q, type ResendLocationRequestRequest as R, type UseAlertsOptions as S, type UseAlertsResult as T, type UpdateDeviceTrustRequest as U, type ValidateCipherTextResponse as V, type UseGeolocationOptions as W, type UseGeolocationResult as X, type UseLocationCaptureOptions as Y, type UseLocationCaptureResult as Z, type UseLocationRequestsOptions as _, type LocationRequest as a, type ValidateCipherTextRequest as a0, type VerifyIPRequest as a1, type
|
|
1024
|
+
export { type UseLocationRequestsResult as $, type APIError as A, type GeolocationClientConfig as B, type CipherTextCustomerData as C, type DeviceFingerprintRequest as D, type GeolocationConfigResponse as E, type GeolocationRecord as F, GeolocationClient as G, type LocationCaptureRequest as H, type LocationCaptureResponse as I, type JurisdictionConfig as J, type LocationRequestChannel as K, type LocationVerification as L, type LocationRequestResult as M, type LocationRequestStatus as N, type LocationShareInfo as O, type UpdateGeofenceRuleRequest as P, type UpdateJurisdictionRequest as Q, type ResendLocationRequestRequest as R, type UseAlertsOptions as S, type UseAlertsResult as T, type UpdateDeviceTrustRequest as U, type ValidateCipherTextResponse as V, type UseGeolocationOptions as W, type UseGeolocationResult as X, type UseLocationCaptureOptions as Y, type UseLocationCaptureResult as Z, type UseLocationRequestsOptions as _, type LocationRequest as a, type ValidateCipherTextRequest as a0, type VerifyIPRequest as a1, type LocationRequestFilters as b, type LocationRequestListResponse as c, type AlertFilters as d, type AlertListResponse as e, type AlertSeverity as f, type AlertStatus as g, type AlertType as h, type CipherTextOptions as i, type CipherTextPayload as j, type CipherTextReason as k, type CipherTextResult as l, type ComplianceCheckResponse as m, type CreateGeofenceRuleRequest as n, type CreateJurisdictionRequest as o, type CreateLocationRequestRequest as p, type DashboardMetrics as q, type DecryptedCipherText as r, type DeviceFingerprint as s, type DeviceTrustResult as t, type GeoIPResult as u, type GeofenceAction as v, type GeofenceEvaluation as w, type GeofenceRule as x, type GeofenceRuleType as y, type GeolocationAlert as z };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-
|
|
1
|
+
import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-CvWNRwwg.mjs';
|
|
2
2
|
import { RiskProfileClient } from './risk-profile/index.mjs';
|
|
3
|
-
import { V as VesantConfig, R as RequestOptions } from './client-
|
|
3
|
+
import { V as VesantConfig, R as RequestOptions } from './client-q9fN8Hhf.mjs';
|
|
4
4
|
import { C as CustomerProfile } from './types-BOFaMQxI.mjs';
|
|
5
5
|
import { E as EntityType, B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.mjs';
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-
|
|
1
|
+
import { D as DeviceFingerprintRequest, L as LocationVerification, V as ValidateCipherTextResponse, a as LocationRequest, G as GeolocationClient, b as LocationRequestFilters, c as LocationRequestListResponse } from './client-0NOPDnT0.js';
|
|
2
2
|
import { RiskProfileClient } from './risk-profile/index.js';
|
|
3
|
-
import { V as VesantConfig, R as RequestOptions } from './client-
|
|
3
|
+
import { V as VesantConfig, R as RequestOptions } from './client-q9fN8Hhf.js';
|
|
4
4
|
import { C as CustomerProfile } from './types-UGyDl1fd.js';
|
|
5
5
|
import { E as EntityType, B as BlockReason, P as PaginationParams } from './types-CBQRNL-l.js';
|
|
6
6
|
|
|
@@ -50,6 +50,80 @@ declare class CircuitBreaker {
|
|
|
50
50
|
reset(): void;
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
+
/**
|
|
54
|
+
* Pluggable authentication for BaseClient.
|
|
55
|
+
*
|
|
56
|
+
* A TokenProvider supplies the credential used for the Authorization header on
|
|
57
|
+
* every request, resolved per-request (async) so callers can source short-lived
|
|
58
|
+
* or rotating credentials (OAuth2 client-credentials, STS, Vault / Secrets
|
|
59
|
+
* Manager) instead of a single static API key. The default StaticApiKeyProvider
|
|
60
|
+
* preserves the original `apiKey` behavior with zero change for existing callers.
|
|
61
|
+
*/
|
|
62
|
+
interface AuthCredential {
|
|
63
|
+
/** Authorization scheme (e.g. 'Bearer'); defaults to 'Bearer' when omitted. */
|
|
64
|
+
scheme?: string;
|
|
65
|
+
/** The credential value (bearer token / API key). */
|
|
66
|
+
token: string;
|
|
67
|
+
}
|
|
68
|
+
interface TokenProviderContext {
|
|
69
|
+
tenantId: string;
|
|
70
|
+
requestId: string;
|
|
71
|
+
/** When true, bypass any cache and obtain a fresh credential (e.g. after a 401). */
|
|
72
|
+
forceRefresh?: boolean;
|
|
73
|
+
}
|
|
74
|
+
interface TokenProvider {
|
|
75
|
+
/** Resolve the credential for a request, or null to send no Authorization header. */
|
|
76
|
+
getCredential(ctx: TokenProviderContext): Promise<AuthCredential | null>;
|
|
77
|
+
/** Whether this provider can obtain a fresh credential on demand (drives 401 retry). */
|
|
78
|
+
canRefresh?(): boolean;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Default provider: wraps a static API key. Returns null when the key is empty
|
|
82
|
+
* so the client sends no Authorization header, matching the pre-provider behavior.
|
|
83
|
+
*/
|
|
84
|
+
declare class StaticApiKeyProvider implements TokenProvider {
|
|
85
|
+
private readonly apiKey;
|
|
86
|
+
constructor(apiKey: string);
|
|
87
|
+
getCredential(): Promise<AuthCredential | null>;
|
|
88
|
+
canRefresh(): boolean;
|
|
89
|
+
}
|
|
90
|
+
interface CachedToken {
|
|
91
|
+
token: string;
|
|
92
|
+
expiresAt?: number;
|
|
93
|
+
}
|
|
94
|
+
interface RefreshingTokenProviderOptions {
|
|
95
|
+
/** Fetches a fresh token. `expiresAt` is epoch milliseconds (optional). */
|
|
96
|
+
fetchToken: () => Promise<CachedToken>;
|
|
97
|
+
/** Refresh this many ms before expiry (default: 30_000). */
|
|
98
|
+
skewMs?: number;
|
|
99
|
+
/** Authorization scheme to emit (default: 'Bearer'). */
|
|
100
|
+
scheme?: string;
|
|
101
|
+
/** Observe each successful (re)fetch — for logging / metrics. */
|
|
102
|
+
onRotate?: (meta: {
|
|
103
|
+
expiresAt?: number;
|
|
104
|
+
}) => void;
|
|
105
|
+
/** Injectable clock (default: Date.now). */
|
|
106
|
+
now?: () => number;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Caches a fetched token and refreshes it when it is within the skew window of
|
|
110
|
+
* expiry or when `forceRefresh` is requested. Concurrent refreshes are de-duped
|
|
111
|
+
* into a single in-flight fetch.
|
|
112
|
+
*/
|
|
113
|
+
declare class RefreshingTokenProvider implements TokenProvider {
|
|
114
|
+
private readonly opts;
|
|
115
|
+
private cached;
|
|
116
|
+
private inFlight;
|
|
117
|
+
private readonly skewMs;
|
|
118
|
+
private readonly scheme;
|
|
119
|
+
private readonly now;
|
|
120
|
+
constructor(opts: RefreshingTokenProviderOptions);
|
|
121
|
+
canRefresh(): boolean;
|
|
122
|
+
getCredential(ctx?: TokenProviderContext): Promise<AuthCredential | null>;
|
|
123
|
+
private isExpiring;
|
|
124
|
+
private refresh;
|
|
125
|
+
}
|
|
126
|
+
|
|
53
127
|
/**
|
|
54
128
|
* Configuration types for Vesant SDK clients
|
|
55
129
|
*/
|
|
@@ -82,6 +156,16 @@ interface BaseClientConfig {
|
|
|
82
156
|
tenantId: string;
|
|
83
157
|
/** Optional API key for authentication */
|
|
84
158
|
apiKey?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Pluggable auth token provider. When set, it supplies the Authorization
|
|
161
|
+
* credential per-request (overriding `apiKey`), enabling OAuth2 / STS / rotating
|
|
162
|
+
* secrets and single-shot 401 re-auth. Defaults to a static-apiKey provider.
|
|
163
|
+
*/
|
|
164
|
+
authProvider?: TokenProvider;
|
|
165
|
+
/** Observe credential rotation triggered by a 401 re-auth (logging / metrics). */
|
|
166
|
+
onCredentialRotated?: (meta: {
|
|
167
|
+
reason: string;
|
|
168
|
+
}) => void;
|
|
85
169
|
/** Custom headers to include in all requests */
|
|
86
170
|
headers?: Record<string, string>;
|
|
87
171
|
/** Request timeout in milliseconds (default: 10000) */
|
|
@@ -108,6 +192,16 @@ interface VesantConfig {
|
|
|
108
192
|
tenantId: string;
|
|
109
193
|
/** Optional API key for authentication */
|
|
110
194
|
apiKey?: string;
|
|
195
|
+
/**
|
|
196
|
+
* Pluggable auth token provider. When set, it supplies the Authorization
|
|
197
|
+
* credential per-request (overriding `apiKey`), enabling OAuth2 / STS / rotating
|
|
198
|
+
* secrets and single-shot 401 re-auth. Defaults to a static-apiKey provider.
|
|
199
|
+
*/
|
|
200
|
+
authProvider?: TokenProvider;
|
|
201
|
+
/** Observe credential rotation triggered by a 401 re-auth (logging / metrics). */
|
|
202
|
+
onCredentialRotated?: (meta: {
|
|
203
|
+
reason: string;
|
|
204
|
+
}) => void;
|
|
111
205
|
/** Custom headers to include in all requests */
|
|
112
206
|
headers?: Record<string, string>;
|
|
113
207
|
/** Request timeout in milliseconds (default: 10000) */
|
|
@@ -195,6 +289,7 @@ declare abstract class BaseClient {
|
|
|
195
289
|
private interceptors;
|
|
196
290
|
private circuitBreaker;
|
|
197
291
|
private rateLimitTracker;
|
|
292
|
+
private authProvider;
|
|
198
293
|
constructor(config: BaseClientConfig);
|
|
199
294
|
/**
|
|
200
295
|
* Resolve the Idempotency-Key for a request. Mutating methods (POST/PUT/PATCH)
|
|
@@ -244,4 +339,4 @@ declare abstract class BaseClient {
|
|
|
244
339
|
}>;
|
|
245
340
|
}
|
|
246
341
|
|
|
247
|
-
export { BaseClient as B, type CGSConfig as C, type Logger as L, type RequestOptions as R, type VesantConfig as V, type BaseClientConfig as a, CircuitBreaker as b, type CircuitBreakerConfig as c, type CircuitBreakerState as d, type CircuitBreakerStatus as e, type RateLimitStatus as f, RateLimitTracker as g, type RequestInterceptor as
|
|
342
|
+
export { type AuthCredential as A, BaseClient as B, type CGSConfig as C, type Logger as L, type RequestOptions as R, StaticApiKeyProvider as S, type TokenProvider as T, type VesantConfig as V, type BaseClientConfig as a, CircuitBreaker as b, type CircuitBreakerConfig as c, type CircuitBreakerState as d, type CircuitBreakerStatus as e, type RateLimitStatus as f, RateLimitTracker as g, RefreshingTokenProvider as h, type RefreshingTokenProviderOptions as i, type RequestInterceptor as j, type RequiredBaseClientConfig as k, type RequiredCGSConfig as l, type RequiredVesantConfig as m, type TokenProviderContext as n };
|
|
@@ -50,6 +50,80 @@ declare class CircuitBreaker {
|
|
|
50
50
|
reset(): void;
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
+
/**
|
|
54
|
+
* Pluggable authentication for BaseClient.
|
|
55
|
+
*
|
|
56
|
+
* A TokenProvider supplies the credential used for the Authorization header on
|
|
57
|
+
* every request, resolved per-request (async) so callers can source short-lived
|
|
58
|
+
* or rotating credentials (OAuth2 client-credentials, STS, Vault / Secrets
|
|
59
|
+
* Manager) instead of a single static API key. The default StaticApiKeyProvider
|
|
60
|
+
* preserves the original `apiKey` behavior with zero change for existing callers.
|
|
61
|
+
*/
|
|
62
|
+
interface AuthCredential {
|
|
63
|
+
/** Authorization scheme (e.g. 'Bearer'); defaults to 'Bearer' when omitted. */
|
|
64
|
+
scheme?: string;
|
|
65
|
+
/** The credential value (bearer token / API key). */
|
|
66
|
+
token: string;
|
|
67
|
+
}
|
|
68
|
+
interface TokenProviderContext {
|
|
69
|
+
tenantId: string;
|
|
70
|
+
requestId: string;
|
|
71
|
+
/** When true, bypass any cache and obtain a fresh credential (e.g. after a 401). */
|
|
72
|
+
forceRefresh?: boolean;
|
|
73
|
+
}
|
|
74
|
+
interface TokenProvider {
|
|
75
|
+
/** Resolve the credential for a request, or null to send no Authorization header. */
|
|
76
|
+
getCredential(ctx: TokenProviderContext): Promise<AuthCredential | null>;
|
|
77
|
+
/** Whether this provider can obtain a fresh credential on demand (drives 401 retry). */
|
|
78
|
+
canRefresh?(): boolean;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Default provider: wraps a static API key. Returns null when the key is empty
|
|
82
|
+
* so the client sends no Authorization header, matching the pre-provider behavior.
|
|
83
|
+
*/
|
|
84
|
+
declare class StaticApiKeyProvider implements TokenProvider {
|
|
85
|
+
private readonly apiKey;
|
|
86
|
+
constructor(apiKey: string);
|
|
87
|
+
getCredential(): Promise<AuthCredential | null>;
|
|
88
|
+
canRefresh(): boolean;
|
|
89
|
+
}
|
|
90
|
+
interface CachedToken {
|
|
91
|
+
token: string;
|
|
92
|
+
expiresAt?: number;
|
|
93
|
+
}
|
|
94
|
+
interface RefreshingTokenProviderOptions {
|
|
95
|
+
/** Fetches a fresh token. `expiresAt` is epoch milliseconds (optional). */
|
|
96
|
+
fetchToken: () => Promise<CachedToken>;
|
|
97
|
+
/** Refresh this many ms before expiry (default: 30_000). */
|
|
98
|
+
skewMs?: number;
|
|
99
|
+
/** Authorization scheme to emit (default: 'Bearer'). */
|
|
100
|
+
scheme?: string;
|
|
101
|
+
/** Observe each successful (re)fetch — for logging / metrics. */
|
|
102
|
+
onRotate?: (meta: {
|
|
103
|
+
expiresAt?: number;
|
|
104
|
+
}) => void;
|
|
105
|
+
/** Injectable clock (default: Date.now). */
|
|
106
|
+
now?: () => number;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Caches a fetched token and refreshes it when it is within the skew window of
|
|
110
|
+
* expiry or when `forceRefresh` is requested. Concurrent refreshes are de-duped
|
|
111
|
+
* into a single in-flight fetch.
|
|
112
|
+
*/
|
|
113
|
+
declare class RefreshingTokenProvider implements TokenProvider {
|
|
114
|
+
private readonly opts;
|
|
115
|
+
private cached;
|
|
116
|
+
private inFlight;
|
|
117
|
+
private readonly skewMs;
|
|
118
|
+
private readonly scheme;
|
|
119
|
+
private readonly now;
|
|
120
|
+
constructor(opts: RefreshingTokenProviderOptions);
|
|
121
|
+
canRefresh(): boolean;
|
|
122
|
+
getCredential(ctx?: TokenProviderContext): Promise<AuthCredential | null>;
|
|
123
|
+
private isExpiring;
|
|
124
|
+
private refresh;
|
|
125
|
+
}
|
|
126
|
+
|
|
53
127
|
/**
|
|
54
128
|
* Configuration types for Vesant SDK clients
|
|
55
129
|
*/
|
|
@@ -82,6 +156,16 @@ interface BaseClientConfig {
|
|
|
82
156
|
tenantId: string;
|
|
83
157
|
/** Optional API key for authentication */
|
|
84
158
|
apiKey?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Pluggable auth token provider. When set, it supplies the Authorization
|
|
161
|
+
* credential per-request (overriding `apiKey`), enabling OAuth2 / STS / rotating
|
|
162
|
+
* secrets and single-shot 401 re-auth. Defaults to a static-apiKey provider.
|
|
163
|
+
*/
|
|
164
|
+
authProvider?: TokenProvider;
|
|
165
|
+
/** Observe credential rotation triggered by a 401 re-auth (logging / metrics). */
|
|
166
|
+
onCredentialRotated?: (meta: {
|
|
167
|
+
reason: string;
|
|
168
|
+
}) => void;
|
|
85
169
|
/** Custom headers to include in all requests */
|
|
86
170
|
headers?: Record<string, string>;
|
|
87
171
|
/** Request timeout in milliseconds (default: 10000) */
|
|
@@ -108,6 +192,16 @@ interface VesantConfig {
|
|
|
108
192
|
tenantId: string;
|
|
109
193
|
/** Optional API key for authentication */
|
|
110
194
|
apiKey?: string;
|
|
195
|
+
/**
|
|
196
|
+
* Pluggable auth token provider. When set, it supplies the Authorization
|
|
197
|
+
* credential per-request (overriding `apiKey`), enabling OAuth2 / STS / rotating
|
|
198
|
+
* secrets and single-shot 401 re-auth. Defaults to a static-apiKey provider.
|
|
199
|
+
*/
|
|
200
|
+
authProvider?: TokenProvider;
|
|
201
|
+
/** Observe credential rotation triggered by a 401 re-auth (logging / metrics). */
|
|
202
|
+
onCredentialRotated?: (meta: {
|
|
203
|
+
reason: string;
|
|
204
|
+
}) => void;
|
|
111
205
|
/** Custom headers to include in all requests */
|
|
112
206
|
headers?: Record<string, string>;
|
|
113
207
|
/** Request timeout in milliseconds (default: 10000) */
|
|
@@ -195,6 +289,7 @@ declare abstract class BaseClient {
|
|
|
195
289
|
private interceptors;
|
|
196
290
|
private circuitBreaker;
|
|
197
291
|
private rateLimitTracker;
|
|
292
|
+
private authProvider;
|
|
198
293
|
constructor(config: BaseClientConfig);
|
|
199
294
|
/**
|
|
200
295
|
* Resolve the Idempotency-Key for a request. Mutating methods (POST/PUT/PATCH)
|
|
@@ -244,4 +339,4 @@ declare abstract class BaseClient {
|
|
|
244
339
|
}>;
|
|
245
340
|
}
|
|
246
341
|
|
|
247
|
-
export { BaseClient as B, type CGSConfig as C, type Logger as L, type RequestOptions as R, type VesantConfig as V, type BaseClientConfig as a, CircuitBreaker as b, type CircuitBreakerConfig as c, type CircuitBreakerState as d, type CircuitBreakerStatus as e, type RateLimitStatus as f, RateLimitTracker as g, type RequestInterceptor as
|
|
342
|
+
export { type AuthCredential as A, BaseClient as B, type CGSConfig as C, type Logger as L, type RequestOptions as R, StaticApiKeyProvider as S, type TokenProvider as T, type VesantConfig as V, type BaseClientConfig as a, CircuitBreaker as b, type CircuitBreakerConfig as c, type CircuitBreakerState as d, type CircuitBreakerStatus as e, type RateLimitStatus as f, RateLimitTracker as g, RefreshingTokenProvider as h, type RefreshingTokenProviderOptions as i, type RequestInterceptor as j, type RequiredBaseClientConfig as k, type RequiredCGSConfig as l, type RequiredVesantConfig as m, type TokenProviderContext as n };
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { B as BlockReason } from '../types-CBQRNL-l.mjs';
|
|
2
|
-
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-
|
|
3
|
-
export { p as CreateLocationRequestRequest, H as LocationCaptureRequest, I as LocationCaptureResponse, a as LocationRequest, K as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, M as LocationRequestResult, N as LocationRequestStatus, O as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-
|
|
2
|
+
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-Dps40EtF.mjs';
|
|
3
|
+
export { p as CreateLocationRequestRequest, H as LocationCaptureRequest, I as LocationCaptureResponse, a as LocationRequest, K as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, M as LocationRequestResult, N as LocationRequestStatus, O as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-CvWNRwwg.mjs';
|
|
4
4
|
import '../risk-profile/index.mjs';
|
|
5
|
-
import '../client-
|
|
5
|
+
import '../client-q9fN8Hhf.mjs';
|
|
6
6
|
import '../types-BOFaMQxI.mjs';
|
|
7
7
|
|
|
8
8
|
declare const sdkReasons: {
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { B as BlockReason } from '../types-CBQRNL-l.js';
|
|
2
|
-
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-
|
|
3
|
-
export { p as CreateLocationRequestRequest, H as LocationCaptureRequest, I as LocationCaptureResponse, a as LocationRequest, K as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, M as LocationRequestResult, N as LocationRequestStatus, O as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-
|
|
2
|
+
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-SMxqod4j.js';
|
|
3
|
+
export { p as CreateLocationRequestRequest, H as LocationCaptureRequest, I as LocationCaptureResponse, a as LocationRequest, K as LocationRequestChannel, b as LocationRequestFilters, c as LocationRequestListResponse, M as LocationRequestResult, N as LocationRequestStatus, O as LocationShareInfo, R as ResendLocationRequestRequest } from '../client-0NOPDnT0.js';
|
|
4
4
|
import '../risk-profile/index.js';
|
|
5
|
-
import '../client-
|
|
5
|
+
import '../client-q9fN8Hhf.js';
|
|
6
6
|
import '../types-UGyDl1fd.js';
|
|
7
7
|
|
|
8
8
|
declare const sdkReasons: {
|