@satorijs/adapter-lark 3.4.1 → 3.5.0

package/lib/types/index.d.ts

@@ -1,8 +1,7 @@
 export * from './internal';
-export * from './auth';
 export * from './event';
-export * from './guild';
 export * from './message';
+export * from './api';
 export declare namespace Lark {
     /**
      * A user in Lark has several different IDs.

package/lib/types/internal.d.ts

@@ -1,4 +1,4 @@
-import { Dict } from '@satorijs/satori';
+import { Dict } from '@satorijs/core';
 import { LarkBot } from '../bot';
 export interface Internal {
 }

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

@@ -1,8 +1,6 @@
 import { Lark } from '..';
-import { Paginated, Pagination } from '../utils';
 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';
 export interface MessageContentMap {
     'text': MessageContent.Text;
@@ -16,15 +14,6 @@ export interface MessageContentMap {
     'share_user': MessageContent.ShareUser;
 }
 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' {
     interface Events {
         /**
@@ -68,153 +57,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' {
-    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>;
-        }>;
-    }
-}

package/lib/utils.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
-import { Context, Session, Universal } from '@satorijs/satori';
+import { Context, Session, Universal } from '@satorijs/core';
 import { FeishuBot, LarkBot } from './bot';
-import { AllEvents, Events, Lark, Message as LarkMessage } from './types';
+import { AllEvents, Events, GetImChatResponse, Lark } from './types';
 export type Sender = {
     sender_id: Lark.UserIds;
     sender_type?: string;
@@ -11,16 +11,16 @@ export type Sender = {
     tenant_key: string;
 });
 export declare function adaptSender(sender: Sender, session: Session): Session;
-export declare function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1']['event'], session: Session): Session;
-export declare function adaptSession<C extends Context>(bot: FeishuBot<C>, body: AllEvents): C[typeof Context.session];
-export declare function decodeMessage(bot: LarkBot, body: LarkMessage): Promise<Universal.Message>;
+export declare function adaptMessage(bot: FeishuBot, data: Events['im.message.receive_v1']['event'], session: Session, details?: boolean): Promise<Session>;
+export declare function adaptSession<C extends Context>(bot: FeishuBot<C>, body: AllEvents): Promise<C[typeof Context.session]>;
+export declare function decodeMessage(bot: LarkBot, body: Lark.Message, details?: boolean): Promise<Universal.Message>;
 /**
  * Get ID type from id string
  * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction
  */
 export declare function extractIdType(id: string): Lark.ReceiveIdType;
-export declare function decodeChannel(guild: Lark.Guild): Universal.Channel;
-export declare function decodeGuild(guild: Lark.Guild): Universal.Guild;
+export declare function decodeChannel(channelId: string, guild: GetImChatResponse['data']): Universal.Channel;
+export declare function decodeGuild(guild: Lark.ListChat): Universal.Guild;
 export declare function decodeUser(user: Lark.User): Universal.User;
 export declare class Cipher {
     encryptKey: string;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@satorijs/adapter-lark",
   "description": "Lark (飞书) Adapter for Satorijs",
-  "version": "3.4.1",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
+  "version": "3.5.0",
+  "type": "module",
+  "main": "lib/index.cjs",
+  "types": "lib/index.d.ts",
   "files": [
     "lib",
     "src"
@@ -33,9 +34,9 @@
     "chat"
   ],
   "devDependencies": {
-    "@cordisjs/server": "^0.1.8"
+    "@cordisjs/plugin-server": "^0.2.2"
   },
   "peerDependencies": {
-    "@satorijs/satori": "^3.6.5"
+    "@satorijs/core": "^4.0.0"
   }
 }

package/src/bot.ts

@@ -1,4 +1,4 @@
-import { Bot, Context, h, Quester, Schema } from '@satorijs/satori'
+import { Bot, Context, h, HTTP, Schema, Universal } from '@satorijs/core'
 
 import { HttpServer } from './http'
 import { LarkMessageEncoder } from './message'
@@ -11,8 +11,8 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 
   _token?: string
   _refresher?: NodeJS.Timeout
-  http: Quester
-  assetsQuester: Quester
+  http: HTTP
+  assetsQuester: HTTP
   internal: Internal
 
   constructor(ctx: C, config: LarkBot.Config) {
@@ -23,7 +23,6 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
       this.logger.warn('selfUrl is not set, some features may not work')
     }
 
-    this.selfId = config.appId
     this.http = ctx.http.extend({
       endpoint: config.endpoint,
     })
@@ -33,13 +32,29 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
     ctx.plugin(HttpServer, this)
   }
 
