@byted-apaas/server-sdk-node 1.1.18-beta.2 → 1.1.18-beta.22

package/application/application.d.ts

@@ -22,12 +22,10 @@ export interface IApplication {
     setLaneName(laneName: string): IApplication;
 }
 export type AppMode = 'openSDK' | 'faasSDK';
-export type DataVersion = 'v1' | 'v2' | 'v3';
 export interface AppCtx {
-    mode?: AppMode;
+    mode: AppMode;
     env?: PlatformEnvType;
-    credential?: AppCredential;
+    credential: AppCredential;
     debugType?: '0' | '2';
     x_tt_env?: string;
-    dataVersion?: DataVersion;
 }

package/context/context.d.ts

@@ -5,6 +5,7 @@ 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 "./taskCenter/taskCenter";
 export declare class Context<T, mt, cf, gv> extends CommonContext implements IContext<T, mt, cf, gv> {
     /**
      * 操作数据库中的记录数据
@@ -33,6 +34,7 @@ export declare class Context<T, mt, cf, gv> extends CommonContext implements ICo
      * 向消息中心推送及更新消息
      */
     msg: Message;
+    taskCenter: TaskCenter;
     /**
      * 根据 apiName 获取对应的全局变量
      * @param apiName 全局变量的 API Name

package/context/db/impl/object.d.ts

@@ -9,7 +9,7 @@ export interface _KObject<T> extends _KObjectSync<T>, _KObjectAsync<T>, _KObject
 }
 export declare class _KObject<T> {
     apiName: string;
-    constructor(objectApiName: string, appCtx?: AppCtx);
+    constructor(objectApiName: string);
 }
 /**
  * _KApplicationObject is open sdk object implement.

package/context/db/impl/object.js

@@ -18,13 +18,12 @@ const structs_1 = require("../../../common/structs");
 const queryPropertiesStore = new propertiesStore_1.default();
 // _KObject will be Mixin with [_KObjectSync, _KObjectAsync, _KObjectQuery]
 class _KObject {
-    constructor(objectApiName, appCtx) {
+    constructor(objectApiName) {
         this.apiName = '';
         if (!objectApiName) {
             throw new server_common_node_1.exceptions.InvalidParamError('objectApiName is empty');
         }
         this.apiName = objectApiName;
-        this.appCtx = appCtx;
     }
 }
 exports._KObject = _KObject;
@@ -331,7 +330,7 @@ class _KObjectQuery {
     }
     ;
     async findStream(handler) {
-        return new _KQuery(this.apiName, this.appCtx, this.authType).findStream(handler);
+        return new _KQuery(this.apiName, this.appCtx).findStream(handler);
     }
     orderBy(fieldApiNames, ...restFieldApiNames) {
         fieldApiNames = !fieldApiNames ? [] : fieldApiNames;
@@ -352,7 +351,7 @@ class _KObjectQuery {
         return new _KQuery(this.apiName, this.appCtx, this.authType).where(conditionMap);
     }
     fuzzySearch(keyword, fieldAPINames) {
-        return new _KQuery(this.apiName, this.appCtx, this.authType).fuzzySearch(keyword, fieldAPINames);
+        return new _KQuery(this.apiName, this.appCtx).fuzzySearch(keyword, fieldAPINames);
     }
     // limit, offset, count
     limit(limit) {
@@ -391,13 +390,13 @@ class _KQuery {
             apiName: objectApiName,
             appCtx: appCtx,
             queryBuilder: new queryBuilder_1.QueryBuilder(objectApiName),
-            queryV2: appCtx && appCtx.mode === "openSDK" ? new logicV2_1.QueryV2(objectApiName) : null, // QueryV2 是提供给 openSDK 使用的
+            queryV2: appCtx ? new logicV2_1.QueryV2(objectApiName) : null,
         });
     }
     async find() {
         this.findPreCheck();
         const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
-        if (queryV2) {
+        if (appCtx) {
             const param = {
                 limit: queryV2._limit,
                 offset: queryV2._offset,
@@ -479,7 +478,7 @@ class _KQuery {
         let maxId = 0, queryCount = 0;
         let criterionV2;
         let criterion;
-        if (queryV2) {
+        if (appCtx) {
             criterionV2 = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
             criterionV2.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
         }
@@ -500,7 +499,7 @@ class _KQuery {
                 break;
             }
             let rs;
-            if (queryV2) {
+            if (appCtx) {
                 criterionV2[criterionV2.length - 1].rightValue = maxId;
                 const param = {
                     limit: newLimit,
@@ -563,7 +562,7 @@ class _KQuery {
         let maxId = 0, queryCount = 0;
         let criterionV2;
         let criterion;
-        if (queryV2) {
+        if (appCtx) {
             criterionV2 = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
             criterionV2.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
         }
@@ -590,7 +589,7 @@ class _KQuery {
                 break;
             }
             let rs;
-            if (queryV2) {
+            if (appCtx) {
                 criterionV2[criterionV2.length - 1].rightValue = maxId;
                 const param = {
                     limit: newLimit,
@@ -630,7 +629,7 @@ class _KQuery {
         let maxId = 0, records = [];
         while (true) {
             let rs;
-            if (queryV2) {
+            if (appCtx) {
                 let criterion = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
                 criterion.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
                 const param = {
@@ -689,10 +688,6 @@ class _KQuery {
         return this;
     }
     select(fieldApiNames, ...restFieldApiNames) {
-        const { appCtx } = queryPropertiesStore.get(this);
-        if (appCtx && appCtx.dataVersion == "v3") {
-            console.log("=======================wby test: ", appCtx.dataVersion);
-        }
         fieldApiNames = !fieldApiNames ? [] : fieldApiNames;
         let fields = server_common_node_1.utils.argsToList(fieldApiNames, restFieldApiNames);
         const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
@@ -772,7 +767,7 @@ class _KQuery {
     ;
     async count() {
         const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
-        if (queryV2) {
+        if (appCtx) {
             const param = {
                 limit: 1,
                 offset: queryV2._offset,

package/context/db/impl/oql/oql.d.ts

@@ -1,13 +1,11 @@
 import { IOql } from './ioql';
-import { AppCtx } from '../../../../application/application';
 export declare class Oql implements IOql {
     oql: string;
     params: any[];
     namedParams: Record<string, any>;
     authType: string;
-    appCtx?: AppCtx;
-    constructor(oql: string, appCtx?: AppCtx);
-    constructor(oql: string, namedArgs: Record<string, any>, appCtx?: AppCtx);
+    constructor(oql: string);
+    constructor(oql: string, namedArgs: Record<string, any>);
     execute(): Promise<any[]>;
     useSystemAuth(): IOql;
     useUserAuth(): IOql;

package/context/db/impl/oql/oql.js

@@ -6,8 +6,7 @@ exports.Oql = void 0;
 const Request = require("../../../../request/interface");
 const constants_1 = require("@byted-apaas/server-common-node/constants/constants");
 class Oql {
-    constructor(oql, namedArgs, appCtx) {
-        this.appCtx = null;
+    constructor(oql, namedArgs) {
         this.oql = oql;
         this.params = [];
         this.namedParams = {};
@@ -15,12 +14,8 @@ class Oql {
         if (namedArgs) {
             this.namedParams = namedArgs;
         }
-        this.appCtx = appCtx;
     }
     async execute() {
-        if (this.appCtx && this.appCtx.dataVersion === "v3") {
-            // todo wby
-        }
         let records = await Request.GetInstance().oql(this.oql, this.params, this.namedParams, this.authType);
         if (records && Array.isArray(records)) {
             return records;

package/context/db/impl/transaction/index.d.ts

@@ -1,7 +1,6 @@
 import { ITransaction, ITransactionWithCurrentObject, TransactionObject } from '../transaction';
 import { TransactionOperation } from './operation';
 import { currentObjApiName } from '../../../../data';
-import { AppCtx } from '../../../../application/application';
 type uuidOrRecordIDResult = {
     _id: uuidOrRecordID;
 };
@@ -13,9 +12,8 @@ export declare class Transaction<T, mt> implements ITransaction<mt>, ITransactio
     uuid2result: Record<string, uuidOrRecordIDResult>;
     isCommit: boolean;
     authType: string;
-    appCtx?: AppCtx;
     batchResults: (string | number)[][];
-    constructor(objectApiName: string, appCtx?: AppCtx);
+    constructor(objectApiName: string);
     currentObject(): TransactionObject<mt[currentObjApiName]>;
     object<T extends keyof mt>(objectApiName: T): TransactionObject<mt[T]>;
     commit(): Promise<void>;

package/context/db/impl/transaction/index.js

@@ -12,15 +12,13 @@ const assert = require('assert');
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const { v4: uuidv4 } = require('uuid'); //nolint:byted_s_ts_no_require_imports
 class Transaction {
-    constructor(objectApiName, appCtx) {
-        this.appCtx = null;
+    constructor(objectApiName) {
         this.objectApiName = objectApiName;
         this.placeholders = {};
         this.operations = [];
         this.uuid2result = {};
         this.isCommit = false;
         this.batchResults = [];
-        this.appCtx = appCtx;
     }
     // @ts-ignore
     currentObject() {
@@ -217,10 +215,6 @@ class Transaction {
         };
     }
     async commit() {
-        if (this.appCtx && this.appCtx.dataVersion === "v3") {
-            // todo wby
-            console.log("==========wby test= commit");
-        }
         if (this.isCommit) {
             throw new server_common_node_1.exceptions.InvalidParamError('The transaction cannot be committed repeatedly');
         }

package/context/taskCenter/taskCenter.d.ts

@@ -0,0 +1,39 @@
+export interface _Task {
+    taskID?: string;
+    APaaSRecord?: _APaaSRecord;
+}
+export interface _APaaSRecord {
+    objectID?: string;
+    objectAPIName?: string;
+    recordID?: string;
+    recordData?: string;
+}
+export declare class _TaskCenter {
+    /**
+     * 推送任务
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    syncTasks(tasks?: _Task[], cacheDuration?: number): Promise<number>;
+    /**
+     * 查询任务详情(从缓存)
+     * @param task 任务
+     */
+    getTaskDetail(task?: _Task): Promise<_Task>;
+    /**
+     * 刷新任务详情缓存
+     * @param tasks 任务
+     * @param cacheDuration 缓存时长
+     */
+    refreshTasksCache(tasks?: _Task[], cacheDuration?: number): Promise<number>;
+}
+/**
+ * 任务中心类
+ */
+export declare class TaskCenter {
+    /**
+     * 任务中心
+     */
+    taskCenter: _TaskCenter;
+    constructor();
+}

