@heroiclands/package-build 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,84 @@
 # @heroiclands/package-build
 
+## 3.4.0
+
+### Minor Changes
+
+- 19df269: Stop emitting `assocMysteryCode` on a compiled mystical ability (#35).
+  
+  The `mysticalability` declaration named a field no SoHL DataModel receives.
+  `MysticalAbilityDataModel` declares `subType`, `assocSkillCode`,
+  `assocAffiliationCode`, `masteryLevelBase`, `improveFlag`, `levelBase` and
+  `charges`, and nothing else — Foundry discards the extra key when the document
+  is constructed, so every mystical ability in every consuming pack shipped a
+  value that was thrown away at load, with nothing at compile or load time saying
+  so.
+  
+  This is the exact inverse of #3 and has the same root cause: nothing compares a
+  builder's emitted `system` block against the DataModel that receives it. #3 was a
+  declared field the builder failed to emit; this is an emitted field the DataModel
+  never declares. Both compile clean, both lose data silently, and an author cannot
+  tell either from a correct build. The general check is #60.
+  
+  **The field was retired, not renamed.**
+  Song-of-Heroic-Lands-FoundryVTT#973 deleted `assocMysteryCode` because nothing in
+  production read the mystery it resolved to; #1012 later added
+  `assocAffiliationCode` as a separate concept — the faction whose standing confers
+  the ability. They look alike and mean different things, so the declaration is
+  dropped rather than retargeted.
+  
+  **This changes emitted documents**, so a consumer wants a rebuild rather than a
+  silent upgrade — though nothing downstream can have depended on the value:
+  
+  - `sohl` — nine notes authored the key, all of them blank. Corrected in
+    Song-of-Heroic-Lands-FoundryVTT#1747.
+  - `sohl-kethira-basic` — no note authors it; all 224 mystical abilities carried
+    the builder's own `""`. Recompiling `main` with this change removes exactly
+    those 224 lines and touches nothing else.
+- dced8b2: Write the derived package into an emitted page's frontmatter (#65).
+  
+  `content-build site` copied a note's frontmatter to the page verbatim. Since
+  3.3.0 a note need not declare `package:` — it is derived from the configured
+  `contentPackage` — and `engine/site-build.mjs` resolved that value one line
+  before it built the page, carrying it for the index, the table universe and the
+  local-package set. It never reached the page's own frontmatter, so a swept tree
+  published pages that said nothing about which package they belong to.
+  
+  **The visible symptom is the breadcrumb.**
+  `@heroiclands/hugo-theme`'s `layouts/partials/breadcrumbs.html` reads
+  `{{ $pkg := .Params.package | default "" }}` and builds the middle crumb from
+  it. With no `package` the section is never resolved and the crumb degrades from
+  a linked, labelled section to a bare, unlinked type slug:
+  
+  ```text
+  before: Home > SoHL Affliction > Aconite   (linked)
+  after:  Home > affliction       > Aconite   (bare)
+  ```
+  
+  Consumer layouts reading the field directly degrade the same way — a `package`
+  column renders blank.
+  
+  The fix is where the value was already known: `pageFrontmatter` spreads
+  `package` after the note's own frontmatter, so a note that declares the field
+  keeps its authored position and value and an unswept tree emits byte-identically,
+  while a swept one regains the line it lost. The alternative — teaching every
+  theme and consumer layout to default the package from a site parameter — pushes
+  a fact the build already knows out to N consumers, and the theme deliberately
+  carries no addresses.
+  
+  **This changes emitted output**, so a consumer wants a rebuild rather than a
+  silent upgrade, which is why it is a minor rather than a patch — the same
+  reasoning as #35. Verified against the swept `sohl` tree: 1,606 emitted content
+  pages differ, none added or removed, and the only diff line class across the
+  whole tree is the restored `package: sohl`. Rendering that tree, 1,600 pages
+  differ and in exactly two ways — the breadcrumb's middle crumb, and a `package`
+  column that was blank.
+  
+  `sohl-thalorna` has the same defect independently, in its own
+  `utils/build-site-content.mjs`, and is fixed in that repository
+  (sohl-thalorna#79) — two emitters, one behaviour, which is a second argument
+  for #36.
+
 ## 3.3.0
 
 ### Minor Changes

package/engine/site-build.mjs

@@ -367,6 +367,16 @@ export function tableUniverse(pages) {
  * redirect stub at each name. They are dropped, and this build emits no
  * redirects of its own.
  *
+ * A content page carries the package the build **derived**, whether or not the
+ * note declared one (#65). `package:` became optional in 3.3.0, so a swept tree
+ * declares none — and the note's frontmatter alone would then publish a page
+ * that does not say which package it belongs to. The emitted page is what a
+ * theme reads: `breadcrumbs.html` builds its middle crumb from
+ * `.Params.package`, so without it that crumb degrades from a linked, labelled
+ * section to a bare type slug. Writing the derived value keeps a page
+ * self-describing and makes sweeping the field out of a content tree
+ * output-preserving for a site as it already is for the packs.
+ *
  * @param {object} page - The page.
  * @param {object} options - `{ sections, readmeSections, decorate }`.
  * @returns {object} The frontmatter to write.
@@ -375,7 +385,17 @@ export function pageFrontmatter(page, { readmeSections = {}, decorate }) {
     const { fm, name, slug, sec, isReadme } = page;
     let data;
     if (page.kind === "content") {
-        data = { ...fm, slug, title: fm.title ?? name, kbfolder: page.folder };
+        data = {
+            ...fm,
+            // Spread after the note's own frontmatter, so a note that declares
+            // the field keeps its authored position and value and an unswept
+            // tree emits byte-identically. Guarded because `package: undefined`
+            // is not a value YAML can carry.
+            ...(page.pkg ? { package: page.pkg } : {}),
+            slug,
+            title: fm.title ?? name,
+            kbfolder: page.folder,
+        };
         if (decorate) decorate(data, page);
         if (isReadme) {
             const meta = readmeSections[sec];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@heroiclands/package-build",
-    "version": "3.3.0",
+    "version": "3.4.0",
     "description": "Shared toolchain for building and shipping a HeroicLands Foundry VTT package — content compilation, manifest, localization, staging, bundle, release and deployment.",
     "license": "GPL-3.0-or-later",
     "type": "module",

package/sohl/item-fields.mjs

@@ -598,14 +598,6 @@ export const ITEM_FIELDS = Object.freeze({
             describe:
                 "Shortcode of the affiliation whose standing confers the ability — a religion, school, or ancestor/totem/spirit.",
         },
-        {
-            name: "assocMysteryCode",
-            to: "assocMysteryCode",
-            ref: "mystery",
-            ...AS_AUTHORED,
-            default: "",
-            describe: "Shortcode of the mystery the ability draws on.",
-        },
         {
             name: "masteryLevelBase",
             to: "masteryLevelBase",

package/types/engine/site-build.d.mts

@@ -84,6 +84,16 @@ export function tableUniverse(pages: object[]): Map<string, object[]>;
  * redirect stub at each name. They are dropped, and this build emits no
  * redirects of its own.
  *
+ * A content page carries the package the build **derived**, whether or not the
+ * note declared one (#65). `package:` became optional in 3.3.0, so a swept tree
+ * declares none — and the note's frontmatter alone would then publish a page
+ * that does not say which package it belongs to. The emitted page is what a
+ * theme reads: `breadcrumbs.html` builds its middle crumb from
+ * `.Params.package`, so without it that crumb degrades from a linked, labelled
+ * section to a bare type slug. Writing the derived value keeps a page
+ * self-describing and makes sweeping the field out of a content tree
+ * output-preserving for a site as it already is for the packs.
+ *
  * @param {object} page - The page.
  * @param {object} options - `{ sections, readmeSections, decorate }`.
  * @returns {object} The frontmatter to write.