mobx-lark 2.6.5 → 2.8.0

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

@@ -11,7 +11,7 @@ export interface TableView extends Record<'view_id' | 'view_name', string> {
     view_type: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
 }
 export interface TableFormView extends Record<'name' | 'description' | 'shared_url', string>, Record<'shared' | 'submit_limit_once', boolean> {
-    shared_limit: 'tenant_editable';
+    shared_limit: 'off' | `${'tenant' | 'anyone'}_editable`;
 }
 export type LarkFormData = LarkData<{
     form: TableFormView;

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

@@ -0,0 +1,31 @@
+import { BaseModel, RESTClient } from 'mobx-restful';
+import { TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
+export * from './type';
+export declare abstract class DocumentAIModel extends BaseModel {
+    baseURI: string;
+    abstract client: RESTClient;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/vat_invoice/recognize}
+     */
+    recognizeVatInvoices(file: File): Promise<{
+        entities: VatInvoice[];
+    }[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/taxi_invoice/recognize}
+     */
+    recognizeTaxiInvoices(file: File): Promise<{
+        entities: TaxiInvoice[];
+    }[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/train_invoice/recognize}
+     */
+    recognizeTrainInvoices(file: File): Promise<{
+        entities: TrainInvoice[];
+    }[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/vehicle_invoice/recognize}
+     */
+    recognizeVehicleInvoice(file: File): Promise<{
+        entities: VehicleInvoice[];
+    }>;
+}

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

@@ -0,0 +1,19 @@
+export type InvoiceEntityType = `invoice_${'code' | 'no' | 'special_seal'}` | `seller_${'name' | 'taxpayer_no'}_in_seal`;
+export type TrafficInvoiceEntityType = 'total_amount' | 'price';
+export interface VatInvoice {
+    type: InvoiceEntityType | `invoice_${'name' | 'date'}` | `total_${'price' | 'tax'}` | `${'big_' | ''}total_price_and_tax` | 'check_code' | `buyer_${'name' | 'taxpayer_no' | 'address_phone' | 'account'}` | `seller_${'name' | 'taxpayer_no' | 'address_phone' | 'account'}` | 'payee' | 'password_area' | 'remarks' | 'reviewer' | 'drawer' | 'is_sealed' | 'machine_num';
+    value: string;
+    items: Record<'type' | 'value', string>[][];
+}
+export interface TaxiInvoice {
+    type: InvoiceEntityType | TrafficInvoiceEntityType | 'car_number' | 'start_date' | `${'start' | 'end'}_time` | 'distance' | `${'dispatch' | 'additional'}_fee` | 'is_sealed' | 'title_trial';
+    value: string;
+}
+export interface TrainInvoice {
+    type: TrafficInvoiceEntityType | 'name' | 'id_num' | 'time' | `${'start' | 'end'}_station` | `sale_${'num' | 'station'}` | `${'train' | 'seat' | 'ticket'}_num` | `seat_${'num' | 'cls'}`;
+    value: string;
+}
+export interface VehicleInvoice {
+    type: 'date' | `invoice_${'code' | 'num'}` | `print_${'code' | 'num'}` | `buyer_${'name' | 'id'}` | `saler_${'name' | 'id' | 'addr'}` | 'vehicle_type' | 'product_model' | `${'certificate' | 'machine' | 'engine'}_num` | 'vin' | `tax${'' | '_rate'}` | 'price' | `total_price${'' | '_little'}`;
+    value: string;
+}

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

@@ -57,7 +57,7 @@ export declare abstract class ChatListModel extends ChatListModel_base {
      * @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, ...data }: NewData<ChatMeta>, option?: CreateChatOption): 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/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,9 +1,11 @@
 export * from './base';
 export * from './User/type';
 export * from './InstantMessenger';
+export * from './Mail';
 export * from './Task';
 export * from './Document';
 export * from './SpreadSheet';
 export * from './BITable';
 export * from './Drive';
 export * from './Wiki';
