@hestia-earth/engine-models 0.73.0 → 0.73.2

package/config/Cycle.json

@@ -27,17 +27,9 @@
       "stage": 1
     },
     {
-      "key": "practices",
-      "model": "hestia",
-      "value": "croppingIntensity",
-      "runStrategy": "add_blank_node_if_missing",
-      "mergeStrategy": "list",
-      "stage": 1
-    },
-    {
-      "key": "practices",
-      "model": "geospatialDatabase",
-      "value": "croppingIntensity",
+      "key": "inputs",
+      "model": "faostat2018",
+      "value": "seed",
       "runStrategy": "add_blank_node_if_missing",
       "mergeStrategy": "list",
       "stage": 1
@@ -100,6 +92,22 @@
         "stage": 1
       }
     ],
+    {
+      "key": "practices",
+      "model": "hestia",
+      "value": "croppingIntensity",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "practices",
+      "model": "geospatialDatabase",
+      "value": "croppingIntensity",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
     [
       {
         "key": "practices",
@@ -321,14 +329,6 @@
       "stage": 1
     },
     [
-      {
-        "key": "practices",
-        "model": "hestia",
-        "value": "longFallowRatio",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
       {
         "key": "practices",
         "model": "hestia",
@@ -467,24 +467,22 @@
         "stage": 1
       }
     ],
-    [
-      {
-        "key": "inputs",
-        "model": "faostat2018",
-        "value": "seed",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "inputs",
-        "model": "pooreNemecek2018",
-        "value": "saplingsDepreciatedAmountPerCycle",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      }
-    ],
+    {
+      "key": "practices",
+      "model": "hestia",
+      "value": "longFallowRatio",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "inputs",
+      "model": "pooreNemecek2018",
+      "value": "saplingsDepreciatedAmountPerCycle",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
     {
       "key": "completeness",
       "model": "cycle",

package/config/Site.json

@@ -65,30 +65,6 @@
         "mergeStrategy": "list",
         "stage": 1
       },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "brackishWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "freshWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "salineWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
       {
         "key": "measurements",
         "model": "hestia",
@@ -470,6 +446,32 @@
         "stage": 2
       }
     ],
+    [
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "brackishWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "freshWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "salineWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
     [
       {
         "key": "defaultMethodClassification",

package/dist/config.d.ts

@@ -12,6 +12,7 @@ export interface IOrchestratorConfig {
     models: (IOrchestratorModelConfig | IOrchestratorModelConfig[])[];
 }
 export type allowedType = NodeType.Cycle | NodeType.Site | NodeType.ImpactAssessment;
+export declare const allowedTypes: allowedType[];
 /**
  * Load orchestrator configuration.
  *

package/dist/config.js

@@ -1,18 +1,22 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMaxStage = exports.loadTriggerConfig = exports.loadRunConfig = exports.loadConfig = void 0;
+exports.getMaxStage = exports.loadTriggerConfig = exports.loadRunConfig = exports.loadConfig = exports.allowedTypes = void 0;
 var schema_1 = require("@hestia-earth/schema");
 var runConfig = require("../config/run-calculations.json");
 var triggerConfig = require("../config/trigger-calculations.json");
 var Cycle = require("../config/Cycle.json");
 var ImpactAssessment = require("../config/ImpactAssessment.json");
 var Site = require("../config/Site.json");
-var allowedTypes = [schema_1.NodeType.Cycle, schema_1.NodeType.Site, schema_1.NodeType.ImpactAssessment];
+exports.allowedTypes = [
+    schema_1.NodeType.Cycle,
+    schema_1.NodeType.Site,
+    schema_1.NodeType.ImpactAssessment
+];
 var validateType = function (nodeType) {
-    return allowedTypes.includes(nodeType) ||
+    return exports.allowedTypes.includes(nodeType) ||
         (function () {
-            throw new Error("Invalid type ".concat(nodeType, ". Allowed types: ").concat(allowedTypes.join(', ')));
+            throw new Error("Invalid type ".concat(nodeType, ". Allowed types: ").concat(exports.allowedTypes.join(', ')));
         })();
 };
 var typeToConfig = (_a = {},

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export * from './config';
 export * from './models';
+export * from './utils';
+export * from './validate-config';
 export * from './version';

package/dist/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./config"), exports);
 __exportStar(require("./models"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./validate-config"), exports);
 __exportStar(require("./version"), exports);

package/dist/models.d.ts

@@ -24,6 +24,10 @@ export interface IModel {
      * A key in the model if term does not exist.
      */
     modelKey?: string;
+    /**
+     * List of other models this model needs to run.
+     */
+    dependencies?: string[];
 }
 export type modelLookup = Record<string, Pick<IModel, 'model' | 'term' | 'modelKey'>[]>;
 export interface IModelLinks {

package/dist/utils.d.ts

@@ -0,0 +1,6 @@
+import { IOrchestratorModelConfig } from './config';
+import { IModel } from './models';
+export declare const findMatchingModel: (model: Partial<IModel>, config?: {
+    useDotValues?: boolean;
+}) => IModel;
+export declare const findMatchingModelFromConfig: (model: Pick<IOrchestratorModelConfig, "model" | "value">) => IModel;

package/dist/utils.js

@@ -0,0 +1,71 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findMatchingModelFromConfig = exports.findMatchingModel = void 0;
+var models_1 = require("./models");
+var matchWithDot = function (model, key, value) {
+    return typeof value === 'string' && value.split('.').pop() === model[key];
+};
+var matchPath = function (model, key, value) {
+    return key === 'path' && typeof value === 'string' && model[key].startsWith(value);
+};
+var findMatchingModel = function (model, config) {
+    if (config === void 0) { config = {
+        useDotValues: false
+    }; }
+    return Object.keys(model).length > 0
+        ? models_1.models.links.find(function (m) {
+            return Object.entries(model).every(function (_a) {
+                var _b = __read(_a, 2), key = _b[0], value = _b[1];
+                return value === m[key] ||
+                    (config.useDotValues && matchWithDot(m, key, value)) ||
+                    matchPath(m, key, value);
+            });
+        })
+        : null;
+};
+exports.findMatchingModel = findMatchingModel;
+var modelMatchOrder = function (_a) {
+    var model = _a.model, value = _a.value;
+    return [
+        { model: model, term: value },
+        { model: model, modelKey: value },
+        {
+            model: model,
+            modelKey: value.split('.').pop()
+        },
+        {
+            model: model,
+            term: value.split('.').pop()
+        },
+        {
+            model: model,
+            path: ['hestia_earth', 'models', model, value].join('/')
+        },
+        !value || value === 'all' ? { model: model } : null
+    ].filter(Boolean);
+};
+var findMatchingModelFromConfig = function (model) {
+    var _a, _b;
+    return (_b = (_a = modelMatchOrder(model)
+        .map(function (params) {
+        return (0, exports.findMatchingModel)(params) ||
+            (0, exports.findMatchingModel)(params, { useDotValues: true });
+    })) === null || _a === void 0 ? void 0 : _a.filter(Boolean)) === null || _b === void 0 ? void 0 : _b.shift();
+};
+exports.findMatchingModelFromConfig = findMatchingModelFromConfig;

package/dist/validate-config.d.ts

@@ -0,0 +1,6 @@
+import { allowedType, IOrchestratorModelConfig } from './config';
+export declare const validateConfig: (nodeType: allowedType) => {
+    model: IOrchestratorModelConfig;
+    existing: string[];
+    missing: string[];
+}[];

package/dist/validate-config.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfig = void 0;
+var config_1 = require("./config");
+var utils_1 = require("./utils");
+// models not included in the links
+var skipModels = ['emissions.deleted', 'transformations'];
+var isHestiaResidueCyclicModel = function (_a) {
+    var model = _a.model, value = _a.value;
+    return model === 'hestia' && (value === null || value === void 0 ? void 0 : value.startsWith('residue'));
+};
+var isOrganicCarbonCyclicModel = function (_a) {
+    var model = _a.model, value = _a.value;
+    return model === 'hestia' && (value === null || value === void 0 ? void 0 : value.startsWith('organicCarbonPer'));
+};
+var includeModel = function (model) {
+    return [
+        !skipModels.includes(model.model),
+        // cyclic dependencies
+        !isHestiaResidueCyclicModel(model),
+        !isOrganicCarbonCyclicModel(model)
+    ].every(Boolean);
+};
+// dependencies that cannot be validated
+var skipDependencies = [
+    // completeness gap-fills after other models run
+    'completeness'
+];
+var matchDependencies = function (models) { return function (model) {
+    var _a, _b, _c;
+    var dependencies = (0, utils_1.findMatchingModelFromConfig)(model).dependencies;
+    var previousModels = models.slice(0, models.indexOf(model));
+    var existing = (_a = dependencies === null || dependencies === void 0 ? void 0 : dependencies.filter(function (value) {
+        return previousModels.some(function (config) { var _a; return ((_a = config.value) === null || _a === void 0 ? void 0 : _a.split('.').pop()) === value; });
+    })) !== null && _a !== void 0 ? _a : [];
+    return {
+        model: model,
+        existing: existing,
+        missing: (_c = (_b = dependencies === null || dependencies === void 0 ? void 0 : dependencies
+        // skip dependencies that dont exist at all
+        .filter(function (value) { return models.some(function (config) { return config.value === value; }); })) === null || _b === void 0 ? void 0 : _b.filter(function (v) {
+            return !existing.includes(v) &&
+                !skipDependencies.includes(v) &&
+                v !== model.value;
+        })) !== null && _c !== void 0 ? _c : []
+    };
+}; };
+var validateConfig = function (nodeType) {
+    var config = (0, config_1.loadConfig)(nodeType);
+    // flatten all models to process one by one, starting with the last one
+    var models = config.models.flat();
+    var results = models.filter(includeModel).map(matchDependencies(models));
+    return results.filter(function (r) { return r.missing.length > 0; });
+};
+exports.validateConfig = validateConfig;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const ENGINE_VERSION = "0.73.0";
+export declare const ENGINE_VERSION = "0.73.2";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENGINE_VERSION = void 0;
-exports.ENGINE_VERSION = '0.73.0';
+exports.ENGINE_VERSION = '0.73.2';