feat: support versioned providers

example/src/app/page.tsx

@@ -146,12 +146,12 @@ export default function Home() {
   return (
     <main className='flex min-h-screen flex-col items-center p-8 bg-gray-50'>
       <div className='max-w-4xl w-full mx-auto'>
-        <h1 className='text-3xl font-bold mb-8 text-center'>Reclaim BrowserSDK</h1>
+        <h1 className='text-3xl font-bold mb-8 text-center'>Reclaim SDK</h1>
 
         {!proofData && !isLoading && (
           <div className="text-center">
             <p className="mb-6 text-gray-700">
-              Click the button below to start the claim process using your browser extension.
+              Click the button below to start the claim process.
             </p>
             <button 
               onClick={startClaimProcess}

package.json

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

src/Reclaim.ts

@@ -139,6 +139,8 @@ const emptyTemplateData: TemplateData = {
     redirectUrl: '',
     acceptAiProviders: false,
     sdkVersion: '',
+    providerVersion: '',
+    resolvedProviderVersion: '',
     jsonProofResponse: false
 }
 export class ReclaimProofRequest {
@@ -151,6 +153,7 @@ export class ReclaimProofRequest {
     private context: Context = { contextAddress: '0x0', contextMessage: 'sample context' };
     private claimCreationType?: ClaimCreationType = ClaimCreationType.STANDALONE;
     private providerId: string;
+    private resolvedProviderVersion?: string;
     private parameters: { [key: string]: string };
     private redirectUrl?: string;
     private intervals: Map<string, NodeJS.Timer> = new Map();
@@ -219,6 +222,11 @@ export class ReclaimProofRequest {
                         { paramName: 'acceptAiProviders', input: options.acceptAiProviders }
                     ], 'the constructor')
                 }
+                if (options.providerVersion) {
+                    validateFunctionParams([
+                        { paramName: 'providerVersion', input: options.providerVersion, isString: true }
+                    ], 'the constructor')
+                }
                 if (options.log) {
                     validateFunctionParams([
                         { paramName: 'log', input: options.log }
@@ -257,8 +265,9 @@ export class ReclaimProofRequest {
             const signature = await proofRequestInstance.generateSignature(appSecret)
             proofRequestInstance.setSignature(signature)
 
-            const data: InitSessionResponse = await initSession(providerId, applicationId, proofRequestInstance.timeStamp, signature);
+            const data: InitSessionResponse = await initSession(providerId, applicationId, proofRequestInstance.timeStamp, signature, options?.providerVersion);
             proofRequestInstance.sessionId = data.sessionId
+            proofRequestInstance.resolvedProviderVersion = data.resolvedProviderVersion
 
             return proofRequestInstance
         } catch (error) {
@@ -282,7 +291,8 @@ export class ReclaimProofRequest {
                 claimCreationType,
                 options,
                 sdkVersion,
-                jsonProofResponse
+                jsonProofResponse,
+                resolvedProviderVersion
             }: ProofPropertiesJSON = JSON.parse(jsonString)
 
             validateFunctionParams([
@@ -323,6 +333,19 @@ export class ReclaimProofRequest {
                 ], 'fromJsonString');
             }
 
+
+            if (options?.providerVersion) {
+                validateFunctionParams([
+                    { input: options.providerVersion, paramName: 'providerVersion', isString: true }
+                ], 'fromJsonString');
+            }
+
+            if (resolvedProviderVersion) {
+                validateFunctionParams([
+                    { input: resolvedProviderVersion, paramName: 'resolvedProviderVersion', isString: true }
+                ], 'fromJsonString');
+            }
+
             const proofRequestInstance = new ReclaimProofRequest(applicationId, providerId, options);
             proofRequestInstance.sessionId = sessionId;
             proofRequestInstance.context = context;
@@ -332,6 +355,7 @@ export class ReclaimProofRequest {
             proofRequestInstance.timeStamp = timeStamp
             proofRequestInstance.signature = signature
             proofRequestInstance.sdkVersion = sdkVersion;
+            proofRequestInstance.resolvedProviderVersion = resolvedProviderVersion;
             return proofRequestInstance
         } catch (error) {
             logger.info('Failed to parse JSON string in fromJsonString:', error);
@@ -493,7 +517,8 @@ export class ReclaimProofRequest {
             timeStamp: this.timeStamp,
             options: this.options,
             sdkVersion: this.sdkVersion,
-            jsonProofResponse: this.jsonProofResponse
+            jsonProofResponse: this.jsonProofResponse,
+            resolvedProviderVersion: this.resolvedProviderVersion ?? ''
         })
     }
 
@@ -509,6 +534,8 @@ export class ReclaimProofRequest {
             const templateData: TemplateData = {
                 sessionId: this.sessionId,
                 providerId: this.providerId,
+                providerVersion: this.options?.providerVersion ?? '',
+                resolvedProviderVersion: this.resolvedProviderVersion ?? '',
                 applicationId: this.applicationId,
                 signature: this.signature,
                 timestamp: this.timeStamp,
@@ -519,6 +546,7 @@ export class ReclaimProofRequest {
                 acceptAiProviders: this.options?.acceptAiProviders ?? false,
                 sdkVersion: this.sdkVersion,
                 jsonProofResponse: this.jsonProofResponse
+
             }
             await updateSession(this.sessionId, SessionStatus.SESSION_STARTED)
             if (this.options?.useAppClip) {
@@ -563,6 +591,8 @@ export class ReclaimProofRequest {
                 timestamp: this.timeStamp,
                 callbackUrl: this.getAppCallbackUrl(),
                 context: JSON.stringify(this.context),
+                providerVersion: this.options?.providerVersion ?? '',
+                resolvedProviderVersion: this.resolvedProviderVersion ?? '',
                 parameters: this.parameters,
                 redirectUrl: this.redirectUrl ?? '',
                 acceptAiProviders: this.options?.acceptAiProviders ?? false,

src/utils/sessionUtils.ts

@@ -22,14 +22,15 @@ export async function initSession(
   providerId: string,
   appId: string,
   timestamp: string,
-  signature: string
+  signature: string,
+  versionNumber?: string
 ): Promise<InitSessionResponse> {
   logger.info(`Initializing session for providerId: ${providerId}, appId: ${appId}`);
   try {
     const response = await fetch(`${BACKEND_BASE_URL}/api/sdk/init/session/`, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify({ providerId, appId, timestamp, signature })
+      body: JSON.stringify({ providerId, appId, timestamp, signature, versionNumber })
     });
 
     const res = await response.json();

src/utils/types.ts

@@ -37,6 +37,7 @@ export type ProofRequestOptions = {
   envUrl?: string;
   useBrowserExtension?: boolean;
   extensionID?: string;
+  providerVersion?: string;
 };
 
 // Modal customization options
@@ -66,6 +67,7 @@ export enum DeviceType {
 // Session and response types
 export type InitSessionResponse = {
   sessionId: string;
+  resolvedProviderVersion: string;
 };
 
 export interface UpdateSessionResponse {
@@ -101,6 +103,7 @@ export type ProofPropertiesJSON = {
   options?: ProofRequestOptions;
   sdkVersion: string;
   jsonProofResponse?: boolean;
+  resolvedProviderVersion: string;
 };
 
 export type TemplateData = {
@@ -116,6 +119,8 @@ export type TemplateData = {
   acceptAiProviders: boolean;
   sdkVersion: string;
   jsonProofResponse?: boolean;
+  providerVersion?: string;
+  resolvedProviderVersion: string;
 };
 
 // Add the new StatusUrlResponse type

src/utils/validationUtils.ts

@@ -148,6 +148,11 @@ export function validateOptions(options: ProofRequestOptions): void {
     logger.info(`Options validation failed: Provided log in options is not valid`);
     throw new InvalidParamError(`The provided log in options is not valid`);
   }
+
+  if (options.providerVersion && typeof options.providerVersion !== 'string') {
+    logger.info(`Options validation failed: Provided providerVersion in options is not valid`);
+    throw new InvalidParamError(`The provided providerVersion in options is not valid`);
+  }
 }