@geekity/cms 0.3.0 → 0.5.0

package/dist/web/context.d.ts

@@ -1,5 +1,8 @@
 import type { ResolvedConfig } from '../config.ts';
 import type { Document } from '../content/document.ts';
+import type { ImageConfig } from '../images/variants.ts';
+import type { AuthorContext } from './authors.ts';
+import type { TaxonomyBases, TaxonomyRedirect } from './taxonomy.ts';
 /** Where the site-wide data file lives, relative to the content directory. */
 export declare const SITE_DATA_FILE = "_data/site.json";
 /** How many posts a listing page holds when the site does not say. */
@@ -20,6 +23,12 @@ export interface SiteData {
     url: string;
     /** Site author. */
     author?: string | undefined;
+    /**
+     * The site's language as a BCP 47 tag, `en` unless the site says otherwise.
+     * It is the `<html lang>`, the RSS channel's `<language>` and the Atom
+     * feed's `xml:lang`.
+     */
+    language?: string | undefined;
     /**
      * The site's avatar, as the public path it is served at. Empty until one has
      * been uploaded on the settings screen; the ActivityPub actor's `icon`.
@@ -27,6 +36,47 @@ export interface SiteData {
     avatar?: string | undefined;
     /** How many posts a listing page holds. */
     postsPerPage?: number | undefined;
+    /**
+     * The first URL segment the tag archives live under, without slashes:
+     * `tag` unless the site says otherwise.
+     */
+    tagBase?: string | undefined;
+    /** The same for the category archives. `category` by default. */
+    categoryBase?: string | undefined;
+    /**
+     * The rssCloud and WebSub server the feeds advertise and this site pings,
+     * as an absolute URL. Empty — or missing — means the site names none.
+     */
+    notifyServer?: string | undefined;
+    /**
+     * The relay inboxes the site subscribes to (FEP-ae0c), as absolute URLs.
+     * The setting itself; where each subscription stands lives in the database
+     * rather than here, because a handshake is not the site's to decide.
+     */
+    relays?: readonly string[] | undefined;
+    /**
+     * The theme the site renders through: the name of one directory under the
+     * configured themes directory. Absent — the ordinary state — is the theme
+     * the package ships (decision-15).
+     */
+    theme?: string | undefined;
+    /**
+     * The slug of the page served at `/`, when the site shows a page there
+     * rather than its latest posts. Absent for the latest posts.
+     */
+    homepage?: string | undefined;
+    /**
+     * The slug of the page whose own URL carries the post listing, when there is
+     * one. Absent unless `homepage` names a page as well.
+     */
+    postsPage?: string | undefined;
+    /**
+     * The taxonomy archives that have moved, as `{ taxonomy, from, to }`: what
+     * lets the URL a renamed archive used to live at point at the one it lives
+     * at now. Written by the taxonomy screens; an Eleventy build of the same
+     * content can publish the same redirects from it.
+     */
+    taxonomyRedirects?: readonly TaxonomyRedirect[] | undefined;
     [key: string]: unknown;
 }
 /**
@@ -59,8 +109,20 @@ export interface DocumentContext {
     date?: Date | undefined;
     /** Taxonomy, in the order the file lists it. */
     tags: string[];
+    /** The second taxonomy: what the document is filed under, in file order. */
+    categories: string[];
     /** The Markdown body rendered to HTML. Templates print it with `| safe`. */
     content: string;
+    /**
+     * What the document is about in one line of plain text: the `description`
+     * the author wrote, else an excerpt of the rendered body, else empty.
+     *
+     * The very string the feeds publish as a summary, from the same function, so
+     * a feed item and the entry a listing prints for the same post cannot say
+     * two different things (decision-16). Always present, empty included, so a
+     * theme prints it without asking whether it is there.
+     */
+    summary: string;
     /** The document's URL path, the same value as `page.url`. */
     url: string;
     /** Eleventy's `page`. */
@@ -70,52 +132,124 @@ export interface DocumentContext {
     /** Everything else from the front matter, including unmodelled keys. */
     [key: string]: unknown;
 }
