mobx-lark 2.7.0 → 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/index.d.ts

@@ -8,3 +8,4 @@ export * from './SpreadSheet';
 export * from './BITable';
 export * from './Drive';
 export * from './Wiki';
+export * from './DocumentAI';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.7.0",
+    "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.19",
+        "@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.17",
+        "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/index.ts

@@ -8,3 +8,4 @@ export * from './SpreadSheet';
 export * from './BITable';
 export * from './Drive';
 export * from './Wiki';
+export * from './DocumentAI';