@concordance-wiki/site 0.1.0

package/dist/build/operations.js

@@ -0,0 +1,99 @@
+import { CONTRACT_METHOD, CONTRACT_RELATION } from "@concordance-wiki/core";
+import { byCodeUnit } from "../order.js";
+import { OPERATION_TYPE } from "../slots.js";
+import { fileKey } from "./context.js";
+/** The check that reports an operation note the contract of its API does not declare: the only finding the API page reads. */
+export const OPERATION_UNMATCHED = "W-OPERATION-UNMATCHED";
+/**
+ * The rank of every operation name in the contract of the API, from the record the import left;
+ * an operation the record does not name, or a record an earlier version wrote without the
+ * names, ranks after the named ones.
+ */
+function contractRanks(context, api) {
+    const record = context.model.build.contracts?.find((candidate) => candidate.api === api.id);
+    return new Map((record?.operations ?? []).map((name, index) => [name, index]));
+}
+/**
+ * The operations the contract import attached to an API, in the order of the contract: the
+ * `exposes` links from it with a `contract_import` provenance, ranked by the operation names the
+ * record keeps, the model order deciding between operations the record does not name.
+ */
+export function exposedOperations(context, api) {
+    const operations = [];
+    for (const link of context.touching.get(api.id) ?? []) {
+        if (link.from !== api.id || link.relation !== CONTRACT_RELATION)
+            continue;
+        const imported = link.provenance.find((provenance) => provenance.method === CONTRACT_METHOD);
+        const entity = context.entities.get(link.to);
+        if (imported === undefined || entity === undefined)
+            continue;
+        operations.push({
+            entity,
+            name: imported.operation ?? entity.title,
+            documented: entity.type_origin !== "contract",
+        });
+    }
+    const ranks = contractRanks(context, api);
+    const rankOf = (operation) => ranks.get(operation.name) ?? Number.MAX_SAFE_INTEGER;
+    // A stable sort: two operations the contract does not rank keep the model order.
+    return operations.toSorted((a, b) => rankOf(a) - rankOf(b));
+}
+/** The names of the attributes of the operation type that reference an API, `api` in the default profile. */
+function apiAttributes(context) {
+    const attributes = context.profile.types[OPERATION_TYPE]?.attributes ?? {};
+    return Object.keys(attributes).filter((name) => {
+        const definition = attributes[name];
+        if (definition?.type !== "ref" && definition?.type !== "ref[]")
+            return false;
+        const { target } = definition;
+        return (typeof target === "string" ? [target] : (target ?? [])).includes("api");
+    });
+}
+/**
+ * Whether a value written in the frontmatter of a note names the API: its identifier, its
+ * identifier within the source of the note, the path of its note in that source, or its title.
+ */
+function namesApi(context, note, api, value) {
+    if (typeof value !== "string")
+        return false;
+    const written = value.trim();
+    const { name } = note.source;
+    return (written === api.id ||
+        `${name}/${written}` === api.id ||
+        context.byFile.get(fileKey(name, written)) === api ||
+        written === api.title.trim());
+}
+/** Whether a note names the API, through a reference attribute of the profile or a recorded link at either end. */
+function declaresApi(context, note, api) {
+    const declared = apiAttributes(context).some((attribute) => {
+        const value = note.attributes[attribute];
+        return (Array.isArray(value) ? value : [value]).some((item) => namesApi(context, note, api, item));
+    });
+    return (declared ||
+        (context.touching.get(note.id) ?? []).some((link) => link.from === api.id || link.to === api.id));
+}
+/**
+ * The operation notes the contract of the API does not declare, in identifier order: the notes
+ * of the operation type that a `W-OPERATION-UNMATCHED` finding names and that name the API,
+ * either in their frontmatter or through a link. Described, absent from the contract.
+ */
+export function unmatchedOperations(context, api) {
+    const named = new Set();
+    for (const finding of context.model.findings) {
+        if (finding.check === OPERATION_UNMATCHED && finding.entity !== undefined) {
+            named.add(finding.entity);
+        }
+    }
+    return [...named]
+        .sort(byCodeUnit)
+        .map((id) => context.entities.get(id))
+        .filter((note) => note?.type === OPERATION_TYPE &&
+        note.type_origin !== "contract" &&
+        declaresApi(context, note, api));
+}
+/** A string attribute of an operation, its `method` or `path`, as the contract or the note wrote it. */
+export function operationAttribute(entity, key) {
+    const value = entity.attributes[key];
+    return typeof value === "string" && value.trim() !== "" ? value.trim() : undefined;
+}
+//# sourceMappingURL=operations.js.map

