@mat3ra/esse 2026.8.17-0 → 2026.8.18-1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mat3ra/esse",
-    "version": "2026.8.17-0",
+    "version": "2026.8.18-1",
     "description": "Mat3ra's Excellent Source of Schemas and Examples (ESSE) for Digital Materials R&D",
     "scripts": {
         "transpile": "tsc -p tsconfig-transpile.json",
@@ -13,13 +13,17 @@
         "lint:fix": "eslint --fix --cache src/js && prettier --write src/js",
         "prettier": "prettier --check src/js",
         "prepare": "husky install || exit 0",
-        "set-schema-ids": "ts-node set_schema_ids.ts"
+        "set-schema-ids": "ts-node set_schema_ids.ts",
+        "prepublishOnly": "npm run transpile-and-build-assets"
     },
     "repository": {
         "type": "git",
         "url": "https://github.com/mat3ra/esse.git"
     },
     "main": "dist/js/esse/index.js",
+    "files": [
+        "dist"
+    ],
     "author": "Mat3ra.com",
     "email": "info@mat3ra.com",
     "bugs": {

package/.babelrc

@@ -1,10 +0,0 @@
-{
-    "presets": [
-        "@babel/preset-env"
-    ],
-    "plugins": [
-        [
-            "@babel/plugin-proposal-class-properties"
-        ]
-    ]
-}

package/.cursor/rules/resolve-generated-merge-conflicts.mdc

@@ -1,36 +0,0 @@
----
-description: Resolve ESSE merge conflicts by merging source schemas and regenerating derived artifacts
-globs: "{schema,example,manifest,dist/js,src/py}/**/*"
-alwaysApply: false
----
-
-# ESSE generated merge conflicts
-
-Treat `schema/**`, `example/**`, and `manifest/**` as sources of truth. These outputs are generated:
-
-- `dist/js/**`
-- `src/py/mat3ra/esse/data/**`
-- `src/py/mat3ra/esse/models/**` (`dist/py` points here)
-
-When merging:
-
-1. Merge source schemas, examples, and manifests first, preserving intentional changes from both branches.
-2. Do not hand-merge generated Python enum suffixes such as `Name631`, `Units284`, or `Value137`; their numbering is unstable and regeneration determines it.
-3. Resolve generated files temporarily if Git requires it, then regenerate all derived artifacts from the merged sources:
-
-```bash
-npm run transpile-and-build-assets
-pre-commit run generate-python-modules --all-files
-```
-
-The Python hook only runs when a staged path contains `schema`, so stage the resolved source schema changes before invoking it. Its canonical command and pinned generator options live in `.pre-commit-config.yaml`.
-
-After generation, stage the generated outputs and verify:
-
-```bash
-git diff --name-only --diff-filter=U
-rg -n '^(<<<<<<<|=======|>>>>>>>)' .
-git diff --check
-```
-
-Do not blindly choose `ours` or `theirs` for generated files when source schemas differ. A side may contain real additions (for example, a new property) while the other contains unrelated schema fixes; the regenerated result must include both.

package/.eslintrc.json

@@ -1,5 +0,0 @@
-{
-    "extends": [
-        "@exabyte-io/eslint-config/json"
-    ]
-}

package/.mocharc.json

@@ -1,5 +0,0 @@
-{
-    "extension": ["ts"],
-    "spec": "tests/js/**/*.ts",
-    "require": "ts-node/register"
-  }

package/.pre-commit-config.yaml

@@ -1,32 +0,0 @@
-repos:
-  - repo: https://github.com/mat3ra/pre-commit-hooks
-    rev: 2023.6.13
-    hooks:
-      - id: ruff
-        exclude: ^src/py/mat3ra/esse/data|^src/py/mat3ra/esse/models|^dist*
-      - id: black
-        exclude: ^src/py/mat3ra/esse/data|^src/py/mat3ra/esse/models|^dist*
-  - repo: local
-    hooks:
-      # Note: only python 3.8.12 is tested for the model generation
-      - id: generate-python-modules
-        name: Regenerate data modules classes from static assets
-        # yamllint disable rule:line-length
-        entry: |
-          bash -c 'if [ ! "$(git diff --cached --name-only | grep schema)" ]; then echo "Skipping model generation because schemas were not changed."; exit 0; fi && \
-            datamodel-codegen \
-                --input ./dist/js/schema/ \
-                --input-file-type jsonschema \
-                --output ./dist/py \
-                --output-model-type pydantic_v2.BaseModel \
-                --use-field-description \
-                --use-double-quotes \
-                --enable-version-header \
-                --use-title-as-name \
-                --class-name ESSE \
-                --disable-timestamp \
-                --use-default \
-                --remove-special-field-name-prefix'
-        language: system
-        pass_filenames: false
-        verbose: true

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-    "singleQuote": false,
-    "printWidth": 100,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "bracketSpacing": true
-}

