5etools-utils 0.2.2 → 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,19 +1,21 @@
 {
 	"name": "5etools-utils",
-	"version": "0.2.2",
+	"version": "0.3.1",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
 	"files": [
-		"lib"
+		"lib",
+		"schema"
 	],
 	"directories": {
 		"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",
@@ -31,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/actions.json

@@ -0,0 +1,109 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "actions.json",
+	"version": "1.2.0",
+	"type": "object",
+	"$defs": {
+		"action": {
+			"type": "object",
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"entries": {
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					}
+				},
+				"source": {
+					"type": "string"
+				},
+				"page": {
+					"$ref": "util.json#/$defs/page"
+				},
+				"fromVariant": {
+					"type": "string",
+					"description": "UID of a \"variantrule\" to be linked as a footnote in the action."
+				},
+				"time": {
+					"type": "array",
+					"items": {
+						"oneOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"properties": {
+									"unit": {
+										"type": "string",
+										"enum": [
+											"action",
+											"bonus",
+											"reaction"
+										]
+									},
+									"number": {
+										"type": "integer"
+									}
+								},
+								"required": [
+									"unit",
+									"number"
+								],
+								"additionalProperties": false
+							}
+						]
+					}
+				},
+				"srd": {
+					"$ref": "util.json#/$defs/srd"
+				},
+				"basicRules": {
+					"$ref": "util.json#/$defs/basicRules"
+				},
+				"seeAlsoAction": {
+					"type": "array",
+					"items": {
+						"type": "string",
+						"description": "UIDs of \"action\"s to be linked in a \"See Also\" footnote.\nEx.: \"disarm|dmg\"."
+					}
+				},
+				"foundrySystem": {
+					"$ref": "util.json#/$defs/foundrySystemObject"
+				},
+				"foundryFlags": {
+					"$ref": "util.json#/$defs/foundryFlagsObject"
+				},
+				"foundryEffects": {
+					"$ref": "util.json#/$defs/foundryEffectsArray"
+				},
+				"foundryImg": {
+					"$ref": "util.json#/$defs/foundryImg"
+				}
+			},
+			"required": [
+				"name",
+				"entries",
+				"source",
+				"page"
+			],
+			"additionalProperties": false
+		}
+	},
+	"properties": {
+		"action": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"$ref": "#/$defs/action"
+			}
+		}
+	},
+	"required": [
+		"action"
+	],
+	"additionalProperties": false
+}

package/schema/brew/adventure/adventure.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "adventure.json",
+	"version": "1.2.0",
+	"type": "object",
+	"properties": {
+		"data": {
+			"$ref": "../util.json#/$defs/adventureBookData"
+		}
+	},
+	"additionalProperties": false
+}

package/schema/brew/adventures.json

