@hestia-earth/schema-convert 24.2.0 → 24.3.0

package/csv.d.ts

@@ -6,13 +6,29 @@ export declare const csvColSep = ",";
  * @returns headers as a list.
  */
 export declare const headersFromCsv: (csv: string) => string[];
+export interface IConvertCSVOptions {
+    /**
+     * Include top-level existing nodes. Defaults to `true`.
+     */
+    includeExising?: boolean;
+    /**
+     * Use `[0]` notation for arrays instead of `.0`. Defaults to `false`.
+     */
+    useBrackets?: boolean;
+    /**
+     * By default, internal properties are not included. Set to `true` to include them.
+     */
+    includeAllHeaders?: boolean;
+    /**
+     * Override list of headers in order. By default, compile all from nodes and sort as they appear.
+     */
+    selectedHeaders?: string[];
+}
 /**
- * CSV format for upload.
+ * Convert a list of Nodes to CSV format.
  *
  * @param nodes List of nodes to convert.
- * @param includeExising Include top-level existing nodes.
- * @param useBrackets Use `[0]` notation for arrays instead of `.0`.
- * @param selectedHeaders Override list of headers in order. By default, compile all from nodes and sort as they appear.
+ * @param options Conversion options.
  * @returns CSV content formatted for upload on Hestia.
  */
-export declare const toCsv: (nodes: any[], includeExising?: boolean, useBrackets?: boolean, selectedHeaders?: any[]) => string;
+export declare const toCsv: (nodes: any[], options?: IConvertCSVOptions) => string;

package/csv.js

@@ -1,4 +1,15 @@
 "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 __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -37,6 +48,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toCsv = exports.headersFromCsv = exports.csvColSep = void 0;
+var schema_1 = require("@hestia-earth/schema");
+var json_schema_1 = require("@hestia-earth/json-schema");
+var schema_utils_1 = require("@hestia-earth/json-schema/schema-utils");
 var get = require('lodash.get');
 var utils_1 = require("./utils");
 var noValue = '-';
@@ -89,19 +103,30 @@ var isIndexedNode = function (headers) {
     var topLevel = headers.filter(function (header) { return !header.includes('.'); });
     return topLevel.some(function (header) { return header === '@id'; });
 };
+var defaultOptions = {
+    includeExising: true,
+    useBrackets: false,
+    includeAllHeaders: false,
+    selectedHeaders: []
+};
+var filterTermHeaders = function (schemas, header) {
+    var title = (0, schema_utils_1.schemaFromKey)(schemas, header).title;
+    return title !== schema_1.NodeType.Term || header.endsWith('id') || header.endsWith('name');
+};
+var filterHeaders = function (headers) {
+    var schemas = (0, json_schema_1.loadSchemas)();
+    var filterIncluded = (0, schema_utils_1.isCSVIncluded)(schemas);
+    return headers.filter(function (header) { return filterIncluded(header) && filterTermHeaders(schemas, header); });
+};
 /**
- * CSV format for upload.
+ * Convert a list of Nodes to CSV format.
  *
  * @param nodes List of nodes to convert.
- * @param includeExising Include top-level existing nodes.
- * @param useBrackets Use `[0]` notation for arrays instead of `.0`.
- * @param selectedHeaders Override list of headers in order. By default, compile all from nodes and sort as they appear.
+ * @param options Conversion options.
  * @returns CSV content formatted for upload on Hestia.
  */
-var toCsv = function (nodes, includeExising, useBrackets, selectedHeaders) {
-    if (includeExising === void 0) { includeExising = true; }
-    if (useBrackets === void 0) { useBrackets = false; }
-    if (selectedHeaders === void 0) { selectedHeaders = []; }
+var toCsv = function (nodes, options) {
+    var _a = __assign(__assign({}, defaultOptions), options), includeExising = _a.includeExising, useBrackets = _a.useBrackets, includeAllHeaders = _a.includeAllHeaders, selectedHeaders = _a.selectedHeaders;
     var headersByType = nodes.reduce(function (prev, _a) {
         var type = _a.type, _t = _a["@type"], node = __rest(_a, ["type", '@type']);
         type = type || _t;
@@ -110,9 +135,10 @@ var toCsv = function (nodes, includeExising, useBrackets, selectedHeaders) {
         prev[type] = Array.from(new Set(__spreadArray(__spreadArray([], __read(prev[type]), false), __read((!includeExising && isIndexedNode(headers) ? [] : headers)), false)));
         return prev;
     }, {});
-    var allHeaders = selectedHeaders.length
-        ? selectedHeaders
-        : Object.keys(headersByType).flatMap(function (type) { return headersByType[type].map(function (key) { return "".concat(typeToColumnName(type), ".").concat(key); }); });
+    var headers = Object.keys(headersByType).flatMap(function (type) {
+        return headersByType[type].map(function (key) { return "".concat(typeToColumnName(type), ".").concat(key); });
+    });
+    var allHeaders = selectedHeaders.length ? selectedHeaders : includeAllHeaders ? headers : filterHeaders(headers);
     return [
         allHeaders.join(exports.csvColSep),
         nodes

package/package.json

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