@hestia-earth/schema-convert 11.0.0 → 11.2.0

package/default-values.d.ts

@@ -0,0 +1,40 @@
+import { SchemaType, JSON as HestiaJson, Cycle, Product, Site, Organisation, Term, ImpactAssessment } from '@hestia-earth/schema';
+export declare const primaryProduct: (products?: Product[], defaultValue?: Product) => Product;
+export declare const extendCycle: (nodes: HestiaJson<SchemaType>[], cycle: Cycle) => Cycle;
+export declare const extendImpactAssessment: (_n: HestiaJson<SchemaType>[], impactAssessment: ImpactAssessment) => {
+    name: string;
+    version?: string;
+    versionDetails?: string;
+    organisation?: Organisation;
+    cycle?: Cycle;
+    endDate?: string;
+    startDate?: string;
+    site?: Site;
+    country?: Term;
+    region?: Term;
+    product?: Term;
+    functionalUnitQuantity?: number;
+    allocationMethod?: import("../../../dist/@hestia-earth/schema").ImpactAssessmentAllocationMethod;
+    source?: import("../../../dist/@hestia-earth/schema").Source;
+    emissionsResourceUse?: import("../../../dist/@hestia-earth/schema").Indicator[];
+    impacts?: import("../../../dist/@hestia-earth/schema").Indicator[];
+    endpoints?: import("../../../dist/@hestia-earth/schema").Indicator[];
+    organic?: boolean;
+    irrigated?: boolean;
+    productValue?: number;
+    autoGenerated?: boolean;
+    originalId?: string;
+    schemaVersion?: string;
+    added?: string[];
+    addedVersion?: string[];
+    updated?: string[];
+    updatedVersion?: string[];
+    aggregated?: boolean;
+    aggregatedVersion?: string;
+    aggregatedQualityScore?: number;
+    dataPrivate?: boolean;
+    type: SchemaType.ImpactAssessment;
+    id?: string;
+};
+export declare const extendSite: (nodes: HestiaJson<SchemaType>[], site: Site) => Site;
+export declare const setDefaultValues: (nodes: HestiaJson<any>[]) => (HestiaJson<SchemaType> | Partial<Partial<HestiaJson<SchemaType.Cycle>>> | Partial<Partial<HestiaJson<SchemaType.ImpactAssessment>>> | Partial<Partial<HestiaJson<SchemaType.Site>>> | Partial<Partial<HestiaJson<SchemaType.Actor>>> | Partial<Partial<HestiaJson<SchemaType.Bibliography>>> | Partial<Partial<HestiaJson<SchemaType.Completeness>>> | Partial<Partial<HestiaJson<SchemaType.Emission>>> | Partial<Partial<HestiaJson<SchemaType.Indicator>>> | Partial<Partial<HestiaJson<SchemaType.Infrastructure>>> | Partial<Partial<HestiaJson<SchemaType.Input>>> | Partial<Partial<HestiaJson<SchemaType.Measurement>>> | Partial<Partial<HestiaJson<SchemaType.Organisation>>> | Partial<Partial<HestiaJson<SchemaType.Practice>>> | Partial<Partial<HestiaJson<SchemaType.Product>>> | Partial<Partial<HestiaJson<SchemaType.Property>>> | Partial<Partial<HestiaJson<SchemaType.Source>>> | Partial<Partial<HestiaJson<SchemaType.Term>>> | Partial<Partial<HestiaJson<SchemaType.Transformation>>> | Partial<Partial<HestiaJson<SchemaType.Transport>>>)[];

package/default-values.js

