@geekity/cms 0.3.0 → 0.5.0

package/dist/comments/akismet.d.ts

@@ -0,0 +1,130 @@
+import type { CommentChecker } from './submission.ts';
+/**
+ * Akismet, as the one {@link CommentChecker} this package ships.
+ *
+ * The CMS knows about spam services through a seam and nothing else (doc-6):
+ * everything below implements that interface and reaches one HTTP API. Take
+ * this file away and comments still work, still queue, and still moderate.
+ *
+ * Two things make it optional at runtime rather than at build time:
+ *
+ * - **The key is a credential**, so it lives in `data/akismet.json` at mode
+ *   `0600` beside the password hashes and the actor's private keys, and never
+ *   in `content/_data/site.json`, which is public, in git and published with
+ *   the site.
+ * - **The key file is read on every call**, so a key pasted into the settings
+ *   screen starts filtering the next comment and a key removed stops filtering
+ *   at once. Without one, nothing is sent anywhere and the verdict is
+ *   `unknown` — the site's own rules decide, exactly as they did before
+ *   anybody had heard of Akismet.
+ */
+/** Where the key lives, under `dataDir`. */
+export declare const AKISMET_KEY_FILE = "akismet.json";
+/** The API this speaks. */
+export declare const AKISMET_ENDPOINT = "https://rest.akismet.com/1.1";
+/**
+ * What Akismet is told this is.
+ *
+ * Its docs ask for `Application/Version | Plugin/Version`, and the pair is how
+ * a report in their dashboard says which piece of software sent a call.
+ */
+export declare const AKISMET_USER_AGENT = "Geekity CMS/1.0 | Akismet/1.1";
+/**
+ * How long Akismet has to answer before the call is abandoned.
+ *
+ * A comment must not wait on somebody else's service: an abandoned call is a
+ * logged failure and no opinion, and the comment goes to the queue.
+ */
+export declare const AKISMET_TIMEOUT_MS = 10000;
+/** What the last {@link verifyAkismetKey} of a key came to. */
+export type AkismetKeyStatus = 
+/** Akismet said `valid`. */
+'valid'
+/** Akismet said `invalid`: the key is not one of theirs, or not any more. */
+ | 'invalid'
+/** Akismet could not be reached, so nothing is known either way. */
+ | 'unchecked';
+/** The key as `data/akismet.json` holds it. */
+export interface AkismetKeyRecord {
+    /** The key itself. */
+    key: string;
+    /** What Akismet said about it when it was last checked. */
+    status: AkismetKeyStatus;
+    /** When that was, as an instant. */
+    checkedAt: string;
+}
+/**
+ * The stored key, or `undefined` when the site has none.
+ *
+ * Read tolerantly and synchronously, like every other file this CMS treats as
+ * truth: a file that will not parse, or one with no key in it, is a site with
+ * no Akismet rather than a site that will not boot.
+ */
+export declare function readAkismetKey(dataDir: string): AkismetKeyRecord | undefined;
+/** Write the key, private to the account the site runs as. */
+export declare function writeAkismetKey(dataDir: string, record: AkismetKeyRecord): Promise<void>;
+/** Forget the key, which is how a site turns Akismet off. */
+export declare function removeAkismetKey(dataDir: string): Promise<void>;
+/** Where one site's key file is. */
+export declare function akismetKeyPath(dataDir: string): string;
+/** What {@link verifyAkismetKey} needs. */
+export interface VerifyAkismetKeyOptions {
+    /** The key to check. */
+    key: string;
+    /** The site's public origin, which Akismet calls the blog. */
+    blog: string;
+    /** The HTTP client. Defaults to the global `fetch`; a test hands in its own. */
+    fetch?: typeof fetch | undefined;
+    /** How long to wait. */
+    timeoutMs?: number | undefined;
+}
+/**
+ * Ask Akismet whether a key is one of theirs.
+ *
+ * Three answers rather than two, because "we could not ask" is not "no": a key
+ * typed while the machine is offline should not be reported as a bad key, and
+ * the settings screen says which of the two happened.
+ */
+export declare function verifyAkismetKey(options: VerifyAkismetKeyOptions): Promise<AkismetKeyStatus>;
+/** What {@link createAkismetChecker} needs around it. */
+export interface AkismetCheckerOptions {
+    /** Where the key file lives. Read on every call, so a new key needs no restart. */
+    dataDir: string;
+    /**
+     * The site's language, as `blog_lang` wants it.
+     *
+     * A function rather than a string because the setting is a file the admin
+     * rewrites: reading it when a comment arrives is what makes a change to it
+     * take effect at once, the way every other setting does (decision-9).
+     */
+    language: () => string;
+    /** The HTTP client. Defaults to the global `fetch`; a test hands in its own. */
+    fetch?: typeof fetch | undefined;
+    /** Where a failure is reported. Defaults to the console. */
+    logger?: {
+        warn(message: string): void;
+    } | undefined;
+    /** How long Akismet has to answer. */
+    timeoutMs?: number | undefined;
+    /**
+     * Send `is_test`, so nothing said here trains the classifier or counts
+     * against the site's plan. Off in production and on wherever a real key
+     * could conceivably meet a real endpoint from a test.
+     */
+    isTest?: boolean | undefined;
+}
+/**
+ * A {@link CommentChecker} that asks Akismet.
+ *
+ * Built whether or not the site has a key: with none, every method returns
+ * without sending anything, which is what lets a key pasted into the settings
+ * screen start working on the very next comment.
+ *
+ * Nothing here throws. The seam would catch it and call it `unknown` anyway
+ * (doc-6), but then the log would say only that a checker refused to answer;
+ * catching it here is what puts Akismet's own words — a 503, a
+ * `X-akismet-debug-help` — in front of whoever has to work out why the queue
+ * has stopped being filtered.
+ */
+export declare function createAkismetChecker(options: AkismetCheckerOptions): CommentChecker;
+//# sourceMappingURL=akismet.d.ts.map

