@geekity/cms 0.3.0

package/dist/federation/delivery.js

@@ -0,0 +1,289 @@
+import { Activity, getTypeId, PUBLIC_COLLECTION, Update } from '@fedify/vocab';
+import { readSiteSettings } from '../admin/settings.js';
+import { saveDocument } from '../content/save.js';
+import { documentContent } from '../content/writer.js';
+import { siteActor } from './actor.js';
+import { articleObjectId, isFederatedDocument, postCreateActivity, postDeleteActivity, postUpdateActivity, } from './article.js';
+import { followerRecipient } from './followers.js';
+import { SITE_ACTOR_IDENTIFIER } from './keys.js';
+import { postObjectId, updateActivityId } from './paths.js';
+/**
+ * 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 function createDeliveryService(options) {
+    const { federation, admin, store, config } = options;
+    const logger = options.logger ?? console;
+    /**
+     * Whether a delivery is over by the time `sendActivity` resolves.
+     *
+     * With no queue it is: Fedify posts to each inbox and waits. With one, all
+     * that is known is that the activity was accepted for delivery, and the
+     * queue retries out of band without reporting back — which is the difference
+     * between a `sent` row and a `queued` one.
+     */
+    const synchronous = config.federation.queue === null;
+    // Deliveries are chained rather than run in parallel, and the chain never
+    // rejects: a failure is recorded against the followers it happened to and
+    // the next activity still goes out.
+    let chain = Promise.resolve();
+    function enqueue(task) {
+        const result = chain.then(task);
+        chain = result.then(ignore, ignore);
+        return result;
+    }
+    /** A context outside any request, which is where a delivery happens from. */
+    function deliveryContext() {
+        return federation.createContext(new URL(config.baseUrl), { admin, store, config });
+    }
+    /**
+     * Write `activitypub.id` and `activitypub.published` into the post's file,
+     * and answer with the document as it now reads.
+     *
+     * This happens before the first activity goes out, so the id the follower is
+     * handed is the id the file will keep however often the post is renamed
+     * afterwards (doc-4). It is written through the same
+     * {@link saveDocument} the admin writes through, which corrects the index in
+     * the same breath — so the watcher's re-read of the file finds a hash that
+     * already matches and this write federates nothing of its own.
+     */
+    async function stamp(document) {
+        const existing = document.activitypub;
+        const id = existing?.id ?? postObjectId(document.slug, config.baseUrl);
+        const published = existing?.published ?? document.date ?? new Date().toISOString();
+        if (existing?.id === id && existing.published === published)
+            return document;
+        return await saveDocument({
+            contentDir: config.contentDir,
+            store,
+            path: document.path,
+            content: { ...documentContent(document), activitypub: { id, published } },
+        });
+    }
+    /**
+     * Record an activity and fan it out to the followers.
+     *
+     * The activity is stored before it is sent, not after, so an activity whose
+     * delivery is interrupted is still one an admin can re-send.
+     */
+    async function send(context, activity, about) {
+        const activityId = activity.id?.href;
+        if (activityId === undefined) {
+            throw new TypeError('An activity cannot be delivered without an id.');
+        }
+        const objectId = articleObjectId(context, about).href;
+        const activityType = typeNameOf(activity);
+        const json = await activity.toJsonLd({
+            format: 'compact',
+            contextLoader: context.contextLoader,
+        });
+        admin.putOutboundActivity({
+            activityId,
+            activityType,
+            objectId,
+            slug: about.slug,
+            json: JSON.stringify(json),
+        });
+        return await fanOut(context, activity, { activityId, activityType, objectId });
+    }
+    /**
+     * Deliver one activity to every follower, one inbox at a time.
+     *
+     * Fedify's own `sendActivity(…, 'followers', …)` would reach the same
+     * inboxes in one call, but it answers `void`: there would be no way of
+     * saying which follower did not get it, which is the thing decision-5
+     * promised to record. So the followers are grouped by the inbox they share —
+     * one POST still serves a whole instance — and each group's outcome is
+     * written against every follower behind it.
+     */
+    async function fanOut(context, activity, about) {
+        const deliveries = [];
+        for (const [inboxId, members] of groupByInbox(admin.listFollowers())) {
+            let status = synchronous ? 'sent' : 'queued';
+            let error = null;
+            try {
+                await context.sendActivity({ identifier: SITE_ACTOR_IDENTIFIER }, members.map(followerRecipient), activity, 
+                // The object id keeps a post's activities in order per server, so a
+                // follower cannot be shown an Update of something it has not been
+                // told about yet.
+                { preferSharedInbox: true, orderingKey: about.objectId });
+            }
+            catch (thrown) {
+                status = 'failed';
+                error = messageOf(thrown);
+                logger.warn(`Could not deliver ${about.activityId} to ${inboxId}: ${error}`);
+            }
+            for (const member of members) {
+                deliveries.push(admin.recordDelivery({
+                    activityId: about.activityId,
+                    actorId: member.actorId,
+                    inboxId,
+                    status,
+                    error,
+                }));
+            }
+        }
+        return { ...about, deliveries };
+    }
+    return {
+        async handle(change) {
+            // A full scan is a rebuild of the index, not news about the site.
+            if (change.origin === 'scan')
+                return;
+            const before = federatedOrUndefined(change.previous);
+            const after = federatedOrUndefined(change.next);
+            if (before === undefined && after === undefined)
+                return;
+            const context = deliveryContext();
+            if (after === undefined) {
+                // Unpublished, trashed or deleted; `before` is the post as it last
+                // stood, and the only version there is to build a Tombstone from.
+                if (before === undefined)
+                    return;
+                const deleted = new Date().toISOString();
+                queue(() => send(context, postDeleteActivity(context, before, deleted), before));
+                return;
+            }
+            {
+                const stamped = await stamp(after);
+                if (before === undefined) {
+                    queue(() => send(context, postCreateActivity(context, stamped), stamped));
+                    return;
+                }
+                // Almost always the same id, because the stamped one follows the post
+                // through a rename. When it is not — a post federated before this
+                // version, renamed since — the old object is withdrawn rather than
+                // left standing under an id nothing answers to any more.
+                const previousId = articleObjectId(context, before).href;
+                if (previousId === articleObjectId(context, stamped).href) {
+                    queue(() => send(context, postUpdateActivity(context, stamped), stamped));
+                    return;
+                }
+                const deleted = new Date().toISOString();
+                queue(() => send(context, postDeleteActivity(context, before, deleted), before));
+                queue(() => send(context, postCreateActivity(context, stamped), stamped));
+            }
+        },
+        async updateActor() {
+            // Building the actor loads — and on a cold database generates — the key
+            // pairs, so a site nobody follows does not pay for an activity that has
+            // nowhere to go.
+            if (admin.countFollowers() === 0)
+                return undefined;
+            return await enqueue(async () => {
+                const context = deliveryContext();
+                const actorId = context.getActorUri(SITE_ACTOR_IDENTIFIER);
+                const actor = await siteActor(context, SITE_ACTOR_IDENTIFIER, {
+                    settings: readSiteSettings(admin),
+                    baseUrl: config.baseUrl,
+                });
+                // The revision is the moment rather than a hash of the profile: an
+                // avatar removed and put back is the same profile twice, and both
+                // times the followers have to be told rather than recognise an id
+                // they have already seen and skip it.
+                const activityId = updateActivityId(actorId, new Date().toISOString());
+                const activity = new Update({
+                    id: activityId,
+                    actor: actorId,
+                    object: actor,
+                    to: PUBLIC_COLLECTION,
+                    cc: context.getFollowersUri(SITE_ACTOR_IDENTIFIER),
+                });
+                const about = {
+                    activityId: activityId.href,
+                    activityType: 'Update',
+                    // The object is the actor, not a post, and there is no slug to
+                    // record: that is what keeps an actor Update out of the federation
+                    // screen's per-post delivery table.
+                    objectId: actorId.href,
+                };
+                admin.putOutboundActivity({
+                    ...about,
+                    slug: null,
+                    json: JSON.stringify(await activity.toJsonLd({ format: 'compact', contextLoader: context.contextLoader })),
+                });
+                return await fanOut(context, activity, about);
+            }).catch((thrown) => {
+                // A profile update is a side effect of saving the settings, and losing
+                // it must not lose the save.
+                logger.warn(`The actor update could not be delivered: ${messageOf(thrown)}`);
+                return undefined;
+            });
+        },
+        async redeliver(activityId) {
+            const stored = admin.getOutboundActivity(activityId);
+            if (stored === undefined)
+                return undefined;
+            return await enqueue(async () => {
+                const context = deliveryContext();
+                const activity = await Activity.fromJsonLd(JSON.parse(stored.json), {
+                    contextLoader: context.contextLoader,
+                    documentLoader: context.documentLoader,
+                });
+                return await fanOut(context, activity, {
+                    activityId: stored.activityId,
+                    activityType: stored.activityType,
+                    objectId: stored.objectId,
+                });
+            });
+        },
+        settled() {
+            return chain.then(ignore);
+        },
+    };
+    /**
+     * Put one delivery on the queue and stop caring about its result.
+     *
+     * Nothing is waiting for a delivery that a change set off, so a rejection
+     * here has nowhere to go but the log; the per-follower failures are already
+     * in the database by the time one gets this far.
+     */
+    function queue(task) {
+        enqueue(task).catch((thrown) => {
+            logger.warn(`A delivery failed: ${messageOf(thrown)}`);
+        });
+    }
+}
+/**
+ * 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 function groupByInbox(followers) {
+    const groups = new Map();
+    for (const follower of followers) {
+        const inbox = follower.sharedInboxId ?? follower.inboxId;
+        const group = groups.get(inbox);
+        if (group === undefined)
+            groups.set(inbox, [follower]);
+        else
+            group.push(follower);
+    }
+    return groups;
+}
+/** The document, when it is one this site federates, and `undefined` otherwise. */
+function federatedOrUndefined(document) {
+    if (document === undefined)
+        return undefined;
+    return isFederatedDocument(document) ? document : undefined;
+}
+/** An activity's short type name — `Create`, `Update`, `Delete` — from its type URI. */
+function typeNameOf(activity) {
+    const typeId = getTypeId(activity);
+    return typeId.hash === '' ? typeId.href : typeId.hash.slice(1);
+}
+function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+function ignore() {
+    // Deliberately empty: the chain must not reject, and a failure has already
+    // been recorded against the followers it happened to.
+}
+//# sourceMappingURL=delivery.js.map

