5etools-utils 0.9.14 → 0.9.16

package/lib/UtilClean.js

@@ -3,12 +3,14 @@ const _CLEAN_JSON_REPLACEMENTS = {
 	"–": "\\u2013",
 	"‑": "\\u2011",
 	"−": "\\u2212",
-	"“": `\\"`,
-	"”": `\\"`,
+	" ": "\\u00A0",
+
 	"’": "'",
 	"‘": "'",
+	"’": "'",
 	"…": "...",
-	" ": "\\u00A0",
+	"\u200B": "", // zero-width space
+	"\u2002": " ", // em space
 	"ff": "ff",
 	"ffi": "ffi",
 	"ffl": "ffl",
@@ -23,6 +25,9 @@ const _CLEAN_JSON_REPLACEMENTS = {
 	"Nj": "Nj",
 	"nj": "nj",
 	"ſt": "ft",
+	"“": `"`,
+	"”": `"`,
+	"\u201a": ",",
 };
 const _CLEAN_JSON_REPLACEMENT_REGEX = new RegExp(Object.keys(_CLEAN_JSON_REPLACEMENTS).join("|"), "g");
 

package/package.json

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

package/schema/brew/bestiary/bestiary.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
-	"version": "1.21.19",
+	"version": "1.21.20",
 	"title": "Bestiary Schema",
 	"$id": "bestiary.json",
 	"type": "object",
@@ -1125,13 +1125,14 @@
 				"miscTags": {
 					"type": "array",
 					"items": {
-						"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
+						"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n MLW: Has Melee Weapons\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
 						"enum": [
 							"AOE",
 							"HPR",
 							"MW",
 							"RW",
 							"RCH",
+							"MLW",
 							"RNG",
 							"THW"
 						]
@@ -2306,13 +2307,14 @@
 						"miscTags": {
 							"type": "array",
 							"items": {
-								"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
+								"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n MLW: Has Melee Weapons\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
 								"enum": [
 									"AOE",
 									"HPR",
 									"MW",
 									"RW",
 									"RCH",
+									"MLW",
 									"RNG",
 									"THW"
 								]
@@ -3501,13 +3503,14 @@
 						"miscTags": {
 							"type": "array",
 							"items": {
-								"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
+								"description": "AOE: Has Areas of Effect\n HPR: Has HP Reduction\n MW: Has Weapon Attacks, Melee\n RW: Has Weapon Attacks, Ranged\n RCH: Has Reach Attacks\n MLW: Has Melee Weapons\n RNG: Has Ranged Weapons\n THW: Has Thrown Weapons",
 								"enum": [
 									"AOE",
 									"HPR",
 									"MW",
 									"RW",
 									"RCH",
+									"MLW",
 									"RNG",
 									"THW"
 								]

package/schema/brew/fluff-recipes.json

@@ -1,41 +1,14 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "fluff-recipes.json",
-	"version": "1.1.2",
+	"version": "1.2.0",
 	"type": "object",
 	"properties": {
+		"_meta": {
+			"$ref": "util.json#/$defs/metaBlock"
+		},
 		"recipeFluff": {
-			"type": "array",
-			"minItems": 1,
-			"uniqueItems": true,
-			"items": {
-				"type": "object",
-				"properties": {
-					"name": {
-						"type": "string"
-					},
-					"source": {
-						"$ref": "util.json#/$defs/source"
-					},
-					"images": {
-						"type": "array",
-						"items": {
-							"$ref": "entry.json#/$defs/entryImage"
-						}
-					},
-					"entries": {
-						"type": "array",
-						"items": {
-							"$ref": "entry.json"
-						}
-					}
-				},
-				"required": [
-					"name",
-					"source"
-				],
-				"additionalProperties": false
-			}
+			"$ref": "util.json#/$defs/genericFluffArray"
 		}
 	},
 	"additionalProperties": false

package/schema/brew/recipes.json

@@ -1,10 +1,10 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "recipes.json",
-	"version": "1.3.0",
+	"version": "1.4.0",
 	"type": "object",
 	"$defs": {
-		"recipe": {
+		"recipeData": {
 			"type": "object",
 			"properties": {
 				"name": {
@@ -19,6 +19,9 @@
 				"time": {
 					"type": "object",
 					"properties": {
+						"total": {
+							"$ref": "util-time.json#/$defs/timeMinutes"
+						},
 						"cooking": {
 							"$ref": "util-time.json#/$defs/timeMinutes"
 						},
@@ -178,16 +181,450 @@
 					"$ref": "util.json#/$defs/foundryImg"
 				}
 			},
-			"required": [
-				"name",
-				"source",
-				"instructions",
-				"ingredients"
-			],
 			"additionalProperties": false
+		},
+		"recipe": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"time": {
+							"type": "object",
+							"properties": {
+								"total": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								},
+								"cooking": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								},
+								"preparation": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								}
+							},
+							"additionalProperties": false,
+							"minProperties": 1
+						},
+						"serves": {
+							"oneOf": [
+								{
+									"type": "object",
+									"properties": {
+										"min": {
+											"type": "integer"
+										},
+										"max": {
+											"type": "integer"
+										},
+										"note": {
+											"$ref": "entry.json"
+										}
+									},
+									"required": [
+										"min",
+										"max"
+									],
+									"additionalProperties": false
+								},
+								{
+									"type": "object",
+									"properties": {
+										"exact": {
+											"type": "integer"
+										},
+										"note": {
+											"$ref": "entry.json"
+										}
+									},
+									"required": [
+										"exact"
+									],
+									"additionalProperties": false
+								}
+							]
+						},
+						"makes": {
+							"$ref": "entry.json"
+						},
+						"ingredients": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"equipment": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"instructions": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"noteCook": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"type": {
+							"type": "string",
+							"examples": [
+								"Dwarven",
+								"Elven",
+								"Elixir/Ale",
+								"Human",
+								"Halfling",
+								"Uncommon Cuisine"
+							]
+						},
+						"diet": {
+							"type": "string",
+							"description": "C: Vegetarian [aka \"cheese\"]\n V: Vegan\n X: Omnivorous",
+							"enum": [
+								"C",
+								"V",
+								"X"
+							]
+						},
+						"miscTags": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"enum": [
+									"alcohol"
+								]
+							}
+						},
+						"allergenGroups": {
+							"type": "array",
+							"description": "One of the 14 major food allergens; see https://erudus.com/food-allergens for more information.",
+							"items": {
+								"type": "string",
+								"enum": [
+									"celery",
+									"crustaceans",
+									"eggs",
+									"fish",
+									"gluten",
+									"lupin",
+									"milk",
+									"molluscs",
+									"mustard",
+									"nuts",
+									"peanuts",
+									"sesame",
+									"soya",
+									"sulphites"
+								]
+							}
+						},
+						"dishTypes": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"examples": [
+									"appetizer",
+									"bread",
+									"cocktail",
+									"dessert",
+									"drink",
+									"entree",
+									"pastry",
+									"salad",
+									"side",
+									"snack",
+									"soup"
+								]
+							}
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						},
+						"fluff": {
+							"$ref": "util.json#/$defs/fluffObject"
+						},
+						"foundryImg": {
+							"$ref": "util.json#/$defs/foundryImg"
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"name",
+						"source",
+						"instructions",
+						"ingredients"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"name": {
+							"type": "string"
+						},
+						"source": {
+							"$ref": "util.json#/$defs/source"
+						},
+						"page": {
+							"$ref": "util.json#/$defs/page"
+						},
+						"time": {
+							"type": "object",
+							"properties": {
+								"total": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								},
+								"cooking": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								},
+								"preparation": {
+									"$ref": "util-time.json#/$defs/timeMinutes"
+								}
+							},
+							"additionalProperties": false,
+							"minProperties": 1
+						},
+						"serves": {
+							"oneOf": [
+								{
+									"type": "object",
+									"properties": {
+										"min": {
+											"type": "integer"
+										},
+										"max": {
+											"type": "integer"
+										},
+										"note": {
+											"$ref": "entry.json"
+										}
+									},
+									"required": [
+										"min",
+										"max"
+									],
+									"additionalProperties": false
+								},
+								{
+									"type": "object",
+									"properties": {
+										"exact": {
+											"type": "integer"
+										},
+										"note": {
+											"$ref": "entry.json"
+										}
+									},
+									"required": [
+										"exact"
+									],
+									"additionalProperties": false
+								}
+							]
+						},
+						"makes": {
+							"$ref": "entry.json"
+						},
+						"ingredients": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"equipment": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"instructions": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"noteCook": {
+							"type": "array",
+							"items": {
+								"$ref": "entry.json"
+							}
+						},
+						"type": {
+							"type": "string",
+							"examples": [
+								"Dwarven",
+								"Elven",
+								"Elixir/Ale",
+								"Human",
+								"Halfling",
+								"Uncommon Cuisine"
+							]
+						},
+						"diet": {
+							"type": "string",
+							"description": "C: Vegetarian [aka \"cheese\"]\n V: Vegan\n X: Omnivorous",
+							"enum": [
+								"C",
+								"V",
+								"X"
+							]
+						},
+						"miscTags": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"enum": [
+									"alcohol"
+								]
+							}
+						},
+						"allergenGroups": {
+							"type": "array",
+							"description": "One of the 14 major food allergens; see https://erudus.com/food-allergens for more information.",
+							"items": {
+								"type": "string",
+								"enum": [
+									"celery",
+									"crustaceans",
+									"eggs",
+									"fish",
+									"gluten",
+									"lupin",
+									"milk",
+									"molluscs",
+									"mustard",
+									"nuts",
+									"peanuts",
+									"sesame",
+									"soya",
+									"sulphites"
+								]
+							}
+						},
+						"dishTypes": {
+							"type": "array",
+							"items": {
+								"type": "string",
+								"examples": [
+									"appetizer",
+									"bread",
+									"cocktail",
+									"dessert",
+									"drink",
+									"entree",
+									"pastry",
+									"salad",
+									"side",
+									"snack",
+									"soup"
+								]
+							}
+						},
+						"hasFluff": {
+							"type": "boolean"
+						},
+						"hasFluffImages": {
+							"type": "boolean"
+						},
+						"fluff": {
+							"$ref": "util.json#/$defs/fluffObject"
+						},
+						"foundryImg": {
+							"$ref": "util.json#/$defs/foundryImg"
+						},
+						"_copy": {
+							"type": "object",
+							"properties": {
+								"name": {
+									"type": "string"
+								},
+								"source": {
+									"$ref": "util.json#/$defs/source"
+								},
+								"pantheon": {
+									"description": "Used in deity data",
+									"type": "string"
+								},
+								"shortName": {
+									"description": "Used in subclass data",
+									"type": "string"
+								},
+								"className": {
+									"description": "Used in subclass data",
+									"type": "string"
+								},
+								"classSource": {
+									"description": "Used in subclass data",
+									"$ref": "util.json#/$defs/source"
+								},
+								"raceName": {
+									"description": "Used in race feature data",
+									"type": "string"
+								},
+								"raceSource": {
+									"description": "Used in race feature data",
+									"$ref": "util.json#/$defs/source"
+								},
+								"_mod": {
+									"$ref": "util.json#/$defs/_modObject"
+								},
+								"_trait": {
+									"type": "object",
+									"properties": {
+										"name": {
+											"type": "string"
+										},
+										"source": {
+											"$ref": "util.json#/$defs/source"
+										}
+									},
+									"required": [
+										"name",
+										"source"
+									]
+								},
+								"_preserve": {
+									"type": "object",
+									"patternProperties": {
+										".*": {
+											"const": true
+										}
+									}
+								}
+							},
+							"required": [
+								"name",
+								"source"
+							],
+							"additionalProperties": false
+						}
+					},
+					"additionalProperties": false,
+					"required": [
+						"_copy"
+					]
+				}
+			]
 		}
 	},
 	"properties": {
+		"_meta": {
+			"$ref": "util.json#/$defs/metaBlock"
+		},
 		"recipe": {
 			"type": "array",
 			"uniqueItems": true,

package/schema/brew/spells/spells.json

@@ -1,7 +1,7 @@
 {
 	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"$id": "spells.json",
-	"version": "1.9.7",
+	"version": "1.9.8",
 	"title": "Spells",
 	"type": "object",
 	"$defs": {
@@ -278,13 +278,14 @@
 				},
 				"miscTags": {
 					"type": "array",
-					"description": "AAD: Additional Attack Damage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
+					"description": "AAD: Additional Attack Damage\n ADV: Grants Advantage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
 					"minItems": 1,
 					"uniqueItems": true,
 					"items": {
 						"type": "string",
 						"enum": [
 							"AAD",
+							"ADV",
 							"DFT",
 							"FMV",
 							"HL",
@@ -823,13 +824,14 @@
 						},
 						"miscTags": {
 							"type": "array",
-							"description": "AAD: Additional Attack Damage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
+							"description": "AAD: Additional Attack Damage\n ADV: Grants Advantage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
 							"minItems": 1,
 							"uniqueItems": true,
 							"items": {
 								"type": "string",
 								"enum": [
 									"AAD",
+									"ADV",
 									"DFT",
 									"FMV",
 									"HL",
@@ -1376,13 +1378,14 @@
 						},
 						"miscTags": {
 							"type": "array",
-							"description": "AAD: Additional Attack Damage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
+							"description": "AAD: Additional Attack Damage\n ADV: Grants Advantage\n DFT: Difficult Terrain\n FMV: Forced Movement\n HL: Healing\n LGT: Creates Light\n LGTS: Creates Sunlight\n MAC: Modifies AC\n OBJ: Affects Objects\n OBS: Obscures Vision\n PRM: Permanent Effects\n PS: Plane Shifting\nRO: Rollable Effects\n SCL: Scaling Effects\n  SMN: Summons Creature\n SGT: Requires Sight\n THP: Grants Temporary Hit Points\n TP: Teleportation\n UBA: Uses Bonus Action",
 							"minItems": 1,
 							"uniqueItems": true,
 							"items": {
 								"type": "string",
 								"enum": [
 									"AAD",
+									"ADV",
 									"DFT",
 									"FMV",
 									"HL",