@elizaos/plugin-feishu 2.0.0-alpha

package/dist/types.d.ts

@@ -0,0 +1,288 @@
+import type { Content, EntityPayload, MessagePayload, WorldPayload } from "@elizaos/core";
+/**
+ * Feishu event data structure (local type since lark SDK doesn't export it)
+ */
+export interface FeishuEventData {
+    event?: Record<string, unknown>;
+    header?: {
+        event_id?: string;
+        token?: string;
+        create_time?: string;
+        event_type?: string;
+        tenant_key?: string;
+        app_id?: string;
+    };
+}
+/**
+ * Base content type for Feishu messages (extends Content for compatibility).
+ * Note: Do not add FeishuCard directly to this interface as it conflicts with Content's index signature.
+ */
+export interface FeishuContent extends Content {
+    /** Image key for image messages */
+    feishuImageKey?: string;
+    /** File key for file messages */
+    feishuFileKey?: string;
+}
+/**
+ * Internal type for Feishu-specific content with card support (not exported to Content).
+ * This type is used internally for message sending/receiving.
+ */
+export interface FeishuMessageContent {
+    text?: string;
+    /** Interactive card content */
+    card?: FeishuCard;
+    /** Image key for image messages */
+    imageKey?: string;
+    /** File key for file messages */
+    fileKey?: string;
+}
+/**
+ * Helper type for accessing Feishu-specific card content (internal use)
+ */
+export type FeishuCardContent = {
+    card?: FeishuCard;
+    imageKey?: string;
+    fileKey?: string;
+};
+/**
+ * Feishu interactive card structure.
+ */
+export interface FeishuCard {
+    /** Card configuration */
+    config?: {
+        wideScreenMode?: boolean;
+        enableForward?: boolean;
+    };
+    /** Card header */
+    header?: {
+        title?: {
+            tag: string;
+            content: string;
+        };
+        template?: string;
+    };
+    /** Card elements */
+    elements?: FeishuCardElement[];
+}
+/**
+ * Card element types.
+ */
+export type FeishuCardElement = {
+    tag: "div";
+    text: {
+        tag: string;
+        content: string;
+    };
+} | {
+    tag: "action";
+    actions: FeishuCardAction[];
+} | {
+    tag: "hr";
+} | {
+    tag: "note";
+    elements: {
+        tag: string;
+        content: string;
+    }[];
+};
+/**
+ * Card action types.
+ */
+export interface FeishuCardAction {
+    tag: "button";
+    text: {
+        tag: string;
+        content: string;
+    };
+    type?: "default" | "primary" | "danger";
+    url?: string;
+    value?: Record<string, string>;
+}
+/**
+ * Event types emitted by the Feishu plugin.
+ */
+export declare enum FeishuEventTypes {
+    WORLD_JOINED = "FEISHU_WORLD_JOINED",
+    WORLD_CONNECTED = "FEISHU_WORLD_CONNECTED",
+    WORLD_LEFT = "FEISHU_WORLD_LEFT",
+    ENTITY_JOINED = "FEISHU_ENTITY_JOINED",
+    ENTITY_LEFT = "FEISHU_ENTITY_LEFT",
+    ENTITY_UPDATED = "FEISHU_ENTITY_UPDATED",
+    MESSAGE_RECEIVED = "FEISHU_MESSAGE_RECEIVED",
+    MESSAGE_SENT = "FEISHU_MESSAGE_SENT",
+    REACTION_RECEIVED = "FEISHU_REACTION_RECEIVED",
+    INTERACTION_RECEIVED = "FEISHU_INTERACTION_RECEIVED",
+    SLASH_START = "FEISHU_SLASH_START"
+}
+/**
+ * Map of event types to their payload types.
+ */
+export interface FeishuEventPayloadMap {
+    [FeishuEventTypes.MESSAGE_RECEIVED]: FeishuMessageReceivedPayload;
+    [FeishuEventTypes.MESSAGE_SENT]: FeishuMessageSentPayload;
+    [FeishuEventTypes.REACTION_RECEIVED]: FeishuReactionReceivedPayload;
+    [FeishuEventTypes.WORLD_JOINED]: FeishuWorldPayload;
+    [FeishuEventTypes.WORLD_CONNECTED]: FeishuWorldPayload;
+    [FeishuEventTypes.WORLD_LEFT]: FeishuWorldPayload;
+    [FeishuEventTypes.SLASH_START]: {
+        chatId: string;
+    };
+    [FeishuEventTypes.ENTITY_JOINED]: FeishuEntityPayload;
+    [FeishuEventTypes.ENTITY_LEFT]: FeishuEntityPayload;
+    [FeishuEventTypes.ENTITY_UPDATED]: FeishuEntityPayload;
+    [FeishuEventTypes.INTERACTION_RECEIVED]: FeishuInteractionPayload;
+}
+/**
+ * Feishu chat types.
+ */
+export declare enum FeishuChatType {
+    /** Private one-on-one chat */
+    P2P = "p2p",
+    /** Group chat */
+    GROUP = "group"
+}
+/**
+ * Feishu user information.
+ */
+export interface FeishuUser {
+    /** Open ID (user identifier) */
+    openId: string;
+    /** Union ID (cross-app identifier) */
+    unionId?: string;
+    /** User ID (tenant-level identifier) */
+    userId?: string;
+    /** User's display name */
+    name?: string;
+    /** User's avatar URL */
+    avatarUrl?: string;
+    /** Whether the user is a bot */
+    isBot?: boolean;
+}
+/**
+ * Feishu chat information.
+ */
+export interface FeishuChat {
+    /** Chat ID */
+    chatId: string;
+    /** Chat type */
+    chatType: FeishuChatType;
+    /** Chat name/title */
+    name?: string;
+    /** Chat owner's open ID */
+    ownerOpenId?: string;
+    /** Chat description */
+    description?: string;
+    /** Tenant key */
+    tenantKey?: string;
+}
+/**
+ * Feishu message information.
+ */
+export interface FeishuMessage {
+    /** Message ID */
+    messageId: string;
+    /** Root message ID (for threads) */
+    rootId?: string;
+    /** Parent message ID (for replies) */
+    parentId?: string;
+    /** Message type */
+    msgType: string;
+    /** Message content (JSON string) */
+    content: string;
+    /** Create time (Unix timestamp in milliseconds) */
+    createTime: string;
+    /** Update time (Unix timestamp in milliseconds) */
+    updateTime?: string;
+    /** Whether the message is deleted */
+    deleted?: boolean;
+    /** Chat ID */
+    chatId: string;
+    /** Sender information */
+    sender: {
+        id: string;
+        idType: string;
+        senderType: string;
+        tenantKey?: string;
+    };
+    /** Mentions in the message */
+    mentions?: FeishuMention[];
+}
+/**
+ * Mention information in a message.
+ */
+export interface FeishuMention {
+    /** Mention key in the message */
+    key: string;
+    /** Mentioned user's ID */
+    id: string;
+    /** ID type */
+    idType: string;
+    /** Mentioned user's name */
+    name: string;
+    /** Tenant key */
+    tenantKey?: string;
+}
+/**
+ * Payload for received messages.
+ */
+export interface FeishuMessageReceivedPayload extends MessagePayload {
+    /** Original Feishu message */
+    originalMessage: FeishuMessage;
+    /** Chat information */
+    chat: FeishuChat;
+    /** Sender information */
+    sender: FeishuUser;
+}
+/**
+ * Payload for sent messages.
+ */
+export interface FeishuMessageSentPayload extends MessagePayload {
+    /** Message IDs of sent messages */
+    messageIds: string[];
+    /** Chat ID */
+    chatId: string;
+}
+/**
+ * Payload for reaction events.
+ */
+export interface FeishuReactionReceivedPayload extends FeishuMessageReceivedPayload {
+    /** Reaction type/emoji */
+    reactionType: string;
+}
+/**
+ * Payload for world/chat events.
+ */
+export interface FeishuWorldPayload extends WorldPayload {
+    /** Chat information */
+    chat: FeishuChat;
+    /** Bot's open ID */
+    botOpenId?: string;
+}
+/**
+ * Payload for entity (user) events.
+ */
+export interface FeishuEntityPayload extends EntityPayload {
+    /** Feishu user information */
+    feishuUser: FeishuUser;
+    /** Chat where the event occurred */
+    chat: FeishuChat;
+}
+/**
+ * Payload for interaction events (card actions, etc.).
+ */
+export interface FeishuInteractionPayload {
+    /** Interaction type */
+    type: string;
+    /** Action data */
+    action: {
+        tag: string;
+        value?: Record<string, string>;
+    };
+    /** User who triggered the interaction */
+    user: FeishuUser;
+    /** Chat where the interaction occurred */
+    chat?: FeishuChat;
+    /** Token for responding to the interaction */
+    token?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,cAAc,EACd,YAAY,EACb,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,mCAAmC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yBAAyB;IACzB,MAAM,CAAC,EAAE;QACP,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;IACF,kBAAkB;IAClB,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE;YACN,GAAG,EAAE,MAAM,CAAC;YACZ,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,oBAAoB;IACpB,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB;IAAE,GAAG,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACtD;IAAE,GAAG,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAAE,GAC9C;IAAE,GAAG,EAAE,IAAI,CAAA;CAAE,GACb;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,QAAQ,CAAC;IACd,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,YAAY,wBAAwB;IACpC,eAAe,2BAA2B;IAC1C,UAAU,sBAAsB;IAChC,aAAa,yBAAyB;IACtC,WAAW,uBAAuB;IAClC,cAAc,0BAA0B;IACxC,gBAAgB,4BAA4B;IAC5C,YAAY,wBAAwB;IACpC,iBAAiB,6BAA6B;IAC9C,oBAAoB,gCAAgC;IACpD,WAAW,uBAAuB;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,4BAA4B,CAAC;IAClE,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IAC1D,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,6BAA6B,CAAC;IACpE,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IACpD,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACvD,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAClD,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACtD,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;IACpD,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACvD,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;CACnE;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,8BAA8B;IAC9B,GAAG,QAAQ;IACX,iBAAiB;IACjB,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,QAAQ,EAAE,cAAc,CAAC;IACzB,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,0BAA0B;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,8BAA8B;IAC9B,eAAe,EAAE,aAAa,CAAC;IAC/B,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,yBAAyB;IACzB,MAAM,EAAE,UAAU,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC9D,mCAAmC;IACnC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,6BACf,SAAQ,4BAA4B;IACpC,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,uBAAuB;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,8BAA8B;IAC9B,UAAU,EAAE,UAAU,CAAC;IACvB,oCAAoC;IACpC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAChC,CAAC;IACF,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAC;IACjB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@elizaos/plugin-feishu",
+  "version": "2.0.0-alpha",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@elizaos/core": "workspace:*",
+    "@types/node": "^25.0.3",
+    "@larksuiteoapi/node-sdk": "^1.40.0",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "vitest": "^4.0.0",
+    "@biomejs/biome": "^2.3.11"
+  },
+  "scripts": {
+    "build": "bun run build.ts",
+    "dev": "bun --hot build.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "bunx @biomejs/biome check --write --unsafe .",
+    "clean": "rm -rf dist .turbo node_modules .turbo-tsconfig.json tsconfig.tsbuildinfo",
+    "format": "bunx @biomejs/biome format --write .",
+    "format:check": "bunx @biomejs/biome format .",
+    "lint:check": "bunx @biomejs/biome check .",
+    "build:ts": "bun run build",
+    "typecheck": "tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/elizaos/eliza.git"
+  },
+  "agentConfig": {
+    "pluginType": "elizaos:plugin:1.0.0",
+    "pluginParameters": {
+      "FEISHU_APP_ID": {
+        "type": "string",
+        "description": "Feishu/Lark application ID (cli_xxx format) for bot authentication.",
+        "required": true,
+        "sensitive": false
+      },
+      "FEISHU_APP_SECRET": {
+        "type": "string",
+        "description": "Feishu/Lark application secret for bot authentication.",
+        "required": true,
+        "sensitive": true
+      },
+      "FEISHU_DOMAIN": {
+        "type": "string",
+        "description": "Domain to use: 'feishu' for China or 'lark' for global.",
+        "required": false,
+        "sensitive": false
+      },
+      "FEISHU_ALLOWED_CHATS": {
+        "type": "string",
+        "description": "JSON-encoded array of chat IDs authorized to interact with the bot.",
+        "required": false,
+        "sensitive": false
+      },
+      "FEISHU_TEST_CHAT_ID": {
+        "type": "string",
+        "description": "Chat ID used by the test suite for validation.",
+        "required": false,
+        "sensitive": false
+      }
+    }
+  },
+  "milaidy": {
+    "platforms": [
+      "node"
+    ],
+    "runtime": "node",
+    "platformDetails": {
+      "node": "ESM build available via exports.import"
+    }
+  }
+}