@satorijs/adapter-lark 3.4.1 → 3.5.0

package/src/types/index.ts

@@ -1,8 +1,7 @@
 export * from './internal'
-export * from './auth'
 export * from './event'
-export * from './guild'
 export * from './message'
+export * from './api'
 
 export namespace Lark {
   /**

package/src/types/internal.ts

@@ -1,4 +1,4 @@
-import { Dict, makeArray, Quester } from '@satorijs/satori'
+import { Dict, HTTP, makeArray } from '@satorijs/core'
 import { LarkBot } from '../bot'
 
 export interface Internal {}
@@ -36,7 +36,7 @@ export class Internal {
               if (!args.length) throw new Error(`too few arguments for ${path}, received ${raw}`)
               return args.shift()
             })
-            const config: Quester.RequestConfig = {}
+            const config: HTTP.RequestConfig = {}
             if (args.length === 1) {
               if (method === 'GET' || method === 'DELETE') {
                 config.params = args[0]

package/src/types/message/index.ts

@@ -1,10 +1,7 @@
-import { Internal, Lark } from '..'
-import { Paginated, Pagination } from '../utils'
-
+import { Lark } from '..'
 import { MessageContent } from './content'
 
 export * from './content'
-export * from './asset'
 
 export type MessageType = 'text' | 'post' | 'image' | 'file' | 'audio' | 'media' | 'sticker' | 'interactive' | 'share_chat' | 'share_user'
 
@@ -22,16 +19,6 @@ export interface MessageContentMap {
 
 export type MessageContentType<T extends MessageType> = T extends keyof MessageContentMap ? MessageContentMap[T] : any
 
-export interface Sender extends Lark.UserIdentifiers {
-  sender_type: string
-  tenant_key: string
-}
-export interface Mention extends Lark.UserIdentifiers {
-  key: string
-  name: string
-  tenant_key: string
-}
-
 declare module '../event' {
   export interface Events {
     /**
@@ -75,176 +62,3 @@ declare module '../event' {
     }>
   }
 }
-
-export interface MessagePayload {
-  receive_id: string
-  content: string
-  msg_type: string
-}
-
-export interface Message {
-  /**
-   * The id of current message
-   *
-   * Should be started with `om_`
-   */
-  message_id: string
-  /**
-   * The id of the *root* message in reply chains
-   * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2
-   */
-  root_id: string
-
-  /**
-   * The id of the direct *parent* message in reply chains
-   * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#ac79c1c2
-   */
-  parent_id: string
-
-  /**
-   * The message type.
-   * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json
-   */
-  msg_type: MessageType
-
-  /**
-   * The timestamp when the message is created in milliseconds.
-   */
-  create_time: string
-
-  /**
-   * The timestamp when the message is last updated in milliseconds.
-   */
-  update_time: string
-
-  /**
-   * Whether the message is deleted.
-   */
-  deleted: boolean
-
-  /**
-   * Whether the message is updated.
-   */
-  updated: boolean
-
-  /**
-   * The id of the group / channel the message is sent to.
-   */
-  chat_id: string
-
-  /**
-   * The sender of the message.
-   * Can be a user or an app.
-   */
-  sender: Sender
-
-  /**
-   * The body of the message.
-   */
-  body: {
-    /**
-     * The content of the message.
-     * Should be a string that represents the JSON object contains the message content.
-     */
-    content: string
-  }
-
-  /**
-   * Users mentioned in the message.
-   */
-  mentions: Mention[]
-
-  /**
-   * The id of the direct *parent* message in `merge and repost` chains.
-   */
-  upper_message_id: string
-}
-
-export interface ReadUser {
-  user_id_type: Lark.UserIdType
-  user_id: string
-  timestamp: string
-  tenant_key: string
-}
-
-export interface GetMessageListParams {
-  /**
-   * Currently there is only 'chat' available
-   * @see https://open.larksuite.com/document/server-docs/im-v1/message/list
-   */
-  container_id_type: 'p2p' | 'chat'
-  /**
-   * Should be in the format like `oc_234jsi43d3ssi993d43545f`
-   */
-  container_id: string
-  /** Timestamp in seconds */
-  start_time?: string | number
-  /** Timestamp in seconds */
-  end_time?: string | number
-  /** @default 'ByCreateTimeAsc' */
-  sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc'
-  /** Range from 1 to 50 */
-  page_size?: number
-  /**
-   * If the current page is the first page, this field should be omitted.
-   * Otherwise you could use the `page_token` from the previous response to
-   * get the next page.
-   */
-  page_token?: string
-}
-
-declare module '../internal' {
-  export interface Internal {
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create */
-    sendMessage(receive_id_type: Lark.ReceiveIdType, message: MessagePayload): Promise<BaseResponse & { data: Message }>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/reply */
-    replyMessage(message_id: string, message: MessagePayload): Promise<BaseResponse & { data: Message }>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/update */
-    updateMessage(message_id: string, message: Omit<MessagePayload, 'receive_id'>): Promise<BaseResponse & { data: Message }>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/get */
-    getMessage(message_id: string): Promise<BaseResponse & { data: Message }>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete */
-    deleteMessage(message_id: string): Promise<BaseResponse>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/forward */
-    forwardMessage(
-      message_id: string,
-      receive_id_type: Lark.ReceiveIdType,
-      data: { receive_id: string },
-    ): Promise<BaseResponse & { data: Message }>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/merge_forward */
-    mergeForwardMessage(
-      receive_id_type: Lark.ReceiveIdType,
-      data: { receive_id: string; message_id_list: string[] },
-    ): Promise<BaseResponse & { data: { message: Message; invalid_message_id_list: string[] }}>
-    /** @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/read_users */
-    getMessageReadUsers(message_id: string, params: Pagination<{ user_id_type: Lark.UserIdType }>): Promise<BaseResponse & { data: Paginated<ReadUser> }>
-    /** @see https://open.larksuite.com/document/server-docs/im-v1/message/list */
-    getMessageList(params: GetMessageListParams): Promise<BaseResponse & { data: Paginated<Message> }>
-  }
-}
-
-Internal.define({
-  '/im/v1/messages': {
-    GET: 'getMessageList',
-  },
-  '/im/v1/messages?receive_id_type={receive_id_type}': {
-    POST: 'sendMessage',
-  },
-  '/im/v1/messages/{message_id}/reply': {
-    POST: 'replyMessage',
-  },
-  '/im/v1/messages/{message_id}': {
-    GET: 'getMessage',
-    PUT: 'updateMessage',
-    DELETE: 'deleteMessage',
-  },
-  '/im/v1/messages/{message_id}/read_users': {
-    GET: 'getMessageReadUsers',
-  },
-  '/im/v1/messages/{message_id}/forward?receive_id_type={receive_id_type}': {
-    POST: 'forwardMessage',
-  },
-  '/im/v1/messages/merge_forward?receive_id_type={receive_id_type}': {
-    POST: 'mergeForwardMessage',
-  },
-})