+  get appId() {
+    return this.config.appId
+  }
+
   async initialize() {
     await this.refreshToken()
+    const { bot } = await this.http.get<{
+      bot: {
+        activate_status: number
+        app_name: string
+        avatar_url: string
+        ip_white_list: any[]
+        open_id: string
+      }
+    }>('/bot/v3/info')
+    this.selfId = bot.open_id
+    this.user.avatar = bot.avatar_url
+    this.user.name = bot.app_name
     this.online()
   }
 
   private async refreshToken() {
-    const { tenant_access_token: token } = await this.internal.getTenantAccessToken({
+    const { tenant_access_token: token } = await this.internal.tenantAccessTokenInternalAuth({
       app_id: this.config.appId,
       app_secret: this.config.appSecret,
     })
@@ -62,35 +77,38 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   }
 
   async editMessage(channelId: string, messageId: string, content: h.Fragment) {
-    await this.internal.updateMessage(messageId, {
+    await this.internal.updateImMessage(messageId, {
       content: h.normalize(content).join(''),
       msg_type: 'text',
     })
   }
 
   async deleteMessage(channelId: string, messageId: string) {
-    await this.internal.deleteMessage(messageId)
+    await this.internal.deleteImMessage(messageId)
   }
 
-  async getMessage(channelId: string, messageId: string) {
-    const data = await this.internal.getMessage(messageId)
-    return await Utils.decodeMessage(this, data.data)
+  async getMessage(channelId: string, messageId: string, recursive = true) {
+    const data = await this.internal.getImMessage(messageId)
+    const message = await Utils.decodeMessage(this, data.data.items[0], recursive)
+    const im = await this.internal.getImChat(channelId)
+    message.channel.type = im.data.chat_mode === 'p2p' ? Universal.Channel.Type.DIRECT : Universal.Channel.Type.TEXT
+    return message
   }
 
   async getMessageList(channelId: string, before?: string) {
-    const { data: messages } = await this.internal.getMessageList({ container_id_type: 'chat', container_id: channelId, page_token: before })
+    const { data: messages } = await this.internal.listImMessage({ 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)
-    return Utils.decodeUser(data.data)
+    return Utils.decodeUser(data.data.user)
   }
 
   async getChannel(channelId: string) {
-    const { data } = await this.internal.getGuildInfo(channelId)
-    return Utils.decodeChannel(data)
+    const { data } = await this.internal.getImChat(channelId)
+    return Utils.decodeChannel(channelId, data)
   }
 
   async getChannelList(guildId: string) {
@@ -98,24 +116,24 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   }
 
   async getGuild(guildId: string) {
-    const { data } = await this.internal.getGuildInfo(guildId)
+    const { data } = await this.internal.getImChat(guildId)
     return Utils.decodeGuild(data)
   }
 
   async getGuildList(after?: string) {
-    const { data: guilds } = await this.internal.getCurrentUserGuilds({ page_token: after })
+    const { data: guilds } = await this.internal.listImChat({ page_token: after })
     return { data: guilds.items.map(Utils.decodeGuild), next: guilds.page_token }
   }
 
   async getGuildMemberList(guildId: string, after?: string) {
-    const { data: users } = await this.internal.getGuildMembers(guildId, { page_token: after })
+    const { data: users } = await this.internal.getImChatMembers(guildId, { page_token: after })
     const data = users.items.map(v => ({ user: { id: v.member_id, name: v.name }, name: v.name }))
     return { data, next: users.page_token }
   }
 }
 
 export namespace LarkBot {
-  export interface Config extends HttpServer.Options, Quester.Config {
+  export interface Config extends HttpServer.Options, HTTP.Config {
     appId: string
     appSecret: string
     encryptKey?: string
@@ -135,14 +153,14 @@ export namespace LarkBot {
         Schema.object({
           platform: Schema.const('feishu').required(),
         }),
-        Quester.createConfig('https://open.feishu.cn/open-apis/'),
+        HTTP.createConfig('https://open.feishu.cn/open-apis/'),
         HttpServer.createConfig('/feishu'),
       ]),
       Schema.intersect([
         Schema.object({
           platform: Schema.const('lark').required(),
         }),
-        Quester.createConfig('https://open.larksuite.com/open-apis/'),
+        HTTP.createConfig('https://open.larksuite.com/open-apis/'),
         HttpServer.createConfig('/lark'),
       ]),
     ]),

package/src/http.ts

@@ -1,7 +1,7 @@
 import { Readable } from 'node:stream'
 import { ReadableStream } from 'node:stream/web'
-import { Adapter, Context, Logger, Schema } from '@satorijs/satori'
-import {} from '@cordisjs/server'
+import { Adapter, Context, Logger, Schema } from '@satorijs/core'
+import {} from '@cordisjs/plugin-server'
 
 import { FeishuBot } from './bot'
 import { AllEvents } from './types'
@@ -72,6 +72,7 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, FeishuBo
 
       // dispatch message
       bot.logger.debug('received decryped event: %o', body)
+      // @TODO: need await?
       this.dispatchSession(body)
 
       // Lark requires 200 OK response to make sure event is received
@@ -91,20 +92,19 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, FeishuBo
         params: { type },
         responseType: 'stream',
       })
-
+      ctx.set('content-type', resp.headers.get('content-type'))
       ctx.status = 200
-      ctx.response.headers['Content-Type'] = resp.headers.get('content-type')
       ctx.response.body = Readable.fromWeb(resp.data)
     })
   }
 
