@zhin.js/adapter-slack 1.0.77 → 1.1.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 (92) hide show
  1. package/CHANGELOG.md +642 -0
  2. package/README.md +112 -158
  3. package/adapters/slack.js +40 -0
  4. package/adapters/slack.ts +45 -0
  5. package/agent/PERMITS.md +24 -0
  6. package/{skills/slack/SKILL.md → agent/skills/slack.md} +2 -0
  7. package/agent/tools/add_reaction.ts +29 -0
  8. package/agent/tools/archive_channel.ts +21 -0
  9. package/agent/tools/edit_message.ts +25 -0
  10. package/agent/tools/invite_to_channel.ts +23 -0
  11. package/agent/tools/pin_message.ts +23 -0
  12. package/agent/tools/remove_reaction.ts +32 -0
  13. package/agent/tools/set_purpose.ts +23 -0
  14. package/agent/tools/set_topic.ts +23 -0
  15. package/agent/tools/unarchive.ts +21 -0
  16. package/agent/tools/unpin_message.ts +23 -0
  17. package/agent/tools/user_info.ts +29 -0
  18. package/commands/endpoint/add/[id].js +3 -0
  19. package/commands/endpoint/add/[id].ts +3 -0
  20. package/commands/endpoint/list.js +3 -0
  21. package/commands/endpoint/list.ts +3 -0
  22. package/commands/endpoint/remove/[id].js +3 -0
  23. package/commands/endpoint/remove/[id].ts +3 -0
  24. package/lib/client.d.ts +25 -0
  25. package/lib/client.js +2 -0
  26. package/lib/endpoint.d.ts +153 -0
  27. package/lib/endpoint.js +425 -0
  28. package/lib/index.d.ts +10 -10
  29. package/lib/index.js +10 -242
  30. package/lib/markdown-to-mrkdwn.d.ts +9 -0
  31. package/lib/markdown-to-mrkdwn.js +121 -0
  32. package/lib/mrkdwn-to-markdown.d.ts +4 -0
  33. package/lib/mrkdwn-to-markdown.js +30 -0
  34. package/lib/platform-permit.d.ts +15 -0
  35. package/lib/platform-permit.js +43 -0
  36. package/lib/protocol.d.ts +153 -0
  37. package/lib/protocol.js +272 -0
  38. package/lib/side-event-dispatch.d.ts +4 -0
  39. package/lib/side-event-dispatch.js +45 -0
  40. package/lib/slack-endpoint-commands.d.ts +1 -0
  41. package/lib/slack-endpoint-commands.js +18 -0
  42. package/lib/slack-inbound-filter.d.ts +12 -0
  43. package/lib/slack-inbound-filter.js +46 -0
  44. package/lib/slack-message-ref.d.ts +7 -0
  45. package/lib/slack-message-ref.js +17 -0
  46. package/lib/slack-outbound.d.ts +24 -0
  47. package/lib/slack-outbound.js +111 -0
  48. package/lib/slack-reaction.d.ts +1 -0
  49. package/lib/slack-reaction.js +26 -0
  50. package/lib/slack-response-url.d.ts +5 -0
  51. package/lib/slack-response-url.js +16 -0
  52. package/lib/slack-runtime-state.d.ts +1 -0
  53. package/lib/slack-runtime-state.js +6 -0
  54. package/lib/webhook.d.ts +14 -0
  55. package/lib/webhook.js +72 -0
  56. package/package.json +67 -15
  57. package/plugin.js +19 -0
  58. package/schema.json +95 -0
  59. package/src/client.ts +30 -0
  60. package/src/endpoint.ts +526 -0
  61. package/src/index.ts +59 -265
  62. package/src/markdown-to-mrkdwn.ts +117 -0
  63. package/src/mrkdwn-to-markdown.ts +29 -0
  64. package/src/platform-permit.ts +59 -0
  65. package/src/protocol.ts +435 -0
  66. package/src/side-event-dispatch.ts +54 -0
  67. package/src/slack-endpoint-commands.ts +19 -0
  68. package/src/slack-inbound-filter.ts +60 -0
  69. package/src/slack-message-ref.ts +18 -0
  70. package/src/slack-outbound.ts +170 -0
  71. package/src/slack-reaction.ts +23 -0
  72. package/src/slack-response-url.ts +26 -0
  73. package/src/slack-runtime-state.ts +7 -0
  74. package/src/webhook.ts +106 -0
  75. package/lib/adapter.d.ts +0 -16
  76. package/lib/adapter.d.ts.map +0 -1
  77. package/lib/adapter.js +0 -43
  78. package/lib/adapter.js.map +0 -1
  79. package/lib/bot.d.ts +0 -106
  80. package/lib/bot.d.ts.map +0 -1
  81. package/lib/bot.js +0 -628
  82. package/lib/bot.js.map +0 -1
  83. package/lib/index.d.ts.map +0 -1
  84. package/lib/index.js.map +0 -1
  85. package/lib/types.d.ts +0 -17
  86. package/lib/types.d.ts.map +0 -1
  87. package/lib/types.js +0 -2
  88. package/lib/types.js.map +0 -1
  89. package/plugin.yml +0 -3
  90. package/src/adapter.ts +0 -52
  91. package/src/bot.ts +0 -688
  92. package/src/types.ts +0 -18
