@byted-apaas/server-sdk-node 1.1.20-beta.9 → 1.1.20

package/global/application/flow/flow.d.ts

@@ -8,12 +8,13 @@ export interface Flow {
     getExecutionUserTaskInfo: (executionId: number) => Promise<FlowTaskInfo[]>;
     /**
      * 执行流程
-     * @param APIName 流程的 APIName
+     * @param apiName 流程的 APIName
      * @param options 流程执行选项
+     * @param async 是否异步执行
      *      - params 流程入参
      * @constructor
      */
-    execute: (APIName: string, options?: ExecuteOptions) => Promise<ExecutionResult>;
+    execute: (apiName: string, options?: ExecuteOptions, async?: boolean) => Promise<ExecutionResult>;
     /**
      * 撤销流程实例 (仅支持撤销包含人工任务的流程实例)
      * @param executionId 流程实例 Id

package/global/application/flow/impl/flow.d.ts

@@ -11,7 +11,7 @@ export declare class Flow implements IFlow {
      */
     instanceId: number;
     constructor(flowParams: any);
-    execute(APIName: string, options: ExecuteOptions | undefined): Promise<ExecutionResult>;
+    execute(apiName: string, options: ExecuteOptions | undefined, async?: boolean | undefined): Promise<ExecutionResult>;
     getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
     getExecutionUserTaskInfo(executionId: number): Promise<FlowTaskInfo[]>;
     revokeExecution(executionId: number, options: RevokeExecutionOptions): Promise<void>;

package/global/application/flow/impl/flow.js

@@ -10,9 +10,9 @@ class Flow {
         this.apiName = flowParams?.apiName;
         this.instanceId = flowParams?.instanceId;
     }
-    async execute(APIName, options) {
-        if (!APIName || typeof APIName !== 'string') {
-            throw new exceptions_1.InvalidParamError(`param's type (${APIName}) need string, but is ${typeof APIName}`);
+    async execute(apiName, options, async) {
+        if (!apiName || typeof apiName !== 'string') {
+            throw new exceptions_1.InvalidParamError(`param's type (${apiName}) need string, but is ${typeof apiName}`);
         }
         if (options && options.params && server_common_node_1.checkUtils.isNotObject(options.params)) {
             throw new exceptions_1.InvalidParamError(`options.params's type (${options}) need object, but is ${Array.isArray(options) ? 'array' : typeof options.params}`);
@@ -20,7 +20,7 @@ class Flow {
         if (!options) {
             options = {};
         }
-        return await Request.GetInstance().executeFlow(APIName, options);
+        return await Request.GetInstance().executeFlow(apiName, options, async);
     }
     async getExecutionInfo(executionId) {
         if (!executionId || typeof executionId !== 'number') {

package/hooks/api.d.ts

@@ -18,7 +18,7 @@ export declare function mountWorkflowFeature(context: any): void;
 export declare function terminateWorkflow(): (workflowInstanceId: number, options: any) => Promise<void>;
 export declare function mockFlowFeature(context: any): any;
 export declare function mockGetExecutionUserTaskInfo(): (executionId: bigint) => Promise<FlowTaskInfo[]>;
-export declare function mockExecuteFlow(): (APIName: string, options?: ExecuteOptions) => Promise<ExecutionResult>;
+export declare function mockExecuteFlow(): (apiName: string, options?: ExecuteOptions) => Promise<ExecutionResult>;
 export declare function mockRevokeExecution(): (executionId: number, options: RevokeExecutionOptions) => Promise<void>;
 export declare function mockGetExecutionInfo(): (executionId: number) => Promise<ExecutionInfo>;
 export declare function invokeMicroservice(): (apiName: string) => {

package/hooks/api.js

@@ -257,9 +257,9 @@ function mockGetExecutionUserTaskInfo() {
 }
 exports.mockGetExecutionUserTaskInfo = mockGetExecutionUserTaskInfo;
 function mockExecuteFlow() {
-    return async (APIName, options) => {
-        if (!APIName || typeof APIName !== 'string') {
-            throw new exceptions_1.InvalidParamError(`param's type (${APIName}) need string, but is ${typeof APIName}`);
+    return async (apiName, options) => {
+        if (!apiName || typeof apiName !== 'string') {
+            throw new exceptions_1.InvalidParamError(`param's type (${apiName}) need string, but is ${typeof apiName}`);
         }
         if (options && options.params && checkUtils.isNotObject(options.params)) {
             throw new exceptions_1.InvalidParamError(`options.params's type (${options}) need object, but is ${Array.isArray(options) ? 'array' : typeof options.params}`);
@@ -267,7 +267,7 @@ function mockExecuteFlow() {
         if (!options) {
             options = {};
         }
-        return await Request.GetInstance().executeFlow(APIName, options);
+        return await Request.GetInstance().executeFlow(apiName, options, false);
     };
 }
 exports.mockExecuteFlow = mockExecuteFlow;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.20-beta.9",
+  "version": "1.1.20",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -13,7 +13,7 @@
     "clean": "tsc --build --clean && rm -rf **/*.js.map"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "2.0.19",
+    "@byted-apaas/server-common-node": "^2.0.13",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",

package/request/interface.d.ts

@@ -84,7 +84,7 @@ export interface IInnerAPIBaseRequest {
     }, params: any) => Promise<any>;
     createAsyncTaskV2: (name: string, params: any) => Promise<any>;
     getExecutionUserTaskInfo: (executionId: bigint) => Promise<any>;
-    executeFlow: (APIName: string, options: any) => Promise<ExecutionResult>;
+    executeFlow: (APIName: string, options: any, async: any) => Promise<ExecutionResult>;
     revokeExecution: (executionId: number, revokeOptions: RevokeExecutionOptions) => Promise<void>;
     getExecutionInfo: (executionId: number) => Promise<ExecutionInfo>;
     getTenantInfo: (appCtx: AppCtx) => Promise<any>;

package/request/openapi.d.ts

@@ -56,7 +56,7 @@ export declare class RequestHttp implements IInnerAPIRequest {
     }, params: any): Promise<any>;
     createAsyncTaskV2(name: string, params: any): Promise<any>;
     getExecutionUserTaskInfo(executionId: bigint): Promise<any>;
-    executeFlow(APIName: string, options: any): Promise<ExecutionResult>;
+    executeFlow(apiName: string, options: any, async: any): Promise<ExecutionResult>;
     revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
     getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
     getTenantInfo(appCtx: AppCtx): Promise<any>;
@@ -79,6 +79,6 @@ export declare class RequestHttp implements IInnerAPIRequest {
     getApprovalInstance(params: IGetApprovalInstanceOptions): Promise<IApprovalInstance>;
 }
 export declare function getExecutionUserTaskInfo(executionId: bigint): Promise<any>;
-export declare function executeFlow(APIName: string, option: any): Promise<ExecutionResult>;
+export declare function executeFlow(apiName: string, option: any, async: any): Promise<ExecutionResult>;
 export declare function revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
 export declare function getExecutionInfo(executionId: number): Promise<ExecutionInfo>;

package/request/openapi.js

@@ -11,7 +11,8 @@ const constants_3 = require("@byted-apaas/server-common-node/constants/constants
 const common_1 = require("./common");
 const utils_1 = require("@byted-apaas/server-common-node/utils/utils");
 const permissionUtils = require("@byted-apaas/server-common-node/utils/permissionUtils");
-const { URLSearchParams } = require('url');
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { URLSearchParams } = require('url'); //nolint:byted_s_ts_no_require_imports
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const nodeCls = require('node-cls'); //nolint:byted_s_ts_no_require_imports
 const fs = require('fs');
@@ -1126,8 +1127,8 @@ class RequestHttp {
     async getExecutionUserTaskInfo(executionId) {
         return await getExecutionUserTaskInfo(executionId);
     }
-    async executeFlow(APIName, options) {
-        return await executeFlow(APIName, options);
+    async executeFlow(apiName, options, async) {
+        return await executeFlow(apiName, options, async);
     }
     async revokeExecution(executionId, revokeOptions) {
         return await revokeExecution(executionId, revokeOptions);
@@ -1414,17 +1415,20 @@ async function getExecutionUserTaskInfo(executionId) {
     return res.taskList;
 }
 exports.getExecutionUserTaskInfo = getExecutionUserTaskInfo;
-async function executeFlow(APIName, option) {
-    if (!APIName) {
+async function executeFlow(apiName, option, async) {
+    if (!apiName) {
         throw new exceptions.InvalidParamError(`flow apiName is empty`);
     }
     let options = commonHttp.getOptions(null, constants_2.openapiHttpPath.executeFlow);
-    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)()).replace(replaceKeys.apiName, APIName);
+    const urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)()).replace(replaceKeys.apiName, apiName);
     options.json = {
         'operator': utils.getUserIDFromCtx(),
         'variables': (0, common_1.transMapToFlowVariable)(option.params),
         'loopMasks': utils.getLoopMasks(),
     };
+    if (async !== undefined) {
+        options.json['async'] = async;
+    }
     let res = await openapi.doRequest(null, urlPath, options);
     return {
         executionId: res.executionId,