mobx-lark 2.9.0 → 2.10.0

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

@@ -1,5 +1,5 @@
 import { BaseModel, RESTClient } from 'mobx-restful';
-import { BankCardEntity, Contract, Resume, TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
+import { BankCardEntity, BusinessCard, BusinessLicense, Contract, IDCard, Resume, TaxiInvoice, TrainInvoice, VatInvoice, VehicleInvoice } from './type';
 export * from './type';
 export declare abstract class DocumentAIModel extends BaseModel {
     baseURI: string;
@@ -36,6 +36,18 @@ export declare abstract class DocumentAIModel extends BaseModel {
      * @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/id_card/recognize}
+     */
+    recognizeIDCard(file: File): Promise<IDCard>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/document_ai-v1/business_card/recognize}
+     */
+    recognizeBusinessCard(file: File): Promise<BusinessCard[]>;
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/business_license/recognize}
+     */
+    recognizeBusinessLicense(file: File): Promise<BusinessLicense>;
     /**
      * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/resume/parse}
      */

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

@@ -22,6 +22,33 @@ export interface BankCardEntity {
     type: 'card_number' | 'date_of_expiry';
     value: string;
 }
+export interface IDCardEntity {
+    type: `identity_${'code' | 'name'}` | 'birth' | 'gender' | 'race' | 'address' | 'issued_by' | `valid_date_${'start' | 'end'}`;
+    value: string;
+}
+export declare enum IDCardSide {
+    Cover = 0,
+    Profile = 1
+}
+export interface IDCard {
+    entities: IDCardEntity[];
+    side: IDCardSide;
+    corners: number[];
+}
+export interface BusinessCardEntity {
+    type: `${'contact' | 'company'}_names` | 'departments' | 'job_titles' | 'emails' | 'websites' | 'addresses' | `${'mobile' | 'work' | 'other'}_phones` | 'faxes';
+    value: string;
+}
+export interface BusinessCard {
+    entities: BusinessCardEntity[];
+}
+export interface BusinessLicenseEntity {
+    type: 'certificate_type' | 'unified_social_credit_code' | `company_${'name' | 'type'}` | 'domicile' | 'legal_representative' | 'registered_capital' | `established_${'time' | 'date'}` | 'business_scope' | 'approval_date' | 'website';
+    value: string;
+}
+export interface BusinessLicense {
+    entities: BusinessLicenseEntity[];
+}
 export type ResumePeriod = Record<`${'start' | 'end'}_${'date' | 'time'}`, string>;
 export declare enum EducationQualification {
     PrimarySchool = 1,

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

@@ -1,7 +1,7 @@
 import { BaseListModel, RESTClient } from 'mobx-restful';
 import { LarkDocumentType, UploadTargetType } from '../../type';
 import { UserIdType } from '../User/type';
-import { CopiedFile, DriveFile, DriveFileType, TransferOwner, TransferOption } from './type';
+import { CopiedFile, DriveFile, DriveFileType, PublicFileType, PublicPermission, PublicPermissionPatch, TransferOption, TransferOwner } from './type';
 export * from './type';
 export declare abstract class DriveFileModel extends BaseListModel<DriveFile> {
     baseURI: string;
@@ -29,6 +29,14 @@ export declare abstract class DriveFileModel extends BaseListModel<DriveFile> {
      * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy}
      */
     copyOne(type: LarkDocumentType, file_token: string, name?: string, folder_token?: string, user_id_type?: UserIdType): Promise<CopiedFile>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-public/patch-2}
+     */
+    updatePublicPermission(type: PublicFileType, token: string, permission: PublicPermissionPatch): Promise<PublicPermission>;
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-public/permission-public-password/create}
+     */
+    createPublicPassword(type: PublicFileType, token: string): Promise<string>;
     /**
      * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-member/transfer_owner}
      */

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

@@ -2,6 +2,31 @@ import { LarkDocumentType } from '../../type';
 export type DriveFile = Record<`doc_${'token' | 'type'}` | 'title' | 'owner_id' | 'create_time' | `latest_modify_${'user' | 'time'}` | 'url' | 'sec_label_name', string>;
 export type CopiedFile = Record<'type' | `${'parent_' | ''}token` | 'name' | 'url', string>;
 export type DriveFileType = LarkDocumentType | 'minutes' | 'folder' | 'wiki';
