@logto/js 5.1.1 → 6.1.0

package/lib/consts/openid.d.ts

@@ -38,6 +38,12 @@ export declare enum UserScope {
      * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
      */
     Phone = "phone",
+    /**
+     * Scope for user address.
+     *
+     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
+     */
+    Address = "address",
     /**
      * Scope for user's custom data.
      *

package/lib/consts/openid.js

@@ -40,6 +40,12 @@ var UserScope;
      * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
      */
     UserScope["Phone"] = "phone";
+    /**
+     * Scope for user address.
+     *
+     * See {@link idTokenClaims} for mapped claims in ID Token and {@link userinfoClaims} for additional claims in Userinfo Endpoint.
+     */
+    UserScope["Address"] = "address";
     /**
      * Scope for user's custom data.
      *
@@ -78,6 +84,7 @@ const idTokenClaims = Object.freeze({
     [UserScope.Profile]: ['name', 'picture', 'username'],
     [UserScope.Email]: ['email', 'email_verified'],
     [UserScope.Phone]: ['phone_number', 'phone_number_verified'],
+    [UserScope.Address]: [],
     [UserScope.Roles]: ['roles'],
     [UserScope.Organizations]: ['organizations'],
     [UserScope.OrganizationRoles]: ['organization_roles'],
@@ -91,6 +98,7 @@ const userinfoClaims = Object.freeze({
     [UserScope.Profile]: [],
     [UserScope.Email]: [],
     [UserScope.Phone]: [],
+    [UserScope.Address]: [],
     [UserScope.Roles]: [],
     [UserScope.Organizations]: [],
     [UserScope.OrganizationRoles]: [],

package/lib/index.js

@@ -10,6 +10,5 @@ export { decodeIdToken } from './utils/id-token.js';
 export { decodeAccessToken } from './utils/access-token.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';
 export { ReservedResource, ReservedScope, UserScope, buildOrganizationUrn, getOrganizationIdFromUrn, idTokenClaims, organizationUrnPrefix, userClaims, userinfoClaims } from './consts/openid.js';

package/lib/utils/index.d.ts

@@ -4,4 +4,3 @@ export * from './id-token.js';
 export * from './access-token.js';
 export * from './scopes.js';
 export * from './arbitrary-object.js';
-export * from './angular.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/js",
-  "version": "5.1.1",
+  "version": "6.1.0",
   "type": "module",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -28,7 +28,6 @@
     "@silverhand/ts-config": "^6.0.0",
     "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^2.1.9",
-    "angular-auth-oidc-client": "^19.0.0",
     "eslint": "^8.57.0",
     "happy-dom": "^16.0.0",
     "jose": "^5.2.2",

package/lib/utils/angular.d.ts

@@ -1,112 +0,0 @@
-import { type OpenIdConfiguration } from 'angular-auth-oidc-client';
-import { Prompt } from '../consts/index.js';
-import { type SignInUriParameters } from '../index.js';
-/** The Logto configuration object for Angular apps. */
-export type LogtoAngularConfig = {
-    /**
-     * The endpoint for the Logto server, you can get it from the integration guide
-     * or the team settings page of the Logto Console.
-     *
-     * @example https://foo.logto.app
-     */
-    endpoint: string;
-    /**
-     * The client ID of your application, you can get it from the integration guide
-     * or the application details page of the Logto Console.
-     */
-    appId: string;
-    /**
-     * The scopes (permissions) that your application needs to access.
-     * Scopes that will be added by default: `openid`, `offline_access` and `profile`.
-     */
-    scopes?: string[];
-    /**
-     * The API resource that your application needs to access.
-     *
-     * @see {@link https://docs.logto.io/docs/recipes/rbac/ | RBAC} to learn more about how to use
-     * role-based access control (RBAC) to protect API resources.
-     */
-    resource?: string;
-    /**
-     * @param redirectUri The redirect URI that the user will be redirected to after the sign-in flow
-     * is completed.
-     */
-    redirectUri: string;
-    /**
-     * @param postLogoutRedirectUri The URI that the user will be redirected to after the sign-out
-     * flow is completed.
-     */
-    postLogoutRedirectUri?: string;
-    /**
-     * The prompt parameter to be used for the authorization request.
-     *
-     * @default Prompt.Consent
-     */
-    prompt?: Prompt | Prompt[];
-    /**
-     * Whether to include reserved scopes (`openid`, `offline_access` and `profile`) in the scopes.
-     *
-     * @default true
-     */
-    includeReservedScopes?: boolean;
-    /**
-     * Login hint indicates the current user (usually an email address or a phone number).
-     *
-     * @link SignInUriParameters.loginHint
-     */
-    loginHint?: SignInUriParameters['loginHint'];
-    /**
-     * The first screen to be shown in the sign-in experience.
-     *
-     * @link SignInUriParameters.firstScreen
-     */
-    firstScreen?: SignInUriParameters['firstScreen'];
-    /**
-     * Identifiers used in the identifier sign-in, identifier register or reset password pages.
-     *
-     * Note: This parameter is applicable only when the `firstScreen` is set to either`identifierSignIn`
-     * or `identifierRegister`.
-     *
-     * @link SignInUriParameters.identifiers
-     */
-    identifiers?: SignInUriParameters['identifiers'];
-    /**
-     * Direct sign-in options.
-     *
-     * @link SignInUriParameters.directSignIn
-     */
-    directSignIn?: SignInUriParameters['directSignIn'];
-    /**
-     * Extra parameters to be appended to the sign-in URI.
-     *
-     * Note: The parameters should be supported by the authorization server.
-     *
-     * @link SignInUriParameters.extraParams
-     */
-    extraParams?: SignInUriParameters['extraParams'];
-};
-/**
- * A helper function to build the OpenID Connect configuration for `angular-auth-oidc-client`
- * using a Logto-friendly way.
- *
- * @example
- * ```ts
- * // A minimal example
- * import { buildAngularAuthConfig } from '@logto/js';
- * import { provideAuth } from 'angular-auth-oidc-client';
- *
- * provideAuth({
- *   config: buildAngularAuthConfig({
- *     endpoint: '<your-logto-endpoint>',
- *     appId: '<your-app-id>',
- *     redirectUri: '<your-app-redirect-uri>',
- *   }),
- * });
- * ```
- *
- * @param logtoConfig The Logto configuration object for Angular apps.
- * @returns The OpenID Connect configuration for `angular-auth-oidc-client`.
- * @see {@link https://angular-auth-oidc-client.com/ | angular-auth-oidc-client} to learn more
- * about how to use the library.
- */
-export declare const buildAngularAuthConfig: (logtoConfig: LogtoAngularConfig) => OpenIdConfiguration;

package/lib/utils/angular.js

@@ -1,64 +0,0 @@
-import { conditional } from '@silverhand/essentials';
-import { Prompt, QueryKey } from '../consts/index.js';
-import { withReservedScopes } from './scopes.js';
-
-/**
- * A helper function to build the OpenID Connect configuration for `angular-auth-oidc-client`
- * using a Logto-friendly way.
- *
- * @example
- * ```ts
- * // A minimal example
- * import { buildAngularAuthConfig } from '@logto/js';
- * import { provideAuth } from 'angular-auth-oidc-client';
- *
- * provideAuth({
- *   config: buildAngularAuthConfig({
- *     endpoint: '<your-logto-endpoint>',
- *     appId: '<your-app-id>',
- *     redirectUri: '<your-app-redirect-uri>',
- *   }),
- * });
- * ```
- *
- * @param logtoConfig The Logto configuration object for Angular apps.
- * @returns The OpenID Connect configuration for `angular-auth-oidc-client`.
- * @see {@link https://angular-auth-oidc-client.com/ | angular-auth-oidc-client} to learn more
- * about how to use the library.
- */
-const buildAngularAuthConfig = (logtoConfig) => {
-    const { endpoint, appId: clientId, scopes, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = Prompt.Consent, includeReservedScopes = true, loginHint, identifiers, firstScreen, directSignIn, extraParams, } = logtoConfig;
-    const scope = includeReservedScopes ? withReservedScopes(scopes) : scopes?.join(' ');
-    const customParameters = {
-        ...conditional(resource && { [QueryKey.Resource]: resource }),
-        ...conditional(loginHint && { [QueryKey.LoginHint]: loginHint }),
-        ...conditional(firstScreen && { [QueryKey.FirstScreen]: firstScreen }),
-        ...conditional(identifiers && { [QueryKey.Identifier]: identifiers.join(' ') }),
-        ...conditional(directSignIn && { [QueryKey.DirectSignIn]: `${directSignIn.method}:${directSignIn.target}` }),
-        ...extraParams,
-    };
-    return {
-        authority: new URL('/oidc', endpoint).href,
-        redirectUrl,
-        postLogoutRedirectUri,
-        clientId,
-        scope,
-        responseType: 'code',
-        autoUserInfo: !resource,
-        renewUserInfoAfterTokenRenew: !resource,
-        silentRenew: true,
-        useRefreshToken: true,
-        customParamsAuthRequest: {
-            prompt: Array.isArray(prompt) ? prompt.join(' ') : prompt,
-            ...customParameters,
-        },
-        customParamsCodeRequest: {
-            ...customParameters,
-        },
-        customParamsRefreshTokenRequest: {
-            ...customParameters,
-        },
-    };
-};
-
-export { buildAngularAuthConfig };