apaas-oapi-client 0.1.16 → 0.1.18

package/UserManual.md

@@ -22,9 +22,9 @@ aPaaS 平台有完整的 Open API 能力，但是目前这些能力全都以单
 - ……
 	
 
-<br>
 
-<br>
+
+
 
 **📦 安装**
 
@@ -36,7 +36,7 @@ yarn add apaas-oapi-client
 
 ***
 
-<br>
+
 
 # **🚀 快速开始**
 
@@ -62,7 +62,7 @@ main();
 
 ***
 
-<br>
+
 
 ## **🔐 认证**
 
@@ -77,7 +77,7 @@ main();
 
 ***
 
-<br>
+
 
 ## **📝 日志等级**
 
@@ -94,7 +94,27 @@ main();
 
 ***
 
-<br>
+
+
+# 💾 **数据模块**
+
+## **📋 对象列表接口**
+
+### **获取所有对象（数据表）**
+
+```JavaScript
+const res = await client.object.list({
+  offset: 0,
+  limit: 100,
+  filter: {
+    type: 'custom',
+    quickQuery: 'store'
+  }
+});
+console.log(res);
+```
+
+***
 
 ## **🔍 查询接口**
 
@@ -151,7 +171,7 @@ console.log('Items:', items);
 
 ***
 
-<br>
+
 
 
 ***
@@ -188,7 +208,7 @@ console.log('Items:', items);
 ```
 
 
-<br>
+
 ## **✏️ 更新接口**
 
 ### **单条更新**
@@ -221,7 +241,7 @@ console.log(res);
 
 ***
 
-<br>
+
 
 ## **🗑️ 删除接口**
 
@@ -251,68 +271,220 @@ console.log(res);
 
 ***
 
-## **🛠️ 高级**
 
-### **获取当前** **token**
+
+## **📊 对象元数据接口**
+
+### **获取指定对象字段元数据**
 
 ```JavaScript
-console.log(client.token);
+const res = await client.object.metadata.field({
+  object_name: '_user',
+  field_name: '_id'
+});
+console.log(res);
 ```
 
-### **获取当前 namespace**
+### **获取指定对象所有字段信息**
 
 ```JavaScript