package/lib/webhook.js ADDED
@@ -0,0 +1,72 @@
1
+ import { getLogger } from '@zhin.js/logger';
2
+ import { headerValue, readTextBody, verifySlackSignature, } from './protocol.js';
3
+ const logger = getLogger('slack');
4
+ export function registerSlackWebhookRoutes(http, handler) {
5
+ const path = handler.config.webhookPath;
6
+ return [
7
+ http.route('POST', path, async (request, response) => {
8
+ await handleSlackWebhookRequest(request, response, handler);
9
+ }, { summary: 'Slack Events API / Interactivity', tags: ['slack'] }),
10
+ ];
11
+ }
12
+ export async function handleSlackWebhookRequest(request, response, handler) {
13
+ try {
14
+ const rawBody = await readTextBody(request);
15
+ const timestamp = headerValue(request.headers, 'x-slack-request-timestamp');
16
+ const signature = headerValue(request.headers, 'x-slack-signature');
17
+ if (!verifySlackSignature(handler.config.signingSecret, rawBody, timestamp, signature)) {
18
+ response.writeHead(401, { 'Content-Type': 'text/plain' });
19
+ response.end('Invalid signature');
20
+ return;
21
+ }
22
+ const contentType = headerValue(request.headers, 'content-type');
23
+ if (contentType.includes('application/x-www-form-urlencoded')) {
24
+ const params = new URLSearchParams(rawBody);
25
+ const payloadStr = params.get('payload');
26
+ if (payloadStr) {
27
+ const payload = JSON.parse(payloadStr);
28
+ response.writeHead(200);
29
+ response.end('');
30
+ handler.admitInteraction(payload);
31
+ return;
32
+ }
33
+ const body = Object.fromEntries(params);
34
+ if (body.command) {
35
+ response.writeHead(200);
36
+ response.end('');
37
+ handler.admitSlashCommand(body);
38
+ return;
39
+ }
40
+ }
41
+ let envelope;
42
+ try {
43
+ envelope = JSON.parse(rawBody);
44
+ }
45
+ catch {
46
+ response.writeHead(200);
47
+ response.end('');
48
+ return;
49
+ }
50
+ if (envelope.type === 'url_verification') {
51
+ const challenge = envelope.challenge;
52
+ response.writeHead(200, { 'Content-Type': 'application/json' });
53
+ response.end(JSON.stringify({ challenge }));
54
+ return;
55
+ }
56
+ if (envelope.type === 'event_callback' && envelope.event) {
57
+ response.writeHead(200);
58
+ response.end('');
59
+ handler.handleEnvelope(envelope);
60
+ return;
61
+ }
62
+ response.writeHead(200);
63
+ response.end('');
64
+ }
65
+ catch (error) {
66
+ logger.error('Slack webhook error:', error);
67
+ if (!response.headersSent) {
68
+ response.writeHead(200);
69
+ response.end('');
70
+ }
71
+ }
72
+ }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@zhin.js/adapter-slack",
3
- "version": "1.0.77",
4
- "description": "Zhin.js adapter for Slack",
3
+ "version": "1.1.0",
4
+ "description": "Zhin.js Slack adapter for Plugin Runtime (Socket Mode / HTTP Events)",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",
7
7
  "types": "./lib/index.d.ts",
