apaas-oapi-client 0.1.17 → 0.1.18

package/UserManual.md

@@ -510,7 +510,53 @@ 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>
 
 # **☁️ 云函数模块**
 
@@ -524,7 +570,7 @@ console.log(res);
 
 ***
 
-
+<br>
 
 ## **🛠️ 高级**
 

package/dist/index.d.ts

@@ -463,6 +463,49 @@ declare class Client {
             }>;
         };
     };
+    /**
+     * 自动化流程模块
+     */
+    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;

package/dist/index.js

@@ -935,6 +935,74 @@ class Client {
                 }
             }
         };
+        /**
+         * 自动化流程模块
+         */
+        this.automation = {
+            /**
+             * V1 版本
+             */
+            v1: {
+                /**
+                 * 执行流程
+                 * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any }
+                 * @returns 接口返回结果
+                 */
+                execute: async (params) => {
+                    const { flow_api_name, operator, params: flowParams } = params;
+                    await this.ensureTokenValid();
+                    const url = `/api/flow/v1/namespaces/${this.namespace}/flows/${flow_api_name}/execute`;
+                    this.log(LoggerLevel.info, `[automation.v1.execute] Executing flow: ${flow_api_name}`);
+                    const res = await this.axiosInstance.post(url, {
+                        operator,
+                        params: flowParams
+                    }, {
+                        headers: {
+                            Authorization: `${this.accessToken}`,
+                            'Content-Type': 'application/json'
+                        }
+                    });
+                    this.log(LoggerLevel.debug, `[automation.v1.execute] Flow executed: ${flow_api_name}, code=${res.data.code}`);
+                    this.log(LoggerLevel.trace, `[automation.v1.execute] Response: ${JSON.stringify(res.data)}`);
+                    return res.data;
+                }
+            },
+            /**
+             * V2 版本
+             */
+            v2: {
+                /**
+                 * 执行流程
+                 * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any, is_resubmit?: boolean, pre_instance_id?: string }
+                 * @returns 接口返回结果
+                 */
+                execute: async (params) => {
+                    const { flow_api_name, operator, params: flowParams, is_resubmit, pre_instance_id } = params;
+                    await this.ensureTokenValid();
+                    const url = `/v2/namespaces/${this.namespace}/flows/${flow_api_name}/execute`;
+                    this.log(LoggerLevel.info, `[automation.v2.execute] Executing flow: ${flow_api_name}`);
+                    const requestData = {
+                        operator,
+                        params: flowParams
+                    };
+                    if (is_resubmit !== undefined) {
+                        requestData.is_resubmit = is_resubmit;
+                    }
+                    if (pre_instance_id) {
+                        requestData.pre_instance_id = pre_instance_id;
+                    }
+                    const res = await this.axiosInstance.post(url, requestData, {
+                        headers: {
+                            Authorization: `${this.accessToken}`,
+                            'Content-Type': 'application/json'
+                        }
+                    });
+                    this.log(LoggerLevel.debug, `[automation.v2.execute] Flow executed: ${flow_api_name}, code=${res.data.code}`);
+                    this.log(LoggerLevel.trace, `[automation.v2.execute] Response: ${JSON.stringify(res.data)}`);
+                    return res.data;
+                }
+            }
+        };
         this.clientId = options.clientId;
         this.clientSecret = options.clientSecret;
         this.namespace = options.namespace;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "apaas-oapi-client",
-    "version": "0.1.17",
+    "version": "0.1.18",
     "main": "dist/index.js",
     "exports": {
         ".": "./dist/index.js",

package/src/index.ts

@@ -1298,6 +1298,98 @@ class Client {
             }
         }
     };
+
+    /**
+     * 自动化流程模块
+     */
+    public automation = {
+        /**
+         * V1 版本
+         */
+        v1: {
+            /**
+             * 执行流程
+             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any }
+             * @returns 接口返回结果
+             */
+            execute: async (params: { flow_api_name: string; operator: { _id: number; email: string }; params: any }): Promise<any> => {
+                const { flow_api_name, operator, params: flowParams } = params;
+                await this.ensureTokenValid();
+
+                const url = `/api/flow/v1/namespaces/${this.namespace}/flows/${flow_api_name}/execute`;
+
+                this.log(LoggerLevel.info, `[automation.v1.execute] Executing flow: ${flow_api_name}`);
+
+                const res = await this.axiosInstance.post(
+                    url,
+                    {
+                        operator,
+                        params: flowParams
+                    },
+                    {
+                        headers: {
+                            Authorization: `${this.accessToken}`,
+                            'Content-Type': 'application/json'
+                        }
+                    }
+                );
+
+                this.log(LoggerLevel.debug, `[automation.v1.execute] Flow executed: ${flow_api_name}, code=${res.data.code}`);
+                this.log(LoggerLevel.trace, `[automation.v1.execute] Response: ${JSON.stringify(res.data)}`);
+
+                return res.data;
+            }
+        },
+
+        /**
+         * V2 版本
+         */
+        v2: {
+            /**
+             * 执行流程
+             * @param params 请求参数 { flow_api_name: string, operator: { _id: number, email: string }, params: any, is_resubmit?: boolean, pre_instance_id?: string }
+             * @returns 接口返回结果
+             */
+            execute: async (params: {
+                flow_api_name: string;
+                operator: { _id: number; email: string };
+                params: any;
+                is_resubmit?: boolean;
+                pre_instance_id?: string;
+            }): Promise<any> => {
+                const { flow_api_name, operator, params: flowParams, is_resubmit, pre_instance_id } = params;
+                await this.ensureTokenValid();
+
+                const url = `/v2/namespaces/${this.namespace}/flows/${flow_api_name}/execute`;
+
+                this.log(LoggerLevel.info, `[automation.v2.execute] Executing flow: ${flow_api_name}`);
+
+                const requestData: any = {
+                    operator,
+                    params: flowParams
+                };
+
+                if (is_resubmit !== undefined) {
+                    requestData.is_resubmit = is_resubmit;
+                }
+                if (pre_instance_id) {
+                    requestData.pre_instance_id = pre_instance_id;
+                }
+
+                const res = await this.axiosInstance.post(url, requestData, {
+                    headers: {
+                        Authorization: `${this.accessToken}`,
+                        'Content-Type': 'application/json'
+                    }
+                });
+
+                this.log(LoggerLevel.debug, `[automation.v2.execute] Flow executed: ${flow_api_name}, code=${res.data.code}`);
+                this.log(LoggerLevel.trace, `[automation.v2.execute] Response: ${JSON.stringify(res.data)}`);
+
+                return res.data;
+            }
+        }
+    };
 }
 
 export const apaas = {