Chrome extension

.changeset/config.json

@@ -14,6 +14,9 @@
   "updateInternalDependencies": "patch",
   "ignore": [
     "scratchpad",
+    "@forgerock/devtools-extension",
+    "@forgerock/devtools-bridge",
+    "@forgerock/devtools-types",
     "@forgerock/pingone-scripts",
     "@forgerock/device-client-app",
     "@forgerock/davinci-app",

.changeset/quiet-onions-study.md

@@ -0,0 +1,6 @@
+---
+'@forgerock/journey-client': minor
+'@forgerock/oidc-client': minor
+---
+
+Adds subscribe method to public api

.changeset/seven-hoops-win.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': minor
+---
+
+Adds a get cache method to expose the cache for consumers like devtools

.gitignore

@@ -5,6 +5,9 @@
 .pnpm-store/*
 .npm/_logs
 
+# Elm
+elm-stuff/
+
 # Generated code
 logs/*
 tmp/

.prototools

@@ -0,0 +1,5 @@
+node = "22"
+pnpm = "10"
+
+[settings]
+auto-install=true

e2e/davinci-app/main.ts

@@ -8,6 +8,7 @@ import './style.css';
 
 import { Config, FRUser, TokenManager } from '@forgerock/javascript-sdk';
 import { davinci } from '@forgerock/davinci-client';
+import { attachDevToolsBridge } from '@forgerock/devtools-bridge';
 import type {
   CustomLogger,
   DaVinciConfig,
@@ -334,16 +335,13 @@ const urlParams = new URLSearchParams(window.location.search);
     }
   }
 
-  /**
-   * Optionally subscribe to the store to listen for all store updates
-   * This is useful for debugging and logging
-   * It returns an unsubscribe function that you can call to stop listening
-   */
   davinciClient.subscribe(() => {
     const node = davinciClient.getNode();
     console.log('Event emitted from store:', node);
   });
 
+  attachDevToolsBridge(davinciClient, config);
+
   const qs = window.location.search;
   const searchParams = new URLSearchParams(qs);
 

e2e/davinci-app/package.json

@@ -12,6 +12,7 @@
   },
   "dependencies": {
     "@forgerock/davinci-client": "workspace:*",
+    "@forgerock/devtools-bridge": "workspace:*",
     "@forgerock/javascript-sdk": "4.7.0",
     "@forgerock/protect": "workspace:*",
     "@forgerock/sdk-logger": "workspace:*"

e2e/davinci-app/tsconfig.app.json

@@ -18,6 +18,9 @@
     {
       "path": "../../packages/protect/tsconfig.lib.json"
     },
+    {
+      "path": "../../packages/devtools-bridge/tsconfig.lib.json"
+    },
     {
       "path": "../../packages/davinci-client/tsconfig.lib.json"
     }

e2e/journey-app/main.ts

@@ -7,6 +7,7 @@
 import './style.css';
 
 import { journey } from '@forgerock/journey-client';
+import { attachJourneyBridge } from '@forgerock/devtools-bridge';
 
 import type { JourneyClient, RequestMiddleware } from '@forgerock/journey-client/types';
 
@@ -65,6 +66,7 @@ if (searchParams.get('middleware') === 'true') {
   let journeyClient: JourneyClient;
   try {
     journeyClient = await journey({ config: config, requestMiddleware });
+    attachJourneyBridge(journeyClient, config);
   } catch (error) {
     const message = error instanceof Error ? error.message : 'Unknown error';
     console.error('Failed to initialize journey client:', message);

e2e/journey-app/package.json

@@ -11,6 +11,7 @@
     "serve": "pnpm nx nxServe"
   },
   "dependencies": {
+    "@forgerock/devtools-bridge": "workspace:*",
     "@forgerock/journey-client": "workspace:*",
     "@forgerock/oidc-client": "workspace:*",
     "@forgerock/protect": "workspace:*",

e2e/journey-app/tsconfig.app.json

@@ -15,14 +15,17 @@
   ],
   "references": [
     {
-      "path": "../../packages/sdk-effects/logger/tsconfig.lib.json"
+      "path": "../../packages/device-client/tsconfig.lib.json"
     },
     {
-      "path": "../../packages/device-client/tsconfig.lib.json"
+      "path": "../../packages/sdk-effects/logger/tsconfig.lib.json"
     },
     {
       "path": "../../packages/oidc-client/tsconfig.lib.json"
     },
+    {
+      "path": "../../packages/devtools-bridge/tsconfig.lib.json"
+    },
     {
       "path": "../../packages/protect/tsconfig.lib.json"
     },

e2e/oidc-app/package.json

@@ -9,6 +9,7 @@
     "serve": "pnpm nx nxServe"
   },
   "dependencies": {
+    "@forgerock/devtools-bridge": "workspace:*",
     "@forgerock/oidc-client": "workspace:*"
   },
   "nx": {

e2e/oidc-app/src/utils/oidc-app.ts

@@ -6,6 +6,7 @@
  * of the MIT license. See the LICENSE file for details.
  *
  */
+import { attachOidcBridge } from '@forgerock/devtools-bridge';
 import { oidc } from '@forgerock/oidc-client';
 import type {
   AuthorizationError,
@@ -54,6 +55,7 @@ export async function oidcApp({ config, urlParams }) {
   if ('error' in oidcClient) {
     displayError(oidcClient);
   }
+  attachOidcBridge(oidcClient, config);
 
   document.getElementById('login-background').addEventListener('click', async () => {
     const authorizeOptions: GetAuthorizationUrlOptions =

e2e/oidc-app/tsconfig.app.json

@@ -21,6 +21,9 @@
   "references": [
     {
       "path": "../../packages/oidc-client/tsconfig.lib.json"
+    },
+    {
+      "path": "../../packages/devtools-bridge/tsconfig.lib.json"
     }
   ]
 }

eslint.config.mjs

@@ -109,6 +109,14 @@ export default [
               sourceTag: 'scope:sdk-types',
               onlyDependOnLibsWithTags: [],
             },
+            {
+              sourceTag: 'scope:devtools-types',
+              onlyDependOnLibsWithTags: [],
+            },
+            {
+              sourceTag: 'scope:devtools-bridge',
+              onlyDependOnLibsWithTags: ['scope:devtools-types', 'scope:package'],
+            },
           ],
         },
       ],

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

@@ -178,7 +178,7 @@ export interface CollectorErrors {
 }
 
 // @public (undocumented)
-export type Collectors = FlowCollector | PasswordCollector | TextCollector | SingleSelectCollector | IdpCollector | SubmitCollector | ActionCollector<'ActionCollector'> | SingleValueCollector<'SingleValueCollector'> | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | ReadOnlyCollector | ValidatedTextCollector | ProtectCollector | PollingCollector | FidoRegistrationCollector | FidoAuthenticationCollector | QrCodeCollector | AgreementCollector | UnknownCollector;
+export type Collectors = FlowCollector | PasswordCollector | TextCollector | SingleSelectCollector | IdpCollector | SubmitCollector | ActionCollector<'ActionCollector'> | SingleValueCollector<'SingleValueCollector'> | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | PhoneNumberExtensionCollector | ReadOnlyCollector | ValidatedTextCollector | ProtectCollector | PollingCollector | FidoRegistrationCollector | FidoAuthenticationCollector | QrCodeCollector | AgreementCollector | UnknownCollector;
 
 // @public
 export type CollectorValueType<T> = T extends {
@@ -212,7 +212,7 @@ export type CollectorValueType<T> = T extends {
 } ? string[] : string | string[] | PhoneNumberInputValue | FidoRegistrationInputValue | FidoAuthenticationInputValue;
 
 // @public (undocumented)
-export type ComplexValueFields = DeviceAuthenticationField | DeviceRegistrationField | PhoneNumberField | FidoRegistrationField | FidoAuthenticationField | PollingField;
+export type ComplexValueFields = DeviceAuthenticationField | DeviceRegistrationField | PhoneNumberField | PhoneNumberExtensionField | FidoRegistrationField | FidoAuthenticationField | PollingField;
 
 // @public (undocumented)
 export interface ContinueNode {
@@ -267,13 +267,11 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
     resume: (input: {
         continueToken: string;
     }) => Promise<InternalErrorResponse | NodeStates>;
-    start: <QueryParams extends OutgoingQueryParams = OutgoingQueryParams>(options?: StartOptions<QueryParams> | undefined) => Promise<ContinueNode | StartNode | ErrorNode | FailureNode | SuccessNode>;
+    start: <QueryParams extends OutgoingQueryParams = OutgoingQueryParams>(options?: StartOptions<QueryParams> | undefined) => Promise<ContinueNode | ErrorNode | FailureNode | StartNode | SuccessNode>;
     update: <T extends SingleValueCollectors | MultiSelectCollector | ObjectValueCollectors | AutoCollectors>(collector: T) => Updater<T>;
     validate: (collector: SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors | AutoCollectors) => Validator;
-    poll: (collector: PollingCollector) => Poller;
+    pollStatus: (collector: PollingCollector) => Poller;
     getClient: () => {
-        status: "start";
-    } | {
         action: string;
         collectors: Collectors[];
         description?: string;
@@ -287,6 +285,8 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
         status: "error";
     } | {
         status: "failure";
+    } | {
+        status: "start";
     } | {
         authorization?: {
             code?: string;
@@ -297,7 +297,7 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
     getCollectors: () => Collectors[];
     getError: () => DaVinciError | null;
     getErrorCollectors: () => CollectorErrors[];
-    getNode: () => ContinueNode | StartNode | ErrorNode | FailureNode | SuccessNode;
+    getNode: () => ContinueNode | ErrorNode | FailureNode | StartNode | SuccessNode;
     getServer: () => {
         _links?: Links;
         id?: string;
@@ -306,8 +306,6 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
         href?: string;
         eventName?: string;
         status: "continue";
-    } | {
-        status: "start";
     } | {
         _links?: Links;
         eventName?: string;
@@ -323,6 +321,8 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
         interactionId?: string;
         interactionToken?: string;
         status: "failure";
+    } | {
+        status: "start";
     } | {
         _links?: Links;
         eventName?: string;
@@ -524,6 +524,7 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
                 type: string;
             };
         };
+        getCache: (requestId: string) => unknown;
     };
 }>;
 
@@ -1035,7 +1036,7 @@ export type InferNoValueCollectorType<T extends NoValueCollectorTypes> = T exten
 export type InferSingleValueCollectorType<T extends SingleValueCollectorTypes> = T extends 'TextCollector' ? TextCollector : T extends 'SingleSelectCollector' ? SingleSelectCollector : T extends 'ValidatedTextCollector' ? ValidatedTextCollector : T extends 'PasswordCollector' ? PasswordCollector : SingleValueCollectorWithValue<'SingleValueCollector'> | SingleValueCollectorNoValue<'SingleValueCollector'>;
 
 // @public (undocumented)
-export type InferValueObjectCollectorType<T extends ObjectValueCollectorTypes> = T extends 'DeviceAuthenticationCollector' ? DeviceAuthenticationCollector : T extends 'DeviceRegistrationCollector' ? DeviceRegistrationCollector : T extends 'PhoneNumberCollector' ? PhoneNumberCollector : ObjectOptionsCollectorWithObjectValue<'ObjectValueCollector'> | ObjectOptionsCollectorWithStringValue<'ObjectValueCollector'>;
+export type InferValueObjectCollectorType<T extends ObjectValueCollectorTypes> = T extends 'DeviceAuthenticationCollector' ? DeviceAuthenticationCollector : T extends 'DeviceRegistrationCollector' ? DeviceRegistrationCollector : T extends 'PhoneNumberCollector' ? PhoneNumberCollector : T extends 'PhoneNumberExtensionCollector' ? PhoneNumberExtensionCollector : ObjectOptionsCollectorWithObjectValue<'ObjectValueCollector'> | ObjectOptionsCollectorWithStringValue<'ObjectValueCollector'>;
 
 // @public (undocumented)
 export type InitFlow = () => Promise<FlowNode | InternalErrorResponse>;
@@ -1170,8 +1171,8 @@ value: Record<string, unknown>;
 }, string>;
 
 // @public
-export const nodeCollectorReducer: Reducer<(TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[]> & {
-    getInitialState: () => (TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[];
+export const nodeCollectorReducer: Reducer<(TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | PhoneNumberExtensionCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[]> & {
+    getInitialState: () => (TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | PhoneNumberExtensionCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[];
 };
 
 // @public (undocumented)
@@ -1283,10 +1284,10 @@ export type ObjectValueAutoCollectorTypes = 'ObjectValueAutoCollector' | 'FidoRe
 export type ObjectValueCollector<T extends ObjectValueCollectorTypes> = ObjectOptionsCollectorWithObjectValue<T> | ObjectOptionsCollectorWithStringValue<T> | ObjectValueCollectorWithObjectValue<T>;
 
 // @public (undocumented)
-export type ObjectValueCollectors = DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | ObjectOptionsCollectorWithObjectValue<'ObjectSelectCollector'> | ObjectOptionsCollectorWithStringValue<'ObjectSelectCollector'>;
+export type ObjectValueCollectors = DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | PhoneNumberExtensionCollector | ObjectOptionsCollectorWithObjectValue<'ObjectSelectCollector'> | ObjectOptionsCollectorWithStringValue<'ObjectSelectCollector'>;
 
 // @public
-export type ObjectValueCollectorTypes = 'DeviceAuthenticationCollector' | 'DeviceRegistrationCollector' | 'PhoneNumberCollector' | 'ObjectOptionsCollector' | 'ObjectValueCollector' | 'ObjectSelectCollector';
+export type ObjectValueCollectorTypes = 'DeviceAuthenticationCollector' | 'DeviceRegistrationCollector' | 'PhoneNumberCollector' | 'PhoneNumberExtensionCollector' | 'ObjectOptionsCollector' | 'ObjectValueCollector' | 'ObjectSelectCollector';
 
 // @public (undocumented)
 export interface ObjectValueCollectorWithObjectValue<T extends ObjectValueCollectorTypes, IV = Record<string, string>, OV = Record<string, string>> {
@@ -1328,13 +1329,68 @@ export type PasswordCollector = SingleValueCollectorNoValue<'PasswordCollector'>
 // @public (undocumented)
 export type PhoneNumberCollector = ObjectValueCollectorWithObjectValue<'PhoneNumberCollector', PhoneNumberInputValue, PhoneNumberOutputValue>;
 
+// @public (undocumented)
+export interface PhoneNumberExtensionCollector {
+    // (undocumented)
+    category: 'ObjectValueCollector';
+    // (undocumented)
+    error: string | null;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    input: {
+        key: string;
+        value: PhoneNumberExtensionInputValue;
+        type: string;
+        validation: (ValidationRequired | ValidationPhoneNumber)[] | null;
+    };
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    output: {
+        key: string;
+        label: string;
+        type: string;
+        extensionLabel: string;
+        value: PhoneNumberExtensionOutputValue;
+    };
+    // (undocumented)
+    type: 'PhoneNumberExtensionCollector';
+}
+
+// @public (undocumented)
+export type PhoneNumberExtensionField = PhoneNumberField & {
+    showExtension: boolean;
+    extensionLabel: string;
+};
+
+// @public (undocumented)
+export interface PhoneNumberExtensionInputValue {
+    // (undocumented)
+    countryCode: string;
+    // (undocumented)
+    extension: string;
+    // (undocumented)
+    phoneNumber: string;
+}
+
+// @public (undocumented)
+export interface PhoneNumberExtensionOutputValue {
+    // (undocumented)
+    countryCode?: string;
+    // (undocumented)
+    extension?: string;
+    // (undocumented)
+    phoneNumber?: string;
+}
+
 // @public (undocumented)
 export type PhoneNumberField = {
     type: 'PHONE_NUMBER';
     key: string;
     label: string;
-    defaultCountryCode: string | null;
     required: boolean;
+    defaultCountryCode: string | null;
     validatePhoneNumber: boolean;
 };
 
@@ -1724,7 +1780,7 @@ export type UnknownField = Record<string, unknown>;
 // @public (undocumented)
 export const updateCollectorValues: ActionCreatorWithPayload<    {
 id: string;
-value: string | string[] | PhoneNumberInputValue | FidoRegistrationInputValue | FidoAuthenticationInputValue;
+value: string | string[] | PhoneNumberInputValue | PhoneNumberExtensionInputValue | FidoRegistrationInputValue | FidoAuthenticationInputValue;
 index?: number;
 }, string>;