@heroiclands/package-build 22.12.3 → 22.13.1

package/engine/metadata-index.mjs

@@ -54,7 +54,12 @@ import { metadataFileName, PACKAGEBUILD_PACKAGE } from "./packages.mjs";
 import { packageBuildRecords } from "./packagebuild-index.mjs";
 
 export { metadataFileName };
-import { PACKAGE_BASE, readCanonicalKey, resolvePackageUrl } from "./content-address.mjs";
+import {
+    PACKAGE_BASE,
+    canonicalKey,
+    readCanonicalKey,
+    resolvePackageUrl,
+} from "./content-address.mjs";
 import { HOMEPAGE_TYPE } from "./homepage.mjs";
 
 /**
@@ -369,11 +374,23 @@ export function loadForeignIndexes(config, localPackages, bases = PACKAGE_BASE)
                 error.position = line >= 0 ? { line: line + 1 } : {};
                 throw error;
             }
-            referenceRecords.push(record);
-            const key = encodeAddresses(record?.address?.canonical);
+            let key = encodeAddresses(record?.address?.canonical);
             if (!key) continue;
-            const parts = readCanonicalKey(key);
+            let parts = readCanonicalKey(key);
             if (!parts) continue;
+            if (
+                parts.system === "none" &&
+                record.documents &&
+                parts.type.startsWith("doc") &&
+                record.type === parts.type
+            ) {
+                record.type = parts.type.slice(3);
+                key = canonicalKey(parts.package, "note", record.type, parts.shortcode);
+                parts = readCanonicalKey(key);
+                record.foundry = { note: record.foundry?.none };
+                record.address.canonical = key;
+            }
+            referenceRecords.push(record);
             // First writer wins, so two packages claiming one address cannot
             // make the build depend on the order the cache was read in.
             if (index.has(key)) continue;
@@ -436,11 +453,11 @@ export function loadForeignIndexes(config, localPackages, bases = PACKAGE_BASE)
             if (entry.url) {
                 const identity = completeAddress({
                     package: record.package,
-                    system: "none",
+                    system: "note",
                     type: record.type,
                     shortcode: record.shortcode,
                 });
-                if (identity.type !== record.type)
+                if (key !== renderAddress(identity))
                     pageAliases.push([
                         renderAddress(identity),
                         {

package/engine/note-addresses.mjs

@@ -24,7 +24,13 @@ export { AddressEntries, encodeAddresses, cloneAddressState } from "./address-va
 
 /** Structured positions whose Address is nested inside a declared container. */
 export const STRUCTURED_ADDRESSES = Object.freeze([
-    { path: ["packFolder"], shape: "scalar-or-map", type: "folder", accepts: ["folder"] },
+    {
+        path: ["packFolder"],
+        shape: "scalar-or-map",
+        type: "folder",
+        accepts: ["folder"],
+        system: "none",
+    },
     {
         noteType: "affiliation",
         path: ["data", "governance", "ranks", "*", "lore"],
@@ -67,6 +73,9 @@ export function addressPositions(fm, context = {}) {
                 shape,
                 type: field.ref,
                 accepts: field.accepts,
+                ...(ASSET_TYPE_NAMES.has(field.ref) || field.ref === "folder" ?
+                    { system: "none" }
+                :   {}),
             });
     }
     out.push(...STRUCTURED_ADDRESSES.filter((p) => !p.noteType || p.noteType === fm.type));
@@ -79,7 +88,7 @@ export function addressPositions(fm, context = {}) {
             shape: "scalar-or-map",
             type: "folder",
             accepts: ["folder"],
-            system,
+            system: "none",
         });
         out.push({
             path: [system, "items", "*", "model"],
@@ -93,7 +102,7 @@ export function addressPositions(fm, context = {}) {
                 shape: "value",
                 type: slot.type,
                 accepts: slot.accepts,
-                system,
+                system: "none",
             });
         const spec = context.systemBlocks?.[system];
         for (const [index, entry] of (Array.isArray(fm[system]?.items) ?
@@ -121,7 +130,13 @@ export function addressPositions(fm, context = {}) {
                         field.address.holds === "items" ? "list" : (field.address.holds ?? "value"),
                     type: field.address.type,
                     accepts: field.address.accepts,
-                    system,
+                    system:
+                        (
+                            ASSET_TYPE_NAMES.has(field.address.type) ||
+                            field.address.type === "folder"
+                        ) ?
+                            "none"
+                        :   system,
                 });
             }
         }
