@logto/client 2.6.3 → 2.6.5

package/lib/client.cjs

@@ -57,6 +57,10 @@ class StandardLogtoClient {
          * It uses the same refresh strategy as {@link getAccessToken}.
          */
         this.getOrganizationToken = memoize.memoize(this.#getOrganizationToken);
+        /**
+         * Clear the access token from the cache storage.
+         */
+        this.clearAccessToken = memoize.memoize(this.#clearAccessToken);
         /**
          * Handle the sign-in callback by parsing the authorization code from the
          * callback URI and exchanging it for the tokens.
@@ -141,7 +145,7 @@ class StandardLogtoClient {
         return js.fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
     async signIn(options, mode, hint) {
-        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, } = typeof options === 'string' || options instanceof URL
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, prompt, } = typeof options === 'string' || options instanceof URL
             ? {
                 redirectUri: options,
                 postRedirectUri: undefined,
@@ -150,11 +154,12 @@ class StandardLogtoClient {
                 loginHint: hint,
                 directSignIn: undefined,
                 extraParams: undefined,
+                prompt: undefined,
             }
             : options;
         const redirectUri = redirectUriUrl.toString();
         const postRedirectUri = postRedirectUriUrl?.toString();
-        const { appId: clientId, prompt, resources, scopes } = this.logtoConfig;
+        const { appId: clientId, prompt: promptViaConfig, resources, scopes } = this.logtoConfig;
         const { authorizationEndpoint } = await this.getOidcConfig();
         const [codeVerifier, state] = await Promise.all([
             this.adapter.generateCodeVerifier(),
@@ -169,7 +174,7 @@ class StandardLogtoClient {
             state,
             scopes,
             resources,
-            prompt,
+            prompt: prompt ?? promptViaConfig,
             firstScreen,
             interactionMode,
             loginHint,
@@ -251,10 +256,6 @@ class StandardLogtoClient {
     async setRefreshToken(value) {
         return this.adapter.setStorageItem(types.PersistKey.RefreshToken, value);
     }
-    async clearAccessToken() {
-        this.accessTokenMap.clear();
-        await this.adapter.storage.removeItem('accessToken');
-    }
     async getAccessTokenByRefreshToken(resource, organizationId) {
         const currentRefreshToken = await this.getRefreshToken();
         if (!currentRefreshToken) {
@@ -346,6 +347,10 @@ class StandardLogtoClient {
         }
         return this.getAccessToken(undefined, organizationId);
     }
+    async #clearAccessToken() {
+        this.accessTokenMap.clear();
+        await this.adapter.storage.removeItem('accessToken');
+    }
     async #handleSignInCallback(callbackUri) {
         const signInSession = await this.getSignInSession();
         if (!signInSession) {

package/lib/client.d.ts

@@ -12,6 +12,11 @@ export type SignInOptions = {
      * sign-in callback. If not specified, the user will stay on the `redirectUri` page.
      */
     postRedirectUri?: string | URL;
+    /**
+     * The prompt parameter to be used for the authorization request.
+     * Note: If specified, it will override the prompt value in Logto configs.
+     */
+    prompt?: SignInUriParameters['prompt'];
 } & Pick<SignInUriParameters, 'interactionMode' | 'firstScreen' | 'loginHint' | 'directSignIn' | 'extraParams'>;
 /**
  * The Logto base client class that provides the essential methods for
@@ -61,6 +66,10 @@ export declare class StandardLogtoClient {
      * It uses the same refresh strategy as {@link getAccessToken}.
      */
     readonly getOrganizationToken: (this: unknown, organizationId: string) => Promise<string>;
+    /**
+     * Clear the access token from the cache storage.
+     */
+    readonly clearAccessToken: (this: unknown) => Promise<void>;
     /**
      * Handle the sign-in callback by parsing the authorization code from the
      * callback URI and exchanging it for the tokens.
@@ -183,7 +192,6 @@ export declare class StandardLogtoClient {
     protected setSignInSession(value: Nullable<LogtoSignInSessionItem>): Promise<void>;
     private setIdToken;
     private setRefreshToken;
-    private clearAccessToken;
     private getAccessTokenByRefreshToken;
     private saveAccessTokenMap;
     private loadAccessTokenMap;

package/lib/client.js

@@ -55,6 +55,10 @@ class StandardLogtoClient {
          * It uses the same refresh strategy as {@link getAccessToken}.
          */
         this.getOrganizationToken = memoize(this.#getOrganizationToken);
+        /**
+         * Clear the access token from the cache storage.
+         */
+        this.clearAccessToken = memoize(this.#clearAccessToken);
         /**
          * Handle the sign-in callback by parsing the authorization code from the
          * callback URI and exchanging it for the tokens.
@@ -139,7 +143,7 @@ class StandardLogtoClient {
         return fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
     async signIn(options, mode, hint) {
-        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, } = typeof options === 'string' || options instanceof URL
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, prompt, } = typeof options === 'string' || options instanceof URL
             ? {
                 redirectUri: options,
                 postRedirectUri: undefined,
@@ -148,11 +152,12 @@ class StandardLogtoClient {
                 loginHint: hint,
                 directSignIn: undefined,
                 extraParams: undefined,
+                prompt: undefined,
             }
             : options;
         const redirectUri = redirectUriUrl.toString();
         const postRedirectUri = postRedirectUriUrl?.toString();
-        const { appId: clientId, prompt, resources, scopes } = this.logtoConfig;
+        const { appId: clientId, prompt: promptViaConfig, resources, scopes } = this.logtoConfig;
         const { authorizationEndpoint } = await this.getOidcConfig();
         const [codeVerifier, state] = await Promise.all([
             this.adapter.generateCodeVerifier(),
@@ -167,7 +172,7 @@ class StandardLogtoClient {
             state,
             scopes,
             resources,
-            prompt,
+            prompt: prompt ?? promptViaConfig,
             firstScreen,
             interactionMode,
             loginHint,
@@ -249,10 +254,6 @@ class StandardLogtoClient {
     async setRefreshToken(value) {
         return this.adapter.setStorageItem(PersistKey.RefreshToken, value);
     }
-    async clearAccessToken() {
-        this.accessTokenMap.clear();
-        await this.adapter.storage.removeItem('accessToken');
-    }
     async getAccessTokenByRefreshToken(resource, organizationId) {
         const currentRefreshToken = await this.getRefreshToken();
         if (!currentRefreshToken) {
@@ -344,6 +345,10 @@ class StandardLogtoClient {
         }
         return this.getAccessToken(undefined, organizationId);
     }
+    async #clearAccessToken() {
+        this.accessTokenMap.clear();
+        await this.adapter.storage.removeItem('accessToken');
+    }
     async #handleSignInCallback(callbackUri) {
         const signInSession = await this.getSignInSession();
         if (!signInSession) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/client",
-  "version": "2.6.3",
+  "version": "2.6.5",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",