[add] File Ownership transfer & BI Table schema query methods (#16)

Co-authored-by: TechQuery <shiy2008@gmail.com>

Author: Copilot

package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.6.1",
+    "version": "2.6.3",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",

src/Lark.ts

@@ -2,9 +2,13 @@ import { Context, HTTPClient } from 'koajax';
 import { buildURLData, cache, sleep } from 'web-utility';
 
 import {
+    BiTable,
+    BiTableSchema,
+    BiTableView,
     CopiedFile,
     DocumentModel,
     DriveFileModel,
+    TableFormView,
     UserIdType,
     WikiNode,
     WikiNodeModel
@@ -281,4 +285,29 @@ export class LarkApp implements LarkAppOption {
 
         return this.documentStore.getOneContent(doc_token, 'markdown');
     }
+
+    async getBiTableSchema(appId: string) {
+        const { client } = this;
+
+        class InternalTableModel extends BiTable() {
+            client = client;
+        }
+        class InternalFormModel extends BiTableView('form') {
+            client = client;
+        }
+        const tables = await new InternalTableModel(appId).getAll(),
+            forms: Record<string, TableFormView[]> = {};
+
+        for (const { name, table_id } of tables)
+            forms[name] = await new InternalFormModel(appId, table_id).getAll();
+
+        const tableIdMap = Object.fromEntries(tables.map(({ name, table_id }) => [name, table_id])),
+            formLinkMap = Object.fromEntries(
+                Object.entries(forms).map(([name, list]) => [
+                    name,
+                    Object.fromEntries(list.map(({ name, shared_url }) => [name, shared_url]))
+                ])
+            );
+        return { tables, tableIdMap, forms, formLinkMap } as BiTableSchema;
+    }
 }

src/module/BITable/type.ts

@@ -15,13 +15,21 @@ export interface TableView extends Record<'view_id' | 'view_name', string> {
 }
 
 export interface TableFormView
-    extends Record<'name' | 'description' | 'shared_url', string>,
+    extends
+        Record<'name' | 'description' | 'shared_url', string>,
         Record<'shared' | 'submit_limit_once', boolean> {
     shared_limit: 'tenant_editable';
 }
 
 export type LarkFormData = LarkData<{ form: TableFormView }>;
 
+export interface BiTableSchema {
+    tables: BITable[];
+    tableIdMap: Record<string, string>;
+    forms: Record<string, TableFormView[]>;
+    formLinkMap: Record<string, Record<string, string>>;
+}
+
 export interface TableCellText {
     type: 'text';
     text: string;
@@ -36,14 +44,17 @@ export interface TableCellLink extends Record<'link' | 'text', string> {
     type: 'url';
 }
 
-export interface TableCellMedia
-    extends Record<'file_token' | 'name' | `${'' | 'tmp_'}url`, string> {
+export interface TableCellMedia extends Record<
+    'file_token' | 'name' | `${'' | 'tmp_'}url`,
+    string
+> {
     type: `${string}/${string}`;
     size: number;
 }
 
 export interface TableCellAttachment
-    extends Pick<TableCellMedia, 'name' | 'size'>,
+    extends
+        Pick<TableCellMedia, 'name' | 'size'>,
         Record<'id' | 'attachmentToken', string>,
         Record<'height' | 'timeStamp' | 'width', number> {
     mimeType: TableCellMedia['type'];
@@ -96,8 +107,10 @@ export type TableCellValue =
 
 export type TableRecordFields = Record<string, TableCellValue>;
 
-export interface TableRecord<T extends TableRecordFields>
-    extends Record<'id' | 'record_id', string> {
+export interface TableRecord<T extends TableRecordFields> extends Record<
+    'id' | 'record_id',
+    string
+> {
     created_by: TableCellUser;
     created_time: number;
     last_modified_by?: TableCellUser;

src/module/Drive/index.ts

@@ -4,7 +4,7 @@ import { buildURLData, splitArray } from 'web-utility';
 
 import { LarkData, LarkDocumentPathTypeMap, LarkDocumentType, UploadTargetType } from '../../type';
 import { UserIdType } from '../User/type';
-import { CopiedFile, DriveFile } from './type';
+import { CopiedFile, DriveFile, DriveFileType, TransferOwner, TransferOption } from './type';
 
 export * from './type';
 
@@ -105,4 +105,20 @@ export abstract class DriveFileModel extends BaseListModel<DriveFile> {
         );
         return body!.data!.file;
     }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/permission/permission-member/transfer_owner}
+     */
+    @toggle('uploading')
+    async transferOwner(
+        type: DriveFileType,
+        token: string,
+        newOwner: TransferOwner,
+        option = {} as TransferOption
+    ) {
+        await this.client.post<LarkData>(
+            `${this.baseURI}/permissions/${token}/members/transfer_owner?${buildURLData({ ...option, type })}`,
+            newOwner
+        );
+    }
 }

src/module/Drive/type.ts

@@ -1,3 +1,5 @@
+import { LarkDocumentType } from '../../type';
+
 export type DriveFile = Record<
     | `doc_${'token' | 'type'}`
     | 'title'
@@ -9,4 +11,18 @@ export type DriveFile = Record<
     string
 >;
 
-export type CopiedFile = Record<'token' | 'type' | 'name' | 'parent_token' | 'url', string>;
+export type CopiedFile = Record<'type' | `${'parent_' | ''}token` | 'name' | 'url', string>;
+
+export type DriveFileType = LarkDocumentType | 'minutes' | 'folder' | 'wiki';
+
+export interface TransferOwner {
+    member_type: 'email' | 'userid' | 'openid';
+    member_id: string;
+}
+
+export interface TransferOption {
+    need_notification?: boolean;
+    remove_old_owner?: boolean;
+    stay_put?: boolean;
+    old_owner_perm?: 'view' | 'edit' | 'full_access';
+}