dsh-connect 0.7.2 → 0.9.0

package/lib/channels/feishu/adapter.d.ts

@@ -0,0 +1,133 @@
+import type { ChannelAdapter, ChoiceOption, ChoicePrompt, ChoiceResult, InboundMessage, OutboundTarget, SummaryCard } from "../../types.js";
+import type { Language } from "../../i18n.js";
+/** Pad every label with trailing spaces up to the same display width. */
+export declare function padLabels(options: readonly ChoiceOption[]): ChoiceOption[];
+/**
+ * Render options as an equal-width button grid: 2 buttons per row via
+ * `column_set` (two weighted columns), padding the last row with empty
+ * columns so every row is a uniform 2-cell layout. Labels are padded to the
+ * same display width so the buttons themselves render uniformly. Destructive
+ * actions (labels starting with ❌) render as red danger buttons.
+ */
+export declare function buildButtonGrid(options: readonly ChoiceOption[], columnsPerRow?: number): unknown[];
+/**
+ * Render options as a single-select dropdown (`select_static`) inside an
+ * `action` container. Selecting an entry fires the card action with
+ * `action.tag === "select_static"` and the picked option id in `action.option`.
+ */
+export declare function buildSelectMenu(options: readonly ChoiceOption[], placeholder?: string, initial?: string): unknown[];
+/**
+ * Assemble the card elements for a choice prompt. When `sections` is given,
+ * the options are split into titled groups — each with a bold section caption
+ * and a divider before it — instead of one flat grid. Options not listed in
+ * any section (typically the trailing exit/back buttons) are rendered after
+ * the sections, separated by a divider.
+ *
+ * @param prompt - The choice prompt to render
+ * @param defaultColumns - Default number of columns per row (default: 2)
+ */
+export declare function buildChoiceElements(prompt: ChoicePrompt, defaultColumns?: number): unknown[];
+/** Classify a local file name for the Feishu upload API (image vs stream file). */
+export declare function classifyFeishuFile(filename: string): "image" | "file";
+/** Strip path separators / control chars from a downloaded file's name. */
+export declare function sanitizeFileName(name: string): string;
+/**
+ * Extract a human-readable error detail. Feishu business errors (missing
+ * permission, invalid resource, …) arrive as HTTP 200/400 with the real
+ * `{code, msg}` in the response body; prefer that over the axios fallback
+ * message like "Request failed with status code 400" that hides the cause.
+ */
+export declare function extractErrorDetail(error: unknown): string;
+export interface FeishuConfig {
+    appId?: string;
+    appSecret?: string;
+    transport?: "websocket" | "webhook";
+    verificationToken?: string;
+    encryptKey?: string;
+    /** HTTP port for `transport: "webhook"` (default 9000). */
+    webhookPort?: number;
+    /** HTTP path the Feishu event callback posts to (default "/"). */
+    webhookPath?: string;
+    /** Group messages must @-mention the bot (default true). */
+    requireMention?: boolean;
+    /** Single-chat policy (SDK values): open / allowlist / pair / disabled. */
+    dmMode?: "open" | "allowlist" | "pair" | "disabled";
+    /** Bind one DSH session per group thread instead of one per chat (default false). */
+    threadIsolation?: boolean;
+    /**
+     * Allow the interactive one-click onboarding flow when no credentials are
+     * configured (default true). Set `false` to never start it — the adapter then
+     * just warns, which is what a supervisor-managed deployment wants.
+     */
+    onboarding?: boolean;
+    /** User-facing message language: `zh` (default) or `en`. */
+    language?: Language;
+}
+export declare class FeishuAdapter implements ChannelAdapter {
+    private readonly logger?;
+    private readonly isChatAllowed?;
+    readonly id = "feishu";
+    private readonly channel;
+    private readonly pendingChoices;
+    /** Cards whose stale-button tap was already noticed (dedupe, self-clearing). */
+    private readonly staleNoticed;
+    private readonly staleTimers;
+    private readonly t;
+    private readonly transport;
+    private readonly webhookPort;
+    private readonly webhookPath;
+    private readonly threadIsolation;
+    private server?;
+    private handler?;
+    constructor(config: FeishuConfig, logger?: {
+        info?: (...args: unknown[]) => void;
+        warn?: (...args: unknown[]) => void;
+        error?: (...args: unknown[]) => void;
+    } | undefined, isChatAllowed?: ((channel: string, chatKey: string, senderKey: string) => boolean) | undefined);
+    onInbound(handler: (msg: InboundMessage) => void | Promise<void>): void;
+    /** Resource types downloadable via `im.v1.messageResource.get`. Stickers are not supported by the Feishu API. */
+    private static readonly DOWNLOADABLE_TYPES;
+    /** Download attached images / files into local temp dirs; return their paths (and any failures). */
+    private downloadResources;
+    /**
+     * Download a resource inside a user message.
+     *
+     * Note: do NOT use the SDK's `downloadResource(fileKey, type)` — it calls
+     * `im.v1.image.get` / `im.v1.file.get` (download image / download file), and
+     * per the Feishu docs those endpoints **can only download resources uploaded
+     * by the bot itself**. Resources inside user-sent messages must be fetched
+     * with "get resource file from message" `im.v1.messageResource.get` (with
+     * message_id + type=image/file/audio/video), otherwise it returns HTTP 400.
+     */
+    private downloadMessageResource;
+    /**
+     * Housekeeping for the per-channel temp dirs: remove downloads older than
+     * 24h so a busy bot doesn't fill the OS temp partition. Best-effort — a
+     * failure to clean is logged, never fatal.
+     */
+    private cleanupTempDirs;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /** Base chat id for outbound sends (strips any `:thread=` suffix). */
+    private chatIdOf;
+    sendText(target: OutboundTarget, text: string): Promise<void>;
+    sendCard(target: OutboundTarget, card: SummaryCard): Promise<void>;
+    streamText(target: OutboundTarget, chunks: AsyncIterable<string>): Promise<void>;
+    /**
+     * Deliver a local file to the chat. The SDK uploads the source itself:
+     * images are sent inline, everything else as an attachment.
+     */
+    sendFile(target: OutboundTarget, filePath: string, options?: {
+        filename?: string;
+    }): Promise<void>;
+    /**
+     * Build the send options shared by text/markdown deliveries: an optional
+     * reply target and @-mentions (SDK renders `<at user_id=…>` prefixes for
+     * both text and post messages, so group completion cards can nudge the
+     * requester).
+     */
+    private sendOpts;
+    promptChoice(target: OutboundTarget, prompt: ChoicePrompt, updateMessageId?: string): Promise<ChoiceResult>;
+    closeMenu(messageId: string, summary: string): Promise<void>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/lib/channels/feishu/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/channels/feishu/adapter.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,cAAc,EACd,WAAW,EACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAkB9C,yEAAyE;AACzE,wBAAgB,SAAS,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,GAAG,YAAY,EAAE,CAc1E;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,EAAE,aAAa,GAAE,MAAU,GAAG,OAAO,EAAE,CA8BtG;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,EAAE,WAAW,SAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,CAclH;AAkBD;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,EAAE,cAAc,GAAE,MAAU,GAAG,OAAO,EAAE,CAmC/F;AAoDD,mFAAmF;AACnF,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAGrE;AAED,2EAA2E;AAC3E,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMrD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAczD;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;IACpD,qFAAqF;IACrF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAoBD,qBAAa,aAAc,YAAW,cAAc;IAiBhD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC;IAjBjC,QAAQ,CAAC,EAAE,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAoC;IACnE,gFAAgF;IAChF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IACzD,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAiB;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAU;IAC1C,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,OAAO,CAAC,CAAgD;gBAG9D,MAAM,EAAE,YAAY,EACH,MAAM,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;QAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;KAAE,YAAA,EAC3H,aAAa,CAAC,GAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,OAAO,aAAA;IAiCnG,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAIvE,iHAAiH;IACjH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAgD;IAE1F,oGAAoG;YACtF,iBAAiB;IA6D/B;;;;;;;;;OASG;YACW,uBAAuB;IAQrC;;;;OAIG;YACW,eAAe;IAuBvB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+GtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB3B,sEAAsE;IACtE,OAAO,CAAC,QAAQ;IAIV,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7D,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlE,UAAU,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IActF;;;OAGG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IASxG;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IASV,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAgF3G,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQnE"}