package/context/taskCenter/taskCenter.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskCenter = 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;
+/**
+ * 任务中心类
+ */
+class TaskCenter {
+    constructor() {
+        this.taskCenter = new _TaskCenter();
+    }
+}
+exports.TaskCenter = TaskCenter;

package/global/global.d.ts

@@ -6,7 +6,7 @@ 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 { DBV3 } from '../context/db/impl/dbV3';
+import { TaskCenter } from "../context/taskCenter/taskCenter";
 declare global {
     export namespace application {
         /**
@@ -26,9 +26,9 @@ declare global {
          */
         let operator: IOperator;
         /**
-         * 新 data 接口
+         * 消息中心
          */
-        let dataV2: DBV3<{}>;
+        let taskCenter: TaskCenter;
         /**
          * 常量
          */

package/hooks/hooks.js

@@ -11,7 +11,7 @@ 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 dbV3_1 = require("../context/db/impl/dbV3");
+const taskCenter_1 = require("../context/taskCenter/taskCenter");
 /**
  * 根据 key 获取对应的全局变量
  * @param key 全局变量的 key
@@ -58,6 +58,7 @@ 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.resources = new resources_1._Resources();
     context.integration = new integration_1._Integration();
     context.getVar = getVar;
@@ -74,7 +75,6 @@ function mountApplication(context) {
         global.application = {};
     }
     global.application.data = new db_1.DB();
-    global.application.dataV2 = new dbV3_1.DBV3();
     // publicAPI
     if (!global.application.publicAPI) {
         global.application.publicAPI = {};
@@ -84,6 +84,7 @@ 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.resources = new resources_1._Resources();
     global.application.metadata = metadataApi.metadata(context);
     // globalVar

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.18-beta.2",
+  "version": "1.1.18-beta.22",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -13,11 +13,10 @@
     "clean": "tsc --build --clean && rm -rf **/*.js.map"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "^2.0.9",
+    "@byted-apaas/server-common-node": "^2.0.13-beta.35",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",
-    "package.json": "^2.0.1",
     "typescript": "^4.9.3",
     "uuid": "^8.3.2"
   },

package/request/interface.d.ts

@@ -59,6 +59,9 @@ 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>;
     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

@@ -26,6 +26,9 @@ 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<number>;
+    getTaskDetail(task: any): Promise<any>;
+    refreshTasksCache(cacheDuration: number, tasks: any): Promise<number>;
     getFields(objectApiName: string): any;
     getField(objectApiName: string, fieldApiName: string): any;
     terminateWorkflowInstance(workflowInstanceId: number, operator: number, reason: string): any;

package/request/openapi.js

@@ -818,6 +818,9 @@ class RequestHttp {
         this.openSDKUploadFile = openSDKUploadFile;
         this.openSDKUploadAvatar = openSDKUploadAvatar;
         this.openSDKDownloadAvatar = openSDKDownloadAvatar;
+        this.syncTasks = syncTasks;
+        this.getTaskDetail = getTaskDetail;
+        this.refreshTasksCache = refreshTasksCache;
     }
     updateWorkflowVariables(ctx, instanceId, variables, variableTypes) {
     }
@@ -860,6 +863,15 @@ class RequestHttp {
     updateMessage(msgId, msg) {
         return null;
     }
+    syncTasks(tasks, cacheDuration) {
+        return null;
+    }
+    getTaskDetail(task) {
+        return null;
+    }
+    refreshTasksCache(cacheDuration, tasks) {
+        return null;
+    }
     getFields(objectApiName) {
     }
     getField(objectApiName, fieldApiName) {
@@ -1285,3 +1297,42 @@ 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': JSON.stringify(tasks),
+        'cache_duration': cacheDuration,
+    };
+    let res = await openapi.doRequest(null, urlPath, options);
+    return res.affect;
+}
+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': JSON.stringify(task),
+    };
+    let res = await openapi.doRequest(null, urlPath, options);
+    return {
+        taskDetail: {
+            taskID: res?.task_id,
+            aPaaSRecord: {
+                objectID: res?.APaaSRecord?.object_id,
+                ObjectAPIName: res?.APaaSRecord?.object_api_name,
+                RecordID: res?.APaaSRecord?.record_id,
+                RecordData: res?.APaaSRecord?.record_data,
+            }
+        }
+    };
+}
+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': JSON.stringify(tasks),
+        'cache_duration': cacheDuration,
+    };
+    let res = await openapi.doRequest(null, urlPath, options);
+    return res.affect;
+}

