@logto/client 2.5.0 → 2.5.1

package/lib/client.cjs

@@ -140,9 +140,14 @@ 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, 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();
@@ -163,6 +168,7 @@ class StandardLogtoClient {
             resources,
             prompt,
             interactionMode,
+            loginHint,
         });
         await Promise.all([
             this.setSignInSession({ redirectUri, postRedirectUri, codeVerifier, state }),

package/lib/client.d.ts

@@ -22,6 +22,10 @@ export type SignInOptions = {
      * @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
@@ -140,7 +144,7 @@ export declare class StandardLogtoClient {
      * @param redirectUri See {@link SignInOptions.redirectUri}.
      * @param interactionMode See {@link SignInOptions.interactionMode}.
      */
-    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,14 @@ 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, 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();
@@ -161,6 +166,7 @@ class StandardLogtoClient {
             resources,
             prompt,
             interactionMode,
+            loginHint,
         });
         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.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"