package/dist/federation/delivery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delivery.js","sourceRoot":"","sources":["../../src/federation/delivery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAIxD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAwE5D;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAqC;IACzE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACrD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;IAEzC;;;;;;;OAOG;IACH,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC;IAErD,0EAA0E;IAC1E,0EAA0E;IAC1E,oCAAoC;IACpC,IAAI,KAAK,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEhD,SAAS,OAAO,CAAI,IAAsB;QACxC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,6EAA6E;IAC7E,SAAS,eAAe;QACtB,OAAO,UAAU,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,UAAU,KAAK,CAAC,QAAkB;QACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC;QACtC,MAAM,EAAE,GAAG,QAAQ,EAAE,EAAE,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,SAAS,GAAG,QAAQ,EAAE,SAAS,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACnF,IAAI,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC;QAE7E,OAAO,MAAM,YAAY,CAAC;YACxB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,KAAK;YACL,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE;SAC1E,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,UAAU,IAAI,CACjB,OAAuC,EACvC,QAAkB,EAClB,KAAe;QAEf,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;QACrC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC;YACnC,MAAM,EAAE,SAAS;YACjB,aAAa,EAAE,OAAO,CAAC,aAAa;SACrC,CAAC,CAAC;QAEH,KAAK,CAAC,mBAAmB,CAAC;YACxB,UAAU;YACV,YAAY;YACZ,QAAQ;YACR,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QAEH,OAAO,MAAM,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,UAAU,MAAM,CACnB,OAAuC,EACvC,QAAkB,EAClB,KAAqE;QAErE,MAAM,UAAU,GAAe,EAAE,CAAC;QAElC,KAAK,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC,EAAE,CAAC;YACrE,IAAI,MAAM,GAAmB,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;YAC7D,IAAI,KAAK,GAAkB,IAAI,CAAC;YAEhC,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,YAAY,CACxB,EAAE,UAAU,EAAE,qBAAqB,EAAE,EACrC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAC9B,QAAQ;gBACR,oEAAoE;gBACpE,kEAAkE;gBAClE,kBAAkB;gBAClB,EAAE,iBAAiB,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,QAAQ,EAAE,CACzD,CAAC;YACJ,CAAC;YAAC,OAAO,MAAM,EAAE,CAAC;gBAChB,MAAM,GAAG,QAAQ,CAAC;gBAClB,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAC,UAAU,OAAO,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC;YAC/E,CAAC;YAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,UAAU,CAAC,IAAI,CACb,KAAK,CAAC,cAAc,CAAC;oBACnB,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,OAAO;oBACP,MAAM;oBACN,KAAK;iBACN,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,OAAO;QACL,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,kEAAkE;YAClE,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO;YAErC,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACrD,MAAM,KAAK,GAAG,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO;YAExD,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;YAElC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,mEAAmE;gBACnE,kEAAkE;gBAClE,IAAI,MAAM,KAAK,SAAS;oBAAE,OAAO;gBACjC,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACzC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBACjF,OAAO;YACT,CAAC;YAED,CAAC;gBACC,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;gBAEnC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;oBAC1E,OAAO;gBACT,CAAC;gBAED,sEAAsE;gBACtE,kEAAkE;gBAClE,mEAAmE;gBACnE,yDAAyD;gBACzD,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC;gBACzD,IAAI,UAAU,KAAK,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;oBAC1D,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;oBAC1E,OAAO;gBACT,CAAC;gBAED,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACzC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBACjF,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;QAED,KAAK,CAAC,WAAW;YACf,wEAAwE;YACxE,wEAAwE;YACxE,iBAAiB;YACjB,IAAI,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC;gBAAE,OAAO,SAAS,CAAC;YAEnD,OAAO,MAAM,OAAO,CAAC,KAAK,IAAI,EAAE;gBAC9B,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;gBAClC,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;gBAC3D,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,qBAAqB,EAAE;oBAC5D,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC;oBACjC,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB,CAAC,CAAC;gBAEH,mEAAmE;gBACnE,kEAAkE;gBAClE,kEAAkE;gBAClE,sCAAsC;gBACtC,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;gBACvE,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC;oBAC1B,EAAE,EAAE,UAAU;oBACd,KAAK,EAAE,OAAO;oBACd,MAAM,EAAE,KAAK;oBACb,EAAE,EAAE,iBAAiB;oBACrB,EAAE,EAAE,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC;iBACnD,CAAC,CAAC;gBAEH,MAAM,KAAK,GAAG;oBACZ,UAAU,EAAE,UAAU,CAAC,IAAI;oBAC3B,YAAY,EAAE,QAAQ;oBACtB,+DAA+D;oBAC/D,mEAAmE;oBACnE,oCAAoC;oBACpC,QAAQ,EAAE,OAAO,CAAC,IAAI;iBACvB,CAAC;gBAEF,KAAK,CAAC,mBAAmB,CAAC;oBACxB,GAAG,KAAK;oBACR,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB,MAAM,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,CACrF;iBACF,CAAC,CAAC;gBAEH,OAAO,MAAM,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAe,EAAE,EAAE;gBAC3B,uEAAuE;gBACvE,6BAA6B;gBAC7B,MAAM,CAAC,IAAI,CAAC,4CAA4C,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAK,CAAC,SAAS,CAAC,UAAU;YACxB,MAAM,MAAM,GAAG,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;YACrD,IAAI,MAAM,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YAE3C,OAAO,MAAM,OAAO,CAAC,KAAK,IAAI,EAAE;gBAC9B,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;gBAClC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBAClE,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,cAAc,EAAE,OAAO,CAAC,cAAc;iBACvC,CAAC,CAAC;gBACH,OAAO,MAAM,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE;oBACrC,UAAU,EAAE,MAAM,CAAC,UAAU;oBAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;oBACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;iBAC1B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;KACF,CAAC;IAEF;;;;;;OAMG;IACH,SAAS,KAAK,CAAC,IAA4B;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,MAAe,EAAE,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,sBAAsB,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,SAA8B;IACzD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAsB,CAAC;IAE7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,OAAO,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;;YAClD,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,mFAAmF;AACnF,SAAS,oBAAoB,CAAC,QAA8B;IAC1D,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC7C,OAAO,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9D,CAAC;AAED,wFAAwF;AACxF,SAAS,UAAU,CAAC,QAAkB;IACpC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,MAAM;IACb,2EAA2E;IAC3E,sDAAsD;AACxD,CAAC"}

