@zhin.js/adapter-milky 3.0.2 → 5.0.0

package/lib/sse-client.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Minimal fetch-based SSE client (no EventSource dependency).
+ * Parses `text/event-stream` frames and invokes onMessage for each `data:` payload.
+ */
+export interface SseClientOptions {
+    readonly url: string;
+    readonly headers?: Record<string, string>;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly signal?: AbortSignal;
+    readonly onMessage: (data: string) => void;
+    readonly onError?: (error: Error) => void;
+    readonly onOpen?: () => void;
+}
+export interface SseClientHandle {
+    readonly closed: Promise<void>;
+    close(): void;
+}
+export declare function openSseStream(options: SseClientOptions): SseClientHandle;
+/** Exported for unit tests. */
+export declare function consumeSseBuffer(buffer: string, onMessage: (data: string) => void): string;

package/lib/sse-client.js

@@ -0,0 +1,85 @@
+export function openSseStream(options) {
+    const controller = new AbortController();
+    const fetchImpl = options.fetch ?? globalThis.fetch;
+    let settle;
+    const closed = new Promise((resolve) => { settle = resolve; });
+    const run = async () => {
+        try {
+            const response = await fetchImpl(options.url, {
+                method: 'GET',
+                headers: {
+                    Accept: 'text/event-stream',
+                    ...(options.headers ?? {}),
+                },
+                signal: anySignal([controller.signal, options.signal]),
+            });
+            if (!response.ok) {
+                throw new Error(`SSE HTTP ${response.status}`);
+            }
+            if (!response.body) {
+                throw new Error('SSE response has no body');
+            }
+            options.onOpen?.();
+            const reader = response.body.getReader();
+            const decoder = new TextDecoder();
+            let buffer = '';
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done)
+                    break;
+                buffer += decoder.decode(value, { stream: true });
+                buffer = consumeSseBuffer(buffer, options.onMessage);
+            }
+            buffer += decoder.decode();
+            consumeSseBuffer(`${buffer}\n\n`, options.onMessage);
+        }
+        catch (error) {
+            if (!controller.signal.aborted) {
+                const err = error instanceof Error ? error : new Error(String(error));
+                options.onError?.(err);
+            }
+        }
+        finally {
+            settle();
+        }
+    };
+    void run();
+    return {
+        closed,
+        close() {
+            controller.abort();
+        },
+    };
+}
+/** Exported for unit tests. */
+export function consumeSseBuffer(buffer, onMessage) {
+    let rest = buffer;
+    while (true) {
+        const sep = rest.indexOf('\n\n');
+        if (sep < 0)
+            return rest;
+        const frame = rest.slice(0, sep);
+        rest = rest.slice(sep + 2);
+        const dataLines = [];
+        for (const line of frame.split('\n')) {
+            if (line.startsWith('data:')) {
+                dataLines.push(line.slice(5).replace(/^ /, ''));
+            }
+        }
+        if (dataLines.length > 0)
+            onMessage(dataLines.join('\n'));
+    }
+}
+function anySignal(signals) {
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (!signal)
+            continue;
+        if (signal.aborted) {
+            controller.abort();
+            return controller.signal;
+        }
+        signal.addEventListener('abort', () => controller.abort(), { once: true });
+    }
+    return controller.signal;
+}

package/lib/sse-endpoint.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Milky SSE client endpoint — GET text/event-stream on /event.
+ */
+import type { EndpointInstance } from '@zhin.js/adapter';
+import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { CapabilityId } from '@zhin.js/plugin-runtime';
+import { callApi, type MilkyEvent, type MilkySseConfig } from './protocol.js';
+import { type SseClientHandle } from './sse-client.js';
+export type CreateMilkySseStream = (options: {
+    readonly url: string;
+    readonly headers: Record<string, string>;
+    readonly onMessage: (data: string) => void;
+    readonly onError?: (error: Error) => void;
+    readonly onOpen?: () => void;
+}) => SseClientHandle;
+export interface MilkySseEndpointOptions {
+    readonly id: CapabilityId;
+    readonly gateway: MessageGateway;
+    readonly config: MilkySseConfig;
+    readonly createSseStream?: CreateMilkySseStream;
+    readonly callApi?: typeof callApi;
+}
+export declare class MilkySseEndpoint implements EndpointInstance {
+    #private;
+    constructor(options: MilkySseEndpointOptions);
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ target, payload }: {
+        readonly target: string;
+        readonly payload: unknown;
+    }): Promise<string>;
+    callApi(action: string, params?: Record<string, unknown>): Promise<unknown>;
+    recallMessage(id: string): Promise<void>;
+    kickMember(groupId: number, userId: number, rejectAddRequest?: boolean): Promise<boolean>;
+    muteMember(groupId: number, userId: number, duration?: number): Promise<boolean>;
+    muteAll(groupId: number, enable?: boolean): Promise<boolean>;
+    setAdmin(groupId: number, userId: number, enable?: boolean): Promise<boolean>;
+    setCard(groupId: number, userId: number, card: string): Promise<boolean>;
+    setTitle(groupId: number, userId: number, title: string): Promise<boolean>;
+    setGroupName(groupId: number, name: string): Promise<boolean>;
+    getMemberList(groupId: number): Promise<unknown[]>;
+    getGroupInfo(groupId: number): Promise<unknown>;
+    admit(event: MilkyEvent): void;
+    apiOptions(): {
+        baseUrl: string;
+        access_token?: string;
+    };
+}

