@geekity/cms 0.3.0 → 0.5.0

package/dist/web/documents.js

@@ -1,14 +1,21 @@
+import { isScheduled } from '../content/schedule.js';
 import { isTrashedPath } from '../content/store.js';
-import { postObjectId } from '../federation/paths.js';
+import { absoluteUrl } from './negotiate.js';
 /**
  * Whether the public site may show a document.
  *
- * Two things hide one: `draft: true` in the front matter, and living under
- * `_trash/`. Both stay indexed so the admin can find them; neither is ever
- * served, listed, or fed.
+ * Three things hide one: `draft: true` in the front matter, living under
+ * `_trash/`, and a date that has not arrived yet. All three stay indexed so
+ * the admin can find them; none is ever served, listed, or fed.
+ *
+ * This is the predicate the index answers in SQL, so anything that has to
+ * decide about a single document in hand — a permalink, a View link, the
+ * sitemap — asks it here rather than deriving the rule again. The clock
+ * defaults to the system one; a caller with a store should pass
+ * {@link ContentStore.now} so the answer matches the listings it came from.
  */
-export function isPublicDocument(document) {
-    return !document.draft && !isTrashedPath(document.path);
+export function isPublicDocument(document, now = new Date()) {
+    return !document.draft && !isTrashedPath(document.path) && !isScheduled(document, now);
 }
 /**
  * The document a public URL resolves to, or `undefined`.
@@ -19,21 +26,56 @@ export function isPublicDocument(document) {
  */
 export function publicDocumentAt(store, permalink) {
     const document = store.getByPermalink(permalink);
-    if (document === undefined || !isPublicDocument(document))
+    if (document === undefined || !isPublicDocument(document, store.now()))
         return undefined;
     return document;
 }
+/**
+ * A post's ActivityStreams object id: its permalink, absolute on the site's
+ * base URL, or the id its file already names.
+ *
+ * decision-13. A permalink is by name permanent, and the fediverse id is the
+ * same promise made to a different audience, so one URL answers both: a
+ * browser gets the page and a peer gets the `Article`, by content negotiation.
+ * There is no second URL to mint and none to keep in step.
+ *
+ * A stored `activitypub.id` wins, for the life of the post. That is not a
+ * cache: it is what lets a post migrated from WordPress keep the
+ * `https://example.com/?p=813` id its followers, its replies and its RSS
+ * subscribers already hold (decision-14), so the CMS serves the object there
+ * too and names it in every `Update` and `Delete`. A hand-written
+ * `activitypub.id` that is not a URL is not an id, and the permalink is used
+ * instead.
+ *
+ * Unlike {@link activityStreamsId} this answers for any post, published or
+ * not: a draft that was announced before it was withdrawn still has the name
+ * its followers filed it under, and a `Delete` has to say it.
+ */
+export function postObjectId(document, baseUrl) {
+    const stored = document.activitypub?.id;
+    if (stored !== undefined && stored !== '') {
+        try {
+            return new URL(stored).href;
+        }
+        catch {
+            // Not a URL, so not an id. Fall through to the permalink.
+        }
+    }
+    return absoluteUrl(document.permalink, baseUrl);
+}
 /**
  * The ActivityStreams id of a document, or `undefined` when it has none.
  *
  * Only a published post federates (doc-4), so only a published post has an id
  * to advertise. This is what the theme's `<link rel="alternate">` points at,
- * and it is deliberately the same string the object dispatcher answers under:
- * the page and the object agree about the post's name in the fediverse.
+ * what every feed keys the post by (decision-12) and what the permalink
+ * answers an ActivityStreams request with: the page, the feed item and the
+ * object all agree about the post's name in the fediverse, because after
+ * decision-13 they are the same URL.
  */
 export function activityStreamsId(document, baseUrl) {
     if (document.type !== 'post' || !isPublicDocument(document))
         return undefined;
-    return postObjectId(document.slug, baseUrl);
+    return postObjectId(document, baseUrl);
 }
 //# sourceMappingURL=documents.js.map

package/dist/web/documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/web/documents.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB;IACjD,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAmB,EAAE,SAAiB;IACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5E,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAkB,EAAE,OAAe;IACnE,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9E,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC"}
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/web/documents.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB,EAAE,GAAG,GAAS,IAAI,IAAI,EAAE;IACzE,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAmB,EAAE,SAAiB;IACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IACzF,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CAAC,QAAkB,EAAE,OAAe;IAC9D,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;IACxC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QAC1C,IAAI,CAAC;YACH,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,0DAA0D;QAC5D,CAAC;IACH,CAAC;IACD,OAAO,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAkB,EAAE,OAAe;IACnE,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9E,OAAO,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC"}

package/dist/web/feed-atom.d.ts

@@ -0,0 +1,22 @@
+import type { FeedItem } from './feed-item.ts';
+import type { FeedSource } from './feed-source.ts';
+/**
+ * Atom 1.0: the feed and its entries, rendered from {@link FeedItem}s.
+ *
+ * An entry names the post by its object id and lists every term it carries,
+ * which is what RSS and JSON Feed do with the same item: decision-12 leaves
+ * the three formats nothing to disagree about.
+ */
+/** One feed as an Atom 1.0 document. */
+export declare function atomFeed(source: FeedSource): string;
+/**
+ * One item as an Atom entry.
+ *
+ * `<id>` is the object id and the `rel="alternate"` link is the permalink,
+ * which are the same URL for every post born on this CMS and differ only for
+ * one carrying a stored id. A summary is written whenever there is one, which
+ * after decision-12 is every post with a body: Atom's `<summary>` is optional,
+ * and an empty one says less than none.
+ */
+export declare function atomEntry(item: FeedItem): string[];
+//# sourceMappingURL=feed-atom.d.ts.map

package/dist/web/feed-atom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-atom.d.ts","sourceRoot":"","sources":["../../src/web/feed-atom.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAS/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAInD;;;;;;GAMG;AAEH,wCAAwC;AACxC,wBAAgB,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CA8BnD;AAeD;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,EAAE,CAoBlD"}

package/dist/web/feed-atom.js

@@ -0,0 +1,83 @@
+import { feedItems } from './feed-item.js';
+import { contentTypeOf, EMPTY_FEED_UPDATED, FEED_GENERATOR, FEED_GENERATOR_URI, feedLanguage, notifyServerOf, } from './feed-source.js';
+import { author, element, escapeXml, link, optionalElement, SOURCE_NAMESPACE } from './feed-xml.js';
+import { absoluteUrl, latestModified } from './negotiate.js';
+/**
+ * Atom 1.0: the feed and its entries, rendered from {@link FeedItem}s.
+ *
+ * An entry names the post by its object id and lists every term it carries,
+ * which is what RSS and JSON Feed do with the same item: decision-12 leaves
+ * the three formats nothing to disagree about.
+ */
+/** One feed as an Atom 1.0 document. */
+export function atomFeed(source) {
+    const { site, documents, baseUrl } = source;
+    const updated = latestModified(documents) ?? EMPTY_FEED_UPDATED;
+    const lines = [
+        '<?xml version="1.0" encoding="utf-8"?>',
+        `<feed xmlns="http://www.w3.org/2005/Atom"`,
+        `      xmlns:source="${SOURCE_NAMESPACE}"`,
+        `      xml:lang="${escapeXml(feedLanguage(site))}">`,
+        element('id', absoluteUrl(source.href, baseUrl)),
+        element('title', source.title),
+        ...optionalElement('subtitle', site.tagline),
+        element('updated', updated.toISOString()),
+        link({
+            rel: 'self',
+            type: contentTypeOf('atom'),
+            href: absoluteUrl(source.feedHref, baseUrl),
+        }),
+        link({ rel: 'alternate', type: 'text/html', href: absoluteUrl(source.href, baseUrl) }),
+        ...atomCloud(site),
+        `  <generator uri="${escapeXml(FEED_GENERATOR_URI)}">${escapeXml(FEED_GENERATOR)}</generator>`,
+        ...author(site.author, 1),
+    ];
+    for (const item of feedItems(documents, source)) {
+        lines.push(...atomEntry(item));
+    }
+    lines.push('</feed>', '');
+    return lines.join('\n');
+}
+/**
+ * The notify server as an Atom feed can say it: the `rel="hub"` link WebSub
+ * defines, and `<source:cloud>`, which is namespaced and so belongs here as
+ * much as in RSS. The legacy `<cloud>` is not: it is an RSS 2.0 element with
+ * no namespace, and Atom has nowhere to put it.
+ */
+function atomCloud(site) {
+    const notify = notifyServerOf(site);
+    if (notify === undefined)
+        return [];
+    return [element('source:cloud', notify.pleaseNotify), link({ rel: 'hub', href: notify.hub })];
+}
+/**
+ * One item as an Atom entry.
+ *
+ * `<id>` is the object id and the `rel="alternate"` link is the permalink,
+ * which are the same URL for every post born on this CMS and differ only for
+ * one carrying a stored id. A summary is written whenever there is one, which
+ * after decision-12 is every post with a body: Atom's `<summary>` is optional,
+ * and an empty one says less than none.
+ */
+export function atomEntry(item) {
+    return [
+        '  <entry>',
+        element('id', item.id, 2),
+        element('title', item.title, 2),
+        element('updated', (item.updated ?? EMPTY_FEED_UPDATED).toISOString(), 2),
+        ...(item.published === undefined
+            ? []
+            : [element('published', item.published.toISOString(), 2)]),
+        link({ rel: 'alternate', type: 'text/html', href: item.link }, 2),
+        ...author(item.author, 2),
+        ...item.terms.map((term) => `    <category term="${escapeXml(term)}"/>`),
+        ...(item.summary === ''
+            ? []
+            : [`    <summary type="text">${escapeXml(item.summary)}</summary>`]),
+        // `type="html"` means the markup is escaped rather than inlined, so a
+        // reader that does not parse XHTML still gets the whole post.
+        `    <content type="html">${escapeXml(item.html)}</content>`,
+        '  </entry>',
+    ];
+}
+//# sourceMappingURL=feed-atom.js.map

package/dist/web/feed-atom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-atom.js","sourceRoot":"","sources":["../../src/web/feed-atom.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,cAAc,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAE7D;;;;;;GAMG;AAEH,wCAAwC;AACxC,MAAM,UAAU,QAAQ,CAAC,MAAkB;IACzC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC5C,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC;IAEhE,MAAM,KAAK,GAAa;QACtB,wCAAwC;QACxC,2CAA2C;QAC3C,uBAAuB,gBAAgB,GAAG;QAC1C,mBAAmB,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI;QACpD,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;QAC9B,GAAG,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC;QAC5C,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;QACzC,IAAI,CAAC;YACH,GAAG,EAAE,MAAM;YACX,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;YAC3B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;SAC5C,CAAC;QACF,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QACtF,GAAG,SAAS,CAAC,IAAI,CAAC;QAClB,qBAAqB,SAAS,CAAC,kBAAkB,CAAC,KAAK,SAAS,CAAC,cAAc,CAAC,cAAc;QAC9F,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;KAC1B,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC1B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAc;IAC/B,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAEpC,OAAO,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,OAAO;QACL,WAAW;QACX,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/B,OAAO,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,kBAAkB,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACzE,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS;YAC9B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACzB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,uBAAuB,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;QACxE,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,EAAE;YACrB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,4BAA4B,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACtE,sEAAsE;QACtE,8DAA8D;QAC9D,4BAA4B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY;QAC5D,YAAY;KACb,CAAC;AACJ,CAAC"}

package/dist/web/feed-item.d.ts

@@ -0,0 +1,145 @@
+import type { Document } from '../content/document.ts';
+import type { SiteData } from './context.ts';
+/**
+ * One post as a feed shows it, in one shape whatever format the feed is.
+ *
+ * This is the model the three serialisers render. It exists because they used
+ * to read the {@link Document} themselves, three times, and disagreed about
+ * what they found: RSS keyed an item by the post's ActivityStreams object id
+ * where Atom and JSON Feed used the permalink, RSS listed both taxonomies
+ * where the others listed tags only, and RSS fell back to an excerpt where the
+ * others printed nothing. One derivation, done once per post and site, means
+ * there is one answer to each of those questions and one place to change it.
+ *
+ * decision-12 is what each of those answers is, and the shape here is what
+ * makes it unavoidable: there is one {@link FeedItem.id}, one
+ * {@link FeedItem.terms} list and one {@link FeedItem.summary}, so a format
+ * cannot print a second-best version of any of them. The one pair left,
+ * {@link FeedItem.id} beside {@link FeedItem.link}, is two real things: what
+ * the post is called and where it is read, which differ only for a post
+ * carrying a stored id.
+ */
+export interface FeedItem {
+    /**
+     * The post's name: its ActivityStreams object id, which after decision-13 is
+     * the permalink, or the stored id a migrated post carries. decision-12 makes
+     * this every feed's key for the post, so all three formats print it: RSS as
+     * `guid`, Atom as `<id>` and JSON Feed as `id`.
+     */
+    id: string;
+    /**
+     * Where the post is read: its permalink, absolute on the site's base URL.
+     * The same in every format — RSS's `link`, Atom's `rel="alternate"` and JSON
+     * Feed's `url` — and equal to {@link FeedItem.id} unless the post carries a
+     * stored one.
+     */
+    link: string;
+    /** Display title. */
+    title: string;
+    /** When it was published, if it carries a date that parses. */
+    published?: Date | undefined;
+    /** When it last changed: its `updated`, else its date. */
+    updated?: Date | undefined;
+    /** The post's own author, when it names one. Atom and JSON Feed print this. */
+    author?: string | undefined;
+    /**
+     * Who a feed credits: the post's own author, else the site's. RSS's
+     * `dc:creator` prints it, because an RSS item has nowhere else to say it.
+     */
+    creator?: string | undefined;
+    /**
+     * What the post is filed under and tagged with, categories first and each in
+     * file order, as one list.
+     *
+     * One list rather than two because no feed format distinguishes them: RSS has
+     * a single `<category>`, Atom a single `<category term>` and JSON Feed a
+     * single `tags`, which is exactly how WordPress publishes both taxonomies
+     * too. decision-12 says every format lists every term, and a model that
+     * cannot say which vocabulary a term came from is a model no format can
+     * quietly list half of.
+     */
+    terms: readonly string[];
+    /**
+     * What every format prints as the summary: the description the author wrote,
+     * else an excerpt of the rendered body. Never the whole post — the content is
+     * where that goes — and empty only for a post with nothing to summarise,
+     * which is the one case a format leaves the element out.
+     */
+    summary: string;
+    /** The rendered body. */
+    html: string;
+    /** The Markdown the body was written from, for `source:markdown`. */
+    markdown: string;
+    /**
+     * Where this item's comments are, and how many there are, or `undefined`
+     * when the feed did not resolve the counts. A feed whose builder did not
+     * would otherwise publish "0 comments" about a post with plenty.
+     */
+    comments?: FeedItemComments | undefined;
+}
+/**
+ * Which revision of the item's serialisation a feed's validator is keyed by.
+ *
+ * A feed's ETag is a hash of the documents and the site's metadata, because
+ * those are what usually move it. The rules for turning a document into an item
+ * are not in that hash, so a release that changes them — this one, which
+ * changes every RSS `guid`, both the other formats' ids, the terms they list
+ * and their summaries — would leave the validator where it was, and a reader
+ * polling with `If-None-Match` would be handed a 304 that hides the new bytes.
+ *
+ * Bumping this moves every post feed's ETag exactly once, at the upgrade, and
+ * never again until the next such change. The comments feeds do not carry it:
+ * a comment is not a {@link FeedItem} and its bytes are untouched.
+ */
+export declare const FEED_ITEM_REVISION = 2;
+/** Where one item's comments are, counted. */
+export interface FeedItemComments {
+    /** The page a person reads them on. */
+    page: string;
+    /** The feed a reader polls for them. */
+    feed: string;
+    /** How many there are. */
+    count: number;
+}
+/** What an item needs to know about the feed it is part of. */
+export interface FeedItemContext {
+    /** Site-wide data, for the author a post does not name. */
+    site: SiteData;
+    /** The site's public origin, for absolute ids and links. */
+    baseUrl: string;
+    /** How many replies each document has, by permalink. See {@link FeedItem.comments}. */
+    commentCounts?: ReadonlyMap<string, number> | undefined;
+}
+/**
+ * One document as the item every format renders.
+ *
+ * The only reading of a {@link Document} a feed does: after this, a serialiser
+ * sees an item and nothing else, so two formats cannot quietly disagree about
+ * what a post's summary or its name is.
+ */
+export declare function feedItem(document: Document, context: FeedItemContext): FeedItem;
+/** One item per document, in the order the feed was given them. */
+export declare function feedItems(documents: readonly Document[], context: FeedItemContext): readonly FeedItem[];
+/**
+ * How many words of the rendered text an excerpt keeps when a post carries no
+ * `description`. WordPress's own excerpt length, so a migrated site's feed
+ * reads the same.
+ */
+export declare const EXCERPT_WORDS = 55;
+/**
+ * The plain-text summary a feed carries for a post.
+ *
+ * The `description` front matter when the post has one — it is what the author
+ * wrote for exactly this — and otherwise the first paragraph of the rendered
+ * body, stripped to text and cut where WordPress cuts an excerpt. Never the
+ * whole post: the content element is where the whole post goes, and a reader
+ * that shows both should have something to choose between.
+ */
+export declare function feedExcerpt(document: Document): string;
+/**
+ * The first paragraph of some HTML as plain text, cut where WordPress cuts an
+ * excerpt. What a post falls back to when it carries no `description`, and
+ * what a comment — which never carries one — always uses.
+ */
+export declare function excerptFromHtml(html: string): string;
+//# sourceMappingURL=feed-item.d.ts.map

package/dist/web/feed-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-item.d.ts","sourceRoot":"","sources":["../../src/web/feed-item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAK7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,SAAS,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC7B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC3B,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;;;;;;OAUG;IACH,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CACzC;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC,8CAA8C;AAC9C,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,+DAA+D;AAC/D,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,IAAI,EAAE,QAAQ,CAAC;IACf,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,uFAAuF;IACvF,aAAa,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACzD;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,GAAG,QAAQ,CAsC/E;AAED,mEAAmE;AACnE,wBAAgB,SAAS,CACvB,SAAS,EAAE,SAAS,QAAQ,EAAE,EAC9B,OAAO,EAAE,eAAe,GACvB,SAAS,QAAQ,EAAE,CAErB;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,KAAK,CAAC;AAEhC;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAGtD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAapD"}

package/dist/web/feed-item.js

@@ -0,0 +1,120 @@
+import { activityStreamsId } from './documents.js';
+import { feedPathUnder } from './feed-source.js';
+import { absoluteUrl, lastModifiedOf } from './negotiate.js';
+/**
+ * Which revision of the item's serialisation a feed's validator is keyed by.
+ *
+ * A feed's ETag is a hash of the documents and the site's metadata, because
+ * those are what usually move it. The rules for turning a document into an item
+ * are not in that hash, so a release that changes them — this one, which
+ * changes every RSS `guid`, both the other formats' ids, the terms they list
+ * and their summaries — would leave the validator where it was, and a reader
+ * polling with `If-None-Match` would be handed a 304 that hides the new bytes.
+ *
+ * Bumping this moves every post feed's ETag exactly once, at the upgrade, and
+ * never again until the next such change. The comments feeds do not carry it:
+ * a comment is not a {@link FeedItem} and its bytes are untouched.
+ */
+export const FEED_ITEM_REVISION = 2;
+/**
+ * One document as the item every format renders.
+ *
+ * The only reading of a {@link Document} a feed does: after this, a serialiser
+ * sees an item and nothing else, so two formats cannot quietly disagree about
+ * what a post's summary or its name is.
+ */
+export function feedItem(document, context) {
+    const { baseUrl } = context;
+    const link = absoluteUrl(document.permalink, baseUrl);
+    const published = document.date === undefined ? undefined : new Date(document.date);
+    const item = {
+        // A page or a draft has no ActivityStreams id to advertise, and falls back
+        // to its address. A feed only ever carries published posts, so in practice
+        // this is the object id; the fallback is what keeps the shape total.
+        id: activityStreamsId(document, baseUrl) ?? link,
+        link,
+        title: document.title,
+        terms: [...document.categories, ...document.tags],
+        summary: feedExcerpt(document),
+        html: document.html,
+        markdown: document.body,
+    };
+    if (published !== undefined && !Number.isNaN(published.getTime()))
+        item.published = published;
+    const updated = lastModifiedOf(document);
+    if (updated !== undefined)
+        item.updated = updated;
+    if (document.author !== undefined)
+        item.author = document.author;
+    const creator = document.author ?? context.site.author;
+    if (creator !== undefined && creator !== '')
+        item.creator = creator;
+    const counts = context.commentCounts;
+    if (counts !== undefined) {
+        item.comments = {
+            page: `${link}#comments`,
+            feed: absoluteUrl(feedPathUnder(document.permalink, 'rss'), baseUrl),
+            count: counts.get(document.permalink) ?? 0,
+        };
+    }
+    return item;
+}
+/** One item per document, in the order the feed was given them. */
+export function feedItems(documents, context) {
+    return documents.map((document) => feedItem(document, context));
+}
+/**
+ * How many words of the rendered text an excerpt keeps when a post carries no
+ * `description`. WordPress's own excerpt length, so a migrated site's feed
+ * reads the same.
+ */
+export const EXCERPT_WORDS = 55;
+/**
+ * The plain-text summary a feed carries for a post.
+ *
+ * The `description` front matter when the post has one — it is what the author
+ * wrote for exactly this — and otherwise the first paragraph of the rendered
+ * body, stripped to text and cut where WordPress cuts an excerpt. Never the
+ * whole post: the content element is where the whole post goes, and a reader
+ * that shows both should have something to choose between.
+ */
+export function feedExcerpt(document) {
+    if (document.description !== undefined)
+        return document.description;
+    return excerptFromHtml(document.html);
+}
+/**
+ * The first paragraph of some HTML as plain text, cut where WordPress cuts an
+ * excerpt. What a post falls back to when it carries no `description`, and
+ * what a comment — which never carries one — always uses.
+ */
+export function excerptFromHtml(html) {
+    // Tags are dropped rather than replaced by a space: the markup inside a
+    // paragraph is inline, and "now</span>," is one word followed by a comma.
+    // What separates the words is the whitespace the renderer already put
+    // between its block tags, which the collapse below turns into single spaces.
+    const paragraph = /<p[^>]*>([\s\S]*?)<\/p>/i.exec(html)?.[1] ?? html;
+    const text = decodeHtmlText(paragraph.replace(/<[^>]*>/g, ''))
+        .replace(/\s+/g, ' ')
+        .trim();
+    if (text === '')
+        return '';
+    const words = text.split(' ');
+    return words.length <= EXCERPT_WORDS ? text : `${words.slice(0, EXCERPT_WORDS).join(' ')} …`;
+}
+/**
+ * The five named entities the Markdown renderer emits, resolved.
+ *
+ * An excerpt is text rather than markup, so `&amp;` in the rendered HTML has
+ * to become `&` here before the XML escaping puts it back: leaving it would
+ * publish a summary reading "Fish &amp;amp; chips".
+ */
+function decodeHtmlText(value) {
+    return value
+        .replace(/&lt;/g, '<')
+        .replace(/&gt;/g, '>')
+        .replace(/&quot;/g, '"')
+        .replace(/&#(?:39|x27);/g, "'")
+        .replace(/&amp;/g, '&');
+}
+//# sourceMappingURL=feed-item.js.map

package/dist/web/feed-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-item.js","sourceRoot":"","sources":["../../src/web/feed-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAgF7D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAsBpC;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAkB,EAAE,OAAwB;IACnE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEpF,MAAM,IAAI,GAAa;QACrB,2EAA2E;QAC3E,2EAA2E;QAC3E,qEAAqE;QACrE,EAAE,EAAE,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,IAAI;QAChD,IAAI;QACJ,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,KAAK,EAAE,CAAC,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC;QACjD,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC;QAC9B,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,QAAQ,EAAE,QAAQ,CAAC,IAAI;KACxB,CAAC;IAEF,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAAE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAE9F,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,OAAO,KAAK,SAAS;QAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAElD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;QAAE,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEjE,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IACvD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,EAAE;QAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAEpE,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IACrC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG;YACd,IAAI,EAAE,GAAG,IAAI,WAAW;YACxB,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC;YACpE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,SAAS,CACvB,SAA8B,EAC9B,OAAwB;IAExB,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,QAAkB;IAC5C,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC,WAAW,CAAC;IACpE,OAAO,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,wEAAwE;IACxE,0EAA0E;IAC1E,sEAAsE;IACtE,6EAA6E;IAC7E,MAAM,SAAS,GAAG,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACrE,MAAM,IAAI,GAAG,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;SAC3D,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE,CAAC;IACV,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAE3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,OAAO,KAAK,CAAC,MAAM,IAAI,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AAC/F,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,KAAK;SACT,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC9B,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAC5B,CAAC"}

package/dist/web/feed-json.d.ts

@@ -0,0 +1,79 @@
+import type { FeedItem } from './feed-item.ts';
+import type { FeedSource } from './feed-source.ts';
+/**
+ * JSON Feed 1.1: the document, its items, and the vocabulary they are spelled
+ * in.
+ *
+ * An item is keyed by the post's object id and lists every term it carries,
+ * which is what the two XML formats do with the same item: decision-12 leaves
+ * the three formats nothing to disagree about.
+ */
+/** The `version` every JSON Feed this CMS writes declares. */
+export declare const JSON_FEED_VERSION = "https://jsonfeed.org/version/1.1";
+/** What JSON Feed 1.1 calls the protocol the notify server's hub speaks. */
+export declare const JSON_FEED_HUB_TYPE = "WebSub";
+/** A JSON Feed 1.1 document. */
+export interface JsonFeed {
+    /** {@link JSON_FEED_VERSION}. */
+    version: string;
+    /** The feed's name. */
+    title: string;
+    /** The HTML page this feed syndicates. */
+    home_page_url: string;
+    /** Where this feed itself lives. */
+    feed_url: string;
+    /** The site's tagline, when it has one. */
+    description?: string;
+    /** Site-level authors, when the site names one. */
+    authors?: JsonFeedAuthor[];
+    /**
+     * Where a subscriber can be told the feed changed rather than polling it.
+     * One entry, the site's notify server, when it names one.
+     */
+    hubs?: JsonFeedHub[];
+    /** The entries, newest first. */
+    items: JsonFeedItem[];
+}
+/**
+ * A real-time endpoint, as JSON Feed 1.1 models one. `type` names the protocol
+ * rather than a media type, and `WebSub` is the one this CMS's server speaks.
+ */
+export interface JsonFeedHub {
+    /** The protocol: `WebSub`. */
+    type: string;
+    /** The hub's URL. */
+    url: string;
+}
+/** An author, as JSON Feed 1.1 models one. */
+export interface JsonFeedAuthor {
+    name: string;
+}
+/** One entry of a {@link JsonFeed}. */
+export interface JsonFeedItem {
+    /**
+     * Permanent identifier: the post's ActivityStreams object id, which is its
+     * permalink unless the post carries a stored one.
+     */
+    id: string;
+    /** Where the entry can be read: the permalink. */
+    url: string;
+    /** Display title. */
+    title: string;
+    /** The rendered body. */
+    content_html: string;
+    /** The post's summary, unless there is nothing to summarise. */
+    summary?: string;
+    /** Publish date, RFC 3339. */
+    date_published?: string;
+    /** Last modification date, RFC 3339. */
+    date_modified?: string;
+    /** The post's terms — its categories and then its tags, in file order. */
+    tags?: string[];
+    /** The post's own author, when it names one. */
+    authors?: JsonFeedAuthor[];
+}
+/** One feed as a JSON Feed 1.1 document. */
+export declare function jsonFeed(source: FeedSource): JsonFeed;
+/** One item as a JSON Feed item. */
+export declare function jsonFeedItem(item: FeedItem): JsonFeedItem;
+//# sourceMappingURL=feed-json.d.ts.map

package/dist/web/feed-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-json.d.ts","sourceRoot":"","sources":["../../src/web/feed-json.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAGnD;;;;;;;GAOG;AAEH,8DAA8D;AAC9D,eAAO,MAAM,iBAAiB,qCAAqC,CAAC;AAEpE,4EAA4E;AAC5E,eAAO,MAAM,kBAAkB,WAAW,CAAC;AAE3C,gCAAgC;AAChC,MAAM,WAAW,QAAQ;IACvB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;IACrB,iCAAiC;IACjC,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,uCAAuC;AACvC,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,4CAA4C;AAC5C,wBAAgB,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,CAcrD;AAED,oCAAoC;AACpC,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY,CAiBzD"}

package/dist/web/feed-json.js

@@ -0,0 +1,53 @@
+import { feedItems } from './feed-item.js';
+import { notifyServerOf } from './feed-source.js';
+import { absoluteUrl } from './negotiate.js';
+/**
+ * JSON Feed 1.1: the document, its items, and the vocabulary they are spelled
+ * in.
+ *
+ * An item is keyed by the post's object id and lists every term it carries,
+ * which is what the two XML formats do with the same item: decision-12 leaves
+ * the three formats nothing to disagree about.
+ */
+/** The `version` every JSON Feed this CMS writes declares. */
+export const JSON_FEED_VERSION = 'https://jsonfeed.org/version/1.1';
+/** What JSON Feed 1.1 calls the protocol the notify server's hub speaks. */
+export const JSON_FEED_HUB_TYPE = 'WebSub';
+/** One feed as a JSON Feed 1.1 document. */
+export function jsonFeed(source) {
+    const { site, baseUrl } = source;
+    const notify = notifyServerOf(site);
+    return {
+        version: JSON_FEED_VERSION,
+        title: source.title,
+        home_page_url: absoluteUrl(source.href, baseUrl),
+        feed_url: absoluteUrl(source.feedHref, baseUrl),
+        ...(site.tagline === undefined ? {} : { description: site.tagline }),
+        ...(site.author === undefined ? {} : { authors: [{ name: site.author }] }),
+        ...(notify === undefined ? {} : { hubs: [{ type: JSON_FEED_HUB_TYPE, url: notify.hub }] }),
+        items: feedItems(source.documents, source).map(jsonFeedItem),
+    };
+}
+/** One item as a JSON Feed item. */
+export function jsonFeedItem(item) {
+    const entry = {
+        id: item.id,
+        url: item.link,
+        title: item.title,
+        content_html: item.html,
+    };
+    // A key with nothing behind it is left out rather than sent empty: a JSON
+    // Feed reader treats absent and empty differently.
+    if (item.summary !== '')
+        entry.summary = item.summary;
+    if (item.published !== undefined)
+        entry.date_published = item.published.toISOString();
+    if (item.updated !== undefined)
+        entry.date_modified = item.updated.toISOString();
+    if (item.terms.length > 0)
+        entry.tags = [...item.terms];
+    if (item.author !== undefined)
+        entry.authors = [{ name: item.author }];
+    return entry;
+}
+//# sourceMappingURL=feed-json.js.map

package/dist/web/feed-json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feed-json.js","sourceRoot":"","sources":["../../src/web/feed-json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;GAOG;AAEH,8DAA8D;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,kCAAkC,CAAC;AAEpE,4EAA4E;AAC5E,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC;AAkE3C,4CAA4C;AAC5C,MAAM,UAAU,QAAQ,CAAC,MAAkB;IACzC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACjC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IAEpC,OAAO;QACL,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,aAAa,EAAE,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC;QAChD,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QACpE,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;QAC1E,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QAC1F,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,MAAM,KAAK,GAAiB;QAC1B,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,GAAG,EAAE,IAAI,CAAC,IAAI;QACd,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,YAAY,EAAE,IAAI,CAAC,IAAI;KACxB,CAAC;IAEF,0EAA0E;IAC1E,mDAAmD;IACnD,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE;QAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IACtD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS;QAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;IACtF,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;QAAE,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACjF,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACxD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,CAAC,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAEvE,OAAO,KAAK,CAAC;AACf,CAAC"}