@byted-apaas/server-sdk-node 0.0.1-beta.3

package/request/interface.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Criterion } 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";
+export declare function GetInstance(): IInnerAPIRequest;
+export declare function GetFaaSInfraInstance(): IFaaSInfraRequest;
+export declare type UploadFileResp = {
+    id: string;
+    token: string;
+    size: bigint;
+    mimeType: string;
+    name: string;
+};
+export declare type OrderV2 = {
+    field: string;
+    direction: string;
+    type: string;
+};
+export declare type OpenSDKGetRecordsReq = {
+    limit: number;
+    offset: number;
+    fields: string[];
+    quickSearch?: string;
+    filter: any[];
+    sort: OrderV2[];
+    count: boolean;
+};
+export interface IInnerAPIRequest extends IInnerAPIBaseRequest, IInnerAPIOpenSDKRequest {
+}
+export interface IInnerAPIBaseRequest {
+    createRecordBySync(objectApiName: string, record: object): any;
+    updateRecordBySync(objectApiName: string, recordID: number, record: object): any;
+    deleteRecordBySync(objectApiName: string, recordID: number): any;
+    createRecordsByAsync(objectApiName: string, records: object[]): any;
+    updateRecordsByAsync(objectApiName: string, recordMap: Record<number, object>): any;
+    deleteRecordsByAsync(objectApiName: string, recordIDs: number[]): any;
+    createRecordsBySync(objectApiName: string, records: object[]): any;
+    updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>): any;
+    deleteRecordsBySync(objectApiName: string, recordIDs: number[]): any;
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean): any;
+    updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): Promise<void>;
+    uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
+    downloadFileByID(fileID: string, filePath?: string): Promise<Buffer | void>;
+    downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | void>;
+    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[]): Promise<Map<string, number>>;
+    getGlobalConfigByKey<valueT>(key: string): Promise<valueT>;
+    oql(oql: string, args: any[], namedArgs: Record<string, any>): 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): Promise<ExecutionResult>;
+    revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
+    getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
+    getTenantInfo(appCtx: AppCtx): Promise<any>;
+}
+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

@@ -0,0 +1,41 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetFaaSInfraInstance = exports.GetInstance = void 0;
+const openapi_1 = require("./openapi");
+const innerapi_1 = require("./innerapi");
+const common = require("@byted-apaas/server-common-node");
+const faasinfra_1 = require("./faasinfra");
+const utils = common.utils;
+const constants = common.constants;
+const requestInstanceMap = {
+    "httpRequest": null,
+    "rpcRequest": null,
+};
+function GetHttpInstance() {
+    if (!requestInstanceMap["httpRequest"]) {
+        requestInstanceMap["httpRequest"] = new openapi_1.RequestHttp();
+    }
+    return requestInstanceMap["httpRequest"];
+}
+function GetRpcInstance() {
+    if (!requestInstanceMap["rpcRequest"]) {
+        requestInstanceMap["rpcRequest"] = new innerapi_1.RequestRpc();
+    }
+    return requestInstanceMap["rpcRequest"];
+}
+function GetInstance() {
+    // 内网版 && 非本地开发 使用 RPC 请求
+    if ((utils.getFaasType() === constants.faaSAccessType.InspirecloudIntranetAccessType ||
+        utils.getFaasType() === constants.faaSAccessType.ByteFaaSIntranetAccessType) && !utils.isLocalDebug()) {
+        return GetRpcInstance();
+    }
+    return GetHttpInstance();
+}
+exports.GetInstance = GetInstance;
+function GetFaaSInfraInstance() {
+    return new faasinfra_1.FaaSInfraRequest();
+}
+exports.GetFaaSInfraInstance = GetFaaSInfraInstance;
+;

package/request/interface.ts

