fix(davinci-client): add validation props to collectors

Author: ancheetah

.changeset/fine-windows-search.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': patch
+---
+
+Exposes `required` and `validatePhoneNumber` properties on collectors

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

@@ -33,6 +33,7 @@ import type {
   ObjectValueCollectors,
   PhoneNumberInputValue,
   AutoCollectors,
+  MultiValueCollectors,
 } from './collector.types.js';
 import type {
   InitFlow,
@@ -290,11 +291,13 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
 
     /**
      * @method validate - Method for validating the value against validation rules
-     * @param {SingleValueCollector} collector - the collector to validate
+     * @param {SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors} collector - the collector to validate
      * @returns {function} - a function to call for validating collector value
-     * @throws {Error} - if the collector is not a SingleValueCollector
+     * @throws {Error} - if the collector cannot be validated
      */
-    validate: (collector: SingleValueCollectors): Validator => {
+    validate: (
+      collector: SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors,
+    ): Validator => {
       if (!collector.id) {
         return handleUpdateValidateError(
           'Argument for `collector` has no ID',
@@ -317,9 +320,13 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
         return handleUpdateValidateError('Collector not found', 'state_error', log.error);
       }
 
-      if (collectorToUpdate.category !== 'ValidatedSingleValueCollector') {
+      if (
+        collectorToUpdate.category !== 'ValidatedSingleValueCollector' &&
+        collectorToUpdate.category !== 'ObjectValueCollector' &&
+        collectorToUpdate.category !== 'MultiValueCollector'
+      ) {
         return handleUpdateValidateError(
-          'Collector is not a SingleValueCollector and cannot be validated',
+          'Collector is not a SingleValueCollector, ObjectValueCollector, or MultiValueCollector and cannot be validated',
           'state_error',
           log.error,
         );

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

@@ -37,6 +37,12 @@ interface ValidationRegex {
   rule: string;
 }
 
+interface ValidationPhoneNumber {
+  type: 'validatePhoneNumber';
+  message: string;
+  rule: boolean;
+}
+
 export interface SingleValueCollectorWithValue<T extends SingleValueCollectorTypes> {
   category: 'SingleValueCollector';
   error: string | null;
@@ -196,6 +202,7 @@ export interface MultiValueCollectorWithValue<T extends MultiValueCollectorTypes
     key: string;
     value: string[];
     type: string;
+    validation?: ValidationRequired[];
   };
   output: {
     key: string;
@@ -216,12 +223,12 @@ export interface MultiValueCollectorNoValue<T extends MultiValueCollectorTypes>
     key: string;
     value: string[];
     type: string;
+    validation?: ValidationRequired[];
   };
   output: {
     key: string;
     label: string;
     type: string;
-    value: string[];
     options: SelectorOption[];
   };
 }
@@ -308,6 +315,7 @@ export interface ObjectOptionsCollectorWithStringValue<
     key: string;
     value: V;
     type: string;
+    validation?: ValidationRequired[];
   };
   output: {
     key: string;
@@ -331,6 +339,7 @@ export interface ObjectOptionsCollectorWithObjectValue<
     key: string;
     value: V;
     type: string;
+    validation?: ValidationRequired[];
   };
   output: {
     key: string;
@@ -355,6 +364,7 @@ export interface ObjectValueCollectorWithObjectValue<
     key: string;
     value: IV;
     type: string;
+    validation?: (ValidationRequired | ValidationPhoneNumber)[];
   };
   output: {
     key: string;

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

@@ -30,7 +30,12 @@ import type {
   RedirectField,
   StandardField,
 } from './davinci.types.js';
-import { PhoneNumberOutputValue, ValidatedTextCollector } from './collector.types.js';
+import {
+  MultiSelectCollector,
+  PhoneNumberCollector,
+  PhoneNumberOutputValue,
+  ValidatedTextCollector,
+} from './collector.types.js';
 
 describe('Action Collectors', () => {
   describe('returnFlowCollector', () => {
@@ -410,6 +415,7 @@ describe('Multi-Value Collectors', () => {
       const result = returnMultiSelectCollector(comboField, 1, []);
       expect(result.type).toBe('MultiSelectCollector');
       expect(result.output).toHaveProperty('value', []);
+      expect(result.input).toHaveProperty('validation');
     });
   });
 });
@@ -438,7 +444,7 @@ describe('Object value collectors', () => {
           description: 'device2-value',
         },
       ],
-      required: true,
+      required: false,
     };
 
     const transformedDevices = mockField.options.map((device) => ({
@@ -524,6 +530,13 @@ describe('Object value collectors', () => {
           key: mockField.key,
           value: '',
           type: mockField.type,
+          validation: [
+            {
+              message: 'Value cannot be empty',
+              rule: true,
+              type: 'required',
+            },
+          ],
         },
         output: {
           key: mockField.key,
@@ -561,6 +574,18 @@ describe('returnPhoneNumberCollector', () => {
           phoneNumber: '',
         },
         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,
@@ -580,8 +605,8 @@ describe('returnPhoneNumberCollector', () => {
       defaultCountryCode: 'US',
       label: 'Phone Number',
       type: 'PHONE_NUMBER',
-      required: true,
-      validatePhoneNumber: true,
+      required: false,
+      validatePhoneNumber: false,
     };
     const result = returnObjectValueCollector(mockField, 1, {});
     expect(result).toEqual({
@@ -616,8 +641,8 @@ describe('returnPhoneNumberCollector', () => {
       defaultCountryCode: 'US',
       label: 'Phone Number',
       type: 'PHONE_NUMBER',
-      required: true,
-      validatePhoneNumber: true,
+      required: false,
+      validatePhoneNumber: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       countryCode: 'CA',
@@ -657,8 +682,8 @@ describe('returnPhoneNumberCollector', () => {
       defaultCountryCode: null,
       label: 'Phone Number',
       type: 'PHONE_NUMBER',
-      required: true,
-      validatePhoneNumber: true,
+      required: false,
+      validatePhoneNumber: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       phoneNumber: '1234567890',
@@ -696,8 +721,8 @@ describe('returnPhoneNumberCollector', () => {
       defaultCountryCode: 'US',
       label: 'Phone Number',
       type: 'PHONE_NUMBER',
-      required: true,
-      validatePhoneNumber: true,
+      required: false,
+      validatePhoneNumber: false,
     };
     const prefillMock: PhoneNumberOutputValue = {
       countryCode: 'CA',
@@ -778,17 +803,40 @@ describe('Return collector validator', () => {
   const validatedTextCollector = {
     input: {
       validation: [
-        { type: 'required', message: 'This field is required' },
+        { type: 'required', message: 'This field is required', rule: true },
         { type: 'regex', message: 'Invalid format', rule: '^[a-zA-Z0-9]+$' },
       ],
     },
   } as ValidatedTextCollector;
 
+  const objectValueCollector = {
+    input: {
+      validation: [
+        { type: 'required', message: 'This field is required', rule: true },
+        { type: 'validatePhoneNumber', message: 'Phone number should be validated', rule: true },
+      ],
+    },
+  } as PhoneNumberCollector;
+
+  const multiValueCollector = {
+    input: {
+      validation: [{ type: 'required', message: 'This field is required', rule: true }],
+    },
+  } as MultiSelectCollector;
+
   const validator = returnValidator(validatedTextCollector);
+  const objValidator = returnValidator(objectValueCollector);
+  const multiValueValidator = returnValidator(multiValueCollector);
 
   it('should return an error message for required validation when value is empty', () => {
     const result = validator('');
     expect(result).toContain('This field is required');
+
+    const objResult = objValidator({});
+    expect(objResult).toContain('This field is required');
+
+    const multiValueResult = multiValueValidator({});
+    expect(multiValueResult).toContain('This field is required');
   });
 
   it('should return an error message for regex validation when value does not match the pattern', () => {
@@ -799,6 +847,12 @@ describe('Return collector validator', () => {
   it('should return no error messages when value passes all validations', () => {
     const result = validator('validValue123');
     expect(result).toEqual([]);
+
+    const objResult = objValidator({ countryCode: 'US', phoneNumber: '1234567890' });
+    expect(objResult).toEqual([]);
+
+    const multiValueResult = multiValueValidator(['a', 'b', 'c']);
+    expect(multiValueResult).toEqual([]);
   });
 
   it('should handle invalid regex patterns gracefully', () => {