@hestia-earth/glossary 0.98.3 → 0.100.0

package/index.js

@@ -37,6 +37,7 @@ __export(index_exports, {
   getDefaultModels: () => getDefaultModels,
   getEcoalimMapping: () => getEcoalimMapping,
   getEcoinventMapping: () => getEcoinventMapping,
+  getElcd32Mapping: () => getElcd32Mapping,
   getEmissionGroupings: () => getEmissionGroupings,
   getModelGroup: () => getModelGroup,
   getTermModelRestrictions: () => getTermModelRestrictions,
@@ -62,6 +63,7 @@ var import_blankNodesGroup = __toESM(require("./resources/blankNodesGroup.json")
 var import_defaultModelId = __toESM(require("./resources/defaultModelId.json"), 1);
 var import_ecoalimMapping = __toESM(require("./resources/ecoalimMapping.json"), 1);
 var import_ecoinventMapping = __toESM(require("./resources/ecoinventMapping.json"), 1);
+var import_elcd32Mapping = __toESM(require("./resources/elcd32Mapping.json"), 1);
 var import_emission_groupings = __toESM(require("./resources/emission-groupings.json"), 1);
 var import_id_to_iso3166_2 = __toESM(require("./resources/id-to-iso3166-2.json"), 1);
 var import_inHestiaDefaultSystemBoundary = __toESM(require("./resources/inHestiaDefaultSystemBoundary.json"), 1);
@@ -82,6 +84,7 @@ const RESOURCES = {
   "defaultModelId.json": import_defaultModelId.default,
   "ecoalimMapping.json": import_ecoalimMapping.default,
   "ecoinventMapping.json": import_ecoinventMapping.default,
+  "elcd32Mapping.json": import_elcd32Mapping.default,
   "emission-groupings.json": import_emission_groupings.default,
   "id-to-iso3166-2.json": import_id_to_iso3166_2.default,
   "inHestiaDefaultSystemBoundary.json": import_inHestiaDefaultSystemBoundary.default,
@@ -130,6 +133,7 @@ const getEcoalimMapping = (id) => import_ecoalimMapping.default[id];
 const getEcoinventMapping = (id) => import_ecoinventMapping.default[id];
 const getWorldSteelMapping = (id) => import_worldsteelMapping.default[id];
 const getBafuMapping = (id) => import_bafuMapping.default[id];
+const getElcd32Mapping = (id) => import_elcd32Mapping.default[id];
 const getBlankNodesGroup = (id) => import_blankNodesGroup.default[id];
 const getEmissionGroupings = (id) => import_emission_groupings.default[id];
 const isCoverCrop = (id) => getBlankNodesGroup(id) === "Cover crops";
@@ -147,6 +151,7 @@ const termOrder = ({ "@id": id, termType }) => termType ? id ? import_term_order
   getDefaultModels,
   getEcoalimMapping,
   getEcoinventMapping,
+  getElcd32Mapping,
   getEmissionGroupings,
   getModelGroup,
   getTermModelRestrictions,

package/index.mjs

@@ -6,6 +6,7 @@ import blankNodesGroup from "./resources/blankNodesGroup.json" with { type: "jso
 import defaultModelId from "./resources/defaultModelId.json" with { type: "json" };
 import ecoalimMapping from "./resources/ecoalimMapping.json" with { type: "json" };
 import ecoinventMapping from "./resources/ecoinventMapping.json" with { type: "json" };
+import elcd32Mapping from "./resources/elcd32Mapping.json" with { type: "json" };
 import emissionGroupings from "./resources/emission-groupings.json" with { type: "json" };
 import idToIso31662Map from "./resources/id-to-iso3166-2.json" with { type: "json" };
 import inHestiaDefaultSystemBoundary from "./resources/inHestiaDefaultSystemBoundary.json" with { type: "json" };
@@ -30,6 +31,7 @@ const RESOURCES = {
   "defaultModelId.json": defaultModelId,
   "ecoalimMapping.json": ecoalimMapping,
   "ecoinventMapping.json": ecoinventMapping,
+  "elcd32Mapping.json": elcd32Mapping,
   "emission-groupings.json": emissionGroupings,
   "id-to-iso3166-2.json": idToIso31662Map,
   "inHestiaDefaultSystemBoundary.json": inHestiaDefaultSystemBoundary,
@@ -44,103 +46,42 @@ const RESOURCES = {
 };
 
 /**
- * Get a value from a resource by filename.
- *
- * Prefer the dedicated getters below when possible: using this generic helper
+ * Get a value from a resource by filename. Prefer the dedicated getters below: this one
  * defeats tree-shaking, as it can reference any bundled resource.
- *
- * @param {string} filename The name of the file containing the resources.
- * @param {string} key The key in the resource file.
- * @returns {any} The data associated with the `key`.
  */
 export const loadResourceKey = (filename, key) => {
   const resource = RESOURCES[filename];
   return key ? resource?.[key] : resource;
 };
 
-/**
- * Converts the iso31662 code to the [term.name](https://hestia.earth/schema/Term#name) from the HESTIA Glossary.
- *
- * @param {string} code The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
- * @returns {string} The HESTIA country [name](https://hestia.earth/schema/Term#name).
- */
+/** Converts an ISO 3166-2 code to the HESTIA region name. */
 export const iso31662ToName = (code = "") =>
   iso31662ToNameMap[code.toUpperCase()];
 
-/**
- * Converts the iso31662 code to the [term.id](https://hestia.earth/schema/Term#id) from the HESTIA Glossary.
- *
- * @param {string} code The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
- * @returns {string} The HESTIA country [id](https://hestia.earth/schema/Term#id).
- */
+/** Converts an ISO 3166-2 code to the HESTIA region id. */
 export const iso31662ToId = (code = "") => iso31662ToIdMap[code.toUpperCase()];
 
-/**
- * Converts the [term.id](https://hestia.earth/schema/Term#id) from the HESTIA Glossary to a iso31662 code.
- *
- * @param {string} id The HESTIA country [id](https://hestia.earth/schema/Term#id).
- * @returns {string} The [iso31662 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
- */
+/** Converts a HESTIA region id to its ISO 3166-2 code. */
 export const idToIso31662 = (id = "") => idToIso31662Map[id.toUpperCase()];
 
-/**
- * Determines how an array of values should be handled (if summed up, or averaged, etc.).
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {string} Possible values are: `mean`, `mode` and `sum`.
- */
+/** How an array of values is combined: `mean`, `mode` or `sum` (the default). */
 export const getArrayTreatment = (id) => arrayTreatment[id] || "sum";
 
-/**
- * Returns the `@id` of the default model that should be used for display of this Term.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {string} The `@id` of the model if set.
- */
 export const getDefaultModelId = (id) => defaultModelId[id];
 
-/**
- * Returns the list of `@id` of the default models that should be used for display.
- *
- * @returns {string[]} The list of default `@id`.
- */
 export const getDefaultModels = () =>
   Object.entries(defaultModelId)
     .filter(([, value]) => !!value)
     .map(([key]) => key);
 
-/**
- * Returns the list of restrictions of the Term.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns A list of restrictions as an object.
- */
 export const getTermRestrictions = (id) => termRestrictions[id];
 
-/**
- * Returns the list of restrictions of the Term/Model mapping.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @param {string} modelId The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns A list of restrictions as an object.
- */
 export const getTermModelRestrictions = (id, modelId) =>
   (termRestrictions[id] || {})[modelId];
 
-/**
- * Returns the list of restrictions of the Term/Model mapping.
- *
- * @param {string} termType The HESTIA term [termType](https://hestia.earth/schema/Term#termType).
- * @returns A list of lookups.
- */
 export const getTermTypeLookups = (termType) => termTypeLookups[termType];
 
-/**
- * Checks whether the emission is in the HESTIA System Boundary.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {boolean} True if the Term is included.
- */
+/** A Term with no `inHestiaDefaultSystemBoundary` value counts as in the boundary. */
 export const isInSystemBoundary = (id) => {
   const value = inHestiaDefaultSystemBoundary[id];
   return !value || value === "true";
@@ -149,29 +90,12 @@ export const isInSystemBoundary = (id) => {
 // built once, so repeated checks do not scan the list
 const backgroundEmissions = new Set(backgroundEmissionTermIds);
 
-/**
- * Checks whether the emission or resource use is a background one - attributed to producing an
- * input rather than to the Cycle itself, and carried by a background emissions lookup.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {boolean} True if a background emissions lookup carries a value for the Term.
- */
+/** True when a background emissions lookup carries a value for the Term. */
 export const isBackgroundEmission = (id) => backgroundEmissions.has(id);
 
-/**
- * Returns every Term a background emissions lookup carries a value for, across every dataset.
- *
- * @returns {string[]} The HESTIA term [ids](https://hestia.earth/schema/Term#id).
- */
 export const getBackgroundEmissionTerms = () => [...backgroundEmissionTermIds];
 
-/**
- * Returns the Terms one background emissions dataset carries a value for, by indicator
- * (`emission` and `resourceUse`).
- *
- * @param {string} modelId The `@id` of the model whose lookups carry the values.
- * @returns {{emission: string[], resourceUse: string[]}} The HESTIA term [ids](https://hestia.earth/schema/Term#id).
- */
+/** The Terms one background emissions dataset carries a value for, by `emission` and `resourceUse`. */
 export const getBackgroundEmissionTermsByModel = (modelId) =>
   backgroundEmissionTermsByModel[modelId];
 
@@ -188,15 +112,9 @@ const backgroundEmissionModels = Object.entries(
 }, {});
 
 /**
- * Returns the models whose background emissions lookups carry a value for the Term.
- *
- * This is not which model produced a given emission - several datasets carry the same Term, so
- * only the blank node's `methodModel` says which one ran. Models deriving their values from
- * these datasets rather than carrying their own lookups (`linkedImpactAssessment`, `hestia`)
- * are not listed here; `@hestia-earth/engine-models` links those per Term.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {string[]} The `@id` of each model.
+ * The models whose background emissions lookups carry a value for the Term - not which one
+ * produced a given emission, which only the blank node's `methodModel` says. Models deriving
+ * their values from these datasets (`linkedImpactAssessment`, `hestia`) are not listed.
  */
 export const getBackgroundEmissionModels = (id) =>
   backgroundEmissionModels[id] ?? [];
@@ -204,13 +122,6 @@ export const getBackgroundEmissionModels = (id) =>
 // built once, so repeated checks do not scan the list
 const plantations = new Set(plantationIds);
 
-/**
- * Checks whether the crop is grown as a plantation - a permanent crop that produces over several
- * years, rather than one planted and harvested within a Cycle.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {boolean} True if the Term is a plantation crop.
- */
 export const isPlantation = (id) => plantations.has(id);
 
 export const getEcoalimMapping = (id) => ecoalimMapping[id];
@@ -221,38 +132,17 @@ export const getWorldSteelMapping = (id) => worldsteelMapping[id];
 
 export const getBafuMapping = (id) => bafuMapping[id];
 
+export const getElcd32Mapping = (id) => elcd32Mapping[id];
+
 export const getBlankNodesGroup = (id) => blankNodesGroup[id];
 
-/**
- * Get the groupings for the Emission.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {object} Different groupings types and values.
- */
 export const getEmissionGroupings = (id) => emissionGroupings[id];
 
-/**
- * Determines if the property is identifying a cover crop.
- *
- * @param {*} id The property `@id`
- * @returns `true` if the property represents a cover crop.
- */
 export const isCoverCrop = (id) => getBlankNodesGroup(id) === "Cover crops";
 
-/**
- * Return the group for this term with a specific model.
- *
- * @param {string} id The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @param {string} modelId The HESTIA term [id](https://hestia.earth/schema/Term#id).
- * @returns {string} The HESTIA term [id](https://hestia.earth/schema/Term#id) of the group.
- */
 export const getModelGroup = (id, modelId) => (modelGroups[id] || {})[modelId];
 
-/**
- *
- * @param {object} term The HESTIA term, providing `@id` and/or `termType`.
- * @returns {number|list} The index if searching for a specific Term by `@id`, or the ordered list of ids if search by `termType`.
- */
+/** The Term's index when given an `@id`, or the ordered ids when given only a `termType`. */
 export const termOrder = ({ "@id": id, termType }) =>
   termType
     ? id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/glossary",
-  "version": "0.98.3",
+  "version": "0.100.0",
   "description": "HESTIA Earth Glossary library",
   "main": "index.js",
   "module": "index.mjs",