@hestia-earth/schema-convert 27.2.0 → 28.0.0

package/README.md

@@ -1,6 +1,6 @@
-# Hestia Schema Converter
+# HESTIA Schema Converter
 
-Module to convert CSV to JSON or JSON to CSV following Hestia's Schema
+Module to convert CSV to JSON or JSON to CSV following HESTIA's Schema
 
 ## Install
 

package/default-values.d.ts

@@ -2,18 +2,6 @@ import { SchemaType, JSON as HestiaJson, Cycle, Product, Site, Organisation, Ter
 export declare const siteLocationName: (region?: Term, country?: Term) => string;
 export declare const primaryProduct: (products?: Product[], defaultValue?: Product) => Product;
 export declare const cycleDefaultName: ({ endDate, treatment, description }: Cycle, site?: Site, product?: Product) => string;
-/**
- * Parse date in format `YYYY-MM-DD, YYYY-MM, or YYYY`.
- *
- * @param date The date as a string;
- * @param isStart If the date is a `startDate`, meaning `2000` will be set as `2000-01-01`.
- * If it is an `endDate`, then `2000` will be set as `2000-12-31`.
- */
-export declare const parseDate: (date: string, isStart?: boolean) => Date;
-export declare const calculateCycleDuration: ({ cycleDuration, startDate, endDate }: Partial<Cycle>) => boolean;
-export declare const cycleDefaultDuration: ({ startDate, endDate }: Partial<Cycle>) => number;
-export declare const calculateStartDate: ({ cycleDuration, startDate, endDate }: Partial<Cycle>) => boolean;
-export declare const cycleStartDate: ({ cycleDuration, endDate }: Partial<Cycle>) => string;
 export declare const extendCycle: (nodes: HestiaJson<SchemaType>[], cycle: Cycle) => Cycle;
 export declare const impactAssessmentDefaultName: ({ product, country, region, endDate }: Partial<ImpactAssessment>) => string;
 export declare const extendImpactAssessment: (nodes: HestiaJson<SchemaType>[], impactAssessment: ImpactAssessment) => {

package/default-values.js

@@ -12,7 +12,7 @@ var __assign = (this && this.__assign) || function () {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setDefaultValues = exports.extendSite = exports.siteDefaultName = exports.extendImpactAssessment = exports.impactAssessmentDefaultName = exports.extendCycle = exports.cycleStartDate = exports.calculateStartDate = exports.cycleDefaultDuration = exports.calculateCycleDuration = exports.parseDate = exports.cycleDefaultName = exports.primaryProduct = exports.siteLocationName = void 0;
+exports.setDefaultValues = exports.extendSite = exports.siteDefaultName = exports.extendImpactAssessment = exports.impactAssessmentDefaultName = exports.extendCycle = exports.cycleDefaultName = exports.primaryProduct = exports.siteLocationName = void 0;
 var schema_1 = require("@hestia-earth/schema");
 var utils_1 = require("./utils");
 var findLinkedNode = function (nodes, type, node) {
@@ -53,53 +53,15 @@ var cycleDefaultName = function (_a, site, product) {
     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);
 };
 exports.cycleDefaultName = cycleDefaultName;
-var cycleDurationDefault = 365;
-var lastDayOfMonth = function (date) {
-    return new Date(new Date(date.getFullYear(), date.getMonth() + 1, 0, 12).toJSON().substring(0, 10));
+var defaultSiteArea = function (cycle) {
+    return (0, utils_1.reduceUndefinedValues)({
+        siteArea: cycle.functionalUnit === schema_1.CycleFunctionalUnit['1 ha'] ? cycle.siteArea || 1 : undefined
+    });
 };
-/**
- * Parse date in format `YYYY-MM-DD, YYYY-MM, or YYYY`.
- *
- * @param date The date as a string;
- * @param isStart If the date is a `startDate`, meaning `2000` will be set as `2000-01-01`.
- * If it is an `endDate`, then `2000` will be set as `2000-12-31`.
- */
-var parseDate = function (date, isStart) {
-    if (isStart === void 0) { isStart = true; }
-    return date.length === 4
-        ? new Date("".concat(date, "-").concat(isStart ? '01-01T12:00:00.000Z' : '12-31T12:00:00.000Z'))
-        : date.length === 7
-            ? new Date("".concat(date, "-").concat(isStart
-                ? '01'
-                : new Date(lastDayOfMonth(new Date("".concat(date, "-01T12:00:00.000Z")))).getDate().toString().padStart(2, '0')))
-            : new Date("".concat(date, "T12:00:00.000Z"));
-};
-exports.parseDate = parseDate;
-var calculateCycleDuration = function (_a) {
-    var cycleDuration = _a.cycleDuration, startDate = _a.startDate, endDate = _a.endDate;
-    return [!cycleDuration || cycleDuration === cycleDurationDefault, !!startDate, !!endDate].every(Boolean) &&
-        new Date(startDate).getTime() < new Date(endDate).getTime();
-};
-exports.calculateCycleDuration = calculateCycleDuration;
-var cycleDefaultDuration = function (_a) {
-    var startDate = _a.startDate, endDate = _a.endDate;
-    return (0, utils_1.diffInDays)((0, exports.parseDate)(startDate, true), (0, exports.parseDate)(endDate, false));
-};
-exports.cycleDefaultDuration = cycleDefaultDuration;
-var calculateStartDate = function (_a) {
-    var cycleDuration = _a.cycleDuration, startDate = _a.startDate, endDate = _a.endDate;
-    return [!!cycleDuration, !!endDate, !startDate].every(Boolean);
-};
-exports.calculateStartDate = calculateStartDate;
-var cycleStartDate = function (_a) {
-    var cycleDuration = _a.cycleDuration, endDate = _a.endDate;
-    return (0, utils_1.daysBefore)((0, exports.parseDate)(endDate, false), cycleDuration).toJSON().substring(0, 10);
-};
-exports.cycleStartDate = cycleStartDate;
 var extendCycle = function (nodes, cycle) {
     var product = (0, exports.primaryProduct)(cycle.products);
     var site = findLinkedNode(nodes, schema_1.SchemaType.Site, cycle.site);
-    return __assign(__assign(__assign(__assign({}, cycle), { name: (0, exports.cycleDefaultName)(cycle, site, product) }), ((0, exports.calculateCycleDuration)(cycle) ? { cycleDuration: (0, exports.cycleDefaultDuration)(cycle) } : {})), ((0, exports.calculateStartDate)(cycle) ? { startDate: (0, exports.cycleStartDate)(cycle) } : {}));
+    return __assign(__assign(__assign({}, cycle), { name: (0, exports.cycleDefaultName)(cycle, site, product) }), defaultSiteArea(cycle));
 };
 exports.extendCycle = extendCycle;
 var impactAssessmentDefaultName = function (_a) {

package/json.d.ts

@@ -39,9 +39,9 @@ export declare const cleanStringValue: (value: string) => string;
 export declare const formatNode: (schemas: definitions, type: SchemaType, data: ICSVContent, ignoreInternal: boolean, top?: boolean) => any;
 export declare const filterEmptyNode: (schemas: definitions, node: any) => boolean;
 /**
- * Convert CSV to Hestia JSON-LD format.
+ * Convert CSV to HESTIA JSON-LD format.
  *
- * @param schemas The definitions of the Hestia Schema (`import { loadSchemas } from "@hestia-earth/json-schema"`)
+ * @param schemas The definitions of the HESTIA Schema (`import { loadSchemas } from "@hestia-earth/json-schema"`)
  * @param content The content of the CSV as a string
  * @returns A list of JSON-LD content.
  */

package/json.js

@@ -576,9 +576,9 @@ var convetToNode = function (schemas) { return function (data) {
         .filter(function (node) { return (0, exports.filterEmptyNode)(schemas, node); });
 }; };
 /**
- * Convert CSV to Hestia JSON-LD format.
+ * Convert CSV to HESTIA JSON-LD format.
  *
- * @param schemas The definitions of the Hestia Schema (`import { loadSchemas } from "@hestia-earth/json-schema"`)
+ * @param schemas The definitions of the HESTIA Schema (`import { loadSchemas } from "@hestia-earth/json-schema"`)
  * @param content The content of the CSV as a string
  * @returns A list of JSON-LD content.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hestia-earth/schema-convert",
-  "version": "27.2.0",
-  "description": "Hestia Schema Converters",
+  "version": "28.0.0",
+  "description": "HESTIA Schema Converters",
   "main": "index.js",
   "typings": "index.d.ts",
   "bin": {

package/utils.d.ts

@@ -11,3 +11,4 @@ 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;
 export declare const daysBefore: (date?: Date, days?: number) => Date;
+export declare const daysInYear: (year: number) => 366 | 365;

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.daysBefore = 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;
+exports.daysInYear = exports.daysBefore = 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');
 var omit = function (data, keys) {
     var obj = __assign({}, data);
@@ -88,3 +88,5 @@ var daysBefore = function (date, days) {
     return newDate;
 };
 exports.daysBefore = daysBefore;
+var daysInYear = function (year) { return ((year % 4 === 0 && year % 100 > 0) || year % 400 === 0 ? 366 : 365); };
+exports.daysInYear = daysInYear;