package/dist/build/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../src/build/operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAe,MAAM,wBAAwB,CAAC;AAEzF,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAoB,MAAM,cAAc,CAAC;AAEzD,8HAA8H;AAC9H,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAW3D;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAAoB,EAAE,GAAW;IACtD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;IAC5F,OAAO,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAoB,EAAE,GAAW;IACjE,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QACtD,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,QAAQ,KAAK,iBAAiB;YAAE,SAAS;QAC1E,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC;QAC7F,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;YAAE,SAAS;QAC7D,UAAU,CAAC,IAAI,CAAC;YACd,MAAM;YACN,IAAI,EAAE,QAAQ,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK;YACxC,UAAU,EAAE,MAAM,CAAC,WAAW,KAAK,UAAU;SAC9C,CAAC,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,SAA2B,EAAU,EAAE,CACrD,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,gBAAgB,CAAC;IACvD,iFAAiF;IACjF,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,6GAA6G;AAC7G,SAAS,aAAa,CAAC,OAAoB;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,UAAU,IAAI,EAAE,CAAC;IAC3E,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7C,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,UAAU,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,EAAE,IAAI,KAAK,OAAO;YAAE,OAAO,KAAK,CAAC;QAC7E,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;QAC9B,OAAO,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,QAAQ,CAAC,OAAoB,EAAE,IAAY,EAAE,GAAW,EAAE,KAAc;IAC/E,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;IAC7B,OAAO,CACL,OAAO,KAAK,GAAG,CAAC,EAAE;QAClB,GAAG,IAAI,IAAI,OAAO,EAAE,KAAK,GAAG,CAAC,EAAE;QAC/B,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,GAAG;QAClD,OAAO,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAC7B,CAAC;AACJ,CAAC;AAED,mHAAmH;AACnH,SAAS,WAAW,CAAC,OAAoB,EAAE,IAAY,EAAE,GAAW;IAClE,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QACzD,MAAM,KAAK,GAAY,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAClD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAa,EAAE,EAAE,CACrE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CACnC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,CACL,QAAQ;QACR,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC,CACjG,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAoB,EAAE,GAAW;IACnE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,OAAO,CAAC,KAAK,KAAK,mBAAmB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1E,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC;SACd,IAAI,CAAC,UAAU,CAAC;SAChB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACrC,MAAM,CACL,CAAC,IAAI,EAAkB,EAAE,CACvB,IAAI,EAAE,IAAI,KAAK,cAAc;QAC7B,IAAI,CAAC,WAAW,KAAK,UAAU;QAC/B,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAClC,CAAC;AACN,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,kBAAkB,CAAC,MAAc,EAAE,GAAsB;IACvE,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACrF,CAAC"}

package/dist/build/paths.d.ts