package/context/db/impl/dbV3.d.ts

@@ -1,47 +0,0 @@
-import { _IKAllEndpoint, _IKQuery } from './IObject';
-import { ITransactionGetter } from './transaction';
-import { IDB } from '../db';
-import { metadataMap } from '../../../data/index';
-import { IOql } from './oql/ioql';
-export declare class DBV3<T, mt = metadataMap> implements IDB<T, mt> {
-    objectApiName: string;
-    constructor(objectApiName?: string);
-    /**
-     * 操作指定对象的记录数据
-     * @param objectApiName 指定对象的 ApiName
-     * @example
-     * ```
-     * context.db.object('_user').where({
-     *     gender: 'male'
-     * }).find()
-     * ```
-     */
-    object<K extends keyof mt>(objectApiName: K): _IKAllEndpoint<mt[K]> & _IKQuery<mt[K]>;
-    /**
-     * 创建一个新的空事务
-     * @example
-     * ```
-     * let tx = context.db.newTransaction();
-     * let user = tx.object('_user').registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: '用户1', en: 'user1' }),
-     * });
-     * let contract = tx.object('contract').registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
-     *     user: {id: user._id}
-     * });
-     * await tx.commit();
-     * ```
-     */
-    newTransaction(): ITransactionGetter<T, mt>;
-    /**
-     * OQL 操作
-     * @param oql 指定 OQL 语句
-     * @example
-     * ```
-     * let users = await context.db.oql('select _email from _user').execute();
-     * ```
-     */
-    oql(oql: string): IOql;
-    oql(oql: string, nameArgs: Record<string, any>): IOql;
-    toDataParam(): any;
-}

