[add] Markdown download API of Lark documents (#12)

Author: TechQuery

.github/workflows/main.yml

@@ -14,10 +14,10 @@ jobs:
 
             - uses: pnpm/action-setup@v4
               with:
-                  version: 9
+                  version: 10
             - uses: actions/setup-node@v4
               with:
-                  node-version: 20
+                  node-version: 22
                   registry-url: https://registry.npmjs.org
                   cache: pnpm
             - name: Install Dependencies

package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-lark",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "license": "LGPL-3.0",
     "author": "shiy2008@gmail.com",
     "description": "Unofficial TypeScript SDK for FeiShu/Lark API, which is based on MobX-RESTful.",
@@ -25,27 +25,32 @@
         "url": "https://github.com/idea2app/MobX-Lark/issues"
     },
     "dependencies": {
-        "@swc/helpers": "^0.5.15",
-        "koajax": "^3.1.1",
+        "@swc/helpers": "^0.5.17",
+        "koajax": "^3.1.2",
         "mobx": "^6.13.7",
         "mobx-restful": "^2.1.0",
         "regenerator-runtime": "^0.14.1",
         "web-utility": "^4.4.3"
     },
     "devDependencies": {
-        "@parcel/config-default": "~2.14.0",
-        "@parcel/transformer-typescript-tsc": "~2.14.0",
-        "@types/node": "^22.13.10",
-        "dotenv": "^16.4.7",
+        "@parcel/config-default": "~2.14.4",
+        "@parcel/transformer-typescript-tsc": "~2.14.4",
+        "@types/node": "^22.14.1",
+        "dotenv": "^16.5.0",
         "husky": "^9.1.7",
-        "lint-staged": "^15.5.0",
+        "lint-staged": "^15.5.1",
         "mobx": "^6.13.7",
-        "parcel": "~2.14.0",
+        "parcel": "~2.14.4",
         "prettier": "^3.5.3",
         "ts-node": "^10.9.2",
-        "typedoc": "^0.28.0",
+        "typedoc": "^0.28.2",
         "typedoc-plugin-mdn-links": "^5.0.1",
-        "typescript": "~5.8.2"
+        "typescript": "~5.8.3"
+    },
+    "pnpm": {
+        "onlyBuiltDependencies": [
+            "@swc/core"
+        ]
     },
     "prettier": {
         "singleQuote": true,

pnpm-lock.yaml

@@ -1,6 +1,7 @@
 import { Context, HTTPClient, makeFormData } from 'koajax';
 import { buildURLData, cache, Second } from 'web-utility';
 
+import { LarkWikiNode } from './module';
 import {
     isLarkError,
     JSTicket,
@@ -165,11 +166,17 @@ export class LarkApp implements LarkAppOption {
     async downloadFile(id: string) {
         await this.getAccessToken();
 
-        const { body } = await this.client.request<ArrayBuffer>({
-            path: `drive/v1/medias/${id}/download`,
-            responseType: 'arraybuffer'
-        });
-        return body!;
+        const { headers, body } = await this.client.get<Blob>(
+            `drive/v1/medias/${id}/download`,
+            {},
+            { responseType: 'blob' }
+        );
+        const { 'Content-Disposition': CD, 'Content-Type': CT } = headers;
+
+        const [type] = (CT as string)?.split(';') || [],
+            [, fileName] = (CD as string)?.match(/filename="?(.*?)"?$/) || [];
+
+        return new File([body!], fileName, { type });
     }
 
     /**
@@ -195,4 +202,41 @@ export class LarkApp implements LarkAppOption {
 
         return body!.data!.file_token;
     }
+
+    /**
+     * @see {@link https://open.feishu.cn/document/server-docs/docs/wiki-v2/space-node/get_node}
+     */
+    async wiki2docx(id: string) {
+        await this.getAccessToken();
+
+        const { body } = await this.client.get<
+            LarkData<{ node: LarkWikiNode }>
+        >(`wiki/v2/spaces/get_node?token=${id}`);
+
+        const { obj_type, obj_token } = body!.data!.node;
+
+        return obj_type === 'docx' ? obj_token : '';
+    }
+
+    static documentPathPattern = /(wiki|docx)\/(\w+)/;
+
+    /**
+     * @see {@link https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/docs-v1/content/get}
+     */
+    async downloadMarkdown(URI: string) {
+        await this.getAccessToken();
+
+        const [, type, id] = URI.match(LarkApp.documentPathPattern) || [];
+
+        const doc_token = type === 'wiki' ? await this.wiki2docx(id) : id;
+
+        const { body } = await this.client.get<LarkData<{ content: string }>>(
+            `docs/v1/content?${new URLSearchParams({
+                doc_type: 'docx',
+                doc_token,
+                content_type: 'markdown'
+            })}`
+        );
+        return body!.data!.content;
+    }
 }

src/Lark.ts

@@ -61,10 +61,19 @@ export function BiDataTable<
             this.baseURI = `bitable/v1/apps/${appId}/tables/${tableId}/records`;
         }
 
-        normalize({ fields, ...meta }: TableRecord<T>): T {
+        extractFields({ fields, ...meta }: TableRecord<T>): T {
             return { ...meta, ...fields };
         }
 
+        /**
+         * @deprecated
+         */
+        normalize = this.extractFields;
+
+        wrapFields(fields: F) {
+            return fields as unknown as T;
+        }
+
         /**
          * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get}
          */
@@ -81,7 +90,9 @@ export function BiDataTable<
          * @see {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update}
          */
         @toggle('uploading')
-        async updateOne(fields: F, id?: string) {
+        async updateOne(data: F, id?: string) {
+            const fields = this.wrapFields(data);
+
             const { body } = await (id
                 ? this.client.put<TableRecordData<T>>(`${this.baseURI}/${id}`, {
                       fields

src/module/BITable/index.ts

@@ -0,0 +1,16 @@
+export interface LarkWikiNode
+    extends Record<
+        | 'title'
+        | 'creator'
+        | 'owner'
+        | `${'' | 'origin_'}space_id`
+        | `node_create_time`
+        | `${'' | 'parent_' | 'origin_'}node_token`
+        | `obj_token`
+        | `obj_${'create' | 'edit'}_time`,
+        string
+    > {
+    node_type: 'origin' | 'shortcut';
+    obj_type: `doc${'' | 'x'}` | 'sheet' | 'mindnote' | 'bitable' | 'file';
+    has_child: boolean;
+}

src/module/Wiki/type.ts

@@ -3,3 +3,4 @@ export * from './InstantMessenger';
 export * from './Task';
 export * from './SpreadSheet';
 export * from './BITable';
+export * from './Wiki/type';

src/module/index.ts

@@ -121,8 +121,8 @@ describe('MobX Lark SDK', async () => {
     });
 
     await it('should download a file', async expect => {
-        const file = await app.downloadFile(MEDIA_ID!);
+        const { size } = await app.downloadFile(MEDIA_ID!);
 
-        expect(file.byteLength > 0);
+        expect(size > 0);
     });
 }).finally(() => process.exit());