@satorijs/adapter-lark 3.11.9 → 3.12.0

package/lib/types/mail.d.ts

@@ -416,7 +416,13 @@ export declare 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';
         }
         interface CreateResponse {
@@ -434,7 +440,13 @@ export declare 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';
         }
         interface PatchRequest {
@@ -444,7 +456,13 @@ export declare 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';
         }
         interface PatchResponse {
@@ -462,7 +480,13 @@ export declare 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';
         }
         interface UpdateRequest {
@@ -472,7 +496,13 @@ export declare 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';
         }
         interface UpdateResponse {
@@ -490,7 +520,13 @@ export declare 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';
         }
         interface GetResponse {
@@ -508,7 +544,13 @@ export declare 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';
         }
         interface ListQuery extends Pagination {
@@ -596,7 +638,16 @@ export declare 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';
             }
             interface CreateQuery {
@@ -614,7 +665,16 @@ export declare 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';
             }
             interface GetQuery {
@@ -632,7 +692,16 @@ export declare 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';
             }
             interface ListQuery extends Pagination {
@@ -731,7 +800,11 @@ export declare 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';
             }
             interface CreateQuery {
@@ -749,7 +822,11 @@ export declare 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';
             }
             interface GetQuery {
@@ -767,7 +844,11 @@ export declare 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';
             }
             interface ListQuery extends Pagination {
@@ -937,7 +1018,10 @@ export declare namespace Mail {
             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';
             }
             interface CreateQuery {
@@ -949,7 +1033,10 @@ export declare 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';
             }
             interface GetQuery {
@@ -961,7 +1048,10 @@ export declare 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';
             }
             interface ListQuery extends Pagination {

package/lib/types/search.d.ts

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

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.9",
+  "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