@byted-apaas/server-sdk-node 1.0.7 → 1.0.9

package/context/db/db.d.ts

@@ -51,6 +51,18 @@ export interface IDB<T, mt> {
      * ```
      */
     oql(oql: string): IOql;
+    /**
+     * OQL 操作
+     * @param oql OQL 语句
+     * @param nameArgs 用于替换 OQL 语句中的占位符
+     * @example
+     * ```
+     * let employees = await context.db.oql("select _email from _user where _type = $user_type",{
+     *     "user_type": "_employee",
+     * }).execute();
+     * ```
+     */
+    oql(oql: string, nameArgs: Record<string, any>): IOql;
 }
 /**
  * IDBWithCurrentObject 经由 IDBGetter 返回，是 DB 的动态增加的接口结构

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

@@ -158,7 +158,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").orderBy(["_email", "_phoneNumber"]).find()
      * ```
      */
-    orderBy<K extends keyof T>(fieldApiNames: K[]): _IKQuery<T>;
+    orderBy<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 根据指定字段升序排序（a -> z, 0 -> 9）
      * @param fieldApiNames 排序依据的字段，按先后顺序确定优先级，用逗号分隔
@@ -167,7 +167,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").orderBy("_email", "_phoneNumber").find()
      * ```
      */
-    orderBy<K extends keyof T>(...fieldApiNames: K[]): _IKQuery<T>;
+    orderBy<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 根据指定字段降序排序（z -> a, 9 -> 0）
      * @param fieldApiNames 排序依据的字段数组，按先后顺序确定优先级
@@ -176,7 +176,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").orderByDesc("_email", "_phoneNumber").find()
      * ```
      */
-    orderByDesc<K extends keyof T>(fieldApiNames: K[]): _IKQuery<T>;
+    orderByDesc<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 根据指定字段降序排序（z -> a, 9 -> 0）
      * @param fieldApiNames 排序依据的字段，按先后顺序确定优先级，用逗号分隔
@@ -185,7 +185,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").orderByDesc("_email", "_phoneNumber").find()
      * ```
      */
-    orderByDesc<K extends keyof T>(...fieldApiNames: K[]): _IKQuery<T>;
+    orderByDesc<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定需返回的字段
      * @param fieldApiNames 需返回的字段数组
@@ -194,7 +194,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").select(["_name", "_email"]).find()
      * ```
      */
-    select<K extends keyof T>(fieldApiNames: K[]): _IKQuery<T>;
+    select<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定需返回的字段
      * @param fieldApiNames 需返回的字段，用逗号分隔
@@ -203,7 +203,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").select("_name", "_email").find()
      * ```
      */
-    select<K extends keyof T>(...fieldApiNames: K[]): _IKQuery<T>;
+    select<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 设置查询条件
      * @param conditionMap 对字段赋值以指定查询筛选条件
@@ -215,11 +215,11 @@ export interface _IKQuery<T> {
      * }).find()
      * ```
      */
-    where(conditionMap: _WhereCond<T>): _IKQuery<T>;
+    where(conditionMap: _WhereCond<T>): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 设置查询条件
      */
-    where(): _IKQuery<T>;
+    where(): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定分页查询的数量
      * @param limit 分页查询的数量
@@ -229,7 +229,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").limit(10)
      * ```
      */
-    limit(limit: number): _IKQuery<T>;
+    limit(limit: number): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定分页查询的偏移量
      * @param offset 分页查询的偏移量
@@ -239,7 +239,7 @@ export interface _IKQuery<T> {
      * context.db.object("_user").offset(0)
      * ```
      */
-    offset(offset: number): _IKQuery<T>;
+    offset(offset: number): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定条件的行数
      * @example

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

@@ -43,6 +43,7 @@ export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
      * ```
      */
     oql(oql: string): IOql;
+    oql(oql: string, nameArgs: Record<string, any>): IOql;
 }
 export declare class DBWithCurrentObject<T, mt = metadataMap> extends DB<T, mt> implements IDB<T, mt>, IDBWithCurrentObject<T, mt> {
     /**

package/context/db/impl/db.js

@@ -42,15 +42,10 @@ class DB {
         return new index_1.Transaction(this.objectApiName);
     }
     ;
-    /**
-     * OQL 操作
-     * @param oql 指定 OQL 语句
-     * @example
-     * ```
-     * let users = await context.db.oql("select _email from _user").execute();
-     * ```
-     */
-    oql(oql) {
+    oql(oql, nameArgs) {
+        if (nameArgs) {
+            return new oql_1.Oql(oql, nameArgs);
+        }
         return new oql_1.Oql(oql);
     }
 }

package/context/db/impl/object.js

@@ -56,24 +56,30 @@ class _KObjectSync {
     }
     ;
     async delete(recordOrRecordID) {
+        let recordID = 0;
         // 用户直接传入 record id 来进行删除的情况
         if (typeof recordOrRecordID === "number") {
-            return await Request.GetInstance().deleteRecordBySync(this.apiName, recordOrRecordID);
+            recordID = recordOrRecordID;
         }
-        // 用户传入 object 结构来进行删除的情况
-        let record = recordOrRecordID;
-        if (server_common_node_1.checkUtils.isObject(record)) {
-            // 如果用户没有传入包含 id 的 record，则报错
-            if (!record._id) {
-                throw new server_common_node_1.exceptions.InvalidParamError("record._id is empty");
+        else {
+            // 用户传入 object 结构来进行删除的情况
+            let record = recordOrRecordID;
+            if (server_common_node_1.checkUtils.isObject(record)) {
+                // 如果用户没有传入包含 id 的 record，则报错
+                if (!record._id) {
+                    throw new server_common_node_1.exceptions.InvalidParamError("record._id is empty");
+                }
+                recordID = record._id;
             }
+        }
+        if (recordID > 0) {
             if (this.appCtx && this.appCtx.mode == 'openSDK') {
                 // request from OpenSDK
                 return await (0, common_1.runCtxForOpenSDK)(this.appCtx, async () => {
-                    return await Request.GetInstance().openSDKDeleteRecordBySync(this.apiName, record._id);
+                    return await Request.GetInstance().openSDKDeleteRecordBySync(this.apiName, recordID);
                 });
             }
-            return await Request.GetInstance().deleteRecordBySync(this.apiName, record._id);
+            return await Request.GetInstance().deleteRecordBySync(this.apiName, recordID);
         }
         throw new server_common_node_1.exceptions.InvalidParamError("record must be number or object");
     }
@@ -163,8 +169,7 @@ class _KObjectSync {
                 return await Request.GetInstance().openSDKDeleteRecordsBySync(this.apiName, recordIDs);
             });
         }
-        await Request.GetInstance().deleteRecordsBySync(this.apiName, recordIDs);
-        return;
+        return await Request.GetInstance().deleteRecordsBySync(this.apiName, recordIDs);
     }
     async batchUpdate(recordMapList) {
         // 参数校验、组装
@@ -184,13 +189,11 @@ class _KObjectSync {
         }
         if (this.appCtx && this.appCtx.mode == 'openSDK') {
             // request from OpenSDK
-            await (0, common_1.runCtxForOpenSDK)(this.appCtx, async () => {
-                return await Request.GetInstance().openSDKUpdateRecordsBySync(this.apiName, recordMap);
+            return await (0, common_1.runCtxForOpenSDK)(this.appCtx, async () => {
+                return await Request.GetInstance().openSDKUpdateRecordsBySync(this.apiName, recordMapList);
             });
-            return;
         }
-        await Request.GetInstance().updateRecordsBySync(this.apiName, recordMap);
-        return;
+        return await Request.GetInstance().updateRecordsBySync(this.apiName, recordMap);
     }
     ;
 }
@@ -495,6 +498,7 @@ class _KQuery {
     }
     limit(limit) {
         const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        limit = Number(limit);
         if (queryV2) {
             queryV2.limit(limit);
         }
@@ -506,6 +510,7 @@ class _KQuery {
     ;
     offset(offset) {
         const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        offset = Number(offset);
         if (queryV2) {
             queryV2.offset(offset);
         }

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

@@ -4,5 +4,6 @@ export declare class Oql implements IOql {
     params: any[];
     namedParams: Record<string, any>;
     constructor(oql: string);
+    constructor(oql: string, namedArgs: Record<string, any>);
     execute(): Promise<any[]>;
 }

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

@@ -5,10 +5,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Oql = void 0;
 const Request = require("../../../../request/interface");
 class Oql {
-    constructor(oql) {
+    constructor(oql, namedArgs) {
         this.oql = oql;
         this.params = [];
         this.namedParams = {};
+        this.params = [];
+        if (namedArgs) {
+            this.namedParams = namedArgs;
+        }
     }
     async execute() {
         let records = await Request.GetInstance().oql(this.oql, this.params, this.namedParams);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -12,7 +12,7 @@
     "pre-build": "rm -rf build && tsc"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "^1.0.8",
+    "@byted-apaas/server-common-node": "^1.0.11",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",

package/request/innerapi.js

@@ -767,7 +767,7 @@ async function oql(oql, args, namedArgs) {
     const queryData = JSON.stringify({
         "query": oql,
         "args": args,
-        "named_args": namedArgs,
+        "namedArgs": namedArgs,
         "compat": true
     });
     // 2. prepare args

package/request/openapi.js

@@ -582,7 +582,7 @@ async function openSDKCreateRecordsBySync(objectApiName, records) {
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.objectApiName, objectApiName);
     // 2.请求
-    options.json = records;
+    options.json = { records: records };
     return await openapi.doRequest(null, urlPath, options);
 }
 ;
@@ -592,7 +592,7 @@ async function openSDKUpdateRecordsBySync(objectApiName, records) {
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.objectApiName, objectApiName);
     // 2.请求
-    options.json = records;
+    options.json = { records: records };
     return await openapi.doRequest(null, urlPath, options);
 }
 ;
@@ -602,7 +602,7 @@ async function openSDKDeleteRecordsBySync(objectApiName, recordIDs) {
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.objectApiName, objectApiName);
     // 2.请求
-    options.json = recordIDs;
+    options.json = { _ids: recordIDs };
     return await openapi.doRequest(null, urlPath, options);
 }
 ;