@@ -0,0 +1,169 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+import { Criterion } from "../kunlun/operator/impl/logic";
+import { Stream } from "stream";
+import { RequestHttp } from "./openapi";
+import { RequestRpc } from "./innerapi";
+import * as common from "@byted-apaas/server-common-node";
+import { FaaSInfraRequest } from "./faasinfra";
+import {
+    ExecutionInfo,
+    ExecutionResult,
+    FlowTaskInfo,
+    RevokeExecutionOptions
+} from "@byted-apaas/server-common-node/context/workflow/workflow";
+import { AppCtx } from "../application/application";
+import { Order } from "../context/db/impl/order";
+
+const utils = common.utils;
+const constants = common.constants;
+
+const requestInstanceMap: Record<string, IInnerAPIRequest> = {
+    "httpRequest": null,
+    "rpcRequest": null,
+}
+
+function GetHttpInstance(): IInnerAPIRequest {
+    if (!requestInstanceMap["httpRequest"]) {
+        requestInstanceMap["httpRequest"] = new RequestHttp();
+    }
+    return requestInstanceMap["httpRequest"];
+}
+
+function GetRpcInstance(): IInnerAPIRequest {
+    if (!requestInstanceMap["rpcRequest"]) {
+        requestInstanceMap["rpcRequest"] = new RequestRpc();
+    }
+    return requestInstanceMap["rpcRequest"];
+}
+
+export function GetInstance(): IInnerAPIRequest {
+    // 内网版 && 非本地开发 使用 RPC 请求
+    if ((utils.getFaasType() === constants.faaSAccessType.InspirecloudIntranetAccessType ||
+        utils.getFaasType() === constants.faaSAccessType.ByteFaaSIntranetAccessType) && !utils.isLocalDebug()) {
+        return GetRpcInstance();
+    }
+    return GetHttpInstance();
+}
+
+export function GetFaaSInfraInstance(): IFaaSInfraRequest {
+    return new FaaSInfraRequest();
+}
+
+export type UploadFileResp = {
+    // ID, 文件的唯一标识
+    id: string
+    // Token, 文件的访问 token
+    token: string
+    // Size, 文件的大小
+    size: bigint
+    // MIME Type, 文件的 MIME 类型
+    mimeType: string
+    // Name, 文件的名称
+    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 interface IInnerAPIRequest extends IInnerAPIBaseRequest, IInnerAPIOpenSDKRequest { };
+export interface IInnerAPIBaseRequest {
+    createRecordBySync(objectApiName: string, record: object): any;
+
+    updateRecordBySync(objectApiName: string, recordID: number, record: object): any;
+
+    deleteRecordBySync(objectApiName: string, recordID: number): any;
+
+    createRecordsByAsync(objectApiName: string, records: object[]): any;
+
+    updateRecordsByAsync(objectApiName: string, recordMap: Record<number, object>): any;
+
+    deleteRecordsByAsync(objectApiName: string, recordIDs: number[]): any;
+
+    createRecordsBySync(objectApiName: string, records: object[]): any;
+
+    updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>): any;
+
+    deleteRecordsBySync(objectApiName: string, recordIDs: number[]): any;
+
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean): any;
+
+    updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): Promise<void>;
+
+    uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
+
+    downloadFileByID(fileID: string, filePath?: string): Promise<Buffer | void>;
+
+    downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | void>;
+
+    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[]): Promise<Map<string, number>>;
+
+    getGlobalConfigByKey<valueT>(key: string): Promise<valueT>;
+
+    oql(oql: string, args: any[], namedArgs: Record<string, any>): 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): Promise<ExecutionResult>;
+
+    revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
+
+    getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
+
+    getTenantInfo(appCtx: AppCtx): Promise<any>;
+}
+
+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/openapi.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Stream } from "stream";
+import { Order } from "../context/db/impl/order";
+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";
+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): any;
+    updateRecordBySync(objectApiName: string, recordID: number, record: object): any;
+    deleteRecordBySync(objectApiName: string, recordID: number): any;
+    createRecordsByAsync(objectApiName: string, records: object[]): any;
+    updateRecordsByAsync(objectApiName: string, recordMap: Record<number, object>): any;
+    deleteRecordsByAsync(objectApiName: string, recordIDs: number[]): any;
+    createRecordsBySync(objectApiName: string, records: object[]): any;
+    updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>): any;
+    deleteRecordsBySync(objectApiName: string, recordIDs: number[]): any;
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean): any;
+    uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
+    downloadFileByID(fileID: string, filePath?: string): Promise<void | Buffer>;
+    downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | void>;
+    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[]): Promise<Map<string, number>>;
+    getGlobalConfigByKey<valueT>(key: string): Promise<valueT>;
+    oql(oql: string, args: any[], namedArgs: Record<string, any>): 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): Promise<ExecutionResult>;
+    revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
+    getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
+    getTenantInfo(appCtx: AppCtx): 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>;
+}
+export declare function getExecutionUserTaskInfo(executionId: bigint): Promise<any>;
+export declare function executeFlow(APIName: string, option: any): Promise<ExecutionResult>;
+export declare function revokeExecution(executionId: number, revokeOptions: RevokeExecutionOptions): Promise<void>;
+export declare function getExecutionInfo(executionId: number): Promise<ExecutionInfo>;