@logto/client 2.4.0 → 2.5.1

package/lib/adapter/types.d.ts

@@ -39,16 +39,17 @@ export type InferStorageKey<S> = S extends Storage<infer Key> ? Key : never;
  * @param url The URL to navigate to.
  * @param parameters The parameters for the navigation.
  * @param parameters.redirectUri The redirect URI that the user will be redirected to after the
- * flow is completed. That is, the "redirect URI" for sign-in and "post-logout redirect URI" for
- * sign-out.
- * @param parameters.for The purpose of the navigation. It can be either "sign-in" or "sign-out".
+ * flow is completed. That is, the "redirect URI" for "sign-in" and "post-logout redirect URI" for
+ * "sign-out". For the "post-sign-in" navigation, it should be ignored.
+ * @param parameters.for The purpose of the navigation. It can be either "sign-in", "sign-out", or
+ * "post-sign-in".
  * @remarks Usually, the `redirectUri` parameter can be ignored unless the client needs to pass the
  * redirect scheme or other parameters to the native app, such as `ASWebAuthenticationSession` in
  * iOS.
  */
 export type Navigate = (url: string, parameters: {
     redirectUri?: string;
-    for: 'sign-in' | 'sign-out';
+    for: 'sign-in' | 'sign-out' | 'post-sign-in';
 }) => void | Promise<void>;
 export type JwtVerifier = {
     verifyIdToken(idToken: string): Promise<void>;

package/lib/client.cjs

@@ -9,6 +9,7 @@ var memoize = require('./utils/memoize.cjs');
 var once = require('./utils/once.cjs');
 var types = require('./adapter/types.cjs');
 
+/* eslint-disable max-lines */
 /**
  * The Logto base client class that provides the essential methods for
  * interacting with the Logto server.
@@ -139,23 +140,17 @@ class StandardLogtoClient {
         }
         return js.fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
-    /**
-     * Start the sign-in flow with the specified redirect URI. The URI must be
-     * registered in the Logto Console.
-     *
-     * The user will be redirected to that URI after the sign-in flow is completed,
-     * and the client will be able to get the authorization code from the URI.
-     * To fetch the tokens from the authorization code, use {@link handleSignInCallback}
-     * after the user is redirected in the callback URI.
-     *
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
-     * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
-     * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/integrate-logto/vanilla-js/#sign-in | Sign in} for more information.
-     * @see {@link InteractionMode}
-     */
-    async signIn(redirectUri, interactionMode) {
+    async signIn(options, mode, hint) {
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, interactionMode, loginHint, } = typeof options === 'string' || options instanceof URL
+            ? {
+                redirectUri: options,
+                postRedirectUri: undefined,
+                interactionMode: mode,
+                loginHint: hint,
+            }
+            : options;
+        const redirectUri = redirectUriUrl.toString();
+        const postRedirectUri = postRedirectUriUrl?.toString();
         const { appId: clientId, prompt, resources, scopes } = this.logtoConfig;
         const { authorizationEndpoint } = await this.getOidcConfig();
         const [codeVerifier, state] = await Promise.all([
@@ -166,16 +161,17 @@ class StandardLogtoClient {
         const signInUri = js.generateSignInUri({
             authorizationEndpoint,
             clientId,
-            redirectUri,
+            redirectUri: redirectUri.toString(),
             codeChallenge,
             state,
             scopes,
             resources,
             prompt,
             interactionMode,
+            loginHint,
         });
         await Promise.all([
-            this.setSignInSession({ redirectUri, codeVerifier, state }),
+            this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),
             this.setRefreshToken(null),
             this.setIdToken(null),
         ]);
@@ -349,7 +345,7 @@ class StandardLogtoClient {
         if (!signInSession) {
             throw new errors.LogtoClientError('sign_in_session.not_found');
         }
-        const { redirectUri, state, codeVerifier } = signInSession;
+        const { redirectUri, postRedirectUri, state, codeVerifier } = signInSession;
         const code = js.verifyAndParseCodeFromCallbackUri(callbackUri, redirectUri, state);
         // NOTE: Will add scope to accessTokenKey when needed. (Linear issue LOG-1589)
         const accessTokenKey = index$2.buildAccessTokenKey();
@@ -377,7 +373,11 @@ class StandardLogtoClient {
         });
         await this.saveAccessTokenMap();
         await this.setSignInSession(null);
+        if (postRedirectUri) {
+            await this.adapter.navigate(postRedirectUri, { for: 'post-sign-in' });
+        }
     }
 }
+/* eslint-enable max-lines */
 
 exports.StandardLogtoClient = StandardLogtoClient;

package/lib/client.d.ts

@@ -2,6 +2,31 @@ import { type IdTokenClaims, type UserInfoResponse, type InteractionMode, type A
 import { type Nullable } from '@silverhand/essentials';
 import { ClientAdapterInstance, type ClientAdapter, type JwtVerifier } from './adapter/index.js';
 import type { AccessToken, LogtoConfig, LogtoSignInSessionItem } from './types/index.js';
+export type SignInOptions = {
+    /**
+     * The redirect URI that the user will be redirected to after the sign-in flow is completed.
+     */
+    redirectUri: string | URL;
+    /**
+     * The URI that the user will be redirected to after `redirectUri` successfully handled the
+     * sign-in callback. If not specified, the user will stay on the `redirectUri` page.
+     */
+    postRedirectUri?: string | URL;
+    /**
+     * The interaction mode to be used for the authorization request. It determines the first page
+     * that the user will see in the sign-in flow.
+     *
+     * Note it's not a part of the OIDC standard, but a Logto-specific extension.
+     *
+     * @default InteractionMode.SignIn
+     * @see {@link InteractionMode}
+     */
+    interactionMode?: InteractionMode;
+    /**
+     * Login hint indicates the current user (usually an email address).
+     */
+    loginHint?: string;
+};
 /**
  * The Logto base client class that provides the essential methods for
  * interacting with the Logto server.
@@ -106,6 +131,7 @@ export declare class StandardLogtoClient {
      * @throws LogtoClientError if the user is not authenticated.
      */
     fetchUserInfo(): Promise<UserInfoResponse>;
+    signIn(options: SignInOptions): Promise<void>;
     /**
      * Start the sign-in flow with the specified redirect URI. The URI must be
      * registered in the Logto Console.
@@ -115,14 +141,10 @@ export declare class StandardLogtoClient {
      * To fetch the tokens from the authorization code, use {@link handleSignInCallback}
      * after the user is redirected in the callback URI.
      *
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
-     * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
-     * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/integrate-logto/vanilla-js/#sign-in | Sign in} for more information.
-     * @see {@link InteractionMode}
+     * @param redirectUri See {@link SignInOptions.redirectUri}.
+     * @param interactionMode See {@link SignInOptions.interactionMode}.
      */
-    signIn(redirectUri: string, interactionMode?: InteractionMode): Promise<void>;
+    signIn(redirectUri: SignInOptions['redirectUri'], interactionMode?: SignInOptions['interactionMode'], loginHint?: SignInOptions['loginHint']): Promise<void>;
     /**
      * Check if the user is redirected from the sign-in page by checking if the
      * current URL matches the redirect URI in the sign-in session.

package/lib/client.js

@@ -7,6 +7,7 @@ import { memoize } from './utils/memoize.js';
 import { once } from './utils/once.js';
 import { PersistKey, CacheKey } from './adapter/types.js';
 
+/* eslint-disable max-lines */
 /**
  * The Logto base client class that provides the essential methods for
  * interacting with the Logto server.
@@ -137,23 +138,17 @@ class StandardLogtoClient {
         }
         return fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
-    /**
-     * Start the sign-in flow with the specified redirect URI. The URI must be
-     * registered in the Logto Console.
-     *
-     * The user will be redirected to that URI after the sign-in flow is completed,
-     * and the client will be able to get the authorization code from the URI.
-     * To fetch the tokens from the authorization code, use {@link handleSignInCallback}
-     * after the user is redirected in the callback URI.
-     *
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow is completed.
-     * @param interactionMode The interaction mode to be used for the authorization request. Note it's not
-     * a part of the OIDC standard, but a Logto-specific extension. Defaults to `signIn`.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/integrate-logto/vanilla-js/#sign-in | Sign in} for more information.
-     * @see {@link InteractionMode}
-     */
-    async signIn(redirectUri, interactionMode) {
+    async signIn(options, mode, hint) {
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, interactionMode, loginHint, } = typeof options === 'string' || options instanceof URL
+            ? {
+                redirectUri: options,
+                postRedirectUri: undefined,
+                interactionMode: mode,
+                loginHint: hint,
+            }
+            : options;
+        const redirectUri = redirectUriUrl.toString();
+        const postRedirectUri = postRedirectUriUrl?.toString();
         const { appId: clientId, prompt, resources, scopes } = this.logtoConfig;
         const { authorizationEndpoint } = await this.getOidcConfig();
         const [codeVerifier, state] = await Promise.all([
@@ -164,16 +159,17 @@ class StandardLogtoClient {
         const signInUri = generateSignInUri({
             authorizationEndpoint,
             clientId,
-            redirectUri,
+            redirectUri: redirectUri.toString(),
             codeChallenge,
             state,
             scopes,
             resources,
             prompt,
             interactionMode,
+            loginHint,
         });
         await Promise.all([
-            this.setSignInSession({ redirectUri, codeVerifier, state }),
+            this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),
             this.setRefreshToken(null),
             this.setIdToken(null),
         ]);
@@ -347,7 +343,7 @@ class StandardLogtoClient {
         if (!signInSession) {
             throw new LogtoClientError('sign_in_session.not_found');
         }
-        const { redirectUri, state, codeVerifier } = signInSession;
+        const { redirectUri, postRedirectUri, state, codeVerifier } = signInSession;
         const code = verifyAndParseCodeFromCallbackUri(callbackUri, redirectUri, state);
         // NOTE: Will add scope to accessTokenKey when needed. (Linear issue LOG-1589)
         const accessTokenKey = buildAccessTokenKey();
@@ -375,7 +371,11 @@ class StandardLogtoClient {
         });
         await this.saveAccessTokenMap();
         await this.setSignInSession(null);
+        if (postRedirectUri) {
+            await this.adapter.navigate(postRedirectUri, { for: 'post-sign-in' });
+        }
     }
 }
+/* eslint-enable max-lines */
 
 export { StandardLogtoClient };

package/lib/mock.d.ts

@@ -26,9 +26,11 @@ export declare const postSignOutRedirectUri = "http://localhost:3000";
 export declare const mockCodeChallenge = "code_challenge_value";
 export declare const mockedCodeVerifier = "code_verifier_value";
 export declare const mockedState = "state_value";
+export declare const mockedUserHint = "johndoe@example.com";
 export declare const mockedSignInUri: string;
 export declare const mockedSignInUriWithLoginPrompt: string;
 export declare const mockedSignUpUri: string;
+export declare const mockedSignInUriWithLoginHint: string;
 export declare const accessToken = "access_token_value";
 export declare const refreshToken = "new_refresh_token_value";
 export declare const idToken = "id_token_value";

package/lib/types/index.d.ts

@@ -62,6 +62,7 @@ export declare const isLogtoSignInSessionItem: (data: unknown) => data is LogtoS
 export declare const isLogtoAccessTokenMap: (data: unknown) => data is Record<string, AccessToken>;
 export type LogtoSignInSessionItem = {
     redirectUri: string;
+    postRedirectUri?: string;
     codeVerifier: string;
     state: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/client",
-  "version": "2.4.0",
+  "version": "2.5.1",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -29,7 +29,7 @@
     "directory": "packages/client"
   },
   "dependencies": {
-    "@logto/js": "^4.0.0",
+    "@logto/js": "^4.0.1",
     "@silverhand/essentials": "^2.8.7",
     "camelcase-keys": "^7.0.1",
     "jose": "^5.2.2"