@hestia-earth/data-validation 0.41.8 → 0.41.10

package/file-errors/public-api.js

@@ -432,6 +432,11 @@ var validations = [
     level: "warning",
     message: "should specify the fate of cropResidue"
   },
+  {
+    function: "validate_cycleDuration",
+    level: "error",
+    message: "must be one year prior to endDate"
+  },
   {
     function: "validate_cycleDuration",
     level: "error",
@@ -662,6 +667,11 @@ var validations = [
     level: "error",
     message: "must be a product"
   },
+  {
+    function: "validate_input_unspecified_term",
+    level: "warning",
+    message: "should use a specific term"
+  },
   {
     function: "_validate_all_values",
     level: "warning",
@@ -771,6 +781,11 @@ var validations = [
     function: "validate_excreta_inputs_products",
     level: "error",
     message: "must be included as an Input"
+  },
+  {
+    function: "validate_transformation_inputs_value",
+    level: "error",
+    message: "must be specified for multiple Inputs with the same term"
   }
 ];
 
@@ -1476,6 +1491,13 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     },
     "must be equal to previous product multiplied by the share": () => `Products from a transformation which are an Input in to the next transformation must follow the following rule:
     ${code("previous.product.value * current.transformedShare / 100 == current.input.value")}`,
+    "must be specified for multiple Inputs with the same term": ({ params }) => {
+      var _a, _b;
+      return `There are multiple Inputs of ${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"]))} in this Transformation
+    which only differ by fields other than ${code("variety")} or ${code("fate")}, so the ${code("transformedShare")}
+    cannot tell how the Product ${code("value")} should be split between them.
+    Please specify the ${code("value")} of each of these Inputs.`;
+    },
     "at least one Input must be a Product of the Cycle": () => `A Transformation converts a Product from a Cycle into another Product.
     Therefore, at least one Input into the Transformation must be a Product of the Cycle.`,
     "must have only one entry with the same term.termType = excretaManagement": () => `There can only be one Practice of type excretaManagement in a Cycle.
@@ -1523,6 +1545,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
         (_d = params == null ? void 0 : params.term) == null ? void 0 : _d.termType
       )} which reflects the specific ${glossaryTypeLink((_e = params == null ? void 0 : params.product) == null ? void 0 : _e.termType)}.`;
     },
