@geekity/cms 0.3.0 → 0.4.0

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

@@ -0,0 +1,26 @@
+import type { FeedItem } from './feed-item.ts';
+import type { CommentFeedSource, FeedSource } from './feed-source.ts';
+/**
+ * RSS 2.0: the post feed, the comments feed, and the channel they share.
+ *
+ * The items come from {@link FeedItem}s rather than from documents, so what an
+ * RSS item says about a post is decided in one place and read here — and says
+ * the same as what Atom and JSON Feed say about it, because there is only one
+ * id, one term list and one summary on the item to print.
+ */
+/** One feed as an RSS 2.0 document. */
+export declare function rssFeed(source: FeedSource): string;
+/**
+ * One item as RSS.
+ *
+ * The `guid` is the item's id, which decision-12 makes every feed's key for
+ * the post: after decision-13 that is the permalink itself, or the stored id a
+ * migrated post carries. `isPermaLink` tells a reader which of the two it is
+ * looking at — `true` when the id is the permalink, so a reader that resolves
+ * a guid finds the post, and `false` when it is a stored name like WordPress's
+ * `?p=813`, which is the id that post's subscribers already hold.
+ */
+export declare function rssItem(item: FeedItem): string[];
+/** One comments feed as an RSS 2.0 document. */
+export declare function commentsRssFeed(source: CommentFeedSource): string;
+//# sourceMappingURL=feed-rss.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feed-rss.d.ts","sourceRoot":"","sources":["../../src/web/feed-rss.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAQ/C,OAAO,KAAK,EAAE,iBAAiB,EAAe,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAanF;;;;;;;GAOG;AAEH,uCAAuC;AACvC,wBAAgB,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAmClD;AA8CD;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,EAAE,CAsBhD;AA2BD,gDAAgD;AAChD,wBAAgB,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAgCjE"}

package/dist/web/feed-rss.js

