@owlmeans/bot-slack 0.0.0-stage → 0.2.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +74 -2
  2. package/agent-meta/manifest.json +16 -0
  3. package/agent-meta/skills/bot-slack/SKILL.md +117 -0
  4. package/build/api.d.ts +7 -0
  5. package/build/api.d.ts.map +1 -0
  6. package/build/api.js +65 -0
  7. package/build/api.js.map +1 -0
  8. package/build/append.d.ts +9 -0
  9. package/build/append.d.ts.map +1 -0
  10. package/build/append.js +13 -0
  11. package/build/append.js.map +1 -0
  12. package/build/consts.d.ts +70 -0
  13. package/build/consts.d.ts.map +1 -0
  14. package/build/consts.js +205 -0
  15. package/build/consts.js.map +1 -0
  16. package/build/errors.d.ts +22 -0
  17. package/build/errors.d.ts.map +1 -0
  18. package/build/errors.js +35 -0
  19. package/build/errors.js.map +1 -0
  20. package/build/index.d.ts +8 -0
  21. package/build/index.d.ts.map +1 -0
  22. package/build/index.js +7 -0
  23. package/build/index.js.map +1 -0
  24. package/build/mock.d.ts +10 -0
  25. package/build/mock.d.ts.map +1 -0
  26. package/build/mock.js +253 -0
  27. package/build/mock.js.map +1 -0
  28. package/build/normalize.d.ts +4 -0
  29. package/build/normalize.d.ts.map +1 -0
  30. package/build/normalize.js +131 -0
  31. package/build/normalize.js.map +1 -0
  32. package/build/plugin.d.ts +11 -0
  33. package/build/plugin.d.ts.map +1 -0
  34. package/build/plugin.js +165 -0
  35. package/build/plugin.js.map +1 -0
  36. package/build/signature.d.ts +8 -0
  37. package/build/signature.d.ts.map +1 -0
  38. package/build/signature.js +25 -0
  39. package/build/signature.js.map +1 -0
  40. package/build/text.d.ts +9 -0
  41. package/build/text.d.ts.map +1 -0
  42. package/build/text.js +12 -0
  43. package/build/text.js.map +1 -0
  44. package/build/types.d.ts +185 -0
  45. package/build/types.d.ts.map +1 -0
  46. package/build/types.js +2 -0
  47. package/build/types.js.map +1 -0
  48. package/package.json +56 -4
  49. package/src/api.ts +70 -0
  50. package/src/append.ts +18 -0
  51. package/src/consts.ts +231 -0
  52. package/src/errors.ts +38 -0
  53. package/src/index.ts +7 -0
  54. package/src/mock.ts +287 -0
  55. package/src/normalize.ts +157 -0
  56. package/src/plugin.ts +191 -0
  57. package/src/signature.ts +33 -0
  58. package/src/text.ts +16 -0
  59. package/src/types.ts +207 -0
  60. package/tests/context.ts +85 -0
  61. package/tests/descriptor.spec.ts +64 -0
  62. package/tests/mock-ids.spec.ts +36 -0
  63. package/tests/slack-runtime.spec.ts +210 -0
  64. package/tests/slack.spec.ts +420 -0
  65. package/tests/tsconfig.json +12 -0
  66. package/tsconfig.json +16 -0
