@mat3ra/esse 2026.8.13-0 → 2026.8.18-0

package/dist/js/esse/utils.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyPatchWithDotNotation = applyPatchWithDotNotation;
-exports.applyPatchTree = applyPatchTree;
-function isPlainObject(value) {
-    return value !== null && typeof value === "object" && !Array.isArray(value);
-}
-function applyPatchWithDotNotation(target, path, patchValue) {
-    const keys = path.split(".");
-    let current = target;
-    // Navigate to parent of final key
-    for (let index = 0; index < keys.length - 1; index += 1) {
-        const key = keys[index];
-        if (!isPlainObject(current[key])) {
-            // Path does not exist or is not an object → skip patch
-            return;
-        }
-        current = current[key];
-    }
-    const finalKey = keys[keys.length - 1];
-    const existingValue = current[finalKey];
-    if (isPlainObject(existingValue) && isPlainObject(patchValue)) {
-        // Merge object into existing object
-        Object.assign(existingValue, patchValue);
-    }
-    else if (existingValue !== undefined) {
-        // Overwrite leaf value
-        current[finalKey] = patchValue;
-    }
-    // If existingValue is undefined, we skip;
-}
-function applyPatchTree(schema, patchNode, pathPrefix) {
-    Object.entries(patchNode).forEach(([key, value]) => {
-        if (key.includes(".")) {
-            // Dot notation relative to current prefix
-            const fullPathSegments = [...pathPrefix, ...key.split(".")];
-            const fullPath = fullPathSegments.join(".");
-            applyPatchWithDotNotation(schema, fullPath, value);
-        }
-        else if (isPlainObject(value)) {
-            // Nested subtree → recurse with extended prefix
-            applyPatchTree(schema, value, [...pathPrefix, key]);
-        }
-        else {
-            // Leaf patch (primitive / array) → treat as direct field patch
-            const fullPathSegments = [...pathPrefix, key];
-            const fullPath = fullPathSegments.join(".");
-            applyPatchWithDotNotation(schema, fullPath, value);
-        }
-    });
-}

package/dist/js/json_include/index.d.ts

@@ -1,22 +0,0 @@
-export interface CacheObject {
-    [key: string]: CacheObject | CacheObject[];
-}
-export declare class JSONInclude {
-    JSON_INCLUDE_CACHE: CacheObject;
-    /**
-     * Extracts file name(path) from the include statement.
-     * @param value string to extract the file name from.
-     */
-    _getIncludeFileName: (value: unknown) => string | null | undefined;
-    /**
-     * Walks a nested object to resolve include statements.
-     * @param obj Object to traverse.
-     * @param dirpath directory from which `obj` is obtained. Include statements are relative to `obj` path.
-     */
-    _walkObjectToInclude(obj: CacheObject | CacheObject[], dirpath: string): void;
-    /**
-     * Resolves `include` statements.
-     * @param filePath file to parse.
-     */
-    parseIncludeStatements(filePath: string): CacheObject[];
-}

package/dist/js/json_include/index.js

