@transmitsecurity/platform-web-sdk 2.3.0 → 2.3.1

package/dist/drs.d.ts

@@ -216,11 +216,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;