@satorijs/adapter-lark 3.10.5 → 3.11.0

package/lib/utils.d.ts

@@ -1,6 +1,6 @@
 import { Context, Session, Universal } from '@satorijs/core';
 import { LarkBot } from './bot';
-import { GetImChatResponse, ListChat, Message, User } from './types';
+import { Im, ListChat, Message, User } from './types';
 import { MessageContent } from './content';
 export interface EventHeader<K extends keyof Events> {
     event_id: string;
@@ -154,7 +154,7 @@ export declare function decodeMessage<C extends Context = Context>(bot: LarkBot<
  * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction
  */
 export declare function extractIdType(id: string): ReceiveIdType;
-export declare function decodeChannel(channelId: string, guild: GetImChatResponse): Universal.Channel;
+export declare function decodeChannel(channelId: string, guild: Im.Chat.GetResponse): Universal.Channel;
 export declare function decodeGuild(guild: ListChat): Universal.Guild;
 export declare function decodeUser(user: User): Universal.User;
 export declare class Cipher {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@satorijs/adapter-lark",
   "description": "Lark (飞书) Adapter for Satorijs",
-  "version": "3.10.5",
+  "version": "3.11.0",
   "type": "module",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -34,13 +34,13 @@
     "chat"
   ],
   "devDependencies": {
-    "@cordisjs/plugin-server": "^0.2.5",
-    "@satorijs/core": "^4.5.0",
+    "@cordisjs/plugin-server": "^0.2.7",
+    "@satorijs/core": "^4.5.2",
     "cordis": "^3.18.1",
     "cosmokit": "^1.7.2",
     "dedent": "^1.5.3"
   },
   "peerDependencies": {
-    "@satorijs/core": "^4.5.0"
+    "@satorijs/core": "^4.5.2"
   }
 }

package/src/bot.ts

@@ -1,11 +1,11 @@
 import { Bot, Context, h, HTTP, Schema, Time, Universal } from '@satorijs/core'
-import { CreateImFileForm } from './types'
+import { Im } from './types'
 import { HttpServer } from './http'
 import { LarkMessageEncoder } from './message'
 import { Internal } from './internal'
 import * as Utils from './utils'
 
-const fileTypeMap: Record<Exclude<CreateImFileForm['file_type'], 'stream'>, string[]> = {
+const fileTypeMap: Record<Exclude<Im.File.CreateForm['file_type'], 'stream'>, string[]> = {
   opus: ['audio/opus'],
   mp4: ['video/mp4'],
   pdf: ['application/pdf'],
@@ -80,7 +80,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
     // 初次获得 token 后的半小时内必须刷新一次，因为初次获得的 token 可能是 1.5 小时前生成的。
     let timeout = Time.minute * 20
     try {
-      const { tenant_access_token: token } = await this.internal.tenantAccessTokenInternalAuth({
+      const { tenant_access_token: token } = await this.internal.auth.tenantAccessTokenInternal({
         app_id: this.config.appId,
         app_secret: this.config.appSecret,
       })
@@ -103,30 +103,30 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   }
 
   async deleteMessage(channelId: string, messageId: string) {
-    await this.internal.deleteImMessage(messageId)
+    await this.internal.im.message.delete(messageId)
   }
 
   async getMessage(channelId: string, messageId: string, recursive = true) {
-    const data = await this.internal.getImMessage(messageId)
+    const data = await this.internal.im.message.get(messageId)
     const message = await Utils.decodeMessage(this, data.items![0], recursive)
-    const im = await this.internal.getImChat(channelId)
+    const im = await this.internal.im.chat.get(channelId)
     message.channel!.type = im.chat_mode === 'p2p' ? Universal.Channel.Type.DIRECT : Universal.Channel.Type.TEXT
     return message
   }
 
   async getMessageList(channelId: string, before?: string) {
-    const messages = await this.internal.listImMessage({ container_id_type: 'chat', container_id: channelId, page_token: before })
+    const messages = await this.internal.im.message.list({ container_id_type: 'chat', container_id: channelId, page_token: before })
     const data = await Promise.all(messages.items.reverse().map(data => Utils.decodeMessage(this, data)))
     return { data, next: data[0]?.id }
   }
 
   async getUser(userId: string, guildId?: string) {
-    const data = await this.internal.getContactUser(userId)
+    const data = await this.internal.contact.user.get(userId)
     return Utils.decodeUser(data.user!)
   }
 
   async getChannel(channelId: string) {
-    const chat = await this.internal.getImChat(channelId)
+    const chat = await this.internal.im.chat.get(channelId)
     return Utils.decodeChannel(channelId, chat)
   }
 
@@ -135,31 +135,31 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   }
 
   async getGuild(guildId: string) {
-    const chat = await this.internal.getImChat(guildId)
+    const chat = await this.internal.im.chat.get(guildId)
     return Utils.decodeGuild(chat)
   }
 
   async getGuildList(after?: string) {
-    const chats = await this.internal.listImChat({ page_token: after })
+    const chats = await this.internal.im.chat.list({ page_token: after })
     return { data: chats.items.map(Utils.decodeGuild), next: chats.page_token }
   }
 
   async getGuildMemberList(guildId: string, after?: string) {
-    const members = await this.internal.getImChatMembers(guildId, { page_token: after })
+    const members = await this.internal.im.chat.members.get(guildId, { page_token: after })
     const data = members.items!.map(v => ({ user: { id: v.member_id, name: v.name }, name: v.name }))
     return { data, next: members.page_token }
   }
 
   async createUpload(...uploads: Universal.Upload[]): Promise<string[]> {
     return await Promise.all(uploads.map(async (upload) => {
-      let type: CreateImFileForm['file_type'] = 'stream'
+      let type: Im.File.CreateForm['file_type'] = 'stream'
       for (const [key, value] of Object.entries(fileTypeMap)) {
         if (value.includes(upload.type)) {
-          type = key as CreateImFileForm['file_type']
+          type = key as Im.File.CreateForm['file_type']
           break
         }
       }
-      const response = await this.internal.createImFile({
+      const response = await this.internal.im.file.create({
         file_name: upload.filename,
         file_type: type,
         file: new Blob([upload.data]),

package/src/content.ts

@@ -447,6 +447,7 @@ export namespace MessageContent {
     export interface SelectElement extends BaseSelectElement<'select_static'> {
       options: OptionElement[]
       initial_option?: string
+      behaviors?: ActionBehavior[]
     }
 
     export interface MultiSelectElement extends BaseSelectElement<'multi_select_static'> {
@@ -553,6 +554,7 @@ export namespace MessageContent {
       | ButtonElement
       | CheckerElement
       | ColumnSetElement
+      | SelectElement
   }
 
   export interface Template {

package/src/internal.ts

@@ -34,17 +34,26 @@ export interface InternalRoute {
 }
 
 export class Internal<C extends Context = Context> {
-  constructor(private bot: LarkBot<C>) {}
+  constructor(bot: LarkBot<C>, tree = Internal._tree) {
+    return new Proxy(this, {
+      get: (target, prop) => {
+        if (typeof prop === 'symbol') return Reflect.get(target, prop)
+        const value = tree[prop]
+        if (typeof value === 'function') return value.bind(bot)
+        if (value) return new Internal(bot, value)
+      },
+    })
+  }
 
-  private _assertResponse(response: HTTP.Response<BaseResponse>) {
+  private static _assertResponse(bot: LarkBot, response: HTTP.Response<BaseResponse>) {
     if (!response.data.code) return
-    this.bot.logger.debug('response: %o', response.data)
+    bot.logger.debug('response: %o', response.data)
     const error = new HTTP.Error(`request failed`)
     error.response = response
     throw error
   }
 
-  private _buildData(arg: object, options: InternalRoute) {
+  private static _buildData(arg: object, options: InternalRoute) {
     if (options.multipart) {
       const form = new FormData()
       for (const [key, value] of Object.entries(arg)) {
@@ -60,6 +69,8 @@ export class Internal<C extends Context = Context> {
     }
   }
 
+  private static _tree: Dict = Object.create(null)
+
   static define(routes: Dict<Partial<Record<HTTP.Method, string | InternalRoute>>>) {
     for (const path in routes) {
       for (const key in routes[path]) {
@@ -69,7 +80,7 @@ export class Internal<C extends Context = Context> {
             route = { name: route }
           }
 
-          const impl = async function (this: Internal, ...args: any[]) {
+          const impl = async function (bot: LarkBot, ...args: any[]) {
             const raw = args.join(', ')
             const url = path.replace(/\{([^}]+)\}/g, () => {
               if (!args.length) throw new Error(`too few arguments for ${path}, received ${raw}`)
@@ -80,10 +91,10 @@ export class Internal<C extends Context = Context> {
               if (method === 'GET' || method === 'DELETE') {
                 config.params = args[0]
               } else {
-                config.data = this._buildData(args[0], route)
+                config.data = Internal._buildData(args[0], route)
               }
             } else if (args.length === 2 && method !== 'GET' && method !== 'DELETE') {
-              config.data = this._buildData(args[0], route)
+              config.data = Internal._buildData(args[0], route)
               config.params = args[1]
             } else if (args.length > 1) {
               throw new Error(`too many arguments for ${path}, received ${raw}`)
@@ -91,8 +102,8 @@ export class Internal<C extends Context = Context> {
             if (route.type === 'binary') {
               config.responseType = 'arraybuffer'
             }
-            const response = await this.bot.http(method, url, config)
-            this._assertResponse(response)
+            const response = await bot.http(method, url, config)
+            Internal._assertResponse(bot, response)
             if (route.type === 'raw-json' || route.type === 'binary') {
               return response.data
             } else {
@@ -100,12 +111,18 @@ export class Internal<C extends Context = Context> {
             }
           }
 
-          Internal.prototype[route.name] = function (this: Internal, ...args: any[]) {
+          let root = Internal._tree
+          const parts = route.name.split('.')
+          const lastPart = parts.pop()!
+          for (const part of parts) {
+            root = root[part] ??= Object.create(null)
+          }
+          root[lastPart] = function (this: LarkBot, ...args: any[]) {
             let promise: Promise<any> | undefined
             const result = {} as Paginated
             for (const key of ['then', 'catch', 'finally']) {
               result[key] = (...args2: any[]) => {
-                return (promise ??= impl.apply(this, args))[key](...args2)
+                return (promise ??= impl(this, ...args))[key](...args2)
               }
             }
 
@@ -126,7 +143,7 @@ export class Internal<C extends Context = Context> {
                 return this
               }
               result[Symbol.for('satori.pagination')] = async () => {
-                const data = await impl.apply(this, iterArgs)
+                const data = await impl(this, ...iterArgs)
                 iterArgs[argIndex].page_token = data[tokenKey]
                 return {
                   data: data[itemsKey],

package/src/message.ts

@@ -1,6 +1,6 @@
 import { Context, Dict, h, MessageEncoder } from '@satorijs/core'
 import { LarkBot } from './bot'
-import { CreateImFileForm, Message } from './types'
+import { Im, Message } from './types'
 import { EventPayload, extractIdType } from './utils'
 import { MessageContent } from './content'
 
@@ -13,6 +13,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
   private card: MessageContent.Card | undefined
   private noteElements: MessageContent.Card.NoteElement.InnerElement[] | undefined
   private actionElements: MessageContent.Card.Element[] = []
+  private isForm = false
 
   public editMessageIds: string[] | undefined
 
@@ -28,7 +29,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
           }
         } else if (this.referrer.type === 'card.action.trigger') {
           // cannot determine whether the card is in thread or not
-          const { items: [message] } = await this.bot.internal.getImMessage(this.referrer.event.context.open_message_id)
+          const { items: [message] } = await this.bot.internal.im.message.get(this.referrer.event.context.open_message_id)
           if (message?.thread_id) {
             quote = {
               id: this.referrer.event.context.open_message_id,
@@ -42,18 +43,18 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         if (!messageId) throw new Error('No message to edit')
         if (data.msg_type === 'interactive') {
           delete data.msg_type
-          await this.bot.internal.patchImMessage(messageId, data)
+          await this.bot.internal.im.message.patch(messageId, data)
         } else {
-          await this.bot.internal.updateImMessage(messageId, data)
+          await this.bot.internal.im.message.update(messageId, data)
         }
       } else if (quote?.id) {
-        resp = await this.bot.internal.replyImMessage(quote.id, {
+        resp = await this.bot.internal.im.message.reply(quote.id, {
           ...data,
           reply_in_thread: quote.replyInThread,
         })
       } else {
         data.receive_id = this.channelId
-        resp = await this.bot.internal.createImMessage(data, {
+        resp = await this.bot.internal.im.message.create(data, {
           receive_id_type: extractIdType(this.channelId),
         })
       }
@@ -127,7 +128,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
 
   async createImage(url: string) {
     const { filename, type, data } = await this.bot.assetsQuester.file(url)
-    const { image_key } = await this.bot.internal.createImImage({
+    const { image_key } = await this.bot.internal.im.image.create({
       image_type: 'message',
       image: new File([data], filename, { type }),
     })
@@ -148,7 +149,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
 
     const { filename, type, data } = await this.bot.assetsQuester.file(url)
 
-    let file_type: CreateImFileForm['file_type']
+    let file_type: Im.File.CreateForm['file_type']
     if (_type === 'audio') {
       // FIXME: only support opus
       file_type = 'opus'
@@ -164,7 +165,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
       }
     }
 
-    const form: CreateImFileForm = {
+    const form: Im.File.CreateForm = {
       file_type,
       file: new File([data], filename, { type }),
       file_name: filename,
@@ -173,7 +174,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
       form.duration = attrs.duration
     }
 
-    const { file_key } = await this.bot.internal.createImFile(form)
+    const { file_key } = await this.bot.internal.im.file.create(form)
     await this.post({
       msg_type: _type === 'video' ? 'media' : _type,
       content: JSON.stringify({ file_key }),
@@ -251,7 +252,9 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
     } else if (type === 'form') {
       this.flushText()
       const length = this.card?.elements.length
+      this.isForm = true
       await this.render(children)
+      this.isForm = false
       if (this.card?.elements.length > length) {
         const elements = this.card?.elements.splice(length)
         this.card.elements.push({
@@ -267,7 +270,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         this.card?.elements.push({
           tag: 'checker',
           name: (attrs.argument ? '@@' : attrs.option ? `@${attrs.option}=` : '') + attrs.name,
-          checked: attrs.checked,
+          checked: attrs.value,
           text: {
             tag: 'plain_text',
             content: this.textContent,
@@ -293,20 +296,68 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         this.textContent = ''
       } else {
         this.flushText()
+        const input: MessageContent.Card.InputElement = {
+          tag: 'input',
+          name: attrs.name,
+          width: attrs.width,
+          label: attrs.label && {
+            tag: 'plain_text',
+            content: attrs.label,
+          },
+          placeholder: attrs.placeholder && {
+            tag: 'plain_text',
+            content: attrs.placeholder,
+          },
+          default_value: attrs.value,
+          disabled: attrs.disabled,
+          required: attrs.required,
+        }
+        if (this.isForm) {
+          this.card?.elements.push(input)
+        } else {
+          this.card?.elements.push({
+            tag: 'action',
+            actions: [{
+              ...input,
+              behaviors: this.createBehavior(attrs),
+            }],
+          })
+        }
+      }
+    } else if (type === 'select') {
+      this.flushText()
+      const select: MessageContent.Card.SelectElement = {
+        tag: 'select_static',
+        name: attrs.name,
+        width: attrs.width,
+        initial_option: attrs.value,
+        disabled: attrs.disabled,
+        required: attrs.required,
+        placeholder: attrs.placeholder && {
+          tag: 'plain_text',
+          content: attrs.placeholder,
+        },
+        options: [],
+      }
+      for (const child of children) {
+        if (child.type !== 'option') continue
+        await this.render(child.children)
+        select.options.push({
+          value: child.attrs.value,
+          text: {
+            tag: 'plain_text',
+            content: this.textContent ?? child.attrs.value,
+          },
+        })
+        this.textContent = ''
+      }
+      if (this.isForm) {
+        this.card?.elements.push(select)
+      } else {
         this.card?.elements.push({
           tag: 'action',
           actions: [{
-            tag: 'input',
-            name: attrs.name,
-            width: attrs.width,
-            label: attrs.label && {
-              tag: 'plain_text',
-              content: attrs.label,
-            },
-            placeholder: attrs.placeholder && {
-              tag: 'plain_text',
-              content: attrs.placeholder,
-            },
+            ...select,
             behaviors: this.createBehavior(attrs),
           }],
         })
@@ -437,13 +488,14 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
           }
           this.card = { elements: [] }
           await this.render(child.children)
+          this.flushText()
           columns.push({
             tag: 'column',
             width: child.attrs.width,
             weight: child.attrs.weight,
             padding: child.attrs.padding,
-            vertical_align: child.attrs.verticalAlign,
-            vertical_spacing: child.attrs.verticalSpacing,
+            vertical_align: child.attrs.verticalAlign ?? 'center',
+            vertical_spacing: child.attrs.verticalSpacing ?? '0px',
             background_style: child.attrs.backgroundStyle,
             elements: this.card.elements,
           })