chore: pr revisions

Author: ancheetah

.changeset/long-singers-do.md

@@ -2,6 +2,4 @@
 '@forgerock/davinci-client': minor
 ---
 
-Add support for extension in PhoneNumberCollector
-
-BREAKING CHANGE: `ObjectValueCollectorWithObjectValue` type was removed
+A new PhoneNumberExtensionCollector has been added to support phone number fields that include an extension. When a DaVinci PHONE_NUMBER field has showExtension: true, the SDK now produces a PhoneNumberExtensionCollector instead of a PhoneNumberCollector.

.gitignore

@@ -95,3 +95,6 @@ GEMINI.md
 .claude/worktrees
 .claude/settings.local.json
 .opensource
+
+# Polaris
+.polaris-setup-progress.json

e2e/davinci-app/components/object-value.ts

@@ -115,7 +115,7 @@ export default function objectValueComponent(
     phoneInput.setAttribute('placeholder', 'Enter phone number');
 
     const extensionLabel = document.createElement('label');
-    extensionLabel.textContent = collector.output.options.extensionLabel || 'Extension';
+    extensionLabel.textContent = collector.output.extensionLabel || 'Extension';
     extensionLabel.className = 'object-options-title';
     extensionLabel.setAttribute('for', 'extension-input-1');
 

e2e/davinci-suites/src/form-fields.test.ts

@@ -57,7 +57,7 @@ test('Should render form fields', async ({ page }) => {
     'phone-field': {
       phoneNumber: '1234567890',
       countryCode: 'GB',
-      extension: '7890',
+      extension: '7890', // Tests PhoneNumberExtensionCollector
     },
   });
 });

e2e/davinci-suites/src/phone-number-field.test.ts

