@geekity/cms 0.3.0

package/dist/federation/actor.d.ts

@@ -0,0 +1,55 @@
+import type { Context, RequestContext } from '@fedify/fedify';
+import { Application, Group, Organization, Person, Service } from '@fedify/vocab';
+import type { Actor } from '@fedify/vocab';
+import type { SiteSettings } from '../admin/settings.ts';
+/**
+ * The vocabulary class behind each of {@link ACTOR_TYPES}.
+ *
+ * The setting is a string, because it is a form field and a SQLite row; this
+ * is where it becomes the class the actor document is built from.
+ */
+export declare const ACTOR_CLASSES: {
+    readonly Person: typeof Person;
+    readonly Organization: typeof Organization;
+    readonly Service: typeof Service;
+    readonly Group: typeof Group;
+    readonly Application: typeof Application;
+};
+/** What {@link siteActor} needs beyond the Fedify context. */
+export interface SiteActorOptions {
+    /** The settings the profile is built from. */
+    settings: SiteSettings;
+    /**
+     * The base URL actually in effect, which the settings' own may not be: it is
+     * what the avatar's path is resolved against. Defaults to the setting.
+     */
+    baseUrl?: string | undefined;
+}
+/**
+ * The site's avatar as the absolute URL an `icon` carries, or `undefined` when
+ * the site has none.
+ *
+ * The setting holds what the upload endpoint handed back —
+ * `/uploads/2026/09/me.png` — because that is where the site serves the file
+ * and where an Eleventy build of the same content copies it through to. A peer
+ * reading the actor has no site to resolve that against, so it is made
+ * absolute here. An avatar already given as an absolute URL is left alone.
+ */
+export declare function avatarUrl(avatar: string, baseUrl: string): string | undefined;
+/**
+ * The site's ActivityPub actor, as doc-4 describes it: one actor for the whole
+ * site, whose profile fields are the settings.
+ *
+ * Every URL comes from the Fedify context rather than from string
+ * concatenation, so the ids stay in step with the paths the dispatchers are
+ * registered under. The keys come from the key pairs dispatcher: `publicKey`
+ * is the RSA one Mastodon verifies HTTP Signatures with, `assertionMethods`
+ * are the multikeys FEP-8b32 proofs are checked against.
+ */
+export declare function siteActor(context: RequestContext<unknown> | Context<unknown>, identifier: string, options: SiteActorOptions): Promise<Actor>;
+/**
+ * The class for an actor type, falling back to the default when the stored
+ * setting is one this version does not know.
+ */
+export declare function actorClassFor(actorType: string): (typeof ACTOR_CLASSES)[keyof typeof ACTOR_CLASSES];
+//# sourceMappingURL=actor.d.ts.map

package/dist/federation/actor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actor.d.ts","sourceRoot":"","sources":["../../src/federation/actor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAa,KAAK,EAAS,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAG3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGzD;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;CAMuD,CAAC;AAElF,8DAA8D;AAC9D,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,QAAQ,EAAE,YAAY,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAW7E;AAED;;;;;;;;;GASG;AACH,wBAAsB,SAAS,CAC7B,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,EACnD,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,KAAK,CAAC,CA8BhB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,MAAM,GAChB,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAGpD"}

package/dist/federation/actor.js

