@satorijs/adapter-lark 3.8.6 → 3.9.1

package/src/internal.ts

@@ -0,0 +1,143 @@
+import { Dict, HTTP, makeArray } from '@satorijs/core'
+import { LarkBot } from './bot'
+
+export interface Internal {}
+
+export interface BaseResponse {
+  /** error code. would be 0 if success, and non-0 if failed. */
+  code: number
+  /** error message. would be 'success' if success. */
+  msg: string
+}
+
+export type Paginated<T = any, ItemsKey extends string = 'items'> =
+  & Promise<
+    & { [K in ItemsKey]: T[] }
+    & { page_token?: string; has_more: boolean }
+  >
+  & AsyncIterableIterator<T>
+
+export interface Pagination {
+  page_size?: number
+  page_token?: string
+}
+
+export interface InternalRoute {
+  name: string
+  pagination?: {
+    argIndex: number
+    itemsKey?: string
+    tokenKey?: string
+  }
+  multipart?: boolean
+  type?: 'raw-json' | 'binary'
+}
+
+export class Internal {
+  constructor(private bot: LarkBot) {}
+
+  private _assertResponse(response: HTTP.Response<BaseResponse>) {
+    if (!response.data.code) return
+    this.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) {
+    if (options.multipart) {
+      const form = new FormData()
+      for (const [key, value] of Object.entries(arg)) {
+        if (value instanceof File) {
+          form.append(key, value, value.name)
+        } else {
+          form.append(key, value)
+        }
+      }
+      return form
+    } else {
+      return arg
+    }
+  }
+
+  static define(routes: Dict<Partial<Record<HTTP.Method, string | InternalRoute>>>) {
+    for (const path in routes) {
+      for (const key in routes[path]) {
+        const method = key as HTTP.Method
+        for (let route of makeArray(routes[path][method])) {
+          if (typeof route === 'string') {
+            route = { name: route }
+          }
+
+          const impl = async function (this: Internal, ...args: any[]) {
+            const raw = args.join(', ')
+            const url = path.replace(/\{([^}]+)\}/g, () => {
+              if (!args.length) throw new Error(`too few arguments for ${path}, received ${raw}`)
+              return args.shift()
+            })
+            const config: HTTP.RequestConfig = {}
+            if (args.length === 1) {
+              if (method === 'GET' || method === 'DELETE') {
+                config.params = args[0]
+              } else {
+                config.data = this._buildData(args[0], route)
+              }
+            } else if (args.length === 2 && method !== 'GET' && method !== 'DELETE') {
+              config.data = this._buildData(args[0], route)
+              config.params = args[1]
+            } else if (args.length > 1) {
+              throw new Error(`too many arguments for ${path}, received ${raw}`)
+            }
+            if (route.type === 'binary') {
+              config.responseType = 'arraybuffer'
+            }
+            const response = await this.bot.http(method, url, config)
+            this._assertResponse(response)
+            if (route.type === 'raw-json' || route.type === 'binary') {
+              return response.data
+            } else {
+              return response.data.data
+            }
+          }
+
+          Internal.prototype[route.name] = function (this: Internal, ...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)
+              }
+            }
+
+            if (route.pagination) {
+              const { argIndex, itemsKey = 'items', tokenKey = 'page_token' } = route.pagination
+              const iterArgs = [...args]
+              iterArgs[argIndex] = { ...args[argIndex] }
+              let pagination: { data: any[]; next?: any } | undefined
+              result.next = async function () {
+                pagination ??= await this[Symbol.for('satori.pagination')]()
+                if (pagination.data.length) return { done: false, value: pagination.data.shift() }
+                if (!pagination.next) return { done: true, value: undefined }
+                pagination = await this[Symbol.for('satori.pagination')]()
+                return this.next()
+              }
+              result[Symbol.asyncIterator] = function () {
+                return this
+              }
+              result[Symbol.for('satori.pagination')] = async () => {
+                const data = await impl.apply(this, iterArgs)
+                iterArgs[argIndex].page_token = data[tokenKey]
+                return {
+                  data: data[itemsKey],
+                  next: data.has_more ? iterArgs : undefined,
+                }
+              }
+            }
+
+            return result
+          }
+        }
+      }
+    }
+  }
+}