package/dist/comments/akismet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"akismet.d.ts","sourceRoot":"","sources":["../../src/comments/akismet.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAoC,MAAM,iBAAiB,CAAC;AAExF;;;;;;;;;;;;;;;;;;GAkBG;AAEH,4CAA4C;AAC5C,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAE/C,2BAA2B;AAC3B,eAAO,MAAM,gBAAgB,iCAAiC,CAAC;AAE/D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,kCAAkC,CAAC;AAElE;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAEzC,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB;AAC1B,4BAA4B;AAC1B,OAAO;AACT,6EAA6E;GAC3E,SAAS;AACX,oEAAoE;GAClE,WAAW,CAAC;AAEhB,+CAA+C;AAC/C,MAAM,WAAW,gBAAgB;IAC/B,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,MAAM,EAAE,gBAAgB,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAsB5E;AAED,8DAA8D;AAC9D,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9F;AAED,6DAA6D;AAC7D,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErE;AAED,oCAAoC;AACpC,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,2CAA2C;AAC3C,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,KAAK,CAAC,EAAE,OAAO,KAAK,GAAG,SAAS,CAAC;IACjC,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,gBAAgB,CAAC,CAY3B;AAED,yDAAyD;AACzD,MAAM,WAAW,qBAAqB;IACpC,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,MAAM,CAAC;IACvB,gFAAgF;IAChF,KAAK,CAAC,EAAE,OAAO,KAAK,GAAG,SAAS,CAAC;IACjC,4DAA4D;IAC5D,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC;IACrD,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,cAAc,CA+DnF"}

package/dist/comments/akismet.js

