@edirect/oidc-client 11.0.49 → 11.0.50

package/dist/README.md

@@ -1,136 +1,43 @@
 # @edirect/oidc-client
 
-OpenID Connect client for eDirect applications. Supports three OAuth2 grant types — `password`, `client_credentials`, and `sso` — with a uniform API for acquiring and refreshing tokens.
+OpenID Connect client for Edirect applications. Provides a simple interface for authenticating with OIDC providers, supporting multiple grant types and token management.
 
 ## Features
 
-- Three grant types: `password`, `client_credentials`, `sso`
-- Uniform `getAccessToken()` and `getRefreshToken()` API across all grant types
-- OIDC provider discovery via configurable `baseUrl` and `oidcPath`
-- Token set parsing utilities
+- Supports password, client_credentials, and other grant types
+- Handles access and refresh tokens
+- Integrates with Edirect config modules
 
 ## Installation
 
-```sh
-pnpm add @edirect/oidc-client
-# or
+```bash
 npm install @edirect/oidc-client
 ```
 
 ## Usage
 
-### Password Grant (username + password)
-
-Used when the application authenticates on behalf of a user:
-
-```ts
-import OidcClient from '@edirect/oidc-client';
-
-const client = await OidcClient({
-  grantType: 'password',
-  baseUrl: process.env.OIDC_PROVIDER_URL, // e.g., 'https://keycloak.example.com'
-  oidcPath: process.env.OIDC_PROVIDER_PATH, // e.g., '/realms/my-realm'
-  clientId: process.env.OIDC_CLIENT_ID,
-  clientSecret: process.env.OIDC_CLIENT_SECRET,
-});
-
-// Acquire access token
-const tokenSet = await client.getAccessToken({
-  username: process.env.OIDC_USERNAME,
-  password: process.env.OIDC_PASSWORD,
-});
-
-console.log(tokenSet.access_token);
-console.log(tokenSet.expires_in);
-
-// Refresh token (not available for client_credentials)
-const refreshed = await client.getRefreshToken(tokenSet);
+```js
+(async () => {
+  const OidcClient = require('@edirect/oidc-client');
+  const oidcClient = await OidcClient({
+    grantType: 'password' | 'client_credentials' | 'authorization_code',
+    baseUrl: process.env.OIDC_PROVIDER_URL,
+    oidcPath: process.env.OIDC_PROVIDER_PATH,
+    clientId: process.env.OIDC_CLIENT_ID,
+    clientSecret: process.env.OIDC_CLIENT_SECRET,
+    redirectUri: process.env.OIDC_CALLBACK_URL,
+  });
+
+  const loginData = {
+    username: process.env.OIDC_USERNAME,
+    password: process.env.OIDC_PASSWORD,
+  };
+
+  const accessTokenSet = await oidcClient.getAccessToken(loginData);
+  console.log('\n', { accessTokenSet }, '\n');
+
+  // not applicable to client_credentials grant type
+  const refreshTokenSet = await oidcClient.getRefreshToken(accessTokenSet);
+  console.log('\n', { refreshTokenSet }, '\n');
+})();
 ```
-
-### Client Credentials Grant (service-to-service)
-
-Used for machine-to-machine authentication:
-
-```ts
-import OidcClient from '@edirect/oidc-client';
-
-const client = await OidcClient({
-  grantType: 'client_credentials',
-  baseUrl: process.env.OIDC_PROVIDER_URL,
-  oidcPath: process.env.OIDC_PROVIDER_PATH,
-  clientId: process.env.OIDC_CLIENT_ID,
-  clientSecret: process.env.OIDC_CLIENT_SECRET,
-});
-
-// No login data required for client_credentials
-const tokenSet = await client.getAccessToken();
-console.log(tokenSet.access_token);
-
-// Note: getRefreshToken is not applicable to client_credentials
-```
-
-### SSO Grant
-
-Used for SSO-based authentication flows:
-
-```ts
-const client = await OidcClient({
-  grantType: 'sso',
-  baseUrl: process.env.OIDC_PROVIDER_URL,
-  oidcPath: process.env.OIDC_PROVIDER_PATH,
-  clientId: process.env.OIDC_CLIENT_ID,
-  clientSecret: process.env.OIDC_CLIENT_SECRET,
-  redirectUri: process.env.OIDC_CALLBACK_URL,
-});
-
-const tokenSet = await client.getAccessToken({ code: authorizationCode });
-```
-
-## API
-
-### `OidcClient(params: Connect): Promise<OidcConnect>`
-
-Factory function that initializes the OIDC client for the specified grant type.
-
-| Parameter      | Type                                          | Description                                |
-| -------------- | --------------------------------------------- | ------------------------------------------ |
-| `grantType`    | `'password' \| 'client_credentials' \| 'sso'` | OAuth2 grant type                          |
-| `baseUrl`      | `string`                                      | OIDC provider base URL                     |
-| `oidcPath`     | `string`                                      | OIDC realm path (e.g., `/realms/my-realm`) |
-| `clientId`     | `string`                                      | Client ID registered in the OIDC provider  |
-| `clientSecret` | `string`                                      | Client secret                              |
-| `redirectUri`  | `string`                                      | Callback URL (for `sso` grant)             |
-
-### Client Methods
-
-| Method            | Signature                           | Description                                                  |
-| ----------------- | ----------------------------------- | ------------------------------------------------------------ |
-| `getAccessToken`  | `(loginData?) => Promise<TokenSet>` | Acquire an access token                                      |
-| `getRefreshToken` | `(tokenSet) => Promise<TokenSet>`   | Refresh an existing token set (not for `client_credentials`) |
-
-### `TokenSet`
-
-```ts
-interface TokenSet {
-  access_token: string;
-  token_type: string;
-  expires_in: number;
-  refresh_token?: string; // not present for client_credentials
-  refresh_expires_in?: number;
-  id_token?: string;
-  session_state?: string;
-  scope?: string;
-}
-```
-
-## Environment Variables
-
-| Variable             | Description                                                   |
-| -------------------- | ------------------------------------------------------------- |
-| `OIDC_PROVIDER_URL`  | OIDC provider base URL (e.g., `https://keycloak.example.com`) |
-| `OIDC_PROVIDER_PATH` | OIDC realm path (e.g., `/realms/my-realm`)                    |
-| `OIDC_CLIENT_ID`     | Client ID                                                     |
-| `OIDC_CLIENT_SECRET` | Client secret                                                 |
-| `OIDC_USERNAME`      | Username (for `password` grant)                               |
-| `OIDC_PASSWORD`      | Password (for `password` grant)                               |
-| `OIDC_CALLBACK_URL`  | Redirect URI (for `sso` grant)                                |

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/oidc-client",
-  "version": "11.0.48",
+  "version": "11.0.46",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -16,7 +16,7 @@
     "dist"
   ],
   "dependencies": {
-    "openid-client": "^6.8.2",
+    "openid-client": "^6.8.1",
     "tslib": "^2.8.1"
   },
   "type": "commonjs"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edirect/oidc-client",
-  "version": "11.0.49",
+  "version": "11.0.50",
   "packageScope": "@edirect",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -42,4 +42,4 @@
     "build:esm": "tsc -p tsconfig.esm.json",
     "build": "pnpm run build:cjs && pnpm run build:esm"
   }
-}
+}