@docsworth/cli 0.0.0-stage → 0.2.0

package/dist/core/references.d.ts

@@ -0,0 +1,52 @@
+import type { Page, Repo } from "./repo.js";
+/**
+ * HTML's named character references that hold an ASCII character: all 49 of them. Every
+ * other name stands for non-ASCII characters only. test/references.test.ts checks this
+ * table against the `entities` package.
+ */
+export declare const ASCII_REFERENCES: Readonly<Record<string, string>>;
+/**
+ * HTML's named references to invisible format characters only (soft hyphen, zero-width
+ * space and joiners, word joiner, bidi marks): all 17. The rendered view drops them.
+ * test/references.test.ts checks this list against the `entities` package.
+ */
+export declare const INVISIBLE_REFERENCES: ReadonlySet<string>;
+/** The pages `who` can't see, as a sweep reads names. Built once per repo and audience. */
+export interface PageNames {
+    /** The knowledge root, without a trailing slash. */
+    root: string;
+    /** Skeleton of each repo path → whether it's hidden (hidden wins a collision). */
+    paths: Map<string, boolean>;
+    /** The same for each path under the knowledge root, when it has two segments or more. */
+    under: Map<string, boolean>;
+    /** Skeletons of hidden pages' file names, by length. */
+    names: Map<number, Set<string>>;
+    /** For each such file name, the hidden pages' repo paths. */
+    spelled: Map<string, string[]>;
+    /** For each such file name, the hidden pages' paths under the root (two segments or more). */
+    spelledUnder: Map<string, string[]>;
+    /** The most segments in a repo path: a longer tail can't name one. */
+    depth: number;
+    /** The knowledge repo's URL prefixes on GitHub (`github.com/acme/knowledge/`), if it's there. */
+    repoUrls: string[];
+    /** The same, folded as rendered text (`foldRendered`), for the rendered view. */
+    rendered?: PageNames;
+}
+export declare function pageNames(repo: Repo, hidden: (page: Page) => boolean): PageNames;
+/**
+ * Whether a link destination, as written on page `from`, leads to a hidden page: one
+ * that resolves to it, or a URL that ends with its path. A path under the knowledge root
+ * that is no loaded page fails closed: a page that didn't load has no trustworthy ACL.
+ * `html` for an attribute in raw HTML, where backslash escapes don't apply.
+ */
+export declare function destinationHides(dest: string, from: string, names: PageNames, html?: boolean): boolean;
+/** The lines of `text`, on page `from`, that name a hidden page: see the module comment. */
+export declare function namingLines(text: string, from: string, names: PageNames, depth?: number, inherited?: string[]): Set<number>;
+/**
+ * The lines of `text` where `find`, run over each view the sweep reads (as prose and
+ * joined, with and without CommonMark's escapes, and as rendered), reports a span. For
+ * names that aren't paths: a mirrored page's id, say.
+ */
+export declare function linesWhere(text: string, find: (view: string, cased: string) => Iterable<[number, number]>, depth?: number, inherited?: string[]): Set<number>;
+/** `text` with each line in `lines` replaced by its container markers and `placeholder`. */
+export declare function replaceLines(text: string, lines: Set<number>, placeholder: string): string;