@hestia-earth/data-validation 0.41.15 → 0.41.16

package/file-errors/public-api.d.mts

@@ -57,7 +57,7 @@ declare const urlConfig: (baseUrl?: string) => IUrlConfig;
  * primary entry point). They are kept structurally compatible on purpose.
  */
 type validationErrorLevel = 'error' | 'warning';
-type validationErrorParam = 'missingProperty' | 'type' | 'term' | 'termType' | 'termIds' | 'model' | 'product' | 'range' | 'node' | 'allowedValues' | 'allowedValue' | 'additionalProperty' | 'expected' | 'default' | 'current' | 'percentage' | 'keys' | 'threshold' | 'outliers' | 'country' | 'min' | 'max' | 'mu' | 'sd' | 'defaultSource' | 'source' | 'group' | 'message' | 'distance' | 'siteType' | 'products' | 'units' | 'duplicatedIndexes' | 'invalidCoordinates' | 'ids' | 'limit' | 'delta' | 'newlyCovered' | 'recommended' | 'missing';
+type validationErrorParam = 'missingProperty' | 'type' | 'term' | 'termType' | 'termIds' | 'model' | 'product' | 'range' | 'node' | 'allowedValues' | 'allowedValue' | 'additionalProperty' | 'expected' | 'default' | 'current' | 'percentage' | 'keys' | 'threshold' | 'outliers' | 'country' | 'min' | 'max' | 'mu' | 'sd' | 'defaultSource' | 'source' | 'group' | 'message' | 'distance' | 'siteType' | 'products' | 'units' | 'duplicatedIndexes' | 'invalidCoordinates' | 'ids' | 'limit' | 'delta' | 'newlyCovered' | 'recommended' | 'missing' | 'cause' | 'compound';
 type validationErrorKeyword = 'required' | 'type' | 'if' | 'then' | 'not';
 interface ICustomValidationRules {
     const?: any;

package/file-errors/public-api.d.ts

@@ -57,7 +57,7 @@ declare const urlConfig: (baseUrl?: string) => IUrlConfig;
  * primary entry point). They are kept structurally compatible on purpose.
  */
 type validationErrorLevel = 'error' | 'warning';
