@rynx-ai/plugin-channel-lark 0.1.9

package/dist/lark-settings-card.js

@@ -0,0 +1,158 @@
+/** Sentinel option value meaning "use the runtime/model default". */
+export const SETTINGS_DEFAULT_VALUE = "__default__";
+export const SETTINGS_EFFORT_VALUES = [
+    "none",
+    "minimal",
+    "low",
+    "medium",
+    "high",
+    "xhigh",
+    "max",
+    "ultra",
+];
+const EFFORT_LABELS = {
+    minimal: "minimal · 最小",
+    low: "low · 低",
+    medium: "medium · 中",
+    high: "high · 高",
+    xhigh: "xhigh · 极高",
+    none: "none · 关闭",
+    max: "max · 最大",
+    ultra: "ultra · 自动委派",
+};
+/**
+ * Effort options for the currently-selected model: the model's own
+ * `supportedEfforts` when it advertises them, otherwise the full effort set.
+ * Always prefixed with the "follow the model default" sentinel.
+ */
+function effortOptionsFor(models, selectedModel) {
+    const model = models.find((m) => m.value === selectedModel);
+    const supported = Array.from(new Set(model?.supportedEfforts ?? []));
+    const values = supported.length > 0 ? supported : SETTINGS_EFFORT_VALUES;
+    return [
+        { text: plainText("默认（跟随模型）"), value: SETTINGS_DEFAULT_VALUE },
+        ...values.map((value) => ({ text: plainText(EFFORT_LABELS[value] ?? value), value })),
+    ];
+}
+function plainText(content) {
+    return { tag: "plain_text", content };
+}
+function buildSelect(field, sessionKey, includeRuntime, placeholder, options, initialValue) {
+    return {
+        tag: "select_static",
+        name: field,
+        placeholder: plainText(placeholder),
+        initial_option: initialValue,
+        options,
+        behaviors: [
+            {
+                type: "callback",
+                value: { kind: "settings_select", field, sessionKey, includeRuntime },
+            },
+        ],
+    };
+}
+function labelMarkdown(content) {
+    return { tag: "markdown", content };
+}
+/**
+ * Build the `/runtime` / `/model` settings card object: dropdowns for runtime
+ * (optional), model and reasoning effort, plus confirm / cancel buttons.
+ * Selections round-trip via `card.action.trigger` callbacks (`settings_select`
+ * per change — runtime/model changes re-render this card; `settings_apply` /
+ * `settings_cancel` on the buttons). The effort options reflect the currently
+ * selected model's supported efforts.
+ */
+export function buildSettingsCard(input) {
+    const { sessionKey, includeRuntime, models, selectedRuntime, selectedModel, selectedEffort } = input;
+    const elements = [];
+    elements.push(labelMarkdown(includeRuntime
+        ? "选择**运行时 / 模型 / 思考强度**，点击确认后对新会话生效。"
+        : "为当前运行时选择**模型 / 思考强度**，点击确认后对新会话生效。"));
+    if (includeRuntime) {
+        const runtimeOptions = input.runtimeOptions.map((option) => ({
+            text: plainText(option.label),
+            value: option.value,
+        }));
+        elements.push(labelMarkdown("**运行时**"));
+        elements.push(buildSelect("runtime", sessionKey, includeRuntime, "选择运行时", runtimeOptions, selectedRuntime));
+    }
+    const modelOptions = [
+        { text: plainText("跟随运行时默认"), value: SETTINGS_DEFAULT_VALUE },
+        ...models.map((model) => ({
+            text: plainText(`${model.label}${model.isDefault ? " ⭐️" : ""}`),
+            value: model.value,
+        })),
+    ];
+    elements.push(labelMarkdown("**模型**"));
+    elements.push(buildSelect("model", sessionKey, includeRuntime, "选择模型", modelOptions, selectedModel));
+    elements.push(labelMarkdown("**思考强度**"));
+    elements.push(buildSelect("effort", sessionKey, includeRuntime, "选择思考强度", effortOptionsFor(models, selectedModel), selectedEffort));
+    const confirmButton = {
+        tag: "button",
+        text: plainText("确认"),
+        type: "primary",
+        size: "medium",
+        behaviors: [
+            {
+                type: "callback",
+                value: { kind: "settings_apply", sessionKey, includeRuntime },
+            },
+        ],
+    };
+    const cancelButton = {
+        tag: "button",
+        text: plainText("取消"),
+        type: "default",
+        size: "medium",
+        behaviors: [
+            {
+                type: "callback",
+                value: { kind: "settings_cancel", sessionKey, includeRuntime },
+            },
+        ],
+    };
+    // `flex_mode: "none"` + auto-width columns keep the two buttons sized to
+    // their content and sitting adjacent on the left (weighted columns would
+    // stretch each button across half the card, pushing 取消 to the far right).
+    elements.push({
+        tag: "column_set",
+        flex_mode: "none",
+        horizontal_spacing: "8px",
+        columns: [
+            { tag: "column", width: "auto", elements: [confirmButton] },
+            { tag: "column", width: "auto", elements: [cancelButton] },
+        ],
+    });
+    return {
+        schema: "2.0",
+        header: {
+            title: plainText(includeRuntime ? "⚙️ 运行设置" : "⚙️ 模型设置"),
+            template: "blue",
+        },
+        body: { elements },
+    };
+}
+/** String form of {@link buildSettingsCard} (for the initial card send). */
+export function buildSettingsCardJson(input) {
+    return JSON.stringify(buildSettingsCard(input));
+}
+/**
+ * Build a static result card shown after the user confirms or cancels the
+ * settings card — replaces the interactive form with a plain conclusion.
+ * Returned as a plain object so it can be embedded in a card-action response.
+ */
+export function buildSettingsResultCard(input) {
+    return {
+        schema: "2.0",
+        header: {
+            title: plainText(input.includeRuntime ? "⚙️ 运行设置" : "⚙️ 模型设置"),
+            template: input.template,
+        },
+        body: { elements: [{ tag: "markdown", content: input.content }] },
+    };
+}
+/** String form of {@link buildSettingsResultCard}. */
+export function buildSettingsResultCardJson(input) {
+    return JSON.stringify(buildSettingsResultCard(input));
+}