@@ -1,75 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.JSONInclude = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const common_1 = require("../utils/common");
-const settings_1 = require("./settings");
-class JSONInclude {
-    constructor() {
-        this.JSON_INCLUDE_CACHE = {};
-        /**
-         * Extracts file name(path) from the include statement.
-         * @param value string to extract the file name from.
-         */
-        this._getIncludeFileName = (value) => {
-            if (typeof value === "string" && value.search(settings_1.INCLUDE_VALUE_REGEX) !== -1) {
-                const matched = value.match(settings_1.INCLUDE_VALUE_REGEX);
-                return matched && matched[1];
-            }
-        };
-    }
-    /**
-     * Walks a nested object to resolve include statements.
-     * @param obj Object to traverse.
-     * @param dirpath directory from which `obj` is obtained. Include statements are relative to `obj` path.
-     */
-    _walkObjectToInclude(obj, dirpath) {
-        if ((0, common_1.isInstanceOf)(obj, "Array")) {
-            for (let i = 0; i < obj.length; i++) {
-                if ((0, common_1.isInstanceOf)(obj[i], "Object") || (0, common_1.isInstanceOf)(obj[i], "Array")) {
-                    this._walkObjectToInclude(obj[i], dirpath);
-                }
-            }
-        }
-        else if ((0, common_1.isInstanceOf)(obj, "Object")) {
-            if (settings_1.INCLUDE_KEY in obj) {
-                const includeName = this._getIncludeFileName(obj[settings_1.INCLUDE_KEY]);
-                if (includeName) {
-                    delete obj[settings_1.INCLUDE_KEY];
-                    if (!(includeName in this.JSON_INCLUDE_CACHE)) {
-                        const filePath = path_1.default.join(dirpath, includeName);
-                        this.JSON_INCLUDE_CACHE[includeName] =
-                            this.parseIncludeStatements(filePath);
-                    }
-                    Object.keys(this.JSON_INCLUDE_CACHE[includeName]).forEach((attr) => {
-                        // @ts-ignore
-                        obj[attr] = this.JSON_INCLUDE_CACHE[includeName][attr];
-                    });
-                }
-            }
-            Object.keys(obj).forEach((key) => {
-                if ((0, common_1.isInstanceOf)(obj[key], "Object") || (0, common_1.isInstanceOf)(obj[key], "Array")) {
-                    this._walkObjectToInclude(obj[key], dirpath);
-                }
-            });
-        }
-    }
-    /**
-     * Resolves `include` statements.
-     * @param filePath file to parse.
-     */
-    parseIncludeStatements(filePath) {
-        const data = (0, common_1.safeParseJSON)(fs_1.default.readFileSync(filePath, "utf8"));
-        console.log("Parsing file: ", filePath);
-        if (settings_1.OBJECT_ONLY && !(0, common_1.isInstanceOf)(data, "Object")) {
-            throw new Error("The JSON file being included should always be a dict rather than a list");
-        }
-        this._walkObjectToInclude(data, path_1.default.dirname(filePath));
-        return data;
-    }
-}
-exports.JSONInclude = JSONInclude;

package/dist/js/json_include/settings.d.ts

@@ -1,3 +0,0 @@
-export declare const INCLUDE_KEY = "...";
-export declare const INCLUDE_VALUE_REGEX: RegExp;
-export declare const OBJECT_ONLY = false;

package/dist/js/json_include/settings.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OBJECT_ONLY = exports.INCLUDE_VALUE_REGEX = exports.INCLUDE_KEY = void 0;
-exports.INCLUDE_KEY = "...";
-exports.INCLUDE_VALUE_REGEX = /^include\((.+)\)$/;
-exports.OBJECT_ONLY = false; // whether to only include Object, and not Array.

package/dist/js/scripts/compileTs.d.ts

@@ -1 +0,0 @@
-export default function compileTS(schemaPath: string, savePath: string): Promise<void>;

