5etools-utils 0.14.39 → 0.15.0

package/bin/test-edition-sources.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {BrewTester} from "../lib/BrewTester.js";
+
+await BrewTester.pTestEditionSources();

package/lib/BrewTester/BrewTesterEdition.js

@@ -0,0 +1,115 @@
+import fs from "fs";
+import Um from "../UtilMisc.js";
+import {BrewTesterBase} from "./BrewTesterBase.js";
+import * as Uf from "../UtilFs.js";
+import {readJsonSync} from "../UtilFs.js";
+import url from "url";
+import pathlib from "path";
+import {ObjectWalker} from "../ObjectWalker.js";
+
+const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
+
+export class BrewTesterEdition extends BrewTesterBase {
+	_LOG_TAG = "EDITION";
+
+	static _EDITION_CLASSIC = "classic";
+
+	// TODO(Future) this is non-exhaustive; we do not check e.g. `item.attachedSpells`
+	//   Generalize an "entity -> used UIDs" system to use both here and in other tests
+	static _getSourcesUsed ({filePath, json}) {
+		return [
+			...new Set([
+				...this._getSourcesUsedMeta({json, prop: "dependencies"}),
+				...this._getSourcesUsedMeta({json, prop: "includes"}),
+
+				...Object.entries(json)
+					.flatMap(([prop, arr]) => {
+						if (!(arr instanceof Array)) return [];
+						return arr
+							.flatMap(ent => [
+								...this._getSourcesUsedEntityDirect({ent}),
+								...this._getSourcesUsedEntityText({filePath, ent}),
+							]);
+					}),
+			]),
+		];
+	}
+
+	static _getSourcesUsedMeta ({json, prop}) {
+		if (!json._meta[prop]) return [];
+		return Object.values(json._meta[prop])
+			.flat();
+	}
+
+	static _getSourcesUsedEntityDirect ({ent}) {
+		return [
+			ent.source,
+			ent.inherits?.source,
+			ent._copy?.source,
+			...(ent._copy?._templates?.map(it => it.source) || []),
+			...(ent.otherSources?.map(it => it.source) || []),
+			...(ent.referenceSources || []),
+		]
+			.filter(Boolean);
+	}
+
+	static _RE_NAIVE_TAG = /{@[^ ]+ [^|]+\|(?<source>[^|}]+)/g;
+
+	static _getSourcesUsedEntityText ({filePath, ent}) {
+		const out = [];
+		ObjectWalker.walk({
+			obj: ent,
+			filePath,
+			primitiveHandlers: str => {
+				// TODO(Future) use more accurate source finding, e.g. that provided by `Renderer.utils.getTagMeta`
+				str.replace(this._RE_NAIVE_TAG, (...m) => {
+					const {source} = m.at(-1);
+					out.push(source);
+					return m[0];
+				});
+			},
+		});
+		return out;
+	}
+
+	/* -------------------------------------------- */
+
+	async _pRun () {
+		Um.info(this._LOG_TAG, `Checking sources used...`);
+
+		const schemaSources = readJsonSync(pathlib.join(__dirname, "..", "..", "schema", "site", "sources-5etools.json"));
+		const modernSources = Object.fromEntries(
+			schemaSources.$defs.sourcesModern.enum
+				.map(src => [src.toLowerCase(), src]),
+		);
+
+		const results = [];
+		Uf.runOnDirs((dir) => {
+			Um.info(this._LOG_TAG, `Checking dir "${dir}"...`);
+			const dirFiles = fs.readdirSync(dir, "utf8")
+				.filter(file => file.endsWith(".json"));
+
+			dirFiles.forEach(file => {
+				const filePath = `${dir}/${file}`;
+
+				const json = JSON.parse(fs.readFileSync(filePath, "utf-8"));
+
+				if (json._meta?.edition !== this.constructor._EDITION_CLASSIC) return;
+
+				const sourcesUsedModern = this.constructor._getSourcesUsed({filePath, json})
+					.map(src => modernSources[src.toLowerCase()])
+					.filter(Boolean);
+				if (!sourcesUsedModern.length) return;
+
+				results.push(`${dir}/${file} used ${sourcesUsedModern.length === 1 ? "a " : ""}modern source${sourcesUsedModern.length === 1 ? "" : "s"} but was marked as "edition": ${this.constructor._EDITION_CLASSIC}"! Source${sourcesUsedModern.length === 1 ? " was" : "s were"} ${sourcesUsedModern.map(src => `"${src}"`).join(", ")}`);
+			});
+		});
+
+		if (results.length) {
+			results.forEach(r => Um.error(this._LOG_TAG, r));
+			throw new Error(`${results.length} file${results.length === 1 ? ` used modern source(s) but was marked as "edition": ${this.constructor._EDITION_CLASSIC}"!` : `s used modern source(s) but were marked as "edition": ${this.constructor._EDITION_CLASSIC}"!`} See above for more info.`);
+		}
+
+		Um.info(this._LOG_TAG, `Complete.`);
+	}
+}