+export * from './DocumentAI';

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.5",
+    "version": "2.8.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",
@@ -25,9 +25,9 @@
         "url": "https://github.com/idea2app/MobX-Lark/issues"
     },
     "dependencies": {
-        "@swc/helpers": "^0.5.18",
+        "@swc/helpers": "^0.5.20",
         "@types/react": "^19.2.14",
-        "koajax": "^3.1.2",
+        "koajax": "^3.3.0",
         "lodash.memoize": "^4.1.2",
         "mobx": "^6.15.0",
         "mobx-restful": "^2.1.4",
@@ -42,20 +42,20 @@
         "@parcel/transformer-typescript-tsc": "~2.16.4",
         "@types/fs-extra": "^11.0.4",
         "@types/lodash.memoize": "^4.1.9",
-        "@types/node": "^24.10.13",
+        "@types/node": "^24.12.0",
         "@types/react-dom": "^19.2.3",
         "@types/turndown": "^5.0.6",
         "dotenv": "^17.3.1",
-        "fs-extra": "^11.3.3",
+        "fs-extra": "^11.3.4",
         "husky": "^9.1.7",
-        "lint-staged": "^16.2.7",
+        "lint-staged": "^16.4.0",
         "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.16",
+        "typedoc": "^0.28.18",
         "typedoc-plugin-mdn-links": "^5.1.1",
         "typescript": "~5.8.3"
     },

package/src/Lark.ts

