@geekity/cms 0.3.0 → 0.5.0

package/dist/content/search.js

@@ -0,0 +1,136 @@
+/**
+ * What the full-text index is fed and how a reader's words become a query
+ * against it (TASK-22).
+ *
+ * The index itself is an FTS5 table in the content store, written and dropped
+ * alongside the document rows, so it is derived exactly as they are
+ * (decision-9). This module is the part that needs no database: the text a
+ * document is indexed by, and the translation from what somebody typed into a
+ * search box into an FTS5 `MATCH` expression that cannot be a syntax error.
+ */
+/**
+ * The marks the index puts either side of a matched word in a snippet.
+ *
+ * Control characters rather than markup, because the snippet is plain text
+ * that the web layer escapes before it turns these into `<mark>`: a post that
+ * talks about `<mark>` should print the words, not the element. They are
+ * stripped out of everything indexed, so a document cannot forge one.
+ */
+export const SNIPPET_OPEN = '\u0002';
+export const SNIPPET_CLOSE = '\u0003';
+/** How many terms of a query are kept. Anything longer is somebody pasting a post. */
+export const MAXIMUM_QUERY_TERMS = 16;
+/**
+ * What one document is indexed by.
+ *
+ * The body is the rendered HTML stripped to text rather than the Markdown, so
+ * a link's URL, a fence's language and the syntax around emphasis are not
+ * words a reader can find a post by — only what the post says.
+ */
+export function searchText(document) {
+    return {
+        title: clean(document.title),
+        description: clean(document.description ?? ''),
+        terms: clean([...document.tags, ...document.categories].join(' ')),
+        body: htmlToText(document.html),
+    };
+}
+/**
+ * Some HTML as the words a reader sees.
+ *
+ * A block tag becomes a space, so `</p><p>` between two paragraphs does not
+ * glue the last word of one to the first word of the next; an inline tag
+ * becomes nothing, so `<a>there</a>.` reads "there." rather than "there ."
+ * in a snippet. Scripts and styles go entirely, contents and all.
+ */
+export function htmlToText(html) {
+    return clean(decodeEntities(html
+        .replace(/<(script|style)\b[^>]*>[\s\S]*?<\/\1\s*>/gi, ' ')
+        .replace(/<!--[\s\S]*?-->/g, ' ')
+        .replace(BLOCK_TAG, ' ')
+        .replace(/<[^>]*>/g, '')));
+}
+/** Tags that separate words: blocks, line breaks and the things between cells. */
+const BLOCK_TAG = /<\/?(?:address|article|aside|blockquote|br|dd|details|div|dl|dt|figcaption|figure|footer|h[1-6]|header|hr|img|li|nav|ol|p|pre|section|summary|table|td|th|tr|ul)\b[^>]*>/gi;
+/**
+ * A reader's query as an FTS5 `MATCH` expression, or `undefined` when there is
+ * nothing in it to search for.
+ *
+ * Every term is quoted, so nothing a reader types — a stray `"`, a `-`, an
+ * `AND`, a `column:` prefix, a bracket — is ever read as FTS5 syntax: the
+ * worst a query can do is find nothing. What it does understand is the two
+ * things a search box is expected to: words in `"double quotes"` are a phrase,
+ * and a bare word ending in `*` is a prefix. Terms are joined by FTS5's
+ * implicit AND, so every word has to be somewhere in the document.
+ */
+export function searchExpression(query) {
+    const terms = [];
+    // A quoted phrase, a quote left open at the end, or a run of anything else.
+    const pattern = /"([^"]*)"?|([^\s"]+)/g;
+    for (const match of clean(query).matchAll(pattern)) {
+        if (terms.length >= MAXIMUM_QUERY_TERMS)
+            break;
+        const phrase = match[1];
+        if (phrase !== undefined) {
+            if (isSearchable(phrase))
+                terms.push(quote(phrase.trim()));
+            continue;
+        }
+        const word = match[2];
+        const prefix = word.length > 1 && word.endsWith('*');
+        const stem = word.replace(/\*+$/, '');
+        if (!isSearchable(stem))
+            continue;
+        terms.push(prefix ? `${quote(stem)} *` : quote(stem));
+    }
+    return terms.length === 0 ? undefined : terms.join(' ');
+}
+/**
+ * Whether a term holds anything the tokenizer would keep. A term of nothing
+ * but punctuation becomes an empty phrase, which matches nothing and would
+ * turn a query of three good words and a dash into a query that finds nothing.
+ */
+function isSearchable(term) {
+    return /[\p{L}\p{N}]/u.test(term);
+}
+/** A term as an FTS5 string, which escapes a quote by doubling it. */
+function quote(term) {
+    return `"${term.replace(/"/g, '""')}"`;
+}
+/** Whitespace collapsed, and the snippet marks taken out so nothing can forge one. */
+function clean(value) {
+    return value
+        .replaceAll(SNIPPET_OPEN, '')
+        .replaceAll(SNIPPET_CLOSE, '')
+        .replace(/\s+/g, ' ')
+        .trim();
+}
+/** The entities a rendered body holds, named or numeric, resolved to text. */
+function decodeEntities(value) {
+    return value.replace(/&(#x[0-9a-f]+|#[0-9]+|[a-z]+);/gi, (entity, name) => {
+        if (name.startsWith('#')) {
+            const code = name[1] === 'x' || name[1] === 'X'
+                ? Number.parseInt(name.slice(2), 16)
+                : Number.parseInt(name.slice(1), 10);
+            return code > 0 && code <= 0x10ffff ? String.fromCodePoint(code) : ' ';
+        }
+        return NAMED_ENTITIES[name.toLowerCase()] ?? entity;
+    });
+}
+/** The named entities Markdown output and hand-written HTML actually use. */
+const NAMED_ENTITIES = {
+    amp: '&',
+    lt: '<',
+    gt: '>',
+    quot: '"',
+    apos: "'",
+    nbsp: ' ',
+    hellip: '…',
+    mdash: '—',
+    ndash: '–',
+    lsquo: '‘',
+    rsquo: '’',
+    ldquo: '“',
+    rdquo: '”',
+};
+//# sourceMappingURL=search.js.map

