@reclaimprotocol/js-sdk 5.4.1 → 5.5.0

package/dist/index.d.ts

@@ -686,7 +686,8 @@ declare enum SessionStatus {
     PROOF_SUBMISSION_FAILED = "PROOF_SUBMISSION_FAILED",
     ERROR_SUBMITTED = "ERROR_SUBMITTED",
     ERROR_SUBMISSION_FAILED = "ERROR_SUBMISSION_FAILED",
-    PROOF_MANUAL_VERIFICATION_SUBMITED = "PROOF_MANUAL_VERIFICATION_SUBMITED"
+    PROOF_MANUAL_VERIFICATION_SUBMITED = "PROOF_MANUAL_VERIFICATION_SUBMITED",
+    SESSION_CANCELLED = "SESSION_CANCELLED"
 }
 type ProofPropertiesJSON = {
     applicationId: string;
@@ -1328,6 +1329,33 @@ declare class ReclaimProofRequest {
      * ```
      */
     closeEmbeddedFlow(): void;
+    /**
+     * Cancels an in-progress verification session.
+     *
+     * Use this when the user abandons the flow (e.g. navigates back) before a
+     * proof is produced. It tears down all local session machinery — the status
+     * polling interval, the 10-minute interval-ending timeout, and any portal UI
+     * (modal / tab / embedded iframe) — and marks the session CANCELLED on the
+     * backend.
+     *
+     * Marking the session CANCELLED is what prevents a stale, abandoned session
+     * from later being reported as a failure: the portal's inactivity monitor
+     * treats a cancelled session as a clean terminal state and will not emit a
+     * connection-failure error to the cancel/error callback. Because that callback
+     * URL is typically shared across sessions, suppressing it here stops an
+     * abandoned session from contaminating the next one.
+     *
+     * `onSuccess` / `onError` are intentionally NOT invoked — cancellation is a
+     * deliberate, silent teardown, not a verification outcome. Safe to call more
+     * than once; a no-op when no session is active.
+     *
+     * @example
+     * ```typescript
+     * // e.g. in a React effect cleanup when the user navigates away
+     * await proofRequest.cancelSession();
+     * ```
+     */
+    cancelSession(): Promise<void>;
     /**
      * Exports the Reclaim proof verification request as a JSON string
      *

package/dist/index.js

@@ -84,7 +84,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@reclaimprotocol/js-sdk",
-      version: "5.4.1",
+      version: "5.5.0",
       description: "Designed to request proofs from the Reclaim protocol and manage the flow of claims and witness interactions.",
       main: "dist/index.js",
       types: "dist/index.d.ts",
@@ -3311,6 +3311,49 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
     }
     this.clearInterval();
   }
+  /**
+   * Cancels an in-progress verification session.
+   *
+   * Use this when the user abandons the flow (e.g. navigates back) before a
+   * proof is produced. It tears down all local session machinery — the status
+   * polling interval, the 10-minute interval-ending timeout, and any portal UI
+   * (modal / tab / embedded iframe) — and marks the session CANCELLED on the
+   * backend.
+   *
+   * Marking the session CANCELLED is what prevents a stale, abandoned session
+   * from later being reported as a failure: the portal's inactivity monitor
+   * treats a cancelled session as a clean terminal state and will not emit a
+   * connection-failure error to the cancel/error callback. Because that callback
+   * URL is typically shared across sessions, suppressing it here stops an
+   * abandoned session from contaminating the next one.
+   *
+   * `onSuccess` / `onError` are intentionally NOT invoked — cancellation is a
+   * deliberate, silent teardown, not a verification outcome. Safe to call more
+   * than once; a no-op when no session is active.
+   *
+   * @example
+   * ```typescript
+   * // e.g. in a React effect cleanup when the user navigates away
+   * await proofRequest.cancelSession();
+   * ```
+   */
+  cancelSession() {
+    return __async(this, null, function* () {
+      if (!this.sessionId) {
+        return;
+      }
+      const sessionId = this.sessionId;
+      logger11.info(`Cancelling session: ${sessionId}`);
+      this.closeModal();
+      this.closePortalTab();
+      this.closeEmbeddedFlow();
+      try {
+        yield updateSession(sessionId, "SESSION_CANCELLED" /* SESSION_CANCELLED */);
+      } catch (error) {
+        logger11.info(`cancelSession: backend update failed for ${sessionId}: ${error}`);
+      }
+    });
+  }
   /**
    * Exports the Reclaim proof verification request as a JSON string
    *