@hestia-earth/data-validation 0.41.11 → 0.41.12

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';
+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 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';
+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 validationErrorKeyword = 'required' | 'type' | 'if' | 'then' | 'not';
 interface ICustomValidationRules {
     const?: any;

package/file-errors/public-api.js

@@ -712,6 +712,11 @@ var validations = [
     level: "error",
     message: "must have a value or a distance if complete"
   },
+  {
+    function: "validate_coverage",
+    level: "warning",
+    message: "can not calculate all emissions"
+  },
   {
     function: "validate_has_termType",
     level: "warning",
@@ -1204,6 +1209,30 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
   const listAsCode = (values) => (values != null ? values : []).map((value) => r.code(value)).join(", ");
   const joinWithAnd = (values) => values.length > 1 ? `${values.slice(0, -1).join(", ")} and ${values[values.length - 1]}` : values.join("");
   const listAsCodeWithAnd = (values) => joinWithAnd((values != null ? values : []).map((value) => r.code(value)));
+  const joinWithOr = (values) => values.length > 1 ? `${values.slice(0, -1).join(", ")} or ${values[values.length - 1]}` : values.join("");
+  const pluralizeCount = (count, word) => `${count} ${pluralize(word, count)}`;
+  const termNames = (terms = [], max = 3) => [
+    ...terms.slice(0, max).map(({ "@id": id, name }) => termLink({ id, name })),
+    ...terms.length > max ? [`${terms.length - max} more`] : []
+  ].reduce((text, name, index, names) => index === 0 ? name : `${text}; ${index === names.length - 1 ? "and " : ""}${name}`, "");
+  const coverageItems = {
+    properties: ({ expected, term, blankNodeType }) => `add ${listAsCodeWithAnd(expected)} to the ${code(term == null ? void 0 : term["@id"])} ${blankNodeType}`,
+    cropResidue: () => `add the fate of the crop residue: a ${code(schema.TermTermType.cropResidueManagement)} Practice, or the crop residue Products`,
+    completeness: ({ paths }) => `set ${listAsCodeWithAnd(paths)} to ${code(true)}, if all the ${joinWithAnd(
+      paths.map((path) => path.split(".")[1])
+    )} data is recorded`,
+    pastureGrass: () => `add a ${code("pastureGrass")} Practice, with the type of grass as its key`,
+    system: ({ expected }) => `add an animal production system Practice${(expected == null ? void 0 : expected.length) ? `: ${joinWithOr(expected.map(code))}` : ""}`,
+    milkYield: ({ expected }) => `add a milk yield Practice to the Animals: ${joinWithOr(expected.map(code))}`,
+    animals: () => "add the herd composition, as Animals",
+    data: ({ path, expected }) => path === "or" ? `add one of ${joinWithOr(expected.map((fields) => listAsCodeWithAnd(fields)))}` : (expected == null ? void 0 : expected.length) && expected.join() !== path.split(".").pop() ? `add ${joinWithOr(expected.map(code))} to ${code(path)}` : `add ${code(path)}`
+  };
+  const coverageItem = (item) => {
+    var _a, _b;
+    return `\u2022 ${(_b = (_a = coverageItems[item.type]) == null ? void 0 : _a.call(coverageItems, item)) != null ? _b : code(item.path)}${item.nodeType && item.nodeType !== schema.SchemaType.Cycle ? ` (on the ${item.nodeType})` : ""}`;
+  };
+  const coverageRequirement = ({ path, expected, current, nodeType: nodeType2 }) => `${code(path)} is ${joinWithOr(expected.map(code))}${current ? ` (this ${nodeType2} has ${code(current)})` : ""}`;
+  const coverageMissing = ({ requirements, terms }) => `\u2022 HESTIA only calculates them when ${joinWithAnd(requirements.map(coverageRequirement))}: ${termNames(terms)}.`;
   const listAsTermLinksWithAnd = (termIds) => joinWithAnd((termIds != null ? termIds : []).map((id) => termLink({ id })));
   const glossaryQueryLink = (query, type) => r.link(`${urls.glossaryBaseUrl()}?query=${encodeURIComponent(query)}&termType=${type}`, query);
   const joinValues = (values) => (values || []).filter(Boolean).map((value) => r.code(value)).join(r.inlineSeparator);
@@ -1813,7 +1842,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       schema.CycleFunctionalUnit.relative
     )} or change the ${schemaLink("Site#siteType", "siteType")}.`,
     "should specify a value when HESTIA has a default one": ({ params }) => `As you have not specified a ${code("value")}, we will assume the value is ${code(params == null ? void 0 : params.expected)}.