@@ -0,0 +1,45 @@
+/** The pages of the site that are not an entity's, as paths under the output folder. */
+export declare const HOME_PAGE = "index.html";
+export declare const INDEX_PAGE = "index/index.html";
+export declare const TODO_PAGE = "todo/index.html";
+/** The results page; the files of the index sit next to it under `search/`. */
+export declare const SEARCH_PAGE = "search/index.html";
+/** The page listing every space. */
+export declare const SPACES_PAGE = "spaces/index.html";
+/** The page saying where the site comes from and when it was built. */
+export declare const ABOUT_PAGE = "about/index.html";
+export declare const ASSETS_DIRECTORY = "assets";
+export declare const FRAGMENTS_DIRECTORY = "fragments";
+/** The fragment of an entity, next to the model: `fragments/<id>.json`. */
+export declare function fragmentPath(id: string): string;
+/** The JSON view of the contract of an API, next to its fragment: `fragments/<id>.contract.json`. */
+export declare function contractFragmentPath(id: string): string;
+/** Whether a contract location is fetched rather than read from the source. */
+export declare function isContractUrl(location: string): boolean;
+/**
+ * Where the copy of a path contract lands under the site: next to the page of its API, under the
+ * file name the note points at. A URL contract is never copied.
+ */
+export declare function contractFileTarget(id: string, location: string): string;
+/** Where the build keeps an image of a note, by its target under the site, so that `render` places it without a source. */
+export declare function fragmentImagePath(target: string): string;
+/** The mentions of an entity, one file per entity and never a global index: `fragments/<id>.mentions.json`. */
+export declare function mentionsFragmentPath(id: string): string;
+/**
+ * The href of one file of the site from a page, both as paths under the output folder: relative,
+ * climbing with `..`, never starting with `/`, so that it resolves over `file://` as behind a server.
+ */
+export declare function relativeHref(from: string, to: string): string;
+/** The page of a space, at the root of the source: `<source>/index.html`, where no entity page stands since an identifier has two segments at least. */
+export declare function spacePagePath(source: string): string;
+/** The href of the page of a space from another page. */
+export declare function spaceHref(from: string, source: string): string;
+/** The results page filtered on one value of a facet, from a page: `search/index.html?type=rule`. */
+export declare function searchFilterHref(from: string, facet: string, value: string): string;
+/** The href of an entity page from another page. */
+export declare function entityHref(from: string, id: string): string;
+/** The prefix of the asset hrefs from a page, `../assets/` for instance. */
+export declare function assetsBaseOf(from: string): string;
+/** The prefix of the hrefs from a page to the site root, `../../` for instance; empty at the root. */
+export declare function siteRootOf(from: string): string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/build/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/build/paths.ts"],"names":[],"mappings":"AAIA,wFAAwF;AACxF,eAAO,MAAM,SAAS,eAAe,CAAC;AACtC,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAC3C,+EAA+E;AAC/E,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAC/C,oCAAoC;AACpC,eAAO,MAAM,WAAW,sBAAsB,CAAC;AAC/C,uEAAuE;AACvE,eAAO,MAAM,UAAU,qBAAqB,CAAC;AAC7C,eAAO,MAAM,gBAAgB,WAAW,CAAC;AACzC,eAAO,MAAM,mBAAmB,cAAc,CAAC;AAE/C,2EAA2E;AAC3E,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,qGAAqG;AACrG,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,+EAA+E;AAC/E,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEvE;AAED,2HAA2H;AAC3H,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,+GAA+G;AAC/G,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED,wJAAwJ;AACxJ,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,yDAAyD;AACzD,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9D;AAED,qGAAqG;AACrG,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEnF;AAED,oDAAoD;AACpD,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,4EAA4E;AAC5E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,sGAAsG;AACtG,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG/C"}

package/dist/build/paths.js