-console.log(client.currentNamespace);
+const res = await client.object.metadata.fields({
+  object_name: 'object_store'
+});
+console.log(res);
 ```
 
 ***
 
-<br>
 
-## **💡 备注**
 
-- 本 SDK 默认使用 [axios](https://www.npmjs.com/package/axios) 请求。
-	
-- 内置 [bottleneck](https://www.npmjs.com/package/bottleneck) 进行请求限流。
-	
-- 日志打印默认使用 console.log 并带时间戳，可通过 setLoggerLevel 动态控制输出等级。
-	
+# **📎 附件模块**
+
+## **文件操作**
+
+### **上传文件**
+
+```JavaScript
+const fs = require('fs');
+
+const res = await client.attachment.file.upload({
+  file: fs.createReadStream('/path/to/file.zip')
+});
+console.log(res);
+// 返回: { code: "0", msg: "success", data: { fileId, type, name, size } }
+```
+
+### **下载文件**
+
+```JavaScript
+const fileData = await client.attachment.file.download({
+  file_id: '625d2f602af94d46972073db32a99ed2'
+});
+// 返回文件二进制流
+```
+
+### **删除文件**
+
+```JavaScript
+const res = await client.attachment.file.delete({
+  file_id: '625d2f602af94d46972073db32a99ed2'
+});
+console.log(res);
+```
+
+## **头像图片操作**
+
+### **上传头像图片**
+
+```JavaScript
+const fs = require('fs');
+
+const res = await client.attachment.avatar.upload({
+  image: fs.createReadStream('/path/to/avatar.jpg')
+});
+console.log(res);
+```
+
+### **下载头像图片**
+
+```JavaScript
+const imageData = await client.attachment.avatar.download({
+  image_id: 'c70d03b21d3c40468ee710d984cfb7a8_o'
+});
+// 返回图片二进制流
+```
 
 ***
 
-<br>
 
-<br>
 
-> 由 [aPaaS OAPI Client SDK](https://www.npmjs.com/package/apaas-oapi-client) 提供支持，如有问题请提交 Issue 反馈。
+# **💽 全局数据模块**
+
+## **全局选项**
+
+### **查询全局选项详情**
+
+```JavaScript
+const res = await client.global.options.detail({
+  api_name: 'global_option_abc'
+});
+console.log(res);
+```
+
+### **查询全局选项列表**
+
+```JavaScript
+const res = await client.global.options.list({
+  limit: 10,
+  offset: 0,
+  filter: { quickQuery: 'Sample Text' }
+});
+console.log(res);
+```
+
+### **分页查询所有全局选项**
+
+```JavaScript
+const { total, items } = await client.global.options.listWithIterator({
+  limit: 100,
+  filter: { quickQuery: 'Sample Text' }
+});
+console.log('Total:', total);
+console.log('Items:', items);
+```
+
+## **环境变量**
+
+### **查询环境变量详情**
+
+```JavaScript
+const res = await client.global.variables.detail({
+  api_name: 'global_variable_abc'
+});
+console.log(res);
+```
+
+### **查询环境变量列表**
+
+```JavaScript
+const res = await client.global.variables.list({
+  limit: 10,
+  offset: 0,
+  filter: { quickQuery: 'Sample Text' }
+});
+console.log(res);
+```
+
+### **分页查询所有环境变量**
+
+```JavaScript
+const { total, items } = await client.global.variables.listWithIterator({
+  limit: 100,
+  filter: { quickQuery: 'Sample Text' }
+});
+console.log('Total:', total);
+console.log('Items:', items);
+```
 
-<br>
 ***
 
-## **📊 对象元数据接口**
 
-### **获取指定对象字段元数据**
+
+# **📄 页面模块**
+
+### **获取所有页面**
 
 ```JavaScript
