Merge pull request #92 from Exabyte-io/feature/SOF-7753

Feature/SOF-7753 Update: move CP names to ESSE

Author: VsevolodX

dist/js/context/ContextProvider.d.ts

@@ -1,60 +1,27 @@
+import { ContextProviderSchema, Name as ContextProviderNameEnum } from "@mat3ra/esse/dist/js/types";
 export interface ContextProviderInstance {
     constructor: typeof ContextProvider;
-    config: ContextProviderConfig;
-}
-export interface ContextProviderConfig {
-    name: ContextProviderName | `${ContextProviderName}`;
-    domain?: string;
-    entityName?: string;
-    data?: object;
-    extraData?: object;
-    isEdited?: boolean;
-    context?: object;
-}
-export declare enum ContextProviderName {
-    PlanewaveCutoffDataManager = "PlanewaveCutoffDataManager",
-    KGridFormDataManager = "KGridFormDataManager",
-    QGridFormDataManager = "QGridFormDataManager",
-    IGridFormDataManager = "IGridFormDataManager",
-    QPathFormDataManager = "QPathFormDataManager",
-    IPathFormDataManager = "IPathFormDataManager",
-    KPathFormDataManager = "KPathFormDataManager",
-    ExplicitKPathFormDataManager = "ExplicitKPathFormDataManager",
-    ExplicitKPath2PIBAFormDataManager = "ExplicitKPath2PIBAFormDataManager",
-    HubbardJContextManager = "HubbardJContextManager",
-    HubbardUContextManager = "HubbardUContextManager",
-    HubbardVContextManager = "HubbardVContextManager",
-    HubbardContextManagerLegacy = "HubbardContextManagerLegacy",
-    NEBFormDataManager = "NEBFormDataManager",
-    BoundaryConditionsFormDataManager = "BoundaryConditionsFormDataManager",
-    MLSettingsDataManager = "MLSettingsDataManager",
-    MLTrainTestSplitDataManager = "MLTrainTestSplitDataManager",
-    IonDynamicsContextProvider = "IonDynamicsContextProvider",
-    CollinearMagnetizationDataManager = "CollinearMagnetizationDataManager",
-    NonCollinearMagnetizationDataManager = "NonCollinearMagnetizationDataManager",
-    QEPWXInputDataManager = "QEPWXInputDataManager",
-    QENEBInputDataManager = "QENEBInputDataManager",
-    VASPInputDataManager = "VASPInputDataManager",
-    VASPNEBInputDataManager = "VASPNEBInputDataManager",
-    NWChemInputDataManager = "NWChemInputDataManager"
+    config: ContextProviderSchema;
 }
 export interface ContextProviderStatic {
-    getConstructorConfig: (config: ContextProviderConfig) => ContextProviderInstance;
-    createConfigFromContext: (config: ContextProviderConfig) => ContextProviderConfig;
+    getConstructorConfig: (config: ContextProviderSchema) => ContextProviderInstance;
+    createConfigFromContext: (config: ContextProviderSchema) => ContextProviderSchema;
     getExtraDataKeyByName: (name: string) => string;
     getIsEditedKeyByName: (name: string) => string;
 }
