@logto/js 4.1.4 → 4.2.0

package/lib/consts/index.cjs

@@ -37,6 +37,7 @@ exports.QueryKey = void 0;
     /** The query key for specifying the organization ID. */
     QueryKey["OrganizationId"] = "organization_id";
     QueryKey["FirstScreen"] = "first_screen";
+    QueryKey["Identifier"] = "identifier";
     QueryKey["DirectSignIn"] = "direct_sign_in";
 })(exports.QueryKey || (exports.QueryKey = {}));
 /** The prompt parameter to be used for the authorization request. */

package/lib/consts/index.d.ts

@@ -33,6 +33,7 @@ export declare enum QueryKey {
     /** The query key for specifying the organization ID. */
     OrganizationId = "organization_id",
     FirstScreen = "first_screen",
+    Identifier = "identifier",
     DirectSignIn = "direct_sign_in"
 }
 /** The prompt parameter to be used for the authorization request. */

package/lib/consts/index.js

@@ -35,6 +35,7 @@ var QueryKey;
     /** The query key for specifying the organization ID. */
     QueryKey["OrganizationId"] = "organization_id";
     QueryKey["FirstScreen"] = "first_screen";
+    QueryKey["Identifier"] = "identifier";
     QueryKey["DirectSignIn"] = "direct_sign_in";
 })(QueryKey || (QueryKey = {}));
 /** The prompt parameter to be used for the authorization request. */

package/lib/core/sign-in.cjs

@@ -11,7 +11,8 @@ const buildPrompt = (prompt) => {
     }
     return prompt ?? index.Prompt.Consent;
 };
-const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes: scopes$1, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
+// eslint-disable-next-line complexity
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes: scopes$1, resources, prompt, firstScreen, identifiers: identifier, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
     const urlSearchParameters = new URLSearchParams({
         [index.QueryKey.ClientId]: clientId,
         [index.QueryKey.RedirectUri]: redirectUri,
@@ -41,6 +42,9 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
     else if (interactionMode) {
         urlSearchParameters.append(index.QueryKey.InteractionMode, interactionMode);
     }
+    if (identifier && identifier.length > 0) {
+        urlSearchParameters.append(index.QueryKey.Identifier, identifier.join(' '));
+    }
     if (extraParams) {
         for (const [key, value] of Object.entries(extraParams)) {
             urlSearchParameters.append(key, value);

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

@@ -12,6 +12,7 @@ export type DirectSignInOptions = {
      */
     target: string;
 };
+type Identifier = 'email' | 'phone' | 'username';
 export type SignInUriParameters = {
     authorizationEndpoint: string;
     clientId: string;
@@ -25,7 +26,23 @@ export type SignInUriParameters = {
      * The first screen to be shown in the sign-in experience.
      */
     firstScreen?: FirstScreen;
-    /** The first screen to be shown in the sign-in experience. */
+    /**
+     * Specifies identifiers used in the identifier sign-in or identifier register page.
+     *
+     * Available values: `email`, `phone`, `username`.
+     *
+     * This parameter is applicable only when the `firstScreen` is set to either `identifierSignIn` or `identifierRegister`.
+     *
+     * If the provided identifier is not supported in the Logto sign-in experience configuration, it will be ignored,
+     * and if no one of them is supported, it will fallback to the sign-in / sign-up method value set in the sign-in experience configuration.
+     *
+     */
+    identifiers?: Identifier[];
+    /**
+     * The first screen to be shown in the sign-in experience.
+     *
+     * @deprecated Use `firstScreen` instead.
+     */
     interactionMode?: InteractionMode;
     /**
      * Login hint indicates the current user (usually an email address or a phone number).
@@ -51,4 +68,5 @@ export type SignInUriParameters = {
      */
     includeReservedScopes?: boolean;
 };
-export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes, }: SignInUriParameters) => string;
+export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, identifiers: identifier, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes, }: SignInUriParameters) => string;
+export {};

package/lib/core/sign-in.js

@@ -9,7 +9,8 @@ const buildPrompt = (prompt) => {
     }
     return prompt ?? Prompt.Consent;
 };
-const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
+// eslint-disable-next-line complexity
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, identifiers: identifier, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
     const urlSearchParameters = new URLSearchParams({
         [QueryKey.ClientId]: clientId,
         [QueryKey.RedirectUri]: redirectUri,
@@ -39,6 +40,9 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
     else if (interactionMode) {
         urlSearchParameters.append(QueryKey.InteractionMode, interactionMode);
     }
+    if (identifier && identifier.length > 0) {
+        urlSearchParameters.append(QueryKey.Identifier, identifier.join(' '));
+    }
     if (extraParams) {
         for (const [key, value] of Object.entries(extraParams)) {
             urlSearchParameters.append(key, value);

package/lib/core/user-info.d.ts

@@ -1,12 +1,19 @@
+import { type Nullable } from '@silverhand/essentials';
 import { type IdTokenClaims } from '../index.js';
 import type { Requester } from '../types/index.js';
 type Identity = {
     userId: string;
     details?: Record<string, unknown>;
 };
+type OrganizationData = {
+    id: string;
+    name: string;
+    description: Nullable<string>;
+};
 export type UserInfoResponse = IdTokenClaims & {
     custom_data?: unknown;
     identities?: Record<string, Identity>;
+    organization_data?: OrganizationData[];
 };
 export declare const fetchUserInfo: (userInfoEndpoint: string, accessToken: string, requester: Requester) => Promise<UserInfoResponse>;
 export {};

package/lib/types/index.d.ts

@@ -13,12 +13,16 @@ 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 `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.
  *
+ * Note: `signIn` is deprecated, use `sign_in` instead
+ *
  * @experimental Don't use this type as it's under development.
  */
-export type FirstScreen = 'signIn' | 'register';
+export type FirstScreen = 'signIn' | 'sign_in' | 'register' | 'reset_password' | 'identifier:sign_in' | 'identifier:register' | 'single_sign_on';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/js",
-  "version": "4.1.4",
+  "version": "4.2.0",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -28,7 +28,7 @@
     "@silverhand/ts-config": "^6.0.0",
     "@types/node": "^20.11.19",
     "@vitest/coverage-v8": "^1.6.0",
-    "angular-auth-oidc-client": "^17.0.0",
+    "angular-auth-oidc-client": "^18.0.0",
     "eslint": "^8.57.0",
     "happy-dom": "^14.0.0",
     "jose": "^5.2.2",