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

package/request/faasinfra.js

@@ -1,146 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FaaSInfraRequest = void 0;
-const common = require("@byted-apaas/server-common-node");
-const headers = common.constants.headers;
-const commonHttp = common.http;
-const faasinfra = common.http.faasinfra;
-const faasinfraHttpPath = common.http.faasinfraHttpPath;
-const replaceKeys = common.http.replaceKeys;
-const exceptions = common.exceptions;
-const utils = common.utils;
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const nodeCls = require('node-cls'); //nolint:byted_s_ts_no_require_imports
-const loopMasksKey = headers.loopMasksKey;
-const loopCtxKey = headers.loopCtxKey;
-const url_1 = require("url");
-const exceptions_1 = require("@byted-apaas/server-common-node/utils/exceptions");
-class FaaSInfraRequest {
-    constructor() {
-    }
-    async createDistributeTaskV1(dataset, handlerFunc, progressCallbackFunc, completedCallbackFunc, options) {
-        // 1.获取 options
-        let config = commonHttp.getOptions(null, faasinfraHttpPath.createDistributedTask);
-        // 2.构造url
-        let urlPath = config._reqPath.replace(replaceKeys.namespace, utils.getNamespaceFromCtx());
-        // 3.请求
-        config.json = {
-            'domainName': utils.getTenantNameFromCtx(),
-            'namespace': utils.getNamespaceFromCtx(),
-            'userId': utils.getUserIDFromCtx(),
-            dataset,
-            handlerFunc,
-            progressCallbackFunc,
-            completedCallbackFunc,
-            options,
-        };
-        let task_id = utils.getTriggerTaskID();
-        if (task_id) {
-            config.json[headers.triggerTaskId] = task_id;
-        }
-        let loopCtx = nodeCls.get(loopCtxKey);
-        if (checkLoopCtx(loopCtx)) {
-            config.json[loopMasksKey] = loopCtx.loopMasks;
-            if (!utils.isMicroservice() && (handlerFunc !== '' && config.json[loopMasksKey].includes(utils.handleFuncName({}, handlerFunc))) ||
-                (progressCallbackFunc !== '' && config.json[loopMasksKey].includes(utils.handleFuncName({}, progressCallbackFunc))) ||
-                (completedCallbackFunc !== '' && config.json[loopMasksKey].includes(utils.handleFuncName({}, completedCallbackFunc)))) {
-                throw new exceptions.InvalidParamError('Task execution forms a loop.');
-            }
-        }
-        return await faasinfra.doRequest(null, urlPath, config);
-    }
-    async createDistributeTaskV2(dataset, handlerFunc, progressCallbackFunc, completedCallbackFunc, options) {
-        // 1.获取 options
-        let config = commonHttp.getOptions(null, faasinfraHttpPath.createDistributedTaskV2);
-        // 2.构造url
-        let urlPath = config._reqPath.replace(replaceKeys.namespace, utils.getNamespaceFromCtx());
-        // 3.请求
-        config.json = {
-            'domainName': utils.getTenantNameFromCtx(),
-            'namespace': utils.getNamespaceFromCtx(),
-            'userId': utils.getUserIDFromCtx(),
-            dataset,
-            handlerFunc,
-            progressCallbackFunc,
-            completedCallbackFunc,
-            options,
-            'extra': getDebugExtraInfo(),
-        };
-        let task_id = utils.getTriggerTaskID();
-        if (task_id) {
-            config.json[headers.triggerTaskId] = task_id;
-        }
-        let loopCtx = nodeCls.get(loopCtxKey);
-        if (checkLoopCtx(loopCtx)) {
-            config.json[loopMasksKey] = loopCtx.loopMasks;
-            if ((handlerFunc !== '' && config.json[loopMasksKey].includes(handlerFunc)) ||
-                (progressCallbackFunc !== '' && config.json[loopMasksKey].includes(progressCallbackFunc)) ||
-                (completedCallbackFunc !== '' && config.json[loopMasksKey].includes(completedCallbackFunc))) {
-                throw new exceptions.InvalidParamError(`Task execution forms a loop.`);
-            }
-        }
-        return await faasinfra.doRequest(null, urlPath, config);
-    }
-    async invokeMicroserviceSync(apiName, path, method, body) {
-        let reqPath = faasinfraHttpPath.invokeMicroserviceSync;
-        let options = commonHttp.getOptions(null, reqPath);
-        let urlPath = options._reqPath.replace(replaceKeys.namespace, utils.getNamespaceFromCtx());
-        options.json = {
-            'microserviceId': apiName,
-            path,
-            method,
-            'query': parseQueryParams(path),
-        };
-        // 处理 body 参数
-        if (method.toUpperCase() !== 'GET') {
-            options.json.body = JSON.stringify(body);
-        }
-        return await faasinfra.doRequest(null, urlPath, options);
-    }
-    async invokeMicroserviceAsync(apiName, path, method, body) {
-        let reqPath = faasinfraHttpPath.invokeMicroserviceAsync;
-        let options = commonHttp.getOptions(null, reqPath);
-        let urlPath = options._reqPath.replace(replaceKeys.namespace, utils.getNamespaceFromCtx());
-        options.json = {
-            'microserviceId': apiName,
-            path,
-            method,
-            'query': parseQueryParams(path),
-        };
-        // 处理 body 参数
-        if (method.toUpperCase() !== 'GET') {
-            options.json.body = JSON.stringify(body);
-        }
-        return await faasinfra.doRequest(null, urlPath, options);
-    }
-}
-exports.FaaSInfraRequest = FaaSInfraRequest;
-function getDebugExtraInfo() {
-    let extra = {
-        'FunctionFrameVersion': 'FunctionFrameV2',
-    };
-    if (utils.isDebug()) {
-        extra.DebugInfo = utils.getDebugCode();
-    }
-    return extra;
-}
-function checkLoopCtx(reqCtx) {
-    return reqCtx && reqCtx.loopMasks && Array.isArray(reqCtx.loopMasks);
-}
-function parseQueryParams(path) {
-    let params = {};
-    const url = new url_1.URL(path, 'https://aa.bb.cc');
-    for (let [k, v] of url.searchParams.entries()) {
-        if (typeof (k) !== 'string') {
-            throw new exceptions_1.InternalError(`The type of k should be string, but ${typeof (k)}`);
-        }
-        if (typeof (v) !== 'string') {
-            throw new exceptions_1.InternalError(`The type of v should be string, but ${typeof (v)}`);
-        }
-        params[k] = v.split(',');
-    }
-    if (Object.keys(params).length === 0) {
-        return undefined;
-    }
-    return params;
-}