@@ -32,24 +32,55 @@
32
32
  "directory": "plugins/adapters/slack"
33
33
  },
34
34
  "dependencies": {
35
- "@slack/bolt": "^4.7.3",
36
- "@slack/web-api": "^7.16.0"
35
+ "@slack/socket-mode": "^2.0.7",
36
+ "@slack/web-api": "^7.19.0",
37
+ "@zhin.js/adapter": "1.1.12",
38
+ "@zhin.js/core": "1.1.35",
39
+ "@zhin.js/feature-kit": "1.1.0",
40
+ "@zhin.js/host-http": "1.1.0",
41
+ "@zhin.js/im-contract": "1.1.0",
42
+ "@zhin.js/logger": "1.1.0"
43
+ },
44
+ "peerDependencies": {
45
+ "zod": "^4.0.0",
46
+ "@zhin.js/adapter": "^1.1.12",
47
+ "@zhin.js/agent": "^1.1.23",
48
+ "@zhin.js/command": "^1.1.0",
49
+ "@zhin.js/core": "^1.1.35",
50
+ "@zhin.js/host-http": "^1.1.0",
51
+ "@zhin.js/permission": "^1.1.0",
52
+ "zhin.js": "^1.1.0"
53
+ },
54
+ "peerDependenciesMeta": {
55
+ "@zhin.js/agent": {
56
+ "optional": true
57
+ },
58
+ "@zhin.js/command": {
59
+ "optional": true
60
+ },
61
+ "zhin.js": {
62
+ "optional": true
63
+ },
64
+ "zod": {
65
+ "optional": true
66
+ }
37
67
  },
38
68
  "devDependencies": {
39
- "@types/node": "^25.9.1",
69
+ "@types/node": "^26.1.2",
40
70
  "typescript": "^6.0.3",
41
- "zhin.js": "1.0.92"
42
- },
43
- "peerDependencies": {
44
- "zhin.js": "1.0.92"
71
+ "vitest": "^4.1.10",
72
+ "zod": "^4.4.3",
73
+ "@zhin.js/agent": "1.1.23",
74
+ "zhin.js": "1.1.0"
45
75
  },
46
76
  "files": [
77
+ "adapters",
78
+ "commands",
79
+ "plugin.js",
80
+ "schema.json",
47
81
  "src",
48
82
  "lib",
49
- "client",
50
- "dist",
51
- "skills",
52
- "plugin.yml",
83
+ "agent",
53
84
  "README.md",
54
85
  "CHANGELOG.md"
55
86
  ],
@@ -57,9 +88,30 @@
57
88
  "access": "public",
58
89
  "registry": "https://registry.npmjs.org"
59
90
  },
91
+ "engines": {
92
+ "node": "^20.19.0 || >=22.12.0"
93
+ },
94
+ "zhin": {
95
+ "protocol": 1,
96
+ "type": "plugin",
97
+ "entry": "./plugin.js",
98
+ "engine": "^1.0.0",
99
+ "runtime": "trusted",
100
+ "features": [
101
+ {
102
+ "package": "@zhin.js/adapter",
103
+ "api": "^1.0.0"
104
+ },
105
+ {
106
+ "package": "@zhin.js/command",
107
+ "api": "^1.0.0"
108
+ }
109
+ ],
110
+ "plugins": []
111
+ },
60
112
  "scripts": {
61
- "build": "pnpm build:node",
113
+ "build": "tsc",
62
114
  "clean": "rimraf lib",
63
- "build:node": "tsc"
115
+ "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/adapters/slack/tests"
64
116
  }
65
117
  }
