@geekity/cms 0.30.0 → 0.32.0

package/dist/admin/settings.d.ts

@@ -1,585 +1,6 @@
-import type { RetentionPolicy } from '../privacy/policy.ts';
-import type { ResolvedConfig } from '../config.ts';
-import type { LocationSharing } from '../content/location.ts';
-import type { MailProviderName } from '../mail/provider.ts';
-import type { UpdatePeriod } from '../web/feed-source.ts';
-import type { CreativeCommonsKey } from '../web/license.ts';
-import type { AiCrawlerPolicy, RobotsPolicy } from '../web/robots.ts';
-import type { NavigationMenus } from '../web/navigation.ts';
-import type { TaxonomyBases, TaxonomyRedirect } from '../web/taxonomy.ts';
-import type { AdminStore } from './store.ts';
 /**
  * Where the settings live: the General page, and the root every other settings
  * page hangs off ({@link settingsPagePath}).
  */
 export declare const SETTINGS_PATH = "/admin/settings";
-/**
- * What a language tag may look like: BCP 47's shape rather than its registry —
- * a two or three letter primary subtag followed by dash-separated subtags of
- * letters and digits.
- *
- * Checking the shape and not the registry is deliberate. The value ends up in
- * `<html lang>`, an RSS `<language>` and an Atom `xml:lang`, where a
- * well-formed tag a reader has never heard of is harmless and a malformed one
- * is not; refusing a valid tag because this CMS shipped before it was
- * registered would be worse than accepting one nobody uses.
- */
-export declare const LANGUAGE_TAG_PATTERN: RegExp;
-/**
- * What an email address has to look like before the settings screen will keep
- * it: something, an `@`, and a dotted host.
- *
- * Deliberately loose. The grammar in RFC 5321 allows addresses nobody has ever
- * typed, and the only test that settles whether an address works is sending to
- * it — which is what the Send test email button is for. This catches the
- * typo where a whole field was pasted into the wrong box.
- */
-export declare const EMAIL_PATTERN: RegExp;
-/**
- * The settings a site holds, as `content/_data/site.json` says them.
- *
- * The file is the source of truth (decision-9): the settings screen reads it,
- * validates the form and writes it back, and nothing else remembers a setting.
- * That is what makes a hand edit of the file — in an editor, from a git
- * checkout, by an Eleventy build's own tooling — show on the very next
- * request, and what makes `data/geekity.db` a cache a site may delete.
- *
- * This shape is the typed view of the file; {@link settingsFromSiteJson} reads
- * it and {@link siteJsonFor} writes it, so the two stay inverses of each
- * other. The file may hold keys this shape does not model — `feedSize`,
- * anything a site put there — and a save keeps every one of them.
- */
-export interface SiteSettings {
-    /** Site title, shown in the header, the `<title>` and the feeds. */
-    title: string;
-    /** One-line description under the title. May be empty. */
-    tagline: string;
-    /**
-     * Public origin. Whether it is the one in effect depends on
-     * {@link ResolvedConfig.baseUrlSource}; see {@link effectiveBaseUrl}.
-     */
-    baseUrl: string;
-    /** An IANA zone name, e.g. `Europe/London`. */
-    timezone: string;
-    /**
-     * The site's language as a BCP 47 tag, `en` by default. It is the
-     * `<html lang>` the theme writes, the RSS channel's `<language>` and the
-     * Atom feed's `xml:lang`.
-     */
-    language: string;
-    /**
-     * The locale the public site's dates and counts are written in, when it is
-     * not the language: `en-US` on an `en` site, say. Empty, the default, means
-     * the language.
-     */
-    locale: string;
-    /** How many posts a listing page holds. A positive integer. */
-    postsPerPage: number;
-    /**
-     * The slug of the page served at `/`, or empty when the site shows its
-     * latest posts there. WordPress's Reading choice.
-     *
-     * A slug rather than a permalink, because a permalink is a thing the editor
-     * may change and the setting should follow the page rather than the URL it
-     * happened to have. A slug naming nothing published — a page drafted,
-     * trashed or deleted since — is a site back on its latest posts: the pick is
-     * kept so putting the page back puts the front page back with it.
-     */
-    homepage: string;
-    /**
-     * The slug of the page whose permalink carries the post listing, or empty
-     * for none. Only meaningful beside a {@link SiteSettings.homepage}, and the
-     * settings screen refuses one without it, exactly as WordPress does.
-     */
-    postsPage: string;
-    /**
-     * Who the site is: one user's username, or empty for a site with several
-     * authors (TASK-192). A username makes it that user's blog: the homepage
-     * carries their bio card and their `rel="me"` links, it and their archive
-     * claim each other, and the root is their IndieAuth identity (decision-23).
-     *
-     * A file written before the Site author select may hold a display name or a
-     * name nobody has. It is read as stored and resolved where it is used, by
-     * `userForAuthor`, so a display name still names its user and anything else
-     * names nobody; the General page writes the username at its next save.
-     */
-    author: string;
-    /**
-     * The theme the site renders through: the name of one directory under the
-     * configured themes directory, or empty for the theme the package ships
-     * (decision-15).
-     *
-     * A setting rather than a deployment fact, for the reason the tagline is: it
-     * is a look somebody chooses on the Appearance screen, and a site moved from
-     * one host to another should arrive looking the same. A name that is not a
-     * theme is refused here and falls back to the packaged theme out on the
-     * site, so a hand-edited file is a warning in the log rather than a 500.
-     */
-    theme: string;
-    /**
-     * The upload the site's icons are derived from, as a path such as
-     * `/uploads/2026/10/icon.png`, or empty for none. Read from and written
-     * to the `icon` key of `site.json` only.
-     */
-    icon: string;
-    /**
-     * What readers may do with the site's posts: empty for no
-     * license, which is all rights reserved, a Creative Commons key, or
-     * `custom` for the URL and name beside it. `site.json` writes a key, or a
-     * custom license's URL, under `license`, so the file says it the way a
-     * post's front matter does.
-     */
-    license: LicenseChoice;
-    /** A custom license's terms, as an absolute URL. Empty unless `license` is `custom`. */
-    licenseUrl: string;
-    /** A custom license's name. Empty unless `license` is `custom`. */
-    licenseName: string;
-    /**
-     * The first URL segment the tag archives live under, `tag` by default: one
-     * URL-safe path segment, no slashes. WordPress's own base, so a site
-     * imported from it keeps every archive URL it published.
-     */
-    tagBase: string;
-    /** The same for the category archives, `category` by default. */
-    categoryBase: string;
-    /**
-     * Whether the site takes native comments at all (TASK-50).
-     *
-     * Off means off everywhere: no form under any post, and every submission
-     * refused. It does not touch the fediverse — a reply, a like or a boost
-     * arrives because a remote server sent it, and a site cannot stop that or
-     * pretend it did not happen.
-     */
-    comments: boolean;
-    /**
-     * How many days after its `date` a post stops taking comments. Zero never
-     * closes one.
-     *
-     * The age at which a post stops being a conversation and starts being a spam
-     * target; fourteen days is WordPress's own default. A post may say otherwise
-     * for itself with `comments: true` or `comments: false` in its front matter.
-     */
-    commentsCloseAfterDays: number;
-    /**
-     * How many days a comment keeps its author's email (TASK-135). Zero keeps it
-     * forever. Past it the email is removed from the comment file and the index,
-     * and with it the author's subscription to replies.
-     */
-    commentEmailRetentionDays: number;
-    /**
-     * How many days a comment or a contact message keeps the salted hash of the
-     * address it came from. Zero keeps it forever.
-     */
-    addressHashRetentionDays: number;
-    /** How many days a contact message is kept at all. Zero keeps it forever. */
-    contactMessageRetentionDays: number;
-    /**
-     * Whether the site tells the pages a post links to that it has (TASK-51).
-     *
-     * On by default, because a link nobody is told about is half a conversation.
-     * Off means no webmention is ever sent, including by the Resend button.
-     */
-    webmentionsSend: boolean;
-    /**
-     * Whether the site accepts webmentions sent to it (TASK-51).
-     *
-     * On by default. Off takes the endpoint off every page and answers the
-     * endpoint itself with a 404, which is what a site that does not receive
-     * them looks like from outside. It does not touch the fediverse, and it does
-     * not touch what has already arrived: a webmention already in the queue is
-     * still there for a moderator.
-     */
-    webmentionsReceive: boolean;
-    /**
-     * Where the site announces that a feed changed, and the server its feeds
-     * advertise as their rssCloud endpoint and their WebSub hub. An absolute
-     * http(s) URL, {@link DEFAULT_NOTIFY_SERVER} by default; empty turns
-     * real-time notification off altogether.
-     */
-    notifyServer: string;
-    /**
-     * How often the RSS feeds tell a reader to poll them: `feedUpdateFrequency`
-     * times a `feedUpdatePeriod`, in the Syndication module's two elements
-     * (TASK-152). Once an hour by default, which is what WordPress declares.
-     */
-    feedUpdatePeriod: UpdatePeriod;
-    /** How many polls per {@link SiteSettings.feedUpdatePeriod}: a whole number, at least one. */
-    feedUpdateFrequency: number;
-    /**
-     * How the site treats the crawlers that feed AI products, as the robots file
-     * spells it in per-agent groups (TASK-148). `allow` by default.
-     */
-    aiCrawlers: AiCrawlerPolicy;
-    /**
-     * The three Content-Signal preferences the robots file declares: `yes`,
-     * `no`, or empty for a signal the site says nothing about.
-     */
-    contentSignalSearch: ContentSignalChoice;
-    /** Whether the site's pages may be fed to an AI answer live. */
-    contentSignalAiInput: ContentSignalChoice;
-    /** Whether the site's pages may be used to train a model. */
-    contentSignalAiTrain: ContentSignalChoice;
-    /**
-     * Lines the robots file carries beyond the CMS's own: groups of
-     * `User-agent` lines and their rules, one line per entry, blank lines
-     * between groups. Every group still keeps crawlers out of the admin.
-     */
-    robotsRules: readonly string[];
-    /**
-     * Whether the site serves `/llms.txt` and advertises it from the home page
-     * (TASK-149). On by default. A site that wants to write the file itself
-     * leaves this on and puts it at `content/llms.txt`.
-     */
-    llmsTxt: boolean;
-    /**
-     * Whether the site tells the IndexNow search engines about every URL a
-     * publish, an edit or a deletion moved (TASK-151). Off by default: it sends
-     * the site's URLs to a third party, which is the site's call to make.
-     */
-    indexNow: boolean;
-    /**
-     * The key IndexNow verifies the site by, served at `/{key}.txt`. Generated
-     * the first time IndexNow is turned on and kept when it is turned off, so
-     * turning it back on keeps the key the search engines already checked. It
-     * is no secret: the whole point of it is that anybody can fetch it.
-     */
-    indexNowKey: string;
-    /**
-     * How the site sends email, or `none` for a site that does not (TASK-53).
-     *
-     * The name of the provider only. The key or the SMTP password that makes it
-     * work is a credential and lives in `data/mail.json`, never here: this file
-     * is public, in git and published with the site.
-     */
-    mailProvider: MailProviderName;
-    /** The display name on the From line. Falls back to the site title. */
-    mailFromName: string;
-    /**
-     * The address on the From line. Empty falls back to `no-reply@` at the base
-     * URL's host, which is what an unconfigured site would have to send as
-     * anyway — but a provider will only accept a sender it has verified, so a
-     * site that sends anything real sets this.
-     */
-    mailFromAddress: string;
-    /** Where a reply to the site's mail should go. Empty means the From address. */
-    mailReplyTo: string;
-    /**
-     * Where a message from the contact form is sent (TASK-56).
-     *
-     * Empty falls back to the first admin with an email, so a site that has
-     * never visited this field still has somewhere to write. It is read when a
-     * message arrives and is never put on a render context, so it cannot appear
-     * in the HTML of the page the form is on however a theme is written.
-     */
-    contactEmail: string;
-    /**
-     * Where a security researcher reports a vulnerability: the `Contact` lines
-     * of `/.well-known/security.txt` (RFC 9116, TASK-133), each a `mailto:`,
-     * `https:` or `tel:` URI, in the order the site prefers them.
-     *
-     * Empty means the site answers that path with a 404. There is no fallback
-     * to {@link SiteSettings.contactEmail}: that address is promised never to
-     * appear on the public site, and this one is published by definition.
-     */
-    securityContacts: readonly string[];
-    /** The `Policy` line of security.txt: an https URL, or empty for none. */
-    securityPolicy: string;
-    /**
-     * The `Preferred-Languages` line of security.txt: language tags joined by
-     * `, `, or empty for none.
-     */
-    securityLanguages: string;
-    /**
-     * The relay inboxes the site subscribes to (FEP-ae0c): a Mastodon-style
-     * relay boosts every public post it is sent, which is how a small site
-     * reaches instances nobody on it follows.
-     *
-     * Each is the relay's own inbox URL, absolute and whole — a relay's inbox is
-     * a path like `/user/_____relay_____/inbox`, not an origin. The list is
-     * edited one per line on the settings screen and held as an array in the
-     * file; where each subscription stands is in the database, because the
-     * handshake is not the site's to decide.
-     */
-    relays: readonly string[];
-    /**
-     * Every menu the site holds, by name: `site.json`'s `menus`, each an ordered
-     * list of items a theme renders wherever it declares an area of that name
-     * and an Eleventy build reads out of the same file.
-     *
-     * Not a field of the settings form, and deliberately: a menu is content a
-     * site arranges rather than a switch it sets, and which menus there are to
-     * edit comes from the active theme. The Navigation screen is what writes
-     * them (TASK-108); a settings page carries them through a save untouched,
-     * the way it carries the archive renames.
-     */
-    menus: NavigationMenus;
-    /**
-     * The taxonomy archives that have moved: one `{ taxonomy, from, to }` per
-     * term the taxonomy screens renamed or merged away, so the URL it used to
-     * live at can point at the one it lives at now.
-     *
-     * Not a field of the settings form: it is a record of what happened rather
-     * than a preference, and the taxonomy screens are what write it. Chains are collapsed as they are
-     * recorded, so the list answers every old URL in one hop.
-     */
-    taxonomyRedirects: readonly TaxonomyRedirect[];
-    /**
-     * What the site publishes of a post's location (TASK-223, decision-29):
-     * nothing, the place's words, or the coordinates too. `none` by default,
-     * because the location is personal data and the author chooses to share it.
-     * Chosen on Settings > Privacy.
-     */
-    locationSharing: LocationSharing;
-    /**
-     * The IndieAuth apps the owner lets sign in without PKCE (TASK-225), each a
-     * client_id. Empty, the default, means every app needs PKCE, as the
-     * IndieAuth spec says. Not a field of the settings form: Users > Connected
-     * apps edits it, and a settings save carries it, like the menus.
-     */
-    clientsWithoutPkce: readonly string[];
-}
-/** What a site says about one Content-Signal: yes, no, or nothing. */
-export type ContentSignalChoice = '' | 'yes' | 'no';
-export type LicenseChoice = '' | CreativeCommonsKey | 'custom';
-/** What the settings say the robots file should carry. */
-export declare function robotsPolicyOf(settings: SiteSettings): RobotsPolicy;
-/**
- * The settings the form on the settings screen carries.
- *
- * Every setting but the two that a screen of its own writes: the recorded
- * archive renames, which the taxonomy screens write, and the menus, which the
- * Navigation screen writes. See {@link CarriedSettings}.
- */
-export type SettingsField = Exclude<keyof SiteSettings, 'taxonomyRedirects' | 'menus' | 'indexNowKey' | 'clientsWithoutPkce'>;
-/**
- * The settings no settings form carries, as a save takes them from the file.
- *
- * Both are records of what another screen did rather than preferences typed
- * into a box, so a save of the title reads them off `site.json` as it stands
- * inside the write rather than off the form — which is what makes a menu
- * edited while the settings page was open survive the save.
- */
-export type CarriedSettings = Partial<Pick<SiteSettings, 'taxonomyRedirects' | 'menus' | 'indexNowKey' | 'clientsWithoutPkce'>>;
-/**
- * What a site is worth before anybody has said otherwise.
- *
- * `baseUrl` is empty rather than a guess: only the resolved config knows what
- * port the site is on, so the fallback is applied where the config is in hand.
- */
-export declare const DEFAULT_SITE_SETTINGS: SiteSettings;
-/** The form field each setting is submitted under. */
-export declare const SETTINGS_FIELDS: {
-    readonly title: 'title';
-    readonly tagline: 'tagline';
-    readonly baseUrl: 'base_url';
-    readonly timezone: 'timezone';
-    readonly language: 'language';
-    readonly locale: 'locale';
-    readonly postsPerPage: 'posts_per_page';
-    readonly homepage: 'homepage';
-    readonly postsPage: 'posts_page';
-    readonly author: 'author';
-    readonly theme: 'theme';
-    readonly icon: 'icon';
-    readonly license: 'license';
-    readonly licenseUrl: 'license_url';
-    readonly licenseName: 'license_name';
-    readonly tagBase: 'tag_base';
-    readonly categoryBase: 'category_base';
-    readonly comments: 'comments';
-    readonly commentsCloseAfterDays: 'comments_close_after_days';
-    readonly commentEmailRetentionDays: 'comment_email_retention_days';
-    readonly addressHashRetentionDays: 'address_hash_retention_days';
-    readonly contactMessageRetentionDays: 'contact_message_retention_days';
-    readonly webmentionsSend: 'webmentions_send';
-    readonly webmentionsReceive: 'webmentions_receive';
-    readonly notifyServer: 'notify_server';
-    readonly feedUpdatePeriod: 'feed_update_period';
-    readonly feedUpdateFrequency: 'feed_update_frequency';
-    readonly aiCrawlers: 'ai_crawlers';
-    readonly contentSignalSearch: 'content_signal_search';
-    readonly contentSignalAiInput: 'content_signal_ai_input';
-    readonly contentSignalAiTrain: 'content_signal_ai_train';
-    readonly robotsRules: 'robots_rules';
-    readonly llmsTxt: 'llms_txt';
-    readonly indexNow: 'index_now';
-    readonly mailProvider: 'mail_provider';
-    readonly mailFromName: 'mail_from_name';
-    readonly mailFromAddress: 'mail_from_address';
-    readonly mailReplyTo: 'mail_reply_to';
-    readonly contactEmail: 'contact_email';
-    readonly securityContacts: 'security_contacts';
-    readonly securityPolicy: 'security_policy';
-    readonly securityLanguages: 'security_languages';
-    readonly relays: 'relays';
-    readonly locationSharing: 'location_sharing';
-};
-/** A submitted settings form, before it is known to be valid. */
-export type SettingsForm = Record<SettingsField, string>;
-/** One message per field that is wrong. An empty object is a valid form. */
-export type SettingsProblems = Partial<Record<SettingsField, string>>;
-/**
- * A site's settings, as its `content/_data/site.json` says them right now.
- *
- * Read on every request that needs one rather than cached, which is what a
- * source of truth being a file is worth: a hand edit shows on the public site,
- * on the settings screen and in the actor document without a restart and
- * without anything being told. The file is a few hundred bytes, so the read
- * costs less than the parse of the template that is about to use it.
- *
- * A file that is missing, or one that will not parse, is the defaults rather
- * than an error: a typo in `site.json` should leave a site up and answerable,
- * with the settings screen there to put it right.
- */
-export declare function readSiteSettings(contentDir: string): SiteSettings;
-export declare function readSiteJson(contentDir: string): Record<string, unknown>;
-/**
- * `content/_data/site.json` as the settings it names, defaults filled in.
- *
- * Read tolerantly, key by key, because the file is public, in git and editable
- * by hand: a key of the wrong type, or one a site has never written, falls
- * back to the default rather than taking the site down. The empty string is a
- * value of its own for `tagline`, `author` and `notifyServer`, where empty is
- * a decision — no tagline, no author, notifications off — and not for
- * `title`, `timezone`, `language` or the two archive bases, where it is a hole
- * only a default can fill.
- */
-export declare function settingsFromSiteJson(file: Record<string, unknown>): SiteSettings;
-/** The two archive bases the settings hold, as the URL builders want them. */
-export declare function taxonomyBasesFromSettings(settings: SiteSettings): TaxonomyBases;
-/**
- * `content/_data/site.json` as it should read for these settings.
- *
- * Every key the settings model is written whether or not it has a value, so
- * the file's shape is stable and an Eleventy template may reference
- * `site.tagline` without guarding it. Every other key the file already had is
- * kept: a site may put anything in there and reach it from its templates, and
- * the settings form is not going to be the thing that throws it away.
- *
- * `homepage` and `postsPage` are the one exception, and they earn it: a site
- * showing its latest posts has no static front page at all rather than an
- * empty one, so the keys are absent rather than empty — which is also how a
- * `site.json` written before this version reads, and what it should mean.
- */
-export declare function siteJsonFor(settings: SiteSettings, existing?: Record<string, unknown>): Record<string, unknown>;
-/** The absolute path of one site's `content/_data/site.json`. */
-export declare function siteDataPath(contentDir: string): string;
-/**
- * Rewrite `content/_data/site.json` as these settings, keeping the keys they
- * do not model.
- *
- * {@link updateSiteSettings} for a caller whose new settings depend on the old
- * ones, which every screen's is: this is for the callers that have the whole
- * object already, a test's set-up among them.
- */
-export declare function writeSiteJson(options: {
-    contentDir: string;
-    settings: SiteSettings;
-}): Promise<void>;
-/**
- * Change the settings: re-read the file, apply the change, write it back, with
- * nothing able to write that file in between ({@link updateFileAtomically}).
- *
- * The re-read is what makes the file win the way it wins for a post
- * (decision-9). Two people with the settings screen open both save what they
- * see, and the second save is applied to what the first one actually wrote
- * rather than to what the second one had on screen — so a change to a field
- * the second person did not touch survives. The write is a temporary file and
- * a rename, so a reader — an Eleventy build, the site data source, another
- * process entirely — never sees a half-written file. Keys the settings do not
- * model, `feedSize` and anything a site added, are kept.
- */
-export declare function updateSiteSettings(options: {
-    contentDir: string;
-    change: (current: SiteSettings) => SiteSettings;
-}): Promise<SiteSettings>;
-/**
- * Turn an older site's settings rows into `content/_data/site.json`, once, and
- * drop the table.
- *
- * TASK-14 made SQLite the source and the file its mirror; decision-9 reversed
- * that, and a site upgrading across the two has rows nothing would ever read
- * again. So the first boot of this version writes them out. Which side wins
- * when both have something to say is decided the way it is decided everywhere
- * else: the file wins when it was written after the last save, because that is
- * a hand edit or a restored checkout, and the rows win otherwise. Either way
- * the actor handle and type come from the rows, because `site.json` never
- * carried them and losing them would rename the site's actor.
- *
- * Synchronous because `createCms` is: it runs before the server is listening
- * and before anything else has touched the file.
- */
-export declare function migrateSettingsToFile(options: {
-    admin: AdminStore;
-    contentDir: string;
-}): void;
-/**
- * The base URL actually in effect, and why.
- *
- * A base URL is a deployment fact before it is a preference: it decides the
- * absolute URLs in the feeds, the ActivityPub ids, and whether the session
- * cookie is `Secure`. So `GEEKITY_BASE_URL` and a `baseUrl` in the config file
- * both win over the stored setting, and the settings form says so rather than
- * offering a field that would quietly do nothing.
- */
-export declare function effectiveBaseUrl(config: Pick<ResolvedConfig, 'baseUrl' | 'baseUrlSource'>, settings: SiteSettings): string;
-/**
- * What a check may need to know beyond the form itself.
- *
- * One field has anything here, and it is the theme: whether a name is a theme
- * is a question about the file system rather than about the string, and only
- * the config knows where this site's themes are. A check given no context does
- * what it can — the theme's is still a name it can refuse — so a caller with
- * no config in hand is not blocked.
- */
-export interface SettingsContext {
-    /** Where the site's themes are: {@link ResolvedConfig.themesDir}. */
-    themesDir?: string | undefined;
-    contentDir?: string | undefined;
-}
-/** Every field of the settings, in the order the form fields name them. */
-export declare const SETTINGS_FIELD_NAMES: readonly SettingsField[];
-/**
- * What is wrong with a submitted settings form, one message per field.
- *
- * `fields` is what a page carries: it validates its own fields and says
- * nothing about the rest, so a page cannot refuse a save over a field it does
- * not show and gives no way to fix. `context` is what a check needs beyond the
- * form; see {@link SettingsContext}.
- */
-export declare function settingsProblems(form: SettingsForm, fields?: readonly SettingsField[], context?: SettingsContext): SettingsProblems;
-/**
- * A validated form as settings. Only call it on a form
- * {@link settingsProblems} found nothing wrong with.
- *
- * The archive renames and the menus are carried in rather than read off the
- * form, because they are not on it: the taxonomy screens write the one and the
- * Navigation screen the other, and a save of the fields that are on the form
- * keeps whatever is stored. Passing the settings read inside the write is all
- * a caller has to do, since they hold both.
- */
-export declare function settingsFromForm(form: SettingsForm, carried?: CarriedSettings): SiteSettings;
-/** The settings as the form shows them. */
-export declare function formFromSettings(settings: SiteSettings): SettingsForm;
-/**
- * A relay textarea as the list of inboxes it names: normalised, in the order
- * they were given, with repeats dropped.
- *
- * Exported because the same parsing turns a stored setting, a submitted form
- * and a `site.json` array into the one list; a second spelling of it would let
- * the file and the database disagree about what a site subscribes to.
- */
-export declare function relayList(value: string): string[];
-/**
- * A relay inbox URL, or `undefined` when it is not an absolute http(s) one.
- *
- * Unlike {@link normalizeBaseUrl} this keeps the whole URL bar a trailing
- * slash: a relay inbox is a path — `/user/_____relay_____/inbox` — rather than
- * an origin, and some relays hang one off a query string.
- */
-export declare function normalizeRelayInbox(value: string): string | undefined;
-/** The same, from bytes already in hand. */
-export declare function parseSiteJson(source: string): Record<string, unknown>;
-/** The three retention periods, as the sweep reads them. */
-export declare function retentionPolicyOf(settings: SiteSettings): RetentionPolicy;
 //# sourceMappingURL=settings.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/admin/settings.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAQnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAI9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAG5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAI1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAI5D,OAAO,KAAK,EACV,eAAe,EAGf,YAAY,EACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAM5D,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG1E,OAAO,KAAK,EAAE,UAAU,EAAiB,MAAM,YAAY,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,aAAa,oBAA6B,CAAC;AAExD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,QAA8C,CAAC;AAEhF;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,QAAsC,CAAC;AAEjE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,YAAY;IAC3B,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,+DAA+D;IAC/D,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;OAUG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;;;OAUG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,OAAO,EAAE,aAAa,CAAC;IACvB,wFAAwF;IACxF,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC,6EAA6E;IAC7E,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;;;OAKG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;;;;;;OAQG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,gBAAgB,EAAE,YAAY,CAAC;IAC/B,8FAA8F;IAC9F,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAC;IAC5B;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gEAAgE;IAChE,oBAAoB,EAAE,mBAAmB,CAAC;IAC1C,6DAA6D;IAC7D,oBAAoB,EAAE,mBAAmB,CAAC;IAC1C;;;;OAIG;IACH,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,YAAY,EAAE,gBAAgB,CAAC;IAC/B,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,gFAAgF;IAChF,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;;;;;;;OAQG;IACH,iBAAiB,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC/C;;;;;OAKG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;;;;OAKG;IACH,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,sEAAsE;AACtE,MAAM,MAAM,mBAAmB,GAAG,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC;AAEpD,MAAM,MAAM,aAAa,GAAG,EAAE,GAAG,kBAAkB,GAAG,QAAQ,CAAC;AAiB/D,0DAA0D;AAC1D,wBAAgB,cAAc,CAAC,QAAQ,EAAE,YAAY,GAAG,YAAY,CAUnE;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CACjC,MAAM,YAAY,EAClB,mBAAmB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,CACrE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CACnC,IAAI,CAAC,YAAY,EAAE,mBAAmB,GAAG,OAAO,GAAG,aAAa,GAAG,oBAAoB,CAAC,CACzF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,YAmDnC,CAAC;AAEF,sDAAsD;AACtD,eAAO,MAAM,eAAe;oBACnB,OAAO;sBACL,SAAS;sBACT,UAAU;uBACT,UAAU;uBACV,UAAU;qBACZ,QAAQ;2BACF,gBAAgB;uBACpB,UAAU;wBACT,YAAY;qBACf,QAAQ;oBACT,OAAO;mBACR,MAAM;sBACH,SAAS;yBACN,aAAa;0BACZ,cAAc;sBAClB,UAAU;2BACL,eAAe;uBACnB,UAAU;qCACI,2BAA2B;wCACxB,8BAA8B;uCAC/B,6BAA6B;0CAC1B,gCAAgC;8BAC5C,kBAAkB;iCACf,qBAAqB;2BAC3B,eAAe;+BACX,oBAAoB;kCACjB,uBAAuB;yBAChC,aAAa;kCACJ,uBAAuB;mCACtB,yBAAyB;mCACzB,yBAAyB;0BAClC,cAAc;sBAClB,UAAU;uBACT,WAAW;2BACP,eAAe;2BACf,gBAAgB;8BACb,mBAAmB;0BACvB,eAAe;2BACd,eAAe;+BACX,mBAAmB;6BACrB,iBAAiB;gCACd,oBAAoB;qBAC/B,QAAQ;8BACC,kBAAkB;CACa,CAAC;AAEnD,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AAEzD,4EAA4E;AAC5E,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,CAEjE;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAExE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAqIhF;AASD,8EAA8E;AAC9E,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,YAAY,GAAG,aAAa,CAE/E;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,YAAY,EACtB,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACrC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwFzB;AAED,iEAAiE;AACjE,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAEvD;AAOD;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;CACxB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,YAAY,CAAC;CACjD,GAAG,OAAO,CAAC,YAAY,CAAC,CAUxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAiB9F;AA8CD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,GAAG,eAAe,CAAC,EACzD,QAAQ,EAAE,YAAY,GACrB,MAAM,CAGR;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC;AAwRD,2EAA2E;AAC3E,eAAO,MAAM,oBAAoB,EAAE,SAAS,aAAa,EAErC,CAAC;AAErB;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,YAAY,EAClB,MAAM,GAAE,SAAS,aAAa,EAAyB,EACvD,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CASlB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,GAAE,eAAoB,GAAG,YAAY,CAuEhG;AAgBD,2CAA2C;AAC3C,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,GAAG,YAAY,CA+CrE;AA0DD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAOjD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAcrE;AA2FD,4CAA4C;AAC5C,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUrE;AAED,4DAA4D;AAC5D,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,YAAY,GAAG,eAAe,CAMzE"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/admin/settings.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,aAAa,oBAA6B,CAAC"}