@logto/js 4.0.0-alpha.2 → 4.0.0

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

@@ -1,18 +1,10 @@
-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>;
 };
-export type UserInfoResponse = {
-    sub: string;
-    name?: Nullable<string>;
-    username?: Nullable<string>;
-    picture?: Nullable<string>;
-    email?: Nullable<string>;
-    email_verified?: boolean;
-    phone_number?: Nullable<string>;
-    phone_number_verified?: boolean;
+export type UserInfoResponse = IdTokenClaims & {
     custom_data?: unknown;
     identities?: Record<string, Identity>;
 };

package/lib/index.cjs

@@ -12,6 +12,7 @@ var idToken = require('./utils/id-token.cjs');
 var accessToken = require('./utils/access-token.cjs');
 var scopes = require('./utils/scopes.cjs');
 var arbitraryObject = require('./utils/arbitrary-object.cjs');
+var angular = require('./utils/angular.cjs');
 var index = require('./consts/index.cjs');
 var openid = require('./consts/openid.cjs');
 
@@ -35,6 +36,7 @@ exports.decodeIdToken = idToken.decodeIdToken;
 exports.decodeAccessToken = accessToken.decodeAccessToken;
 exports.withDefaultScopes = scopes.withDefaultScopes;
 exports.isArbitraryObject = arbitraryObject.isArbitraryObject;
+exports.buildAngularAuthConfig = angular.buildAngularAuthConfig;
 exports.ContentType = index.ContentType;
 Object.defineProperty(exports, "Prompt", {
 	enumerable: true,

package/lib/index.js

@@ -10,5 +10,6 @@ export { decodeIdToken } from './utils/id-token.js';
 export { decodeAccessToken } from './utils/access-token.js';
 export { withDefaultScopes } 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/angular.cjs

@@ -0,0 +1,58 @@
+'use strict';
+
+var index = require('../consts/index.cjs');
+var scopes = require('./scopes.cjs');
+
+/**
+ * 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: scopes$1, resource, redirectUri: redirectUrl, postLogoutRedirectUri, prompt = index.Prompt.Consent, } = logtoConfig;
+    const scope = scopes.withDefaultScopes(scopes$1);
+    const customParameters = resource ? { resource } : undefined;
+    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,
+        },
+    };
+};
+
+exports.buildAngularAuthConfig = buildAngularAuthConfig;

package/lib/utils/angular.d.ts

@@ -0,0 +1,70 @@
+import { type OpenIdConfiguration } from 'angular-auth-oidc-client';
+import { Prompt } from '../consts/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[];
+};
+/**
+ * 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

@@ -0,0 +1,56 @@
+import { Prompt } from '../consts/index.js';
+import { withDefaultScopes } 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, } = logtoConfig;
+    const scope = withDefaultScopes(scopes);
+    const customParameters = resource ? { resource } : undefined;
+    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 };

package/lib/utils/index.d.ts

@@ -4,3 +4,4 @@ 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": "4.0.0-alpha.2",
+  "version": "4.0.0",
   "type": "module",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
@@ -24,24 +24,26 @@
     "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",
-    "@types/node": "^20.0.0",
+    "@types/node": "^20.11.19",
+    "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",
-    "jose": "^5.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.0.0"
+    "typescript": "^5.3.3"
   },
   "eslintConfig": {
     "extends": "@silverhand"