package/build_schemas.py

@@ -1,60 +0,0 @@
-"""
-This script builds the schemas and examples modules.
-The schemas module contains all the schemas in the SCHEMAS_DIR.
-The examples module contains all the examples in the EXAMPLES_DIR.
-The script is aware of the include and reference statements and is using the json_include library to resolve them.
-The script creates the python modules containing the schemas and examples and avoids
-having the dependency on the filesystem during the calls to the ESSE class.
-Usage (NOTE: "-e" in pip install is required for the file references to be resolved):
-    virtualenv .venv
-    source .venv/bin/activate
-    pip install -e ."[tests]"
-    python build_schemas.py
-After that, check for the files `src/py/mat3ra/esse/data/schemas.py` and `src/py/mat3ra/esse/data/examples.py`.
-"""
-import os
-import json
-import yaml
-from pathlib import Path
-
-from mat3ra.esse.utils import parse_include_reference_statements_by_dir
-
-TOP_DIR = os.path.dirname(__file__)
-SCHEMAS = parse_include_reference_statements_by_dir(TOP_DIR)
-# Wrap examples into {"data": example, "path": schema_id} format to relate them to schemas.
-EXAMPLES = parse_include_reference_statements_by_dir(TOP_DIR, True)
-
-with open(os.path.join(TOP_DIR, "manifest/properties.yaml")) as f:
-    PROPERTIES_MANIFEST = yaml.load(f.read(), Loader=yaml.FullLoader)
-    RESULTS = [k for k, v in PROPERTIES_MANIFEST.items() if v.get("isResult")]
-
-with open("src/py/mat3ra/esse/data/schemas.py", "w") as f:
-    f.write("import json\n" + f"SCHEMAS = json.loads(json.dumps({SCHEMAS}))")
-
-with open("src/py/mat3ra/esse/data/examples.py", "w") as f:
-    f.write("import json\n" + f"EXAMPLES = json.loads(json.dumps({EXAMPLES}))")
-
-with open("src/py/mat3ra/esse/data/properties.py", "w") as f:
-    content = (
-        "import json\n"
-        + f"PROPERTIES_MANIFEST = json.loads(json.dumps({PROPERTIES_MANIFEST}))\n"
-        + f"RESULTS = json.loads(json.dumps({RESULTS}))\n"
-    )
-    f.write(content)
-
-if os.environ.get("BUILD_DOCS") != "true":
-    exit(0)
-
-for schema in SCHEMAS:
-    id_as_path = schema["$id"].replace("-", "_")
-    full_path = os.path.join(TOP_DIR, "docs/py/schema", id_as_path + ".json")
-    Path(full_path).parent.mkdir(parents=True, exist_ok=True)
-    with open(full_path, "w") as f:
-        f.write(json.dumps(schema, sort_keys=True, indent=4, separators=(",", ": ")))
-
-for example in EXAMPLES:
-    id_as_path = example["path"].replace("-", "_")
-    full_path = os.path.join(TOP_DIR, "docs/py/example", id_as_path + ".json")
-    Path(full_path).parent.mkdir(parents=True, exist_ok=True)
-    with open(full_path, "w") as f:
-        f.write(json.dumps(example, sort_keys=True, indent=4, separators=(",", ": ")))

package/build_schemas.ts

@@ -1,48 +0,0 @@
-/**
- * build_schemas uses node API to read all schemas from the FS
- * at build time and writes them out to a single schemas.js file for
- * downstream consumption to avoid FS calls in the browser.
- */
-import * as fs from "fs";
-
-import JSONSchemasGenerator from "./src/js/esse/JSONSchemasGenerator";
-
-// JS Modules
-
-const generator = new JSONSchemasGenerator();
-const { schemas, wrappedExamples, propertiesManifest, results } = generator;
-
-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/";
-const skipMergeAllOff = process.env.SKIP_MERGE_ALLOF === "true";
-
-generator.writeResolvedSchemas(subfolder, skipMergeAllOff);
-generator.writeResolvedExamples(subfolder);

package/compile_ts.ts

@@ -1,3 +0,0 @@
-import compileTS from "./src/js/scripts/compileTs";
-
-compileTS("./dist/js/schema", `./src/js/types.ts`);

package/docs/README.md

@@ -1,3 +0,0 @@
-# Overview
-
-This folder is used for the fully-built (without "$ref", "$allOf", "include()" statements) JSON assets and is populated by the [build_schemas.js](../build_schemas.js) (with and appropriate flag).