@larksuite/openclaw-lark 2026.3.9

package/src/tools/oauth-cards.js

@@ -0,0 +1,251 @@
+/**
+ * Copyright (c) 2026 ByteDance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ *
+ * oauth-cards.ts — OAuth 授权卡片构建函数。
+ *
+ * 从 oauth.ts 提取的纯 UI 函数，与 OAuth 业务流程解耦。
+ */
+// ---------------------------------------------------------------------------
+// Card builders
+// ---------------------------------------------------------------------------
+export function buildAuthCard(params) {
+    const { verificationUriComplete, expiresMin, scope, isBatchAuth, totalAppScopes, alreadyGranted, batchInfo, filteredScopes, appId, showBatchAuthHint, } = params;
+    const inAppUrl = toInAppWebUrl(verificationUriComplete);
+    const multiUrl = {
+        url: inAppUrl,
+        pc_url: inAppUrl,
+        android_url: inAppUrl,
+        ios_url: inAppUrl,
+    };
+    // 将 scope 转成可读说明
+    const scopeDesc = formatScopeDescription(scope, isBatchAuth, totalAppScopes, alreadyGranted, batchInfo, filteredScopes, appId);
+    const elements = [
+        // 授权说明
+        {
+            tag: 'markdown',
+            content: scopeDesc,
+            text_size: 'normal',
+        },
+        // 授权按钮（small，靠右）
+        {
+            tag: 'column_set',
+            flex_mode: 'none',
+            horizontal_align: 'right',
+            columns: [
+                {
+                    tag: 'column',
+                    width: 'auto',
+                    elements: [
+                        {
+                            tag: 'button',
+                            text: { tag: 'plain_text', content: '前往授权' },
+                            type: 'primary',
+                            size: 'medium',
+                            multi_url: multiUrl,
+                        },
+                    ],
+                },
+            ],
+        },
+        // 失效时间提醒
+        {
+            tag: 'markdown',
+            content: `<font color='grey'>授权链接将在 ${expiresMin} 分钟后失效，届时需重新发起</font>`,
+            text_size: 'notation',
+        },
+        // 批量授权提示（仅 auto-auth 流程展示）
+        ...(showBatchAuthHint
+            ? [
+                {
+                    tag: 'markdown',
+                    content: "<font color='grey'>💡如果你希望一次性授予所有插件所需要的权限，可以告诉我「授予所有用户权限」，我会协助你完成。</font>",
+                    text_size: 'notation',
+                },
+            ]
+            : []),
+    ];
+    return {
+        schema: '2.0',
+        config: {
+            wide_screen_mode: false,
+            style: {
+                color: {
+                    'light-yellow-bg': {
+                        light_mode: 'rgba(255, 214, 102, 0.12)',
+                        dark_mode: 'rgba(255, 214, 102, 0.08)',
+                    },
+                },
+            },
+        },
+        header: {
+            title: {
+                tag: 'plain_text',
+                content: '需要您的授权才能继续',
+            },
+            subtitle: {
+                tag: 'plain_text',
+                content: '',
+            },
+            template: 'blue',
+            padding: '12px 12px 12px 12px',
+            icon: {
+                tag: 'standard_icon',
+                token: 'lock-chat_filled',
+            },
+        },
+        body: { elements },
+    };
+}
+/** scope 字符串 → 可读描述 */
+export function formatScopeDescription(scope, isBatchAuth, totalAppScopes, alreadyGranted, batchInfo, _filteredScopes, _appId) {
+    const scopes = scope?.split(/\s+/).filter(Boolean);
+    if (isBatchAuth && scopes && scopes.length > 0) {
+        let message = `应用需要授权 **${scopes.length}** 个用户权限（共 ${totalAppScopes} 个，已授权 ${alreadyGranted} 个）。`;
+        // 如果超过 5 个 scope，只显示前 3 个，然后用"..."表示
+        if (scopes.length > 5) {
+            const previewScopes = scopes.slice(0, 3).join('\n');
+            message += `\n\n**将要授权的权限**：\n${previewScopes}\n...\n`;
+        }
+        else {
+            const scopeList = scopes.map((s, idx) => `${idx + 1}. ${s}`).join('\n');
+            message += `\n\n**将要授权的权限列表**：\n${scopeList}\n`;
+        }
+        // 添加分批提示信息
+        if (batchInfo) {
+            message += `\n\n${batchInfo}`;
+        }
+        return message;
+    }
+    const desc = '授权后，应用将能够以您的身份执行相关操作。';
+    if (!scopes?.length)
+        return desc;
+    const message = desc + '\n\n所需权限：\n' + scopes.map((s) => `- ${s}`).join('\n');
+    return message;
+}
+export function toInAppWebUrl(targetUrl) {
+    const encoded = encodeURIComponent(targetUrl);
+    const lkMeta = encodeURIComponent(JSON.stringify({
+        'page-meta': {
+            showNavBar: 'false',
+            showBottomNavBar: 'false',
+        },
+    }));
+    return ('https://applink.feishu.cn/client/web_url/open' +
+        `?mode=sidebar-semi&max_width=800&reload=false&url=${encoded}&lk_meta=${lkMeta}`);
+}
+export function buildAuthSuccessCard() {
+    return {
+        schema: '2.0',
+        config: {
+            wide_screen_mode: false,
+            style: {
+                color: {
+                    'light-green-bg': {
+                        light_mode: 'rgba(52, 199, 89, 0.12)',
+                        dark_mode: 'rgba(52, 199, 89, 0.08)',
+                    },
+                },
+            },
+        },
+        header: {
+            title: {
+                tag: 'plain_text',
+                content: '授权成功',
+            },
+            subtitle: {
+                tag: 'plain_text',
+                content: '',
+            },
+            template: 'green',
+            padding: '12px 12px 12px 12px',
+            icon: {
+                tag: 'standard_icon',
+                token: 'yes_filled',
+            },
+        },
+        body: {
+            elements: [
+                {
+                    tag: 'markdown',
+                    content: '您的飞书账号已成功授权，正在为您继续执行操作。\n\n' +
+                        "<font color='grey'>如需撤销授权，可随时告诉我。</font>",
+                },
+            ],
+        },
+    };
+}
+export function buildAuthFailedCard(_reason) {
+    return {
+        schema: '2.0',
+        config: {
+            wide_screen_mode: false,
+            style: {
+                color: {
+                    'light-grey-bg': {
+                        light_mode: 'rgba(142, 142, 147, 0.12)',
+                        dark_mode: 'rgba(142, 142, 147, 0.08)',
+                    },
+                },
+            },
+        },
+        header: {
+            title: {
+                tag: 'plain_text',
+                content: '授权未完成',
+            },
+            subtitle: {
+                tag: 'plain_text',
+                content: '',
+            },
+            template: 'yellow',
+            padding: '12px 12px 12px 12px',
+            icon: {
+                tag: 'standard_icon',
+                token: 'warning_filled',
+            },
+        },
+        body: {
+            elements: [
+                {
+                    tag: 'markdown',
+                    content: '授权链接已过期，请重新发起授权。',
+                },
+            ],
+        },
+    };
+}
+export function buildAuthIdentityMismatchCard() {
+    return {
+        schema: '2.0',
+        config: {
+            wide_screen_mode: false,
+        },
+        header: {
+            title: {
+                tag: 'plain_text',
+                content: '授权失败，操作账号与发起账号不一致',
+            },
+            subtitle: {
+                tag: 'plain_text',
+                content: '',
+            },
+            template: 'red',
+            padding: '12px 12px 12px 12px',
+            icon: {
+                tag: 'standard_icon',
+                token: 'close_filled',
+            },
+        },
+        body: {
+            elements: [
+                {
+                    tag: 'markdown',
+                    content: '检测到当前进行授权操作的飞书账号与发起授权请求的账号不一致。为保障数据安全，本次授权已被拒绝。\n\n' +
+                        "<font color='grey'>请授权请求的发起人使用其账号，点击授权链接完成授权。</font>",
+                },
+            ],
+        },
+    };
+}
+//# sourceMappingURL=oauth-cards.js.map

