@byted-apaas/server-sdk-node 1.1.17 → 1.1.18-beta.0

package/application/application.d.ts

@@ -22,10 +22,12 @@ 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/db/impl/dbV3.d.ts

@@ -0,0 +1,47 @@
+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

@@ -0,0 +1,63 @@
+"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;

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);
+    constructor(objectApiName: string, appCtx?: AppCtx);
 }
 /**
  * _KApplicationObject is open sdk object implement.

package/context/db/impl/object.js

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

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

@@ -1,11 +1,13 @@
 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;
-    constructor(oql: string);
-    constructor(oql: string, namedArgs: Record<string, any>);
+    appCtx?: AppCtx;
+    constructor(oql: string, appCtx?: AppCtx);
+    constructor(oql: string, namedArgs: Record<string, any>, appCtx?: AppCtx);
     execute(): Promise<any[]>;
     useSystemAuth(): IOql;
     useUserAuth(): IOql;

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

@@ -6,7 +6,8 @@ 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) {
+    constructor(oql, namedArgs, appCtx) {
+        this.appCtx = null;
         this.oql = oql;
         this.params = [];
         this.namedParams = {};
@@ -14,8 +15,12 @@ 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,6 +1,7 @@
 import { ITransaction, ITransactionWithCurrentObject, TransactionObject } from '../transaction';
 import { TransactionOperation } from './operation';
 import { currentObjApiName } from '../../../../data';
+import { AppCtx } from '../../../../application/application';
 type uuidOrRecordIDResult = {
     _id: uuidOrRecordID;
 };
@@ -12,8 +13,9 @@ 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);
+    constructor(objectApiName: string, appCtx?: AppCtx);
     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,13 +12,15 @@ 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) {
+    constructor(objectApiName, appCtx) {
+        this.appCtx = null;
         this.objectApiName = objectApiName;
         this.placeholders = {};
         this.operations = [];
         this.uuid2result = {};
         this.isCommit = false;
         this.batchResults = [];
+        this.appCtx = appCtx;
     }
     // @ts-ignore
     currentObject() {
@@ -215,6 +217,10 @@ 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/hooks/hooks.js

@@ -11,6 +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");
 /**
  * 根据 key 获取对应的全局变量
  * @param key 全局变量的 key
@@ -73,6 +74,7 @@ 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 = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.17",
+  "version": "1.1.18-beta.0",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -13,10 +13,11 @@
     "clean": "tsc --build --clean && rm -rf **/*.js.map"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "^2.0.5",
+    "@byted-apaas/server-common-node": "^2.0.9",
     "@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"
   },