5etools-utils 0.8.37 → 0.9.0

package/README.md

@@ -4,4 +4,5 @@ Available commands:
 
 ```
 npx test-json-brew [file] [--dir <dir>]
+npx test-json-ua [file] [--dir <dir>]
 ```

package/bin/test-json-ua.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {BrewTester} from "../lib/BrewTester.js";
+
+BrewTester.pTestJson(process.argv, {mode: "ua"});

package/lib/BrewTester.js

@@ -10,7 +10,7 @@ class _BrewTesterJson {
 	static _LOG_TAG = "JSON";
 	static _IS_FAIL_SLOW = !!process.env.FAIL_SLOW;
 
-	static async pRun (args) {
+	static async pRun (args, {mode = "brew"} = {}) {
 		const program = new Command()
 			.argument("[file]", "File to test")
 			.option("--dir <dir>", "Directory to test")
@@ -19,7 +19,7 @@ class _BrewTesterJson {
 		program.parse(args);
 		const opts = program.opts();
 
-		const jsonTester = new JsonTester({isBrew: true, tagLog: this._LOG_TAG, fnGetSchemaId: () => "homebrew.json"});
+		const jsonTester = new JsonTester({mode, tagLog: this._LOG_TAG, fnGetSchemaId: () => "homebrew.json"});
 
 		let results;
 		if (program.args[0]) {

package/lib/TestJson.js

@@ -18,6 +18,12 @@ const _IS_TRIM_RESULTS = !process.env.VET_TEST_JSON_RESULTS_UNTRIMMED;
 
 const LOG_TAG = "JSON";
 
+const MODES = {
+	SITE: "site",
+	BREW: "brew",
+	UA: "ua",
+};
+
 class JsonTester {
 	static _RE_DATE = /^\d\d\d\d-\d\d-\d\d$/;
 
@@ -25,18 +31,20 @@ class JsonTester {
 		{
 			fnGetSchemaId,
 
-			isBrew = false,
+			mode = null,
 			dirSchema = null,
 			tagLog = LOG_TAG,
 		},
 	) {
-		if (isBrew && dirSchema) throw new Error(`"isBrew" and "dirSchema" are mutually exclusive!`);
+		if (mode && dirSchema) throw new Error(`"mode" and "dirSchema" are mutually exclusive!`);
+		if (mode != null && !Object.values(MODES).includes(mode)) throw new Error(`"mode" must be one of ${Object.values(MODES).join("/")}!`);
 		if (!fnGetSchemaId) throw new Error(`"fnGetSchemaId" is required!`);
 
 		this._dirSchemaSite = path.join(__dirname, "..", "schema", "site");
 		this._dirSchemaBrew = path.join(__dirname, "..", "schema", "brew");
+		this._dirSchemaUa = path.join(__dirname, "..", "schema", "ua");
 
-		this._dirSchema = dirSchema ?? (isBrew ? this._dirSchemaBrew : this._dirSchemaSite);
+		this._dirSchema = dirSchema ?? (mode === "site" ? this._dirSchemaSite : mode === "brew" ? this._dirSchemaBrew : this._dirSchemaSite);
 		this._tagLog = tagLog;
 		this._fnGetSchemaId = fnGetSchemaId;
 
@@ -113,9 +121,14 @@ class JsonTester {
 	}
 
 	doLoadSchema (type, relativeFilePath) {
-		if (!["site", "brew"].includes(type)) throw new Error(`Unknown schema type "${type}"`);
-
-		const dir = type === "site" ? this._dirSchemaSite : this._dirSchemaBrew;
+		if (!Object.values(MODES).includes(type)) throw new Error(`Unknown schema type "${type}"`);
+
+		const dir = {
+			[MODES.SITE]: this._dirSchemaSite,
+			[MODES.BREW]: this._dirSchemaBrew,
+			[MODES.UA]: this._dirSchemaUa,
+		}[type];
+		if (!dir) throw new Error(`Unhandled type "${type}"!`);
 
 		this._ajv.addSchema(
 			Uf.readJsonSync(path.join(dir, relativeFilePath)),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.8.37",
+	"version": "0.9.0",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -13,6 +13,7 @@
 	},
 	"bin": {
 		"test-json-brew": "bin/test-json-brew.js",
+		"test-json-ua": "bin/test-json-ua.js",
 		"test-file-extensions": "bin/test-file-extensions.js",
 		"test-file-locations": "bin/test-file-locations.js"
 	},

package/schema/site/util.json

@@ -48,7 +48,7 @@
 		"sourceJson": {
 			"type": "string",
 			"description": "An identifying string, as seen in the JSON in \"source\" fields.",
-			"pattern": "^(?!UA|XUA)[-a-zA-Z0-9 :&+!]+$"
+			"pattern": "^[-a-zA-Z0-9 :&+!]+$"
 		},
 		"page": {
 			"type": "integer"

package/schema/site-fast/util.json

@@ -48,7 +48,7 @@
 		"sourceJson": {
 			"type": "string",
 			"description": "An identifying string, as seen in the JSON in \"source\" fields.",
-			"pattern": "^(?!UA|XUA)[-a-zA-Z0-9 :&+!]+$"
+			"pattern": "^[-a-zA-Z0-9 :&+!]+$"
 		},
 		"page": {
 			"type": "integer"

package/schema/ua/actions.json

@@ -0,0 +1,97 @@
+{
+	"$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": {
+					"$ref": "util.json#/$defs/source"
+				},
+				"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\"."
+					}
+				}
+			},
+			"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/ua/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/ua/adventures.json

@@ -0,0 +1,214 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "adventures.json",
+	"version": "1.10.11",
+	"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": {
+						"$ref": "util.json#/$defs/source"
+					},
+					"parentSource": {
+						"type": "string",
+						"description": "Used for books that contain multiple adventures, e.g. TftYP",
+						"$ref": "util.json#/$defs/source"
+					},
+					"group": {
+						"description": "The group under which this adventure should be listed in the navbar.",
+						"type": "string",
+						"enum": [
+							"supplement",
+							"supplement-alt",
+							"prerelease",
+							"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",
+						"enum": [
+							"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",
+							"Keys from the Golden Vault"
+						]
+					}
+				},
+				"additionalProperties": false,
+				"required": [
+					"name",
+					"id",
+					"source",
+					"contents",
+					"level",
+					"published",
+					"storyline",
+					"group"
+				]
+			}
+		}
+	},
+	"additionalProperties": false
+}