package/context/db/impl/dbV3.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DBV3 = void 0;
-const object_1 = require("./object");
-const index_1 = require("./transaction/index");
-const oql_1 = require("./oql/oql");
-class DBV3 {
-    constructor(objectApiName) {
-        this.objectApiName = objectApiName;
-    }
-    /**
-     * 操作指定对象的记录数据
-     * @param objectApiName 指定对象的 ApiName
-     * @example
-     * ```
-     * context.db.object('_user').where({
-     *     gender: 'male'
-     * }).find()
-     * ```
-     */
-    object(objectApiName) {
-        const appCtx = {
-            dataVersion: "v3",
-        };
-        return new object_1._KObject(objectApiName, appCtx);
-    }
-    ;
-    /**
-     * 创建一个新的空事务
-     * @example
-     * ```
-     * let tx = context.db.newTransaction();
-     * let user = tx.object('_user').registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: '用户1', en: 'user1' }),
-     * });
-     * let contract = tx.object('contract').registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
-     *     user: {id: user._id}
-     * });
-     * await tx.commit();
-     * ```
-     */
-    newTransaction() {
-        const appCtx = {
-            dataVersion: "v3",
-        };
-        return new index_1.Transaction(this.objectApiName, appCtx);
-    }
-    ;
-    oql(oql, nameArgs) {
-        const appCtx = {
-            dataVersion: "v3",
-        };
-        if (nameArgs) {
-            return new oql_1.Oql(oql, nameArgs, appCtx);
-        }
-        return new oql_1.Oql(oql, undefined, appCtx);
-    }
-    toDataParam() {
-        console.log("================= toDataParam");
-    }
-}
-exports.DBV3 = DBV3;