ForgeRock · ancheetah · Apr 17, 2026
diff --git a/.changeset/long-singers-do.md b/.changeset/long-singers-do.md
@@ -0,0 +1,7 @@
+---
+'@forgerock/davinci-client': minor
+---
+
+Add support for extension in PhoneNumberCollector
+
+BREAKING CHANGE: `ObjectValueCollectorWithObjectValue` type was removed
diff --git a/e2e/davinci-app/components/object-value.ts b/e2e/davinci-app/components/object-value.ts
@@ -87,6 +87,7 @@ export default function objectValueComponent(
       updater({
         phoneNumber: selectedValue,
         countryCode: collector.output.value?.countryCode || '',
+        extension: collector.output.value?.extension || '',
       } as any);
     });
 

diff --git a/e2e/davinci-suites/src/form-fields.test.ts b/e2e/davinci-suites/src/form-fields.test.ts
@@ -42,9 +42,10 @@ test('Should render form fields', async ({ page }) => {
 
   await page.getByRole('button', { name: 'Submit' }).click();
   const request = await requestPromise;
-
-  const parsedData = JSON.parse(request.postData());
+  const postData = request.postData();
+  const parsedData = postData ? JSON.parse(postData) : {};
   const data = parsedData.parameters.data;
+
   expect(data.actionKey).toBe('submit');
   expect(data.formData).toStrictEqual({
     'text-input-key': 'The input',
@@ -55,6 +56,7 @@ test('Should render form fields', async ({ page }) => {
     'phone-field': {
       phoneNumber: '1234567890',
       countryCode: 'GB',
+      extension: '4321',
     },
   });
 });

diff --git a/packages/davinci-client/src/lib/collector.types.test-d.ts b/packages/davinci-client/src/lib/collector.types.test-d.ts
@@ -23,6 +23,12 @@ import type {
   InferSingleValueCollectorType,
   InferMultiValueCollectorType,
   InferActionCollectorType,
+  PhoneNumberCollector,
+  ObjectOptionsCollectorWithObjectValue,
+  InferValueObjectCollectorType,
+  PhoneNumberInputValue,
+  PhoneNumberOutputValue,
+  PhoneNumberOptions,
 } from './collector.types.js';
 
 describe('Collector Types', () => {
@@ -354,5 +360,75 @@ describe('Collector Types', () => {
 
       expectTypeOf(tCollector).toMatchTypeOf<FlowCollector>();
     });
+
+    it('should correctly infer PhoneNumberCollector Type', () => {
+      const tCollector: InferValueObjectCollectorType<'PhoneNumberCollector'> = {
+        category: 'ObjectValueCollector',
+        error: null,
+        type: 'PhoneNumberCollector',
+        id: '',
+        name: '',
+        input: {
+          key: '',
+          value: { countryCode: '', phoneNumber: '', extension: '' },
+          type: '',
+          validation: null,
+        },
+        output: {
+          key: '',
+          label: '',
+          type: '',
+          options: { showExtension: false },
+          value: { countryCode: '', phoneNumber: '', extension: '' },
+        },
+      };
+
+      expectTypeOf(tCollector).toEqualTypeOf<PhoneNumberCollector>();
+    });
+  });
+
+  describe('ObjectValueCollector Types', () => {
+    it('should validate PhoneNumberCollector structure', () => {
+      expectTypeOf<PhoneNumberCollector>().toEqualTypeOf<
+        ObjectOptionsCollectorWithObjectValue<
+          'PhoneNumberCollector',
+          PhoneNumberInputValue,
+          PhoneNumberOutputValue,
+          PhoneNumberOptions
+        >
+      >();
+      expectTypeOf<PhoneNumberCollector>()
+        .toHaveProperty('category')
+        .toEqualTypeOf<'ObjectValueCollector'>();
+      expectTypeOf<PhoneNumberCollector>()
+        .toHaveProperty('type')
+        .toEqualTypeOf<'PhoneNumberCollector'>();
+      expectTypeOf<PhoneNumberCollector['input']['value']>().toEqualTypeOf<PhoneNumberInputValue>();
+      expectTypeOf<PhoneNumberCollector['output']['options']>().toEqualTypeOf<PhoneNumberOptions>();
+    });
+
+    it('should validate PhoneNumberCollector base type constraints', () => {
+      const collector: PhoneNumberCollector = {
+        category: 'ObjectValueCollector',
+        type: 'PhoneNumberCollector',
+        error: null,
+        id: 'test',
+        name: 'Test',
+        input: {
+          key: 'phone',
+          value: { countryCode: '+1', phoneNumber: '5555555555', extension: '' },
+          type: 'string',
+          validation: null,
+        },
+        output: {
+          key: 'phone',
+          label: 'Phone Number',
+          type: 'phone',
+          options: { showExtension: true },
+          value: { countryCode: '+1', phoneNumber: '5555555555' },
+        },
+      };
+      expectTypeOf(collector).toEqualTypeOf<PhoneNumberCollector>();
+    });
   });
 });
