@hestia-earth/api 0.18.21 → 0.18.23-0

package/dist/reconciliations/model/model.d.ts

@@ -1,4 +1,5 @@
 import { BaseModel } from '../../db/model.base';
+export { getMainErrorMessage as reconciliationsGetMainErrorMessage, validateProductCorrespondence as reconciliationsValidateProductCorrespondence, validateImpactAssessmentLinks as reconciliationsValidateImpactAssessmentLinks, validateExpectedNodes as reconciliationsValidateExpectedNodes, validatePrivate as reconciliationsValidatePrivate } from './validations';
 export declare enum ReconciliationLevel {
     success = "success",
     warning = "warning",

package/dist/reconciliations/model/model.js

@@ -15,8 +15,14 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Reconciliation = exports.ReconciliationLevel = void 0;
+exports.Reconciliation = exports.ReconciliationLevel = exports.reconciliationsValidatePrivate = exports.reconciliationsValidateExpectedNodes = exports.reconciliationsValidateImpactAssessmentLinks = exports.reconciliationsValidateProductCorrespondence = exports.reconciliationsGetMainErrorMessage = void 0;
 var model_base_1 = require("../../db/model.base");
+var validations_1 = require("./validations");
+Object.defineProperty(exports, "reconciliationsGetMainErrorMessage", { enumerable: true, get: function () { return validations_1.getMainErrorMessage; } });
+Object.defineProperty(exports, "reconciliationsValidateProductCorrespondence", { enumerable: true, get: function () { return validations_1.validateProductCorrespondence; } });
+Object.defineProperty(exports, "reconciliationsValidateImpactAssessmentLinks", { enumerable: true, get: function () { return validations_1.validateImpactAssessmentLinks; } });
+Object.defineProperty(exports, "reconciliationsValidateExpectedNodes", { enumerable: true, get: function () { return validations_1.validateExpectedNodes; } });
+Object.defineProperty(exports, "reconciliationsValidatePrivate", { enumerable: true, get: function () { return validations_1.validatePrivate; } });
 var ReconciliationLevel;
 (function (ReconciliationLevel) {
     ReconciliationLevel["success"] = "success";

package/dist/reconciliations/model/validations.d.ts

@@ -0,0 +1,13 @@
+import { NodeType, ICycleJSONLD, JSONLD, JSON, SchemaType, ITermJSONLD, Term } from '@hestia-earth/schema';
+import { INode } from '@hestia-earth/schema-convert';
+export type Node = (INode | JSONLD<NodeType>) & {
+    site?: JSON<SchemaType.Site> | JSONLD<NodeType.Site>;
+    cycle?: JSON<SchemaType.Cycle> | JSONLD<NodeType.Cycle>;
+};
+export declare const notPrivateError = "expected-not-private";
+export declare const EXTRANEOUS = "extraneous";
+export declare const validateExpectedNodes: (nodes: Node[]) => Error[];
+export declare const validateImpactAssessmentLinks: (nodes: Node[]) => Error[];
+export declare const validatePrivate: (cycle: ICycleJSONLD) => Error[];
+export declare const validateProductCorrespondence: (expectedProducts: (ITermJSONLD | Term)[], recalculatedProducts: (ITermJSONLD | Term)[], idRecalculated: string) => Error[];
+export declare const getMainErrorMessage: (errors: any) => "expected-not-private" | "recalculation-error" | "invalid-nodes";

package/dist/reconciliations/model/validations.js

@@ -0,0 +1,97 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMainErrorMessage = exports.validateProductCorrespondence = exports.validatePrivate = exports.validateImpactAssessmentLinks = exports.validateExpectedNodes = exports.EXTRANEOUS = exports.notPrivateError = void 0;
+var schema_1 = require("@hestia-earth/schema");
+exports.notPrivateError = 'expected-not-private';
+exports.EXTRANEOUS = 'extraneous';
+var getType = function (node) { return (node === null || node === void 0 ? void 0 : node['@type']) || (node === null || node === void 0 ? void 0 : node.type); };
+var getId = function (node) { return (node === null || node === void 0 ? void 0 : node['@id']) || (node === null || node === void 0 ? void 0 : node.id); };
+var getErrorsFromValidationsObj = function (validations) {
+    return Object.entries(validations)
+        .filter(function (_a) {
+        var _errorMsg = _a[0], validationFailed = _a[1];
+        return validationFailed;
+    })
+        .map(function (_a) {
+        var errorMsg = _a[0];
+        return new Error(errorMsg);
+    });
+};
+var validateExpectedNodes = function (nodes) {
+    var _a;
+    var _b;
+    var cycles = nodes.filter(function (node) { return getType(node) === schema_1.NodeType.Cycle; });
+    var sites = nodes.filter(function (node) { return getType(node) === schema_1.NodeType.Site; });
+    var impactAssessments = nodes.filter(function (node) { return getType(node) === schema_1.NodeType.ImpactAssessment; });
+    var cycleId = getId(cycles === null || cycles === void 0 ? void 0 : cycles[0]);
+    var cycleSiteId = getId((_b = cycles === null || cycles === void 0 ? void 0 : cycles[0]) === null || _b === void 0 ? void 0 : _b.site);
+    var siteId = getId(sites === null || sites === void 0 ? void 0 : sites[0]);
+    var validations = __assign((_a = {}, _a['More than one Cycle found in expected nodes'] = cycles.length > 1, _a['No Cycle found in expected nodes'] = cycles.length < 1, _a['Cycle missing name field in expected nodes'] = cycles.length && !cycles[0].name, _a['More than one Site found in expected nodes'] = sites.length > 1, _a["Cycle ".concat(cycleId, " is not linked to Site ").concat(siteId, " in expected nodes")] = cycleSiteId !== siteId, _a), impactAssessments.reduce(function (acc, ia) {
+        acc["ImpactAssessment ".concat(getId(ia), " is not linked to Cycle ").concat(cycleId, " in expected nodes")] =
+            getId(ia === null || ia === void 0 ? void 0 : ia.cycle) !== cycleId;
+        return acc;
+    }, {}));
+    var validationErrors = getErrorsFromValidationsObj(validations);
+    return validationErrors;
+};
+exports.validateExpectedNodes = validateExpectedNodes;
+var matchedProduct = function (impacts) { return function (product) {
+    return impacts.filter(function (ia) { return getId(product.term) === getId(ia.product); }).length > 1;
+}; };
+var validateImpactAssessmentLinks = function (nodes) {
+    var _a;
+    var _b, _c;
+    var impactAssessments = nodes.filter(function (node) { return getType(node) === schema_1.NodeType.ImpactAssessment; });
+    var cycle = nodes.find(function (node) { return getType(node) === schema_1.NodeType.Cycle; });
+    var cycleId = getId(cycle);
+    var validations = (_a = {},
+        _a["Cycle ".concat(cycleId, " has no associated impact assessment")] = !impactAssessments.length,
+        _a["Cycle ".concat(cycleId, " has no products")] = !((_b = cycle.products) === null || _b === void 0 ? void 0 : _b.length),
+        _a["Cycle ".concat(cycleId, " has a product with more than one linked impact assessment")] = (_c = cycle.products) === null || _c === void 0 ? void 0 : _c.some(matchedProduct(impactAssessments)),
+        _a);
+    var validationErrors = getErrorsFromValidationsObj(validations);
+    return validationErrors;
+};
+exports.validateImpactAssessmentLinks = validateImpactAssessmentLinks;
+var validatePrivate = function (cycle) {
+    var _a;
+    return getErrorsFromValidationsObj((_a = {}, _a[exports.notPrivateError] = !cycle.dataPrivate, _a));
+};
+exports.validatePrivate = validatePrivate;
+var validateProductCorrespondence = function (expectedProducts, recalculatedProducts, idRecalculated) {
+    var missingProducts = expectedProducts.filter(function (pExpected) { return !recalculatedProducts.some(function (pRecalculated) { return getId(pRecalculated) === getId(pExpected); }); });
+    var extraneousProducts = recalculatedProducts.filter(function (pRecalculated) { return !expectedProducts.some(function (pExpected) { return getId(pRecalculated) === getId(pExpected); }); });
+    return [
+        [missingProducts, 'missing'],
+        [extraneousProducts, exports.EXTRANEOUS]
+    ]
+        .map(function (_a) {
+        var products = _a[0], errorType = _a[1];
+        return products.length
+            ? new Error("Cycle ".concat(idRecalculated, " has ").concat(errorType, " impact assessment for products: ").concat(products
+                .map(function (p) { return p['@id']; })
+                .join(', ')))
+            : null;
+    })
+        .filter(Boolean);
+};
+exports.validateProductCorrespondence = validateProductCorrespondence;
+var getMainErrorMessage = function (errors) {
+    return errors.length && errors.length === 1 && errors[0].message.includes(exports.EXTRANEOUS)
+        ? 'recalculation-error'
+        : errors.some(function (e) { return e.message === exports.notPrivateError; })
+            ? exports.notPrivateError
+            : 'invalid-nodes';
+};
+exports.getMainErrorMessage = getMainErrorMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/api",
-  "version": "0.18.21",
+  "version": "0.18.23-0",
   "description": "Hestia API definitions",
   "main": "dist/models.js",
   "typings": "dist/models.d.ts",