@@ -0,0 +1,249 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "adventures.json",
+	"version": "1.10.9",
+	"type": "object",
+	"properties": {
+		"adventure": {
+			"type": "array",
+			"minItems": 1,
+			"uniqueItems": true,
+			"items": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"alias": {
+						"$ref": "util.json#/$defs/alias"
+					},
+					"id": {
+						"type": "string",
+						"description": "An ID that will be used to refer to this adventure in tags."
+					},
+					"source": {
+						"type": "string"
+					},
+					"parentSource": {
+						"type": "string",
+						"description": "Used for books that contain multiple adventures, e.g. TftYP"
+					},
+					"group": {
+						"description": "The group under which this adventure should be listed in the navbar.",
+						"type": "string",
+						"enum": [
+							"supplement",
+							"supplement-alt",
+							"homebrew",
+							"other"
+						]
+					},
+					"contents": {
+						"description": "The linked Table of Contents of the adventure.",
+						"type": "array",
+						"minItems": 1,
+						"items": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"headers": {
+									"type": "array",
+									"minItems": 1,
+									"items": {
+										"oneOf": [
+											{
+												"type": "string"
+											},
+											{
+												"type": "object",
+												"properties": {
+													"depth": {
+														"type": "integer"
+													},
+													"header": {
+														"type": "string"
+													},
+													"index": {
+														"description": "The relative index of this header in the current chapter, i.e. if \"Treasure\" appears twice and you wish the contents entry to link to the second instance, set the \"index\" to 1.",
+														"type": "integer"
+													}
+												},
+												"required": [
+													"header"
+												]
+											}
+										]
+									}
+								},
+								"ordinal": {
+									"type": "object",
+									"properties": {
+										"type": {
+											"type": "string",
+											"enum": [
+												"chapter",
+												"appendix",
+												"part",
+												"episode",
+												"level"
+											]
+										},
+										"identifier": {
+											"type": [
+												"integer",
+												"string"
+											]
+										}
+									},
+									"additionalProperties": false,
+									"required": [
+										"type",
+										"identifier"
+									]
+								}
+							},
+							"additionalProperties": false,
+							"required": [
+								"name"
+							]
+						}
+					},
+					"level": {
+						"description": "The character levels that the adventure ranges across.",
+						"oneOf": [
+							{
+								"type": "object",
+								"properties": {
+									"start": {
+										"type": "integer"
+									},
+									"end": {
+										"type": "integer"
+									}
+								},
+								"additionalProperties": false,
+								"required": [
+									"start",
+									"end"
+								]
+							},
+							{
+								"type": "object",
+								"properties": {
+									"custom": {
+										"type": "string"
+									}
+								},
+								"additionalProperties": false,
+								"required": [
+									"custom"
+								]
+							}
+						]
+					},
+					"published": {
+						"type": "string",
+						"format": "date",
+						"description": "The date of publication of the adventure, in the format YYYY-MM-DD (RFC3339)."
+					},
+					"publishedOrder": {
+						"description": "A sorting order for adventures within a single source.",
+						"type": "integer"
+					},
+					"coverUrl": {
+						"description": "A direct link to an image which should be 300 x 300px in size. Larger images will be centred and cropped.",
+						"type": "string"
+					},
+					"storyline": {
+						"type": "string",
+						"examples": [
+							"Starter Set",
+							"Tyranny of Dragons",
+							"Elemental Evil",
+							"Rage of Demons",
+							"Ravenloft",
+							"Storm King's Thunder",
+							"Tales from the Yawning Portal",
+							"Tomb of Annihilation",
+							"Waterdeep",
+							"Ravnica",
+							"Extra Life",
+							"Ghosts of Saltmarsh",
+							"Acquisitions Incorporated",
+							"Essentials Kit",
+							"Stranger Things",
+							"Baldur's Gate",
+							"Eberron",
+							"Rick and Morty",
+							"Wildemount",
+							"Icewind Dale",
+							"Mythic Odysseys of Theros",
+							"Candlekeep Mysteries",
+							"Adventures in the Forgotten Realms",
+							"The Wild Beyond the Witchlight",
+							"Ixalan",
+							"NERDS Restoring Harmony",
+							"Strixhaven",
+							"Critical Role",
+							"Journeys through the Radiant Citadel",
+							"Spelljammer",
+							"Dragonlance"
+						]
+					},
+					"alAveragePlayerLevel": {
+						"description": "Adventurers League Average Player Level; for use in homebrew.",
+						"type": "integer"
+					},
+					"alLength": {
+						"description": "Adventurers League length (in hours); for use in homebrew.",
+						"type": "object",
+						"oneOf": [
+							{
+								"properties": {
+									"min": {
+										"type": "integer"
+									},
+									"max": {
+										"type": "integer"
+									}
+								},
+								"required": [
+									"min",
+									"max"
+								]
+							},
+							{
+								"properties": {
+									"exact": {
+										"type": "integer"
+									}
+								},
+								"required": [
+									"exact"
+								]
+							}
+						]
+					},
+					"alId": {
+						"description": "Adventurers League ID; for use in homebrew.",
+						"type": "string"
+					}
+				},
+				"additionalProperties": false,
+				"required": [
+					"name",
+					"id",
+					"source",
+					"contents",
+					"level",
+					"published",
+					"storyline",
+					"group"
+				]
+			}
+		}
+	},
+	"additionalProperties": false
+}