@nextclaw/channel-plugin-feishu 0.2.18 → 0.2.20

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.
package/src/sheets.ts CHANGED
@@ -1,40 +1,18 @@
1
1
  import { Type } from "@sinclair/typebox";
2
2
  import type { OpenClawPluginApi } from "./nextclaw-sdk/feishu.js";
3
3
  import { listEnabledFeishuAccounts } from "./accounts.js";
4
- import { wwwDomain } from "./domains.js";
5
- import { resolveAnyEnabledFeishuToolsConfig } from "./tool-account.js";
6
4
  import {
7
- assertLarkOk,
8
- createToolContext,
9
- handleInvokeError,
10
- json,
11
- registerTool,
12
- StringEnum,
13
- } from "./user-tool-helpers.js";
14
-
15
- const MAX_READ_ROWS = 200;
16
- const MAX_WRITE_ROWS = 5000;
17
- const MAX_WRITE_COLS = 100;
18
-
19
- type SheetParams = {
20
- action: "info" | "read" | "write" | "append" | "find" | "create" | "export";
21
- url?: string;
22
- spreadsheet_token?: string;
23
- range?: string;
24
- sheet_id?: string;
25
- value_render_option?: "FormattedValue" | "UnformattedValue" | "Formula" | "ToString";
26
- values?: unknown[][];
27
- find?: string;
28
- match_case?: boolean;
29
- match_entire_cell?: boolean;
30
- search_by_regex?: boolean;
31
- include_formulas?: boolean;
32
- title?: string;
33
- folder_token?: string;
34
- headers?: unknown[];
35
- data?: unknown[][];
36
- file_extension?: "xlsx" | "csv";
37
- };
5
+ type SheetParams,
6
+ handleCreate,
7
+ handleExport,
8
+ handleFind,
9
+ handleInfo,
10
+ handleRead,
11
+ handleWrite,
12
+ resolveToken,
13
+ } from "./sheets-shared.js";
14
+ import { resolveAnyEnabledFeishuToolsConfig } from "./tool-account.js";
15
+ import { createToolContext, handleInvokeError, registerTool, StringEnum } from "./user-tool-helpers.js";
38
16
 
39
17
  const SheetSchema = Type.Union([
40
18
  Type.Object({ action: Type.Literal("info"), url: Type.Optional(Type.String()), spreadsheet_token: Type.Optional(Type.String()) }),
@@ -90,313 +68,6 @@ const SheetSchema = Type.Union([
90
68
  }),
91
69
  ]);
92
70
 