package/dist/content/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/content/search.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,QAAQ,CAAC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC;AAEtC,sFAAsF;AACtF,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AActC;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,QAAkB;IAC3C,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC5B,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC;QAC9C,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClE,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;KAChC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,OAAO,KAAK,CACV,cAAc,CACZ,IAAI;SACD,OAAO,CAAC,4CAA4C,EAAE,GAAG,CAAC;SAC1D,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC;SAChC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAC3B,CACF,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,SAAS,GACb,4KAA4K,CAAC;AAE/K;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,4EAA4E;IAC5E,MAAM,OAAO,GAAG,uBAAuB,CAAC;IAExC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,MAAM,IAAI,mBAAmB;YAAE,MAAM;QAE/C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,IAAI,YAAY,CAAC,MAAM,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3D,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAW,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAAE,SAAS;QAClC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,IAAY;IAChC,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,sEAAsE;AACtE,SAAS,KAAK,CAAC,IAAY;IACzB,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;AACzC,CAAC;AAED,sFAAsF;AACtF,SAAS,KAAK,CAAC,KAAa;IAC1B,OAAO,KAAK;SACT,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;SAC5B,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;SAC7B,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,8EAA8E;AAC9E,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,kCAAkC,EAAE,CAAC,MAAM,EAAE,IAAY,EAAE,EAAE;QAChF,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,GACR,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG;gBAChC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACpC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACzC,OAAO,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,CAAC;QACD,OAAO,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,MAAM,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6EAA6E;AAC7E,MAAM,cAAc,GAAqC;IACvD,GAAG,EAAE,GAAG;IACR,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,MAAM,EAAE,GAAG;IACX,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,GAAG;IACV,KAAK,EAAE,GAAG;CACX,CAAC"}

package/dist/content/store.d.ts

@@ -1,12 +1,25 @@
 import type { Document, DocumentType } from './document.ts';
-/** File name of the derived index inside a site's data directory. */
-export declare const DATABASE_FILE = "geekity.db";
+export { DATABASE_FILE } from '../cache.ts';
 /** Directory name that marks a document as thrown away but not yet deleted. */
 export declare const TRASH_DIRECTORY = "_trash";
