@zhin.js/adapter-lark 1.0.97 → 1.1.2

package/agents/lark/system.md

@@ -0,0 +1,3 @@
+# LARK Platform Agent
+
+You are the lark platform specialist. Interpret requests in the current lark conversation and load only the narrowest private Skill needed for the task.

package/commands/lark/endpoint/add/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { larkEndpointCommands } from '../../definition.js';
+export default larkEndpointCommands.add;

package/commands/lark/endpoint/add/[id]/index.ts

@@ -0,0 +1,3 @@
+import { larkEndpointCommands } from '../../definition.js';
+
+export default larkEndpointCommands.add;

package/commands/lark/endpoint/definition.js

@@ -0,0 +1,20 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+/**
+ * `lark endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/lark/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { larkRuntimeStateToken } from "../../../lib/lark-runtime-state.js";
+export const larkEndpointCommands = createEndpointCommands({
+    adapterKey: 'lark',
+    adapterDisplayName: 'Lark',
+    fields: [
+        { key: 'appId', required: true, env: true, description: '飞书 App ID' },
+        { key: 'appSecret', required: true, env: true, description: '飞书 App Secret' },
+        { key: 'encryptKey', env: true, description: '事件加密 key' },
+        { key: 'verificationToken', env: true, description: '事件验证 token' },
+    ],
+    running: (use) => use(larkRuntimeStateToken).endpoints.values(),
+    describeEntry: (entry) => `appId: ${String(entry.appId)}`,
+}, defineCommand);

package/commands/lark/endpoint/definition.ts

@@ -0,0 +1,20 @@
+/**
+ * `lark endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/lark/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { larkRuntimeStateToken } from '../../../src/lark-runtime-state.js';
+
+export const larkEndpointCommands = createEndpointCommands({
+  adapterKey: 'lark',
+  adapterDisplayName: 'Lark',
+  fields: [
+    { key: 'appId', required: true, env: true, description: '飞书 App ID' },
+    { key: 'appSecret', required: true, env: true, description: '飞书 App Secret' },
+    { key: 'encryptKey', env: true, description: '事件加密 key' },
+    { key: 'verificationToken', env: true, description: '事件验证 token' },
+  ],
+  running: (use) => use(larkRuntimeStateToken).endpoints.values(),
+  describeEntry: (entry) => `appId: ${String(entry.appId)}`,
+}, defineCommand);

package/commands/lark/endpoint/list/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { larkEndpointCommands } from '../definition.js';
+export default larkEndpointCommands.list;

package/commands/lark/endpoint/list/index.ts

@@ -0,0 +1,3 @@
+import { larkEndpointCommands } from '../definition.js';
+
+export default larkEndpointCommands.list;

package/commands/lark/endpoint/remove/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { larkEndpointCommands } from '../../definition.js';
+export default larkEndpointCommands.remove;

package/commands/lark/endpoint/remove/[id]/index.ts

@@ -0,0 +1,3 @@
+import { larkEndpointCommands } from '../../definition.js';
+
+export default larkEndpointCommands.remove;

package/lib/client.d.ts

@@ -0,0 +1,12 @@
+import type { LarkClient } from './endpoint.js';
+import type { LarkEventBody } from './protocol.js';
+export type LarkClientEventMap = Record<string, LarkEventBody>;
+declare module '@zhin.js/feature-kit' {
+    interface AdapterClientRegistry {
+        readonly lark: {
+            readonly client: LarkClient;
+            readonly events: LarkClientEventMap;
+        };
+    }
+}
+export declare const larkClient: import("@zhin.js/adapter").EndpointClientToken<LarkClient, LarkClientEventMap>;

package/lib/client.js

@@ -0,0 +1,2 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+export const larkClient = defineEndpointClient('lark');

package/lib/endpoint.d.ts

@@ -0,0 +1,100 @@
+import { Endpoint } from 'zhin.js/adapter';
+import { 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';
+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 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> {
+    #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;
+    constructor(options: LarkEndpointOptions);
+    /** Used by webhook handler. */
+    get isOpen(): boolean;
+    get config(): ResolvedLarkConfig;
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
+    recallMessage(messageId: string): Promise<void>;
+    /** POST /im/v1/images（image_type=message），返回 image_key；失败返回 null。 */
+    uploadImage(media: Parameters<typeof resolveMediaBinary>[0]): Promise<string | null>;
+    /** Test / internal: admit a parsed message when open (non-webhook path). */
+    admit(msg: LarkMessage): 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>;
+}