package/src/utils.ts

@@ -1,14 +1,14 @@
 import crypto from 'crypto'
-import { Context, h, Session, trimSlash, Universal } from '@satorijs/satori'
+import { Context, h, Session, trimSlash, Universal } from '@satorijs/core'
 import { FeishuBot, LarkBot } from './bot'
-import { AllEvents, Events, Lark, Message as LarkMessage, MessageContentType, MessageType } from './types'
+import { AllEvents, Events, GetImChatResponse, Lark, MessageContentType, MessageType } from './types'
 
 export type Sender =
   | {
-      sender_id: Lark.UserIds
-      sender_type?: string
-      tenant_key: string
-    }
+    sender_id: Lark.UserIds
+    sender_type?: string
+    tenant_key: string
+  }
   | (Lark.UserIdentifiers & { sender_type?: string; tenant_key: string })
 
 export function adaptSender(sender: Sender, session: Session): Session {
@@ -22,7 +22,7 @@ export function adaptSender(sender: Sender, session: Session): Session {
   return session
 }
 
-export function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1']['event'], session: Session): Session {
+export async function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1']['event'], session: Session, details = true): Promise<Session> {
   const json = JSON.parse(data.message.content) as MessageContentType<MessageType>
   const assetEndpoint = trimSlash(bot.config.selfUrl ?? bot.ctx.server.config.selfUrl) + bot.config.path + '/assets'
   const content: (string | h)[] = []
@@ -62,30 +62,34 @@ export function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1
   session.timestamp = +data.message.create_time
   session.messageId = data.message.message_id
   session.channelId = data.message.chat_id
+  session.guildId = data.message.chat_id
   session.content = content.map((c) => c.toString()).join(' ')
 
+  if (data.message.parent_id && details) {
+    session.quote = await bot.getMessage(session.channelId, data.message.parent_id, false)
+  }
   return session
 }
 
-export function adaptSession<C extends Context>(bot: FeishuBot<C>, body: AllEvents) {
+export async function adaptSession<C extends Context>(bot: FeishuBot<C>, body: AllEvents) {
   const session = bot.session()
   session.setInternal('lark', body)
 
   switch (body.type) {
     case 'im.message.receive_v1':
       session.type = 'message'
-      session.subtype = body.event.message.chat_type
+      session.subtype = body.event.message.chat_id
       if (session.subtype === 'p2p') session.subtype = 'private'
       session.isDirect = session.subtype === 'private'
       adaptSender(body.event.sender, session)
-      adaptMessage(bot, body.event, session)
+      await adaptMessage(bot, body.event, session)
       break
   }
   return session
 }
 
 // TODO: This function has many duplicated code with `adaptMessage`, should refactor them
-export async function decodeMessage(bot: LarkBot, body: LarkMessage): Promise<Universal.Message> {
+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 assetEndpoint = trimSlash(bot.config.selfUrl ?? bot.ctx.server.config.selfUrl) + bot.config.path + '/assets'
   const content: h[] = []
@@ -127,9 +131,17 @@ export async function decodeMessage(bot: LarkBot, body: LarkMessage): Promise<Un
     createdAt: +body.create_time,
     updatedAt: +body.update_time,
     id: body.message_id,
+    messageId: body.message_id,
+    user: {
+      id: body.sender.id,
+    },
+    channel: {
+      id: body.chat_id,
+      type: Universal.Channel.Type.TEXT,
+    },
     content: content.map((c) => c.toString()).join(' '),
     elements: content,
-    quote: body.upper_message_id ? await bot.getMessage(body.chat_id, body.upper_message_id) : undefined,
+    quote: (body.upper_message_id && details) ? await bot.getMessage(body.chat_id, body.upper_message_id, false) : undefined,
   }
 }
 
@@ -145,16 +157,16 @@ export function extractIdType(id: string): Lark.ReceiveIdType {
   return 'user_id'
 }
 
-export function decodeChannel(guild: Lark.Guild): Universal.Channel {
+export function decodeChannel(channelId: string, guild: GetImChatResponse['data']): Universal.Channel {
   return {
-    id: guild.chat_id,
+    id: channelId,
     type: Universal.Channel.Type.TEXT,
     name: guild.name,
-    parentId: guild.chat_id,
+    parentId: channelId,
   }
 }
 
-export function decodeGuild(guild: Lark.Guild): Universal.Guild {
+export function decodeGuild(guild: Lark.ListChat): Universal.Guild {
   return {
     id: guild.chat_id,
     name: guild.name,