diff --git a/packages/davinci-client/src/lib/collector.types.ts b/packages/davinci-client/src/lib/collector.types.ts
@@ -297,11 +297,17 @@ export interface DeviceValue {
 export interface PhoneNumberInputValue {
   countryCode: string;
   phoneNumber: string;
+  extension: string;
 }
 
 export interface PhoneNumberOutputValue {
   countryCode?: string;
   phoneNumber?: string;
+  extension?: string;
+}
+
+export interface PhoneNumberOptions {
+  showExtension: boolean;
 }
 
 export interface ObjectOptionsCollectorWithStringValue<
@@ -331,6 +337,7 @@ export interface ObjectOptionsCollectorWithObjectValue<
   T extends ObjectValueCollectorTypes,
   V = Record<string, string>,
   D = Record<string, string>,
+  O = Record<string, string>,
 > {
   category: 'ObjectValueCollector';
   error: string | null;
@@ -341,38 +348,14 @@ export interface ObjectOptionsCollectorWithObjectValue<
     key: string;
     value: V;
     type: string;
-    validation: ValidationRequired[] | null;
-  };
-  output: {
-    key: string;
-    label: string;
-    type: string;
-    options: DeviceOptionWithDefault[];
-    value?: D | null;
-  };
-}
-
-export interface ObjectValueCollectorWithObjectValue<
-  T extends ObjectValueCollectorTypes,
-  IV = Record<string, string>,
-  OV = Record<string, string>,
-> {
-  category: 'ObjectValueCollector';
-  error: string | null;
-  type: T;
-  id: string;
-  name: string;
-  input: {
-    key: string;
-    value: IV;
-    type: string;
     validation: (ValidationRequired | ValidationPhoneNumber)[] | null;
   };
   output: {
     key: string;
     label: string;
     type: string;
-    value?: OV | null;
+    options: O;
+    value?: D | null;
   };
 }
 
@@ -396,21 +379,23 @@ export type ObjectValueCollectors =
 
 export type ObjectValueCollector<T extends ObjectValueCollectorTypes> =
   | ObjectOptionsCollectorWithObjectValue<T>
-  | ObjectOptionsCollectorWithStringValue<T>
-  | ObjectValueCollectorWithObjectValue<T>;
+  | ObjectOptionsCollectorWithStringValue<T>;
 
 export type DeviceRegistrationCollector = ObjectOptionsCollectorWithStringValue<
   'DeviceRegistrationCollector',
   string
 >;
 export type DeviceAuthenticationCollector = ObjectOptionsCollectorWithObjectValue<
   'DeviceAuthenticationCollector',
-  DeviceValue
+  DeviceValue,
+  Record<string, string>,
+  DeviceOptionWithDefault[]
 >;
-export type PhoneNumberCollector = ObjectValueCollectorWithObjectValue<
+export type PhoneNumberCollector = ObjectOptionsCollectorWithObjectValue<
   'PhoneNumberCollector',
   PhoneNumberInputValue,
