@transmitsecurity/platform-web-sdk 2.3.2-beta-26093939905.0 → 2.4.0

package/dist/drs.d.ts

@@ -24,6 +24,18 @@ type LightweightPayload = {
 type TransactionType = 'purchase' | 'bill_payment' | 'mobile_recharge' | 'money_transfer' | 'credit_transfer' | 'credit_redemption' | 'top_up' | 'withdrawal' | 'investment' | 'loan' | 'refund' | 'other';
 type TransactionMethod = 'bank_account' | 'wire' | 'card' | 'p2p' | 'wallet';
 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";
+interface ActionResultOptions {
+    /** Identifier containing sensitive user data. Mosaic will encrypt and securely store this data. */
+    privateUserIdentifier?: string;
+    /** Type of challenge used when a challenge was recommended for this action. */
+    challengeType?: ChallengeType;
+    /** Opaque identifier of the user in your system. */
+    userId?: string;
+}
 interface ActionResponse {
     /** The token return by the SDK when the action was reported */
     actionToken?: string;
@@ -216,11 +228,17 @@ declare class TSAccountProtection {
     /** @ignore */
     getActions(): Promise<string[]>;
     getSessionToken(): Promise<any>;
+    /**
+     * Returns the lightweight (citadel) device payload to be forwarded to citadel via the caller's backend.
+     * The response from citadel includes a `deviceId` that must be passed back via {@link setDeviceId}
+     * — the server may issue a new one or rotate it, and the SDK only persists it when told to.
+     */
     getPayload(): Promise<LightweightPayload>;
     clearQueue(): void;
     /**
      * Sets the deviceId for lightweight mode (citadel).
-     * Should be called after receiving deviceId from backend on first request.
+     * Should be called after every response from citadel — the server may rotate the deviceId
+     * (e.g. after schema validation), so always propagate the returned value back into the SDK.
      * @param deviceId - The JWT deviceId returned from citadel backend
      */
     setDeviceId(deviceId: string): void;
@@ -246,6 +264,16 @@ declare class TSAccountProtection {
      * @returns Indicates if the call succeeded
      */
     setAuthenticatedUser(userId: string, options?: {}): Promise<boolean>;
+    /**
+     * Reports the result of an action for which a recommendation was previously issued.
+     * This includes whether the user successfully completed the action and, when applicable,
+     * the type of challenge that was presented.
+     * @param actionToken The token returned when the action was triggered by {@link TSAccountProtection.triggerActionEvent}
+     * @param result The outcome of the action
+     * @param options Additional context associated with the action result
+     * @returns Indicates if the call succeeded
+     */
+    reportActionResult(actionToken: string, result: ActionResult, options?: ActionResultOptions): Promise<boolean>;
     /**
      * Clears the user context for all subsequent events in the browser session
      * @param options Reserved for future use
@@ -275,6 +303,16 @@ declare const triggerActionEvent: TSAccountProtection['triggerActionEvent'];
  * @returns Indicates if the call succeeded
  */
 declare const setAuthenticatedUser: TSAccountProtection['setAuthenticatedUser'];
+/**
+ * Reports the result of an action for which a recommendation was previously issued.
+ * This includes whether the user successfully completed the action and, when applicable,
+ * the type of challenge that was presented.
+ * @param actionToken The token returned when the action was triggered by triggerActionEvent()
+ * @param result The outcome of the action ("success" | "failure" | "incomplete")
+ * @param options Additional context associated with the action result
+ * @returns Indicates if the call succeeded
+ */
+declare const reportActionResult: TSAccountProtection['reportActionResult'];
 /**
  * Clears the user context for all subsequent events in the browser session
  * @param options Reserved for future use
@@ -310,4 +348,4 @@ declare const __internal: {
 declare const PACKAGE_VERSION: string;
 declare function initialize(config: any): void;
 
-export { ActionEventOptions, ActionResponse, LightweightPayload, PACKAGE_VERSION, __internal, clearUser, getActions, getPayload, getSecureSessionToken, getSessionToken, initialize, setAuthenticatedUser, setDeviceId, triggerActionEvent };
+export { ActionEventOptions, ActionResponse, ActionResultOptions, LightweightPayload, PACKAGE_VERSION, __internal, clearUser, getActions, getPayload, getSecureSessionToken, getSessionToken, initialize, reportActionResult, setAuthenticatedUser, setDeviceId, triggerActionEvent };