-export default class ContextProvider {
-    config: ContextProviderConfig;
-    name: `${ContextProviderName}`;
+export default class ContextProvider implements ContextProviderSchema {
+    config: ContextProviderSchema;
+    name: ContextProviderNameEnum;
     domain?: string;
     entityName?: string;
     data?: object;
     extraData?: object;
     isEdited?: boolean;
-    constructor(config: ContextProviderConfig);
-    static getConstructorConfig(config: ContextProviderConfig): ContextProviderInstance;
-    static createConfigFromContext(config: ContextProviderConfig): ContextProviderConfig & ({
+    context?: object;
+    [k: string]: unknown;
+    constructor(config: ContextProviderSchema);
+    static getConstructorConfig(config: ContextProviderSchema): ContextProviderInstance;
+    static createConfigFromContext(config: ContextProviderSchema): ContextProviderSchema & ({
         data: never;
         extraData: any;
         isEdited: any;

dist/js/context/ContextProvider.js

@@ -3,49 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextProviderName = void 0;
-/*
- * @summary This is a standalone class that contains "data" for a property with "name". Helps facilitate UI logic.
- *          Can be initialized from context when user edits are present:
- *          - user edits the corresponding property, eg. "kpath"
- *          - isKpathEdited is set to `true`
- *          - context property is updated for the parent entity (eg. Unit) in a way that persists in Redux state
- *          - new entity inherits the "data" through "context" field in config
- *          - `extraData` field is used to store any other data that should be passed from one instance of provider
- *             to next one, for example data about material to track when it is changed.
- * @notes   Should hold static data only (see `setData` method), no classes or functions
- */
 const utils_1 = require("@mat3ra/utils");
 const lodash_1 = __importDefault(require("lodash"));
-// TODO: separate application-specific CPs
-var ContextProviderName;
-(function (ContextProviderName) {
-    ContextProviderName["PlanewaveCutoffDataManager"] = "PlanewaveCutoffDataManager";
-    ContextProviderName["KGridFormDataManager"] = "KGridFormDataManager";
-    ContextProviderName["QGridFormDataManager"] = "QGridFormDataManager";
-    ContextProviderName["IGridFormDataManager"] = "IGridFormDataManager";
-    ContextProviderName["QPathFormDataManager"] = "QPathFormDataManager";
-    ContextProviderName["IPathFormDataManager"] = "IPathFormDataManager";
-    ContextProviderName["KPathFormDataManager"] = "KPathFormDataManager";
-    ContextProviderName["ExplicitKPathFormDataManager"] = "ExplicitKPathFormDataManager";
-    ContextProviderName["ExplicitKPath2PIBAFormDataManager"] = "ExplicitKPath2PIBAFormDataManager";
-    ContextProviderName["HubbardJContextManager"] = "HubbardJContextManager";
-    ContextProviderName["HubbardUContextManager"] = "HubbardUContextManager";
-    ContextProviderName["HubbardVContextManager"] = "HubbardVContextManager";
-    ContextProviderName["HubbardContextManagerLegacy"] = "HubbardContextManagerLegacy";
-    ContextProviderName["NEBFormDataManager"] = "NEBFormDataManager";
-    ContextProviderName["BoundaryConditionsFormDataManager"] = "BoundaryConditionsFormDataManager";
-    ContextProviderName["MLSettingsDataManager"] = "MLSettingsDataManager";
-    ContextProviderName["MLTrainTestSplitDataManager"] = "MLTrainTestSplitDataManager";
-    ContextProviderName["IonDynamicsContextProvider"] = "IonDynamicsContextProvider";
-    ContextProviderName["CollinearMagnetizationDataManager"] = "CollinearMagnetizationDataManager";
-    ContextProviderName["NonCollinearMagnetizationDataManager"] = "NonCollinearMagnetizationDataManager";
-    ContextProviderName["QEPWXInputDataManager"] = "QEPWXInputDataManager";
-    ContextProviderName["QENEBInputDataManager"] = "QENEBInputDataManager";
-    ContextProviderName["VASPInputDataManager"] = "VASPInputDataManager";
-    ContextProviderName["VASPNEBInputDataManager"] = "VASPNEBInputDataManager";
-    ContextProviderName["NWChemInputDataManager"] = "NWChemInputDataManager";
-})(ContextProviderName || (exports.ContextProviderName = ContextProviderName = {}));
 class ContextProvider {
     constructor(config) {
         this.config = config;

dist/js/context/ContextProviderJinja.d.ts

@@ -0,0 +1,10 @@
+import { ContextProviderSchema } from "@mat3ra/esse/dist/js/types";
+import ContextProvider from "./ContextProvider";
+interface JSONSchemaDataProviderConfig extends ContextProviderSchema {
+    isUsingJinjaVariables?: boolean;
+}
+export default class ContextProviderJinja extends ContextProvider {
+    isUsingJinjaVariables: boolean;
+    constructor(config: JSONSchemaDataProviderConfig);
+}
+export {};

dist/js/context/ContextProviderJinja.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ContextProvider_1 = __importDefault(require("./ContextProvider"));
+class ContextProviderJinja extends ContextProvider_1.default {
+    constructor(config) {
+        super(config);
+        this.isUsingJinjaVariables = Boolean(config.isUsingJinjaVariables);
+    }
+}
+exports.default = ContextProviderJinja;

dist/js/context/JSONSchemaDataProvider.d.ts

@@ -0,0 +1,7 @@
+import JinjaContextProvider from "./JinjaContextProvider";
+/**
+ * @summary Provides jsonSchema only.
+ */
+export default class JSONSchemaDataProvider extends JinjaContextProvider {
+    get jsonSchema(): void;
+}

dist/js/context/JSONSchemaDataProvider.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable class-methods-use-this */
+const JinjaContextProvider_1 = __importDefault(require("./JinjaContextProvider"));
+/**
+ * @summary Provides jsonSchema only.
+ */
+class JSONSchemaDataProvider extends JinjaContextProvider_1.default {
+    get jsonSchema() {
+        throw new Error("Not implemented.");
+    }
+}
+exports.default = JSONSchemaDataProvider;

dist/js/context/JSONSchemaFormDataProvider.d.ts

@@ -1,8 +1,5 @@
 import type { UiSchema } from "react-jsonschema-form";
-import ContextProvider, { type ContextProviderConfig } from "./ContextProvider";
-interface JSONSchemaFormDataProviderConfig extends ContextProviderConfig {
-    isUsingJinjaVariables?: boolean;
-}
+import JSONSchemaDataProvider from "./JSONSchemaDataProvider";
 /**
  * @summary Provides jsonSchema and uiSchema for generating react-jsonschema-form
  *          See https://github.com/mozilla-services/react-jsonschema-form for Form UI.
@@ -13,13 +10,9 @@ interface JSONSchemaFormDataProviderConfig extends ContextProviderConfig {
  *      formData={provider.getData(unit.important)} />
  * ```
  */
-export default class JSONSchemaFormDataProvider extends ContextProvider {
-    isUsingJinjaVariables: boolean;
-    constructor(config: JSONSchemaFormDataProviderConfig);
-    get jsonSchema(): void;
+export default class JSONSchemaFormDataProvider extends JSONSchemaDataProvider {
     get uiSchema(): UiSchema;
     get fields(): {};
     get defaultFieldStyles(): {};
     get uiSchemaStyled(): UiSchema;
 }
-export {};

dist/js/context/JSONSchemaFormDataProvider.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ContextProvider_1 = __importDefault(require("./ContextProvider"));
+const JSONSchemaDataProvider_1 = __importDefault(require("./JSONSchemaDataProvider"));
 /**
  * @summary Provides jsonSchema and uiSchema for generating react-jsonschema-form
  *          See https://github.com/mozilla-services/react-jsonschema-form for Form UI.
@@ -14,14 +14,8 @@ const ContextProvider_1 = __importDefault(require("./ContextProvider"));
  *      formData={provider.getData(unit.important)} />
  * ```
  */
-class JSONSchemaFormDataProvider extends ContextProvider_1.default {
-    constructor(config) {
-        super(config);
-        this.isUsingJinjaVariables = Boolean(config === null || config === void 0 ? void 0 : config.isUsingJinjaVariables);
-    }
-    get jsonSchema() {
-        throw new Error("Not implemented.");
-    }
+// TODO: MOVE to WebApp/ave or wove
+class JSONSchemaFormDataProvider extends JSONSchemaDataProvider_1.default {
     get uiSchema() {
         throw new Error("Not implemented.");
     }

dist/js/context/JinjaContextProvider.d.ts

@@ -0,0 +1,10 @@
+import { ContextProviderSchema } from "@mat3ra/esse/dist/js/types";
+import ContextProvider from "./ContextProvider";
+interface JSONSchemaDataProviderConfig extends ContextProviderSchema {
+    isUsingJinjaVariables?: boolean;
+}
+export default class JinjaContextProvider extends ContextProvider {
+    isUsingJinjaVariables: boolean;
+    constructor(config: JSONSchemaDataProviderConfig);
+}
+export {};

dist/js/context/JinjaContextProvider.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ContextProvider_1 = __importDefault(require("./ContextProvider"));
+class JinjaContextProvider extends ContextProvider_1.default {
+    constructor(config) {
+        super(config);
+        this.isUsingJinjaVariables = Boolean(config.isUsingJinjaVariables);
+    }
+}
+exports.default = JinjaContextProvider;