package/lib/sse-endpoint.js

@@ -0,0 +1,261 @@
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { registerMilkyAgentEndpoint } from './milky-agent-deps.js';
+import { buildSendAction, buildSseConnectOptions, callApi, extractInboundAudioUrl, formatInboundContent, formatInboundMessageId, formatInboundTarget, formatOutboundMessageId, formatOutboundSegments, isMentioned, parseMessageReceiveData, parseMilkyMessageId, senderNickname, } from './protocol.js';
+import { openSseStream } from './sse-client.js';
+const logger = getLogger('milky');
+export class MilkySseEndpoint {
+    #options;
+    #callApi;
+    #stream;
+    #reconnectTimer;
+    #open = false;
+    #started = false;
+    #stopping = false;
+    #unregisterAgent;
+    constructor(options) {
+        this.#options = options;
+        this.#callApi = options.callApi ?? callApi;
+    }
+    async start() {
+        if (this.#started)
+            return;
+        this.#started = true;
+        this.#stopping = false;
+        this.#unregisterAgent = registerMilkyAgentEndpoint(this.#options.config.name, this);
+        await this.#connect();
+    }
+    open() {
+        this.#open = true;
+    }
+    close() {
+        this.#open = false;
+    }
+    async stop() {
+        this.#open = false;
+        this.#stopping = true;
+        this.#started = false;
+        this.#unregisterAgent?.();
+        this.#unregisterAgent = undefined;
+        if (this.#reconnectTimer) {
+            clearTimeout(this.#reconnectTimer);
+            this.#reconnectTimer = undefined;
+        }
+        this.#stream?.close();
+        this.#stream = undefined;
+        logger.debug(formatCompact({ op: 'disconnect', endpoint: this.#options.config.name, mode: 'sse' }));
+    }
+    async send({ target, payload }) {
+        const message = formatOutboundSegments(payload);
+        const { action, params } = buildSendAction(target, message);
+        const data = await this.callApi(action, params);
+        const messageId = formatOutboundMessageId(target, data?.message_seq);
+        logger.debug(formatCompact({
+            op: 'milky_send',
+            endpoint: this.#options.config.name,
+            target,
+            messageId,
+            mode: 'sse',
+        }));
+        return messageId;
+    }
+    callApi(action, params = {}) {
+        return this.#callApi(this.apiOptions(), action, params);
+    }
+    async recallMessage(id) {
+        const parsed = parseMilkyMessageId(id);
+        if (!parsed)
+            throw new Error(`Invalid message id: ${id}`);
+        if (parsed.message_scene === 'group') {
+            await this.callApi('recall_group_message', {
+                group_id: parsed.peer_id,
+                message_seq: parsed.message_seq,
+            });
+        }
+        else {
+            await this.callApi('recall_private_message', {
+                user_id: parsed.peer_id,
+                message_seq: parsed.message_seq,
+            });
+        }
+    }
+    async kickMember(groupId, userId, rejectAddRequest = false) {
+        await this.callApi('kick_group_member', {
+            group_id: groupId,
+            user_id: userId,
+            reject_add_request: rejectAddRequest,
+        });
+        return true;
+    }
+    async muteMember(groupId, userId, duration = 600) {
+        await this.callApi('set_group_member_mute', {
+            group_id: groupId,
+            user_id: userId,
+            duration,
+        });
+        return true;
+    }
+    async muteAll(groupId, enable = true) {
+        await this.callApi('set_group_whole_mute', { group_id: groupId, is_mute: enable });
+        return true;
+    }
+    async setAdmin(groupId, userId, enable = true) {
+        await this.callApi('set_group_member_admin', {
+            group_id: groupId,
+            user_id: userId,
+            is_set: enable,
+        });
+        return true;
+    }
+    async setCard(groupId, userId, card) {
+        await this.callApi('set_group_member_card', {
+            group_id: groupId,
+            user_id: userId,
+            card,
+        });
+        return true;
+    }
+    async setTitle(groupId, userId, title) {
+        await this.callApi('set_group_member_special_title', {
+            group_id: groupId,
+            user_id: userId,
+            special_title: title,
+        });
+        return true;
+    }
+    async setGroupName(groupId, name) {
+        await this.callApi('set_group_name', { group_id: groupId, new_group_name: name });
+        return true;
+    }
+    async getMemberList(groupId) {
+        return this.callApi('get_group_member_list', { group_id: groupId });
+    }
+    async getGroupInfo(groupId) {
+        return this.callApi('get_group_info', { group_id: groupId });
+    }
+    admit(event) {
+        const data = parseMessageReceiveData(event);
+        if (!this.#open || !data)
+            return;
+        this.#admitMessage(data, event);
+    }
+    apiOptions() {
+        return {
+            baseUrl: this.#options.config.baseUrl,
+            access_token: this.#options.config.access_token,
+        };
+    }
+    #admitMessage(data, event) {
+        const target = formatInboundTarget(data);
+        const content = formatInboundContent(data);
+        const audioUrl = extractInboundAudioUrl(data);
+        const nickname = senderNickname(data);
+        const mentioned = isMentioned(data, event.self_id);
+        void this.#options.gateway.receive({
+            adapter: this.#options.id,
+            target,
+            content,
+            sender: String(data.sender_id),
+            id: formatInboundMessageId(data),
+            metadata: Object.freeze({
+                message_scene: data.message_scene,
+                peer_id: String(data.peer_id),
+                sender_id: String(data.sender_id),
+                message_seq: data.message_seq,
+                endpoint: this.#options.config.name,
+                time: data.time ?? event.time,
+                self_id: event.self_id != null ? String(event.self_id) : undefined,
+                ...(nickname ? { nickname } : {}),
+                ...(mentioned ? { mentioned: true } : {}),
+                ...(audioUrl ? { audio_url: audioUrl } : {}),
+            }),
+        }).catch((err) => {
+            logger.warn(formatCompact({
+                op: 'milky_gateway_receive_failed',
+                target,
+                error: err instanceof Error ? err.message : String(err),
+            }));
+        });
+    }
+    async #connect() {
+        const { url, headers, safeUrl } = buildSseConnectOptions(this.#options.config);
+        const create = this.#options.createSseStream ?? ((opts) => openSseStream(opts));
+        await new Promise((resolve, reject) => {
+            let settled = false;
+            const stream = create({
+                url,
+                headers,
+                onOpen: () => {
+                    if (settled)
+                        return;
+                    settled = true;
+                    logger.debug(formatCompact({
+                        endpoint: this.#options.config.name,
+                        mode: 'sse',
+                        url: safeUrl,
+                    }));
+                    resolve();
+                },
+                onMessage: (data) => this.#onMessage(data),
+                onError: (error) => {
+                    logger.warn(formatCompact({
+                        op: 'sse_error',
+                        endpoint: this.#options.config.name,
+                        ok: false,
+                        error: error.message,
+                    }));
+                    if (!settled) {
+                        settled = true;
+                        reject(error);
+                    }
+                },
+            });
+            this.#stream = stream;
+            void stream.closed.then(() => {
+                if (this.#stopping)
+                    return;
+                logger.warn(formatCompact({
+                    op: 'disconnect',
+                    endpoint: this.#options.config.name,
+                    mode: 'sse',
+                    reconnect_ms: this.#options.config.reconnect_interval,
+                }));
+                if (!settled) {
+                    settled = true;
+                    reject(new Error('Milky SSE closed before open'));
+                }
+                this.#scheduleReconnect();
+            });
+        });
+    }
+    #onMessage(data) {
+        try {
+            const event = JSON.parse(data);
+            this.admit(event);
+        }
+        catch (error) {
+            logger.warn(formatCompact({
+                op: 'milky_parse_failed',
+                endpoint: this.#options.config.name,
+                mode: 'sse',
+                error: error instanceof Error ? error.message : String(error),
+            }));
+        }
+    }
+    #scheduleReconnect() {
+        if (this.#stopping || !this.#started || this.#reconnectTimer)
+            return;
+        const delay = this.#options.config.reconnect_interval;
+        this.#reconnectTimer = setTimeout(() => {
+            this.#reconnectTimer = undefined;
+            void this.#connect().catch((err) => {
+                logger.warn(formatCompact({
+                    op: 'reconnect',
+                    endpoint: this.#options.config.name,
+                    mode: 'sse',
+                    ok: false,
+                    error: err instanceof Error ? err.message : String(err),
+                }));
+            });
+        }, delay);
+    }
+}

