@aeolus-fleet/gateway 0.32.2 → 0.33.0

package/dist/core/slack/send-slack-events.js

@@ -0,0 +1,78 @@
+import { TAKEN_KEPT_MS, UNTAKEN_KEPT_MS } from './kept-slack-event.js';
+/** How many kept events a round sends at most. */
+const ROUND_LIMIT = 50;
+/** The reaction that tells the person their message reached the fleet. */
+export const STORED_REACTION = 'white_check_mark';
+/** The fleet's codes for a send it did not answer, or could not start: nothing was stored, so the same send goes again. */
+const NOT_ANSWERED = new Set(['UNAVAILABLE', 'SERVICE_UNAVAILABLE', 'INTERNAL_SERVER_ERROR', 'TIMEOUT']);
+/** The fleet's codes for a crew token that no longer works: the person ship is crewed again at their next visit, and the send goes then. */
+const ENDED_CREW = new Set(['LEASE_ENDED', 'UNAUTHORIZED']);
+export const NOT_REACHED_TEXT = 'This message did not reach the fleet; send it again';
+/** What the person reads in the thread when core refused their message, plainly. */
+function refusalText(ship, refusal) {
+    switch (refusal.code) {
+        case 'NOT_REACHABLE':
+            return `You may not message ${ship}`;
+        case 'UNRESOLVABLE_SELECTOR':
+            return `${ship} was retired`;
+        default:
+            return `${ship} did not take your message: ${refusal.message}`;
+    }
+}
+/**
+ * Use case: a round of the gateway's sends from Slack into the fleet
+ * (gateway scopes 9.4 steps 5 to 7, P-B2). Each kept event goes as the
+ * person ship, which the gateway crews, to the bot's ship by its id, as
+ * Markdown, keyed by Slack's event id so a send tried again is the same
+ * send. Core stored it: the gateway reacts to the person's Slack message.
+ * Core refused it: the reason goes in its thread. Core did not answer: it
+ * goes again next round. Nothing builds up: a taken event's id goes an
+ * hour after core took it, and an event core has not taken in 24 hours
+ * goes, the person told in its thread.
+ */
+export function createSendSlackEvents(deps) {
+    const send = async (event) => {
+        const app = await deps.apps.findByAppId(event.appId);
+        const crew = await deps.crews.find(event.fleetId, event.personShipId);
+        if (app === undefined || app.bot === null || crew === undefined) {
+            // No bot to answer with, or no crew to send as: the event waits, and goes after 24 hours told as not reached.
+            return 'later';
+        }
+        const where = { channel: event.channel, threadTs: event.threadTs ?? event.ts };
+        const message = { to: event.shipId, contentType: 'text/markdown', payload: event.markdown, idempotencyKey: `slack:${event.eventId}` };
+        const sent = await deps.sender.send(crew.crewToken, event.inReplyTo === null ? message : { ...message, inReplyTo: event.inReplyTo });
+        if (sent.isOk) {
+            const { fleetId, personShipId, appId, channel, ts, threadTs } = event;
+            await deps.posts.save({ fleetId, personShipId, messageId: sent.value.messageId, deliveryId: null, senderShipId: null, appId, channel, ts, threadTs, isLinkOnly: false, ackedAt: null });
+            if (event.deliveryId !== null) {
+                // A refusal leaves the delivery acknowledged, as an answer on the gateway's page does when handled is refused.
+                await deps.door.handled(crew.crewToken, event.deliveryId);
+            }
+            // Without the reaction the person sees no sign and sends again: the event goes again, the same send by its key.
+            const reacted = await deps.slack.react(app.bot.token, { channel, ts, name: STORED_REACTION });
+            return reacted.isOk ? 'taken' : 'later';
+        }
+        if (NOT_ANSWERED.has(sent.error.code) || ENDED_CREW.has(sent.error.code)) {
+            return 'later';
+        }
+        // A refusal is dropped only once the person was told it.
+        const told = await deps.slack.postInThread(app.bot.token, { ...where, text: refusalText(app.name, sent.error) });
+        return told.isOk ? 'taken' : 'later';
+    };
+    const tellNotReached = async (event) => {
+        const app = await deps.apps.findByAppId(event.appId);
+        if (app !== undefined && app.bot !== null) {
+            await deps.slack.postInThread(app.bot.token, { channel: event.channel, threadTs: event.threadTs ?? event.ts, text: NOT_REACHED_TEXT });
+        }
+        await deps.events.remove(event.fleetId, event.eventId);
+    };
+    return async () => {
+        const now = deps.clock.now();
+        await deps.events.forgetTaken(new Date(now.getTime() - TAKEN_KEPT_MS));
+        for (const event of await deps.events.untakenSince(new Date(now.getTime() - UNTAKEN_KEPT_MS))) {
+            await tellNotReached(event);
+        }
+        await deps.events.sendDue(send, { limit: ROUND_LIMIT, at: now });
+    };
+}
+//# sourceMappingURL=send-slack-events.js.map

