@hestia-earth/data-validation 0.41.12 → 0.41.14

package/file-errors/public-api.js

@@ -187,6 +187,11 @@ var validations = [
     level: "error",
     message: "must not have background methodTier"
   },
+  {
+    function: "validate_methodTier_background",
+    level: "error",
+    message: "must be an existing term"
+  },
   {
     function: "validate_depth",
     level: "warning",
@@ -1287,6 +1292,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);
@@ -1651,6 +1665,13 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       100
     )} if the Number of tillages has been set to ${code(0)}. Please resolve this conflict.`,
     "can not be linked to the same Cycle": () => "You can not link an Input to the Impact Assessment of the same Cycle.",
+    "can not be linked to a different term": ({ params }) => {
+      var _a;
+      return `The Impact Assessment linked to this Input is for the Product ${termLink({
+        id: params == null ? void 0 : params.current
+      })}, which does not match the Input.
+    Link an Impact Assessment whose Product is ${joinWithOr(((_a = params == null ? void 0 : params.expected) != null ? _a : []).map((id) => termLink({ id })))} instead.`;
+    },
     // deprecated, remove when message is not being used anymore
     "must be 0 for product value 0": ({ dataPath, params }, errorCount) => `If the amount produced is zero, the ${code(dataPath == null ? void 0 : dataPath.split(".").pop())} of ${errorCount === 1 ? code(params == null ? void 0 : params.term.name) : "that product"} must also be zero.`,
     "economicValueShare must be 0 for product value 0": ({ params }, errorCount) => `If the amount produced is zero, the economicValueShare of ${errorCount === 1 ? code(params == null ? void 0 : params.term.name) : "that product"} must also be zero.`,
@@ -1696,22 +1717,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 +1742,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`,
@@ -2106,13 +2129,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       return `If completeness is set to true for ${schemaLink(
         `Completeness#${params.expected}`,
         params.expected
-      )}, every Transport must have a ${schemaLink("Transport#value", "value")} (in tkm) or a ${schemaLink(
+      )}, every Transport must have a ${schemaLink("Transport#value", "value")} (in tkm), a ${schemaLink(
         "Transport#distance",
         "distance"
-      )} (in km). This ${termLink({
+      )} (in km), or ${schemaLink("Transport#inputs", "inputs")} (e.g. the fuel used) which all have a ${code(
+        "value"
+      )}. This ${termLink({
         id: (_a = params.term) == null ? void 0 : _a["@id"],
         name: (_b = params.term) == null ? void 0 : _b.name
-      })} has neither.`;
+      })} has none of these.`;
     },
     "primary product cannot be an input": ({ params }) => params.siteType === schema.SiteSiteType["agri-food processor"] ? `For a processing cycle, the primary Product must not also be an Input into the cycle.
   This ensures we reflect the full process rather than just single sub-processes.
@@ -2149,11 +2174,11 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       "Saplings"
     )} used divided by the number of possible Cycles in the plantation's lifespan.
     See the ${guideLink("guide-file-upload-special-cases", "special upload case")} for more details.`,
-    "seed cannot be used as an input here": ({ params }) => `The Cycle only represents plantation crops, which are established from saplings rather than sown, so ${externalNodeLink(
+    "seed cannot be used as an input here": ({ params }) => `The Cycle only represents plantation crops, which are established from planting material rather than sown, so ${externalNodeLink(
       {
         "@type": schema.NodeType.Term,
         "@id": String(params.expected),
-        name: "Saplings, depreciated amount per Cycle"
+        name: humanizeTermId(String(params.expected))
       }
     )} should be used instead of ${code(params.current)}.
     If this is a case of intercropping, add the relevant ${code(schema.TermTermType.landCover)} Practices to the Cycle, or, if it was sown as a cover crop under the plantation, add the ${termLink(
@@ -2164,7 +2189,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     )} Practice.`,
     "saplingsDepreciatedAmountPerCycle cannot be used as an input here": ({ params }) => `The Cycle only represents non-plantation crops, so ${termLink({
       id: String(params.expected),
-      name: "Seed"
+      name: humanizeTermId(String(params.expected))
     })} should be used instead of ${code(params.current)}.
     If this is a case of intercropping, add the relevant ${code(schema.TermTermType.landCover)} Practices to the Cycle.`,
     "must use the depreciated term": ({ params }) => {
@@ -2242,11 +2267,22 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     Please amend the value of ${code("harvestedArea")} accordingly.`,
     "must be above the minimum": ({ params: { min } }) => `Must be above ${min}.`,
     "must be below the maximum": ({ params: { max } }) => `Must be below ${max}.`,
