fix(validateOptions): Remove deprecated API

We now have api-check to validate options for types. This dual api was not helpful.

BREAKING CHANGE: If you were using validateOptions, you'll need to switch to apiCheck

Author: Kent C. Dodds

other/ERRORS_AND_WARNINGS.md

@@ -127,12 +127,6 @@ of the expression, the scope you're passed wont have all the properties you may
 See documentation [here](http://docs.angular-formly.com/docs/field-configuration-object#hideexpression-string--function)
 and an example [here](http://angular-formly.com/#/example/field-options/hide-fields)
 
-# validateOptions deprecated
-
-Because angular-formly already has a dependency on `api-check` and this is just a better way to validate your options,
-you should use this method instead. In an effort to simplify things. This has been deprecated in favor of the `apiCheck`
-property.
-
 # skipNgModelAttrsManipulator moved
 
 This property has been moved from the `data` property to the `extras` property.

src/directives/formly-field.js

@@ -564,7 +564,6 @@ function formlyField($http, $q, $compile, $templateCache, $interpolate, formlyCo
 
       wrapper.forEach((aWrapper) => {
         formlyUsability.checkWrapper(aWrapper, options);
-        aWrapper.validateOptions && aWrapper.validateOptions(options);
         runApiCheck(aWrapper, options);
       });
       const promises = wrapper.map(w => getTemplate(w.template || w.templateUrl, !w.template));
@@ -639,9 +638,6 @@ function formlyField($http, $q, $compile, $templateCache, $interpolate, formlyCo
     // validate with the type
     const type = options.type && formlyConfig.getType(options.type);
     if (type) {
-      if (type.validateOptions) {
-        type.validateOptions(options);
-      }
       runApiCheck(type, options, true);
     }
     if (options.expressionProperties && options.expressionProperties.hide) {

src/directives/formly-field.test.js

@@ -102,15 +102,12 @@ describe('formly-field', function() {
 
 
   describe('api check', () => {
-    let validateOptions;
     beforeEach(() => {
       /* eslint no-console:0 */
       const originalWarn = console.warn;
       console.warn = () => {};
-      validateOptions = sinon.spy();
       formlyConfig.setType({
-        name: 'text', template: `<input name="{{id}}" ng-model="model[options.key]" />`,
-        validateOptions
+        name: 'text', template: `<input name="{{id}}" ng-model="model[options.key]" />`
       });
       scope.model = {};
       console.warn = originalWarn;
@@ -127,13 +124,6 @@ describe('formly-field', function() {
 
       expect(() => compileAndDigest()).to.throw(/extra.*properties.*extraProp/);
     });
-
-    it(`should invoke the validateOptions property of the type`, () => {
-      const field = {type: 'text'};
-      scope.fields = [field];
-      compileAndDigest();
-      expect(validateOptions).to.have.been.calledWith(field);
-    });
   });
 
   describe('default type options', () => {

src/providers/formlyApiCheck.js

@@ -49,7 +49,6 @@ const formlyWrapperType = apiCheck.shape({
   templateUrl: apiCheck.shape.ifNot('template', apiCheck.string).optional,
   types: apiCheck.typeOrArrayOf(apiCheck.string).optional,
   overwriteOk: apiCheck.bool.optional,
-  validateOptions: apiCheck.func.optional,
   apiCheck: apiCheckProperty.optional,
   apiCheckInstance: apiCheckInstanceProperty.optional,
   apiCheckFunction: apiCheckFunctionProperty.optional,
@@ -204,7 +203,6 @@ const formlyTypeOptions = apiCheck.shape({
   extends: apiCheck.string.optional,
   wrapper: specifyWrapperType.optional,
   data: apiCheck.object.optional,
-  validateOptions: apiCheck.func.optional,
   apiCheck: apiCheckProperty.optional,
   apiCheckInstance: apiCheckInstanceProperty.optional,
   apiCheckFunction: apiCheckFunctionProperty.optional,

src/providers/formlyConfig.js

@@ -61,7 +61,6 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
       prefix: 'formlyConfig.setType',
       url: 'settype-validation-failed'
     });
-    checkDeprecatedOptions(options);
     if (!options.overwriteOk) {
       checkOverwrite(options.name, typeMap, options, 'types');
     } else {
@@ -73,7 +72,6 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     const extendsType = getType(options.extends, true, options);
     extendTypeControllerFunction(options, extendsType);
     extendTypeLinkFunction(options, extendsType);
-    extendTypeValidateOptionsFunction(options, extendsType);
     extendTypeDefaultOptions(options, extendsType);
     utils.reverseDeepMerge(options, extendsType);
     extendTemplate(options, extendsType);
@@ -120,31 +118,6 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     }
   }
 
-  function extendTypeValidateOptionsFunction(options, extendsType) {
-    const extendsFn = extendsType.validateOptions;
-    if (!angular.isDefined(extendsFn)) {
-      return;
-    }
-    const optionsFn = options.validateOptions;
-    const originalDefaultOptions = options.defaultOptions;
-    if (angular.isDefined(optionsFn)) {
-      options.validateOptions = function(opts) {
-        optionsFn(opts);
-        const mergedOptions = angular.copy(opts);
-        let defaultOptions = originalDefaultOptions;
-        if (defaultOptions) {
-          if (angular.isFunction(defaultOptions)) {
-            defaultOptions = defaultOptions(mergedOptions);
-          }
-          utils.reverseDeepMerge(mergedOptions, defaultOptions);
-        }
-        extendsFn(mergedOptions);
-      };
-    } else {
-      options.validateOptions = extendsFn;
-    }
-  }
-
   function extendTypeDefaultOptions(options, extendsType) {
     const extendsDO = extendsType.defaultOptions;
     if (!angular.isDefined(extendsDO)) {
@@ -241,7 +214,6 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     if (options.template) {
       formlyUsabilityProvider.checkWrapperTemplate(options.template, options);
     }
-    checkDeprecatedOptions(options);
     if (!options.overwriteOk) {
       checkOverwrite(options.name, templateWrappersMap, options, 'templateWrappers');
     } else {
@@ -267,17 +239,6 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     }
   }
 
-  function checkDeprecatedOptions(options) {
-    if (options.validateOptions) {
-      warn(
-        'validateoptions-deprecated',
-        'the `validateOptions` property has been deprecated.',
-        `Attempted for type: ${options.name}`,
-        options
-      );
-    }
-  }
-
   function getWrapper(name) {
     return templateWrappersMap[name || defaultWrapperName];
   }

src/providers/formlyConfig.test.js

@@ -424,85 +424,6 @@ describe('formlyConfig', () => {
 
         });
 
-        describe(`validateOptions functions`, () => {
-          let options, parentFn, childFn;
-          beforeEach(() => {
-            options = {
-              data: {
-                a: 'b',
-                c: {d: 'e'}
-              }
-            };
-            parentFn = sinon.spy();
-            childFn = sinon.spy();
-          });
-
-          it(`should give a deprecation warning when specified as part of a type`, () => {
-            shouldWarn(
-              /Formly Warning: the `validateOptions` property has been deprecated. Attempted for type: foobar/,
-              function() {
-                setterFn({
-                  name: 'foobar',
-                  validateOptions() {}
-                });
-              }
-            );
-          });
-
-          describe(`old functionality`, () => {
-            let originalWarn;
-            beforeEach(() => {
-              originalWarn = console.warn;
-              console.warn = () => {};
-            });
-
-            it(`should call the parent validateOptions function when there is no child function`, () => {
-              setterFn([
-                {name, template, validateOptions: parentFn},
-                {name: 'type2', extends: name}
-              ]);
-              getterFn('type2').validateOptions(options);
-              expect(parentFn).to.have.been.calledWith(options);
-            });
-
-            it(`should call the child validateOptions function when there is no parent function`, () => {
-              setterFn([
-                {name, template},
-                {name: 'type2', extends: name, validateOptions: childFn}
-              ]);
-              getterFn('type2').validateOptions(options);
-              expect(childFn).to.have.been.calledWith(options);
-            });
-
-            it(`should call the child validateOptions function and the parent validateOptions function when they are both present`, () => {
-              setterFn([
-                {name, template, validateOptions: parentFn},
-                {name: 'type2', extends: name, validateOptions: childFn}
-              ]);
-              getterFn('type2').validateOptions(options);
-              expect(childFn).to.have.been.calledWith(options);
-              expect(parentFn).to.have.been.calledWith(options);
-            });
-
-            it(`should pass the result of the child's defaultOptions with the given options to the parent's validateOptions function`, () => {
-              const defaultOptions = {data: {f: 'g'}};
-              const combinedOptions = {data: {a: 'b', c: {d: 'e'}, f: 'g'}};
-              setterFn([
-                {name, template, validateOptions: parentFn},
-                {name: 'type2', extends: name, validateOptions: childFn, defaultOptions}
-              ]);
-              getterFn('type2').validateOptions(options);
-              expect(childFn).to.have.been.calledWith(options);
-              expect(parentFn).to.have.been.calledWith(combinedOptions);
-            });
-
-            afterEach(() => {
-              console.warn = originalWarn;
-            });
-          });
-
-        });
-
         describe(`controller functions`, () => {
           let parentFn, childFn, $controller, $scope;
           beforeEach(inject(($rootScope, _$controller_) => {