@satorijs/adapter-lark 3.8.6 → 3.9.0

package/lib/types/verification.d.ts

@@ -0,0 +1,14 @@
+import { Verification } from '.';
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 获取认证信息
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/verification-v1/verification/get
+         */
+        getVerification(): Promise<GetVerificationResponse>;
+    }
+}
+export interface GetVerificationResponse {
+    /** 认证信息 */
+    verification?: Verification;
+}

package/lib/types/wiki.d.ts

@@ -0,0 +1,240 @@
+import { Member, Node, Setting, Space, TaskResult } from '.';
+import { Pagination } from '../internal';
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 获取知识空间列表
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list
+         */
+        listWikiSpace(query?: ListWikiSpaceQuery): Paginated<Space>;
+        /**
+         * 获取知识空间信息
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get
+         */
+        getWikiSpace(space_id: string, query?: GetWikiSpaceQuery): Promise<GetWikiSpaceResponse>;
+        /**
+         * 创建知识空间
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create
+         */
+        createWikiSpace(body: CreateWikiSpaceRequest): Promise<CreateWikiSpaceResponse>;
+        /**
+         * 获取知识空间成员列表
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list
+         */
+        listWikiSpaceMember(space_id: string, query?: Pagination): Paginated<Member, 'members'>;
+        /**
+         * 添加知识空间成员
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create
+         */
+        createWikiSpaceMember(space_id: string, body: CreateWikiSpaceMemberRequest, query?: CreateWikiSpaceMemberQuery): Promise<CreateWikiSpaceMemberResponse>;
+        /**
+         * 删除知识空间成员
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete
+         */
+        deleteWikiSpaceMember(space_id: string, member_id: string, body: DeleteWikiSpaceMemberRequest): Promise<DeleteWikiSpaceMemberResponse>;
+        /**
+         * 更新知识空间设置
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update
+         */
+        updateWikiSpaceSetting(space_id: string, body: UpdateWikiSpaceSettingRequest): Promise<UpdateWikiSpaceSettingResponse>;
+        /**
+         * 创建知识空间节点
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create
+         */
+        createWikiSpaceNode(space_id: string, body: CreateWikiSpaceNodeRequest): Promise<CreateWikiSpaceNodeResponse>;
+        /**
+         * 获取知识空间节点信息
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node
+         */
+        getNodeWikiSpace(query?: GetNodeWikiSpaceQuery): Promise<GetNodeWikiSpaceResponse>;
+        /**
+         * 获取知识空间子节点列表
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list
+         */
+        listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Paginated<Node>;
+        /**
+         * 移动知识空间节点
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move
+         */
+        moveWikiSpaceNode(space_id: string, node_token: string, body: MoveWikiSpaceNodeRequest): Promise<MoveWikiSpaceNodeResponse>;
+        /**
+         * 更新知识空间节点标题
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title
+         */
+        updateTitleWikiSpaceNode(space_id: string, node_token: string, body: UpdateTitleWikiSpaceNodeRequest): Promise<void>;
+        /**
+         * 创建知识空间节点副本
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy
+         */
+        copyWikiSpaceNode(space_id: string, node_token: string, body: CopyWikiSpaceNodeRequest): Promise<CopyWikiSpaceNodeResponse>;
+        /**
+         * 移动云空间文档至知识空间
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki
+         */
+        moveDocsToWikiWikiSpaceNode(space_id: string, body: MoveDocsToWikiWikiSpaceNodeRequest): Promise<MoveDocsToWikiWikiSpaceNodeResponse>;
+        /**
+         * 获取任务结果
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get
+         */
+        getWikiTask(task_id: string, query?: GetWikiTaskQuery): Promise<GetWikiTaskResponse>;
+        /**
+         * 搜索 Wiki
+         * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki
+         */
+        searchWikiNode(body: SearchWikiNodeRequest, query?: Pagination): Paginated<Node>;
+    }
+}
+export interface ListWikiSpaceQuery extends Pagination {
+    /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
+    lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW';
+}
+export interface GetWikiSpaceQuery {
+    /** 当查询个人文档库时，指定返回的文档库名称展示语言。可选值有：zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
+    lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW';
+}
+export interface CreateWikiSpaceRequest {
+    /** 知识空间名称 */
+    name?: string;
+    /** 知识空间描述 */
+    description?: string;
+    /** 表示知识空间的分享状态 */
+    open_sharing?: 'open' | 'closed';
+}
+export interface CreateWikiSpaceMemberRequest {
+    /** 知识库协作者 ID 类型 */
+    member_type: string;
+    /** 知识库协作者 ID */
+    member_id: string;
+    /** 知识库协作者角色 */
+    member_role: string;
+}
+export interface CreateWikiSpaceMemberQuery {
+    /** 添加权限后是否通知对方 */
+    need_notification?: boolean;
+}
+export interface DeleteWikiSpaceMemberRequest {
+    /** 知识库协作者 ID 类型 */
+    member_type: string;
+    /** 知识库协作者角色 */
+    member_role: string;
+    /** 知识库协作者类型 */
+    type?: 'user' | 'chat' | 'department';
+}
+export interface UpdateWikiSpaceSettingRequest {
+    /** 谁可以创建空间的一级页面： "admin_and_member" = 管理员和成员 "admin"  - 仅管理员 */
+    create_setting?: string;
+    /** 可阅读用户可否创建副本/打印/导出/复制： "allow" - 允许 "not_allow" - 不允许 */
+    security_setting?: string;
+    /** 可阅读用户可否评论： "allow" - 允许 "not_allow" - 不允许 */
+    comment_setting?: string;
+}
+export interface CreateWikiSpaceNodeRequest {
+    /** 文档类型，对于快捷方式，该字段是对应的实体的obj_type。 */
+    obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides';
+    /** 父节点 token。若当前节点为一级节点，父节点 token 为空。 */
+    parent_node_token?: string;
+    /** 节点类型 */
+    node_type: 'origin' | 'shortcut';
+    /** 快捷方式对应的实体node_token，当节点为快捷方式时，该值不为空。 */
+    origin_node_token?: string;
+    /** 文档标题 */
+    title?: string;
+}
+export interface GetNodeWikiSpaceQuery {
+    /** 文档的wiki token */
+    token: string;
+    /** 文档类型 */
+    obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki';
+}
+export interface ListWikiSpaceNodeQuery extends Pagination {
+    /** 父节点token */
+    parent_node_token?: string;
+}
+export interface MoveWikiSpaceNodeRequest {
+    /** 移动到的父节点token */
+    target_parent_token?: string;
+    /** 移动到的知识空间ID */
+    target_space_id?: string;
+}
+export interface UpdateTitleWikiSpaceNodeRequest {
+    /** 节点新标题 */
+    title: string;
+}
+export interface CopyWikiSpaceNodeRequest {
+    /** 目标父节点token */
+    target_parent_token?: string;
+    /** 目标知识空间id */
+    target_space_id?: string;
+    /** 复制后的新标题。如果填空，则新标题为空。如果不填，则使用原节点标题。 */
+    title?: string;
+}
+export interface MoveDocsToWikiWikiSpaceNodeRequest {
+    /** 节点的父亲token */
+    parent_wiki_token?: string;
+    /** 文档类型 */
+    obj_type: 'doc' | 'sheet' | 'bitable' | 'mindnote' | 'docx' | 'file' | 'slides';
+    /** 文档token */
+    obj_token: string;
+    /** 没有权限时，是否申请迁入文档 */
+    apply?: boolean;
+}
+export interface GetWikiTaskQuery {
+    /** 任务类型 */
+    task_type: 'move';
+}
+export interface SearchWikiNodeRequest {
+    /** 搜索关键词 */
+    query: string;
+    /** 文档所属的知识空间ID，为空搜索所有 wiki */
+    space_id?: string;
+    /** wiki token，不为空搜索该节点及其所有子节点，为空搜索所有 wiki（根据 space_id 选择 space） */
+    node_id?: string;
+}
+export interface GetWikiSpaceResponse {
+    /** 知识空间 */
+    space?: Space;
+}
+export interface CreateWikiSpaceResponse {
+    /** 知识空间信息 */
+    space?: Space;
+}
+export interface CreateWikiSpaceMemberResponse {
+    /** 知识库协作者 */
+    member?: Member;
+}
+export interface DeleteWikiSpaceMemberResponse {
+    /** 成员信息 */
+    member: Member;
+}
+export interface UpdateWikiSpaceSettingResponse {
+    /** 空间设置 */
+    setting?: Setting;
+}
+export interface CreateWikiSpaceNodeResponse {
+    /** 节点 */
+    node?: Node;
+}
+export interface GetNodeWikiSpaceResponse {
+    /** 节点信息 */
+    node?: Node;
+}
+export interface MoveWikiSpaceNodeResponse {
+    /** 移动后的节点信息 */
+    node?: Node;
+}
+export interface CopyWikiSpaceNodeResponse {
+    /** copy后的节点 */
+    node: Node;
+}
+export interface MoveDocsToWikiWikiSpaceNodeResponse {
+    /** 移动后的知识库token */
+    wiki_token?: string;
+    /** 任务id */
+    task_id?: string;
+    /** 是否提交了文档迁入申请 */
+    applied?: boolean;
+}
+export interface GetWikiTaskResponse {
+    /** 任务结果 */
+    task: TaskResult;
+}