+    "should use a specific term": ({ params }) => {
+      var _a, _b, _c;
+      return `You have used ${termLink({
+        id: (_a = params == null ? void 0 : params.term) == null ? void 0 : _a["@id"],
+        name: (_b = params == null ? void 0 : params.term) == null ? void 0 : _b.name
+      })}, which does not say what was used.
+    If you know it, choose the specific ${glossaryTypeLink((_c = params == null ? void 0 : params.term) == null ? void 0 : _c.termType)} term instead:
+    background emissions, characterisation factors and completeness all depend on it.`;
+    },
     "should not use several terms describing the same product": ({ params }) => {
       var _a, _b, _c, _d;
       const isFertiliser = ((_a = params == null ? void 0 : params.term) == null ? void 0 : _a.termType) === schema.TermTermType.organicFertiliser;
@@ -2141,6 +2172,10 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     "must be in the same format as endDate": () => `The date format does not match the format of ${code("endDate")}. You must use the same date format for both fields.`,
     "must be at least equal to the minimum value": ({ params: { min } }) => `Must be at least equal to ${min}`,
     "must equal to endDate - startDate in days": ({ params: { expected } }) => `Must be equal to ${code("endDate")} - ${code("startDate")} in days (inclusive of the ${code("startDate")} and ${code("endDate")} days) (~${expected})`,
+    "must be one year prior to endDate": ({ params: { current, expected } }) => `With a ${schemaLink("Cycle#startDateDefinition", "startDateDefinition")} of ${code("one year prior")}, the ${code(
+      "startDate"
+    )} must be the day after the ${code("endDate")} one year earlier, so that the Cycle covers exactly one year.
+    Your ${code("startDate")} is ${code(current)}; it should be ${code(expected)}.`,
     "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)}`,

package/file-errors/public-api.mjs

@@ -430,6 +430,11 @@ var validations = [
     level: "warning",
     message: "should specify the fate of cropResidue"
   },
+  {
+    function: "validate_cycleDuration",
+    level: "error",
+    message: "must be one year prior to endDate"
+  },
   {
     function: "validate_cycleDuration",
     level: "error",
@@ -660,6 +665,11 @@ var validations = [
     level: "error",
     message: "must be a product"
   },
+  {
+    function: "validate_input_unspecified_term",
+    level: "warning",
+    message: "should use a specific term"
+  },
   {
     function: "_validate_all_values",
     level: "warning",
@@ -769,6 +779,11 @@ var validations = [
     function: "validate_excreta_inputs_products",
     level: "error",
     message: "must be included as an Input"
+  },
+  {
+    function: "validate_transformation_inputs_value",
+    level: "error",
+    message: "must be specified for multiple Inputs with the same term"
   }
 ];
 
@@ -1474,6 +1489,13 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     },
     "must be equal to previous product multiplied by the share": () => `Products from a transformation which are an Input in to the next transformation must follow the following rule:
     ${code("previous.product.value * current.transformedShare / 100 == current.input.value")}`,
+    "must be specified for multiple Inputs with the same term": ({ params }) => {
+      var _a, _b;
+      return `There are multiple Inputs of ${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"]))} in this Transformation
+    which only differ by fields other than ${code("variety")} or ${code("fate")}, so the ${code("transformedShare")}
+    cannot tell how the Product ${code("value")} should be split between them.
+    Please specify the ${code("value")} of each of these Inputs.`;
+    },
     "at least one Input must be a Product of the Cycle": () => `A Transformation converts a Product from a Cycle into another Product.
     Therefore, at least one Input into the Transformation must be a Product of the Cycle.`,
     "must have only one entry with the same term.termType = excretaManagement": () => `There can only be one Practice of type excretaManagement in a Cycle.
@@ -1521,6 +1543,15 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
         (_d = params == null ? void 0 : params.term) == null ? void 0 : _d.termType
       )} which reflects the specific ${glossaryTypeLink((_e = params == null ? void 0 : params.product) == null ? void 0 : _e.termType)}.`;
     },
