@transmitsecurity/platform-web-sdk 2.6.0 → 2.6.2

package/dist/drs.d.ts

@@ -59,7 +59,8 @@ type AvsMatchLevel = 'none' | 'postal' | 'street' | 'full' | 'unknown';
 /** The outcome of an action reported via {@link TSAccountProtection.reportActionResult} */
 type ActionResult = "success" | "failure" | "incomplete";
 /** Type of challenge presented to the user, when a challenge was recommended for the action */
-type ChallengeType = "sms_otp" | "email_otp" | "totp" | "push_otp" | "voice_otp" | "idv" | "captcha" | "password" | "passkey";
+type ChallengeType = "sms_otp" | "email_otp" | "totp" | "push_otp" | "voice_otp" | "idv" | "captcha" | "password" | "passkey" | "document_verification" | "security_question" | "knowledge_based_authentication" | "device_approval" | "out_of_band" | "otp" | "device_biometrics" | "face_id" | "fingerprint" | "mobile_approve" | "pin" | "cap_rep_token" | "symantec_token" | "duo" | "secure_id" | "csm" | "biometric" | "devicetag_rep_token" | "email_verification" | "magic_link" | "symantec_pin" | "web_to_mobile";
+type AuthMethodType = 'password' | 'webauthn' | 'totp' | 'email_otp' | 'sms_otp' | 'direct_otp' | 'voice_otp' | 'push_otp' | 'idv' | 'email_magic_link' | 'mobile_biometric' | 'face' | 'pin_authenticator' | 'google' | 'facebook' | 'apple' | 'line' | 'saml' | 'oidc';
 interface ActionResultOptions {
     /** Identifier containing sensitive user data. Mosaic will encrypt and securely store this data. */
     privateUserIdentifier?: string;
@@ -177,6 +178,24 @@ interface TransactionData {
         matchLevel?: AvsMatchLevel;
     };
 }
+interface AuthContext {
+    /**
+     * Opaque identifier of the authenticated user in your system. Required — providing an auth
+     * context signals the user is already authenticated (e.g. they logged in through a flow
+     * outside this SDK before reaching this action).
+     */
+    userId: string;
+    /** Unix timestamp (ms) of when the login happened. */
+    loginTimestamp?: number;
+    /** The challenge type used for the authentication action (e.g. sms_otp, password, passkey). */
+    challengeType?: ChallengeType;
+    /** The number of failed attempts for the authentication action. */
+    failedAttempts?: number;
+    /** The authentication method used for the authentication action (e.g. password, biometric, sso). */
+    authMethod?: AuthMethodType;
+    /** The origin url of the page the user logged in from. */
+    loginOrigin?: string;
+}
 interface ActionEventOptions {
     /** Any ID that could help relate the action with external context or session */
     correlationId?: string;
@@ -201,6 +220,12 @@ interface ActionEventOptions {
     triggerSource?: 'page_load' | 'interaction_interval';
     /** @internal Per-type tally of interactions counted toward this checkpoint. Set only by AgenticManager. @ignore */
     agenticCountedInteractions?: Record<string, number>;
+    /**
+     * Authentication context for an already-authenticated user. Providing it signals the user is
+     * authenticated (userId is required) and registers them like {@link TSAccountProtection.setAuthenticatedUser}.
+     * Useful when the login happened outside this SDK (e.g. a different site).
+     */
+    authContext?: AuthContext;
     /**
      * The fields below are supported for Enterprise-IAM sdk usage actions, added `ignore` for avoiding preseting this attribute in the docs
      * @ignore
@@ -232,6 +257,8 @@ interface ActionEventOptions {
     uploadFile?: Record<string, boolean | string | number>;
 }
 declare class TSAccountProtection {
+    private static initializedInstance;
+    private static initializedAgenticInstance;
     private initializationPromise;
     private disabledReason;
     private enableSessionToken;
@@ -404,4 +431,4 @@ declare const __internal: {
 declare const PACKAGE_VERSION: string;
 declare function initialize(config: any): void;
 
-export { ActionEventOptions, ActionResponse, ActionResultOptions, LightweightPayload, PACKAGE_VERSION, __internal, clearUser, getActions, getPayload, getSecureSessionToken, getSessionToken, initialize, reportActionResult, setAuthenticatedUser, setDeviceId, triggerActionEvent };
+export { ActionEventOptions, ActionResponse, ActionResultOptions, AuthContext, LightweightPayload, PACKAGE_VERSION, __internal, clearUser, getActions, getPayload, getSecureSessionToken, getSessionToken, initialize, reportActionResult, setAuthenticatedUser, setDeviceId, triggerActionEvent };