@@ -0,0 +1,74 @@
+import { posix } from "node:path";
+import { pagePath } from "@concordance-wiki/core";
+/** The pages of the site that are not an entity's, as paths under the output folder. */
+export const HOME_PAGE = "index.html";
+export const INDEX_PAGE = "index/index.html";
+export const TODO_PAGE = "todo/index.html";
+/** The results page; the files of the index sit next to it under `search/`. */
+export const SEARCH_PAGE = "search/index.html";
+/** The page listing every space. */
+export const SPACES_PAGE = "spaces/index.html";
+/** The page saying where the site comes from and when it was built. */
+export const ABOUT_PAGE = "about/index.html";
+export const ASSETS_DIRECTORY = "assets";
+export const FRAGMENTS_DIRECTORY = "fragments";
+/** The fragment of an entity, next to the model: `fragments/<id>.json`. */
+export function fragmentPath(id) {
+    return `${FRAGMENTS_DIRECTORY}/${id}.json`;
+}
+/** The JSON view of the contract of an API, next to its fragment: `fragments/<id>.contract.json`. */
+export function contractFragmentPath(id) {
+    return `${FRAGMENTS_DIRECTORY}/${id}.contract.json`;
+}
+/** Whether a contract location is fetched rather than read from the source. */
+export function isContractUrl(location) {
+    return /^https?:\/\//.test(location);
+}
+/**
+ * Where the copy of a path contract lands under the site: next to the page of its API, under the
+ * file name the note points at. A URL contract is never copied.
+ */
+export function contractFileTarget(id, location) {
+    return `${id}/${posix.basename(location)}`;
+}
+/** Where the build keeps an image of a note, by its target under the site, so that `render` places it without a source. */
+export function fragmentImagePath(target) {
+    return `${FRAGMENTS_DIRECTORY}/${target}`;
+}
+/** The mentions of an entity, one file per entity and never a global index: `fragments/<id>.mentions.json`. */
+export function mentionsFragmentPath(id) {
+    return `${FRAGMENTS_DIRECTORY}/${id}.mentions.json`;
+}
+/**
+ * The href of one file of the site from a page, both as paths under the output folder: relative,
+ * climbing with `..`, never starting with `/`, so that it resolves over `file://` as behind a server.
+ */
+export function relativeHref(from, to) {
+    return posix.relative(posix.dirname(from), to);
+}
+/** The page of a space, at the root of the source: `<source>/index.html`, where no entity page stands since an identifier has two segments at least. */
+export function spacePagePath(source) {
+    return `${source}/index.html`;
+}
+/** The href of the page of a space from another page. */
+export function spaceHref(from, source) {
+    return relativeHref(from, spacePagePath(source));
+}
+/** The results page filtered on one value of a facet, from a page: `search/index.html?type=rule`. */
+export function searchFilterHref(from, facet, value) {
+    return `${relativeHref(from, SEARCH_PAGE)}?${facet}=${encodeURIComponent(value)}`;
+}
+/** The href of an entity page from another page. */
+export function entityHref(from, id) {
+    return relativeHref(from, pagePath(id));
+}
+/** The prefix of the asset hrefs from a page, `../assets/` for instance. */
+export function assetsBaseOf(from) {
+    return `${relativeHref(from, ASSETS_DIRECTORY)}/`;
+}
+/** The prefix of the hrefs from a page to the site root, `../../` for instance; empty at the root. */
+export function siteRootOf(from) {
+    const up = relativeHref(from, ".");
+    return up === "" ? "" : `${up}/`;
+}
+//# sourceMappingURL=paths.js.map

package/dist/build/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../src/build/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,wFAAwF;AACxF,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,CAAC;AACtC,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,CAAC;AAC7C,MAAM,CAAC,MAAM,SAAS,GAAG,iBAAiB,CAAC;AAC3C,+EAA+E;AAC/E,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAC/C,oCAAoC;AACpC,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAC/C,uEAAuE;AACvE,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,CAAC;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AACzC,MAAM,CAAC,MAAM,mBAAmB,GAAG,WAAW,CAAC;AAE/C,2EAA2E;AAC3E,MAAM,UAAU,YAAY,CAAC,EAAU;IACrC,OAAO,GAAG,mBAAmB,IAAI,EAAE,OAAO,CAAC;AAC7C,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,oBAAoB,CAAC,EAAU;IAC7C,OAAO,GAAG,mBAAmB,IAAI,EAAE,gBAAgB,CAAC;AACtD,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAU,EAAE,QAAgB;IAC7D,OAAO,GAAG,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC7C,CAAC;AAED,2HAA2H;AAC3H,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,GAAG,mBAAmB,IAAI,MAAM,EAAE,CAAC;AAC5C,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,oBAAoB,CAAC,EAAU;IAC7C,OAAO,GAAG,mBAAmB,IAAI,EAAE,gBAAgB,CAAC;AACtD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,EAAU;IACnD,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,wJAAwJ;AACxJ,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,OAAO,GAAG,MAAM,aAAa,CAAC;AAChC,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,MAAc;IACpD,OAAO,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAa,EAAE,KAAa;IACzE,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,KAAK,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;AACpF,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,EAAU;IACjD,OAAO,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC;AACpD,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACnC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC;AACnC,CAAC"}