-  PhoneNumberOutputValue
+  PhoneNumberOutputValue,
+  PhoneNumberOptions
 >;
 
 /** *********************************************************************

diff --git a/packages/davinci-client/src/lib/collector.utils.test.ts b/packages/davinci-client/src/lib/collector.utils.test.ts
@@ -567,6 +567,7 @@ describe('returnPhoneNumberCollector', () => {
       type: 'PHONE_NUMBER',
       required: true,
       validatePhoneNumber: true,
+      showExtension: false,
     };
 
     const result = returnObjectValueCollector(mockField, 1, {});
@@ -581,6 +582,7 @@ describe('returnPhoneNumberCollector', () => {
         value: {
           countryCode: '',
           phoneNumber: '',
+          extension: '',
         },
         type: mockField.type,
         validation: [
@@ -600,9 +602,11 @@ describe('returnPhoneNumberCollector', () => {
         key: mockField.key,
         label: mockField.label,
         type: mockField.type,
+        options: { showExtension: false },
         value: {
           countryCode: '',
           phoneNumber: '',
+          extension: '',
         },
       },
     });
@@ -616,6 +620,7 @@ describe('returnPhoneNumberCollector', () => {
       type: 'PHONE_NUMBER',
       required: false,
       validatePhoneNumber: false,
+      showExtension: false,
     };
     const result = returnObjectValueCollector(mockField, 1, {});
     expect(result).toEqual({
@@ -629,6 +634,7 @@ describe('returnPhoneNumberCollector', () => {
         value: {
           countryCode: mockField.defaultCountryCode,
           phoneNumber: '',
+          extension: '',
         },
         type: mockField.type,
         validation: null,
@@ -637,9 +643,11 @@ describe('returnPhoneNumberCollector', () => {
         key: mockField.key,
         label: mockField.label,
         type: mockField.type,
+        options: { showExtension: false },
         value: {
           countryCode: mockField.defaultCountryCode,
           phoneNumber: '',
+          extension: '',
         },
       },
     });
@@ -653,6 +661,7 @@ describe('returnPhoneNumberCollector', () => {
       type: 'PHONE_NUMBER',
       required: false,
       validatePhoneNumber: false,
+      showExtension: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       countryCode: 'CA',
@@ -669,6 +678,7 @@ describe('returnPhoneNumberCollector', () => {
         value: {
           countryCode: prefillMock.countryCode,
           phoneNumber: '',
+          extension: '',
         },
         type: mockField.type,
         validation: null,
@@ -677,9 +687,11 @@ describe('returnPhoneNumberCollector', () => {
         key: mockField.key,
         label: mockField.label,
         type: mockField.type,
+        options: { showExtension: false },
         value: {
           countryCode: prefillMock.countryCode,
           phoneNumber: '',
+          extension: '',
         },
       },
     });
@@ -695,6 +707,7 @@ describe('returnPhoneNumberCollector', () => {
       type: 'PHONE_NUMBER',
       required: false,
       validatePhoneNumber: false,
+      showExtension: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       phoneNumber: '1234567890',
@@ -711,6 +724,7 @@ describe('returnPhoneNumberCollector', () => {
         value: {
           countryCode: '',
           phoneNumber: prefillMock.phoneNumber,
+          extension: '',
         },
         type: mockField.type,
         validation: null,
@@ -719,9 +733,11 @@ describe('returnPhoneNumberCollector', () => {
         key: mockField.key,
         label: mockField.label,
         type: mockField.type,
+        options: { showExtension: false },
         value: {
           countryCode: '',
           phoneNumber: prefillMock.phoneNumber,
+          extension: '',
         },
       },
     });
@@ -735,6 +751,7 @@ describe('returnPhoneNumberCollector', () => {
       type: 'PHONE_NUMBER',
       required: false,
       validatePhoneNumber: false,
+      showExtension: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       countryCode: 'CA',
@@ -752,6 +769,7 @@ describe('returnPhoneNumberCollector', () => {
         value: {
           countryCode: prefillMock.countryCode,
           phoneNumber: prefillMock.phoneNumber,
+          extension: '',
         },
         type: mockField.type,
         validation: null,
@@ -760,13 +778,48 @@ describe('returnPhoneNumberCollector', () => {
         key: mockField.key,
         label: mockField.label,
         type: mockField.type,
+        options: { showExtension: false },
         value: {
           countryCode: prefillMock.countryCode,
           phoneNumber: prefillMock.phoneNumber,
+          extension: '',
         },
       },
     });
   });
+
+  it('showExtension is reflected in output options', () => {
+    const mockField: PhoneNumberField = {
+      key: 'phone-number-key',
+      defaultCountryCode: null,
+      label: 'Phone Number',
+      type: 'PHONE_NUMBER',
+      required: false,
+      validatePhoneNumber: false,
+      showExtension: true,
+    };
+    const result = returnObjectValueCollector(mockField, 1, {});
+    expect(result.output.options).toEqual({ showExtension: true });
+  });
+
+  it('prefilled extension is set on collector', () => {
+    const mockField: PhoneNumberField = {
+      key: 'phone-number-key',
+      defaultCountryCode: null,
+      label: 'Phone Number',
+      type: 'PHONE_NUMBER',
+      required: false,
+      validatePhoneNumber: false,
+      showExtension: true,
+    };
+    const prefillMock: PhoneNumberOutputValue = {
+      phoneNumber: '1234567890',
+      extension: '123',
+    };
+    const result = returnObjectValueCollector(mockField, 1, prefillMock);
+    expect(result.input.value.extension).toBe('123');
+    expect(result.output.value?.extension).toBe('123');
+  });
 });
 
 describe('No Value Collectors', () => {