@amykit/plugin-slack 0.5.0

package/dist/config.js

@@ -0,0 +1,44 @@
+import { DEFAULT_RATE_LIMIT_RETRIES, DEFAULT_RETRY_AFTER_S } from "./SlackApi.js";
+import { DEFAULT_RETENTION_DAYS } from "./SlackConversation.js";
+/** What this plugin needs told to it, and nothing more. */
+export const configSchema = {
+    channel: {
+        type: "string",
+        required: true,
+        description: "the channel id every work thread opens in, such as C0XXXXXXX — an id, not a name",
+        example: "C0XXXXXXX",
+    },
+    token: {
+        type: "string",
+        required: true,
+        description: "where the bot token lives: `env:SLACK_BOT_TOKEN` or `file:<path>#<KEY>`, never the token itself",
+        example: "env:SLACK_BOT_TOKEN",
+    },
+    operator: {
+        type: "string",
+        required: true,
+        description: "the user id, such as U0XXXXXXX, whose replies are answers; everybody else's are ignored",
+        example: "U0XXXXXXX",
+    },
+    maxRateLimitRetries: {
+        type: "number",
+        description: "how many times a call Slack rate limits (HTTP 429) is waited out and tried again before it fails",
+        default: DEFAULT_RATE_LIMIT_RETRIES,
+    },
+    defaultRetryAfterSeconds: {
+        type: "number",
+        description: "how long to wait after a 429 that carries no Retry-After; one names its own wait, and that wins",
+        default: DEFAULT_RETRY_AFTER_S,
+    },
+    directory: {
+        type: "string",
+        description: "where each work item's thread is remembered, relative to the state directory",
+        default: "slack",
+    },
+    retentionDays: {
+        type: "number",
+        description: "days a downloaded file or a thread's memory stays unused before it is pruned, 0 to keep everything. A pruned file is fetched again when its reply is read; a pruned thread means the next question opens a new one",
+        default: DEFAULT_RETENTION_DAYS,
+    },
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,2DAA2D;AAC3D,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,kFAAkF;QAC/F,OAAO,EAAE,WAAW;KACrB;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,iGAAiG;QAC9G,OAAO,EAAE,qBAAqB;KAC/B;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,yFAAyF;QACtG,OAAO,EAAE,WAAW;KACrB;IACD,mBAAmB,EAAE;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kGAAkG;QAC/G,OAAO,EAAE,0BAA0B;KACpC;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,iGAAiG;QAC9G,OAAO,EAAE,qBAAqB;KAC/B;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8EAA8E;QAC3F,OAAO,EAAE,OAAO;KACjB;IACD,aAAa,EAAE;QACb,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,oNAAoN;QACtN,OAAO,EAAE,sBAAsB;KAChC;CACF,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { plugin } from "./plugin.js";
+export { configSchema } from "./config.js";
+export { DEFAULT_RETENTION_DAYS, SlackConversation } from "./SlackConversation.js";
+export type { SlackCheck, SlackConversationOptions } from "./SlackConversation.js";
+export { DEFAULT_RATE_LIMIT_RETRIES, DEFAULT_RETRY_AFTER_S, SLACK_API, SlackApi, TooLarge, fetchTransport } from "./SlackApi.js";
+export type { HttpRequest, HttpResponse, HttpTransport, SlackAnswer, SlackApiOptions } from "./SlackApi.js";
+export { resolveToken } from "./secret.js";
+export type { SecretSources } from "./secret.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACnF,YAAY,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACjI,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC5G,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export { plugin } from "./plugin.js";
+export { configSchema } from "./config.js";
+export { DEFAULT_RETENTION_DAYS, SlackConversation } from "./SlackConversation.js";
+export { DEFAULT_RATE_LIMIT_RETRIES, DEFAULT_RETRY_AFTER_S, SLACK_API, SlackApi, TooLarge, fetchTransport } from "./SlackApi.js";
+export { resolveToken } from "./secret.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEnF,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEjI,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from "@amykit/core";
+export declare const plugin: Plugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAMtC,eAAO,MAAM,MAAM,EAAE,MAyCpB,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,43 @@
+import path from "node:path";
+import { configSchema } from "./config.js";
+import { resolveToken } from "./secret.js";
+import { DEFAULT_RATE_LIMIT_RETRIES, DEFAULT_RETRY_AFTER_S, SlackApi } from "./SlackApi.js";
+import { DEFAULT_RETENTION_DAYS, SlackConversation } from "./SlackConversation.js";
+export const plugin = {
+    name: "@amykit/plugin-slack",
+    version: "0.1.0",
+    configSchema,
+    register(registry, ctx) {
+        const channel = ctx.config.channel;
+        const operator = ctx.config.operator;
+        // Refused at mount, naming the setting: a name where an id belongs is a
+        // thread posted nowhere, found only by waiting for an answer.
+        if (!/^[CG][A-Z0-9]+$/.test(channel)) {
+            throw new Error(`@amykit/plugin-slack: \`channel\` must be a channel id such as C0XXXXXXX, got ${channel}`);
+        }
+        if (!/^[UW][A-Z0-9]+$/.test(operator)) {
+            throw new Error(`@amykit/plugin-slack: \`operator\` must be a user id such as U0XXXXXXX, got ${operator}`);
+        }
+        // The host applies the schema's defaults; a caller that did not still mounts the same thing.
+        const retries = ctx.config.maxRateLimitRetries ?? DEFAULT_RATE_LIMIT_RETRIES;
+        const fallback = ctx.config.defaultRetryAfterSeconds ?? DEFAULT_RETRY_AFTER_S;
+        const retentionDays = ctx.config.retentionDays ?? DEFAULT_RETENTION_DAYS;
+        for (const [name, value] of Object.entries({ maxRateLimitRetries: retries, defaultRetryAfterSeconds: fallback, retentionDays })) {
+            if (!Number.isFinite(value) || value < 0) {
+                throw new Error(`@amykit/plugin-slack: \`${name}\` must be zero or more, got ${value}`);
+            }
+        }
+        const api = new SlackApi(resolveToken(ctx.config.token), {
+            maxRateLimitRetries: Math.floor(retries),
+            defaultRetryAfterSeconds: fallback,
+        });
+        registry.port("conversation", new SlackConversation(api, {
+            channel,
+            operator,
+            directory: path.join(ctx.paths.state, ctx.config.directory ?? "slack"),
+            retentionDays,
+            now: ctx.now,
+        }));
+    },
+};
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC5F,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEnF,MAAM,CAAC,MAAM,MAAM,GAAW;IAC5B,IAAI,EAAE,sBAAsB;IAC5B,OAAO,EAAE,OAAO;IAChB,YAAY;IACZ,QAAQ,CAAC,QAAQ,EAAE,GAAG;QACpB,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,OAAiB,CAAC;QAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAkB,CAAC;QAC/C,wEAAwE;QACxE,8DAA8D;QAC9D,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,iFAAiF,OAAO,EAAE,CAAC,CAAC;QAC9G,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,+EAA+E,QAAQ,EAAE,CAAC,CAAC;QAC7G,CAAC;QAED,6FAA6F;QAC7F,MAAM,OAAO,GAAI,GAAG,CAAC,MAAM,CAAC,mBAA0C,IAAI,0BAA0B,CAAC;QACrG,MAAM,QAAQ,GAAI,GAAG,CAAC,MAAM,CAAC,wBAA+C,IAAI,qBAAqB,CAAC;QACtG,MAAM,aAAa,GAAI,GAAG,CAAC,MAAM,CAAC,aAAoC,IAAI,sBAAsB,CAAC;QACjG,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,mBAAmB,EAAE,OAAO,EAAE,wBAAwB,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;YAChI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,gCAAgC,KAAK,EAAE,CAAC,CAAC;YAC1F,CAAC;QACH,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,KAAe,CAAC,EAAE;YACjE,mBAAmB,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YACxC,wBAAwB,EAAE,QAAQ;SACnC,CAAC,CAAC;QACH,QAAQ,CAAC,IAAI,CACX,cAAc,EACd,IAAI,iBAAiB,CAAC,GAAG,EAAE;YACzB,OAAO;YACP,QAAQ;YACR,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAG,GAAG,CAAC,MAAM,CAAC,SAAgC,IAAI,OAAO,CAAC;YAC9F,aAAa;YACb,GAAG,EAAE,GAAG,CAAC,GAAG;SACb,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/secret.d.ts

@@ -0,0 +1,13 @@
+export interface SecretSources {
+    env: NodeJS.ProcessEnv;
+    readFile: (file: string) => string;
+}
+/**
+ * The bot token, from where the config says it lives.
+ *
+ * `env:<NAME>` or `file:<path>#<KEY>`, and nothing else. A token written into
+ * `config.yaml` itself is refused rather than used, because that file is the
+ * one people paste into an issue when something breaks.
+ */
+export declare function resolveToken(ref: string, sources?: SecretSources): string;
+//# sourceMappingURL=secret.d.ts.map

package/dist/secret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret.d.ts","sourceRoot":"","sources":["../src/secret.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC;IACvB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC;AAOD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,aAAyB,GAAG,MAAM,CAsBpF"}

package/dist/secret.js

@@ -0,0 +1,56 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+const FROM_DISK = {
+    env: process.env,
+    readFile: (file) => fs.readFileSync(file, "utf8"),
+};
+/**
+ * The bot token, from where the config says it lives.
+ *
+ * `env:<NAME>` or `file:<path>#<KEY>`, and nothing else. A token written into
+ * `config.yaml` itself is refused rather than used, because that file is the
+ * one people paste into an issue when something breaks.
+ */
+export function resolveToken(ref, sources = FROM_DISK) {
+    if (ref.startsWith("env:")) {
+        const name = ref.slice("env:".length);
+        const value = sources.env[name];
+        if (!value)
+            throw new Error(`@amykit/plugin-slack: \`token\` names ${name}, which is not set`);
+        return value;
+    }
+    if (ref.startsWith("file:")) {
+        const [file = "", key = ""] = ref.slice("file:".length).split("#");
+        if (!file || !key) {
+            throw new Error("@amykit/plugin-slack: `token` must be `file:<path>#<KEY>`, naming the key inside the file");
+        }
+        const value = keyIn(sources.readFile(expandHome(file)), key);
+        if (!value)
+            throw new Error(`@amykit/plugin-slack: ${file} has no ${key}`);
+        return value;
+    }
+    throw new Error("@amykit/plugin-slack: `token` must say where the token lives — `env:SLACK_BOT_TOKEN` or " +
+        "`file:<path>#<KEY>` — and is never written into the config itself");
+}
+/** One `KEY=value` line of a dotenv-shaped file, quotes stripped. */
+function keyIn(text, key) {
+    for (const line of text.split(/\r?\n/)) {
+        const equals = line.indexOf("=");
+        if (equals === -1)
+            continue;
+        const name = line.slice(0, equals).trim().replace(/^export\s+/, "");
+        if (name !== key)
+            continue;
+        return unquote(line.slice(equals + 1).trim());
+    }
+    return undefined;
+}
+function unquote(value) {
+    const quote = value[0];
+    return (quote === '"' || quote === "'") && value.length > 1 && value.endsWith(quote) ? value.slice(1, -1) : value;
+}
+function expandHome(file) {
+    return file === "~" || file.startsWith("~/") ? path.join(os.homedir(), file.slice(1)) : file;
+}
+//# sourceMappingURL=secret.js.map

package/dist/secret.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret.js","sourceRoot":"","sources":["../src/secret.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAO7B,MAAM,SAAS,GAAkB;IAC/B,GAAG,EAAE,OAAO,CAAC,GAAG;IAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;CAClD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,UAAyB,SAAS;IAC1E,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,oBAAoB,CAAC,CAAC;QAC/F,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;QAC/G,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,WAAW,GAAG,EAAE,CAAC,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,KAAK,CACb,0FAA0F;QACxF,mEAAmE,CACtE,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,SAAS,KAAK,CAAC,IAAY,EAAE,GAAW;IACtC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,CAAC,CAAC;YAAE,SAAS;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACpE,IAAI,IAAI,KAAK,GAAG;YAAE,SAAS;QAC3B,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CAAC,KAAa;IAC5B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,OAAO,CAAC,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACpH,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI,KAAK,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/F,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@amykit/plugin-slack",
+  "version": "0.5.0",
+  "description": "A Slack thread per piece of work, over the Web API, as the conversation port.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Nicolas Melo",
+  "homepage": "https://github.com/nicolasmelo1/amy#readme",
+  "bugs": "https://github.com/nicolasmelo1/amy/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nicolasmelo1/amy.git",
+    "directory": "plugins/slack"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@amykit/core": "^0.5.0"
+  },
+  "devDependencies": {
+    "@amykit/test-fixtures": "^0.1.0"
+  }
+}