@mat3ra/esse 2024.1.25-7 → 2024.1.26-0

package/build_schemas.js

@@ -8,8 +8,10 @@ const path = require("path");
 const mergeAllOf = require("json-schema-merge-allof");
 const { ESSE } = require("./lib/js/esse");
 
+// JS Modules
+
 const esse = new ESSE();
-const { schemas, wrappedExamples } = esse;
+const { schemas, wrappedExamples, propertiesManifest, results } = esse;
 const schema = esse.buildGlobalSchema();
 
 fs.writeFileSync(
@@ -20,19 +22,47 @@ fs.writeFileSync(
 
 fs.writeFileSync("./schema.js", "module.exports = " + JSON.stringify(schema), "utf8");
 
+if (process.env.BUILD_PYTHON_MODULES === "true") {
+    // PY Modules
+    fs.writeFileSync(
+        "./src/py/mat3ra/esse/data/examples.py",
+        ["import json", `EXAMPLES = json.loads(r'''${JSON.stringify(wrappedExamples)}''')`].join(
+            "\n",
+        ),
+        "utf8",
+    );
+    fs.writeFileSync(
+        "./src/py/mat3ra/esse/data/schemas.py",
+        ["import json", `SCHEMAS = json.loads(r'''${JSON.stringify(schemas)}''')`].join("\n"),
+        "utf8",
+    );
+    fs.writeFileSync(
+        "./src/py/mat3ra/esse/data/properties.py",
+        [
+            "import json",
+            `PROPERTIES_MANIFEST = json.loads(r'''${JSON.stringify(propertiesManifest)}''')`,
+            `RESULTS = json.loads(r'''${JSON.stringify(results)}''')`,
+        ].join("\n"),
+        "utf8",
+    );
+}
+
 if (process.env.BUILD_ASSETS !== "true") {
     process.exit(0);
 }
 
 const subfolder = process.env.BUILD_PATH || "./docs/js/";
 schemas.forEach((s) => {
+    let mergedSchema = s;
     if (process.env.SKIP_MERGE_ALLOF !== "true") {
-        s = mergeAllOf(s, { resolvers: { defaultResolver: mergeAllOf.options.resolvers.title } });
+        mergedSchema = mergeAllOf(s, {
+            resolvers: { defaultResolver: mergeAllOf.options.resolvers.title },
+        });
     }
-    const id_as_path = s.$id.replace("-", "_");
+    const id_as_path = mergedSchema.$id.replace("-", "_");
     const full_path = `${subfolder}/schema/${id_as_path}.json`;
     fs.mkdirSync(path.dirname(full_path), { recursive: true });
-    fs.writeFileSync(full_path, JSON.stringify(s, null, 4), "utf8");
+    fs.writeFileSync(full_path, JSON.stringify(mergedSchema, null, 4), "utf8");
 });
 wrappedExamples.forEach((e) => {
     const id_as_path = e.path.replace("-", "_");

package/lib/js/esse/index.js

@@ -7,6 +7,10 @@ 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");
@@ -26,8 +30,20 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 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) {
@@ -43,11 +59,13 @@ var ESSE = /*#__PURE__*/function () {
       return isValid;
     });
 
-    this.schemas = SCHEMAS;
-    this.wrappedExamples = EXAMPLES;
-    this.examples = EXAMPLES.map(function (example) {
+    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, [{

package/lib/js/esse/settings.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SCHEMAS_DIR = exports.EXAMPLES_DIR = void 0;
+exports.SCHEMAS_DIR = exports.PROPERTIES_MANIFEST_PATH = exports.EXAMPLES_DIR = void 0;
 
 var _path = _interopRequireDefault(require("path"));
 
@@ -15,4 +15,8 @@ exports.SCHEMAS_DIR = SCHEMAS_DIR;
 
 var EXAMPLES_DIR = _path["default"].resolve(__dirname, "../../../example");
 
-exports.EXAMPLES_DIR = EXAMPLES_DIR;
+exports.EXAMPLES_DIR = EXAMPLES_DIR;
+
+var PROPERTIES_MANIFEST_PATH = _path["default"].resolve(__dirname, "../../../manifest/properties.yaml");
+
+exports.PROPERTIES_MANIFEST_PATH = PROPERTIES_MANIFEST_PATH;

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "@mat3ra/esse",
-    "version": "2024.1.25-7",
+    "version": "2024.1.26-0",
     "description": "Mat3ra's Excellent Source of Schemas and Examples (ESSE) for Digital Materials R&D",
     "scripts": {
         "prepublishOnly": "rm -rf lib; npm run transpile",
         "transpile": "mkdir -p lib; babel src/js --out-dir lib/js; node build_schemas.js",
         "transpile-and-build-assets": "mkdir -p lib; babel src/js --out-dir lib/js; BUILD_ASSETS=true BUILD_PATH='./lib/js' node build_schemas.js",
         "build:assets": "node build_schemas.js",
+        "build:js-and-python-modules": "BUILD_PYTHON_MODULES=true node build_schemas.js",
         "build:assets-with-docs": "BUILD_ASSETS=true node build_schemas.js",
         "test": "nyc --reporter=text mocha --bail --require @babel/register tests/js/",
         "lint": "eslint src/js && prettier --write src/js",

package/src/js/esse/index.js

@@ -1,17 +1,27 @@
 import Ajv from "ajv";
+import fs from "fs";
+import yaml from "js-yaml";
 
 import { buildSchemaDefinitions } from "./schemaUtils";
-import { EXAMPLES_DIR, SCHEMAS_DIR } from "./settings";
+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() {
-        this.schemas = SCHEMAS;
-        this.wrappedExamples = EXAMPLES;
-        this.examples = EXAMPLES.map((example) => example.data);
+    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) {

package/src/js/esse/settings.js

@@ -2,3 +2,7 @@ import path from "path";
 
 export const SCHEMAS_DIR = path.resolve(__dirname, "../../../schema");
 export const EXAMPLES_DIR = path.resolve(__dirname, "../../../example");
+export const PROPERTIES_MANIFEST_PATH = path.resolve(
+    __dirname,
+    "../../../manifest/properties.yaml",
+);