+    "should use a specific term": ({ params }) => {
+      var _a, _b, _c;
+      return `You have used ${termLink({
+        id: (_a = params == null ? void 0 : params.term) == null ? void 0 : _a["@id"],
+        name: (_b = params == null ? void 0 : params.term) == null ? void 0 : _b.name
+      })}, which does not say what was used.
+    If you know it, choose the specific ${glossaryTypeLink((_c = params == null ? void 0 : params.term) == null ? void 0 : _c.termType)} term instead:
+    background emissions, characterisation factors and completeness all depend on it.`;
+    },
     "should not use several terms describing the same product": ({ params }) => {
       var _a, _b, _c, _d;
       const isFertiliser = ((_a = params == null ? void 0 : params.term) == null ? void 0 : _a.termType) === TermTermType.organicFertiliser;
@@ -2139,6 +2170,10 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     "must be in the same format as endDate": () => `The date format does not match the format of ${code("endDate")}. You must use the same date format for both fields.`,
     "must be at least equal to the minimum value": ({ params: { min } }) => `Must be at least equal to ${min}`,
     "must equal to endDate - startDate in days": ({ params: { expected } }) => `Must be equal to ${code("endDate")} - ${code("startDate")} in days (inclusive of the ${code("startDate")} and ${code("endDate")} days) (~${expected})`,
+    "must be one year prior to endDate": ({ params: { current, expected } }) => `With a ${schemaLink("Cycle#startDateDefinition", "startDateDefinition")} of ${code("one year prior")}, the ${code(
+      "startDate"
+    )} must be the day after the ${code("endDate")} one year earlier, so that the Cycle covers exactly one year.
+    Your ${code("startDate")} is ${code(current)}; it should be ${code(expected)}.`,
     "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)}`,

package/index.js

@@ -438,6 +438,11 @@ var validations = [
     level: "warning",
     message: "should specify the fate of cropResidue"
   },
+  {
+    function: "validate_cycleDuration",
+    level: "error",
+    message: "must be one year prior to endDate"
+  },
   {
     function: "validate_cycleDuration",
     level: "error",
@@ -668,6 +673,11 @@ var validations = [
     level: "error",
     message: "must be a product"
   },
+  {
+    function: "validate_input_unspecified_term",
+    level: "warning",
+    message: "should use a specific term"
+  },
   {
     function: "_validate_all_values",
     level: "warning",
@@ -777,6 +787,11 @@ var validations = [
     function: "validate_excreta_inputs_products",
     level: "error",
     message: "must be included as an Input"
+  },
+  {
+    function: "validate_transformation_inputs_value",
+    level: "error",
+    message: "must be specified for multiple Inputs with the same term"
   }
 ];
 var validation_default = {

package/index.mjs

@@ -436,6 +436,11 @@ var validations = [
     level: "warning",
     message: "should specify the fate of cropResidue"
   },
+  {
+    function: "validate_cycleDuration",
+    level: "error",
+    message: "must be one year prior to endDate"
+  },
   {
     function: "validate_cycleDuration",
     level: "error",
@@ -666,6 +671,11 @@ var validations = [
     level: "error",
     message: "must be a product"
   },
+  {
+    function: "validate_input_unspecified_term",
+    level: "warning",
+    message: "should use a specific term"
+  },
   {
     function: "_validate_all_values",
     level: "warning",
@@ -775,6 +785,11 @@ var validations = [
     function: "validate_excreta_inputs_products",
     level: "error",
     message: "must be included as an Input"
+  },
+  {
+    function: "validate_transformation_inputs_value",
+    level: "error",
+    message: "must be specified for multiple Inputs with the same term"
   }
 ];
 var validation_default = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/data-validation",
-  "version": "0.41.8",
+  "version": "0.41.10",
   "description": "HESTIA Data Validation library",
   "main": "index.js",
   "module": "index.mjs",
@@ -79,9 +79,9 @@
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
     "@hestia-earth/eslint-config": "^0.1.1",
-    "@hestia-earth/json-schema": "^39.0.1",
-    "@hestia-earth/schema": "^39.0.1",
-    "@hestia-earth/schema-validation": "^39.0.1",
+    "@hestia-earth/json-schema": "^39.2.0",
+    "@hestia-earth/schema": "^39.2.0",
+    "@hestia-earth/schema-validation": "^39.2.0",
     "@hestia-earth/utils": "^0.17.17",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",

package/validation.json

@@ -425,6 +425,11 @@
       "level": "warning",
       "message": "should specify the fate of cropResidue"
     },
+    {
+      "function": "validate_cycleDuration",
+      "level": "error",
+      "message": "must be one year prior to endDate"
+    },
     {
       "function": "validate_cycleDuration",
       "level": "error",
@@ -655,6 +660,11 @@
       "level": "error",
       "message": "must be a product"
     },
+    {
+      "function": "validate_input_unspecified_term",
+      "level": "warning",
+      "message": "should use a specific term"
+    },
     {
       "function": "_validate_all_values",
       "level": "warning",
@@ -764,6 +774,11 @@
       "function": "validate_excreta_inputs_products",
       "level": "error",
       "message": "must be included as an Input"
+    },
+    {
+      "function": "validate_transformation_inputs_value",
+      "level": "error",
+      "message": "must be specified for multiple Inputs with the same term"
     }
   ]
 }