package/dist/build/redirect.d.ts

@@ -0,0 +1,20 @@
+import { type Entity } from "@concordance-wiki/core";
+import { type JSX } from "preact";
+import { type SiteContext } from "./context.js";
+/** A former keyword address kept for the note that took the expression over. */
+export interface Redirect {
+    /** The keyword page identifier, `keywords/<slug>`. */
+    from: string;
+    to: Entity;
+}
+/**
+ * The redirects of the site, by keyword identifier: every `keywords` entry of the fragments
+ * whose identifier no page of the model holds; when two notes claim one address, the lower
+ * identifier keeps it.
+ */
+export declare function redirectsOf(context: SiteContext): Redirect[];
+/** The body of a redirect page: the title of the note, and the link the `<meta>` refresh follows. */
+export declare function redirectBody(context: SiteContext, redirect: Redirect): JSX.Element;
+/** Where a redirect forwards, relative to its own page. */
+export declare function redirectHref(redirect: Redirect): string;
+//# sourceMappingURL=redirect.d.ts.map

package/dist/build/redirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.d.ts","sourceRoot":"","sources":["../../src/build/redirect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAK,KAAK,GAAG,EAAE,MAAM,QAAQ,CAAC;AAGrC,OAAO,EAAW,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAGzD,gFAAgF;AAChF,MAAM,WAAW,QAAQ;IACvB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,QAAQ,EAAE,CAS5D;AAED,qGAAqG;AACrG,wBAAgB,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,GAAG,GAAG,CAAC,OAAO,CAalF;AAED,2DAA2D;AAC3D,wBAAgB,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEvD"}

package/dist/build/redirect.js

@@ -0,0 +1,31 @@
+import { pagePath } from "@concordance-wiki/core";
+import { h } from "preact";
+import { byCodeUnit } from "../order.js";
+import { message } from "./context.js";
+import { entityHref } from "./paths.js";
+/**
+ * The redirects of the site, by keyword identifier: every `keywords` entry of the fragments
+ * whose identifier no page of the model holds; when two notes claim one address, the lower
+ * identifier keeps it.
+ */
+export function redirectsOf(context) {
+    const claims = new Map();
+    for (const entity of [...context.model.entities].sort((a, b) => byCodeUnit(a.id, b.id))) {
+        for (const from of context.fragments.get(entity.id)?.keywords ?? []) {
+            if (context.entities.has(from) || claims.has(from))
+                continue;
+            claims.set(from, entity);
+        }
+    }
+    return [...claims].sort(([a], [b]) => byCodeUnit(a, b)).map(([from, to]) => ({ from, to }));
+}
+/** The body of a redirect page: the title of the note, and the link the `<meta>` refresh follows. */
+export function redirectBody(context, redirect) {
+    const href = redirectHref(redirect);
+    return h("div", { class: "redirect" }, h("h1", null, redirect.to.title), h("p", null, `${message(context, "keyword.noteWritten")} `, h("a", { href }, redirect.to.title)));
+}
+/** Where a redirect forwards, relative to its own page. */
+export function redirectHref(redirect) {
+    return entityHref(pagePath(redirect.from), redirect.to.id);
+}
+//# sourceMappingURL=redirect.js.map

