@satorijs/adapter-lark 3.11.8 → 3.12.0

package/src/types/security_and_compliance.ts

@@ -1,5 +1,5 @@
 import * as Lark from '.'
-import { Internal, Paginated } from '../internal'
+import { Internal, Paginated, Pagination } from '../internal'
 
 declare module '../internal' {
   interface Internal {
@@ -9,9 +9,285 @@ declare module '../internal' {
 
 export namespace SecurityAndCompliance {
   export interface Methods {
+    deviceRecord: DeviceRecord.Methods
+    deviceApplyRecord: DeviceApplyRecord.Methods
     openapiLog: OpenapiLog.Methods
   }
 
+  export namespace DeviceRecord {
+    export interface Methods {
+      /**
+       * 获取客户端设备认证信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/mine
+       */
+      mine(): Promise<MineResponse>
+      /**
+       * 新增设备
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/create
+       */
+      create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
+      /**
+       * 查询设备信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/list
+       */
+      list(query?: ListQuery): Paginated<Lark.DeviceRecord>
+      /**
+       * 获取设备信息
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/get
+       */
+      get(device_record_id: string, query?: GetQuery): Promise<GetResponse>
+      /**
+       * 更新设备
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/update
+       */
+      update(device_record_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<void>
+      /**
+       * 删除设备
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_record/delete
+       */
+      delete(device_record_id: string): Promise<void>
+    }
+
+    export const enum MineResponseDeviceOwnership {
+      /** 未知设备 */
+      Unknown = 0,
+      /** 个人设备 */
+      Personal = 1,
+      /** 企业设备 */
+      Company = 2,
+    }
+
+    export const enum MineResponseDeviceStatus {
+      /** 未知状态 */
+      Unknown = 0,
+      /** 信任设备 */
+      Trusted = 1,
+      /** 非信任设备 */
+      Untrusted = 2,
+    }
+
+    export interface MineResponse {
+      /** 设备认证编码 */
+      device_record_id?: string
+      /** 设备归属 */
+      device_ownership?: MineResponseDeviceOwnership
+      /** 可信状态 */
+      device_status?: MineResponseDeviceStatus
+    }
+
+    export const enum CreateRequestDeviceSystem {
+      /** Windows */
+      Windows = 1,
+      /** macOS */
+      MacOS = 2,
+      /** Linux */
+      Linux = 3,
+      /** Android */
+      Android = 4,
+      /** iOS */
+      IOS = 5,
+      /** OpenHarmony */
+      OpenHarmony = 6,
+    }
+
+    export const enum CreateRequestDeviceOwnership {
+      /** 未知设备 */
+      Unknown = 0,
+      /** 个人设备 */
+      Personal = 1,
+      /** 企业设备 */
+      Company = 2,
+    }
+
+    export const enum CreateRequestDeviceStatus {
+      /** 未知状态 */
+      Unknown = 0,
+      /** 信任设备 */
+      Trusted = 1,
+      /** 非信任设备 */
+      Untrusted = 2,
+    }
+
+    export interface CreateRequest {
+      /** 操作系统 */
+      device_system: CreateRequestDeviceSystem
+      /** 生产序列号 */
+      serial_number?: string
+      /** 硬盘序列号 */
+      disk_serial_number?: string
+      /** 主板UUID */
+      uuid?: string
+      /** MAC地址 */
+      mac_address?: string
+      /** Android标识符 */
+      android_id?: string
+      /** iOS供应商标识符 */
+      idfv?: string
+      /** Harmony供应商标识符 */
+      aaid?: string
+      /** 设备归属 */
+      device_ownership: CreateRequestDeviceOwnership
+      /** 可信状态 */
+      device_status: CreateRequestDeviceStatus
+      /** 最近登录用户ID */
+      latest_user_id?: string
+      /** 设备指纹列表 */
+      dids?: string[]
+    }
+
+    export interface CreateQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface CreateResponse {
+      /** 设备认证编码 */
+      device_record_id?: string
+    }
+
+    export const enum ListQueryDeviceOwnership {
+      /** 未知设备 */
+      Unknown = 0,
+      /** 个人设备 */
+      Personal = 1,
+      /** 企业设备 */
+      Company = 2,
+    }
+
+    export const enum ListQueryDeviceStatus {
+      /** 未知状态 */
+      Unknown = 0,
+      /** 信任设备 */
+      Trusted = 1,
+      /** 非信任设备 */
+      Untrusted = 2,
+    }
+
+    export const enum ListQueryDeviceTerminalType {
+      /** 未知 */
+      Unknown = 0,
+      /** 移动端 */
+      Mobile = 1,
+      /** 桌面端 */
+      PC = 2,
+    }
+
+    export const enum ListQueryOs {
+      /** 未知 */
+      Unknown = 0,
+      /** Windows */
+      Windows = 1,
+      /** macOS */
+      MacOS = 2,
+      /** Linux */
+      Linux = 3,
+      /** Android */
+      Android = 4,
+      /** iOS */
+      IOS = 5,
+      /** 鸿蒙 */
+      OpenHarmony = 6,
+    }
+
+    export interface ListQuery extends Pagination {
+      /** 设备认证编码 */
+      device_record_id?: string
+      /** 当前登录用户ID */
+      current_user_id?: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'open_id' | 'union_id' | 'user_id'
+      /** 设备名称 */
+      device_name?: string
+      /** 生产序列号 */
+      serial_number?: string
+      /** 硬盘序列号 */
+      disk_serial_number?: string
+      /** MAC地址 */
+      mac_address?: string
+      /** Android标识符 */
+      android_id?: string
+      /** 主板UUID */
+      uuid?: string
+      /** iOS供应商标识符 */
+      idfv?: string
+      /** Harmony供应商标识符 */
+      aaid?: string
+      /** 设备归属 */
+      device_ownership?: ListQueryDeviceOwnership
+      /** 可信状态 */
+      device_status?: ListQueryDeviceStatus
+      /** 设备类型 */
+      device_terminal_type?: ListQueryDeviceTerminalType
+      /** 设备操作系统 */
+      os?: ListQueryOs
+      /** 最近登录用户ID */
+      latest_user_id?: string
+      /** 设备指纹 */
+      did?: string
+    }
+
+    export interface GetQuery {
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+
+    export interface GetResponse {
+      /** 设备记录 */
+      device_record?: Lark.DeviceRecord
+    }
+
+    export const enum UpdateRequestDeviceOwnership {
+      /** 未知设备 */
+      Unknown = 0,
+      /** 个人设备 */
+      Personal = 1,
+      /** 企业设备 */
+      Company = 2,
+    }
+
+    export const enum UpdateRequestDeviceStatus {
+      /** 未知状态 */
+      Unknown = 0,
+      /** 信任设备 */
+      Trusted = 1,
+      /** 非信任设备 */
+      Untrusted = 2,
+    }
+
+    export interface UpdateRequest {
+      /** 设备归属 */
+      device_ownership: UpdateRequestDeviceOwnership
+      /** 可信状态 */
+      device_status: UpdateRequestDeviceStatus
+      /** 最近登录用户ID */
+      latest_user_id?: string
+      /** 设备指纹列表 */
+      dids?: string[]
+    }
+
+    export interface UpdateQuery {
+      /** 版本号 */
+      version: string
+      /** 此次调用中使用的用户ID的类型 */
+      user_id_type?: 'user_id' | 'union_id' | 'open_id'
+    }
+  }
+
+  export namespace DeviceApplyRecord {
+    export interface Methods {
+      /**
+       * 审批设备申报
+       * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/security_and_compliance-v2/device_apply_record/update
+       */
+      update(device_apply_record_id: string, body: UpdateRequest): Promise<void>
+    }
+
+    export interface UpdateRequest {
+      /** 是否审批通过 */
+      is_approved: boolean
+    }
+  }
+
   export namespace OpenapiLog {
     export interface Methods {
       /**
@@ -39,6 +315,21 @@ export namespace SecurityAndCompliance {
 }
 
 Internal.define({
+  '/security_and_compliance/v2/device_records/mine': {
+    GET: 'securityAndCompliance.deviceRecord.mine',
+  },
+  '/security_and_compliance/v2/device_records': {
+    POST: 'securityAndCompliance.deviceRecord.create',
+    GET: { name: 'securityAndCompliance.deviceRecord.list', pagination: { argIndex: 0 } },
+  },
+  '/security_and_compliance/v2/device_records/{device_record_id}': {
+    GET: 'securityAndCompliance.deviceRecord.get',
+    PUT: 'securityAndCompliance.deviceRecord.update',
+    DELETE: 'securityAndCompliance.deviceRecord.delete',
+  },
+  '/security_and_compliance/v2/device_apply_records/{device_apply_record_id}': {
+    PUT: 'securityAndCompliance.deviceApplyRecord.update',
+  },
   '/security_and_compliance/v1/openapi_logs/list_data': {
     POST: 'securityAndCompliance.openapiLog.listData',
   },

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,
+  ])
+}