@satorijs/adapter-lark 3.6.1 → 3.7.0

package/src/types/internal.ts

@@ -15,17 +15,15 @@ type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
 export class Internal {
   constructor(private bot: LarkBot) {}
 
-  private processReponse(response: any): BaseResponse {
-    const { code, msg } = response
-    if (code === 0) {
-      return response
-    } else {
-      this.bot.logger.debug('response: %o', response)
-      throw new Error(`HTTP response with non-zero status (${code}) with message "${msg}"`)
-    }
+  private assertResponse(response: HTTP.Response<BaseResponse>) {
+    if (!response.data.code) return
+    this.bot.logger.debug('response: %o', response.data)
+    const error = new HTTP.Error(`request failed`)
+    error.response = response
+    throw error
   }
 
-  static define(routes: Dict<Partial<Record<Method, string | string[]>>>) {
+  static define(routes: Dict<Partial<Record<Method, string | string[]>>>, extractData = true) {
     for (const path in routes) {
       for (const key in routes[path]) {
         const method = key as Method
@@ -49,7 +47,9 @@ export class Internal {
             } else if (args.length > 1) {
               throw new Error(`too many arguments for ${path}, received ${raw}`)
             }
-            return this.processReponse((await this.bot.http(method, url, config)).data)
+            const response = await this.bot.http(method, url, config)
+            this.assertResponse(response.data)
+            return extractData ? response.data.data : response.data
           }
         }
       }

package/src/types/message/content.ts

@@ -153,9 +153,10 @@ export namespace MessageContent {
   }
 
   export interface Card {
-    config: Card.Config
+    config?: Card.Config
     card_link?: Card.URLs
-    elements?: Card.Element[]
+    header?: Card.Header
+    elements: Card.Element[]
   }
 
   export namespace Card {
@@ -233,17 +234,27 @@ export namespace MessageContent {
       export type Color = 'neutral' | 'blue' | 'torqoise' | 'lime' | 'orange' | 'violet' | 'indigo' | 'wathet' | 'green' | 'yellow' | 'red' | 'purple' | 'carmine'
     }
 
-    export interface ImageElement extends BaseElement<'image'> {
+    export interface BaseImageElement extends BaseElement<'image'> {
       img_key: string
       alt?: PlainTextElement
+    }
+
+    export interface ImageElement extends BaseImageElement {
       title?: PlainTextElement
+      transparent?: string
+      preview?: boolean
+      corner_radius?: string
+      scale_type?: 'crop_center' | 'fit_horizontal' | 'crop_top'
+      size?: 'large' | 'medium' | 'small' | 'tiny' | 'stretch_without_padding' | 'stretch' | string
+      /** @deprecated */
       custom_width?: number
+      /** @deprecated */
       compact_width?: boolean
+      /** @deprecated */
       mode?: 'crop_center' | 'fit_horizontal' | 'large' | 'medium' | 'small' | 'tiny'
-      preview?: boolean
     }
 
-    export interface HorizontalRuleElement extends BaseElement<'hr'> {}
+    export interface HRElement extends BaseElement<'hr'> {}
 
     export interface DivElement extends BaseElement<'div'> {
       text?: DivPlainTextElement
@@ -256,15 +267,77 @@ export namespace MessageContent {
       href?: Record<string, URLs>
     }
 
-    export interface HorizontalRuleElement extends BaseElement<'hr'> {}
+    export interface PersonElement extends BaseElement<'person'> {
+      user_id: string
+      size?: 'large' | 'medium' | 'small' | 'extra_small'
+    }
 
-    export interface ActionModule extends BaseElement<'action'> {
-      actions: ActionElement[]
-      layout?: 'bisected' | 'trisection' | 'flow'
+    export interface PersonListElement extends BaseElement<'person_list'> {
+      persons: { id: string }[]
+      size?: 'large' | 'medium' | 'small' | 'extra_small'
+      show_name?: boolean
+      show_avatar?: boolean
     }
 
-    export type ActionElement =
-      | ButtonElement
+    export interface ChartElement extends BaseElement<'chart'> {
+      chart_spec: {} // TODO
+      aspect_ratio?: '1:1' | '2:1' | '4:3' | '16:9'
+      color_theme?: 'brand' | 'rainbow' | 'complementary' | 'converse' | 'primary'
+      preview?: boolean
+      height?: 'auto' | string
+    }
+
+    export interface TableElement extends BaseElement<'table'> {
+      page_size?: number
+      row_height?: 'low' | 'medium' | 'high' | string
+      header_style?: TableElement.HeaderStyle
+      columns: TableElement.Column[]
+      rows: object[]
+    }
+
+    export namespace TableElement {
+      export interface HeaderStyle {
+        text_align?: TextAlign
+        text_size?: TextSize
+        background_style?: 'grey' | 'none'
+        text_color?: 'default' | 'grey'
+        bold?: boolean
+        lines?: number
+      }
+
+      export interface Column {
+        name: string
+        display_name?: string
+        width?: 'auto' | string
+        horizontal_align?: 'left' | 'center' | 'right'
+        data_type?: 'text' | 'lark_md' | 'options' | 'number' | 'persons' | 'date' | 'markdown'
+        format?: {
+          percision?: number
+          symbol?: string
+          separator?: string
+        }
+        date_format?: string
+      }
+    }
+
+    export interface NoteElement extends BaseElement<'note'> {
+      elements: NoteElement.InnerElement[]
+    }
+
+    export namespace NoteElement {
+      export type InnerElement = IconElement | PlainTextElement | BaseImageElement
+    }
+
+    export interface FormElement extends BaseElement<'form'> {
+      name: string
+      elements: Element[]
+      confirm?: ConfirmElement
+    }
+
+    export interface ActionElement extends BaseElement<'action'> {
+      actions: Element[]
+      layout?: 'bisected' | 'trisection' | 'flow'
+    }
 
     export type ActionBehavior =
       | OpenURLBehavior
@@ -283,26 +356,157 @@ export namespace MessageContent {
       value: Record<string, string>
     }
 
-    export interface ButtonElement extends BaseElement<'button'> {
+    export interface BaseButtonElement extends BaseElement<'button'> {
       text: PlainTextElement
-      type?: ButtonElement.Type
       size?: ButtonElement.Size
-      width?: ButtonElement.Width
       icon?: IconElement
-      hover_tips?: PlainTextElement
       disabled?: boolean
+      behaviors?: ActionBehavior[]
+    }
+
+    export interface ButtonElement extends BaseButtonElement {
+      type?: ButtonElement.Type
+      width?: ButtonElement.Width
+      hover_tips?: PlainTextElement
       disabled_tips?: PlainTextElement
       confirm?: {
         title: PlainTextElement
         text: PlainTextElement
       }
-      behaviors?: ActionBehavior[]
       // form-related fields
       name?: string
       required?: boolean
       action_type?: 'link' | 'request' | 'multi' | 'form_submit' | 'form_reset'
     }
 
+    export interface ConfirmElement {
+      title: PlainTextElement
+      text: PlainTextElement
+    }
+
+    export interface InputElement extends BaseElement<'input'> {
+      name: string
+      required?: boolean
+      placeholder?: PlainTextElement
+      default_value?: string
+      disabled?: boolean
+      width?: 'default' | 'fill' | string
+      max_length?: number
+      input_type?: 'text' | 'multiline_text' | 'password'
+      show_icon?: boolean
+      rows?: number
+      auto_resize?: boolean
+      max_rows?: number
+      label?: PlainTextElement
+      label_position?: 'top' | 'left'
+      value?: string | object
+      behaviors?: ActionBehavior[]
+      confirm?: ConfirmElement
+      fallback?: {
+        tag?: string
+        text?: PlainTextElement
+      }
+    }
+
+    export interface OverflowElement extends BaseElement<'overflow'> {
+      width?: 'default' | 'fill' | string
+      options: OverflowElement.Option[]
+      value?: object
+      confirm?: ConfirmElement
+    }
+
+    export namespace OverflowElement {
+      export interface Option {
+        text?: PlainTextElement
+        multi_url?: URLs
+        value?: string
+      }
+    }
+
+    export interface BaseSelectElement<T extends string = string> extends BaseElement<T> {
+      type?: 'default' | 'text'
+      name?: string
+      required?: boolean
+      disabled?: boolean
+      placeholder?: PlainTextElement
+      width?: 'default' | 'fill' | string
+      confirm?: ConfirmElement
+    }
+
+    export interface OptionElement {
+      text: PlainTextElement
+      icon?: IconElement
+      value: string
+    }
+
+    export interface SelectElement extends BaseSelectElement<'select_static'> {
+      options: OptionElement[]
+      initial_option?: string
+    }
+
+    export interface MultiSelectElement extends BaseSelectElement<'multi_select_static'> {
+      options: OptionElement[]
+      selected_values?: string[]
+    }
+
+    export interface SelectPersonElement extends BaseSelectElement<'select_person'> {
+      options?: { value: string }[]
+    }
+
+    export interface MultiSelectPersonElement extends BaseSelectElement<'multi_select_person'> {
+      options?: { value: string }[]
+      selected_values?: string[]
+    }
+
+    export interface DatePickerElement extends BaseSelectElement<'date_picker'> {
+      initial_date?: string
+      value?: object
+    }
+
+    export interface TimePickerElement extends BaseSelectElement<'picker_time'> {
+      initial_time?: string
+      value?: object
+    }
+
+    export interface DateTimePickerElement extends BaseSelectElement<'picker_datetime'> {
+      initial_datetime?: string
+      value?: object
+    }
+
+    export interface CheckerElement extends BaseElement<'checker'> {
+      name?: string
+      checked?: boolean
+      disabled?: boolean
+      text?: CheckerElement.TextElement
+      overall_checkable?: boolean
+      button_area?: {
+        pc_display_rule?: 'always' | 'on_hover'
+        buttons?: CheckerElement.ButtonElement[]
+      }
+      checked_style?: {
+        show_strikethrough?: boolean
+        opacity?: number
+      }
+      margin?: string
+      padding?: string
+      confirm?: ConfirmElement
+      behaviors?: ActionBehavior[]
+      hover_tips?: PlainTextElement
+      disable_tips?: PlainTextElement
+    }
+
+    export namespace CheckerElement {
+      export interface TextElement extends PlainTextElement {
+        text_size?: 'normal' | 'heading' | 'notation'
+        text_color?: string
+        text_align?: TextAlign
+      }
+
+      export interface ButtonElement extends BaseButtonElement {
+        type: 'text' | 'primary_text' | 'danger_text'
+      }
+    }
+
     export namespace ButtonElement {
       export type Size = 'tiny' | 'small' | 'medium' | 'large'
       export type Width = 'default' | 'fill' | string
@@ -312,8 +516,15 @@ export namespace MessageContent {
     export type Element =
       | DivElement
       | MarkdownElement
-      | HorizontalRuleElement
-      | ActionModule
+      | HRElement
+      | ActionElement
+      | NoteElement
+      | ChartElement
+      | TableElement
+      | ImageElement
+      | FormElement
+      | InputElement
+      | ButtonElement
   }
 
   export interface Template {

package/src/types/message/index.ts

@@ -76,5 +76,21 @@ declare module '../event' {
         open_chat_id: string
       }
     }
+    /**
+     * 机器人自定义菜单事件
+     * @see https://open.feishu.cn/document/client-docs/bot-v3/events/menu
+     */
+    'application.bot.menu_v6': {
+      operator: {
+        operator_name: string
+        operator_id: {
+          union_id: string
+          user_id: string
+          open_id: string
+        }
+      }
+      event_key: string
+      timestamp: number
+    }
   }
 }

package/src/utils.ts

@@ -84,6 +84,15 @@ export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: Eve
       adaptSender(body.event.sender, session)
       await adaptMessage(bot, body.event, session)
       break
+    case 'application.bot.menu_v6':
+      if (body.event.event_key.startsWith('command:')) {
+        session.type = 'interaction/command'
+        session.content = body.event.event_key.slice(8)
+        session.channelId = body.event.operator.operator_id.open_id
+        session.userId = body.event.operator.operator_id.open_id
+        session.isDirect = true
+      }
+      break
     case 'card.action.trigger':
       if (body.event.action.value?._satori_type === 'command') {
         session.type = 'interaction/command'
@@ -106,11 +115,17 @@ export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: Eve
         for (const [key, value] of Object.entries(options)) {
           content += ` --${key} ${value}`
         }
+        if (body.event.action.input_value) {
+          content += ` ${body.event.action.input_value}`
+        }
         session.content = content
         session.messageId = body.event.context.open_message_id
         session.channelId = body.event.context.open_chat_id
         session.guildId = body.event.context.open_chat_id
         session.userId = body.event.operator.open_id
+        const chat = await bot.internal.getImChat(session.channelId)
+        // TODO: add channel data
+        session.isDirect = chat.chat_mode === 'p2p'
       }
       break
   }
@@ -186,7 +201,7 @@ export function extractIdType(id: string): Lark.ReceiveIdType {
   return 'user_id'
 }
 
-export function decodeChannel(channelId: string, guild: GetImChatResponse['data']): Universal.Channel {
+export function decodeChannel(channelId: string, guild: GetImChatResponse): Universal.Channel {
   return {
     id: channelId,
     type: Universal.Channel.Type.TEXT,

package/lib/types/auth.d.ts

@@ -1,40 +0,0 @@
-import { BaseResponse } from '.';
-/**
- * Lark defines three types of token:
- * - app_access_token: to access the API in an app (published on App Store).
- * - tenant_access_token: to access the API as an enterprise or a team (tenant).
- *   *We commonly use this one*
- * - user_access_token: to access the API as the specific user.
- *
- * @see https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM
- */
-export interface AppCredentials {
-    app_id: string;
-    app_secret: string;
-}
-export interface AppAccessToken extends BaseResponse {
-    /** access token */
-    app_access_token: string;
-    /** expire time in seconds. e.g: 7140 (119 minutes) */
-    expire: number;
-}
-export interface TenantAccessToken extends BaseResponse {
-    /** access token */
-    tenant_access_token: string;
-    /** expire time in seconds. e.g: 7140 (119 minutes) */
-    expire: number;
-}
-declare module './internal' {
-    interface Internal {
-        /**
-         * Returns the app_access_token for the bot.
-         * @see https://open.larksuite.com/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal
-         */
-        getAppAccessToken(data: AppCredentials): Promise<AppAccessToken>;
-        /**
-         * Returns the tenant_access_token for the bot.
-         * @see https://open.larksuite.com/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal
-         */
-        getTenantAccessToken(data: AppCredentials): Promise<TenantAccessToken>;
-    }
-}

package/lib/types/guild.d.ts

@@ -1,59 +0,0 @@
-import { Dict } from '@satorijs/satori';
-import { Lark } from '.';
-import { Paginated, Pagination } from './utils';
-declare module '.' {
-    namespace Lark {
-        interface Guild {
-            avatar: string;
-            name: string;
-            description: string;
-            i18n_names: Dict<string>;
-            add_member_permission: string;
-            share_card_permission: string;
-            at_all_permission: string;
-            edit_permission: string;
-            owner_id_type: string;
-            owner_id: string;
-            chat_id: string;
-            chat_mode: string;
-            chat_type: string;
-            chat_tag: string;
-            join_message_visibility: string;
-            leave_message_visibility: string;
-            membership_approval: string;
-            moderation_permission: string;
-            external: boolean;
-            tenant_key: string;
-            user_count: string;
-            bot_count: string;
-        }
-    }
-}
-export interface GuildMember {
-    member_id_type: Lark.UserIdType;
-    member_id: string;
-    name: string;
-    tenant_key: string;
-}
-declare module './internal' {
-    interface Internal {
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list */
-        getCurrentUserGuilds(params?: Pagination<{
-            user_id_type?: Lark.UserIdType;
-        }>): Promise<{
-            data: Paginated<Lark.Guild>;
-        }>;
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get */
-        getGuildInfo(chat_id: string, params?: {
-            user_id_type?: string;
-        }): Promise<BaseResponse & {
-            data: Lark.Guild;
-        }>;
-        /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get */
-        getGuildMembers(chat_id: string, params?: Pagination<{
-            member_id_type?: Lark.UserIdType;
-        }>): Promise<{
-            data: Paginated<GuildMember>;
-        }>;
-    }
-}

package/lib/types/message/asset.d.ts

@@ -1,40 +0,0 @@
-import { BaseResponse } from '..';
-export interface Asset<T> extends BaseResponse {
-    data: T;
-}
-export type Image = Asset<{
-    image_key: string;
-}>;
-export type File = Asset<{
-    file_key: string;
-}>;
-declare module '../internal' {
-    interface Internal {
-        /**
-         * Upload an image to obtain an `image_key` for use in sending messages or changing the avatar.
-         *
-         * The data should contain:
-         * - `image_type`: 'message' | 'avatar'
-         * - `image': Buffer
-         * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create
-         */
-        uploadImage(data: FormData): Promise<Image>;
-        /**
-         * Upload a file to obtain a `file_key` for use in sending messages.
-         *
-         * The data should contain:
-         * - `file_type`: 'opus' | 'mp4' | 'pdf' | 'xls' | 'ppt' | 'stream'
-         *   - `opus`: Opus audio file
-         *   - `mp4`: MP4 video file
-         *   - `pdf`: PDF file
-         *   - `xls`: Excel file
-         *   - `ppt`: PowerPoint file
-         *   - `stream`: Stream file, or any other file not listed above
-         * - `file_name`: string, include extension
-         * - `duration`?: number, the duration of audio/video file in milliseconds
-         * - `file`: Buffer
-         * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/file/create
-         */
-        uploadFile(data: FormData): Promise<File>;
-    }
-}

package/lib/types/user.d.ts

@@ -1,78 +0,0 @@
-import { Lark } from '.';
-declare module '.' {
-    namespace Lark {
-        interface User {
-            union_id: string;
-            user_id?: string;
-            open_id: string;
-            name?: string;
-            en_name?: string;
-            nickname?: string;
-            email?: string;
-            mobile?: string;
-            mobile_visible: boolean;
-            gender?: Gender;
-            avatar?: AvatarInfo;
-            status?: UserStatus;
-            department_ids?: string[];
-            leader_user_id?: string;
-            city?: string;
-            country?: string;
-            work_station?: string;
-            join_time?: number;
-            is_tenant_manager?: boolean;
-            employee_no?: string;
-            employee_type?: number;
-            orders?: UserOrder[];
-            custom_attrs?: any;
-            enterprise_email?: string;
-            job_title?: string;
-            geo?: string;
-            job_level_id?: string;
-            job_family_id?: string;
-            assign_info?: any;
-            department_path?: DepartmentDetail[];
-        }
-        enum Gender {
-            SECRET = 0,
-            MALE = 1,
-            FEMALE = 2
-        }
-        interface AvatarInfo {
-            avatar_72: string;
-            avatar_240: string;
-            avatar_640: string;
-            avatar_origin: string;
-        }
-        interface UserStatus {
-            is_frozen: boolean;
-            is_resigned: boolean;
-            is_activated: boolean;
-            is_exited: boolean;
-            is_unjoin: boolean;
-        }
-        interface UserOrder {
-            department_id: string;
-            user_order: number;
-            department_order: number;
-            is_primary_dept: boolean;
-        }
-        interface DepartmentDetail {
-            dotted_line_leader_user_ids: string[];
-        }
-    }
-}
-export interface GuildMember {
-    member_id_type: Lark.UserIdType;
-    member_id: string;
-    name: string;
-    tenant_key: string;
-}
-declare module './internal' {
-    interface Internal {
-        /** @see https://open.larksuite.com/document/server-docs/contact-v3/user/get */
-        getContactUser(user_id: string, user_id_type?: Lark.UserIdType, department_id_type?: Lark.DepartmentIdType): Promise<BaseResponse & {
-            data: Lark.User;
-        }>;
-    }
-}

package/lib/types/utils.d.ts

@@ -1,9 +0,0 @@
-export type Pagination<T> = T & {
-    page_size?: number;
-    page_token?: string;
-};
-export interface Paginated<T> {
-    items: T[];
-    has_more: boolean;
-    page_token: string;
-}