@@ -0,0 +1,274 @@
+import { rm } from 'node:fs/promises';
+import path from 'node:path';
+import { readFileIfPresentSync, writeFileAtomically } from '../files/atomic.js';
+import { COMMENT_FIELDS } from './submission.js';
+/**
+ * Akismet, as the one {@link CommentChecker} this package ships.
+ *
+ * The CMS knows about spam services through a seam and nothing else (doc-6):
+ * everything below implements that interface and reaches one HTTP API. Take
+ * this file away and comments still work, still queue, and still moderate.
+ *
+ * Two things make it optional at runtime rather than at build time:
+ *
+ * - **The key is a credential**, so it lives in `data/akismet.json` at mode
+ *   `0600` beside the password hashes and the actor's private keys, and never
+ *   in `content/_data/site.json`, which is public, in git and published with
+ *   the site.
+ * - **The key file is read on every call**, so a key pasted into the settings
+ *   screen starts filtering the next comment and a key removed stops filtering
+ *   at once. Without one, nothing is sent anywhere and the verdict is
+ *   `unknown` — the site's own rules decide, exactly as they did before
+ *   anybody had heard of Akismet.
+ */
+/** Where the key lives, under `dataDir`. */
+export const AKISMET_KEY_FILE = 'akismet.json';
+/** The API this speaks. */
+export const AKISMET_ENDPOINT = 'https://rest.akismet.com/1.1';
+/**
+ * What Akismet is told this is.
+ *
+ * Its docs ask for `Application/Version | Plugin/Version`, and the pair is how
+ * a report in their dashboard says which piece of software sent a call.
+ */
+export const AKISMET_USER_AGENT = 'Geekity CMS/1.0 | Akismet/1.1';
+/**
+ * How long Akismet has to answer before the call is abandoned.
+ *
+ * A comment must not wait on somebody else's service: an abandoned call is a
+ * logged failure and no opinion, and the comment goes to the queue.
+ */
+export const AKISMET_TIMEOUT_MS = 10_000;
+/**
+ * The stored key, or `undefined` when the site has none.
+ *
+ * Read tolerantly and synchronously, like every other file this CMS treats as
+ * truth: a file that will not parse, or one with no key in it, is a site with
+ * no Akismet rather than a site that will not boot.
+ */
+export function readAkismetKey(dataDir) {
+    const raw = readFileIfPresentSync(akismetKeyPath(dataDir));
+    if (raw === undefined)
+        return undefined;
+    let parsed;
+    try {
+        parsed = JSON.parse(raw);
+    }
+    catch {
+        return undefined;
+    }
+    if (typeof parsed !== 'object' || parsed === null)
+        return undefined;
+    const file = parsed;
+    const key = typeof file['key'] === 'string' ? file['key'].trim() : '';
+    if (key === '')
+        return undefined;
+    const status = file['status'];
+    return {
+        key,
+        status: status === 'valid' || status === 'invalid' ? status : 'unchecked',
+        checkedAt: typeof file['checkedAt'] === 'string' ? file['checkedAt'] : '',
+    };
+}
+/** Write the key, private to the account the site runs as. */
+export async function writeAkismetKey(dataDir, record) {
+    await writeFileAtomically(akismetKeyPath(dataDir), `${JSON.stringify(record, null, 2)}\n`, {
+        mode: 0o600,
+    });
+}
+/** Forget the key, which is how a site turns Akismet off. */
+export async function removeAkismetKey(dataDir) {
+    await rm(akismetKeyPath(dataDir), { force: true });
+}
+/** Where one site's key file is. */
+export function akismetKeyPath(dataDir) {
+    return path.join(dataDir, AKISMET_KEY_FILE);
+}
+/**
+ * Ask Akismet whether a key is one of theirs.
+ *
+ * Three answers rather than two, because "we could not ask" is not "no": a key
+ * typed while the machine is offline should not be reported as a bad key, and
+ * the settings screen says which of the two happened.
+ */
+export async function verifyAkismetKey(options) {
+    const body = new URLSearchParams({ api_key: options.key, blog: options.blog });
+    let answer;
+    try {
+        answer = await post(`${AKISMET_ENDPOINT}/verify-key`, body, options.fetch, options.timeoutMs);
+    }
+    catch {
+        return 'unchecked';
+    }
+    if (!answer.ok)
+        return 'unchecked';
+    return answer.body.trim() === 'valid' ? 'valid' : 'invalid';
+}
+/**
+ * A {@link CommentChecker} that asks Akismet.
+ *
+ * Built whether or not the site has a key: with none, every method returns
+ * without sending anything, which is what lets a key pasted into the settings
+ * screen start working on the very next comment.
+ *
+ * Nothing here throws. The seam would catch it and call it `unknown` anyway
+ * (doc-6), but then the log would say only that a checker refused to answer;
+ * catching it here is what puts Akismet's own words — a 503, a
+ * `X-akismet-debug-help` — in front of whoever has to work out why the queue
+ * has stopped being filtered.
+ */
+export function createAkismetChecker(options) {
+    const warn = (message) => {
+        (options.logger ?? console).warn(message);
+    };
+    /** Send one call, or nothing at all when the site has no key. */
+    async function send(method, fields) {
+        const stored = readAkismetKey(options.dataDir);
+        if (stored === undefined)
+            return undefined;
+        try {
+            const answer = await post(`${AKISMET_ENDPOINT}/${method}`, fields(stored.key), options.fetch, options.timeoutMs);
+            if (!answer.ok) {
+                warn(`Akismet answered ${method} with ${String(answer.status)}.${help(answer)}`);
+                return undefined;
+            }
+            return answer;
+        }
+        catch (error) {
+            warn(`Akismet could not be asked about ${method}: ${messageOf(error)}`);
+            return undefined;
+        }
+    }
+    return {
+        async check(submission) {
+            const answer = await send('comment-check', (key) => checkFields(key, submission, options));
+            if (answer === undefined)
+                return 'unknown';
+            const said = answer.body.trim();
+            if (said === 'true')
+                return answer.proTip?.trim() === 'discard' ? 'discard' : 'spam';
+            // Anything that is not `true` or `false` is Akismet telling us the call
+            // was wrong — a key it does not know, a blog it cannot parse — and the
+            // header is where it says which.
+            if (said !== 'false') {
+                warn(`Akismet answered comment-check with ${JSON.stringify(said)}.${help(answer)}`);
+                return 'unknown';
+            }
+            // `false` is not `ham`. Akismet saw nothing wrong; whether that means
+            // approved or pending is TASK-50's rule about who has commented before,
+            // and this has no business overruling it.
+            return 'unknown';
+        },
+        async reportSpam(report) {
+            await send('submit-spam', (key) => reportFields(key, report, options));
+        },
+        async reportHam(report) {
+            await send('submit-ham', (key) => reportFields(key, report, options));
+        },
+    };
+}
+/** The fields one `comment-check` carries. */
+function checkFields(key, submission, options) {
+    const { comment } = submission;
+    // A webmention is a page linking here rather than a form somebody filled in,
+    // so it has no honeypot to name; a contact message is a form like a
+    // comment's, so it does.
+    const formless = (submission.type ?? comment.source) === 'webmention';
+    return fields({
+        api_key: key,
+        blog: submission.baseUrl,
+        blog_charset: 'UTF-8',
+        blog_lang: blogLang(options.language()),
+        user_ip: submission.address,
+        user_agent: submission.userAgent,
+        referrer: submission.referrer,
+        permalink: submission.post.url,
+        // What the caller says this is, or what the comment says it is: a
+        // webmention is a page linking here rather than a form somebody filled in,
+        // and Akismet takes a type it does not know as a type of its own.
+        comment_type: submission.type ?? (comment.source === 'webmention' ? 'webmention' : 'comment'),
+        comment_author: comment.author.name,
+        comment_author_email: comment.author.email ?? undefined,
+        comment_author_url: comment.author.url ?? undefined,
+        comment_content: comment.content.markdown,
+        comment_date_gmt: comment.submitted,
+        // Naming the honeypot lets Akismet see that a submission left it empty,
+        // which is one more thing it knows about a submission it is judging.
+        honeypot_field_name: formless ? undefined : COMMENT_FIELDS.trap,
+        is_test: options.isTest === true ? '1' : undefined,
+    });
+}
+/**
+ * The fields a `submit-spam` or `submit-ham` carries.
+ *
+ * As close to the original `comment-check` as this site can get, which is what
+ * Akismet asks for — but not all the way there. `user_ip`, `user_agent` and
+ * `referrer` are gone, because a stored comment keeps a salted hash of the
+ * address and nothing else (doc-6): the file is published with the site, and
+ * an address in it would be a reader's home written into a public repository.
+ * The content, the author and the permalink are what is left, and they are
+ * what a correction is mostly about.
+ */
+function reportFields(key, report, options) {
+    const { comment } = report;
+    return fields({
+        api_key: key,
+        blog: report.baseUrl,
+        blog_charset: 'UTF-8',
+        blog_lang: blogLang(options.language()),
+        permalink: report.url,
+        comment_type: comment.source === 'webmention' ? 'webmention' : 'comment',
+        comment_author: comment.author.name,
+        comment_author_email: comment.author.email ?? undefined,
+        comment_author_url: comment.author.url ?? undefined,
+        comment_content: comment.content.markdown,
+        comment_date_gmt: comment.submitted,
+        is_test: options.isTest === true ? '1' : undefined,
+    });
+}
+/** A body, with everything the site could not fill in left out entirely. */
+function fields(values) {
+    const body = new URLSearchParams();
+    for (const [name, value] of Object.entries(values)) {
+        if (value !== undefined && value !== '')
+            body.set(name, value);
+    }
+    return body;
+}
+/**
+ * A language setting as `blog_lang` wants it: ISO 639-1, so `en-GB` is `en`.
+ *
+ * The setting is a BCP 47 tag because that is what an `<html lang>` and a feed
+ * want; Akismet documents the shorter thing, and the primary subtag is it.
+ */
+function blogLang(language) {
+    return (language.split('-')[0] ?? '').trim().toLowerCase();
+}
+/** Whatever Akismet said was wrong, as a sentence to append to a log line. */
+function help(answer) {
+    return answer.debugHelp === undefined ? '' : ` ${answer.debugHelp}`;
+}
+function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+/** POST a urlencoded body to Akismet and read the answer. */
+async function post(url, body, client, timeoutMs) {
+    const call = client ?? globalThis.fetch;
+    const response = await call(url, {
+        method: 'POST',
+        headers: {
+            'content-type': 'application/x-www-form-urlencoded; charset=utf-8',
+            'user-agent': AKISMET_USER_AGENT,
+        },
+        body: body.toString(),
+        signal: AbortSignal.timeout(timeoutMs ?? AKISMET_TIMEOUT_MS),
+    });
+    return {
+        ok: response.ok,
+        status: response.status,
+        body: await response.text(),
+        proTip: response.headers.get('x-akismet-pro-tip') ?? undefined,
+        debugHelp: response.headers.get('x-akismet-debug-help') ?? undefined,
+    };
+}
+//# sourceMappingURL=akismet.js.map

