@hestia-earth/ui-components 0.43.14 → 0.43.16

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

@@ -515,6 +515,11 @@ const distributionSourceMessage = {
     posterior: 'This was flagged against HESTIA Cycle data for this product in this country.'
 };
 const isMigrationError = ({ params }) => params?.current && 'expected' in params;
+/**
+ * "Check the Emission value you provided" — the term's own type names what to look at, and it is
+ * dropped entirely when the error carries no term, so the sentence never reads "the N/A value".
+ */
+const termTypeValueLabel = (term) => [term?.termType ? termTypeLabel(term.termType) : '', 'value'].filter(Boolean).join(' ');
 /**
  * Builds the error formatting functions for a given presentation (`renderer`) and link
  * configuration (`urls`). The error catalog below is the single source of truth; the
@@ -531,9 +536,14 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
     const guideLink = (guidePath, title) => r.link(`${urls.baseUrl()}/guide/${guidePath}`, title);
     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 humanizeTermId = (id) => id
+        .replace(/([a-z])([A-Z])/g, (_, lower, upper) => `${lower} ${upper.toLowerCase()}`)
+        .replace(/^./, (char) => char.toUpperCase());
     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 listAsTermLinksWithAnd = (termIds) => joinWithAnd((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))
@@ -800,7 +810,7 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
         ${params?.threshold ? `Our threshold is ±${threshold(params?.threshold)}.` : ''}
         Please either:
         ${formatList([
-                'Check the ${params?.term.termType} value you provided;',
+                `Check the ${termTypeValueLabel(params?.term)} you provided;`,
                 'Check the data you provided which is the input into this model;',
                 'Carefully read the documentation to understand if we used a default property as part of the calculations.'
             ], 'decimal')}`
@@ -850,12 +860,24 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
         'is too generic': ({ params }) => `You have the following Product ${code(params?.product?.name)} however,
     you have used a generic ${glossaryTypeLink(params?.term?.termType)} term ${code(params?.term?.name)}.
     Use a more specific term for the ${glossaryTypeLink(params?.term?.termType)} which reflects the specific ${glossaryTypeLink(params?.product?.termType)}.`,
-        'should not use identical terms with different units': ({ params }) => `You have added the same ${code(params?.term?.termType)} in ${params?.units
-            ?.map(unit => code(unit))
-            .join(' and ')} units.
-    If these terms refer to the same ${code(params?.term?.termType)}, this will lead to double counting.${params?.units?.includes('kg N')
-            ? ` Instead use the ${termLink({ id: 'nitrogenContent', name: 'Nitrogen Content' })} Property on the ${code('kg')} term to define the nitrogen content of the ${code(params?.term?.termType)}.`
-            : ''}`,
+        'should not use several terms describing the same product': ({ params }) => {
+            const isFertiliser = params?.term?.termType === TermTermType.organicFertiliser;
+            const blankNode = isFertiliser ? 'Input' : 'Product';
+            const subject = isFertiliser ? 'the same application' : 'the same animals';
+            const fix = isFertiliser
+                ? `nutrient content Properties, such as ${termLink({
+                    id: 'nitrogenContent',
+                    name: 'Nitrogen Content'
+                })}, to state how much of each nutrient it carries`
+                : `${glossaryQueryLink('Processing conversion', TermTermType.property)} Properties to state the other weights`;
+            return `You have added ${termLink({
+                id: params?.term?.['@id'],
+                name: params?.term?.name
+            })} alongside ${listAsTermLinksWithAnd(params?.termIds)}.
+    These ${glossaryTypeLink(params?.term?.termType)} terms are alternative ways of stating the same quantity,
+    so if they refer to ${subject}, this will lead to double counting.
+    Instead keep a single ${blankNode} and add the relevant ${fix}.`;
+        },
         'is missing required bibliographic information': () => `The automatic bibliography search failed for this Bibliography. Either:
     ${formatList([
             `Manually fill-in the ${r.bold('required')} bibliographic information as per ${schemaLink(SchemaType.Bibliography, 'our schema')}.`,
@@ -1106,6 +1128,16 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
             : ''}`,
         'invalid water salinity': ({ params }) => `The water type ${params?.current} is not consistent with the Water salinity you specified.
     Make sure the Water salinity value is correct and either fix it or update the water type accordingly.`,
+        'requires a water salinity measurement': ({ params: { term, expected } = {} }) => {
+            const measurements = (expected || []).map(id => externalNodeLink({ '@type': NodeType.Term, '@id': id, name: humanizeTermId(id) }));
+            return `You have recorded the product ${code(term?.name || term?.['@id'])}, but this species can be reared in more
+    than one salinity type and does not have a ${code('defaultSalinity')} value, so we cannot gap-fill the salinity
+    of the water.
+    Please specify the salinity of the system by adding ${measurements.length > 0
+                ? `one of ${joinWithAnd(measurements)} to the ${schemaLink('Site#measurements', 'Site measurements')}`
+                : `a water salinity measurement to the ${schemaLink('Site#measurements', 'Site measurements')}`}.
+    This will allow us to model the emissions accurately.`;
+        },
         'measurements for the same termType must be consistent': ({ params }) => `The information you have provided for ${code(params.termType)} Measurements is not consistent across all Measurements.
     Please ensure that all your ${code(params.termType)} Measurements have a ${code('dates')} field if at least one ${code(params.termType)} Measurement has a ${code('dates')} field specified.
     Please also ensure that all your ${code(params.termType)} Measurements have ${code('depthUpper')} and ${code('depthLower')} fields if at least one ${code(params.termType)} Measurement has ${code('depthUpper')} and ${code('depthLower')} fields specified.`,
@@ -1169,6 +1201,12 @@ const createErrorFormatter = ({ renderer: r, urls }) => {
         })}.
     This input should be present in each plantation Cycle in your upload, with the ${code('value')} being the total number of ${code('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.`,
+        'must use the depreciated term': ({ params }) => `${code(params.term?.name || params.term?.['@id'])} is used over more than one Cycle, so a Cycle Input must record only the amount depreciated over this Cycle.
+    Use ${termLink({
+            id: params.expected,
+            name: humanizeTermId(params.expected)
+        })} instead, with the ${code('value')} being the total amount used divided by the number of Cycles over its lifespan.
+    Alternatively, record it on the Site as an ${schemaLink('Infrastructure')} input with a ${code('lifespan')}, and HESTIA will calculate the depreciated amount for you.`,
         'must be linked to a verified country-level Impact Assessment': ({ params }) => [
             'This Input must be linked to a country-level verified aggregation, but none could be found.',
             params?.current ? 'Note: using a verified World aggregation is not valid.' : ''