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

package/context/context.d.ts

@@ -5,6 +5,8 @@ import { IDBGetter } from './db/db';
 import { Context as CommonContext } from '@byted-apaas/server-common-node';
 import { IMetaData } from './metadata/metadata';
 import { _IIntegration } from './integration/IIntegration';
+import { TaskCenter } from "./task/taskCenter";
+import { PushCenter } from "./push/pushCenter";
 export declare class Context<T, mt, cf, gv> extends CommonContext implements IContext<T, mt, cf, gv> {
     /**
      * 操作数据库中的记录数据
@@ -33,6 +35,11 @@ export declare class Context<T, mt, cf, gv> extends CommonContext implements ICo
      * 向消息中心推送及更新消息
      */
     msg: Message;
+    taskCenter: TaskCenter;
+    /**
+     * 推送中心
+     */
+    pushCenter: PushCenter;
     /**
      * 根据 apiName 获取对应的全局变量
      * @param apiName 全局变量的 API Name

package/context/push/pushCenter.d.ts

@@ -0,0 +1,55 @@
+export interface _ReceiverInfo {
+    receiver_id: string;
+    receiver_id_type?: string;
+    tags?: Map<string, string>;
+    variables?: _Variable[];
+    extra?: Map<string, string>;
+}
+export interface _Variable {
+    key: string;
+    value?: string;
+}
+/**
+ * 推送中心类
+ */
+export declare class PushCenter {
+    /**
+     * 批量发布消息
+     * @param receiverInfos 接收者信息
+     * @param channelIDs 管道ID
+     * @param template 模版
+     * @param msgType 消息类型
+     * @param batchNo 批量编号
+     * @param senderID 发送者ID
+     * @param senderIDType 发送者ID类型
+     * @param subBatchNo 批量子编号
+     * @param tags 标签信息
+     * @param extra 扩展信息
+     */
+    sendMessageBatch(receiverInfos: _ReceiverInfo[], channelIDs: string[], template: string, msgType: string, batchNo: string, senderID: string, senderIDType: string, subBatchNo?: string, tags?: Map<string, string>, extra?: Map<string, string>): Promise<any>;
+    /**
+     * 批量获取消息状态
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批次编号
+     * @param tags 标签列表
+     */
+    getMessageBatchStatus(batchNo: string, subBatchNo: string, tags?: Map<string, string>): Promise<any>;
+    /**
+     * 获取消息状态
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批量编号
+     * @param receiverIDs 接收者ID列表
+     * @param tags 标签列表
+     * @param withFeedback 是否获取已读反馈
+     * @param offset 是否获取已读反馈
+     * @param limit 是否获取已读反馈
+     */
+    getMessageStatus(batchNo: string, subBatchNo: string, receiverIDs?: string[], tags?: Map<string, string>, withFeedback?: boolean, offset?: number, limit?: number): Promise<any>;
+    /**
+     * 撤回消息
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批量编号
+     * @param receiverIDs 接收者ID列表
+     */
+    recallMessageBatch(batchNo: string, subBatchNo: string, receiverIDs?: string[]): Promise<any>;
+}

package/context/push/pushCenter.js

@@ -0,0 +1,62 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushCenter = void 0;
+const Request = require("../../request/interface");
+/**
+ * 推送中心类
+ */
+class PushCenter {
+    /**
+     * 批量发布消息
+     * @param receiverInfos 接收者信息
+     * @param channelIDs 管道ID
+     * @param template 模版
+     * @param msgType 消息类型
+     * @param batchNo 批量编号
+     * @param senderID 发送者ID
+     * @param senderIDType 发送者ID类型
+     * @param subBatchNo 批量子编号
+     * @param tags 标签信息
+     * @param extra 扩展信息
+     */
+    async sendMessageBatch(receiverInfos, channelIDs, template, msgType, batchNo, senderID, senderIDType, subBatchNo, tags, extra) {
+        return await Request.GetInstance().sendMessageBatch(receiverInfos, channelIDs, template, msgType, batchNo, senderID, senderIDType, subBatchNo, tags, extra);
+    }
+    ;
+    /**
+     * 批量获取消息状态
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批次编号
+     * @param tags 标签列表
+     */
+    async getMessageBatchStatus(batchNo, subBatchNo, tags) {
+        return await Request.GetInstance().getMessageBatchStatus(batchNo, subBatchNo, tags);
+    }
+    ;
+    /**
+     * 获取消息状态
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批量编号
+     * @param receiverIDs 接收者ID列表
+     * @param tags 标签列表
+     * @param withFeedback 是否获取已读反馈
+     * @param offset 是否获取已读反馈
+     * @param limit 是否获取已读反馈
+     */
+    async getMessageStatus(batchNo, subBatchNo, receiverIDs, tags, withFeedback, offset, limit) {
+        return await Request.GetInstance().getMessageStatus(batchNo, subBatchNo, receiverIDs, tags, withFeedback, offset, limit);
+    }
+    ;
+    /**
+     * 撤回消息
+     * @param batchNo 批量编号
+     * @param subBatchNo 子批量编号
+     * @param receiverIDs 接收者ID列表
+     */
+    async recallMessageBatch(batchNo, subBatchNo, receiverIDs) {
+        return await Request.GetInstance().recallMessageBatch(batchNo, subBatchNo, receiverIDs);
+    }
+}
+exports.PushCenter = PushCenter;

package/context/task/taskCenter.d.ts

@@ -0,0 +1,32 @@
+export interface _Task {
+    task_id?: string;
+    apaas_record?: _APaaSRecord;
+}
+export interface _APaaSRecord {
+    object_id?: string;
+    object_api_name?: string;
+    record_id?: string;
+    record_data?: string;
+}
+/**
+ * 任务中心类
+ */
+export declare class TaskCenter {
+    /**
+     * 推送任务
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    syncTasks(tasks?: _Task[], cacheDuration?: number): Promise<any>;
+    /**
+     * 查询任务详情(从缓存)
+     * @param task 任务
+     */
+    getTaskDetail(task?: _Task): Promise<any>;
+    /**
+     * 刷新任务详情缓存
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    refreshTasksCache(tasks?: _Task[], cacheDuration?: number): Promise<any>;
+}

package/context/task/taskCenter.js

@@ -0,0 +1,38 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskCenter = void 0;
+const Request = require("../../request/interface");
+/**
+ * 任务中心类
+ */
+class TaskCenter {
+    /**
+     * 推送任务
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    async syncTasks(tasks, cacheDuration) {
+        return await Request.GetInstance().syncTasks(tasks, cacheDuration);
+    }
+    ;
+    /**
+     * 查询任务详情(从缓存)
+     * @param task 任务
+     */
+    async getTaskDetail(task) {
+        return await Request.GetInstance().getTaskDetail(task);
+    }
+    ;
+    /**
+     * 刷新任务详情缓存
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    async refreshTasksCache(tasks, cacheDuration) {
+        return await Request.GetInstance().refreshTasksCache(tasks, cacheDuration);
+    }
+    ;
+}
+exports.TaskCenter = TaskCenter;

package/global/global.d.ts

@@ -6,6 +6,8 @@ import { Flow } from './application/flow/flow';
 import { _Resources } from '../context/resources/impl/resources';
 import { Message } from '../context/msg/msg';
 import { _IIntegration } from '../context/integration/IIntegration';
+import { TaskCenter } from "../context/task/taskCenter";
+import { PushCenter } from "../context/push/pushCenter";
 declare global {
     export namespace application {
         /**
@@ -30,6 +32,14 @@ declare global {
         /**
          * metadataV3 接口
          */
+        /**
+         * 消息中心
+         */
+        let taskCenter: TaskCenter;
+        /**
+         * 推送中心
+         */
+        let pushCenter: PushCenter;
         /**
          * 常量
          */

package/hooks/hooks.js

@@ -11,6 +11,8 @@ 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");
+const taskCenter_1 = require("../context/task/taskCenter");
+const pushCenter_1 = require("../context/push/pushCenter");
 /**
  * 根据 key 获取对应的全局变量
  * @param key 全局变量的 key
@@ -57,6 +59,8 @@ function mountContext(context, logger, requireFunc) {
     context.function = api.getFunctionSync(context, logger);
     context.tasks = new tasks_1.Tasks(context.function);
     context.msg = new msg_1.Message();
+    context.taskCenter = new taskCenter_1.TaskCenter();
+    context.pushCenter = new pushCenter_1.PushCenter();
     context.resources = new resources_1._Resources();
     context.integration = new integration_1._Integration();
     context.getVar = getVar;
@@ -83,6 +87,8 @@ function mountApplication(context) {
     global.application.publicAPI.method = server_common_node_1.utils.getHttpMethod();
     global.application.publicAPI.headers = server_common_node_1.utils.getHttpHeaders();
     global.application.msg = new msg_1.Message();
+    global.application.taskCenter = new taskCenter_1.TaskCenter();
+    global.application.pushCenter = new pushCenter_1.PushCenter();
     global.application.resources = new resources_1._Resources();
     global.application.metadata = metadataApi.metadata(context);
     // (global as any).application.metadataV3 = metadataApi.metadataV3(context);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.20",
+  "version": "1.1.21-beta.1",
   "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.13",
+    "@byted-apaas/server-common-node": "^2.0.20-beta.2",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",

package/request/interface.d.ts

@@ -66,6 +66,13 @@ export interface IInnerAPIBaseRequest {
     downloadFileByToken: (fileToken: string, filePath?: string) => Promise<Buffer | undefined>;
     createMessage: (msg: any) => Promise<number>;
     updateMessage: (msgId: number, msg: any) => Promise<void>;
+    syncTasks: (tasks: any, cacheDuration: number) => Promise<number>;
+    getTaskDetail: (task: any) => Promise<any>;
+    refreshTasksCache: (tasks: any, cacheDuration: number) => Promise<number>;
+    sendMessageBatch: (receiverInfos: any, channelIDs: string[], template: string, msgType: string, batchNo: string, senderID: string, senderIDType: string, subBatchNo?: string, tags?: Map<string, string>, extra?: Map<string, string>) => Promise<string>;
+    getMessageBatchStatus: (batchNo: string, subBatchNo: string, tags?: Map<string, string>) => Promise<any>;
+    getMessageStatus: (batchNo: string, subBatchNo: string, receiverIDs?: string[], tags?: Map<string, string>, withFeedback?: boolean, offset?: number, limit?: number) => Promise<any>;
+    recallMessageBatch: (batchNo: string, subBatchNo: string, receiverIDs?: string[]) => Promise<any>;
     getFields: (objectApiName: string) => Promise<any>;
     getField: (objectApiName: string, fieldApiName: string) => Promise<any>;
     terminateWorkflowInstance: (workflowInstanceId: number, operator: number, reason: string) => Promise<void>;

package/request/openapi.d.ts

@@ -33,6 +33,13 @@ export declare class RequestHttp implements IInnerAPIRequest {
     downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | undefined>;
     createMessage(msg: any): Promise<number>;
     updateMessage(msgId: number, msg: any): Promise<void>;
+    syncTasks(tasks: any, cacheDuration: number): Promise<any>;
+    getTaskDetail(task: any): Promise<any>;
+    sendMessageBatch(receiverInfos: any, channelIDs: string[], template: string, msgType: string, batchNo: string, senderID: string, senderIDType: string, subBatchNo?: string, tags?: Map<string, string>, extra?: Map<string, string>): Promise<string>;
+    getMessageBatchStatus(batchNo: string, subBatchNo: string, tags?: Map<string, string>): Promise<any>;
+    getMessageStatus(batchNo: string, subBatchNo: string, receiverIDs?: string[], tags?: Map<string, string>, withFeedback?: boolean, offset?: number, limit?: number): Promise<any>;
+    recallMessageBatch(batchNo: string, subBatchNo: string, receiverIDs?: string[]): Promise<any>;
+    refreshTasksCache(cacheDuration: number, tasks: any): Promise<any>;
     getFields(objectApiName: string): any;
     getField(objectApiName: string, fieldApiName: string): any;
     terminateWorkflowInstance(workflowInstanceId: number, operator: number, reason: string): any;

package/request/openapi.js

@@ -1040,6 +1040,13 @@ class RequestHttp {
         this.openSDKUploadFile = openSDKUploadFile;
         this.openSDKUploadAvatar = openSDKUploadAvatar;
         this.openSDKDownloadAvatar = openSDKDownloadAvatar;
+        this.syncTasks = syncTasks;
+        this.getTaskDetail = getTaskDetail;
+        this.refreshTasksCache = refreshTasksCache;
+        this.sendMessageBatch = sendMessageBatch;
+        this.getMessageBatchStatus = getMessageBatchStatus;
+        this.getMessageStatus = getMessageStatus;
+        this.recallMessageBatch = recallMessageBatch;
     }
     updateWorkflowVariables(ctx, instanceId, variables, variableTypes) {
     }
@@ -1098,6 +1105,27 @@ class RequestHttp {
     updateMessage(msgId, msg) {
         return null;
     }
+    syncTasks(tasks, cacheDuration) {
+        return null;
+    }
+    getTaskDetail(task) {
+        return null;
+    }
+    sendMessageBatch(receiverInfos, channelIDs, template, msgType, batchNo, senderID, senderIDType, subBatchNo, tags, extra) {
+        return null;
+    }
+    getMessageBatchStatus(batchNo, subBatchNo, tags) {
+        return null;
+    }
+    getMessageStatus(batchNo, subBatchNo, receiverIDs, tags, withFeedback, offset, limit) {
+        return null;
+    }
+    recallMessageBatch(batchNo, subBatchNo, receiverIDs) {
+        return null;
+    }
+    refreshTasksCache(cacheDuration, tasks) {
+        return null;
+    }
     getFields(objectApiName) {
     }
     getField(objectApiName, fieldApiName) {
@@ -1526,3 +1554,80 @@ async function getDefaultIntegrationTenantAccessToken() {
         appId: res.appId,
     };
 }
+async function syncTasks(tasks, cacheDuration) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.taskCenterSyncTasks);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'tasks': tasks,
+        'cache_duration': cacheDuration,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function getTaskDetail(task) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.taskCenterGetTaskDetail);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'task': task,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function refreshTasksCache(tasks, cacheDuration) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.taskCenterRefreshTasksCache);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'tasks': tasks,
+        'cache_duration': cacheDuration,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function sendMessageBatch(receiverInfos, channelIDs, template, msgType, batchNo, senderID, senderIDType, subBatchNo, tags, extra) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.pushCenterSendMessageBatch);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'receiver_infos': receiverInfos,
+        'channel_ids': channelIDs,
+        'template': template,
+        'msg_type': msgType,
+        'batch_no': batchNo,
+        'sender_id': senderID,
+        'sender_id_type': senderIDType,
+        'sub_batch_no': subBatchNo,
+        'tags': tags,
+        'extra': extra,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function getMessageBatchStatus(batchNo, subBatchNo, tags) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.pushCenterGetMessageBatchStatus);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'batch_no': batchNo,
+        'sub_batch_no': subBatchNo,
+        'tags': tags,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function getMessageStatus(batchNo, subBatchNo, receiverIDs, tags, withFeedback, offset, limit) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.pushCenterGetMessageStatus);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'batch_no': batchNo,
+        'sub_batch_no': subBatchNo,
+        'receiver_ids': receiverIDs,
+        'tags': tags,
+        'with_feedback': withFeedback,
+        'offset': offset,
+        'limit': limit,
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}
+async function recallMessageBatch(batchNo, subBatchNo, receiverIDs) {
+    let options = commonHttp.getOptions(null, openapiHttpPath.pushCenterRecallMessageBatch);
+    let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
+    options.json = {
+        'batch_no': batchNo,
+        'sub_batch_no': subBatchNo,
+        'receiver_ids': receiverIDs
+    };
+    return await openapi.doRequest(null, urlPath, options);
+}