package/dist/comments/akismet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"akismet.js","sourceRoot":"","sources":["../../src/comments/akismet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AACtC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGjD;;;;;;;;;;;;;;;;;;GAkBG;AAEH,4CAA4C;AAC5C,MAAM,CAAC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE/C,2BAA2B;AAC3B,MAAM,CAAC,MAAM,gBAAgB,GAAG,8BAA8B,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,+BAA+B,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAqBzC;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,MAAM,GAAG,GAAG,qBAAqB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3D,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAExC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACpE,MAAM,IAAI,GAAG,MAAiC,CAAC;IAC/C,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtE,IAAI,GAAG,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAEjC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,OAAO;QACL,GAAG;QACH,MAAM,EAAE,MAAM,KAAK,OAAO,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW;QACzE,SAAS,EAAE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE;KAC1E,CAAC;AACJ,CAAC;AAED,8DAA8D;AAC9D,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAe,EAAE,MAAwB;IAC7E,MAAM,mBAAmB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACzF,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC;AACL,CAAC;AAED,6DAA6D;AAC7D,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAe;IACpD,MAAM,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,cAAc,CAAC,OAAe;IAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AAC9C,CAAC;AAcD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAgC;IAEhC,MAAM,IAAI,GAAG,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE/E,IAAI,MAAqB,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,gBAAgB,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAChG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,WAAW,CAAC;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9D,CAAC;AA4BD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,MAAM,IAAI,GAAG,CAAC,OAAe,EAAQ,EAAE;QACrC,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC,CAAC;IAEF,iEAAiE;IACjE,KAAK,UAAU,IAAI,CACjB,MAAsD,EACtD,MAAwC;QAExC,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC/C,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAE3C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CACvB,GAAG,gBAAgB,IAAI,MAAM,EAAE,EAC/B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAClB,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,SAAS,CAClB,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBACf,IAAI,CAAC,oBAAoB,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACjF,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,oCAAoC,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACxE,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,CAAC,KAAK,CAAC,UAAU;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;YAC3F,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YAE3C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,IAAI,KAAK,MAAM;gBAAE,OAAO,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;YAErF,wEAAwE;YACxE,uEAAuE;YACvE,iCAAiC;YACjC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,IAAI,CAAC,uCAAuC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACpF,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,sEAAsE;YACtE,wEAAwE;YACxE,0CAA0C;YAC1C,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,MAAM;YACrB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,KAAK,CAAC,SAAS,CAAC,MAAM;YACpB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACxE,CAAC;KACF,CAAC;AACJ,CAAC;AAED,8CAA8C;AAC9C,SAAS,WAAW,CAClB,GAAW,EACX,UAA6B,EAC7B,OAA8B;IAE9B,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC;IAC/B,6EAA6E;IAC7E,oEAAoE;IACpE,yBAAyB;IACzB,MAAM,QAAQ,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,YAAY,CAAC;IAEtE,OAAO,MAAM,CAAC;QACZ,OAAO,EAAE,GAAG;QACZ,IAAI,EAAE,UAAU,CAAC,OAAO;QACxB,YAAY,EAAE,OAAO;QACrB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvC,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,UAAU,EAAE,UAAU,CAAC,SAAS;QAChC,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,SAAS,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG;QAC9B,kEAAkE;QAClE,2EAA2E;QAC3E,kEAAkE;QAClE,YAAY,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7F,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;QACnC,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,SAAS;QACvD,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,SAAS;QACnD,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ;QACzC,gBAAgB,EAAE,OAAO,CAAC,SAAS;QACnC,wEAAwE;QACxE,qEAAqE;QACrE,mBAAmB,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI;QAC/D,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,YAAY,CACnB,GAAW,EACX,MAAqB,EACrB,OAA8B;IAE9B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAE3B,OAAO,MAAM,CAAC;QACZ,OAAO,EAAE,GAAG;QACZ,IAAI,EAAE,MAAM,CAAC,OAAO;QACpB,YAAY,EAAE,OAAO;QACrB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC,GAAG;QACrB,YAAY,EAAE,OAAO,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;QACxE,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;QACnC,oBAAoB,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,SAAS;QACvD,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,SAAS;QACnD,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ;QACzC,gBAAgB,EAAE,OAAO,CAAC,SAAS;QACnC,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;KACnD,CAAC,CAAC;AACL,CAAC;AAED,4EAA4E;AAC5E,SAAS,MAAM,CAAC,MAA0C;IACxD,MAAM,IAAI,GAAG,IAAI,eAAe,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,QAAgB;IAChC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAC7D,CAAC;AAED,8EAA8E;AAC9E,SAAS,IAAI,CAAC,MAAqB;IACjC,OAAO,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;AACtE,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAgBD,6DAA6D;AAC7D,KAAK,UAAU,IAAI,CACjB,GAAW,EACX,IAAqB,EACrB,MAAgC,EAChC,SAA6B;IAE7B,MAAM,IAAI,GAAG,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC;IACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE;QAC/B,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,kDAAkD;YAClE,YAAY,EAAE,kBAAkB;SACjC;QACD,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;QACrB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;KAC7D,CAAC,CAAC;IAEH,OAAO;QACL,EAAE,EAAE,QAAQ,CAAC,EAAE;QACf,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;QAC3B,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,SAAS;QAC9D,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,SAAS;KACrE,CAAC;AACJ,CAAC"}

package/dist/comments/conversation.d.ts

@@ -0,0 +1,29 @@
+import type { AdminStore, PostComment } from '../admin/store.ts';
+import type { Document } from '../content/document.ts';
+import type { Interaction } from '../web/conversation.ts';
+/**
+ * Native comments as the conversation sees them.
+ *
+ * `web/conversation.ts` deliberately knows nothing about where an answer came
+ * from, so this is the translation: a stored comment becomes an
+ * {@link Interaction} and joins the fediverse replies in the same thread,
+ * nested by the same rule. Nothing about a comment survives the trip that a
+ * theme would have to special-case — the source is on the record so a theme
+ * *may*, not so it must.
+ *
+ * Only approved comments come through. A comment waiting for a moderator and
+ * one filed as spam are both in the file and both in the index, and neither is
+ * anything a reader should be shown.
+ */
+/** The approved comments on a post, as interactions, oldest first. */
+export declare function commentInteractions(admin: AdminStore, document: Document): Interaction[];
+/** One stored comment as the thread's own shape. */
+export declare function interactionOf(comment: PostComment, document: Document): Interaction;
+/**
+ * The `id` a comment is anchored at on the page.
+ *
+ * Prefixed rather than bare so a comment can never collide with a heading
+ * anchor the post's own Markdown produced.
+ */
+export declare function commentAnchor(id: string): string;
+//# sourceMappingURL=conversation.d.ts.map

package/dist/comments/conversation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["../../src/comments/conversation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AAEH,sEAAsE;AACtE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,WAAW,EAAE,CAKxF;AAED,oDAAoD;AACpD,wBAAgB,aAAa,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,GAAG,WAAW,CA2BnF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEhD"}

package/dist/comments/conversation.js

@@ -0,0 +1,60 @@
+/**
+ * Native comments as the conversation sees them.
+ *
+ * `web/conversation.ts` deliberately knows nothing about where an answer came
+ * from, so this is the translation: a stored comment becomes an
+ * {@link Interaction} and joins the fediverse replies in the same thread,
+ * nested by the same rule. Nothing about a comment survives the trip that a
+ * theme would have to special-case — the source is on the record so a theme
+ * *may*, not so it must.
+ *
+ * Only approved comments come through. A comment waiting for a moderator and
+ * one filed as spam are both in the file and both in the index, and neither is
+ * anything a reader should be shown.
+ */
+/** The approved comments on a post, as interactions, oldest first. */
+export function commentInteractions(admin, document) {
+    return admin
+        .listCommentsFor(document.slug)
+        .filter((comment) => comment.status === 'approved')
+        .map((comment) => interactionOf(comment, document));
+}
+/** One stored comment as the thread's own shape. */
+export function interactionOf(comment, document) {
+    return {
+        id: comment.id,
+        source: comment.source,
+        kind: comment.kind,
+        author: {
+            name: comment.author.name,
+            // A commenter has no fediverse identity: they gave a name, maybe a
+            // website, and nothing that names them anywhere else.
+            handle: null,
+            url: comment.author.url,
+            // Only a webmention has one: it came out of the source page's `h-card`,
+            // and a form asks nobody for a picture.
+            avatar: comment.author.avatar,
+            actorId: null,
+        },
+        // Where it can be read. A comment written here lives here, at its own
+        // anchor; a webmention lives on the page it was sent from, and its `url`
+        // says so. A theme that prints `url` for a fediverse reply prints a
+        // working link for either.
+        url: comment.url ?? `${document.permalink}#${commentAnchor(comment.id)}`,
+        content: comment.content.html,
+        published: new Date(comment.submitted),
+        inReplyTo: comment.inReplyTo,
+        status: comment.status,
+        replies: [],
+    };
+}
+/**
+ * The `id` a comment is anchored at on the page.
+ *
+ * Prefixed rather than bare so a comment can never collide with a heading
+ * anchor the post's own Markdown produced.
+ */
+export function commentAnchor(id) {
+    return `comment-${id}`;
+}
+//# sourceMappingURL=conversation.js.map

package/dist/comments/conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../src/comments/conversation.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AAEH,sEAAsE;AACtE,MAAM,UAAU,mBAAmB,CAAC,KAAiB,EAAE,QAAkB;IACvE,OAAO,KAAK;SACT,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC;SAC9B,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC;SAClD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,aAAa,CAAC,OAAoB,EAAE,QAAkB;IACpE,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,EAAE;YACN,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;YACzB,mEAAmE;YACnE,sDAAsD;YACtD,MAAM,EAAE,IAAI;YACZ,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;YACvB,wEAAwE;YACxE,wCAAwC;YACxC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM;YAC7B,OAAO,EAAE,IAAI;SACd;QACD,sEAAsE;QACtE,yEAAyE;QACzE,oEAAoE;QACpE,2BAA2B;QAC3B,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,QAAQ,CAAC,SAAS,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;QACxE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;QAC7B,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,OAAO,WAAW,EAAE,EAAE,CAAC;AACzB,CAAC"}

package/dist/comments/form.d.ts

@@ -0,0 +1,123 @@
+import type { Document } from '../content/document.ts';
+import { COMMENT_FIELDS } from './submission.ts';
+import type { CommentForm, CommentProblems } from './submission.ts';
+/**
+ * The comment form as a template receives it.
+ *
+ * The theme renders `partials/comment-form.njk` from this, and it is on the
+ * context only when the post is actually taking comments — so a closed post
+ * shows the thread with no form, and a layout asks `{% if commentForm %}`
+ * rather than working out the rules for itself.
+ */
+export interface CommentFormContext {
+    /** Where the form posts. */
+    action: string;
+    /** The name each field is submitted under. */
+    fields: typeof COMMENT_FIELDS;
+    /** Which post is being commented on, as the hidden field carries it. */
+    post: string;
+    /**
+     * When this form was rendered, in epoch milliseconds, as the hidden field
+     * carries it. What the minimum submit time is measured against.
+     */
+    loaded: string;
+    /** What is in the fields: empty on a fresh form, what was typed on a refused one. */
+    values: Record<'name' | 'email' | 'url' | 'body' | 'inReplyTo' | 'notify', string>;
+    /**
+     * Whether to offer "tell me about replies" at all (TASK-55).
+     *
+     * False on a site that sends no mail, where the box would be a promise
+     * nothing could keep. A theme asks `{% if commentForm.notifiable %}`.
+     */
+    notifiable: boolean;
+    /** One message per field a person has to put right. Empty on a fresh form. */
+    problems: CommentProblems;
+    /** A message about the submission as a whole, when there is one. */
+    error?: string | undefined;
+    /** The longest a name may be, for the field's `maxlength`. */
+    nameLength: number;
+    /** The longest a comment may be, for the textarea's `maxlength`. */
+    bodyLength: number;
+    /**
+     * Who the site knows is filling this in, when a session says so (TASK-103).
+     *
+     * Absent for a stranger, so a theme asks `{% if commentForm.signedInAs %}`
+     * and draws the short form — the comment box and a sentence naming the
+     * person — instead of the name, email and website boxes and the honeypot.
+     * Nothing about the account is here but the two things the sentence prints:
+     * the email is never handed to a template, exactly as a stranger's never is.
+     */
+    signedInAs?: {
+        name: string;
+        url: string;
+    } | undefined;
+    /**
+     * The token the signed-in form carries, and absent on a stranger's.
+     *
+     * A form that acts on nobody's behalf needs none; the moment this one posts
+     * under somebody's name, a page on another site could make them post without
+     * knowing it, so it carries the same per-session token every admin form
+     * does and the endpoint checks it the way the admin guard does.
+     */
+    csrfToken?: string | undefined;
+}
+/**
+ * Who the site knows is commenting, when a valid session says so.
+ *
+ * Read from the session on the request rather than from anything the browser
+ * typed: `email` is the account's, which the comment is stored with and which
+ * no template is ever handed, and `csrfToken` is that session's own.
+ */
+export interface CommentViewer {
+    /** What the comment goes under: their display name, else their username. */
+    name: string;
+    /** Their author archive, which is the comment's website. */
+    url: string;
+    /** The account's email, which is stored and never shown. */
+    email: string | null;
+    /** This session's CSRF token, which the form carries. */
+    csrfToken: string;
+}
+/**
+ * The same form drawn for somebody the site knows rather than for a stranger.
+ *
+ * A function over a built form rather than another parameter on the two
+ * builders, so `commentForm` and `refilledCommentForm` keep the signatures the
+ * package publishes and there is one place that decides what "signed in"
+ * changes about a form.
+ */
+export declare function signedInCommentForm(form: CommentFormContext, viewer: CommentViewer): CommentFormContext;
+/** Where the comment form posts. */
+export declare const COMMENT_POST_PATH = "/_geekity/comments";
+/** The query the redirect after a submission carries, and what it can say. */
+export declare const COMMENT_NOTICE_PARAM = "comment";
+/**
+ * The query a Reply link on a comment carries.
+ *
+ * Threading without a line of JavaScript: the link goes to the form with the
+ * comment it answers named in the URL, the form puts that in its hidden field,
+ * and Cancel is a link back to the page without the query.
+ */
+export declare const COMMENT_REPLY_PARAM = "reply_to";
+/**
+ * What that query means, and what the reader is told.
+ *
+ * A redirect rather than a rendered page, so a refresh does not post the
+ * comment again; a query rather than a flash, because a reader has no session
+ * to hang one on.
+ */
+export declare const COMMENT_NOTICES: Readonly<Record<string, string>>;
+/** A fresh, empty form for a post that is taking comments. */
+export declare function commentForm(document: Document, now?: Date, notifiable?: boolean): CommentFormContext;
+/**
+ * The same form with what somebody typed still in it.
+ *
+ * What a refused submission is answered with: losing a paragraph because an
+ * email address had a typo in it is the fastest way to lose a commenter.
+ */
+export declare function refilledCommentForm(document: Document, values: CommentFormContext['values'], problems: CommentProblems, now?: Date, error?: string, notifiable?: boolean): CommentFormContext;
+/** What a form holds before anybody has typed in it. */
+export declare function blankValues(): CommentFormContext['values'];
+/** What a submitted form typed, for putting back in a refused one. */
+export declare function valuesOf(form: CommentForm): CommentFormContext['values'];
+//# sourceMappingURL=form.d.ts.map

