@reclaimprotocol/js-sdk 5.0.0-dev.2 → 5.0.0-dev.3

package/dist/index.js

@@ -84,7 +84,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@reclaimprotocol/js-sdk",
-      version: "5.0.0-dev.2",
+      version: "5.0.0-dev.3",
       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",
@@ -193,6 +193,7 @@ var require_package = __commonJS({
 var index_exports = {};
 __export(index_exports, {
   ReclaimProofRequest: () => ReclaimProofRequest,
+  TeeVerificationError: () => TeeVerificationError,
   assertValidProofsByHash: () => assertValidProofsByHash,
   assertValidateProof: () => assertValidateProof,
   assertVerifiedProof: () => assertVerifiedProof,
@@ -279,6 +280,7 @@ var InavlidParametersError = createErrorClass("InavlidParametersError");
 var ProofSubmissionFailedError = createErrorClass("ProofSubmissionFailedError");
 var ErrorDuringVerificationError = createErrorClass("ErrorDuringVerificationError");
 var CallbackUrlRequiredError = createErrorClass("CallbackUrlRequiredError");
+var TeeVerificationError = createErrorClass("TeeVerificationError");
 
 // src/utils/logger.ts
 var SimpleLogger = class {
@@ -855,7 +857,7 @@ function getShortenedUrl(url) {
       });
       const res = yield response.json();
       if (!response.ok) {
-        logger5.info(`Failed to shorten URL: ${url}, Response: ${JSON.stringify(res)}`);
+        logger5.info(`Failed to shorten URL: status=${response.status}`);
         return url;
       }
       const shortenedVerificationUrl = res.result.shortUrl;
@@ -2320,7 +2322,7 @@ Got:      ${report.reportData}`);
 // src/Reclaim.ts
 var logger10 = logger_default.logger;
 var sdkVersion = require_package().version;
-function verifyProof(proofOrProofs, config, verifyTEE) {
+function verifyProof(proofOrProofs, config) {
   return __async(this, null, function* () {
     const proofs = Array.isArray(proofOrProofs) ? proofOrProofs : [proofOrProofs];
     try {
@@ -2339,25 +2341,31 @@ function verifyProof(proofOrProofs, config, verifyTEE) {
         isVerified: true,
         data: proofs.map(extractProofData)
       };
-      if (verifyTEE) {
+      if (config.verifyTEE) {
         const hasTeeData = proofs.every((proof) => proof.teeAttestation || JSON.parse(proof.claimData.context).attestationNonce);
         if (!hasTeeData) {
-          logger10.error("TEE verification requested but one or more proofs are missing TEE attestation data");
+          const teeError = new TeeVerificationError("TEE verification requested but one or more proofs are missing TEE attestation data");
+          logger10.error(teeError.message);
           result.isTeeVerified = false;
           result.isVerified = false;
+          result.error = teeError;
           return result;
         }
         try {
           const teeResults = yield Promise.all(proofs.map((proof) => verifyTeeAttestation(proof)));
           result.isTeeVerified = teeResults.every((r) => r === true);
           if (!result.isTeeVerified) {
-            logger10.error("TEE attestation verification failed for one or more proofs");
+            const teeError = new TeeVerificationError("TEE attestation verification failed for one or more proofs");
+            logger10.error(teeError.message);
+            result.isVerified = false;
+            result.error = teeError;
           }
-          result.isVerified = result.isVerified && result.isTeeVerified;
         } catch (error) {
-          logger10.error("Error verifying TEE attestation:", error);
+          const teeError = new TeeVerificationError("Error verifying TEE attestation", error);
+          logger10.error(teeError.message);
           result.isTeeVerified = false;
           result.isVerified = false;
+          result.error = teeError;
         }
       }
       return result;
@@ -2365,7 +2373,8 @@ function verifyProof(proofOrProofs, config, verifyTEE) {
       logger10.error("Error in validating proof:", error);
       return {
         isVerified: false,
-        data: []
+        data: [],
+        error: error instanceof Error ? error : new Error(String(error))
       };
     }
   });
@@ -2433,6 +2442,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
     this.intervals = /* @__PURE__ */ new Map();
     this.jsonProofResponse = false;
     this.extensionID = "reclaim-extension";
+    this.appSharePageUrl = "https://share.reclaimprotocol.org/verify";
     this.FAILURE_TIMEOUT = 30 * 1e3;
     /**
      * Validates signature and returns template data
@@ -2483,7 +2493,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
       };
       return templateData;
     };
-    var _a, _b, _c;
+    var _a, _b;
     this.providerId = providerId;
     this.timeStamp = Date.now().toString();
     this.applicationId = applicationId;
@@ -2502,7 +2512,11 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
     if (options.useAppClip === void 0) {
       options.useAppClip = false;
     }
-    this.customSharePageUrl = (_c = (_b = options.portalUrl) != null ? _b : options.customSharePageUrl) != null ? _c : "https://portal.reclaimprotocol.org";
+    const customUrl = (_b = options.portalUrl) != null ? _b : options.customSharePageUrl;
+    this.customSharePageUrl = customUrl != null ? customUrl : "https://portal.reclaimprotocol.org";
+    if (customUrl) {
+      this.appSharePageUrl = customUrl;
+    }
     options.customSharePageUrl = this.customSharePageUrl;
     if (options == null ? void 0 : options.envUrl) {
       setBackendBaseUrl(options.envUrl);
@@ -2831,11 +2845,11 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    *
    * @param url - The URL where users should be redirected after successful proof generation
    * @param method - The redirection method that should be used for redirection. Allowed options: `GET`, and `POST`.
-   * `POST` form redirection is only supported in In-Browser SDK.
+   * `POST` form redirection is only supported in Portal flow.
    * @param body - List of name-value pairs to be sent as the body of the form request.
    * `When `method` is set to `POST`, `body` will be sent with 'application/x-www-form-urlencoded' content type.
    * When `method` is set to `GET`, if `body` is set then `body` will be sent as query parameters.
-   * Sending `body` on redirection is only supported in In-Browser SDK.
+   * Sending `body` on redirection is only supported in Portal flow.
    *
    * @throws {InvalidParamError} When URL is invalid
    *
@@ -2897,11 +2911,11 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    *
    * @param url - The URL where users should be redirected after an error which aborts the verification process
    * @param method - The redirection method that should be used for redirection. Allowed options: `GET`, and `POST`.
-   * `POST` form redirection is only supported in In-Browser SDK.
+   * `POST` form redirection is only supported in Portal flow.
    * @param body - List of name-value pairs to be sent as the body of the form request.
    * When `method` is set to `POST`, `body` will be sent with 'application/x-www-form-urlencoded' content type.
    * When `method` is set to `GET`, if `body` is set then `body` will be sent as query parameters.
-   * Sending `body` on redirection is only supported in In-Browser SDK.
+   * Sending `body` on redirection is only supported in Portal flow.
    * @throws {InvalidParamError} When URL is invalid
    *
    * @example
@@ -3196,8 +3210,80 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
       attestationNonceData: this.attestationNonceData
     });
   }
+  encodeTemplateData(templateData) {
+    let template = encodeURIComponent(JSON.stringify(templateData));
+    template = replaceAll(template, "(", "%28");
+    template = replaceAll(template, ")", "%29");
+    return template;
+  }
   buildSharePageUrl(template) {
-    return `https://share.reclaimprotocol.org/verify/?template=${template}`;
+    return `${this.appSharePageUrl}/?template=${template}`;
+  }
+  openPortalTab(templateData, preOpenedTab) {
+    return __async(this, null, function* () {
+      const newTab = preOpenedTab != null ? preOpenedTab : window.open("about:blank", "_blank");
+      const link = yield createLinkWithTemplateData(templateData, this.customSharePageUrl);
+      logger10.info("Opening portal in new tab: " + link);
+      if (newTab) {
+        this.portalTab = newTab;
+        newTab.location = link;
+        setTimeout(() => {
+          try {
+            if (newTab.location.href === "about:blank") {
+              newTab.close();
+              this.portalTab = void 0;
+              window.open(link, "_blank");
+            }
+          } catch (_) {
+          }
+        }, 500);
+      }
+    });
+  }
+  closePortalTab() {
+    var _a;
+    try {
+      (_a = this.portalTab) == null ? void 0 : _a.close();
+    } catch (_) {
+    }
+    this.portalTab = void 0;
+  }
+  embedPortalIframe(templateData, target) {
+    return __async(this, null, function* () {
+      let link = yield createLinkWithTemplateData(templateData, this.customSharePageUrl);
+      const separator = link.includes("?") ? "&" : "?";
+      link = `${link}${separator}embedded=true`;
+      logger10.info("Embedding portal in iframe: " + link);
+      this.closeEmbeddedFlow();
+      const iframe = document.createElement("iframe");
+      iframe.src = link;
+      iframe.style.width = "100%";
+      iframe.style.height = "100%";
+      iframe.style.border = "none";
+      iframe.setAttribute("allow", "clipboard-write");
+      iframe.setAttribute("sandbox", "allow-scripts allow-same-origin allow-forms");
+      target.appendChild(iframe);
+      this.portalIframe = iframe;
+    });
+  }
+  /**
+   * Closes the embedded portal iframe and stops the session polling.
+   *
+   * Call this to programmatically cancel the embedded verification flow
+   * that was started with `triggerReclaimFlow({ target: element })`.
+   * Also called automatically when verification succeeds or fails.
+   *
+   * @example
+   * ```typescript
+   * proofRequest.closeEmbeddedFlow();
+   * ```
+   */
+  closeEmbeddedFlow() {
+    if (this.portalIframe) {
+      this.portalIframe.remove();
+      this.portalIframe = void 0;
+    }
+    this.clearInterval();
   }
   /**
    * Exports the Reclaim proof verification request as a JSON string
@@ -3270,7 +3356,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    * // Portal URL (default)
    * const url = await proofRequest.getRequestUrl();
    *
-   * // Native app flow URL
+   * // Verifier app flow URL
    * const url = await proofRequest.getRequestUrl({ verificationMode: 'app' });
    * ```
    */
@@ -3287,15 +3373,13 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
         const templateData = this.getTemplateData();
         yield updateSession(this.sessionId, "SESSION_STARTED" /* SESSION_STARTED */);
         if (mode === "app") {
-          let template = encodeURIComponent(JSON.stringify(templateData));
-          template = replaceAll(template, "(", "%28");
-          template = replaceAll(template, ")", "%29");
+          const template = this.encodeTemplateData(templateData);
           if (((_c = this.options) == null ? void 0 : _c.useAppClip) && getDeviceType() === "mobile" /* MOBILE */ && getMobileDeviceType() === "ios" /* IOS */) {
             const appClipUrl = this.customAppClipUrl ? `${this.customAppClipUrl}&template=${template}` : `https://appclip.apple.com/id?p=org.reclaimprotocol.app.clip&template=${template}`;
             logger10.info("App Clip Url created successfully: " + appClipUrl);
             return appClipUrl;
           }
-          const sharePageUrl = yield createLinkWithTemplateData(templateData, "https://share.reclaimprotocol.org/verify");
+          const sharePageUrl = yield createLinkWithTemplateData(templateData, this.appSharePageUrl);
           logger10.info("Share page Url created successfully: " + sharePageUrl);
           return sharePageUrl;
         }
@@ -3312,8 +3396,9 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    * Triggers the appropriate Reclaim verification flow based on device type and configuration.
    *
    * Defaults to portal mode (remote browser verification). Pass `{ verificationMode: 'app' }`
-   * for native app flow via the share page.
+   * for verifier app flow via the share page.
    *
+   * - **Embedded iframe**: Pass `{ target: element }` to embed the portal inside a DOM element instead of a new tab
    * - Desktop: browser extension takes priority in both modes
    * - Desktop portal mode (no extension): opens portal in new tab
    * - Desktop app mode (no extension): shows QR code modal with share page URL
@@ -3321,15 +3406,22 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    * - Mobile app mode: opens share page (or App Clip on iOS if `useAppClip` is `true`)
    *
    * @param launchOptions - Optional launch configuration to override default behavior
-   * @returns Promise<void>
+   * @returns Promise<FlowHandle> - Handle to control the flow (close, access iframe)
    * @throws {SignatureNotFoundError} When signature is not set
    *
    * @example
    * ```typescript
-   * // Portal flow (default)
-   * await proofRequest.triggerReclaimFlow();
+   * // Portal flow (default) — opens in new tab
+   * const handle = await proofRequest.triggerReclaimFlow();
+   * handle.tab;   // Window reference to the opened tab
+   * handle.close(); // close tab and stop polling
+   *
+   * // Embed portal in an iframe inside a DOM element
+   * const handle = await proofRequest.triggerReclaimFlow({ target: document.getElementById('reclaim-container') });
+   * handle.iframe; // HTMLIFrameElement reference
+   * handle.close(); // remove iframe and stop polling
    *
-   * // Native app flow
+   * // Verifier app flow
    * await proofRequest.triggerReclaimFlow({ verificationMode: 'app' });
    *
    * // App Clip on iOS (requires useAppClip: true at init)
@@ -3345,7 +3437,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    */
   triggerReclaimFlow(launchOptions) {
     return __async(this, null, function* () {
-      var _a, _b, _c, _d, _e, _f;
+      var _a, _b, _c, _d, _e;
       const options = launchOptions || ((_a = this.options) == null ? void 0 : _a.launchOptions) || {};
       const mode = (_b = options.verificationMode) != null ? _b : "portal";
       if (!this.signature) {
@@ -3357,37 +3449,38 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
         logger10.info(`Triggering Reclaim flow (mode: ${mode})`);
         const deviceType = getDeviceType();
         updateSession(this.sessionId, "SESSION_STARTED" /* SESSION_STARTED */);
+        if ("target" in options && !options.target) {
+          logger10.warn("triggerReclaimFlow: target was provided but is null/undefined \u2014 falling back to default flow. Ensure the element exists in the DOM.");
+        }
+        if (options.target && mode === "portal") {
+          yield this.embedPortalIframe(templateData, options.target);
+          return {
+            close: () => this.closeEmbeddedFlow(),
+            iframe: this.portalIframe
+          };
+        }
         if (deviceType === "desktop" /* DESKTOP */) {
-          const extensionAvailable = yield this.isBrowserExtensionAvailable();
-          if (((_c = this.options) == null ? void 0 : _c.useBrowserExtension) && extensionAvailable) {
-            logger10.info("Triggering browser extension flow");
-            this.triggerBrowserExtensionFlow();
-            return;
-          }
-          if (mode === "portal") {
-            const portalUrl = (_d = this.customSharePageUrl) != null ? _d : "https://portal.reclaimprotocol.org";
-            const newTab = window.open("about:blank", "_blank");
-            const link = yield createLinkWithTemplateData(templateData, portalUrl);
-            logger10.info("Opening portal in new tab: " + link);
-            if (newTab) {
-              newTab.location = link;
-              setTimeout(() => {
-                try {
-                  if (newTab.location.href === "about:blank") {
-                    newTab.close();
-                    window.open(link, "_blank");
-                  }
-                } catch (_) {
+          if ((_c = this.options) == null ? void 0 : _c.useBrowserExtension) {
+            const extensionAvailable = yield this.isBrowserExtensionAvailable();
+            if (extensionAvailable) {
+              logger10.info("Triggering browser extension flow");
+              this.triggerBrowserExtensionFlow();
+              return {
+                close: () => {
+                  this.clearInterval();
                 }
-              }, 500);
+              };
             }
+          }
+          if (mode === "portal") {
+            yield this.openPortalTab(templateData);
           } else {
             logger10.info("Showing QR code modal with share page URL");
-            yield this.showQRCodeModal("app");
+            yield this.showQRCodeModal();
           }
         } else if (deviceType === "mobile" /* MOBILE */) {
           if (mode === "app") {
-            if (((_e = this.options) == null ? void 0 : _e.useAppClip) && getMobileDeviceType() === "ios" /* IOS */) {
+            if (((_d = this.options) == null ? void 0 : _d.useAppClip) && getMobileDeviceType() === "ios" /* IOS */) {
               logger10.info("Redirecting to iOS app clip");
               this.redirectToAppClip();
             } else {
@@ -3395,24 +3488,18 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
               yield this.redirectToInstantApp(options);
             }
           } else {
-            const portalUrl = (_f = this.customSharePageUrl) != null ? _f : "https://portal.reclaimprotocol.org";
-            const newTab = window.open("about:blank", "_blank");
-            const link = yield createLinkWithTemplateData(templateData, portalUrl);
-            logger10.info("Opening portal on mobile: " + link);
-            if (newTab) {
-              newTab.location = link;
-              setTimeout(() => {
-                try {
-                  if (newTab.location.href === "about:blank") {
-                    newTab.close();
-                    window.open(link, "_blank");
-                  }
-                } catch (_) {
-                }
-              }, 500);
-            }
+            yield this.openPortalTab(templateData);
           }
         }
+        return {
+          close: () => {
+            var _a2;
+            this.closePortalTab();
+            this.closeEmbeddedFlow();
+            (_a2 = this.modal) == null ? void 0 : _a2.close();
+          },
+          tab: (_e = this.portalTab) != null ? _e : void 0
+        };
       } catch (error) {
         logger10.info("Error triggering Reclaim flow:", error);
         throw error;
@@ -3477,11 +3564,10 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
     window.postMessage(message, "*");
     logger10.info("Browser extension flow triggered");
   }
-  showQRCodeModal(mode = "portal") {
+  showQRCodeModal() {
     return __async(this, null, function* () {
       try {
-        const url = mode === "app" ? "https://share.reclaimprotocol.org/verify" : this.customSharePageUrl;
-        const requestUrl = yield createLinkWithTemplateData(this.templateData, url);
+        const requestUrl = yield createLinkWithTemplateData(this.templateData, this.appSharePageUrl);
         this.modal = new QRCodeModal(this.modalOptions);
         yield this.modal.show(requestUrl);
       } catch (error) {
@@ -3494,9 +3580,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
     return __async(this, null, function* () {
       var _a;
       try {
-        let template = encodeURIComponent(JSON.stringify(this.templateData));
-        template = replaceAll(template, "(", "%28");
-        template = replaceAll(template, ")", "%29");
+        const template = this.encodeTemplateData(this.templateData);
         let instantAppUrl = this.buildSharePageUrl(template);
         logger10.info("Redirecting to Android instant app: " + instantAppUrl);
         const isDeferredDeeplinksFlowEnabled = (_a = options.canUseDeferredDeepLinksFlow) != null ? _a : false;
@@ -3555,12 +3639,10 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
   }
   redirectToAppClip() {
     try {
-      let template = encodeURIComponent(JSON.stringify(this.templateData));
-      template = replaceAll(template, "(", "%28");
-      template = replaceAll(template, ")", "%29");
+      const template = this.encodeTemplateData(this.templateData);
       const appClipUrl = this.customAppClipUrl ? `${this.customAppClipUrl}&template=${template}` : `https://appclip.apple.com/id?p=org.reclaimprotocol.app.clip&template=${template}`;
       logger10.info("Redirecting to iOS app clip: " + appClipUrl);
-      const verifierUrl = `https://share.reclaimprotocol.org/verifier/?template=${template}`;
+      const verifierUrl = `${this.appSharePageUrl}/?template=${template}`;
       window.location.href = appClipUrl;
       setTimeout(() => {
         window.location.href = verifierUrl;
@@ -3643,7 +3725,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
    * ```
    */
   startSession(_0) {
-    return __async(this, arguments, function* ({ onSuccess, onError, verificationConfig }) {
+    return __async(this, arguments, function* ({ onSuccess, onError }) {
       if (!this.sessionId) {
         const message = "Session can't be started due to undefined value of sessionId";
         logger10.info(message);
@@ -3690,6 +3772,8 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
               }
               this.clearInterval();
               (_b = this.modal) == null ? void 0 : _b.close();
+              this.closePortalTab();
+              this.closeEmbeddedFlow();
             }
           } else {
             if (statusUrlResponse.session.statusV2 === "PROOF_SUBMISSION_FAILED" /* PROOF_SUBMISSION_FAILED */) {
@@ -3702,6 +3786,8 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
               }
               this.clearInterval();
               (_d = this.modal) == null ? void 0 : _d.close();
+              this.closePortalTab();
+              this.closeEmbeddedFlow();
             }
           }
         } catch (e) {
@@ -3710,6 +3796,8 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
           }
           this.clearInterval();
           (_e = this.modal) == null ? void 0 : _e.close();
+          this.closePortalTab();
+          this.closeEmbeddedFlow();
         }
       }), sessionUpdatePollingInterval);
       this.intervals.set(this.sessionId, interval);
@@ -3752,6 +3840,7 @@ var ReclaimProofRequest = class _ReclaimProofRequest {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ReclaimProofRequest,
+  TeeVerificationError,
   assertValidProofsByHash,
   assertValidateProof,
   assertVerifiedProof,