@logto/client 2.5.0 → 2.6.0

package/lib/client.cjs

@@ -140,9 +140,17 @@ class StandardLogtoClient {
         }
         return js.fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
-    async signIn(options, mode) {
-        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, interactionMode, } = typeof options === 'string' || options instanceof URL
-            ? { redirectUri: options, postRedirectUri: undefined, interactionMode: mode }
+    async signIn(options, mode, hint) {
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, } = typeof options === 'string' || options instanceof URL
+            ? {
+                redirectUri: options,
+                postRedirectUri: undefined,
+                firstScreen: undefined,
+                interactionMode: mode,
+                loginHint: hint,
+                directSignIn: undefined,
+                extraParams: undefined,
+            }
             : options;
         const redirectUri = redirectUriUrl.toString();
         const postRedirectUri = postRedirectUriUrl?.toString();
@@ -162,7 +170,11 @@ class StandardLogtoClient {
             scopes,
             resources,
             prompt,
+            firstScreen,
             interactionMode,
+            loginHint,
+            directSignIn,
+            extraParams,
         });
         await Promise.all([
             this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),

package/lib/client.d.ts

@@ -1,4 +1,4 @@
-import { type IdTokenClaims, type UserInfoResponse, type InteractionMode, type AccessTokenClaims, type OidcConfigResponse } from '@logto/js';
+import { type IdTokenClaims, type UserInfoResponse, type AccessTokenClaims, type OidcConfigResponse, type SignInUriParameters } from '@logto/js';
 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';
@@ -12,17 +12,7 @@ export type SignInOptions = {
      * 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;
-};
+} & Pick<SignInUriParameters, 'interactionMode' | 'firstScreen' | 'loginHint' | 'directSignIn' | 'extraParams'>;
 /**
  * The Logto base client class that provides the essential methods for
  * interacting with the Logto server.
@@ -127,8 +117,21 @@ export declare class StandardLogtoClient {
      * @throws LogtoClientError if the user is not authenticated.
      */
     fetchUserInfo(): Promise<UserInfoResponse>;
+    /**
+     * Start the sign-in flow with the specified options.
+     *
+     * The redirect URI is required and it 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 options The options for the sign-in flow.
+     */
     signIn(options: SignInOptions): Promise<void>;
     /**
+     *
      * Start the sign-in flow with the specified redirect URI. The URI must be
      * registered in the Logto Console.
      *
@@ -137,10 +140,12 @@ export declare class StandardLogtoClient {
      * To fetch the tokens from the authorization code, use {@link handleSignInCallback}
      * after the user is redirected in the callback URI.
      *
+     * @deprecated Use the object parameter instead.
      * @param redirectUri See {@link SignInOptions.redirectUri}.
      * @param interactionMode See {@link SignInOptions.interactionMode}.
+     * @param loginHint See {@link SignInOptions.loginHint}.
      */
-    signIn(redirectUri: SignInOptions['redirectUri'], interactionMode?: SignInOptions['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

@@ -138,9 +138,17 @@ class StandardLogtoClient {
         }
         return fetchUserInfo(userinfoEndpoint, accessToken, this.adapter.requester);
     }
-    async signIn(options, mode) {
-        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, interactionMode, } = typeof options === 'string' || options instanceof URL
-            ? { redirectUri: options, postRedirectUri: undefined, interactionMode: mode }
+    async signIn(options, mode, hint) {
+        const { redirectUri: redirectUriUrl, postRedirectUri: postRedirectUriUrl, firstScreen, interactionMode, loginHint, directSignIn, extraParams, } = typeof options === 'string' || options instanceof URL
+            ? {
+                redirectUri: options,
+                postRedirectUri: undefined,
+                firstScreen: undefined,
+                interactionMode: mode,
+                loginHint: hint,
+                directSignIn: undefined,
+                extraParams: undefined,
+            }
             : options;
         const redirectUri = redirectUriUrl.toString();
         const postRedirectUri = postRedirectUriUrl?.toString();
@@ -160,7 +168,11 @@ class StandardLogtoClient {
             scopes,
             resources,
             prompt,
+            firstScreen,
             interactionMode,
+            loginHint,
+            directSignIn,
+            extraParams,
         });
         await Promise.all([
             this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/client",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -29,10 +29,10 @@
     "directory": "packages/client"
   },
   "dependencies": {
-    "@logto/js": "^4.0.0",
     "@silverhand/essentials": "^2.8.7",
     "camelcase-keys": "^7.0.1",
-    "jose": "^5.2.2"
+    "jose": "^5.2.2",
+    "@logto/js": "^4.1.0"
   },
   "devDependencies": {
     "@peculiar/webcrypto": "^1.4.5",