package/dist/federation/federation.d.ts

@@ -0,0 +1,75 @@
+import type { Federation, FederationOptions } from '@fedify/fedify';
+import type { AdminStore } from '../admin/store.ts';
+import type { FederationOverrides, ResolvedConfig } from '../config.ts';
+import type { Document } from '../content/document.ts';
+import type { ContentStore } from '../content/store.ts';
+/** The `software.name` this CMS reports in NodeInfo. Lower case, as the schema demands. */
+export declare const SOFTWARE_NAME = "geekity-cms";
+/**
+ * How many activities one page of the outbox holds.
+ *
+ * A constant rather than the site's `postsPerPage`, because an outbox cursor
+ * is a URL a peer may come back to: changing the setting would silently move
+ * every page boundary underneath whoever is walking the collection.
+ */
+export declare const OUTBOX_PAGE_SIZE = 20;
+/** What every Fedify dispatcher in the CMS is handed. */
+export interface FederationContextData {
+    /** Settings and, through them, the actor's profile and its keys. */
+    readonly admin: AdminStore;
+    /** The content index, which the outbox and the post objects are built from. */
+    readonly store: ContentStore;
+    /** Config after defaults and environment overrides. */
+    readonly config: ResolvedConfig;
+}
+/** A CMS federation object, with the context data its dispatchers expect. */
+export type SiteFederation = Federation<FederationContextData>;
+/**
+ * What {@link createSiteFederation} takes: the site's base URL, and the
+ * {@link FederationOverrides} a site may swap the defaults for.
+ */
+export interface CreateSiteFederationOptions extends FederationOverrides {
+    /**
+     * The site's base URL. Fedify otherwise mints ids from `request.url`, which
+     * behind a proxy is the internal address rather than the one peers
+     * dereference, so this is the one option with no sensible default.
+     *
+     * Only its origin is used; see {@link federationOrigin}.
+     */
+    baseUrl: string;
+    /** Anything else Fedify takes, for a site that needs to reach past this factory. */
+    federationOptions?: Partial<FederationOptions<FederationContextData>> | undefined;
+}
+/**
+ * Build the site's `Federation` object: the actor, its keys, the post objects,
+ * the outbox, WebFinger and NodeInfo.
+ *
+ * It is a factory rather than a module-level singleton so the KV store and the
+ * queue are arguments (decision-5), so a test can build one per data directory,
+ * and so a site that outgrows the in-memory pair changes a call rather than
+ * this file. The followers come out of SQLite; the following collection is
+ * empty, and doc-4 says it always will be.
+ */
+export declare function createSiteFederation(options: CreateSiteFederationOptions): SiteFederation;
+/**
+ * The published post a slug names, or `undefined`.
+ *
+ * Slugs are not unique across years, and the index answers with the newest
+ * match. That is the same rule the admin's own slug lookup follows, so a
+ * collision resolves the same way wherever it is asked about.
+ */
+export declare function federatedPost(store: ContentStore, slug: string): Document | undefined;
+/**
+ * The post whose ActivityStreams object is served at `/ap/posts/{slug}`.
+ *
+ * Nearly always the post with that slug. The exception is a post renamed after
+ * it was announced: it keeps the id its old slug minted, written into
+ * `activitypub.id` (doc-4), so the old URL has to keep answering or every
+ * follower's copy points at a 404. That case is found by searching the
+ * archive for the post holding the id, which is a walk rather than an index
+ * lookup — the front matter is the source of truth (decision-1) and the index
+ * has no column for it — but it is only reached when the slug itself does not
+ * answer.
+ */
+export declare function federatedObject(store: ContentStore, slug: string, baseUrl: string): Document | undefined;
+//# sourceMappingURL=federation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"federation.d.ts","sourceRoot":"","sources":["../../src/federation/federation.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAA6B,MAAM,gBAAgB,CAAC;AAI/F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAmBxD,2FAA2F;AAC3F,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC,yDAAyD;AACzD,MAAM,WAAW,qBAAqB;IACpC,oEAAoE;IACpE,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACjC;AAED,6EAA6E;AAC7E,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,oFAAoF;IACpF,iBAAiB,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC,GAAG,SAAS,CAAC;CACnF;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,cAAc,CAoHzF;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAGrF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,YAAY,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,QAAQ,GAAG,SAAS,CAUtB"}

