@larksuiteoapi/node-sdk 1.4.0 → 1.4.1

package/README.md

@@ -430,19 +430,26 @@ router.post(
 ```
 
 ### [Message Card](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)
+
 The processing of the Message Card is also a kind of Event processing. The only difference between the two is that the processor of the Message Card is used to respond to the events generated by the interaction between the user and the Message Card. If the processor has a return value (*the value structure should be in line with the structure defined by [Message Card Structure](https://open.feishu.cn/document/ukTMukTMukTM/uEjNwUjLxYDM14SM2ATN)*), then the return value is used to update the responded message card:
 
 ```typescript
 import http from 'http';
 import * as lark from '@larksuiteoapi/node-sdk';
+import type { InteractiveCardActionEvent, InteractiveCard } from '@larksuiteoapi/node-sdk';
 
 const cardDispatcher = new lark.CardActionHandler(
     {
       encryptKey: 'encrypt key',
       verificationToken: 'verification token'
     },
-    async(data) => {
+    async (data: InteractiveCardActionEvent) => {
         console.log(data);
+        const newCard: InteractiveCard = {
+          // your new interactive card content
+          header: {},
+          elements: []
+        };
         return newCard;
     }
 );
@@ -451,6 +458,7 @@ const server = http.createServer();
 server.on('request', lark.adaptDefault('/webhook/card', cardDispatcher));
 server.listen(3000);
 ````
+
 #### `CardActionHandler` construction parameters
 
 | Parameter | Description | Type | Required | Default |

package/README.zh.md

@@ -429,19 +429,26 @@ router.post(
 ```
 
 ### [消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)
+
 对消息卡片的处理亦是对事件处理的一种，两者的不同点仅在于消息卡片的处理器用于响应用户与消息卡片交互所产生的事件，若处理器有返回值（*返回值的数据结构理应为符合[消息卡片结构](https://open.feishu.cn/document/ukTMukTMukTM/uEjNwUjLxYDM14SM2ATN)所定义的结构*），则返回值被用来更新被响应的消息卡片：
 
 ```typescript
 import http from 'http';
 import * as lark from '@larksuiteoapi/node-sdk';
+import type { InteractiveCardActionEvent, InteractiveCard } from '@larksuiteoapi/node-sdk';
 
 const cardDispatcher = new lark.CardActionHandler(
     {
       encryptKey: 'encrypt key',
       verificationToken: 'verification token'
     },
-    async (data) => {
+    async (data: InteractiveCardActionEvent) => {
         console.log(data);
+        const newCard: InteractiveCard = {
+          // your new interactive card content
+          header: {},
+          elements: []
+        };
         return newCard;
     }
 );
@@ -450,6 +457,7 @@ const server = http.createServer();
 server.on('request', lark.adaptDefault('/webhook/card', cardDispatcher));
 server.listen(3000);
 ```
+
 #### `CardActionHandler`构造参数
 
 |  参数   | 描述  | 类型 | 必须 | 默认 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

package/types/index.d.ts

@@ -53361,4 +53361,137 @@ declare const adaptKoaRouter: (dispatcher: EventDispatcher | CardActionHandler,
     autoChallenge?: boolean;
 }) => (ctx: any, next: any) => Promise<void>;
 
-export { AESCipher, AppType, CAppTicket, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, LoggerLevel, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };
+interface InteractiveCardActionEvent {
+    open_id: string;
+    user_id?: string;
+    tenant_key: string;
+    open_message_id: string;
+    token: string;
+    action: {
+        value: Record<string, any>;
+        tag: string;
+        option?: string;
+        timezone?: string;
+    };
+}
+interface InteractiveCard {
+    config?: InteractiveCardConfig;
+    header?: InteractiveCardHeader;
+    elements?: InteractiveCardElement[];
+    i18n_elements?: Record<string, InteractiveCardElement[]>;
+    card_link?: InteractiveCardUrlItem;
+}
+interface InteractiveCardConfig {
+    enable_forward?: boolean;
+    update_multi?: boolean;
+    wide_screen_mode?: boolean;
+}
+declare type InteractiveCardHeaderTemplate = 'blue' | 'wathet' | 'turquoise' | 'green' | 'yellow' | 'orange' | 'red' | 'carmine' | 'violet' | 'purple' | 'indigo' | 'grey';
+interface InteractiveCardHeader {
+    title: InteractiveCardTitle;
+    template?: InteractiveCardHeaderTemplate;
+}
+declare type InteractiveCardElement = InteractiveCardDivElement | InteractiveCardMarkdownElement | InteractiveCardDividerElement | InteractiveCardImageElement | InteractiveCardNoteElement | InterfaceCardActionElement;
+interface InteractiveCardTitle extends Omit<InteractiveCardPlainTextItem, 'lines'> {
+    i18n?: Record<string, string>;
+}
+declare type InteractiveCardTextItem = InteractiveCardPlainTextItem | InteractiveCardLarkMdItem;
+interface InteractiveCardPlainTextItem {
+    tag: 'plain_text';
+    content?: string;
+    lines?: number;
+}
+interface InteractiveCardLarkMdItem {
+    tag: 'lark_md';
+    content?: string;
+}
+interface InteractiveCardImageItem {
+    tag: 'img';
+    img_key: string;
+    alt: InteractiveCardPlainTextItem;
+    preview?: boolean;
+}
+interface InteractiveCardUrlItem {
+    url: string;
+    android_url?: string;
+    ios_url?: string;
+    pc_url?: string;
+}
+interface InteractiveCardField {
+    is_short: boolean;
+    text: InteractiveCardTextItem;
+}
+interface InteractiveCardDivElement {
+    tag: 'div';
+    text: InteractiveCardTextItem;
+    fields?: InteractiveCardField[];
+    extra?: any;
+}
+interface InteractiveCardMarkdownElement {
+    tag: 'markdown';
+    content: string;
+    text_align?: 'left' | 'center' | 'right';
+    href?: Record<string, InteractiveCardUrlItem>;
+}
+interface InteractiveCardDividerElement {
+    tag: 'hr';
+}
+interface InteractiveCardImageElement extends InteractiveCardImageItem {
+    title?: InteractiveCardTextItem;
+    custom_width?: number;
+    compact_width?: boolean;
+    mode?: 'crop_center' | 'fit_horizontal';
+}
+interface InteractiveCardNoteElement {
+    tag: 'note';
+    elements: (InteractiveCardTextItem | InteractiveCardImageItem)[];
+}
+interface InterfaceCardActionElement {
+    tag: 'action';
+    actions: InteractiveCardActionItem[];
+    layout?: 'bisected' | 'trisection' | 'flow';
+}
+declare type InteractiveCardActionItem = InteractiveCardDatePickerActionItem | InteractiveCardButtonActionItem | InteractiveCardOverflowActionItem | InteractiveCardSelectMenuActionItem;
+interface InteractiveCardActionBaseItem {
+    confirm?: {
+        title: InteractiveCardPlainTextItem;
+        text: InteractiveCardPlainTextItem;
+    };
+}
+interface InteractiveCardActionOptionItem {
+    text?: InteractiveCardPlainTextItem;
+    value?: string;
+}
+interface InteractiveCardDatePickerActionItem extends InteractiveCardActionBaseItem {
+    tag: 'date_picker' | 'picker_time' | 'picker_datetime';
+    initial_date?: string;
+    initial_time?: string;
+    initial_datetime?: string;
+    placeholder?: InteractiveCardPlainTextItem;
+    value?: Record<string, any>;
+}
+interface InteractiveCardButtonActionItem extends InteractiveCardActionBaseItem {
+    tag: 'button';
+    text?: InteractiveCardTextItem;
+    url?: string;
+    multi_utl?: InteractiveCardUrlItem;
+    type?: 'default' | 'primary' | 'danger';
+    value?: Record<string, any>;
+}
+interface InteractiveCardOverflowActionItem extends InteractiveCardActionBaseItem {
+    tag: 'overflow';
+    options?: (InteractiveCardActionOptionItem & {
+        url?: string;
+        multi_utl?: InteractiveCardUrlItem;
+    })[];
+    value?: Record<string, any>;
+}
+interface InteractiveCardSelectMenuActionItem extends InteractiveCardActionBaseItem {
+    tag: 'select_static' | 'select_person';
+    placeholder?: InteractiveCardPlainTextItem;
+    initial_option?: string;
+    option?: InteractiveCardActionOptionItem[];
+    value?: Record<string, any>;
+}
+
+export { AESCipher, AppType, CAppTicket, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };