@geekity/cms 0.3.0 → 0.4.0

package/dist/admin/settings-email.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Email: how the site sends mail, and where a message written to it goes.
+ *
+ * The settings are here and the credentials are not: an API key and an SMTP
+ * password live in `data/mail.json` at mode 0600, never in the public
+ * `site.json`, and they are their own pair of forms so a credential typed wrong
+ * cannot lose an edit to the From line beside it.
+ */
+import type { SettingsPage } from './settings-page.ts';
+import type { SiteSettings } from './settings.ts';
+/**
+ * Where the mail credential's form and its Remove button post.
+ *
+ * Its own endpoint for the reason the Akismet key has one: an API key and an
+ * SMTP password are credentials, they live in `data/mail.json` rather than in
+ * `content/_data/site.json`, and a credential typed wrong must not lose an edit
+ * to the From line. Which provider is in use and who mail is from are settings
+ * and stay on the Email form.
+ */
+export declare const MAIL_PATH = "/admin/settings/mail";
+/** The fields the credential form and its Remove button submit. */
+export declare const MAIL_FIELDS: {
+    readonly brevoApiKey: 'brevo_api_key';
+    readonly smtpHost: 'smtp_host';
+    readonly smtpPort: 'smtp_port';
+    readonly smtpSecure: 'smtp_secure';
+    readonly smtpUser: 'smtp_user';
+    readonly smtpPassword: 'smtp_password';
+    readonly action: 'action';
+};
+/** The {@link MAIL_FIELDS.action} that forgets every mail credential. */
+export declare const MAIL_REMOVE = "remove";
+/** Where the Send test email button posts. */
+export declare const MAIL_TEST_PATH = "/admin/settings/mail/test";
+/** The field that form submits: where to send the test message. */
+export declare const MAIL_TEST_FIELDS: {
+    readonly to: 'to';
+};
+/** The message the Send test email button sends, as the theme names it. */
+export declare const MAIL_TEST_TEMPLATE = "test";
+/** The Email settings page. */
+export declare const EMAIL_SETTINGS: SettingsPage;
+/**
+ * What the page says about email: which provider is chosen, whether the
+ * credential it needs is there, and enough of it to recognise which one.
+ *
+ * Nothing here ever prints a key or a password. A settings screen that echoed
+ * one would put a credential in every browser cache, every screenshot and every
+ * `view-source`; the last four characters of an API key and the host and user
+ * of an SMTP connection are enough for somebody to tell what is stored without
+ * being handed the means to use it.
+ */
+export declare function mailPanel(dataDir: string, settings: SiteSettings): Record<string, unknown>;
+//# sourceMappingURL=settings-email.d.ts.map

package/dist/admin/settings-email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-email.d.ts","sourceRoot":"","sources":["../../src/admin/settings-email.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAcH,OAAO,KAAK,EAAwB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAGlD;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,yBAA0B,CAAC;AAEjD,mEAAmE;AACnE,eAAO,MAAM,WAAW;aACtB,WAAW,EAAE,eAAe;aAC5B,QAAQ,EAAE,WAAW;aACrB,QAAQ,EAAE,WAAW;aACrB,UAAU,EAAE,aAAa;aACzB,QAAQ,EAAE,WAAW;aACrB,YAAY,EAAE,eAAe;aAC7B,MAAM,EAAE,QAAQ;CACR,CAAC;AAEX,yEAAyE;AACzE,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC,8CAA8C;AAC9C,eAAO,MAAM,cAAc,8BAA+B,CAAC;AAE3D,mEAAmE;AACnE,eAAO,MAAM,gBAAgB;aAAK,EAAE,EAAE,IAAI;CAAW,CAAC;AAEtD,2EAA2E;AAC3E,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAEzC,+BAA+B;AAC/B,eAAO,MAAM,cAAc,EAAE,YAU5B,CAAC;AA+GF;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CA2C1F"}

package/dist/admin/settings-email.js

@@ -0,0 +1,189 @@
+/**
+ * Email: how the site sends mail, and where a message written to it goes.
+ *
+ * The settings are here and the credentials are not: an API key and an SMTP
+ * password live in `data/mail.json` at mode 0600, never in the public
+ * `site.json`, and they are their own pair of forms so a credential typed wrong
+ * cannot lose an edit to the From line beside it.
+ */
+import { readMailCredentials, removeMailCredentials, writeMailCredentials, } from '../mail/credentials.js';
+import { MAIL_PROVIDERS } from '../mail/provider.js';
+import { flash } from './flash.js';
+import { bodyField, settingsPagePath } from './settings-page.js';
+import { EMAIL_PATTERN, readSiteSettings, SETTINGS_PATH } from './settings.js';
+import { ADMIN_TEMPLATES } from './templates.js';
+/**
+ * Where the mail credential's form and its Remove button post.
+ *
+ * Its own endpoint for the reason the Akismet key has one: an API key and an
+ * SMTP password are credentials, they live in `data/mail.json` rather than in
+ * `content/_data/site.json`, and a credential typed wrong must not lose an edit
+ * to the From line. Which provider is in use and who mail is from are settings
+ * and stay on the Email form.
+ */
+export const MAIL_PATH = `${SETTINGS_PATH}/mail`;
+/** The fields the credential form and its Remove button submit. */
+export const MAIL_FIELDS = {
+    brevoApiKey: 'brevo_api_key',
+    smtpHost: 'smtp_host',
+    smtpPort: 'smtp_port',
+    smtpSecure: 'smtp_secure',
+    smtpUser: 'smtp_user',
+    smtpPassword: 'smtp_password',
+    action: 'action',
+};
+/** The {@link MAIL_FIELDS.action} that forgets every mail credential. */
+export const MAIL_REMOVE = 'remove';
+/** Where the Send test email button posts. */
+export const MAIL_TEST_PATH = `${SETTINGS_PATH}/mail/test`;
+/** The field that form submits: where to send the test message. */
+export const MAIL_TEST_FIELDS = { to: 'to' };
+/** The message the Send test email button sends, as the theme names it. */
+export const MAIL_TEST_TEMPLATE = 'test';
+/** The Email settings page. */
+export const EMAIL_SETTINGS = {
+    child: 'email',
+    label: 'Email',
+    path: settingsPagePath('email'),
+    template: ADMIN_TEMPLATES.settingsEmail,
+    fields: ['mailProvider', 'mailFromName', 'mailFromAddress', 'mailReplyTo', 'contactEmail'],
+    panels: (c, settings) => mailPanel(c.var.config.dataDir, settings),
+    endpoints: mountMail,
+};
+/** The mail credential's endpoints: save it, forget it, and prove it works. */
+function mountMail(app, _options) {
+    const here = EMAIL_SETTINGS.path;
+    /**
+     * The mail credential: one form saves it, a second forgets it.
+     *
+     * It keeps both providers' credentials at once, so a site trying SMTP after
+     * Brevo can switch the provider back without pasting the key in again.
+     *
+     * A blank secret keeps the stored one. The form cannot render a password back
+     * into a page, so a blank field has to mean "unchanged" or nobody could ever
+     * edit the SMTP port without retyping the password.
+     */
+    app.post(MAIL_PATH, async (c) => {
+        const body = await c.req.parseBody();
+        const { config } = c.var;
+        const stored = readMailCredentials(config.dataDir);
+        if (bodyField(body[MAIL_FIELDS.action]) === MAIL_REMOVE) {
+            await removeMailCredentials(config.dataDir);
+            flash(c, 'notice', 'The mail credentials are gone. No email is sent any more.');
+            return c.redirect(here, 303);
+        }
+        const apiKey = bodyField(body[MAIL_FIELDS.brevoApiKey]).trim();
+        const host = bodyField(body[MAIL_FIELDS.smtpHost]).trim();
+        const port = Number(bodyField(body[MAIL_FIELDS.smtpPort]).trim());
+        const password = bodyField(body[MAIL_FIELDS.smtpPassword]);
+        if (host !== '' && (!Number.isInteger(port) || port < 1 || port > 65535)) {
+            flash(c, 'error', 'An SMTP port is a whole number between 1 and 65535. Nothing was saved.');
+            return c.redirect(here, 303);
+        }
+        const credentials = {
+            ...(apiKey === ''
+                ? stored.brevo === undefined
+                    ? {}
+                    : { brevo: stored.brevo }
+                : { brevo: { apiKey } }),
+            ...(host === ''
+                ? stored.smtp === undefined
+                    ? {}
+                    : { smtp: stored.smtp }
+                : {
+                    smtp: {
+                        host,
+                        port,
+                        secure: bodyField(body[MAIL_FIELDS.smtpSecure]) !== '',
+                        user: bodyField(body[MAIL_FIELDS.smtpUser]).trim(),
+                        // A blank password keeps the stored one, so the port and the user
+                        // can be edited without retyping a secret the form was never
+                        // allowed to show.
+                        password: password === '' ? (stored.smtp?.password ?? '') : password,
+                    },
+                }),
+        };
+        await writeMailCredentials(config.dataDir, credentials);
+        const settings = readSiteSettings(config.contentDir);
+        flash(c, 'notice', settings.mailProvider === 'none'
+            ? 'Saved. Choose a provider above and save the settings to start sending.'
+            : 'Saved. Send a test message to prove it reaches you.');
+        return c.redirect(here, 303);
+    });
+    /**
+     * Send test email: the one button that proves the whole chain.
+     *
+     * It goes through the same mail service every feature will, so what it proves
+     * is not "these credentials parse" but "a message from this site arrives" —
+     * the template, the From line, the provider and the retry included. Whatever
+     * the provider said comes back on the flash, its own words and all, because a
+     * refusal names the field to fix and a summary of one never does.
+     */
+    app.post(MAIL_TEST_PATH, async (c) => {
+        const body = await c.req.parseBody();
+        const to = bodyField(body[MAIL_TEST_FIELDS.to]).trim();
+        if (!EMAIL_PATTERN.test(to)) {
+            flash(c, 'error', 'Type the address to send the test message to.');
+            return c.redirect(here, 303);
+        }
+        const result = await c.var.mail.send({ to, template: MAIL_TEST_TEMPLATE });
+        flash(c, result.ok && !result.skipped ? 'notice' : 'error', result.skipped
+            ? 'No mail is configured, so nothing was sent. Choose a provider and save a credential first.'
+            : result.ok
+                ? `A test message was sent to ${to} via ${result.provider}${result.messageId === undefined ? '' : ` (${result.messageId})`}. If it does not arrive, look in the spam folder and at the provider's own log.`
+                : `${result.provider} would not send to ${to} after ${String(result.attempts)} ${result.attempts === 1 ? 'attempt' : 'attempts'}: ${result.error ?? 'no reason given'}`);
+        return c.redirect(here, 303);
+    });
+}
+/**
+ * What the page says about email: which provider is chosen, whether the
+ * credential it needs is there, and enough of it to recognise which one.
+ *
+ * Nothing here ever prints a key or a password. A settings screen that echoed
+ * one would put a credential in every browser cache, every screenshot and every
+ * `view-source`; the last four characters of an API key and the host and user
+ * of an SMTP connection are enough for somebody to tell what is stored without
+ * being handed the means to use it.
+ */
+export function mailPanel(dataDir, settings) {
+    const stored = readMailCredentials(dataDir);
+    const present = settings.mailProvider === 'brevo' ? stored.brevo !== undefined : stored.smtp !== undefined;
+    return {
+        mailUrl: MAIL_PATH,
+        mailFields: MAIL_FIELDS,
+        mailRemove: MAIL_REMOVE,
+        mailTestUrl: MAIL_TEST_PATH,
+        mailTestFields: MAIL_TEST_FIELDS,
+        mailProviders: MAIL_PROVIDERS,
+        mailProvider: settings.mailProvider,
+        // Whether the chosen provider has what it needs. A key stored for the
+        // provider that is not chosen is not "configured": nothing would use it.
+        mailConfigured: settings.mailProvider !== 'none' && present,
+        mailBrevoPresent: stored.brevo !== undefined,
+        mailSmtpPresent: stored.smtp !== undefined,
+        ...(stored.brevo === undefined
+            ? {}
+            : { mailBrevoKeyHint: `…${stored.brevo.apiKey.slice(-4)}` }),
+        ...(stored.smtp === undefined
+            ? {}
+            : {
+                mailSmtp: {
+                    host: stored.smtp.host,
+                    port: stored.smtp.port,
+                    secure: stored.smtp.secure,
+                    user: stored.smtp.user,
+                    // Not the password. Whether there is one at all is all the screen
+                    // needs to say.
+                    hasPassword: stored.smtp.password !== '',
+                },
+            }),
+        mailHint: settings.mailProvider === 'none'
+            ? 'This site sends no email. Password resets, moderation notices and contact messages are still recorded; they are simply not sent.'
+            : present
+                ? 'Mail is configured. Send a test message to prove it reaches you.'
+                : settings.mailProvider === 'brevo'
+                    ? 'Brevo is chosen but there is no API key, so nothing is sent.'
+                    : 'SMTP is chosen but there is no server, so nothing is sent.',
+    };
+}
+//# sourceMappingURL=settings-email.js.map

package/dist/admin/settings-email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-email.js","sourceRoot":"","sources":["../../src/admin/settings-email.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAKH,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE/E,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,aAAa,OAAO,CAAC;AAEjD,mEAAmE;AACnE,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,eAAe;IAC5B,QAAQ,EAAE,WAAW;IACrB,QAAQ,EAAE,WAAW;IACrB,UAAU,EAAE,aAAa;IACzB,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,eAAe;IAC7B,MAAM,EAAE,QAAQ;CACR,CAAC;AAEX,yEAAyE;AACzE,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC;AAEpC,8CAA8C;AAC9C,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,aAAa,YAAY,CAAC;AAE3D,mEAAmE;AACnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,EAAE,EAAE,IAAI,EAAW,CAAC;AAEtD,2EAA2E;AAC3E,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC,+BAA+B;AAC/B,MAAM,CAAC,MAAM,cAAc,GAAiB;IAC1C,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,gBAAgB,CAAC,OAAO,CAAC;IAC/B,QAAQ,EAAE,eAAe,CAAC,aAAa;IACvC,MAAM,EAAE,CAAC,cAAc,EAAE,cAAc,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,CAAC;IAE1F,MAAM,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;IAElE,SAAS,EAAE,SAAS;CACrB,CAAC;AAEF,+EAA+E;AAC/E,SAAS,SAAS,CAAC,GAAqB,EAAE,QAA8B;IACtE,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;IAEjC;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACrC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC;QACzB,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnD,IAAI,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,WAAW,EAAE,CAAC;YACxD,MAAM,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC5C,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,2DAA2D,CAAC,CAAC;YAChF,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/D,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QAE3D,IAAI,IAAI,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YACzE,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,wEAAwE,CAAC,CAAC;YAC5F,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,WAAW,GAAoB;YACnC,GAAG,CAAC,MAAM,KAAK,EAAE;gBACf,CAAC,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS;oBAC1B,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE;gBAC3B,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC;YAC1B,GAAG,CAAC,IAAI,KAAK,EAAE;gBACb,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;oBACzB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;gBACzB,CAAC,CAAC;oBACE,IAAI,EAAE;wBACJ,IAAI;wBACJ,IAAI;wBACJ,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE;wBACtD,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE;wBAClD,kEAAkE;wBAClE,6DAA6D;wBAC7D,mBAAmB;wBACnB,QAAQ,EAAE,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ;qBACrE;iBACF,CAAC;SACP,CAAC;QAEF,MAAM,oBAAoB,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAExD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrD,KAAK,CACH,CAAC,EACD,QAAQ,EACR,QAAQ,CAAC,YAAY,KAAK,MAAM;YAC9B,CAAC,CAAC,wEAAwE;YAC1E,CAAC,CAAC,qDAAqD,CAC1D,CAAC;QACF,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACrC,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAEvD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,+CAA+C,CAAC,CAAC;YACnE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAE3E,KAAK,CACH,CAAC,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EACjD,MAAM,CAAC,OAAO;YACZ,CAAC,CAAC,4FAA4F;YAC9F,CAAC,CAAC,MAAM,CAAC,EAAE;gBACT,CAAC,CAAC,8BAA8B,EAAE,QAAQ,MAAM,CAAC,QAAQ,GACrD,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,SAAS,GAC7D,iFAAiF;gBACnF,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,sBAAsB,EAAE,UAAU,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IACzE,MAAM,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UACtC,KAAK,MAAM,CAAC,KAAK,IAAI,iBAAiB,EAAE,CAC/C,CAAC;QACF,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,OAAe,EAAE,QAAsB;IAC/D,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,OAAO,GACX,QAAQ,CAAC,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC;IAE7F,OAAO;QACL,OAAO,EAAE,SAAS;QAClB,UAAU,EAAE,WAAW;QACvB,UAAU,EAAE,WAAW;QACvB,WAAW,EAAE,cAAc;QAC3B,cAAc,EAAE,gBAAgB;QAChC,aAAa,EAAE,cAAc;QAC7B,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,sEAAsE;QACtE,yEAAyE;QACzE,cAAc,EAAE,QAAQ,CAAC,YAAY,KAAK,MAAM,IAAI,OAAO;QAC3D,gBAAgB,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS;QAC5C,eAAe,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS;QAC1C,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS;YAC5B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC9D,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;YAC3B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI;oBACtB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI;oBACtB,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;oBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI;oBACtB,kEAAkE;oBAClE,gBAAgB;oBAChB,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE;iBACzC;aACF,CAAC;QACN,QAAQ,EACN,QAAQ,CAAC,YAAY,KAAK,MAAM;YAC9B,CAAC,CAAC,kIAAkI;YACpI,CAAC,CAAC,OAAO;gBACP,CAAC,CAAC,kEAAkE;gBACpE,CAAC,CAAC,QAAQ,CAAC,YAAY,KAAK,OAAO;oBACjC,CAAC,CAAC,8DAA8D;oBAChE,CAAC,CAAC,4DAA4D;KACvE,CAAC;AACJ,CAAC"}

package/dist/admin/settings-federation.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Federation: which relays the site subscribes to.
+ *
+ * There is nothing else on this page any more. decision-14 replaced the site
+ * actor with one actor per user, so the handle, the type and the picture a
+ * site used to federate under are a user's profile, edited on the users
+ * screen; what is left here is the one setting that is an instruction as well
+ * as a value — a line added is a `Follow` to send and a line removed is an
+ * `Undo` — so a save of this page reconciles them.
+ */
+import type { WordPressRequests } from '../federation/wordpress.ts';
+import type { User } from './accounts.ts';
+import type { SettingsPage } from './settings-page.ts';
+/** The Federation settings page. */
+export declare const FEDERATION_SETTINGS: SettingsPage;
+/** One compatibility path, as the panel beside the switch shows it. */
+export interface WordPressRouteRow {
+    /** The path itself, which is what a peer still holds. */
+    readonly path: string;
+    /** Whose it is, or the empty string for the instance-wide inbox. */
+    readonly username: string;
+    /** When it was last asked for, or `null` for never. */
+    readonly lastRequestedAt: string | null;
+}
+/**
+ * Every path the compatibility switch answers, and when each was last asked
+ * for.
+ *
+ * The whole point of the panel: the switch can come off once no follower's
+ * server is delivering to the old URLs any more, and that is a question only
+ * the record of what was asked for can answer. So a route nobody has ever
+ * asked for is listed too, saying never — an empty table would read as "no
+ * such path" rather than as "nobody is using it".
+ *
+ * A user with no WordPress number is not here at all: the plugin never
+ * published a path for them, so there is nothing for a peer to be holding.
+ */
+export declare function wordPressRoutes(users: readonly User[], requests: WordPressRequests): WordPressRouteRow[];
+//# sourceMappingURL=settings-federation.d.ts.map