package/request/interface.d.ts

@@ -1,121 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Criterion, CriterionV3 } from '../kunlun/operator/impl/logic';
-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;
-export type UploadFileResp = {
-    id: string;
-    token: string;
-    size: bigint;
-    mime_type: string;
-    name: string;
-};
-export type OrderV2 = {
-    field: string;
-    direction: string;
-    type: string;
-};
-export type OpenSDKGetRecordsReq = {
-    limit: number;
-    offset: number;
-    fields: string[];
-    quickSearch?: string;
-    filter: any[];
-    sort: OrderV2[];
-    count: boolean;
-};
-export type AppAccessToken = {
-    expire: number;
-    appAccessToken: string;
-    appId: string;
-};
-export type TenantAccessToken = {
-    expire: number;
-    tenantAccessToken: string;
-    appId: string;
-};
-export interface IInnerAPIRequest extends IInnerAPIBaseRequest, IInnerAPIOpenSDKRequest {
-}
-export interface IInnerAPIBaseRequest {
-    createRecordBySync: (objectApiName: string, record: object, authType: string) => any;
-    createRecordBySyncV3: (objectApiName: string, record: object, authType: string) => any;
-    updateRecordBySync: (objectApiName: string, recordID: number, record: object, authType: string) => any;
-    updateRecordBySyncV3: (objectApiName: string, recordID: string, record: object, authType: string) => any;
-    deleteRecordBySync: (objectApiName: string, recordID: number, authType: string) => any;
-    deleteRecordBySyncV3: (objectApiName: string, recordID: string, authType: string) => any;
-    createRecordsByAsync: (objectApiName: string, records: object[], authType: string) => any;
-    updateRecordsByAsync: (objectApiName: string, recordMap: Record<number, object>, authType: string) => any;
-    deleteRecordsByAsync: (objectApiName: string, recordIDs: number[], authType: string) => any;
-    createRecordsBySync: (objectApiName: string, records: object[], authType: string) => any;
-    createRecordsBySyncV3: (objectApiName: string, records: object[], authType: string) => any;
-    updateRecordsBySync: (objectApiName: string, recordMap: Record<number, object>, authType: string) => Promise<Record<number, string>>;
-    updateRecordsBySyncV3: (objectApiName: string, recordMap: object[], authType: string) => Promise<Record<string, string>>;
-    deleteRecordsBySync: (objectApiName: string, recordIDs: number[], authType: string) => Promise<Record<number, string>>;
-    deleteRecordsBySyncV3: (objectApiName: string, recordIDs: string[], authType: string) => Promise<Record<string, string>>;
-    getRecordsOrCountByCriterion: (objectApiName: string, criterion: string | Criterion, fuzzySearch: any, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string) => any;
-    getRecordsV3OrCounByCriterion: (objectApiName: string, criterion: string | CriterionV3, quickQuery: string, quickQueryFields: string[], order: Order[], fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string) => any;
-    updateWorkflowVariables: (ctx: any, instanceId: number, variables: object, variableTypes: object) => Promise<void>;
-    uploadFile: (data: Stream, expire: number, fileName?: string) => Promise<UploadFileResp>;
-    downloadFileByID: (fileID: string, filePath?: string) => Promise<Buffer | undefined>;
-    downloadFileByToken: (fileToken: string, filePath?: string) => Promise<Buffer | undefined>;
-    createMessage: (msg: any) => Promise<number>;
-    updateMessage: (msgId: number, msg: any) => Promise<void>;
-    getFields: (objectApiName: string) => Promise<any>;
-    getField: (objectApiName: string, fieldApiName: string) => Promise<any>;
-    terminateWorkflowInstance: (workflowInstanceId: number, operator: number, reason: string) => Promise<void>;
-    modifyRecordsWithTransaction: (placeholders: Record<string, number>, operations: object[], authType: string, version: string) => Promise<Map<string, number>>;
-    getGlobalConfigByKey: <valueT>(key: string) => Promise<valueT>;
-    oql: (oql: string, args: any[], namedArgs: Record<string, any>, authType: string) => Promise<string | any[]>;
-    invokeFuncSync: (idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any) => Promise<any>;
-    createAsyncTaskV1: (idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any) => Promise<any>;
-    createAsyncTaskV2: (name: string, params: any) => Promise<any>;
-    getExecutionUserTaskInfo: (executionId: bigint) => Promise<any>;
-    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>;
-    mGetFileToken: (ids: string[]) => Promise<string>;
-    getIntegrationAppAccessToken: (apiName: string) => Promise<AppAccessToken>;
-    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;
-    openSDKUpdateRecordBySync: (objectApiName: string, recordID: number, record: object) => any;
-    openSDKDeleteRecordBySync: (objectApiName: string, recordID: number) => any;
-    openSDKCreateRecordsBySync: (objectApiName: string, records: object[]) => any;
-    openSDKUpdateRecordsBySync: (objectApiName: string, recordMap: Record<number, object>) => any;
-    openSDKDeleteRecordsBySync: (objectApiName: string, recordIDs: number[]) => any;
-    openSDKGetRecords: (objectApiName: string, param: OpenSDKGetRecordsReq) => any;
-    openSDKUploadFile: (fileName: string, data: Buffer) => any;
-    openSDKUploadAvatar: (fileName: string, data: Buffer) => any;
-    openSDKDownloadAvatar: (imageID: string) => any;
-    invokeFuncWithAuth: (idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any) => Promise<any>;
-}
-export interface IFaaSInfraRequest {
-    createDistributeTaskV1: (dataset: any, handlerFunc: string, progressCallbackFunc: string, completedCallbackFunc: string, options: any) => Promise<any>;
-    createDistributeTaskV2: (dataset: any, handlerFunc: string, progressCallbackFunc: string, completedCallbackFunc: string, options: any) => Promise<any>;
-    invokeMicroserviceSync: (apiName: string, path: string, method: string, body: any) => Promise<any>;
-    invokeMicroserviceAsync: (apiName: string, path: string, method: string, body: any) => Promise<any>;
-}

