@logto/client 2.6.3 → 2.6.4

package/lib/client.cjs

@@ -141,7 +141,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 +150,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 +170,7 @@ class StandardLogtoClient {
             state,
             scopes,
             resources,
-            prompt,
+            prompt: prompt ?? promptViaConfig,
             firstScreen,
             interactionMode,
             loginHint,

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

package/lib/client.js

@@ -139,7 +139,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 +148,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 +168,7 @@ class StandardLogtoClient {
             state,
             scopes,
             resources,
-            prompt,
+            prompt: prompt ?? promptViaConfig,
             firstScreen,
             interactionMode,
             loginHint,

package/package.json

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