package/src/tools/oauth-cards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth-cards.js","sourceRoot":"","sources":["../../../src/tools/oauth-cards.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,8EAA8E;AAC9E,gBAAgB;AAChB,8EAA8E;AAE9E,MAAM,UAAU,aAAa,CAAC,MAW7B;IACC,MAAM,EACJ,uBAAuB,EACvB,UAAU,EACV,KAAK,EACL,WAAW,EACX,cAAc,EACd,cAAc,EACd,SAAS,EACT,cAAc,EACd,KAAK,EACL,iBAAiB,GAClB,GAAG,MAAM,CAAC;IACX,MAAM,QAAQ,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG;QACf,GAAG,EAAE,QAAQ;QACb,MAAM,EAAE,QAAQ;QAChB,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,QAAQ;KAClB,CAAC;IAEF,iBAAiB;IACjB,MAAM,SAAS,GAAG,sBAAsB,CACtC,KAAK,EACL,WAAW,EACX,cAAc,EACd,cAAc,EACd,SAAS,EACT,cAAc,EACd,KAAK,CACN,CAAC;IAEF,MAAM,QAAQ,GAA8B;QAC1C,OAAO;QACP;YACE,GAAG,EAAE,UAAU;YACf,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,QAAQ;SACpB;QACD,iBAAiB;QACjB;YACE,GAAG,EAAE,YAAY;YACjB,SAAS,EAAE,MAAM;YACjB,gBAAgB,EAAE,OAAO;YACzB,OAAO,EAAE;gBACP;oBACE,GAAG,EAAE,QAAQ;oBACb,KAAK,EAAE,MAAM;oBACb,QAAQ,EAAE;wBACR;4BACE,GAAG,EAAE,QAAQ;4BACb,IAAI,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE;4BAC5C,IAAI,EAAE,SAAS;4BACf,IAAI,EAAE,QAAQ;4BACd,SAAS,EAAE,QAAQ;yBACpB;qBACF;iBACF;aACF;SACF;QACD,SAAS;QACT;YACE,GAAG,EAAE,UAAU;YACf,OAAO,EAAE,6BAA6B,UAAU,uBAAuB;YACvE,SAAS,EAAE,UAAU;SACtB;QACD,2BAA2B;QAC3B,GAAG,CAAC,iBAAiB;YACnB,CAAC,CAAC;gBACE;oBACE,GAAG,EAAE,UAAU;oBACf,OAAO,EACL,2EAA2E;oBAC7E,SAAS,EAAE,UAAU;iBACtB;aACF;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,KAAK;QACb,MAAM,EAAE;YACN,gBAAgB,EAAE,KAAK;YACvB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,iBAAiB,EAAE;wBACjB,UAAU,EAAE,2BAA2B;wBACvC,SAAS,EAAE,2BAA2B;qBACvC;iBACF;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,YAAY;aACtB;YACD,QAAQ,EAAE;gBACR,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,EAAE;aACZ;YACD,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE;gBACJ,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,kBAAkB;aAC1B;SACF;QACD,IAAI,EAAE,EAAE,QAAQ,EAAE;KACnB,CAAC;AACJ,CAAC;AAED,uBAAuB;AACvB,MAAM,UAAU,sBAAsB,CACpC,KAAc,EACd,WAAqB,EACrB,cAAuB,EACvB,cAAuB,EACvB,SAAkB,EAClB,eAA0B,EAC1B,MAAe;IAEf,MAAM,MAAM,GAAG,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnD,IAAI,WAAW,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,OAAO,GAAG,YAAY,MAAM,CAAC,MAAM,cAAc,cAAc,UAAU,cAAc,MAAM,CAAC;QAElG,qCAAqC;QACrC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,IAAI,qBAAqB,aAAa,SAAS,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxE,OAAO,IAAI,uBAAuB,SAAS,IAAI,CAAC;QAClD,CAAC;QAED,WAAW;QACX,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,IAAI,OAAO,SAAS,EAAE,CAAC;QAChC,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,GAAG,uBAAuB,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE,MAAM;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,SAAiB;IAC7C,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,kBAAkB,CAC/B,IAAI,CAAC,SAAS,CAAC;QACb,WAAW,EAAE;YACX,UAAU,EAAE,OAAO;YACnB,gBAAgB,EAAE,OAAO;SAC1B;KACF,CAAC,CACH,CAAC;IACF,OAAO,CACL,+CAA+C;QAC/C,qDAAqD,OAAO,YAAY,MAAM,EAAE,CACjF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL,MAAM,EAAE,KAAK;QACb,MAAM,EAAE;YACN,gBAAgB,EAAE,KAAK;YACvB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,gBAAgB,EAAE;wBAChB,UAAU,EAAE,yBAAyB;wBACrC,SAAS,EAAE,yBAAyB;qBACrC;iBACF;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,MAAM;aAChB;YACD,QAAQ,EAAE;gBACR,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,EAAE;aACZ;YACD,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE;gBACJ,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,YAAY;aACpB;SACF;QACD,IAAI,EAAE;YACJ,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,UAAU;oBACf,OAAO,EACL,6BAA6B;wBAC7B,0CAA0C;iBAC7C;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAe;IACjD,OAAO;QACL,MAAM,EAAE,KAAK;QACb,MAAM,EAAE;YACN,gBAAgB,EAAE,KAAK;YACvB,KAAK,EAAE;gBACL,KAAK,EAAE;oBACL,eAAe,EAAE;wBACf,UAAU,EAAE,2BAA2B;wBACvC,SAAS,EAAE,2BAA2B;qBACvC;iBACF;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,OAAO;aACjB;YACD,QAAQ,EAAE;gBACR,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,EAAE;aACZ;YACD,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE;gBACJ,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,gBAAgB;aACxB;SACF;QACD,IAAI,EAAE;YACJ,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,UAAU;oBACf,OAAO,EAAE,kBAAkB;iBAC5B;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,6BAA6B;IAC3C,OAAO;QACL,MAAM,EAAE,KAAK;QACb,MAAM,EAAE;YACN,gBAAgB,EAAE,KAAK;SACxB;QACD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,mBAAmB;aAC7B;YACD,QAAQ,EAAE;gBACR,GAAG,EAAE,YAAY;gBACjB,OAAO,EAAE,EAAE;aACZ;YACD,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE;gBACJ,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,cAAc;aACtB;SACF;QACD,IAAI,EAAE;YACJ,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,UAAU;oBACf,OAAO,EACL,qDAAqD;wBACrD,sDAAsD;iBACzD;aACF;SACF;KACF,CAAC;AACJ,CAAC"}