package/request/interface.js

@@ -1,30 +0,0 @@
-"use strict";
-// Copyright 2022 ByteDance Ltd. and/or its affiliates
-// SPDX-License-Identifier: MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetFaaSInfraInstance = exports.GetInstance = exports.GetHttpInstance = void 0;
-const openapi_1 = require("./openapi");
-const faasinfra_1 = require("./faasinfra");
-const version_1 = require("../version/version");
-const server_common_node_1 = require("@byted-apaas/server-common-node");
-const requestInstanceMap = {
-    'httpRequest': null,
-    'rpcRequest': null,
-};
-function GetHttpInstance() {
-    if (!requestInstanceMap.httpRequest) {
-        requestInstanceMap.httpRequest = new openapi_1.RequestHttp();
-        // 设置 SDK 版本信息到请求上下文，用于埋点上报
-        server_common_node_1.utils.setSDKInfo(version_1.SDKName, version_1.SDKVersion);
-    }
-    return requestInstanceMap.httpRequest;
-}
-exports.GetHttpInstance = GetHttpInstance;
-function GetInstance() {
-    return GetHttpInstance();
-}
-exports.GetInstance = GetInstance;
-function GetFaaSInfraInstance() {
-    return new faasinfra_1.FaaSInfraRequest();
-}
-exports.GetFaaSInfraInstance = GetFaaSInfraInstance;