package/dist/federation/federation.js

@@ -0,0 +1,190 @@
+import { createRequire } from 'node:module';
+import { createFederation, InProcessMessageQueue, MemoryKvStore } from '@fedify/fedify';
+import { Announce, Article, Create, Delete, Follow, Like, Undo } from '@fedify/vocab';
+import { readSiteSettings } from '../admin/settings.js';
+import { siteActor } from './actor.js';
+import { isFederatedDocument, postArticle, postCreateActivity } from './article.js';
+import { followersPage, lastFollowersCursor } from './followers.js';
+import { handleDelete, handleFollow, handleLoggedActivity, handleUndo } from './inbox.js';
+import { loadActorKeyPairs, SITE_ACTOR_IDENTIFIER } from './keys.js';
+import { ACTOR_PATH, federationOrigin, FOLLOWERS_PATH, FOLLOWING_PATH, INBOX_PATH, NODEINFO_PATH, OUTBOX_PATH, POST_OBJECT_PATH, postObjectId, SHARED_INBOX_PATH, } from './paths.js';
+/** The `software.name` this CMS reports in NodeInfo. Lower case, as the schema demands. */
+export const SOFTWARE_NAME = 'geekity-cms';
+/**
+ * How many activities one page of the outbox holds.
+ *
+ * A constant rather than the site's `postsPerPage`, because an outbox cursor
+ * is a URL a peer may come back to: changing the setting would silently move
+ * every page boundary underneath whoever is walking the collection.
+ */
+export const OUTBOX_PAGE_SIZE = 20;
+/**
+ * Build the site's `Federation` object: the actor, its keys, the post objects,
+ * the outbox, WebFinger and NodeInfo.
+ *
+ * It is a factory rather than a module-level singleton so the KV store and the
+ * queue are arguments (decision-5), so a test can build one per data directory,
+ * and so a site that outgrows the in-memory pair changes a call rather than
+ * this file. The followers come out of SQLite; the following collection is
+ * empty, and doc-4 says it always will be.
+ */
+export function createSiteFederation(options) {
+    const federation = createFederation({
+        kv: options.kv ?? new MemoryKvStore(),
+        origin: federationOrigin(options.baseUrl),
+        // `null` is not the same as absent: it asks for no queue at all, so an
+        // activity is handled and delivered inside the request that carried it.
+        // Leaving the key off entirely is how Fedify is told that, which is why
+        // this is a spread rather than a value.
+        ...(options.queue === null ? {} : { queue: options.queue ?? new InProcessMessageQueue() }),
+        ...(options.allowPrivateAddress === undefined
+            ? {}
+            : { allowPrivateAddress: options.allowPrivateAddress }),
+        ...options.federationOptions,
+    });
+    federation
+        .setActorDispatcher(ACTOR_PATH, async (context, identifier) => {
+        if (identifier !== SITE_ACTOR_IDENTIFIER)
+            return null;
+        const settings = readSiteSettings(context.data.admin);
+        return await siteActor(context, identifier, {
+            settings,
+            baseUrl: context.data.config.baseUrl,
+        });
+    })
+        // WebFinger asks for a username; this is what turns the handle somebody
+        // typed into the identifier the URLs are built from, and what makes the
+        // handle a setting rather than part of the actor's id.
+        .mapHandle((context, username) => username === readSiteSettings(context.data.admin).actorHandle ? SITE_ACTOR_IDENTIFIER : null)
+        .setKeyPairsDispatcher(async (context, identifier) => identifier === SITE_ACTOR_IDENTIFIER
+        ? await loadActorKeyPairs(context.data.admin, identifier)
+        : []);
+    // A post's ActivityStreams object. `null` is a 404, which is what a draft, a
+    // trashed post, a page and a slug that names nothing all get: the object
+    // dispatcher is the only thing that decides whether an object exists, so it
+    // cannot disagree with the outbox about it.
+    federation.setObjectDispatcher(Article, POST_OBJECT_PATH, (context, values) => {
+        const document = federatedObject(context.data.store, values.slug, context.data.config.baseUrl);
+        return document === undefined ? null : postArticle(context, document);
+    });
+    federation
+        .setOutboxDispatcher(OUTBOX_PATH, (context, identifier, cursor) => identifier === SITE_ACTOR_IDENTIFIER ? outboxPage(context, cursor) : null)
+        .setCounter((context, identifier) => identifier === SITE_ACTOR_IDENTIFIER ? context.data.store.counts().posts : null)
+        // Paging is cursor-based, and the cursor is an offset, so the first page
+        // is always the start of the archive and the last is wherever the archive
+        // currently ends.
+        .setFirstCursor((_context, identifier) => (identifier === SITE_ACTOR_IDENTIFIER ? '0' : null))
+        .setLastCursor((context, identifier) => {
+        if (identifier !== SITE_ACTOR_IDENTIFIER)
+            return null;
+        const total = context.data.store.counts().posts;
+        return String(total === 0 ? 0 : Math.floor((total - 1) / OUTBOX_PAGE_SIZE) * OUTBOX_PAGE_SIZE);
+    });
+    // The followers, straight out of SQLite and paged like the outbox. Fedify
+    // renders each one as its actor id, and hands the same rows — inbox and
+    // shared inbox included — to `ctx.sendActivity(…, 'followers', …)`, so this
+    // one dispatcher is both what a peer reads and where delivery fans out to.
+    federation
+        .setFollowersDispatcher(FOLLOWERS_PATH, (context, identifier, cursor) => identifier === SITE_ACTOR_IDENTIFIER ? followersPage(context, cursor) : null)
+        .setCounter((context, identifier) => identifier === SITE_ACTOR_IDENTIFIER ? context.data.admin.countFollowers() : null)
+        .setFirstCursor((_context, identifier) => (identifier === SITE_ACTOR_IDENTIFIER ? '0' : null))
+        .setLastCursor((context, identifier) => identifier === SITE_ACTOR_IDENTIFIER
+        ? lastFollowersCursor(context.data.admin.countFollowers())
+        : null);
+    // Always empty, and always will be: doc-4 says the site follows nobody.
+    federation.setFollowingDispatcher(FOLLOWING_PATH, (_context, identifier) => identifier === SITE_ACTOR_IDENTIFIER ? { items: [] } : null);
+    // The inbox, personal and shared. Fedify has already verified the signature
+    // by the time a listener runs — an unsigned or badly signed delivery never
+    // reaches one — so a handler may trust that the activity's actor really sent
+    // it. An activity of a type not listed here is answered 202 and dropped,
+    // which is what doc-4 asks for everything past these five.
+    federation
+        .setInboxListeners(INBOX_PATH, SHARED_INBOX_PATH)
+        .on(Follow, handleFollow)
+        .on(Undo, handleUndo)
+        .on(Delete, handleDelete)
+        .on(Like, handleLoggedActivity)
+        .on(Announce, handleLoggedActivity)
+        .on(Create, handleLoggedActivity);
+    federation.setNodeInfoDispatcher(NODEINFO_PATH, (context) => {
+        const counts = context.data.store.counts();
+        return {
+            software: { name: SOFTWARE_NAME, version: packageVersion() },
+            protocols: ['activitypub'],
+            // A CMS is not a signup service; the admin makes accounts by hand.
+            openRegistrations: false,
+            usage: {
+                users: { total: context.data.admin.countUsers() },
+                localPosts: counts.posts,
+                localComments: 0,
+            },
+        };
+    });
+    return federation;
+}
+/**
+ * The published post a slug names, or `undefined`.
+ *
+ * Slugs are not unique across years, and the index answers with the newest
+ * match. That is the same rule the admin's own slug lookup follows, so a
+ * collision resolves the same way wherever it is asked about.
+ */
+export function federatedPost(store, slug) {
+    const document = store.getBySlug(slug);
+    return document !== undefined && isFederatedDocument(document) ? document : undefined;
+}
+/**
+ * The post whose ActivityStreams object is served at `/ap/posts/{slug}`.
+ *
+ * Nearly always the post with that slug. The exception is a post renamed after
+ * it was announced: it keeps the id its old slug minted, written into
+ * `activitypub.id` (doc-4), so the old URL has to keep answering or every
+ * follower's copy points at a 404. That case is found by searching the
+ * archive for the post holding the id, which is a walk rather than an index
+ * lookup — the front matter is the source of truth (decision-1) and the index
+ * has no column for it — but it is only reached when the slug itself does not
+ * answer.
+ */
+export function federatedObject(store, slug, baseUrl) {
+    const objectId = postObjectId(slug, baseUrl);
+    const direct = federatedPost(store, slug);
+    if (direct !== undefined) {
+        const stored = direct.activitypub?.id;
+        if (stored === undefined || stored === objectId)
+            return direct;
+    }
+    return store.listPosts().find((post) => post.activitypub?.id === objectId);
+}
+/**
+ * One page of the outbox: the `Create` that announced each post, newest first.
+ *
+ * The cursor is the offset into the archive as a decimal string. That keeps a
+ * page URL meaning what it meant when it was minted, which a cursor derived
+ * from the site's page size would not: the size is a setting somebody may
+ * change between two requests.
+ */
+function outboxPage(context, cursor) {
+    const offset = cursorOffset(cursor);
+    const { store } = context.data;
+    const documents = store.listPosts({ limit: OUTBOX_PAGE_SIZE, offset });
+    const total = store.counts().posts;
+    const next = offset + OUTBOX_PAGE_SIZE;
+    return {
+        items: documents.map((document) => postCreateActivity(context, document)),
+        nextCursor: next < total ? String(next) : null,
+        prevCursor: offset <= 0 ? null : String(Math.max(0, offset - OUTBOX_PAGE_SIZE)),
+    };
+}
+/** A cursor as an offset. Anything unreadable starts at the beginning. */
+function cursorOffset(cursor) {
+    if (cursor === null || !/^[0-9]+$/.test(cursor))
+        return 0;
+    return Number(cursor);
+}
+/** The published version of `@geekity/cms`, which NodeInfo reports. */
+function packageVersion() {
+    const require = createRequire(import.meta.url);
+    const manifest = require('../../package.json');
+    return manifest.version ?? '0.0.0';
+}
+//# sourceMappingURL=federation.js.map