@@ -0,0 +1,203 @@
+import { excerptFromHtml, feedItems } from './feed-item.js';
+import { contentTypeOf, EMPTY_FEED_UPDATED, FEED_GENERATOR, feedLanguage, notifyServerOf, } from './feed-source.js';
+import { cdata, DC_NAMESPACE, element, escapeXml, rfc822, SOURCE_NAMESPACE, WFW_NAMESPACE, } from './feed-xml.js';
+import { absoluteUrl, latestModified } from './negotiate.js';
+import { sanitizeCommentHtml } from './sanitize.js';
+/**
+ * RSS 2.0: the post feed, the comments feed, and the channel they share.
+ *
+ * The items come from {@link FeedItem}s rather than from documents, so what an
+ * RSS item says about a post is decided in one place and read here — and says
+ * the same as what Atom and JSON Feed say about it, because there is only one
+ * id, one term list and one summary on the item to print.
+ */
+/** One feed as an RSS 2.0 document. */
+export function rssFeed(source) {
+    const { site, documents, baseUrl } = source;
+    const link = absoluteUrl(source.href, baseUrl);
+    const built = latestModified(documents) ?? EMPTY_FEED_UPDATED;
+    const lines = [
+        '<?xml version="1.0" encoding="utf-8"?>',
+        '<rss version="2.0"',
+        '     xmlns:atom="http://www.w3.org/2005/Atom"',
+        '     xmlns:content="http://purl.org/rss/1.0/modules/content/"',
+        `     xmlns:dc="${DC_NAMESPACE}"`,
+        `     xmlns:source="${SOURCE_NAMESPACE}"`,
+        `     xmlns:wfw="${WFW_NAMESPACE}">`,
+        '  <channel>',
+        element('title', source.title, 2),
+        element('link', link, 2),
+        // Required by the spec even when the site has no tagline, so it is written
+        // empty rather than left out.
+        element('description', site.tagline ?? '', 2),
+        element('language', feedLanguage(site), 2),
+        element('lastBuildDate', rfc822(built), 2),
+        element('generator', FEED_GENERATOR, 2),
+        `    <atom:link rel="self" type="${escapeXml(contentTypeOf('rss'))}" href="${escapeXml(absoluteUrl(source.feedHref, baseUrl))}"/>`,
+        ...cloudElements(site),
+        ...channelImage(source, link),
+    ];
+    for (const item of feedItems(documents, source)) {
+        lines.push(...rssItem(item));
+    }
+    lines.push('  </channel>', '</rss>', '');
+    return lines.join('\n');
+}
+/**
+ * The notify server, said the three ways an RSS channel can say it: the legacy
+ * `<cloud>` a 2001 aggregator understands, `<source:cloud>` for one that reads
+ * Dave Winer's namespace, and the WebSub `rel="hub"` link.
+ *
+ * All three name the same server, so a subscriber gets told the moment the
+ * feed changes whichever of the protocols it speaks. Nothing at all when the
+ * site names no server.
+ */
+function cloudElements(site) {
+    const notify = notifyServerOf(site);
+    if (notify === undefined)
+        return [];
+    const { cloud } = notify;
+    return [
+        `    <cloud domain="${escapeXml(cloud.domain)}" port="${String(cloud.port)}"` +
+            ` path="${escapeXml(cloud.path)}"` +
+            ` registerProcedure="${escapeXml(cloud.registerProcedure)}"` +
+            ` protocol="${escapeXml(cloud.protocol)}"/>`,
+        element('source:cloud', notify.pleaseNotify, 2),
+        `    <atom:link rel="hub" href="${escapeXml(notify.hub)}"/>`,
+    ];
+}
+/**
+ * The channel's `<image>`, from the site's avatar.
+ *
+ * RSS wants the title and the link to repeat the channel's own, and a reader
+ * that shows a feed icon is showing the site's face; the avatar setting is the
+ * only picture a site names.
+ */
+function channelImage(source, link) {
+    const avatar = source.site.avatar;
+    if (avatar === undefined || avatar === '')
+        return [];
+    return [
+        '    <image>',
+        element('url', absoluteUrl(avatar, source.baseUrl), 3),
+        element('title', source.title, 3),
+        element('link', link, 3),
+        '    </image>',
+    ];
+}
+/**
+ * One item as RSS.
+ *
+ * The `guid` is the item's id, which decision-12 makes every feed's key for
+ * the post: after decision-13 that is the permalink itself, or the stored id a
+ * migrated post carries. `isPermaLink` tells a reader which of the two it is
+ * looking at — `true` when the id is the permalink, so a reader that resolves
+ * a guid finds the post, and `false` when it is a stored name like WordPress's
+ * `?p=813`, which is the id that post's subscribers already hold.
+ */
+export function rssItem(item) {
+    return [
+        '    <item>',
+        element('title', item.title, 3),
+        element('link', item.link, 3),
+        `      <guid isPermaLink="${item.id === item.link ? 'true' : 'false'}">` +
+            `${escapeXml(item.id)}</guid>`,
+        ...(item.published === undefined ? [] : [element('pubDate', rfc822(item.published), 3)]),
+        ...(item.creator === undefined ? [] : [element('dc:creator', item.creator, 3)]),
+        // Every term becomes a category. RSS has one `<category>` and no way to say
+        // which vocabulary a term came from, which is exactly how WordPress
+        // publishes tags and categories too.
+        ...item.terms.map((term) => `      <category>${escapeXml(term)}</category>`),
+        ...commentPointers(item),
+        element('description', item.summary, 3),
+        `      <content:encoded>${cdata(item.html)}</content:encoded>`,
+        // The source of the item, per the namespace: a reader that understands
+        // Markdown should render from this rather than from the HTML above. It is
+        // the same text the ActivityStreams `Article` carries as its `source`.
+        `      <source:markdown>${cdata(item.markdown)}</source:markdown>`,
+        '    </item>',
+    ];
+}
+/**
+ * Where one item's comments are, said three ways.
+ *
+ * `<comments>` is the page a person should read them on and `wfw:commentRss`
+ * the feed a reader should poll, which is the pair WordPress publishes and so
+ * the pair every reader already understands. `source:comments` is the same
+ * feed with the count beside it, so a reader can say "3 comments" without
+ * fetching anything.
+ *
+ * Written only when the item carries them: a feed whose builder did not
+ * resolve the counts would otherwise publish "0 comments" about a post with
+ * plenty.
+ */
+function commentPointers(item) {
+    const comments = item.comments;
+    if (comments === undefined)
+        return [];
+    return [
+        element('comments', comments.page, 3),
+        element('wfw:commentRss', comments.feed, 3),
+        `      <source:comments count="${String(comments.count)}" ` +
+            `feedUrl="${escapeXml(comments.feed)}"/>`,
+    ];
+}
+/** One comments feed as an RSS 2.0 document. */
+export function commentsRssFeed(source) {
+    const { site, comments, baseUrl } = source;
+    const link = absoluteUrl(source.href, baseUrl);
+    const built = comments[0]?.published ?? EMPTY_FEED_UPDATED;
+    const lines = [
+        '<?xml version="1.0" encoding="utf-8"?>',
+        '<rss version="2.0"',
+        '     xmlns:atom="http://www.w3.org/2005/Atom"',
+        '     xmlns:content="http://purl.org/rss/1.0/modules/content/"',
+        `     xmlns:dc="${DC_NAMESPACE}"`,
+        `     xmlns:source="${SOURCE_NAMESPACE}">`,
+        '  <channel>',
+        element('title', source.title, 2),
+        element('link', link, 2),
+        element('description', site.tagline ?? '', 2),
+        element('language', feedLanguage(site), 2),
+        element('lastBuildDate', rfc822(built), 2),
+        element('generator', FEED_GENERATOR, 2),
+        `    <atom:link rel="self" type="${escapeXml(contentTypeOf('rss'))}" href="${escapeXml(absoluteUrl(source.feedHref, baseUrl))}"/>`,
+        // A comments feed is polled like any other, so it advertises the same
+        // server: a subscriber to one is told a reply arrived rather than finding
+        // out on its next poll.
+        ...cloudElements(site),
+    ];
+    for (const comment of comments)
+        lines.push(...commentItem(comment));
+    lines.push('  </channel>', '</rss>', '');
+    return lines.join('\n');
+}
+/**
+ * One comment as an RSS item.
+ *
+ * A comment is not a {@link FeedItem}: it is one entry of the conversation
+ * under a post, with its own id, its own author and no taxonomy at all, and
+ * the Conversation module is what derives it. The sanitising happens here, at
+ * the last moment before the markup a stranger wrote becomes bytes this site
+ * publishes, so there is one place to check rather than one per caller.
+ */
+function commentItem(comment) {
+    const html = sanitizeCommentHtml(comment.html);
+    const title = comment.post === undefined ? comment.author : `${comment.author} on ${comment.post.title}`;
+    return [
+        '    <item>',
+        element('title', title, 3),
+        element('link', comment.url, 3),
+        // A reply's id is a name rather than an address: some servers publish a
+        // note at an id nothing dereferences and a `url` somewhere else entirely.
+        `      <guid isPermaLink="false">${escapeXml(comment.id)}</guid>`,
+        element('pubDate', rfc822(comment.published), 3),
+        element('dc:creator', comment.author, 3),
+        // A comment never carries a description, so its summary is always an
+        // excerpt of what it says.
+        element('description', excerptFromHtml(html), 3),
+        `      <content:encoded>${cdata(html)}</content:encoded>`,
+        '    </item>',
+    ];
+}
+//# sourceMappingURL=feed-rss.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feed-rss.js","sourceRoot":"","sources":["../../src/web/feed-rss.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,cAAc,GACf,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,KAAK,EACL,YAAY,EACZ,OAAO,EACP,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,aAAa,GACd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD;;;;;;;GAOG;AAEH,uCAAuC;AACvC,MAAM,UAAU,OAAO,CAAC,MAAkB;IACxC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC5C,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC;IAE9D,MAAM,KAAK,GAAa;QACtB,wCAAwC;QACxC,oBAAoB;QACpB,+CAA+C;QAC/C,+DAA+D;QAC/D,kBAAkB,YAAY,GAAG;QACjC,sBAAsB,gBAAgB,GAAG;QACzC,mBAAmB,aAAa,IAAI;QACpC,aAAa;QACb,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxB,2EAA2E;QAC3E,8BAA8B;QAC9B,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;QACvC,mCAAmC,SAAS,CAC1C,aAAa,CAAC,KAAK,CAAC,CACrB,WAAW,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK;QACjE,GAAG,aAAa,CAAC,IAAI,CAAC;QACtB,GAAG,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC;KAC9B,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,IAAc;IACnC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEzB,OAAO;QACL,sBAAsB,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YAC3E,UAAU,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YAClC,uBAAuB,SAAS,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG;YAC5D,cAAc,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK;QAC9C,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;QAC/C,kCAAkC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK;KAC7D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,MAAkB,EAAE,IAAY;IACpD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;IAClC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAErD,OAAO;QACL,aAAa;QACb,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACtD,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxB,cAAc;KACf,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CAAC,IAAc;IACpC,OAAO;QACL,YAAY;QACZ,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/B,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7B,4BAA4B,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI;YACtE,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS;QAChC,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACxF,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAC/E,4EAA4E;QAC5E,oEAAoE;QACpE,qCAAqC;QACrC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC;QAC5E,GAAG,eAAe,CAAC,IAAI,CAAC;QACxB,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACvC,0BAA0B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB;QAC9D,uEAAuE;QACvE,0EAA0E;QAC1E,uEAAuE;QACvE,0BAA0B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB;QAClE,aAAa;KACd,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,eAAe,CAAC,IAAc;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAEtC,OAAO;QACL,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACrC,OAAO,CAAC,gBAAgB,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,iCAAiC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI;YACzD,YAAY,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK;KAC5C,CAAC;AACJ,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,eAAe,CAAC,MAAyB;IACvD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAC3C,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,SAAS,IAAI,kBAAkB,CAAC;IAE3D,MAAM,KAAK,GAAa;QACtB,wCAAwC;QACxC,oBAAoB;QACpB,+CAA+C;QAC/C,+DAA+D;QAC/D,kBAAkB,YAAY,GAAG;QACjC,sBAAsB,gBAAgB,IAAI;QAC1C,aAAa;QACb,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACjC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxB,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;QACvC,mCAAmC,SAAS,CAC1C,aAAa,CAAC,KAAK,CAAC,CACrB,WAAW,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,KAAK;QACjE,sEAAsE;QACtE,0EAA0E;QAC1E,wBAAwB;QACxB,GAAG,aAAa,CAAC,IAAI,CAAC;KACvB,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpE,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,WAAW,CAAC,OAAoB;IACvC,MAAM,IAAI,GAAG,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,KAAK,GACT,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IAE7F,OAAO;QACL,YAAY;QACZ,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/B,wEAAwE;QACxE,0EAA0E;QAC1E,mCAAmC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS;QACjE,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAChD,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACxC,qEAAqE;QACrE,2BAA2B;QAC3B,OAAO,CAAC,aAAa,EAAE,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChD,0BAA0B,KAAK,CAAC,IAAI,CAAC,oBAAoB;QACzD,aAAa;KACd,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,244 @@
+import type { Document } from '../content/document.ts';
+import type { SiteData } from './context.ts';
+/**
+ * What a feed is, before anything has been written: which formats the site
+ * serves, where each one lives, what the site's settings say about it, and
+ * what one feed is built from.
+ *
+ * Everything here is a fact about the feed as a whole — its URL, its language,
+ * its notify server, its entries — rather than about any one item or any one
+ * format. The serialisers and the response layer both read it, which is why it
+ * sits below them and imports neither.
+ */
+/**
+ * The three syndication formats the public site serves.
+ *
+ * Feeds are fixed routes rather than representations (doc-3): a feed reader
+ * sends whatever `Accept` header its HTTP library happened to default to, so
+ * the URL has to say which format it wants.
+ *
+ * RSS is first because it is what the subscribers of a site moving off
+ * WordPress actually hold, and it is what the bare `/feed/` serves.
+ */
+export type FeedFormat = 'rss' | 'atom' | 'json';
+/** Every format, RSS first, in the order a page should advertise them. */
+export declare const FEED_FORMATS: readonly FeedFormat[];
+/** The segment every feed URL hangs off its listing root by: `/feed/…`. */
+export declare const FEED_SEGMENT = "feed";
+/**
+ * The segment under `feed/` each format lives at.
+ *
+ * RSS has none, so the bare `/feed/` is RSS 2.0 — WordPress's layout, and the
+ * URL every existing subscriber of a migrated site already polls.
+ */
+export declare const FEED_SEGMENTS: Readonly<Record<FeedFormat, string>>;
+/**
+ * Spellings WordPress also answered on, which this site redirects rather than
+ * serves. `/feed/rss/` was its alias for the RSS 2.0 feed.
+ */
+export declare const FEED_ALIASES: Readonly<Record<string, FeedFormat>>;
+/**
+ * The root the site-wide comments feed hangs off, so `/comments/feed/` is the
+ * URL WordPress served it at. It is a listing root like any other as far as
+ * {@link feedPathUnder} is concerned; nothing is served at the root itself.
+ */
+export declare const COMMENTS_ROOT = "/comments/";
+/** What a post's comments feed calls itself, before the post's title. */
+export declare const COMMENTS_TITLE_PREFIX = "Comments on: ";
+/** What each format is labelled with on the wire. */
+export declare const FEED_CONTENT_TYPES: Readonly<Record<FeedFormat, string>>;
+/**
+ * The URL of one format's feed under a listing root.
+ *
+ * The root is any listing URL ending in `/` — the site root, a taxonomy
+ * archive, and in time a post's permalink for its comments feed — so this is
+ * the one place the `/feed/…/` shape is spelled.
+ */
+export declare function feedPathUnder(root: string, format: FeedFormat): string;
+/**
+ * The URL of a comments feed: one post's, or — with no permalink — the whole
+ * site's.
+ *
+ * WordPress's URLs, so a site migrated from it keeps both. There is one format,
+ * RSS 2.0, because that is what a comments feed is read in.
+ */
+export declare function commentsFeedPath(permalink?: string): string;
+/** A feed URL taken apart: which listing it syndicates, and in what format. */
+export interface FeedPath {
+    /** The listing root the feed hangs off, ending in `/`. */
+    root: string;
+    /** Which format the URL asked for. */
+    format: FeedFormat;
+    /**
+     * Whether this is the canonical spelling of that feed. `/feed/rss/` is not:
+     * it is a WordPress alias, and it earns a redirect rather than a body.
+     */
+    canonical: boolean;
+}
+/**
+ * A path as the feed it names, or `undefined` when it names none.
+ *
+ * The inverse of {@link feedPathUnder}, and deliberately ignorant of what the
+ * root turns out to be: the caller decides whether `/tag/x/` is a listing it
+ * serves. Only the slashed form parses; the bare `/feed` is handled by the
+ * canonical redirect, like every other missing trailing slash on the site.
+ */
+export declare function splitFeedPath(pathname: string): FeedPath | undefined;
+/** The media type a format is labelled with, without the charset. */
+export declare function contentTypeOf(format: FeedFormat): string;
+/**
+ * The notify server a site advertises and pings when it has not said
+ * otherwise: the one this CMS's author runs, which speaks both rssCloud and
+ * WebSub, so one server covers every real-time subscriber a feed has.
+ */
+export declare const DEFAULT_NOTIFY_SERVER = "https://rpc.rsscloud.io";
+/** The three paths a notify server answers on, under whatever URL it lives at. */
+export declare const NOTIFY_PATHS: {
+    /** Where a subscriber registers for rssCloud notifications. */
+    readonly pleaseNotify: 'pleaseNotify';
+    /** The WebSub hub: where a subscriber subscribes, and a publisher publishes. */
+    readonly hub: 'websub';
+    /** Where this site says a feed changed. */
+    readonly ping: 'ping';
+};
+/**
+ * The port and protocol the legacy `<cloud>` element carries, whatever scheme
+ * the server itself is reached over.
+ *
+ * rpc.rsscloud.io's quick start prescribes exactly these: the element predates
+ * TLS being the default, and a reader that understands it is looking for the
+ * shape rather than for a port to dial.
+ */
+export declare const NOTIFY_CLOUD_PORT = 80;
+/** The `protocol` of that same element. */
+export declare const NOTIFY_CLOUD_PROTOCOL = "http-post";
+/** One notify server, as the three vocabularies that talk to it spell it. */
+export interface NotifyServer {
+    /** The server's URL, without a trailing slash. What the setting holds. */
+    base: string;
+    /** Where an rssCloud subscriber registers: `source:cloud`. */
+    pleaseNotify: string;
+    /** The WebSub hub: `atom:link rel="hub"` and JSON Feed's `hubs`. */
+    hub: string;
+    /** Where this site announces that a feed changed. */
+    ping: string;
+    /** The same registration endpoint, taken apart for RSS's `<cloud>`. */
+    cloud: {
+        /** The server's host name. */
+        domain: string;
+        /** Always {@link NOTIFY_CLOUD_PORT}. */
+        port: number;
+        /** The registration path, from the root of that host. */
+        path: string;
+        /** Empty: the REST endpoint takes no procedure name. */
+        registerProcedure: string;
+        /** Always {@link NOTIFY_CLOUD_PROTOCOL}. */
+        protocol: string;
+    };
+}
+/**
+ * One notify server URL as everything derived from it, or `undefined` when
+ * there is no server: an empty setting is how a site turns the whole feature
+ * off, and a value that is not an absolute http(s) URL is treated the same way
+ * rather than published as nonsense.
+ */
+export declare function notifyEndpoints(server: string): NotifyServer | undefined;
+/**
+ * The notify server this site's feeds advertise, from `notifyServer` in
+ * `content/_data/site.json`.
+ *
+ * An empty value is a site that turned real-time notification off; a missing
+ * key is a site that has never said, and gets {@link DEFAULT_NOTIFY_SERVER}.
+ * That is the same rule the settings read the file by, so the server the feeds
+ * advertise is always the server the CMS pings.
+ */
+export declare function notifyServerOf(site: SiteData): NotifyServer | undefined;
+/** How many entries a feed carries when the site does not say. */
+export declare const DEFAULT_FEED_SIZE = 20;
+/** What the feeds name themselves as. */
+export declare const FEED_GENERATOR = "Geekity";
+/** Where a reader can go to find out what wrote the feed. */
+export declare const FEED_GENERATOR_URI = "https://www.npmjs.com/package/@geekity/cms";
+/**
+ * How many entries a feed carries.
+ *
+ * `feedSize` in `content/_data/site.json` wins; without it a feed is longer
+ * than an archive page, because a reader that polls once a day should not miss
+ * a post on a site that publishes several.
+ */
+export declare function feedSize(site: SiteData): number;
+/** The language a feed declares when the site does not name one. */
+export declare const DEFAULT_FEED_LANGUAGE = "en";
+/** The language tag a feed declares: the site's, or {@link DEFAULT_FEED_LANGUAGE}. */
+export declare function feedLanguage(site: SiteData): string;
+/**
+ * The instant a feed reports as its own `updated`.
+ *
+ * An empty feed still has to carry one, and it has to be the same on every
+ * request or the ETag would change while nothing did, so it is the epoch
+ * rather than the clock.
+ */
+export declare const EMPTY_FEED_UPDATED: Date;
+/** Everything one feed is built from, whichever format it ends up in. */
+export interface FeedSource {
+    /** Site-wide data, for the title, subtitle and author. */
+    site: SiteData;
+    /** The entries, newest first. Already filtered to what the public may see. */
+    documents: readonly Document[];
+    /** Title of this feed. The site title, or the site title and the tag. */
+    title: string;
+    /** Path of the HTML page this feed syndicates: `/` or `/tags/{tag}/`. */
+    href: string;
+    /** Path of the feed itself, for the self link. */
+    feedHref: string;
+    /** The site's public origin, for absolute ids and links. */
+    baseUrl: string;
+    /**
+     * How many replies each document has, by permalink, for the comment
+     * pointers every RSS item carries.
+     *
+     * Resolved rather than looked up while the feed is written, because the
+     * counts are part of the feed's own validator: a post that has been answered
+     * since is a changed feed even though no post moved.
+     */
+    commentCounts?: ReadonlyMap<string, number> | undefined;
+}
+/** Everything one comments feed is built from. */
+export interface CommentFeedSource {
+    /** Site-wide data, for the description and the language. */
+    site: SiteData;
+    /** The comments, newest first. Their HTML is sanitised here, not before. */
+    comments: readonly FeedComment[];
+    /** Title of this feed: `Comments on: {post}`, or the site's. */
+    title: string;
+    /** Path of the HTML page these comments are about. */
+    href: string;
+    /** Path of the feed itself, for the self link. */
+    feedHref: string;
+    /** The site's public origin, for absolute links. */
+    baseUrl: string;
+}
+/** One comment, as a feed shows it. */
+export interface FeedComment {
+    /** The reply's own name in the fediverse: the `guid`. */
+    id: string;
+    /** Where it can be read. */
+    url: string;
+    /** Who wrote it. */
+    author: string;
+    /** When it was published. */
+    published: Date;
+    /** What it says, as its own server rendered it and before sanitising. */
+    html: string;
+    /**
+     * The post it answers, named on every item of the site-wide feed and on none
+     * of a post's own — there, every item answers the same post.
+     */
+    post?: {
+        title: string;
+        permalink: string;
+    } | undefined;
+}
+/** Enough of any feed to say where it lives: what a header needs from one. */
+export type FeedIdentity = Pick<FeedSource, 'site' | 'feedHref' | 'baseUrl'>;
+//# sourceMappingURL=feed-source.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feed-source.d.ts","sourceRoot":"","sources":["../../src/web/feed-source.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;;;;;GASG;AAEH;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjD,0EAA0E;AAC1E,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAA4B,CAAC;AAE3E,2EAA2E;AAC3E,eAAO,MAAM,YAAY,SAAS,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAI9D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAE7D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C,yEAAyE;AACzE,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD,qDAAqD;AACrD,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAInE,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM,CAGtE;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED,+EAA+E;AAC/E,MAAM,WAAW,QAAQ;IACvB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,MAAM,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAkBpE;AAED,qEAAqE;AACrE,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,4BAA4B,CAAC;AAE/D,kFAAkF;AAClF,eAAO,MAAM,YAAY;IACvB,+DAA+D;aAC/D,YAAY,EAAE,cAAc;IAC5B,gFAAgF;aAChF,GAAG,EAAE,QAAQ;IACb,2CAA2C;aAC3C,IAAI,EAAE,MAAM;CACJ,CAAC;AAEX;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,2CAA2C;AAC3C,eAAO,MAAM,qBAAqB,cAAc,CAAC;AAEjD,6EAA6E;AAC7E,MAAM,WAAW,YAAY;IAC3B,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,KAAK,EAAE;QACL,8BAA8B;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAC;QACb,yDAAyD;QACzD,IAAI,EAAE,MAAM,CAAC;QACb,wDAAwD;QACxD,iBAAiB,EAAE,MAAM,CAAC;QAC1B,4CAA4C;QAC5C,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CA4BxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY,GAAG,SAAS,CAIvE;AAED,kEAAkE;AAClE,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,yCAAyC;AACzC,eAAO,MAAM,cAAc,YAAY,CAAC;AAExC,6DAA6D;AAC7D,eAAO,MAAM,kBAAkB,+CAA+C,CAAC;AAE/E;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAM/C;AAED,oEAAoE;AACpE,eAAO,MAAM,qBAAqB,OAAO,CAAC;AAE1C,sFAAsF;AACtF,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAKnD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,MAAc,CAAC;AAE9C,yEAAyE;AACzE,MAAM,WAAW,UAAU;IACzB,0DAA0D;IAC1D,IAAI,EAAE,QAAQ,CAAC;IACf,8EAA8E;IAC9E,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC/B,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACzD;AAED,kDAAkD;AAClD,MAAM,WAAW,iBAAiB;IAChC,4DAA4D;IAC5D,IAAI,EAAE,QAAQ,CAAC;IACf,4EAA4E;IAC5E,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;IACjC,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,uCAAuC;AACvC,MAAM,WAAW,WAAW;IAC1B,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,SAAS,EAAE,IAAI,CAAC;IAChB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACzD;AAED,8EAA8E;AAC9E,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC"}