@satorijs/adapter-lark 3.6.0 → 3.6.2

package/src/types/message/content.ts

@@ -1,23 +1,35 @@
-// https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json
+// https://open.larksuite.com/document/server-docs/im-v1/message-content-description/create_json
 
-export namespace MessageContent {
-  export type Contents =
-    | Text
-    | Image
-    | ShareChat
-    | ShareUser
-    | Audio
-    | Media
-    | File
-    | Sticker
-    | RichText
-
-  export type MediaContents =
-    | Image
-    | Audio
-    | Media
-    | File
+declare global {
+  namespace JSX {
+    interface IntrinsicElements {
+      'lark:share-chat': {
+        'chat-id': string
+      }
+      'lark:share-user': {
+        'user-id': string
+      }
+      'lark:system': {
+        'need-rollup'?: boolean
+      }
+    }
+  }
+}
 
+export interface MessageContent {
+  text: MessageContent.Text
+  post: MessageContent.RichText
+  image: MessageContent.Image
+  file: MessageContent.File
+  audio: MessageContent.Audio
+  media: MessageContent.Media
+  sticker: MessageContent.Sticker
+  share_chat: MessageContent.ShareChat
+  share_user: MessageContent.ShareUser
+  system: MessageContent.System
+}
+
+export namespace MessageContent {
   export interface Text {
     text: string
   }
@@ -40,7 +52,7 @@ export namespace MessageContent {
 
   export interface Media {
     file_key: string
-    image_key: string
+    image_key?: string
   }
 
   export interface File {
@@ -51,52 +63,475 @@ export namespace MessageContent {
     file_key: string
   }
 
+  export interface System {
+    type: 'divider'
+    params: {
+      divider_text: {
+        text: string
+        i18n_text?: Record<string, string>
+      }
+    }
+    options?: {
+      need_rollup?: boolean
+    }
+  }
+
   export interface RichText {
     [locale: string]: {
-      title: string
+      title?: string
       content: RichText.Paragraph[]
     }
   }
 
   export namespace RichText {
-    export interface Paragraph extends Array<RichText.Content> {}
+    export type Style = 'bold' | 'italic' | 'underline' | 'lineThrough'
 
-    export interface BaseContent {
-      tag: string
+    export interface BaseElement<T extends string = string> {
+      tag: T
     }
 
-    export interface TextContent extends BaseContent {
-      tag: 'text'
+    export interface TextElement extends BaseElement<'text'> {
       text: string
       un_escape?: boolean
+      style?: Style[]
     }
-    export interface LinkContent extends BaseContent {
-      tag: 'a'
+
+    export interface LinkElement extends BaseElement<'a'> {
       text: string
       href: string
+      style?: Style[]
     }
-    export interface AtContent extends BaseContent {
-      tag: 'at'
+
+    export interface AtElement extends BaseElement<'at'> {
       user_id: string
-      user_name?: string
+      style?: Style[]
+      // user_name?: string
     }
-    export interface ImageContent extends BaseContent {
-      tag: 'img'
+
+    export interface ImageElement extends BaseElement<'img'> {
       image_key: string
-      height?: number
-      width?: number
+      // height?: number
+      // width?: number
     }
-    export interface MediaContent extends BaseContent {
-      tag: 'media'
+
+    export interface MediaElement extends BaseElement<'media'> {
       file_key: string
       image_key?: string
     }
 
-    export type Content =
-      | RichText.TextContent
-      | RichText.LinkContent
-      | RichText.AtContent
-      | RichText.ImageContent
-      | RichText.MediaContent
+    export interface EmotionElement extends BaseElement<'emoji'> {
+      emoji_type: string
+    }
+
+    export interface CodeBlockElement extends BaseElement<'code_block'> {
+      language?: string
+      text: string
+    }
+
+    export interface HRElement extends BaseElement<'hr'> {}
+
+    export interface MarkdownElement extends BaseElement<'md'> {
+      text: string
+    }
+
+    export type InlineElement =
+      | TextElement
+      | LinkElement
+      | AtElement
+      | EmotionElement
+      | MarkdownElement
+
+    export type BlockElement =
+      | ImageElement
+      | MediaElement
+      | CodeBlockElement
+      | HRElement
+
+    export type Paragraph =
+      | InlineElement[]
+      | [BlockElement]
+  }
+
+  export interface Card {
+    config?: Card.Config
+    card_link?: Card.URLs
+    header?: Card.Header
+    elements: Card.Element[]
+  }
+
+  export namespace Card {
+    /** @see https://open.larksuite.com/document/common-capabilities/message-card/getting-started/card-structure/card-configuration */
+    export interface Config {
+      enable_forward?: boolean
+      update_multi?: boolean
+    }
+
+    export interface URLs {
+      url: string
+      pc_url?: string
+      ios_url?: string
+      android_url?: string
+    }
+
+    /** @see https://open.larksuite.com/document/common-capabilities/message-card/message-cards-content/card-header */
+    export interface Header {
+      title: I18nPlainTextElement
+      subtitle?: I18nPlainTextElement
+      template?: Header.Template
+      icon?: CustomIconElement
+      ud_icon?: StandardIconElement
+      text_tag_list?: TextTagElement[]
+      i18n_text_tag_list?: Record<string, TextTagElement[]>
+    }
+
+    export namespace Header {
+      export type Template = 'blue' | 'wathet' | 'turquoise' | 'green' | 'yellow' | 'orange' | 'red' | 'carmine' | 'violet' | 'purple' | 'indigo' | 'grey' | 'default'
+    }
+
+    export interface BaseElement<T extends string = string> {
+      tag: T
+    }
+
+    export type TextSize =
+      | 'heading-0' | 'heading-1' | 'heading-2' | 'heading-3' | 'heading-4' | 'heading'
+      | 'normal' | 'notation' | 'xxxx-large' | 'xxx-large' | 'xx-large' | 'x-large' | 'large' | 'medium' | 'small' | 'x-small'
+
+    export type TextAlign = 'left' | 'center' | 'right'
+
+    export interface PlainTextElement extends BaseElement<'plain_text'> {
+      content: string
+    }
+
+    export interface I18nPlainTextElement extends PlainTextElement {
+      i18n?: Record<string, string>
+    }
+
+    export interface DivPlainTextElement extends PlainTextElement {
+      text_size?: TextSize
+      text_color?: string
+      text_align?: TextAlign
+      lines?: number
+      icon?: IconElement
+    }
+
+    export type IconElement = StandardIconElement | CustomIconElement
+
+    export interface CustomIconElement extends BaseElement<'custom_icon'> {
+      img_key: string
+    }
+
+    export interface StandardIconElement extends BaseElement<'standard_icon'> {
+      token: string
+      color?: string
+    }
+
+    export interface TextTagElement extends BaseElement<'text_tag'> {
+      text: PlainTextElement
+      color: TextTagElement.Color
+    }
+
+    export namespace TextTagElement {
+      export type Color = 'neutral' | 'blue' | 'torqoise' | 'lime' | 'orange' | 'violet' | 'indigo' | 'wathet' | 'green' | 'yellow' | 'red' | 'purple' | 'carmine'
+    }
+
+    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'
+    }
+
+    export interface HRElement extends BaseElement<'hr'> {}
+
+    export interface DivElement extends BaseElement<'div'> {
+      text?: DivPlainTextElement
+    }
+
+    export interface MarkdownElement extends BaseElement<'markdown'> {
+      content: string
+      text_size?: TextSize
+      text_align?: TextAlign
+      href?: Record<string, URLs>
+    }
+
+    export interface PersonElement extends BaseElement<'person'> {
+      user_id: string
+      size?: 'large' | 'medium' | 'small' | 'extra_small'
+    }
+
+    export interface PersonListElement extends BaseElement<'person_list'> {
+      persons: { id: string }[]
+      size?: 'large' | 'medium' | 'small' | 'extra_small'
+      show_name?: boolean
+      show_avatar?: boolean
+    }
+
+    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
+      | CallbackBehavior
+
+    export interface OpenURLBehavior {
+      type: 'open_url'
+      default_url: string
+      pc_url?: string
+      ios_url?: string
+      android_url?: string
+    }
+
+    export interface CallbackBehavior {
+      type: 'callback'
+      value: Record<string, string>
+    }
+
+    export interface BaseButtonElement extends BaseElement<'button'> {
+      text: PlainTextElement
+      size?: ButtonElement.Size
+      icon?: IconElement
+      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
+      }
+      // 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
+      export type Type = 'default' | 'primary' | 'danger' | 'text' | 'primary_text' | 'danger_text' | 'primary_filled' | 'danger_filled' | 'laser'
+    }
+
+    export type Element =
+      | DivElement
+      | MarkdownElement
+      | HRElement
+      | ActionElement
+      | NoteElement
+      | ChartElement
+      | TableElement
+      | ImageElement
+      | FormElement
+      | InputElement
+      | ButtonElement
+  }
+
+  export interface Template {
+    type: 'template'
+    data: {
+      template_id: string
+      template_variable: object
+    }
   }
 }

package/src/types/message/index.ts

@@ -1,24 +1,7 @@
-import { Lark } from '..'
-import { MessageContent } from './content'
+import { Lark, MessageContent } from '..'
 
 export * from './content'
 
-export type MessageType = 'text' | 'post' | 'image' | 'file' | 'audio' | 'media' | 'sticker' | 'interactive' | 'share_chat' | 'share_user'
-
-export interface MessageContentMap {
-  'text': MessageContent.Text
-  'post': MessageContent.RichText
-  'image': MessageContent.Image
-  'file': MessageContent.File
-  'audio': MessageContent.Audio
-  'media': MessageContent.Media
-  'sticker': MessageContent.Sticker
-  'share_chat': MessageContent.ShareChat
-  'share_user': MessageContent.ShareUser
-}
-
-export type MessageContentType<T extends MessageType> = T extends keyof MessageContentMap ? MessageContentMap[T] : any
-
 declare module '../event' {
   export interface Events {
     /**
@@ -38,7 +21,7 @@ declare module '../event' {
         create_time: string
         chat_id: string
         chat_type: string
-        message_type: MessageType
+        message_type: keyof MessageContent
         content: string
         mentions: {
           key: string
@@ -93,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

@@ -1,7 +1,7 @@
 import crypto from 'crypto'
 import { Context, h, Session, trimSlash, Universal } from '@satorijs/core'
-import { FeishuBot, LarkBot } from './bot'
-import { EventPayload, Events, GetImChatResponse, Lark, MessageContentType, MessageType } from './types'
+import { LarkBot } from './bot'
+import { EventPayload, Events, GetImChatResponse, Lark } from './types'
 
 export type Sender =
   | {
@@ -22,8 +22,8 @@ export function adaptSender(sender: Sender, session: Session): Session {
   return session
 }
 
-export async function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1'], session: Session, details = true): Promise<Session> {
-  const json = JSON.parse(data.message.content) as MessageContentType<MessageType>
+export async function adaptMessage(bot: LarkBot, data: Events['im.message.receive_v1'], session: Session, details = true): Promise<Session> {
+  const json = JSON.parse(data.message.content)
   const assetEndpoint = trimSlash(bot.config.selfUrl ?? bot.ctx.server.config.selfUrl) + bot.config.path + '/assets'
   const content: (string | h)[] = []
   switch (data.message.message_type) {
@@ -71,7 +71,7 @@ export async function adaptMessage(bot: FeishuBot, data: Events['im.message.rece
   return session
 }
 
-export async function adaptSession<C extends Context>(bot: FeishuBot<C>, body: EventPayload) {
+export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: EventPayload) {
   const session = bot.session()
   session.setInternal('lark', body)
 
@@ -84,6 +84,15 @@ export async function adaptSession<C extends Context>(bot: FeishuBot<C>, body: E
       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: FeishuBot<C>, body: E
         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 { data } = await bot.internal.getImChat(session.channelId)
+        // TODO: add channel data
+        session.isDirect = data.chat_mode === 'p2p'
       }
       break
   }
@@ -119,7 +134,7 @@ export async function adaptSession<C extends Context>(bot: FeishuBot<C>, body: E
 
 // TODO: This function has many duplicated code with `adaptMessage`, should refactor them
 export async function decodeMessage(bot: LarkBot, body: Lark.Message, details = true): Promise<Universal.Message> {
-  const json = JSON.parse(body.body.content) as MessageContentType<MessageType>
+  const json = JSON.parse(body.body.content)
   const assetEndpoint = trimSlash(bot.config.selfUrl ?? bot.ctx.server.config.selfUrl) + bot.config.path + '/assets'
   const content: h[] = []
   switch (body.msg_type) {