Merge pull request #83 from reclaimprotocol/feat/regional-error

feat: require callback URL for regional portals

Author: LaithAlebrahim

README.md

@@ -37,7 +37,7 @@ Install the Reclaim Protocol SDK and a QR code generator:
 npm install @reclaimprotocol/js-sdk react-qr-code
 ```
 
-**Current SDK Version**: 4.13.0
+**Current SDK Version**: 4.14.0
 
 ## Step 3: Set up your React component
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@reclaimprotocol/js-sdk",
-  "version": "4.13.0",
+  "version": "4.14.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",

package.json

@@ -33,7 +33,8 @@ import {
     SetSignatureError,
     SignatureGeneratingError,
     SignatureNotFoundError,
-    ErrorDuringVerificationError
+    ErrorDuringVerificationError,
+    CallbackUrlRequiredError
 } from './utils/errors'
 import { validateContext, validateFunctionParams, validateParameters, validateSignature, validateURL, validateModalOptions, validateFunctionParamsWithFn, validateRedirectionMethod, validateRedirectionBody } from './utils/validationUtils'
 import { fetchStatusUrl, initSession, updateSession } from './utils/sessionUtils'
@@ -975,6 +976,23 @@ export class ReclaimProofRequest {
         if (!this.signature) {
             throw new SignatureNotFoundError('Signature is not set.')
         }
+
+        // When using a non-default regional portal, a custom callback URL is required
+        const defaultHosts = ['share.reclaimprotocol.org', 'portal.reclaimprotocol.org'];
+        if (this.customSharePageUrl) {
+            try {
+                const sharePageHost = new URL(this.customSharePageUrl).hostname;
+                if (!defaultHosts.includes(sharePageHost) && !this.appCallbackUrl) {
+                    throw new CallbackUrlRequiredError(
+                        'A custom callback URL is required when using a customSharePage url'
+                    );
+                }
+            } catch (e) {
+                if (e instanceof CallbackUrlRequiredError) throw e;
+                // If URL parsing fails, skip this check — URL validation elsewhere will catch it
+            }
+        }
+
         validateSignature(this.providerId, this.signature, this.applicationId, this.timeStamp)
         const templateData: TemplateData = {
             sessionId: this.sessionId,

src/Reclaim.ts

@@ -39,3 +39,4 @@ export const StatusUrlError = createErrorClass('StatusUrlError');
 export const InavlidParametersError = createErrorClass('InavlidParametersError');
 export const ProofSubmissionFailedError = createErrorClass('ProofSubmissionFailedError');
 export const ErrorDuringVerificationError = createErrorClass('ErrorDuringVerificationError');
+export const CallbackUrlRequiredError = createErrorClass('CallbackUrlRequiredError');