Fix JSON Schema (#10)

* refine exports

* reduce unwanted ‘example’ suggestions

* prune

* improve compat

Author: OllieJT

packages/forge-helpers/src/files/get-version.ts

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 
 /**
  * Retrieves the JSON content of a schema file.
- * @param relativeFilePath - The relative path to the JSON schema file (e.g., "0.0.0/core.json").
+ * @param relativeFilePath - The relative path to the JSON schema file (e.g., "0.0.0/ruleset.json").
  * @returns The parsed JSON content of the file.
  * @throws Will throw an error if the file cannot be read or parsed.
  */

packages/forge-schema/scripts/generate-json-schema.ts

@@ -1,27 +1,45 @@
 import path from "node:path";
 import { z } from "zod/v4";
-// import { jsonCollection } from "../src/json-collection.js";
-import { characterDocument } from "../src/models/doc-character.js";
-import { campaignRuleset } from "../src/models/ruleset-campaign.js";
-import { coreRuleset } from "../src/models/ruleset-core.js";
+import { campaign } from "../src/models/campaign.js";
+import { character } from "../src/models/character.js";
+import { ruleset } from "../src/models/ruleset.js";
 
-const characterDocumentSchema = z.toJSONSchema(characterDocument, {
-	reused: "ref",
-});
-const campaignRulesetSchema = z.toJSONSchema(campaignRuleset, {
-	reused: "ref",
-});
-const coreRulesetSchema = z.toJSONSchema(coreRuleset, { reused: "ref" });
-
-const defaultSchema = z.toJSONSchema(z.globalRegistry, {
-	target: "draft-2020-12",
-	unrepresentable: "throw",
-	cycles: "throw",
-	reused: "ref",
-	override(ctx) {
-		ctx.jsonSchema.$id = ctx.jsonSchema.id;
+// Compose schema data and filenames
+const schemas = [
+	{
+		filename: "character.json",
+		data: z.toJSONSchema(character, {
+			unrepresentable: "throw",
+			cycles: "throw",
+			reused: "ref",
+			override(ctx) {
+				ctx.jsonSchema.$id = ctx.jsonSchema.id;
+			},
+		}),
+	},
+	{
+		filename: "campaign.json",
+		data: z.toJSONSchema(campaign, {
+			unrepresentable: "throw",
+			cycles: "throw",
+			reused: "ref",
+			override(ctx) {
+				ctx.jsonSchema.$id = ctx.jsonSchema.id;
+			},
+		}),
 	},
-});
+	{
+		filename: "ruleset.json",
+		data: z.toJSONSchema(ruleset, {
+			unrepresentable: "throw",
+			cycles: "throw",
+			reused: "ref",
+			override(ctx) {
+				ctx.jsonSchema.$id = ctx.jsonSchema.id;
+			},
+		}),
+	},
+];
 
 /**
  * Returns the version value from the package.json
@@ -65,14 +83,6 @@ const generateSchemas = async (): Promise<void> => {
 
 	const directory = await useDirectory(version);
 
-	// Compose schema data and filenames
-	const schemas = [
-		{ data: characterDocumentSchema, filename: "document-character.json" },
-		{ data: campaignRulesetSchema, filename: "ruleset-campaign.json" },
-		{ data: coreRulesetSchema, filename: "ruleset-core.json" },
-		{ data: defaultSchema, filename: "schema.json" },
-	];
-
 	// Dynamically import fs/promises for ESM compatibility
 	const { writeFile } = await import("node:fs/promises");
 

packages/forge-schema/src/models/artifact/ancestry.ts

@@ -12,33 +12,9 @@ export const ancestry = z
 	.meta({
 		title: "Ancestry",
 		description: "The ancestry of a character",
-		examples: [
-			{
-				_type: "ancestry",
-				name: "Ribbet",
-				description:
-					"Ribbets resemble anthropomorphic frogs with protruding eyes, and webbed hands and feet.",
-				primaryFeature: {
-					name: "Amphibious",
-					description: "You can breathe and move naturally under water.",
-				},
-				secondaryFeature: {
-					name: "Long Tounge",
-					description:
-						"You can use your long tounge to grab onto things within close range. Mark a stress to use your tounge as a finesse close weapon that deals d12 physical damage using your proficiency.",
-				},
-			},
-		],
 	});
 
 export const ancestryReference = createReference("heritage/ancestry").meta({
 	id: "ReferenceAncestry",
 	title: "Reference to an Ancestry",
-	examples: [
-		{
-			_type: "reference",
-			_key: "heritage/ancestry",
-			value: "ribbet",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/community.ts

@@ -15,29 +15,9 @@ export const community = z
 		id: "Community",
 		title: "Community",
 		description: "A community that shaped a characters backstory",
-		examples: [
-			{
-				_type: "community",
-				name: "Highborn",
-				description:
-					"Being part of a highborn community means you're accustomed to a life of elegance, opulence, and prestige within the upper echelons of society.",
-				feature: {
-					name: "Privilege",
-					description:
-						"You have advantage on rolls to consort with nobles, negotiate prices, or leverage your reputation to get what you want.",
-				},
-			},
-		],
 	});
 
 export const communityReference = createReference("heritage/community").meta({
 	id: "ReferenceCommunity",
 	title: "Reference to a Community",
-	examples: [
-		{
-			_type: "reference",
-			_key: "heritage/community",
-			value: "highborn",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/domain.ts

@@ -11,24 +11,9 @@ export const domain = z
 		id: "Domain",
 		title: "Domain",
 		description: "A domain of a character class",
-		examples: [
-			{
-				_type: "domain",
-				name: "Arcana",
-				description:
-					"Arcana is the domain of innate and instinctual magic. Those who choose this path tap into the raw, enigmatic forces of the realms to manipulate both their own energy and the elements. Arcana offers wielders a volatile power, but it is incredibly potent when correctly channeled. The Arcana domain can be accessed by the Druid and Sorcerer classes.",
-			},
-		],
 	});
 
 export const domainReference = createReference("role/domain").meta({
 	id: "ReferenceDomain",
 	title: "Reference to a Domain",
-	examples: [
-		{
-			_type: "reference",
-			_key: "role/domain",
-			value: "arcana",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/inventory-armor.ts

@@ -15,30 +15,9 @@ export const inventoryArmor = z
 		id: "Armor",
 		title: "Armor",
 		description: "A set of armor that can be equipped by a character",
-		examples: [
-			{
-				_type: "inventoryArmor",
-				name: "Full Plate Armor",
-				description: null,
-				baseThresholds: {
-					_type: "damageThresholds",
-					major: 8,
-					severe: 17,
-				},
-				baseScore: 4,
-				features: ["Very Heavy: -2 to Evasion"],
-			},
-		],
 	});
 
 export const inventoryArmorReference = createReference("item/armor").meta({
 	id: "ReferenceArmor",
 	title: "Reference to a piece of Armor",
-	examples: [
-		{
-			_type: "reference",
-			_key: "item/armor",
-			value: "full-plate-armor",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/inventory-thing.ts

@@ -11,23 +11,9 @@ export const inventoryThing = z
 		id: "Thing",
 		title: "Thing",
 		description: "A thing that can be added to a character's inventory",
-		examples: [
-			{
-				_type: "inventoryThing",
-				name: "Suspicious looking potion",
-				description: "The label is written in a language you don't recognize.",
-			},
-		],
 	});
 
 export const inventoryThingReference = createReference("item/thing").meta({
 	id: "ReferenceThing",
 	title: "Reference to a Thing",
-	examples: [
-		{
-			_type: "reference",
-			_key: "item/thing",
-			value: "suspicious-looking-potion",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/inventory-weapon.ts

@@ -20,28 +20,9 @@ export const inventoryWeapon = z
 		id: "Weapon",
 		title: "Weapon",
 		description: "A weapon that can be equipped by a character",
-		examples: [
-			{
-				_type: "inventoryWeapon",
-				name: "Warhammer",
-				trait: "Strength",
-				range: "Melee",
-				damageDice: "d8",
-				damageType: "Physical",
-				features: ["Versatile"],
-				burden: "One-Handed",
-			},
-		],
 	});
 
 export const inventoryWeaponReference = createReference("item/weapon").meta({
 	id: "ReferenceWeapon",
 	title: "Reference to a Weapon",
-	examples: [
-		{
-			_type: "reference",
-			_key: "item/weapon",
-			value: "warhammer",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/role-class.ts

@@ -34,50 +34,9 @@ export const roleClass = z
 		id: "Class",
 		title: "Class",
 		description: "A class of a character",
-		examples: [
-			{
-				_type: "class",
-				name: "Barbarian",
-				domain: {
-					_type: "reference",
-					_key: "role/domain",
-					value: "arcana",
-				},
-				initialEvasion: 10,
-				initialHitPoints: 5,
-				initialInventory: [
-					{
-						_type: "inventoryThing",
-						name: "A romance novel or a letter never opened",
-						description: null,
-					},
-				],
-				features: [
-					{
-						name: "Rally",
-						description:
-							"Once per session, describe how you rally the party and give yourself and each of your allies a Rally Die. At level 1, your Rally Die is a d6. A PC can spend their Rally Die to roll it, adding the result to their action roll, reaction roll, damage roll, or to clear a number of Stress equal to the result. At the end of each session, clear all unspent Rally Dice. At level 5, your Rally Die increases to a d8.",
-					},
-				],
-				hopeFeature: {
-					name: "Make a Scene",
-					description:
-						"Spend 3 Hope to temporarily Distract a target within Close range, giving them a -2 penalty to their Difficulty.",
-				},
-
-				subclasses: [],
-			},
-		],
 	});
 
 export const roleClassReference = createReference("role/class").meta({
 	id: "ReferenceClass",
 	title: "Reference to a Class",
-	examples: [
-		{
-			_type: "reference",
-			_key: "role/class",
-			value: "barbarian",
-		},
-	],
 });

packages/forge-schema/src/models/artifact/role-subclass.ts

@@ -18,60 +18,9 @@ export const roleSubclass = z
 		id: "Subclass",
 		title: "Subclass",
 		description: "A subclass of a class",
-		examples: [
-			{
-				_type: "subclass",
-				name: "Troubadour",
-				description:
-					"Play the Troubadour if you want to play music to bolster your allies.",
-				spellTrait: "Presence",
-
-				foundationFeatures: [
-					{
-						_type: "feature",
-						name: "Gifted Performer",
-						description:
-							"You can play three different types of songs, once each per long rest; describe how you perform for others to gain the listed benefit:",
-						notes: [
-							"Relaxing Song: You and all allies within Close range clear a Hit Point.",
-							"Epic Song: Make a target within Close range temporarily Vulnerable.",
-							"Heartbreaking Song: You and all allies within Close range gain a Hope.",
-						],
-						modifiers: null,
-					},
-				],
-				specializationFeatures: [
-					{
-						_type: "feature",
-						name: "Maestro",
-						description:
-							"Your rallying songs steel the courage of those who listen. When you give a Rally Die to an ally, they can gain a Hope or clear a Stress.",
-						notes: null,
-						modifiers: null,
-					},
-				],
-				masteryFeatures: [
-					{
-						_type: "feature",
-						name: "Virtuoso",
-						description:
-							"You are among the greatest of your craft and your skill is boundless. You can perform each of your “Gifted Performer” feature’s songs twice per long rest.",
-						notes: null,
-						modifiers: null,
-					},
-				],
-			},
-		],
 	});
 
 export const roleSubclassReference = createReference("role/subclass").meta({
 	id: "ReferenceSubclass",
 	title: "Reference to a Subclass",
-	examples: [
-		{
-			_type: "reference",
-			_key: "role/subclass",
-			value: "troubadour",
-		},
-	],
 });