@zhin.js/adapter-slack 4.0.1 → 4.1.1

package/agent/tools/user_info.ts

@@ -0,0 +1,31 @@
+import { defineAgentTool } from '@zhin.js/agent/tools';
+import { z } from 'zod';
+import { getSlackAgentDeps } from '../../src/slack-agent-deps.js';
+
+export default defineAgentTool<{
+  endpoint_id: string;
+  user_id: string;
+}>({
+  description: '查询 Slack 用户详细信息',
+  inputSchema: z.object({
+    endpoint_id: z.string().describe('Endpoint 名称'),
+    user_id: z.string().describe('用户 ID'),
+  }),
+  platforms: ['slack'],
+  tags: ['slack'],
+  async execute({ endpoint_id, user_id }) {
+    const { getEndpoint } = getSlackAgentDeps();
+    const endpoint = getEndpoint(endpoint_id);
+    const user = await endpoint.getUserInfo(user_id);
+    return {
+      id: user.id,
+      name: user.name,
+      real_name: user.real_name,
+      display_name: user.profile?.display_name,
+      email: user.profile?.email,
+      is_admin: user.is_admin,
+      is_bot: user.is_bot,
+      status_text: user.profile?.status_text,
+    };
+  },
+});

package/lib/endpoint.d.ts

@@ -1,108 +1,147 @@
-import { Endpoint, Message, SendOptions } from 'zhin.js';
-import type { SlackEndpointConfig, SlackMessageEvent } from "./types.js";
-import type { SlackAdapter } from "./adapter.js";
-export declare class SlackEndpoint implements Endpoint<SlackEndpointConfig, SlackMessageEvent> {
+import type { EndpointInstance } from '@zhin.js/adapter';
+import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { HttpHost } from '@zhin.js/host-http';
+import type { CapabilityId } from '@zhin.js/plugin-runtime';
+import { type ResolvedSlackConfig, type SlackEvent, type SlackInteractionPayload, type SlackMessageEvent, type SlackSlashCommand } from './protocol.js';
+import { type SlackChatClient } from './slack-outbound.js';
+import { type SlackWebhookHandler } from './webhook.js';
+export interface SlackSocketLike {
+    on(event: string, handler: (args: {
+        ack: () => Promise<void>;
+        body: unknown;
+    }) => void | Promise<void>): void;
+    start(): Promise<void>;
+    disconnect(): Promise<void>;
+}
+export interface SlackWebClientLike extends SlackChatClient {
+    auth: {
+        test(): Promise<{
+            user_id?: string;
+            user?: string;
+        }>;
+    };
+    conversations: {
+        invite(opts: {
+            channel: string;
+            users: string;
+        }): Promise<unknown>;
+        kick(opts: {
+            channel: string;
+            user: string;
+        }): Promise<unknown>;
+        setTopic(opts: {
+            channel: string;
+            topic: string;
+        }): Promise<unknown>;
+        setPurpose(opts: {
+            channel: string;
+            purpose: string;
+        }): Promise<unknown>;
+        archive(opts: {
+            channel: string;
+        }): Promise<unknown>;
+        unarchive(opts: {
+            channel: string;
+        }): Promise<unknown>;
+        rename(opts: {
+            channel: string;
+            name: string;
+        }): Promise<unknown>;
+        members(opts: {
+            channel: string;
+        }): Promise<{
+            members?: string[];
+        }>;
+        info(opts: {
+            channel: string;
+        }): Promise<{
+            channel?: unknown;
+        }>;
+    };
+    users: {
+        info(opts: {
+            user: string;
+        }): Promise<{
+            user?: unknown;
+        }>;
+    };
+    reactions: {
+        add(opts: {
+            channel: string;
+            timestamp: string;
+            name: string;
+        }): Promise<unknown>;
+        remove(opts: {
+            channel: string;
+            timestamp: string;
+            name: string;
+        }): Promise<unknown>;
+    };
+    pins: {
+        add(opts: {
+            channel: string;
+            timestamp: string;
+        }): Promise<unknown>;
+        remove(opts: {
+            channel: string;
+            timestamp: string;
+        }): Promise<unknown>;
+    };
+    chat: SlackChatClient['chat'] & {
+        delete(opts: {
+            channel: string;
+            ts: string;
+        }): Promise<unknown>;
+    };
+}
+export interface SlackEndpointOptions {
+    readonly id: CapabilityId;
+    readonly gateway: MessageGateway;
+    readonly config: ResolvedSlackConfig;
+    readonly http?: HttpHost;
+    readonly createClient?: (token: string) => SlackWebClientLike;
+    readonly createSocket?: (opts: {
+        readonly appToken: string;
+        readonly clientPingTimeout: number;
+    }) => SlackSocketLike;
+}
+export declare class SlackEndpoint implements EndpointInstance, SlackWebhookHandler {
     #private;
-    adapter: SlackAdapter;
-    $config: SlackEndpointConfig;
-    $connected: boolean;
-    /** 延迟到 `$connect`，避免子类 mock `$connect` 时仍在构造函数里创建 Bolt/WebClient（会在后台触发 Slack API） */
-    private app?;
-    private client?;
-    get logger(): import("zhin.js").Logger;
-    get $id(): string;
-    constructor(adapter: SlackAdapter, $config: SlackEndpointConfig);
-    $connect(): Promise<void>;
-    $disconnect(): Promise<void>;
-    private senderPermitCache;
-    private enrichChannelSender;
-    private handleSlackMessage;
-    $formatMessage(msg: SlackMessageEvent): Message<SlackMessageEvent>;
-    private parseMessageContent;
-    private parseSlackText;
-    $sendMessage(options: SendOptions): Promise<string>;
-    private sendContentToChannel;
-    $recallMessage(id: string): Promise<void>;
-    /**
-     * 邀请用户到频道
-     * @param channel 频道 ID
-     * @param users 用户 ID 列表
-     */
+    constructor(options: SlackEndpointOptions);
+    get client(): SlackWebClientLike | undefined;
+    get platformUserId(): string | undefined;
+    get config(): ResolvedSlackConfig;
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ target, payload }: {
+        readonly target: string;
+        readonly payload: unknown;
+    }): Promise<string>;
+    /** Test / internal: admit a message event when open. */
+    admit(event: SlackMessageEvent | SlackEvent): void;
+    admitInteraction(payload: SlackInteractionPayload): void;
+    admitSlashCommand(cmd: SlackSlashCommand): void;
+    handleEnvelope(body: unknown): void;
+    trackMessageChannel(ts: string, channel: string): void;
+    resolveMessageRef(messageId: string, channelHint?: string): {
+        channel: string;
+        ts: string;
+    } | null;
+    editMessage(channel: string, messageTs: string, content: unknown): Promise<void>;
     inviteToChannel(channel: string, users: string[]): Promise<boolean>;