package/dist/admin/settings-federation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-federation.d.ts","sourceRoot":"","sources":["../../src/admin/settings-federation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAQH,OAAO,KAAK,EAAE,iBAAiB,EAAkB,MAAM,4BAA4B,CAAC;AAEpF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGvD,oCAAoC;AACpC,eAAO,MAAM,mBAAmB,EAAE,YAmBjC,CAAC;AAwCF,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,QAAQ,EAAE,iBAAiB,GAC1B,iBAAiB,EAAE,CA6BrB"}

package/dist/admin/settings-federation.js

@@ -0,0 +1,103 @@
+/**
+ * Federation: which relays the site subscribes to.
+ *
+ * There is nothing else on this page any more. decision-14 replaced the site
+ * actor with one actor per user, so the handle, the type and the picture a
+ * site used to federate under are a user's profile, edited on the users
+ * screen; what is left here is the one setting that is an instruction as well
+ * as a value — a line added is a `Follow` to send and a line removed is an
+ * `Undo` — so a save of this page reconciles them.
+ */
+import { readWordPressRequests, WORDPRESS_ACTIVITYPUB_BASE, WORDPRESS_SHARED_INBOX_PATH, } from '../federation/wordpress.js';
+import { listUsers } from './accounts.js';
+import { settingsPagePath } from './settings-page.js';
+import { ADMIN_TEMPLATES } from './templates.js';
+/** The Federation settings page. */
+export const FEDERATION_SETTINGS = {
+    child: 'federation',
+    label: 'Federation',
+    path: settingsPagePath('federation'),
+    template: ADMIN_TEMPLATES.settingsFederation,
+    fields: ['relays', 'wordpressActivityPub'],
+    panels: (c) => ({
+        wordpressRoutes: wordPressRoutes(listUsers(c.var.config.dataDir), readWordPressRequests(c.var.config.dataDir)),
+    }),
+    saved: (c) => {
+        // The reconciliation reads the settings that were just written, so it has
+        // to come after the save rather than be derived from the form.
+        return toldRelays(c.var.relays.sync());
+    },
+};
+/**
+ * The sentence a flash adds about the relays a save subscribed to or left.
+ *
+ * A relay does not answer at once — FEP-ae0c allows a human to approve the
+ * subscription days later — so the message says a follow was sent rather than
+ * that the site is now on the relay, and points at the screen that will say.
+ */
+function toldRelays(report) {
+    const parts = [];
+    if (report.followed.length > 0) {
+        parts.push(report.followed.length === 1
+            ? 'A follow has been sent to one new relay'
+            : `Follows have been sent to ${String(report.followed.length)} new relays`);
+    }
+    if (report.unfollowed.length > 0) {
+        parts.push(report.unfollowed.length === 1
+            ? 'one relay has been unfollowed'
+            : `${String(report.unfollowed.length)} relays have been unfollowed`);
+    }
+    if (parts.length === 0)
+        return '';
+    const sentence = parts.join(', and ');
+    return ` ${sentence.charAt(0).toUpperCase()}${sentence.slice(1)}; the Federation screen says where each stands.`;
+}
+/** The order the paths are listed in, which is the order the plugin's actor names them. */
+const WORDPRESS_ROUTE_ORDER = [
+    'actor',
+    'inbox',
+    'outbox',
+    'followers',
+    'following',
+];
+/**
+ * Every path the compatibility switch answers, and when each was last asked
+ * for.
+ *
+ * The whole point of the panel: the switch can come off once no follower's
+ * server is delivering to the old URLs any more, and that is a question only
+ * the record of what was asked for can answer. So a route nobody has ever
+ * asked for is listed too, saying never — an empty table would read as "no
+ * such path" rather than as "nobody is using it".
+ *
+ * A user with no WordPress number is not here at all: the plugin never
+ * published a path for them, so there is nothing for a peer to be holding.
+ */
+export function wordPressRoutes(users, requests) {
+    const rows = [];
+    for (const user of users) {
+        if (user.wordpressActorId === undefined)
+            continue;
+        const asked = requests.users[user.username] ?? {};
+        const actor = `${WORDPRESS_ACTIVITYPUB_BASE}/actors/${String(user.wordpressActorId)}`;
+        for (const route of WORDPRESS_ROUTE_ORDER) {
+            rows.push({
+                path: route === 'actor' ? actor : `${actor}/${route}`,
+                username: user.username,
+                lastRequestedAt: asked[route] ?? null,
+            });
+        }
+    }
+    // The shared inbox last, and only when somebody could be delivered through
+    // it: it belongs to the site rather than to a person, and a site with nobody
+    // to deliver to has no use for it.
+    if (rows.length > 0) {
+        rows.push({
+            path: WORDPRESS_SHARED_INBOX_PATH,
+            username: '',
+            lastRequestedAt: requests.sharedInbox ?? null,
+        });
+    }
+    return rows;
+}
+//# sourceMappingURL=settings-federation.js.map

