@imtbl/sdk 0.23.1 → 0.23.2

package/dist/index.cjs

@@ -3009,7 +3009,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.2' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3069,7 +3069,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3355,7 +3355,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.1',
+    sdkVersion: 'ts-immutable-sdk-0.23.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -8217,14 +8217,25 @@ class AuthManager {
             this.deviceCredentialsManager.clearCredentials();
         }, PassportErrorType.LOGOUT_ERROR);
     }
-    async loginSilent() {
-        return withPassportError(async () => this.getUser(), PassportErrorType.SILENT_LOGIN_ERROR);
+    async loginSilent({ forceRefresh } = { forceRefresh: false }) {
+        // eslint-disable-next-line arrow-body-style
+        return withPassportError(async () => {
+            return this.getUser({ forceRefresh });
+        }, PassportErrorType.SILENT_LOGIN_ERROR);
     }
-    async getWebUser() {
+    /**
+     * Get the user from the cache or refresh the token if it's expired.
+     * @param forceRefresh If set to true, force an HTTP call to the OIDC server's authorization endpoint. This call will
+     * throw an error if there's no refresh token.
+     */
+    async getWebUser({ forceRefresh = false }) {
+        if (forceRefresh) {
+            const newOidcUser = await this.userManager.signinSilent();
+            return newOidcUser ? AuthManager.mapOidcUserToDomainModel(newOidcUser) : null;
+        }
         const oidcUser = await this.userManager.getUser();
-        if (!oidcUser) {
+        if (!oidcUser)
             return null;
-        }
         const tokenExpired = isTokenExpired(oidcUser);
         if (!tokenExpired) {
             return AuthManager.mapOidcUserToDomainModel(oidcUser);
@@ -8237,9 +8248,9 @@ class AuthManager {
         }
         return null;
     }
-    async getUser() {
+    async getUser({ forceRefresh } = { forceRefresh: false }) {
         return withPassportError(async () => {
-            const user = await this.getWebUser();
+            const user = await this.getWebUser({ forceRefresh });
             if (user) {
                 return user;
             }
@@ -9017,7 +9028,7 @@ class PassportImxProviderFactory {
             }, jwt);
             // User metadata is updated asynchronously. Poll userinfo endpoint until it is updated.
             const updatedUser = await retryWithDelay(async () => {
-                const user = await this.authManager.loginSilent();
+                const user = await this.authManager.loginSilent({ forceRefresh: true }); // force refresh to get updated user info
                 const metadataExists = !!user?.imx;
                 if (metadataExists) {
                     return user;
@@ -9517,7 +9528,7 @@ async function registerZkEvmUser({ authManager, config, magicProvider, multiRoll
         user = await authManager.refreshToken(credentials.refresh_token);
     }
     else {
-        user = await authManager.loginSilent();
+        user = await authManager.loginSilent({ forceRefresh: true });
     }
     if (!user?.zkEvm) {
         throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, 'Failed to refresh user details');
@@ -32131,7 +32142,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.1";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.2";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/index.js

@@ -2987,7 +2987,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.23.2' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3047,7 +3047,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.23.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -3333,7 +3333,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.1',
+    sdkVersion: 'ts-immutable-sdk-0.23.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -8195,14 +8195,25 @@ class AuthManager {
             this.deviceCredentialsManager.clearCredentials();
         }, PassportErrorType.LOGOUT_ERROR);
     }
-    async loginSilent() {
-        return withPassportError(async () => this.getUser(), PassportErrorType.SILENT_LOGIN_ERROR);
+    async loginSilent({ forceRefresh } = { forceRefresh: false }) {
+        // eslint-disable-next-line arrow-body-style
+        return withPassportError(async () => {
+            return this.getUser({ forceRefresh });
+        }, PassportErrorType.SILENT_LOGIN_ERROR);
     }
-    async getWebUser() {
+    /**
+     * Get the user from the cache or refresh the token if it's expired.
+     * @param forceRefresh If set to true, force an HTTP call to the OIDC server's authorization endpoint. This call will
+     * throw an error if there's no refresh token.
+     */
+    async getWebUser({ forceRefresh = false }) {
+        if (forceRefresh) {
+            const newOidcUser = await this.userManager.signinSilent();
+            return newOidcUser ? AuthManager.mapOidcUserToDomainModel(newOidcUser) : null;
+        }
         const oidcUser = await this.userManager.getUser();
-        if (!oidcUser) {
+        if (!oidcUser)
             return null;
-        }
         const tokenExpired = isTokenExpired(oidcUser);
         if (!tokenExpired) {
             return AuthManager.mapOidcUserToDomainModel(oidcUser);
@@ -8215,9 +8226,9 @@ class AuthManager {
         }
         return null;
     }
-    async getUser() {
+    async getUser({ forceRefresh } = { forceRefresh: false }) {
         return withPassportError(async () => {
-            const user = await this.getWebUser();
+            const user = await this.getWebUser({ forceRefresh });
             if (user) {
                 return user;
             }
@@ -8995,7 +9006,7 @@ class PassportImxProviderFactory {
             }, jwt);
             // User metadata is updated asynchronously. Poll userinfo endpoint until it is updated.
             const updatedUser = await retryWithDelay(async () => {
-                const user = await this.authManager.loginSilent();
+                const user = await this.authManager.loginSilent({ forceRefresh: true }); // force refresh to get updated user info
                 const metadataExists = !!user?.imx;
                 if (metadataExists) {
                     return user;
@@ -9495,7 +9506,7 @@ async function registerZkEvmUser({ authManager, config, magicProvider, multiRoll
         user = await authManager.refreshToken(credentials.refresh_token);
     }
     else {
-        user = await authManager.loginSilent();
+        user = await authManager.loginSilent({ forceRefresh: true });
     }
     if (!user?.zkEvm) {
         throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, 'Failed to refresh user details');
@@ -32109,7 +32120,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.1";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.23.2";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/passport.js

@@ -1785,7 +1785,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.23.1' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.23.2' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -1841,7 +1841,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.23.1',
+    sdkVersion: 'ts-immutable-sdk-0.23.2',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -6686,14 +6686,25 @@ class AuthManager {
             this.deviceCredentialsManager.clearCredentials();
         }, PassportErrorType.LOGOUT_ERROR);
     }
-    async loginSilent() {
-        return withPassportError(async () => this.getUser(), PassportErrorType.SILENT_LOGIN_ERROR);
+    async loginSilent({ forceRefresh } = { forceRefresh: false }) {
+        // eslint-disable-next-line arrow-body-style
+        return withPassportError(async () => {
+            return this.getUser({ forceRefresh });
+        }, PassportErrorType.SILENT_LOGIN_ERROR);
     }
-    async getWebUser() {
+    /**
+     * Get the user from the cache or refresh the token if it's expired.
+     * @param forceRefresh If set to true, force an HTTP call to the OIDC server's authorization endpoint. This call will
+     * throw an error if there's no refresh token.
+     */
+    async getWebUser({ forceRefresh = false }) {
+        if (forceRefresh) {
+            const newOidcUser = await this.userManager.signinSilent();
+            return newOidcUser ? AuthManager.mapOidcUserToDomainModel(newOidcUser) : null;
+        }
         const oidcUser = await this.userManager.getUser();
-        if (!oidcUser) {
+        if (!oidcUser)
             return null;
-        }
         const tokenExpired = isTokenExpired(oidcUser);
         if (!tokenExpired) {
             return AuthManager.mapOidcUserToDomainModel(oidcUser);
@@ -6706,9 +6717,9 @@ class AuthManager {
         }
         return null;
     }
-    async getUser() {
+    async getUser({ forceRefresh } = { forceRefresh: false }) {
         return withPassportError(async () => {
-            const user = await this.getWebUser();
+            const user = await this.getWebUser({ forceRefresh });
             if (user) {
                 return user;
             }
@@ -7486,7 +7497,7 @@ class PassportImxProviderFactory {
             }, jwt);
             // User metadata is updated asynchronously. Poll userinfo endpoint until it is updated.
             const updatedUser = await retryWithDelay(async () => {
-                const user = await this.authManager.loginSilent();
+                const user = await this.authManager.loginSilent({ forceRefresh: true }); // force refresh to get updated user info
                 const metadataExists = !!user?.imx;
                 if (metadataExists) {
                     return user;
@@ -7986,7 +7997,7 @@ async function registerZkEvmUser({ authManager, config, magicProvider, multiRoll
         user = await authManager.refreshToken(credentials.refresh_token);
     }
     else {
-        user = await authManager.loginSilent();
+        user = await authManager.loginSilent({ forceRefresh: true });
     }
     if (!user?.zkEvm) {
         throw new JsonRpcError(RpcErrorCode.INTERNAL_ERROR, 'Failed to refresh user details');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.23.1",
+  "version": "0.23.2",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",