@geekity/cms 0.3.0 → 0.5.0

package/dist/federation/records.js

@@ -0,0 +1,506 @@
+import { readdirSync } from 'node:fs';
+import path from 'node:path';
+import { readFileIfPresentSync, withFileLock, writeFileAtomicallySync } from '../files/atomic.js';
+import { uriOf } from './replies.js';
+/**
+ * The two things an ActivityPub site cannot regenerate, as files it publishes.
+ *
+ * decision-9 makes the filesystem the source of truth for everything durable,
+ * and for federation that is the followers and the log of what the inbox was
+ * told. Both live under `content/_data/federation/`, which puts them in git
+ * beside the posts, hands them to an Eleventy build of the same directory as
+ * `federation.followers` and `federation.inbox`, and leaves SQLite holding
+ * nothing but an index of them — one that is rebuilt from these files on every
+ * boot and may be deleted at rest.
+ *
+ * Two rules make that safe, and both live here so no handler has to remember
+ * them:
+ *
+ * - **The file first, the index inside the same step.** Every writer takes
+ *   {@link withFileLock} over the file it is about to change and writes the
+ *   index before it lets go, so a follow and an unfollow arriving together
+ *   cannot leave the index saying something the file does not. SQLite's
+ *   transactions used to cover this and cover nothing here any more.
+ * - **The index is derived, never told.** A row is built from a line of the
+ *   log by {@link inboxRowFrom} whether it is being written for the first time
+ *   or rebuilt at boot, so a rebuilt index cannot differ from the live one.
+ */
+/** Where the federation files live, relative to the content directory. */
+export const FEDERATION_DATA_DIRECTORY = '_data/federation';
+/** What a user's followers file is called, inside their own directory. */
+export const FOLLOWERS_FILE = 'followers.json';
+/** The directory of monthly inbox logs, relative to the content directory. */
+export const INBOX_DIRECTORY = `${FEDERATION_DATA_DIRECTORY}/inbox`;
+/**
+ * The directory one user's federation files live in, relative to the content
+ * directory: `_data/federation/{username}`.
+ *
+ * decision-14 makes every user an actor, and an actor's followers are its own
+ * — an actor that was followed and forgotten simply stops hearing from the
+ * site — so the one file doc-4 had becomes one per user. The name is the
+ * username verbatim, because it is also the name in the actor's id and in the
+ * key files, and a directory nobody can match to a person would be worse than
+ * one with an unusual name in it.
+ *
+ * `inbox` is not a username: it is where the shared log lives, and
+ * `web/authors.ts` reserves the path for exactly that reason. A name that
+ * could climb out of the directory is refused rather than sanitised, because
+ * sanitising two different usernames into one directory would merge two
+ * people's followers.
+ */
+export function userDirectory(username) {
+    if (username === '' || username === '.' || username === '..' || /[/\\]/.test(username)) {
+        throw new Error(`"${username}" cannot name a federation directory.`);
+    }
+    return `${FEDERATION_DATA_DIRECTORY}/${username}`;
+}
+/** The absolute path of one user's `content/_data/federation/{username}/followers.json`. */
+export function followersFile(contentDir, username) {
+    return path.join(contentDir, ...userDirectory(username).split('/'), FOLLOWERS_FILE);
+}
+/**
+ * Every user the content directory holds federation files for, sorted.
+ *
+ * Read from the directory rather than from `data/users.json`, because
+ * decision-9 makes the files the truth: a rebuilt database has to put back
+ * exactly what is on disk, including the followers of a user whose account was
+ * removed — deleting the account is not the same act as unfollowing everybody
+ * on their behalf, and only one of the two can be taken back.
+ */
+export function federatedUsernames(contentDir) {
+    let entries;
+    try {
+        entries = readdirSync(path.join(contentDir, ...FEDERATION_DATA_DIRECTORY.split('/')), {
+            withFileTypes: true,
+        });
+    }
+    catch {
+        // No directory is a site nobody has federated with yet.
+        return [];
+    }
+    return entries
+        .filter((entry) => entry.isDirectory() && entry.name !== 'inbox')
+        .map((entry) => entry.name)
+        .sort();
+}
+/** The absolute path of one site's `content/_data/federation/inbox`. */
+export function inboxDirectory(contentDir) {
+    return path.join(contentDir, ...INBOX_DIRECTORY.split('/'));
+}
+/**
+ * The month an instant falls in, `yyyy-mm`, in UTC.
+ *
+ * UTC rather than the site's zone because the log is a record of what a server
+ * was told, not of a site's day: the name of a file that has been written must
+ * not move when somebody changes the `timezone` setting.
+ */
+export function inboxMonth(instant) {
+    const at = new Date(instant);
+    if (Number.isNaN(at.getTime()))
+        return instant.slice(0, 7);
+    return `${String(at.getUTCFullYear()).padStart(4, '0')}-${String(at.getUTCMonth() + 1).padStart(2, '0')}`;
+}
+/** The log file an activity that arrived at this instant belongs in. */
+export function inboxFile(contentDir, instant) {
+    return path.join(inboxDirectory(contentDir), `${inboxMonth(instant)}.jsonl`);
+}
+/**
+ * One user's followers, as their `followers.json` says them, oldest follow
+ * first.
+ *
+ * A missing file is an empty list, which is what a site nobody has followed
+ * yet has. Anything else that is not a list of deliverable followers throws,
+ * naming the file: this is read at boot to build the index, and a damaged file
+ * read as "no followers" would quietly unfollow everybody — the one thing
+ * doc-4 says an ActivityPub site can never take back.
+ */
+export function readFollowers(contentDir, username) {
+    const file = followersFile(contentDir, username);
+    const source = readFileIfPresentSync(file);
+    if (source === undefined)
+        return [];
+    return parseFollowers(source, file, username);
+}
+/**
+ * Record a follow of one user: append the follower to that user's file, or
+ * refresh the profile of one already there, and put the same thing in the
+ * index.
+ *
+ * Following twice is not two followers. The file is keyed by actor id exactly
+ * as the index is, and an actor already in it keeps its place and its original
+ * follow time — a repeated or redelivered `Follow` refreshes the name and the
+ * avatar and nothing else.
+ */
+export async function addFollower(records, username, follower) {
+    const { admin, contentDir } = records;
+    const file = followersFile(contentDir, username);
+    return await withFileLock(file, () => {
+        const held = readFollowers(contentDir, username);
+        const existing = held.find((entry) => entry.actorId === follower.actorId);
+        const stored = {
+            username,
+            actorId: follower.actorId,
+            inboxId: follower.inboxId,
+            sharedInboxId: follower.sharedInboxId,
+            handle: follower.handle,
+            name: follower.name,
+            iconUrl: follower.iconUrl,
+            url: follower.url,
+            // The file remembers when the follow began, so a profile refresh cannot
+            // move an actor to the top of the list it has been on for a year.
+            followedAt: existing?.followedAt ?? follower.followedAt ?? new Date().toISOString(),
+        };
+        const next = existing === undefined
+            ? [...held, stored]
+            : held.map((entry) => (entry.actorId === stored.actorId ? stored : entry));
+        writeFileAtomicallySync(file, followersJson(next));
+        admin.putFollower(stored);
+        return stored;
+    });
+}
+/**
+ * Forget one of a user's followers: an `Undo(Follow)`, or an actor deleting
+ * itself.
+ *
+ * Returns whether anything was there to forget. The index is emptied of the
+ * actor whether or not the file held it, so a row left over from a file that
+ * was edited by hand cannot go on being delivered to.
+ */
+export async function removeFollower(records, username, actorId) {
+    const { admin, contentDir } = records;
+    const file = followersFile(contentDir, username);
+    return await withFileLock(file, () => {
+        const held = readFollowers(contentDir, username);
+        const next = held.filter((entry) => entry.actorId !== actorId);
+        if (next.length !== held.length)
+            writeFileAtomicallySync(file, followersJson(next));
+        const indexed = admin.deleteFollower(username, actorId);
+        return next.length !== held.length || indexed;
+    });
+}
+/**
+ * The whole inbox log, oldest month first and, within a month, in the order
+ * the activities arrived.
+ *
+ * Every month file under `content/_data/federation/inbox` is read; a file or a
+ * line that will not parse throws, naming the file. Fedify answers a throwing
+ * dispatcher by swallowing the throw, so a log this cannot read has to stop
+ * the boot rather than wait to be noticed through a request.
+ */
+export function readInboxLog(contentDir) {
+    const lines = [];
+    for (const file of inboxFiles(contentDir))
+        lines.push(...readInboxFile(file));
+    return lines;
+}
+/**
+ * Record one inbound activity: append it to the month's log and index it.
+ *
+ * `json` is the activity as compacted JSON-LD, which is what the handler has
+ * and what doc-4 says to keep whole — nothing is picked out of it here beyond
+ * the columns the index pages and counts by, because what a later phase will
+ * want out of an activity is not knowable from here.
+ *
+ * An activity with no actor is dropped and nothing is written: Fedify has
+ * already refused anything whose signature does not match its actor, so one
+ * without an actor is malformed rather than anonymous. A redelivery of an
+ * activity the month already holds replaces its line where it stands, which is
+ * what the index's unique key on the activity id does to the row.
+ */
+export async function appendInboxActivity(records, json, options = {}) {
+    const { admin, contentDir } = records;
+    const receivedAt = options.receivedAt ?? new Date().toISOString();
+    const line = { receivedAt, recipient: options.recipient ?? null, json };
+    const row = inboxRowFrom(line);
+    if (row === undefined)
+        return undefined;
+    const file = inboxFile(contentDir, receivedAt);
+    return await withFileLock(file, () => {
+        const held = readInboxFile(file);
+        const at = row.activityId === null ? -1 : held.findIndex(sameActivity(row.activityId));
+        const next = at === -1 ? [...held, line] : held.with(at, line);
+        writeFileAtomicallySync(file, inboxJsonl(next));
+        return admin.logInboxActivity(row);
+    });
+}
+/**
+ * One line of the log as the index row it makes, or `undefined` when it is not
+ * an activity the log keeps.
+ *
+ * This is the only place a row is derived, and the live append and the boot
+ * rebuild both go through it, so a row rebuilt from the log cannot say
+ * something different from the row the activity made when it arrived. Every
+ * column is read out of the JSON, so the file really is the whole story;
+ * `inReplyTo` is the one the store derives for itself, from this same JSON and
+ * by the same rule.
+ */
+export function inboxRowFrom(line) {
+    let parsed;
+    try {
+        parsed = JSON.parse(line.json);
+    }
+    catch {
+        return undefined;
+    }
+    if (!isRecord(parsed))
+        return undefined;
+    const actorId = uriOf(parsed['actor']);
+    if (actorId === null)
+        return undefined;
+    return {
+        activityId: uriOf(parsed['id']),
+        activityType: activityTypeOf(parsed['type']),
+        actorId,
+        objectId: uriOf(parsed['object']),
+        recipient: line.recipient,
+        receivedAt: line.receivedAt,
+        json: line.json,
+    };
+}
+/**
+ * Rebuild the followers and inbox indexes from the files.
+ *
+ * This is what makes `data/geekity.db` disposable for federation (decision-9):
+ * the two tables hold nothing but what these files say, so every boot throws
+ * away what they hold and reads them again. That is also what makes editing
+ * `followers.json` by hand and restarting a supported thing to do, and why a
+ * database deleted at rest costs a site nothing.
+ *
+ * Exported so `geekity rebuild` can call the very function boot calls. It is
+ * synchronous because both callers are, and it reads before it writes: a file
+ * that will not parse throws with the file named and leaves the index exactly
+ * as it was, rather than emptying it and then failing.
+ */
+export function rebuildFederationIndexes(records) {
+    const { admin, contentDir } = records;
+    const followers = federatedUsernames(contentDir).flatMap((username) => readFollowers(contentDir, username));
+    const activities = [];
+    for (const line of readInboxLog(contentDir)) {
+        const row = inboxRowFrom(line);
+        if (row !== undefined)
+            activities.push(row);
+    }
+    admin.replaceFollowers(followers);
+    admin.replaceInboxActivities(activities);
+    return { followers: followers.length, activities: activities.length };
+}
+/**
+ * Write an older site's inbox rows out as files, once.
+ *
+ * Before decision-9 the table was the source rather than an index of one, so a
+ * site upgrading has rows that no file carries. The rule is the simple one the
+ * other decision-9 migrations use, and it is simple here because the log did
+ * not exist as a file at all before: a log that is already there wins outright
+ * and is not touched, and rows are written out only where there is none. The
+ * lines it writes name no recipient, because the site they came from had one
+ * actor and it is gone (decision-14).
+ *
+ * The site actor's followers are **not** migrated. decision-14 replaces one
+ * site actor with one actor per user, and there is no honest answer to which
+ * user inherited the followers of an account that no longer exists: a follow
+ * is an agreement with somebody, and handing it to whoever happens to have the
+ * lowest user id would be answering it for them. A site that federated as the
+ * site actor starts again as its users, and the old
+ * `content/_data/federation/followers.json` is left exactly where it is for an
+ * operator who wants to move rows into a user's file by hand.
+ *
+ * The table is not dropped, unlike `settings`, `actor_keys` and `users`: it
+ * stays as the index the rest of the CMS reads. {@link rebuildFederationIndexes}
+ * is what runs next and puts the files back into it.
+ */
+export function migrateFederationToFiles(records) {
+    const { admin, contentDir } = records;
+    if (inboxFiles(contentDir).length === 0) {
+        const byMonth = new Map();
+        for (const activity of [...admin.listInboxActivities()].reverse()) {
+            const line = {
+                receivedAt: activity.receivedAt,
+                recipient: activity.recipient,
+                json: activity.json,
+            };
+            const month = inboxFile(contentDir, activity.receivedAt);
+            byMonth.set(month, [...(byMonth.get(month) ?? []), line]);
+        }
+        for (const [month, lines] of byMonth)
+            writeFileAtomicallySync(month, inboxJsonl(lines));
+    }
+}
+/**
+ * One user's followers as their file spells them: an array, indented, newline
+ * ended.
+ *
+ * The username is not written into the entries. It is the name of the
+ * directory the file is in, and saying it again once per follower would be a
+ * second place for it to be wrong.
+ */
+function followersJson(followers) {
+    const entries = followers.map(({ username: _username, ...rest }) => rest);
+    return `${JSON.stringify(entries, null, 2)}\n`;
+}
+/**
+ * `followers.json` as the followers it names, or a thrown error naming it.
+ *
+ * An entry with no actor id or no inbox is refused rather than dropped. Those
+ * two are the whole of what a follower is for — something to deliver to, and a
+ * name to key it by — and skipping such an entry would leave the file and the
+ * index quietly disagreeing about who follows the site.
+ */
+function parseFollowers(source, file, username) {
+    let parsed;
+    try {
+        parsed = JSON.parse(source);
+    }
+    catch (error) {
+        throw new Error(`${file} could not be read as JSON: ${messageOf(error)}`, { cause: error });
+    }
+    if (!Array.isArray(parsed)) {
+        throw new Error(`${file} should be a list of followers, one object per follower.`);
+    }
+    return parsed.map((entry, index) => {
+        if (typeof entry !== 'object' || entry === null || Array.isArray(entry)) {
+            throw new Error(`${file}: entry ${String(index + 1)} is not a follower object.`);
+        }
+        const follower = entry;
+        const actorId = follower['actorId'];
+        const inboxId = follower['inboxId'];
+        if (typeof actorId !== 'string' || actorId === '') {
+            throw new Error(`${file}: entry ${String(index + 1)} has no actorId.`);
+        }
+        if (typeof inboxId !== 'string' || inboxId === '') {
+            throw new Error(`${file}: the follower "${actorId}" has no inboxId to deliver to.`);
+        }
+        return {
+            username,
+            actorId,
+            inboxId,
+            sharedInboxId: optionalText(follower['sharedInboxId']),
+            handle: optionalText(follower['handle']),
+            name: optionalText(follower['name']),
+            iconUrl: optionalText(follower['iconUrl']),
+            url: optionalText(follower['url']),
+            followedAt: typeof follower['followedAt'] === 'string' ? follower['followedAt'] : '',
+        };
+    });
+}
+/** A value the file may have left out, as the text it holds or `null`. */
+function optionalText(value) {
+    return typeof value === 'string' && value !== '' ? value : null;
+}
+/** Every month log a site has, oldest first. */
+function inboxFiles(contentDir) {
+    const directory = inboxDirectory(contentDir);
+    let entries;
+    try {
+        entries = readdirSync(directory);
+    }
+    catch {
+        // No directory is no log, which is what a site nobody has interacted with
+        // has. Every other way this can fail fails again on the next boot.
+        return [];
+    }
+    // The names are `yyyy-mm`, so sorting them as text sorts them by month, and
+    // reading them in that order is what makes the row ids the arrival order.
+    return entries
+        .filter((name) => name.endsWith('.jsonl'))
+        .sort()
+        .map((name) => path.join(directory, name));
+}
+/** One month's log as its lines, or a thrown error naming the file. */
+function readInboxFile(file) {
+    const source = readFileIfPresentSync(file);
+    if (source === undefined)
+        return [];
+    const lines = [];
+    const rows = source.split('\n');
+    for (const [index, row] of rows.entries()) {
+        if (row.trim() === '')
+            continue;
+        let parsed;
+        try {
+            parsed = JSON.parse(row);
+        }
+        catch (error) {
+            throw new Error(`${file}: line ${String(index + 1)} is not JSON: ${messageOf(error)}`, {
+                cause: error,
+            });
+        }
+        if (!isRecord(parsed)) {
+            throw new Error(`${file}: line ${String(index + 1)} is not an activity.`);
+        }
+        // `receivedAt` and `recipient` are the log's own words and everything else
+        // is the activity, so taking them off leaves exactly what the peer
+        // delivered.
+        const { receivedAt, recipient, ...activity } = parsed;
+        lines.push({
+            receivedAt: typeof receivedAt === 'string' ? receivedAt : '',
+            recipient: typeof recipient === 'string' && recipient !== '' ? recipient : null,
+            json: JSON.stringify(activity),
+        });
+    }
+    return lines;
+}
+/** The lines as the file spells them: one compact JSON object each. */
+function inboxJsonl(lines) {
+    return lines
+        .map((line) => `${JSON.stringify({
+        receivedAt: line.receivedAt,
+        // Absent rather than null for a shared-inbox delivery that named
+        // nobody, so a log written before decision-14 and one written after
+        // it read the same.
+        ...(line.recipient === null ? {} : { recipient: line.recipient }),
+        ...JSON.parse(line.json),
+    })}\n`)
+        .join('');
+}
+/** Whether a line carries this activity id, for the redelivery that replaces it. */
+function sameActivity(activityId) {
+    return (line) => {
+        const parsed = JSON.parse(line.json);
+        return isRecord(parsed) && uriOf(parsed['id']) === activityId;
+    };
+}
+/**
+ * The short ActivityStreams type name an activity carries: `Like`, `Announce`,
+ * `Create`.
+ *
+ * A compacted document usually spells it as that word, which is what the
+ * `INBOX_INTERACTIONS` table on the federation screen keys on. Anything else
+ * is reduced the way the type IRI is: the fragment, else the last path
+ * segment, so an activity outside the core vocabulary still has a name rather
+ * than a URL. An activity with several types is filed under the first, and one
+ * with none is `Activity`, which is what it is.
+ */
+function activityTypeOf(value) {
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            const found = activityTypeOf(item);
+            if (found !== 'Activity')
+                return found;
+        }
+        return 'Activity';
+    }
+    if (typeof value !== 'string' || value === '')
+        return 'Activity';
+    if (!value.includes(':'))
+        return value;
+    try {
+        const url = new URL(value);
+        if (url.hash !== '')
+            return url.hash.slice(1);
+        const last = url.pathname
+            .split('/')
+            .filter((segment) => segment !== '')
+            .pop();
+        return last ?? value;
+    }
+    catch {
+        return value;
+    }
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function messageOf(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=records.js.map

package/dist/federation/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../../src/federation/records.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,IAAI,MAAM,WAAW,CAAC;AAS7B,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,yBAAyB,GAAG,kBAAkB,CAAC;AAE5D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAE/C,8EAA8E;AAC9E,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,yBAAyB,QAAQ,CAAC;AAEpE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,IAAI,QAAQ,KAAK,EAAE,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvF,MAAM,IAAI,KAAK,CAAC,IAAI,QAAQ,uCAAuC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,GAAG,yBAAyB,IAAI,QAAQ,EAAE,CAAC;AACpD,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,aAAa,CAAC,UAAkB,EAAE,QAAgB;IAChE,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC;AACtF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAAkB;IACnD,IAAI,OAAuD,CAAC;IAC5D,IAAI,CAAC;QACH,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,yBAAyB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE;YACpF,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,wDAAwD;QACxD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;SAChE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC1B,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,cAAc,CAAC,UAAkB;IAC/C,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAAe;IACxC,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;QAAE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3D,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAC5G,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,SAAS,CAAC,UAAkB,EAAE,OAAe;IAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC/E,CAAC;AAUD;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,UAAkB,EAAE,QAAgB;IAChE,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAEpC,OAAO,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAA0B,EAC1B,QAAgB,EAChB,QAAuC;IAEvC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACtC,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEjD,OAAO,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE;QACnC,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAa;YACvB,QAAQ;YACR,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,aAAa,EAAE,QAAQ,CAAC,aAAa;YACrC,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,wEAAwE;YACxE,kEAAkE;YAClE,UAAU,EAAE,QAAQ,EAAE,UAAU,IAAI,QAAQ,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpF,CAAC;QAEF,MAAM,IAAI,GACR,QAAQ,KAAK,SAAS;YACpB,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACnB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAE/E,uBAAuB,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA0B,EAC1B,QAAgB,EAChB,OAAe;IAEf,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACtC,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEjD,OAAO,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE;QACnC,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;YAAE,uBAAuB,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpF,MAAM,OAAO,GAAG,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC;AA4BD;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,UAAkB;IAC7C,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAA0B,EAC1B,IAAY,EACZ,OAAO,GAA+E,EAAE;IAExF,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACtC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClE,MAAM,IAAI,GAAc,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;IACnF,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAExC,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAE/C,OAAO,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE;QACnC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,EAAE,GAAG,GAAG,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACvF,MAAM,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAE/D,uBAAuB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,IAAe;IAC1C,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IAExC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACvC,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAEvC,OAAO;QACL,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,YAAY,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,OAAO;QACP,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;KAChB,CAAC;AACJ,CAAC;AAUD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAA0B;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAEtC,MAAM,SAAS,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpE,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,CACpC,CAAC;IACF,MAAM,UAAU,GAAuB,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,GAAG,KAAK,SAAS;YAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAClC,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEzC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAA0B;IACjE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAEtC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC/C,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,KAAK,CAAC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;YAClE,MAAM,IAAI,GAAc;gBACtB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB,CAAC;YACF,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;YACzD,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,OAAO;YAAE,uBAAuB,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1F,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CAAC,SAA8B;IACnD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC1E,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc,CAAC,MAAc,EAAE,IAAY,EAAE,QAAgB;IACpE,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,+BAA+B,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,0DAA0D,CAAC,CAAC;IACrF,CAAC;IAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,4BAA4B,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,QAAQ,GAAG,KAAgC,CAAC;QAClD,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,WAAW,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,kBAAkB,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,mBAAmB,OAAO,iCAAiC,CAAC,CAAC;QACtF,CAAC;QAED,OAAO;YACL,QAAQ;YACR,OAAO;YACP,OAAO;YACP,aAAa,EAAE,YAAY,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACtD,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAC1C,GAAG,EAAE,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClC,UAAU,EAAE,OAAO,QAAQ,CAAC,YAAY,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE;SACrF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,0EAA0E;AAC1E,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAClE,CAAC;AAED,gDAAgD;AAChD,SAAS,UAAU,CAAC,UAAkB;IACpC,MAAM,SAAS,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,OAAiB,CAAC;IACtB,IAAI,CAAC;QACH,OAAO,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,0EAA0E;QAC1E,mEAAmE;QACnE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,4EAA4E;IAC5E,0EAA0E;IAC1E,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SACzC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,uEAAuE;AACvE,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,MAAM,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAEpC,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAChC,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1C,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,SAAS;QAEhC,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,UAAU,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,iBAAiB,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE;gBACrF,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,UAAU,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,sBAAsB,CAAC,CAAC;QAC5E,CAAC;QAED,2EAA2E;QAC3E,mEAAmE;QACnE,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC;YACT,UAAU,EAAE,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;YAC5D,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;YAC/E,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,uEAAuE;AACvE,SAAS,UAAU,CAAC,KAA2B;IAC7C,OAAO,KAAK;SACT,GAAG,CACF,CAAC,IAAI,EAAE,EAAE,CACP,GAAG,IAAI,CAAC,SAAS,CAAC;QAChB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,iEAAiE;QACjE,oEAAoE;QACpE,oBAAoB;QACpB,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QACjE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;KACzB,CAAC,IAAI,CACT;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,oFAAoF;AACpF,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,UAAU,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,KAAK,KAAK,UAAU;gBAAE,OAAO,KAAK,CAAC;QACzC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,UAAU,CAAC;IACjE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAEvC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,IAAI,GAAG,CAAC,IAAI,KAAK,EAAE;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ;aACtB,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,EAAE,CAAC;aACnC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,IAAI,KAAK,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,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"}

package/dist/federation/relays.d.ts

@@ -0,0 +1,114 @@
+import { Accept, Reject } from '@fedify/vocab';
+import type { Recipient } from '@fedify/vocab';
+import type { AdminStore, Relay } from '../admin/store.ts';
+import type { ResolvedConfig } from '../config.ts';
+import type { ContentStore } from '../content/store.ts';
+import type { SiteFederation } from './federation.ts';
+/** Where a relay reports what it could not do. `console` will do. */
+export interface RelayLogger {
+    warn(message: string): void;
+}
+/** What {@link createRelayService} needs. */
+export interface CreateRelayServiceOptions {
+    /** The site's federation object, which mints the ids and signs the requests. */
+    federation: SiteFederation;
+    /** The settings, which hold the relay list, and the subscription records. */
+    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?: RelayLogger | undefined;
+}
+/** What one call to {@link RelayService.sync} did. */
+export interface RelaySyncReport {
+    /** The relays newly followed, because the list named them and nothing knew them. */
+    readonly followed: readonly string[];
+    /** The relays unfollowed, because the list stopped naming them. */
+    readonly unfollowed: readonly string[];
+}
+/**
+ * The site's half of the Mastodon relay protocol (FEP-ae0c).
+ *
+ * A relay is not a follower and is not stored as one: it is followed rather
+ * than following, its subscription can be refused, and it has no profile worth
+ * showing. What it shares with a follower is the only thing that matters to
+ * the rest of the system — an inbox every public activity is delivered to —
+ * and {@link relayRecipient} is where that likeness is spelled out.
+ */
+export interface RelayService {
+    /**
+     * Bring the subscriptions in line with the relay list in the settings: a
+     * listed relay with no record is followed, a record no longer listed is
+     * undone. Called at boot and after every save of the settings.
+     *
+     * A listed relay whose record was lost — a rebuilt database, a restored
+     * content directory — is followed again, which is what makes the file the
+     * source and the records derivable from it.
+     */
+    sync(): RelaySyncReport;
+    /**
+     * Send the `Follow` again for one relay, under a fresh id, and put its
+     * record back to pending. This is the Retry on the federation screen: a
+     * relay may have been down, or may have lost the subscription.
+     */
+    retry(inboxId: string): Promise<Relay | undefined>;
+    /** Resolve once every queued `Follow` and `Undo` has finished, however it finished. */
+    settled(): Promise<void>;
+}
+/**
+ * One relay as the {@link Recipient} Fedify delivers to.
+ *
+ * The inbox stands in for the id until the relay has answered, because the
+ * `Follow` goes out before the site knows what to call it: Fedify drops a
+ * recipient with no id, so `null` would silently send nothing. The id is only
+ * ever used to key the inbox and to build a collection synchronisation header
+ * for a shared inbox, and a relay publishes no shared inbox — a relay *is* one
+ * — so standing the inbox in for it costs the relay nothing.
+ */
+export declare function relayRecipient(relay: Relay): Recipient;
+/**
+ * The relays a public activity is delivered to: the accepted ones, and only
+ * those.
+ *
+ * A pending subscription has not been agreed to and a rejected one has been
+ * refused; delivering to either would be posting into an inbox that has not
+ * said it wants this, which is what the handshake exists to establish.
+ */
+export declare function acceptedRelays(admin: AdminStore): Relay[];
+/**
+ * Build the relay service for one site.
+ *
+ * FEP-ae0c is the whole of the protocol: a `Follow` whose object is the
+ * literal Public collection, sent to the relay's inbox and signed the way any
+ * other activity is; an `Accept` or a `Reject` back, which may take days
+ * because a relay is allowed to hold a subscription for a human to approve;
+ * and an `Undo` of that same `Follow` to leave.
+ */
+export declare function createRelayService(options: CreateRelayServiceOptions): RelayService;
+/**
+ * Mark the subscription an `Accept` answers as accepted, and record who the
+ * relay turned out to be. `undefined` when it answers no follow this site
+ * sent — the site follows nothing but relays (doc-4), so that is a stray.
+ *
+ * A free function over the store rather than a method on the service: nothing
+ * about it is queued or sent, and the inbox listener that calls it has the
+ * store on its context and no service.
+ */
+export declare function acceptRelay(admin: AdminStore, activity: Accept): Relay | undefined;
+/** The same for a `Reject`, which marks the relay rejected with its reason. */
+export declare function rejectRelay(admin: AdminStore, activity: Reject): Relay | undefined;
+/**
+ * Match an `Accept` or a `Reject` to the subscription it answers.
+ *
+ * The follow id is what FEP-ae0c says the answer names, so it is tried first.
+ * A relay that has answered before is then recognised by its actor id, which
+ * covers a re-follow whose answer echoes a stale id. Last, a single pending
+ * subscription on the answering relay's own origin is taken as the one meant:
+ * a relay answering from the host its inbox is on is answering about that
+ * inbox, and there is nothing else it could be about. Two pending
+ * subscriptions on one host are left alone rather than guessed between.
+ */
+export declare function relayAnswering(admin: AdminStore, activity: Accept | Reject): Relay | undefined;
+//# sourceMappingURL=relays.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relays.d.ts","sourceRoot":"","sources":["../../src/federation/relays.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAA6B,MAAM,EAAQ,MAAM,eAAe,CAAC;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAK/C,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,KAAK,EAAyB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE7E,qEAAqE;AACrE,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,6CAA6C;AAC7C,MAAM,WAAW,yBAAyB;IACxC,gFAAgF;IAChF,UAAU,EAAE,cAAc,CAAC;IAC3B,6EAA6E;IAC7E,KAAK,EAAE,UAAU,CAAC;IAClB,yEAAyE;IACzE,KAAK,EAAE,YAAY,CAAC;IACpB,uDAAuD;IACvD,MAAM,EAAE,cAAc,CAAC;IACvB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAClC;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,oFAAoF;IACpF,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;OAQG;IACH,IAAI,IAAI,eAAe,CAAC;IACxB;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IACnD,uFAAuF;IACvF,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,CAKtD;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,EAAE,CAEzD;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,YAAY,CAyMnF;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CASlF;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CASlF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,CAoB9F"}