+/**
+ * One of a post's neighbours by date, as a theme links it: `previous` and
+ * `next` under an entry.
+ *
+ * Two keys rather than the whole document, because that is what the link is —
+ * the words on it and where it goes — and a theme that was handed a second
+ * document context would be a theme that could print a second post by
+ * accident.
+ */
+export interface NeighbourContext {
+    /** The neighbour's title, which is what the link says. */
+    title: string;
+    /** Its URL path. */
+    url: string;
+}
 /**
  * A document as a template sees it.
  *
  * Front matter goes on first so the keys the CMS models always win: a file
  * with a stray `content` or `page` key cannot displace the rendered body or
  * the page data.
+ *
+ * `images` is the site's image config, and giving it is what turns an uploaded
+ * picture in `content` into a `<picture>` with a `srcset` (decision-10). It is
+ * an argument rather than something `renderMarkdown` does, because only the
+ * theme's HTML may have it: the feeds, the JSON and Markdown representations
+ * and the ActivityStreams `content` all read `document.html` directly and must
+ * keep the plain `<img>` of the original.
+ *
+ * `author` is the profile behind the front matter's `author` (TASK-67), and it
+ * is an argument for the reason `images` is: only something holding the site's
+ * users can resolve a name to a person. Given one, the context's `author` is
+ * that object rather than the raw string — `author.name` to print and
+ * `author.url` to link — so a theme writes one thing whether the file names a
+ * login, a display name from before decision-14, or somebody who has no
+ * account here at all. Without one the file's own string is left where it was,
+ * which is what a test over a single template renders.
  */
-export declare function documentContext(document: Document): DocumentContext;
+export declare function documentContext(document: Document, images?: ImageConfig, author?: AuthorContext): DocumentContext;
 /** Reads `content/_data/site.json`, and re-reads it when the file changes. */
 export interface SiteDataSource {
     /** The current site data, defaults filled in. */
     read(): SiteData;
 }
 /**
- * The settings the admin stores, as site data.
+ * A source over one site's data.
+ *
+ * `content/_data/site.json` is the only source of it (decision-9): the
+ * settings screen writes that file and nothing else remembers what it said, so
+ * a save and a hand edit reach the theme by exactly the same route.
  *
- * The admin's settings screen is the source of truth for the values it
- * manages, and `content/_data/site.json` is the mirror it writes for an
- * Eleventy build. Handing the source a reader for the settings is what makes a
- * saved title show on the very next request rather than on the next time the
- * file's modification time is noticed.
+ * The file is read on every call and parsed only when its bytes differ from
+ * the last read, so a render costs one small read rather than one parse. A
+ * `stat` key was tried first and is not enough: a filesystem rounds the
+ * modification time to its clock tick, a few milliseconds on Linux, so a
+ * second write inside one tick that keeps the size and the inode, a theme
+ * name swapped for one of the same length say, looked like no write at all.
+ * The file is a few hundred bytes; reading it is cheaper than being wrong. A
+ * file that is missing or will not parse falls back to the defaults instead
+ * of failing the request: a typo in `site.json` should not take the site down.
  */
