@heroiclands/package-build 21.1.0 → 22.0.0

package/types/engine/wikilinks.d.mts

@@ -128,6 +128,10 @@ export function anchorPageId(noteId: string, anchorSlug: string): string;
  *   vendored manifests of packages this build links into but does not publish.
  * @param {string} [contentPackage] - This build's *content* package, which an
  *   authored address may name explicitly. Defaults to `packageId`.
+ * @param {object} [opts] - Options.
+ * @param {Map<string, object>} [opts.assets] - The files this package ships, by
+ *   canonical address. They resolve no link — an asset is not a document — and
+ *   answer only the art fields, which name a file and never a document.
  * @returns {{byShortcode: Map<string, object>, types: Set<string>}} `types` is
  *   every type the tree actually contains, so a qualifier naming no real type
  *   can be told apart from a missing target.
@@ -140,7 +144,9 @@ export function buildWikilinkIndex(docs: Array<{
     pack?: string;
     docPack?: string;
     draft?: boolean;
-}>, packageId: string, foreign?: Map<string, object>, contentPackage?: string): {
+}>, packageId: string, foreign?: Map<string, object>, contentPackage?: string, { assets }?: {
+    assets?: Map<string, object> | undefined;
+}): {
     byShortcode: Map<string, object>;
     types: Set<string>;
 };

package/types/manifest.d.mts

@@ -17,6 +17,28 @@
 export function normalizeRepoUrl(repository: string | {
     url?: string;
 }): string;
+/**
+ * A package's homepage — the page `url` sends a reader to.
+ *
+ * Derived from the content package rather than declared, because the address is
+ * already fixed: every package publishes an authored homepage at
+ * `<origin>/<contentPackage>/`, and the shared site-deploy workflow publishes
+ * it there. A declared copy would be a second spelling of a settled fact, free
+ * to drift — and the one that drifts is this one, because nothing fetches `url`
+ * the way Foundry fetches `manifest`, so a wrong value is never reported.
+ *
+ * The site's own `baseURL` says the same thing, and is deliberately not the
+ * source: it sits at `site/hugo.toml` in most repositories and `kb/hugo.toml`
+ * in the system, so reading it would mean the packaging half knowing where each
+ * repository keeps its site configuration.
+ *
+ * @param {string} contentPackage - The package's content-package name.
+ * @returns {string} The homepage URL, with its trailing slash.
+ * @throws {TypeError} When no name is given. Interpolating a missing one yields
+ *   `<origin>/undefined/`, a URL that resolves and is wrong — and nothing
+ *   fetches `url`, so it would be advertised for as long as nobody clicked it.
+ */
+export function packageHomepage(contentPackage: string): string;
 /**
  * The addresses a Foundry manifest advertises.
  *
@@ -26,14 +48,23 @@ export function normalizeRepoUrl(repository: string | {
  * install at that release forever. `download` points at this exact version,
  * because that is the archive this manifest describes.
  *
+ * **`url` is the homepage, not the repository.** It is the Project Homepage
+ * link a reader follows from the package listing *before* installing anything,
+ * so it answers "what is this?" — which a page written for that question does
+ * and a source tree does not. `bugs`, `manifest` and `download` address release
+ * artefacts and stay on the repository that holds them.
+ *
  * @param {object} opts
  * @param {string} opts.repoUrl - Normalised repository URL.
+ * @param {string} opts.homeUrl - The package's homepage, from
+ *   {@link packageHomepage}.
  * @param {string} opts.version - The version being built.
  * @param {"system"|"module"} opts.artifact - Which artifact is shipped.
  * @returns {{url: string, bugs: string, manifest: string, download: string}}
  */
-export function releaseUrls({ repoUrl, version, artifact }: {
+export function releaseUrls({ repoUrl, homeUrl, version, artifact }: {
     repoUrl: string;
+    homeUrl: string;
     version: string;
     artifact: "system" | "module";
 }): {
@@ -223,6 +254,16 @@ export function writeManifest({ config, packageJson, artifact, outDir, flags, co
  * convention this project is free to choose.
  */
 export const ARTIFACTS: readonly string[];
+/**
+ * Where every HeroicLands package's homepage is served from.
+ *
+ * Stated once here and read by {@link packageHomepage}, so the origin a
+ * manifest advertises and the origin the configuration documents cannot come
+ * to disagree.
+ *
+ * @type {string}
+ */
+export const HOMEPAGE_ORIGIN: string;
 /**
  * Relationship keys that direct the **build**, rather than describe the
  * package.

package/types/sohl/actors.d.mts

@@ -56,7 +56,6 @@ export class Actors extends SystemActorCompiler {
         system: {
             shortcode: any;
             templatePriority: number | null;
-            portrait: any;
             appearance: string;
             dossier: string;
         };