@satorijs/adapter-lark 3.11.8 → 3.12.0

package/lib/types/security_and_compliance.d.ts

@@ -1,5 +1,5 @@
 import * as Lark from '.';
-import { Paginated } from '../internal';
+import { Paginated, Pagination } from '../internal';
 declare module '../internal' {
     interface Internal {
         securityAndCompliance: SecurityAndCompliance.Methods;
@@ -7,8 +7,261 @@ declare module '../internal' {
 }
 export declare namespace SecurityAndCompliance {
     interface Methods {
+        deviceRecord: DeviceRecord.Methods;
+        deviceApplyRecord: DeviceApplyRecord.Methods;
         openapiLog: OpenapiLog.Methods;
     }
+    namespace DeviceRecord {
+        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>;
+        }
+        const enum MineResponseDeviceOwnership {
+            /** 未知设备 */
+            Unknown = 0,
+            /** 个人设备 */
+            Personal = 1,
+            /** 企业设备 */
+            Company = 2
+        }
+        const enum MineResponseDeviceStatus {
+            /** 未知状态 */
+            Unknown = 0,
+            /** 信任设备 */
+            Trusted = 1,
+            /** 非信任设备 */
+            Untrusted = 2
+        }
+        interface MineResponse {
+            /** 设备认证编码 */
+            device_record_id?: string;
+            /** 设备归属 */
+            device_ownership?: MineResponseDeviceOwnership;
+            /** 可信状态 */
+            device_status?: MineResponseDeviceStatus;
+        }
+        const enum CreateRequestDeviceSystem {
+            /** Windows */
+            Windows = 1,
+            /** macOS */
+            MacOS = 2,
+            /** Linux */
+            Linux = 3,
+            /** Android */
+            Android = 4,
+            /** iOS */
+            IOS = 5,
+            /** OpenHarmony */
+            OpenHarmony = 6
+        }
+        const enum CreateRequestDeviceOwnership {
+            /** 未知设备 */
+            Unknown = 0,
+            /** 个人设备 */
+            Personal = 1,
+            /** 企业设备 */
+            Company = 2
+        }
+        const enum CreateRequestDeviceStatus {
+            /** 未知状态 */
+            Unknown = 0,
+            /** 信任设备 */
+            Trusted = 1,
+            /** 非信任设备 */
+            Untrusted = 2
+        }
+        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[];
+        }
+        interface CreateQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface CreateResponse {
+            /** 设备认证编码 */
+            device_record_id?: string;
+        }
+        const enum ListQueryDeviceOwnership {
+            /** 未知设备 */
+            Unknown = 0,
+            /** 个人设备 */
+            Personal = 1,
+            /** 企业设备 */
+            Company = 2
+        }
+        const enum ListQueryDeviceStatus {
+            /** 未知状态 */
+            Unknown = 0,
+            /** 信任设备 */
+            Trusted = 1,
+            /** 非信任设备 */
+            Untrusted = 2
+        }
+        const enum ListQueryDeviceTerminalType {
+            /** 未知 */
+            Unknown = 0,
+            /** 移动端 */
+            Mobile = 1,
+            /** 桌面端 */
+            PC = 2
+        }
+        const enum ListQueryOs {
+            /** 未知 */
+            Unknown = 0,
+            /** Windows */
+            Windows = 1,
+            /** macOS */
+            MacOS = 2,
+            /** Linux */
+            Linux = 3,
+            /** Android */
+            Android = 4,
+            /** iOS */
+            IOS = 5,
+            /** 鸿蒙 */
+            OpenHarmony = 6
+        }
+        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;
+        }
+        interface GetQuery {
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+        interface GetResponse {
+            /** 设备记录 */
+            device_record?: Lark.DeviceRecord;
+        }
+        const enum UpdateRequestDeviceOwnership {
+            /** 未知设备 */
+            Unknown = 0,
+            /** 个人设备 */
+            Personal = 1,
+            /** 企业设备 */
+            Company = 2
+        }
+        const enum UpdateRequestDeviceStatus {
+            /** 未知状态 */
+            Unknown = 0,
+            /** 信任设备 */
+            Trusted = 1,
+            /** 非信任设备 */
+            Untrusted = 2
+        }
+        interface UpdateRequest {
+            /** 设备归属 */
+            device_ownership: UpdateRequestDeviceOwnership;
+            /** 可信状态 */
+            device_status: UpdateRequestDeviceStatus;
+            /** 最近登录用户ID */
+            latest_user_id?: string;
+            /** 设备指纹列表 */
+            dids?: string[];
+        }
+        interface UpdateQuery {
+            /** 版本号 */
+            version: string;
+            /** 此次调用中使用的用户ID的类型 */
+            user_id_type?: 'user_id' | 'union_id' | 'open_id';
+        }
+    }
+    namespace DeviceApplyRecord {
+        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>;
+        }
+        interface UpdateRequest {
+            /** 是否审批通过 */
+            is_approved: boolean;
+        }
+    }
     namespace OpenapiLog {
         interface Methods {
             /**

package/lib/ws.d.ts

@@ -0,0 +1,30 @@
+import { Adapter, Context, Schema } from '@satorijs/core';
+import { LarkBot } from './bot';
+import pb from 'protobufjs/light';
+interface FrameSegment {
+    message_id: string;
+    sum: number;
+    seq: number;
+    data: Uint8Array;
+}
+export declare class WsClient<C extends Context = Context> extends Adapter.WsClient<C, LarkBot<C, LarkBot.BaseConfig & WsClient.Options>> {
+    _deviceId: string;
+    _serviceId: number;
+    _pingInterval: number;
+    _ping: NodeJS.Timeout;
+    _cache: Record<string, FrameSegment[]>;
+    _frame: pb.Type;
+    constructor(ctx: C, bot: LarkBot<C, LarkBot.BaseConfig & WsClient.Options>);
+    prepare(): Promise<WebSocket>;
+    ping(): void;
+    accept(): Promise<void>;
+    send(frame: any): void;
+    retrieve(seg: FrameSegment): Uint8Array | undefined;
+}
+export declare namespace WsClient {
+    interface Options extends Adapter.WsClientConfig {
+        protocol: 'ws';
+    }
+    const Options: Schema<Options>;
+}
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@satorijs/adapter-lark",
   "description": "Lark (飞书) Adapter for Satorijs",
-  "version": "3.11.8",
+  "version": "3.12.0",
   "type": "module",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -34,13 +34,16 @@
     "chat"
   ],
   "devDependencies": {
-    "@cordisjs/plugin-server": "^0.2.7",
+    "@cordisjs/plugin-server": "^0.2.9",
     "@satorijs/core": "^4.5.2",
     "cordis": "^3.18.1",
-    "cosmokit": "^1.7.2",
+    "cosmokit": "^1.8.1",
     "dedent": "^1.5.3"
   },
   "peerDependencies": {
     "@satorijs/core": "^4.5.2"
+  },
+  "dependencies": {
+    "protobufjs": "^8.0.0"
   }
 }

package/src/bot.ts

@@ -1,6 +1,7 @@
 import { Bot, Context, h, HTTP, Schema, Time, Universal } from '@satorijs/core'
 import { Im } from './types'
 import { HttpServer } from './http'
+import { WsClient } from './ws'
 import { LarkMessageEncoder } from './message'
 import { Internal } from './internal'
 import * as Utils from './utils'
@@ -14,7 +15,7 @@ const fileTypeMap: Record<Exclude<Im.File.CreateForm['file_type'], 'stream'>, st
   ppt: ['application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation'],
 }
 
-export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config> {
+export class LarkBot<C extends Context = Context, T extends LarkBot.Config = LarkBot.Config> extends Bot<C, T> {
   static inject = ['server', 'http']
   static MessageEncoder = LarkMessageEncoder
 
@@ -23,7 +24,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   assetsQuester: HTTP
   internal: Internal<C>
 
-  constructor(ctx: C, config: LarkBot.Config) {
+  constructor(ctx: C, config: T) {
     super(ctx, config, 'lark')
 
     this.http = ctx.http.extend({
@@ -32,7 +33,11 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
     this.assetsQuester = ctx.http
     this.internal = new Internal(this)
 
-    ctx.plugin(HttpServer, this)
+    if (config.protocol === 'http') {
+      ctx.plugin(HttpServer, this)
+    } else if (config.protocol === 'ws') {
+      ctx.plugin(WsClient, this as any)
+    }
 
     this.defineInternalRoute('/*path', async ({ params, method, headers, body, query }) => {
       const response = await this.http('/' + params.path, {
@@ -78,6 +83,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
     // 剩余有效期小于 30 分钟时，调用本接口会返回一个新的 tenant_access_token，此时会同时存在两个有效的 tenant_access_token。
     // 剩余有效期大于等于 30 分钟时，调用本接口会返回原有的 tenant_access_token。
     // 初次获得 token 后的半小时内必须刷新一次，因为初次获得的 token 可能是 1.5 小时前生成的。
+    if (!this.isActive) return
     let timeout = Time.minute * 20
     try {
       const { tenant_access_token: token } = await this.internal.auth.tenantAccessTokenInternal({
@@ -170,35 +176,42 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 }
 
 export namespace LarkBot {
-  export interface Config extends HttpServer.Options, HTTP.Config {
+  export interface BaseConfig extends HTTP.Config {
     appId: string
     appSecret: string
-    encryptKey?: string
-    verificationToken?: string
   }
 
+  export type Config = BaseConfig & (HttpServer.Options | WsClient.Options)
+
   export const Config: Schema<Config> = Schema.intersect([
     Schema.object({
-      platform: Schema.union(['feishu', 'lark']).required().description('平台名称。'),
+      platform: Schema.union(['feishu', 'lark']).default('feishu').description('平台名称。'),
       appId: Schema.string().required().description('机器人的应用 ID。'),
       appSecret: Schema.string().role('secret').required().description('机器人的应用密钥。'),
-      encryptKey: Schema.string().role('secret').description('机器人的 Encrypt Key。'),
-      verificationToken: Schema.string().description('事件推送的验证令牌。'),
+      protocol: process.env.KOISHI_ENV === 'browser'
+        ? Schema.const('ws').default('ws')
+        : Schema.union(['http', 'ws']).description('选择要使用的协议。').default('http'),
     }),
     Schema.union([
       Schema.intersect([
         Schema.object({
-          platform: Schema.const('feishu').required(),
+          platform: Schema.const('lark').required(),
         }),
-        HTTP.createConfig('https://open.feishu.cn/open-apis'),
-        HttpServer.createConfig('/feishu'),
+        HTTP.createConfig('https://open.larksuite.com/open-apis'),
+        Schema.union([
+          HttpServer.createConfig('/lark'),
+          WsClient.Options,
+        ]),
       ]),
       Schema.intersect([
         Schema.object({
-          platform: Schema.const('lark').required(),
+          platform: Schema.const('feishu') as any,
         }),
-        HTTP.createConfig('https://open.larksuite.com/open-apis'),
-        HttpServer.createConfig('/lark'),
+        HTTP.createConfig('https://open.feishu.cn/open-apis'),
+        Schema.union([
+          HttpServer.createConfig('/feishu'),
+          WsClient.Options,
+        ]),
       ]),
     ]),
   ])

package/src/http.ts

@@ -3,7 +3,7 @@ import {} from '@cordisjs/plugin-server'
 import { LarkBot } from './bot'
 import { adaptSession, Cipher, EventPayload } from './utils'
 
-export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<C>> {
+export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<C, LarkBot.BaseConfig & HttpServer.Options>> {
   static inject = ['server']
 
   private logger: Logger
@@ -14,14 +14,14 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<
     this.logger = ctx.logger('lark')
   }
 
-  fork(ctx: C, bot: LarkBot<C>) {
+  fork(ctx: C, bot: LarkBot<C, LarkBot.BaseConfig & HttpServer.Options>) {
     super.fork(ctx, bot)
 
     this._refreshCipher()
     return bot.initialize()
   }
 
-  async connect(bot: LarkBot) {
+  async connect(bot: LarkBot<C, LarkBot.BaseConfig & HttpServer.Options>) {
     const { path } = bot.config
     bot.ctx.server.post(path, (ctx) => {
       this._refreshCipher()
@@ -70,7 +70,7 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<
       }
 
       // dispatch message
-      bot.logger.debug('received decryped event: %o', body)
+      bot.logger.debug('received decrypted event: %o', body)
       this.dispatchSession(body)
 
       // Lark requires 200 OK response to make sure event is received
@@ -124,15 +124,21 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<
 
 export namespace HttpServer {
   export interface Options {
+    protocol: 'http'
     selfUrl?: string
     path?: string
+    encryptKey?: string
+    verificationToken?: string
     verifyToken?: boolean
     verifySignature?: boolean
   }
 
   export const createConfig = (path: string): Schema<Options> => Schema.object({
+    protocol: Schema.const('http'),
     path: Schema.string().role('url').description('要连接的服务器地址。').default(path),
     selfUrl: Schema.string().role('link').description('服务器暴露在公网的地址。缺省时将使用全局配置。'),
+    encryptKey: Schema.string().role('secret').description('机器人的 Encrypt Key。'),
+    verificationToken: Schema.string().description('事件推送的验证令牌。'),
     verifyToken: Schema.boolean().description('是否验证令牌。'),
     verifySignature: Schema.boolean().description('是否验证签名。'),
   }).description('服务端设置')

package/src/types/acs.ts

@@ -226,7 +226,10 @@ export namespace Acs {
     export interface ListQuery extends Pagination {
       /** 记录开始时间，单位秒 */
       from: number
-      /** 记录结束时间，单位秒，时间跨度不能超过30天 */
+      /**
+       * 记录结束时间，单位秒，
+       * 时间跨度不能超过30天
+       */
       to: number
       /** 门禁设备 ID */
       device_id?: string

package/src/types/aily.ts

@@ -71,17 +71,17 @@ export namespace Aily {
     export namespace AilyMessage {
       export interface Methods {
         /**
-         * 发送智能伙伴消息
+         * 发送 Aily 消息
          * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/create
          */
         create(aily_session_id: string, body: CreateRequest): Promise<CreateResponse>
         /**
-         * 获取智能伙伴消息
+         * 获取 Aily 消息
          * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/get
          */
         get(aily_session_id: string, aily_message_id: string): Promise<GetResponse>
         /**
-         * 列出智能伙伴消息
+         * 列出 Aily 消息
          * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/aily-v1/aily_session-aily_message/list
          */
         list(aily_session_id: string, query?: ListQuery): Paginated<Lark.AilyMessage, 'messages'>