package/dist/admin/settings-federation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-federation.js","sourceRoot":"","sources":["../../src/admin/settings-federation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,oCAAoC;AACpC,MAAM,CAAC,MAAM,mBAAmB,GAAiB;IAC/C,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,YAAY;IACnB,IAAI,EAAE,gBAAgB,CAAC,YAAY,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC,kBAAkB;IAC5C,MAAM,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAC;IAE1C,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,eAAe,EAAE,eAAe,CAC9B,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAC/B,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAC5C;KACF,CAAC;IAEF,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE;QACX,0EAA0E;QAC1E,+DAA+D;QAC/D,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,MAAuB;IACzC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CACR,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YAC1B,CAAC,CAAC,yCAAyC;YAC3C,CAAC,CAAC,6BAA6B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAC7E,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CACR,MAAM,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;YAC5B,CAAC,CAAC,+BAA+B;YACjC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,8BAA8B,CACtE,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAElC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,iDAAiD,CAAC;AACnH,CAAC;AAED,2FAA2F;AAC3F,MAAM,qBAAqB,GAA8B;IACvD,OAAO;IACP,OAAO;IACP,QAAQ;IACR,WAAW;IACX,WAAW;CACZ,CAAC;AAYF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAsB,EACtB,QAA2B;IAE3B,MAAM,IAAI,GAAwB,EAAE,CAAC;IAErC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS;YAAE,SAAS;QAClD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,GAAG,0BAA0B,WAAW,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAEtF,KAAK,MAAM,KAAK,IAAI,qBAAqB,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC;gBACR,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,KAAK,EAAE;gBACrD,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI;aACtC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,6EAA6E;IAC7E,mCAAmC;IACnC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC;YACR,IAAI,EAAE,2BAA2B;YACjC,QAAQ,EAAE,EAAE;YACZ,eAAe,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI;SAC9C,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/admin/settings-general.d.ts

@@ -0,0 +1,12 @@
+/**
+ * General: what the site is called, where it lives, and what it looks like.
+ *
+ * WordPress's own first settings page, and the one the Settings heading lands
+ * on. There is no avatar here any more: decision-14 made every user an actor
+ * with a picture of their own, so the picture a site shows the fediverse is a
+ * user's, edited on the users screen beside the rest of their profile.
+ */
+import type { SettingsPage } from './settings-page.ts';
+/** The General settings page. */
+export declare const GENERAL_SETTINGS: SettingsPage;
+//# sourceMappingURL=settings-general.d.ts.map

package/dist/admin/settings-general.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-general.d.ts","sourceRoot":"","sources":["../../src/admin/settings-general.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAKvD,iCAAiC;AACjC,eAAO,MAAM,gBAAgB,EAAE,YAwB9B,CAAC"}

package/dist/admin/settings-general.js

