@logto/js 4.0.0 → 4.1.0

package/lib/consts/index.cjs

@@ -22,6 +22,7 @@ exports.QueryKey = void 0;
     QueryKey["GrantType"] = "grant_type";
     QueryKey["IdToken"] = "id_token";
     QueryKey["IdTokenHint"] = "id_token_hint";
+    QueryKey["LoginHint"] = "login_hint";
     QueryKey["PostLogoutRedirectUri"] = "post_logout_redirect_uri";
     QueryKey["Prompt"] = "prompt";
     QueryKey["RedirectUri"] = "redirect_uri";
@@ -35,6 +36,8 @@ exports.QueryKey = void 0;
     QueryKey["InteractionMode"] = "interaction_mode";
     /** The query key for specifying the organization ID. */
     QueryKey["OrganizationId"] = "organization_id";
+    QueryKey["FirstScreen"] = "first_screen";
+    QueryKey["DirectSignIn"] = "direct_sign_in";
 })(exports.QueryKey || (exports.QueryKey = {}));
 /** The prompt parameter to be used for the authorization request. */
 exports.Prompt = void 0;

package/lib/consts/index.d.ts

@@ -19,6 +19,7 @@ export declare enum QueryKey {
     GrantType = "grant_type",
     IdToken = "id_token",
     IdTokenHint = "id_token_hint",
+    LoginHint = "login_hint",
     PostLogoutRedirectUri = "post_logout_redirect_uri",
     Prompt = "prompt",
     RedirectUri = "redirect_uri",
@@ -30,7 +31,9 @@ export declare enum QueryKey {
     Token = "token",
     InteractionMode = "interaction_mode",
     /** The query key for specifying the organization ID. */
-    OrganizationId = "organization_id"
+    OrganizationId = "organization_id",
+    FirstScreen = "first_screen",
+    DirectSignIn = "direct_sign_in"
 }
 /** The prompt parameter to be used for the authorization request. */
 export declare enum Prompt {

package/lib/consts/index.js

@@ -20,6 +20,7 @@ var QueryKey;
     QueryKey["GrantType"] = "grant_type";
     QueryKey["IdToken"] = "id_token";
     QueryKey["IdTokenHint"] = "id_token_hint";
+    QueryKey["LoginHint"] = "login_hint";
     QueryKey["PostLogoutRedirectUri"] = "post_logout_redirect_uri";
     QueryKey["Prompt"] = "prompt";
     QueryKey["RedirectUri"] = "redirect_uri";
@@ -33,6 +34,8 @@ var QueryKey;
     QueryKey["InteractionMode"] = "interaction_mode";
     /** The query key for specifying the organization ID. */
     QueryKey["OrganizationId"] = "organization_id";
+    QueryKey["FirstScreen"] = "first_screen";
+    QueryKey["DirectSignIn"] = "direct_sign_in";
 })(QueryKey || (QueryKey = {}));
 /** The prompt parameter to be used for the authorization request. */
 var Prompt;

package/lib/core/sign-in.cjs

@@ -11,7 +11,7 @@ const buildPrompt = (prompt) => {
     }
     return prompt ?? index.Prompt.Consent;
 };
