@hestia-earth/ui-components 0.43.11 → 0.43.13

package/fesm2022/hestia-earth-ui-components-file-errors.mjs

@@ -498,9 +498,22 @@ const guidePageId = (nodeType, errorMessage) => {
 };
 const mapErrorMessage = 'does not contain latitude and longitude';
 const allowedDataPathsLabels = Object.values(SchemaType);
+const isInfrastructureInputTermType = (dataPath = '') => /infrastructure\[\d+\]\.inputs\[\d+\]\.term\.termType$/.test(dataPath);
 const idPatternError = (chars) => `You can only use the following characters for this field: ${chars.join(', ')}`;
 const noTillage = { id: 'noTillage', name: 'No tillage' };
 const pastureGrass = { id: 'pastureGrass', name: 'Pasture grass' };
+/**
+ * Which distribution flagged a value as outside its confidence interval.
+ *
+ * The two mean very different things, so the message has to say which one fired: a `posterior` is
+ * fitted to HESTIA Cycle data for this country and product, while a `prior` is only the FAOSTAT
+ * national average — it stands in for any country/product too thin to have a posterior, so it is
+ * weak evidence rather than an alarm.
+ */
+const distributionSourceMessage = {
+    prior: 'This was flagged against the FAOSTAT prior (national average), not HESTIA Cycle data for this product, so it is weak evidence.',
+    posterior: 'This was flagged against HESTIA Cycle data for this product in this country.'
+};
 const isMigrationError = ({ params }) => params?.current && 'expected' in params;
 /**
  * Builds the error formatting functions for a given presentation (`renderer`) and link
@@ -519,6 +532,8 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
     const glossaryTypeLink = (type, text = termTypeLabel(type)) => r.link(`${urls.glossaryBaseUrl()}?termType=${type}`, text);
     const termLink = ({ id, name }) => r.link(`${urls.baseUrl()}/term/${id}`, name || id);
     const listAsCode = (values) => (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 ?? []).map(value => r.code(value)));
     const joinValues = (values) => (values || [])
         .filter(Boolean)
         .map(value => r.code(value))
@@ -583,6 +598,18 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
                             ? `${r.underline(negation ? 'none' : 'one')} of the following must be valid: ${formatList(rule.anyOf.map(nested => formatRule(nested)))}`
                             : '';
     const patternErrorKey = (pattern) => `should match pattern "${pattern}"`;
+    /**
+     * Names the distribution(s) behind the grouped warnings, as a trailing sentence.
+     *
+     * Returns an empty string when no error carries a `source`, so warnings raised before the
+     * validation service started sending it read exactly as they did before.
+     */
+    const distributionSources = (errors) => {
+        const sentences = unique(errors.map(({ params }) => params?.source))
+            .map(source => distributionSourceMessage[source])
+            .filter(Boolean);
+        return sentences.length ? `${sentences.join(r.lineBreak)}${r.lineBreak}` : '';
+    };
     // set message as empty to not display it
     const customErrorMessage = {
         'this field is required': ({ dataPath }, _errorCount, allErrors) => {
@@ -612,6 +639,9 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
         },
         "should have required property '@id'": idNotFoundError,
         "should have required property 'id'": idNotFoundError,
+        "should have required property 'inputsCompleteness'": () => `You must add the ${schemaLink('Infrastructure#inputsCompleteness', 'inputsCompleteness')} field when you have specified inputs for the Site infrastructure.
+    This allows us to know whether the ${code('material')} completeness can be updated after copying the
+    infrastructure inputs to the Cycle.`,
         'should match exactly one schema in oneOf': () => '',
         'should match some schema in anyOf': () => '',
         'should match "then" schema': () => '',
@@ -709,16 +739,20 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
                 ].every(Boolean))
                 : null;
             return [
-                dataPath.endsWith('term.termType')
-                    ? [
-                        `For ${pluralize(paths[paths.length - 3].label, 0)}, we only allow terms from the following glossaries: ${listAsCode(params?.allowedValues)}.`,
-                        ifError
-                            ? ''
-                            : 'Please either change the Term you are using and ensure it is from one of the glossaries listed above, or follow the schema to identify where this Term can be added.'
-                    ]
-                        .filter(Boolean)
-                        .join(' ')
-                    : `Only the following ${values} are permitted: ${listAsCode(params?.allowedValues)}.`,
+                isInfrastructureInputTermType(dataPath)
+                    ? `Only terms in the ${listAsCodeWithAnd(params?.allowedValues)} glossaries can be added as inputs to Site
+        infrastructure. Other inputs, e.g., ${code('fuel')}, should be specified on the Cycle.
+        You can use the ${schemaLink('Input#operation', 'operation')} field on inputs to specify what the input is for.`
+                    : dataPath.endsWith('term.termType')
+                        ? [
+                            `For ${pluralize(paths[paths.length - 3].label, 0)}, we only allow terms from the following glossaries: ${listAsCode(params?.allowedValues)}.`,
+                            ifError
+                                ? ''
+                                : 'Please either change the Term you are using and ensure it is from one of the glossaries listed above, or follow the schema to identify where this Term can be added.'
+                        ]
+                            .filter(Boolean)
+                            .join(' ')
+                        : `Only the following ${values} are permitted: ${listAsCode(params?.allowedValues)}.`,
                 ifError?.schema.properties
                     ? `This validation applies when the following conditions are met:${formatList(Object.entries(ifError.schema.properties).map(([key, value]) => formatRule(value, key)))}`
                     : ''
@@ -893,7 +927,7 @@ const 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 }) => params?.outliers?.map(value => `The ${dataPath.includes('product') ? 'product' : 'input'} value ${errorCount === 1 ? `${code(value)} ` : ''}is ${value > params?.min ? 'above' : 'below'} ${params?.threshold ? `${code(`${(params.threshold + (1 - params.threshold) / 2) * 100}%`)} of` : ''} all ${params?.group ? code(params.group) : code(params?.term?.name)} data in ${code(params?.country.name)} on the HESTIA platform.`))).join(r.lineBreak)}${r.lineBreak}
+        'is outside confidence interval': (error, errorCount, allErrors) => `${unique((allErrors.length ? allErrors : [error]).flatMap(({ dataPath, params }) => params?.outliers?.map(value => `The ${dataPath.includes('product') ? 'product' : 'input'} value ${errorCount === 1 ? `${code(value)} ` : ''}is ${value > params?.min ? 'above' : 'below'} ${params?.threshold ? `${code(`${(params.threshold + (1 - params.threshold) / 2) * 100}%`)} of` : ''} all ${params?.group ? code(params.group) : code(params?.term?.name)} data in ${code(params?.country.name)} on the HESTIA platform.`))).join(r.lineBreak)}${r.lineBreak}${distributionSources(allErrors.length ? allErrors : [error])}
     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?.expected)} ha.
     This may be an error if the boundary represents the area under cultivation.`,
@@ -1198,7 +1232,7 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
         const field = message.split("'")[1].replace("'", '');
         const nodeType = dataPathLabel(error?.dataPath);
         return `You are missing the following required field: ${code(field)}. ${nodeType && nodeType.toLowerCase() !== 'completeness'
-            ? `Either: add ${code(field)}, or if you if you did not intend to add this ${nodeType}, please remove all fields on this ${nodeType}.`
+            ? `Either: add ${code(field)}, or if you did not intend to add this ${nodeType}, please remove all fields on this ${nodeType}.`
             : ''}`.trim();
     };
     const parseDefaultMessage = (message, error) => r.capitalizeFirst(message?.startsWith('should have required property') ? requiredPropertyError(message, error) : message);