package/request/openapi.d.ts

@@ -1,84 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Stream } from 'stream';
-import { Order } from '../context/db/impl/order';
-import { Criterion, CriterionV3 } 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();
-    updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): any;
-    createRecordBySync(objectApiName: string, record: object, authType: string): any;
-    createRecordBySyncV3(objectApiName: string, record: object, authType: string): any;
-    updateRecordBySync(objectApiName: string, recordID: number, record: object, authType: string): any;
-    updateRecordBySyncV3(objectApiName: string, recordID: string, record: object, authType: string): any;
-    deleteRecordBySync(objectApiName: string, recordID: number, authType: string): any;
-    deleteRecordBySyncV3(objectApiName: string, recordID: string, authType: string): any;
-    createRecordsByAsync(objectApiName: string, records: object[], authType: string): any;
-    updateRecordsByAsync(objectApiName: string, recordMap: Record<number, object>, authType: string): any;
-    deleteRecordsByAsync(objectApiName: string, recordIDs: number[], authType: string): any;
-    createRecordsBySync(objectApiName: string, records: object[], authType: string): any;
-    createRecordsBySyncV3(objectApiName: string, records: object[], authType: string): any;
-    updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>, authType: string): Promise<Record<number, string>>;
-    updateRecordsBySyncV3(objectApiName: string, records: object[], authType: string): Promise<Record<string, string>>;
-    deleteRecordsBySync(objectApiName: string, recordIDs: number[], authType: string): Promise<Record<number, string>>;
-    deleteRecordsBySyncV3(objectApiName: string, recordIDs: string[], authType: string): Promise<Record<string, string>>;
-    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], fuzzySearch: any, ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
-    getRecordsV3OrCounByCriterion(objectApiName: string, criterion: string | CriterionV3, quickQuery: string, quickQueryFields: string[], order: Order[], fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
-    uploadFile(data: Stream, expire: number, fileName?: string): Promise<UploadFileResp>;
-    downloadFileByID(fileID: string, filePath?: string): Promise<undefined | Buffer>;
-    downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | undefined>;
-    createMessage(msg: any): Promise<number>;
-    updateMessage(msgId: number, msg: any): Promise<void>;
-    getFields(objectApiName: string): any;
-    getField(objectApiName: string, fieldApiName: string): any;
-    terminateWorkflowInstance(workflowInstanceId: number, operator: number, reason: string): any;
-    modifyRecordsWithTransaction(placeholders: Record<string, number>, operations: object[], authType: string, version: string): Promise<Map<string, number>>;
-    getGlobalConfigByKey<valueT>(key: string): Promise<valueT>;
-    oql(oql: string, args: any[], namedArgs: Record<string, any>, authType: string): any;
-    invokeFuncSync(idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any): Promise<any>;
-    invokeFuncWithAuth(idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any): Promise<any>;
-    createAsyncTaskV1(idOrName: {
-        APIId?: string;
-        APIName?: string;
-        isInvokeByAPIName: boolean;
-    }, params: any): Promise<any>;
-    createAsyncTaskV2(name: string, params: any): Promise<any>;
-    getExecutionUserTaskInfo(executionId: bigint): Promise<any>;
-    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>;
-    mGetFileToken(ids: string[]): Promise<string>;
-    getIntegrationAppAccessToken(apiName: string): Promise<any>;
-    getIntegrationTenantAccessToken(apiName: string): Promise<any>;
-    getDefaultIntegrationAppAccessToken(): Promise<any>;
-    getDefaultIntegrationTenantAccessToken(): Promise<any>;
-    openSDKCreateRecordBySync(objectApiName: string, record: object): any;
-    openSDKUpdateRecordBySync(objectApiName: string, recordID: number, record: object): any;
-    openSDKDeleteRecordBySync(objectApiName: string, recordID: number): any;
-    openSDKCreateRecordsBySync(objectApiName: string, records: object[]): any;
-    openSDKUpdateRecordsBySync(objectApiName: string, recordMap: Record<number, object>): any;
-    openSDKDeleteRecordsBySync(objectApiName: string, recordIDs: number[]): any;
-    openSDKGetRecords(objectApiName: string, param: OpenSDKGetRecordsReq): Promise<any | number>;
-    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, async: any): Promise<ExecutionResult>;
-export declare function revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
-export declare function getExecutionInfo(executionId: number): Promise<ExecutionInfo>;