-const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes: scopes$1, resources, prompt, interactionMode, }) => {
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes: scopes$1, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }) => {
     const urlSearchParameters = new URLSearchParams({
         [index.QueryKey.ClientId]: clientId,
         [index.QueryKey.RedirectUri]: redirectUri,
@@ -21,12 +21,22 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
         [index.QueryKey.ResponseType]: responseType,
         [index.QueryKey.Prompt]: buildPrompt(prompt),
         [index.QueryKey.Scope]: scopes.withDefaultScopes(scopes$1),
+        ...extraParams,
     });
+    if (loginHint) {
+        urlSearchParameters.append(index.QueryKey.LoginHint, loginHint);
+    }
+    if (directSignIn) {
+        urlSearchParameters.append(index.QueryKey.DirectSignIn, `${directSignIn.method}:${directSignIn.target}`);
+    }
     for (const resource of resources ?? []) {
         urlSearchParameters.append(index.QueryKey.Resource, resource);
     }
-    // Set interactionMode to signUp for a create account user experience
-    if (interactionMode) {
+    if (firstScreen) {
+        urlSearchParameters.append(index.QueryKey.FirstScreen, firstScreen);
+    }
+    // @deprecated Remove later
+    else if (interactionMode) {
         urlSearchParameters.append(index.QueryKey.InteractionMode, interactionMode);
     }
     return `${authorizationEndpoint}?${urlSearchParameters.toString()}`;

package/lib/core/sign-in.d.ts

@@ -1,5 +1,19 @@
 import { Prompt } from '../consts/index.js';
-import type { InteractionMode } from '../types/index.js';
+import type { FirstScreen, InteractionMode } from '../types/index.js';
+export type DirectSignInOptions = {
+    /**
+     * The method to be used for the direct sign-in.
+     */
+    method: 'social' | 'email' | 'sms';
+    /**
+     * The target to be used for the direct sign-in.
+     *
+     * - For `method: 'social'`, it should be the social connector target.
+     * - For `method: 'email'`, it should be the email address.
+     * - For `method: 'sms'`, it should be the phone number.
+     */
+    target: string;
+};
 export type SignInUriParameters = {
     authorizationEndpoint: string;
     clientId: string;
@@ -9,6 +23,20 @@ export type SignInUriParameters = {
     scopes?: string[];
     resources?: string[];
     prompt?: Prompt | Prompt[];
+    /** The first screen to be shown in the sign-in experience. */
+    firstScreen?: FirstScreen;
+    /** @deprecated Use `firstScreen` instead. */
     interactionMode?: InteractionMode;
+    /**
+     * Login hint indicates the current user (usually an email address or a phone number).
+     */
+    loginHint?: string;
+    /** Parameters for direct sign-in. */
+    directSignIn?: DirectSignInOptions;
+    /**
+     * Extra parameters for the authentication request. Note that the parameters should be supported
+     * by the authorization server.
+     */
+    extraParams?: Record<string, string>;
 };
-export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, interactionMode, }: SignInUriParameters) => string;
+export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }: SignInUriParameters) => string;

package/lib/core/sign-in.js

@@ -9,7 +9,7 @@ const buildPrompt = (prompt) => {
     }
     return prompt ?? Prompt.Consent;
 };
-const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, interactionMode, }) => {
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }) => {
     const urlSearchParameters = new URLSearchParams({
         [QueryKey.ClientId]: clientId,
         [QueryKey.RedirectUri]: redirectUri,
@@ -19,12 +19,22 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
         [QueryKey.ResponseType]: responseType,
         [QueryKey.Prompt]: buildPrompt(prompt),
         [QueryKey.Scope]: withDefaultScopes(scopes),
+        ...extraParams,
     });
+    if (loginHint) {
+        urlSearchParameters.append(QueryKey.LoginHint, loginHint);
+    }
+    if (directSignIn) {
+        urlSearchParameters.append(QueryKey.DirectSignIn, `${directSignIn.method}:${directSignIn.target}`);
+    }
     for (const resource of resources ?? []) {
         urlSearchParameters.append(QueryKey.Resource, resource);
     }
-    // Set interactionMode to signUp for a create account user experience
-    if (interactionMode) {
+    if (firstScreen) {
+        urlSearchParameters.append(QueryKey.FirstScreen, firstScreen);
+    }
+    // @deprecated Remove later
+    else if (interactionMode) {
         urlSearchParameters.append(QueryKey.InteractionMode, interactionMode);
     }
     return `${authorizationEndpoint}?${urlSearchParameters.toString()}`;

package/lib/types/index.d.ts

@@ -13,5 +13,12 @@ export type Requester = <T>(...args: Parameters<typeof fetch>) => Promise<T>;
  *
  * - `signIn`: The authorization request will be initiated with a sign-in page.
  * - `signUp`: The authorization request will be initiated with a sign-up page.
+ *
+ * @deprecated Use {@link FirstScreen} instead.
  */
 export type InteractionMode = 'signIn' | 'signUp';
+/**
+ * The first screen to be shown in the sign-in experience. Note it's not a part of the OIDC
+ * standard, but a Logto-specific extension.
+ */
+export type FirstScreen = 'signIn' | 'register';

package/package.json

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