Merge pull request #1 from Exabyte-io/chore/SOF-5949

Chore/sof 5949 - init repository with sources from `imports/core_code` in the main web application

Author: tjduigna

.nycrc

@@ -0,0 +1,7 @@
+{
+    "all": true,
+    "include": [
+        "src/**/*.js",
+        "src/**/*.jsx"
+    ]
+}

README.md

@@ -1,12 +1,48 @@
-# template-definitions
+[![npm version](https://badge.fury.io/js/%40exabyte-io%2F/code.js.svg)](https://badge.fury.io/js/%40exabyte-io%2F/code.js)
+[![License: Apache](https://img.shields.io/badge/License-Apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
-Template repository for entity definition libraries in Javascript
+# @exabyte-io/code.js
 
-See [here](https://docs.github.com/en/github-ae@latest/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
-for details on how to use this repository.
+@exabyte-io/code.js houses entity definitions for use in the Mat3ra platform.
 
-Included is a simple `template.py` analog to `cookiecutter` which will prompt
-the user for some information and then write out templated values in select files.
-After usage, the `template.py` file can be removed and the `README.md` and associated
-`files` can be committed.
+
+### Installation
+
+For usage within a javascript project:
+
+```bash
+npm install @exabyte-io/code.js
+```
+
+For development:
+
+```bash
+git clone https://github.com/Exabyte-io/code.js.git
+```
+
+
+### Contribution
+
+This repository is an [open-source](LICENSE.md) work-in-progress and we welcome contributions.
+
+We regularly deploy the latest code containing all accepted contributions online as part of the
+[Mat3ra.com](https://mat3ra.com) platform, so contributors will see their code in action there.
+
+See [ESSE](https://github.com/Exabyte-io/esse) for additional context regarding the data schemas used here.
+
+Useful commands for development:
+
+```bash
+# run linter without persistence
+npm run lint
+
+# run linter and save edits
+npm run lint:fix
+
+# compile the library
+npm run transpile
+
+# run tests
+npm run test
+```
 

package-lock.json

@@ -1,31 +1,35 @@
 {
-    "name": "@exabyte-io/PROJECT_NAME",
+    "name": "@exabyte-io/code.js",
     "version": "0.0.0",
-    "description": "PROJECT_DESCRIPTION",
+    "description": "COre DEfinitions in JS for Mat3ra.com (Exabyte.io)",
     "scripts": {
         "test": "nyc --reporter=text mocha --recursive --bail --require @babel/register/lib --require tests/setup.js tests",
         "lint": "eslint src tests && prettier --write src tests",
         "lint:fix": "eslint --fix --cache src tests && prettier --write src tests",
         "transpile": "babel --out-dir dist src",
-        "postinstall": "npm run transpile",
-        "prepare": "husky install"
+        "postinstall": "npm run transpile"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/Exabyte-io/PROJECT_NAME.git"
+        "url": "https://github.com/Exabyte-io/code.js.git"
     },
     "main": "dist/index.js",
+    "exports": {
+        "./context": "./dist/context/index.js",
+        "./entity": "./dist/entity/index.js",
+        "./utils": "./dist/utils/index.js"
+    },
     "files": [
         "/dist",
         "/src",
         ".babelrc"
     ],
     "author": "Exabyte Inc.",
     "bugs": {
-        "url": "https://github.com/Exabyte-io/PROJECT_NAME/issues"
+        "url": "https://github.com/Exabyte-io/code.js/issues"
     },
     "license": "Apache-2.0",
-    "homepage": "https://github.com/Exabyte-io/PROJECT_NAME",
+    "homepage": "https://github.com/Exabyte-io/code.js",
     "dependencies": {
         "@babel/cli": "7.16.0",
         "@babel/core": "7.16.0",
@@ -34,7 +38,11 @@
         "@babel/preset-env": "7.16.4",
         "@babel/preset-react": "7.16.7",
         "@babel/register": "^7.16.0",
-        "@babel/runtime-corejs3": "7.16.8"
+        "@babel/runtime-corejs3": "7.16.8",
+        "crypto-js": "^4.1.1",
+        "lodash": "^4.17.21",
+        "mixwith": "^0.1.1",
+        "underscore": "^1.13.3"
     },
     "devDependencies": {
         "chai": "^4.3.4",
@@ -59,4 +67,3 @@
         "*.{js,css}": "prettier --write"
     }
 }
-

package.json

@@ -0,0 +1,31 @@
+import { ContextProvider } from "./provider";
+import { ContextProviderRegistryContainer } from "./registry";
+
+import { JobContextPickKeysForMixin, WorkflowContextPickKeysForMixin } from "./pickers";
+
+import {
+    ApplicationContextMixinBuilder,
+    MaterialContextMixinBuilder,
+    MaterialsContextMixinBuilder,
+    MaterialsSetContextMixin,
+    MethodDataContextMixin,
+    JobContextMixin,
+    WorkflowContextMixin,
+} from "./mixins";
+
+export {
+    ContextProvider,
+    ContextProviderRegistryContainer,
+
+    JobContextPickKeysForMixin,
+    WorkflowContextPickKeysForMixin,
+
+    ApplicationContextMixinBuilder,
+    MaterialContextMixinBuilder,
+    MaterialsContextMixinBuilder,
+    MaterialsSetContextMixin,
+    MethodDataContextMixin,
+    JobContextMixin,
+    WorkflowContextMixin,
+
+};

src/context/index.js

@@ -0,0 +1,138 @@
+import CryptoJS from "crypto-js";
+
+import { compareEntitiesInOrderedSetForSorting } from "../entity/set/ordered/utils";
+
+export const ApplicationContextMixinBuilder = (applicationCls) => (superclass) => class extends superclass {
+    constructor(config) {
+        super(config);
+        if (!applicationCls) throw Error("ApplicationContextMixinBuilder: applicationCls is undefined");
+        this._application = config.context && config.context.application || applicationCls.createDefault();
+    }
+
+    get application() {
+        return this._application;
+    }
+};
+
+export const MaterialContextMixinBuilder = (materialCls) => (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        if (!materialCls) throw Error("MaterialContextMixinBuilder: materialCls is undefined");
+        this._material = config.context && config.context.material;
+        if (!this._material) this._material = materialCls.createDefault();
+        this.updateMaterialHash();
+    }
+
+    get isEditedIsSetToFalseOnMaterialUpdate() {
+        return false;
+    }
+
+    updateMaterialHash() {
+        if (this.isEditedIsSetToFalseOnMaterialUpdate) this.isEdited = false;
+        this.extraData = {materialHash: this.material.hash};
+    }
+
+    // Workaround: Material.createDefault() used to initiate workflow reducer and hence here too
+    //  does not have an id. Here we catch when such material is used and avoid resetting isEdited
+    get isMaterialCreatedDefault() {
+        return !Boolean(this.material.id);
+    }
+
+    get isMaterialUpdated() {
+        return Boolean(this.extraData && (this.extraData.materialHash !== this.material.hash));
+    }
+
+    get material() {
+        return this._material;
+    }
+};
+
+export const MaterialsSetContextMixin = (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        this._materialsSet = this.config.context && this.config.context.materialsSet;
+    }
+
+    get materialsSet() {return this._materialsSet}
+
+    sortMaterialsByIndexInSet(materials = []) {
+        // DO NOT SORT IN PLACE AS IT CHANGES THE ORDER IN `this.materials` AND HAS SIDE EFFECTS (MaterialViewer).
+        return materials.concat().sort((a, b) => compareEntitiesInOrderedSetForSorting(a, b, this.materialsSet._id, false));
+    }
+
+};
+
+export const MaterialsContextMixinBuilder = (materialCls) => (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        const materials = this.config.context && this.config.context.materials;
+        if (!materialCls) throw Error("MaterialsContextMixinBuilder: materialCls is undefined");
+        this._materials = (materials && materials.length) ? materials : [materialCls.createDefault()];
+    }
+
+    get materials() {return this._materials}
+};
+
+export const MethodDataContextMixin = (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        this._methodData = config.context && config.context.methodData || {};
+        this.isEdited = false;  // we always get the `defaultData` (recalculated from scratch, not persistent)
+    }
+
+    /* @summary Replace the logic in constructor with this in order to enable passing `methodDataHash` between
+     *          subsequent initializations of the derived class. Not used at present and kept for the record.
+     */
+    _initMethodDataHash() {
+        this.methodDataHash = CryptoJS.MD5(JSON.stringify(this.methodData)).toString();
+        this.extraData = {methodDataHash: this.methodDataHash};
+        if (!this._methodData) {
+            this._methodData = {};
+            this.isEdited = false;
+            // Commented out to reduce effect on performance. Uncomment for debugging purposes.
+            // TODO: remove on next refactoring or convert to log
+            // console.warn("MethodDataContextMixin: methodData is undefined or null");
+        } else {
+            if (this.isMethodDataUpdated) {
+                this.isEdited = false;
+            } else {
+                this.isEdited = config.isEdited;
+            }
+        }
+    }
+
+    get methodData() {return this._methodData}
+
+    get isMethodDataUpdated() {
+        return Boolean(this.extraData && (this.extraData.methodDataHash !== this.methodDataHash));
+    }
+
+};
+
+export const WorkflowContextMixin = (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        this._workflow = config.context && config.context.workflow || {};
+        this.isEdited = false;  // we always get the `defaultData` (recalculated from scratch, not persistent)
+    }
+
+    get workflow() {return this._workflow}
+
+};
+
+export const JobContextMixin = (superclass) => class extends superclass {
+
+    constructor(config) {
+        super(config);
+        this._job = config.context && config.context.job || {};
+        this.isEdited = false;  // we always get the `defaultData` (recalculated from scratch, not persistent)
+    }
+
+    get job() {return this._job}
+
+};

src/context/mixins.js

@@ -0,0 +1,17 @@
+import _ from "underscore";
+
+export const WorkflowContextPickKeysForMixin = (workflow) => {
+    return {
+        workflow: _.pick(workflow, [
+            "hasRelaxation"
+        ])
+    };
+};
+
+export const JobContextPickKeysForMixin = (job) => {
+    return {
+        job: _.pick(job, [
+            "parentJob"
+        ])
+    };
+};