@mat3ra/prode 2025.11.25-0

package/.babelrc

@@ -0,0 +1,17 @@
+{
+    "presets": [
+        [
+            "@babel/preset-env",
+            {
+                "targets": {
+                    "node": "current"
+                }
+            }
+        ],
+        "@babel/preset-react",
+    ],
+    "plugins": [
+        "@babel/plugin-proposal-class-properties"
+    ]
+}
+

package/LICENSE.md

@@ -0,0 +1,15 @@
+# LICENSE
+
+Copyright 2022 Exabyte Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,93 @@
+[![npm version](https://badge.fury.io/js/%40exabyte-io%2Fprode.svg)](https://badge.fury.io/js/%40exabyte-io%2Fprode)
+[![License: Apache](https://img.shields.io/badge/License-Apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+# prode
+
+PROperty DEfinitions - prode - houses Property entity definitions for use in the Mat3ra platform.
+
+
+### Installation
+
+For usage within a javascript project:
+
+```bash
+npm install @exabyte-io/prode
+```
+
+For development:
+
+```bash
+git clone https://github.com/Exabyte-io/prode.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
+```
+
+## Using Linter
+
+Linter setup will prevent committing files that don't adhere to the code standard. It will
+attempt to fix what it can automatically prior to the commit in order to reduce diff noise. This can lead to "unexpected" behavior where a
+file that is staged for commit is not identical to the file that actually gets committed. This happens
+in the `lint-staged` directive of the `package.json` file (by using a `husky` pre-commit hook). For example,
+if you add extra whitespace to a file, stage it, and try to commit it, you will see the following:
+
+```bash
+➜  repo-js git:(feature/cool-feature) ✗ git commit -m "Awesome feature works great"
+✔ Preparing...
+✔ Running tasks...
+✖ Prevented an empty git commit!
+✔ Reverting to original state because of errors...
+✔ Cleaning up...
+
+  ⚠ lint-staged prevented an empty git commit.
+  Use the --allow-empty option to continue, or check your task configuration
+
+husky - pre-commit hook exited with code 1 (error)
+```
+
+The staged change may remain but will not have been committed. Then it will look like you still have a staged
+change to commit, but the pre-commit hook will not actually commit it for you, quite frustrating! Styling can
+be applied manually and fixed by running:
+
+```bash
+npm run lint:fix
+```
+
+In which case, you may need to then add the linter edits to your staging, which in the example above, puts the
+file back to identical with the base branch, resulting in no staged changes whatsoever.
+
+ProDe
+=====
+
+The`ProDe` package is central to many other entities in the Mat3ra workflow
+ecosystem, where `ProDe` houses entity definitions for:
+
+- `Property` - the basic definition of a property
+  - properties can be of the following types:
+    - `scalar` `non_scalar` `tensor` `object`
+  - specific properties are implemented by subclassing `Property`
+  - more info at https://docs.mat3ra.com/properties/overview/
+

package/dist/js/MetaProperty.d.ts

@@ -0,0 +1,3 @@
+import Property from "./Property";
+export default class MetaProperty<TSchema extends object = object> extends Property<TSchema> {
+}

package/dist/js/MetaProperty.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Property_1 = __importDefault(require("./Property"));
+class MetaProperty extends Property_1.default {
+}
+exports.default = MetaProperty;

package/dist/js/Property.d.ts

@@ -0,0 +1,25 @@
+import { NamedInMemoryEntity } from "@mat3ra/code/dist/js/entity";
+import type { AnyObject } from "@mat3ra/esse/dist/js/esse/types";
+import type { PropertyHolderSchema } from "@mat3ra/esse/dist/js/types";
+import { type PropertyName, PropertyType } from "./settings";
+export type PropertySchemaJSON = PropertyHolderSchema["data"] & AnyObject;
+export type PropertyRowValue = PropertySchemaJSON & {
+    slug?: string;
+    group?: string;
+};
+export default class Property<TSchema extends object = object> extends NamedInMemoryEntity {
+    toJSON: (exclude?: string[]) => TSchema & AnyObject;
+    _json: TSchema & AnyObject;
+    name: `${PropertyName}`;
+    readonly prettyName: string;
+    static readonly propertyType: PropertyType;
+    static readonly propertyName: PropertyName;
+    static readonly isRefined: boolean;
+    static readonly isConvergence: boolean;
+    static readonly isAbleToReturnMultipleResults: boolean;
+    toRowValues(group: string | undefined, slug: string | undefined): (TSchema & AnyObject & {
+        slug?: string;
+        group?: string;
+    })[];
+    static prettifyName(name: string): string;
+}

package/dist/js/Property.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const entity_1 = require("@mat3ra/code/dist/js/entity");
+class Property extends entity_1.NamedInMemoryEntity {
+    constructor() {
+        super(...arguments);
+        this.prettyName = Property.prettifyName(this.name);
+    }
+    toRowValues(group, slug) {
+        return [
+            {
+                ...this.toJSON(),
+                slug,
+                group,
+            },
+        ];
+    }
+    static prettifyName(name) {
+        return (name.charAt(0).toUpperCase() + name.slice(1)).replace("_", " ");
+    }
+}
+Property.isRefined = false;
+Property.isConvergence = false;
+Property.isAbleToReturnMultipleResults = false;
+exports.default = Property;

package/dist/js/PropertyFactory.d.ts

@@ -0,0 +1,54 @@
+import type { MetaPropertyHolderSchema, PropertyHolderSchema, ProtoPropertyHolderSchema } from "@mat3ra/esse/dist/js/types";
+import type MetaProperty from "./MetaProperty";
+import AveragePotentialProfileProperty from "./properties/non-scalar/AveragePotentialProfileProperty";
+import BandGapsProperty from "./properties/non-scalar/BandGapsProperty";
+import BandStructureProperty from "./properties/non-scalar/BandStructureProperty";
+import ChargeDensityProfileProperty from "./properties/non-scalar/ChargeDensityProfileProperty";
+import ConvergenceElectronicProperty from "./properties/non-scalar/convergence/ConvergenceElectronicProperty";
+import ConvergenceIonicProperty from "./properties/non-scalar/convergence/ConvergenceIonicProperty";
+import DensityOfStatesProperty from "./properties/non-scalar/DensityOfStatesProperty";
+import DielectricTensorProperty from "./properties/non-scalar/DielectricTensorProperty";
+import FileContentProperty from "./properties/non-scalar/FileContentProperty";
+import FinalStructureProperty from "./properties/non-scalar/FinalStructureProperty";
+import HubbardUProperty from "./properties/non-scalar/HubbardUProperty";
+import HubbardVNNProperty from "./properties/non-scalar/HubbardVNNProperty";
+import HubbardVProperty from "./properties/non-scalar/HubbardVProperty";
+import IsRelaxedProperty from "./properties/non-scalar/IsRelaxedProperty";
+import JupyterNotebookEndpointProperty from "./properties/non-scalar/JupyterNotebookEndpointProperty";
+import PhononDispersionsProperty from "./properties/non-scalar/PhononDispersionsProperty";
+import PhononDOSProperty from "./properties/non-scalar/PhononDOSProperty";
+import PotentialProfileProperty from "./properties/non-scalar/PotentialProfileProperty";
+import ReactionEnergyProfileProperty from "./properties/non-scalar/ReactionEnergyProfileProperty";
+import WorkflowProperty from "./properties/non-scalar/WorkflowProperty";
+import TotalEnergyContributionsProperty from "./properties/object/TotalEnergyContributionsProperty";
+import FermiEnergyProperty from "./properties/scalar/FermiEnergyProperty";
+import IonizationPotentialElementalProperty from "./properties/scalar/IonizationPotentialElementalProperty";
+import PressureProperty from "./properties/scalar/PressureProperty";
+import ReactionEnergyBarrierProperty from "./properties/scalar/ReactionEnergyBarrierProperty";
+import SurfaceEnergyProperty from "./properties/scalar/SurfaceEnergyProperty";
+import TotalEnergyProperty from "./properties/scalar/TotalEnergyProperty";
+import TotalForcesProperty from "./properties/scalar/TotalForceProperty";
+import ValenceBandOffsetProperty from "./properties/scalar/ValenceBandOffsetProperty";
+import ZeroPointEnergyProperty from "./properties/scalar/ZeroPointEnergyProperty";
+import AtomicForcesProperty from "./properties/tensor/AtomicForcesProperty";
+import MagneticMomentsProperty from "./properties/tensor/MagneticMomentsProperty";
+import StressTensorProperty from "./properties/tensor/StressTensorProperty";
+import AtomicConstraintsProperty from "./proto_properties/AtomicConstraintsProperty";
+import BoundaryConditionsProperty from "./proto_properties/BoundaryConditionsProperty";
+import { PropertyName } from "./settings";
+type AnyProperty = PropertyHolderSchema["data"];
+type AnyMetaProperty = MetaPropertyHolderSchema["data"];
+type AnyProtoProperty = ProtoPropertyHolderSchema["data"];
+export default class PropertyFactory {
+    static methodsTree: Record<string, () => void>;
+    static getRefinedPropertyNames(): PropertyName[];
+    static getConvergencePropertyNames(): PropertyName[];
+    static getMultipleResultsPropertyNames(): PropertyName[];
+    static getScalarPropertyNames(): PropertyName[];
+    static getNonScalarPropertyNames(): PropertyName[];
+    private static filterPropertyNames;
+    static createProperty(config: AnyProperty): AveragePotentialProfileProperty | BandGapsProperty | BandStructureProperty | ChargeDensityProfileProperty | ConvergenceElectronicProperty | ConvergenceIonicProperty | DensityOfStatesProperty | DielectricTensorProperty | FileContentProperty | FinalStructureProperty | HubbardUProperty | HubbardVNNProperty | HubbardVProperty | IsRelaxedProperty | JupyterNotebookEndpointProperty | PhononDispersionsProperty | PhononDOSProperty | PotentialProfileProperty | ReactionEnergyProfileProperty | WorkflowProperty | TotalEnergyContributionsProperty | FermiEnergyProperty | IonizationPotentialElementalProperty | PressureProperty | ReactionEnergyBarrierProperty | SurfaceEnergyProperty | TotalEnergyProperty | TotalForcesProperty | ValenceBandOffsetProperty | ZeroPointEnergyProperty | AtomicForcesProperty | MagneticMomentsProperty | StressTensorProperty;
+    static createMetaProperty(config: AnyMetaProperty): MetaProperty;
+    static createProtoProperty(config: AnyProtoProperty): AtomicConstraintsProperty | BoundaryConditionsProperty;
+}
+export {};

package/dist/js/PropertyFactory.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PseudopotentialMetaProperty_1 = __importDefault(require("./meta_properties/PseudopotentialMetaProperty"));
+const AveragePotentialProfileProperty_1 = __importDefault(require("./properties/non-scalar/AveragePotentialProfileProperty"));
+const BandGapsProperty_1 = __importDefault(require("./properties/non-scalar/BandGapsProperty"));
+const BandStructureProperty_1 = __importDefault(require("./properties/non-scalar/BandStructureProperty"));
+const ChargeDensityProfileProperty_1 = __importDefault(require("./properties/non-scalar/ChargeDensityProfileProperty"));
+const ConvergenceElectronicProperty_1 = __importDefault(require("./properties/non-scalar/convergence/ConvergenceElectronicProperty"));
+const ConvergenceIonicProperty_1 = __importDefault(require("./properties/non-scalar/convergence/ConvergenceIonicProperty"));
+const DensityOfStatesProperty_1 = __importDefault(require("./properties/non-scalar/DensityOfStatesProperty"));
+const DielectricTensorProperty_1 = __importDefault(require("./properties/non-scalar/DielectricTensorProperty"));
+const FileContentProperty_1 = __importDefault(require("./properties/non-scalar/FileContentProperty"));
+const FinalStructureProperty_1 = __importDefault(require("./properties/non-scalar/FinalStructureProperty"));
+const HubbardUProperty_1 = __importDefault(require("./properties/non-scalar/HubbardUProperty"));
+const HubbardVNNProperty_1 = __importDefault(require("./properties/non-scalar/HubbardVNNProperty"));
+const HubbardVProperty_1 = __importDefault(require("./properties/non-scalar/HubbardVProperty"));
+const IsRelaxedProperty_1 = __importDefault(require("./properties/non-scalar/IsRelaxedProperty"));
+const JupyterNotebookEndpointProperty_1 = __importDefault(require("./properties/non-scalar/JupyterNotebookEndpointProperty"));
+const PhononDispersionsProperty_1 = __importDefault(require("./properties/non-scalar/PhononDispersionsProperty"));
+const PhononDOSProperty_1 = __importDefault(require("./properties/non-scalar/PhononDOSProperty"));
+const PotentialProfileProperty_1 = __importDefault(require("./properties/non-scalar/PotentialProfileProperty"));
+const ReactionEnergyProfileProperty_1 = __importDefault(require("./properties/non-scalar/ReactionEnergyProfileProperty"));
+const WorkflowProperty_1 = __importDefault(require("./properties/non-scalar/WorkflowProperty"));
+const TotalEnergyContributionsProperty_1 = __importDefault(require("./properties/object/TotalEnergyContributionsProperty"));
+const FermiEnergyProperty_1 = __importDefault(require("./properties/scalar/FermiEnergyProperty"));
+const IonizationPotentialElementalProperty_1 = __importDefault(require("./properties/scalar/IonizationPotentialElementalProperty"));
+const PressureProperty_1 = __importDefault(require("./properties/scalar/PressureProperty"));
+const ReactionEnergyBarrierProperty_1 = __importDefault(require("./properties/scalar/ReactionEnergyBarrierProperty"));
+const SurfaceEnergyProperty_1 = __importDefault(require("./properties/scalar/SurfaceEnergyProperty"));
+const TotalEnergyProperty_1 = __importDefault(require("./properties/scalar/TotalEnergyProperty"));
+const TotalForceProperty_1 = __importDefault(require("./properties/scalar/TotalForceProperty"));
+const ValenceBandOffsetProperty_1 = __importDefault(require("./properties/scalar/ValenceBandOffsetProperty"));
+const ZeroPointEnergyProperty_1 = __importDefault(require("./properties/scalar/ZeroPointEnergyProperty"));
+const AtomicForcesProperty_1 = __importDefault(require("./properties/tensor/AtomicForcesProperty"));
+const MagneticMomentsProperty_1 = __importDefault(require("./properties/tensor/MagneticMomentsProperty"));
+const StressTensorProperty_1 = __importDefault(require("./properties/tensor/StressTensorProperty"));
+const AtomicConstraintsProperty_1 = __importDefault(require("./proto_properties/AtomicConstraintsProperty"));
+const BoundaryConditionsProperty_1 = __importDefault(require("./proto_properties/BoundaryConditionsProperty"));
+const settings_1 = require("./settings");
+const PROPERTY_CLASS_MAP = {
+    [PressureProperty_1.default.propertyName]: PressureProperty_1.default,
+    [TotalForceProperty_1.default.propertyName]: TotalForceProperty_1.default,
+    [TotalEnergyProperty_1.default.propertyName]: TotalEnergyProperty_1.default,
+    [SurfaceEnergyProperty_1.default.propertyName]: SurfaceEnergyProperty_1.default,
+    [ConvergenceElectronicProperty_1.default.propertyName]: ConvergenceElectronicProperty_1.default,
+    [ConvergenceIonicProperty_1.default.propertyName]: ConvergenceIonicProperty_1.default,
+    [FermiEnergyProperty_1.default.propertyName]: FermiEnergyProperty_1.default,
+    [ZeroPointEnergyProperty_1.default.propertyName]: ZeroPointEnergyProperty_1.default,
+    [TotalEnergyContributionsProperty_1.default.propertyName]: TotalEnergyContributionsProperty_1.default,
+    [AtomicForcesProperty_1.default.propertyName]: AtomicForcesProperty_1.default,
+    [StressTensorProperty_1.default.propertyName]: StressTensorProperty_1.default,
+    [DensityOfStatesProperty_1.default.propertyName]: DensityOfStatesProperty_1.default,
+    [BandStructureProperty_1.default.propertyName]: BandStructureProperty_1.default,
+    [BandGapsProperty_1.default.propertyName]: BandGapsProperty_1.default,
+    [PhononDispersionsProperty_1.default.propertyName]: PhononDispersionsProperty_1.default,
+    [PhononDOSProperty_1.default.propertyName]: PhononDOSProperty_1.default,
+    [FinalStructureProperty_1.default.propertyName]: FinalStructureProperty_1.default,
+    [IsRelaxedProperty_1.default.propertyName]: IsRelaxedProperty_1.default,
+    [WorkflowProperty_1.default.propertyName]: WorkflowProperty_1.default,
+    [MagneticMomentsProperty_1.default.propertyName]: MagneticMomentsProperty_1.default,
+    [ReactionEnergyBarrierProperty_1.default.propertyName]: ReactionEnergyBarrierProperty_1.default,
+    [ReactionEnergyProfileProperty_1.default.propertyName]: ReactionEnergyProfileProperty_1.default,
+    [PotentialProfileProperty_1.default.propertyName]: PotentialProfileProperty_1.default,
+    [ChargeDensityProfileProperty_1.default.propertyName]: ChargeDensityProfileProperty_1.default,
+    [AveragePotentialProfileProperty_1.default.propertyName]: AveragePotentialProfileProperty_1.default,
+    [ValenceBandOffsetProperty_1.default.propertyName]: ValenceBandOffsetProperty_1.default,
+    [IonizationPotentialElementalProperty_1.default.propertyName]: IonizationPotentialElementalProperty_1.default,
+    [FileContentProperty_1.default.propertyName]: FileContentProperty_1.default,
+    [DielectricTensorProperty_1.default.propertyName]: DielectricTensorProperty_1.default,
+    [HubbardUProperty_1.default.propertyName]: HubbardUProperty_1.default,
+    [HubbardVNNProperty_1.default.propertyName]: HubbardVNNProperty_1.default,
+    [HubbardVProperty_1.default.propertyName]: HubbardVProperty_1.default,
+    [JupyterNotebookEndpointProperty_1.default.propertyName]: JupyterNotebookEndpointProperty_1.default,
+};
+const META_PROPERTY_CLASS_MAP = {
+    [PseudopotentialMetaProperty_1.default.propertyName]: PseudopotentialMetaProperty_1.default,
+};
+const PROTO_PROPERTY_CLASS_MAP = {
+    [BoundaryConditionsProperty_1.default.propertyName]: BoundaryConditionsProperty_1.default,
+    [AtomicConstraintsProperty_1.default.propertyName]: AtomicConstraintsProperty_1.default,
+};
+class PropertyFactory {
+    static getRefinedPropertyNames() {
+        return this.filterPropertyNames((PropertyClass) => {
+            return PropertyClass.isRefined;
+        });
+    }
+    static getConvergencePropertyNames() {
+        return this.filterPropertyNames((PropertyClass) => {
+            return PropertyClass.isConvergence;
+        });
+    }
+    static getMultipleResultsPropertyNames() {
+        return this.filterPropertyNames((PropertyClass) => {
+            return PropertyClass.isAbleToReturnMultipleResults;
+        });
+    }
+    static getScalarPropertyNames() {
+        return this.filterPropertyNames((PropertyClass) => {
+            return PropertyClass.propertyType === settings_1.PropertyType.scalar;
+        });
+    }
+    static getNonScalarPropertyNames() {
+        return this.filterPropertyNames((PropertyClass) => {
+            return PropertyClass.propertyType === settings_1.PropertyType.non_scalar;
+        });
+    }
+    static filterPropertyNames(filterFn) {
+        const properties = Object.values({
+            ...PROPERTY_CLASS_MAP,
+            ...META_PROPERTY_CLASS_MAP,
+            ...PROTO_PROPERTY_CLASS_MAP,
+        });
+        return properties.filter(filterFn).map((PropertyClass) => {
+            return PropertyClass.propertyName;
+        });
+    }
+    static createProperty(config) {
+        const PropertyClass = PROPERTY_CLASS_MAP[config.name];
+        return new PropertyClass(config);
+    }
+    static createMetaProperty(config) {
+        const { name } = config;
+        const PropertyClass = META_PROPERTY_CLASS_MAP[name];
+        return new PropertyClass(config);
+    }
+    static createProtoProperty(config) {
+        const { name } = config;
+        const PropertyClass = PROTO_PROPERTY_CLASS_MAP[name];
+        return new PropertyClass(config);
+    }
+}
+PropertyFactory.methodsTree = {};
+exports.default = PropertyFactory;

package/dist/js/ProtoProperty.d.ts

@@ -0,0 +1,5 @@
+import Property from "./Property";
+import { PropertyType } from "./settings";
+export default class ProtoProperty<TSchema extends object = object> extends Property<TSchema> {
+    static readonly propertyType = PropertyType.non_scalar;
+}

package/dist/js/ProtoProperty.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Property_1 = __importDefault(require("./Property"));
+const settings_1 = require("./settings");
+class ProtoProperty extends Property_1.default {
+}
+ProtoProperty.propertyType = settings_1.PropertyType.non_scalar;
+exports.default = ProtoProperty;

package/dist/js/charts/highcharts.d.ts

@@ -0,0 +1,57 @@
+import type { AxisOptions, IndividualSeriesOptions, Options, PlotLines } from "highcharts";
+import type { XDataArray } from "../properties/include/mixins/2d_plot";
+/**
+ * Callback JavaScript function to format the data label. Note that if a format is defined, the format takes
+ * precedence and the formatter is ignored.
+ * Available data are:
+ * - this.percentage Stacked series and pies only. The point's percentage of the total.
+ * - this.point      The point object. The point name, if defined, is available through this.point.name.
+ * - this.series     The series object. The series name is available through this.series.name.
+ * - this.total      Stacked series only. The total value at this point's x value.
+ * - this.x:         The x value.
+ * - this.y:         The y value.
+ */
+export type FormatterScope = {
+    percentage: number;
+    point: {
+        name: string;
+        index: number;
+    };
+    series: {
+        name: string;
+    };
+    total: number;
+    x: number;
+    y: number;
+    key: number;
+};
+export type Formatter = (this: FormatterScope) => string;
+export interface HighChartsConfigParams {
+    title?: string;
+    subtitle: string;
+    yAxisTitle?: string;
+    xAxisTitle?: string;
+    yAxisType: string;
+    series?: IndividualSeriesOptions[];
+    legend?: string[] | object[] | boolean;
+}
+/**
+ * @description Base class for Highcharts configuration
+ */
+export declare abstract class HighChartsConfig implements HighChartsConfigParams {
+    readonly title: HighChartsConfigParams["title"];
+    readonly subtitle: HighChartsConfigParams["subtitle"];
+    readonly yAxisTitle: HighChartsConfigParams["yAxisTitle"];
+    readonly xAxisTitle: HighChartsConfigParams["xAxisTitle"];
+    readonly yAxisType: HighChartsConfigParams["yAxisType"];
+    readonly legend: HighChartsConfigParams["legend"];
+    readonly _series: HighChartsConfigParams["series"];
+    constructor({ title, subtitle, yAxisTitle, xAxisTitle, yAxisType, series, legend, }: HighChartsConfigParams);
+    yAxis(): AxisOptions;
+    xAxis(): AxisOptions;
+    abstract tooltipFormatter(_xDataArray?: XDataArray): (this: FormatterScope) => string;
+    plotSingleLine({ value, width, label, color, dashStyle, }: PlotLines): PlotLines[];
+    get series(): IndividualSeriesOptions[] | undefined;
+    get config(): Options;
+    get overrideConfig(): Options;
+}

package/dist/js/charts/highcharts.js

@@ -0,0 +1,96 @@
+"use strict";
+/* eslint-disable class-methods-use-this */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HighChartsConfig = void 0;
+/**
+ * @description Base class for Highcharts configuration
+ */
+class HighChartsConfig {
+    constructor({ title, subtitle, yAxisTitle, xAxisTitle, yAxisType, series, legend, }) {
+        this.title = title;
+        this.subtitle = subtitle;
+        this.yAxisTitle = yAxisTitle;
+        this.xAxisTitle = xAxisTitle;
+        this.yAxisType = yAxisType;
+        this._series = series;
+        this.legend = legend;
+    }
+    yAxis() {
+        return {
+            title: {
+                text: this.yAxisTitle,
+            },
+            type: this.yAxisType,
+            gridLineColor: "#eee",
+            plotLines: [
+                {
+                    value: 0,
+                    width: 1,
+                    color: "#808080",
+                },
+            ],
+        };
+    }
+    xAxis() {
+        return {
+            title: {
+                text: this.xAxisTitle,
+            },
+            tickPixelInterval: 200,
+        };
+    }
+    plotSingleLine({ value, width = 1, label, color = "red", dashStyle = "dash", }) {
+        return [
+            {
+                value,
+                width,
+                label,
+                color,
+                dashStyle,
+            },
+        ];
+    }
+    get series() {
+        return this._series;
+    }
+    get config() {
+        return {
+            credits: {
+                enabled: false,
+            },
+            chart: {
+                animation: false,
+                zoomType: "xy",
+            },
+            title: {
+                text: "",
+                x: -20, // center
+            },
+            subtitle: {
+                text: this.subtitle,
+                x: -20,
+            },
+            yAxis: this.yAxis(),
+            xAxis: this.xAxis(),
+            tooltip: {
+                formatter: this.tooltipFormatter(),
+            },
+            plotOptions: {
+                series: {
+                    animation: false,
+                },
+            },
+            legend: {
+                enabled: Boolean(this.legend),
+                maxHeight: 70,
+            },
+            series: this.series,
+            ...this.overrideConfig,
+        };
+    }
+    // use in child classes to add/override default config props
+    get overrideConfig() {
+        return {};
+    }
+}
+exports.HighChartsConfig = HighChartsConfig;

package/dist/js/generated/AtomicConstraintsPropertySchemaMixin.d.ts

@@ -0,0 +1,5 @@
+import type { InMemoryEntity } from "@mat3ra/code/dist/js/entity";
+import type { AtomicConstraintsPropertySchema } from "@mat3ra/esse/dist/js/types";
+export type AtomicConstraintsPropertySchemaMixin = Omit<AtomicConstraintsPropertySchema, "_id" | "slug" | "systemName" | "schemaVersion">;
+export type AtomicConstraintsPropertyInMemoryEntity = InMemoryEntity & AtomicConstraintsPropertySchemaMixin;
+export declare function atomicConstraintsPropertySchemaMixin(item: InMemoryEntity): void;

package/dist/js/generated/AtomicConstraintsPropertySchemaMixin.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.atomicConstraintsPropertySchemaMixin = atomicConstraintsPropertySchemaMixin;
+function atomicConstraintsPropertySchemaMixin(item) {
+    // @ts-expect-error
+    const properties = {
+        get name() {
+            return this.requiredProp("name");
+        },
+        get values() {
+            return this.requiredProp("values");
+        },
+    };
+    Object.defineProperties(item, Object.getOwnPropertyDescriptors(properties));
+}

package/dist/js/generated/AtomicForcesPropertySchemaMixin.d.ts

@@ -0,0 +1,5 @@
+import type { InMemoryEntity } from "@mat3ra/code/dist/js/entity";
+import type { AtomicForcesPropertySchema } from "@mat3ra/esse/dist/js/types";
+export type AtomicForcesPropertySchemaMixin = Omit<AtomicForcesPropertySchema, "_id" | "slug" | "systemName" | "schemaVersion">;
+export type AtomicForcesPropertyInMemoryEntity = InMemoryEntity & AtomicForcesPropertySchemaMixin;
+export declare function atomicForcesPropertySchemaMixin(item: InMemoryEntity): void;

package/dist/js/generated/AtomicForcesPropertySchemaMixin.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.atomicForcesPropertySchemaMixin = atomicForcesPropertySchemaMixin;
+function atomicForcesPropertySchemaMixin(item) {
+    // @ts-expect-error
+    const properties = {
+        get name() {
+            return this.requiredProp("name");
+        },
+        get values() {
+            return this.requiredProp("values");
+        },
+        get units() {
+            return this.requiredProp("units");
+        },
+    };
+    Object.defineProperties(item, Object.getOwnPropertyDescriptors(properties));
+}

package/dist/js/generated/AveragePotentialProfilePropertySchemaMixin.d.ts

@@ -0,0 +1,5 @@
+import type { InMemoryEntity } from "@mat3ra/code/dist/js/entity";
+import type { AveragePotentialProfilePropertySchema } from "@mat3ra/esse/dist/js/types";
+export type AveragePotentialProfilePropertySchemaMixin = Omit<AveragePotentialProfilePropertySchema, "_id" | "slug" | "systemName" | "schemaVersion">;
+export type AveragePotentialProfilePropertyInMemoryEntity = InMemoryEntity & AveragePotentialProfilePropertySchemaMixin;
+export declare function averagePotentialProfilePropertySchemaMixin(item: InMemoryEntity): void;

package/dist/js/generated/AveragePotentialProfilePropertySchemaMixin.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.averagePotentialProfilePropertySchemaMixin = averagePotentialProfilePropertySchemaMixin;
+function averagePotentialProfilePropertySchemaMixin(item) {
+    // @ts-expect-error
+    const properties = {
+        get xAxis() {
+            return this.requiredProp("xAxis");
+        },
+        get yAxis() {
+            return this.requiredProp("yAxis");
+        },
+        get name() {
+            return this.requiredProp("name");
+        },
+        get xDataArray() {
+            return this.requiredProp("xDataArray");
+        },
+        get yDataSeries() {
+            return this.requiredProp("yDataSeries");
+        },
+    };
+    Object.defineProperties(item, Object.getOwnPropertyDescriptors(properties));
+}

package/dist/js/generated/BandGapsPropertySchemaMixin.d.ts

@@ -0,0 +1,5 @@
+import type { InMemoryEntity } from "@mat3ra/code/dist/js/entity";
+import type { BandGapsPropertySchema } from "@mat3ra/esse/dist/js/types";
+export type BandGapsPropertySchemaMixin = Omit<BandGapsPropertySchema, "_id" | "slug" | "systemName" | "schemaVersion">;
+export type BandGapsPropertyInMemoryEntity = InMemoryEntity & BandGapsPropertySchemaMixin;
+export declare function bandGapsPropertySchemaMixin(item: InMemoryEntity): void;