@hestia-earth/glossary 0.97.1 → 0.98.1

package/index.js

@@ -28,6 +28,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   getArrayTreatment: () => getArrayTreatment,
+  getBackgroundEmissionModels: () => getBackgroundEmissionModels,
+  getBackgroundEmissionTerms: () => getBackgroundEmissionTerms,
+  getBackgroundEmissionTermsByModel: () => getBackgroundEmissionTermsByModel,
   getBafuMapping: () => getBafuMapping,
   getBlankNodesGroup: () => getBlankNodesGroup,
   getDefaultModelId: () => getDefaultModelId,
@@ -41,6 +44,7 @@ __export(index_exports, {
   getTermTypeLookups: () => getTermTypeLookups,
   getWorldSteelMapping: () => getWorldSteelMapping,
   idToIso31662: () => idToIso31662,
+  isBackgroundEmission: () => isBackgroundEmission,
   isCoverCrop: () => isCoverCrop,
   isInSystemBoundary: () => isInSystemBoundary,
   isPlantation: () => isPlantation,
@@ -51,6 +55,8 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_arrayTreatment = __toESM(require("./resources/arrayTreatment.json"), 1);
+var import_backgroundEmissionTerms = __toESM(require("./resources/backgroundEmissionTerms.json"), 1);
+var import_backgroundEmissionTermsByModel = __toESM(require("./resources/backgroundEmissionTermsByModel.json"), 1);
 var import_bafuMapping = __toESM(require("./resources/bafuMapping.json"), 1);
 var import_blankNodesGroup = __toESM(require("./resources/blankNodesGroup.json"), 1);
 var import_defaultModelId = __toESM(require("./resources/defaultModelId.json"), 1);
@@ -69,6 +75,8 @@ var import_termType_lookups = __toESM(require("./resources/termType-lookups.json
 var import_worldsteelMapping = __toESM(require("./resources/worldsteelMapping.json"), 1);
 const RESOURCES = {
   "arrayTreatment.json": import_arrayTreatment.default,
+  "backgroundEmissionTerms.json": import_backgroundEmissionTerms.default,
+  "backgroundEmissionTermsByModel.json": import_backgroundEmissionTermsByModel.default,
   "bafuMapping.json": import_bafuMapping.default,
   "blankNodesGroup.json": import_blankNodesGroup.default,
   "defaultModelId.json": import_defaultModelId.default,
@@ -103,6 +111,19 @@ const isInSystemBoundary = (id) => {
   const value = import_inHestiaDefaultSystemBoundary.default[id];
   return !value || value === "true";
 };
+const backgroundEmissions = new Set(import_backgroundEmissionTerms.default);
+const isBackgroundEmission = (id) => backgroundEmissions.has(id);
+const getBackgroundEmissionTerms = () => [...import_backgroundEmissionTerms.default];
+const getBackgroundEmissionTermsByModel = (modelId) => import_backgroundEmissionTermsByModel.default[modelId];
+const backgroundEmissionModels = Object.entries(
+  import_backgroundEmissionTermsByModel.default
+).reduce((prev, [model, indicators]) => {
+  Object.values(indicators).flat().forEach((id) => {
+    prev[id] = [...prev[id] ?? [], model];
+  });
+  return prev;
+}, {});
+const getBackgroundEmissionModels = (id) => backgroundEmissionModels[id] ?? [];
 const plantations = new Set(import_isPlantation.default);
 const isPlantation = (id) => plantations.has(id);
 const getEcoalimMapping = (id) => import_ecoalimMapping.default[id];
@@ -117,6 +138,9 @@ const termOrder = ({ "@id": id, termType }) => termType ? id ? import_term_order
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getArrayTreatment,
+  getBackgroundEmissionModels,
+  getBackgroundEmissionTerms,
+  getBackgroundEmissionTermsByModel,
   getBafuMapping,
   getBlankNodesGroup,
   getDefaultModelId,
@@ -130,6 +154,7 @@ const termOrder = ({ "@id": id, termType }) => termType ? id ? import_term_order
   getTermTypeLookups,
   getWorldSteelMapping,
   idToIso31662,
+  isBackgroundEmission,
   isCoverCrop,
   isInSystemBoundary,
   isPlantation,

package/index.mjs

@@ -1,19 +1,6 @@
-// Tree-shakeable ESM entry point — the single source of truth for the public
-// API. The CommonJS entry (`index.js`, used by Node `require`) is GENERATED from
-// this file by `npm run build:index` (run automatically via the `prepare` hook
-// on install/publish), so edit this file only — never `index.js`.
-//
-// Every resource is imported statically so that bundlers (webpack, rollup,
-// esbuild, …) can statically determine which JSON files each export depends on
-// and drop the rest. Combined with `"sideEffects": false` in package.json, a
-// consumer importing a single getter only pulls in the one resource it needs,
-// instead of the whole `resources/` directory.
-//
-// To add a resource getter: add its static `import` below, the matching
-// `export const`, and (only if it should be reachable via the generic
-// `loadResourceKey`) an entry in the `RESOURCES` map.
-
 import arrayTreatment from "./resources/arrayTreatment.json" with { type: "json" };
+import backgroundEmissionTermIds from "./resources/backgroundEmissionTerms.json" with { type: "json" };
+import backgroundEmissionTermsByModel from "./resources/backgroundEmissionTermsByModel.json" with { type: "json" };
 import bafuMapping from "./resources/bafuMapping.json" with { type: "json" };
 import blankNodesGroup from "./resources/blankNodesGroup.json" with { type: "json" };
 import defaultModelId from "./resources/defaultModelId.json" with { type: "json" };
@@ -36,6 +23,8 @@ import worldsteelMapping from "./resources/worldsteelMapping.json" with { type:
 // resources only it references) when a consumer never imports those helpers.
 const RESOURCES = {
   "arrayTreatment.json": arrayTreatment,
+  "backgroundEmissionTerms.json": backgroundEmissionTermIds,
+  "backgroundEmissionTermsByModel.json": backgroundEmissionTermsByModel,
   "bafuMapping.json": bafuMapping,
   "blankNodesGroup.json": blankNodesGroup,
   "defaultModelId.json": defaultModelId,
@@ -157,6 +146,61 @@ export const isInSystemBoundary = (id) => {
   return !value || value === "true";
 };
 
+// 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.
+ */
+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).
+ */
+export const getBackgroundEmissionTermsByModel = (modelId) =>
+  backgroundEmissionTermsByModel[modelId];
+
+// built once, so repeated lookups do not scan every dataset
+const backgroundEmissionModels = Object.entries(
+  backgroundEmissionTermsByModel,
+).reduce((prev, [model, indicators]) => {
+  Object.values(indicators)
+    .flat()
+    .forEach((id) => {
+      prev[id] = [...(prev[id] ?? []), model];
+    });
+  return prev;
+}, {});
+
+/**
+ * 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.
+ */
+export const getBackgroundEmissionModels = (id) =>
+  backgroundEmissionModels[id] ?? [];
+
 // built once, so repeated checks do not scan the list
 const plantations = new Set(plantationIds);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/glossary",
-  "version": "0.97.1",
+  "version": "0.98.1",
   "description": "HESTIA Earth Glossary library",
   "main": "index.js",
   "module": "index.mjs",
@@ -22,6 +22,7 @@
   },
   "scripts": {
     "gen:impact-assessment": "node scripts/node/generate-impact-assessment-data.js",
+    "gen:background-emission-terms": "node scripts/node/generate-background-emission-terms.js",
     "gen:emission-grouping": "node scripts/node/generate-emission-groupings.js",
     "gen:lookups-data": "node scripts/node/generate-lookups-data.js",
     "gen:model-groups": "node scripts/node/generate-model-groups-data.js",