package/dist/comments/form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/comments/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,cAAc,EAA4C,MAAM,iBAAiB,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,MAAM,EAAE,OAAO,cAAc,CAAC;IAC9B,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,EAAE,MAAM,CAAC,CAAC;IACnF;;;;;OAKG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,8EAA8E;IAC9E,QAAQ,EAAE,eAAe,CAAC;IAC1B,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACvD;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,kBAAkB,EACxB,MAAM,EAAE,aAAa,GACpB,kBAAkB,CAMpB;AAED,oCAAoC;AACpC,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AAEtD,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,YAAY,CAAC;AAE9C;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAG5D,CAAC;AAEF,8DAA8D;AAC9D,wBAAgB,WAAW,CACzB,QAAQ,EAAE,QAAQ,EAClB,GAAG,GAAE,IAAiB,EACtB,UAAU,UAAQ,GACjB,kBAAkB,CAEpB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,kBAAkB,CAAC,QAAQ,CAAC,EACpC,QAAQ,EAAE,eAAe,EACzB,GAAG,GAAE,IAAiB,EACtB,KAAK,CAAC,EAAE,MAAM,EACd,UAAU,UAAQ,GACjB,kBAAkB,CAapB;AAED,wDAAwD;AACxD,wBAAgB,WAAW,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAE1D;AAED,sEAAsE;AACtE,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CASxE"}