package/dist/core/slack/send-slack-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-slack-events.js","sourceRoot":"","sources":["../../../src/core/slack/send-slack-events.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAuB,MAAM,uBAAuB,CAAC;AAG5F,kDAAkD;AAClD,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,0EAA0E;AAC1E,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAC;AAElD,2HAA2H;AAC3H,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,SAAS,CAAC,CAAC,CAAC;AAEzG,4IAA4I;AAC5I,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;AAE5D,MAAM,CAAC,MAAM,gBAAgB,GAAG,qDAAqD,CAAC;AAItF,oFAAoF;AACpF,SAAS,WAAW,CAAC,IAAY,EAAE,OAA0C;IAC3E,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,eAAe;YAClB,OAAO,uBAAuB,IAAI,EAAE,CAAC;QACvC,KAAK,uBAAuB;YAC1B,OAAO,GAAG,IAAI,cAAc,CAAC;QAC/B;YACE,OAAO,GAAG,IAAI,+BAA+B,OAAO,CAAC,OAAO,EAAE,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,qBAAqB,CAAC,IASrC;IACC,MAAM,IAAI,GAAG,KAAK,EAAE,KAAqB,EAA8B,EAAE;QACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QACtE,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAChE,8GAA8G;YAC9G,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;QAC/E,MAAM,OAAO,GAAG,EAAE,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACtI,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;QACrI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;YACtE,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACxL,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC9B,+GAA+G;gBAC/G,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;YAC5D,CAAC;YACD,gHAAgH;YAChH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;YAC9F,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QAC1C,CAAC;QACD,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACzE,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,yDAAyD;QACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IACvC,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,KAAK,EAAE,KAAqB,EAAiB,EAAE;QACpE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;YAC1C,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACzI,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC,CAAC;IAEF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC;QACvE,KAAK,MAAM,KAAK,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC;YAC9F,MAAM,cAAc,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;AACJ,CAAC"}

package/dist/core/slack/ship-bot.d.ts

@@ -0,0 +1,23 @@
+import type { Actor } from '../actors/authenticate-actor.js';
+import type { ActorCredential, CredentialOf } from '../actors/credential-of.js';
+import { type DomainError } from '../shared/errors.js';
+import { type Result } from '../shared/result.js';
+import type { SlackApps, SlackShips } from './ports.js';
+import type { SlackApp } from './slack-app.js';
+export type ShipBotRefusal = DomainError<'NO_SUCH_BOT' | 'NOT_REACHABLE' | 'FLEET_UNAVAILABLE'>;
+/**
+ * A ship's bot in the actor's fleet, once the fleet, asked as the actor,
+ * answers that the actor manages the ship (B6). The gateway's own bot is no
+ * ship's.
+ */
+export declare function managedShipBot(deps: {
+    apps: Pick<SlackApps, 'find'>;
+    ships: Pick<SlackShips, 'read' | 'checkManage'>;
+    credentialOf: CredentialOf;
+}, asked: {
+    actor: Actor;
+    as: ActorCredential;
+    appId: string;
+}): Promise<Result<SlackApp & {
+    shipName: string;
+}, ShipBotRefusal>>;

package/dist/core/slack/ship-bot.js

@@ -0,0 +1,25 @@
+import { refuse } from '../shared/errors.js';
+import { ok } from '../shared/result.js';
+/**
+ * A ship's bot in the actor's fleet, once the fleet, asked as the actor,
+ * answers that the actor manages the ship (B6). The gateway's own bot is no
+ * ship's.
+ */
+export async function managedShipBot(deps, asked) {
+    const app = await deps.apps.find(asked.actor.fleetId, asked.appId);
+    if (app?.shipId === undefined || app.shipId === null) {
+        return refuse('NO_SUCH_BOT', `The gateway made no ship's bot ${asked.appId} in this fleet`);
+    }
+    const ship = await deps.ships.read(app.fleetId, app.shipId);
+    const shipName = ship.isOk ? ship.value.name : app.name;
+    const credential = await deps.credentialOf(asked.actor, asked.as);
+    if (!credential.isOk) {
+        return credential;
+    }
+    const managed = await deps.ships.checkManage(credential.value, app.shipId);
+    if (!managed.isOk) {
+        return managed.error.code === 'UNAVAILABLE' ? refuse('FLEET_UNAVAILABLE', `The fleet did not say whether you manage ${shipName}: ${managed.error.message}`) : refuse('NOT_REACHABLE', managed.error.message);
+    }
+    return ok({ ...app, shipName });
+}
+//# sourceMappingURL=ship-bot.js.map

package/dist/core/slack/ship-bot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ship-bot.js","sourceRoot":"","sources":["../../../src/core/slack/ship-bot.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAoB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,EAAE,EAAe,MAAM,qBAAqB,CAAC;AAMtD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,IAAoH,EACpH,KAA2D;IAE3D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACnE,IAAI,GAAG,EAAE,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC,aAAa,EAAE,kCAAkC,KAAK,CAAC,KAAK,gBAAgB,CAAC,CAAC;IAC9F,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IACxD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3E,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,EAAE,4CAA4C,QAAQ,KAAK,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/M,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClC,CAAC"}

