5etools-utils 0.3.0 → 0.3.1

package/lib/Api.js

@@ -1,5 +1,5 @@
 import {JsonTester} from "./TestJson.js";
-import * as Um from "./UtilMisc.js";
+import Um from "./UtilMisc.js";
 import * as Uf from "./UtilFs.js";
 
 export {

package/lib/TestJson.js

@@ -7,8 +7,8 @@ import Ajv2020 from "ajv/dist/2020.js";
 import addFormats from "ajv-formats";
 import * as jsonSourceMap from "json-source-map";
 
-import * as uf from "./UtilFs.js";
-import * as um from "./UtilMisc.js";
+import * as Uf from "./UtilFs.js";
+import Um from "./UtilMisc.js";
 import {WorkerList, Deferred} from "./WorkerList.js";
 
 const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
@@ -23,12 +23,20 @@ class JsonTester {
 
 	constructor (
 		{
-			dirSchema,
+			fnGetSchemaId,
+
+			isBrew = false,
+			dirSchema = null,
 			tagLog = LOG_TAG,
-			fnGetSchemaId = () => "homebrew.json",
 		},
 	) {
-		this._dirSchema = dirSchema;
+		if (isBrew && dirSchema) throw new Error(`"isBrew" and "dirSchema" are mutually exclusive!`);
+		if (!fnGetSchemaId) throw new Error(`"fnGetSchemaId" is required!`);
+
+		this._dirSchema = dirSchema ??
+			(isBrew
+				? path.join(__dirname, "..", "schema", "brew")
+				: path.join(__dirname, "..", "schema", "site"));
 		this._tagLog = tagLog;
 		this._fnGetSchemaId = fnGetSchemaId;
 
@@ -98,7 +106,7 @@ class JsonTester {
 		});
 
 		const error = this._getFileErrors({filePath});
-		um.error(this._tagLog, error);
+		Um.error(this._tagLog, error);
 		out.errors.push(error);
 
 		return out;
@@ -107,10 +115,10 @@ class JsonTester {
 	_doLoadSchema () {
 		if (this._isSchemaLoaded) return;
 
-		uf.listJsonFiles(this._dirSchema)
+		Uf.listJsonFiles(this._dirSchema)
 			.forEach(filePath => {
 				filePath = path.normalize(filePath);
-				const contents = uf.readJSON(filePath);
+				const contents = Uf.readJSON(filePath);
 
 				const relativeFilePath = path.relative(this._dirSchema, filePath)
 					.replace(/\\/g, "/");
@@ -121,12 +129,17 @@ class JsonTester {
 		this._isSchemaLoaded = true;
 	}
 
+	_hasSchema (schemaId) {
+		this._doLoadSchema();
+		return !!this._ajv.schemas[schemaId];
+	}
+
 	getFileErrors ({filePath} = {}) {
 		this._doLoadSchema();
 
-		um.info(this._tagLog, `\tValidating "${filePath}"...`);
+		Um.info(this._tagLog, `\tValidating "${filePath}"...`);
 
-		const data = uf.readJSON(filePath);
+		const data = Uf.readJSON(filePath);
 		this._addImplicits(data);
 
 		const isValid = this._ajv.validate(this._fnGetSchemaId(filePath), data);
@@ -136,7 +149,7 @@ class JsonTester {
 	}
 
 	_doRunOnDir ({isFailFast, dir, errors, errorsFull, ...opts} = {}) {
-		for (const filePath of uf.listJsonFiles(dir, opts)) {
+		for (const filePath of Uf.listJsonFiles(dir, opts)) {
 			const {errors: errorsFile, errorsFull: errorsFullFile} = this.getFileErrors({filePath});
 			errors.push(...errorsFile);
 			errorsFull.push(...errorsFullFile);
@@ -150,7 +163,7 @@ class JsonTester {
 	 * @param [opts.dirBlocklist]
 	 */
 	getErrors (dir, opts = {}) {
-		um.info(this._tagLog, `Validating JSON against schema`);
+		Um.info(this._tagLog, `Validating JSON against schema`);
 
 		const errors = [];
 		const errorsFull = [];
@@ -161,12 +174,12 @@ class JsonTester {
 	}
 
 	getErrorsOnDirs ({isFailFast = false} = {}) {
-		um.info(this._tagLog, `Validating JSON against schema`);
+		Um.info(this._tagLog, `Validating JSON against schema`);
 
 		const errors = [];
 		const errorsFull = [];
 
-		uf.runOnDirs((dir) => {
+		Uf.runOnDirs((dir) => {
 			if (isFailFast && errors.length) return;
 			return this._doRunOnDir({isFailFast, errors, errorsFull, dir});
 		});
@@ -174,19 +187,30 @@ class JsonTester {
 		return {errors, errorsFull};
 	}
 
-	async pGetErrorsOnDirsWorkers ({isFailFast = false} = {}) {
-		um.info(this._tagLog, `Validating JSON against schema`);
+	async pGetErrorsOnDirsWorkers ({isFailFast = false, fileList = null} = {}) {
+		Um.info(this._tagLog, `Validating JSON against schema`);
 
 		const cntWorkers = Math.max(1, os.cpus().length - 1);
 
 		const errors = [];
 		const errorsFull = [];
 
-		const fileQueue = [];
+		const fileQueue = [...(fileList || [])];
 
-		uf.runOnDirs((dir) => {
-			fileQueue.push(...uf.listJsonFiles(dir));
+		if (!fileList) {
+			Uf.runOnDirs((dir) => {
+				fileQueue.push(...Uf.listJsonFiles(dir));
+			});
+		}
+
+		// region Verify that every file path maps to a valid schema
+		fileQueue.forEach(filePath => {
+			const schemaId = this._fnGetSchemaId(filePath);
+			if (!schemaId) throw new Error(`Failed to get schema ID for file path "${filePath}"`);
+			if (!this._hasSchema(schemaId)) throw new Error(`No schema loaded with schema ID "${schemaId}"`);
+			return schemaId;
 		});
+		// endregion
 
 		const workerList = new WorkerList();
 

package/lib/UtilMisc.js

@@ -1,22 +1,41 @@
-function _taggedConsole (fn, tag, ...args) {
-	const expandedTag = tag.padStart(12, " ");
-	fn(`[${expandedTag}]`, ...args);
-}
+class MiscUtil {
+	/* -------------------------------------------- */
 
-function warn (tag, ...args) {
-	_taggedConsole(console.warn, tag, ...args);
-}
+	// region Logging
+	static _taggedConsole (fn, tag, ...args) {
+		const expandedTag = tag.padStart(12, " ");
+		fn(`[${expandedTag}]`, ...args);
+	}
 
-function info (tag, ...args) {
-	_taggedConsole(console.info, tag, ...args);
-}
+	static warn (tag, ...args) { this._taggedConsole(console.warn, tag, ...args); }
+	static info (tag, ...args) { this._taggedConsole(console.info, tag, ...args); }
+	static error (tag, ...args) { this._taggedConsole(console.error, tag, ...args); }
+	// endregion
+
+	/* -------------------------------------------- */
+
+	static get (object, ...path) {
+		if (object == null) return null;
+		for (let i = 0; i < path.length; ++i) {
+			object = object[path[i]];
+			if (object == null) return object;
+		}
+		return object;
+	}
+
+	/* -------------------------------------------- */
+
+	static copyFast (obj) {
+		if ((typeof obj !== "object") || obj == null) return obj;
+
+		if (obj instanceof Array) return obj.map(MiscUtil.copyFast);
+
+		const cpy = {};
+		for (const k of Object.keys(obj)) cpy[k] = MiscUtil.copyFast(obj[k]);
+		return cpy;
+	}
 
-function error (tag, ...args) {
-	_taggedConsole(console.error, tag, ...args);
+	/* -------------------------------------------- */
 }
 
-export {
-	warn,
-	info,
-	error,
-};
+export default MiscUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -12,9 +12,10 @@
 		"lib": "./lib"
 	},
 	"scripts": {
+		"build": "node node/compile-schemas.js",
 		"test": "npm run lint:js && npm run test:js",
 		"test:js": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-		"lint:js": "eslint lib test --fix"
+		"lint:js": "eslint lib node test --fix"
 	},
 	"repository": {
 		"type": "git",
@@ -32,6 +33,7 @@
 		"json-source-map": "^0.6.1"
 	},
 	"devDependencies": {
+		"commander": "^9.4.1",
 		"eslint": "^8.11.0",
 		"jest": "^29.3.1"
 	}

package/schema/brew/bestiary/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/bestiary/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/changelog.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "changelog.json",
+	"version": "1.0.0",
+	"type": "array",
+	"minItems": 1,
+	"uniqueItems": true,
+	"items": {
+		"type": "object",
+		"properties": {
+			"ver": {
+				"type": "string"
+			},
+			"date": {
+				"type": "string",
+				"format": "date"
+			},
+			"title": {
+				"type": "string"
+			},
+			"titleAlt": {
+				"type": "string"
+			},
+			"txt": {
+				"type": "string"
+			}
+		},
+		"required": [
+			"ver",
+			"date",
+			"txt"
+		],
+		"additionalProperties": false
+	}
+}

package/schema/brew/class/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/life.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "life.json",
+	"version": "1.0.0",
+	"type": "object",
+	"properties": {
+		"lifeClass": true,
+		"lifeBackground": true,
+		"lifeTrinket": true
+	},
+	"required": [
+		"lifeClass",
+		"lifeBackground",
+		"lifeTrinket"
+	],
+	"additionalProperties": false
+}

package/schema/brew/spells/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/spells/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew-fast/bestiary/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew-fast/bestiary/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew-fast/changelog.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "changelog.json",
+	"version": "1.0.0",
+	"type": "array",
+	"minItems": 1,
+	"uniqueItems": true,
+	"items": {
+		"type": "object",
+		"properties": {
+			"ver": {
+				"type": "string"
+			},
+			"date": {
+				"type": "string",
+				"format": "date"
+			},
+			"title": {
+				"type": "string"
+			},
+			"titleAlt": {
+				"type": "string"
+			},
+			"txt": {
+				"type": "string"
+			}
+		},
+		"required": [
+			"ver",
+			"date",
+			"txt"
+		],
+		"additionalProperties": false
+	}
+}

package/schema/brew-fast/class/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew-fast/life.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "life.json",
+	"version": "1.0.0",
+	"type": "object",
+	"properties": {
+		"lifeClass": true,
+		"lifeBackground": true,
+		"lifeTrinket": true
+	},
+	"required": [
+		"lifeClass",
+		"lifeBackground",
+		"lifeTrinket"
+	],
+	"additionalProperties": false
+}

package/schema/brew-fast/spells/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew-fast/spells/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/bestiary/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/bestiary/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/changelog.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "changelog.json",
+	"version": "1.0.0",
+	"type": "array",
+	"minItems": 1,
+	"uniqueItems": true,
+	"items": {
+		"type": "object",
+		"properties": {
+			"ver": {
+				"type": "string"
+			},
+			"date": {
+				"type": "string",
+				"format": "date"
+			},
+			"title": {
+				"type": "string"
+			},
+			"titleAlt": {
+				"type": "string"
+			},
+			"txt": {
+				"type": "string"
+			}
+		},
+		"required": [
+			"ver",
+			"date",
+			"txt"
+		],
+		"additionalProperties": false
+	}
+}

package/schema/site/class/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/life.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "life.json",
+	"version": "1.0.0",
+	"type": "object",
+	"properties": {
+		"lifeClass": true,
+		"lifeBackground": true,
+		"lifeTrinket": true
+	},
+	"required": [
+		"lifeClass",
+		"lifeBackground",
+		"lifeTrinket"
+	],
+	"additionalProperties": false
+}

package/schema/site/spells/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site/spells/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site-fast/bestiary/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site-fast/bestiary/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site-fast/changelog.json

@@ -0,0 +1,35 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "changelog.json",
+	"version": "1.0.0",
+	"type": "array",
+	"minItems": 1,
+	"uniqueItems": true,
+	"items": {
+		"type": "object",
+		"properties": {
+			"ver": {
+				"type": "string"
+			},
+			"date": {
+				"type": "string",
+				"format": "date"
+			},
+			"title": {
+				"type": "string"
+			},
+			"titleAlt": {
+				"type": "string"
+			},
+			"txt": {
+				"type": "string"
+			}
+		},
+		"required": [
+			"ver",
+			"date",
+			"txt"
+		],
+		"additionalProperties": false
+	}
+}

package/schema/site-fast/class/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site-fast/life.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "life.json",
+	"version": "1.0.0",
+	"type": "object",
+	"properties": {
+		"lifeClass": true,
+		"lifeBackground": true,
+		"lifeTrinket": true
+	},
+	"required": [
+		"lifeClass",
+		"lifeBackground",
+		"lifeTrinket"
+	],
+	"additionalProperties": false
+}

package/schema/site-fast/spells/fluff-index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/site-fast/spells/index.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"version": "1.0.0",
+	"type": "object",
+	"patternProperties": {
+		"^[-a-zA-Z0-9]+$": {
+			"type": "string"
+		}
+	},
+	"additionalProperties": false
+}