package/plugin.js ADDED
@@ -0,0 +1,19 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ import { createEndpointRuntimeState } from 'zhin.js/adapter';
3
+ import { definePlugin } from 'zhin.js';
4
+ import { permissionHostToken } from '@zhin.js/permission';
5
+ import { checkSlackPlatformPermit } from "./lib/platform-permit.js";
6
+ import { slackRuntimeStateToken } from "./lib/slack-runtime-state.js";
7
+ export default definePlugin({
8
+ name: 'slack',
9
+ metadata: {
10
+ displayName: 'Slack Adapter',
11
+ },
12
+ setup(context) {
13
+ context.resources.provide(slackRuntimeStateToken, createEndpointRuntimeState());
14
+ if (context.resources.has(permissionHostToken)) {
15
+ const host = context.resources.use(permissionHostToken);
16
+ return host.registerPlatform('slack', checkSlackPlatformPermit);
17
+ }
18
+ },
19
+ });
package/schema.json ADDED
@@ -0,0 +1,95 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "type": "object",
4
+ "additionalProperties": false,
5
+ "properties": {
6
+ "socketMode": {
7
+ "type": "boolean",
8
+ "default": true,
9
+ "description": "Prefer Socket Mode (default). Set false for HTTP Events via httpHostToken."
10
+ },
11
+ "webhookPath": {
12
+ "type": "string",
13
+ "default": "/slack/events"
14
+ },
15
+ "clientPingTimeout": {
16
+ "type": "number",
17
+ "default": 15000,
18
+ "description": "Socket Mode client ping timeout (ms)"
19
+ },
20
+ "master": {
21
+ "type": [
22
+ "string",
23
+ "number"
24
+ ],
25
+ "description": "框架 master(Slack user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖"
26
+ },
27
+ "trusted": {
28
+ "type": "array",
29
+ "items": {
30
+ "type": [
31
+ "string",
32
+ "number"
33
+ ],
34
+ "description": "Trusted Slack user id"
35
+ },
36
+ "description": "框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加"
37
+ },
38
+ "endpoints": {
39
+ "type": "array",
40
+ "description": "多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)",
41
+ "items": {
42
+ "type": "object",
43
+ "additionalProperties": true,
44
+ "properties": {
45
+ "master": {
46
+ "type": [
47
+ "string",
48
+ "number"
49
+ ],
50
+ "description": "本 endpoint 的框架 master(Slack user id);覆盖顶层 master"
51
+ },
52
+ "trusted": {
53
+ "type": "array",
54
+ "items": {
55
+ "type": [
56
+ "string",
57
+ "number"
58
+ ],
59
+ "description": "Trusted Slack user id"
60
+ },
61
+ "description": "本 endpoint 的 trusted 列表"
62
+ },
63
+ "token": {
64
+ "type": "string",
65
+ "description": "Bot User OAuth Token (xoxb-...)"
66
+ },
67
+ "signingSecret": {
68
+ "type": "string",
69
+ "description": "Required for HTTP Events API (socketMode: false)"
70
+ },
71
+ "appToken": {
72
+ "type": "string",
73
+ "description": "App-Level Token (xapp-...) for Socket Mode"
74
+ },
75
+ "id": {
76
+ "type": "string",
77
+ "description": "Slack bot name"
78
+ }
79
+ },
80
+ "required": [
81
+ "id",
82
+ "token"
83
+ ]
84
+ }
85
+ },
86
+ "commandPrefix": {
87
+ "type": "string",
88
+ "default": "",
89
+ "description": "命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖"
90
+ }
91
+ },
92
+ "required": [
93
+ "endpoints"
94
+ ]
95
+ }
package/src/client.ts ADDED
@@ -0,0 +1,30 @@
1
+ import { defineEndpointClient } from 'zhin.js/adapter';
2
+ import type { SlackWebClientLike } from './endpoint.js';
3
+ import type { SlackEvent } from './protocol.js';
4
+
5
+ /** Slack users.info response fields projected by the bundled tools. */
6
+ export interface SlackUserInfo {
7
+ id?: string;
8
+ name?: string;
9
+ real_name?: string;
10
+ is_admin?: boolean;
11
+ is_bot?: boolean;
12
+ profile?: {
13
+ display_name?: string;
14
+ email?: string;
15
+ status_text?: string;
16
+ };
17
+ }
18
+
19
+ export type SlackClientEventMap = Record<string, SlackEvent>;
20
+
21
+ declare module '@zhin.js/feature-kit' {
22
+ interface AdapterClientRegistry {
23
+ readonly slack: {
24
+ readonly client: SlackWebClientLike;
25
+ readonly events: SlackClientEventMap;
26
+ };
27
+ }
28
+ }
29
+
30
+ export const slackClient = defineEndpointClient<SlackWebClientLike, SlackClientEventMap>('slack');