@ganglion/weacpx-channel-feishu 0.1.0-beta.0

package/README.md

@@ -0,0 +1,11 @@
+# @ganglion/weacpx-channel-feishu
+
+Feishu channel plugin for `weacpx`.
+
+```bash
+weacpx plugin add @ganglion/weacpx-channel-feishu
+weacpx channel add feishu
+weacpx restart
+```
+
+The channel requires a Feishu self-built app `appId` and `appSecret`.

package/dist/channel.d.ts

@@ -0,0 +1,31 @@
+import type { ChannelStartInput, CoordinatorMessageInput, CreateChannelDeps, MessageChannelRuntime, OrchestrationDeliveryCallbacks } from "weacpx/plugin-api";
+import type { FeishuResolvedAccountConfig } from "./config.js";
+import { type FeishuLarkClient } from "./lark-client.js";
+type OrchestrationTaskRecord = Parameters<MessageChannelRuntime["notifyTaskCompletion"]>[0];
+interface FeishuChannelDeps extends CreateChannelDeps {
+    createClient?: (account: FeishuResolvedAccountConfig) => FeishuLarkClient;
+}
+export declare class FeishuChannel implements MessageChannelRuntime {
+    private readonly deps;
+    readonly id = "feishu";
+    private readonly accounts;
+    private dedup;
+    private markDelivered;
+    private markFailed;
+    private agent;
+    private quota;
+    private logger;
+    private readonly config;
+    constructor(options: Record<string, unknown> | undefined, deps?: FeishuChannelDeps);
+    isLoggedIn(): boolean;
+    login(): Promise<string>;
+    logout(): void;
+    configureOrchestration(callbacks: OrchestrationDeliveryCallbacks): void;
+    start(input: ChannelStartInput): Promise<void>;
+    notifyTaskCompletion(task: OrchestrationTaskRecord): Promise<void>;
+    notifyTaskProgress(task: OrchestrationTaskRecord, text: string): Promise<void>;
+    sendCoordinatorMessage(input: CoordinatorMessageInput): Promise<void>;
+    private sendRouteText;
+    private handleMessageEvent;
+}
+export {};

package/dist/chat-queue.d.ts

@@ -0,0 +1,11 @@
+export declare function buildFeishuQueueKey(accountId: string, chatId: string, threadId?: string): string;
+export declare function enqueueFeishuChatTask(input: {
+    accountId: string;
+    chatId: string;
+    threadId?: string;
+    task: () => Promise<void>;
+}): {
+    status: "queued" | "immediate";
+    promise: Promise<void>;
+};
+export declare function resetFeishuChatQueueForTests(): void;

package/dist/config.d.ts

@@ -0,0 +1,34 @@
+export type FeishuDmPolicy = "open" | "allowlist" | "disabled";
+export type FeishuGroupPolicy = "open" | "allowlist" | "disabled";
+export interface FeishuAccountConfig {
+    name?: string;
+    enabled?: boolean;
+    appId?: string;
+    appSecret?: string;
+    domain?: string;
+    requireMention?: boolean;
+    dmPolicy?: FeishuDmPolicy;
+    groupPolicy?: FeishuGroupPolicy;
+    allowFrom?: string[];
+}
+export interface FeishuResolvedAccountConfig {
+    accountId: string;
+    name?: string;
+    enabled: boolean;
+    configured: boolean;
+    appId: string;
+    appSecret: string;
+    domain: string;
+    requireMention: boolean;
+    dmPolicy: FeishuDmPolicy;
+    groupPolicy: FeishuGroupPolicy;
+    allowFrom: string[];
+}
+export interface FeishuChannelConfig extends FeishuAccountConfig {
+    defaultAccount: string;
+    textMessageFormat: "text";
+    dedupTtlMs: number;
+    dedupMaxEntries: number;
+    accounts: FeishuResolvedAccountConfig[];
+}
+export declare function parseFeishuChannelConfig(raw: unknown): FeishuChannelConfig;

package/dist/content-converters.d.ts

@@ -0,0 +1,11 @@
+import type { FeishuMessageEvent, FeishuContentConversionResult } from "./types";
+interface ConvertInput {
+    messageType: string;
+    content: string;
+    messageId: string;
+    mentions?: FeishuMessageEvent["message"]["mentions"];
+    botOpenId?: string;
+    stripBotMentions?: boolean;
+}
+export declare function convertFeishuMessageContent(input: ConvertInput): Promise<FeishuContentConversionResult>;
+export {};

package/dist/feishu-provider.d.ts

@@ -0,0 +1,2 @@
+import { type ChannelCliProvider } from "./provider.js";
+export declare const feishuCliProvider: ChannelCliProvider;

package/dist/inbound.d.ts

@@ -0,0 +1,32 @@
+import type { FeishuMessageEvent } from "./types.js";
+import type { FeishuResolvedAccountConfig } from "./config.js";
+export declare function parseFeishuText(raw: string): string;
+export declare function buildFeishuConversationId(accountId: string, chatId: string, threadId?: string): string;
+export declare function parseFeishuConversationId(chatKey: string): {
+    accountId: string;
+    chatId: string;
+    threadId?: string;
+} | null;
+export declare function shouldHandleFeishuMessage(input: {
+    event: FeishuMessageEvent;
+    botOpenId?: string;
+    requireMention: boolean;
+    parsedText?: string;
+    allowMediaOnly?: boolean;
+}): {
+    handle: true;
+    text: string;
+} | {
+    handle: false;
+    reason: "no_mention" | "unsupported_type";
+};
+export type FeishuPolicyDecision = {
+    allow: true;
+} | {
+    allow: false;
+    reason: "dm_disabled" | "group_disabled" | "sender_not_allowlisted" | "missing_sender_id";
+};
+export declare function evaluateFeishuAccessPolicy(input: {
+    event: FeishuMessageEvent;
+    account: Pick<FeishuResolvedAccountConfig, "dmPolicy" | "groupPolicy" | "allowFrom">;
+}): FeishuPolicyDecision;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { WeacpxPlugin } from "weacpx/plugin-api";
+export { FeishuChannel } from "./channel.js";
+export { feishuCliProvider } from "./feishu-provider.js";
+declare const plugin: WeacpxPlugin;
+export default plugin;