package/lib/BrewTester.js

@@ -2,10 +2,12 @@ import {BrewTesterJson} from "./BrewTester/BrewTesterJson.js";
 import {BrewTesterFileLocations} from "./BrewTester/BrewTesterFileLocations.js";
 import {BrewTesterFileNames} from "./BrewTester/BrewTesterFileNames.js";
 import {BrewTesterFileProps} from "./BrewTester/BrewTesterFileProps.js";
+import {BrewTesterEdition} from "./BrewTester/BrewTesterEdition.js";
 
 export class BrewTester {
 	static async pTestJson ({mode, filepath, dir}) { return (new BrewTesterJson({mode, filepath, dir})).pRun(); }
 	static pTestFileLocations () { return (new BrewTesterFileLocations()).pRun(); }
 	static pTestFileNames () { return (new BrewTesterFileNames()).pRun(); }
 	static pTestFileProps () { return (new BrewTesterFileProps()).pRun(); }
+	static pTestEditionSources () { return (new BrewTesterEdition()).pRun(); }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.14.39",
+	"version": "0.15.0",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",
@@ -16,7 +16,8 @@
 		"test-json-ua": "bin/test-json-ua.js",
 		"test-file-names": "bin/test-file-names.js",
 		"test-file-locations": "bin/test-file-locations.js",
-		"test-file-props": "bin/test-file-props.js"
+		"test-file-props": "bin/test-file-props.js",
+		"test-edition-sources": "bin/test-edition-sources.js"
 	},
 	"scripts": {
 		"build:dangerous:sources": "node node/fetch-5etools-sources.js",

package/schema/brew/foundry-items.json

@@ -1,12 +1,15 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "foundry-items.json",
-	"version": "1.2.2",
+	"version": "1.2.3",
 	"type": "object",
 	"properties": {
 		"magicvariant": {
 			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
 		},
+		"baseitem": {
+			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
+		},
 		"item": {
 			"type": "array",
 			"minItems": 1,

package/schema/brew/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.5",
+	"version": "1.11.6",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -627,6 +627,9 @@
 		"foundryMagicvariant": {
 			"$ref": "foundry-items.json#/properties/magicvariant"
 		},
+		"foundryBaseitem": {
+			"$ref": "foundry-items.json#/properties/baseitem"
+		},
 		"itemGroup": {
 			"$ref": "items.json#/properties/itemGroup"
 		},

package/schema/brew/sources-5etools.json

@@ -114,6 +114,7 @@
 				"XPHB",
 				"XDMG",
 				"XMM",
+				"XSAC",
 				"DrDe",
 				"DrDe-DaS",
 				"DrDe-BD",
@@ -188,6 +189,208 @@
 				"MisMV1",
 				"AATM"
 			]
+		},
+		"sourcesLegacy": {
+			"type": "string",
+			"enum": [
+				"PHB",
+				"DMG",
+				"MM",
+				"EEPC",
+				"VGM",
+				"MTF",
+				"Screen"
+			]
+		},
+		"sourcesClassic": {
+			"type": "string",
+			"enum": [
+				"PHB",
+				"DMG",
+				"MM",
+				"CoS",
+				"EEPC",
+				"EET",
+				"HotDQ",
+				"LMoP",
+				"OotA",
+				"PotA",
+				"RoT",
+				"RoTOS",
+				"SCAG",
+				"SKT",
+				"ToA",
+				"TLK",
+				"ToD",
+				"TTP",
+				"TftYP",
+				"TftYP-AtG",
+				"TftYP-DiT",
+				"TftYP-TFoF",
+				"TftYP-THSoT",
+				"TftYP-TSC",
+				"TftYP-ToH",
+				"TftYP-WPM",
+				"VGM",
+				"XGE",
+				"OGA",
+				"MTF",
+				"WDH",
+				"WDMM",
+				"GGR",
+				"KKW",
+				"LLK",
+				"AZfyT",
+				"GoS",
+				"AI",
+				"OoW",
+				"ESK",
+				"DIP",
+				"HftT",
+				"DC",
+				"SLW",
+				"SDW",
+				"BGDIA",
+				"LR",
+				"AL",
+				"SAC",
+				"ERLW",
+				"EFR",
+				"RMBRE",
+				"RMR",
+				"MFF",
+				"AWM",
+				"IMR",
+				"SADS",
+				"EGW",
+				"ToR",
+				"DD",
+				"FS",
+				"US",
+				"MOT",
+				"IDRotF",
+				"TCE",
+				"VRGR",
+				"HoL",
+				"RtG",
+				"AitFR",
+				"AitFR-ISF",
+				"AitFR-THP",
+				"AitFR-AVT",
+				"AitFR-DN",
+				"AitFR-FCD",
+				"WBtW",
+				"DoD",
+				"MaBJoV",
+				"FTD",
+				"SCC",
+				"SCC-CK",
+				"SCC-HfMT",
+				"SCC-TMM",
+				"SCC-ARiR",
+				"MPMM",
+				"CRCotN",
+				"JttRC",
+				"SAiS",
+				"AAG",
+				"BAM",
+				"LoX",
+				"DoSI",
+				"DSotDQ",
+				"KftGV",
+				"BGG",
+				"PaBTSO",
+				"PAitM",
+				"SatO",
+				"ToFW",
+				"MPP",
+				"BMT",
+				"DMTCRG",
+				"QftIS",
+				"VEoR",
+				"TD",
+				"Screen",
+				"ScreenWildernessKit",
+				"ScreenDungeonKit",
+				"ScreenSpelljammer",
+				"HF",
+				"HFFotM",
+				"HFStCM",
+				"PaF",
+				"CM",
+				"NRH",
+				"NRH-TCMC",
+				"NRH-AVitW",
+				"NRH-ASS",
+				"NRH-CoI",
+				"NRH-TLT",
+				"NRH-AWoL",
+				"NRH-AT",
+				"MGELFT",
+				"VD",
+				"SjA",
+				"HAT-TG",
+				"HAT-LMI",
+				"GotSF",
+				"LK",
+				"CoA",
+				"PiP",
+				"DitLCoT",
+				"VNotEE",
+				"LRDT",
+				"ALCurseOfStrahd",
+				"ALElementalEvil",
+				"ALRageOfDemons",
+				"PSA",
+				"PSI",
+				"PSK",
+				"PSZ",
+				"PSX",
+				"PSD",
+				"XMtS",
+				"UATheMysticClass",
+				"MCV1SC",
+				"MCV2DC",
+				"MCV3MC",
+				"MCV4EC",
+				"MisMV1",
+				"AATM"
+			]
+		},
+		"sourcesModern": {
+			"type": "string",
+			"enum": [
+				"XPHB",
+				"XDMG",
+				"XMM",
+				"XSAC",
+				"DrDe",
+				"DrDe-DaS",
+				"DrDe-BD",
+				"DrDe-TWoO",
+				"DrDe-FWtVC",
+				"DrDe-TDoN",
+				"DrDe-TFV",
+				"DrDe-BtS",
+				"DrDe-SD",
+				"DrDe-ACfaS",
+				"DrDe-DotSC",
+				"HotB",
+				"WttHC",
+				"FRAiF",
+				"FRHoF",
+				"ABH",
+				"NF",
+				"LFL",
+				"EFA",
+				"FFotR",
+				"XScreen",
+				"HFDoMM",
+				"UtHftLH",
+				"ScoEE",
+				"HBTD",
+				"BQGT"
+			]
 		}
 	},
 	"markdownDescription": "A dump of 5etools sources. See node/fetch-5etools-sources.js."