-  dispatchSession(body: AllEvents): void {
+  async dispatchSession(body: AllEvents) {
     const { header } = body
     if (!header) return
     const { app_id, event_type } = header
     body.type = event_type // add type to body to ease typescript type narrowing
-    const bot = this.bots.find((bot) => bot.selfId === app_id)
-    const session = adaptSession(bot, body)
+    const bot = this.bots.find((bot) => bot.appId === app_id)
+    const session = await adaptSession(bot, body)
     bot.dispatch(session)
   }
 

package/src/index.ts

@@ -1,11 +1,11 @@
-import { FeishuBot } from './bot'
+import { LarkBot } from './bot'
 import * as Lark from './types'
 
 export * from './bot'
 
 export { Lark, Lark as Feishu }
 
-export default FeishuBot
+export default LarkBot
 
 declare module '@satorijs/core' {
   interface Session {

package/src/message.ts

@@ -1,6 +1,6 @@
-import { Context, h, MessageEncoder, Quester } from '@satorijs/satori'
+import { Context, h, MessageEncoder } from '@satorijs/core'
 import { LarkBot } from './bot'
-import { BaseResponse, Message, MessageContent, MessageType } from './types'
+import { BaseResponse, Lark, MessageContent, MessageType } from './types'
 import { extractIdType } from './utils'
 
 export interface Addition {
@@ -17,22 +17,26 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
 
   async post(data?: any) {
     try {
-      let resp: BaseResponse & { data: Message }
+      let resp: BaseResponse & { data?: Lark.Message }
       if (this.quote) {
-        resp = await this.bot.internal?.replyMessage(this.quote, data)
+        resp = await this.bot.internal.replyImMessage(this.quote, data)
       } else {
         data.receive_id = this.channelId
-        resp = await this.bot.internal?.sendMessage(extractIdType(this.channelId), data)
+        resp = await this.bot.internal?.createImMessage(data, {
+          receive_id_type: extractIdType(this.channelId),
+        })
       }
       const session = this.bot.session()
       session.messageId = resp.data.message_id
       session.timestamp = Number(resp.data.create_time) * 1000
       session.userId = resp.data.sender.id
+      session.channelId = this.channelId
+      session.guildId = this.guildId
       session.app.emit(session, 'send', session)
       this.results.push(session.event.message)
     } catch (e) {
       // try to extract error message from Lark API
-      if (Quester.Error.is(e)) {
+      if (this.bot.http.isError(e)) {
         if (e.response?.data?.code) {
           const generalErrorMsg = `Check error code at https://open.larksuite.com/document/server-docs/getting-started/server-error-codes`
           e.message += ` (Lark error code ${e.response.data.code}: ${e.response.data.msg ?? generalErrorMsg})`
@@ -79,7 +83,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
 
     if (type === 'img' || type === 'image') {
       payload.append('image_type', 'message')
-      const { data } = await this.bot.internal.uploadImage(payload)
+      const { data } = await this.bot.internal.createImImage(payload)
       return {
         type: 'image',
         file: {
@@ -105,7 +109,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         }
       }
       payload.append('file_name', filename)
-      const { data } = await this.bot.internal.uploadFile(payload)
+      const { data } = await this.bot.internal.createImFile(payload)
       return {
         type: msgType,
         file: {
@@ -157,6 +161,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         if (attrs.src || attrs.url) {
           await this.flush()
           this.addition = await this.sendFile(type, attrs.src || attrs.url)
+          await this.flush()
         }
         break
       case 'figure': // FIXME: treat as message element for now