package/dist/federation/federation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"federation.js","sourceRoot":"","sources":["../../src/federation/federation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAExF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAEtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAKxD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC1F,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,UAAU,EACV,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,GAClB,MAAM,YAAY,CAAC;AAEpB,2FAA2F;AAC3F,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAgCnC;;;;;;;;;GASG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAoC;IACvE,MAAM,UAAU,GAAG,gBAAgB,CAAwB;QACzD,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,IAAI,aAAa,EAAE;QACrC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;QACzC,uEAAuE;QACvE,wEAAwE;QACxE,wEAAwE;QACxE,wCAAwC;QACxC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,qBAAqB,EAAE,EAAE,CAAC;QAC1F,GAAG,CAAC,OAAO,CAAC,mBAAmB,KAAK,SAAS;YAC3C,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,EAAE,CAAC;QACzD,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAC;IAEH,UAAU;SACP,kBAAkB,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE;QAC5D,IAAI,UAAU,KAAK,qBAAqB;YAAE,OAAO,IAAI,CAAC;QACtD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,OAAO,MAAM,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE;YAC1C,QAAQ;YACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;SACrC,CAAC,CAAC;IACL,CAAC,CAAC;QACF,wEAAwE;QACxE,wEAAwE;QACxE,uDAAuD;SACtD,SAAS,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAC/B,QAAQ,KAAK,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAC7F;SACA,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CACnD,UAAU,KAAK,qBAAqB;QAClC,CAAC,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC;QACzD,CAAC,CAAC,EAAE,CACP,CAAC;IAEJ,6EAA6E;IAC7E,yEAAyE;IACzE,4EAA4E;IAC5E,4CAA4C;IAC5C,UAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC5E,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/F,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,UAAU;SACP,mBAAmB,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,CAChE,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAC1E;SACA,UAAU,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,CAClC,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAChF;QACD,yEAAyE;QACzE,0EAA0E;QAC1E,kBAAkB;SACjB,cAAc,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC7F,aAAa,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE;QACrC,IAAI,UAAU,KAAK,qBAAqB;YAAE,OAAO,IAAI,CAAC;QACtD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;QAChD,OAAO,MAAM,CACX,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAChF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,0EAA0E;IAC1E,wEAAwE;IACxE,4EAA4E;IAC5E,2EAA2E;IAC3E,UAAU;SACP,sBAAsB,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,CACtE,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAC7E;SACA,UAAU,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,CAClC,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAClF;SACA,cAAc,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC7F,aAAa,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,CACrC,UAAU,KAAK,qBAAqB;QAClC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QAC1D,CAAC,CAAC,IAAI,CACT,CAAC;IACJ,wEAAwE;IACxE,UAAU,CAAC,sBAAsB,CAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CACzE,UAAU,KAAK,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAC5D,CAAC;IAEF,4EAA4E;IAC5E,2EAA2E;IAC3E,6EAA6E;IAC7E,yEAAyE;IACzE,2DAA2D;IAC3D,UAAU;SACP,iBAAiB,CAAC,UAAU,EAAE,iBAAiB,CAAC;SAChD,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;SACxB,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC;SACpB,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;SACxB,EAAE,CAAC,IAAI,EAAE,oBAAoB,CAAC;SAC9B,EAAE,CAAC,QAAQ,EAAE,oBAAoB,CAAC;SAClC,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAEpC,UAAU,CAAC,qBAAqB,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,EAAE;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAC3C,OAAO;YACL,QAAQ,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE;YAC5D,SAAS,EAAE,CAAC,aAAa,CAAC;YAC1B,mEAAmE;YACnE,iBAAiB,EAAE,KAAK;YACxB,KAAK,EAAE;gBACL,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE;gBACjD,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,aAAa,EAAE,CAAC;aACjB;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,KAAmB,EAAE,IAAY;IAC7D,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,QAAQ,KAAK,SAAS,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AACxF,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAmB,EACnB,IAAY,EACZ,OAAe;IAEf,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAE1C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;QACtC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC;IACjE,CAAC;IAED,OAAO,KAAK,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CACjB,OAA8C,EAC9C,MAAqB;IAErB,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;IACnC,MAAM,IAAI,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAEvC,OAAO;QACL,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzE,UAAU,EAAE,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;QAC9C,UAAU,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC;KAChF,CAAC;AACJ,CAAC;AAED,0EAA0E;AAC1E,SAAS,YAAY,CAAC,MAAqB;IACzC,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,CAAC,CAAC;IAC1D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAED,uEAAuE;AACvE,SAAS,cAAc;IACrB,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,oBAAoB,CAAyB,CAAC;IACvE,OAAO,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC;AACrC,CAAC"}