+    "must be greater than min": ({ params }) => `The ${code("max")} (${joinValues([].concat(params == null ? void 0 : params.max).map(String))}) must be greater than the ${code(
+      "min"
+    )} (${joinValues([].concat(params == null ? void 0 : params.min).map(String))}).
+    Please check they have not been swapped: the ${code("value")} can be gap-filled from them.`,
     "must be linked to waste input": () => `The term ${code(
       "ionisingCompoundsToAirInputsProduction"
     )} can only have 1 entry of ${code("termType")}: ${glossaryTypeLink(
       schema.TermTermType.waste
     )}, so that the ${code("value")} field can represent the amount of units of that waste term.`,
+    "must be an existing term": ({ params }) => {
+      var _a, _b;
+      return `${code(((_a = params == null ? void 0 : params.term) == null ? void 0 : _a.name) || ((_b = params == null ? void 0 : params.term) == null ? void 0 : _b["@id"]))} is not in the ${glossaryLink(
+        "Glossary"
+      )}: it has been removed or renamed.
+    Please replace it with the current term.`;
+    },
     "must not have background methodTier": ({ params: { allowedValues } }) => `Only background emissions (e.g., "Inputs Production") can have ${code("methodTier")}=${schema.EmissionMethodTier.background}.
     You must instead choose one of the following values: ${listAsCode(allowedValues)}`,
     "should be within acceptable range of the lookup value": ({ params }) => `The ${code(params.term["@id"])} value is ${code(params.delta)}% higher than our default value for this Term (${code(params.expected)}).

package/file-errors/public-api.mjs

@@ -185,6 +185,11 @@ var validations = [
     level: "error",
     message: "must not have background methodTier"
   },
+  {
+    function: "validate_methodTier_background",
+    level: "error",
+    message: "must be an existing term"
+  },
   {
     function: "validate_depth",
     level: "warning",
@@ -1285,6 +1290,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);
@@ -1649,6 +1663,13 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       100
     )} if the Number of tillages has been set to ${code(0)}. Please resolve this conflict.`,
     "can not be linked to the same Cycle": () => "You can not link an Input to the Impact Assessment of the same Cycle.",
+    "can not be linked to a different term": ({ params }) => {
+      var _a;
+      return `The Impact Assessment linked to this Input is for the Product ${termLink({
+        id: params == null ? void 0 : params.current
+      })}, which does not match the Input.
+    Link an Impact Assessment whose Product is ${joinWithOr(((_a = params == null ? void 0 : params.expected) != null ? _a : []).map((id) => termLink({ id })))} instead.`;
+    },
     // deprecated, remove when message is not being used anymore
     "must be 0 for product value 0": ({ dataPath, params }, errorCount) => `If the amount produced is zero, the ${code(dataPath == null ? void 0 : dataPath.split(".").pop())} of ${errorCount === 1 ? code(params == null ? void 0 : params.term.name) : "that product"} must also be zero.`,
     "economicValueShare must be 0 for product value 0": ({ params }, errorCount) => `If the amount produced is zero, the economicValueShare of ${errorCount === 1 ? code(params == null ? void 0 : params.term.name) : "that product"} must also be zero.`,
@@ -1694,22 +1715,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 +1740,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`,
@@ -2104,13 +2127,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       return `If completeness is set to true for ${schemaLink(
         `Completeness#${params.expected}`,
         params.expected
-      )}, every Transport must have a ${schemaLink("Transport#value", "value")} (in tkm) or a ${schemaLink(
+      )}, every Transport must have a ${schemaLink("Transport#value", "value")} (in tkm), a ${schemaLink(
         "Transport#distance",
         "distance"
-      )} (in km). This ${termLink({
+      )} (in km), or ${schemaLink("Transport#inputs", "inputs")} (e.g. the fuel used) which all have a ${code(
+        "value"
+      )}. This ${termLink({
         id: (_a = params.term) == null ? void 0 : _a["@id"],
         name: (_b = params.term) == null ? void 0 : _b.name
-      })} has neither.`;
+      })} has none of these.`;
     },
     "primary product cannot be an input": ({ params }) => params.siteType === SiteSiteType["agri-food processor"] ? `For a processing cycle, the primary Product must not also be an Input into the cycle.
   This ensures we reflect the full process rather than just single sub-processes.
@@ -2147,11 +2172,11 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       "Saplings"
     )} used divided by the number of possible Cycles in the plantation's lifespan.
     See the ${guideLink("guide-file-upload-special-cases", "special upload case")} for more details.`,