@@ -0,0 +1,88 @@
+"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);
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDefaultValues = exports.extendSite = exports.extendImpactAssessment = exports.extendCycle = exports.primaryProduct = void 0;
+var schema_1 = require("@hestia-earth/schema");
+var utils_1 = require("./utils");
+var findLinkedNode = function (nodes, type, node) {
+    return node ? (nodes.find(function (v) {
+        return (v.type === type && v.id === node.id) || (v['@type'] === type && v['@id'] === node['@id']);
+    }) || node) : undefined;
+};
+var siteLocationName = function (region, country) { return [
+    region === null || region === void 0 ? void 0 : region.name,
+    // make sure country doesnt appear in region already, if so don't add it
+    (country === null || country === void 0 ? void 0 : country.name) ? ((region === null || region === void 0 ? void 0 : region.name) && region.name.includes(country === null || country === void 0 ? void 0 : country.name) ? undefined : country === null || country === void 0 ? void 0 : country.name) : undefined
+].filter(Boolean).join(', '); };
+exports.primaryProduct = function (products, defaultValue) {
+    if (defaultValue === void 0) { defaultValue = {}; }
+    return (products && products.length ? (products.find(function (product) { return product.primary || product.economicValueShare > 50; }) || products[0]) : null) || defaultValue;
+};
+var defaultName = function (product, country, region, endDate, treatment, description) {
+    return [
+        (product === null || product === void 0 ? void 0 : product.name) || 'No Product',
+        siteLocationName(region, country),
+        endDate,
+        treatment,
+        utils_1.ellipsis(description, 30)
+    ].filter(Boolean).join(' - ');
+};
+var cycleDefaultName = function (_a, site, product) {
+    var endDate = _a.endDate, treatment = _a.treatment, description = _a.description;
+    return defaultName(product === null || product === void 0 ? void 0 : product.term, site === null || site === void 0 ? void 0 : site.country, site === null || site === void 0 ? void 0 : site.region, endDate, treatment, description);
+};
+var cycleDurationDefault = 365;
+var calculateCycleDuration = function (_a) {
+    var cycleDuration = _a.cycleDuration, startDate = _a.startDate, endDate = _a.endDate;
+    return (!cycleDuration || cycleDuration === cycleDurationDefault) &&
+        startDate && endDate && (new Date(startDate).getTime() < new Date(endDate).getTime());
+};
+var cycleDefaultDuration = function (_a) {
+    var startDate = _a.startDate, endDate = _a.endDate;
+    return utils_1.diffInDays(startDate, endDate);
+};
+exports.extendCycle = function (nodes, cycle) {
+    var product = exports.primaryProduct(cycle.products);
+    var site = findLinkedNode(nodes, schema_1.SchemaType.Site, cycle.site);
+    return __assign(__assign(__assign({}, cycle), { name: cycleDefaultName(cycle, site, product) }), (calculateCycleDuration(cycle) ? { cycleDuration: cycleDefaultDuration(cycle) } : {}));
+};
+var impactAssessmentDefaultName = function (_a) {
+    var product = _a.product, country = _a.country, region = _a.region, endDate = _a.endDate;
+    return defaultName(product, country, region, endDate);
+};
+exports.extendImpactAssessment = function (_n, impactAssessment) { return (__assign(__assign({}, impactAssessment), { name: impactAssessment.name || impactAssessmentDefaultName(impactAssessment) })); };
+var siteDefaultName = function (_a, organisation) {
+    var siteType = _a.siteType, region = _a.region, country = _a.country, description = _a.description;
+    return [
+        siteType ? utils_1.keyToLabel(siteType) : null,
+        organisation === null || organisation === void 0 ? void 0 : organisation.name,
+        siteLocationName(region, country),
+        utils_1.ellipsis(description, 30)
+    ].filter(Boolean).join(' - ');
+};
+exports.extendSite = function (nodes, site) {
+    var org = findLinkedNode(nodes, schema_1.SchemaType.Organisation, site.organisation);
+    return __assign(__assign({}, site), { name: siteDefaultName(site, org) });
+};
+var extendNodeType = (_a = {},
+    _a[schema_1.SchemaType.Cycle] = exports.extendCycle,
+    _a[schema_1.SchemaType.ImpactAssessment] = exports.extendImpactAssessment,
+    _a[schema_1.SchemaType.Site] = exports.extendSite,
+    _a);
+var extendNode = function (nodes) { return function (node) {
+    return node.type in extendNodeType ?
+        utils_1.reduceUndefinedValues(extendNodeType[node.type](nodes, node), true) :
+        node;
+}; };
+exports.setDefaultValues = function (nodes) { return nodes.map(extendNode(nodes)); };

