@satorijs/adapter-lark 3.9.5 → 3.10.0

package/lib/bot.d.ts

@@ -5,17 +5,14 @@ import { Internal } from './internal';
 export declare class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config> {
     static inject: string[];
     static MessageEncoder: typeof LarkMessageEncoder;
-    _token?: string;
     _refresher?: NodeJS.Timeout;
     http: HTTP;
     assetsQuester: HTTP;
-    internal: Internal;
+    internal: Internal<C>;
     constructor(ctx: C, config: LarkBot.Config);
     getResourceUrl(type: string, message_id: string, file_key: string): string;
     initialize(): Promise<void>;
     private refreshToken;
-    get token(): string;
-    set token(v: string);
     editMessage(channelId: string, messageId: string, content: h.Fragment): Promise<void>;
     deleteMessage(channelId: string, messageId: string): Promise<void>;
     getMessage(channelId: string, messageId: string, recursive?: boolean): Promise<Universal.Message>;

package/lib/content.d.ts

@@ -299,6 +299,9 @@ export declare namespace MessageContent {
             name?: string;
             required?: boolean;
             action_type?: 'link' | 'request' | 'multi' | 'form_submit' | 'form_reset';
+            value?: Record<string, string>;
+            url?: string;
+            multi_url?: Omit<URLs, 'url'>;
         }
         interface ConfirmElement {
             title: PlainTextElement;
@@ -421,7 +424,7 @@ export declare namespace MessageContent {
             type Width = 'default' | 'fill' | string;
             type Type = 'default' | 'primary' | 'danger' | 'text' | 'primary_text' | 'danger_text' | 'primary_filled' | 'danger_filled' | 'laser';
         }
-        type Element = DivElement | MarkdownElement | HRElement | ActionElement | NoteElement | ChartElement | TableElement | ImageElement | FormElement | InputElement | ButtonElement;
+        type Element = DivElement | MarkdownElement | HRElement | ActionElement | NoteElement | ChartElement | TableElement | ImageElement | FormElement | InputElement | ButtonElement | CheckerElement;
     }
     interface Template {
         type: 'template';

package/lib/index.cjs

@@ -146,17 +146,21 @@ async function adaptSession(bot, body) {
         const toArg = /* @__PURE__ */ __name((value) => {
           if (typeof value === "string") {
             return `'${value}'`;
-          } else if (typeof value === "number") {
-            return value;
           } else {
-            return `''`;
+            return value;
           }
         }, "toArg");
         for (let i = 0; i < args.length; ++i) {
           content += ` ${toArg(args[i])}`;
         }
         for (const [key, value] of Object.entries(options)) {
-          content += ` --${key} ${toArg(value)}`;
+          if (value === true) {
+            content += ` --${key}`;
+          } else if (value === false) {
+            content += ` --no-${key}`;
+          } else {
+            content += ` --${key} ${toArg(value)}`;
+          }
         }
         if (body.event.action.input_value) {
           content += ` ${toArg(body.event.action.input_value)}`;
@@ -322,6 +326,7 @@ var HttpServer = class extends import_core2.Adapter {
         });
         if (!result) return ctx.status = 403;
       }
+      if (!ctx.request.is("json")) return ctx.status = 415;
       const body = this._tryDecryptBody(ctx.request.body);
       if (body?.type === "url_verification" && body?.challenge && typeof body.challenge === "string") {
         ctx.response.body = { challenge: body.challenge };
@@ -576,13 +581,13 @@ var LarkMessageEncoder = class extends import_core3.MessageEncoder {
     } else if (type === "at") {
       if (this.card) {
         if (attrs.type === "all") {
-          this.textContent += `<at id=all>${attrs.name ?? "所有人"}</at>`;
+          this.textContent += `<at id=all>${attrs.name ?? ""}</at>`;
         } else {
           this.textContent += `<at id=${attrs.id}>${attrs.name ?? ""}</at>`;
         }
       } else {
         if (attrs.type === "all") {
-          this.textContent += `<at user_id="all">${attrs.name ?? "所有人"}</at>`;
+          this.textContent += `<at user_id="all">${attrs.name ?? ""}</at>`;
         } else {
           this.textContent += `<at user_id="${attrs.id}">${attrs.name ?? ""}</at>`;
         }
@@ -620,7 +625,7 @@ var LarkMessageEncoder = class extends import_core3.MessageEncoder {
       const length = this.card?.elements.length;
       await this.render(children);
       if (this.card?.elements.length > length) {
-        const elements = this.card?.elements.slice(length);
+        const elements = this.card?.elements.splice(length);
         this.card.elements.push({
           tag: "form",
           name: attrs.name || "Form",
@@ -628,24 +633,56 @@ var LarkMessageEncoder = class extends import_core3.MessageEncoder {
         });
       }
     } else if (type === "input") {
-      this.flushText();
-      this.card?.elements.push({
-        tag: "action",
-        actions: [{
-          tag: "input",
+      if (attrs.type === "checkbox") {
+        this.flushText();
+        await this.render(children);
+        this.card?.elements.push({
+          tag: "checker",
           name: attrs.name,
-          width: attrs.width,
-          label: attrs.label && {
+          checked: attrs.checked,
+          text: {
             tag: "plain_text",
-            content: attrs.label
-          },
-          placeholder: attrs.placeholder && {
+            content: this.textContent
+          }
+        });
+      } else if (attrs.type === "submit") {
+        this.flushText(true);
+        await this.render(children);
+        this.card?.elements.push({
+          tag: "button",
+          name: attrs.name,
+          text: {
             tag: "plain_text",
-            content: attrs.placeholder
+            content: this.textContent
           },
-          behaviors: this.createBehavior(attrs)
-        }]
-      });
+          action_type: "form_submit",
+          value: {
+            _satori_type: "command",
+            content: attrs.text
+          }
+        });
+      } else {
+        this.flushText();
+        await this.render(children);
+        this.card?.elements.push({
+          tag: "action",
+          actions: [{
+            tag: "input",
+            name: attrs.name,
+            width: attrs.width,
+            label: this.textContent && {
+              tag: "plain_text",
+              content: this.textContent
+            },
+            placeholder: attrs.placeholder && {
+              tag: "plain_text",
+              content: attrs.placeholder
+            },
+            behaviors: this.createBehavior(attrs)
+          }]
+        });
+      }
+      this.textContent = "";
     } else if (type === "button") {
       this.card ??= { elements: [] };
       this.flushText(true);
@@ -883,7 +920,6 @@ var LarkBot = class extends import_core5.Bot {
   }
   static inject = ["server", "http"];
   static MessageEncoder = LarkMessageEncoder;
-  _token;
   _refresher;
   http;
   assetsQuester;
@@ -931,7 +967,7 @@ var LarkBot = class extends import_core5.Bot {
         app_secret: this.config.appSecret
       });
       this.logger.debug("refreshed token %s", token);
-      this.token = token;
+      this.http.config.headers.Authorization = `Bearer ${token}`;
     } catch (error) {
       this.logger.error("failed to refresh token, retrying in 10s");
       this.logger.error(error);
@@ -941,13 +977,6 @@ var LarkBot = class extends import_core5.Bot {
     this._refresher = setTimeout(() => this.refreshToken(), timeout);
     this.online();
   }
-  get token() {
-    return this._token;
-  }
-  set token(v) {
-    this._token = v;
-    this.http.config.headers.Authorization = `Bearer ${v}`;
-  }
   async editMessage(channelId, messageId, content) {
     const encoder = new LarkMessageEncoder(this, channelId);
     encoder.editMessageIds = [messageId];

package/lib/internal.d.ts

@@ -1,4 +1,4 @@
-import { Dict, HTTP } from '@satorijs/core';
+import { Context, Dict, HTTP } from '@satorijs/core';
 import { LarkBot } from './bot';
 export interface Internal {
 }
@@ -28,9 +28,9 @@ export interface InternalRoute {
     multipart?: boolean;
     type?: 'raw-json' | 'binary';
 }
-export declare class Internal {
+export declare class Internal<C extends Context = Context> {
     private bot;
-    constructor(bot: LarkBot);
+    constructor(bot: LarkBot<C>);
     private _assertResponse;
     private _buildData;
     static define(routes: Dict<Partial<Record<HTTP.Method, string | InternalRoute>>>): void;

package/lib/utils.d.ts

@@ -146,9 +146,9 @@ export type Sender = {
     tenant_key: string;
 });
 export declare function adaptSender(sender: Sender, session: Session): Session;
-export declare function adaptMessage(bot: LarkBot, data: Events['im.message.receive_v1'], session: Session, details?: boolean): Promise<Session>;
+export declare function adaptMessage<C extends Context = Context>(bot: LarkBot<C>, data: Events['im.message.receive_v1'], session: Session, details?: boolean): Promise<Session>;
 export declare function adaptSession<C extends Context>(bot: LarkBot<C>, body: EventPayload): Promise<C[typeof import("cordis").Context.session]>;
-export declare function decodeMessage(bot: LarkBot, body: Message, details?: boolean): Promise<Universal.Message>;
+export declare function decodeMessage<C extends Context = Context>(bot: LarkBot<C>, body: Message, details?: boolean): Promise<Universal.Message>;
 /**
  * Get ID type from id string
  * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@satorijs/adapter-lark",
   "description": "Lark (飞书) Adapter for Satorijs",
-  "version": "3.9.5",
+  "version": "3.10.0",
   "type": "module",
   "main": "lib/index.cjs",
   "types": "lib/index.d.ts",
@@ -37,7 +37,7 @@
     "@cordisjs/plugin-server": "^0.2.5",
     "@satorijs/core": "^4.5.0",
     "cordis": "^3.18.1",
-    "cosmokit": "^1.6.3",
+    "cosmokit": "^1.7.2",
     "dedent": "^1.5.3"
   },
   "peerDependencies": {

package/src/bot.ts

@@ -18,11 +18,10 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
   static inject = ['server', 'http']
   static MessageEncoder = LarkMessageEncoder
 
-  _token?: string
   _refresher?: NodeJS.Timeout
   http: HTTP
   assetsQuester: HTTP
-  internal: Internal
+  internal: Internal<C>
 
   constructor(ctx: C, config: LarkBot.Config) {
     super(ctx, config, 'lark')
@@ -86,7 +85,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
         app_secret: this.config.appSecret,
       })
       this.logger.debug('refreshed token %s', token)
-      this.token = token
+      this.http.config.headers!.Authorization = `Bearer ${token}`
     } catch (error) {
       this.logger.error('failed to refresh token, retrying in 10s')
       this.logger.error(error)
@@ -97,15 +96,6 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
     this.online()
   }
 
-  get token() {
-    return this._token
-  }
-
-  set token(v: string) {
-    this._token = v
-    this.http.config.headers.Authorization = `Bearer ${v}`
-  }
-
   async editMessage(channelId: string, messageId: string, content: h.Fragment) {
     const encoder = new LarkMessageEncoder(this, channelId)
     encoder.editMessageIds = [messageId]
@@ -118,9 +108,9 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 
   async getMessage(channelId: string, messageId: string, recursive = true) {
     const data = await this.internal.getImMessage(messageId)
-    const message = await Utils.decodeMessage(this, data.items[0], recursive)
+    const message = await Utils.decodeMessage(this, data.items![0], recursive)
     const im = await this.internal.getImChat(channelId)
-    message.channel.type = im.chat_mode === 'p2p' ? Universal.Channel.Type.DIRECT : Universal.Channel.Type.TEXT
+    message.channel!.type = im.chat_mode === 'p2p' ? Universal.Channel.Type.DIRECT : Universal.Channel.Type.TEXT
     return message
   }
 
@@ -132,7 +122,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 
   async getUser(userId: string, guildId?: string) {
     const data = await this.internal.getContactUser(userId)
-    return Utils.decodeUser(data.user)
+    return Utils.decodeUser(data.user!)
   }
 
   async getChannel(channelId: string) {
@@ -156,7 +146,7 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 
   async getGuildMemberList(guildId: string, after?: string) {
     const members = await this.internal.getImChatMembers(guildId, { page_token: after })
-    const data = members.items.map(v => ({ user: { id: v.member_id, name: v.name }, name: v.name }))
+    const data = members.items!.map(v => ({ user: { id: v.member_id, name: v.name }, name: v.name }))
     return { data, next: members.page_token }
   }
 

package/src/content.ts

@@ -378,6 +378,10 @@ export namespace MessageContent {
       name?: string
       required?: boolean
       action_type?: 'link' | 'request' | 'multi' | 'form_submit' | 'form_reset'
+      // legacy fields
+      value?: Record<string, string>
+      url?: string
+      multi_url?: Omit<URLs, 'url'>
     }
 
     export interface ConfirmElement {
@@ -526,6 +530,7 @@ export namespace MessageContent {
       | FormElement
       | InputElement
       | ButtonElement
+      | CheckerElement
   }
 
   export interface Template {

package/src/http.ts

@@ -43,6 +43,9 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<
         if (!result) return (ctx.status = 403)
       }
 
+      // only accept JSON body
+      if (!ctx.request.is('json')) return ctx.status = 415
+
       // try to decrypt message first if encryptKey is set
       const body = this._tryDecryptBody(ctx.request.body)
       // respond challenge message
@@ -81,7 +84,7 @@ export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<
     if (!header) return
     const { app_id, event_type } = header
     body.type = event_type // add type to body to ease typescript type narrowing
-    const bot = this.bots.find((bot) => bot.config.appId === app_id)
+    const bot = this.bots.find((bot) => bot.config.appId === app_id)!
     const session = await adaptSession(bot, body)
     bot.dispatch(session)
   }

package/src/internal.ts

@@ -1,4 +1,4 @@
-import { Dict, HTTP, makeArray } from '@satorijs/core'
+import { Context, Dict, HTTP, makeArray } from '@satorijs/core'
 import { LarkBot } from './bot'
 
 export interface Internal {}
@@ -33,8 +33,8 @@ export interface InternalRoute {
   type?: 'raw-json' | 'binary'
 }
 
-export class Internal {
-  constructor(private bot: LarkBot) {}
+export class Internal<C extends Context = Context> {
+  constructor(private bot: LarkBot<C>) {}
 
   private _assertResponse(response: HTTP.Response<BaseResponse>) {
     if (!response.data.code) return
@@ -113,12 +113,13 @@ export class Internal {
               const { argIndex, itemsKey = 'items', tokenKey = 'page_token' } = route.pagination
               const iterArgs = [...args]
               iterArgs[argIndex] = { ...args[argIndex] }
-              let pagination: { data: any[]; next?: any } | undefined
+              type Pagniation = { data: any[]; next?: any }
+              let pagination: Pagniation | undefined
               result.next = async function () {
-                pagination ??= await this[Symbol.for('satori.pagination')]()
+                pagination ??= await this[Symbol.for('satori.pagination')]() as Pagniation
                 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')]()
+                pagination = await this[Symbol.for('satori.pagination')]() as Pagniation
                 return this.next()
               }
               result[Symbol.asyncIterator] = function () {

package/src/message.ts

@@ -208,13 +208,13 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
     } else if (type === 'at') {
       if (this.card) {
         if (attrs.type === 'all') {
-          this.textContent += `<at id=all>${attrs.name ?? '所有人'}</at>`
+          this.textContent += `<at id=all>${attrs.name ?? ''}</at>`
         } else {
           this.textContent += `<at id=${attrs.id}>${attrs.name ?? ''}</at>`
         }
       } else {
         if (attrs.type === 'all') {
-          this.textContent += `<at user_id="all">${attrs.name ?? '所有人'}</at>`
+          this.textContent += `<at user_id="all">${attrs.name ?? ''}</at>`
         } else {
           this.textContent += `<at user_id="${attrs.id}">${attrs.name ?? ''}</at>`
         }
@@ -253,7 +253,7 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
       const length = this.card?.elements.length
       await this.render(children)
       if (this.card?.elements.length > length) {
-        const elements = this.card?.elements.slice(length)
+        const elements = this.card?.elements.splice(length)
         this.card.elements.push({
           tag: 'form',
           name: attrs.name || 'Form',
@@ -261,24 +261,56 @@ export class LarkMessageEncoder<C extends Context = Context> extends MessageEnco
         })
       }
     } else if (type === 'input') {
-      this.flushText()
-      this.card?.elements.push({
-        tag: 'action',
-        actions: [{
-          tag: 'input',
+      if (attrs.type === 'checkbox') {
+        this.flushText()
+        await this.render(children)
+        this.card?.elements.push({
+          tag: 'checker',
           name: attrs.name,
-          width: attrs.width,
-          label: attrs.label && {
+          checked: attrs.checked,
+          text: {
             tag: 'plain_text',
-            content: attrs.label,
+            content: this.textContent,
           },
-          placeholder: attrs.placeholder && {
+        })
+      } else if (attrs.type === 'submit') {
+        this.flushText(true)
+        await this.render(children)
+        this.card?.elements.push({
+          tag: 'button',
+          name: attrs.name,
+          text: {
             tag: 'plain_text',
-            content: attrs.placeholder,
+            content: this.textContent,
           },
-          behaviors: this.createBehavior(attrs),
-        }],
-      })
+          action_type: 'form_submit',
+          value: {
+            _satori_type: 'command',
+            content: attrs.text,
+          },
+        })
+      } else {
+        this.flushText()
+        await this.render(children)
+        this.card?.elements.push({
+          tag: 'action',
+          actions: [{
+            tag: 'input',
+            name: attrs.name,
+            width: attrs.width,
+            label: this.textContent && {
+              tag: 'plain_text',
+              content: this.textContent,
+            },
+            placeholder: attrs.placeholder && {
+              tag: 'plain_text',
+              content: attrs.placeholder,
+            },
+            behaviors: this.createBehavior(attrs),
+          }],
+        })
+      }
+      this.textContent = ''
     } else if (type === 'button') {
       this.card ??= { elements: [] }
       this.flushText(true)

package/src/utils.ts

@@ -168,7 +168,12 @@ export function adaptSender(sender: Sender, session: Session): Session {
   return session
 }
 
-export async function adaptMessage(bot: LarkBot, data: Events['im.message.receive_v1'], session: Session, details = true): Promise<Session> {
+export async function adaptMessage<C extends Context = Context>(
+  bot: LarkBot<C>,
+  data: Events['im.message.receive_v1'],
+  session: Session,
+  details = true,
+): Promise<Session> {
   const json = JSON.parse(data.message.content)
   const content: (string | h)[] = []
   switch (data.message.message_type) {
@@ -182,7 +187,7 @@ export async function adaptMessage(bot: LarkBot, data: Events['im.message.receiv
       // Lark's `at` Element would be `@user_id` in text
       text.split(' ').forEach((word) => {
         if (word.startsWith('@')) {
-          const mention = data.message.mentions.find((mention) => mention.key === word)
+          const mention = data.message.mentions.find((mention) => mention.key === word)!
           content.push(h.at(mention.id.open_id, { name: mention.name }))
         } else {
           content.push(word)
@@ -261,17 +266,21 @@ export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: Eve
         const toArg = (value: any) => {
           if (typeof value === 'string') {
             return `'${value}'`
-          } else if (typeof value === 'number') {
+          } else { // number, boolean
             return value
-          } else {
-            return `''`
           }
         }
         for (let i = 0; i < args.length; ++i) {
           content += ` ${toArg(args[i])}`
         }
         for (const [key, value] of Object.entries(options)) {
-          content += ` --${key} ${toArg(value)}`
+          if (value === true) {
+            content += ` --${key}`
+          } else if (value === false) {
+            content += ` --no-${key}`
+          } else {
+            content += ` --${key} ${toArg(value)}`
+          }
         }
         if (body.event.action.input_value) {
           content += ` ${toArg(body.event.action.input_value)}`
@@ -291,8 +300,8 @@ export async function adaptSession<C extends Context>(bot: LarkBot<C>, body: Eve
 }
 
 // TODO: This function has many duplicated code with `adaptMessage`, should refactor them
-export async function decodeMessage(bot: LarkBot, body: Message, details = true): Promise<Universal.Message> {
-  const json = JSON.parse(body.body.content)
+export async function decodeMessage<C extends Context = Context>(bot: LarkBot<C>, body: Message, details = true): Promise<Universal.Message> {
+  const json = JSON.parse(body.body!.content)
   const content: h[] = []
   switch (body.msg_type) {
     case 'text': {
@@ -305,7 +314,7 @@ export async function decodeMessage(bot: LarkBot, body: Message, details = true)
       // Lark's `at` Element would be `@user_id` in text
       text.split(' ').forEach((word) => {
         if (word.startsWith('@')) {
-          const mention = body.mentions.find((mention) => mention.key === word)
+          const mention = body.mentions!.find((mention) => mention.key === word)!
           content.push(h.at(mention.id, { name: mention.name }))
         } else {
           content.push(h.text(word))
@@ -314,37 +323,37 @@ export async function decodeMessage(bot: LarkBot, body: Message, details = true)
       break
     }
     case 'image':
-      content.push(h.image(bot.getResourceUrl('image', body.message_id, json.image_key)))
+      content.push(h.image(bot.getResourceUrl('image', body.message_id!, json.image_key)))
       break
     case 'audio':
-      content.push(h.audio(bot.getResourceUrl('file', body.message_id, json.file_key)))
+      content.push(h.audio(bot.getResourceUrl('file', body.message_id!, json.file_key)))
       break
     case 'media':
-      content.push(h.video(bot.getResourceUrl('file', body.message_id, json.file_key), {
+      content.push(h.video(bot.getResourceUrl('file', body.message_id!, json.file_key), {
         poster: json.image_key,
       }))
       break
     case 'file':
-      content.push(h.file(bot.getResourceUrl('file', body.message_id, json.file_key)))
+      content.push(h.file(bot.getResourceUrl('file', body.message_id!, json.file_key)))
       break
   }
 
   return {
-    timestamp: +body.update_time,
-    createdAt: +body.create_time,
-    updatedAt: +body.update_time,
+    timestamp: +body.update_time!,
+    createdAt: +body.create_time!,
+    updatedAt: +body.update_time!,
     id: body.message_id,
     messageId: body.message_id,
     user: {
-      id: body.sender.id,
+      id: body.sender!.id,
     },
     channel: {
-      id: body.chat_id,
+      id: body.chat_id!,
       type: Universal.Channel.Type.TEXT,
     },
     content: content.map((c) => c.toString()).join(' '),
     elements: content,
-    quote: (body.upper_message_id && details) ? await bot.getMessage(body.chat_id, body.upper_message_id, false) : undefined,
+    quote: (body.upper_message_id && details) ? await bot.getMessage(body.chat_id!, body.upper_message_id, false) : undefined,
   }
 }
 
@@ -371,7 +380,7 @@ export function decodeChannel(channelId: string, guild: GetImChatResponse): Univ
 
 export function decodeGuild(guild: ListChat): Universal.Guild {
   return {
-    id: guild.chat_id,
+    id: guild.chat_id!,
     name: guild.name,
     avatar: guild.avatar,
   }
@@ -379,7 +388,7 @@ export function decodeGuild(guild: ListChat): Universal.Guild {
 
 export function decodeUser(user: User): Universal.User {
   return {
-    id: user.open_id,
+    id: user.open_id!,
     avatar: user.avatar?.avatar_origin,
     isBot: false,
     name: user.name,