@@ -0,0 +1,165 @@
1
+ import { BotActionKind, BotCredentialsRejected, BotTransport, BotUnsupportedAction, } from '@owlmeans/bot';
2
+ import { botHookHelper } from '@owlmeans/server-bot';
3
+ import { makeSlackApi } from './api.js';
4
+ import { SLACK_API_BASE, SLACK_CREDENTIAL_ERRORS, SLACK_DESCRIPTOR, SLACK_EMOJI_NAMES, SLACK_PLATFORM, SLACK_RATE_LIMIT_MAX_WAIT_S, SLACK_RATE_LIMIT_RETRIES, SLACK_SETUP_CREDENTIALS_STEP, SLACK_SETUP_HOOK_PENDING_STEP, SLACK_SETUP_HOOK_STEP, SLACK_SETUP_TAIL_STEPS, SLACK_SIGNATURE_HEADER, SLACK_TEXT_MAX, SLACK_TIMESTAMP_HEADER, } from './consts.js';
5
+ import { SlackApiError } from './errors.js';
6
+ import { makeSlackMock } from './mock.js';
7
+ import { slackNormalizer } from './normalize.js';
8
+ import { slackSignatureHelper } from './signature.js';
9
+ import { slackTextHelper } from './text.js';
10
+ /**
11
+ * The Slack plugin over the Events API and the Web API (https://docs.slack.dev/apis/): `auth.test`
12
+ * verifies, a person pastes the Request URL (manual setup), every hook request is checked against
13
+ * the signing secret, and `chat.postMessage` / `chat.delete` / `reactions.add` act. A reply goes
14
+ * into the message's thread; `delete` uses the admin `userToken`.
15
+ */
16
+ export const makeSlackBotPlatform = (opts = {}) => {
17
+ const base = (opts.base ?? SLACK_API_BASE).replace(/\/+$/, '');
18
+ const retry = { retries: opts.retries ?? SLACK_RATE_LIMIT_RETRIES, maxRetryWaitS: opts.maxRetryWaitS ?? SLACK_RATE_LIMIT_MAX_WAIT_S };
19
+ const mock = makeSlackMock();
20
+ const api = (session) => makeSlackApi(session, base, retry);
21
+ /** Clipped to the text limit without splitting a surrogate pair. */
22
+ const clip = (text) => {
23
+ if (text.length <= SLACK_TEXT_MAX) {
24
+ return text;
25
+ }
26
+ const cut = text.slice(0, SLACK_TEXT_MAX - 1);
27
+ return `${/[\uD800-\uDBFF]$/.test(cut) ? cut.slice(0, -1) : cut}…`;
28
+ };
29
+ /** `:thumbsup:` → `thumbsup`; a mapped Unicode emoji → its name; anything else as given. */
30
+ const emojiName = (emoji) => {
31
+ const trimmed = emoji.trim();
32
+ const bare = trimmed.replace(/️/g, '');
33
+ return SLACK_EMOJI_NAMES[bare] ?? trimmed.replace(/^:+|:+$/g, '');
34
+ };
35
+ /** A credential refusal of `auth.test` as `BotCredentialsRejected`, anything else as it is. */
36
+ const authTest = async (session, token, label) => {
37
+ try {
38
+ return await api(session).call('auth.test', {}, token != null ? { token } : {});
39
+ }
40
+ catch (error) {
41
+ if (error instanceof SlackApiError && SLACK_CREDENTIAL_ERRORS.includes(error.code)) {
42
+ throw new BotCredentialsRejected(`slack:${label}${error.code}`);
43
+ }
44
+ throw error;
45
+ }
46
+ };
47
+ const verify = async (session) => {
48
+ const credentials = session.connection.credentials;
49
+ if (session.transport === BotTransport.Live) {
50
+ const missing = ['botToken', 'signingSecret'].filter(key => (credentials[key] ?? '') === '');
51
+ if (missing.length > 0) {
52
+ throw new BotCredentialsRejected(`missing:${missing.join(',')}`);
53
+ }
54
+ }
55
+ const bot = await authTest(session, undefined, '');
56
+ if (bot.bot_id == null || bot.bot_id === '') {
57
+ throw new BotCredentialsRejected('slack:botToken-not-a-bot-token');
58
+ }
59
+ const userToken = credentials.userToken ?? '';
60
+ if (userToken !== '') {
61
+ const admin = await authTest(session, userToken, 'userToken:');
62
+ if (admin.bot_id != null && admin.bot_id !== '') {
63
+ throw new BotCredentialsRejected('slack:userToken-not-a-user-token');
64
+ }
65
+ if (admin.team_id !== bot.team_id) {
66
+ throw new BotCredentialsRejected('slack:userToken-another-workspace');
67
+ }
68
+ }
69
+ const id = bot.user_id ?? bot.bot_id;
70
+ return { id, ...(bot.user != null ? { username: bot.user } : {}), ...(bot.team != null ? { name: bot.team } : {}) };
71
+ };
72
+ const setup = (connection) => [
73
+ SLACK_SETUP_CREDENTIALS_STEP,
74
+ connection.hookUrl != null && connection.hookUrl !== '' ? `${SLACK_SETUP_HOOK_STEP}${connection.hookUrl}` : SLACK_SETUP_HOOK_PENDING_STEP,
75
+ ...SLACK_SETUP_TAIL_STEPS,
76
+ ];
77
+ /**
78
+ * The signature over the raw body with the signing secret (a MOCK connection also accepts its hook
79
+ * secret — what the mock signs with when it has no signing secret), a fresh timestamp, and only
80
+ * then the `url_verification` handshake.
81
+ */
82
+ const authenticate = (request, connection) => {
83
+ if (request.method.toUpperCase() !== 'POST') {
84
+ return { result: 'reject', reason: 'method' };
85
+ }
86
+ const timestamp = botHookHelper.header(request, SLACK_TIMESTAMP_HEADER);
87
+ if (!slackSignatureHelper.fresh(timestamp, Date.now())) {
88
+ return { result: 'reject', reason: 'stale-timestamp' };
89
+ }
90
+ const secrets = [
91
+ connection.credentials.signingSecret ?? '',
92
+ ...(connection.transport === BotTransport.Mock ? [connection.hookSecret] : []),
93
+ ].filter(secret => secret !== '');
94
+ if (secrets.length === 0) {
95
+ return { result: 'reject', reason: 'no-signing-secret' };
96
+ }
97
+ const signature = botHookHelper.header(request, SLACK_SIGNATURE_HEADER);
98
+ if (!slackSignatureHelper.matches(signature, timestamp, botHookHelper.rawText(request), secrets)) {
99
+ return { result: 'reject', reason: 'signature' };
100
+ }
101
+ const payload = botHookHelper.json(request);
102
+ if (payload != null && payload.type === 'url_verification') {
103
+ return typeof payload.challenge === 'string'
104
+ ? { result: 'challenge', reply: { challenge: payload.challenge } }
105
+ : { result: 'reject', reason: 'challenge' };
106
+ }
107
+ return { result: 'ok' };
108
+ };
109
+ const refOf = (posted, chat, thread, space) => ({
110
+ chat: posted.channel ?? chat,
111
+ id: posted.ts ?? '',
112
+ ...(thread != null && thread !== '' ? { thread } : {}),
113
+ ...(space != null ? { space } : {}),
114
+ });
115
+ const act = async (session, action) => {
116
+ const client = api(session);
117
+ switch (action.kind) {
118
+ case BotActionKind.Reply: {
119
+ // Slack threads hang off the parent: a reply inside a thread names the thread, else the message.
120
+ const thread = action.to.thread ?? action.to.id;
121
+ const posted = await client.call('chat.postMessage', {
122
+ channel: action.to.chat, text: slackTextHelper.encode(clip(action.text)), thread_ts: thread,
123
+ });
124
+ return { message: refOf(posted, action.to.chat, thread, action.to.space) };
125
+ }
126
+ case BotActionKind.Send: {
127
+ const thread = action.chat.thread;
128
+ const posted = await client.call('chat.postMessage', {
129
+ channel: action.chat.id, text: slackTextHelper.encode(clip(action.text)), ...(thread != null && thread !== '' ? { thread_ts: thread } : {}),
130
+ });
131
+ return { message: refOf(posted, action.chat.id, thread, action.chat.space) };
132
+ }
133
+ case BotActionKind.Delete: {
134
+ // A bot token deletes only the bot's own posts: a member's message needs an admin's user token.
135
+ const token = session.connection.credentials.userToken ?? '';
136
+ if (token === '') {
137
+ throw new BotUnsupportedAction(BotActionKind.Delete);
138
+ }
139
+ await client.call('chat.delete', { channel: action.message.chat, ts: action.message.id }, { token });
140
+ return {};
141
+ }
142
+ case BotActionKind.React:
143
+ await client.call('reactions.add', {
144
+ channel: action.message.chat, timestamp: action.message.id, name: emojiName(action.emoji),
145
+ });
146
+ return {};
147
+ case BotActionKind.Mute:
148
+ case BotActionKind.Ban:
149
+ throw new BotUnsupportedAction(action.kind);
150
+ }
151
+ };
152
+ return {
153
+ platform: SLACK_PLATFORM,
154
+ descriptor: SLACK_DESCRIPTOR,
155
+ verify,
156
+ setup,
157
+ authenticate,
158
+ normalize: slackNormalizer.normalize,
159
+ act,
160
+ mock,
161
+ };
162
+ };
163
+ /** The built-in instance (`https://slack.com/api`) — its `mock` is the one simulated connections use. */
164
+ export const slackBotPlatform = makeSlackBotPlatform();
165
+ //# sourceMappingURL=plugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAAE,sBAAsB,EAAE,YAAY,EAAE,oBAAoB,GAE1E,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAKpD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EACL,cAAc,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,cAAc,EAC5F,2BAA2B,EAAE,wBAAwB,EAAE,4BAA4B,EACnF,6BAA6B,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,sBAAsB,EACpG,cAAc,EAAE,sBAAsB,GACvC,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAG3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAI,GAA4B,EAAE,EAAoB,EAAE;IAC3F,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,cAAc,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAC9D,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,wBAAwB,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,2BAA2B,EAAE,CAAA;IACrI,MAAM,IAAI,GAAG,aAAa,EAAE,CAAA;IAC5B,MAAM,GAAG,GAAG,CAAC,OAA2B,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAE/E,oEAAoE;IACpE,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE;QACpC,IAAI,IAAI,CAAC,MAAM,IAAI,cAAc,EAAE,CAAC;YAClC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC,CAAA;QAE7C,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAA;IACpE,CAAC,CAAA;IAED,4FAA4F;IAC5F,MAAM,SAAS,GAAG,CAAC,KAAa,EAAU,EAAE;QAC1C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;QAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAEtC,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;IACnE,CAAC,CAAA;IAED,+FAA+F;IAC/F,MAAM,QAAQ,GAAG,KAAK,EAAE,OAA2B,EAAE,KAAyB,EAAE,KAAa,EAA0B,EAAE;QACvH,IAAI,CAAC;YACH,OAAO,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAgB,WAAW,EAAE,EAAE,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QAChG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,aAAa,IAAI,uBAAuB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnF,MAAM,IAAI,sBAAsB,CAAC,SAAS,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;YACjE,CAAC;YACD,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,KAAK,EAAE,OAA2B,EAAgC,EAAE;QACjF,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAA;QAClD,IAAI,OAAO,CAAC,SAAS,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,CAAA;YAC5F,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,sBAAsB,CAAC,WAAW,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAClE,CAAC;QACH,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAA;QAClD,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,sBAAsB,CAAC,gCAAgC,CAAC,CAAA;QACpE,CAAC;QACD,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,IAAI,EAAE,CAAA;QAC7C,IAAI,SAAS,KAAK,EAAE,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC,CAAA;YAC9D,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAChD,MAAM,IAAI,sBAAsB,CAAC,kCAAkC,CAAC,CAAA;YACtE,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;gBAClC,MAAM,IAAI,sBAAsB,CAAC,mCAAmC,CAAC,CAAA;YACvE,CAAC;QACH,CAAC;QACD,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,MAAM,CAAA;QAEpC,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAA;IACrH,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,UAAiC,EAAY,EAAE,CAAC;QAC7D,4BAA4B;QAC5B,UAAU,CAAC,OAAO,IAAI,IAAI,IAAI,UAAU,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,qBAAqB,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,6BAA6B;QACzI,GAAG,sBAAsB;KAC1B,CAAA;IAED;;;;OAIG;IACH,MAAM,YAAY,GAAsC,CAAC,OAAO,EAAE,UAAU,EAAqB,EAAE;QACjG,IAAI,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YAC5C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;QAC/C,CAAC;QACD,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAA;QACvE,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;YACvD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;QACxD,CAAC;QACD,MAAM,OAAO,GAAG;YACd,UAAU,CAAC,WAAW,CAAC,aAAa,IAAI,EAAE;YAC1C,GAAG,CAAC,UAAU,CAAC,SAAS,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/E,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,CAAA;QACjC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAA;QAC1D,CAAC;QACD,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAA;QACvE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,SAAS,EAAE,SAAU,EAAE,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;YAClG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;QAClD,CAAC;QACD,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAmD,CAAA;QAC7F,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YAC3D,OAAO,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;gBAC1C,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE;gBAClE,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;QAC/C,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;IACzB,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,MAAmB,EAAE,IAAY,EAAE,MAAe,EAAE,KAAc,EAAiB,EAAE,CAAC,CAAC;QACpG,IAAI,EAAE,MAAM,CAAC,OAAO,IAAI,IAAI;QAC5B,EAAE,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE;QACnB,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpC,CAAC,CAAA;IAEF,MAAM,GAAG,GAAG,KAAK,EAAE,OAA2B,EAAE,MAAyB,EAAoC,EAAE;QAC7G,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,CAAA;QAC3B,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,aAAa,CAAC,KAAK,EAAE,CAAC;gBACzB,iGAAiG;gBACjG,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAA;gBAC/C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAc,kBAAkB,EAAE;oBAChE,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM;iBAC5F,CAAC,CAAA;gBACF,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAA;YAC5E,CAAC;YACD,KAAK,aAAa,CAAC,IAAI,EAAE,CAAC;gBACxB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAA;gBACjC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAc,kBAAkB,EAAE;oBAChE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC5I,CAAC,CAAA;gBACF,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAA;YAC9E,CAAC;YACD,KAAK,aAAa,CAAC,MAAM,EAAE,CAAC;gBAC1B,gGAAgG;gBAChG,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,SAAS,IAAI,EAAE,CAAA;gBAC5D,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;oBACjB,MAAM,IAAI,oBAAoB,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;gBACtD,CAAC;gBACD,MAAM,MAAM,CAAC,IAAI,CAAc,aAAa,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;gBACjH,OAAO,EAAE,CAAA;YACX,CAAC;YACD,KAAK,aAAa,CAAC,KAAK;gBACtB,MAAM,MAAM,CAAC,IAAI,CAAc,eAAe,EAAE;oBAC9C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;iBAC1F,CAAC,CAAA;gBACF,OAAO,EAAE,CAAA;YACX,KAAK,aAAa,CAAC,IAAI,CAAC;YACxB,KAAK,aAAa,CAAC,GAAG;gBACpB,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC,CAAA;IAED,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,UAAU,EAAE,gBAAgB;QAC5B,MAAM;QACN,KAAK;QACL,YAAY;QACZ,SAAS,EAAE,eAAe,CAAC,SAAS;QACpC,GAAG;QACH,IAAI;KACL,CAAA;AACH,CAAC,CAAA;AAED,yGAAyG;AACzG,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE,CAAA"}
@@ -0,0 +1,8 @@
1
+ import type { SlackSignatureHelper } from './types.js';
2
+ /**
3
+ * Slack's request signing (https://docs.slack.dev/authentication/verifying-requests-from-slack):
4
+ * the secret is used as UTF-8 text, the basestring is `v0:<timestamp>:<raw body>`.
5
+ */
6
+ export declare const createSlackSignatureHelper: () => SlackSignatureHelper;
7
+ export declare const slackSignatureHelper: SlackSignatureHelper;
8
+ //# sourceMappingURL=signature.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../src/signature.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEtD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,QAAO,oBAqB7C,CAAA;AAED,eAAO,MAAM,oBAAoB,sBAA+B,CAAA"}
@@ -0,0 +1,25 @@
1
+ import { createHmac } from 'node:crypto';
2
+ import { botHookHelper } from '@owlmeans/server-bot';
3
+ import { SLACK_SIGNATURE_TOLERANCE_S, SLACK_SIGNATURE_VERSION } from './consts.js';
4
+ /**
5
+ * Slack's request signing (https://docs.slack.dev/authentication/verifying-requests-from-slack):
6
+ * the secret is used as UTF-8 text, the basestring is `v0:<timestamp>:<raw body>`.
7
+ */
8
+ export const createSlackSignatureHelper = () => {
9
+ const sign = (secret, timestamp, body) => `${SLACK_SIGNATURE_VERSION}=${createHmac('sha256', secret).update(`${SLACK_SIGNATURE_VERSION}:${timestamp}:${body}`).digest('hex')}`;
10
+ const matches = (signature, timestamp, body, secrets) => {
11
+ let matched = false;
12
+ // Every secret is compared, matched or not: the time taken says nothing about which one.
13
+ for (const secret of secrets) {
14
+ if (secret !== '' && botHookHelper.sameSecret(signature, sign(secret, timestamp, body))) {
15
+ matched = true;
16
+ }
17
+ }
18
+ return matched;
19
+ };
20
+ const fresh = (timestamp, nowMs) => timestamp != null && /^\d{1,12}$/.test(timestamp)
21
+ && Math.abs(nowMs / 1000 - Number(timestamp)) <= SLACK_SIGNATURE_TOLERANCE_S;
22
+ return { sign, matches, fresh };
23
+ };
24
+ export const slackSignatureHelper = createSlackSignatureHelper();
25
+ //# sourceMappingURL=signature.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"signature.js","sourceRoot":"","sources":["../src/signature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACpD,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAGlF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,GAAyB,EAAE;IACnE,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,SAAiB,EAAE,IAAY,EAAU,EAAE,CACvE,GAAG,uBAAuB,IAAI,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,uBAAuB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAA;IAEtI,MAAM,OAAO,GAAG,CAAC,SAA6B,EAAE,SAAiB,EAAE,IAAY,EAAE,OAA0B,EAAW,EAAE;QACtH,IAAI,OAAO,GAAG,KAAK,CAAA;QACnB,yFAAyF;QACzF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,IAAI,MAAM,KAAK,EAAE,IAAI,aAAa,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACxF,OAAO,GAAG,IAAI,CAAA;YAChB,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,SAA6B,EAAE,KAAa,EAAW,EAAE,CACtE,SAAS,IAAI,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC;WAC9C,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,2BAA2B,CAAA;IAE9E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;AACjC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,0BAA0B,EAAE,CAAA"}
@@ -0,0 +1,9 @@
1
+ import type { SlackTextHelper } from './types.js';
2
+ /**
3
+ * Slack escapes `&`, `<` and `>` in message text (https://docs.slack.dev/messaging/formatting-message-text/):
4
+ * an inbound text is decoded so handlers match what people read; an outbound text is encoded so the
5
+ * contract's plain text stays literal (no accidental links or mentions).
6
+ */
7
+ export declare const createSlackTextHelper: () => SlackTextHelper;
8
+ export declare const slackTextHelper: SlackTextHelper;
9
+ //# sourceMappingURL=text.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,QAAO,eAMxC,CAAA;AAED,eAAO,MAAM,eAAe,iBAA0B,CAAA"}
package/build/text.js ADDED
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Slack escapes `&`, `<` and `>` in message text (https://docs.slack.dev/messaging/formatting-message-text/):
3
+ * an inbound text is decoded so handlers match what people read; an outbound text is encoded so the
4
+ * contract's plain text stays literal (no accidental links or mentions).
5
+ */
6
+ export const createSlackTextHelper = () => {
7
+ const decode = (text) => text.replace(/&lt;/g, '<').replace(/&gt;/g, '>').replace(/&amp;/g, '&');
8
+ const encode = (text) => text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
9
+ return { decode, encode };
10
+ };
11
+ export const slackTextHelper = createSlackTextHelper();
12
+ //# sourceMappingURL=text.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"text.js","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAoB,EAAE;IACzD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAEhH,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAEhH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,qBAAqB,EAAE,CAAA"}
@@ -0,0 +1,185 @@
1
+ import type { BotConnection } from '@owlmeans/bot';
2
+ import type { BotMockCall, BotNativeInbound, BotNormalizedUpdate, BotPlatformConnection, BotPlatformMock, BotPlatformPlugin, BotPlatformSession } from '@owlmeans/server-bot';
3
+ export interface SlackProfile {
4
+ real_name?: string;
5
+ display_name?: string;
6
+ name?: string;
7
+ }
8
+ export interface SlackBotProfile {
9
+ id?: string;
10
+ name?: string;
11
+ app_id?: string;
12
+ }
13
+ /** A `message` event (or the `message` an edit carries) — `ts` is the message id. */
14
+ export interface SlackMessage {
15
+ type: 'message';
16
+ subtype?: string;
17
+ channel?: string;
18
+ /** `channel` · `group` (private channel) · `im` · `mpim`. */
19
+ channel_type?: string;
20
+ user?: string;
21
+ text?: string;
22
+ ts?: string;
23
+ event_ts?: string;
24
+ /** The thread's parent `ts`; equal to `ts` on the parent itself. */
25
+ thread_ts?: string;
26
+ /** Who wrote the thread's parent — on a thread reply. */
27
+ parent_user_id?: string;
28
+ team?: string;
29
+ bot_id?: string;
30
+ app_id?: string;
31
+ bot_profile?: SlackBotProfile;
32
+ /** Delivered on members' messages, not documented on the event's page — read when present. */
33
+ user_profile?: SlackProfile;
34
+ edited?: {
35
+ user?: string;
36
+ ts?: string;
37
+ };
38
+ hidden?: boolean;
39
+ /** `message_changed`: the message as it is now / as it was. */
40
+ message?: SlackMessage;
41
+ previous_message?: SlackMessage;
42
+ }
43
+ export interface SlackAppMention {
44
+ type: 'app_mention';
45
+ channel?: string;
46
+ user?: string;
47
+ text?: string;
48
+ ts?: string;
49
+ event_ts?: string;
50
+ thread_ts?: string;
51
+ team?: string;
52
+ bot_id?: string;
53
+ app_id?: string;
54
+ }
55
+ export interface SlackAuthorization {
56
+ enterprise_id?: string | null;
57
+ team_id?: string;
58
+ user_id?: string;
59
+ is_bot?: boolean;
60
+ is_enterprise_install?: boolean;
61
+ }
62
+ /** The outer JSON of every Events API request. */
63
+ export interface SlackEnvelope {
64
+ type: 'event_callback' | 'url_verification' | 'app_rate_limited' | string;
65
+ token?: string;
66
+ team_id?: string;
67
+ api_app_id?: string;
68
+ event?: SlackMessage | SlackAppMention | {
69
+ type: string;
70
+ };
71
+ event_id?: string;
72
+ event_time?: number;
73
+ authorizations?: SlackAuthorization[];
74
+ is_ext_shared_channel?: boolean;
75
+ event_context?: string;
76
+ /** `url_verification` only. */
77
+ challenge?: string;
78
+ }
79
+ /** Every Web API answer. */
80
+ export interface SlackAnswer {
81
+ ok: boolean;
82
+ error?: string;
83
+ warning?: string;
84
+ }
85
+ export interface SlackAuthTest extends SlackAnswer {
86
+ url?: string;
87
+ team?: string;
88
+ user?: string;
89
+ team_id?: string;
90
+ user_id?: string;
91
+ /** Present for a bot token only. */
92
+ bot_id?: string;
93
+ enterprise_id?: string;
94
+ is_enterprise_install?: boolean;
95
+ }
96
+ export interface SlackPosted extends SlackAnswer {
97
+ channel?: string;
98
+ ts?: string;
99
+ message?: SlackMessage;
100
+ }
101
+ export interface SlackBotPlatformOptions {
102
+ /** The Web API, default `https://slack.com/api`; calls go to `<base>/<method>`. */
103
+ base?: string;
104
+ /** Retries of a call answered 429, default 2. */
105
+ retries?: number;
106
+ /** The longest `Retry-After` waited for, in seconds, default 30. */
107
+ maxRetryWaitS?: number;
108
+ }
109
+ export interface SlackRetryPolicy {
110
+ retries: number;
111
+ maxRetryWaitS: number;
112
+ }
113
+ export interface SlackCallOptions {
114
+ /** Another token than the bot's — the admin `userToken` for `chat.delete`. */
115
+ token?: string;
116
+ signal?: AbortSignal;
117
+ timeoutMs?: number;
118
+ }
119
+ /** The Web API over a session's transport. */
120
+ export interface SlackApi {
121
+ /**
122
+ * POST `<base>/<method>` with a JSON body and `Authorization: Bearer <token>`; a 429 is retried
123
+ * after its `Retry-After` (bounded). @throws {SlackApiError} `ok: false`, a transport fault
124
+ */
125
+ call: <T extends SlackAnswer>(method: string, params?: Record<string, unknown>, opts?: SlackCallOptions) => Promise<T>;
126
+ }
127
+ export interface SlackApiFactory {
128
+ (session: Pick<BotPlatformSession, 'connection' | 'fetch'>, base: string, retry: SlackRetryPolicy): SlackApi;
129
+ }
130
+ /** The Events API request signature. */
131
+ export interface SlackSignatureHelper {
132
+ /** `v0=` + hex HMAC-SHA256(secret, `v0:<timestamp>:<body>`). */
133
+ sign: (secret: string, timestamp: string, body: string) => string;
134
+ /** Whether `signature` signs `body` at `timestamp` with any of `secrets` — timing-safe. */
135
+ matches: (signature: string | undefined, timestamp: string, body: string, secrets: readonly string[]) => boolean;
136
+ /** Whether `timestamp` (seconds) is within the tolerance of `nowMs`. */
137
+ fresh: (timestamp: string | undefined, nowMs: number) => boolean;
138
+ }
139
+ /** Slack's three escaped characters in message text. */
140
+ export interface SlackTextHelper {
141
+ /** `&amp;` `&lt;` `&gt;` → `&` `<` `>` — what a person reads. */
142
+ decode: (text: string) => string;
143
+ /** `&` `<` `>` → entities — plain text Slack shows as written. */
144
+ encode: (text: string) => string;
145
+ }
146
+ export interface SlackNormalizer {
147
+ /**
148
+ * An `event_callback`'s `message` (new, or edited when it carries new text) or `app_mention` → one
149
+ * update; system subtypes, the bot's own messages and every other payload → none.
150
+ */
151
+ normalize: (payload: unknown, connection: BotConnection) => BotNormalizedUpdate[];
152
+ }
153
+ /** Who the fake workspace says the fake bot is — stable per connection id. */
154
+ export interface SlackMockIdentity {
155
+ teamId: string;
156
+ teamName: string;
157
+ appId: string;
158
+ botId: string;
159
+ botUserId: string;
160
+ username: string;
161
+ /** The admin `auth.test` answers for the connection's `userToken`. */
162
+ adminUserId: string;
163
+ }
164
+ export interface SlackMock extends BotPlatformMock {
165
+ /** A signed `url_verification` request — what Slack posts when the Request URL is pasted. */
166
+ challenge: (connection: BotPlatformConnection, challenge?: string) => BotNativeInbound;
167
+ /** The fake workspace, app and bot of a connection id. */
168
+ identityOf: (connection: string) => SlackMockIdentity;
169
+ }
170
+ /** One mock connection's state. */
171
+ export interface SlackMockState {
172
+ /** The last `ts` handed out, in microseconds — every new one is later. */
173
+ clock: number;
174
+ /** Every call, with `auth` — the token it carried (`bot`, `user` or `none`). */
175
+ calls: BotMockCall[];
176
+ /** The `ts` of messages the fake bot posted — a thread under one is the bot's. */
177
+ sent: Set<string>;
178
+ /** `<channel>:<ts>:<name>` of reactions already added. */
179
+ reactions: Set<string>;
180
+ }
181
+ /** The Slack plugin, its mock typed as Slack's own. */
182
+ export interface SlackBotPlatform extends BotPlatformPlugin {
183
+ mock: SlackMock;
184
+ }
185
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAClD,OAAO,KAAK,EACV,WAAW,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,eAAe,EAAE,iBAAiB,EAC7G,kBAAkB,EACnB,MAAM,sBAAsB,CAAA;AAI7B,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,qFAAqF;AACrF,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6DAA6D;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,8FAA8F;IAC9F,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACvC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,gBAAgB,CAAC,EAAE,YAAY,CAAA;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,MAAM,CAAA;IACzE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,YAAY,GAAG,eAAe,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACrC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,4BAA4B;AAC5B,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,OAAO,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE,YAAY,CAAA;CACvB;AAID,MAAM,WAAW,uBAAuB;IACtC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,8CAA8C;AAC9C,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,SAAS,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;CACvH;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,YAAY,GAAG,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,QAAQ,CAAA;CAC7G;AAED,wCAAwC;AACxC,MAAM,WAAW,oBAAoB;IACnC,gEAAgE;IAChE,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;IACjE,2FAA2F;IAC3F,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,KAAK,OAAO,CAAA;IAChH,wEAAwE;IACxE,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;CACjE;AAED,wDAAwD;AACxD,MAAM,WAAW,eAAe;IAC9B,iEAAiE;IACjE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;IAChC,kEAAkE;IAClE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,KAAK,mBAAmB,EAAE,CAAA;CAClF;AAED,8EAA8E;AAC9E,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,sEAAsE;IACtE,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,SAAU,SAAQ,eAAe;IAChD,6FAA6F;IAC7F,SAAS,EAAE,CAAC,UAAU,EAAE,qBAAqB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,gBAAgB,CAAA;IACtF,0DAA0D;IAC1D,UAAU,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,iBAAiB,CAAA;CACtD;AAED,mCAAmC;AACnC,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAA;IACb,gFAAgF;IAChF,KAAK,EAAE,WAAW,EAAE,CAAA;IACpB,kFAAkF;IAClF,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,0DAA0D;IAC1D,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CACvB;AAED,uDAAuD;AACvD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,IAAI,EAAE,SAAS,CAAA;CAChB"}
package/build/types.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,58 @@
1
1
  {
2
2
  "name": "@owlmeans/bot-slack",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.2.0-alpha.0",
4
+ "description": "OwlMeans chat-bot platform plugin for Slack: the @owlmeans/server-bot plugin, its descriptor and its native API client.",
5
+ "license": "MIT",
6
+ "homepage": "https://owlmeans.com/docs/",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/owlmeans/connect.git",
10
+ "directory": "packages/bot-slack"
11
+ },
12
+ "bugs": {
13
+ "url": "https://github.com/owlmeans/connect/issues"
14
+ },
15
+ "author": "Igor Tkachenko <igor.tkachenko@owlmeans.com> (https://owlmeans.com)",
16
+ "type": "module",
17
+ "scripts": {
18
+ "build": "tsc -b",
19
+ "dev": "sleep 4 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
20
+ "watch": "tsc -b -w --preserveWatchOutput --pretty",
21
+ "test": "bun test ./tests"
22
+ },
23
+ "main": "build/index.js",
24
+ "module": "build/index.js",
25
+ "types": "build/index.d.ts",
26
+ "exports": {
27
+ ".": {
28
+ "import": "./build/index.js",
29
+ "require": "./build/index.js",
30
+ "default": "./build/index.js",
31
+ "module": "./build/index.js",
32
+ "types": "./build/index.d.ts"
33
+ }
34
+ },
35
+ "dependencies": {
36
+ "@owlmeans/bot": "^0.2.0-alpha.0",
37
+ "@owlmeans/context": "^0.2.0-alpha.0",
38
+ "@owlmeans/server-bot": "^0.2.0-alpha.0"
39
+ },
40
+ "peerDependencies": {
41
+ "ajv": "*"
42
+ },
43
+ "devDependencies": {
44
+ "@owlmeans/dep-config": "^0.2.0-alpha.0",
45
+ "@owlmeans/log": "^0.2.0-alpha.0",
46
+ "@owlmeans/resource": "^0.2.0-alpha.0",
47
+ "@owlmeans/static-resource": "^0.2.0-alpha.0",
48
+ "@owlmeans/test": "^0.2.0-alpha.0",
49
+ "@types/bun": "^1.4.4",
50
+ "@types/node": "^26.6.5",
51
+ "ajv": "^8.20.0",
52
+ "nodemon": "^3.1.14",
53
+ "typescript": "^7.0.2"
54
+ },
55
+ "publishConfig": {
56
+ "access": "public"
57
+ }
58
+ }
package/src/api.ts ADDED
@@ -0,0 +1,70 @@
1
+ import { SLACK_CALL_TIMEOUT_MS, SLACK_RATE_LIMIT_DEFAULT_WAIT_S } from './consts.js'
2
+ import { SlackApiError } from './errors.js'
3
+ import type { SlackAnswer, SlackApi, SlackApiFactory, SlackCallOptions } from './types.js'
4
+ import { botSignalHelper } from '@owlmeans/server-bot'
5
+
6
+ /** `Retry-After` in seconds (an HTTP date counts from now); the default when absent or unreadable. */
7
+ const retryAfterOf = (response: Response): number => {
8
+ const value = response.headers.get('retry-after')
9
+ if (value == null || value.trim() === '') {
10
+ return SLACK_RATE_LIMIT_DEFAULT_WAIT_S
11
+ }
12
+ const seconds = Number(value)
13
+ if (Number.isFinite(seconds) && seconds >= 0) {
14
+ return Math.ceil(seconds)
15
+ }
16
+ const at = Date.parse(value)
17
+
18
+ return Number.isFinite(at) ? Math.max(0, Math.ceil((at - Date.now()) / 1000)) : SLACK_RATE_LIMIT_DEFAULT_WAIT_S
19
+ }
20
+
21
+ /**
22
+ * The Web API over a session: `POST <base>/<method>`, JSON in, `Authorization: Bearer <token>`, the
23
+ * `{ ok, error? }` answer out. Tokens travel in a header — never in a URL, never in an error.
24
+ */
25
+ export const makeSlackApi: SlackApiFactory = (session, base, retry): SlackApi => {
26
+ const call = async <T extends SlackAnswer>(
27
+ method: string, params: Record<string, unknown> = {}, opts: SlackCallOptions = {}
28
+ ): Promise<T> => {
29
+ const token = opts.token ?? session.connection.credentials.botToken ?? ''
30
+ for (let attempt = 0; ; attempt++) {
31
+ let response: Response
32
+ try {
33
+ response = await session.fetch(`${base}/${method}`, {
34
+ method: 'POST',
35
+ headers: { 'content-type': 'application/json; charset=utf-8', authorization: `Bearer ${token}` },
36
+ body: JSON.stringify(params),
37
+ signal: botSignalHelper.deadline(opts.timeoutMs ?? SLACK_CALL_TIMEOUT_MS, opts.signal),
38
+ })
39
+ } catch (error) {
40
+ if (opts.signal?.aborted === true) {
41
+ throw error
42
+ }
43
+ // Only the error's kind is passed on: a transport message is not ours to repeat.
44
+ const name = error instanceof Error ? error.name : 'Error'
45
+ throw SlackApiError.of(method, name === 'TimeoutError' ? 'timeout' : 'unreachable')
46
+ }
47
+ if (response.status === 429) {
48
+ const wait = retryAfterOf(response)
49
+ if (attempt < retry.retries && wait <= retry.maxRetryWaitS) {
50
+ await botSignalHelper.pause(wait * 1000, opts.signal)
51
+ continue
52
+ }
53
+ throw SlackApiError.of(method, 'ratelimited', wait)
54
+ }
55
+ let answer: T
56
+ try {
57
+ answer = await response.json() as T
58
+ } catch {
59
+ throw SlackApiError.of(method, `http_${response.status}`)
60
+ }
61
+ if (answer?.ok !== true) {
62
+ throw SlackApiError.of(method, typeof answer?.error === 'string' && answer.error !== '' ? answer.error : `http_${response.status}`)
63
+ }
64
+
65
+ return answer
66
+ }
67
+ }
68
+
69
+ return { call }
70
+ }
package/src/append.ts ADDED
@@ -0,0 +1,18 @@
1
+ import type { BasicContext } from '@owlmeans/context'
2
+ import { appendBot, BOT_SERVICE } from '@owlmeans/server-bot'
3
+ import { makeSlackBotPlatform } from './plugin.js'
4
+ import type { SlackBotPlatformOptions, SlackBotPlatform } from './types.js'
5
+
6
+ /**
7
+ * Register the Slack plugin on the context's bot service — appending the service (`appendBot`, its
8
+ * default options) when it is not there yet — and answer the plugin. Registration is explicit:
9
+ * importing this package registers nothing.
10
+ */
11
+ export const appendSlackBotPlatform = <C extends BasicContext<any>>(
12
+ context: C, opts?: SlackBotPlatformOptions, alias: string = BOT_SERVICE
13
+ ): SlackBotPlatform => {
14
+ const plugin = makeSlackBotPlatform(opts)
15
+ appendBot(context, undefined, alias).register(plugin)
16
+
17
+ return plugin
18
+ }