@hestia-earth/engine-models 0.65.1

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@hestia-earth/engine-models",
+  "version": "0.65.1",
+  "description": "HESTIA Engine Models",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "build:models": "node scripts/generate-models-links.js",
+    "build:documentation": "node scripts/generate-documentation.js",
+    "build": "npm run build:models && npm run build:documentation",
+    "build:module": "rm -rf dist && tsc -p tsconfig.dist.json",
+    "lint": "tsc --noEmit && eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --coverage",
+    "test:jsonld": "hestia-validate-jsonld '' tests/fixtures",
+    "test:terms": "node scripts/validate-terms-models.js && hestia-validate-terms tests/fixtures",
+    "prepare-release": "node scripts/update-package-version.js && npm run build",
+    "release": "standard-version -a",
+    "postrelease": "git push origin develop --follow-tags"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/hestia-earth/hestia-engine-models.git"
+  },
+  "keywords": [
+    "hestia",
+    "engine",
+    "models",
+    "gap-filling",
+    "calculation",
+    "python"
+  ],
+  "author": "Guillaume Royer <guillaume@hestia.earth>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/hestia-earth/hestia-engine-models/issues"
+  },
+  "homepage": "https://gitlab.com/hestia-earth/hestia-engine-models#readme",
+  "peerDependencies": {
+    "@hestia-earth/schema": "*"
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.26.0",
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@hestia-earth/eslint-config": "^0.1.0",
+    "@hestia-earth/api": "^0.24.34",
+    "@hestia-earth/glossary": "^0.60.0",
+    "@hestia-earth/json-schema": "^30.5.0",
+    "@hestia-earth/schema": "^30.5.0",
+    "@hestia-earth/schema-validation": "^30.5.0",
+    "@hestia-earth/utils": "^0.13.0",
+    "@jest/globals": "^29.7.0",
+    "@typescript-eslint/eslint-plugin": "^5.23.0",
+    "@typescript-eslint/parser": "^5.23.0",
+    "aws-sdk": "^2.1608.0",
+    "axios": "^1.7.2",
+    "capitalize": "^2.0.4",
+    "csvtojson": "^2.0.10",
+    "dotenv": "^8.6.0",
+    "eslint": "^7.32.0",
+    "eslint-plugin-jsdoc": "^30.7.13",
+    "husky": "^4.3.8",
+    "jest": "^29.7.0",
+    "lodash.merge": "^4.6.2",
+    "pluralize": "^8.0.0",
+    "standard-version": "^9.5.0",
+    "ts-jest": "^29.2.5"
+  },
+  "standard-version": {
+    "scripts": {
+      "postchangelog": "npm run prepare-release && git add model-links.json && git add hestia_earth/models/**/*.md && git add hestia_earth/models/version.py"
+    }
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './models';

package/src/models.spec.ts

@@ -0,0 +1,12 @@
+import { describe, expect, test } from '@jest/globals';
+
+import { loadModels } from './models';
+
+describe('models', () => {
+  describe('loadModels', () => {
+    test('load models', () => {
+      const { links } = loadModels();
+      expect(links?.length > 0).toBeTruthy();
+    });
+  });
+});

package/src/models.ts

@@ -0,0 +1,44 @@
+import { EmissionMethodTier } from '@hestia-earth/schema';
+
+export interface IModel {
+  /**
+   * Is model from EcoinventV3.
+   */
+  ecoinvent: boolean;
+  /**
+   * Path to the implementation (code) of the model.
+   */
+  path: string;
+  /**
+   * Path to the documentation of the model.
+   */
+  docPath: string;
+  /**
+   * Path to the API Documentation.
+   */
+  apiDocsPath?: string;
+  /**
+   * The name of the model used as `methodModel`.
+   */
+  model: string;
+  /**
+   * The term the model is associated with.
+   */
+  term?: string;
+  /**
+   * The methodTier of the Emission (if applicable).
+   */
+  methodTier?: EmissionMethodTier;
+  /**
+   * A key in the model if term does not exist.
+   */
+  modelKey?: string;
+}
+
+export interface IModelLinks {
+  links: IModel[];
+  ecoinventLinks?: IModel[];
+  ecoinventV3AndEmberClimateLinks?: IModel[];
+}
+
+export const loadModels = (): IModelLinks => require('../model-links.json');