@mat3ra/esse 2024.2.19-0 → 2024.2.19-1

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

@@ -1,6 +1,8 @@
-import { AnyObject } from "../esse/types";
+export interface CacheObject {
+    [key: string]: CacheObject | CacheObject[];
+}
 export declare class JSONInclude {
-    JSON_INCLUDE_CACHE: AnyObject;
+    JSON_INCLUDE_CACHE: CacheObject;
     /**
      * Extracts file name(path) from the include statement.
      * @param value string to extract the file name from.
@@ -11,10 +13,10 @@ export declare class JSONInclude {
      * @param obj Object to traverse.
      * @param dirpath directory from which `obj` is obtained. Include statements are relative to `obj` path.
      */
-    _walkObjectToInclude(obj: AnyObject | AnyObject[], dirpath: string): void;
+    _walkObjectToInclude(obj: CacheObject | CacheObject[], dirpath: string): void;
     /**
      * Resolves `include` statements.
      * @param filePath file to parse.
      */
-    parseIncludeStatements(filePath: string): AnyObject[];
+    parseIncludeStatements(filePath: string): CacheObject[];
 }

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@mat3ra/esse",
-    "version": "2024.2.19-0",
+    "version": "2024.2.19-1",
     "description": "Mat3ra's Excellent Source of Schemas and Examples (ESSE) for Digital Materials R&D",
     "scripts": {
         "prepublishOnly": "rm -rf lib; npm run transpile",
-        "transpile": "tsc; BUILD_ASSETS=true BUILD_PATH='./lib/js' node build_schemas.js",
+        "transpile": "tsc && BUILD_ASSETS=true BUILD_PATH='./lib/js' node build_schemas.js",
         "transpile-and-build-assets": "npm run transpile && ts-node compile_ts.ts",
         "build:assets": "node build_schemas.js",
         "build:js-and-python-modules": "BUILD_PYTHON_MODULES=true node build_schemas.js",
@@ -30,10 +30,25 @@
     },
     "homepage": "https://github.com/Exabyte-io/esse",
     "devDependencies": {
+        "@exabyte-io/eslint-config": "^2023.8.29-1",
         "@types/js-yaml": "^4.0.9",
         "@typescript-eslint/eslint-plugin": "^5.9.1",
         "@typescript-eslint/parser": "^5.9.1",
         "chai": "4.3.4",
+        "eslint": "^7.32.0",
+        "eslint-config-airbnb": "^19.0.2",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-import-resolver-exports": "^1.0.0-beta.5",
+        "eslint-import-resolver-meteor": "^0.4.0",
+        "eslint-import-resolver-node": "^0.3.9",
+        "eslint-plugin-import": "^2.25.3",
+        "eslint-plugin-jsdoc": "^37.1.0",
+        "eslint-plugin-jsx-a11y": "^6.5.1",
+        "eslint-plugin-mui-path-imports": "0.0.15",
+        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-plugin-react": "^7.30.0",
+        "eslint-plugin-react-hooks": "^4.3.0",
+        "eslint-plugin-simple-import-sort": "^7.0.0",
         "husky": "^7.0.4",
         "lint-staged": "^12.1.2",
         "mocha": "^9.2.0",
@@ -54,27 +69,12 @@
         "@babel/preset-typescript": "^7.22.5",
         "@babel/register": "^7.16.0",
         "@babel/runtime-corejs3": "7.16.8",
-        "@exabyte-io/eslint-config": "^2023.8.29-1",
         "@tsconfig/node14": "^14.1.0",
         "@tsconfig/node20": "^20.1.2",
         "@types/chai": "^4.3.11",
         "@types/json-schema-merge-allof": "^0.6.5",
         "@types/mocha": "^10.0.6",
         "ajv": "8.12.0",
-        "eslint": "^7.32.0",
-        "eslint-config-airbnb": "^19.0.2",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-import-resolver-exports": "^1.0.0-beta.5",
-        "eslint-import-resolver-meteor": "^0.4.0",
-        "eslint-import-resolver-node": "^0.3.9",
-        "eslint-plugin-import": "^2.25.3",
-        "eslint-plugin-jsdoc": "^37.1.0",
-        "eslint-plugin-jsx-a11y": "^6.5.1",
-        "eslint-plugin-mui-path-imports": "0.0.15",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-react": "^7.30.0",
-        "eslint-plugin-react-hooks": "^4.3.0",
-        "eslint-plugin-simple-import-sort": "^7.0.0",
         "js-yaml": "^4.1.0",
         "json-schema": "^0.4.0",
         "json-schema-deref-sync": "0.14.0",

package/src/js/json_include/index.ts

@@ -1,12 +1,15 @@
 import fs from "fs";
 import path from "path";
 
-import { AnyObject } from "../esse/types";
 import { isInstanceOf, safeParseJSON } from "../utils/common";
 import { INCLUDE_KEY, INCLUDE_VALUE_REGEX, OBJECT_ONLY } from "./settings";
 
+export interface CacheObject {
+    [key: string]: CacheObject | CacheObject[];
+}
+
 export class JSONInclude {
-    JSON_INCLUDE_CACHE: AnyObject = {};
+    JSON_INCLUDE_CACHE: CacheObject = {};
 
     /**
      * Extracts file name(path) from the include statement.
@@ -24,7 +27,7 @@ export class JSONInclude {
      * @param obj Object to traverse.
      * @param dirpath directory from which `obj` is obtained. Include statements are relative to `obj` path.
      */
-    _walkObjectToInclude(obj: AnyObject | AnyObject[], dirpath: string) {
+    _walkObjectToInclude(obj: CacheObject | CacheObject[], dirpath: string) {
         if (isInstanceOf(obj, "Array")) {
             for (let i = 0; i < obj.length; i++) {
                 if (isInstanceOf(obj[i], "Object") || isInstanceOf(obj[i], "Array")) {
@@ -60,7 +63,7 @@ export class JSONInclude {
      * @param filePath file to parse.
      */
     parseIncludeStatements(filePath: string) {
-        const data: AnyObject[] = safeParseJSON(fs.readFileSync(filePath, "utf8"));
+        const data: CacheObject[] = safeParseJSON(fs.readFileSync(filePath, "utf8"));
         if (OBJECT_ONLY && !isInstanceOf(data, "Object")) {
             throw new Error(
                 "The JSON file being included should always be a dict rather than a list",