package/dist/core/slack/show-all-in-slack.d.ts

@@ -0,0 +1,16 @@
+import type { Actor } from '../actors/authenticate-actor.js';
+import { type DomainError } from '../shared/errors.js';
+import { type Result } from '../shared/result.js';
+import type { SlackLinks } from './ports.js';
+export type ShowAllInSlack = (input: {
+    actor: Actor;
+    isOn: boolean;
+}) => Promise<Result<undefined, DomainError<'NOT_LINKED'>>>;
+/**
+ * Use case: the person turns Show everything that waits in Slack on or off
+ * (gateway scopes 9.6, B5): with it on, messages from ships that are not
+ * bots show through the gateway's own bot too. Off until turned on (W8).
+ */
+export declare function createShowAllInSlack(deps: {
+    links: Pick<SlackLinks, 'ofAccount' | 'showAll'>;
+}): ShowAllInSlack;

package/dist/core/slack/show-all-in-slack.js

@@ -0,0 +1,18 @@
+import { refuse } from '../shared/errors.js';
+import { ok } from '../shared/result.js';
+/**
+ * Use case: the person turns Show everything that waits in Slack on or off
+ * (gateway scopes 9.6, B5): with it on, messages from ships that are not
+ * bots show through the gateway's own bot too. Off until turned on (W8).
+ */
+export function createShowAllInSlack(deps) {
+    return async ({ actor, isOn }) => {
+        const link = actor.kind === 'account' ? await deps.links.ofAccount(actor.fleetId, actor.accountId) : undefined;
+        if (link === undefined) {
+            return refuse('NOT_LINKED', 'Link your Slack account first');
+        }
+        await deps.links.showAll(link.fleetId, { accountId: link.accountId, isOn });
+        return ok(undefined);
+    };
+}
+//# sourceMappingURL=show-all-in-slack.js.map

package/dist/core/slack/show-all-in-slack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show-all-in-slack.js","sourceRoot":"","sources":["../../../src/core/slack/show-all-in-slack.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAoB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,EAAE,EAAe,MAAM,qBAAqB,CAAC;AAKtD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAA0D;IAC7F,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE;QAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/G,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,MAAM,CAAC,YAAY,EAAE,+BAA+B,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC"}

package/dist/core/slack/show-in-slack.d.ts

@@ -0,0 +1,38 @@
+import type { FleetId } from '@aeolus-fleet/common';
+import type { FleetRefusal } from '../connection/ports.js';
+import type { Sleep } from '../mcp-out/run-party.js';
+import type { PersonShip, PersonShipDoor, PushedPersonDelivery, ShownThere } from '../people/ports.js';
+import type { Clock } from '../shared/clock.js';
+import { type Result } from '../shared/result.js';
+import type { SlackApps, SlackLinks, SlackMessages, SlackPosts } from './ports.js';
+export type ShowInSlack = (ship: PersonShip, wake: {
+    crewToken: string;
+    fresh: readonly PushedPersonDelivery[];
+}) => Promise<Result<ShownThere, FleetRefusal>>;
+/**
+ * Use case: shows what waits for a linked person's person ship in Slack
+ * (gateway scopes 9.5), as the gateway wakes them. A reply to a message
+ * from Slack goes into that conversation or thread; a bot ship's message
+ * into that bot's direct messages with the person (P-B1); anything else
+ * through the gateway's own bot, headed by the sender, once the person
+ * turned Slack on (B5). A bot removed in Slack falls back to the gateway's
+ * bot, with Slack on. Each delivery is kept as a post, handed with channel
+ * slack, posted, given its Slack message, then acknowledged (B4); a link for
+ * what Slack does not show in full is handed only, as a wake. Slack rate
+ * limited: the post waits Retry-After and goes again with the same hand-over.
+ * Slack refused the post: nothing is kept, and web push and email wake as
+ * before. A post the gateway did not finish (it stopped, or core refused
+ * the acknowledgement) is finished first, at every wake, never posted twice
+ * once in Slack. It answers the deliveries Slack showed, which no other
+ * channel wakes for, and whether a post is left unfinished.
+ */
+export declare function createShowInSlack(deps: {
+    links: Pick<SlackLinks, 'ofPersonShip'>;
+    apps: Pick<SlackApps, 'find' | 'ofShip' | 'gatewayBot'>;
+    posts: SlackPosts;
+    slack: Pick<SlackMessages, 'post'>;
+    door: Pick<PersonShipDoor, 'pushReceive' | 'handed' | 'ack'>;
+    sleep: Sleep;
+    clock: Clock;
+    overviewUrlOf: (fleetId: FleetId) => string;
+}): ShowInSlack;

package/dist/core/slack/show-in-slack.js

