@logto/angular 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Silverhand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Logto Angular helper
+
+This package provides a helper for Angular to use Logto.

package/lib/index.d.ts

@@ -0,0 +1,113 @@
+import { Prompt, type SignInUriParameters } from '@logto/js';
+import { type OpenIdConfiguration } from 'angular-auth-oidc-client';
+/** 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;
+export type { UserInfoResponse } from '@logto/js';
+export { UserScope } from '@logto/js';

package/lib/index.js

@@ -0,0 +1,64 @@
+import { Prompt, withReservedScopes, QueryKey } from '@logto/js';
+export { UserScope } from '@logto/js';
+import { conditional } from '@silverhand/essentials';
+
+/**
+ * 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 };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@logto/angular",
+  "version": "1.0.0",
+  "type": "module",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    "types": "./lib/index.d.ts",
+    "import": "./lib/index.js",
+    "default": "./lib/index.js"
+  },
+  "files": [
+    "lib"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/logto-io/js.git",
+    "directory": "packages/angular"
+  },
+  "dependencies": {
+    "@silverhand/essentials": "^2.9.2",
+    "@logto/js": "^6.0.0"
+  },
+  "devDependencies": {
+    "@silverhand/eslint-config": "^6.0.1",
+    "@silverhand/eslint-config-react": "^6.0.2",
+    "@silverhand/ts-config": "^6.0.0",
+    "@silverhand/ts-config-react": "^6.0.0",
+    "angular-auth-oidc-client": "^19.0.0",
+    "eslint": "^8.57.0",
+    "lint-staged": "^15.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.3.3",
+    "vitest": "^2.1.9"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand"
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev:tsc": "tsc -p tsconfig.build.json -w --preserveWatchOutput",
+    "precommit": "lint-staged",
+    "check": "tsc --noEmit",
+    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
+    "lint": "eslint --ext .ts --ext .tsx src"
+  }
+}