feat(json-schema): add enum validator

fix #3723, #3714
ngx-formly · Sep 16, 2023 · 087f35c · 087f35c
1 parent 0bf7676
commit 087f35c
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/demo/src/app/examples/advanced/json-schema/app.module.ts b/demo/src/app/examples/advanced/json-schema/app.module.ts
@@ -77,6 +77,7 @@ export function typeValidationMessage({ schemaType }: any) {
         { name: 'maxItems', message: maxItemsValidationMessage },
         { name: 'uniqueItems', message: 'should NOT have duplicate items' },
         { name: 'const', message: constValidationMessage },
+        { name: 'enum', message: `must be equal to one of the allowed values` },
       ],
       types: [
         { name: 'null', component: NullTypeComponent, wrappers: ['form-field'] },

diff --git a/src/core/json-schema/src/formly-json-schema.service.spec.ts b/src/core/json-schema/src/formly-json-schema.service.spec.ts
@@ -797,6 +797,20 @@ describe('Service: FormlyJsonschema', () => {
             expect(props.multiple).toBeTrue();
           });
         });
+
+        it('should add enum validator', () => {
+          const schema: JSONSchema7 = {
+            type: 'integer',
+            enum: [1, 2, 3],
+          };
+          const config = formlyJsonschema.toFieldConfig(schema);
+
+          const enumValidators = config.validators.enum;
+          expect(enumValidators).toBeDefined();
+          expect(enumValidators(new FormControl(4))).toBeFalse();
+          expect(enumValidators(new FormControl(5))).toBeFalse();
+          expect(enumValidators(new FormControl(1))).toBeTrue();
+        });
       });
 
       it('should support const as hidden', () => {

diff --git a/src/core/json-schema/src/formly-json-schema.service.ts b/src/core/json-schema/src/formly-json-schema.service.ts
@@ -411,9 +411,25 @@ export class FormlyJsonschema {
     }
 
     if (this.isEnum(schema)) {
-      field.props.multiple = field.type === 'array';
+      const enumOptions = this.toEnumOptions(schema);
+      const multiple = field.type === 'array';
+
       field.type = 'enum';
-      field.props.options = this.toEnumOptions(schema);
+      field.props.multiple = multiple;
+      field.props.options = enumOptions;
+
+      const enumValues = enumOptions.map((o) => o.value);
+      this.addValidator(field, 'enum', ({ value }: AbstractControl) => {
+        if (value === undefined) {
+          return true;
+        }
+
+        if (multiple) {
+          return Array.isArray(value) ? value.every((o) => enumValues.includes(o)) : false;
+        }
+
+        return enumValues.includes(value);
+      });
     }
 
     if (schema.oneOf && !field.type) {