@transmitsecurity/platform-web-sdk 2.2.0 → 2.3.1

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/drs.d.ts CHANGED
@@ -216,11 +216,17 @@ declare class TSAccountProtection {
216
216
  /** @ignore */
217
217
  getActions(): Promise<string[]>;
218
218
  getSessionToken(): Promise<any>;
219
+ /**
220
+ * Returns the lightweight (citadel) device payload to be forwarded to citadel via the caller's backend.
221
+ * The response from citadel includes a `deviceId` that must be passed back via {@link setDeviceId}
222
+ * — the server may issue a new one or rotate it, and the SDK only persists it when told to.
223
+ */
219
224
  getPayload(): Promise<LightweightPayload>;
220
225
  clearQueue(): void;
221
226
  /**
222
227
  * Sets the deviceId for lightweight mode (citadel).
223
- * Should be called after receiving deviceId from backend on first request.
228
+ * Should be called after every response from citadel the server may rotate the deviceId
229
+ * (e.g. after schema validation), so always propagate the returned value back into the SDK.
224
230
  * @param deviceId - The JWT deviceId returned from citadel backend
225
231
  */
226
232
  setDeviceId(deviceId: string): void;