@@ -0,0 +1,101 @@
+import { Application, Endpoints, Group, Image, Organization, Person, Service } from '@fedify/vocab';
+import { ACTOR_TYPES, DEFAULT_SITE_SETTINGS } from '../admin/settings.js';
+import { absoluteUrl } from '../web/negotiate.js';
+/**
+ * The vocabulary class behind each of {@link ACTOR_TYPES}.
+ *
+ * The setting is a string, because it is a form field and a SQLite row; this
+ * is where it becomes the class the actor document is built from.
+ */
+export const ACTOR_CLASSES = {
+    Person,
+    Organization,
+    Service,
+    Group,
+    Application,
+};
+/**
+ * The site's avatar as the absolute URL an `icon` carries, or `undefined` when
+ * the site has none.
+ *
+ * The setting holds what the upload endpoint handed back —
+ * `/uploads/2026/09/me.png` — because that is where the site serves the file
+ * and where an Eleventy build of the same content copies it through to. A peer
+ * reading the actor has no site to resolve that against, so it is made
+ * absolute here. An avatar already given as an absolute URL is left alone.
+ */
+export function avatarUrl(avatar, baseUrl) {
+    const value = avatar.trim();
+    if (value === '')
+        return undefined;
+    if (urlOrNull(value) !== null)
+        return value;
+    if (baseUrl === '')
+        return undefined;
+    try {
+        return absoluteUrl(value, baseUrl);
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * The site's ActivityPub actor, as doc-4 describes it: one actor for the whole
+ * site, whose profile fields are the settings.
+ *
+ * Every URL comes from the Fedify context rather than from string
+ * concatenation, so the ids stay in step with the paths the dispatchers are
+ * registered under. The keys come from the key pairs dispatcher: `publicKey`
+ * is the RSA one Mastodon verifies HTTP Signatures with, `assertionMethods`
+ * are the multikeys FEP-8b32 proofs are checked against.
+ */
+export async function siteActor(context, identifier, options) {
+    const { settings } = options;
+    // The base URL in effect, which is what the profile's own URL and the
+    // avatar's are built on; the setting is the fallback for a caller that has
+    // no resolved config in hand.
+    const baseUrl = options.baseUrl ?? settings.baseUrl;
+    const icon = avatarUrl(settings.avatar, baseUrl);
+    const keys = await context.getActorKeyPairs(identifier);
+    const ActorClass = actorClassFor(settings.actorType);
+    return new ActorClass({
+        id: context.getActorUri(identifier),
+        preferredUsername: settings.actorHandle,
+        name: settings.title,
+        summary: settings.tagline === '' ? null : settings.tagline,
+        url: urlOrNull(baseUrl),
+        icon: icon === undefined ? null : new Image({ url: new URL(icon) }),
+        inbox: context.getInboxUri(identifier),
+        outbox: context.getOutboxUri(identifier),
+        followers: context.getFollowersUri(identifier),
+        following: context.getFollowingUri(identifier),
+        endpoints: new Endpoints({ sharedInbox: context.getInboxUri() }),
+        publicKey: keys[0]?.cryptographicKey ?? null,
+        assertionMethods: keys.map((key) => key.multikey),
+        // A blog actor accepts every follower, and says so, rather than leaving a
+        // client to guess whether a follow will ever be answered.
+        manuallyApprovesFollowers: false,
+        discoverable: true,
+        indexable: true,
+    });
+}
+/**
+ * The class for an actor type, falling back to the default when the stored
+ * setting is one this version does not know.
+ */
+export function actorClassFor(actorType) {
+    const known = ACTOR_TYPES.includes(actorType) ? actorType : DEFAULT_SITE_SETTINGS.actorType;
+    return ACTOR_CLASSES[known] ?? Person;
+}
+/** A URL, or `null` when the string is empty or is not one. */
+function urlOrNull(value) {
+    if (value === '')
+        return null;
+    try {
+        return new URL(value);
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=actor.js.map

package/dist/federation/actor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actor.js","sourceRoot":"","sources":["../../src/federation/actor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGpG,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM;IACN,YAAY;IACZ,OAAO;IACP,KAAK;IACL,WAAW;CACoE,CAAC;AAalF;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,OAAe;IACvD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IACnC,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAErC,IAAI,CAAC;QACH,OAAO,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,OAAmD,EACnD,UAAkB,EAClB,OAAyB;IAEzB,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,sEAAsE;IACtE,2EAA2E;IAC3E,8BAA8B;IAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC;IACpD,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAErD,OAAO,IAAI,UAAU,CAAC;QACpB,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC;QACnC,iBAAiB,EAAE,QAAQ,CAAC,WAAW;QACvC,IAAI,EAAE,QAAQ,CAAC,KAAK;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO;QAC1D,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;QACvB,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACnE,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC;QACtC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC;QACxC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC;QAC9C,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC;QAC9C,SAAS,EAAE,IAAI,SAAS,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;QAChE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,gBAAgB,IAAI,IAAI;QAC5C,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;QACjD,0EAA0E;QAC1E,0DAA0D;QAC1D,yBAAyB,EAAE,KAAK;QAChC,YAAY,EAAE,IAAI;QAClB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,SAAiB;IAEjB,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,SAAS,CAAC;IAC5F,OAAO,aAAa,CAAC,KAAmC,CAAC,IAAI,MAAM,CAAC;AACtE,CAAC;AAED,+DAA+D;AAC/D,SAAS,SAAS,CAAC,KAAa;IAC9B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC9B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/federation/article.d.ts

@@ -0,0 +1,83 @@
+import type { Context } from '@fedify/fedify';
+import { Article, Create, Delete, Update } from '@fedify/vocab';
+import type { Document } from '../content/document.ts';
+import type { FederationContextData } from './federation.ts';
+/** The media type an `Article`'s `source` is labelled with. */
+export declare const SOURCE_MEDIA_TYPE = "text/markdown";
+/**
+ * Whether a document is one of the objects this site federates.
+ *
+ * doc-4 federates published posts and nothing else: pages are standing
+ * content with no place in a timeline, and a draft or a trashed post is not
+ * public at all. This is the one rule, so the object dispatcher, the outbox
+ * and the permalink all agree about what exists.
+ */
+export declare function isFederatedDocument(document: Document): boolean;
+/**
+ * One post as the `Article` doc-4 describes.
+ *
+ * The id comes from the Fedify context rather than from string concatenation,
+ * so it stays in step with the path the object dispatcher is registered under,
+ * and it is built from the slug rather than from the permalink, so moving a
+ * post does not mint a second object. `url` is the permalink, which is the
+ * page a human should land on.
+ *
+ * `source` carries the Markdown the file holds, so a peer that wants to quote
+ * or re-render the post has the text rather than only the rendering of it.
+ */
+export declare function postArticle(context: Context<FederationContextData>, document: Document): Article;
+/**
+ * The `Create` that announces a post: what the outbox lists, and what delivery
+ * sends.
+ *
+ * Its addressing is the article's, because an activity a follower cannot see
+ * is an object it will never learn about. The id is a fragment of the
+ * article's, so the same post always produces the same activity id.
+ */
+export declare function postCreateActivity(context: Context<FederationContextData>, document: Document): Create;
+/**
+ * The `Update` that announces an edit to a post followers already hold.
+ *
+ * The whole article goes with it rather than a diff, because that is all
+ * ActivityPub offers and all a peer can apply. Its id carries the document's
+ * hash, so two edits are two activities and the same edit delivered twice is
+ * one; see {@link updateActivityId}.
+ */
+export declare function postUpdateActivity(context: Context<FederationContextData>, document: Document): Update;
+/**
+ * The `Delete` that withdraws a post: a `Tombstone` where the `Article` was.
+ *
+ * doc-4 sends this when a post becomes a draft, is trashed or is deleted, and
+ * all three look the same from outside — the object is gone and the copy every
+ * follower holds should go with it. The `Tombstone` keeps the object's id and
+ * says what it used to be, which is what lets a peer that never held the
+ * article recognise what it is being told about.
+ *
+ * The document is the one as it was before it went, because after a delete
+ * there is no other.
+ */
+export declare function postDeleteActivity(context: Context<FederationContextData>, document: Document, deleted: string): Delete;
+/**
+ * A post's ActivityStreams object id: the one written into its front matter if
+ * it has been federated, and the one its slug implies if it has not.
+ *
+ * The stored id is what makes a rename invisible to a follower. Ids are minted
+ * from the slug, so a post renamed after it was announced would otherwise
+ * become a second object and be delivered as a `Create` all over again; doc-4
+ * asks the `activitypub.id` key to prevent exactly that. The object dispatcher
+ * resolves a stored id back to its post, so the old URL keeps answering.
+ */
+export declare function articleObjectId(context: Context<FederationContextData>, document: Document): URL;
+/**
+ * An ISO 8601 date as the `Temporal.Instant` the vocabulary takes, or
+ * `undefined` when there is no usable date.
+ *
+ * The value comes from `@js-temporal/polyfill` because Node does not ship
+ * `Temporal` yet, and Fedify recognises a polyfilled instant by its
+ * `Symbol.toStringTag` rather than by its class. The cast is the one place
+ * that costs: the polyfill's declarations and TypeScript's `esnext.temporal`
+ * lib describe the same object with types that are not assignable to one
+ * another.
+ */
+export declare function toInstant(value: string | undefined): Temporal.Instant | undefined;
+//# sourceMappingURL=article.d.ts.map

package/dist/federation/article.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.d.ts","sourceRoot":"","sources":["../../src/federation/article.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EAKN,MAAM,EACP,MAAM,eAAe,CAAC;AAGvB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAI7D,+DAA+D;AAC/D,eAAO,MAAM,iBAAiB,kBAAkB,CAAC;AAEjD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAE/D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAwBhG;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,QAAQ,EAAE,QAAQ,GACjB,MAAM,CAWR;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,QAAQ,EAAE,QAAQ,GACjB,MAAM,CAWR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,MAAM,GACd,MAAM,CAcR;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,GAAG,CAWhG;AAYD;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,OAAO,GAAG,SAAS,CAOjF"}

package/dist/federation/article.js

@@ -0,0 +1,169 @@
+import { Article, Create, Delete, Hashtag, PUBLIC_COLLECTION, Source, Tombstone, Update, } from '@fedify/vocab';
+import { Temporal as TemporalPolyfill } from '@js-temporal/polyfill';
+import { isPublicDocument } from '../web/documents.js';
+import { absoluteUrl } from '../web/negotiate.js';
+import { tagHref } from '../web/routes.js';
+import { SITE_ACTOR_IDENTIFIER } from './keys.js';
+import { createActivityId, deleteActivityId, updateActivityId } from './paths.js';
+/** The media type an `Article`'s `source` is labelled with. */
+export const SOURCE_MEDIA_TYPE = 'text/markdown';
+/**
+ * Whether a document is one of the objects this site federates.
+ *
+ * doc-4 federates published posts and nothing else: pages are standing
+ * content with no place in a timeline, and a draft or a trashed post is not
+ * public at all. This is the one rule, so the object dispatcher, the outbox
+ * and the permalink all agree about what exists.
+ */
+export function isFederatedDocument(document) {
+    return document.type === 'post' && isPublicDocument(document);
+}
+/**
+ * One post as the `Article` doc-4 describes.
+ *
+ * The id comes from the Fedify context rather than from string concatenation,
+ * so it stays in step with the path the object dispatcher is registered under,
+ * and it is built from the slug rather than from the permalink, so moving a
+ * post does not mint a second object. `url` is the permalink, which is the
+ * page a human should land on.
+ *
+ * `source` carries the Markdown the file holds, so a peer that wants to quote
+ * or re-render the post has the text rather than only the rendering of it.
+ */
+export function postArticle(context, document) {
+    const { baseUrl } = context.data.config;
+    return new Article({
+        id: articleObjectId(context, document),
+        url: new URL(absoluteUrl(document.permalink, baseUrl)),
+        name: document.title,
+        content: document.html,
+        source: new Source({ content: document.body, mediaType: SOURCE_MEDIA_TYPE }),
+        published: toInstant(document.date) ?? null,
+        updated: toInstant(document.updated) ?? null,
+        attribution: context.getActorUri(SITE_ACTOR_IDENTIFIER),
+        // Public addressing, as a blog post is: anybody may fetch it, and every
+        // follower is told about it.
+        to: PUBLIC_COLLECTION,
+        cc: context.getFollowersUri(SITE_ACTOR_IDENTIFIER),
+        tags: document.tags.map((tag) => new Hashtag({
+            name: `#${tag}`,
+            href: new URL(absoluteUrl(tagHref(tag, 0), baseUrl)),
+        })),
+    });
+}
+/**
+ * The `Create` that announces a post: what the outbox lists, and what delivery
+ * sends.
+ *
+ * Its addressing is the article's, because an activity a follower cannot see
+ * is an object it will never learn about. The id is a fragment of the
+ * article's, so the same post always produces the same activity id.
+ */
+export function postCreateActivity(context, document) {
+    const article = postArticle(context, document);
+    return new Create({
+        id: createActivityId(articleObjectId(context, document)),
+        actor: context.getActorUri(SITE_ACTOR_IDENTIFIER),
+        object: article,
+        published: toInstant(document.date) ?? null,
+        to: PUBLIC_COLLECTION,
+        cc: context.getFollowersUri(SITE_ACTOR_IDENTIFIER),
+    });
+}
+/**
+ * The `Update` that announces an edit to a post followers already hold.
+ *
+ * The whole article goes with it rather than a diff, because that is all
+ * ActivityPub offers and all a peer can apply. Its id carries the document's
+ * hash, so two edits are two activities and the same edit delivered twice is
+ * one; see {@link updateActivityId}.
+ */
+export function postUpdateActivity(context, document) {
+    const article = postArticle(context, document);
+    return new Update({
+        id: updateActivityId(articleObjectId(context, document), revisionOf(document)),
+        actor: context.getActorUri(SITE_ACTOR_IDENTIFIER),
+        object: article,
+        published: toInstant(document.updated ?? document.date) ?? null,
+        to: PUBLIC_COLLECTION,
+        cc: context.getFollowersUri(SITE_ACTOR_IDENTIFIER),
+    });
+}
+/**
+ * The `Delete` that withdraws a post: a `Tombstone` where the `Article` was.
+ *
+ * doc-4 sends this when a post becomes a draft, is trashed or is deleted, and
+ * all three look the same from outside — the object is gone and the copy every
+ * follower holds should go with it. The `Tombstone` keeps the object's id and
+ * says what it used to be, which is what lets a peer that never held the
+ * article recognise what it is being told about.
+ *
+ * The document is the one as it was before it went, because after a delete
+ * there is no other.
+ */
+export function postDeleteActivity(context, document, deleted) {
+    const objectId = articleObjectId(context, document);
+    return new Delete({
+        id: deleteActivityId(objectId, deleted),
+        actor: context.getActorUri(SITE_ACTOR_IDENTIFIER),
+        object: new Tombstone({
+            id: objectId,
+            formerType: Article,
+            deleted: toInstant(deleted) ?? null,
+        }),
+        to: PUBLIC_COLLECTION,
+        cc: context.getFollowersUri(SITE_ACTOR_IDENTIFIER),
+    });
+}
+/**
+ * A post's ActivityStreams object id: the one written into its front matter if
+ * it has been federated, and the one its slug implies if it has not.
+ *
+ * The stored id is what makes a rename invisible to a follower. Ids are minted
+ * from the slug, so a post renamed after it was announced would otherwise
+ * become a second object and be delivered as a `Create` all over again; doc-4
+ * asks the `activitypub.id` key to prevent exactly that. The object dispatcher
+ * resolves a stored id back to its post, so the old URL keeps answering.
+ */
+export function articleObjectId(context, document) {
+    const stored = document.activitypub?.id;
+    if (stored !== undefined && stored !== '') {
+        try {
+            return new URL(stored);
+        }
+        catch {
+            // A hand-written `activitypub.id` that is not a URL is not an id. Fall
+            // back to the derived one rather than failing the delivery.
+        }
+    }
+    return context.getObjectUri(Article, { slug: document.slug });
+}
+/**
+ * Which revision of a document an `Update` is announcing.
+ *
+ * The content hash: it changes with every real edit and with nothing else, so
+ * it names the revision without a clock and without a counter to keep.
+ */
+function revisionOf(document) {
+    return document.hash.slice(0, 16);
+}
+/**
+ * An ISO 8601 date as the `Temporal.Instant` the vocabulary takes, or
+ * `undefined` when there is no usable date.
+ *
+ * The value comes from `@js-temporal/polyfill` because Node does not ship
+ * `Temporal` yet, and Fedify recognises a polyfilled instant by its
+ * `Symbol.toStringTag` rather than by its class. The cast is the one place
+ * that costs: the polyfill's declarations and TypeScript's `esnext.temporal`
+ * lib describe the same object with types that are not assignable to one
+ * another.
+ */
+export function toInstant(value) {
+    if (value === undefined)
+        return undefined;
+    const date = new Date(value);
+    if (Number.isNaN(date.getTime()))
+        return undefined;
+    return TemporalPolyfill.Instant.fromEpochMilliseconds(date.getTime());
+}
+//# sourceMappingURL=article.js.map

package/dist/federation/article.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.js","sourceRoot":"","sources":["../../src/federation/article.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,MAAM,EACN,MAAM,EACN,OAAO,EACP,iBAAiB,EACjB,MAAM,EACN,SAAS,EACT,MAAM,GACP,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAElF,+DAA+D;AAC/D,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAkB;IACpD,OAAO,QAAQ,CAAC,IAAI,KAAK,MAAM,IAAI,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CAAC,OAAuC,EAAE,QAAkB;IACrF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IAExC,OAAO,IAAI,OAAO,CAAC;QACjB,EAAE,EAAE,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC;QACtC,GAAG,EAAE,IAAI,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,EAAE,QAAQ,CAAC,KAAK;QACpB,OAAO,EAAE,QAAQ,CAAC,IAAI;QACtB,MAAM,EAAE,IAAI,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;QAC5E,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI;QAC3C,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI;QAC5C,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC;QACvD,wEAAwE;QACxE,6BAA6B;QAC7B,EAAE,EAAE,iBAAiB;QACrB,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;QAClD,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CACrB,CAAC,GAAG,EAAE,EAAE,CACN,IAAI,OAAO,CAAC;YACV,IAAI,EAAE,IAAI,GAAG,EAAE;YACf,IAAI,EAAE,IAAI,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;SACrD,CAAC,CACL;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAuC,EACvC,QAAkB;IAElB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE/C,OAAO,IAAI,MAAM,CAAC;QAChB,EAAE,EAAE,gBAAgB,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACxD,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC;QACjD,MAAM,EAAE,OAAO;QACf,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI;QAC3C,EAAE,EAAE,iBAAiB;QACrB,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAuC,EACvC,QAAkB;IAElB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAE/C,OAAO,IAAI,MAAM,CAAC;QAChB,EAAE,EAAE,gBAAgB,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC9E,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC;QACjD,MAAM,EAAE,OAAO;QACf,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI;QAC/D,EAAE,EAAE,iBAAiB;QACrB,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAuC,EACvC,QAAkB,EAClB,OAAe;IAEf,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEpD,OAAO,IAAI,MAAM,CAAC;QAChB,EAAE,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACvC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC;QACjD,MAAM,EAAE,IAAI,SAAS,CAAC;YACpB,EAAE,EAAE,QAAQ;YACZ,UAAU,EAAE,OAAO;YACnB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI;SACpC,CAAC;QACF,EAAE,EAAE,iBAAiB;QACrB,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;KACnD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAAC,OAAuC,EAAE,QAAkB;IACzF,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;QACzB,CAAC;QAAC,MAAM,CAAC;YACP,uEAAuE;YACvE,4DAA4D;QAC9D,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AAChE,CAAC;AAED;;;;;GAKG;AACH,SAAS,UAAU,CAAC,QAAkB;IACpC,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,KAAyB;IACjD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IACnD,OAAO,gBAAgB,CAAC,OAAO,CAAC,qBAAqB,CACnD,IAAI,CAAC,OAAO,EAAE,CACgB,CAAC;AACnC,CAAC"}

package/dist/federation/delivery.d.ts

@@ -0,0 +1,90 @@
+import type { AdminStore, Delivery, Follower } from '../admin/store.ts';
+import type { ResolvedConfig } from '../config.ts';
+import type { ContentStore } from '../content/store.ts';
+import type { DocumentChange } from '../content/sync.ts';
+import type { SiteFederation } from './federation.ts';
+/** What one activity's delivery came to, follower by follower. */
+export interface DeliveryReport {
+    /** The activity that went out. */
+    readonly activityId: string;
+    /** `Create`, `Update` or `Delete`. */
+    readonly activityType: string;
+    /**
+     * The ActivityStreams id of what it was about: a post, or the site's own
+     * actor when the profile itself was what moved.
+     */
+    readonly objectId: string;
+    /** One row per follower, as recorded. Empty when nobody follows the site. */
+    readonly deliveries: readonly Delivery[];
+}
+/** Where a delivery service reports what it could not do. `console` will do. */
+export interface DeliveryLogger {
+    warn(message: string): void;
+}
+/** What {@link createDeliveryService} needs. */
+export interface CreateDeliveryServiceOptions {
+    /** The site's federation object, which mints the ids and signs the requests. */
+    federation: SiteFederation;
+    /** Followers and the delivery log. */
+    admin: AdminStore;
+    /** The content index, which the dispatchers read through the context. */
+    store: ContentStore;
+    /** Config after defaults and environment overrides. */
+    config: ResolvedConfig;
+    /** Where failures are reported. Defaults to `console`. */
+    logger?: DeliveryLogger | undefined;
+}
+/**
+ * Sends a site's posts to its followers, and remembers how that went.
+ *
+ * Deliveries run one after another on a queue of their own rather than at
+ * once, because ActivityPub has no way of saying that a `Create` came before
+ * the `Update` that follows it: a peer that receives them out of order keeps
+ * the wrong version.
+ */
+export interface DeliveryService {
+    /**
+     * Consider one index change, and deliver whatever it implies. Resolves once
+     * the change has been recorded in the file — not once the activity has been
+     * delivered, which is what {@link DeliveryService.settled} is for.
+     */
+    handle(change: DocumentChange): Promise<void>;
+    /**
+     * Tell the followers that the site's own profile has moved: an `Update`
+     * whose object is the actor, which is how a peer learns that the name, the
+     * summary or the avatar it cached is out of date.
+     *
+     * `undefined` when nobody follows the site, in which case nothing is built
+     * and nothing is recorded: there is no cached profile anywhere to refresh.
+     */
+    updateActor(): Promise<DeliveryReport | undefined>;
+    /**
+     * Send a recorded activity again, to every follower the site has now.
+     *
+     * decision-5 accepts that an activity queued when the process exits is lost
+     * and promises this as the way back. `undefined` means no such activity was
+     * ever sent.
+     */
+    redeliver(activityId: string): Promise<DeliveryReport | undefined>;
+    /** Resolve once every queued delivery has finished, however it finished. */
+    settled(): Promise<void>;
+}
+/**
+ * Build the delivery service for one site.
+ *
+ * doc-4's delivery table is the whole of the policy: a post that becomes
+ * published is a `Create`, an edit to a published post is an `Update`, and a
+ * post that stops being published — draft, trashed or deleted, which are one
+ * thing from outside — is a `Delete` of a `Tombstone`.
+ *
+ * Nothing is delivered for a full scan. The boot scan reports a cold index as
+ * a directory full of creations, so federating them would announce the whole
+ * archive to every follower every time somebody deleted the database.
+ */
+export declare function createDeliveryService(options: CreateDeliveryServiceOptions): DeliveryService;
+/**
+ * Followers keyed by the inbox one POST to which reaches them: the instance's
+ * shared inbox where it published one, and the follower's own where it did not.
+ */
+export declare function groupByInbox(followers: readonly Follower[]): Map<string, Follower[]>;
+//# sourceMappingURL=delivery.d.ts.map

package/dist/federation/delivery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delivery.d.ts","sourceRoot":"","sources":["../../src/federation/delivery.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAkB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAUzD,OAAO,KAAK,EAAyB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAK7E,kEAAkE;AAClE,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,UAAU,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC1C;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,gDAAgD;AAChD,MAAM,WAAW,4BAA4B;IAC3C,gFAAgF;IAChF,UAAU,EAAE,cAAc,CAAC;IAC3B,sCAAsC;IACtC,KAAK,EAAE,UAAU,CAAC;IAClB,yEAAyE;IACzE,KAAK,EAAE,YAAY,CAAC;IACpB,uDAAuD;IACvD,MAAM,EAAE,cAAc,CAAC;IACvB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IACnD;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IACnE,4EAA4E;IAC5E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,eAAe,CAkR5F;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAWpF"}