@@ -0,0 +1,48 @@
+/**
+ * General: what the site is called, where it lives, and what it looks like.
+ *
+ * WordPress's own first settings page, and the one the Settings heading lands
+ * on. There is no avatar here any more: decision-14 made every user an actor
+ * with a picture of their own, so the picture a site shows the fediverse is a
+ * user's, edited on the users screen beside the rest of their profile.
+ */
+import { bodyField, settingsPagePath } from './settings-page.js';
+import { effectiveBaseUrl, SETTINGS_FIELDS } from './settings.js';
+import { ADMIN_TEMPLATES } from './templates.js';
+/** The General settings page. */
+export const GENERAL_SETTINGS = {
+    child: 'general',
+    label: 'General',
+    path: settingsPagePath('general'),
+    template: ADMIN_TEMPLATES.settingsGeneral,
+    fields: ['title', 'tagline', 'author', 'baseUrl', 'timezone', 'language'],
+    // The base URL field shows the one in effect rather than the one the file
+    // happens to hold: a site.json with no `url` at all would otherwise render an
+    // empty field that the validator refuses the moment anything is saved.
+    shown: (config, settings) => ({ ...settings, baseUrl: effectiveBaseUrl(config, settings) }),
+    panels: (c, settings) => baseUrlPanel(c.var.config, settings),
+    // A field the form rendered read-only is not submitted, so an overridden base
+    // URL keeps the value it had rather than being cleared by a save.
+    reads: ({ c, body, current }) => ({
+        baseUrl: c.var.config.baseUrlSource === 'default'
+            ? bodyField(body[SETTINGS_FIELDS.baseUrl])
+            : current.baseUrl === ''
+                ? c.var.config.baseUrl
+                : current.baseUrl,
+    }),
+};
+/** What the page says about the base URL: the one in effect, and why it is. */
+function baseUrlPanel(config, settings) {
+    const overridden = config.baseUrlSource !== 'default';
+    return {
+        baseUrlInEffect: effectiveBaseUrl(config, settings),
+        baseUrlOverridden: overridden,
+        baseUrlSource: config.baseUrlSource,
+        baseUrlNote: overridden
+            ? config.baseUrlSource === 'environment'
+                ? 'GEEKITY_BASE_URL is set, so it is the base URL in effect and this field is not editable here.'
+                : 'The config file sets baseUrl, so it is the base URL in effect and this field is not editable here.'
+            : 'Absolute URLs, the feeds and the session cookie pick this up when the site next starts.',
+    };
+}
+//# sourceMappingURL=settings-general.js.map

package/dist/admin/settings-general.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-general.js","sourceRoot":"","sources":["../../src/admin/settings-general.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,iCAAiC;AACjC,MAAM,CAAC,MAAM,gBAAgB,GAAiB;IAC5C,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,gBAAgB,CAAC,SAAS,CAAC;IACjC,QAAQ,EAAE,eAAe,CAAC,eAAe;IACzC,MAAM,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC;IAEzE,0EAA0E;IAC1E,8EAA8E;IAC9E,uEAAuE;IACvE,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;IAE3F,MAAM,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC;IAE7D,8EAA8E;IAC9E,kEAAkE;IAClE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAChC,OAAO,EACL,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,KAAK,SAAS;YACtC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC,CAAC,OAAO,CAAC,OAAO,KAAK,EAAE;gBACtB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO;gBACtB,CAAC,CAAC,OAAO,CAAC,OAAO;KACxB,CAAC;CACH,CAAC;AAEF,+EAA+E;AAC/E,SAAS,YAAY,CACnB,MAAyD,EACzD,QAAsB;IAEtB,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,KAAK,SAAS,CAAC;IAEtD,OAAO;QACL,eAAe,EAAE,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC;QACnD,iBAAiB,EAAE,UAAU;QAC7B,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,WAAW,EAAE,UAAU;YACrB,CAAC,CAAC,MAAM,CAAC,aAAa,KAAK,aAAa;gBACtC,CAAC,CAAC,+FAA+F;gBACjG,CAAC,CAAC,oGAAoG;YACxG,CAAC,CAAC,yFAAyF;KAC9F,CAAC;AACJ,CAAC"}

package/dist/admin/settings-page.d.ts