@@ -103,8 +103,9 @@ test.describe('Device registration tests', () => {
     await page.getByRole('button', { name: 'DEVICE_REGISTRATION' }).click();
     await expect(page.getByText('SDK Automation - Device Registration')).toBeVisible();
     await page.getByRole('button', { name: 'Text Message' }).click();
-    await expect(page.getByText('SDK Automation - Enter Phone Number')).toBeVisible();
+    await expect(page.getByText('SDK Automation [JS] - Enter Phone Number')).toBeVisible();
     await page.getByRole('textbox', { name: 'Enter Phone Number' }).fill('3035550100');
+    await expect(page.getByText('Extension')).not.toBeVisible(); // Tests standard PhoneNumberCollector
     await page.getByRole('button', { name: 'Submit' }).click();
 
     await expect(page.getByText('SMS/Voice MFA Registered')).toBeVisible();

packages/davinci-client/src/lib/collector.types.test-d.ts

@@ -410,7 +410,7 @@ describe('Collector Types', () => {
           key: '',
           label: '',
           type: '',
-          options: { extensionLabel: '' },
+          extensionLabel: '',
           value: {},
         },
       };

packages/davinci-client/src/lib/collector.types.ts

@@ -317,10 +317,6 @@ export interface PhoneNumberExtensionOutputValue {
   extension?: string;
 }
 
-export interface PhoneNumberExtensionOptions {
-  extensionLabel: string;
-}
-
 export interface ObjectOptionsCollectorWithStringValue<
   T extends ObjectValueCollectorTypes,
   V = string,
@@ -409,7 +405,7 @@ export interface PhoneNumberExtensionCollector {
     key: string;
     label: string;
     type: string;
-    options: PhoneNumberExtensionOptions;
+    extensionLabel: string;
     value: PhoneNumberExtensionOutputValue;
   };
 }

packages/davinci-client/src/lib/collector.utils.test.ts

@@ -788,6 +788,59 @@ describe('returnObjectValueCollector with phone fields', () => {
     expect(result.type).toBe('PhoneNumberExtensionCollector');
   });
 
+  it('creates a full PhoneNumberExtensionCollector with all fields', () => {
+    const mockField: PhoneNumberExtensionField = {
+      key: 'phone-number-key',
+      defaultCountryCode: 'US',
+      label: 'Phone Number',
+      type: 'PHONE_NUMBER',
+      required: true,
+      validatePhoneNumber: true,
+      showExtension: true,
+      extensionLabel: 'Extension',
+    };
+    const result = returnObjectValueCollector(mockField, 1, {}) as PhoneNumberExtensionCollector;
+    expect(result).toEqual({
+      category: 'ObjectValueCollector',
+      error: null,
+      type: 'PhoneNumberExtensionCollector',
+      id: 'phone-number-key-1',
+      name: 'phone-number-key',
+      input: {
+        key: mockField.key,
+        value: {
+          countryCode: 'US',
+          phoneNumber: '',
+          extension: '',
+        },
+        type: mockField.type,
+        validation: [
+          {
+            message: 'Value cannot be empty',
+            rule: true,
+            type: 'required',
+          },
+          {
+            message: 'Phone number should be validated',
+            rule: true,
+            type: 'validatePhoneNumber',
+          },
+        ],
+      },
+      output: {
+        key: mockField.key,
+        label: mockField.label,
+        type: mockField.type,
+        extensionLabel: 'Extension',
+        value: {
+          countryCode: 'US',
+          phoneNumber: '',
+          extension: '',
+        },
+      },
+    });
+  });
+
   it('prefilled extension is set on collector', () => {
     const mockField: PhoneNumberExtensionField = {
       key: 'phone-number-key',
@@ -810,7 +863,20 @@ describe('returnObjectValueCollector with phone fields', () => {
     ) as PhoneNumberExtensionCollector;
     expect(result.input.value.extension).toBe('123');
     expect(result.output.value?.extension).toBe('123');
-    expect(result.output.options.extensionLabel).toBe('Extension');
+    expect(result.output.extensionLabel).toBe('Extension');
+  });
+
+  it('PhoneNumberCollector does not have extensionLabel in output', () => {
+    const mockField: PhoneNumberField = {
+      key: 'phone-number-key',
+      defaultCountryCode: null,
+      label: 'Phone Number',
+      type: 'PHONE_NUMBER',
+      required: false,
+      validatePhoneNumber: false,
+    };
+    const result = returnObjectValueCollector(mockField, 1, {});
+    expect(result.output).not.toHaveProperty('extensionLabel');
   });
 });
 

packages/davinci-client/src/lib/collector.utils.ts

@@ -612,6 +612,7 @@ export function returnObjectCollector<
 
   let options;
   let defaultValue;
+  let extensionLabel: string | null = null;
 
   if (field.type === 'DEVICE_AUTHENTICATION') {
     if (!('options' in field)) {
@@ -680,7 +681,7 @@ export function returnObjectCollector<
         extension: prefilledExtension ?? '',
       };
 
-      options = { extensionLabel: field.extensionLabel || '' };
+      extensionLabel = field.extensionLabel;
     } else {
       // PhoneNumberCollector default value
       defaultValue = {
@@ -707,6 +708,7 @@ export function returnObjectCollector<
       label: field.label,
       type: field.type,
       ...(options && { options: options || [] }),
+      ...(extensionLabel !== null && { extensionLabel }),
       ...(defaultValue && { value: defaultValue }),
     },
   } as InferValueObjectCollectorType<CollectorType>;

packages/davinci-client/src/lib/node.reducer.test.ts

@@ -994,12 +994,12 @@ describe('The phone number extension collector reducer', () => {
           key: 'phone-number-key',
           label: 'Phone Number',
           type: 'PHONE_NUMBER',
+          extensionLabel: 'Extension',
           value: {
             countryCode: '',
             phoneNumber: '',
             extension: '',
           },
-          options: { extensionLabel: 'Extension' },
         },
       },
     ]);
@@ -1052,12 +1052,12 @@ describe('The phone number extension collector reducer', () => {
           key: 'phone-number-key',
           label: 'Phone Number',
           type: 'PHONE_NUMBER',
+          extensionLabel: 'Extension',
           value: {
             countryCode: 'US',
             phoneNumber: '1234567890',
             extension: '123',
           },
-          options: { extensionLabel: 'Extension' },
         },
       },
     ]);
@@ -1101,7 +1101,7 @@ describe('The phone number extension collector reducer', () => {
             phoneNumber: '',
             extension: '',
           },
-          options: { extensionLabel: 'Extension' },
+          extensionLabel: 'Extension',
         },
       },
     ];
@@ -1126,12 +1126,12 @@ describe('The phone number extension collector reducer', () => {
           key: 'phone-number-key',
           label: 'Phone Number',
           type: 'PHONE_NUMBER',
+          extensionLabel: 'Extension',
           value: {
             countryCode: '',
             phoneNumber: '',
             extension: '',
           },
-          options: { extensionLabel: 'Extension' },
         },
       },
     ]);