@@ -0,0 +1,154 @@
+import { ok } from '../shared/result.js';
+import { slackPostOf } from './slack-post-of.js';
+/** How often a post Slack rate limits is asked again within one wake. */
+const RATE_LIMITED_TRIES = 3;
+const SECOND_MS = 1000;
+/** The number a delivery is handed with: the first hand-over, made again with the same number counts nothing (0040). */
+const FIRST_HAND_OVER = 1;
+function isInSlack(app) {
+    return app !== undefined && app.bot !== null && app.removedInSlackAt === null;
+}
+/**
+ * Use case: shows what waits for a linked person's person ship in Slack
+ * (gateway scopes 9.5), as the gateway wakes them. A reply to a message
+ * from Slack goes into that conversation or thread; a bot ship's message
+ * into that bot's direct messages with the person (P-B1); anything else
+ * through the gateway's own bot, headed by the sender, once the person
+ * turned Slack on (B5). A bot removed in Slack falls back to the gateway's
+ * bot, with Slack on. Each delivery is kept as a post, handed with channel
+ * slack, posted, given its Slack message, then acknowledged (B4); a link for
+ * what Slack does not show in full is handed only, as a wake. Slack rate
+ * limited: the post waits Retry-After and goes again with the same hand-over.
+ * Slack refused the post: nothing is kept, and web push and email wake as
+ * before. A post the gateway did not finish (it stopped, or core refused
+ * the acknowledgement) is finished first, at every wake, never posted twice
+ * once in Slack. It answers the deliveries Slack showed, which no other
+ * channel wakes for, and whether a post is left unfinished.
+ */
+export function createShowInSlack(deps) {
+    const whereOf = async (link, delivery) => {
+        const { fleetId, personShipId, slackUserId, isShowingAll } = link;
+        const repliedTo = delivery.inReplyTo === null ? undefined : await deps.posts.ofMessage(fleetId, { personShipId, messageId: delivery.inReplyTo });
+        if (repliedTo !== undefined) {
+            const app = await deps.apps.find(fleetId, repliedTo.appId);
+            if (isInSlack(app)) {
+                return { app, channel: repliedTo.channel, threadTs: repliedTo.threadTs ?? repliedTo.ts };
+            }
+        }
+        const bot = await deps.apps.ofShip(fleetId, delivery.senderShipId);
+        if (isInSlack(bot)) {
+            return { app: bot, channel: slackUserId, threadTs: null };
+        }
+        const gatewayBot = isShowingAll ? await deps.apps.gatewayBot(fleetId) : undefined;
+        return isInSlack(gatewayBot) ? { app: gatewayBot, channel: slackUserId, threadTs: null } : undefined;
+    };
+    /** Posts it, waiting out Slack's rate limits: the Slack message, or none when Slack refused it. */
+    const posted = async (where, shown) => {
+        for (let tried = 1;; tried += 1) {
+            const answered = await deps.slack.post(where.app.bot.token, { channel: where.channel, threadTs: where.threadTs, text: shown.text, buttons: shown.buttons });
+            if (answered.isOk) {
+                return answered.value.ts;
+            }
+            if (answered.error.kind !== 'rateLimited' || tried >= RATE_LIMITED_TRIES) {
+                return undefined;
+            }
+            await deps.sleep(answered.error.retryAfterSeconds * SECOND_MS, new AbortController().signal);
+        }
+    };
+    /**
+     * Posts a kept post not yet in Slack, then acknowledges it unless a link.
+     * A post not yet in Slack whose delivery the read did not hold is handed
+     * again with the same number, which counts nothing: still handed, it
+     * waits for a later read; acknowledged meanwhile, or undeliverable, it is
+     * forgotten. A post in Slack is acknowledged by core's ack alone, which
+     * takes a delivery acknowledged meanwhile as OK.
+     */
+    const finish = async ({ crewToken, post, delivery }) => {
+        let current = post;
+        if (current.ts === null) {
+            if (delivery === undefined) {
+                const handed = await deps.door.handed(crewToken, { deliveryId: post.deliveryId, handOverNumber: FIRST_HAND_OVER, channel: 'slack' });
+                if (!handed.isOk || handed.value === 'handed') {
+                    return 'waiting';
+                }
+                await deps.posts.remove(post.fleetId, post);
+                return 'notShown';
+            }
+            const app = await deps.apps.find(post.fleetId, post.appId);
+            const shown = slackPostOf(delivery, { overviewUrl: deps.overviewUrlOf(post.fleetId), isHeadedBySender: app?.shipId === null });
+            const ts = isInSlack(app) ? await posted({ app, channel: post.channel, threadTs: post.threadTs }, shown.kind === 'shown' ? shown : { text: shown.text, buttons: [] }) : undefined;
+            if (ts === undefined) {
+                await deps.posts.remove(post.fleetId, post);
+                return 'notShown';
+            }
+            current = { ...current, ts };
+            await deps.posts.save(current);
+        }
+        if (current.isLinkOnly || current.ackedAt !== null) {
+            return 'shown';
+        }
+        const acked = await deps.door.ack(crewToken, post.deliveryId);
+        if (!acked.isOk) {
+            return 'unacknowledged';
+        }
+        await deps.posts.save({ ...current, ackedAt: deps.clock.now() });
+        return 'shown';
+    };
+    return async (ship, { crewToken, fresh }) => {
+        const link = await deps.links.ofPersonShip(ship.fleetId, ship.shipId);
+        const shownIds = new Set();
+        let isAnyUnfinished = false;
+        if (link?.stoppedAt !== null) {
+            return ok({ shown: shownIds, isAnyUnfinished });
+        }
+        const unfinished = await deps.posts.unfinished(ship.fleetId, ship.shipId);
+        if (unfinished.length > 0) {
+            // A post not yet in Slack needs its delivery, handed already: read with the held ones again.
+            const held = await deps.door.pushReceive(crewToken, { max: unfinished.length + fresh.length });
+            if (!held.isOk) {
+                return held;
+            }
+            for (const post of unfinished) {
+                const { deliveryId } = post;
+                if (deliveryId !== null) {
+                    const finished = await finish({ crewToken, post: { ...post, deliveryId }, delivery: held.value.find((each) => each.deliveryId === deliveryId) });
+                    isAnyUnfinished ||= finished === 'unacknowledged' || finished === 'waiting';
+                }
+            }
+        }
+        for (const delivery of fresh) {
+            const where = await whereOf(link, delivery);
+            if (where === undefined) {
+                continue;
+            }
+            const shown = slackPostOf(delivery, { overviewUrl: deps.overviewUrlOf(ship.fleetId), isHeadedBySender: where.app.shipId === null });
+            const post = {
+                fleetId: ship.fleetId,
+                personShipId: ship.shipId,
+                messageId: delivery.messageId,
+                deliveryId: delivery.deliveryId,
+                senderShipId: delivery.senderShipId,
+                appId: where.app.appId,
+                channel: where.channel,
+                ts: null,
+                threadTs: where.threadTs,
+                isLinkOnly: shown.kind === 'link',
+                ackedAt: null,
+            };
+            // Kept before it is handed: a gateway that stops in between finishes it at the next wake.
+            await deps.posts.save(post);
+            const handed = await deps.door.handed(crewToken, { deliveryId: delivery.deliveryId, handOverNumber: FIRST_HAND_OVER, channel: 'slack' });
+            if (!handed.isOk || handed.value !== 'handed') {
+                await deps.posts.remove(ship.fleetId, post);
+                continue;
+            }
+            const finished = await finish({ crewToken, post: { ...post, deliveryId: delivery.deliveryId }, delivery });
+            if (finished === 'shown' || finished === 'unacknowledged') {
+                shownIds.add(delivery.deliveryId);
+            }
+            isAnyUnfinished ||= finished === 'unacknowledged';
+        }
+        return ok({ shown: shownIds, isAnyUnfinished });
+    };
+}
+//# sourceMappingURL=show-in-slack.js.map