-type validationErrorParam = 'missingProperty' | 'type' | 'term' | 'termType' | 'termIds' | 'model' | 'product' | 'range' | 'node' | 'allowedValues' | 'allowedValue' | 'additionalProperty' | 'expected' | 'default' | 'current' | 'percentage' | 'keys' | 'threshold' | 'outliers' | 'country' | 'min' | 'max' | 'mu' | 'sd' | 'defaultSource' | 'source' | 'group' | 'message' | 'distance' | 'siteType' | 'products' | 'units' | 'duplicatedIndexes' | 'invalidCoordinates' | 'ids' | 'limit' | 'delta' | 'newlyCovered' | 'recommended' | 'missing';
+type validationErrorParam = 'missingProperty' | 'type' | 'term' | 'termType' | 'termIds' | 'model' | 'product' | 'range' | 'node' | 'allowedValues' | 'allowedValue' | 'additionalProperty' | 'expected' | 'default' | 'current' | 'percentage' | 'keys' | 'threshold' | 'outliers' | 'country' | 'min' | 'max' | 'mu' | 'sd' | 'defaultSource' | 'source' | 'group' | 'message' | 'distance' | 'siteType' | 'products' | 'units' | 'duplicatedIndexes' | 'invalidCoordinates' | 'ids' | 'limit' | 'delta' | 'newlyCovered' | 'recommended' | 'missing' | 'cause' | 'compound';
 type validationErrorKeyword = 'required' | 'type' | 'if' | 'then' | 'not';
 interface ICustomValidationRules {
     const?: any;

package/file-errors/public-api.js

@@ -632,6 +632,11 @@ var validations = [
     level: "warning",
     message: "should add missing inputs"
   },
+  {
+    function: "validate_compound_fertiliser_composition",
+    level: "warning",
+    message: "should match the nutrient ratio of the compound fertiliser"
+  },
   {
     function: "validate_related_impacts",
     level: "error",
@@ -2294,6 +2299,23 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     "must equal to endDate - startDate in decimal years": ({ params: { expected } }) => `Must be equal to ${code("endDate")} - ${code("startDate")} in years (~${expected})`,
     "must be more than or equal to other crop residues": ({ params: { expected } }) => `Must be more than or equal to sum(${expected.join(" + ")})`,
     "should add missing inputs": ({ params: { expected } }) => `Should add missing inputs: ${listAsCode(expected)}`,
+    "should match the nutrient ratio of the compound fertiliser": ({ params }) => {
+      var _a, _b;
+      const [denominator, numerator] = ((_a = params == null ? void 0 : params.termIds) != null ? _a : []).map((id) => termLink({ id }));
+      const expected = (params == null ? void 0 : params.min) === (params == null ? void 0 : params.max) ? code(params == null ? void 0 : params.min) : `${code(params == null ? void 0 : params.min)} to ${code(params == null ? void 0 : params.max)}`;
+      const causes = {
+        swapped: "This is close to the inverse of the expected ratio: the values of the two Inputs may have been swapped.",
+        elemental: `This is close to the expected ratio converted to elements: the value may have been given as kg of elemental P or K rather than kg of ${code(
+          "P2O5"
+        )} or ${code("K2O")}.`,
+        otherCompound: `This is close to the ratio of ${termLink({
+          id: params == null ? void 0 : params.compound
+        })}: the values may have been calculated from the composition of another fertiliser.`
+      };
+      return `The value of ${numerator} divided by the value of ${denominator} is ${code(params == null ? void 0 : params.current)}, but the composition of this fertiliser gives a ratio of ${expected}.
+    ${(_b = causes[params == null ? void 0 : params.cause]) != null ? _b : ""}
+    Please check that both Inputs are the amounts of each nutrient applied with this fertiliser.`;
+    },
     "the property value type is incorrect": ({ params: { expected } }) => `The value must be a ${expected}.`,
     "the node value type is incorrect": ({ params: { expected } }) => `The value must be a ${expected}.`,
     "can not be linked to the same type": ({ params: { current } }) => `Cannot be linked to the same ${current}.`,

package/file-errors/public-api.mjs

@@ -630,6 +630,11 @@ var validations = [
     level: "warning",
     message: "should add missing inputs"
   },
+  {
+    function: "validate_compound_fertiliser_composition",
+    level: "warning",
+    message: "should match the nutrient ratio of the compound fertiliser"
+  },
   {
     function: "validate_related_impacts",
     level: "error",
@@ -2292,6 +2297,23 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     "must equal to endDate - startDate in decimal years": ({ params: { expected } }) => `Must be equal to ${code("endDate")} - ${code("startDate")} in years (~${expected})`,
     "must be more than or equal to other crop residues": ({ params: { expected } }) => `Must be more than or equal to sum(${expected.join(" + ")})`,
     "should add missing inputs": ({ params: { expected } }) => `Should add missing inputs: ${listAsCode(expected)}`,
+    "should match the nutrient ratio of the compound fertiliser": ({ params }) => {
+      var _a, _b;
+      const [denominator, numerator] = ((_a = params == null ? void 0 : params.termIds) != null ? _a : []).map((id) => termLink({ id }));
+      const expected = (params == null ? void 0 : params.min) === (params == null ? void 0 : params.max) ? code(params == null ? void 0 : params.min) : `${code(params == null ? void 0 : params.min)} to ${code(params == null ? void 0 : params.max)}`;
+      const causes = {
+        swapped: "This is close to the inverse of the expected ratio: the values of the two Inputs may have been swapped.",
+        elemental: `This is close to the expected ratio converted to elements: the value may have been given as kg of elemental P or K rather than kg of ${code(
+          "P2O5"
+        )} or ${code("K2O")}.`,
+        otherCompound: `This is close to the ratio of ${termLink({
+          id: params == null ? void 0 : params.compound
+        })}: the values may have been calculated from the composition of another fertiliser.`
+      };
+      return `The value of ${numerator} divided by the value of ${denominator} is ${code(params == null ? void 0 : params.current)}, but the composition of this fertiliser gives a ratio of ${expected}.
+    ${(_b = causes[params == null ? void 0 : params.cause]) != null ? _b : ""}
+    Please check that both Inputs are the amounts of each nutrient applied with this fertiliser.`;
+    },
     "the property value type is incorrect": ({ params: { expected } }) => `The value must be a ${expected}.`,
     "the node value type is incorrect": ({ params: { expected } }) => `The value must be a ${expected}.`,
     "can not be linked to the same type": ({ params: { current } }) => `Cannot be linked to the same ${current}.`,

package/index.js

@@ -638,6 +638,11 @@ var validations = [
     level: "warning",
     message: "should add missing inputs"
   },
+  {
+    function: "validate_compound_fertiliser_composition",
+    level: "warning",
+    message: "should match the nutrient ratio of the compound fertiliser"
+  },
   {
     function: "validate_related_impacts",
     level: "error",

package/index.mjs

@@ -636,6 +636,11 @@ var validations = [
     level: "warning",
     message: "should add missing inputs"
   },
+  {
+    function: "validate_compound_fertiliser_composition",
+    level: "warning",
+    message: "should match the nutrient ratio of the compound fertiliser"
+  },
   {
     function: "validate_related_impacts",
     level: "error",

package/package.json

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

package/validation.json

@@ -625,6 +625,11 @@
       "level": "warning",
       "message": "should add missing inputs"
     },
+    {
+      "function": "validate_compound_fertiliser_composition",
+      "level": "warning",
+      "message": "should match the nutrient ratio of the compound fertiliser"
+    },
     {
       "function": "validate_related_impacts",
       "level": "error",