package/dist/js/scripts/compileTs.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = compileTS;
-const fs_1 = __importDefault(require("fs"));
-const json_schema_to_typescript_1 = require("json-schema-to-typescript");
-const schemaUtils_1 = require("../esse/schemaUtils");
-const filesystem_1 = require("../utils/filesystem");
-/**
- * By definition, the "compile" function will generate 2 schemas based on the following input:
- * {
- *    "title": "schema1",
- *    "type": "object",
- *    "properties": {
- *        "prop": {
- *             "title": "schema2",
- *             "type": "string"
- *        }
- *    }
- * }
- *
- * Result:
- * type schema2 = string;
- *
- * interface schema1 {
- *      prop: schema2
- * }
- *
- * To disable this behavior we need to remove "title" property from the "prop":
- *  {
- *    "title": "schema1",
- *    "type": "object",
- *    "properties": {
- *        "prop": {
- *             "type": "string"
- *        }
- *    }
- * }
- *
- * New result:
- * interface schema1 {
- *      prop: string;
- * }
- * @returns Clean schema
- */
-function cleanSchema(schema) {
-    let firstRun = true;
-    return (0, schemaUtils_1.mapObjectDeep)(schema, (object) => {
-        if (typeof object === "object" && (object === null || object === void 0 ? void 0 : object.title) && !firstRun) {
-            firstRun = false;
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const { title, $schema, ...restObject } = object;
-            return restObject;
-        }
-        firstRun = false;
-    });
-}
-async function compileTS(schemaPath, savePath) {
-    try {
-        await fs_1.default.promises.unlink(savePath);
-    }
-    catch (err) {
-        console.log("File with types not exists");
-    }
-    await (0, filesystem_1.walkDir)(schemaPath, async (filePath) => {
-        const data = await fs_1.default.promises.readFile(filePath, "utf8");
-        const schema = cleanSchema(JSON.parse(data));
-        console.log(`Compiling Typescript: ${filePath}`);
-        // @ts-ignore
-        const compiledSchema = await (0, json_schema_to_typescript_1.compile)(schema, schema.title || "", {
-            unreachableDefinitions: true,
-            additionalProperties: false,
-            enableConstEnums: false,
-            bannerComment: `/** Schema ${filePath} */`,
-        });
-        await fs_1.default.promises.appendFile(savePath, `${compiledSchema} \n`, { flag: "a+" });
-    });
-}

package/dist/js/scripts/createEnumsFromYaml.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/js/scripts/createEnumsFromYaml.js

@@ -1,28 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
-const lodash_1 = __importDefault(require("lodash"));
-const path_1 = __importDefault(require("path"));
-const filesystem_1 = require("../utils/filesystem");
-/**
- *  We use YAML files to list enum options which need to be reused in other places.
- *  The format also allows for additional context to the often shortened slugs, such as DOIs.
- *  This script converts the enum lists to JSON files for $ref blocks inside schemas.
- */
-const SCHEMA_DIR = "../../../schema/";
-(0, filesystem_1.walkDir)(SCHEMA_DIR, (filePath) => {
-    if (path_1.default.extname(filePath) !== ".yml") {
-        return;
-    }
-    console.log(filePath);
-    const outFilename = `${path_1.default.basename(filePath, ".yml")}.json`;
-    const dirname = path_1.default.dirname(filePath);
-    const fileContents = fs_1.default.readFileSync(filePath);
-    const obj = js_yaml_1.default.load(fileContents.toString());
-    const enumObj = lodash_1.default.mapValues(obj, (value) => ({ enum: value }));
-    fs_1.default.writeFileSync(`${path_1.default.join(dirname, outFilename)}`, `${JSON.stringify(enumObj, null, 4)}\n`);
-});

package/dist/js/scripts/setSchemaIds.d.ts

@@ -1,5 +0,0 @@
-/**
- * Helper script.
- * Applies correct $id to all schemas based on the schema path
- */
-export default function setSchemaIds(schemaDir: string): void;

package/dist/js/scripts/setSchemaIds.js

@@ -1,30 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = setSchemaIds;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const filesystem_1 = require("../utils/filesystem");
-/**
- * Helper script.
- * Applies correct $id to all schemas based on the schema path
- */
-function setSchemaIds(schemaDir) {
-    (0, filesystem_1.walkDirSync)(schemaDir, (filePath) => {
-        if (path_1.default.extname(filePath) !== ".json") {
-            return;
-        }
-        const fileContents = fs_1.default.readFileSync(filePath);
-        console.log(filePath);
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { $id, ...schema } = JSON.parse(fileContents.toString());
-        const schemaId = filePath.replace(schemaDir, "").replace(".json", "").replace(/_/g, "-");
-        if ($id !== schemaId) {
-            console.log(`Set correct $id: ${filePath}`);
-            const newContent = JSON.stringify({ $id: schemaId, ...schema }, null, 4);
-            fs_1.default.writeFileSync(filePath, `${newContent}\n`);
-        }
-    });
-}