package/dist/build/redirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.js","sourceRoot":"","sources":["../../src/build/redirect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,CAAC,EAAY,MAAM,QAAQ,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,OAAO,EAAoB,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AASxC;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,OAAoB;IAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACxF,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,QAAQ,IAAI,EAAE,EAAE,CAAC;YACpE,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC7D,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,YAAY,CAAC,OAAoB,EAAE,QAAkB;IACnE,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACpC,OAAO,CAAC,CACN,KAAK,EACL,EAAE,KAAK,EAAE,UAAU,EAAE,EACrB,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,EAChC,CAAC,CACC,GAAG,EACH,IAAI,EACJ,GAAG,OAAO,CAAC,OAAO,EAAE,qBAAqB,CAAC,GAAG,EAC7C,CAAC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,CACpC,CACF,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,YAAY,CAAC,QAAkB;IAC7C,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC"}

package/dist/build/site.d.ts

@@ -0,0 +1,99 @@
+import { type CanonicalModel, type FileSystem, type LegalConfig, type StalenessConfig } from "@concordance-wiki/core";
+import type { Profile } from "@concordance-wiki/profile";
+import type { ContrastFinding } from "../a11y/contrast.js";
+import { type BudgetReport } from "../budget.js";
+import { type IslandBundle } from "../islands/bundle.js";
+import { type SearchTokenizer } from "../search/build.js";
+import type { ResolvedTheme, ThemeOverride } from "../theme/types.js";
+import { type PageReport, type WrittenDocument } from "./assemble.js";
+import { type SiteFolders, type SiteNames } from "./context.js";
+import { type ViewerBundles } from "./entity-page.js";
+import type { EntityFragment } from "./fragments.js";
+/** Excluding previews, per page. */
+export declare const SITE_PAGE_BUDGET = 150000;
+export interface SiteInput {
+    model: CanonicalModel;
+    /** The fragments the build wrote next to the model, by entity identifier; an entity without one has no section. */
+    fragments: ReadonlyMap<string, EntityFragment>;
+    profile: Profile;
+    theme: ResolvedTheme;
+    /** The project locale: the language of the labels, the fallback title language of the types. */
+    locale: string;
+    /** The site title when the theme carries no `theme.yaml`. */
+    projectName: string;
+    names?: SiteNames;
+    /** `project.edit_url` of the configuration. */
+    editUrl?: string;
+    /** `project.contribute_url` of the configuration: where every call to action leads when no forge link can be built. */
+    contributeUrl?: string;
+    /** `sources[].folders` of the configuration, by source name: the titles and descriptions of the folders. */
+    folders?: SiteFolders;
+    /** The `ref` of every source that declares one, for the edit links when `edit_url` is unset. */
+    sourceRefs?: Record<string, string>;
+    /** The `description` of every source that declares one: the content of its space on the spaces page. */
+    sourceDescriptions?: Record<string, string>;
+    /** The names of the glossary sources, where the lead of a keyword page offers to write the note. */
+    glossarySources?: string[];
+    /** `build.mentions_inline` of the configuration. */
+    mentionsInline?: number;
+    /** `staleness` of the configuration: the thresholds behind the dormant flag of the home page. */
+    staleness?: StalenessConfig;
+    /** The collation of the project locale, `compare` of its language pack, which orders the alphabetical index. */
+    collate?: (a: string, b: string) => number;
+    /** The tokeniser of the search index; the commands give the one of the language packs. */
+    tokenize: SearchTokenizer;
+    /** `build.extracted_text_max_chars` of the configuration: characters of the body indexed per entity. */
+    bodyMaxChars?: number;
+    /** `privacy.pseudonymize.enabled` of the configuration, which the page of a meeting states. */
+    pseudonymized?: boolean;
+    /** `project.legal` of the configuration: the pages the organisation declares, linked from the footer of every page. */
+    legal?: LegalConfig;
+    /** The markdown of the file `project.about` names, rendered after the generated content of the about page. */
+    about?: string;
+    /** `inference.keyword_pages.min_occurrences` of the configuration, which the about page names. */
+    keywordThreshold?: number;
+    /** `site.url` of the configuration: where the site is published, which the page served for a missing address links back through. */
+    siteUrl?: string;
+    /** `site.publish_every_days` of the configuration: past three times that many days, every page shows its age. */
+    publishEveryDays?: number;
+}
+export interface SiteOptions extends SiteInput {
+    output: string;
+    fileSystem: FileSystem;
+    maxPageBytes?: number;
+}
+export interface SiteReport {
+    /** Every page written, sorted by path, with its size and accessibility findings. */
+    pages: PageReport[];
+    budget: BudgetReport;
+    overrides: ThemeOverride[];
+    contrast: ContrastFinding[];
+    /** Every file written under the output folder, sorted. */
+    files: string[];
+    /** The search index written under `search/`: its weight and its number of shards. */
+    search: SearchIndexSize;
+    /** How many pages are former keyword addresses forwarding to a note. */
+    redirects: number;
+    /** Lines describing what was written. */
+    summary: string[];
+    /** One line per page over budget or accessibility finding; the site is written all the same. */
+    warnings: string[];
+}
+export interface SearchIndexSize {
+    bytes: number;
+    shards: number;
+}
+/** The documents of a site: the pages, the index files, and the size of the index for the summary. */
+export interface SiteDocuments {
+    documents: WrittenDocument[];
+    search: SearchIndexSize;
+}
+/** Whether any entity has a PDF to leaf through: the only case where the viewer bundles are worth building. */
+export declare function needsViewer(fragments: ReadonlyMap<string, EntityFragment>): boolean;
+/** The viewer bundles among those built, as paths under the output folder; nothing when they were not built. */
+export declare function viewerBundlesOf(islands: readonly IslandBundle[]): ViewerBundles | undefined;
+/** Every document of the site, the pages and the search index, rendered against the given bundles. */
+export declare function siteDocuments(input: SiteInput, islands: IslandBundle[]): SiteDocuments;
+/** Writes the whole site from a model and its fragments; nothing here reads a source. */
+export declare function buildSite(options: SiteOptions): Promise<SiteReport>;
+//# sourceMappingURL=site.d.ts.map