-    "seed cannot be used as an input here": ({ params }) => `The Cycle only represents plantation crops, which are established from saplings rather than sown, so ${externalNodeLink(
+    "seed cannot be used as an input here": ({ params }) => `The Cycle only represents plantation crops, which are established from planting material rather than sown, so ${externalNodeLink(
       {
         "@type": NodeType.Term,
         "@id": String(params.expected),
-        name: "Saplings, depreciated amount per Cycle"
+        name: humanizeTermId(String(params.expected))
       }
     )} should be used instead of ${code(params.current)}.
     If this is a case of intercropping, add the relevant ${code(TermTermType.landCover)} Practices to the Cycle, or, if it was sown as a cover crop under the plantation, add the ${termLink(
@@ -2162,7 +2187,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     )} Practice.`,
     "saplingsDepreciatedAmountPerCycle cannot be used as an input here": ({ params }) => `The Cycle only represents non-plantation crops, so ${termLink({
       id: String(params.expected),
-      name: "Seed"
+      name: humanizeTermId(String(params.expected))
     })} should be used instead of ${code(params.current)}.
     If this is a case of intercropping, add the relevant ${code(TermTermType.landCover)} Practices to the Cycle.`,
     "must use the depreciated term": ({ params }) => {
@@ -2240,11 +2265,22 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     Please amend the value of ${code("harvestedArea")} accordingly.`,
     "must be above the minimum": ({ params: { min } }) => `Must be above ${min}.`,
     "must be below the maximum": ({ params: { max } }) => `Must be below ${max}.`,
+    "must be greater than min": ({ params }) => `The ${code("max")} (${joinValues([].concat(params == null ? void 0 : params.max).map(String))}) must be greater than the ${code(
+      "min"
+    )} (${joinValues([].concat(params == null ? void 0 : params.min).map(String))}).
+    Please check they have not been swapped: the ${code("value")} can be gap-filled from them.`,
     "must be linked to waste input": () => `The term ${code(
       "ionisingCompoundsToAirInputsProduction"
     )} can only have 1 entry of ${code("termType")}: ${glossaryTypeLink(
       TermTermType.waste
     )}, so that the ${code("value")} field can represent the amount of units of that waste term.`,
+    "must be an existing term": ({ params }) => {
+      var _a, _b;
+      return `${code(((_a = params == null ? void 0 : params.term) == null ? void 0 : _a.name) || ((_b = params == null ? void 0 : params.term) == null ? void 0 : _b["@id"]))} is not in the ${glossaryLink(
+        "Glossary"
+      )}: it has been removed or renamed.
+    Please replace it with the current term.`;
+    },
     "must not have background methodTier": ({ params: { allowedValues } }) => `Only background emissions (e.g., "Inputs Production") can have ${code("methodTier")}=${EmissionMethodTier.background}.
     You must instead choose one of the following values: ${listAsCode(allowedValues)}`,
     "should be within acceptable range of the lookup value": ({ params }) => `The ${code(params.term["@id"])} value is ${code(params.delta)}% higher than our default value for this Term (${code(params.expected)}).

package/index.js

@@ -193,6 +193,11 @@ var validations = [
     level: "error",
     message: "must not have background methodTier"
   },
+  {
+    function: "validate_methodTier_background",
+    level: "error",
+    message: "must be an existing term"
+  },
   {
     function: "validate_depth",
     level: "warning",

package/index.mjs

@@ -191,6 +191,11 @@ var validations = [
     level: "error",
     message: "must not have background methodTier"
   },
+  {
+    function: "validate_methodTier_background",
+    level: "error",
+    message: "must be an existing term"
+  },
   {
     function: "validate_depth",
     level: "warning",

package/package.json

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

package/validation.json

@@ -180,6 +180,11 @@
       "level": "error",
       "message": "must not have background methodTier"
     },
+    {
+      "function": "validate_methodTier_background",
+      "level": "error",
+      "message": "must be an existing term"
+    },
     {
       "function": "validate_depth",
       "level": "warning",