mobx-lark 2.6.4 → 2.7.0

package/dist/module/InstantMessenger/index.d.ts

@@ -1,5 +1,5 @@
 import { ListModel, NewData } from 'mobx-restful';
-import { ChatMessage, ChatMeta, SendChatMessage } from './type';
+import { ChatMessage, ChatMeta, CreateChatOption, SendChatMessage } from './type';
 export * from './type';
 declare const ChatListModel_base: (abstract new (...args: any[]) => {
     stream?: AsyncGenerator<ChatMeta, void, any> | undefined;
@@ -54,9 +54,10 @@ export declare abstract class ChatListModel extends ChatListModel_base {
      */
     openStream(): AsyncGenerator<ChatMeta, void, unknown>;
     /**
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
+     * @see {@link https://open.feishu.cn/document/server-docs/group/chat/create}
+     * @see {@link https://open.feishu.cn/document/server-docs/group/chat/update-2}
      */
-    updateOne({ chat_id }: NewData<ChatMeta>): Promise<ChatMeta>;
+    updateOne({ chat_id, ...data }: Partial<NewData<ChatMeta>>, option?: CreateChatOption): Promise<ChatMeta>;
 }
 declare const MessageListModel_base: (abstract new (...args: any[]) => {
     stream?: AsyncGenerator<ChatMessage, void, any> | undefined;

package/dist/module/InstantMessenger/type/index.d.ts

@@ -1,18 +1,31 @@
 import { TranslationMap } from '../../../type';
+import { UserIdType } from '../../User/type';
 import { ChatMessageContent } from './message';
 export * from './message';
 export type ChatPermission = 'all_members' | 'only_owner' | 'not_anyone';
-export interface CreateChatMeta extends Record<'owner_id' | 'avatar' | 'name' | 'description', string>, Record<`${'join' | 'leave'}_message_visibility`, ChatPermission>, Record<`${'user' | 'bot'}_id_list`, string[]> {
+export type ChatManagerPermission = Exclude<ChatPermission, 'not_anyone'>;
+export type ChatMemberPermission = Exclude<ChatPermission, 'only_owner'>;
+export interface RestrictedModeSetting extends Partial<Record<`${'screenshot' | 'download' | 'message'}_has_permission_setting`, ChatMemberPermission>> {
+    status?: boolean;
+}
+export interface CreateChatMeta extends Record<'owner_id' | 'avatar' | 'name' | 'description', string>, Record<`${'join' | 'leave'}_message_visibility`, ChatPermission>, Record<`${'user' | 'bot'}_id_list`, string[]>, Record<`${'urgent' | 'video_conference' | 'hide_member_count'}_setting` | 'edit_permission', ChatManagerPermission> {
     chat_mode: 'group';
     chat_type: 'private' | 'public';
+    group_message_type: 'chat' | 'thread';
     i18n_names: TranslationMap;
-    external: boolean;
-    membership_approval: 'no_approval_required' | 'approval_required';
+    membership_approval: `${'no_' | ''}approval_required`;
+    restricted_mode_setting: RestrictedModeSetting;
 }
-export interface ChatMeta extends CreateChatMeta, Record<'tenant_key' | 'chat_id', string>, Record<`${'add_member' | 'at_all' | 'edit' | 'moderation'}_permission`, ChatPermission> {
-    owner_id_type: 'user_id';
-    chat_tag: 'inner';
-    share_card_permission: 'allowed';
+export interface CreateChatOption {
+    user_id_type?: UserIdType;
+    set_bot_manager?: boolean;
+    uuid?: string;
+}
+export interface ChatMeta extends CreateChatMeta, Record<'tenant_key' | 'chat_id', string>, Record<`${'add_member' | 'at_all' | 'moderation'}_permission`, ChatPermission> {
+    owner_id_type: UserIdType;
+    chat_tag: 'inner' | 'tenant' | 'department' | 'edu' | 'meeting' | 'customer_service';
+    external: boolean;
+    share_card_permission: `${'not_' | ''}allowed`;
 }
 export type ChatMessageType = 'text' | 'card';
 export interface SendChatMessage {

package/dist/module/Mail/index.d.ts

@@ -0,0 +1,70 @@
+import { Filter, IDType, ListModel, NewData } from 'mobx-restful';
+import { MailMessage } from './type';
+export * from './type';
+export type MailMessageFilter = Filter<MailMessage> & {
+    folder_id?: string;
+    only_unread?: boolean;
+};
+declare const MailMessageModel_base: (abstract new (...args: any[]) => {
+    stream?: AsyncGenerator<MailMessage, void, any> | undefined;
+    openStream(filter: MailMessageFilter): AsyncGenerator<MailMessage, void, any>;
+    clearList(): void;
+    clear(): void;
+    restoreList({ filter, pageIndex, pageSize, allItems, totalCount }?: Partial<Pick<ListModel<MailMessage, Partial<NewData<MailMessage>>>, "filter" | "pageIndex" | "pageSize" | "allItems" | "totalCount">> | undefined): Promise<void>;
+    loadStream(filter: MailMessageFilter, newCount: number): Promise<MailMessage[]>;
+    loadPage(pageIndex: number, pageSize: number, filter: MailMessageFilter): Promise<{
+        pageData: MailMessage[];
+        totalCount: number;
+    }>;
+    pageIndex: number;
+    pageSize: number;
+    filter: MailMessageFilter;
+    totalCount: number;
+    pageList: MailMessage[][];
+    readonly currentPage: MailMessage[];
+    readonly pageCount: number;
+    readonly allItems: MailMessage[];
+    readonly noMore: boolean;
+    statistic: Partial<Record<import("web-utility").TypeKeys<MailMessage, import("web-utility").IndexKey>, Record<string, number>>>;
+    turnTo(pageIndex: number, pageSize?: number): ListModel<MailMessage, MailMessageFilter>;
+    loadNewPage(pageIndex: number, pageSize: number, filter: MailMessageFilter): Promise<{
+        pageData: MailMessage[];
+        totalCount: number;
+    }>;
+    getList(filter?: MailMessageFilter | undefined, pageIndex?: number, pageSize?: number): Promise<MailMessage[]>;
+    refreshList(): Promise<MailMessage[]>;
+    getAllInStream(filter?: MailMessageFilter | undefined, pageSize?: number): AsyncGenerator<MailMessage, void, unknown>;
+    getAll(filter?: MailMessageFilter | undefined, pageSize?: number): Promise<MailMessage[]>;
+    countAll(keys: import("web-utility").TypeKeys<MailMessage, import("web-utility").IndexKey>[], filter?: MailMessageFilter | undefined, pageSize?: number): Promise<Partial<Record<import("web-utility").TypeKeys<MailMessage, import("web-utility").IndexKey>, Record<string, number>>>>;
+    indexOf(id: IDType): number;
+    changeOne(data: Partial<MailMessage>, id: IDType, patch?: boolean): void;
+    updateOne(data: Partial<NewData<MailMessage>>, id?: IDType): Promise<MailMessage>;
+    removeOne(id: IDType): Promise<void>;
+    deleteOne(id: IDType): Promise<void>;
+    client: import("mobx-restful").RESTClient;
+    baseURI: string;
+    indexKey: "message_id" | "smtp_message_id" | "body_plain_text" | "body_html" | "thread_id" | "internal_date" | "subject" | "to" | "cc" | "bcc" | "dedupe_key" | "message_state" | "head_from" | "raw" | "attachments";
+    currentOne: MailMessage;
+    clearCurrent(): void;
+    getOne(id: IDType): Promise<MailMessage>;
+    downloading: number;
+    uploading: number;
+    [Symbol.asyncIterator]: (filter?: MailMessageFilter | undefined, pageSize?: number) => AsyncGenerator<MailMessage, void, unknown>;
+}) & import("web-utility").AbstractClass<ListModel<MailMessage, MailMessageFilter>>;
+export declare abstract class MailMessageModel extends MailMessageModel_base {
+    mailboxId: string;
+    baseURI: string;
+    constructor(mailboxId: string);
+    /**
+     * @see {@link https://open.feishu.cn/document/mail-v1/user_mailbox-message/list}
+     */
+    openStream(filter?: MailMessageFilter): AsyncGenerator<MailMessage, void, unknown>;
+    /**
+     * @see {@link https://open.feishu.cn/document/mail-v1/user_mailbox-message/get}
+     */
+    getOne(id: IDType): Promise<MailMessage>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/mail-v1/user_mailbox-message/send}
+     */
+    updateOne(mail: Partial<NewData<MailMessage>>): Promise<MailMessage>;
+}

package/dist/module/Mail/type.d.ts

@@ -0,0 +1,27 @@
+export interface MailAddress {
+    mail_address: string;
+    name?: string;
+}
+export declare enum MailAttachmentType {
+    Normal = 1,
+    Large = 2
+}
+export interface MailAttachment {
+    attachment_type: MailAttachmentType;
+    id: string;
+    cid?: string;
+    filename: string;
+    is_inline: boolean;
+}
+export declare enum MailMessageState {
+    Received = 1,
+    Sent = 2,
+    Draft = 3
+}
+export type MailMessage = Record<`${'smtp_' | ''}message_id` | 'thread_id' | 'internal_date' | 'subject' | `body_${'plain_text' | 'html'}`, string> & Record<'to' | 'cc' | 'bcc', MailAddress[]> & {
+    dedupe_key?: string;
+    message_state: MailMessageState;
+    head_from: MailAddress;
+    raw?: string;
+    attachments: MailAttachment[];
+};

package/dist/module/base.d.ts

@@ -1,2 +1,2 @@
 import { DataObject, RESTClient } from 'mobx-restful';
-export declare function createPageStream<T extends DataObject>(client: RESTClient, path: string, onCount: (total: number) => any, filter?: DataObject): AsyncGenerator<T, void, unknown>;
+export declare function createPageStream<T = DataObject>(client: RESTClient, path: string, onCount: (total: number) => any, filter?: DataObject): AsyncGenerator<Awaited<T>, void, unknown>;

package/dist/module/index.d.ts

@@ -1,6 +1,7 @@
 export * from './base';
 export * from './User/type';
 export * from './InstantMessenger';
+export * from './Mail';
 export * from './Task';
 export * from './Document';
 export * from './SpreadSheet';

package/dist/type.d.ts

@@ -8,7 +8,7 @@ export type LarkData<D extends Record<string, any> = {}, E extends Record<string
         [key: string]: any;
     };
 };
-export type LarkPageData<D extends Record<string, any> = {}> = LarkData<{
+export type LarkPageData<D = {}> = LarkData<{
     page_token: string;
     items: D[];
     has_more: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.6.4",
+    "version": "2.7.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",
@@ -25,8 +25,8 @@
         "url": "https://github.com/idea2app/MobX-Lark/issues"
     },
     "dependencies": {
-        "@swc/helpers": "^0.5.18",
-        "@types/react": "^19.2.7",
+        "@swc/helpers": "^0.5.19",
+        "@types/react": "^19.2.14",
         "koajax": "^3.1.2",
         "lodash.memoize": "^4.1.2",
         "mobx": "^6.15.0",
@@ -38,25 +38,25 @@
         "react": ">=16"
     },
     "devDependencies": {
-        "@parcel/config-default": "~2.16.3",
-        "@parcel/transformer-typescript-tsc": "~2.16.3",
+        "@parcel/config-default": "~2.16.4",
+        "@parcel/transformer-typescript-tsc": "~2.16.4",
         "@types/fs-extra": "^11.0.4",
         "@types/lodash.memoize": "^4.1.9",
-        "@types/node": "^22.19.3",
+        "@types/node": "^24.10.13",
         "@types/react-dom": "^19.2.3",
         "@types/turndown": "^5.0.6",
-        "dotenv": "^17.2.3",
+        "dotenv": "^17.3.1",
         "fs-extra": "^11.3.3",
         "husky": "^9.1.7",
         "lint-staged": "^16.2.7",
-        "parcel": "~2.16.3",
-        "prettier": "^3.7.4",
-        "react": "^19.2.3",
-        "react-dom": "^19.2.3",
+        "parcel": "~2.16.4",
+        "prettier": "^3.8.1",
+        "react": "^19.2.4",
+        "react-dom": "^19.2.4",
         "ts-node": "^10.9.2",
         "turndown": "^7.2.2",
-        "typedoc": "^0.28.15",
-        "typedoc-plugin-mdn-links": "^5.0.10",
+        "typedoc": "^0.28.17",
+        "typedoc-plugin-mdn-links": "^5.1.1",
         "typescript": "~5.8.3"
     },
     "pnpm": {

package/src/module/InstantMessenger/index.ts

@@ -3,7 +3,7 @@ import { buildURLData } from 'web-utility';
 
 import { LarkData } from '../../type';
 import { createPageStream } from '../base';
-import { ChatMessage, ChatMeta, SendChatMessage } from './type';
+import { ChatMessage, ChatMeta, CreateChatOption, SendChatMessage } from './type';
 
 export * from './type';
 
@@ -22,16 +22,19 @@ export abstract class ChatListModel extends Stream<ChatMeta>(ListModel) {
     }
 
     /**
-     * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create
+     * @see {@link https://open.feishu.cn/document/server-docs/group/chat/create}
+     * @see {@link https://open.feishu.cn/document/server-docs/group/chat/update-2}
      */
     @toggle('uploading')
-    async updateOne({ chat_id }: NewData<ChatMeta>) {
+    async updateOne(
+        { chat_id, ...data }: Partial<NewData<ChatMeta>>,
+        option: CreateChatOption = {}
+    ) {
         const { body } = await (chat_id
-            ? this.client.put<LarkData<ChatMeta>>(`${this.baseURI}/chats/${chat_id}`)
+            ? this.client.put<LarkData<ChatMeta>>(`${this.baseURI}/${chat_id}`, data)
             : this.client.post<LarkData<ChatMeta>>(
-                  `${this.baseURI}/chats?${buildURLData({
-                      set_bot_manager: true
-                  })}`
+                  `${this.baseURI}?${buildURLData(option)}`,
+                  data
               ));
         return (this.currentOne = body!.data!);
     }

package/src/module/InstantMessenger/type/index.ts

@@ -1,31 +1,53 @@
 import { TranslationMap } from '../../../type';
+import { UserIdType } from '../../User/type';
 import { ChatMessageContent } from './message';
 
 export * from './message';
 
 export type ChatPermission = 'all_members' | 'only_owner' | 'not_anyone';
 
+export type ChatManagerPermission = Exclude<ChatPermission, 'not_anyone'>;
+
+export type ChatMemberPermission = Exclude<ChatPermission, 'only_owner'>;
+
+export interface RestrictedModeSetting extends Partial<
+    Record<`${'screenshot' | 'download' | 'message'}_has_permission_setting`, ChatMemberPermission>
+> {
+    status?: boolean;
+}
+
 export interface CreateChatMeta
-    extends Record<'owner_id' | 'avatar' | 'name' | 'description', string>,
+    extends
+        Record<'owner_id' | 'avatar' | 'name' | 'description', string>,
         Record<`${'join' | 'leave'}_message_visibility`, ChatPermission>,
-        Record<`${'user' | 'bot'}_id_list`, string[]> {
+        Record<`${'user' | 'bot'}_id_list`, string[]>,
+        Record<
+            `${'urgent' | 'video_conference' | 'hide_member_count'}_setting` | 'edit_permission',
+            ChatManagerPermission
+        > {
     chat_mode: 'group';
     chat_type: 'private' | 'public';
+    group_message_type: 'chat' | 'thread';
     i18n_names: TranslationMap;
-    external: boolean;
-    membership_approval: 'no_approval_required' | 'approval_required';
+    membership_approval: `${'no_' | ''}approval_required`;
+    restricted_mode_setting: RestrictedModeSetting;
+}
+
+export interface CreateChatOption {
+    user_id_type?: UserIdType;
+    set_bot_manager?: boolean;
+    uuid?: string;
 }
 
 export interface ChatMeta
-    extends CreateChatMeta,
+    extends
+        CreateChatMeta,
         Record<'tenant_key' | 'chat_id', string>,
-        Record<
-            `${'add_member' | 'at_all' | 'edit' | 'moderation'}_permission`,
-            ChatPermission
-        > {
-    owner_id_type: 'user_id';
-    chat_tag: 'inner';
-    share_card_permission: 'allowed';
+        Record<`${'add_member' | 'at_all' | 'moderation'}_permission`, ChatPermission> {
+    owner_id_type: UserIdType;
+    chat_tag: 'inner' | 'tenant' | 'department' | 'edu' | 'meeting' | 'customer_service';
+    external: boolean;
+    share_card_permission: `${'not_' | ''}allowed`;
 }
 
 export type ChatMessageType = 'text' | 'card';
@@ -45,13 +67,11 @@ export type ChatMetion = Pick<ChatSender, 'id' | 'id_type' | 'tenant_key'> &
     Record<'key' | 'name', string>;
 
 export interface ChatMessage
-    extends Pick<SendChatMessage, 'msg_type'>,
+    extends
+        Pick<SendChatMessage, 'msg_type'>,
         Record<`${'create' | 'update'}_time`, string>,
         Record<'deleted' | 'updated', boolean>,
-        Record<
-            `${'chat' | 'message' | 'upper_message' | 'root' | 'parent'}_id`,
-            string
-        > {
+        Record<`${'chat' | 'message' | 'upper_message' | 'root' | 'parent'}_id`, string> {
     sender: ChatSender;
     mentions: ChatMetion[];
     body: {

package/src/module/Mail/index.ts

@@ -0,0 +1,57 @@
+import { Filter, IDType, ListModel, NewData, Stream, toggle } from 'mobx-restful';
+
+import { LarkData } from '../../type';
+import { createPageStream } from '../base';
+import { MailMessage } from './type';
+
+export * from './type';
+
+export type MailMessageFilter = Filter<MailMessage> & {
+    folder_id?: string;
+    only_unread?: boolean;
+};
+
+export abstract class MailMessageModel extends Stream<MailMessage, MailMessageFilter>(ListModel) {
+    baseURI = '';
+
+    constructor(public mailboxId: string) {
+        super();
+        this.baseURI = `mail/v1/user_mailboxes/${mailboxId}/messages`;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/mail-v1/user_mailbox-message/list}
+     */
+    async *openStream(filter: MailMessageFilter = { folder_id: 'INBOX' }) {
+        const stream = createPageStream<string>(
+            this.client,
+            this.baseURI,
+            total => (this.totalCount = total),
+            filter
+        );
+        for await (const message_id of stream) yield this.getOne(message_id);
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/mail-v1/user_mailbox-message/get}
+     */
+    @toggle('downloading')
+    async getOne(id: IDType) {
+        const { body } = await this.client.get<LarkData<{ message: MailMessage }>>(
+            `${this.baseURI}/${id}`
+        );
+        return (this.currentOne = body!.data!.message);
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/mail-v1/user_mailbox-message/send}
+     */
+    @toggle('uploading')
+    async updateOne(mail: Partial<NewData<MailMessage>>) {
+        const { body } = await this.client.post<
+            LarkData<Record<`${'message' | 'thread'}_id`, string>>
+        >(`${this.baseURI}/send`, mail);
+
+        return (this.currentOne = await this.getOne(body!.data!.message_id));
+    }
+}

package/src/module/Mail/type.ts

@@ -0,0 +1,39 @@
+export interface MailAddress {
+    mail_address: string;
+    name?: string;
+}
+
+export enum MailAttachmentType {
+    Normal = 1,
+    Large = 2
+}
+
+export interface MailAttachment {
+    attachment_type: MailAttachmentType;
+    id: string;
+    cid?: string;
+    filename: string;
+    is_inline: boolean;
+}
+
+export enum MailMessageState {
+    Received = 1,
+    Sent = 2,
+    Draft = 3
+}
+
+export type MailMessage = Record<
+    | `${'smtp_' | ''}message_id`
+    | 'thread_id'
+    | 'internal_date'
+    | 'subject'
+    | `body_${'plain_text' | 'html'}`,
+    string
+> &
+    Record<'to' | 'cc' | 'bcc', MailAddress[]> & {
+        dedupe_key?: string;
+        message_state: MailMessageState;
+        head_from: MailAddress;
+        raw?: string;
+        attachments: MailAttachment[];
+    };

package/src/module/base.ts

@@ -3,7 +3,7 @@ import { buildURLData } from 'web-utility';
 
 import { LarkPageData } from '../type';
 
-export async function* createPageStream<T extends DataObject>(
+export async function* createPageStream<T = DataObject>(
     client: RESTClient,
     path: string,
     onCount: (total: number) => any,

package/src/module/index.ts

@@ -1,6 +1,7 @@
 export * from './base';
 export * from './User/type';
 export * from './InstantMessenger';
+export * from './Mail';
 export * from './Task';
 export * from './Document';
 export * from './SpreadSheet';

package/src/type.ts

@@ -10,7 +10,7 @@ export type LarkData<D extends Record<string, any> = {}, E extends Record<string
     };
 };
 
-export type LarkPageData<D extends Record<string, any> = {}> = LarkData<{
+export type LarkPageData<D = {}> = LarkData<{
     page_token: string;
     items: D[];
     has_more: boolean;