package/lib/types/workplace.d.ts

@@ -0,0 +1,43 @@
+import { BlockAccessData, CustomWorkplaceAccessData, WorkplaceAccessData } from '.';
+import { Pagination } from '../internal';
+declare module '../internal' {
+    interface Internal {
+        /**
+         * 获取工作台访问数据
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_access_data/search
+         */
+        searchWorkplaceWorkplaceAccessData(query?: SearchWorkplaceWorkplaceAccessDataQuery): Paginated<WorkplaceAccessData>;
+        /**
+         * 获取定制工作台访问数据
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/custom_workplace_access_data/search
+         */
+        searchWorkplaceCustomWorkplaceAccessData(query?: SearchWorkplaceCustomWorkplaceAccessDataQuery): Paginated<CustomWorkplaceAccessData>;
+        /**
+         * 获取定制工作台小组件访问数据
+         * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/workplace-v1/workplace_block_access_data/search
+         */
+        searchWorkplaceWorkplaceBlockAccessData(query?: SearchWorkplaceWorkplaceBlockAccessDataQuery): Paginated<BlockAccessData>;
+    }
+}
+export interface SearchWorkplaceWorkplaceAccessDataQuery extends Pagination {
+    /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */
+    from_date: string;
+    /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */
+    to_date: string;
+}
+export interface SearchWorkplaceCustomWorkplaceAccessDataQuery extends Pagination {
+    /** 数据检索开始时间，精确到日。格式yyyy-MM-dd */
+    from_date: string;
+    /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */
+    to_date: string;
+    /** 定制化工作台id.非必填,不填的时候,返回所有定制化工作台数据。 */
+    custom_workplace_id?: string;
+}
+export interface SearchWorkplaceWorkplaceBlockAccessDataQuery extends Pagination {
+    /** 数据检索开始时间，精确到日。格式yyyy-MM-dd。 */
+    from_date: string;
+    /** 数据检索结束时间，精确到日。格式yyyy-MM-dd。 */
+    to_date: string;
+    /** 小组件id */
+    block_id?: string;
+}

