Merge pull request #633 from ForgeRock/feat/export-subscribe-method-v2

feat: expose subscribe method on journey-client and oidc-client

Author: ryanbas21

.changeset/export-subscribe-method.md

@@ -0,0 +1,6 @@
+---
+'@forgerock/journey-client': minor
+'@forgerock/oidc-client': minor
+---
+
+Expose `subscribe` method on journey and oidc client instances, consistent with davinci-client. Allows consumers to listen for store state changes.

packages/journey-client/api-report/journey-client.api.md

@@ -195,6 +195,8 @@ export interface JourneyClient {
     // (undocumented)
     start: (options?: StartParam) => Promise<JourneyResult>;
     // (undocumented)
+    subscribe: (listener: () => void) => () => void;
+    // (undocumented)
     terminate: (options?: {
         query?: Record<string, string>;
     }) => Promise<void | GenericError>;

packages/journey-client/api-report/journey-client.types.api.md

@@ -182,6 +182,8 @@ export interface JourneyClient {
     // (undocumented)
     start: (options?: StartParam) => Promise<JourneyResult>;
     // (undocumented)
+    subscribe: (listener: () => void) => () => void;
+    // (undocumented)
     terminate: (options?: {
         query?: Record<string, string>;
     }) => Promise<void | GenericError>;

packages/journey-client/src/lib/client.store.test.ts

@@ -109,6 +109,7 @@ describe('journey-client', () => {
     expect(client.redirect).toBeInstanceOf(Function);
     expect(client.resume).toBeInstanceOf(Function);
     expect(client.terminate).toBeInstanceOf(Function);
+    expect(client.subscribe).toBeInstanceOf(Function);
   });
 
   test('journey_InvalidWellknownUrl_ThrowsError', async () => {

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

@@ -36,6 +36,7 @@ export type JourneyResult = JourneyStep | JourneyLoginSuccess | JourneyLoginFail
 
 /** The journey client instance returned by the `journey()` function. */
 export interface JourneyClient {
+  subscribe: (listener: () => void) => () => void;
   start: (options?: StartParam) => Promise<JourneyResult>;
   next: (step: JourneyStep, options?: NextOptions) => Promise<JourneyResult>;
   redirect: (step: JourneyStep) => Promise<void>;
@@ -154,6 +155,8 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
   });
 
   const self: JourneyClient = {
+    subscribe: store.subscribe,
+
     start: async (options?: StartParam) => {
       const { data } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
       if (!data) {

packages/oidc-client/api-report/oidc-client.api.md

@@ -27,6 +27,7 @@ import { StoreEnhancer } from '@reduxjs/toolkit';
 import { ThunkDispatch } from '@reduxjs/toolkit';
 import { Tuple } from '@reduxjs/toolkit';
 import { UnknownAction } from '@reduxjs/toolkit';
+import { Unsubscribe } from '@reduxjs/toolkit';
 import { WellknownResponse } from '@forgerock/sdk-types';
 
 export { ActionTypes }
@@ -260,10 +261,12 @@ export function oidc<ActionType extends ActionTypes = ActionTypes>(input: {
 }): Promise<{
     error: string;
     type: string;
+    subscribe?: undefined;
     authorize?: undefined;
     token?: undefined;
     user?: undefined;
 } | {
+    subscribe: (listener: () => void) => Unsubscribe;
     authorize: {
         url: (options?: GetAuthorizationUrlOptions) => Promise<string | GenericError>;
         background: (options?: GetAuthorizationUrlOptions) => Promise<AuthorizationSuccess | AuthorizationError>;

packages/oidc-client/api-report/oidc-client.types.api.md

@@ -27,6 +27,7 @@ import { StoreEnhancer } from '@reduxjs/toolkit';
 import { ThunkDispatch } from '@reduxjs/toolkit';
 import { Tuple } from '@reduxjs/toolkit';
 import { UnknownAction } from '@reduxjs/toolkit';
+import { Unsubscribe } from '@reduxjs/toolkit';
 import { WellknownResponse } from '@forgerock/sdk-types';
 
 export { ActionTypes }
@@ -260,10 +261,12 @@ export function oidc<ActionType extends ActionTypes = ActionTypes>(input: {
 }): Promise<{
     error: string;
     type: string;
+    subscribe?: undefined;
     authorize?: undefined;
     token?: undefined;
     user?: undefined;
 } | {
+    subscribe: (listener: () => void) => Unsubscribe;
     authorize: {
         url: (options?: GetAuthorizationUrlOptions) => Promise<string | GenericError>;
         background: (options?: GetAuthorizationUrlOptions) => Promise<AuthorizationSuccess | AuthorizationError>;

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

@@ -133,6 +133,18 @@ describe('PingOne token get method', async () => {
     expect(tokens.error).toBe('No tokens found');
   });
 
+  it('exposes a subscribe method', async () => {
+    const oidcClient = await oidc({ config, storage: customStorageConfig });
+
+    if ('error' in oidcClient) {
+      throw new Error('Error creating OIDC Client');
+    }
+
+    expect(oidcClient.subscribe).toBeInstanceOf(Function);
+    const unsubscribe = oidcClient.subscribe(vi.fn());
+    expect(unsubscribe).toBeInstanceOf(Function);
+  });
+
   it('Get tokens', async () => {
     customStorage.set(
       storageKey,

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

@@ -109,6 +109,9 @@ export async function oidc<ActionType extends ActionTypes = ActionTypes>({
   const useParFlow = config.par ?? data?.require_pushed_authorization_requests === true;
 
   return {
+    // Pass store methods to the client
+    subscribe: store.subscribe,
+
     /**
      * An object containing methods for the creation, and background use, of the authorization URL
      */