package/src/tools/oauth.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2026 ByteDance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ *
+ * feishu_oauth tool — User OAuth authorisation management.
+ *
+ * Actions:
+ *   - authorize : Initiate Device Flow, send auth card, poll for token.
+ *   - status    : Check whether the current user has a valid UAT.
+ *   - revoke    : Remove the current user's stored UAT.
+ *
+ * Security:
+ *   - **Does not** accept a `user_open_id` parameter.  The target user is
+ *     always the message sender, obtained from the LarkTicket.
+ *   - Token values are never included in the return payload (AI cannot see
+ *     them).
+ */
+import type { OpenClawPluginApi, ClawdbotConfig } from 'openclaw/plugin-sdk';
+import type { ConfiguredLarkAccount } from '../core/types';
+import type { LarkTicket } from '../core/lark-ticket';
+export declare function registerFeishuOAuthTool(api: OpenClawPluginApi): void;
+export interface ExecuteAuthorizeParams {
+    account: ConfiguredLarkAccount;
+    senderOpenId: string;
+    scope: string;
+    isBatchAuth?: boolean;
+    totalAppScopes?: number;
+    alreadyGranted?: number;
+    batchInfo?: string;
+    skipSyntheticMessage?: boolean;
+    showBatchAuthHint?: boolean;
+    forceAuth?: boolean;
+    onAuthComplete?: () => void | Promise<void>;
+    cfg: ClawdbotConfig;
+    ticket: LarkTicket | undefined;
+}
+/**
+ * 执行 OAuth 授权流程（Device Flow）
+ * 可被 feishu_oauth 和 feishu_oauth_batch_auth 共享调用
+ */
+export declare function executeAuthorize(params: ExecuteAuthorizeParams): Promise<{
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    details: unknown;
+}>;
+//# sourceMappingURL=oauth.d.ts.map

package/src/tools/oauth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../../src/tools/oauth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAM3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA+GtD,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,QA+F7D;AAMD,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;CAChC;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC;IAAE,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CA2d/E"}