-const res = await client.object.metadata.field({
-  object_name: '_user',
-  field_name: '_id'
+const res = await client.page.list({
+  limit: 10,
+  offset: 0
 });
 console.log(res);
 ```
 
-### **获取指定对象所有字段信息**
+### **分页查询所有页面**
 
 ```JavaScript
-const res = await client.object.metadata.fields({
-  object_name: 'object_store'
+const { total, items } = await client.page.listWithIterator({
+  limit: 100
+});
+console.log('Total:', total);
+console.log('Items:', items);
+```
+
+### **获取页面详情**
+
+```JavaScript
+const res = await client.page.detail({
+  page_id: 'appPage_aadd64dlqamdo'
 });
 console.log(res);
 ```
 
+### **获取页面访问地址**
+
+```JavaScript
+const res = await client.page.url({
+  page_id: 'appPage_aadd64dlqamdo',
+  pageParams: { var_EzpvJsER: '1234567890' },
+  parentPageParams: {
+    navId: 'aadd64bapmic2',
+    pageApiName: 'page_aaddmtkqgicbg'
+  },
+  navId: 'aadd64bapmic2',
+  tabId: 'tab_legqch3h'
+});
+console.log(res);
+// 返回: { code: "0", msg: "success", data: { link: "https://..." } }
+```
+
 ***
 
-## **🏢 部门 ID 交换**
+
+
+# **🏢 部门模块**
+
+## **部门 ID 交换**
 
 ### **单个部门 ID 交换**
 
@@ -338,7 +510,55 @@ console.log(res);
 
 ***
 
-## **☁️ 云函数调用**
+<br>
+
+# **🔄 自动化流程模块**
+
+## **V1 版本 - 执行流程**
+
+```JavaScript
+const res = await client.automation.v1.execute({
+  flow_api_name: 'automation_cd05fdab67d',
+  operator: {
+    _id: 100,
+    email: 'sample@feishu.cn'
+  },
+  params: {
+    varRecord_ab67d031d44: {
+      _id: 100
+    }
+  }
+});
+console.log(res);
+// 返回: { code: "0", msg: "success", data: { errMsg, executionId, status, data, errCode } }
+```
+
+## **V2 版本 - 执行流程**
+
+V2 版本支持流程重新提交功能。
+
+```JavaScript
+const res = await client.automation.v2.execute({
+  flow_api_name: 'automation_a9ec6ee5fb1',
+  operator: {
+    _id: 100,
+    email: 'sample@feishu.cn'
+  },
+  params: {
+    storeId: 100
+  },
+  is_resubmit: true,
+  pre_instance_id: '1835957428957195'
+});
+console.log(res);
+// 返回: { code: "0", msg: "success", data: { errMsg, executionId, status, data, errCode } }
+```
+
+***
+
+<br>
+
+# **☁️ 云函数模块**
 
 ```JavaScript
 const res = await client.function.invoke({
@@ -348,4 +568,47 @@ const res = await client.function.invoke({
 console.log(res);
 ```
 
+***
+
+<br>
+
+## **🛠️ 高级**
+
+### **获取当前 token**
+
+```JavaScript
+console.log(client.token);
+```
+
+### **获取 token 过期时间**
+
+```JavaScript
+console.log(client.tokenExpireTime); // 返回剩余秒数
+```
+
+### **获取当前 namespace**
+
+```JavaScript
+console.log(client.currentNamespace);
+```
+
+***
+
+
+
+## **💡 备注**
+
+- 本 SDK 默认使用 [axios](https://www.npmjs.com/package/axios) 请求。
+
+- 内置 [bottleneck](https://www.npmjs.com/package/bottleneck) 进行请求限流。
+
+- 日志打印默认使用 console.log 并带时间戳，可通过 setLoggerLevel 动态控制输出等级。
+
+
+***
+
+
+
+> 由 [aPaaS OAPI Client SDK](https://www.npmjs.com/package/apaas-oapi-client) 提供支持，如有问题请提交 Issue 反馈。
+
 ---

package/dist/index.d.ts

@@ -277,6 +277,235 @@ declare class Client {
             params: any;
         }) => Promise<any>;
     };
+    /**
+     * 页面模块
+     */
+    page: {
+        /**
+         * 获取所有页面
+         * @param params 请求参数 { limit: number (max 200), offset: number }
+         * @returns 接口返回结果
+         */
+        list: (params: {
+            limit: number;
+            offset: number;
+        }) => Promise<any>;
+        /**
+         * 获取所有页面 - 支持自动分页，获取全部数据
+         * @description 该方法会自动处理分页，直到获取所有页面数据
+         * @param params 请求参数 { limit?: number }
+         * @returns { total, items }
+         */
+        listWithIterator: (params?: {
+            limit?: number;
+        }) => Promise<{
+            total: number;
+            items: any[];
+        }>;
+        /**
+         * 获取页面详情
+         * @param params 请求参数 { page_id: string }
+         * @returns 接口返回结果
+         */
+        detail: (params: {
+            page_id: string;
+        }) => Promise<any>;
+        /**
+         * 获取页面访问地址
+         * @param params 请求参数 { page_id: string, pageParams?: any, parentPageParams?: any, navId?: string, tabId?: string }
+         * @returns 接口返回结果
+         */
+        url: (params: {
+            page_id: string;
+            pageParams?: any;
+            parentPageParams?: any;
+            navId?: string;
+            tabId?: string;
+        }) => Promise<any>;
+    };
+    /**
+     * 附件模块
+     */
+    attachment: {
+        /**
+         * 文件操作
+         */
+        file: {
+            /**
+             * 上传文件
+             * @param params 请求参数 { file: any }
+             * @returns 接口返回结果
+             */
+            upload: (params: {
+                file: any;
+            }) => Promise<any>;
+            /**
+             * 下载文件
+             * @param params 请求参数 { file_id: string }
+             * @returns 文件二进制流
+             */
+            download: (params: {
+                file_id: string;
+            }) => Promise<any>;
+            /**
+             * 删除文件
+             * @param params 请求参数 { file_id: string }
+             * @returns 接口返回结果
+             */
+            delete: (params: {
+                file_id: string;
+            }) => Promise<any>;
+        };
+        /**
+         * 头像图片操作
+         */
+        avatar: {
+            /**
+             * 上传头像图片
+             * @param params 请求参数 { image: any }
+             * @returns 接口返回结果
+             */
+            upload: (params: {
+                image: any;
+            }) => Promise<any>;
+            /**
+             * 下载头像图片
+             * @param params 请求参数 { image_id: string }
+             * @returns 图片二进制流
+             */
+            download: (params: {
+                image_id: string;
+            }) => Promise<any>;
+        };
+    };
+    /**
+     * 全局数据模块
+     */
+    global: {
+        /**
+         * 全局选项
+         */
+        options: {
+            /**
+             * 查询全局选项详情
+             * @param params 请求参数 { api_name: string }
+             * @returns 接口返回结果
+             */
+            detail: (params: {
+                api_name: string;
+            }) => Promise<any>;
+            /**
+             * 查询全局选项列表
+             * @param params 请求参数 { limit: number, offset: number, filter?: { quickQuery?: string } }
+             * @returns 接口返回结果
+             */
+            list: (params: {
+                limit: number;
+                offset: number;
+                filter?: {
+                    quickQuery?: string;
+                };
+            }) => Promise<any>;
+            /**
+             * 查询所有全局选项 - 支持自动分页，获取全部数据
+             * @description 该方法会自动处理分页，直到获取所有全局选项数据
+             * @param params 请求参数 { limit?: number, filter?: { quickQuery?: string } }
+             * @returns { total, items }
+             */
+            listWithIterator: (params?: {
+                limit?: number;
+                filter?: {
+                    quickQuery?: string;
+                };
+            }) => Promise<{
+                total: number;
+                items: any[];
+            }>;
+        };
+        /**
+         * 环境变量
+         */
+        variables: {
+            /**
+             * 查询环境变量详情
+             * @param params 请求参数 { api_name: string }
+             * @returns 接口返回结果
+             */
+            detail: (params: {
+                api_name: string;
+            }) => Promise<any>;
+            /**
+             * 查询环境变量列表
+             * @param params 请求参数 { limit: number, offset: number, filter?: { quickQuery?: string } }
+             * @returns 接口返回结果
+             */
+            list: (params: {
+                limit: number;
+                offset: number;
+                filter?: {
+                    quickQuery?: string;
+                };
+            }) => Promise<any>;
+            /**
+             * 查询所有环境变量 - 支持自动分页，获取全部数据
+             * @description 该方法会自动处理分页，直到获取所有环境变量数据
+             * @param params 请求参数 { limit?: number, filter?: { quickQuery?: string } }
+             * @returns { total, items }
+             */
+            listWithIterator: (params?: {
+                limit?: number;
+                filter?: {
+                    quickQuery?: string;
+                };
+            }) => Promise<{
+                total: number;
+                items: any[];
+            }>;
+        };
+    };
+    /**
+     * 自动化流程模块
+     */
+    automation: {
+        /**
+         * V1 版本
+         */
+        v1: {
+            /**
+             * 执行流程
+             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any }
+             * @returns 接口返回结果
+             */
+            execute: (params: {
+                flow_api_name: string;
+                operator: {
+                    _id: number;
+                    email: string;
+                };
+                params: any;
+            }) => Promise<any>;
+        };
+        /**
+         * V2 版本
+         */
+        v2: {
+            /**
+             * 执行流程
+             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any, is_resubmit?: boolean, pre_instance_id?: string }
+             * @returns 接口返回结果
+             */
+            execute: (params: {
+                flow_api_name: string;
+                operator: {
+                    _id: number;
+                    email: string;
+                };
+                params: any;
+                is_resubmit?: boolean;
+                pre_instance_id?: string;
+            }) => Promise<any>;
+        };
+    };
 }
 export declare const apaas: {
     Client: typeof Client;