@satorijs/adapter-lark 3.11.9 → 3.12.0

package/src/types/mail.ts

@@ -458,7 +458,13 @@ export namespace Mail {
       name?: string
       /** The mail group's description */
       description?: string
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -477,7 +483,13 @@ export namespace Mail {
       include_external_member?: boolean
       /** Value is true if all company members are in this mail group */
       include_all_company_member?: boolean
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -488,7 +500,13 @@ export namespace Mail {
       name?: string
       /** The mail group's description */
       description?: string
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -507,7 +525,13 @@ export namespace Mail {
       include_external_member?: boolean
       /** Value is true if all company members are in this mail group */
       include_all_company_member?: boolean
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -518,7 +542,13 @@ export namespace Mail {
       name?: string
       /** The mail group's description */
       description?: string
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -537,7 +567,13 @@ export namespace Mail {
       include_external_member?: boolean
       /** Value is true if all company members are in this mail group */
       include_all_company_member?: boolean
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -556,7 +592,13 @@ export namespace Mail {
       include_external_member?: boolean
       /** Value is true if all company members are in this mail group */
       include_all_company_member?: boolean
-      /** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
+      /**
+       * Who can send mail to this mail group. Possible values are:
+       * - ANYONE: Any Internet user can send mail to this mail group
+       * - ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group
+       * - ALL_GROUP_MEMBERS: Any group member can send mail to this mail group
+       * - CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure
+       */
       who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
     }
 
@@ -653,7 +695,16 @@ export namespace Mail {
         user_id?: string
         /** The member's department id. Value is valid when type is DEPARTMENT */
         department_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         * - COMPANY: member is the company
+         * - EXTERNAL_USER: internet user outside the organization
+         * - MAIL_GROUP: member is another mail group
+         * - PUBLIC_MAILBOX: member is a public mailbox
+         * - OTHER_MEMBER: other internal member
+         */
         type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
       }
 
@@ -673,7 +724,16 @@ export namespace Mail {
         user_id?: string
         /** The member's department id. Value is valid when type is DEPARTMENT */
         department_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         * - COMPANY: member is the company
+         * - EXTERNAL_USER: internet user outside the organization
+         * - MAIL_GROUP: member is another mail group
+         * - PUBLIC_MAILBOX: member is a public mailbox
+         * - OTHER_MEMBER: other internal member
+         */
         type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
       }
 
@@ -693,7 +753,16 @@ export namespace Mail {
         user_id?: string
         /** The member's department id. Value is valid when type is DEPARTMENT */
         department_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         * - COMPANY: member is the company
+         * - EXTERNAL_USER: internet user outside the organization
+         * - MAIL_GROUP: member is another mail group
+         * - PUBLIC_MAILBOX: member is a public mailbox
+         * - OTHER_MEMBER: other internal member
+         */
         type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
       }
 
@@ -803,7 +872,11 @@ export namespace Mail {
         department_id?: string
         /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
         email?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         */
         type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
       }
 
@@ -823,7 +896,11 @@ export namespace Mail {
         department_id?: string
         /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
         email?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         */
         type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
       }
 
@@ -843,7 +920,11 @@ export namespace Mail {
         department_id?: string
         /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
         email?: string
-        /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         * - DEPARTMENT: member is a department
+         */
         type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
       }
 
@@ -1029,7 +1110,10 @@ export namespace Mail {
       export interface CreateRequest {
         /** The member's user id. Value is valid when type is USER */
         user_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         */
         type?: 'USER'
       }
 
@@ -1043,7 +1127,10 @@ export namespace Mail {
         member_id?: string
         /** The member's user id. Value is valid when type is USER */
         user_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         */
         type?: 'USER'
       }
 
@@ -1057,7 +1144,10 @@ export namespace Mail {
         member_id?: string
         /** The member's user id. Value is valid when type is USER */
         user_id?: string
-        /** The type of member. Possible values are:- USER: internal user in the team */
+        /**
+         * The type of member. Possible values are:
+         * - USER: internal user in the team
+         */
         type?: 'USER'
       }
 

package/src/types/search.ts

@@ -193,7 +193,10 @@ export namespace Search {
     }
 
     export interface ListQuery extends Pagination {
-      /** 回包数据格式，0-全量数据；1-摘要数据。**注**：摘要数据仅包含"id"，"name"，"state"。 */
+      /**
+       * 回包数据格式，0-全量数据；1-摘要数据。
+       * **注**：摘要数据仅包含"id"，"name"，"state"。
+       */
       view?: ListQueryView
     }
 

package/src/ws.ts

@@ -0,0 +1,183 @@
+import { Adapter, Context, Schema, Universal } from '@satorijs/core'
+import { LarkBot } from './bot'
+import { adaptSession, EventPayload } from './utils'
+import pb from 'protobufjs/light'
+
+enum FrameType {
+  control = 0,
+  data = 1,
+}
+
+enum MessageType {
+  event = 'event',
+  card = 'card',
+  ping = 'ping',
+  pong = 'pong',
+}
+
+interface FrameSegment {
+  message_id: string
+  sum: number
+  seq: number
+  data: Uint8Array
+}
+
+export class WsClient<C extends Context = Context> extends Adapter.WsClient<C, LarkBot<C, LarkBot.BaseConfig & WsClient.Options>> {
+  _deviceId: string
+  _serviceId: number
+  _pingInterval: number = 90000
+  _ping: NodeJS.Timeout
+  _cache: Record<string, FrameSegment[]> = {}
+  _frame: pb.Type
+
+  constructor(ctx: C, bot: LarkBot<C, LarkBot.BaseConfig & WsClient.Options>) {
+    super(ctx, bot)
+  }
+
+  async prepare() {
+    this._frame = pb.Root.fromJSON({
+      nested: {
+        Header: {
+          fields: {
+            key: { rule: 'required', type: 'string', id: 1 },
+            value: { rule: 'required', type: 'string', id: 2 },
+          },
+        },
+        Frame: {
+          fields: {
+            SeqID: { rule: 'required', type: 'uint64', id: 1 },
+            LogID: { rule: 'required', type: 'uint64', id: 2 },
+            service: { rule: 'required', type: 'int32', id: 3 },
+            method: { rule: 'required', type: 'int32', id: 4 },
+            headers: { rule: 'repeated', type: 'Header', id: 5 },
+            payloadEncoding: { type: 'string', id: 6 },
+            payloadType: { type: 'string', id: 7 },
+            payload: { type: 'bytes', id: 8 },
+            LogIDNew: { type: 'string', id: 9 },
+          },
+        },
+      },
+    }).lookupType('Frame')
+
+    const baseUrl = this.bot.config.baseURL ?? new URL(this.bot.config.endpoint).origin
+    const { code, data: { URL: url, ClientConfig: config }, msg } = await this.bot.http.post(`${baseUrl}/callback/ws/endpoint`, {
+      AppID: this.bot.config.appId,
+      AppSecret: this.bot.config.appSecret,
+    })
+    if (code !== 0) throw new Error(`failed to get gateway url: ${code} ${msg}`)
+
+    const urlObj = new URL(url)
+    this._deviceId = urlObj.searchParams.get('device_id')
+    this._serviceId = +urlObj.searchParams.get('service_id')
+    this._pingInterval = config.PingInterval * 1000
+
+    return this.bot.ctx.http.ws(url)
+  }
+
+  ping() {
+    if (!this.socket || this.bot.status !== Universal.Status.ONLINE) {
+      clearTimeout(this._ping)
+      return
+    }
+    const frame = {
+      headers: [{
+        key: 'type',
+        value: MessageType.ping,
+      }],
+      service: this._serviceId,
+      method: FrameType.control,
+      SeqID: 0,
+      LogID: 0,
+    }
+    this.send(frame)
+    this._ping = setTimeout(() => this.ping(), this._pingInterval)
+  }
+
+  async accept() {
+    await this.bot.initialize()
+
+    this.socket.addEventListener('message', async ({ data }) => {
+      const frame: {
+        headers: { key: string; value: string }[]
+        method: FrameType
+        payload?: Uint8Array
+      } = this._frame.decode(new Uint8Array(data as any)) as any
+      const headers: {
+        message_id: string
+        type: MessageType
+        sum: string
+        seq: string
+      } = (frame.headers ?? []).reduce((acc, cur) => {
+        acc[cur.key] = cur.value
+        return acc
+      }, {} as any)
+
+      if (frame.method === FrameType.control && headers.type === MessageType.pong) {
+        this.bot.logger.debug('pong')
+        return
+      }
+
+      if (frame.method === FrameType.data) {
+        if (headers.type !== MessageType.event) return
+
+        const data = this.retrieve({
+          message_id: headers.message_id,
+          sum: +headers.sum,
+          seq: +headers.seq,
+          data: frame.payload,
+        })
+        if (!data) return
+
+        const body: EventPayload = JSON.parse(Buffer.from(data).toString('utf8'))
+        if (!body.header) return
+        this.bot.logger.info('received event: %o', body)
+        body.type = body.header.event_type
+        const session = await adaptSession(this.bot, body)
+        this.bot.dispatch(session)
+
+        this.send({
+          ...frame,
+          headers: [...frame.headers, { key: 'biz_rt', value: '0' }],
+          payload: Buffer.from(JSON.stringify({ code: 200 })),
+        })
+      }
+    })
+
+    this.socket.addEventListener('close', (e) => {
+      clearTimeout(this._ping)
+      this.bot.offline()
+    })
+    this.ping()
+  }
+
+  send(frame: any) {
+    const encoded = this._frame.encode(frame).finish()
+    this.socket.send(encoded as any)
+  }
+
+  retrieve(seg: FrameSegment): Uint8Array | undefined {
+    const { message_id, sum } = seg
+    if (sum === 1) return seg.data
+    if (!this._cache[message_id]) this._cache[message_id] = []
+
+    this._cache[message_id].push(seg)
+    if (this._cache[message_id].length === sum) {
+      const data = Buffer.concat(this._cache[message_id].sort((a, b) => a.seq - b.seq).map((item) => item.data))
+      delete this._cache[message_id]
+      return data
+    }
+  }
+}
+
+export namespace WsClient {
+  export interface Options extends Adapter.WsClientConfig {
+    protocol: 'ws'
+  }
+
+  export const Options: Schema<Options> = Schema.intersect([
+    Schema.object({
+      protocol: Schema.const('ws').required(),
+    }),
+    Adapter.WsClientConfig,
+  ])
+}