package/schema/brew-fast/foundry-items.json

@@ -1,12 +1,15 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "foundry-items.json",
-	"version": "1.2.2",
+	"version": "1.2.3",
 	"type": "object",
 	"properties": {
 		"magicvariant": {
 			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
 		},
+		"baseitem": {
+			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
+		},
 		"item": {
 			"type": "array",
 			"minItems": 1,

package/schema/brew-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.5",
+	"version": "1.11.6",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -625,6 +625,9 @@
 		"foundryMagicvariant": {
 			"$ref": "foundry-items.json#/properties/magicvariant"
 		},
+		"foundryBaseitem": {
+			"$ref": "foundry-items.json#/properties/baseitem"
+		},
 		"itemGroup": {
 			"$ref": "items.json#/properties/itemGroup"
 		},

package/schema/brew-fast/sources-5etools.json

@@ -114,6 +114,7 @@
 				"XPHB",
 				"XDMG",
 				"XMM",
+				"XSAC",
 				"DrDe",
 				"DrDe-DaS",
 				"DrDe-BD",
@@ -188,6 +189,208 @@
 				"MisMV1",
 				"AATM"
 			]
+		},
+		"sourcesLegacy": {
+			"type": "string",
+			"enum": [
+				"PHB",
+				"DMG",
+				"MM",
+				"EEPC",
+				"VGM",
+				"MTF",
+				"Screen"
+			]
+		},
+		"sourcesClassic": {
+			"type": "string",
+			"enum": [
+				"PHB",
+				"DMG",
+				"MM",
+				"CoS",
+				"EEPC",
+				"EET",
+				"HotDQ",
+				"LMoP",
+				"OotA",
+				"PotA",
+				"RoT",
+				"RoTOS",
+				"SCAG",
+				"SKT",
+				"ToA",
+				"TLK",
+				"ToD",
+				"TTP",
+				"TftYP",
+				"TftYP-AtG",
+				"TftYP-DiT",
+				"TftYP-TFoF",
+				"TftYP-THSoT",
+				"TftYP-TSC",
+				"TftYP-ToH",
+				"TftYP-WPM",
+				"VGM",
+				"XGE",
+				"OGA",
+				"MTF",
+				"WDH",
+				"WDMM",
+				"GGR",
+				"KKW",
+				"LLK",
+				"AZfyT",
+				"GoS",
+				"AI",
+				"OoW",
+				"ESK",
+				"DIP",
+				"HftT",
+				"DC",
+				"SLW",
+				"SDW",
+				"BGDIA",
+				"LR",
+				"AL",
+				"SAC",
+				"ERLW",
+				"EFR",
+				"RMBRE",
+				"RMR",
+				"MFF",
+				"AWM",
+				"IMR",
+				"SADS",
+				"EGW",
+				"ToR",
+				"DD",
+				"FS",
+				"US",
+				"MOT",
+				"IDRotF",
+				"TCE",
+				"VRGR",
+				"HoL",
+				"RtG",
+				"AitFR",
+				"AitFR-ISF",
+				"AitFR-THP",
+				"AitFR-AVT",
+				"AitFR-DN",
+				"AitFR-FCD",
+				"WBtW",
+				"DoD",
+				"MaBJoV",
+				"FTD",
+				"SCC",
+				"SCC-CK",
+				"SCC-HfMT",
+				"SCC-TMM",
+				"SCC-ARiR",
+				"MPMM",
+				"CRCotN",
+				"JttRC",
+				"SAiS",
+				"AAG",
+				"BAM",
+				"LoX",
+				"DoSI",
+				"DSotDQ",
+				"KftGV",
+				"BGG",
+				"PaBTSO",
+				"PAitM",
+				"SatO",
+				"ToFW",
+				"MPP",
+				"BMT",
+				"DMTCRG",
+				"QftIS",
+				"VEoR",
+				"TD",
+				"Screen",
+				"ScreenWildernessKit",
+				"ScreenDungeonKit",
+				"ScreenSpelljammer",
+				"HF",
+				"HFFotM",
+				"HFStCM",
+				"PaF",
+				"CM",
+				"NRH",
+				"NRH-TCMC",
+				"NRH-AVitW",
+				"NRH-ASS",
+				"NRH-CoI",
+				"NRH-TLT",
+				"NRH-AWoL",
+				"NRH-AT",
+				"MGELFT",
+				"VD",
+				"SjA",
+				"HAT-TG",
+				"HAT-LMI",
+				"GotSF",
+				"LK",
+				"CoA",
+				"PiP",
+				"DitLCoT",
+				"VNotEE",
+				"LRDT",
+				"ALCurseOfStrahd",
+				"ALElementalEvil",
+				"ALRageOfDemons",
+				"PSA",
+				"PSI",
+				"PSK",
+				"PSZ",
+				"PSX",
+				"PSD",
+				"XMtS",
+				"UATheMysticClass",
+				"MCV1SC",
+				"MCV2DC",
+				"MCV3MC",
+				"MCV4EC",
+				"MisMV1",
+				"AATM"
+			]
+		},
+		"sourcesModern": {
+			"type": "string",
+			"enum": [
+				"XPHB",
+				"XDMG",
+				"XMM",
+				"XSAC",
+				"DrDe",
+				"DrDe-DaS",
+				"DrDe-BD",
+				"DrDe-TWoO",
+				"DrDe-FWtVC",
+				"DrDe-TDoN",
+				"DrDe-TFV",
+				"DrDe-BtS",
+				"DrDe-SD",
+				"DrDe-ACfaS",
+				"DrDe-DotSC",
+				"HotB",
+				"WttHC",
+				"FRAiF",
+				"FRHoF",
+				"ABH",
+				"NF",
+				"LFL",
+				"EFA",
+				"FFotR",
+				"XScreen",
+				"HFDoMM",
+				"UtHftLH",
+				"ScoEE",
+				"HBTD",
+				"BQGT"
+			]
 		}
 	},
 	"markdownDescription": "A dump of 5etools sources. See node/fetch-5etools-sources.js."

package/schema/site/foundry-items.json

@@ -1,12 +1,15 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "foundry-items.json",
-	"version": "1.2.2",
+	"version": "1.2.3",
 	"type": "object",
 	"properties": {
 		"magicvariant": {
 			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
 		},
+		"baseitem": {
+			"$ref": "util-foundry.json#/$defs/foundrySideDataGenericArray"
+		},
 		"item": {
 			"type": "array",
 			"minItems": 1,

package/schema/site/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.5",
+	"version": "1.11.6",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -627,6 +627,9 @@
 		"foundryMagicvariant": {
 			"$ref": "foundry-items.json#/properties/magicvariant"
 		},
+		"foundryBaseitem": {
+			"$ref": "foundry-items.json#/properties/baseitem"
+		},
 		"itemGroup": {
 			"$ref": "items.json#/properties/itemGroup"
 		},