package/lib/utils.d.ts

@@ -1,26 +1,162 @@
 import { Context, Session, Universal } from '@satorijs/core';
 import { LarkBot } from './bot';
-import { EventPayload, Events, GetImChatResponse, Lark } from './types';
+import { GetImChatResponse, ListChat, Message, User } from './types';
+import { MessageContent } from './content';
+export interface EventHeader<K extends keyof Events> {
+    event_id: string;
+    event_type: K;
+    create_time: string;
+    token: string;
+    app_id: string;
+    tenant_key: string;
+}
+export interface Events {
+    /**
+     * Receive message event.
+     * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive
+     */
+    'im.message.receive_v1': {
+        sender: {
+            sender_id: UserIds;
+            sender_type?: string;
+            tenant_key: string;
+        };
+        message: {
+            message_id: string;
+            root_id: string;
+            parent_id: string;
+            thread_id: string;
+            create_time: string;
+            chat_id: string;
+            chat_type: string;
+            message_type: keyof MessageContent;
+            content: string;
+            mentions: {
+                key: string;
+                id: UserIds;
+                name: string;
+                tenant_key: string;
+            }[];
+        };
+    };
+    /**
+     * Message read event.
+     * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/message_read
+     */
+    'im.message.message_read_v1': {
+        reader: {
+            reader_id: UserIds;
+            read_time: string;
+            tenant_key: string;
+        };
+        message_id_list: string[];
+    };
+    /**
+     * Message card callback event.
+     * @see https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-callback-communication
+     */
+    'card.action.trigger': {
+        operator: {
+            tenant_key: string;
+            user_id: string;
+            union_id: string;
+            open_id: string;
+        };
+        token: string;
+        action: {
+            value: any;
+            tag: string;
+            timezone?: string;
+            name?: string;
+            form_value?: any;
+            input_value?: string;
+            option?: string;
+            options?: string[];
+            checked?: boolean;
+        };
+        host: string;
+        /** 卡片分发类型，固定取值为 url_preview，表示链接预览卡片。仅链接预览卡片有此字段。 */
+        delivery_type?: 'url_preview';
+        context: {
+            url?: string;
+            preview_token?: string;
+            open_message_id: string;
+            open_chat_id: string;
+        };
+    };
+    /**
+     * 机器人自定义菜单事件
+     * @see https://open.feishu.cn/document/client-docs/bot-v3/events/menu
+     */
+    'application.bot.menu_v6': {
+        operator: {
+            operator_name: string;
+            operator_id: {
+                union_id: string;
+                user_id: string;
+                open_id: string;
+            };
+        };
+        event_key: string;
+        timestamp: number;
+    };
+}
+export type EventPayload = {
+    [K in keyof Events]: {
+        schema: '2.0';
+        type: K;
+        header: EventHeader<K>;
+        event: Events[K];
+    };
+}[keyof Events];
+/**
+ * A user in Lark has several different IDs.
+ * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction
+ */
+export interface UserIds {
+    union_id: string;
+    /** *user_id* only available when the app has permissions granted by the administrator */
+    user_id?: string;
+    open_id: string;
+}
+/**
+ * Identify a user in Lark.
+ * This behaves like {@link UserIds}, but it only contains *open_id*.
+ * (i.e. the id_type is always `open_id`)
+ */
+export interface UserIdentifiers {
+    id: string;
+    id_type: string;
+}
+export type UserIdType = 'union_id' | 'user_id' | 'open_id';
+/**
+ * The id type when specify a receiver, would be used in the request query.
+ *
+ * NOTE: we always use **open_id** to identify a user, use **chat_id** to identify a channel.
+ * @see https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/create
+ */
+export type ReceiveIdType = UserIdType | 'email' | 'chat_id';
+export type DepartmentIdType = 'department_id' | 'open_department_id';
 export type Sender = {
-    sender_id: Lark.UserIds;
+    sender_id: UserIds;
     sender_type?: string;
     tenant_key: string;
-} | (Lark.UserIdentifiers & {
+} | (UserIdentifiers & {
     sender_type?: string;
     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 adaptSession<C extends Context>(bot: LarkBot<C>, body: EventPayload): Promise<C[typeof import("cordis").Context.session]>;
-export declare function decodeMessage(bot: LarkBot, body: Lark.Message, details?: boolean): Promise<Universal.Message>;
+export declare function decodeMessage(bot: LarkBot, body: Message, details?: boolean): Promise<Universal.Message>;
 /**
  * Get ID type from id string
  * @see https://open.larksuite.com/document/home/user-identity-introduction/introduction
  */
-export declare function extractIdType(id: string): Lark.ReceiveIdType;
+export declare function extractIdType(id: string): ReceiveIdType;
 export declare function decodeChannel(channelId: string, guild: GetImChatResponse): Universal.Channel;
-export declare function decodeGuild(guild: Lark.ListChat): Universal.Guild;
-export declare function decodeUser(user: Lark.User): Universal.User;
+export declare function decodeGuild(guild: ListChat): Universal.Guild;
+export declare function decodeUser(user: User): Universal.User;
 export declare class Cipher {
     encryptKey: string;
     key: Buffer;

package/package.json

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

package/src/bot.ts

@@ -1,10 +1,19 @@
 import { Bot, Context, h, HTTP, Schema, Time, Universal } from '@satorijs/core'
-
+import { CreateImFileForm } from './types'
 import { HttpServer } from './http'
 import { LarkMessageEncoder } from './message'
-import { Internal } from './types'
+import { Internal } from './internal'
 import * as Utils from './utils'
 
+const fileTypeMap: Record<Exclude<CreateImFileForm['file_type'], 'stream'>, string[]> = {
+  opus: ['audio/opus'],
+  mp4: ['video/mp4'],
+  pdf: ['application/pdf'],
+  doc: ['application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'],
+  xls: ['application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'],
+  ppt: ['application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation'],
+}
+
 export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config> {
   static inject = ['server', 'http']
   static MessageEncoder = LarkMessageEncoder
@@ -145,9 +154,16 @@ export class LarkBot<C extends Context = Context> extends Bot<C, LarkBot.Config>
 
   async createUpload(...uploads: Universal.Upload[]): Promise<string[]> {
     return await Promise.all(uploads.map(async (upload) => {
+      let type: CreateImFileForm['file_type'] = 'stream'
+      for (const [key, value] of Object.entries(fileTypeMap)) {
+        if (value.includes(upload.type)) {
+          type = key as CreateImFileForm['file_type']
+          break
+        }
+      }
       const response = await this.internal.createImFile({
         file_name: upload.filename,
-        file_type: upload.type,
+        file_type: type,
         file: new Blob([upload.data]),
       })
       return this.getInternalUrl(`/im/v1/files/${response.file_key}`)

package/src/{types/message/content.ts → content.ts}

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 // https://open.larksuite.com/document/server-docs/im-v1/message-content-description/create_json
 
 declare global {

package/src/http.ts

@@ -1,9 +1,7 @@
 import { Adapter, Context, Logger, Schema } from '@satorijs/core'
 import {} from '@cordisjs/plugin-server'
-
 import { LarkBot } from './bot'
-import { EventPayload } from './types'
-import { adaptSession, Cipher } from './utils'
+import { adaptSession, Cipher, EventPayload } from './utils'
 
 export class HttpServer<C extends Context = Context> extends Adapter<C, LarkBot<C>> {
   static inject = ['server']

package/src/index.ts

@@ -1,4 +1,6 @@
 import { LarkBot } from './bot'
+import { Internal } from './internal'
+import { EventPayload } from './utils'
 import * as Lark from './types'
 
 export * from './bot'
@@ -9,7 +11,7 @@ export default LarkBot
 
 declare module '@satorijs/core' {
   interface Session {
-    feishu: Lark.Internal & Lark.EventPayload
-    lark: Lark.Internal & Lark.EventPayload
+    feishu: Internal & EventPayload
+    lark: Internal & EventPayload
   }
 }