@logto/js 4.1.0 → 4.1.2

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, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }) => {
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes: scopes$1, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
     const urlSearchParameters = new URLSearchParams({
         [index.QueryKey.ClientId]: clientId,
         [index.QueryKey.RedirectUri]: redirectUri,
@@ -20,9 +20,11 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
         [index.QueryKey.State]: state,
         [index.QueryKey.ResponseType]: responseType,
         [index.QueryKey.Prompt]: buildPrompt(prompt),
-        [index.QueryKey.Scope]: scopes.withDefaultScopes(scopes$1),
-        ...extraParams,
     });
+    const computedScopes = includeReservedScopes ? scopes.withReservedScopes(scopes$1) : scopes$1?.join(' ');
+    if (computedScopes) {
+        urlSearchParameters.append(index.QueryKey.Scope, computedScopes);
+    }
     if (loginHint) {
         urlSearchParameters.append(index.QueryKey.LoginHint, loginHint);
     }
@@ -39,6 +41,11 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
     else if (interactionMode) {
         urlSearchParameters.append(index.QueryKey.InteractionMode, interactionMode);
     }
+    if (extraParams) {
+        for (const [key, value] of Object.entries(extraParams)) {
+            urlSearchParameters.append(key, value);
+        }
+    }
     return `${authorizationEndpoint}?${urlSearchParameters.toString()}`;
 };
 

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

@@ -1,16 +1,15 @@
 import { Prompt } from '../consts/index.js';
 import type { FirstScreen, InteractionMode } from '../types/index.js';
+/** @experimental Don't use this type as it's under development. */
 export type DirectSignInOptions = {
     /**
      * The method to be used for the direct sign-in.
      */
-    method: 'social' | 'email' | 'sms';
+    method: 'social';
     /**
      * 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;
 };
@@ -23,20 +22,36 @@ export type SignInUriParameters = {
     scopes?: string[];
     resources?: string[];
     prompt?: Prompt | Prompt[];
-    /** The first screen to be shown in the sign-in experience. */
+    /**
+     * The first screen to be shown in the sign-in experience.
+     *
+     * @experimental Don't use this field as it's under development.
+     */
     firstScreen?: FirstScreen;
-    /** @deprecated Use `firstScreen` instead. */
+    /** The first screen to be shown in the sign-in experience. */
     interactionMode?: InteractionMode;
     /**
      * Login hint indicates the current user (usually an email address or a phone number).
+     *
+     * @experimental Don't use this field as it's under development.
      */
     loginHint?: string;
-    /** Parameters for direct sign-in. */
+    /**
+     * Parameters for direct sign-in.
+     *
+     * @experimental Don't use this field as it's under development.
+     */
     directSignIn?: DirectSignInOptions;
     /**
      * Extra parameters for the authentication request. Note that the parameters should be supported
      * by the authorization server.
      */
     extraParams?: Record<string, string>;
+    /**
+     * Whether to include reserved scopes (`openid`, `offline_access` and `profile`) in the scopes.
+     *
+     * @default true
+     */
+    includeReservedScopes?: boolean;
 };
-export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }: SignInUriParameters) => string;
+export declare const generateSignInUri: ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes, }: SignInUriParameters) => string;

package/lib/core/sign-in.js

@@ -1,5 +1,5 @@
 import { QueryKey, Prompt } from '../consts/index.js';
-import { withDefaultScopes } from '../utils/scopes.js';
+import { withReservedScopes } from '../utils/scopes.js';
 
 const codeChallengeMethod = 'S256';
 const responseType = 'code';
@@ -9,7 +9,7 @@ const buildPrompt = (prompt) => {
     }
     return prompt ?? Prompt.Consent;
 };