package/dist/federation/followers.d.ts

@@ -0,0 +1,43 @@
+import type { Context, PageItems } from '@fedify/fedify';
+import type { Recipient } from '@fedify/vocab';
+import type { Follower } from '../admin/store.ts';
+import type { FederationContextData } from './federation.ts';
+/**
+ * How many followers one page of the collection holds.
+ *
+ * A constant for the same reason the outbox's is: a page URL is something a
+ * peer may come back to, and deriving the size from a setting would move every
+ * page boundary the moment somebody changed it.
+ */
+export declare const FOLLOWERS_PAGE_SIZE = 20;
+/**
+ * A stored follower as the {@link Recipient} Fedify delivers to.
+ *
+ * The shared inbox is offered when the follower published one, because that is
+ * what lets a post addressed to a hundred followers on one instance become one
+ * POST instead of a hundred. Fedify renders a recipient in the collection as
+ * its `id` alone, so the inbox columns cost the collection nothing and are
+ * what `ctx.sendActivity(…, 'followers', …)` needs.
+ */
+export declare function followerRecipient(follower: Follower): Recipient;
+/**
+ * The followers collection, newest follow first: one page of it, or all of it.
+ *
+ * A cursor is the offset into the list as a decimal string, exactly as the
+ * outbox's is, so the two collections page the same way and a cursor keeps
+ * meaning what it meant when it was minted.
+ *
+ * A `null` cursor is not the first page: it is Fedify asking for the whole
+ * collection at once, which is what it does before fanning an activity out to
+ * the followers. Answering it with a page would strand every follower past the
+ * first one silently, so this answers with all of them. The collection a peer
+ * reads never arrives here with `null`, because the first cursor is registered
+ * and a registered first cursor is what makes the collection paged.
+ */
+export declare function followersPage(context: Context<FederationContextData>, cursor: string | null): PageItems<Recipient>;
+/**
+ * The cursor of the last page of the followers collection: the offset the
+ * final whole page starts at, and `0` for a site nobody follows yet.
+ */
+export declare function lastFollowersCursor(total: number): string;
+//# sourceMappingURL=followers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"followers.d.ts","sourceRoot":"","sources":["../../src/federation/followers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAQ/D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,MAAM,EAAE,MAAM,GAAG,IAAI,GACpB,SAAS,CAAC,SAAS,CAAC,CAiBtB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzD"}