package/dist/lark-setup.d.ts

@@ -0,0 +1,17 @@
+import type { AuthMaterial, ConfigField } from "@rynx-ai/core";
+/**
+ * Minimal tenant (app-identity) scopes the Lark channel needs: receive/send
+ * messages, add reactions, read chat + members, upload/download resources, and
+ * resolve user display info. Pre-filled into the scan-confirm page; editable.
+ */
+export declare const LARK_BOT_SCOPES: string[];
+/** The bot only needs to be told when a message arrives. */
+export declare const LARK_BOT_EVENTS: string[];
+/** Config mode 1: paste an existing app's credentials. */
+export declare const larkConfigSchema: ConfigField[];
+/**
+ * Config mode 2: scan-to-create/authorize. Emits a `qr` material (the URL the
+ * host renders as a QR and/or a clickable link) and `status` updates, then
+ * resolves with the App ID / App Secret to persist. Aborts via `signal`.
+ */
+export declare function authorizeLark(emit: (material: AuthMaterial) => void, signal: AbortSignal): Promise<Record<string, unknown>>;

package/dist/lark-setup.js

@@ -0,0 +1,86 @@
+/**
+ * Lark (Feishu) authorization flow + its credential form schema.
+ *
+ * Two config modes the host can offer for this channel type:
+ *   1. **Form** ({@link larkConfigSchema}) — paste an existing app's App ID /
+ *      App Secret. The host renders these fields generically.
+ *   2. **Authorize** ({@link authorizeLark}) — the SDK's `registerApp` device
+ *      flow (RFC 8628-shaped, Feishu-proprietary provisioning): the user scans a
+ *      QR (or opens the link) in Feishu, an app is created/authorized with the
+ *      bot scopes + message-receive event pre-filled, and the SDK returns the
+ *      App ID / App Secret.
+ *
+ * `authorizeLark` is transport-neutral: it translates the SDK's callbacks into
+ * the host's {@link AuthMaterial} stream (`qr` / `status`) and resolves with the
+ * options to persist. The terminal vs web rendering is the host's concern.
+ */
+import { registerApp } from "@larksuiteoapi/node-sdk";
+/**
+ * Minimal tenant (app-identity) scopes the Lark channel needs: receive/send
+ * messages, add reactions, read chat + members, upload/download resources, and
+ * resolve user display info. Pre-filled into the scan-confirm page; editable.
+ */
+export const LARK_BOT_SCOPES = [
+    "im:message",
+    "im:message:send_as_bot",
+    "im:message.group_at_msg:readonly",
+    "im:message.p2p_msg:readonly",
+    "im:message.reactions:write_only",
+    "im:chat:read",
+    "im:chat.members:read",
+    "im:resource",
+    "contact:user.base:readonly",
+];
+/** The bot only needs to be told when a message arrives. */
+export const LARK_BOT_EVENTS = ["im.message.receive_v1"];
+/** Config mode 1: paste an existing app's credentials. */
+export const larkConfigSchema = [
+    {
+        key: "LARK_APP_ID",
+        label: "App ID",
+        type: "string",
+        required: true,
+        help: "形如 cli_xxx,在开放平台「凭证与基础信息」获取",
+    },
+    { key: "LARK_APP_SECRET", label: "App Secret", type: "secret", required: true },
+];
+const STATUS_TEXT = {
+    polling: "等待在飞书中扫码确认…",
+    slow_down: "服务器繁忙,正在放慢轮询…",
+    domain_switched: "识别到国际版租户,已切换到 larksuite.com 继续。",
+};
+/**
+ * Config mode 2: scan-to-create/authorize. Emits a `qr` material (the URL the
+ * host renders as a QR and/or a clickable link) and `status` updates, then
+ * resolves with the App ID / App Secret to persist. Aborts via `signal`.
+ */
+export async function authorizeLark(emit, signal) {
+    let result;
+    try {
+        result = await registerApp({
+            source: "rynx",
+            signal,
+            // One-scan provisioning: pre-fill the scopes + event this channel needs.
+            addons: {
+                scopes: { tenant: LARK_BOT_SCOPES },
+                events: { items: { tenant: LARK_BOT_EVENTS } },
+            },
+            onQRCodeReady: ({ url, expireIn }) => emit({ kind: "qr", url, expireIn }),
+            onStatusChange: ({ status }) => emit({ kind: "status", text: STATUS_TEXT[status] ?? status }),
+        });
+    }
+    catch (error) {
+        throw new Error(scrubSecret(messageOf(error)));
+    }
+    if (!result.client_id || !result.client_secret) {
+        throw new Error("扫码返回的凭据为空,请改用手动填写 App ID / App Secret。");
+    }
+    return { LARK_APP_ID: result.client_id, LARK_APP_SECRET: result.client_secret };
+}
+function messageOf(err) {
+    return err instanceof Error ? err.message : String(err);
+}
+/** Defensively mask any long token-like substring so a secret can't leak. */
+function scrubSecret(text) {
+    return text.replace(/[A-Za-z0-9_-]{30,}/g, "***");
+}