@hestia-earth/data-validation 0.41.12 → 0.41.13

package/file-errors/public-api.js

@@ -1287,6 +1287,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     const sentences = utils.unique(errors.map(({ params }) => params == null ? void 0 : params.source)).map((source) => distributionSourceMessage[source]).filter(Boolean);
     return sentences.length ? `${sentences.join(r.lineBreak)}${r.lineBreak}` : "";
   };
+  const outlierSubject = ({ dataPath, params }, value, errorCount) => {
+    var _a;
+    const shownValue = errorCount === 1 ? ` ${code(value)}` : "";
+    return dataPath.includes("product") ? `The product value${shownValue}` : ((_a = params == null ? void 0 : params.termIds) == null ? void 0 : _a.length) ? `The total of ${joinWithAnd(params.termIds.map((id) => termLink({ id })))}, ${code(value)},` : (params == null ? void 0 : params.group) ? `The total of all ${code(params.group)} inputs of this Cycle${shownValue}` : `The input value${shownValue}`;
+  };
+  const outlierGroupNote = (errors) => errors.some(({ dataPath, params }) => {
+    var _a;
+    return !dataPath.includes("product") && (((_a = params == null ? void 0 : params.termIds) == null ? void 0 : _a.length) || (params == null ? void 0 : params.group));
+  }) ? `This total adds up every input checked together, including the nutrient content of fertilisers recorded in kg, so it can be higher than the value of a single input.${r.lineBreak}` : "";
   const customErrorMessage = {
     "this field is required": ({ dataPath }, _errorCount, allErrors) => {
       const parts = parseDataPath(dataPath);
@@ -1696,22 +1705,24 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     Please, use a term with termType ${glossaryTypeLink(schema.TermTermType.landCover)} instead.
     This will help us gap-fill the amount of grass consumed by the herd.`,
     "the sum of all pastureGrass values must be 100": ({ params }) => `The sum of all ${termLink(pastureGrass)} values must be equal to ${params.expected}%.`,
-    "is outside confidence interval": (error, errorCount, allErrors) => `${utils.unique(
-      (allErrors.length ? allErrors : [error]).flatMap(
-        ({ dataPath, params }) => {
-          var _a;
-          return (_a = params == null ? void 0 : params.outliers) == null ? void 0 : _a.map(
-            (value) => {
+    "is outside confidence interval": (error, errorCount, allErrors) => {
+      const errors = allErrors.length ? allErrors : [error];
+      return `${utils.unique(
+        errors.flatMap(
+          (current) => {
+            var _a, _b;
+            return (_b = (_a = current.params) == null ? void 0 : _a.outliers) == null ? void 0 : _b.map((value) => {
               var _a2;
-              return `The ${dataPath.includes("product") ? "product" : "input"} value ${errorCount === 1 ? `${code(value)} ` : ""}is ${value > (params == null ? void 0 : params.min) ? "above" : "below"} ${(params == null ? void 0 : params.threshold) ? `${code(`${(Number(params.threshold) + (1 - Number(params.threshold)) / 2) * 100}%`)} of` : ""} all ${(params == null ? void 0 : params.group) ? code(params.group) : code((_a2 = params == null ? void 0 : params.term) == null ? void 0 : _a2.name)} data in ${code(
+              const { params } = current;
+              return `${outlierSubject(current, value, errorCount)} is ${value > (params == null ? void 0 : params.min) ? "above" : "below"} ${(params == null ? void 0 : params.threshold) ? `${code(`${(Number(params.threshold) + (1 - Number(params.threshold)) / 2) * 100}%`)} of` : ""} all ${(params == null ? void 0 : params.group) ? code(params.group) : code((_a2 = params == null ? void 0 : params.term) == null ? void 0 : _a2.name)} data in ${code(
                 params == null ? void 0 : params.country.name
               )} on the HESTIA platform.`;
-            }
-          );
-        }
-      )
-    ).join(r.lineBreak)}${r.lineBreak}${distributionSources(allErrors.length ? allErrors : [error])}
-    Please double-check these values before submitting.`,
+            });
+          }
+        )
+      ).join(r.lineBreak)}${r.lineBreak}${outlierGroupNote(errors)}${distributionSources(errors)}
+    Please double-check these values before submitting.`;
+    },
     "should be equal to boundary": ({ params }) => `The calculated ${schemaLink("Site#area", "area")} from ${code("boundary")} is ${code(params == null ? void 0 : params.expected)} ha.
     This may be an error if the boundary represents the area under cultivation.`,
     "must specify the fate of cropResidue": ({ params }) => `For sites of type ${params.siteType.map(code).join(" or ")},
@@ -1719,7 +1730,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       true
     )} for crop residue, the fates and quantities of the residue must be specified.
     ${r.lineBreak}
-    The quantity must include both above and below ground crop residue, where the sum of above ground crop residue and below ground crop residue must be greater than zero.
+    The quantity must include both above and below ground crop residue, where the above ground crop residue must be greater than zero, unless the crop produces no crop residue (e.g. mushrooms).
     This can be added using the terms:
     ${formatList([
       `${termLink({ id: "belowGroundCropResidue", name: "Below ground crop residue" })}; and`,

package/file-errors/public-api.mjs

@@ -1285,6 +1285,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     const sentences = unique(errors.map(({ params }) => params == null ? void 0 : params.source)).map((source) => distributionSourceMessage[source]).filter(Boolean);
     return sentences.length ? `${sentences.join(r.lineBreak)}${r.lineBreak}` : "";
   };
+  const outlierSubject = ({ dataPath, params }, value, errorCount) => {
+    var _a;
+    const shownValue = errorCount === 1 ? ` ${code(value)}` : "";
+    return dataPath.includes("product") ? `The product value${shownValue}` : ((_a = params == null ? void 0 : params.termIds) == null ? void 0 : _a.length) ? `The total of ${joinWithAnd(params.termIds.map((id) => termLink({ id })))}, ${code(value)},` : (params == null ? void 0 : params.group) ? `The total of all ${code(params.group)} inputs of this Cycle${shownValue}` : `The input value${shownValue}`;
+  };
+  const outlierGroupNote = (errors) => errors.some(({ dataPath, params }) => {
+    var _a;
+    return !dataPath.includes("product") && (((_a = params == null ? void 0 : params.termIds) == null ? void 0 : _a.length) || (params == null ? void 0 : params.group));
+  }) ? `This total adds up every input checked together, including the nutrient content of fertilisers recorded in kg, so it can be higher than the value of a single input.${r.lineBreak}` : "";
   const customErrorMessage = {
     "this field is required": ({ dataPath }, _errorCount, allErrors) => {
       const parts = parseDataPath(dataPath);
@@ -1694,22 +1703,24 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     Please, use a term with termType ${glossaryTypeLink(TermTermType.landCover)} instead.
     This will help us gap-fill the amount of grass consumed by the herd.`,
     "the sum of all pastureGrass values must be 100": ({ params }) => `The sum of all ${termLink(pastureGrass)} values must be equal to ${params.expected}%.`,
-    "is outside confidence interval": (error, errorCount, allErrors) => `${unique(
-      (allErrors.length ? allErrors : [error]).flatMap(
-        ({ dataPath, params }) => {
-          var _a;
-          return (_a = params == null ? void 0 : params.outliers) == null ? void 0 : _a.map(
-            (value) => {
+    "is outside confidence interval": (error, errorCount, allErrors) => {
+      const errors = allErrors.length ? allErrors : [error];
+      return `${unique(
+        errors.flatMap(
+          (current) => {
+            var _a, _b;
+            return (_b = (_a = current.params) == null ? void 0 : _a.outliers) == null ? void 0 : _b.map((value) => {
               var _a2;
-              return `The ${dataPath.includes("product") ? "product" : "input"} value ${errorCount === 1 ? `${code(value)} ` : ""}is ${value > (params == null ? void 0 : params.min) ? "above" : "below"} ${(params == null ? void 0 : params.threshold) ? `${code(`${(Number(params.threshold) + (1 - Number(params.threshold)) / 2) * 100}%`)} of` : ""} all ${(params == null ? void 0 : params.group) ? code(params.group) : code((_a2 = params == null ? void 0 : params.term) == null ? void 0 : _a2.name)} data in ${code(
+              const { params } = current;
+              return `${outlierSubject(current, value, errorCount)} is ${value > (params == null ? void 0 : params.min) ? "above" : "below"} ${(params == null ? void 0 : params.threshold) ? `${code(`${(Number(params.threshold) + (1 - Number(params.threshold)) / 2) * 100}%`)} of` : ""} all ${(params == null ? void 0 : params.group) ? code(params.group) : code((_a2 = params == null ? void 0 : params.term) == null ? void 0 : _a2.name)} data in ${code(
                 params == null ? void 0 : params.country.name
               )} on the HESTIA platform.`;
-            }
-          );
-        }
-      )
-    ).join(r.lineBreak)}${r.lineBreak}${distributionSources(allErrors.length ? allErrors : [error])}
-    Please double-check these values before submitting.`,
+            });
+          }
+        )
+      ).join(r.lineBreak)}${r.lineBreak}${outlierGroupNote(errors)}${distributionSources(errors)}
+    Please double-check these values before submitting.`;
+    },
     "should be equal to boundary": ({ params }) => `The calculated ${schemaLink("Site#area", "area")} from ${code("boundary")} is ${code(params == null ? void 0 : params.expected)} ha.
     This may be an error if the boundary represents the area under cultivation.`,
     "must specify the fate of cropResidue": ({ params }) => `For sites of type ${params.siteType.map(code).join(" or ")},
@@ -1717,7 +1728,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       true
     )} for crop residue, the fates and quantities of the residue must be specified.
     ${r.lineBreak}
-    The quantity must include both above and below ground crop residue, where the sum of above ground crop residue and below ground crop residue must be greater than zero.
+    The quantity must include both above and below ground crop residue, where the above ground crop residue must be greater than zero, unless the crop produces no crop residue (e.g. mushrooms).
     This can be added using the terms:
     ${formatList([
       `${termLink({ id: "belowGroundCropResidue", name: "Below ground crop residue" })}; and`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/data-validation",
-  "version": "0.41.12",
+  "version": "0.41.13",
   "description": "HESTIA Data Validation library",
   "main": "index.js",
   "module": "index.mjs",