-export interface SiteSettingsSource {
-    /** The stored settings as site data. Empty when nothing is stored. */
-    read(): Partial<SiteData>;
-}
-/** What {@link createSiteDataSource} reads from besides the config. */
-export interface CreateSiteDataSourceOptions {
-    /** The admin's settings, when the CMS has an admin store to read them from. */
-    settings?: SiteSettingsSource | undefined;
+export declare function createSiteDataSource(config: ResolvedConfig): SiteDataSource;
+/** How many posts a listing page holds, from the site data or the default. */
+export declare function postsPerPage(site: SiteData): number;
+/**
+ * The theme this site has chosen, from the site data, or the empty string for
+ * the theme the package ships.
+ *
+ * Read as tolerantly as everything else out of `site.json` — a key of the
+ * wrong type is a site on the packaged theme rather than a broken render —
+ * and read as a name rather than resolved to a directory, for the reason the
+ * front page is read as a slug: only something holding the themes directory
+ * can say whether the name still points at a theme.
+ */
+export declare function themeName(site: SiteData): string;
+/**
+ * The zone this site's dates are read in, from the site data, or UTC when it
+ * names none.
+ *
+ * The same lens the `date` filter applies (decision-11), for the things the
+ * CMS rather than a template has to put a date through: which month of an
+ * archive a post belongs to is the same calendar question as which day the
+ * line under it says, and the two must not be answered by different clocks.
+ */
+export declare function siteTimezone(site: SiteData): string;
+/** WordPress's Reading choice, as `site.json` spells it. */
+export interface FrontPageSlugs {
+    /** The page served at `/`, or empty for the site's latest posts. */
+    homepage: string;
+    /** The page whose permalink carries the listing, or empty for none. */
+    postsPage: string;
 }
 /**
- * A source over one site's data.
+ * Which page is the front page and which carries the listing, from the site
+ * data.
  *
- * The file is read once and then only again when its modification time moves,
- * so a render costs one `stat` rather than one parse. A file that is missing
- * or will not parse falls back to the defaults instead of failing the request:
- * a typo in `site.json` should not take the site down.
+ * Read as tolerantly as everything else out of `site.json`, and read as slugs
+ * rather than resolved to documents: only something holding the index can say
+ * whether a slug still names a published page, and a slug that names none is a
+ * site showing its latest posts.
+ */
+export declare function frontPageSlugs(site: SiteData): FrontPageSlugs;
+/**
+ * Where this site's taxonomy archives live, from the site data.
  *
- * The stored settings, when there are any, go on top of the file. They are the
- * same values the file was last written from, so the two normally agree; the
- * overlay is what keeps them agreeing in the moment between a save and the
- * file's `mtime` being noticed, and the file underneath is what carries the
- * keys the settings form does not manage.
+ * A base the site could not actually be served under — an empty one, one with
+ * a slash in it, one that would shadow `/admin`, or two that are the same word
+ * — falls back to the default rather than taking the archives down: the value
+ * was refused at the settings screen, so anything that reaches here came from
+ * a hand-edited `site.json`.
  */
-export declare function createSiteDataSource(config: ResolvedConfig, options?: CreateSiteDataSourceOptions): SiteDataSource;
-/** How many posts a listing page holds, from the site data or the default. */
-export declare function postsPerPage(site: SiteData): number;
+export declare function taxonomyBases(site: SiteData): TaxonomyBases;
+/**
+ * The archive renames this site records, from the site data.
+ *
+ * Read as tolerantly as everything else out of `site.json`: an entry that is
+ * not a rename is dropped rather than taking the archives down, because a site
+ * may have written the key by hand.
+ */
+export declare function termRedirects(site: SiteData): TaxonomyRedirect[];
 //# sourceMappingURL=context.d.ts.map

package/dist/web/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/web/context.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,8EAA8E;AAC9E,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAEhD,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,yDAAyD;IACzD,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,gDAAgD;IAChD,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,yBAAyB;IACzB,IAAI,EAAE,WAAW,CAAC;IAClB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe,CA0BnE;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,IAAI,IAAI,QAAQ,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAED,uEAAuE;AACvE,MAAM,WAAW,2BAA2B;IAC1C,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;CAC3C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,2BAAgC,GACxC,cAAc,CAiChB;AAaD,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAMnD"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/web/context.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAErE,8EAA8E;AAC9E,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAEhD,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACvC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,SAAS,gBAAgB,EAAE,GAAG,SAAS,CAAC;IAC5D,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,yDAAyD;IACzD,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB,gDAAgD;IAChD,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,4EAA4E;IAC5E,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,yBAAyB;IACzB,IAAI,EAAE,WAAW,CAAC;IAClB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,WAAW,EACpB,MAAM,CAAC,EAAE,aAAa,GACrB,eAAe,CA+BjB;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,IAAI,IAAI,QAAQ,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAqC3E;AAaD,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAMnD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAGnD;AAED,4DAA4D;AAC5D,MAAM,WAAW,cAAc;IAC7B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,cAAc,CAQ7D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,aAAa,CAE3D;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,gBAAgB,EAAE,CAEhE"}

package/dist/web/context.js

@@ -1,5 +1,9 @@
-import { readFileSync, statSync } from 'node:fs';
+import { readFileSync } from 'node:fs';
 import path from 'node:path';
+import { DEFAULT_TIMEZONE } from '../content/time.js';
+import { siteImageMarkup } from '../images/markup.js';
+import { feedExcerpt } from './feed-item.js';
+import { DEFAULT_TAXONOMY_BASES, taxonomyBasesOrDefault, taxonomyRedirectsOf } from './taxonomy.js';
 /** Where the site-wide data file lives, relative to the content directory. */
 export const SITE_DATA_FILE = '_data/site.json';
 /** How many posts a listing page holds when the site does not say. */
@@ -10,8 +14,24 @@ export const DEFAULT_POSTS_PER_PAGE = 10;
  * Front matter goes on first so the keys the CMS models always win: a file
  * with a stray `content` or `page` key cannot displace the rendered body or
  * the page data.