package/dist/core/slack/show-in-slack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show-in-slack.js","sourceRoot":"","sources":["../../../src/core/slack/show-in-slack.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,EAAE,EAAe,MAAM,qBAAqB,CAAC;AAItD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,yEAAyE;AACzE,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB,wHAAwH;AACxH,MAAM,eAAe,GAAG,CAAC,CAAC;AAkB1B,SAAS,SAAS,CAAC,GAAyB;IAC1C,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,gBAAgB,KAAK,IAAI,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAAC,IASjC;IACC,MAAM,OAAO,GAAG,KAAK,EAAE,IAAe,EAAE,QAAwB,EAA8B,EAAE;QAC9F,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAClE,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;QACjJ,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3D,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnB,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC,EAAE,EAAE,CAAC;YAC3F,CAAC;QACH,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAC5D,CAAC;QACD,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClF,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACvG,CAAC,CAAC;IAEF,mGAAmG;IACnG,MAAM,MAAM,GAAG,KAAK,EAAE,KAAY,EAAE,KAAwD,EAA+B,EAAE;QAC3H,KAAK,IAAI,KAAK,GAAG,CAAC,GAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5J,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClB,OAAO,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,CAAC;YACD,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,KAAK,IAAI,kBAAkB,EAAE,CAAC;gBACzE,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,iBAAiB,GAAG,SAAS,EAAE,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC,CAAC;IAEF;;;;;;;OAOG;IACH,MAAM,MAAM,GAAG,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAA6G,EAAqB,EAAE;QACnL,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,OAAO,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;gBACrI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9C,OAAO,SAAS,CAAC;gBACnB,CAAC;gBACD,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC5C,OAAO,UAAU,CAAC;YACpB,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,EAAE,CAAC,CAAC;YAC/H,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClL,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC5C,OAAO,UAAU,CAAC;YACpB,CAAC;YACD,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACnD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAChB,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAc,CAAC;QACvC,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,IAAI,EAAE,SAAS,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,6FAA6F;YAC7F,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC/F,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;gBAC9B,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;gBAC5B,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;oBACxB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,EAAE,CAAC,CAAC;oBACjJ,eAAe,KAAK,QAAQ,KAAK,gBAAgB,IAAI,QAAQ,KAAK,SAAS,CAAC;gBAC9E,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACX,CAAC;YACD,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,EAAE,KAAK,CAAC,GAAG,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC,CAAC;YACpI,MAAM,IAAI,GAAc;gBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,YAAY,EAAE,IAAI,CAAC,MAAM;gBACzB,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,KAAK;gBACtB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,EAAE,EAAE,IAAI;gBACR,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,UAAU,EAAE,KAAK,CAAC,IAAI,KAAK,MAAM;gBACjC,OAAO,EAAE,IAAI;aACd,CAAC;YACF,0FAA0F;YAC1F,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACzI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9C,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAC5C,SAAS;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC3G,IAAI,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,gBAAgB,EAAE,CAAC;gBAC1D,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACpC,CAAC;YACD,eAAe,KAAK,QAAQ,KAAK,gBAAgB,CAAC;QACpD,CAAC;QACD,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;IAClD,CAAC,CAAC;AACJ,CAAC"}