+/**
+ * What the index reads the time from.
+ *
+ * A post's date decides whether it is public yet, so the index has a clock;
+ * this is the seam that lets a test move it without waiting.
+ */
+export type Clock = () => Date;
+/** The clock an index uses when it is not given one. */
+export declare const systemClock: Clock;
 /** Where {@link openContentStore} puts the database. */
 export interface OpenContentStoreOptions {
     /** Directory the database lives in. Created if it is missing. */
     dataDir: string;
+    /**
+     * What "now" means to the public queries, for the scheduling clause. Defaults
+     * to {@link systemClock}; a test hands one it can move.
+     */
+    now?: Clock | undefined;
 }
 /**
  * The derived index over the Markdown files.
@@ -19,7 +32,18 @@ export interface ContentStore {
     /** Absolute path of the SQLite file. */
     readonly file: string;
     /**
-     * Insert or replace the row for `document.path`, tags included.
+     * What the index thinks the time is: the instant every public query holds a
+     * future-dated document against.
+     *
+     * It is here so that a caller applying the same rule outside SQL — the
+     * public site deciding whether to serve a permalink, the admin deciding
+     * whether to offer a View link — asks the same clock the listings did, and
+     * so a test that moves the index's clock moves theirs with it.
+     */
+    now(): Date;
+    /**
+     * Insert or replace the row for `document.path`, tags and categories
+     * included.
      *
      * Throws {@link DuplicatePermalinkError} when another path already claims
      * the same permalink.
@@ -29,21 +53,122 @@ export interface ContentStore {
     upsertAll(documents: Iterable<Document>): void;
     /** Drop a document by path. Returns `false` when there was nothing to drop. */
     remove(path: string): boolean;
+    /**
+     * Empty the index: every document, its terms and its words.
+     *
+     * What a rebuild does before it reads the files again (TASK-95), and the
+     * counterpart of the `DELETE FROM documents` three migrations run for the
+     * same reason. The index is derived and the files are the source of truth
+     * (decision-1), so this loses nothing a scan cannot work out again — and it
+     * is the whole point: a row whose hash matches its file is a row a scan
+     * leaves alone, so nothing short of emptying the index makes it read
+     * everything.
+     *
+     * One transaction, so the four tables are never half cleared, and no wider
+     * than that: the scan that fills the index again runs outside it. One
+     * connection serves every request, so a transaction held open across a scan
+     * would not isolate the rebuild from anybody — it would swallow their writes
+     * into it.
+     */
+    clear(): void;
     /** The document at a content-relative path, or `undefined`. */
     getByPath(path: string): Document | undefined;
     /** The document a URL resolves to, or `undefined`. Permalinks are unique. */
     getByPermalink(permalink: string): Document | undefined;
+    /**
+     * The post whose front matter names this ActivityStreams id, or `undefined`.
+     *
+     * Only a migrated post has one (decision-13): a post born on the CMS is
+     * named by its permalink and carries no `activitypub.id` at all. This is how
+     * the id its followers already hold keeps answering — with the `Article` for
+     * a peer and a redirect to the permalink for a browser — so the match is on
+     * the whole URL, a `?p=813` query string included.
+     */
+    getByStoredObjectId(objectId: string): Document | undefined;
     /**
      * The document with this slug, or `undefined`. Slugs are not unique across
      * years, so the newest match wins.
      */
     getBySlug(slug: string): Document | undefined;
-    /** Published, untrashed posts, newest first. */
+    /** Published, untrashed, already-due posts, newest first. */
     listPosts(options?: ListOptions): Document[];