+ *
+ * `images` is the site's image config, and giving it is what turns an uploaded
+ * picture in `content` into a `<picture>` with a `srcset` (decision-10). It is
+ * an argument rather than something `renderMarkdown` does, because only the
+ * theme's HTML may have it: the feeds, the JSON and Markdown representations
+ * and the ActivityStreams `content` all read `document.html` directly and must
+ * keep the plain `<img>` of the original.
+ *
+ * `author` is the profile behind the front matter's `author` (TASK-67), and it
+ * is an argument for the reason `images` is: only something holding the site's
+ * users can resolve a name to a person. Given one, the context's `author` is
+ * that object rather than the raw string — `author.name` to print and
+ * `author.url` to link — so a theme writes one thing whether the file names a
+ * login, a display name from before decision-14, or somebody who has no
+ * account here at all. Without one the file's own string is left where it was,
+ * which is what a test over a single template renders.
  */
-export function documentContext(document) {
+export function documentContext(document, images, author) {
     const date = toDate(document.date);
     return {
         ...document.extra,
@@ -19,13 +39,18 @@ export function documentContext(document) {
         slug: document.slug,
         draft: document.draft,
         ...optional('description', document.description),
-        ...optional('author', document.author),
+        ...optional('author', author ?? document.author),
         ...optional('updated', toDate(document.updated)),
         ...optional('activitypub', document.activitypub),
         title: document.title,
         ...optional('date', date),
         tags: document.tags,
-        content: document.html,
+        categories: document.categories,
+        content: images === undefined ? document.html : siteImageMarkup(images, document.html),
+        // The plain-text summary, taken off the document rather than off the
+        // markup above: an excerpt is text, and the `<picture>` a site's image
+        // config puts in the HTML is not something to cut words out of.
+        summary: feedExcerpt(document),
         url: document.permalink,
         type: document.type,
         page: {
@@ -39,36 +64,38 @@ export function documentContext(document) {
 /**
  * A source over one site's data.
  *
- * The file is read once and then only again when its modification time moves,
- * so a render costs one `stat` rather than one parse. A file that is missing
- * or will not parse falls back to the defaults instead of failing the request:
- * a typo in `site.json` should not take the site down.
+ * `content/_data/site.json` is the only source of it (decision-9): the
+ * settings screen writes that file and nothing else remembers what it said, so
+ * a save and a hand edit reach the theme by exactly the same route.
  *
- * The stored settings, when there are any, go on top of the file. They are the
- * same values the file was last written from, so the two normally agree; the
- * overlay is what keeps them agreeing in the moment between a save and the
- * file's `mtime` being noticed, and the file underneath is what carries the
- * keys the settings form does not manage.
+ * The file is read on every call and parsed only when its bytes differ from
+ * the last read, so a render costs one small read rather than one parse. A
+ * `stat` key was tried first and is not enough: a filesystem rounds the
+ * modification time to its clock tick, a few milliseconds on Linux, so a
+ * second write inside one tick that keeps the size and the inode, a theme
+ * name swapped for one of the same length say, looked like no write at all.
+ * The file is a few hundred bytes; reading it is cheaper than being wrong. A
+ * file that is missing or will not parse falls back to the defaults instead
+ * of failing the request: a typo in `site.json` should not take the site down.
  */
-export function createSiteDataSource(config, options = {}) {
+export function createSiteDataSource(config) {
     const file = path.join(config.contentDir, ...SITE_DATA_FILE.split('/'));
-    const settings = options.settings;
     let cached = {};
-    let cachedAt;
+    let cachedText;
     function fromFile() {
-        let modifiedAt;
+        let text;
         try {
-            modifiedAt = statSync(file).mtimeMs;
+            text = readFileSync(file, 'utf8');
         }
         catch {
-            cachedAt = undefined;
+            cachedText = undefined;
             cached = {};
             return cached;
         }
-        if (modifiedAt === cachedAt)
+        if (text === cachedText)
             return cached;
-        cachedAt = modifiedAt;
-        cached = readSiteFile(file);
+        cachedText = text;
+        cached = parseSiteFile(text);
         return cached;
     }
     return {
@@ -76,14 +103,19 @@ export function createSiteDataSource(config, options = {}) {
             // The defaults are rebuilt per read rather than captured, because
             // `config.baseUrl` may have been settled from the settings after this
             // source was made.
-            const defaults = { title: 'Geekity', url: config.baseUrl };
-            return { ...defaults, ...fromFile(), ...settings?.read() };
+            const defaults = {
+                title: 'Geekity',
+                url: config.baseUrl,
+                tagBase: DEFAULT_TAXONOMY_BASES.tag,
+                categoryBase: DEFAULT_TAXONOMY_BASES.category,
+            };
+            return { ...defaults, ...fromFile() };
         },
     };
 }
-function readSiteFile(file) {
+function parseSiteFile(text) {
     try {
-        const parsed = JSON.parse(readFileSync(file, 'utf8'));
+        const parsed = JSON.parse(text);
         return typeof parsed === 'object' && parsed !== null && !Array.isArray(parsed)
             ? parsed
             : {};
@@ -100,6 +132,71 @@ export function postsPerPage(site) {
     }
     return DEFAULT_POSTS_PER_PAGE;
 }
+/**
+ * The theme this site has chosen, from the site data, or the empty string for
+ * the theme the package ships.
+ *
+ * Read as tolerantly as everything else out of `site.json` — a key of the
+ * wrong type is a site on the packaged theme rather than a broken render —
+ * and read as a name rather than resolved to a directory, for the reason the
+ * front page is read as a slug: only something holding the themes directory
+ * can say whether the name still points at a theme.
+ */
+export function themeName(site) {
+    return typeof site['theme'] === 'string' ? site['theme'].trim() : '';
+}
+/**
+ * The zone this site's dates are read in, from the site data, or UTC when it
+ * names none.
+ *
+ * The same lens the `date` filter applies (decision-11), for the things the
+ * CMS rather than a template has to put a date through: which month of an
+ * archive a post belongs to is the same calendar question as which day the
+ * line under it says, and the two must not be answered by different clocks.
+ */
+export function siteTimezone(site) {
+    const timezone = site['timezone'];
+    return typeof timezone === 'string' && timezone !== '' ? timezone : DEFAULT_TIMEZONE;
+}
+/**
+ * Which page is the front page and which carries the listing, from the site
+ * data.
+ *
+ * Read as tolerantly as everything else out of `site.json`, and read as slugs
+ * rather than resolved to documents: only something holding the index can say
+ * whether a slug still names a published page, and a slug that names none is a
+ * site showing its latest posts.
+ */
+export function frontPageSlugs(site) {
+    const homepage = typeof site['homepage'] === 'string' ? site['homepage'].trim() : '';
+    const postsPage = typeof site['postsPage'] === 'string' ? site['postsPage'].trim() : '';
+    // A posts page without a homepage would be a second URL for the listing that
+    // is already at `/`. The settings screen refuses the pair; a hand-edited
+    // file is read the same way rather than serving it.
+    return { homepage, postsPage: homepage === '' ? '' : postsPage };
+}
+/**
+ * Where this site's taxonomy archives live, from the site data.
+ *
+ * A base the site could not actually be served under — an empty one, one with
+ * a slash in it, one that would shadow `/admin`, or two that are the same word
+ * — falls back to the default rather than taking the archives down: the value
+ * was refused at the settings screen, so anything that reaches here came from
+ * a hand-edited `site.json`.
+ */
+export function taxonomyBases(site) {
+    return taxonomyBasesOrDefault({ tag: site['tagBase'], category: site['categoryBase'] });
+}
+/**
+ * The archive renames this site records, from the site data.
+ *
+ * Read as tolerantly as everything else out of `site.json`: an entry that is
+ * not a rename is dropped rather than taking the archives down, because a site
+ * may have written the key by hand.
+ */
+export function termRedirects(site) {
+    return taxonomyRedirectsOf(site['taxonomyRedirects']);
+}
 function toDate(value) {
     if (value === undefined)
         return undefined;

package/dist/web/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/web/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,IAAI,MAAM,WAAW,CAAC;AAK7B,8EAA8E;AAC9E,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAEhD,sEAAsE;AACtE,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAuEzC;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,QAAkB;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEnC,OAAO;QACL,GAAG,QAAQ,CAAC,KAAK;QACjB,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,GAAG,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC;QAChD,GAAG,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;QACtC,GAAG,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAChD,GAAG,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC;QAEhD,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;QACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,QAAQ,CAAC,IAAI;QACtB,GAAG,EAAE,QAAQ,CAAC,SAAS;QACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,GAAG,EAAE,QAAQ,CAAC,SAAS;YACvB,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;YACzB,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,SAAS,EAAE,KAAK,QAAQ,CAAC,IAAI,EAAE;SAChC;KACF,CAAC;AACJ,CAAC;AA4BD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAsB,EACtB,OAAO,GAAgC,EAAE;IAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAElC,IAAI,MAAM,GAA4B,EAAE,CAAC;IACzC,IAAI,QAA4B,CAAC;IAEjC,SAAS,QAAQ;QACf,IAAI,UAA8B,CAAC;QACnC,IAAI,CAAC;YACH,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,SAAS,CAAC;YACrB,MAAM,GAAG,EAAE,CAAC;YACZ,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,UAAU,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC;QAE3C,QAAQ,GAAG,UAAU,CAAC;QACtB,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,IAAI;YACF,kEAAkE;YAClE,sEAAsE;YACtE,mBAAmB;YACnB,MAAM,QAAQ,GAAa,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;YACrE,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;QAC7D,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/D,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5E,CAAC,CAAE,MAAkC;YACrC,CAAC,CAAC,EAAE,CAAC;IACT,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IACxC,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACrF,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED,SAAS,MAAM,CAAC,KAAyB;IACvC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAC7D,CAAC;AAED,SAAS,QAAQ,CAAsB,GAAM,EAAE,KAAoB;IACjE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAmB,CAAC;AACvE,CAAC"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/web/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAI7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpG,8EAA8E;AAC9E,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAEhD,sEAAsE;AACtE,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAkJzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAkB,EAClB,MAAoB,EACpB,MAAsB;IAEtB,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEnC,OAAO;QACL,GAAG,QAAQ,CAAC,KAAK;QACjB,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,GAAG,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC;QAChD,GAAG,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC;QAChD,GAAG,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAChD,GAAG,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,WAAW,CAAC;QAEhD,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;QACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,OAAO,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;QACtF,qEAAqE;QACrE,uEAAuE;QACvE,gEAAgE;QAChE,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC;QAC9B,GAAG,EAAE,QAAQ,CAAC,SAAS;QACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE;YACJ,GAAG,EAAE,QAAQ,CAAC,SAAS;YACvB,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC;YACzB,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,SAAS,EAAE,KAAK,QAAQ,CAAC,IAAI,EAAE;SAChC;KACF,CAAC;AACJ,CAAC;AAQD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAsB;IACzD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAExE,IAAI,MAAM,GAA4B,EAAE,CAAC;IACzC,IAAI,UAA8B,CAAC;IAEnC,SAAS,QAAQ;QACf,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QAAC,MAAM,CAAC;YACP,UAAU,GAAG,SAAS,CAAC;YACvB,MAAM,GAAG,EAAE,CAAC;YACZ,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,IAAI,KAAK,UAAU;YAAE,OAAO,MAAM,CAAC;QAEvC,UAAU,GAAG,IAAI,CAAC;QAClB,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,IAAI;YACF,kEAAkE;YAClE,sEAAsE;YACtE,mBAAmB;YACnB,MAAM,QAAQ,GAAa;gBACzB,KAAK,EAAE,SAAS;gBAChB,GAAG,EAAE,MAAM,CAAC,OAAO;gBACnB,OAAO,EAAE,sBAAsB,CAAC,GAAG;gBACnC,YAAY,EAAE,sBAAsB,CAAC,QAAQ;aAC9C,CAAC;YACF,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,EAAE,EAAE,CAAC;QACxC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5E,CAAC,CAAE,MAAkC;YACrC,CAAC,CAAC,EAAE,CAAC;IACT,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;IACxC,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACrF,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;IAClC,OAAO,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC;AACvF,CAAC;AAUD;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,IAAc;IAC3C,MAAM,QAAQ,GAAG,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrF,MAAM,SAAS,GAAG,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAExF,6EAA6E;IAC7E,yEAAyE;IACzE,oDAAoD;IACpD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;AACnE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,IAAc;IAC1C,OAAO,sBAAsB,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAc;IAC1C,OAAO,mBAAmB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,MAAM,CAAC,KAAyB;IACvC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAC7D,CAAC;AAED,SAAS,QAAQ,CAAsB,GAAM,EAAE,KAAoB;IACjE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAmB,CAAC;AACvE,CAAC"}