fix: adjusts namespaces and call signatures of "isValid" utils

Author: artem-zakharchenko

lib/units/isValid.js

@@ -1,14 +1,23 @@
-function isValidComponent(errors) {
+/**
+ * Concludes HTTP message's component validity based on the given
+ * list of validation errors.
+ * @param {Object<string, any>} errors
+ * @returns {boolean}
+ */
+function isValidField({ errors }) {
   return errors.length === 0;
 }
 
-// Returns a boolean indicating whether a given validation result
-// concludes two HTTP messages as valid (matching).
-// Separated into its own util only to be used in both next and legacy API.
-function isValid(validationResult) {
-  return Object.values(validationResult.fields).every((resultGroup) => {
-    return isValidComponent(resultGroup.errors);
-  });
+/**
+ * Returns a boolean indicating the given validation result as valid.
+ * @param {Object<string, any>} validationResult
+ * @returns {boolean}
+ */
+function isValidResult(validationResult) {
+  return Object.values(validationResult.fields).every(isValidField);
 }
 
-module.exports = { isValid, isValidComponent };
+module.exports = {
+  isValidResult,
+  isValidField
+};

lib/units/validateBody.js

@@ -3,7 +3,7 @@ const mediaTyper = require('media-typer');
 const contentTypeUtils = require('content-type');
 
 const { TextDiff, JsonExample, JsonSchema } = require('../validators');
-const { isValidComponent } = require('./isValid');
+const { isValidField } = require('./isValid');
 
 function isPlainText(mediaType) {
   return mediaType.type === 'text' && mediaType.subtype === 'plain';
@@ -214,7 +214,7 @@ function validateBody(expected, real) {
   errors.push(...validationErrors);
 
   return {
-    isValid: isValidComponent(errors),
+    isValid: isValidField({ errors }),
     validator: ValidatorClass && ValidatorClass.name,
     realType: mediaTyper.format(realType),
     expectedType: mediaTyper.format(expectedType),

lib/units/validateHeaders.js

@@ -1,5 +1,5 @@
 const { HeadersJsonExample } = require('../validators');
-const { isValidComponent } = require('./isValid');
+const { isValidField } = require('./isValid');
 
 const APIARY_JSON_HEADER_TYPE = 'application/vnd.apiary.http-headers+json';
 
@@ -42,7 +42,7 @@ and expected data media type
   }
 
   return {
-    isValid: isValidComponent(errors),
+    isValid: isValidField({ errors }),
     validator: validator && 'HeadersJsonExample',
     realType,
     expectedType,

lib/validate.js

@@ -1,7 +1,7 @@
 const isset = require('./utils/isset');
 const { coerce, coerceWeak } = require('./units/coerce');
 const { normalize } = require('./units/normalize');
-const { isValid } = require('./units/isValid');
+const { isValidResult } = require('./units/isValid');
 const { validateMethod } = require('./units/validateMethod');
 const { validateURI } = require('./units/validateURI');
 const { validateStatusCode } = require('./units/validateStatusCode');
@@ -47,7 +47,7 @@ function validate(expectedMessage, realMessage) {
   }
 
   // Indicates the validity of the real message
-  result.isValid = isValid(result);
+  result.isValid = isValidResult(result);
 
   return result;
 }