@heroiclands/package-build 22.15.1 → 22.16.0

package/types/sohl/being-info.d.mts

@@ -7,53 +7,13 @@
 export function isBeing(fm: {
     type?: unknown;
 } | null | undefined): boolean;
+/** Shared being type and gear groups used by the SoHL infobox. @module */
 /**
- * Derive a being's info-block fields from its raw `sohl.items[]`.
- *
- * Each item's `shortcode` is resolved against `index` — keyed
- * `"<type>:<shortcode>"` — for a display name and a link to the item's own
- * page. `attributes` already match the sidebar shape and pass through
- * untouched.
- *
- * **Authored values win.** Only fields the author did not supply are derived,
- * so a note that hand-writes `sohl.skills` keeps exactly what it wrote. An
- * item's inline `name` beats the index, and an unresolved shortcode falls back
- * to *itself* rather than being dropped — a page that names an item the index
- * has not heard of is better than a page silently missing a row.
- *
- * Returns a new object; the input is not mutated.
- *
- * @param {object|null|undefined} sohl - The note's `sohl` frontmatter block.
- * @param {Map<string, {name?: string, url?: string}>} index - Content index,
- *   `"<type>:<shortcode>"` → the item's page.
- * @returns {object|null} The block with its info-block fields filled in, or the
- *   input unchanged when there is nothing to derive from — with an absent block
- *   reported as `null`, the value an empty one already carries.
- */
-export function deriveBeingInfo(sohl: object | null | undefined, index: Map<string, {
-    name?: string;
-    url?: string;
-}>): object | null;
-/**
- * The note `type` whose pages carry a being info block.
- *
- * One name: `character` and `creature` are the `being` they
- * had always compiled into. The retired names are deliberately **not** accepted
- * as aliases: they throw elsewhere in the system, and tolerating them here
- * would hide the next drift of this kind rather than surface it.
+ * The note type for a being.
  */
 export const BEING_TYPE: "being";
 /**
- * The sidebar group each gear item type is displayed under.
- *
- * Presentation naming, not data-model naming: the note type says `weapongear`,
- * the sidebar heading says "weapons". Kept as one table so a new gear type is
- * added in a single place rather than in each consumer's site build.
- *
- * Keyed by **note** type, which is what a being's embedded `(type, shortcode)`
- * references spell — and three of those are not the document
- * subtype they compile into. A reference still on a renamed spelling is
- * normalised at the lookup below rather than given a second row here.
+ * The infobox group displayed for each gear note type.
  *
  * @type {Readonly<Record<string, string>>}
  */

package/types/sohl/index.d.mts

@@ -6,4 +6,4 @@ export * as kbPasses from "./kb-passes.mjs";
 export * as infobox from "./infobox.mjs";
 export { AFFILIATION_STANDINGS } from "./affiliation-standings.mjs";
 export { DEFAULT_ITEM_ART, defaultItemArt } from "./default-item-art.mjs";
-export { BEING_TYPE, GEAR_TYPE_TO_KEY, deriveBeingInfo, isBeing } from "./being-info.mjs";
+export { BEING_TYPE, GEAR_TYPE_TO_KEY, isBeing } from "./being-info.mjs";

package/types/sohl/infobox.d.mts

@@ -26,10 +26,13 @@ export function decodeItem(entry: object): {
  * sparse creature's box short rather than mostly empty.
  *
  * @param {object} fm - The note's frontmatter.
- * @param {object} ctx - `{ block, resolve }`.
+ * @param {{block: string, resolve?: Function}} ctx - Rendering context.
  * @returns {object[]} The sections.
  */
-export function beingSections(fm: object, { block, resolve }: object): object[];
+export function beingSections(fm: object, { block, resolve }: {
+    block: string;
+    resolve?: Function;
+}): object[];
 /**
  * Armour's box: whatever the note states, then the protection it gives.
  *

package/types/sohl/item-fields.d.mts

@@ -1,3 +1,7 @@
+/** The strike mode required for combat techniques and omitted for other skills.
+ * @type {import("../engine/field-spec.mjs").FieldSpec}
+ */
+export const COMBAT_TECHNIQUE_STRIKE_MODE: import("../engine/field-spec.mjs").FieldSpec;
 /**
  * Every item type's frontmatter vocabulary, in the order the `system` block
  * emits it.
@@ -13,16 +17,3 @@
  * @type {Readonly<Record<string, readonly import("../engine/field-spec.mjs").FieldSpec[]>>}
  */
 export const ITEM_FIELDS: Readonly<Record<string, readonly import("../engine/field-spec.mjs").FieldSpec[]>>;
-/**
- * The one conditional field in the vocabulary: a combat technique's strike
- * mode.
- *
- * A combat technique is authored as a `skill` of subtype `combattechnique` —
- * the standalone item type was merged into Skill — and carries an embedded,
- * discriminated strike mode. It is mandatory for that subtype and absent from
- * every other skill, which is a conditional a flat field list cannot state, so
- * it is applied after the declaration runs.
- *
- * @type {import("../engine/field-spec.mjs").FieldSpec}
- */
-export const COMBAT_TECHNIQUE_STRIKE_MODE: import("../engine/field-spec.mjs").FieldSpec;

package/types/stage.d.mts

@@ -74,6 +74,15 @@ export function cleanBuildArtifacts(root: string, { extra, includeNodeModules }?
     extra?: readonly string[] | undefined;
     includeNodeModules?: boolean | undefined;
 }): string[];
+/**
+ * Remove the configured Foundry stage before a complete build assembles it.
+ * Other build outputs, including the content index, remain available.
+ *
+ * @param {string} root - Repository root.
+ * @param {string} stageDir - Configured stage directory, relative to root.
+ * @returns {boolean} Whether the stage existed.
+ */
+export function resetStage(root: string, stageDir: string): boolean;
 /**
  * Directories every HeroicLands repository regenerates and none commits.
  *