@byted-apaas/server-sdk-node 1.1.13-beta.2 → 1.1.13-beta.4

package/context/metadata/objects/fields.d.ts

@@ -1,4 +1,4 @@
-import { BaseFieldType, FieldType, FilterType, SortConditionType, SubOptionType } from '../types/objects';
+import { BaseFieldType, CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
 import { I18ns } from '../types/common';
 declare class MetadataField {
     type: string;
@@ -36,6 +36,18 @@ declare class Number extends MetadataField {
     decimalPlacesNumber: number;
     constructor(field: FieldType);
 }
+declare class Bigint extends MetadataField {
+    required: boolean;
+    unique: boolean;
+    constructor(field: FieldType);
+}
+declare class Decimal extends MetadataField {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+    constructor(field: FieldType);
+}
 declare class KDate extends MetadataField {
     required: boolean;
     constructor(field: FieldType);
@@ -100,6 +112,22 @@ declare class ReferenceField extends MetadataField {
     fieldApiName: string;
     constructor(field: FieldType);
 }
+declare class Rollup extends MetadataField {
+    rollupType: string;
+    rollupObjectApiName: string;
+    rollupFieldApiName: string;
+    rollupLookupFieldApiName: string;
+    filter: CriterionType;
+    constructor(field: FieldType);
+}
+declare class Region extends MetadataField {
+    required: boolean;
+    multiple: boolean;
+    optionLevel: boolean;
+    strictLevel: number;
+    filter: RegionFilterType[];
+    constructor(field: FieldType);
+}
 declare class File extends MetadataField {
     required: boolean;
     multiple: boolean;
@@ -127,4 +155,4 @@ declare class ExtractSingleRecord extends MetadataField {
 declare function parseFields(inputFields: Record<string, any>): BaseFieldType[];
 declare function parseField(field: FieldType): BaseFieldType;
 declare function getFieldClass(field: FieldType): any;
-export { KText as Text, Multilingual, Number, KDate as Date, DateTime, Option, Email, MobileNumber, Boolean, AvatarOrLogo, Lookup, Formula, AutoID, ReferenceField, File, BackLookup, CompositeType, ExtractSingleRecord, RichText, parseFields, parseField, getFieldClass, };
+export { KText as Text, Multilingual, Number, KDate as Date, DateTime, Option, Email, MobileNumber, Boolean, AvatarOrLogo, Lookup, Formula, AutoID, ReferenceField, File, BackLookup, CompositeType, ExtractSingleRecord, RichText, Bigint, Decimal, Region, Rollup, parseFields, parseField, getFieldClass, };

package/context/metadata/objects/fields.js

@@ -2,7 +2,7 @@
 // Copyright 2022 ByteDance Ltd. and/or its affiliates
 // SPDX-License-Identifier: MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldClass = exports.parseField = exports.parseFields = exports.RichText = exports.ExtractSingleRecord = exports.CompositeType = exports.BackLookup = exports.File = exports.ReferenceField = exports.AutoID = exports.Formula = exports.Lookup = exports.AvatarOrLogo = exports.Boolean = exports.MobileNumber = exports.Email = exports.Option = exports.DateTime = exports.Date = exports.Number = exports.Multilingual = exports.Text = void 0;
+exports.getFieldClass = exports.parseField = exports.parseFields = exports.Rollup = exports.Region = exports.Decimal = exports.Bigint = exports.RichText = exports.ExtractSingleRecord = exports.CompositeType = exports.BackLookup = exports.File = exports.ReferenceField = exports.AutoID = exports.Formula = exports.Lookup = exports.AvatarOrLogo = exports.Boolean = exports.MobileNumber = exports.Email = exports.Option = exports.DateTime = exports.Date = exports.Number = exports.Multilingual = exports.Text = void 0;
 const fieldsUtil = require("./fields.util");
 class MetadataField {
     constructor(type, field) {
@@ -65,6 +65,30 @@ class Number extends MetadataField {
     }
 }
 exports.Number = Number;
+class Bigint extends MetadataField {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('bigint', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+exports.Bigint = Bigint;
+class Decimal extends MetadataField {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('decimal', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+        this.displayAsPercentage = fieldsUtil.getDisplayAsPercentage(field);
+        this.decimalPlacesNumber = fieldsUtil.getDecimalPlaces(field);
+    }
+}
+exports.Decimal = Decimal;
 class KDate extends MetadataField {
     constructor(field) {
         if (!field) {
@@ -198,6 +222,34 @@ class ReferenceField extends MetadataField {
     }
 }
 exports.ReferenceField = ReferenceField;
+class Rollup extends MetadataField {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('rollup', field);
+        this.rollupType = fieldsUtil.getRollupType(field);
+        this.rollupObjectApiName = fieldsUtil.getRollupObjectApiName(field);
+        this.rollupFieldApiName = fieldsUtil.getRollupFieldApiName(field);
+        this.rollupLookupFieldApiName = fieldsUtil.getRollupLookupFieldApiName(field);
+        this.filter = fieldsUtil.getRollupFilter(field);
+    }
+}
+exports.Rollup = Rollup;
+class Region extends MetadataField {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('region', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getSettingsMultiple(field);
+        this.optionLevel = fieldsUtil.getRegionOptionLevel(field);
+        this.strictLevel = fieldsUtil.getRegionStrictLeve(field);
+        this.filter = fieldsUtil.getRegionSettingsFilter(field);
+    }
+}
+exports.Region = Region;
 class File extends MetadataField {
     constructor(field) {
         if (!field) {
@@ -310,25 +362,8 @@ const type2fieldType = {
     'attachment': File,
     'back_lookup': BackLookup,
     'richText': RichText,
-};
-const fieldTypeMap = {
-    'text': 'text',
-    'multilingual': 'multilingual',
-    'number': 'float',
-    'date': 'date',
-    'dateTime': 'datetime',
-    'option': 'enum',
-    'email': 'email',
-    'mobileNumber': 'phone',
-    'boolean': 'boolean',
-    'avatarOrLogo': 'avatar',
-    'lookup': 'lookup',
-    'formula': 'formula',
-    'autoId': 'auto_number',
-    'referenceField': 'reference_field',
-    'file': 'attachment',
-    'backLookup': 'back_lookup',
-    'compositeType': 'compositeType',
-    'extractSingleRecord': 'compositeType',
-    'richText': 'richText',
+    'bigint': Bigint,
+    'decimal': Decimal,
+    'rollup': Rollup,
+    'region': Region,
 };

package/context/metadata/objects/fields.util.d.ts

@@ -1,4 +1,4 @@
-import { FieldType, FilterType, SortConditionType, SubOptionType } from '../types/objects';
+import { CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
 import { I18ns } from '../types/common';
 declare function getUnique(field: FieldType): boolean;
 declare function getCaseSensitive(field: FieldType): boolean;
@@ -35,6 +35,14 @@ declare function getSettingsMultiple(field: FieldType): boolean;
 declare function getCompositeTypeApiName(field: FieldType): string;
 declare function getCompositeTypeSubFields(field: FieldType): object[];
 declare function getSettingsFilter(field: FieldType): FilterType[];
+export declare function getRegionSettingsFilter(field: FieldType): RegionFilterType[];
 declare function getSettingsSort(field: FieldType): SortConditionType[];
 declare function getRecordPosition(field: FieldType): number;
+export declare function getRollupType(field: FieldType): string;
+export declare function getRollupObjectApiName(field: FieldType): string;
+export declare function getRollupFieldApiName(field: FieldType): string;
+export declare function getRollupLookupFieldApiName(field: FieldType): string;
+export declare function getRegionOptionLevel(field: FieldType): boolean;
+export declare function getRegionStrictLeve(field: FieldType): number;
+export declare function getRollupFilter(field: FieldType): CriterionType;
 export { getUnique, getCaseSensitive, getMultiline, getMaxLength, getRegexpExpression, getRegexpErrMsg, getDisplayAsPercentage, getDecimalPlaces, getMultiple, getOptionSource, getGlobalOptionApiName, getOptionList, getDescriptionWhenTrue, getDescriptionWhenFalse, getDefaultValue, getDisplayStyle, getLookupRefObjectApiName, getLookupIsHierarchy, getLookupDisplayStyle, getReturnType, getFormula, getGenerateMethod, getDigitsNumber, getPrefix, getSuffix, getReferenceObjectApiName, getReferenceFieldApiName, getFileMultiple, getFileTypes, getBackLookupObjectApiName, getBackLookupFieldApiName, getSettingsMultiple, getCompositeTypeApiName, getCompositeTypeSubFields, getSettingsFilter, getSettingsSort, getRecordPosition, };

package/context/metadata/objects/fields.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = void 0;
+exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = exports.getRollupFilter = exports.getRegionStrictLeve = exports.getRegionOptionLevel = exports.getRollupLookupFieldApiName = exports.getRollupFieldApiName = exports.getRollupObjectApiName = exports.getRollupType = exports.getRegionSettingsFilter = void 0;
 const common = require("@byted-apaas/server-common-node");
 const common_1 = require("../types/common");
 const commonConstants = common.constants;
@@ -283,6 +283,13 @@ function getSettingsFilter(field) {
     return [];
 }
 exports.getSettingsFilter = getSettingsFilter;
+function getRegionSettingsFilter(field) {
+    if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
+        return field.type.settings.filter;
+    }
+    return [];
+}
+exports.getRegionSettingsFilter = getRegionSettingsFilter;
 // TODO 结构转换
 function getSettingsSort(field) {
     let res = [];
@@ -317,3 +324,55 @@ function getRecordPosition(field) {
     return pos;
 }
 exports.getRecordPosition = getRecordPosition;
+function getRollupType(field) {
+    if (field && field.type && field.type.settings && field.type.settings.rollup_function_type) {
+        return field.type.settings.rollup_function_type;
+    }
+    return "";
+}
+exports.getRollupType = getRollupType;
+function getRollupObjectApiName(field) {
+    if (field && field.type && field.type.settings && field.type.settings.rolluped_object && field.type.settings.rolluped_object.api_alias) {
+        return field.type.settings.rolluped_object.api_alias;
+    }
+    return "";
+}
+exports.getRollupObjectApiName = getRollupObjectApiName;
+function getRollupFieldApiName(field) {
+    if (field && field.type && field.type.settings && field.type.settings.rolluped_field && field.type.settings.rolluped_field.api_alias) {
+        return field.type.settings.rolluped_field.api_alias;
+    }
+    return "";
+}
+exports.getRollupFieldApiName = getRollupFieldApiName;
+function getRollupLookupFieldApiName(field) {
+    if (field && field.type && field.type.settings && field.type.settings.rolluped_lookup_field && field.type.settings.rolluped_lookup_field.api_alias) {
+        return field.type.settings.rolluped_lookup_field.api_alias;
+    }
+    return "";
+}
+exports.getRollupLookupFieldApiName = getRollupLookupFieldApiName;
+function getRegionOptionLevel(field) {
+    if (field && field.type && field.type.settings && field.type.settings.hasLevelStrict) {
+        return field.type.settings.hasLevelStrict;
+    }
+    return undefined;
+}
+exports.getRegionOptionLevel = getRegionOptionLevel;
+function getRegionStrictLeve(field) {
+    if (field && field.type && field.type.settings && field.type.settings.strictLevel) {
+        return field.type.settings.strictLevel;
+    }
+    return undefined;
+}
+exports.getRegionStrictLeve = getRegionStrictLeve;
+function getRollupFilter(field) {
+    if (field && field.type && field.type.settings && field.type.settings.rollup_range_filter) {
+        return {
+            conditions: field.type.settings.rollup_range_filter.conditions,
+            logic: field.type.settings.rollup_range_filter.logic
+        };
+    }
+    return undefined;
+}
+exports.getRollupFilter = getRollupFilter;

package/context/metadata/types/objects.d.ts

@@ -79,7 +79,7 @@ type ConditionType = {
     valueType: ('reference' | 'specified');
     right: (object | string);
 };
-type CriterionType = {
+export type CriterionType = {
     conditions: ConditionType[];
     logic: string;
 };
@@ -90,6 +90,13 @@ export type FilterType = {
     criterion: CriterionType;
     errorMsg: I18ns;
 };
+export type RegionFilterType = {
+    id: string;
+    label: string;
+    errorMessage: I18ns;
+    recordFilter: CriterionType;
+    precondition: object;
+};
 export interface Lookup extends BaseFieldType {
     required: boolean;
     multiple: boolean;
@@ -213,6 +220,19 @@ export type FieldType = {
                 'type': string;
             };
             'is_extract': boolean;
+            'rollup_function_type': string;
+            'rolluped_object': {
+                'api_alias': string;
+            };
+            'rolluped_field': {
+                'api_alias': string;
+            };
+            'rolluped_lookup_field': {
+                'api_alias': string;
+            };
+            'rollup_range_filter': CriterionType;
+            'hasLevelStrict': boolean;
+            'strictLevel': number;
         };
     };
     'unique_type': number;

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

@@ -1,3 +1,5 @@
+import { IApprovalInstance, IApprovalInstanceListOptions, IApprovalInstanceList, IGetApprovalInstanceOptions } from '../../../request/structs';
+export declare function NewFlow(): Flow;
 export interface Flow {
     /**
      * 获取流程实例人工任务详情列表
@@ -25,6 +27,17 @@ export interface Flow {
      * @constructor
      */
     getExecutionInfo: (executionId: number) => Promise<ExecutionInfo>;
+    /**
+     * 获取审批实例列表
+     * @param options 请求参数，可选
+     */
+    getApprovalInstanceList: (options?: IApprovalInstanceListOptions) => Promise<IApprovalInstanceList>;
+    /**
+     * 获取审批实例详情
+     * @param approvalInstanceId 实例ID
+     * @param option 请求参数，可选
+     */
+    getApprovalInstance: (options: IGetApprovalInstanceOptions) => Promise<IApprovalInstance>;
 }
 export interface Execution {
     /**

package/global/application/flow/flow.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewFlow = void 0;
+const flow_1 = require("./impl/flow");
+function NewFlow() {
+    return new flow_1.Flow();
+}
+exports.NewFlow = NewFlow;

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

@@ -0,0 +1,10 @@
+import { Flow as IFlow, ExecuteOptions, ExecutionResult, ExecutionInfo, FlowTaskInfo, RevokeExecutionOptions } from '../flow';
+import { IApprovalInstance, IApprovalInstanceList, IApprovalInstanceListOptions, IGetApprovalInstanceOptions } from "../../../../request/structs";
+export declare class Flow implements IFlow {
+    execute(APIName: string, options: ExecuteOptions | undefined): Promise<ExecutionResult>;
+    getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
+    getExecutionUserTaskInfo(executionId: number): Promise<FlowTaskInfo[]>;
+    revokeExecution(executionId: number, options: RevokeExecutionOptions): Promise<void>;
+    getApprovalInstanceList(options?: IApprovalInstanceListOptions): Promise<IApprovalInstanceList>;
+    getApprovalInstance(options: IGetApprovalInstanceOptions): Promise<IApprovalInstance>;
+}

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Flow = void 0;
+const exceptions_1 = require("@byted-apaas/server-common-node/utils/exceptions");
+const Request = require("../../../../request/interface");
+const server_common_node_1 = require("@byted-apaas/server-common-node");
+class Flow {
+    async execute(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 && 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}`);
+        }
+        if (!options) {
+            options = {};
+        }
+        return await Request.GetInstance().executeFlow(APIName, options);
+    }
+    async getExecutionInfo(executionId) {
+        if (!executionId || typeof executionId !== 'number') {
+            throw new exceptions_1.InvalidParamError(`param's type (${executionId}) is not matched to number, but is ${typeof executionId}`);
+        }
+        return await Request.GetInstance().getExecutionInfo(executionId);
+    }
+    async getExecutionUserTaskInfo(executionId) {
+        if (!executionId || typeof executionId !== 'number') {
+            throw new exceptions_1.InvalidParamError(`param's type (${executionId}) need number, but is ${typeof executionId}`);
+        }
+        return await Request.GetInstance().getExecutionUserTaskInfo(BigInt(executionId));
+    }
+    async revokeExecution(executionId, options) {
+        if (!executionId || typeof executionId !== 'number') {
+            throw new exceptions_1.InvalidParamError(`param's type (${executionId}) is need number, but is ${typeof executionId}`);
+        }
+        return await Request.GetInstance().revokeExecution(executionId, options);
+    }
+    async getApprovalInstanceList(options) {
+        return await Request.GetInstance().getApprovalInstanceList(options);
+    }
+    async getApprovalInstance(options) {
+        if (!options || !options.approvalInstanceId) {
+            throw new exceptions_1.InvalidParamError(`required parameter approvalInstanceId is empty`);
+        }
+        if (typeof options.approvalInstanceId !== 'number') {
+            throw new exceptions_1.InvalidParamError(`param's type (${options.approvalInstanceId}) is need number, but is ${typeof options.approvalInstanceId}`);
+        }
+        return await Request.GetInstance().getApprovalInstance(options);
+    }
+}
+exports.Flow = Flow;

package/hooks/hooks.js

@@ -10,6 +10,7 @@ const db_1 = require("../context/db/impl/db");
 const common_1 = require("../request/common");
 const integration_1 = require("../context/integration/impl/integration");
 const metadataApi = require("../context/metadata/metadata");
+const flow_1 = require("../global/application/flow/flow");
 /**
  * 根据 key 获取对应的全局变量
  * @param key 全局变量的 key
@@ -94,12 +95,7 @@ function mountApplication(context) {
     }
     global.application.constants.metaType = metadataApi.metaType();
     // flow
-    global.application.flow = ({
-        getExecutionUserTaskInfo: api.mockGetExecutionUserTaskInfo(),
-        execute: api.mockExecuteFlow(),
-        revokeExecution: api.mockRevokeExecution(),
-        getExecutionInfo: api.mockGetExecutionInfo(),
-    });
+    global.application.flow = (0, flow_1.NewFlow)();
     // operator
     global.application.operator = new operator_1.Operator();
     global.application.integration = new integration_1._Integration();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.13-beta.2",
+  "version": "1.1.13-beta.4",
   "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.0-beta.2",
+    "@byted-apaas/server-common-node": "^2.0.1-beta.4",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",
@@ -24,10 +24,12 @@
     "@types/google-protobuf": "^3.15.6",
     "@types/mocha": "^9.0.0",
     "@types/node-fetch": "^2.6.2",
+    "@types/sinon": "^17.0.2",
     "axios": "^0.21.0",
     "madge": "^3.12.0",
     "mocha": "^9.1.3",
-    "node-cls": "^1.0.7"
+    "node-cls": "^1.0.7",
+    "sinon": "^17.0.1"
   },
   "mocha": {
     "color": true,
@@ -39,4 +41,4 @@
     ],
     "timeout": 20000
   }
-}
+}

package/request/constants.d.ts

@@ -7,4 +7,6 @@ export declare const openapiHttpPath: {
     executeFlow: PostHttpConfig;
     revokeExecution: PostHttpConfig;
     getExecutionInfo: GetHttpConfig;
+    getApprovalInstanceList: GetHttpConfig;
+    getApprovalInstance: GetHttpConfig;
 };

package/request/constants.js

@@ -13,6 +13,8 @@ exports.metricsMethodKeys = {
     getExecutionInfo: 'openapi_getExecutionInfo',
     revokeExecution: 'openapi_revokeExecution',
     executeFlow: 'openapi_executeFlow',
+    getApprovalInstanceList: 'openapi_getApprovalInstanceList',
+    getApprovalInstance: 'openapi_getApprovalInstance',
 };
 exports.openapiHttpPath = {
     getBatchAttachmentToken: new config_1.PostHttpConfig(`/attachment/v1/getBatchAttachmentToken`, exports.metricsMethodKeys.getBatchAttachmentToken),
@@ -22,4 +24,6 @@ exports.openapiHttpPath = {
     executeFlow: new config_1.PostHttpConfig(`/api/flow/v1/namespaces/${constants_1.replaceKeys.namespace}/flows/${constants_1.replaceKeys.apiName}/execute`, exports.metricsMethodKeys.executeFlow),
     revokeExecution: new config_1.PostHttpConfig(`/api/flow/v1/namespaces/${constants_1.replaceKeys.namespace}/executions/${constants_1.replaceKeys.id}/revoke`, exports.metricsMethodKeys.revokeExecution),
     getExecutionInfo: new config_1.GetHttpConfig(`/api/flow/v1/namespaces/${constants_1.replaceKeys.namespace}/executions/${constants_1.replaceKeys.id}/detail`, exports.metricsMethodKeys.getExecutionInfo),
+    getApprovalInstanceList: new config_1.GetHttpConfig(`/api/approval/v1/approval_instances/listids`, exports.metricsMethodKeys.getApprovalInstanceList),
+    getApprovalInstance: new config_1.GetHttpConfig(`/api/approval/v1/approval_instances/${constants_1.replaceKeys.id}`, exports.metricsMethodKeys.getApprovalInstance),
 };

package/request/interface.d.ts

@@ -5,6 +5,7 @@ import { Stream } from 'stream';
 import { ExecutionInfo, ExecutionResult, RevokeExecutionOptions } from '@byted-apaas/server-common-node/context/workflow/workflow';
 import { AppCtx } from '../application/application';
 import { Order } from '../context/db/impl/order';
+import { IApprovalInstance, IApprovalInstanceList, IApprovalInstanceListOptions, IGetApprovalInstanceOptions } from "./structs";
 export declare function GetHttpInstance(): IInnerAPIRequest;
 export declare function GetInstance(): IInnerAPIRequest;
 export declare function GetFaaSInfraInstance(): IFaaSInfraRequest;
@@ -85,6 +86,8 @@ export interface IInnerAPIBaseRequest {
     getIntegrationTenantAccessToken: (apiName: string) => Promise<TenantAccessToken>;
     getDefaultIntegrationAppAccessToken: () => Promise<AppAccessToken>;
     getDefaultIntegrationTenantAccessToken: () => Promise<TenantAccessToken>;
+    getApprovalInstanceList: (options?: IApprovalInstanceListOptions) => Promise<IApprovalInstanceList>;
+    getApprovalInstance: (options: IGetApprovalInstanceOptions) => Promise<IApprovalInstance>;
 }
 export interface IInnerAPIOpenSDKRequest {
     openSDKCreateRecordBySync: (objectApiName: string, record: object) => any;

package/request/openapi.d.ts

@@ -6,6 +6,7 @@ import { Criterion } from '../kunlun/operator/impl/logic';
 import { IInnerAPIRequest, OpenSDKGetRecordsReq, UploadFileResp } from './interface';
 import { ExecutionInfo, ExecutionResult, RevokeExecutionOptions } from '@byted-apaas/server-common-node/context/workflow/workflow';
 import { AppCtx } from '../application/application';
+import { IApprovalInstance, IApprovalInstanceListOptions, IApprovalInstanceList, IGetApprovalInstanceOptions } from "./structs";
 export declare function updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): Promise<void>;
 export declare class RequestHttp implements IInnerAPIRequest {
     constructor();
@@ -67,6 +68,8 @@ export declare class RequestHttp implements IInnerAPIRequest {
     openSDKUploadFile(fileName: string, data: Buffer): any;
     openSDKUploadAvatar(fileName: string, data: Buffer): any;
     openSDKDownloadAvatar(imageID: string): Promise<Buffer>;
+    getApprovalInstanceList(params?: IApprovalInstanceListOptions): Promise<IApprovalInstanceList>;
+    getApprovalInstance(params: IGetApprovalInstanceOptions): Promise<IApprovalInstance>;
 }
 export declare function getExecutionUserTaskInfo(executionId: bigint): Promise<any>;
 export declare function executeFlow(APIName: string, option: any): Promise<ExecutionResult>;

package/request/openapi.js

@@ -292,6 +292,9 @@ async function getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearc
     let options = commonHttp.getOptions(null, needCount ? openapiHttpPath.mGetCountByCriterionV2 : openapiHttpPath.mGetRecordByCriterionV2);
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.objectApiName, objectApiName);
+    if (needCount) {
+        fieldApiNames = ['_id'];
+    }
     // 3.请求
     options.json = {
         'criterion': JSON.parse(criterion),
@@ -829,10 +832,10 @@ class RequestHttp {
     createRecordsBySync(objectApiName, records, authType) {
     }
     updateRecordsBySync(objectApiName, recordMap, authType) {
-        return undefined;
+        return new Promise(undefined);
     }
     deleteRecordsBySync(objectApiName, recordIDs, authType) {
-        return undefined;
+        return new Promise(undefined);
     }
     getRecordsOrCountByCriterion(objectApiName, criterion, order, fuzzySearch, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     }
@@ -859,8 +862,8 @@ class RequestHttp {
     }
     terminateWorkflowInstance(workflowInstanceId, operator, reason) {
     }
-    modifyRecordsWithTransaction(placeholders, operations, authType) {
-        return null;
+    async modifyRecordsWithTransaction(placeholders, operations, authType) {
+        return new Promise(undefined);
     }
     getGlobalConfigByKey(key) {
         return null;
@@ -942,6 +945,94 @@ class RequestHttp {
         return null;
     }
     ;
+    async getApprovalInstanceList(params) {
+        let options = commonHttp.getOptions(null, constants_2.openapiHttpPath.getApprovalInstanceList);
+        let urlPath = options._reqPath;
+        // 设置参数
+        const searchParams = {};
+        if (params && params.startTime && params.startTime > 0) {
+            searchParams.start_time = params.startTime;
+        }
+        if (params && params.endTime && params.endTime > 0) {
+            searchParams.end_time = params.endTime;
+        }
+        if (params && params.limit && params.limit > 0) {
+            searchParams.limit = params.limit;
+        }
+        if (params && params.pageToken) {
+            searchParams.page_token = params.pageToken;
+        }
+        options.searchParams = searchParams;
+        // 发起请求
+        let resp = await openapi.doRequest(null, urlPath, options);
+        // 应答
+        return {
+            approvalInstanceIds: resp.approval_instance_ids,
+            pageToken: resp.page_token,
+            count: resp.count,
+            hasMore: resp.has_more,
+        };
+    }
+    async getApprovalInstance(params) {
+        let options = commonHttp.getOptions(null, constants_2.openapiHttpPath.getApprovalInstance);
+        let urlPath = options._reqPath.replace(replaceKeys.id, String(params.approvalInstanceId));
+        // 设置参数
+        const searchParams = {
+            includes: "",
+        };
+        const includes = [];
+        if (params && params.includeContent) {
+            includes.push('ApprovalComment_Content');
+        }
+        if (params && params.includeFormData) {
+            includes.push('ApprovalTask_FormData');
+        }
+        searchParams.includes = includes.join(",");
+        options.searchParams = searchParams;
+        // 发起请求
+        let resp = await openapi.doRequest(null, urlPath, options);
+        if (!resp || !resp.approval_instance) {
+            return undefined;
+        }
+        // 处理应答
+        const approvalInstance = resp.approval_instance;
+        const result = {
+            id: approvalInstance.id,
+            label: approvalInstance.label,
+            initiator: approvalInstance.initiator,
+            instanceStartTime: approvalInstance.instance_start_time,
+            status: approvalInstance.status,
+            tasks: [],
+            comments: [],
+        };
+        if (!approvalInstance.tasks && Array.isArray(approvalInstance.tasks)) {
+            for (let task of approvalInstance.tasks) {
+                result.tasks.push({
+                    id: task.id,
+                    taskStatus: task.task_status,
+                    taskStartTime: task.task_start_time,
+                    taskEndTime: task.task_end_time,
+                    formData: task.form_data,
+                    approvalLogic: task.approval_logic,
+                    approvers: task.approvers,
+                    assigners: task.assigners,
+                    taskURL: task.task_url,
+                });
+            }
+        }
+        if (!approvalInstance.comments && Array.isArray(approvalInstance.comments)) {
+            for (let comment of approvalInstance.comments) {
+                result.comments.push({
+                    id: comment.id,
+                    commenter: comment.commenter,
+                    content: comment.content,
+                    createAt: comment.create_at,
+                    updateAt: comment.update_at,
+                });
+            }
+        }
+        return result;
+    }
 }
 exports.RequestHttp = RequestHttp;
 async function invokeFuncWithAuth(idOrName, params) {

package/request/structs.d.ts

@@ -0,0 +1,97 @@
+export interface IApprovalInstanceListReq {
+    start_time?: number;
+    end_time?: number;
+    limit?: number;
+    page_token?: string;
+}
+export interface IGetApprovalInstanceListResp {
+    approval_instance_ids: number[];
+    page_token: string;
+    count: number;
+    has_more: boolean;
+}
+export interface IGetApprovalInstanceResp {
+    approval_instance: {
+        id: number;
+        label: Record<string, string>;
+        initiator: number;
+        instance_start_time: number;
+        status: string;
+        tasks: {
+            id: number;
+            task_status: string;
+            task_start_time: number;
+            task_end_time: number;
+            form_data: string;
+            approval_logic: string;
+            approvers: number[];
+            assigners: number[];
+            task_url: string;
+        }[];
+        comments: {
+            id: number;
+            commenter: number;
+            content: string;
+            create_at: number;
+            update_at: number;
+        }[];
+    };
+}
+export interface IApprovalInstanceReq {
+    includes: string;
+}
+export interface IApprovalInstanceListOptions {
+    startTime?: number;
+    endTime?: number;
+    limit?: number;
+    pageToken?: string;
+}
+export interface IApprovalInstanceList {
+    approvalInstanceIds: number[];
+    pageToken: string;
+    count: number;
+    hasMore: boolean;
+}
+export declare enum ApprovalInstanceStatus {
+    IN_PROCESS = "in_process",
+    AGREED = "agreed",
+    INPROCESS = "rejected",
+    CANCELED = "canceled",
+    FAILED = "failed",
+    COMPLETED = "completed",
+    UNSTARTED = "unstarted",
+    AUTO_END = "auto_end",
+    TERMINATED = "terminated"
+}
+export interface IApprovalInstance {
+    id: number;
+    label: Record<string, string>;
+    initiator: number;
+    instanceStartTime: number;
+    status: string;
+    tasks: IApprovalTask[];
+    comments: IApprovalComment[];
+}
+export interface IApprovalComment {
+    id: number;
+    commenter: number;
+    content: string;
+    createAt: number;
+    updateAt: number;
+}
+export interface IApprovalTask {
+    id: number;
+    taskStatus: string;
+    taskStartTime: number;
+    taskEndTime: number;
+    formData: string;
+    approvalLogic: string;
+    approvers: number[];
+    assigners: number[];
+    taskURL: string;
+}
+export interface IGetApprovalInstanceOptions {
+    approvalInstanceId: number;
+    includeFormData?: boolean;
+    includeContent?: boolean;
+}

package/request/structs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApprovalInstanceStatus = void 0;
+var ApprovalInstanceStatus;
+(function (ApprovalInstanceStatus) {
+    ApprovalInstanceStatus["IN_PROCESS"] = "in_process";
+    ApprovalInstanceStatus["AGREED"] = "agreed";
+    ApprovalInstanceStatus["INPROCESS"] = "rejected";
+    ApprovalInstanceStatus["CANCELED"] = "canceled";
+    ApprovalInstanceStatus["FAILED"] = "failed";
+    ApprovalInstanceStatus["COMPLETED"] = "completed";
+    ApprovalInstanceStatus["UNSTARTED"] = "unstarted";
+    ApprovalInstanceStatus["AUTO_END"] = "auto_end";
+    ApprovalInstanceStatus["TERMINATED"] = "terminated";
+})(ApprovalInstanceStatus = exports.ApprovalInstanceStatus || (exports.ApprovalInstanceStatus = {}));