package/json.js

@@ -86,6 +86,7 @@ var wkt_1 = require("@terraformer/wkt");
 var schema_1 = require("@hestia-earth/schema");
 var types_1 = require("@hestia-earth/json-schema/types");
 var utils_1 = require("./utils");
+var default_values_1 = require("./default-values");
 var IGNORE_FIELD_KEY = '-';
 var VALUE_TYPE_KEY = 'valueType';
 var DEFAULT_ARRAY_DELIMITER = ';';
@@ -462,13 +463,16 @@ var convetToNode = function (schemas) { return function (data) {
  * @returns A list of JSON-LD content.
  */
 exports.toJson = function (schemas, content) { return __awaiter(void 0, void 0, void 0, function () {
+    var nodes;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, csvtojson({
                     delimiter: 'auto',
                     ignoreColumns: /^$/
                 }).fromString(content)];
-            case 1: return [2 /*return*/, (_a.sent()).flatMap(convetToNode(schemas))];
+            case 1:
+                nodes = (_a.sent()).flatMap(convetToNode(schemas));
+                return [2 /*return*/, default_values_1.setDefaultValues(nodes)];
         }
     });
 }); };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/schema-convert",
-  "version": "11.0.0",
+  "version": "11.2.0",
   "description": "Hestia Schema Converters",
   "main": "index.js",
   "typings": "index.d.ts",

package/utils.d.ts

@@ -7,3 +7,6 @@ export declare const isEmpty: (value: any, minKeys?: number) => boolean;
 export declare const nonEmptyValue: (value: any) => boolean;
 export declare const nonEmptyNode: (node: any) => boolean;
 export declare const reduceUndefinedValues: <T>(obj: T, allowNull?: boolean) => Partial<T>;
+export declare const ellipsis: (text?: string, maxlength?: number) => string;
+export declare const keyToLabel: (key: string) => string;
+export declare const diffInDays: (date1: Date | string, date2: Date | string) => number;

package/utils.js

@@ -11,7 +11,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reduceUndefinedValues = exports.nonEmptyNode = exports.nonEmptyValue = exports.isEmpty = exports.isNumber = exports.isBoolean = exports.isIri = exports.isExpandable = exports.omit = void 0;
+exports.diffInDays = exports.keyToLabel = exports.ellipsis = exports.reduceUndefinedValues = exports.nonEmptyNode = exports.nonEmptyValue = exports.isEmpty = exports.isNumber = exports.isBoolean = exports.isIri = exports.isExpandable = exports.omit = void 0;
 var unset = require('lodash.unset');
 exports.omit = function (data, keys) {
     var obj = __assign({}, data);
@@ -53,3 +53,14 @@ exports.reduceUndefinedValues = function (obj, allowNull) {
         return __assign(__assign({}, prev), (isUndefined(value, allowNull) ? {} : (_a = {}, _a[key] = value, _a)));
     }, {});
 };
+exports.ellipsis = function (text, maxlength) {
+    if (text === void 0) { text = ''; }
+    if (maxlength === void 0) { maxlength = 20; }
+    return text.length > maxlength ? text.substring(0, maxlength) + "..." : text;
+};
+exports.keyToLabel = function (key) {
+    return "" + key[0].toUpperCase() + key.replace(/([a-z])([A-Z])/g, '$1 $2').replace(/([_])([a-zA-Z])/g, function (g) { return " " + g[1].toUpperCase(); }).substring(1);
+};
+exports.diffInDays = function (date1, date2) {
+    return Math.abs(Math.round((new Date(date2).getTime() - new Date(date1).getTime()) / (24 * 60 * 60 * 1000)));
+};