@@ -0,0 +1,102 @@
+/**
+ * What every settings page is made of.
+ *
+ * The settings used to be one form with twelve headings. They are six pages
+ * now — General, Reading, Permalinks, Discussion, Email and Federation — and
+ * this is what they have in common: a description of the page, and the one
+ * pair of routes that turns it into a screen you can read and a form you can
+ * save. A page module describes itself and writes its own template; nothing
+ * about how a page is wired lives in the page.
+ *
+ * The save is the part worth reading twice. A page writes only the fields it
+ * carries, and it writes them onto `content/_data/site.json` as re-read inside
+ * the atomic update (decision-9), not onto the copy the form was rendered
+ * from. So two people saving two different pages at the same moment both land:
+ * the second save is applied to what the first one actually wrote, and a
+ * setting neither page shows is not even in the picture.
+ */
+import type { Context, Hono } from 'hono';
+import type { ResolvedConfig } from '../config.ts';
+import type { GeekityEnv } from '../env.ts';
+import type { DeliveryReport } from '../federation/delivery.ts';
+import type { AdminRender } from './documents.ts';
+import type { SettingsField, SettingsForm, SiteSettings } from './settings.ts';
+/** What {@link mountSettingsPage} needs from the admin around it. */
+export interface MountSettingsOptions {
+    /** The admin's renderer, which injects the chrome, the CSRF token and the flash. */
+    render: AdminRender;
+}
+/** A submitted form, before anything has been read out of it. */
+export type SubmittedBody = Record<string, unknown>;
+/** One page under Settings. */
+export interface SettingsPage {
+    /** The child of the Settings section it is, as `src/admin/menu.ts` names it. */
+    child: string;
+    /** What the menu calls it, and what the page is headed. */
+    label: string;
+    /** Where it is: {@link settingsPagePath}. */
+    path: string;
+    /** The template it renders, from {@link ADMIN_TEMPLATES}. */
+    template: string;
+    /** The settings it carries. Every setting is on exactly one page. */
+    fields: readonly SettingsField[];
+    /**
+     * The settings as this page shows them, where what is stored is not what is
+     * in effect. Only General has one, for the base URL a deployment overrides.
+     */
+    shown?: (config: ResolvedConfig, settings: SiteSettings) => SiteSettings;
+    /** What the page renders beyond its own fields: a panel, a credential, a list. */
+    panels?: (c: Context<GeekityEnv>, settings: SiteSettings) => Record<string, unknown>;
+    /**
+     * The fields this page does not read straight off the body, because
+     * something other than the form decides them — a field rendered read-only
+     * submits nothing, and a save must not clear it.
+     */
+    reads?: (options: {
+        c: Context<GeekityEnv>;
+        body: SubmittedBody;
+        current: SiteSettings;
+    }) => Partial<SettingsForm>;
+    /**
+     * What a save of this page sets off beyond the file, as the sentence the
+     * flash adds. The side effect stays where the field is: the actor is told
+     * about a profile change on the page the profile is on, and the relays are
+     * reconciled on the page the relay list is on.
+     */
+    saved?: (c: Context<GeekityEnv>, before: SiteSettings, after: SiteSettings) => Promise<string> | string;
+    /**
+     * The page's own endpoints: a credential, a test message. Each is its own
+     * POST so a refused one cannot lose an edit to a field.
+     */
+    endpoints?: (app: Hono<GeekityEnv>, options: MountSettingsOptions) => void;
+}
+/**
+ * Where one settings page lives.
+ *
+ * General is `/admin/settings` itself rather than `/admin/settings/general`:
+ * it is where the Settings heading lands, where every save that has nothing
+ * better to say redirects, and the URL every older bookmark holds.
+ */
+export declare function settingsPagePath(child: string): string;
+/**
+ * Register one settings page: the screen, the save, and whatever endpoints of
+ * its own it has.
+ *
+ * Every read is of `content/_data/site.json` as it is at that moment, and a
+ * save rewrites it: a page is a view of the file rather than of anything this
+ * process remembers (decision-9). A form the page's own validator has anything
+ * to say about is a 400 that writes nothing at all and comes back with the
+ * problems on the fields that have them.
+ */
+export declare function mountSettingsPage(app: Hono<GeekityEnv>, page: SettingsPage, options: MountSettingsOptions): void;
+/** Everything one settings page's template renders. */
+export declare function settingsScreen(c: Context<GeekityEnv>, page: SettingsPage, settings: SiteSettings): Record<string, unknown>;
+/** A form field as a string. A file upload, or a missing field, is the empty one. */
+export declare function bodyField(value: unknown): string;
+/**
+ * The sentence a flash adds about the followers, when there were any: a save
+ * of the profile is also an announcement, and it should say so rather than
+ * leave the admin wondering.
+ */
+export declare function toldFollowers(report: DeliveryReport | undefined): string;
+//# sourceMappingURL=settings-page.d.ts.map

package/dist/admin/settings-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-page.d.ts","sourceRoot":"","sources":["../../src/admin/settings-page.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAWlD,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE/E,qEAAqE;AACrE,MAAM,WAAW,oBAAoB;IACnC,oFAAoF;IACpF,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,iEAAiE;AACjE,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD,+BAA+B;AAC/B,MAAM,WAAW,YAAY;IAC3B,gFAAgF;IAChF,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,MAAM,EAAE,SAAS,aAAa,EAAE,CAAC;IACjC;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY,KAAK,YAAY,CAAC;IACzE,kFAAkF;IAClF,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrF;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE;QAChB,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACvB,IAAI,EAAE,aAAa,CAAC;QACpB,OAAO,EAAE,YAAY,CAAC;KACvB,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAC5B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CACN,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EACtB,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,YAAY,KAChB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;CAC5E;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EACrB,IAAI,EAAE,YAAY,EAClB,OAAO,EAAE,oBAAoB,GAC5B,IAAI,CA4CN;AAED,uDAAuD;AACvD,wBAAgB,cAAc,CAC5B,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EACtB,IAAI,EAAE,YAAY,EAClB,QAAQ,EAAE,YAAY,GACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAiBzB;AAsBD,qFAAqF;AACrF,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS,GAAG,MAAM,CAMxE"}