+export type PublicFileType = Exclude<DriveFileType, 'folder'>;
+type PublicEditableLevel = 'view' | 'edit';
+type PublicLinkAccessLevel = 'readable' | 'editable';
+type PublicLinkShareScope = `${'' | 'partner_'}tenant` | 'anyone';
+export type PublicCommentEntity = `anyone_can_${PublicEditableLevel}`;
+export type PublicPermissionLevel = PublicCommentEntity | 'only_full_access';
+export type PublicShareEntity = 'anyone' | 'same_tenant';
+export type PublicCollaboratorEntity = `collaborator_can_${PublicEditableLevel}` | 'collaborator_full_access';
+export type PublicExternalAccessEntity = 'open' | 'closed' | 'allow_share_partner_tenant';
+export type PublicLinkShareEntity = `${PublicLinkShareScope}_${PublicLinkAccessLevel}` | 'closed';
+export interface PublicPermission {
+    external_access_entity: PublicExternalAccessEntity;
+    security_entity: PublicPermissionLevel;
+    comment_entity: PublicCommentEntity;
+    share_entity: PublicShareEntity;
+    manage_collaborator_entity: PublicCollaboratorEntity;
+    link_share_entity: PublicLinkShareEntity;
+    copy_entity: PublicPermissionLevel;
+    lock_switch: boolean;
+}
+export type PublicPermissionPatch = Partial<Omit<PublicPermission, 'lock_switch'>>;
+export interface PublishedFile {
+    permission: PublicPermission;
+    password?: string;
+}
 export interface TransferOwner {
     member_type: 'email' | 'userid' | 'openid';
     member_id: string;
@@ -12,3 +37,4 @@ export interface TransferOption {
     stay_put?: boolean;
     old_owner_perm?: 'view' | 'edit' | 'full_access';
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.9.0",
+    "version": "2.10.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",
@@ -48,7 +48,7 @@
         "dotenv": "^17.4.2",
         "fs-extra": "^11.3.5",
         "husky": "^9.1.7",
-        "lint-staged": "^17.0.7",
+        "lint-staged": "^17.0.8",
         "parcel": "~2.16.4",
         "prettier": "^3.8.4",
         "react": "^19.2.7",

package/src/Lark.ts

@@ -9,6 +9,8 @@ import {
     DocumentAIModel,
     DocumentModel,
     DriveFileModel,
+    PublicFileType,
+    PublishedFile,
     TableFormView,
     UserIdType,
     WikiNode,
@@ -291,6 +293,31 @@ export class LarkApp implements LarkAppOption {
         return this.documentStore.getOneContent(doc_token, 'markdown');
     }
 
+    /**
+     * @see {@link DriveFileModel#updatePublicPermission}
+     * @see {@link DriveFileModel#createPublicPassword}
+     */
+    async publishFile(URI: string, enablePassword = false, editable = false) {
+        await this.getAccessToken();
+
+        const [[pathType, token]] = DriveFileModel.parseURI(URI);
+        const type: PublicFileType =
+            pathType === 'wiki' ? pathType : getLarkDocumentType(pathType as LarkDocumentPathType);
+
+        const permission = await this.driveFileStore.updatePublicPermission(type, token, {
+                external_access_entity: 'open',
+                link_share_entity: editable ? 'anyone_editable' : 'anyone_readable',
+                copy_entity: 'anyone_can_view',
+                security_entity: 'anyone_can_view',
+                comment_entity: 'anyone_can_view'
+            }),
+            password = enablePassword
+                ? await this.driveFileStore.createPublicPassword(type, token)
+                : undefined;
+
+        return { permission, password } as PublishedFile;
+    }
+
     async getBiTableSchema(appId: string): Promise<BiTableSchema> {
         const { client } = this;
 

package/src/module/DocumentAI/index.ts

@@ -4,7 +4,10 @@ import { BaseModel, RESTClient, toggle } from 'mobx-restful';
 import { LarkData } from '../../type';
 import {
     BankCardEntity,
+    BusinessCard,
+    BusinessLicense,
     Contract,
+    IDCard,
     Resume,
     TaxiInvoice,
     TrainInvoice,
@@ -95,6 +98,46 @@ export abstract class DocumentAIModel extends BaseModel {
         return body!.data!.bank_card.entities;
     }
 
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/id_card/recognize}
+     */
+    @toggle('uploading')
+    async recognizeIDCard(file: File) {
+        type IDCardTypo = Omit<IDCard, 'corners'> & { conners: number[] };
+
+        const { body } = await this.client.post<LarkData<{ id_card: IDCardTypo }>>(
+            `${this.baseURI}/id_card/recognize`,
+            makeFormData({ file })
+        );
+        const { conners: corners, ...idCard } = body!.data!.id_card;
+
+        return { ...idCard, corners } as IDCard;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/ai/document_ai-v1/business_card/recognize}
+     */
+    @toggle('uploading')
+    async recognizeBusinessCard(file: File) {
+        const { body } = await this.client.post<LarkData<{ business_cards: BusinessCard[] }>>(
+            `${this.baseURI}/business_card/recognize`,
+            makeFormData({ file })
+        );
+        return body!.data!.business_cards;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/business_license/recognize}
+     */
+    @toggle('uploading')
+    async recognizeBusinessLicense(file: File) {
+        const { body } = await this.client.post<LarkData<{ business_license: BusinessLicense }>>(
+            `${this.baseURI}/business_license/recognize`,
+            makeFormData({ file })
+        );
+        return body!.data!.business_license;
+    }
+
     /**
      * @see {@link https://open.feishu.cn/document/ai/document_ai-v1/resume/parse}
      */

package/src/module/DocumentAI/type.ts

@@ -75,6 +75,65 @@ export interface BankCardEntity {
     value: string;
 }
 
+export interface IDCardEntity {
+    type:
+        | `identity_${'code' | 'name'}`
+        | 'birth'
+        | 'gender'
+        | 'race'
+        | 'address'
+        | 'issued_by'
+        | `valid_date_${'start' | 'end'}`;
+    value: string;
+}
+
+export enum IDCardSide {
+    Cover = 0,
+    Profile = 1
+}
+
+export interface IDCard {
+    entities: IDCardEntity[];
+    side: IDCardSide;
+    corners: number[];
+}
+
+export interface BusinessCardEntity {
+    type:
+        | `${'contact' | 'company'}_names`
+        | 'departments'
+        | 'job_titles'
+        | 'emails'
+        | 'websites'
+        | 'addresses'
+        | `${'mobile' | 'work' | 'other'}_phones`
+        | 'faxes';
+    value: string;
+}
+
+export interface BusinessCard {
+    entities: BusinessCardEntity[];
+}
+
+export interface BusinessLicenseEntity {
+    type:
+        | 'certificate_type'
+        | 'unified_social_credit_code'
+        | `company_${'name' | 'type'}`
+        | 'domicile'
+        | 'legal_representative'
+        | 'registered_capital'
+        | `established_${'time' | 'date'}` // 成立日期、营业期限
+        | 'business_scope'
+        | 'approval_date'
+        | 'website';
+    value: string;
+}
+
+export interface BusinessLicense {
+    entities: BusinessLicenseEntity[];
+}
+
 export type ResumePeriod = Record<`${'start' | 'end'}_${'date' | 'time'}`, string>;
 
 export enum EducationQualification {

package/src/module/Drive/index.ts

@@ -4,7 +4,16 @@ import { buildURLData, splitArray } from 'web-utility';
 
 import { LarkData, LarkDocumentPathTypeMap, LarkDocumentType, UploadTargetType } from '../../type';
 import { UserIdType } from '../User/type';
-import { CopiedFile, DriveFile, DriveFileType, TransferOwner, TransferOption } from './type';
+import {
+    CopiedFile,
+    DriveFile,
+    DriveFileType,
+    PublicFileType,
+    PublicPermission,
+    PublicPermissionPatch,
+    TransferOption,
+    TransferOwner
+} from './type';
 
 export * from './type';
 
@@ -106,6 +115,33 @@ export abstract class DriveFileModel extends BaseListModel<DriveFile> {
         return body!.data!.file;
     }
 
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-public/patch-2}
+     */
+    @toggle('uploading')
+    async updatePublicPermission(
+        type: PublicFileType,
+        token: string,
+        permission: PublicPermissionPatch
+    ) {
+        const { body } = await this.client.patch<LarkData<{ permission_public: PublicPermission }>>(
+            `${this.baseURI}/../v2/permissions/${token}/public?${buildURLData({ type })}`,
+            permission
+        );
+        return body!.data!.permission_public;
+    }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-public/permission-public-password/create}
+     */
+    @toggle('uploading')
+    async createPublicPassword(type: PublicFileType, token: string) {
+        const { body } = await this.client.post<LarkData<{ password: string }>>(
+            `${this.baseURI}/permissions/${token}/public/password?${buildURLData({ type })}`
+        );
+        return body!.data!.password;
+    }
+
     /**
      * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-member/transfer_owner}
      */

package/src/module/Drive/type.ts

@@ -14,6 +14,38 @@ export type DriveFile = Record<
 export type CopiedFile = Record<'type' | `${'parent_' | ''}token` | 'name' | 'url', string>;
 
 export type DriveFileType = LarkDocumentType | 'minutes' | 'folder' | 'wiki';
+export type PublicFileType = Exclude<DriveFileType, 'folder'>;
+
+type PublicEditableLevel = 'view' | 'edit';
+type PublicLinkAccessLevel = 'readable' | 'editable';
+type PublicLinkShareScope = `${'' | 'partner_'}tenant` | 'anyone';
+
+export type PublicCommentEntity = `anyone_can_${PublicEditableLevel}`;
+export type PublicPermissionLevel = PublicCommentEntity | 'only_full_access';
+export type PublicShareEntity = 'anyone' | 'same_tenant';
+export type PublicCollaboratorEntity =
+    | `collaborator_can_${PublicEditableLevel}`
+    | 'collaborator_full_access';
+export type PublicExternalAccessEntity = 'open' | 'closed' | 'allow_share_partner_tenant';
+export type PublicLinkShareEntity = `${PublicLinkShareScope}_${PublicLinkAccessLevel}` | 'closed';
+
+export interface PublicPermission {
+    external_access_entity: PublicExternalAccessEntity;
+    security_entity: PublicPermissionLevel;
+    comment_entity: PublicCommentEntity;
+    share_entity: PublicShareEntity;
+    manage_collaborator_entity: PublicCollaboratorEntity;
+    link_share_entity: PublicLinkShareEntity;
+    copy_entity: PublicPermissionLevel;
+    lock_switch: boolean;
+}
+
+export type PublicPermissionPatch = Partial<Omit<PublicPermission, 'lock_switch'>>;
+
+export interface PublishedFile {
+    permission: PublicPermission;
+    password?: string;
+}
 
 export interface TransferOwner {
     member_type: 'email' | 'userid' | 'openid';