-    /**
-     * 从频道踢出用户
-     * @param channel 频道 ID
-     * @param user 用户 ID
-     */
     kickFromChannel(channel: string, user: string): Promise<boolean>;
-    /**
-     * 设置频道话题
-     * @param channel 频道 ID
-     * @param topic 话题
-     */
     setChannelTopic(channel: string, topic: string): Promise<boolean>;
-    /**
-     * 设置频道目的
-     * @param channel 频道 ID
-     * @param purpose 目的
-     */
     setChannelPurpose(channel: string, purpose: string): Promise<boolean>;
-    /**
-     * 归档频道
-     * @param channel 频道 ID
-     */
     archiveChannel(channel: string): Promise<boolean>;
-    /**
-     * 取消归档频道
-     * @param channel 频道 ID
-     */
     unarchiveChannel(channel: string): Promise<boolean>;
-    /**
-     * 重命名频道
-     * @param channel 频道 ID
-     * @param name 新名称
-     */
     renameChannel(channel: string, name: string): Promise<boolean>;
-    /**
-     * 获取频道成员列表
-     * @param channel 频道 ID
-     */
     getChannelMembers(channel: string): Promise<string[]>;
-    /**
-     * 获取频道信息
-     * @param channel 频道 ID
-     */
-    getChannelInfo(channel: string): Promise<any>;
-    /**
-     * 获取用户信息
-     * @param user 用户 ID
-     */
-    getUserInfo(user: string): Promise<any>;
-    /**
-     * 添加消息反应
-     * @param channel 频道 ID
-     * @param timestamp 消息时间戳
-     * @param name 表情名称
-     */
+    getChannelInfo(channel: string): Promise<unknown>;
+    getUserInfo(user: string): Promise<unknown>;
     addReaction(channel: string, timestamp: string, name: string): Promise<boolean>;
-    /**
-     * 移除消息反应
-     * @param channel 频道 ID
-     * @param timestamp 消息时间戳
-     * @param name 表情名称
-     */
     removeReaction(channel: string, timestamp: string, name: string): Promise<boolean>;
-    /**
-     * 置顶消息
-     * @param channel 频道 ID
-     * @param timestamp 消息时间戳
-     */
     pinMessage(channel: string, timestamp: string): Promise<boolean>;
-    /**
-     * 取消置顶消息
-     * @param channel 频道 ID
-     * @param timestamp 消息时间戳
-     */
     unpinMessage(channel: string, timestamp: string): Promise<boolean>;
 }
-//# sourceMappingURL=endpoint.d.ts.map