package/src/message.ts

@@ -1,9 +1,12 @@
 import { Context, Dict, h, MessageEncoder } from '@satorijs/core'
 import { LarkBot } from './bot'
-import { CreateImFileForm, Lark, MessageContent } from './types'
-import { extractIdType } from './utils'
+import { CreateImFileForm, Message } from './types'
+import { EventPayload, extractIdType } from './utils'
+import { MessageContent } from './content'
 
 export class LarkMessageEncoder<C extends Context = Context> extends MessageEncoder<C, LarkBot<C>> {
+  declare referrer?: EventPayload
+
   private quote: Dict | undefined
   private textContent = ''
   private richContent: MessageContent.RichText.Paragraph[] = []
@@ -15,21 +18,20 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
 
   async post(data?: any) {
     try {
-      let resp: Lark.Message
+      let resp: Message
       let quote = this.quote
-      if (!quote) {
-        const payload = this.options?.session?.lark
-        if (payload?.type === 'im.message.receive_v1' && payload.event.message.thread_id) {
+      if (!quote && this.referrer) {
+        if (this.referrer.type === 'im.message.receive_v1' && this.referrer.event.message.thread_id) {
           quote = {
-            id: payload.event.message.message_id,
+            id: this.referrer.event.message.message_id,
             replyInThread: true,
           }
-        } else if (payload?.type === 'card.action.trigger') {
+        } 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(payload.event.context.open_message_id)
+          const { items: [message] } = await this.bot.internal.getImMessage(this.referrer.event.context.open_message_id)
           if (message?.thread_id) {
             quote = {
-              id: payload.event.context.open_message_id,
+              id: this.referrer.event.context.open_message_id,
               replyInThread: true,
             }
           }
@@ -156,7 +158,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
     } else {
       const ext = filename.split('.').pop()
       if (['doc', 'xls', 'ppt', 'pdf'].includes(ext)) {
-        file_type = ext
+        file_type = ext as any
       } else {
         file_type = 'stream'
       }

package/src/types/acs.ts

@@ -0,0 +1,236 @@
+import { AccessRecord, Device, Feature, Rule, User, UserExternal } from '.'
+import { Internal, Pagination } from '../internal'
+
+declare module '../internal' {
+  interface Internal {
+    /**
+     * 修改用户部分信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch
+     */
+    patchAcsUser(user_id: string, body: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise<void>
+    /**
+     * 获取单个用户信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
+     */
+    getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise<GetAcsUserResponse>
+    /**
+     * 获取用户列表
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
+     */
+    listAcsUser(query?: ListAcsUserQuery): Paginated<User>
+    /**
+     * 上传人脸图片
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
+     */
+    updateAcsUserFace(user_id: string, form: UpdateAcsUserFaceForm, query?: UpdateAcsUserFaceQuery): Promise<void>
+    /**
+     * 下载人脸图片
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
+     */
+    getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise<ArrayBuffer>
+    /**
+     * 设备绑定权限组
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
+     */
+    deviceBindAcsRuleExternal(body: DeviceBindAcsRuleExternalRequest): Promise<void>
+    /**
+     * 获取权限组信息
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
+     */
+    getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise<GetAcsRuleExternalResponse>
+    /**
+     * 删除权限组
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
+     */
+    deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise<void>
+    /**
+     * 创建或更新权限组
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
+     */
+    createAcsRuleExternal(body: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise<CreateAcsRuleExternalResponse>
+    /**
+     * 删除访客
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
+     */
+    deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise<void>
+    /**
+     * 添加访客
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
+     */
+    createAcsVisitor(body: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise<CreateAcsVisitorResponse>
+    /**
+     * 获取门禁设备列表
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
+     */
+    listAcsDevice(): Promise<ListAcsDeviceResponse>
+    /**
+     * 获取门禁记录列表
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
+     */
+    listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Paginated<AccessRecord>
+    /**
+     * 下载开门时的人脸识别图片
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
+     */
+    getAcsAccessRecordAccessPhoto(access_record_id: string): Promise<ArrayBuffer>
+  }
+}
+
+export interface PatchAcsUserRequest {
+  /** 用户特征 */
+  feature?: Feature
+}
+
+export interface PatchAcsUserQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetAcsUserQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface ListAcsUserQuery extends Pagination {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface UpdateAcsUserFaceForm {
+  /** 人脸图片内容 */
+  files: Blob
+  /** 文件类型,可选的类型有jpg,png */
+  file_type: string
+  /** 带后缀的文件名 */
+  file_name: string
+}
+
+export interface UpdateAcsUserFaceQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetAcsUserFaceQuery {
+  /** 裁剪图 */
+  is_cropped?: boolean
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface DeviceBindAcsRuleExternalRequest {
+  /** 设备id */
+  device_id: string
+  /** 权限组id列表 */
+  rule_ids: string[]
+}
+
+export interface GetAcsRuleExternalQuery {
+  /** 设备id */
+  device_id?: string
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface DeleteAcsRuleExternalQuery {
+  /** 权限组id */
+  rule_id: string
+}
+
+export interface CreateAcsRuleExternalRequest {
+  /** 权限组信息 */
+  rule: Rule
+}
+
+export interface CreateAcsRuleExternalQuery {
+  /** 权限组id-为空创建,不为空则更新 */
+  rule_id?: string
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface DeleteAcsVisitorQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface CreateAcsVisitorRequest {
+  /** 访客信息 */
+  user: UserExternal
+}
+
+export interface CreateAcsVisitorQuery {
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface ListAcsAccessRecordQuery extends Pagination {
+  /** 记录开始时间，单位秒 */
+  from: number
+  /** 记录结束时间，单位秒，时间跨度不能超过30天 */
+  to: number
+  /** 门禁设备 ID */
+  device_id?: string
+  /** 此次调用中使用的用户ID的类型 */
+  user_id_type?: 'user_id' | 'union_id' | 'open_id'
+}
+
+export interface GetAcsUserResponse {
+  /** 门禁用户信息 */
+  user?: User
+}
+
+export interface GetAcsRuleExternalResponse {
+  /** 设备权限组信息 */
+  rules: Rule[]
+}
+
+export interface CreateAcsRuleExternalResponse {
+  /** 权限组id */
+  rule_id: string
+}
+
+export interface CreateAcsVisitorResponse {
+  /** 访客的id */
+  visitor_id: string
+}
+
+export interface ListAcsDeviceResponse {
+  items?: Device[]
+}
+
+Internal.define({
+  '/acs/v1/users/{user_id}': {
+    PATCH: 'patchAcsUser',
+    GET: 'getAcsUser',
+  },
+  '/acs/v1/users': {
+    GET: { name: 'listAcsUser', pagination: { argIndex: 0 } },
+  },
+  '/acs/v1/users/{user_id}/face': {
+    PUT: { name: 'updateAcsUserFace', multipart: true },
+    GET: { name: 'getAcsUserFace', type: 'binary' },
+  },
+  '/acs/v1/rule_external/device_bind': {
+    POST: 'deviceBindAcsRuleExternal',
+  },
+  '/acs/v1/rule_external': {
+    GET: 'getAcsRuleExternal',
+    DELETE: 'deleteAcsRuleExternal',
+    POST: 'createAcsRuleExternal',
+  },
+  '/acs/v1/visitors/{visitor_id}': {
+    DELETE: 'deleteAcsVisitor',
+  },
+  '/acs/v1/visitors': {
+    POST: 'createAcsVisitor',
+  },
+  '/acs/v1/devices': {
+    GET: 'listAcsDevice',
+  },
+  '/acs/v1/access_records': {
+    GET: { name: 'listAcsAccessRecord', pagination: { argIndex: 0 } },
+  },
+  '/acs/v1/access_records/{access_record_id}/access_photo': {
+    GET: { name: 'getAcsAccessRecordAccessPhoto', type: 'binary' },
+  },
+})