@percy/config 1.30.9-beta.2 → 1.30.9-beta.3

package/dist/validate.js

@@ -184,8 +184,8 @@ function shouldHideError(key, path, error) {
 
 // Validates data according to the associated schema and returns a list of errors, if any.
 export function validate(data, key = '/config') {
+  let errors = new Map();
   if (!ajv.validate(key, data)) {
-    let errors = new Map();
     for (let error of ajv.errors) {
       var _parentSchema$errors2;
       let {
@@ -242,12 +242,55 @@ export function validate(data, key = '/config') {
         message
       });
     }
-
     // filter empty values as a result of scrubbing
     filterEmpty(data);
-
-    // return an array of errors
-    return Array.from(errors.values());
   }
+  if (data.regions && Array.isArray(data.regions)) {
+    data.regions.forEach((region, index) => {
+      /* istanbul ignore next */
+      if (region.elementSelector) {
+        const selectorKeys = ['elementCSS', 'elementXpath', 'boundingBox'];
+        const providedKeys = selectorKeys.filter(key => region.elementSelector[key] !== undefined);
+        if (providedKeys.length !== 1) {
+          const pathStr = `regions[${index}].elementSelector`;
+          errors.set(pathStr, {
+            path: pathStr,
+            message: "Exactly one of 'elementCSS', 'elementXpath', or 'boundingBox' must be provided."
+          });
+          delete data.regions[index];
+        }
+      } else {
+        if (region.algorithm === 'ignore') {
+          const pathStr = `regions[${index}].elementSelector`;
+          errors.set(pathStr, {
+            path: pathStr,
+            message: "'elementSelector' is required when algorithm is 'ignore'."
+          });
+          delete data.regions[index];
+        }
+      }
+      const algorithmType = region.algorithm;
+      const hasConfiguration = region.configuration !== undefined;
+      if (algorithmType === 'layout' || algorithmType === 'ignore') {
+        if (hasConfiguration) {
+          const pathStr = `regions[${index}].configuration`;
+          errors.set(pathStr, {
+            path: pathStr,
+            message: `Configuration is not applicable for '${algorithmType}' algorithm`
+          });
+          delete data.regions[index];
+        }
+      }
+      if ((algorithmType === 'standard' || algorithmType === 'intelliignore') && !hasConfiguration) {
+        const pathStr = `regions[${index}]`;
+        errors.set(pathStr, {
+          path: pathStr,
+          message: `Configuration is recommended for '${algorithmType}' algorithm`
+        });
+      }
+    });
+  }
+  const errorArray = Array.from(errors.values());
+  return errorArray.length > 0 ? errorArray : undefined;
 }
 export default validate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/config",
-  "version": "1.30.9-beta.2",
+  "version": "1.30.9-beta.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/logger": "1.30.9-beta.2",
+    "@percy/logger": "1.30.9-beta.3",
     "ajv": "^8.6.2",
     "cosmiconfig": "^8.0.0",
     "yaml": "^2.0.0"
@@ -46,5 +46,5 @@
   "devDependencies": {
     "json-schema-typed": "^7.0.3"
   },
-  "gitHead": "13493f9b47d1c7bc9e6f86a1499970012e4e169a"
+  "gitHead": "06ceb56e04806677d41a22eb1ccbee81a8d32c15"
 }