5etools-utils 0.15.7 → 0.15.9

package/lib/BrewTester/BrewTesterFileContents.js

@@ -1,166 +1,9 @@
 import fs from "node:fs";
 import {BrewTesterBase} from "./BrewTesterBase.js";
-import {DataTester, DataTesterBase, BraceCheck, EscapeCharacterCheck} from "../TestData.js";
+import {DataTester, BraceCheck, EscapeCharacterCheck, ImageUrlCheck, CopySourceCheck} from "../TestData.js";
 import * as Uf from "../UtilFs.js";
-import {ObjectWalker} from "../ObjectWalker.js";
-import {UtilSource} from "../UtilSource.js";
 import Um from "../UtilMisc.js";
 
-class _CopySourceCheck extends DataTesterBase {
-	static _FileState = class {
-		sources;
-		dependencies;
-		internalCopies;
-
-		constructor ({contents}) {
-			this.sources = new Set(
-				(contents._meta?.sources?.map(src => src?.json) || [])
-					.filter(Boolean),
-			);
-			this.dependencies = Object.fromEntries(
-				Object.entries(contents._meta?.dependencies || {})
-					.map(([prop, arr]) => [prop, new Set(arr)]),
-			);
-			this.internalCopies = new Set(contents._meta?.internalCopies || []);
-		}
-	};
-
-	registerParsedFileCheckers (parsedJsonChecker) {
-		parsedJsonChecker.registerFileHandler(this);
-	}
-
-	handleFile (file, contents) {
-		if (!file.includes("Kobold Press; Scarlet Citadel.json")) return;
-
-		const fileState = new this.constructor._FileState({contents});
-
-		Object.entries(contents)
-			.forEach(([prop, arr]) => {
-				if (prop.startsWith("_")) return;
-				if (!(arr instanceof Array)) return;
-
-				arr.forEach(ent => {
-					const propStack = [prop];
-					const inlineDependencies = new Set();
-
-					ObjectWalker.walk({
-						obj: ent,
-						filePath: file,
-						primitiveHandlers: {
-							preObject: this._onPreObject.bind(this, {propStack, inlineDependencies}),
-							object: this._checkObject.bind(this, {fileState, propStack, inlineDependencies}),
-							postObject: this._onPostObject.bind(this, {propStack, inlineDependencies}),
-						},
-					});
-				});
-			});
-	}
-
-	_onPreObject ({propStack, inlineDependencies}, obj) {
-		if (obj.type !== "statblockInline") return;
-
-		propStack.push(obj.dataType);
-		(obj.dependencies || []).forEach(dep => inlineDependencies.add(dep));
-	}
-
-	_onPostObject ({propStack, inlineDependencies}, obj) {
-		if (obj.type !== "statblockInline") return;
-
-		propStack.pop();
-		inlineDependencies.clear();
-	}
-
-	_checkObject ({fileState, propStack, inlineDependencies}, obj, {filePath}) {
-		if (!obj._copy?.source) return;
-
-		const prop = propStack.at(-1);
-		const sourceCopy = obj._copy.source;
-
-		// Classes/subclasses have an alternate structure.
-		if (["class", "subclass"].includes(prop) && UtilSource.isSiteSource(sourceCopy)) {
-			const classNameLower = obj._copy.className?.toLowerCase();
-			if (
-				fileState.dependencies[prop]?.has(classNameLower)
-				|| inlineDependencies.has(classNameLower)
-			) return;
-		}
-
-		// If a root entity, i.e. not in a `statblockInline`, allow internal copies.
-		if (
-			propStack.length === 1
-			&& fileState.internalCopies.has(prop)
-			&& fileState.sources.has(sourceCopy)
-		) return;
-
-		if (
-			fileState.dependencies[prop]?.has(sourceCopy)
-			|| inlineDependencies.has(sourceCopy)
-		) return;
-
-		this._addMessage(`Entity "${propStack.join(" -> ")}" "${obj.name}" "_copy" source "${sourceCopy}" did not match sources found in dependencies in file "${filePath}"\n`);
-	}
-}
-
-class _ImageUrlCheck extends DataTesterBase {
-	static _RE_IMG_PATH = /^(?<type>img|pdf)\/(?<source>[^/]+)\//;
-
-	static _FileState = class {
-		sources;
-
-		constructor ({contents}) {
-			this.sources = new Set(
-				[
-					...(contents._meta?.sources?.map(src => src?.json) || [])
-						.filter(Boolean)
-						.map(srcJson => srcJson.replace(/:/g, "")),
-					...(contents._test?.additionalImageSources || [])
-						.map(srcJson => srcJson.replace(/:/g, "")),
-				],
-			);
-		}
-	};
-
-	constructor ({imgRepoName, urlPrefixExpected}) {
-		super();
-		this._imgRepoName = imgRepoName;
-		this._urlPrefixExpected = urlPrefixExpected;
-	}
-
-	registerParsedFileCheckers (parsedJsonChecker) {
-		parsedJsonChecker.registerFileHandler(this);
-	}
-
-	handleFile (file, contents) {
-		const fileState = new this.constructor._FileState({contents});
-
-		ObjectWalker.walk({
-			obj: contents,
-			filePath: file,
-			primitiveHandlers: {
-				object: this._checkObject.bind(this, {fileState}),
-			},
-		});
-	}
-
-	_checkObject ({fileState}, obj, {filePath}) {
-		if (obj.type !== "image" || obj.href?.type !== "external" || !obj.href?.url) return;
-
-		const {url} = obj.href;
-		if (!url.toLowerCase().startsWith(this._urlPrefixExpected.toLowerCase())) return;
-
-		const mPath = this.constructor._RE_IMG_PATH.exec(url.slice(this._urlPrefixExpected.length));
-		if (!mPath) {
-			this._addMessage(`Unknown "${this._imgRepoName}" URL pattern in file "${filePath}": "${url}"\n`);
-			return;
-		}
-
-		const {source, type} = mPath.groups;
-		if (fileState.sources.has(source)) return;
-
-		this._addMessage(`Image source part "${source}" in "${this._imgRepoName}" ${type} URL did not match sources found in file "_meta" or "_test" in file "${filePath}": "${url}"\n`);
-	}
-}
-
 export class BrewTesterFileContents extends BrewTesterBase {
 	_LOG_TAG = "FILE_CONTENTS";
 
@@ -180,8 +23,8 @@ export class BrewTesterFileContents extends BrewTesterBase {
 		const dataTesters = [
 			new BraceCheck(),
 			new EscapeCharacterCheck(),
-			new _ImageUrlCheck({imgRepoName: this._imgRepoName, urlPrefixExpected: this._urlPrefixExpected}),
-			new _CopySourceCheck(),
+			new ImageUrlCheck({imgRepoName: this._imgRepoName, urlPrefixExpected: this._urlPrefixExpected}),
+			new CopySourceCheck(),
 		];
 		DataTester.register({dataTesters});
 

package/lib/TestData.js

@@ -1,6 +1,7 @@
 import fs from "fs";
 import {readJsonSync} from "./UtilFs.js";
 import {ObjectWalker} from "./ObjectWalker.js";
+import {UtilSource} from "./UtilSource.js";
 
 /** Runs multiple handlers on each file, to avoid re-reading each file for each handler */
 class _ParsedJsonChecker {
@@ -194,9 +195,166 @@ class DataTester {
 	}
 }
 
+class CopySourceCheck extends DataTesterBase {
+	static _FileState = class {
+		sources;
+		dependencies;
+		internalCopies;
+
+		constructor ({contents}) {
+			this.sources = new Set(
+				(contents._meta?.sources?.map(src => src?.json) || [])
+					.filter(Boolean),
+			);
+			this.dependencies = Object.fromEntries(
+				Object.entries(contents._meta?.dependencies || {})
+					.map(([prop, arr]) => [prop, new Set(arr)]),
+			);
+			this.internalCopies = new Set(contents._meta?.internalCopies || []);
+		}
+	};
+
+	registerParsedFileCheckers (parsedJsonChecker) {
+		parsedJsonChecker.registerFileHandler(this);
+	}
+
+	handleFile (file, contents) {
+		if (!file.includes("Kobold Press; Scarlet Citadel.json")) return;
+
+		const fileState = new this.constructor._FileState({contents});
+
+		Object.entries(contents)
+			.forEach(([prop, arr]) => {
+				if (prop.startsWith("_")) return;
+				if (!(arr instanceof Array)) return;
+
+				arr.forEach(ent => {
+					const propStack = [prop];
+					const inlineDependencies = new Set();
+
+					ObjectWalker.walk({
+						obj: ent,
+						filePath: file,
+						primitiveHandlers: {
+							preObject: this._onPreObject.bind(this, {propStack, inlineDependencies}),
+							object: this._checkObject.bind(this, {fileState, propStack, inlineDependencies}),
+							postObject: this._onPostObject.bind(this, {propStack, inlineDependencies}),
+						},
+					});
+				});
+			});
+	}
+
+	_onPreObject ({propStack, inlineDependencies}, obj) {
+		if (obj.type !== "statblockInline") return;
+
+		propStack.push(obj.dataType);
+		(obj.dependencies || []).forEach(dep => inlineDependencies.add(dep));
+	}
+
+	_onPostObject ({propStack, inlineDependencies}, obj) {
+		if (obj.type !== "statblockInline") return;
+
+		propStack.pop();
+		inlineDependencies.clear();
+	}
+
+	_checkObject ({fileState, propStack, inlineDependencies}, obj, {filePath}) {
+		if (!obj._copy?.source) return;
+
+		const prop = propStack.at(-1);
+		const sourceCopy = obj._copy.source;
+
+		// Classes/subclasses have an alternate structure.
+		if (["class", "subclass"].includes(prop) && UtilSource.isSiteSource(sourceCopy)) {
+			const classNameLower = obj._copy.className?.toLowerCase();
+			if (
+				fileState.dependencies[prop]?.has(classNameLower)
+				|| inlineDependencies.has(classNameLower)
+			) return;
+		}
+
+		// If a root entity, i.e. not in a `statblockInline`, allow internal copies.
+		if (
+			propStack.length === 1
+			&& fileState.internalCopies.has(prop)
+			&& fileState.sources.has(sourceCopy)
+		) return;
+
+		if (
+			fileState.dependencies[prop]?.has(sourceCopy)
+			|| inlineDependencies.has(sourceCopy)
+		) return;
+
+		this._addMessage(`Entity "${propStack.join(" -> ")}" "${obj.name}" "_copy" source "${sourceCopy}" did not match sources found in dependencies in file "${filePath}"\n`);
+	}
+}
+
+class ImageUrlCheck extends DataTesterBase {
+	static _RE_IMG_PATH = /^(?<type>img|pdf)\/(?<source>[^/]+)\//;
+
+	static _FileState = class {
+		sources;
+
+		constructor ({contents}) {
+			this.sources = new Set(
+				[
+					...(contents._meta?.sources?.map(src => src?.json) || [])
+						.filter(Boolean)
+						.map(srcJson => srcJson.replace(/:/g, "")),
+					...(contents._test?.additionalImageSources || [])
+						.map(srcJson => srcJson.replace(/:/g, "")),
+				],
+			);
+		}
+	};
+
+	constructor ({imgRepoName, urlPrefixExpected}) {
+		super();
+		this._imgRepoName = imgRepoName;
+		this._urlPrefixExpected = urlPrefixExpected;
+	}
+
+	registerParsedFileCheckers (parsedJsonChecker) {
+		parsedJsonChecker.registerFileHandler(this);
+	}
+
+	handleFile (file, contents) {
+		const fileState = new this.constructor._FileState({contents});
+
+		ObjectWalker.walk({
+			obj: contents,
+			filePath: file,
+			primitiveHandlers: {
+				object: this._checkObject.bind(this, {fileState}),
+			},
+		});
+	}
+
+	_checkObject ({fileState}, obj, {filePath}) {
+		if (obj.type !== "image" || obj.href?.type !== "external" || !obj.href?.url) return;
+
+		const {url} = obj.href;
+		if (!url.toLowerCase().startsWith(this._urlPrefixExpected.toLowerCase())) return;
+
+		const mPath = this.constructor._RE_IMG_PATH.exec(url.slice(this._urlPrefixExpected.length));
+		if (!mPath) {
+			this._addMessage(`Unknown "${this._imgRepoName}" URL pattern in file "${filePath}": "${url}"\n`);
+			return;
+		}
+
+		const {source, type} = mPath.groups;
+		if (fileState.sources.has(source)) return;
+
+		this._addMessage(`Image source part "${source}" in "${this._imgRepoName}" ${type} URL did not match sources found in file "_meta" or "_test" in file "${filePath}": "${url}"\n`);
+	}
+}
+
 export {
 	DataTester,
 	DataTesterBase,
 	BraceCheck,
 	EscapeCharacterCheck,
+	CopySourceCheck,
+	ImageUrlCheck,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "5etools-utils",
-	"version": "0.15.7",
+	"version": "0.15.9",
 	"description": "Shared utilities for the 5etools ecosystem.",
 	"type": "module",
 	"main": "lib/Api.js",

package/schema/brew/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -315,16 +315,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -381,6 +371,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/brew/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [

package/schema/brew/util-foundry.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-foundry.json",
 	"title": "Util: Foundry",
-	"version": "1.1.7",
+	"version": "1.1.8",
 	"$defs": {
 		"entryDataObject": {
 			"description": "Additional \"5etools-type\" data to be stored on the entry.",
@@ -1517,6 +1517,110 @@
 				"type"
 			]
 		},
+		"_foundryActivityObject_forward": {
+			"type": "object",
+			"properties": {
+				"foundryId": {
+					"description": "Use only when required. For example, when linking a \"rider\".",
+					"$ref": "#/$defs/foundryIdShort",
+					"markdownDescription": "Use only when required. For example, when linking a "rider"."
+				},
+				"img": {
+					"type": "string"
+				},
+				"description": {
+					"type": "object"
+				},
+				"descriptionEntries": {
+					"description": "If supplied, will be used to populate \"description.chatFlavor\".",
+					"type": "array",
+					"items": {
+						"$ref": "entry.json"
+					},
+					"markdownDescription": "If supplied, will be used to populate "description.chatFlavor"."
+				},
+				"consumption": {
+					"type": "object",
+					"properties": {
+						"targets": {
+							"type": "array",
+							"items": {
+								"type": "object",
+								"properties": {
+									"target": {
+										"oneOf": [
+											{
+												"type": "string"
+											},
+											{
+												"description": "A link to an importable entity",
+												"type": "object",
+												"properties": {
+													"prop": {
+														"type": "string"
+													},
+													"uid": {
+														"type": "string"
+													}
+												},
+												"required": [
+													"prop",
+													"uid"
+												],
+												"additionalProperties": false,
+												"markdownDescription": "A link to an importable entity"
+											},
+											{
+												"description": "A link to a 5etools-style resource",
+												"type": "object",
+												"properties": {
+													"consumes": {
+														"type": "object",
+														"properties": {
+															"name": {
+																"$ref": "util.json#/$defs/consumesName"
+															}
+														},
+														"required": [
+															"name"
+														],
+														"additionalProperties": false
+													}
+												},
+												"required": [
+													"consumes"
+												],
+												"additionalProperties": false,
+												"markdownDescription": "A link to a 5etools-style resource"
+											}
+										]
+									}
+								}
+							}
+						}
+					}
+				},
+				"effects": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/_foundryIdRef"
+					}
+				},
+				"_id": false,
+				"sort": false,
+				"template": false,
+				"affects": false,
+				"type": {
+					"const": "forward"
+				},
+				"activity": {
+					"$ref": "#/$defs/_foundryIdRef"
+				}
+			},
+			"required": [
+				"type"
+			]
+		},
 		"_foundryActivityObject_utility": {
 			"type": "object",
 			"properties": {

package/schema/brew-fast/homebrew.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.11.7",
+	"version": "1.12.0",
 	"type": "object",
 	"description": "Homebrew for 5etools. Should include arrays titled similarly to the main site data, e.g. `spell` or `class`",
 	"$defs": {
@@ -313,16 +313,6 @@
 					},
 					"markdownDescription": "Structure as per "dependencies". Additional sources to be included when loading the file."
 				},
-				"references": {
-					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
-					"type": "array",
-					"items": {
-						"type": "string"
-					},
-					"minItems": 1,
-					"uniqueItems": true,
-					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
-				},
 				"internalCopies": {
 					"description": "An array of keys that are copied from within the current document. e.g. \"item\", \"monsterFluff\", \"background\" etc.",
 					"type": "array",
@@ -379,6 +369,16 @@
 			"description": "Supplementary information used when testing this homebrew.",
 			"type": "object",
 			"properties": {
+				"references": {
+					"description": "A \"soft\" alternative to `\"dependencies\"`, used only for data validation (and may therefore be omitted).\n\nAn array of `[\"<NonSiteJsonSource1>\", ..., \"<NonSiteJsonSourceN>\"]`. Entities from these sources will be made available when running e.g. 5etools' `test-tags.js`.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					},
+					"minItems": 1,
+					"uniqueItems": true,
+					"markdownDescription": "A &quot;soft&quot; alternative to &quot;dependencies&quot;, used only for data validation (and may therefore be omitted).\n\nAn array of [&quot;&lt;NonSiteJsonSource1&gt;&quot;, ..., &quot;&lt;NonSiteJsonSourceN&gt;&quot;]. Entities from these sources will be made available when running e.g. 5etools&apos; test-tags.js."
+				},
 				"additionalImageSources": {
 					"description": "Other sources from which this homebrew should be allowed to use images.",
 					"type": "array",

package/schema/brew-fast/util-copy.json

@@ -2,7 +2,7 @@
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "util-copy.json",
 	"title": "Util: Copy",
-	"version": "1.0.10",
+	"version": "1.0.11",
 	"$defs": {
 		"_mod_renameArr_rename": {
 			"type": "object",
@@ -1112,7 +1112,9 @@
 								"required": [
 									"_variables"
 								]
-							}
+							},
+							"minItems": 1,
+							"uniqueItems": true
 						}
 					},
 					"required": [