93
- function parseSheetUrl(url: string): { token: string; sheetId?: string } | null {
94
- try {
95
- const parsed = new URL(url);
96
- const match = parsed.pathname.match(/\/sheets\/([^/?#]+)/);
97
- if (!match) return null;
98
- return { token: match[1], sheetId: parsed.searchParams.get("sheet") || undefined };
99
- } catch {
100
- return null;
101
- }
102
- }
103
-
104
- function resolveToken(params: SheetParams) {
105
- if (params.spreadsheet_token) return { token: params.spreadsheet_token };
106
- if (params.url) return parseSheetUrl(params.url);
107
- return null;
108
- }
109
-
110
- function colLetter(n: number): string {
111
- let result = "";
112
- let value = n;
113
- while (value > 0) {
114
- value -= 1;
115
- result = String.fromCharCode(65 + (value % 26)) + result;
116
- value = Math.floor(value / 26);
117
- }
118
- return result;
119
- }
120
-
121
- function flattenCellValue(cell: unknown): unknown {
122
- if (!Array.isArray(cell)) return cell;
123
- if (cell.length > 0 && cell.every((segment) => segment && typeof segment === "object" && "text" in (segment as object))) {
124
- return cell.map((segment) => String((segment as { text?: unknown }).text ?? "")).join("");
125
- }
126
- return cell;
127
- }
128
-
129
- async function resolveSheetRange(
130
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
131
- token: string,
132
- range?: string,
133
- sheetId?: string,
134
- ) {
135
- if (range) return range;
136
- if (sheetId) return sheetId;
137
- const response = await client.invoke(
138
- "feishu_sheet.info",
139
- (sdk, opts) => sdk.sheets.spreadsheetSheet.query({ path: { spreadsheet_token: token } }, opts),
140
- { as: "user" },
141
- );
142
- assertLarkOk(response);
143
- const firstSheet = (response.data as { sheets?: Array<{ sheet_id?: string }> } | undefined)?.sheets?.[0];
144
- if (!firstSheet?.sheet_id) {
145
- throw new Error("Spreadsheet has no worksheets.");
146
- }
147
- return firstSheet.sheet_id;
148
- }
149
-
150
- async function handleCreate(
151
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
152
- payload: SheetParams,
153
- ) {
154
- const createResponse = await client.invoke(
155
- "feishu_sheet.create",
156
- (sdk, opts) =>
157
- sdk.sheets.spreadsheet.create(
158
- { data: { title: payload.title, folder_token: payload.folder_token } },
159
- opts,
160
- ),
161
- { as: "user" },
162
- );
163
- assertLarkOk(createResponse);
164
- const spreadsheet = (createResponse.data as { spreadsheet?: { spreadsheet_token?: string; title?: string } } | undefined)?.spreadsheet;
165
- const token = spreadsheet?.spreadsheet_token;
166
- if (!token) {
167
- return json({ error: "创建电子表格失败,未返回 spreadsheet_token。" });
168
- }
169
- const allRows = [
170
- ...(payload.headers ? [payload.headers] : []),
171
- ...((payload.data as unknown[][] | undefined) ?? []),
172
- ];
173
- if (allRows.length > 0) {
174
- const sheetsResponse = await client.invoke(
175
- "feishu_sheet.create",
176
- (sdk, opts) => sdk.sheets.spreadsheetSheet.query({ path: { spreadsheet_token: token } }, opts),
177
- { as: "user" },
178
- );
179
- assertLarkOk(sheetsResponse);
180
- const firstSheet = (sheetsResponse.data as { sheets?: Array<{ sheet_id?: string }> } | undefined)?.sheets?.[0];
181
- if (firstSheet?.sheet_id) {
182
- const numCols = Math.max(...allRows.map((row) => row.length), 1);
183
- const range = `${firstSheet.sheet_id}!A1:${colLetter(numCols)}${allRows.length}`;
184
- await client.invokeByPath("feishu_sheet.create", `/open-apis/sheets/v2/spreadsheets/${token}/values`, {
185
- method: "PUT",
186
- body: { valueRange: { range, values: allRows } },
187
- as: "user",
188
- });
189
- }
190
- }
191
- return json({
192
- spreadsheet_token: token,
193
- title: spreadsheet?.title ?? payload.title,
194
- url: `${wwwDomain(client.account.domain)}/sheets/${token}`,
195
- });
196
- }
197
-
198
- async function handleInfo(
199
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
200
- token: string,
201
- ) {
202
- const [spreadsheetRes, sheetsRes] = await Promise.all([
203
- client.invoke(
204
- "feishu_sheet.info",
205
- (sdk, opts) => sdk.sheets.spreadsheet.get({ path: { spreadsheet_token: token } }, opts),
206
- { as: "user" },
207
- ),
208
- client.invoke(
209
- "feishu_sheet.info",
210
- (sdk, opts) => sdk.sheets.spreadsheetSheet.query({ path: { spreadsheet_token: token } }, opts),
211
- { as: "user" },
212
- ),
213
- ]);
214
- assertLarkOk(spreadsheetRes);
215
- assertLarkOk(sheetsRes);
216
- return json({
217
- title: (spreadsheetRes.data as { spreadsheet?: { title?: string } } | undefined)?.spreadsheet?.title,
218
- spreadsheet_token: token,
219
- url: `${wwwDomain(client.account.domain)}/sheets/${token}`,
220
- sheets:
221
- ((sheetsRes.data as { sheets?: Array<Record<string, unknown>> } | undefined)?.sheets ?? []).map((sheet) => ({
222
- sheet_id: sheet.sheet_id,
223
- title: sheet.title,
224
- index: sheet.index,
225
- row_count: (sheet.grid_properties as { row_count?: number } | undefined)?.row_count,
226
- column_count: (sheet.grid_properties as { column_count?: number } | undefined)?.column_count,
227
- })),
228
- });
229
- }
230
-
231
- async function handleRead(
232
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
233
- tokenInfo: { token: string; sheetId?: string },
234
- payload: SheetParams,
235
- ) {
236
- const range = await resolveSheetRange(client, tokenInfo.token, payload.range, payload.sheet_id ?? tokenInfo.sheetId);
237
- const response = await client.invokeByPath<{
238
- data?: { valueRange?: { range?: string; values?: unknown[][] } };
239
- }>("feishu_sheet.read", `/open-apis/sheets/v2/spreadsheets/${tokenInfo.token}/values/${encodeURIComponent(range)}`, {
240
- method: "GET",
241
- query: {
242
- valueRenderOption: payload.value_render_option ?? "ToString",
243
- dateTimeRenderOption: "FormattedString",
244
- },
245
- as: "user",
246
- });
247
- const values = (response.data?.valueRange?.values ?? []).map((row) => row.map(flattenCellValue));
248
- return json({
249
- range: response.data?.valueRange?.range,
250
- values: values.slice(0, MAX_READ_ROWS),
251
- ...(values.length > MAX_READ_ROWS
252
- ? {
253
- truncated: true,
254
- total_rows: values.length,
255
- hint: `结果超过 ${MAX_READ_ROWS} 行,已截断。请缩小 range 后重试。`,
256
- }
257
- : {}),
258
- });
259
- }
260
-
261
- async function handleWrite(
262
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
263
- tokenInfo: { token: string; sheetId?: string },
264
- payload: SheetParams,
265
- ) {
266
- if ((payload.values?.length ?? 0) > MAX_WRITE_ROWS) {
267
- return json({ error: `写入行数超过限制 ${MAX_WRITE_ROWS}` });
268
- }
269
- if ((payload.values ?? []).some((row) => row.length > MAX_WRITE_COLS)) {
270
- return json({ error: `写入列数超过限制 ${MAX_WRITE_COLS}` });
271
- }
272
- const range = await resolveSheetRange(client, tokenInfo.token, payload.range, payload.sheet_id ?? tokenInfo.sheetId);
273
- const response = await client.invokeByPath<{
274
- data?: {
275
- updatedRange?: string;
276
- updatedRows?: number;
277
- updatedColumns?: number;
278
- updatedCells?: number;
279
- revision?: number;
280
- updates?: {
281
- updatedRange?: string;
282
- updatedRows?: number;
283
- updatedColumns?: number;
284
- updatedCells?: number;
285
- revision?: number;
286
- };
287
- };
288
- }>(
289
- payload.action === "write" ? "feishu_sheet.write" : "feishu_sheet.append",
290
- `/open-apis/sheets/v2/spreadsheets/${tokenInfo.token}/${payload.action === "write" ? "values" : "values_append"}`,
291
- {
292
- method: payload.action === "write" ? "PUT" : "POST",
293
- body: { valueRange: { range, values: payload.values } },
294
- as: "user",
295
- },
296
- );
297
- const updates = response.data?.updates ?? response.data;
298
- return json({
299
- updated_range: updates?.updatedRange,
300
- updated_rows: updates?.updatedRows,
301
- updated_columns: updates?.updatedColumns,
302
- updated_cells: updates?.updatedCells,
303
- revision: updates?.revision,
304
- });
305
- }
306
-
307
- async function handleFind(
308
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
309
- token: string,
310
- payload: SheetParams,
311
- ) {
312
- const response = await client.invoke(
313
- "feishu_sheet.find",
314
- (sdk, opts) =>
315
- sdk.sheets.spreadsheetSheet.find(
316
- {
317
- path: { spreadsheet_token: token, sheet_id: payload.sheet_id! },
318
- data: {
319
- find: payload.find,
320
- find_condition: {
321
- range: payload.range ? `${payload.sheet_id}!${payload.range}` : payload.sheet_id,
322
- ...(payload.match_case !== undefined ? { match_case: !payload.match_case } : {}),
323
- ...(payload.match_entire_cell !== undefined ? { match_entire_cell: payload.match_entire_cell } : {}),
324
- ...(payload.search_by_regex !== undefined ? { search_by_regex: payload.search_by_regex } : {}),
325
- ...(payload.include_formulas !== undefined ? { include_formulas: payload.include_formulas } : {}),
326
- },
327
- },
328
- },
329
- opts,
330
- ),
331
- { as: "user" },
332
- );
333
- assertLarkOk(response);
334
- return json({
335
- matched_cells: (response.data as { find_result?: { matched_cells?: unknown[] } } | undefined)?.find_result?.matched_cells ?? [],
336
- matched_formula_cells:
337
- (response.data as { find_result?: { matched_formula_cells?: unknown[] } } | undefined)?.find_result?.matched_formula_cells ?? [],
338
- });
339
- }
340
-
341
- async function handleExport(
342
- client: ReturnType<typeof createToolContext>["toolClient"] extends () => infer T ? T : never,
343
- token: string,
344
- payload: SheetParams,
345
- ) {
346
- const exportCreate = await client.invoke(
347
- "feishu_sheet.export",
348
- (sdk, opts) =>
349
- sdk.drive.exportTask.create(
350
- {
351
- data: {
352
- file_extension: payload.file_extension,
353
- token,
354
- type: "sheet",
355
- sub_id: payload.sheet_id,
356
- },
357
- },
358
- opts,
359
- ),
360
- { as: "user" },
361
- );
362
- assertLarkOk(exportCreate);
363
- const ticket = (exportCreate.data as { ticket?: string } | undefined)?.ticket;
364
- if (!ticket) {
365
- return json({ error: "导出任务创建失败,未返回 ticket。" });
366
- }
367
- for (let i = 0; i < 30; i += 1) {
368
- await new Promise((resolve) => setTimeout(resolve, 1000));
369
- const exportStatus = await client.invoke(
370
- "feishu_sheet.export",
371
- (sdk, opts) =>
372
- sdk.drive.exportTask.get({ path: { ticket }, params: { token } }, opts),
373
- { as: "user" },
374
- );
375
- assertLarkOk(exportStatus);
376
- const result = (exportStatus.data as {
377
- result?: {
378
- job_status?: number;
379
- file_token?: string;
380
- file_name?: string;
381
- file_size?: number;
382
- job_error_msg?: string;
383
- };
384
- } | undefined)?.result;
385
- if (result?.job_status === 0) {
386
- return json({
387
- file_token: result.file_token,
388
- file_name: result.file_name,
389
- file_size: result.file_size,
390
- file_extension: payload.file_extension,
391
- });
392
- }
393
- if ((result?.job_status ?? 0) >= 3) {
394
- return json({ error: result?.job_error_msg ?? `导出失败 (status=${result?.job_status})` });
395
- }
396
- }
397
- return json({ error: "导出任务超时,请稍后重试。" });
398
- }
399
-
400
71
  export function registerFeishuSheetsTools(api: OpenClawPluginApi) {
401
72
  if (!api.config) return;
402
73
  const accounts = listEnabledFeishuAccounts(api.config);
package/src/typing.ts CHANGED
@@ -3,10 +3,9 @@ import { resolveFeishuAccount } from "./accounts.js";
3
3
  import { createFeishuClient } from "./client.js";
4
4
  import { getFeishuRuntime } from "./runtime.js";
5
5
 
6
- // Feishu emoji types for typing indicator
7
- // See: https://open.feishu.cn/document/server-docs/im-v1/message-reaction/emojis-introduce
8
- // Full list: https://github.com/go-lark/lark/blob/main/emoji.go
9
- const TYPING_EMOJI = "Typing"; // Typing indicator emoji
6
+ // Feishu's Typing reaction is not consistently surfaced to users, so use a
7
+ // visible acknowledgement reaction for immediate feedback on receipt.
8
+ const TYPING_EMOJI = "THUMBSUP";
10
9
 
11
10
  /**
12
11
  * Feishu API error codes that indicate the caller should back off.
@@ -163,6 +162,10 @@ export async function removeTypingIndicator(params: {
163
162
  accountId?: string;
164
163
  runtime?: RuntimeEnv;
165
164
  }): Promise<void> {
165
+ // Keep the acknowledgement reaction visible after the reply completes.
166
+ if (TYPING_EMOJI !== "Typing") {
167
+ return;
168
+ }
166
169
  const { cfg, state, accountId, runtime } = params;
167
170
  if (!state.reactionId) {
168
171
  return;