@@ -135,7 +150,10 @@ export function addressPositions(fm, context = {}) {
                 shape: field.address.holds === "items" ? "list" : (field.address.holds ?? "value"),
                 type: field.address.type,
                 accepts: field.address.accepts,
-                system,
+                system:
+                    ASSET_TYPE_NAMES.has(field.address.type) || field.address.type === "folder" ?
+                        "none"
+                    :   system,
             };
             out.push({ ...position, path: [system, "system", ...field.to.split(".")] });
             out.push({
@@ -143,7 +161,7 @@ export function addressPositions(fm, context = {}) {
                 path: [system, ...(field.legacyKey ?? field.name).split(".")],
             });
             if (field.name?.startsWith("data.") && field.topLevelMeans === undefined)
-                out.push({ ...position, system: "none", path: field.name.slice(5).split(".") });
+                out.push({ ...position, path: field.name.slice(5).split(".") });
         }
     }
     for (const position of [...out]) {
@@ -171,7 +189,7 @@ export function decodeNoteAddresses(fm, context) {
         const defaults = {
             ...context,
             types,
-            system: position.system ?? context.system ?? "none",
+            system: position.system ?? context.system ?? "note",
             type: position.type,
         };
         const fail = (value, path, description) => {
@@ -277,7 +295,7 @@ export function noteAddressContext(config) {
     }
     return {
         package: config.contentPackage,
-        system: "none",
+        system: "note",
         systemBlocks,
     };
 }
@@ -313,7 +331,7 @@ export function decodeIndexAddresses(record, context) {
             written,
             {
                 ...context,
-                system: "none",
+                system: "note",
                 types: new Set([...Object.keys(NOTE_VOCABULARY), ...ASSET_TYPE_NAMES]),
             },
             { declared: true },

package/engine/note-ids.mjs

@@ -44,6 +44,9 @@ import { documentId } from "./content-address.mjs";
 import { systemOf } from "./document-subtypes.mjs";
 import { contentPackage } from "./content-package.mjs";
 import { KNOWN_DOCUMENT_SUBTYPE_MAPS } from "./subtype-registry.mjs";
+import { JOURNAL_TYPES } from "./ids.mjs";
+import { NOTE_SYSTEM } from "./systems.mjs";
+import { HOMEPAGE_TYPE } from "./homepage.mjs";
 // The folder id's derivation, taken from the pass that owns it rather than
 // restated here — see the `folder` branch below. `folder-notes.mjs` reaches
 // only `content-address`, `address-charset`, `ids` and `retired-fields`, none
@@ -102,7 +105,7 @@ function text(value) {
  */
 export function noteDocId(fm, { pkg, maps = KNOWN_DOCUMENT_SUBTYPE_MAPS } = {}) {
     if (!fm || typeof fm !== "object") return undefined;
-    const pinned = text(fm.id);
+    const pinned = text(fm.data?.id) ?? text(fm.id);
     if (pinned) return pinned;
     const type = text(fm.type);
     const shortcode = text(fm.shortcode);
@@ -112,7 +115,9 @@ export function noteDocId(fm, { pkg, maps = KNOWN_DOCUMENT_SUBTYPE_MAPS } = {})
     // the two must answer alike about the same note or the divergence this
     // branch closes reopens under a capitalised `type: Folder`.
     if (type.toLowerCase() === FOLDER_TYPE) return folderDocId(owner, shortcode);
-    return documentId(owner, systemOf(type, maps), type, shortcode);
+    const system =
+        JOURNAL_TYPES.has(type) || type === HOMEPAGE_TYPE ? NOTE_SYSTEM : systemOf(type, maps);
+    return documentId(owner, system, type, shortcode);
 }
 
 /**

package/engine/note-vocabulary.mjs

@@ -277,6 +277,29 @@ const TOKEN_ICON = Object.freeze({
  * @type {readonly DataFieldSpec[]}
  */
 export const SHARED_DATA_FIELDS = Object.freeze([
+    Object.freeze({
+        name: "id",
+        ...TEXT,
+        describe: "A fixed document identity when the derived identity is unsuitable.",
+    }),
+    Object.freeze({
+        name: "pack",
+        ...TEXT,
+        describe: "The shared compendium route, with a system block overriding it.",
+    }),
+    Object.freeze({
+        name: "packFolder",
+        ...LINK_BY_PACK,
+        ref: "folder",
+        accepts: ["folder"],
+        describe: "The shared compendium folder Address, with a system block overriding it.",
+    }),
+    Object.freeze({
+        name: "harnworld",
+        shape: "map",
+        kind: "map",
+        describe: "HârnWorld source details shared by every system.",
+    }),
     Object.freeze({
         name: "icon",
         ...LINK,
@@ -605,6 +628,7 @@ export const NOTE_VOCABULARY = Object.freeze({
         // package's declared present compute — see `engine/being-age.mjs`.
         check: checkBeingAge,
         data: Object.freeze([
+            { name: "social", shape: "map", kind: "map", describe: "The being's social profile." },
             TOKEN_ICON,
             TEMPLATE_PRIORITY,
             { name: "archetypes", ...LIST, describe: "Archetypal behaviours the being fits." },

package/engine/pack-router.mjs

@@ -82,7 +82,7 @@
 
 import { NO_PACK, packForType } from "./ids.mjs";
 import { loadPackConfig } from "./pack-config.mjs";
-import { blockProperty, systemBlock } from "./system-block.mjs";
+import { blockDataProperty, systemBlock } from "./system-block.mjs";
 
 /**
  * A note that cannot be routed to a pack. Thrown rather than returned so no
@@ -131,7 +131,9 @@ export { NO_PACK };
  */
 export function declaresNoPack(fm, system) {
     const declared =
-        system === undefined ? fm?.[PACK_FIELD] : blockProperty(fm, system, PACK_FIELD);
+        system === undefined ?
+            (fm?.data?.[PACK_FIELD] ?? fm?.[PACK_FIELD])
+        :   blockDataProperty(fm, system, PACK_FIELD);
     return declared === NO_PACK;
 }
 
@@ -270,7 +272,9 @@ export function createPackRouter(packs) {
         const inBlock = system === undefined ? undefined : systemBlock(fm, system)?.[PACK_FIELD];
         const authoredInBlock = inBlock != null && inBlock !== "";
         let declared =
-            system === undefined ? fm?.[PACK_FIELD] : blockProperty(fm, system, PACK_FIELD);
+            system === undefined ?
+                (fm?.data?.[PACK_FIELD] ?? fm?.[PACK_FIELD])
+            :   blockDataProperty(fm, system, PACK_FIELD);
         // The declaration names where the note's *own* document goes. A pass
         // writing a document derived from it — an item's prose becoming a
         // JournalEntry — is not what the author was addressing.

package/engine/place-relations.mjs

@@ -67,7 +67,7 @@ import { encodeAddresses } from "./address-values.mjs";
 
 import { positionOfFrontmatterPath } from "./diagnostics.mjs";
 import { acceptsType, parseAddress, renderAddress } from "./address.mjs";
-import { NO_SYSTEM } from "./document-subtypes.mjs";
+import { NOTE_SYSTEM } from "./systems.mjs";
 
 /* --------------------------------------------------------------------- */
 /*  The closed sets                                                       */
@@ -232,7 +232,7 @@ function addressDefaults(index) {
         packages: index?.packages,
         noIndexPackages: index?.noIndexPackages,
         package: index?.contentPackage,
-        system: NO_SYSTEM,
+        system: NOTE_SYSTEM,
         type: RELATION_TYPE,
     };
 }
@@ -356,7 +356,7 @@ function checkRelation(note, { field, index }) {
         here.package && self ?
             renderAddress({
                 package: here.package,
-                system: NO_SYSTEM,
+                system: NOTE_SYSTEM,
                 type: RELATION_TYPE,
                 shortcode: self,
             })
@@ -425,7 +425,7 @@ function checkRelation(note, { field, index }) {
                 "to",
                 `${label(i, "to")} must name a place — the other place's \`shortcode\`, or ` +
                     `its address as \`${RELATION_TYPE}-<shortcode>\` or ` +
-                    `\`<package>-${NO_SYSTEM}-${RELATION_TYPE}-<shortcode>\` for a place in ` +
+                    `\`<package>-${NOTE_SYSTEM}-${RELATION_TYPE}-<shortcode>\` for a place in ` +
                     `another package — but reads ${JSON.stringify(encodeAddresses(to))}`,
             );
         } else if (!acceptsType(read, [RELATION_TYPE])) {

package/engine/reference-targets.mjs

@@ -4,9 +4,10 @@
  * SPDX-License-Identifier: GPL-3.0-or-later
  */
 
-import { completeAddress, renderAddress } from "./address.mjs";
-import { systemOf } from "./document-subtypes.mjs";
-import { KNOWN_DOCUMENT_SUBTYPE_MAPS } from "./subtype-registry.mjs";
+import { completeAddress, ownDocumentSystem, renderAddress } from "./address.mjs";
+import { NOTE_SYSTEM } from "./systems.mjs";
+import { JOURNAL_TYPES } from "./ids.mjs";
+import { hasDocEntry } from "./item-docs.mjs";
 
 /**
  * Names and published destinations for reference presentation.
@@ -21,10 +22,9 @@ export function buildReferenceTargets(records, published = new Map()) {
     for (const record of records) {
         if (!record.package || !record.type || !record.shortcode) continue;
         const value = { name: record.name?.full ?? record.name, subType: record.subType };
-        for (const system of new Set([
-            systemOf(record.type, KNOWN_DOCUMENT_SUBTYPE_MAPS),
-            "none",
-        ])) {
+        const systems = new Set([ownDocumentSystem(record.type)]);
+        if (JOURNAL_TYPES.has(record.type) || hasDocEntry(record.type)) systems.add(NOTE_SYSTEM);
+        for (const system of systems) {
             const address = completeAddress({
                 package: record.package,
                 system,

package/engine/shortcode-references.mjs

@@ -52,7 +52,7 @@ export function resolveShortcodeReference(indexes, code, hint) {
     const { address: native, value } = matches.values().next().value;
     const address = completeAddress({
         package: native.package,
-        system: "none",
+        system: "note",
         type: native.type,
         shortcode: native.shortcode,
     });

package/engine/site-index.mjs

@@ -61,12 +61,9 @@ import {
     parseAddress,
     renderAddress,
     isAddressTuple,
-    completeAddress,
+    ownDocumentSystem,
 } from "./address.mjs";
-import { NO_SYSTEM } from "./systems.mjs";
-import { systemOf } from "./document-subtypes.mjs";
-import { KNOWN_DOCUMENT_SUBTYPE_MAPS } from "./note-claims.mjs";
-import { hasDocEntry } from "./item-docs.mjs";
+import { NOTE_SYSTEM } from "./systems.mjs";
 import { contentPackage } from "./content-package.mjs";
 // The declared tag vocabulary, which is where `draft` is stated.
 import { isDraftNote } from "./note-vocabulary.mjs";
@@ -241,42 +238,14 @@ export function buildSiteIndex(
             // resolves it and records it as `pkg`. Never read out of
             // frontmatter: `package:` is retired.
             index.set(
-                canonicalKey(
-                    e.pkg ?? ownPackage,
-                    systemOf(type, KNOWN_DOCUMENT_SUBTYPE_MAPS),
-                    type,
-                    shortcode,
-                ),
+                canonicalKey(e.pkg ?? ownPackage, ownDocumentSystem(type), type, shortcode),
                 value,
             );
             if (e.pkg) packages.add(e.pkg);
-            // In Foundry an item and its documentation are two documents, so
-            // `skill/wpnc` and `docskill/wpnc` are two UUIDs. Here the
-            // item note renders as one page which *is* its documentation, so
-            // the two qualifiers alias one URL and an anchor on either is an
-            // ordinary in-page anchor. One authored link, correct in both
-            // builds — restricted to the types that actually have an item doc,
-            // so a qualifier the packs would reject is reported broken here too.
-            const proseAddress = completeAddress({
-                package: e.pkg ?? ownPackage,
-                system: NO_SYSTEM,
-                type,
-                shortcode,
-            });
-            if (proseAddress.type !== type || hasDocEntry(type)) {
-                contentTypes.add(`doc${type}`);
-                index.set(`doc${type}/${shortcode}`.toLowerCase(), value);
-                // The canonical documentation address too, so the page answers
-                // to the address a bare prose link expands to: body
-                // prose is under no system block, so it defaults to `none`, and
-                // a system-bearing type's `none` address is its `doc<type>`
-                // one. In Foundry that names a second document; here it names
-                // this same page, which is what makes one authored link correct
-                // in both builds.
-                index.set(
-                    canonicalKey(e.pkg ?? ownPackage, NO_SYSTEM, `doc${type}`, shortcode),
-                    value,
-                );
+            // A web page is the readable `note` target for every type.
+            if (ownDocumentSystem(type) !== NOTE_SYSTEM) {
+                // The same page answers to its readable Address.
+                index.set(canonicalKey(e.pkg ?? ownPackage, NOTE_SYSTEM, type, shortcode), value);
             }
         }
     }
@@ -375,7 +344,7 @@ export function resolveInfoboxRef(siteIndex, ref, hint) {
     }
     const context = {
         package: siteIndex.contentPackage ?? contentPackage(),
-        system: "none",
+        system: "note",
         types: siteIndex.contentTypes,
         packages: siteIndex.packages,
     };

package/engine/sql-tables.mjs

@@ -253,7 +253,7 @@ export async function openNotesDatabase(records, { dir, dependencies = [], addre
         addressContext: addressContext ?? {
             package: records.find((record) => record.package)?.package,
             types: new Set(Object.keys(NOTE_VOCABULARY)),
-            system: "none",
+            system: "note",
         },
         stubsExcluded,
         async query(sql) {

package/engine/system-block.mjs

@@ -361,6 +361,25 @@ export function blockProperty(fm, block, key, defaultValue = undefined) {
     return shared === undefined || shared === null ? defaultValue : shared;
 }
 
+/**
+ * A system override followed by a shared `data:` value. The top-level value
+ * remains readable while content repositories move their authored fields.
+ *
+ * @param {object} fm - The note's frontmatter.
+ * @param {string} block - The system block key.
+ * @param {string} key - The shared property.
+ * @param {any} [defaultValue] - Returned when no position declares it.
+ * @returns {any} The selected value.
+ */
+export function blockDataProperty(fm, block, key, defaultValue = undefined) {
+    const declared = systemBlock(fm, block)?.[key];
+    if (declared !== undefined && declared !== null) return declared;
+    const shared = isMapping(fm?.data) ? fm.data[key] : undefined;
+    if (shared !== undefined && shared !== null) return shared;
+    const legacy = isMapping(fm) ? fm[key] : undefined;
+    return legacy === undefined || legacy === null ? defaultValue : legacy;
+}
+
 /**
  * The key a field is authored at **inside** a system block — step 2.
  *

package/engine/systems.mjs

@@ -62,6 +62,9 @@ import { ADDRESS_SEGMENT_PATTERN, isAddressSegment } from "./address-charset.mjs
  */
 export const NO_SYSTEM = "none";
 
+/** The Address segment for a note's readable content. */
+export const NOTE_SYSTEM = "note";
+
 /**
  * Every game system this toolchain compiles for.
  *
@@ -86,7 +89,7 @@ export const SYSTEM_IDS = Object.freeze(new Set(["sohl", "hm3"]));
  *
  * @type {ReadonlySet<string>}
  */
-export const SYSTEM_SEGMENTS = Object.freeze(new Set([...SYSTEM_IDS, NO_SYSTEM]));
+export const SYSTEM_SEGMENTS = Object.freeze(new Set([...SYSTEM_IDS, NO_SYSTEM, NOTE_SYSTEM]));
 
 /**
  * Whether a value names a game system this toolchain knows.

package/engine/web-wikilinks.mjs

@@ -48,7 +48,7 @@ import { replaceOutsideCode } from "./code-fences.mjs";
 // address is matched the way a vendored manifest publishes it — by the
 // segments the target supplies, with the system wildcarded unless stated.
 import { canonicalKey, expandAddress, readCanonicalKey } from "./content-address.mjs";
-import { NO_SYSTEM } from "./systems.mjs";
+import { NOTE_SYSTEM } from "./systems.mjs";
 // The one rule about a link's shape both builds share: it carries a label, and
 // {@link unlabelledLinkMessage} is the one place that says so.
 import { unlabelledLinkMessage } from "./wikilink-syntax.mjs";
@@ -102,7 +102,7 @@ function lookupRead(index, read, contentPackage) {
     // It replaced a system-blind short key for the unqualified form, which
     // could be silently overwritten by a second note of the same
     // `(type, shortcode)` under another system.
-    const key = expandAddress(read, { package: contentPackage, system: NO_SYSTEM });
+    const key = expandAddress(read, { package: contentPackage, system: NOTE_SYSTEM });
     const found = index.get(key);
     if (found || read.package) return found;
 
@@ -393,7 +393,7 @@ export function resolveWebWikilinks(body, ctx) {
     return replaceOutsideCode(embedded.markdown, WIKILINK, (all, rawInner) => {
         const parsed = readWikilink(rawInner, {
             package: ctx.contentPackage,
-            system: "none",
+            system: "note",
             types: ctx.contentTypes ?? new Set(),
             packages: ctx.packages,
             noIndexPackages: ctx.noIndexPackages,