package/dist/core/slack/slack-app.d.ts

@@ -0,0 +1,77 @@
+import type { FleetId, ShipId } from '@aeolus-fleet/common';
+/**
+ * A Slack app the gateway made from a manifest in a fleet's workspace, kept
+ * with what Slack gave for it: its client credentials and signing secret
+ * when made, its bot token once installed. The gateway's own bot is the
+ * fleet's first (B5).
+ */
+export interface SlackApp {
+    readonly fleetId: FleetId;
+    readonly appId: string;
+    /** The ship the app is the bot of; null for the gateway's own bot. */
+    readonly shipId: ShipId | null;
+    readonly clientId: string;
+    readonly clientSecret: string;
+    readonly signingSecret: string;
+    /** Slack's install screen for the app. */
+    readonly installUrl: string;
+    /** The bot's name in Slack, as the gateway last made or renamed it: the ship's name then, or the fleet's for its own bot. */
+    readonly name: string;
+    readonly madeAt: Date;
+    /** When someone last opened Slack's install screen for it from the gateway, while no install came back. */
+    readonly installStartedAt: Date | null;
+    readonly bot: {
+        readonly token: string;
+        readonly userId: string;
+    } | null;
+    /** When Slack said the app was uninstalled or its tokens revoked (app_uninstalled, tokens_revoked). */
+    readonly removedInSlackAt: Date | null;
+}
+/** A bot's state on the Slack page (gateway scopes 9.2). */
+export type BotState = 'made' | 'waitingForInstall' | 'inSlack' | 'removedInSlack';
+export declare function botStateOf(app: SlackApp): BotState;
+/** What the gateway asks Slack to make: the app's name and description, its bot's scopes, the user scopes Sign in with Slack asks, where Slack sends an install or a sign-in back, the events it sends the gateway and where, and where a press of a button goes. */
+export interface SlackAppDescription {
+    readonly name: string;
+    readonly description: string;
+    readonly botScopes: readonly string[];
+    readonly userScopes: readonly string[];
+    /** Where Slack sends an install back first, then any other address Slack may send the person back to. */
+    readonly redirectUrls: readonly string[];
+    readonly events: {
+        readonly url: string;
+        readonly botEvents: readonly string[];
+    };
+    readonly actionsUrl: string;
+}
+/** The gateway's addresses Slack calls: where an install comes back, where events and presses of buttons go, and where Sign in with Slack comes back to link. */
+export interface SlackAddresses {
+    readonly installRedirectUrl: string;
+    readonly eventsUrl: string;
+    readonly actionsUrl: string;
+    readonly linkRedirectUrl: string;
+}
+/** Sign in with Slack's user scopes (OpenID Connect): who signed in, in which workspace, and their name. */
+export declare const SIGN_IN_SCOPES: string[];
+/** Slack's longest app name. */
+export declare const APP_NAME_MAX_LENGTH = 35;
+/** Slack's longest app description. */
+export declare const APP_DESCRIPTION_MAX_LENGTH = 140;
+/**
+ * The gateway's own bot (B5), named after the fleet: it shows a person what
+ * waits for their person ship, in a direct message, where they answer in
+ * its thread or by a button (9.5). A person links their Slack account
+ * through its Sign in with Slack (gateway scopes 9.3).
+ */
+export declare function gatewayBotDescription(fleetName: string, addresses: SlackAddresses): SlackAppDescription;
+/**
+ * A ship's own bot (gateway scopes 9.2): the ship's name, its statement's
+ * summary as the description (0047), a direct messages tab, the events of a
+ * direct message and a mention, and the bot scopes to read them, post and
+ * react. Slack sends its uninstall and revoked tokens too, and a press of a
+ * button under a question it posted (9.5).
+ */
+export declare function shipBotDescription(ship: {
+    name: string;
+    summary: string | null;
+}, addresses: SlackAddresses): SlackAppDescription;