-    If this is incorrect, pelase add a value.`,
+    If this is incorrect, please add a value.`,
     "should contain at least one management node": ({ params }) => `${(params == null ? void 0 : params.termType) ? `Does not contain information about ${code(params.termType)}.
         Please consider adding a history of ${code(
       params.termType
@@ -2038,12 +2067,36 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     but the calculated duration from the end date and start date provided is ${params.current}.`,
     "should add the term pastureGrass": () => `For Cycles with ${code("siteType=permanent pasture")} we recommend specifying the type(s) of ${code("Pasture grass")} grown.
     This is particularly important for ruminants and will allow for a more accurate estimate of the amount of grass grazed.`,
-    "should add the fields for a relative cycle": ({ params }) => {
-      var _a;
-      return `We strongly recommend setting ${(_a = params == null ? void 0 : params.expected) == null ? void 0 : _a.map((param) => code(param)).join("and")} on all other sites for any uploads with a ${code(
-        "relative"
-      )} functional unit. This will allow calculation of land occupation and land transformation.`;
+    "can not calculate all emissions": ({ params }) => {
+      var _a, _b, _c;
+      const indicators = "GWP100, acidification and other similar indicators";
+      const recommended = (_a = params == null ? void 0 : params.recommended) != null ? _a : [];
+      const missing = (_b = params == null ? void 0 : params.missing) != null ? _b : [];
+      const missingCount = missing.reduce(
+        (count, { terms }) => count + terms.length,
+        0
+      );
+      const unlocked = (_c = params == null ? void 0 : params.newlyCovered) != null ? _c : [];
+      const these = recommended.length === 1 ? "this" : "all of this";
+      return (recommended.length ? [
+        r.bold(`HESTIA cannot yet calculate all the emissions used by ${indicators} for this Cycle.`),
+        "To calculate more of them:",
+        ...recommended.map(coverageItem),
+        unlocked.length ? `With ${these}, HESTIA could calculate ${unlocked.length} more ${pluralize("emission", unlocked.length)}, such as: ${termNames(unlocked)}.` : `With ${these}, HESTIA could calculate more of these emissions.`,
+        ...missing.length ? [
+          `Even then, ${pluralizeCount(missingCount, "emission")} will be missing, so the indicators using ${missingCount === 1 ? "it" : "them"} will be incomplete:`,
+          ...missing.map(coverageMissing)
+        ] : []
+      ] : [
+        r.bold(
+          `With the data provided, ${pluralizeCount(missingCount, "emission")} used by ${indicators} cannot be calculated, so those indicators will be incomplete:`
+        ),
+        ...missing.map(coverageMissing)
+      ]).join(r.lineBreak);
     },
+    "should add the fields for a relative cycle": ({ params }) => `We strongly recommend setting ${listAsCodeWithAnd(params == null ? void 0 : params.expected)} on all other sites for any uploads with a ${code(
+      "relative"
+    )} functional unit. This will allow calculation of land occupation and land transformation.`,
     "must not be blank if complete": ({ params }) => `If completeness is set to true for ${schemaLink(
       `Completeness#${params.expected}`,
       params.expected

package/file-errors/public-api.mjs

@@ -710,6 +710,11 @@ var validations = [
     level: "error",
     message: "must have a value or a distance if complete"
   },
+  {
+    function: "validate_coverage",
+    level: "warning",
+    message: "can not calculate all emissions"
+  },
   {
     function: "validate_has_termType",
     level: "warning",
@@ -1202,6 +1207,30 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
   const listAsCode = (values) => (values != null ? values : []).map((value) => r.code(value)).join(", ");
   const joinWithAnd = (values) => values.length > 1 ? `${values.slice(0, -1).join(", ")} and ${values[values.length - 1]}` : values.join("");
   const listAsCodeWithAnd = (values) => joinWithAnd((values != null ? values : []).map((value) => r.code(value)));
+  const joinWithOr = (values) => values.length > 1 ? `${values.slice(0, -1).join(", ")} or ${values[values.length - 1]}` : values.join("");
+  const pluralizeCount = (count, word) => `${count} ${pluralize(word, count)}`;
+  const termNames = (terms = [], max = 3) => [
+    ...terms.slice(0, max).map(({ "@id": id, name }) => termLink({ id, name })),
+    ...terms.length > max ? [`${terms.length - max} more`] : []
+  ].reduce((text, name, index, names) => index === 0 ? name : `${text}; ${index === names.length - 1 ? "and " : ""}${name}`, "");
+  const coverageItems = {
+    properties: ({ expected, term, blankNodeType }) => `add ${listAsCodeWithAnd(expected)} to the ${code(term == null ? void 0 : term["@id"])} ${blankNodeType}`,
+    cropResidue: () => `add the fate of the crop residue: a ${code(TermTermType.cropResidueManagement)} Practice, or the crop residue Products`,
+    completeness: ({ paths }) => `set ${listAsCodeWithAnd(paths)} to ${code(true)}, if all the ${joinWithAnd(
+      paths.map((path) => path.split(".")[1])
+    )} data is recorded`,
+    pastureGrass: () => `add a ${code("pastureGrass")} Practice, with the type of grass as its key`,
+    system: ({ expected }) => `add an animal production system Practice${(expected == null ? void 0 : expected.length) ? `: ${joinWithOr(expected.map(code))}` : ""}`,
+    milkYield: ({ expected }) => `add a milk yield Practice to the Animals: ${joinWithOr(expected.map(code))}`,
+    animals: () => "add the herd composition, as Animals",
+    data: ({ path, expected }) => path === "or" ? `add one of ${joinWithOr(expected.map((fields) => listAsCodeWithAnd(fields)))}` : (expected == null ? void 0 : expected.length) && expected.join() !== path.split(".").pop() ? `add ${joinWithOr(expected.map(code))} to ${code(path)}` : `add ${code(path)}`
+  };
+  const coverageItem = (item) => {
+    var _a, _b;
+    return `\u2022 ${(_b = (_a = coverageItems[item.type]) == null ? void 0 : _a.call(coverageItems, item)) != null ? _b : code(item.path)}${item.nodeType && item.nodeType !== SchemaType.Cycle ? ` (on the ${item.nodeType})` : ""}`;
+  };
+  const coverageRequirement = ({ path, expected, current, nodeType: nodeType2 }) => `${code(path)} is ${joinWithOr(expected.map(code))}${current ? ` (this ${nodeType2} has ${code(current)})` : ""}`;
+  const coverageMissing = ({ requirements, terms }) => `\u2022 HESTIA only calculates them when ${joinWithAnd(requirements.map(coverageRequirement))}: ${termNames(terms)}.`;
   const listAsTermLinksWithAnd = (termIds) => joinWithAnd((termIds != null ? termIds : []).map((id) => termLink({ id })));
   const glossaryQueryLink = (query, type) => r.link(`${urls.glossaryBaseUrl()}?query=${encodeURIComponent(query)}&termType=${type}`, query);
   const joinValues = (values) => (values || []).filter(Boolean).map((value) => r.code(value)).join(r.inlineSeparator);
@@ -1811,7 +1840,7 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
       CycleFunctionalUnit.relative
     )} or change the ${schemaLink("Site#siteType", "siteType")}.`,
     "should specify a value when HESTIA has a default one": ({ params }) => `As you have not specified a ${code("value")}, we will assume the value is ${code(params == null ? void 0 : params.expected)}.
-    If this is incorrect, pelase add a value.`,
+    If this is incorrect, please add a value.`,
     "should contain at least one management node": ({ params }) => `${(params == null ? void 0 : params.termType) ? `Does not contain information about ${code(params.termType)}.
         Please consider adding a history of ${code(
       params.termType
@@ -2036,12 +2065,36 @@ var createErrorFormatter = ({ renderer: r, urls }) => {
     but the calculated duration from the end date and start date provided is ${params.current}.`,
     "should add the term pastureGrass": () => `For Cycles with ${code("siteType=permanent pasture")} we recommend specifying the type(s) of ${code("Pasture grass")} grown.
     This is particularly important for ruminants and will allow for a more accurate estimate of the amount of grass grazed.`,
-    "should add the fields for a relative cycle": ({ params }) => {
-      var _a;
-      return `We strongly recommend setting ${(_a = params == null ? void 0 : params.expected) == null ? void 0 : _a.map((param) => code(param)).join("and")} on all other sites for any uploads with a ${code(
-        "relative"
-      )} functional unit. This will allow calculation of land occupation and land transformation.`;
+    "can not calculate all emissions": ({ params }) => {
+      var _a, _b, _c;
+      const indicators = "GWP100, acidification and other similar indicators";
+      const recommended = (_a = params == null ? void 0 : params.recommended) != null ? _a : [];
+      const missing = (_b = params == null ? void 0 : params.missing) != null ? _b : [];
+      const missingCount = missing.reduce(
+        (count, { terms }) => count + terms.length,
+        0
+      );
+      const unlocked = (_c = params == null ? void 0 : params.newlyCovered) != null ? _c : [];
+      const these = recommended.length === 1 ? "this" : "all of this";
+      return (recommended.length ? [
+        r.bold(`HESTIA cannot yet calculate all the emissions used by ${indicators} for this Cycle.`),
+        "To calculate more of them:",
+        ...recommended.map(coverageItem),
+        unlocked.length ? `With ${these}, HESTIA could calculate ${unlocked.length} more ${pluralize("emission", unlocked.length)}, such as: ${termNames(unlocked)}.` : `With ${these}, HESTIA could calculate more of these emissions.`,
+        ...missing.length ? [
+          `Even then, ${pluralizeCount(missingCount, "emission")} will be missing, so the indicators using ${missingCount === 1 ? "it" : "them"} will be incomplete:`,
+          ...missing.map(coverageMissing)
+        ] : []
+      ] : [
+        r.bold(
+          `With the data provided, ${pluralizeCount(missingCount, "emission")} used by ${indicators} cannot be calculated, so those indicators will be incomplete:`
+        ),
+        ...missing.map(coverageMissing)
+      ]).join(r.lineBreak);
     },
+    "should add the fields for a relative cycle": ({ params }) => `We strongly recommend setting ${listAsCodeWithAnd(params == null ? void 0 : params.expected)} on all other sites for any uploads with a ${code(
+      "relative"
+    )} functional unit. This will allow calculation of land occupation and land transformation.`,
     "must not be blank if complete": ({ params }) => `If completeness is set to true for ${schemaLink(
       `Completeness#${params.expected}`,
       params.expected

package/index.js

@@ -718,6 +718,11 @@ var validations = [
     level: "error",
     message: "must have a value or a distance if complete"
   },
+  {
+    function: "validate_coverage",
+    level: "warning",
+    message: "can not calculate all emissions"
+  },
   {
     function: "validate_has_termType",
     level: "warning",

package/index.mjs

@@ -716,6 +716,11 @@ var validations = [
     level: "error",
     message: "must have a value or a distance if complete"
   },
+  {
+    function: "validate_coverage",
+    level: "warning",
+    message: "can not calculate all emissions"
+  },
   {
     function: "validate_has_termType",
     level: "warning",

package/package.json

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

package/validation.json

@@ -705,6 +705,11 @@
       "level": "error",
       "message": "must have a value or a distance if complete"
     },
+    {
+      "function": "validate_coverage",
+      "level": "warning",
+      "message": "can not calculate all emissions"
+    },
     {
       "function": "validate_has_termType",
       "level": "warning",