@hestia-earth/glossary 0.105.0 → 0.106.0

package/index.js

@@ -43,6 +43,7 @@ __export(index_exports, {
   getTermModelRestrictions: () => getTermModelRestrictions,
   getTermRestrictions: () => getTermRestrictions,
   getTermTypeLookups: () => getTermTypeLookups,
+  getUniqueUseGroupTerms: () => getUniqueUseGroupTerms,
   getWorldSteelMapping: () => getWorldSteelMapping,
   idToIso31662: () => idToIso31662,
   isBackgroundEmission: () => isBackgroundEmission,
@@ -74,6 +75,7 @@ var import_modelGroups = __toESM(require("./resources/modelGroups.json"), 1);
 var import_term_order = __toESM(require("./resources/term-order.json"), 1);
 var import_term_restrictions = __toESM(require("./resources/term-restrictions.json"), 1);
 var import_termType_lookups = __toESM(require("./resources/termType-lookups.json"), 1);
+var import_uniqueUseGroups = __toESM(require("./resources/uniqueUseGroups.json"), 1);
 var import_worldsteelMapping = __toESM(require("./resources/worldsteelMapping.json"), 1);
 const RESOURCES = {
   "arrayTreatment.json": import_arrayTreatment.default,
@@ -95,6 +97,7 @@ const RESOURCES = {
   "term-order.json": import_term_order.default,
   "term-restrictions.json": import_term_restrictions.default,
   "termType-lookups.json": import_termType_lookups.default,
+  "uniqueUseGroups.json": import_uniqueUseGroups.default,
   "worldsteelMapping.json": import_worldsteelMapping.default
 };
 const loadResourceKey = (filename, key) => {
@@ -110,6 +113,12 @@ const getDefaultModels = () => Object.entries(import_defaultModelId.default).fil
 const getTermRestrictions = (id) => import_term_restrictions.default[id];
 const getTermModelRestrictions = (id, modelId) => (import_term_restrictions.default[id] || {})[modelId];
 const getTermTypeLookups = (termType) => import_termType_lookups.default[termType];
+const uniqueUseGroupTerms = Object.fromEntries(
+  Object.values(import_uniqueUseGroups.default).flatMap(
+    (terms) => terms.map((term) => [term["@id"], terms])
+  )
+);
+const getUniqueUseGroupTerms = (id) => uniqueUseGroupTerms[id] ?? [];
 const isInSystemBoundary = (id) => {
   const value = import_inHestiaDefaultSystemBoundary.default[id];
   return !value || value === "true";
@@ -157,6 +166,7 @@ const termOrder = ({ "@id": id, termType }) => termType ? id ? import_term_order
   getTermModelRestrictions,
   getTermRestrictions,
   getTermTypeLookups,
+  getUniqueUseGroupTerms,
   getWorldSteelMapping,
   idToIso31662,
   isBackgroundEmission,

package/index.mjs

@@ -17,6 +17,7 @@ import modelGroups from "./resources/modelGroups.json" with { type: "json" };
 import termOrderData from "./resources/term-order.json" with { type: "json" };
 import termRestrictions from "./resources/term-restrictions.json" with { type: "json" };
 import termTypeLookups from "./resources/termType-lookups.json" with { type: "json" };
+import uniqueUseGroups from "./resources/uniqueUseGroups.json" with { type: "json" };
 import worldsteelMapping from "./resources/worldsteelMapping.json" with { type: "json" };
 
 // Map only used by the generic `loadResourceKey`/`loadResource` API below. It is
@@ -42,6 +43,7 @@ const RESOURCES = {
   "term-order.json": termOrderData,
   "term-restrictions.json": termRestrictions,
   "termType-lookups.json": termTypeLookups,
+  "uniqueUseGroups.json": uniqueUseGroups,
   "worldsteelMapping.json": worldsteelMapping,
 };
 
@@ -81,6 +83,16 @@ export const getTermModelRestrictions = (id, modelId) =>
 
 export const getTermTypeLookups = (termType) => termTypeLookups[termType];
 
+// built once, so repeated lookups do not scan every group
+const uniqueUseGroupTerms = Object.fromEntries(
+  Object.values(uniqueUseGroups).flatMap((terms) =>
+    terms.map((term) => [term["@id"], terms]),
+  ),
+);
+
+/** The Terms sharing the Term's `uniqueUseGroup`, itself included, with their `name` and `units`. */
+export const getUniqueUseGroupTerms = (id) => uniqueUseGroupTerms[id] ?? [];
+
 /** A Term with no `inHestiaDefaultSystemBoundary` value counts as in the boundary. */
 export const isInSystemBoundary = (id) => {
   const value = inHestiaDefaultSystemBoundary[id];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/glossary",
-  "version": "0.105.0",
+  "version": "0.106.0",
   "description": "HESTIA Earth Glossary library",
   "main": "index.js",
   "module": "index.mjs",
@@ -29,6 +29,7 @@
     "gen:term-order": "node scripts/node/generate-term-order.js",
     "gen:term-restrictions": "node scripts/node/generate-term-restrictions.js",
     "gen:termType-lookups": "node scripts/node/generate-termType-lookups.js",
+    "gen:unique-use-groups": "node scripts/node/generate-unique-use-groups.js",
     "generate:all": "npm-run-all --parallel \"gen:*\"",
     "build:index": "esbuild index.mjs --format=cjs --platform=node --outfile=index.js",
     "prepare": "npm run build:index",