+    /**
+     * Published, untrashed, already-due posts dated at or after an instant,
+     * newest first: everything since the start of a month, or a week, or a year.
+     *
+     * A query of its own rather than an option on {@link ContentStore.listPosts}
+     * because it is a different question — "what has been written lately", not
+     * "the front of the archive" — and because an option honoured by one listing
+     * and silently dropped by the counts beside it would be a trap. The instant
+     * is a {@link dateSortKey}, so the comparison is between two UTC ISO strings.
+     */
+    listPostsSince(instant: string): Document[];
+    /**
+     * The published posts either side of one by date: what a theme links as
+     * previous and next under an entry.
+     *
+     * `previous` is the post before it and `next` the one after it, in the order
+     * every listing is in — newest first, ties broken by path — so a reader
+     * walking the links walks the archive. Either is absent at its end of the
+     * archive rather than wrapping round to the other end.
+     *
+     * Only published posts are neighbours: a draft, a trashed post, a page and a
+     * post whose date is still ahead are all things a reader cannot open, and a
+     * link to one would be a link to a 404. A document that is not a post has no
+     * neighbours at all, because an archive is what somebody wrote and a page is
+     * furniture.
+     */
+    neighbours(document: Document): DocumentNeighbours;
+    /**
+     * When the next scheduled document becomes public, as the UTC instant the
+     * index sorts by, or `undefined` when nothing is waiting.
+     *
+     * What a scheduler sets its timer from: one indexed lookup rather than a
+     * walk of the archive.
+     */
+    nextDue(): string | undefined;
+    /**
+     * Published, untrashed documents whose date falls in `(after, now]`, oldest
+     * first: everything that has come due since a scheduler last looked.
+     *
+     * Oldest first because they are announced in the order they became public,
+     * and a follower should be told about the older post first.
+     */
+    listDueSince(after: string): Document[];
     /** Published, untrashed documents carrying a tag, newest first. */
     listByTag(tag: string, options?: ListByTagOptions): Document[];
+    /** Published, untrashed documents filed under a category, newest first. */
+    listByCategory(category: string, options?: ListByTagOptions): Document[];
+    /**
+     * Published, untrashed, already-due posts whose `author` is one of `names`,
+     * newest first: one user's archive (TASK-67).
+     *
+     * A list of names rather than one, because more than one string can read as
+     * the same person: doc-2's `author` holds a username, and a file written
+     * before decision-14 holds a display name that reads as the one user
+     * answering to it. `web/authors.ts` decides which names those are and hands
+     * them here, so the index matches strings and never has to know what a user
+     * is. An empty list matches nothing, which is what a user whose name nothing
+     * resolves to should get.
+     *
+     * Posts only: an author archive is what somebody wrote, and a page is part
+     * of the furniture of the site rather than of anybody's body of work.
+     */
+    listByAuthor(names: readonly string[], options?: ListOptions): Document[];
     /** Everything the admin may see, trash and drafts included unless filtered. */
     listAll(options?: ListAllOptions): Document[];
+    /**
+     * Posts the site has announced to the fediverse: the ones whose front matter
+     * carries an `activitypub.published`, newest first, drafts, scheduled posts
+     * and the trash included.
+     *
+     * The federation screen's row source, and the reason the filter is a query
+     * rather than a walk of {@link ContentStore.listAll}: a draft and a trashed
+     * post belong on that screen — they are what a `Delete` is sent for — so the
+     * only thing that decides the list is whether the post was ever announced,
+     * which is the same thing as whether a follower holds a copy.
+     */
+    listFederated(options?: ListOptions): Document[];
     /** Every indexed path, sorted. What a sync compares the content tree against. */
     listPaths(): string[];
     /** How many documents there are of each kind. */
@@ -52,9 +177,66 @@ export interface ContentStore {
     countByTag(tag: string, options?: ListByTagOptions): number;
     /** Every tag in use on published, untrashed documents, with its count. */
     listTags(): TagCount[];
+    /** How many published, untrashed documents are filed under a category. */
+    countByCategory(category: string, options?: ListByTagOptions): number;
+    /** How many published posts one user's archive holds. See {@link ContentStore.listByAuthor}. */
+    countByAuthor(names: readonly string[]): number;
+    /** Every category in use on published, untrashed documents, with its count. */
+    listCategories(): CategoryCount[];
+    /**
+     * Every term in use in one taxonomy, in alphabetical order, with the number
+     * of documents the public site lists under it and the number of files
+     * carrying it at all.
+     *
+     * The second count is the one the taxonomy screens act on: renaming a term
+     * rewrites every file that carries it, drafts, scheduled posts and the trash
+     * included, so a screen that only showed the public count would understate
+     * what a rename is about to touch. Alphabetical because it is a list to find
+     * a term in rather than a list of what a site writes about, which is what
+     * {@link ContentStore.listTags} is for.
+     */
+    listTermUsage(taxonomy: TaxonomyName): TermUsage[];
+    /**
+     * Published, untrashed, already-due posts and pages matching a reader's
+     * query, best match first (TASK-22).
+     *
+     * `query` is what somebody typed, not FTS5 syntax: see `searchExpression`
+     * for what it understands. A query with nothing searchable in it finds
+     * nothing rather than everything. Relevance is BM25 with a title match
+     * counting for more than a match in the description or the taxonomy, and
+     * those for more than one in the body; documents that tie are in the order
+     * every listing is in, newest first.
+     */
+    search(query: string, options?: ListOptions): SearchHit[];
+    /** How many documents {@link ContentStore.search} would find, for the pager. */
+    countSearch(query: string): number;
     /** Close the database. Safe to call twice. */
     close(): void;
 }