package/lib/webhook-endpoint.d.ts

@@ -0,0 +1,40 @@
+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 { callApi, type MilkyEvent, type MilkyWebhookConfig } from './protocol.js';
+export interface MilkyWebhookEndpointOptions {
+    readonly id: CapabilityId;
+    readonly gateway: MessageGateway;
+    readonly http: HttpHost;
+    readonly config: MilkyWebhookConfig;
+    readonly callApi?: typeof callApi;
+}
+export declare class MilkyWebhookEndpoint implements EndpointInstance {
+    #private;
+    constructor(options: MilkyWebhookEndpointOptions);
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ target, payload }: {
+        readonly target: string;
+        readonly payload: unknown;
+    }): Promise<string>;
+    callApi(action: string, params?: Record<string, unknown>): Promise<unknown>;
+    recallMessage(id: string): Promise<void>;
+    kickMember(groupId: number, userId: number, rejectAddRequest?: boolean): Promise<boolean>;
+    muteMember(groupId: number, userId: number, duration?: number): Promise<boolean>;
+    muteAll(groupId: number, enable?: boolean): Promise<boolean>;
+    setAdmin(groupId: number, userId: number, enable?: boolean): Promise<boolean>;
+    setCard(groupId: number, userId: number, card: string): Promise<boolean>;
+    setTitle(groupId: number, userId: number, title: string): Promise<boolean>;
+    setGroupName(groupId: number, name: string): Promise<boolean>;
+    getMemberList(groupId: number): Promise<unknown[]>;
+    getGroupInfo(groupId: number): Promise<unknown>;
+    admit(event: MilkyEvent): void;
+    apiOptions(): {
+        baseUrl: string;
+        access_token?: string;
+    };
+}

