@zhin.js/adapter-lark 1.1.18 → 1.1.20

package/lib/endpoint.d.ts

@@ -1,105 +1,14 @@
-import type { LarkCardAction } from './cards.js';
-import { Endpoint, type EndpointTransportState, type EndpointControl, type EndpointManagement, type EndpointSendRequest } from 'zhin.js/adapter';
-import type { HttpHost } from '@zhin.js/host-http';
-import type { CapabilityId } from 'zhin.js';
-import { resolveMediaBinary } from './media-upload.js';
-import { type LarkMessage, type ResolvedLarkConfig } from './protocol.js';
-import { type LarkLongConnectionFactory } from './long-connection.js';
-export type LarkFetch = (url: string, init?: {
-    readonly method?: string;
-    readonly headers?: Record<string, string>;
-    readonly body?: string | FormData;
-    readonly signal?: AbortSignal;
-}) => Promise<{
-    readonly ok: boolean;
-    readonly status: number;
-    text(): Promise<string>;
-    json(): Promise<unknown>;
-}>;
-export interface LarkEndpointOptions {
-    readonly id: CapabilityId;
-    readonly http?: HttpHost;
-    readonly longConnectionFactory?: LarkLongConnectionFactory;
-    readonly config: ResolvedLarkConfig;
-    readonly fetch?: LarkFetch;
-}
-export interface LarkClientApi {
-    getUserInfo(userId: string, userIdType?: 'open_id' | 'user_id' | 'union_id'): Promise<unknown>;
-    getChatInfo(chatId: string): Promise<unknown>;
-    uploadFile(filePath: string, fileType?: 'image' | 'file' | 'video' | 'audio'): Promise<string | null>;
-    createChat(name: string, userIds: string[], ownerId?: string): Promise<string | null>;
-    updateChatInfo(chatId: string, options: {
-        name?: string;
-        description?: string;
-    }): Promise<boolean>;
-    addChatMembers(chatId: string, userIds: string[]): Promise<boolean>;
-    removeChatMembers(chatId: string, userIds: string[]): Promise<boolean>;
-    getChatMembers(chatId: string): Promise<unknown[]>;
-    dissolveChat(chatId: string): Promise<boolean>;
-    setChatManagers(chatId: string, userIds: string[]): Promise<boolean>;
-    removeChatManagers(chatId: string, userIds: string[]): Promise<boolean>;
-}
-/** Feishu/Lark OpenAPI client surface carried by every Endpoint event. */
-export declare class LarkClient implements LarkClientApi {
-    readonly api: LarkClientApi;
-    constructor(api: LarkClientApi);
-    getUserInfo: (id: string, type?: "open_id" | "user_id" | "union_id") => Promise<unknown>;
-    getChatInfo: (id: string) => Promise<unknown>;
-    uploadFile: (path: string, type?: "image" | "file" | "video" | "audio") => Promise<string | null>;
-    createChat: (name: string, users: string[], owner?: string) => Promise<string | null>;
-    updateChatInfo: (id: string, options: {
-        name?: string;
-        description?: string;
-    }) => Promise<boolean>;
-    addChatMembers: (id: string, users: string[]) => Promise<boolean>;
-    removeChatMembers: (id: string, users: string[]) => Promise<boolean>;
-    getChatMembers: (id: string) => Promise<unknown[]>;
-    dissolveChat: (id: string) => Promise<boolean>;
-    setChatManagers: (id: string, users: string[]) => Promise<boolean>;
-    removeChatManagers: (id: string, users: string[]) => Promise<boolean>;
-}
-export declare class LarkEndpoint extends Endpoint<LarkClient> {
+import { endpointSpec, type Endpoint } from 'zhin.js/adapter';
+import { LarkClient, type LarkEndpointOptions } from './client.js';
+export type { LarkEndpointOptions } from './client.js';
+export type { LarkFetch } from './client.js';
+/** Actual protocol Client; framework lifecycle and admission stay in their symbol namespace. */
+export declare class LarkEndpoint extends LarkClient implements Endpoint {
     #private;
-    readonly client: LarkClient;
-    /**
-     * Console 社交面语义端口。Lark OpenAPI 仅接读取类列表能力：
-     * - listGroups：GET /im/v1/chats（bot 所在群列表，分页归一为 {group_id: chat_id, name}）
-     * - listGroupMembers：GET /im/v1/chats/:chat_id/members（open_id 分页，返回平台原生成员形状）
-     * 不接的项：listFriends（Lark 无好友概念，contact API 为组织通讯录而非社交关系）、
-     * listChannels（无频道/guild 概念）、写操作（审批/踢人/禁言等本轮不在范围内）。
-     */
-    readonly management: EndpointManagement;
-    readonly control: EndpointControl;
+    readonly [endpointSpec]: import("@zhin.js/adapter").EndpointSpecification;
     constructor(options: LarkEndpointOptions);
-    /** Used by webhook handler. */
-    get isOpen(): boolean;
-    get config(): ResolvedLarkConfig;
-    get transportState(): EndpointTransportState | undefined;
-    start(): Promise<void>;
-    open(): void;
-    close(): void;
-    stop(): Promise<void>;
-    send({ conversation, payload, locale }: EndpointSendRequest): Promise<string>;
-    recallMessage(messageId: string): Promise<void>;
-    /** Upload must succeed before issuing a message; dropped media is never confirmed. */
-    uploadImage(media: Parameters<typeof resolveMediaBinary>[0]): Promise<string>;
-    /** Test / internal: admit a parsed message when open (non-webhook path). */
-    admit(msg: LarkMessage): void;
-    /** Only correlate callbacks to a card actually sent by this endpoint. */
-    admitCardAction(event: LarkCardAction): void;
-    admitPlatform(name: string, event: unknown): void;
-    getUserInfo(userId: string, userIdType?: 'open_id' | 'user_id' | 'union_id'): Promise<unknown>;
-    getChatInfo(chatId: string): Promise<unknown>;
-    uploadFile(filePath: string, fileType?: 'image' | 'file' | 'video' | 'audio'): Promise<string | null>;
-    createChat(name: string, userIds: string[], ownerId?: string): Promise<string | null>;
-    updateChatInfo(chatId: string, options: {
-        name?: string;
-        description?: string;
-    }): Promise<boolean>;
-    addChatMembers(chatId: string, userIds: string[]): Promise<boolean>;
-    removeChatMembers(chatId: string, userIds: string[]): Promise<boolean>;
-    getChatMembers(chatId: string): Promise<unknown[]>;
-    dissolveChat(chatId: string): Promise<boolean>;
-    setChatManagers(chatId: string, userIds: string[]): Promise<boolean>;
-    removeChatManagers(chatId: string, userIds: string[]): Promise<boolean>;
+    protected receiveInboundCallback<T>(receive: () => T | Promise<T>): Promise<T>;
+    protected publishEvent(name: string, payload: unknown): Promise<unknown>;
+    protected publishAccepted(name: string, payload: unknown): Promise<void>;
+    protected publishPlatform(name: string, event: unknown): Promise<unknown>;
 }