mobx-lark 2.8.1 → 2.9.0

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

@@ -97,7 +97,7 @@ export declare function BiDataTable<D extends DataObject, F extends Filter<D> =
 export type BiSearchFilter<D extends DataObject> = Filter<D> & {
     keywords?: string;
 };
-export declare function BiSearch<D extends DataObject, F extends BiSearchFilter<D> = BiSearchFilter<D>>(Model: ReturnType<typeof BiDataTable<D, F>>): abstract new (appId: string, tableId: string) => {
+export declare function BiSearch<D extends DataObject, F extends BiSearchFilter<D> = BiSearchFilter<D>, M extends ReturnType<typeof BiDataTable<D, F>> = ReturnType<typeof BiDataTable<D, F>>>(Model: M): abstract new (appId: string, tableId: string) => {
     baseURI: string;
     client: RESTClient;
     searchKeys: readonly (keyof TableRecordFields)[];

package/dist/module/Document/component/Block.d.ts

@@ -6,4 +6,4 @@ export declare function registerBlocks<T extends Block<any, any, any>>(blocks: T
 export declare const ChildrenRenderer: FC<{
     children?: string[];
 }>;
-export declare function renderBlocks(blocks: Block<any, any, any>[]): import("react/jsx-runtime").JSX.Element;
+export declare function renderBlocks(blocks: Block<any, any, any>[]): import("react").JSX.Element;

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

@@ -1,5 +1,5 @@
 import { BaseModel, RESTClient } from 'mobx-restful';
-import { TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
+import { BankCardEntity, Contract, Resume, TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
 export * from './type';
 export declare abstract class DocumentAIModel extends BaseModel {
     baseURI: string;
@@ -28,4 +28,20 @@ export declare abstract class DocumentAIModel extends BaseModel {
     recognizeVehicleInvoice(file: File): Promise<{
         entities: VehicleInvoice[];
     }>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/optical_char_recognition-v1/basic_recognize}
+     */
+    recognizeText(image: File): Promise<string[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/bank_card/recognize}
+     */
+    recognizeBankCard(file: File): Promise<BankCardEntity[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/resume/parse}
+     */
+    parseResume(file: File): Promise<Resume[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/document_ai-v1/contract/field_extraction}
+     */
+    extractContract(file: File, ocr_mode?: 'unused' | 'force' | 'auto', pdf_page_limit?: number): Promise<Contract>;
 }

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

@@ -1,3 +1,4 @@
+import { Gender } from '../User/type';
 export type InvoiceEntityType = `invoice_${'code' | 'no' | 'special_seal'}` | `seller_${'name' | 'taxpayer_no'}_in_seal`;
 export type TrafficInvoiceEntityType = 'total_amount' | 'price';
 export interface VatInvoice {
@@ -17,3 +18,83 @@ 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;
 }
+export interface BankCardEntity {
+    type: 'card_number' | 'date_of_expiry';
+    value: string;
+}
+export type ResumePeriod = Record<`${'start' | 'end'}_${'date' | 'time'}`, string>;
+export declare enum EducationQualification {
+    PrimarySchool = 1,
+    JuniorHighSchool = 2,
+    VocationalHighSchool = 3,
+    HighSchool = 4,
+    AssociateDegree = 5,
+    BachelorDegree = 6,
+    MasterDegree = 7,
+    Doctorate = 8,
+    Other = 9
+}
+export interface ResumeEducation extends ResumePeriod, Record<'school' | 'major' | 'degree', string> {
+    qualification: EducationQualification;
+}
+export declare enum CareerType {
+    Internship = 1,
+    FullTime = 2
+}
+export interface ResumeCareer extends ResumePeriod, Record<'company' | 'title' | 'type_str' | 'job_description', string> {
+    type: CareerType;
+}
+export type ResumeProject = ResumePeriod & Record<'name' | 'title' | 'description', string>;
+export interface ResumeLanguage {
+    level: number;
+    description: string;
+}
+export type ResumeAward = Record<'award' | 'date' | 'description', string>;
+export type ResumeCertificate = Record<'name' | 'desc', string>;
+export type ResumeCompetition = ResumeCertificate;
+export interface Resume extends Record<'file_md5' | `${'' | 'new_'}content` | 'name' | 'email' | 'mobile' | 'country_code' | 'date_of_birth' | `${'current' | 'home'}_location` | 'self_evaluation', string>, Record<`willing_${'positions' | 'locations'}` | 'urls' | 'social_links', string[]> {
+    mobile_is_virtual: boolean;
+    educations: ResumeEducation[];
+    careers: ResumeCareer[];
+    projects: ResumeProject[];
+    work_year: number | null;
+    gender: Gender;
+    languages: ResumeLanguage[];
+    awards: ResumeAward[];
+    certificates: ResumeCertificate[];
+    competitions: ResumeCompetition[];
+}
+export interface ContractPrice {
+    contract_price: number;
+    contract_price_original: string;
+    text: string;
+}
+export type ContractInitialTerm = Record<`initial_${'time' | 'unit'}`, string>;
+export interface ContractTime extends Record<`${'' | 'original_'}time_${'start' | 'end'}` | `text_${'start' | 'end' | 'initial_term'}`, string> {
+    initial_term: ContractInitialTerm;
+}
+export interface ContractCopy extends Record<'original_copy' | 'key' | 'text', string> {
+    copy_num: number;
+}
+export type ContractCurrency = Record<`currency_${'name' | 'text'}`, string>;
+export type ContractBodyType = 'buy' | 'sell' | 'third';
+export type ContractContact = Record<'contacts' | 'id_number' | 'phone' | 'email' | 'address', string>;
+export type ContractBodyEntity = ContractContact & Record<'legal_representative' | 'party', string>;
+export interface ContractBodyInfo {
+    body_type: ContractBodyType;
+    value: ContractBodyEntity;
+}
+export type ContractBankType = `${'buy' | 'sell' | 'third' | 'uncertain'}_bank`;
+export type ContractBankEntity = ContractContact & Record<'bank_name' | `account_${'name' | 'number'}` | 'tax_number', string>;
+export interface ContractBankInfo {
+    bank_type: ContractBankType;
+    value: ContractBankEntity;
+}
+export interface Contract extends Record<'file_id' | 'header', string> {
+    price: ContractPrice;
+    time: ContractTime;
+    copy: ContractCopy;
+    currency: ContractCurrency;
+    body_info: ContractBodyInfo[];
+    bank_info: ContractBankInfo[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.8.1",
+    "version": "2.9.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",
@@ -25,14 +25,14 @@
         "url": "https://github.com/idea2app/MobX-Lark/issues"
     },
     "dependencies": {
-        "@swc/helpers": "^0.5.21",
-        "@types/react": "^19.2.14",
+        "@swc/helpers": "^0.5.23",
+        "@types/react": "^19.2.17",
         "koajax": "^3.3.0",
         "lodash.memoize": "^4.1.2",
-        "mobx": "^6.15.0",
+        "mobx": "^6.16.1",
         "mobx-restful": "^2.1.4",
         "regenerator-runtime": "^0.14.1",
-        "web-utility": "^4.6.5"
+        "web-utility": "^4.6.6"
     },
     "peerDependencies": {
         "react": ">=16"
@@ -42,31 +42,23 @@
         "@parcel/transformer-typescript-tsc": "~2.16.4",
         "@types/fs-extra": "^11.0.4",
         "@types/lodash.memoize": "^4.1.9",
-        "@types/node": "^24.12.2",
+        "@types/node": "^24.13.2",
         "@types/react-dom": "^19.2.3",
         "@types/turndown": "^5.0.6",
-        "dotenv": "^17.4.0",
-        "fs-extra": "^11.3.4",
+        "dotenv": "^17.4.2",
+        "fs-extra": "^11.3.5",
         "husky": "^9.1.7",
-        "lint-staged": "^16.4.0",
+        "lint-staged": "^17.0.7",
         "parcel": "~2.16.4",
-        "prettier": "^3.8.1",
-        "react": "^19.2.4",
-        "react-dom": "^19.2.4",
+        "prettier": "^3.8.4",
+        "react": "^19.2.7",
+        "react-dom": "^19.2.7",
         "ts-node": "^10.9.2",
         "turndown": "^7.2.4",
-        "typedoc": "^0.28.18",
+        "typedoc": "^0.28.19",
         "typedoc-plugin-mdn-links": "^5.1.1",
         "typescript": "~5.8.3"
     },
-    "pnpm": {
-        "onlyBuiltDependencies": [
-            "@parcel/watcher",
-            "@swc/core",
-            "lmdb",
-            "msgpackr-extract"
-        ]
-    },
     "prettier": {
         "singleQuote": true,
         "trailingComma": "none",

package/pnpm-workspace.yaml

@@ -0,0 +1,9 @@
+packages:
+    - .
+autoInstallPeers: false
+allowBuilds:
+    '@parcel/watcher': true
+    '@swc/core': true
+    core-js: true
+    lmdb: true
+    msgpackr-extract: true

package/src/Lark.ts

@@ -39,7 +39,7 @@ export interface LarkAppClientOption extends LarkAppBaseOption {
     accessToken: string;
 }
 
-export interface LarkAppOption extends LarkAppServerOption, LarkAppClientOption {}
+export type LarkAppOption = LarkAppServerOption & LarkAppClientOption;
 
 export class LarkApp implements LarkAppOption {
     host = 'https://open.feishu.cn/open-apis/';

package/src/module/BITable/index.ts

@@ -177,10 +177,12 @@ export type BiSearchFilter<D extends DataObject> = Filter<D> & {
     keywords?: string;
 };
 
-export function BiSearch<D extends DataObject, F extends BiSearchFilter<D> = BiSearchFilter<D>>(
-    Model: ReturnType<typeof BiDataTable<D, F>>
-) {
-    abstract class BiSearchModel extends Model {
+export function BiSearch<
+    D extends DataObject,
+    F extends BiSearchFilter<D> = BiSearchFilter<D>,
+    M extends ReturnType<typeof BiDataTable<D, F>> = ReturnType<typeof BiDataTable<D, F>>
+>(Model: M) {
+    abstract class BiSearchModel extends (Model as ReturnType<typeof BiDataTable<D, F>>) {
         declare baseURI: string;
         declare client: RESTClient;
 

package/src/module/DocumentAI/index.ts

@@ -1,8 +1,16 @@
-import { makeFormData } from 'koajax';
+import { makeFormData, readAs } from 'koajax';
 import { BaseModel, RESTClient, toggle } from 'mobx-restful';
 
 import { LarkData } from '../../type';
-import { TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
+import {
+    BankCardEntity,
+    Contract,
+    Resume,
+    TaxiInvoice,
+    TrainInvoice,
+    VatInvoice,
+    VehicleInvoice
+} from './type';
 
 export * from './type';
 
@@ -58,4 +66,60 @@ export abstract class DocumentAIModel extends BaseModel {
 
         return body!.data!.vehicle_invoice;
     }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/optical_char_recognition-v1/basic_recognize}
+     */
+    @toggle('uploading')
+    async recognizeText(image: File) {
+        const URI = (await readAs(image, 'dataURL').result) as string;
+
+        const [, base64] = URI.split(',');
+
+        const { body } = await this.client.post<LarkData<{ text_list: string[] }>>(
+            'optical_char_recognition/v1/image/basic_recognize',
+            { image: base64 }
+        );
+        return body!.data!.text_list;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/bank_card/recognize}
+     */
+    @toggle('uploading')
+    async recognizeBankCard(file: File) {
+        const { body } = await this.client.post<
+            LarkData<{ bank_card: { entities: BankCardEntity[] } }>
+        >(`${this.baseURI}/bank_card/recognize`, makeFormData({ file }));
+
+        return body!.data!.bank_card.entities;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/resume/parse}
+     */
+    @toggle('uploading')
+    async parseResume(file: File) {
+        const { body } = await this.client.post<LarkData<{ resumes: Resume[] }>>(
+            `${this.baseURI}/resume/parse`,
+            makeFormData({ file })
+        );
+        return body!.data!.resumes;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/document_ai-v1/contract/field_extraction}
+     */
+    @toggle('uploading')
+    async extractContract(
+        file: File,
+        ocr_mode: 'unused' | 'force' | 'auto' = 'auto',
+        pdf_page_limit = 100
+    ) {
+        const { body } = await this.client.post<LarkData<Contract>>(
+            `${this.baseURI}/contract/field_extraction`,
+            makeFormData({ file, ocr_mode, pdf_page_limit })
+        );
+        return body!.data!;
+    }
 }

package/src/module/DocumentAI/type.ts

@@ -1,3 +1,5 @@
+import { Gender } from '../User/type';
+
 export type InvoiceEntityType =
     | `invoice_${'code' | 'no' | 'special_seal'}`
     | `seller_${'name' | 'taxpayer_no'}_in_seal`;
@@ -67,3 +69,130 @@ export interface VehicleInvoice {
         | `total_price${'' | '_little'}`;
     value: string;
 }
+
+export interface BankCardEntity {
+    type: 'card_number' | 'date_of_expiry';
+    value: string;
+}
+
+export type ResumePeriod = Record<`${'start' | 'end'}_${'date' | 'time'}`, string>;
+
+export enum EducationQualification {
+    PrimarySchool = 1,
+    JuniorHighSchool = 2,
+    VocationalHighSchool = 3,
+    HighSchool = 4,
+    AssociateDegree = 5,
+    BachelorDegree = 6,
+    MasterDegree = 7,
+    Doctorate = 8,
+    Other = 9
+}
+
+export interface ResumeEducation
+    extends ResumePeriod, Record<'school' | 'major' | 'degree', string> {
+    qualification: EducationQualification;
+}
+
+export enum CareerType {
+    Internship = 1,
+    FullTime = 2
+}
+
+export interface ResumeCareer
+    extends ResumePeriod, Record<'company' | 'title' | 'type_str' | 'job_description', string> {
+    type: CareerType;
+}
+
+export type ResumeProject = ResumePeriod & Record<'name' | 'title' | 'description', string>;
+
+export interface ResumeLanguage {
+    level: number;
+    description: string;
+}
+
+export type ResumeAward = Record<'award' | 'date' | 'description', string>;
+
+export type ResumeCertificate = Record<'name' | 'desc', string>;
+
+export type ResumeCompetition = ResumeCertificate;
+
+export interface Resume
+    extends
+        Record<
+            | 'file_md5'
+            | `${'' | 'new_'}content`
+            | 'name'
+            | 'email'
+            | 'mobile'
+            | 'country_code'
+            | 'date_of_birth'
+            | `${'current' | 'home'}_location`
+            | 'self_evaluation',
+            string
+        >,
+        Record<`willing_${'positions' | 'locations'}` | 'urls' | 'social_links', string[]> {
+    mobile_is_virtual: boolean;
+    educations: ResumeEducation[];
+    careers: ResumeCareer[];
+    projects: ResumeProject[];
+    work_year: number | null;
+    gender: Gender;
+    languages: ResumeLanguage[];
+    awards: ResumeAward[];
+    certificates: ResumeCertificate[];
+    competitions: ResumeCompetition[];
+}
+
+export interface ContractPrice {
+    contract_price: number;
+    contract_price_original: string;
+    text: string;
+}
+
+export type ContractInitialTerm = Record<`initial_${'time' | 'unit'}`, string>;
+
+export interface ContractTime extends Record<
+    `${'' | 'original_'}time_${'start' | 'end'}` | `text_${'start' | 'end' | 'initial_term'}`,
+    string
+> {
+    initial_term: ContractInitialTerm;
+}
+
+export interface ContractCopy extends Record<'original_copy' | 'key' | 'text', string> {
+    copy_num: number;
+}
+
+export type ContractCurrency = Record<`currency_${'name' | 'text'}`, string>;
+
+export type ContractBodyType = 'buy' | 'sell' | 'third';
+
+export type ContractContact = Record<
+    'contacts' | 'id_number' | 'phone' | 'email' | 'address',
+    string
+>;
+export type ContractBodyEntity = ContractContact & Record<'legal_representative' | 'party', string>;
+
+export interface ContractBodyInfo {
+    body_type: ContractBodyType;
+    value: ContractBodyEntity;
+}
+
+export type ContractBankType = `${'buy' | 'sell' | 'third' | 'uncertain'}_bank`;
+
+export type ContractBankEntity = ContractContact &
+    Record<'bank_name' | `account_${'name' | 'number'}` | 'tax_number', string>;
+
+export interface ContractBankInfo {
+    bank_type: ContractBankType;
+    value: ContractBankEntity;
+}
+
+export interface Contract extends Record<'file_id' | 'header', string> {
+    price: ContractPrice;
+    time: ContractTime;
+    copy: ContractCopy;
+    currency: ContractCurrency;
+    body_info: ContractBodyInfo[];
+    bank_info: ContractBankInfo[];
+}