@heroiclands/package-build 22.27.0 → 23.0.0

package/types/engine/literature-notes.d.mts

@@ -0,0 +1,29 @@
+/**
+ * Require `data.language` to address a `skill` note whose subType is
+ * `language`.
+ *
+ * An Address that does not resolve is the reference check's to report, so
+ * this speaks only about a target that exists and is the wrong kind.
+ *
+ * @param {object} note
+ * @param {{index?: object}} [options]
+ * @returns {object[]} The findings.
+ */
+export function checkLanguageChoice(note: object, { index }?: {
+    index?: object;
+}): object[];
+/**
+ * Refuse a literature field on a lore note of any other subType.
+ *
+ * @param {object} note
+ * @returns {object[]} One error per literature key written off `literature`.
+ */
+export function checkLiteratureNote(note: object): object[];
+/** The `lore` subType whose notes are works of literature. */
+export const LITERATURE_SUBTYPE: "literature";
+/**
+ * The fields a `literature` note may state. Every one is optional.
+ *
+ * @type {ReadonlyArray<object>}
+ */
+export const LITERATURE_FIELDS: ReadonlyArray<object>;

package/types/engine/literature-works.d.mts

@@ -0,0 +1,68 @@
+/**
+ * One local page's node.
+ *
+ * @param {object} fm - The note's frontmatter.
+ * @param {{title: string, url?: string, package?: string}} page
+ * @returns {WorksNode|null} Null for a note with no type or shortcode.
+ */
+export function worksNode(fm: object, { title, url, package: pkg }: {
+    title: string;
+    url?: string;
+    package?: string;
+}): WorksNode | null;
+/**
+ * The works a fetched index carries, as nodes. Only a work can list itself on
+ * a page, and only a page of this package can carry the list, so a foreign
+ * entry that is not a work is never needed here.
+ *
+ * @param {Map<string, object>|undefined} foreignIndex
+ * @returns {WorksNode[]}
+ */
+export function foreignWorksNodes(foreignIndex: Map<string, object> | undefined): WorksNode[];
+/**
+ * Invert every work's subjects into the list each subject's page carries.
+ *
+ * A subject is resolved in its work's own package. A work naming one subject
+ * twice lists once; a work naming itself is not listed on its own page.
+ * Entries sort by title.
+ *
+ * @param {Iterable<WorksNode|null>} nodes - Every local page, then any foreign work.
+ * @param {object} options
+ * @param {ReadonlySet<string>} options.types - Note types an Address may name.
+ * @returns {Map<string, {works: WorkEntry[]}>} Keyed by the subject page's URL.
+ */
+export function worksPages(nodes: Iterable<WorksNode | null>, { types }: {
+    types: ReadonlySet<string>;
+}): Map<string, {
+    works: WorkEntry[];
+}>;
+/** The page front-matter key the site build writes. */
+export const WORKS_KEY: "works";
+export type WorkEntry = {
+    title: string;
+    url?: string;
+    form?: string;
+};
+export type WorksNode = {
+    /**
+     * Own Address, normalized to the `note` system.
+     */
+    key: string;
+    title: string;
+    /**
+     * Absent for a note that publishes no page.
+     */
+    url?: string | undefined;
+    /**
+     * Owning content package.
+     */
+    package?: string | undefined;
+    /**
+     * A work's `data.form`.
+     */
+    form?: string | undefined;
+    /**
+     * A work's `data.subjects`; empty for any other note.
+     */
+    subjects: unknown[];
+};

package/types/engine/note-vocabulary.d.mts

@@ -455,8 +455,8 @@ export type DataFieldSpec = {
  *
  * Two types answer **false**, and both are structural: a `folder` note's page
  * is a generated section index and a `homepage`'s is the site's front door, so
- * each is complete with no body at all. An empty body on one of them keeps its
- * address and resolves as `full`.
+ * an empty body on one of them keeps its address and resolves as `full`.
+ * This is classification only: author validation requires a body for every type.
  */
 export type TypeVocabulary = {
     /**