Merge pull request #395 from Web3Auth/feat/record-id

feat: generate record-id and include in login b64 params

Author: chaitanyapotti

.gitignore

@@ -105,4 +105,6 @@ dist
 
 .DS_Store
 
-.rollup*
+.rollup*
+
+.npmrc

examples/vue-example/package-lock.json

@@ -19,7 +19,7 @@
     "bs58": "^6.0.0",
     "core-js": "^3.49.0",
     "viem": "^2.47.6",
-    "vue": "^3.5.30"
+    "vue": "^3.5.31"
   },
   "devDependencies": {
     "@tailwindcss/vite": "^4.2.2",

examples/vue-example/package.json

@@ -111,7 +111,7 @@
   },
   "dependencies": {
     "@toruslabs/constants": "^16.1.1",
-    "@toruslabs/customauth": "^22.3.2",
+    "@toruslabs/customauth": "^22.3.3",
     "@toruslabs/ffjavascript": "^6.0.0",
     "@toruslabs/metadata-helpers": "^8.2.0",
     "@toruslabs/secure-pub-sub": "^4.3.0",

package-lock.json

@@ -23,6 +23,7 @@ import {
   BaseLoginParams,
   BUILD_ENV,
   DEFAULT_SESSION_TIME,
+  generateRecordId,
   jsonToBase64,
   LoginParams,
   POPUP_TIMEOUT,
@@ -323,6 +324,7 @@ export class Auth {
     };
 
     const loginId = StorageManager.generateRandomSessionKey();
+    const recordId = generateRecordId();
 
     const dataObject: AuthRequestPayload = {
       actionType: AUTH_ACTIONS.MANAGE_MFA,
@@ -342,7 +344,7 @@ export class Auth {
         extraLoginOptions: {
           login_hint: this.state.userInfo.userId,
         },
-        appState: jsonToBase64({ loginId }),
+        appState: jsonToBase64({ loginId, recordId }),
       },
       sessionId: this.sessionId,
       accessToken: await this.getAccessToken(),
@@ -351,6 +353,7 @@ export class Auth {
     this.storeAuthPayload(loginId, dataObject, dataObject.options.sessionTime, true);
     const configParams: BaseLoginParams = {
       loginId,
+      recordId,
       sessionNamespace: this.options.sessionNamespace,
       storageServerUrl: this.options.storageServerUrl,
     };
@@ -528,9 +531,11 @@ export class Auth {
 
   private async authHandler(url: string, dataObject: AuthRequestPayload, popupTimeout = 1000 * 10): Promise<AuthFlowResult | null> {
     const loginId = StorageManager.generateRandomSessionKey();
+    const recordId = generateRecordId();
     await this.storeAuthPayload(loginId, dataObject);
     const configParams: BaseLoginParams = {
       loginId,
+      recordId,
       sessionNamespace: this.options.sessionNamespace,
       storageServerUrl: this.options.storageServerUrl,
     };

package.json

@@ -539,6 +539,11 @@ export interface BaseLoginParams {
   loginId?: string;
   sessionNamespace?: string;
   storageServerUrl?: string;
+
+  /**
+   * Optional record id to be used for analytics purposes.
+   */
+  recordId?: string;
 }
 
 export interface AuthRequestPayload {

src/core/auth.ts

@@ -31,3 +31,9 @@ export function isObject(value: unknown): value is Record<PropertyKey, unknown>
 export function hasProperty<Key extends PropertyKey>(value: unknown, key: Key): value is Record<Key, unknown> {
   return isObject(value) && key in value;
 }
+
+export function generateRecordId(): string {
+  const cr = typeof globalThis === "object" ? globalThis.crypto : null;
+  if (typeof cr?.randomUUID !== "function") throw new Error("crypto.randomUUID must be defined");
+  return cr.randomUUID();
+}