package/dist/core/slack/slack-app.js

@@ -0,0 +1,53 @@
+export function botStateOf(app) {
+    if (app.removedInSlackAt !== null) {
+        return 'removedInSlack';
+    }
+    if (app.bot !== null) {
+        return 'inSlack';
+    }
+    return app.installStartedAt === null ? 'made' : 'waitingForInstall';
+}
+/** The events every bot sends the gateway: its uninstall and revoked tokens (gateway scopes 9.2). */
+const REMOVAL_EVENTS = ['app_uninstalled', 'tokens_revoked'];
+/** Sign in with Slack's user scopes (OpenID Connect): who signed in, in which workspace, and their name. */
+export const SIGN_IN_SCOPES = ['openid', 'profile'];
+/** Slack's longest app name. */
+export const APP_NAME_MAX_LENGTH = 35;
+/** Slack's longest app description. */
+export const APP_DESCRIPTION_MAX_LENGTH = 140;
+/**
+ * The gateway's own bot (B5), named after the fleet: it shows a person what
+ * waits for their person ship, in a direct message, where they answer in
+ * its thread or by a button (9.5). A person links their Slack account
+ * through its Sign in with Slack (gateway scopes 9.3).
+ */
+export function gatewayBotDescription(fleetName, addresses) {
+    return {
+        name: fleetName.slice(0, APP_NAME_MAX_LENGTH),
+        description: `What waits for you in the ${fleetName} fleet of Aeolus`.slice(0, APP_DESCRIPTION_MAX_LENGTH),
+        botScopes: ['chat:write', 'im:history', 'im:write'],
+        userScopes: SIGN_IN_SCOPES,
+        redirectUrls: [addresses.installRedirectUrl, addresses.linkRedirectUrl],
+        events: { url: addresses.eventsUrl, botEvents: ['message.im', ...REMOVAL_EVENTS] },
+        actionsUrl: addresses.actionsUrl,
+    };
+}
+/**
+ * A ship's own bot (gateway scopes 9.2): the ship's name, its statement's
+ * summary as the description (0047), a direct messages tab, the events of a
+ * direct message and a mention, and the bot scopes to read them, post and
+ * react. Slack sends its uninstall and revoked tokens too, and a press of a
+ * button under a question it posted (9.5).
+ */
+export function shipBotDescription(ship, addresses) {
+    return {
+        name: ship.name.slice(0, APP_NAME_MAX_LENGTH),
+        description: (ship.summary ?? `The ${ship.name} ship of Aeolus`).slice(0, APP_DESCRIPTION_MAX_LENGTH),
+        botScopes: ['chat:write', 'im:history', 'app_mentions:read', 'reactions:write'],
+        userScopes: [],
+        redirectUrls: [addresses.installRedirectUrl],
+        events: { url: addresses.eventsUrl, botEvents: ['message.im', 'app_mention', ...REMOVAL_EVENTS] },
+        actionsUrl: addresses.actionsUrl,
+    };
+}
+//# sourceMappingURL=slack-app.js.map

package/dist/core/slack/slack-app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slack-app.js","sourceRoot":"","sources":["../../../src/core/slack/slack-app.ts"],"names":[],"mappings":"AA+BA,MAAM,UAAU,UAAU,CAAC,GAAa;IACtC,IAAI,GAAG,CAAC,gBAAgB,KAAK,IAAI,EAAE,CAAC;QAClC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC;AACtE,CAAC;AAsBD,qGAAqG;AACrG,MAAM,cAAc,GAAG,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;AAE7D,4GAA4G;AAC5G,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;AAEpD,gCAAgC;AAChC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAEtC,uCAAuC;AACvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,SAAiB,EAAE,SAAyB;IAChF,OAAO;QACL,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC;QAC7C,WAAW,EAAE,6BAA6B,SAAS,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,0BAA0B,CAAC;QAC1G,SAAS,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC;QACnD,UAAU,EAAE,cAAc;QAC1B,YAAY,EAAE,CAAC,SAAS,CAAC,kBAAkB,EAAE,SAAS,CAAC,eAAe,CAAC;QACvE,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,YAAY,EAAE,GAAG,cAAc,CAAC,EAAE;QAClF,UAAU,EAAE,SAAS,CAAC,UAAU;KACjC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAA8C,EAAE,SAAyB;IAC1G,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC;QAC7C,WAAW,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,0BAA0B,CAAC;QACrG,SAAS,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,iBAAiB,CAAC;QAC/E,UAAU,EAAE,EAAE;QACd,YAAY,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC;QAC5C,MAAM,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,cAAc,CAAC,EAAE;QACjG,UAAU,EAAE,SAAS,CAAC,UAAU;KACjC,CAAC;AACJ,CAAC"}

package/dist/core/slack/slack-event.d.ts

