chore(oidc-client): re-export necessary types

Author: ancheetah

e2e/oidc-app/package.json

@@ -9,9 +9,7 @@
     "serve": "pnpm nx nxServe"
   },
   "dependencies": {
-    "@forgerock/javascript-sdk": "^4.8.2",
-    "@forgerock/oidc-client": "workspace:*",
-    "@forgerock/sdk-types": "workspace:*"
+    "@forgerock/oidc-client": "workspace:*"
   },
   "nx": {
     "tags": ["scope:e2e"]

e2e/oidc-app/tsconfig.app.json

@@ -19,9 +19,6 @@
   ],
   "include": ["src/**/*.ts"],
   "references": [
-    {
-      "path": "../../packages/sdk-types/tsconfig.lib.json"
-    },
     {
       "path": "../../packages/oidc-client/tsconfig.lib.json"
     }

e2e/oidc-app/tsconfig.json

@@ -3,9 +3,6 @@
   "files": [],
   "include": [],
   "references": [
-    {
-      "path": "../../packages/sdk-types"
-    },
     {
       "path": "../../packages/oidc-client"
     },

packages/oidc-client/README.md

@@ -4,21 +4,22 @@ A generic OpenID Connect (OIDC) client library for JavaScript and TypeScript, de
 
 ```js
 // Initialize OIDC Client
-const oidcClient = oidc({
+const oidcClient = await oidc({
   /* config */
 });
 
 // Authorize API
-const authResponse = oidcClient.authorize.background(); // Returns code and state if successful, error and Auth URL if not
-const authUrl = oidcClient.authorize.url(); // Returns Auth URL or error
+const authResponse = await oidcClient.authorize.background(); // Returns code and state if successful, error if not
+const authUrl = await oidcClient.authorize.url(); // Returns Auth URL or error
 
 // Tokens API
-const newTokens = oidcClient.token.exchange({
+const newTokens = await oidcClient.token.exchange({
   /* code, state */
 }); // Returns new tokens or error
-const existingTokens = oidcClient.token.get(); // Returns existing tokens or error
+const existingTokens = await oidcClient.token.get(); // Returns existing tokens or error
+const response = await oidcClient.token.revoke(); // Revokes an access token and returns the response or an error
 
 // User API
-const user = oidcClient.user.info(); // Returns user object or error
-const logoutResponse = oidcClient.user.logout(); // Returns null or error
+const user = await oidcClient.user.info(); // Returns user object or error
+const logoutResponse = await oidcClient.user.logout(); // Logs the user out and returns the response or an error
 ```

packages/oidc-client/src/lib/authorize.request.ts

@@ -12,28 +12,28 @@ import {
   buildAuthorizeOptionsµ,
   createAuthorizeErrorµ,
 } from './authorize.request.utils.js';
+import { oidcApi } from './oidc.api.js';
 
+import type { ClientStore } from './client.types.js';
 import type { GetAuthorizationUrlOptions, WellKnownResponse } from '@forgerock/sdk-types';
-
 import type { AuthorizationError, AuthorizationSuccess } from './authorize.request.types.js';
-import type { createClientStore } from './client.store.utils.js';
 import type { OidcConfig } from './config.types.js';
-import { oidcApi } from './oidc.api.js';
 
 /**
  * @function authorizeµ
  * @description Creates an authorization URL for the OIDC client.
  * @param {WellKnownResponse} wellknown - The well-known configuration for the OIDC server.
  * @param {OidcConfig} config - The OIDC client configuration.
  * @param {CustomLogger} log - The logger instance for logging debug information.
+ * @param {ClientStore} store - The Redux store instance for managing OIDC state.
  * @param {GetAuthorizationUrlOptions} options - Optional parameters for the authorization request.
  * @returns {Micro.Micro<AuthorizationSuccess, AuthorizationError, never>} - A micro effect that resolves to the authorization response.
  */
 export function authorizeµ(
   wellknown: WellKnownResponse,
   config: OidcConfig,
   log: CustomLogger,
-  store: ReturnType<typeof createClientStore>,
+  store: ClientStore,
   options?: GetAuthorizationUrlOptions,
 ) {
   return buildAuthorizeOptionsµ(wellknown, config, options).pipe(

packages/oidc-client/src/lib/authorize.request.types.ts

@@ -4,6 +4,10 @@
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
  */
+import type { GetAuthorizationUrlOptions } from '@forgerock/sdk-types';
+
+export type BuildAuthorizationData = [string, GetAuthorizationUrlOptions];
+export type OptionalAuthorizeOptions = Partial<GetAuthorizationUrlOptions>;
 export interface AuthorizeErrorResponse {
   id?: string;
   code?: string;

packages/oidc-client/src/lib/authorize.request.utils.ts

@@ -8,19 +8,20 @@ import { createAuthorizeUrl } from '@forgerock/sdk-oidc';
 import { Micro } from 'effect';
 
 import type { WellKnownResponse, GetAuthorizationUrlOptions } from '@forgerock/sdk-types';
-
-import type { AuthorizationError, AuthorizationSuccess } from './authorize.request.types.js';
+import type {
+  AuthorizationError,
+  AuthorizationSuccess,
+  BuildAuthorizationData,
+  OptionalAuthorizeOptions,
+} from './authorize.request.types.js';
 import type { OidcConfig } from './config.types.js';
 
-type BuildAuthorizationData = [string, GetAuthorizationUrlOptions];
-export type OptionalAuthorizeOptions = Partial<GetAuthorizationUrlOptions>;
-
 /**
  * @function buildAuthorizeOptionsµ
  * @description Builds the authorization options for the OIDC client.
  * @param {WellKnownResponse} wellknown - The well-known configuration for the OIDC server.
  * @param {OptionalAuthorizeOptions} options - Optional parameters for the authorization request.
- * @returns {Micro.Micro<BuildAuthorizationData, AuthorizeErrorResponse, never>}
+ * @returns {Micro.Micro<BuildAuthorizationData, AuthorizationError, never>}
  */
 export function buildAuthorizeOptionsµ(
   wellknown: WellKnownResponse,
@@ -50,7 +51,7 @@ export function buildAuthorizeOptionsµ(
  * @param {WellKnownResponse} wellknown- The well-known configuration for the OIDC server.
  * @param { OidcConfig } config- The OIDC client configuration.
  * @param { GetAuthorizationUrlOptions } options- Optional parameters for the authorization request.
- * @returns { Micro.Micro<never, AuthorizeErrorResponse, never> }
+ * @returns { Micro.Micro<never, AuthorizationError, never> }
  */
 export function createAuthorizeErrorµ(
   res: { error: string; error_description: string },
@@ -121,7 +122,6 @@ export function createAuthorizeUrlµ(
 export function handleResponseµ(
   response: AuthorizationSuccess | AuthorizationError,
   wellknown: WellKnownResponse,
-  config: OidcConfig,
   options: GetAuthorizationUrlOptions,
 ): Micro.Micro<AuthorizationSuccess, AuthorizationError, never> {
   if ('code' in response) {

packages/oidc-client/src/lib/authorize.slice.ts

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
 import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query';
 
 const authorizeSlice = createApi({

packages/oidc-client/src/lib/client.store.ts

@@ -4,9 +4,9 @@
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
  */
-import { CustomLogger, logger as loggerFn, LogLevel } from '@forgerock/sdk-logger';
+import { logger as loggerFn } from '@forgerock/sdk-logger';
 import { createAuthorizeUrl } from '@forgerock/sdk-oidc';
-import { createStorage, StorageConfig } from '@forgerock/storage';
+import { createStorage } from '@forgerock/storage';
 import { Micro } from 'effect';
 import { exitIsFail, exitIsSuccess } from 'effect/Micro';
 
@@ -18,6 +18,8 @@ import { wellknownApi, wellknownSelector } from './wellknown.api.js';
 
 import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware';
 import type { GenericError, GetAuthorizationUrlOptions } from '@forgerock/sdk-types';
+import type { CustomLogger, LogLevel } from '@forgerock/sdk-logger';
+import type { StorageConfig } from '@forgerock/storage';
 
 import type {
   GetTokensOptions,

packages/oidc-client/src/lib/client.store.utils.ts

@@ -5,14 +5,14 @@
  * of the MIT license. See the LICENSE file for details.
  */
 import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware';
-import type { logger as loggerFn } from '@forgerock/sdk-logger';
+import { logger as loggerFn } from '@forgerock/sdk-logger';
 
-import { configureStore, SerializedError } from '@reduxjs/toolkit';
+import { configureStore, type SerializedError } from '@reduxjs/toolkit';
 import { oidcApi } from './oidc.api.js';
 import { wellknownApi } from './wellknown.api.js';
 
 import type { GenericError } from '@forgerock/sdk-types';
-import { FetchBaseQueryError } from '@reduxjs/toolkit/query';
+import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
 
 /**
  * @function createClientStore
@@ -113,9 +113,3 @@ export function createTokenError(type: 'no_tokens' | 'no_access_token' | 'no_id_
 
   return error;
 }
-
-type ClientStore = typeof createClientStore;
-
-export type RootState = ReturnType<ReturnType<ClientStore>['getState']>;
-
-export type AppDispatch = ReturnType<ReturnType<ClientStore>['dispatch']>;