@remoteoss/json-schema-form 0.4.0-beta.0 → 0.4.1-dev.20230703082439

package/src/tests/createHeadlessForm.test.js

@@ -10,6 +10,8 @@ import {
   schemaInputTypeRadioDeprecated,
   schemaInputTypeRadio,
   schemaInputTypeRadioRequiredAndOptional,
+  schemaInputRadioOptionalNull,
+  schemaInputRadioOptionalConventional,
   schemaInputTypeRadioOptionsWithDetails,
   schemaInputTypeSelectSoloDeprecated,
   schemaInputTypeSelectSolo,
@@ -45,6 +47,7 @@ import {
   mockNestedFieldset,
   mockGroupArrayInput,
   schemaFieldsetScopedCondition,
+  schemaWithConditionalToFieldset,
   schemaWithConditionalPresentationProperties,
   schemaWithConditionalReadOnlyProperty,
   schemaWithWrongConditional,
@@ -77,6 +80,17 @@ function friendlyError({ formErrors }) {
   return formErrors;
 }
 
+// Get a field by name recursively
+// eg getField(demo, "age") -> returns "age" field
+// eg getField(demo, child, name) -> returns "child.name" subfield
+const getField = (fields, name, ...subNames) => {
+  const field = fields.find((f) => f.name === name);
+  if (subNames.length > 0) {
+    return getField(field.fields, ...subNames);
+  }
+  return field;
+};
+
 beforeEach(() => {
   jest.spyOn(console, 'error').mockImplementation(() => {});
 });
@@ -420,6 +434,45 @@ describe('createHeadlessForm', () => {
   });
 
   describe('field support', () => {
+    function assertOptionsAllowed({ handleValidation, fieldName, validOptions }) {
+      const validateForm = (vals) => friendlyError(handleValidation(vals));
+
+      // All allowed options are valid
+      validOptions.forEach((value) => {
+        expect(
+          validateForm({
+            [fieldName]: value,
+          })
+        ).toBeUndefined();
+      });
+
+      // Any other arbitrary value is not valid.
+      expect(
+        validateForm({
+          [fieldName]: 'blah-blah',
+        })
+      ).toEqual({
+        [fieldName]: 'The option "blah-blah" is not valid.',
+      });
+
+      // This is a required field:
+      expect(validateForm({})).toEqual({
+        [fieldName]: 'Required field',
+      });
+
+      // As required field, empty string ("") is also considered empty. @BUG RMT-518
+      // Expectation: The error to be "The option '' is not valid."
+      expect(validateForm({ [fieldName]: '' })).toEqual({
+        [fieldName]: 'Required field',
+      });
+
+      // As required field, null is also considered empty @BUG RMT-518
+      // Expectation: The error to be "The option null is not valid."
+      expect(validateForm({ [fieldName]: null })).toEqual({
+        [fieldName]: 'Required field',
+      });
+    }
+
     it('support "text" field type', () => {
       const { fields, handleValidation } = createHeadlessForm(schemaInputTypeText);
 
@@ -522,38 +575,43 @@ describe('createHeadlessForm', () => {
     });
 
     it('support "select" field type @deprecated', () => {
-      const result = createHeadlessForm(schemaInputTypeSelectSoloDeprecated);
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeSelectSoloDeprecated);
 
-      expect(result).toMatchObject({
-        fields: [
-          {
-            description: 'Life Insurance',
-            label: 'Benefits (solo)',
-            name: 'benefits',
-            placeholder: 'Select...',
-            type: 'select',
-            options: [
-              {
-                label: 'Medical Insurance',
-                value: 'Medical Insurance',
-              },
-              {
-                label: 'Health Insurance',
-                value: 'Health Insurance',
-              },
-              {
-                label: 'Travel Bonus',
-                value: 'Travel Bonus',
-              },
-            ],
-          },
-        ],
+      expect(fields).toMatchObject([
+        {
+          description: 'Life Insurance',
+          label: 'Benefits (solo)',
+          name: 'benefits',
+          placeholder: 'Select...',
+          type: 'select',
+          options: [
+            {
+              label: 'Medical Insurance',
+              value: 'Medical Insurance',
+            },
+            {
+              label: 'Health Insurance',
+              value: 'Health Insurance',
+            },
+            {
+              label: 'Travel Bonus',
+              value: 'Travel Bonus',
+            },
+          ],
+        },
+      ]);
+
+      assertOptionsAllowed({
+        handleValidation,
+        fieldName: 'benefits',
+        validOptions: ['Medical Insurance', 'Health Insurance', 'Travel Bonus'],
       });
     });
+
     it('support "select" field type', () => {
-      const result = createHeadlessForm(schemaInputTypeSelectSolo);
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeSelectSolo);
 
-      const fieldSelect = result.fields[0];
+      const fieldSelect = fields[0];
       expect(fieldSelect).toMatchObject({
         name: 'browsers',
         label: 'Browsers (solo)',
@@ -576,6 +634,12 @@ describe('createHeadlessForm', () => {
       });
 
       expect(fieldSelect).not.toHaveProperty('multiple');
+
+      assertOptionsAllowed({
+        handleValidation,
+        fieldName: 'browsers',
+        validOptions: ['chr', 'ff', 'ie'],
+      });
     });
 
     it('supports "select" field type with multiple options @deprecated', () => {
@@ -666,96 +730,149 @@ describe('createHeadlessForm', () => {
     });
 
     it('support "radio" field type @deprecated', () => {
-      const result = createHeadlessForm(schemaInputTypeRadioDeprecated);
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeRadioDeprecated);
 
-      expect(result).toMatchObject({
-        fields: [
-          {
-            description: 'Do you have any siblings?',
-            label: 'Has siblings',
-            name: 'has_siblings',
-            options: [
-              {
-                label: 'Yes',
-                value: 'yes',
-              },
-              {
-                label: 'No',
-                value: 'no',
-              },
-            ],
-            required: true,
-            schema: expect.any(Object),
-            type: 'radio',
-          },
-        ],
-      });
+      expect(fields).toMatchObject([
+        {
+          description: 'Do you have any siblings?',
+          label: 'Has siblings',
+          name: 'has_siblings',
+          options: [
+            {
+              label: 'Yes',
+              value: 'yes',
+            },
+            {
+              label: 'No',
+              value: 'no',
+            },
+          ],
+          required: true,
+          schema: expect.any(Object),
+          type: 'radio',
+        },
+      ]);
 
-      const fieldValidator = result.fields[0].schema;
-      expect(fieldValidator.isValidSync('yes')).toBe(true);
-      expect(() => fieldValidator.validateSync('')).toThrowError('Required field');
+      assertOptionsAllowed({
+        handleValidation,
+        fieldName: 'has_siblings',
+        validOptions: ['yes', 'no'],
+      });
     });
     it('support "radio" field type', () => {
-      const result = createHeadlessForm(schemaInputTypeRadio);
+      const { fields, handleValidation } = createHeadlessForm(schemaInputTypeRadio);
 
-      expect(result).toMatchObject({
-        fields: [
-          {
-            description: 'Do you have any siblings?',
-            label: 'Has siblings',
-            name: 'has_siblings',
-            options: [
-              {
-                label: 'Yes',
-                value: 'yes',
-              },
-              {
-                label: 'No',
-                value: 'no',
-              },
-            ],
-            required: true,
-            schema: expect.any(Object),
-            type: 'radio',
-          },
-        ],
-      });
+      expect(fields).toMatchObject([
+        {
+          description: 'Do you have any siblings?',
+          label: 'Has siblings',
+          name: 'has_siblings',
+          options: [
+            {
+              label: 'Yes',
+              value: 'yes',
+            },
+            {
+              label: 'No',
+              value: 'no',
+            },
+          ],
+          required: true,
+          schema: expect.any(Object),
+          type: 'radio',
+        },
+      ]);
 
-      const fieldValidator = result.fields[0].schema;
-      expect(fieldValidator.isValidSync('yes')).toBe(true);
-      expect(() => fieldValidator.validateSync('')).toThrowError('Required field');
+      assertOptionsAllowed({
+        handleValidation,
+        fieldName: 'has_siblings',
+        validOptions: ['yes', 'no'],
+      });
     });
 
     it('support "radio" optional field', () => {
-      const result = createHeadlessForm(schemaInputTypeRadioRequiredAndOptional);
+      const { fields, handleValidation } = createHeadlessForm(
+        schemaInputTypeRadioRequiredAndOptional
+      );
+      const validateForm = (vals) => friendlyError(handleValidation(vals));
 
-      expect(result).toMatchObject({
-        fields: [
-          {},
-          {
-            name: 'has_car',
-            label: 'Has car',
-            description: 'Do you have a car? (optional field, check oneOf)',
-            options: [
-              {
-                label: 'Yes',
-                value: 'yes',
-              },
-              {
-                label: 'No',
-                value: 'no',
-              },
-            ],
-            required: false,
-            schema: expect.any(Object),
-            type: 'radio',
-          },
-        ],
+      expect(fields).toMatchObject([
+        {},
+        {
+          name: 'has_car',
+          label: 'Has car',
+          description: 'Do you have a car? (optional field, check oneOf)',
+          options: [
+            {
+              label: 'Yes',
+              value: 'yes',
+            },
+            {
+              label: 'No',
+              value: 'no',
+            },
+          ],
+          required: false,
+          schema: expect.any(Object),
+          type: 'radio',
+        },
+      ]);
+
+      expect(
+        validateForm({
+          has_siblings: 'yes',
+          has_car: 'yes',
+        })
+      ).toBeUndefined();
+      expect(validateForm({})).toEqual({
+        has_siblings: 'Required field',
       });
+    });
 
-      const fieldValidator = result.fields[0].schema;
-      expect(fieldValidator.isValidSync('yes')).toBe(true);
-      expect(() => fieldValidator.validateSync('')).toThrowError('Required field');
+    describe('support "radio" optional field - more examples @BUG RMT-518', () => {
+      function assertCommonBehavior(validateForm) {
+        // Happy path
+        expect(validateForm({ has_car: 'yes' })).toBeUndefined();
+
+        // Accepts undefined field
+        expect(validateForm({})).toBeUndefined();
+
+        // Does not accept other values
+        expect(validateForm({ has_car: 'blah-blah' })).toEqual({
+          has_car: 'The option "blah-blah" is not valid.',
+        });
+
+        // Does not accept "null" as string
+        expect(validateForm({ has_car: 'null' })).toEqual({
+          has_car: 'The option "null" is not valid.',
+        });
+
+        // Accepts empty string ("") — @BUG RMT-518
+        // Expectation: Does not accept empty string ("")
+        expect(validateForm({ has_car: '' })).toBeUndefined();
+      }
+
+      it('with null option (as Remote)', () => {
+        const { handleValidation } = createHeadlessForm(schemaInputRadioOptionalNull);
+        const validateForm = (vals) => friendlyError(handleValidation(vals));
+
+        assertCommonBehavior(validateForm);
+
+        // Accepts null value
+        expect(validateForm({ has_car: null })).toBeUndefined();
+      });
+
+      it('without null option (conventional way)', () => {
+        const { handleValidation } = createHeadlessForm(schemaInputRadioOptionalConventional);
+        const validateForm = (vals) => friendlyError(handleValidation(vals));
+
+        assertCommonBehavior(validateForm);
+
+        // Does NOT accept null value
+        expect(validateForm({ has_car: null })).toEqual({
+          has_car: 'The option null is not valid.',
+        });
+      });
     });
 
     it('support "radio" field type with extra info inside each option', () => {
@@ -1182,46 +1299,6 @@ describe('createHeadlessForm', () => {
       });
     });
 
-    it('supports "fieldset" field type', () => {
-      const result = createHeadlessForm(
-        JSONSchemaBuilder()
-          .addInput({
-            fieldset: mockFieldset,
-          })
-          .build()
-      );
-
-      expect(result).toMatchObject({
-        fields: [
-          {
-            description: 'Fieldset description',
-            label: 'Fieldset title',
-            name: 'fieldset',
-            type: 'fieldset',
-            required: false,
-            fields: [
-              {
-                description: 'The number of your national identification (max 10 digits)',
-                label: 'ID number',
-                name: 'id_number',
-                type: 'text',
-                required: true,
-              },
-              {
-                description: 'How many open tabs do you have?',
-                label: 'Tabs',
-                maximum: 10,
-                minimum: 1,
-                name: 'tabs',
-                type: 'number',
-                required: false,
-              },
-            ],
-          },
-        ],
-      });
-    });
-
     it('supports "radio" field type with its "card" and "card-expandable" variants', () => {
       const result = createHeadlessForm(
         JSONSchemaBuilder()
@@ -1287,130 +1364,298 @@ describe('createHeadlessForm', () => {
       });
     });
 
-    it('supports nested "fieldset" field type', () => {
-      const result = createHeadlessForm(
-        JSONSchemaBuilder()
-          .addInput({
-            nestedFieldset: mockNestedFieldset,
-          })
-          .build()
-      );
-
-      expect(result).toMatchObject({
-        fields: [
-          {
-            label: 'Nested fieldset title',
-            description: 'Nested fieldset description',
-            name: 'nestedFieldset',
-            type: 'fieldset',
-            required: false,
-            fields: [
-              {
-                description: 'Fieldset description',
-                label: 'Fieldset title',
-                name: 'innerFieldset',
-                type: 'fieldset',
-                required: false,
-                fields: [
-                  {
-                    description: 'The number of your national identification (max 10 digits)',
-                    label: 'ID number',
-                    name: 'id_number',
-                    type: 'text',
-                    required: true,
-                  },
-                  {
-                    description: 'How many open tabs do you have?',
-                    label: 'Tabs',
-                    maximum: 10,
-                    minimum: 1,
-                    name: 'tabs',
-                    type: 'number',
-                    required: false,
-                  },
-                ],
-              },
-            ],
+    describe('supports "fieldset" field type', () => {
+      it('supports basic case', () => {
+        const result = createHeadlessForm({
+          properties: {
+            fieldset: mockFieldset,
           },
-        ],
+        });
+
+        expect(result).toMatchObject({
+          fields: [
+            {
+              description: 'Fieldset description',
+              label: 'Fieldset title',
+              name: 'fieldset',
+              type: 'fieldset',
+              required: false,
+              fields: [
+                {
+                  description: 'The number of your national identification (max 10 digits)',
+                  label: 'ID number',
+                  name: 'id_number',
+                  type: 'text',
+                  required: true,
+                },
+                {
+                  description: 'How many open tabs do you have?',
+                  label: 'Tabs',
+                  maximum: 10,
+                  minimum: 1,
+                  name: 'tabs',
+                  type: 'number',
+                  required: false,
+                },
+              ],
+            },
+          ],
+        });
       });
-    });
 
-    it('supported "fieldset" with scoped conditionals', () => {
-      const { handleValidation } = createHeadlessForm(schemaFieldsetScopedCondition, {});
-      const validateForm = (vals) => friendlyError(handleValidation(vals));
+      it('supports nested fieldset (fieldset inside fieldset)', () => {
+        const result = createHeadlessForm(
+          JSONSchemaBuilder()
+            .addInput({
+              nestedFieldset: mockNestedFieldset,
+            })
+            .build()
+        );
 
-      // The "child.has_child" is required
-      expect(validateForm({})).toEqual({
-        child: {
-          has_child: 'Required field',
-        },
+        expect(result).toMatchObject({
+          fields: [
+            {
+              label: 'Nested fieldset title',
+              description: 'Nested fieldset description',
+              name: 'nestedFieldset',
+              type: 'fieldset',
+              required: false,
+              fields: [
+                {
+                  description: 'Fieldset description',
+                  label: 'Fieldset title',
+                  name: 'innerFieldset',
+                  type: 'fieldset',
+                  required: false,
+                  fields: [
+                    {
+                      description: 'The number of your national identification (max 10 digits)',
+                      label: 'ID number',
+                      name: 'id_number',
+                      type: 'text',
+                      required: true,
+                    },
+                    {
+                      description: 'How many open tabs do you have?',
+                      label: 'Tabs',
+                      maximum: 10,
+                      minimum: 1,
+                      name: 'tabs',
+                      type: 'number',
+                      required: false,
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        });
       });
 
-      // The "child.no" is valid
-      expect(
-        validateForm({
+      it('supported "fieldset" with scoped conditionals', () => {
+        const { handleValidation } = createHeadlessForm(schemaFieldsetScopedCondition, {});
+        const validateForm = (vals) => friendlyError(handleValidation(vals));
+
+        // The "child.has_child" is required
+        expect(validateForm({})).toEqual({
           child: {
-            has_child: 'no',
+            has_child: 'Required field',
           },
-        })
-      ).toBeUndefined();
+        });
 
-      // Invalid because it expect child.age too
-      expect(
-        validateForm({
+        // The "child.no" is valid
+        expect(
+          validateForm({
+            child: {
+              has_child: 'no',
+            },
+          })
+        ).toBeUndefined();
+
+        // Invalid because it expect child.age too
+        expect(
+          validateForm({
+            child: {
+              has_child: 'yes',
+            },
+          })
+        ).toEqual({
           child: {
-            has_child: 'yes',
+            age: 'Required field',
           },
-        })
-      ).toEqual({
-        child: {
-          age: 'Required field',
-        },
+        });
+
+        // Valid without optional child.passport_id
+        expect(
+          validateForm({
+            child: {
+              has_child: 'yes',
+              age: 15,
+            },
+          })
+        ).toBeUndefined();
+
+        // Valid with optional child.passport_id
+        expect(
+          validateForm({
+            child: {
+              has_child: 'yes',
+              age: 15,
+              passport_id: 'asdf',
+            },
+          })
+        ).toBeUndefined();
       });
 
-      // Valid without optional child.passport_id
-      expect(
-        validateForm({
-          child: {
-            has_child: 'yes',
-            age: 15,
-          },
-        })
-      ).toBeUndefined();
+      it('should set any nested "fieldset" form values to null when they are invisible', async () => {
+        const { handleValidation } = createHeadlessForm(schemaFieldsetScopedCondition, {});
+        const validateForm = (vals) => friendlyError(handleValidation(vals));
 
-      // Valid with optional child.passport_id
-      expect(
-        validateForm({
+        const formValues = {
           child: {
             has_child: 'yes',
             age: 15,
-            passport_id: 'asdf',
           },
-        })
-      ).toBeUndefined();
-    });
+        };
 
-    it('should set any nested "fieldset" form values to null when they are invisible', async () => {
-      const { handleValidation } = createHeadlessForm(schemaFieldsetScopedCondition, {});
-      const validateForm = (vals) => friendlyError(handleValidation(vals));
+        await expect(validateForm(formValues)).toBeUndefined();
+        expect(formValues.child.age).toBe(15);
 
-      const formValues = {
-        child: {
-          has_child: 'yes',
-          age: 15,
-        },
-      };
+        formValues.child.has_child = 'no';
+        // form value updates re-validate; see computeYupSchema()
+        await expect(validateForm(formValues)).toBeUndefined();
+
+        // when child.has_child is 'no' child.age is invisible
+        expect(formValues.child.age).toBe(null);
+      });
+
+      describe('supports conditionals to fieldsets', () => {
+        // To not mix the concepts:
+        // - Scoped conditionals: Conditionals written inside a fieldset
+        // - Conditionals to fieldsets: Root conditionals that affect a fieldset
+
+        // This describe has sequential tests, covering the following:
+        // If the working_hours > 30,
+        // Then the fieldset perks.food changes (the "no" option gets removed)
+
+        // Setup (arrange)
+        const { fields, handleValidation } = createHeadlessForm(schemaWithConditionalToFieldset);
+
+        const validateForm = (vals) => friendlyError(handleValidation(vals));
+        const originalFood = getField(fields, 'perks', 'food');
+
+        const perksForLowWorkHours = {
+          food: 'no', // this option will be removed when the condition happens.
+          retirement: 'basic',
+        };
+
+        it('by default, the Perks.food has 4 options', () => {
+          expect(originalFood.options).toHaveLength(4);
+          expect(originalFood.description).toBeUndefined();
+
+          // Ensure the perks are required
+          expect(validateForm({})).toEqual({
+            work_hours_per_week: 'Required field',
+            perks: {
+              food: 'Required field',
+              retirement: 'Required field',
+            },
+          });
+
+          // Given low work hours, the form is valid.
+          expect(
+            validateForm({
+              work_hours_per_week: 5,
+              perks: perksForLowWorkHours,
+            })
+          ).toBeUndefined();
+        });
+
+        it('Given a lot work hours, the perks.food options change', () => {
+          expect(
+            validateForm({
+              work_hours_per_week: 35,
+            })
+          ).toEqual({
+            pto: 'Required field', // Sanity-check - this field gets required too.
+            perks: {
+              food: 'Required field',
+              retirement: 'Required field',
+            },
+          });
+
+          // The fieldset changed!
+          const foodField = getField(fields, 'perks', 'food');
+          // perks.food options changed ("No" was removed)
+          expect(foodField.options).toHaveLength(3);
+
+          // Ensure the "no" option is no longer accepted:
+          // This is a very important test in case the UI fails for some reason.
+          expect(
+            validateForm({
+              work_hours_per_week: 35,
+              pto: 20,
+              perks: perksForLowWorkHours,
+            })
+          ).toEqual({
+            perks: {
+              food: 'The option "no" is not valid.',
+            },
+          });
+
+          // perks.food has a new description
+          expect(foodField.description).toBe("Above 30 hours, the 'no' option disappears.");
+          // pto has a new description
+          expect(getField(fields, 'pto').description).toBe(
+            'Above 30 hours, the PTO needs to be at least 20 days.'
+          );
+
+          // Sanity-check: Now the PTO also has a minimum value
+          expect(
+            validateForm({
+              work_hours_per_week: 35,
+              pto: 5, // too low
+              perks: { food: 'lunch', retirement: 'basic' },
+            })
+          ).toEqual({
+            pto: 'Must be greater or equal to 20',
+          });
+        });
+
+        it('When changing back to low work hours, the perks.food goes back to the original state', () => {
+          expect(
+            validateForm({
+              work_hours_per_week: 10,
+              pto: 5,
+            })
+          ).toEqual({
+            perks: {
+              food: 'Required field',
+              retirement: 'Required field',
+            },
+            // ...pto is minimum error is gone! (sanity-check)
+          });
 
-      await expect(validateForm(formValues)).toBeUndefined();
-      expect(formValues.child.age).toBe(15);
+          const foodField = getField(fields, 'perks', 'food');
+          // ...Number of perks.food options was back to the original (4)
+          expect(foodField.options).toHaveLength(4);
+          // ...Food description was back to the original
+          expect(foodField.description).toBeUndefined();
 
-      formValues.child.has_child = 'no';
-      // form value updates re-validate; see computeYupSchema()
-      await expect(validateForm(formValues)).toBeUndefined();
+          // @BUG RMT-58 PTO description should disappear, but it didn't.
+          expect(getField(fields, 'pto').description).toBe(
+            'Above 30 hours, the PTO needs to be at least 20 days.'
+          );
 
-      // when child.has_child is 'no' child.age is invisible
-      expect(formValues.child.age).toBe(null);
+          // Given again "low perks", the form valid.
+          expect(
+            validateForm({
+              work_hours_per_week: 10,
+              perks: perksForLowWorkHours,
+            })
+          ).toBeUndefined();
+        });
+      });
     });
 
     it('support "email" field type', () => {
@@ -1729,14 +1974,12 @@ describe('createHeadlessForm', () => {
         strictInputType: false,
       });
 
-      const getByName = (fieldList, name) => fieldList.find((f) => f.name === name);
-
-      const aFieldInRoot = getByName(fields, 'a_string');
+      const aFieldInRoot = getField(fields, 'a_string');
       // It's the entire json schema
       expect(aFieldInRoot.scopedJsonSchema).toEqual(schemaWithoutInputTypes);
 
-      const aFieldset = getByName(fields, 'a_object');
-      const aFieldInTheFieldset = getByName(aFieldset.fields, 'foo');
+      const aFieldset = getField(fields, 'a_object');
+      const aFieldInTheFieldset = getField(aFieldset.fields, 'foo');
 
       // It's only the json schema of that fieldset
       expect(aFieldInTheFieldset.scopedJsonSchema).toEqual(
@@ -2196,8 +2439,6 @@ describe('createHeadlessForm', () => {
   });
 
   describe('when a JSON Schema is provided', () => {
-    const getByName = (fields, name) => fields.find((f) => f.name === name);
-
     describe('and all fields are optional', () => {
       let handleValidation;
       const validateForm = (vals) => friendlyError(handleValidation(vals));
@@ -2604,23 +2845,23 @@ describe('createHeadlessForm', () => {
           const { fields } = createHeadlessForm(schemaWithConditionalReadOnlyProperty, {
             field_a: null,
           });
-          expect(getByName(fields, 'field_b').isVisible).toBe(false);
+          expect(getField(fields, 'field_b').isVisible).toBe(false);
         });
 
         it('given a match, runs "then" (turns visible and editable)', () => {
           const { fields } = createHeadlessForm(schemaWithConditionalReadOnlyProperty, {
             initialValues: { field_a: 'yes' },
           });
-          expect(getByName(fields, 'field_b').isVisible).toBe(true);
-          expect(getByName(fields, 'field_b').readOnly).toBe(false);
+          expect(getField(fields, 'field_b').isVisible).toBe(true);
+          expect(getField(fields, 'field_b').readOnly).toBe(false);
         });
 
         it('given a nested match, runs "else-then" (turns visible but readOnly)', () => {
           const { fields } = createHeadlessForm(schemaWithConditionalReadOnlyProperty, {
             initialValues: { field_a: 'no' },
           });
-          expect(getByName(fields, 'field_b').isVisible).toBe(true);
-          expect(getByName(fields, 'field_b').readOnly).toBe(true);
+          expect(getField(fields, 'field_b').isVisible).toBe(true);
+          expect(getField(fields, 'field_b').readOnly).toBe(true);
         });
       });
 
@@ -2632,26 +2873,26 @@ describe('createHeadlessForm', () => {
             initialValues: { field_a: null, field_a_wrong: null },
           });
           // The dependent correct field gets hidden, but...
-          expect(getByName(fieldsEmpty, 'field_b').isVisible).toBe(false);
+          expect(getField(fieldsEmpty, 'field_b').isVisible).toBe(false);
           // ...the dependent wrong field stays visible because the
           // conditional is wrong (it's missing the if.required[])
-          expect(getByName(fieldsEmpty, 'field_b_wrong').isVisible).toBe(true);
+          expect(getField(fieldsEmpty, 'field_b_wrong').isVisible).toBe(true);
         });
 
         it('given a match ("yes"), both runs "then" (turn visible)', () => {
           const { fields: fieldsVisible } = createHeadlessForm(schemaWithWrongConditional, {
             initialValues: { field_a: 'yes', field_a_wrong: 'yes' },
           });
-          expect(getByName(fieldsVisible, 'field_b').isVisible).toBe(true);
-          expect(getByName(fieldsVisible, 'field_b_wrong').isVisible).toBe(true);
+          expect(getField(fieldsVisible, 'field_b').isVisible).toBe(true);
+          expect(getField(fieldsVisible, 'field_b_wrong').isVisible).toBe(true);
         });
 
         it('not given a match ("no"), both run else (stay hidden)', () => {
           const { fields: fieldsHidden } = createHeadlessForm(schemaWithWrongConditional, {
             initialValues: { field_a: 'no', field_a_wrong: 'no' },
           });
-          expect(getByName(fieldsHidden, 'field_b').isVisible).toBe(false);
-          expect(getByName(fieldsHidden, 'field_b_wrong').isVisible).toBe(false);
+          expect(getField(fieldsHidden, 'field_b').isVisible).toBe(false);
+          expect(getField(fieldsHidden, 'field_b_wrong').isVisible).toBe(false);
         });
       });
 
@@ -2661,7 +2902,7 @@ describe('createHeadlessForm', () => {
             field_a: 'no',
           },
         });
-        const dependentField = getByName(fields, 'field_b');
+        const dependentField = getField(fields, 'field_b');
         expect(dependentField.isVisible).toBe(false);
         expect(dependentField.value).toBe(undefined);
       });
@@ -2672,7 +2913,7 @@ describe('createHeadlessForm', () => {
             field_a: 'yes',
           },
         });
-        const dependentField = getByName(fields, 'field_b');
+        const dependentField = getField(fields, 'field_b');
         expect(dependentField.isVisible).toBe(true);
         expect(dependentField.value).toBe(undefined);
       });