package/dist/build/site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../src/build/site.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAEnB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAmB,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAKL,KAAK,YAAY,EAClB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,oBAAoB,CAAC;AAM5B,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAGL,KAAK,UAAU,EACf,KAAK,eAAe,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAML,KAAK,WAAW,EAChB,KAAK,SAAS,EACf,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAyBrD,oCAAoC;AACpC,eAAO,MAAM,gBAAgB,SAAU,CAAC;AAExC,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,cAAc,CAAC;IACtB,mHAAmH;IACnH,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,aAAa,CAAC;IACrB,gGAAgG;IAChG,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uHAAuH;IACvH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4GAA4G;IAC5G,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,gGAAgG;IAChG,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,wGAAwG;IACxG,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,oGAAoG;IACpG,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iGAAiG;IACjG,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,gHAAgH;IAChH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAC3C,0FAA0F;IAC1F,QAAQ,EAAE,eAAe,CAAC;IAC1B,wGAAwG;IACxG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+FAA+F;IAC/F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uHAAuH;IACvH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,8GAA8G;IAC9G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kGAAkG;IAClG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oIAAoI;IACpI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iHAAiH;IACjH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,oFAAoF;IACpF,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,aAAa,EAAE,CAAC;IAC3B,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,0DAA0D;IAC1D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,qFAAqF;IACrF,MAAM,EAAE,eAAe,CAAC;IACxB,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gGAAgG;IAChG,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,sGAAsG;AACtG,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,MAAM,EAAE,eAAe,CAAC;CACzB;AAoID,+GAA+G;AAC/G,wBAAgB,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,OAAO,CAKnF;AAED,gHAAgH;AAChH,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,GAAG,aAAa,GAAG,SAAS,CAS3F;AAED,sGAAsG;AACtG,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,aAAa,CAoNtF;AAED,yFAAyF;AACzF,wBAAsB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAmCzE"}