@mat3ra/esse 2024.2.6-0 → 2024.2.19-0

package/src/js/utils/filesystem.ts

@@ -0,0 +1,34 @@
+/* eslint-disable no-await-in-loop */
+/* eslint-disable no-restricted-syntax */
+import fs from "fs";
+import path from "path";
+
+export async function walkDir(dir: string, callback: (itemPath: string) => void | Promise<void>) {
+    const subDirs = await fs.promises.readdir(dir);
+
+    for (const subDir of subDirs) {
+        const itemPath = path.join(dir, subDir);
+        const stat = await fs.promises.stat(itemPath);
+
+        if (stat.isDirectory()) {
+            await walkDir(itemPath, callback);
+        } else {
+            await callback(itemPath);
+        }
+    }
+}
+
+export function walkDirSync(dir: string, callback: (itemPath: string) => void) {
+    const subDirs = fs.readdirSync(dir);
+
+    for (const subDir of subDirs) {
+        const itemPath = path.join(dir, subDir);
+        const stat = fs.statSync(itemPath);
+
+        if (stat.isDirectory()) {
+            walkDirSync(itemPath, callback);
+        } else {
+            callback(itemPath);
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compilerOptions": {
+    "target": "ES2018",
+    "jsx": "react",
+    "lib": ["ES2019"],
+    "allowJs": true,
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "declaration": true,
+    "outDir": "./lib",
+    "noEmitOnError": false,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "types": ["mocha", "node"],
+    "rootDir": "./src",
+    "baseUrl": "./",
+  },
+  "include": [ 
+    "./src",
+    "modules.d.ts"
+  ],
+  "exclude": [
+      "node_modules",
+      "lib"
+  ],
+  "ts-node": {
+    "files": true,
+    "compilerOptions": {}
+  },
+}

package/example/workflow/unit.json

@@ -1,8 +0,0 @@
-{
-    "flowchartId": "pw-scf",
-    "head": true,
-    "name": "pw_scf",
-    "status": "idle",
-    "type": "execution",
-    "tags": ["test-tags"]
-}

package/lib/js/esse/index.js

@@ -1,101 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ESSE = void 0;
-
-var _ajv = _interopRequireDefault(require("ajv"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _jsYaml = _interopRequireDefault(require("js-yaml"));
-
-var _schemaUtils = require("./schemaUtils");
-
-var _settings = require("./settings");
-
-var _utils = require("./utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-var SCHEMAS = (0, _utils.parseIncludeReferenceStatementsByDir)(_settings.SCHEMAS_DIR);
-var EXAMPLES = (0, _utils.parseIncludeReferenceStatementsByDir)(_settings.EXAMPLES_DIR, true);
-
-var PROPERTIES_MANIFEST = _jsYaml["default"].load(_fs["default"].readFileSync(_settings.PROPERTIES_MANIFEST_PATH, {
-  encoding: "utf-8"
-}));
-
-var RESULTS = Object.entries(PROPERTIES_MANIFEST).map(function (k) {
-  return k[1].isResult ? k[0] : null;
-}).filter(function (x) {
-  return x;
-});
-
-var ESSE = /*#__PURE__*/function () {
-  function ESSE() {
-    var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-    _classCallCheck(this, ESSE);
-
-    _defineProperty(this, "validate", function (example, schema) {
-      var ajv = new _ajv["default"]({
-        allErrors: true
-      });
-      var isValid = ajv.validate(schema, example);
-
-      if (!isValid) {
-        console.error(ajv.errors);
-      }
-
-      return isValid;
-    });
-
-    this.schemas = config.schemas || SCHEMAS;
-    this.wrappedExamples = config.wrappedExamples || EXAMPLES;
-    this.examples = this.wrappedExamples.map(function (example) {
-      return example.data;
-    });
-    this.propertiesManifest = config.propertiesManifest || PROPERTIES_MANIFEST;
-    this.results = config.results || RESULTS;
-  }
-
-  _createClass(ESSE, [{
-    key: "getSchemaById",
-    value: function getSchemaById(schemaId) {
-      return this.schemas.find(function (schema) {
-        return schema.$id === schemaId;
-      });
-    }
-    /**
-     * Validates a given example against the schema.
-     * @param example {Object|Array} example to validate.
-     * @param schema {Object} schema to validate the example with.
-     * @returns {boolean} whether example is valid.
-     */
-
-  }, {
-    key: "buildGlobalSchema",
-    value: function buildGlobalSchema() {
-      return {
-        $id: "esse-global-schema",
-        $schema: "http://json-schema.org/draft-04/schema#",
-        title: "Global schema",
-        type: "object",
-        definitions: (0, _schemaUtils.buildSchemaDefinitions)(this.schemas)
-      };
-    }
-  }]);
-
-  return ESSE;
-}();
-
-exports.ESSE = ESSE;

package/lib/js/json_include/utils.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isInstanceOf = isInstanceOf;
-exports.safeParseJSON = safeParseJSON;
-
-function isInstanceOf(object, type) {
-  return Object.prototype.toString.call(object).slice(8, -1) === type;
-}
-/**
- * Makes sure that text representing arrays is parsed into Arrays.
- */
-
-
-function safeParseJSON(string) {
-  var obj = JSON.parse(string);
-  return string[0] === "[" ? Object.keys(obj).map(function (key) {
-    return obj[key];
-  }) : obj;
-}

package/src/js/esse/index.js

@@ -1,57 +0,0 @@
-import Ajv from "ajv";
-import fs from "fs";
-import yaml from "js-yaml";
-
-import { buildSchemaDefinitions } from "./schemaUtils";
-import { EXAMPLES_DIR, PROPERTIES_MANIFEST_PATH, SCHEMAS_DIR } from "./settings";
-import { parseIncludeReferenceStatementsByDir } from "./utils";
-
-const SCHEMAS = parseIncludeReferenceStatementsByDir(SCHEMAS_DIR);
-const EXAMPLES = parseIncludeReferenceStatementsByDir(EXAMPLES_DIR, true);
-const PROPERTIES_MANIFEST = yaml.load(
-    fs.readFileSync(PROPERTIES_MANIFEST_PATH, { encoding: "utf-8" }),
-);
-const RESULTS = Object.entries(PROPERTIES_MANIFEST)
-    .map((k) => (k[1].isResult ? k[0] : null))
-    .filter((x) => x);
-
-export class ESSE {
-    constructor(config = {}) {
-        this.schemas = config.schemas || SCHEMAS;
-        this.wrappedExamples = config.wrappedExamples || EXAMPLES;
-        this.examples = this.wrappedExamples.map((example) => example.data);
-        this.propertiesManifest = config.propertiesManifest || PROPERTIES_MANIFEST;
-        this.results = config.results || RESULTS;
-    }
-
-    getSchemaById(schemaId) {
-        return this.schemas.find((schema) => schema.$id === schemaId);
-    }
-
-    /**
-     * Validates a given example against the schema.
-     * @param example {Object|Array} example to validate.
-     * @param schema {Object} schema to validate the example with.
-     * @returns {boolean} whether example is valid.
-     */
-    validate = (example, schema) => {
-        const ajv = new Ajv({ allErrors: true });
-        const isValid = ajv.validate(schema, example);
-
-        if (!isValid) {
-            console.error(ajv.errors);
-        }
-
-        return isValid;
-    };
-
-    buildGlobalSchema() {
-        return {
-            $id: "esse-global-schema",
-            $schema: "http://json-schema.org/draft-04/schema#",
-            title: "Global schema",
-            type: "object",
-            definitions: buildSchemaDefinitions(this.schemas),
-        };
-    }
-}

package/src/js/esse/schemaUtils.js

@@ -1,45 +0,0 @@
-import keyBy from "lodash/keyBy";
-
-export function mapObjectDeep(object, mapValue) {
-    if (typeof object !== "object") {
-        return object;
-    }
-
-    if (Array.isArray(object)) {
-        return object.map(
-            (innerValue) => mapValue(innerValue) || mapObjectDeep(innerValue, mapValue),
-        );
-    }
-
-    const entries = Object.entries(object).map(([key, value]) => {
-        const res = mapValue(value);
-
-        return [key, res === undefined ? mapObjectDeep(value, mapValue) : res];
-    });
-
-    return Object.fromEntries(entries);
-}
-
-export function makeFlatSchemaKey(schemaId) {
-    return schemaId.replace(/[^a-zA-Z-]/g, ":");
-}
-
-export function makeFlatSchemaRef(schemaId) {
-    return { $ref: `#/definitions/${makeFlatSchemaKey(schemaId)}` };
-}
-
-export function buildSchemaDefinitions(originalSchemas) {
-    const schemas = originalSchemas.map((schema) => {
-        return mapObjectDeep(schema, (value) => {
-            if (typeof value === "object" && value.$id) {
-                return makeFlatSchemaRef(value.$id);
-            }
-            if (typeof value === "object" && value.$ref) {
-                // assume value.$ref is a $id
-                return makeFlatSchemaRef(value.$ref);
-            }
-        });
-    });
-
-    return keyBy(schemas, ({ $id }) => makeFlatSchemaKey($id));
-}

package/src/js/esse/utils.js

@@ -1,52 +0,0 @@
-import file from "file";
-import deref from "json-schema-deref-sync";
-import path from "path";
-
-import { JSONInclude } from "../json_include";
-
-/**
- * Resolves `include` and `$ref` statements.
- * @param filePath {String} file to parse.
- */
-export function parseIncludeReferenceStatements(filePath) {
-    const jsonResolver = new JSONInclude();
-    const parsed = jsonResolver.parseIncludeStatements(filePath);
-    const dirPath = path.dirname(filePath);
-    let dereferenced = deref(parsed, { baseFolder: dirPath });
-    // handle circular references and use non-dereferenced source
-    if (dereferenced instanceof Error && dereferenced.message === "Circular self reference") {
-        dereferenced = parsed;
-    }
-    return dereferenced;
-}
-
-/**
- * Resolves `include` and `$ref` statements for all the JSON files inside a given directory.
- * @param dirPath {String} directory to parse.
- */
-export function parseIncludeReferenceStatementsByDir(dirPath, wrapInDataAndPath = false) {
-    const data = [];
-    const topDir = path.resolve(__dirname, "../../../");
-    file.walkSync(dirPath, (dirPath_, dirs_, files_) => {
-        files_.forEach((file_) => {
-            const filePath = path.join(dirPath_, file_);
-            if (filePath.endsWith(".json")) {
-                const config = parseIncludeReferenceStatements(filePath);
-                if (wrapInDataAndPath) {
-                    const _path = path.join(
-                        // remove leading slashes and "example" from path
-                        path
-                            .dirname(filePath)
-                            .replace(path.join(topDir, "example"), "")
-                            .replace(/^\/+/, ""),
-                        path.basename(filePath).replace(".json", ""),
-                    );
-                    data.push({ data: config, path: _path });
-                } else {
-                    data.push(config);
-                }
-            }
-        });
-    });
-    return data;
-}

package/src/js/json_include/utils.js

@@ -1,11 +0,0 @@
-export function isInstanceOf(object, type) {
-    return Object.prototype.toString.call(object).slice(8, -1) === type;
-}
-
-/**
- * Makes sure that text representing arrays is parsed into Arrays.
- */
-export function safeParseJSON(string) {
-    const obj = JSON.parse(string);
-    return string[0] === "[" ? Object.keys(obj).map((key) => obj[key]) : obj;
-}

package/src/js/scripts/setSchemaIds.mjs

@@ -1,34 +0,0 @@
-/* eslint-disable no-restricted-syntax */
-/* eslint-disable no-await-in-loop */
-import fs from "fs/promises";
-import path from "path";
-
-const SCHEMA_DIR = "../../../schema/";
-
-async function walkDir(dir, callback) {
-    const subDirs = await fs.readdir(dir);
-
-    for (const subDir of subDirs) {
-        const itemPath = path.join(dir, subDir);
-        const stat = await fs.stat(itemPath);
-
-        if (stat.isDirectory()) {
-            await walkDir(itemPath, callback);
-        } else {
-            await callback(itemPath);
-        }
-    }
-}
-
-await walkDir(SCHEMA_DIR, async (filePath) => {
-    if (path.extname(filePath) !== ".json") {
-        return;
-    }
-
-    const fileContents = await fs.readFile(filePath);
-    const { $id: oldSchemaId, ...schema } = JSON.parse(fileContents);
-    const schemaId = filePath.replace(SCHEMA_DIR, "").replace(".json", "").replace(/_/g, "-");
-    const newContent = JSON.stringify({ $id: schemaId, ...schema }, null, 4);
-
-    await fs.writeFile(filePath, `${newContent}\n`);
-});