@hestia-earth/engine-models 0.65.6 → 0.65.7

package/src/config.spec.ts

@@ -0,0 +1,67 @@
+import { describe, expect, test } from '@jest/globals';
+import { NodeType } from '@hestia-earth/schema';
+
+import { loadConfig, loadRunConfig, loadTriggerConfig } from './config';
+
+describe('config', () => {
+  describe('loadConfig', () => {
+    test('load existing config', () => {
+      const config = loadConfig(NodeType.Cycle);
+      expect(config.models?.length > 0).toBeTruthy();
+    });
+
+    test('load non-existing config', () => {
+      const t = () => loadConfig('unknown' as any);
+
+      expect(t).toThrowError(
+        'Invalid type unknown. Allowed types: Cycle, Site, ImpactAssessment'
+      );
+    });
+  });
+
+  describe('loadRunConfig', () => {
+    test('load existing config', () => {
+      const config = loadRunConfig(NodeType.ImpactAssessment, 1);
+      expect(config.length > 0).toBeTruthy();
+    });
+
+    test('load non-existing config', () => {
+      const t = () => loadRunConfig('unknown' as any, 1);
+
+      expect(t).toThrowError(
+        'Invalid type unknown. Allowed types: Cycle, Site, ImpactAssessment'
+      );
+    });
+
+    test('load non-existing stage', () => {
+      const t = () => loadRunConfig(NodeType.ImpactAssessment, 2);
+
+      expect(t).toThrowError(
+        'Invalid stage configuration for ImpactAssessment: 2'
+      );
+    });
+  });
+
+  describe('loadTriggerConfig', () => {
+    test('load existing config', () => {
+      const config = loadTriggerConfig(NodeType.ImpactAssessment, 1);
+      expect(config.length > 0).toBeTruthy();
+    });
+
+    test('load non-existing config', () => {
+      const t = () => loadTriggerConfig('unknown' as any, 1);
+
+      expect(t).toThrowError(
+        'Invalid type unknown. Allowed types: Cycle, Site, ImpactAssessment'
+      );
+    });
+
+    test('load non-existing stage', () => {
+      const t = () => loadTriggerConfig(NodeType.ImpactAssessment, 2);
+
+      expect(t).toThrowError(
+        'Invalid stage configuration for ImpactAssessment: 2'
+      );
+    });
+  });
+});

package/src/config.ts

@@ -0,0 +1,82 @@
+import { NodeType } from '@hestia-earth/schema';
+
+export interface IOrchestratorModelConfig {
+  key: string;
+  model: string;
+  value: string;
+  runStrategy: 'always' | 'add_key_if_missing' | 'add_blank_node_if_missing';
+  runArgs?: Record<string, any>;
+  mergeStrategy: 'default' | 'append' | 'list' | 'node';
+  mergeArgs?: Record<string, any>;
+}
+
+export interface IOrchestratorConfig {
+  models: (IOrchestratorModelConfig | IOrchestratorModelConfig[])[];
+}
+
+const allowedTypes = [NodeType.Cycle, NodeType.Site, NodeType.ImpactAssessment];
+
+export type allowedType =
+  | NodeType.Cycle
+  | NodeType.Site
+  | NodeType.ImpactAssessment;
+
+const validateType = (nodeType: any) =>
+  allowedTypes.includes(nodeType) ||
+  (() => {
+    throw new Error(
+      `Invalid type ${nodeType}. Allowed types: ${allowedTypes.join(', ')}`
+    );
+  })();
+
+/**
+ * Load orchestrator configuration.
+ *
+ * @param nodeType NodeType associated with configuration.
+ * @returns
+ */
+export const loadConfig = (nodeType: allowedType): IOrchestratorConfig =>
+  validateType(nodeType) && require(`../config/${nodeType}.json`);
+
+interface ICalculationConfigData {
+  key: 'related' | 'nested';
+  type: allowedType;
+  stage: number;
+}
+
+type calculationConfigStage = {
+  [stage: string]: ICalculationConfigData[];
+};
+
+type calculationConfig = {
+  [type in allowedType]?: calculationConfigStage;
+};
+
+const validateStage = (
+  config: calculationConfig,
+  nodeType: allowedType,
+  stage: number
+) =>
+  `stage-${stage}` in config[nodeType]
+    ? config[nodeType][`stage-${stage}`]
+    : (() => {
+        throw new Error(
+          `Invalid stage configuration for ${nodeType}: ${stage}`
+        );
+      })();
+
+export const loadRunConfig = (nodeType: allowedType, stage: number) =>
+  validateType(nodeType) &&
+  validateStage(
+    require('../config/run-calculations.json') as calculationConfig,
+    nodeType,
+    stage
+  );
+
+export const loadTriggerConfig = (nodeType: allowedType, stage: number) =>
+  validateType(nodeType) &&
+  validateStage(
+    require('../config/trigger-calculations.json') as calculationConfig,
+    nodeType,
+    stage
+  );

package/src/index.ts

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

package/src/version.ts

@@ -1 +1 @@
-export const ENGINE_VERSION = '0.65.6';
+export const ENGINE_VERSION = '0.65.7';