-const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, }) => {
+const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeChallenge, state, scopes, resources, prompt, firstScreen, interactionMode, loginHint, directSignIn, extraParams, includeReservedScopes = true, }) => {
     const urlSearchParameters = new URLSearchParams({
         [QueryKey.ClientId]: clientId,
         [QueryKey.RedirectUri]: redirectUri,
@@ -18,9 +18,11 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
         [QueryKey.State]: state,
         [QueryKey.ResponseType]: responseType,
         [QueryKey.Prompt]: buildPrompt(prompt),
-        [QueryKey.Scope]: withDefaultScopes(scopes),
-        ...extraParams,
     });
+    const computedScopes = includeReservedScopes ? withReservedScopes(scopes) : scopes?.join(' ');
+    if (computedScopes) {
+        urlSearchParameters.append(QueryKey.Scope, computedScopes);
+    }
     if (loginHint) {
         urlSearchParameters.append(QueryKey.LoginHint, loginHint);
     }
@@ -37,6 +39,11 @@ const generateSignInUri = ({ authorizationEndpoint, clientId, redirectUri, codeC
     else if (interactionMode) {
         urlSearchParameters.append(QueryKey.InteractionMode, interactionMode);
     }
+    if (extraParams) {
+        for (const [key, value] of Object.entries(extraParams)) {
+            urlSearchParameters.append(key, value);
+        }
+    }
     return `${authorizationEndpoint}?${urlSearchParameters.toString()}`;
 };
 

package/lib/index.cjs

@@ -35,6 +35,7 @@ exports.isLogtoRequestError = errors.isLogtoRequestError;
 exports.decodeIdToken = idToken.decodeIdToken;
 exports.decodeAccessToken = accessToken.decodeAccessToken;
 exports.withDefaultScopes = scopes.withDefaultScopes;
+exports.withReservedScopes = scopes.withReservedScopes;
 exports.isArbitraryObject = arbitraryObject.isArbitraryObject;
 exports.buildAngularAuthConfig = angular.buildAngularAuthConfig;
 exports.ContentType = index.ContentType;

package/lib/index.js

@@ -8,7 +8,7 @@ export { parseUriParameters, verifyAndParseCodeFromCallbackUri } from './utils/c
 export { LogtoError, LogtoRequestError, OidcError, isLogtoRequestError } from './utils/errors.js';
 export { decodeIdToken } from './utils/id-token.js';
 export { decodeAccessToken } from './utils/access-token.js';
-export { withDefaultScopes } from './utils/scopes.js';
+export { withDefaultScopes, withReservedScopes } from './utils/scopes.js';
 export { isArbitraryObject } from './utils/arbitrary-object.js';
 export { buildAngularAuthConfig } from './utils/angular.js';
 export { ContentType, Prompt, QueryKey, TokenGrantType } from './consts/index.js';

package/lib/types/index.d.ts

@@ -13,12 +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.
+ *
+ * @experimental Don't use this type as it's under development.
  */
 export type FirstScreen = 'signIn' | 'register';

package/lib/utils/angular.cjs

@@ -28,8 +28,8 @@ var scopes = require('./scopes.cjs');
  * about how to use the library.
  */
 const buildAngularAuthConfig = (logtoConfig) => {
-    const { endpoint, appId: clientId, scopes: scopes$1, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = index.Prompt.Consent, } = logtoConfig;
-    const scope = scopes.withDefaultScopes(scopes$1);
+    const { endpoint, appId: clientId, scopes: scopes$1, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = index.Prompt.Consent, includeReservedScopes = true, } = logtoConfig;
+    const scope = includeReservedScopes ? scopes.withReservedScopes(scopes$1) : scopes$1?.join(' ');
     const customParameters = resource ? { resource } : undefined;
     return {
         authority: new URL('/oidc', endpoint).href,

package/lib/utils/angular.d.ts

@@ -42,6 +42,12 @@ export type LogtoAngularConfig = {
      * @default Prompt.Consent
      */
     prompt?: Prompt | Prompt[];
+    /**
+     * Whether to include reserved scopes (`openid`, `offline_access` and `profile`) in the scopes.
+     *
+     * @default true
+     */
+    includeReservedScopes?: boolean;
 };
 /**
  * A helper function to build the OpenID Connect configuration for `angular-auth-oidc-client`

package/lib/utils/angular.js

@@ -1,5 +1,5 @@
 import { Prompt } from '../consts/index.js';
-import { withDefaultScopes } from './scopes.js';
+import { withReservedScopes } from './scopes.js';
 
 /**
  * A helper function to build the OpenID Connect configuration for `angular-auth-oidc-client`
@@ -26,8 +26,8 @@ import { withDefaultScopes } from './scopes.js';
  * about how to use the library.
  */
 const buildAngularAuthConfig = (logtoConfig) => {
-    const { endpoint, appId: clientId, scopes, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = Prompt.Consent, } = logtoConfig;
-    const scope = withDefaultScopes(scopes);
+    const { endpoint, appId: clientId, scopes, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = Prompt.Consent, includeReservedScopes = true, } = logtoConfig;
+    const scope = includeReservedScopes ? withReservedScopes(scopes) : scopes?.join(' ');
     const customParameters = resource ? { resource } : undefined;
     return {
         authority: new URL('/oidc', endpoint).href,

package/lib/utils/scopes.cjs

@@ -7,10 +7,17 @@ var openid = require('../consts/openid.cjs');
  * @param originalScopes
  * @return scopes should contain all default scopes (`openid`, `offline_access` and `profile`)
  */
-const withDefaultScopes = (originalScopes) => {
+const withReservedScopes = (originalScopes) => {
     const reservedScopes = Object.values(openid.ReservedScope);
     const uniqueScopes = new Set([...reservedScopes, openid.UserScope.Profile, ...(originalScopes ?? [])]);
     return Array.from(uniqueScopes).join(' ');
 };
+/**
+ * Alias of {@link withReservedScopes}.
+ *
+ * @deprecated Use {@link withReservedScopes} instead.
+ */
+const withDefaultScopes = withReservedScopes;
 
 exports.withDefaultScopes = withDefaultScopes;
+exports.withReservedScopes = withReservedScopes;

package/lib/utils/scopes.d.ts

@@ -2,4 +2,10 @@
  * @param originalScopes
  * @return scopes should contain all default scopes (`openid`, `offline_access` and `profile`)
  */
+export declare const withReservedScopes: (originalScopes?: string[]) => string;
+/**
+ * Alias of {@link withReservedScopes}.
+ *
+ * @deprecated Use {@link withReservedScopes} instead.
+ */
 export declare const withDefaultScopes: (originalScopes?: string[]) => string;

package/lib/utils/scopes.js

@@ -5,10 +5,16 @@ import { ReservedScope, UserScope } from '../consts/openid.js';
  * @param originalScopes
  * @return scopes should contain all default scopes (`openid`, `offline_access` and `profile`)
  */
-const withDefaultScopes = (originalScopes) => {
+const withReservedScopes = (originalScopes) => {
     const reservedScopes = Object.values(ReservedScope);
     const uniqueScopes = new Set([...reservedScopes, UserScope.Profile, ...(originalScopes ?? [])]);
     return Array.from(uniqueScopes).join(' ');
 };
+/**
+ * Alias of {@link withReservedScopes}.
+ *
+ * @deprecated Use {@link withReservedScopes} instead.
+ */
+const withDefaultScopes = withReservedScopes;
 
-export { withDefaultScopes };
+export { withDefaultScopes, withReservedScopes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/js",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -24,26 +24,19 @@
     "camelcase-keys": "^7.0.1"
   },
   "devDependencies": {
-    "@peculiar/webcrypto": "^1.4.5",
-    "@silverhand/eslint-config": "^5.0.0",
-    "@silverhand/ts-config": "^5.0.0",
-    "@swc/core": "^1.3.50",
-    "@swc/jest": "^0.2.24",
-    "@types/jest": "^29.5.1",
+    "@silverhand/eslint-config": "^6.0.1",
+    "@silverhand/ts-config": "^6.0.0",
     "@types/node": "^20.11.19",
+    "@vitest/coverage-v8": "^1.4.0",
     "angular-auth-oidc-client": "^17.0.0",
-    "eslint": "^8.44.0",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
-    "jest-matcher-specific-error": "^1.0.0",
+    "eslint": "^8.57.0",
+    "happy-dom": "^14.0.0",
     "jose": "^5.2.2",
     "lint-staged": "^15.0.0",
-    "nock": "^13.3.0",
     "prettier": "^3.0.0",
     "rollup": "^4.0.0",
-    "text-encoder": "^0.0.4",
-    "type-fest": "^4.0.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^1.4.0"
   },
   "eslintConfig": {
     "extends": "@silverhand"
@@ -58,7 +51,7 @@
     "check": "tsc --noEmit",
     "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
     "lint": "eslint --ext .ts src",
-    "test": "jest",
-    "test:coverage": "jest --silent --env=jsdom && jest --silent"
+    "test": "vitest",
+    "test:coverage": "vitest --silent --no-watch --environment=happy-dom && vitest --silent --coverage"
   }
 }