@@ -6,6 +6,7 @@ import {
     BiTableSchema,
     BiTableView,
     CopiedFile,
+    DocumentAIModel,
     DocumentModel,
     DriveFileModel,
     TableFormView,
@@ -51,6 +52,7 @@ export class LarkApp implements LarkAppOption {
     driveFileStore: DriveFileModel;
     wikiNodeStore: WikiNodeModel;
     documentStore: DocumentModel;
+    documentAIStore: DocumentAIModel;
 
     constructor(option: LarkAppServerOption | LarkAppClientOption) {
         Object.assign(this, option);
@@ -74,6 +76,9 @@ export class LarkApp implements LarkAppOption {
         this.documentStore = new (class extends DocumentModel {
             client = client;
         })('');
+        this.documentAIStore = new (class extends DocumentAIModel {
+            client = client;
+        })();
     }
 
     private boot() {

package/src/module/BITable/type.ts

@@ -18,7 +18,7 @@ export interface TableFormView
     extends
         Record<'name' | 'description' | 'shared_url', string>,
         Record<'shared' | 'submit_limit_once', boolean> {
-    shared_limit: 'tenant_editable';
+    shared_limit: 'off' | `${'tenant' | 'anyone'}_editable`;
 }
 
 export type LarkFormData = LarkData<{ form: TableFormView }>;

package/src/module/DocumentAI/index.ts

@@ -0,0 +1,61 @@
+import { makeFormData } from 'koajax';
+import { BaseModel, RESTClient, toggle } from 'mobx-restful';
+
+import { LarkData } from '../../type';
+import { TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
+
+export * from './type';
+
+export abstract class DocumentAIModel extends BaseModel {
+    baseURI = 'document_ai/v1';
+
+    abstract client: RESTClient;
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/vat_invoice/recognize}
+     */
+    @toggle('uploading')
+    async recognizeVatInvoices(file: File) {
+        const { body } = await this.client.post<
+            LarkData<{ vat_invoices: { entities: VatInvoice[] }[] }>
+        >(`${this.baseURI}/vat_invoice/recognize`, makeFormData({ file }));
+
+        return body!.data!.vat_invoices;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/taxi_invoice/recognize}
+     */
+    @toggle('uploading')
+    async recognizeTaxiInvoices(file: File) {
+        const { body } = await this.client.post<
+            LarkData<{ taxi_invoices: { entities: TaxiInvoice[] }[] }>
+        >(`${this.baseURI}/taxi_invoice/recognize`, makeFormData({ file }));
+
+        return body!.data!.taxi_invoices;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/train_invoice/recognize}
+     */
+    @toggle('uploading')
+    async recognizeTrainInvoices(file: File) {
+        const { body } = await this.client.post<
+            LarkData<{ train_invoices: { entities: TrainInvoice[] }[] }>
+        >(`${this.baseURI}/train_invoice/recognize`, makeFormData({ file }));
+
+        return body!.data!.train_invoices;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/vehicle_invoice/recognize}
+     */
+    @toggle('uploading')
+    async recognizeVehicleInvoice(file: File) {
+        const { body } = await this.client.post<
+            LarkData<{ vehicle_invoice: { entities: VehicleInvoice[] } }>
+        >(`${this.baseURI}/vehicle_invoice/recognize`, makeFormData({ file }));
+
+        return body!.data!.vehicle_invoice;
+    }
+}

package/src/module/DocumentAI/type.ts

@@ -0,0 +1,69 @@
+export type InvoiceEntityType =
+    | `invoice_${'code' | 'no' | 'special_seal'}`
+    | `seller_${'name' | 'taxpayer_no'}_in_seal`;
+
+export type TrafficInvoiceEntityType = 'total_amount' | 'price';
+
+export interface VatInvoice {
+    type:
+        | InvoiceEntityType
+        | `invoice_${'name' | 'date'}`
+        | `total_${'price' | 'tax'}`
+        | `${'big_' | ''}total_price_and_tax`
+        | 'check_code'
+        | `buyer_${'name' | 'taxpayer_no' | 'address_phone' | 'account'}`
+        | `seller_${'name' | 'taxpayer_no' | 'address_phone' | 'account'}`
+        | 'payee'
+        | 'password_area'
+        | 'remarks'
+        | 'reviewer'
+        | 'drawer'
+        | 'is_sealed'
+        | 'machine_num';
+    value: string;
+    items: Record<'type' | 'value', string>[][];
+}
+
+export interface TaxiInvoice {
+    type:
+        | InvoiceEntityType
+        | TrafficInvoiceEntityType
+        | 'car_number'
+        | 'start_date'
+        | `${'start' | 'end'}_time`
+        | 'distance'
+        | `${'dispatch' | 'additional'}_fee`
+        | 'is_sealed'
+        | 'title_trial';
+    value: string;
+}
+
+export interface TrainInvoice {
+    type:
+        | TrafficInvoiceEntityType
+        | 'name'
+        | 'id_num'
+        | 'time'
+        | `${'start' | 'end'}_station`
+        | `sale_${'num' | 'station'}`
+        | `${'train' | 'seat' | 'ticket'}_num`
+        | `seat_${'num' | 'cls'}`;
+    value: string;
+}
+
+export interface VehicleInvoice {
+    type:
+        | 'date'
+        | `invoice_${'code' | 'num'}`
+        | `print_${'code' | 'num'}`
+        | `buyer_${'name' | 'id'}`
+        | `saler_${'name' | 'id' | 'addr'}`
+        | 'vehicle_type'
+        | 'product_model'
+        | `${'certificate' | 'machine' | 'engine'}_num`
+        | 'vin'
+        | `tax${'' | '_rate'}`
+        | 'price'
+        | `total_price${'' | '_little'}`;
+    value: string;
+}

package/src/module/InstantMessenger/index.ts

@@ -26,7 +26,10 @@ export abstract class ChatListModel extends Stream<ChatMeta>(ListModel) {
      * @see {@link https://open.feishu.cn/document/server-docs/group/chat/update-2}
      */
     @toggle('uploading')
-    async updateOne({ chat_id, ...data }: NewData<ChatMeta>, option: CreateChatOption = {}) {
+    async updateOne(
+        { chat_id, ...data }: Partial<NewData<ChatMeta>>,
+        option: CreateChatOption = {}
+    ) {
         const { body } = await (chat_id
             ? this.client.put<LarkData<ChatMeta>>(`${this.baseURI}/${chat_id}`, data)
             : this.client.post<LarkData<ChatMeta>>(

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,9 +1,11 @@
 export * from './base';
 export * from './User/type';
 export * from './InstantMessenger';
+export * from './Mail';
 export * from './Task';
 export * from './Document';
 export * from './SpreadSheet';
 export * from './BITable';
 export * from './Drive';
 export * from './Wiki';
+export * from './DocumentAI';

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;