@@ -0,0 +1,51 @@
+/**
+ * An event Slack sends for one of the gateway's apps, as its door reads it:
+ * the event's type and the fields the gateway acts on, null where Slack
+ * sent none.
+ */
+export interface SlackEventFields {
+    /** Slack's id of the event, the same on each of its retries. */
+    readonly eventId: string;
+    readonly type: string;
+    /** The workspace the event is in. */
+    readonly teamId: string;
+    readonly userId: string | null;
+    readonly channel: string | null;
+    /** im for a direct message with the bot. */
+    readonly channelType: string | null;
+    /** Set on an edit, a deletion, a join and the like; file_share on a new message with files. */
+    readonly subtype: string | null;
+    /** Set on a bot's own message. */
+    readonly botId: string | null;
+    /** The message's text in Slack's markup. */
+    readonly text: string;
+    /** The message's own timestamp, its id in the conversation. */
+    readonly ts: string | null;
+    /** The thread's first message, when the message is in a thread. */
+    readonly threadTs: string | null;
+    /** The files shared with it, each by its name and its link in Slack. */
+    readonly files: readonly SlackFile[];
+}
+export interface SlackFile {
+    readonly name: string;
+    readonly permalink: string;
+}
+/** A person's new message to a bot: who wrote it, in which workspace, where, and what. */
+export interface PersonMessage {
+    readonly eventId: string;
+    readonly teamId: string;
+    readonly userId: string;
+    readonly channel: string;
+    readonly ts: string;
+    readonly threadTs: string | null;
+    readonly text: string;
+    readonly files: readonly SlackFile[];
+}
+/**
+ * The person's new message an event carries (gateway scopes 9.4 step 2): a
+ * direct message to the bot, or a mention of it in a channel. A bot's
+ * message (L21), an edit, a deletion or a join is none.
+ */
+export declare function personMessageOf(event: SlackEventFields): PersonMessage | undefined;
+/** Whether the event says the app is no longer in Slack (gateway scopes 9.2). */
+export declare function isRemovedEvent(event: SlackEventFields): boolean;

package/dist/core/slack/slack-event.js

@@ -0,0 +1,18 @@
+/** The subtype of a new message with files; any other subtype is no new message. */
+const FILE_SHARE = 'file_share';
+/**
+ * The person's new message an event carries (gateway scopes 9.4 step 2): a
+ * direct message to the bot, or a mention of it in a channel. A bot's
+ * message (L21), an edit, a deletion or a join is none.
+ */
+export function personMessageOf(event) {
+    const { eventId, type, teamId, userId, channel, channelType, subtype, botId, text, ts, threadTs, files } = event;
+    const isNew = (subtype === null || subtype === FILE_SHARE) && botId === null;
+    const isToBot = type === 'app_mention' || (type === 'message' && channelType === 'im');
+    return isNew && isToBot && userId !== null && channel !== null && ts !== null ? { eventId, teamId, userId, channel, ts, threadTs, text, files } : undefined;
+}
+/** Whether the event says the app is no longer in Slack (gateway scopes 9.2). */
+export function isRemovedEvent(event) {
+    return event.type === 'app_uninstalled' || event.type === 'tokens_revoked';
+}
+//# sourceMappingURL=slack-event.js.map

package/dist/core/slack/slack-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slack-event.js","sourceRoot":"","sources":["../../../src/core/slack/slack-event.ts"],"names":[],"mappings":"AA8CA,oFAAoF;AACpF,MAAM,UAAU,GAAG,YAAY,CAAC;AAEhC;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAAuB;IACrD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACjH,MAAM,KAAK,GAAG,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC;IAC7E,MAAM,OAAO,GAAG,IAAI,KAAK,aAAa,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,CAAC,CAAC;IACvF,OAAO,KAAK,IAAI,OAAO,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9J,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,cAAc,CAAC,KAAuB;IACpD,OAAO,KAAK,CAAC,IAAI,KAAK,iBAAiB,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC;AAC7E,CAAC"}

package/dist/core/slack/slack-link.d.ts

@@ -0,0 +1,20 @@
+import type { FleetId, ShipId } from '@aeolus-fleet/common';
+/**
+ * A person's Slack account linked to their account in a fleet (gateway
+ * scopes 9.3), kept by the fleet, the Slack workspace and user, and the
+ * person ship their messages are: one Slack user to one account per fleet,
+ * one Slack user per account. A disabled account's link stops (0055).
+ */
+export interface SlackLink {
+    readonly fleetId: FleetId;
+    readonly teamId: string;
+    readonly slackUserId: string;
+    /** The person's name in Slack as Sign in with Slack gave it. */
+    readonly slackName: string;
+    readonly accountId: string;
+    readonly personShipId: ShipId;
+    readonly linkedAt: Date;
+    readonly stoppedAt: Date | null;
+    /** Show everything that waits in Slack (B5): messages from ships that are not bots too, off until turned on (W8). */
+    readonly isShowingAll: boolean;
+}

package/dist/core/slack/slack-link.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=slack-link.js.map

package/dist/core/slack/slack-link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slack-link.js","sourceRoot":"","sources":["../../../src/core/slack/slack-link.ts"],"names":[],"mappings":""}