package/lib/webhook-endpoint.js

@@ -0,0 +1,212 @@
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { readRequestBody, verifyMilkyAccessToken } from './milky-auth.js';
+import { registerMilkyAgentEndpoint } from './milky-agent-deps.js';
+import { buildSendAction, callApi, extractInboundAudioUrl, formatInboundContent, formatInboundMessageId, formatInboundTarget, formatOutboundMessageId, formatOutboundSegments, isMentioned, parseMessageReceiveData, parseMilkyMessageId, senderNickname, } from './protocol.js';
+const logger = getLogger('milky');
+export class MilkyWebhookEndpoint {
+    #options;
+    #callApi;
+    #routeReleases = [];
+    #open = false;
+    #started = false;
+    #unregisterAgent;
+    constructor(options) {
+        this.#options = options;
+        this.#callApi = options.callApi ?? callApi;
+    }
+    async start() {
+        if (this.#started)
+            return;
+        this.#started = true;
+        this.#unregisterAgent = registerMilkyAgentEndpoint(this.#options.config.name, this);
+        this.#setupRoutes();
+        logger.info(formatCompact({
+            op: 'listen',
+            endpoint: this.#options.config.name,
+            mode: 'webhook',
+            path: this.#options.config.path,
+        }));
+    }
+    open() {
+        this.#open = true;
+    }
+    close() {
+        this.#open = false;
+    }
+    async stop() {
+        this.#open = false;
+        for (const release of this.#routeReleases.splice(0))
+            release();
+        this.#unregisterAgent?.();
+        this.#unregisterAgent = undefined;
+        this.#started = false;
+        logger.debug(formatCompact({ op: 'disconnect', endpoint: this.#options.config.name }));
+    }
+    async send({ target, payload }) {
+        const message = formatOutboundSegments(payload);
+        const { action, params } = buildSendAction(target, message);
+        const data = await this.callApi(action, params);
+        const messageId = formatOutboundMessageId(target, data?.message_seq);
+        logger.debug(formatCompact({
+            op: 'milky_send',
+            endpoint: this.#options.config.name,
+            target,
+            messageId,
+        }));
+        return messageId;
+    }
+    callApi(action, params = {}) {
+        return this.#callApi(this.apiOptions(), action, params);
+    }
+    async recallMessage(id) {
+        const parsed = parseMilkyMessageId(id);
+        if (!parsed)
+            throw new Error(`Invalid message id: ${id}`);
+        if (parsed.message_scene === 'group') {
+            await this.callApi('recall_group_message', {
+                group_id: parsed.peer_id,
+                message_seq: parsed.message_seq,
+            });
+        }
+        else {
+            await this.callApi('recall_private_message', {
+                user_id: parsed.peer_id,
+                message_seq: parsed.message_seq,
+            });
+        }
+    }
+    async kickMember(groupId, userId, rejectAddRequest = false) {
+        await this.callApi('kick_group_member', {
+            group_id: groupId,
+            user_id: userId,
+            reject_add_request: rejectAddRequest,
+        });
+        return true;
+    }
+    async muteMember(groupId, userId, duration = 600) {
+        await this.callApi('set_group_member_mute', {
+            group_id: groupId,
+            user_id: userId,
+            duration,
+        });
+        return true;
+    }
+    async muteAll(groupId, enable = true) {
+        await this.callApi('set_group_whole_mute', { group_id: groupId, is_mute: enable });
+        return true;
+    }
+    async setAdmin(groupId, userId, enable = true) {
+        await this.callApi('set_group_member_admin', {
+            group_id: groupId,
+            user_id: userId,
+            is_set: enable,
+        });
+        return true;
+    }
+    async setCard(groupId, userId, card) {
+        await this.callApi('set_group_member_card', {
+            group_id: groupId,
+            user_id: userId,
+            card,
+        });
+        return true;
+    }
+    async setTitle(groupId, userId, title) {
+        await this.callApi('set_group_member_special_title', {
+            group_id: groupId,
+            user_id: userId,
+            special_title: title,
+        });
+        return true;
+    }
+    async setGroupName(groupId, name) {
+        await this.callApi('set_group_name', { group_id: groupId, new_group_name: name });
+        return true;
+    }
+    async getMemberList(groupId) {
+        return this.callApi('get_group_member_list', { group_id: groupId });
+    }
+    async getGroupInfo(groupId) {
+        return this.callApi('get_group_info', { group_id: groupId });
+    }
+    admit(event) {
+        const data = parseMessageReceiveData(event);
+        if (!this.#open || !data)
+            return;
+        this.#admitMessage(data, event);
+    }
+    apiOptions() {
+        return {
+            baseUrl: this.#options.config.baseUrl,
+            access_token: this.#options.config.access_token,
+        };
+    }
+    #admitMessage(data, event) {
+        const target = formatInboundTarget(data);
+        const content = formatInboundContent(data);
+        const audioUrl = extractInboundAudioUrl(data);
+        const nickname = senderNickname(data);
+        const mentioned = isMentioned(data, event.self_id);
+        void this.#options.gateway.receive({
+            adapter: this.#options.id,
+            target,
+            content,
+            sender: String(data.sender_id),
+            id: formatInboundMessageId(data),
+            metadata: Object.freeze({
+                message_scene: data.message_scene,
+                peer_id: String(data.peer_id),
+                sender_id: String(data.sender_id),
+                message_seq: data.message_seq,
+                endpoint: this.#options.config.name,
+                time: data.time ?? event.time,
+                self_id: event.self_id != null ? String(event.self_id) : undefined,
+                ...(nickname ? { nickname } : {}),
+                ...(mentioned ? { mentioned: true } : {}),
+                ...(audioUrl ? { audio_url: audioUrl } : {}),
+            }),
+        }).catch((err) => {
+            logger.warn(formatCompact({
+                op: 'milky_gateway_receive_failed',
+                target,
+                error: err instanceof Error ? err.message : String(err),
+            }));
+        });
+    }
+    #setupRoutes() {
+        const path = this.#options.config.path;
+        this.#routeReleases.push(this.#options.http.route('POST', path, async (request, response) => {
+            await this.#handleWebhook(request, response);
+        }, { summary: 'Milky webhook callback', tags: ['milky'] }));
+    }
+    async #handleWebhook(request, response) {
+        try {
+            if (!verifyMilkyAccessToken(this.#options.config.access_token, request)) {
+                response.writeHead(403, { 'Content-Type': 'application/json' });
+                response.end(JSON.stringify({ message: 'Unauthorized' }));
+                return;
+            }
+            const raw = await readRequestBody(request);
+            let event;
+            try {
+                event = JSON.parse(raw);
+            }
+            catch {
+                response.writeHead(400, { 'Content-Type': 'application/json' });
+                response.end(JSON.stringify({ message: 'Invalid JSON' }));
+                return;
+            }
+            if (this.#open)
+                this.admit(event);
+            response.writeHead(200, { 'Content-Type': 'application/json' });
+            response.end(JSON.stringify({ status: 'ok' }));
+        }
+        catch (error) {
+            logger.error('Milky webhook error:', error);
+            if (!response.headersSent) {
+                response.writeHead(500, { 'Content-Type': 'application/json' });
+                response.end(JSON.stringify({ message: 'Internal Server Error' }));
+            }
+        }
+    }
+}