+/**
+ * The published posts either side of one, as {@link ContentStore.neighbours}
+ * answers.
+ *
+ * Both keys are absent for a document with no neighbours at all, so a caller
+ * reads the pair rather than asking twice.
+ */
+export interface DocumentNeighbours {
+    /** The post before this one by date, absent at the end of the archive. */
+    previous?: Document | undefined;
+    /** The post after this one by date, absent at the front of it. */
+    next?: Document | undefined;
+}
+/** One document a search found, and the passage it was found in. */
+export interface SearchHit {
+    /** The document. */
+    document: Document;
+    /**
+     * A few words around the match, as plain text, with every matched word
+     * between `SNIPPET_OPEN` and `SNIPPET_CLOSE`. Whoever prints it escapes it
+     * first and turns the marks into markup second.
+     */
+    snippet: string;
+}
 /** Paging for the public listings. */
 export interface ListOptions {
     /** How many documents to return. Defaults to everything. */
@@ -62,7 +244,7 @@ export interface ListOptions {
     /** How many to skip first. Defaults to 0. */
     offset?: number | undefined;
 }
-/** Paging plus the type filter the tag archives need. */
+/** Paging plus the type filter the taxonomy archives need. */
 export interface ListByTagOptions extends ListOptions {
     /** Restrict to posts or pages. Defaults to both. */
     type?: DocumentType | undefined;
@@ -75,19 +257,28 @@ export interface ListAllOptions extends ListOptions {
     draft?: boolean | undefined;
     /** `true` for trashed only, `false` for live only. Defaults to live only. */
     trashed?: boolean | undefined;
+    /**
+     * `true` for documents whose date has not arrived, `false` for those already
+     * due. Defaults to both, which is what the admin's "All" view shows.
+     */
+    scheduled?: boolean | undefined;
     /** Restrict to documents carrying this tag. */
     tag?: string | undefined;
+    /** Restrict to documents filed under this category. */
+    category?: string | undefined;
 }
 /** What {@link ContentStore.counts} reports. */
 export interface ContentCounts {
     /** Every indexed document, trash included. */
     total: number;
-    /** Published, untrashed posts: the size of the public archive. */
+    /** Published, untrashed, already-due posts: the size of the public archive. */
     posts: number;
-    /** Published, untrashed pages. */
+    /** Published, untrashed, already-due pages. */
     pages: number;
     /** Untrashed drafts of either type. */
     drafts: number;
+    /** Untrashed non-drafts of either type whose date has not arrived yet. */
+    scheduled: number;
     /** Documents under `_trash/`. */
     trashed: number;
 }
@@ -96,6 +287,28 @@ export interface TagCount {
     tag: string;
     count: number;
 }
+/** One category and how many published documents are filed under it. */
+export interface CategoryCount {
+    category: string;
+    count: number;
+}
+/**
+ * Which of the two taxonomies a query is about.
+ *
+ * Spelled here rather than imported from `web/taxonomy.ts` because the index
+ * is underneath the web layer and should not depend on it; the two types are
+ * the same union, so they are assignable to each other.
+ */
+export type TaxonomyName = 'tag' | 'category';
+/** One term, and how much of the site carries it. */
+export interface TermUsage {
+    /** The term itself, as the files spell it. */
+    term: string;
+    /** Documents the public site lists under it: published, untrashed, due. */
+    published: number;
+    /** Every file carrying it, drafts, scheduled posts and the trash included. */
+    total: number;
+}
 /**
  * Thrown when two files claim the same permalink. Two documents at one URL is
  * a content mistake the site owner has to fix, so the index refuses it rather

package/dist/content/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/content/store.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAuB,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEjF,qEAAqE;AACrE,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C,+EAA+E;AAC/E,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC,wDAAwD;AACxD,MAAM,WAAW,uBAAuB;IACtC,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACjC,0EAA0E;IAC1E,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC/C,+EAA+E;IAC/E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,+DAA+D;IAC/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC9C,6EAA6E;IAC7E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxD;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC9C,gDAAgD;IAChD,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,EAAE,CAAC;IAC7C,mEAAmE;IACnE,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAC/D,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,EAAE,CAAC;IAC9C,iFAAiF;IACjF,SAAS,IAAI,MAAM,EAAE,CAAC;IACtB,iDAAiD;IACjD,MAAM,IAAI,aAAa,CAAC;IACxB,2DAA2D;IAC3D,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAC5D,0EAA0E;IAC1E,QAAQ,IAAI,QAAQ,EAAE,CAAC;IACvB,8CAA8C;IAC9C,KAAK,IAAI,IAAI,CAAC;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,yDAAyD;AACzD,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,oDAAoD;IACpD,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACjC;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,oDAAoD;IACpD,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yDAAyD;AACzD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAkB,IAAI,6BAA6B;IACnD,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7C,YAAY,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,SAAS,EAS/E;CACF;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAInE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,YAAY,CAgO/E"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/content/store.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAuB,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAGjF,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,+EAA+E;AAC/E,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC;AAE/B,wDAAwD;AACxD,eAAO,MAAM,WAAW,EAAE,KAAwB,CAAC;AAEnD,wDAAwD;AACxD,MAAM,WAAW,uBAAuB;IACtC,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;;;;;OAQG;IACH,GAAG,IAAI,IAAI,CAAC;IACZ;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IACjC,0EAA0E;IAC1E,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAC/C,+EAA+E;IAC/E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,IAAI,IAAI,CAAC;IACd,+DAA+D;IAC/D,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC9C,6EAA6E;IAC7E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxD;;;;;;;;OAQG;IACH,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC5D;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC9C,6DAA6D;IAC7D,SAAS,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,EAAE,CAAC;IAC7C;;;;;;;;;OASG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAC;IAC5C;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,kBAAkB,CAAC;IACnD;;;;;;OAMG;IACH,OAAO,IAAI,MAAM,GAAG,SAAS,CAAC;IAC9B;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAC;IACxC,mEAAmE;IACnE,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAC/D,2EAA2E;IAC3E,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IACzE;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,EAAE,CAAC;IAC1E,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,EAAE,CAAC;IAC9C;;;;;;;;;;OAUG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,EAAE,CAAC;IACjD,iFAAiF;IACjF,SAAS,IAAI,MAAM,EAAE,CAAC;IACtB,iDAAiD;IACjD,MAAM,IAAI,aAAa,CAAC;IACxB,2DAA2D;IAC3D,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAC5D,0EAA0E;IAC1E,QAAQ,IAAI,QAAQ,EAAE,CAAC;IACvB,0EAA0E;IAC1E,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACtE,gGAAgG;IAChG,aAAa,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC;IAChD,+EAA+E;IAC/E,cAAc,IAAI,aAAa,EAAE,CAAC;IAClC;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,SAAS,EAAE,CAAC;IACnD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,EAAE,CAAC;IAC1D,gFAAgF;IAChF,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,8CAA8C;IAC9C,KAAK,IAAI,IAAI,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC,kEAAkE;IAClE,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC7B;AAED,oEAAoE;AACpE,MAAM,WAAW,SAAS;IACxB,oBAAoB;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,sCAAsC;AACtC,MAAM,WAAW,WAAW;IAC1B,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,8DAA8D;AAC9D,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,oDAAoD;IACpD,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACjC;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,oDAAoD;IACpD,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,+EAA+E;IAC/E,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yDAAyD;AACzD,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wEAAwE;AACxE,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,UAAU,CAAC;AAE9C,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,SAAkB,IAAI,6BAA6B;IACnD,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7C,YAAY,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,SAAS,EAS/E;CACF;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAInE;AAuDD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,YAAY,CA+e/E"}