@byted-apaas/server-sdk-node 1.0.16 → 1.1.0-beta.11

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

@@ -1,17 +1,18 @@
 import { _Cond, _Record, _WhereCond } from '../../../types/types';
+import { BatchResult } from "../../../common/structs";
 export interface _IKAllEndpoint<T> extends _IKSyncEndpoint<T>, _IKAsyncEndpoint<T> {
 }
 export interface _IKSyncEndpoint<T> {
     /**
      * 创建记录
      * @param recordMap 用于创建的一条记录
-     * @paramExample {_name: "John", age: 19, gender: "male"}
+     * @paramExample {_name: 'John', age: 19, gender: 'male'}
      * @example
      * ```
-     * context.db.object("_department").create({
-     *     _name: new kunlun.type.Multilingual({ zh: "部门" }),
+     * application.data.object('_department').create({
+     *     _name: new application.constants.type.Multilingual({ zh: '部门' }),
      *     _manager: { _id: 1660000000 },
-     *     _status: "_active"
+     *     _status: '_active'
      * })
      * ```
      */
@@ -23,7 +24,7 @@ export interface _IKSyncEndpoint<T> {
      * @param recordID 用于删除的一条记录的 ID
      * @example
      * ```
-     * context.db.object("_user").delete(123456789123)
+     * application.data.object('_user').delete(123456789123)
      * ```
      */
     delete(recordID: number): Promise<void>;
@@ -32,7 +33,7 @@ export interface _IKSyncEndpoint<T> {
      * @param record 用于删除的一条完整记录
      * @example
      * ```
-     * context.db.object("_user").delete(context.targetRecord.original)
+     * application.data.object('_user').delete(context.targetRecord.original)
      * ```
      */
     delete(record: _Cond<T>): Promise<void>;
@@ -40,11 +41,11 @@ export interface _IKSyncEndpoint<T> {
      * 指定 _id 后，更新对应记录
      * @param _id 主键
      * @param recordMap 用于更新的一条记录
-     * @paramExample {_name: "John", age: 19, gender: "male"}
+     * @paramExample {_name: 'John', age: 19, gender: 'male'}
      * @example
      * ```
-     * context.db.object("_user").update(1660000000, {
-     *     gender: "male"
+     * application.data.object('_user').update(1660000000, {
+     *     gender: 'male'
      * })
      * ```
      */
@@ -52,12 +53,12 @@ export interface _IKSyncEndpoint<T> {
     /**
      * 指定 _id 后，更新对应记录
      * @param recordMap 用于更新的一条记录，需对 _id 赋值
-     * @paramExample {_id: 1660000000, _name: "John", age: 19, gender: "male"}
+     * @paramExample {_id: 1660000000, _name: 'John', age: 19, gender: 'male'}
      * @example
      * ```
-     * context.db.object("_user").update({
+     * application.data.object('_user').update({
      *     _id: 1660000000,
-     *     gender: "male"
+     *     gender: 'male'
      * })
      * ```
      */
@@ -65,7 +66,7 @@ export interface _IKSyncEndpoint<T> {
     /**
      * 批量创建记录
      * @param recordMapList 多条用于创建的记录数据组成的数组
-     * @paramExample [{_name: "John", age: 19, gender: "male"}, {_name: "Alis", age: 16, gender: "female"}]
+     * @paramExample [{_name: 'John', age: 19, gender: 'male'}, {_name: 'Alis', age: 16, gender: 'female'}]
      */
     batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
     /**
@@ -73,19 +74,19 @@ export interface _IKSyncEndpoint<T> {
      * @param recordIdList 多个用于删除的记录 ID 组成的数组
      * @paramExample [1001, 1002, 1003]
      */
-    batchDelete(recordIdList: number[]): Promise<void>;
+    batchDelete(recordIdList: number[]): Promise<BatchResult>;
     /**
      * 批量删除记录
      * @param recordList 多条用于删除的记录数据组成的数组，记录数据需对 _id 赋值
-     * @paramExample [{_id: 1001, _name: "John", gender: "male"}, {_id: 1002, _name: "Alis", gender: "female"}]
+     * @paramExample [{_id: 1001, _name: 'John', gender: 'male'}, {_id: 1002, _name: 'Alis', gender: 'female'}]
      */
-    batchDelete(recordList: _Cond<T>[]): Promise<void>;
+    batchDelete(recordList: _Cond<T>[]): Promise<BatchResult>;
     /**
      * 根据 _id 批量更新记录
      * @param recordMapList 多条用于更新的记录数据组成的数组，记录数据需对 _id 赋值
-     * @paramExample [{_id: 1001, _name: "John", gender: "male"}, {_id: 1002, _name: "Alis", gender: "female"}]
+     * @paramExample [{_id: 1001, _name: 'John', gender: 'male'}, {_id: 1002, _name: 'Alis', gender: 'female'}]
      */
-    batchUpdate(recordMapList: _Cond<T>[]): Promise<void>;
+    batchUpdate(recordMapList: _Cond<T>[]): Promise<BatchResult>;
     /**
      * 用户级鉴权
      */
@@ -99,7 +100,7 @@ export interface _IKAsyncEndpoint<T> {
     /**
      * 批量创建记录（为异步任务）
      * @param recordMapList 用于创建的多条记录
-     * @paramExample [{_name: "John", age: 19, gender: "male"}, {_name: "Alis", age: 16, gender: "female"}]
+     * @paramExample [{_name: 'John', age: 19, gender: 'male'}, {_name: 'Alis', age: 16, gender: 'female'}]
      */
     batchCreateAsync(recordMapList: _Cond<T>[]): Promise<{
         taskID: number;
@@ -121,7 +122,7 @@ export interface _IKAsyncEndpoint<T> {
     /**
      * 根据 _id 批量更新记录（为异步任务）
      * @param recordMapList 用于更新的多条记录，需对 _id 赋值
-     * @paramExample [{_id: 1001, _name: "John", gender: "male"}, {_id: 1002, _name: "Alis", gender: "female"}]
+     * @paramExample [{_id: 1001, _name: 'John', gender: 'male'}, {_id: 1002, _name: 'Alis', gender: 'female'}]
      */
     batchUpdateAsync(recordMapList: _Cond<T>[]): Promise<{
         taskID: number;
@@ -142,8 +143,8 @@ export interface _IKQuery<T> {
      * 无需入参，返回全部符合条件的记录
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * application.data.object('_user').where({
+     *     gender: 'male'
      * }).findAll()
      * ```
      */
@@ -153,7 +154,7 @@ export interface _IKQuery<T> {
      * @param handler 业务处理函数
      * @example
      * ```
-     * await context.db.object("_user").findStream(async (records) => {
+     * await application.data.object('_user').findStream(async (records) => {
      *     // doSomething ...
      * });
      * ```
@@ -163,8 +164,8 @@ export interface _IKQuery<T> {
      * 无需入参，返回符合条件的记录，单次返回 200 条
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * application.data.object('_user').where({
+     *     gender: 'male'
      * }).find()
      * ```
      */
@@ -173,8 +174,8 @@ export interface _IKQuery<T> {
      * 无需入参，返回排在第一位的记录
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * application.data.object('_user').where({
+     *     gender: 'male'
      * }).findOne()
      * ```
      */
@@ -184,7 +185,7 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 排序依据的字段数组，按先后顺序确定优先级
      * @example
      * ```
-     * context.db.object("_user").orderBy(["_email", "_phoneNumber"]).find()
+     * application.data.object('_user').orderBy(['_email', '_phoneNumber']).find()
      * ```
      */
     orderBy<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -193,7 +194,7 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 排序依据的字段，按先后顺序确定优先级，用逗号分隔
      * @example
      * ```
-     * context.db.object("_user").orderBy("_email", "_phoneNumber").find()
+     * application.data.object('_user').orderBy('_email', '_phoneNumber').find()
      * ```
      */
     orderBy<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -202,7 +203,7 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 排序依据的字段数组，按先后顺序确定优先级
      * @example
      * ```
-     * context.db.object("_user").orderByDesc("_email", "_phoneNumber").find()
+     * application.data.object('_user').orderByDesc('_email', '_phoneNumber').find()
      * ```
      */
     orderByDesc<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -211,7 +212,7 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 排序依据的字段，按先后顺序确定优先级，用逗号分隔
      * @example
      * ```
-     * context.db.object("_user").orderByDesc("_email", "_phoneNumber").find()
+     * application.data.object('_user').orderByDesc('_email', '_phoneNumber').find()
      * ```
      */
     orderByDesc<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -220,7 +221,7 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 需返回的字段数组
      * @example
      * ```
-     * context.db.object("_user").select(["_name", "_email"]).find()
+     * application.data.object('_user').select(['_name', '_email']).find()
      * ```
      */
     select<K extends keyof T>(fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -229,18 +230,18 @@ export interface _IKQuery<T> {
      * @param fieldApiNames 需返回的字段，用逗号分隔
      * @example
      * ```
-     * context.db.object("_user").select("_name", "_email").find()
+     * application.data.object('_user').select('_name', '_email').find()
      * ```
      */
     select<K extends keyof T>(...fieldApiNames: K[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 设置查询条件
      * @param conditionMap 对字段赋值以指定查询筛选条件
-     * @paramExample {gender: "male"}
+     * @paramExample {gender: 'male'}
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * application.data.object('_user').where({
+     *     gender: 'male'
      * }).find()
      * ```
      */
@@ -255,7 +256,7 @@ export interface _IKQuery<T> {
      * @param fieldAPINames 『可搜索字段』的字段列表，不可为空
      * @example
      * ```
-     * context.db.object("_user").fuzzySearch("张三", ["_name"]).find()
+     * application.data.object('_user').fuzzySearch('张三', ['_name']).find()
      * ```
      */
     fuzzySearch(keyword: string, fieldAPINames: string[]): Omit<_IKQuery<T>, 'findAll'>;
@@ -265,7 +266,7 @@ export interface _IKQuery<T> {
      * @paramExample 10
      * @example
      * ```
-     * context.db.object("_user").limit(10)
+     * application.data.object('_user').limit(10)
      * ```
      */
     limit(limit: number): Omit<_IKQuery<T>, 'findAll'>;
@@ -275,7 +276,7 @@ export interface _IKQuery<T> {
      * @paramExample 0
      * @example
      * ```
-     * context.db.object("_user").offset(0)
+     * application.data.object('_user').offset(0)
      * ```
      */
     offset(offset: number): Omit<_IKQuery<T>, 'findAll'>;
@@ -283,7 +284,7 @@ export interface _IKQuery<T> {
      * 指定条件的行数
      * @example
      * ```
-     * context.db.object("_user").count()
+     * application.data.object('_user').count()
      * ```
      */
     count(): Promise<number>;

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

@@ -2,8 +2,8 @@ import { _IKAllEndpoint, _IKSyncEndpoint, _IKQuery } from './IObject';
 import { ITransactionGetter } from './transaction';
 import { IDB, IDBSync, IDBWithCurrentObject } from '../db';
 import { currentObjApiName, metadataMap } from '../../../data/index';
-import { IOql } from "./oql/ioql";
-import { AppCtx } from "../../../application/application";
+import { IOql } from './oql/ioql';
+import { AppCtx } from '../../../application/application';
 export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
     objectApiName: string;
     constructor(objectApiName?: string);
@@ -12,8 +12,8 @@ export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
      * @param objectApiName 指定对象的 ApiName
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * context.db.object('_user').where({
+     *     gender: 'male'
      * }).find()
      * ```
      */
@@ -23,11 +23,11 @@ export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
      * @example
      * ```
      * let tx = context.db.newTransaction();
-     * let user = tx.object("_user").registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * 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" }),
+     * let contract = tx.object('contract').registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
      *     user: {id: user._id}
      * });
      * await tx.commit();
@@ -39,7 +39,7 @@ export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
      * @param oql 指定 OQL 语句
      * @example
      * ```
-     * let users = await context.db.oql("select _email from _user").execute();
+     * let users = await context.db.oql('select _email from _user').execute();
      * ```
      */
     oql(oql: string): IOql;

package/context/db/impl/db.js

@@ -14,8 +14,8 @@ class DB {
      * @param objectApiName 指定对象的 ApiName
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * context.db.object('_user').where({
+     *     gender: 'male'
      * }).find()
      * ```
      */
@@ -28,11 +28,11 @@ class DB {
      * @example
      * ```
      * let tx = context.db.newTransaction();
-     * let user = tx.object("_user").registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * 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" }),
+     * let contract = tx.object('contract').registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
      *     user: {id: user._id}
      * });
      * await tx.commit();

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

@@ -1,6 +1,7 @@
 import { _Cond, _Record, _WhereCond } from '../../../types/types';
 import { _IKAsyncEndpoint, _IKQuery, _IKSyncEndpoint } from './IObject';
 import { AppCtx } from '../../../application/application';
+import { BatchResult } from "../../../common/structs";
 /**
  * _KObject is kunlun object, every method new a _KQuery object to deal.
  */
@@ -32,9 +33,9 @@ declare class _KObjectSync<T> implements _IKSyncEndpoint<T> {
     update(_id: number, recordMap: _Cond<T>): Promise<void>;
     update(recordMap: _Cond<T>): Promise<void>;
     batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
-    batchDelete(recordIdList: number[]): Promise<void>;
-    batchDelete(recordList: _Cond<T>[]): Promise<void>;
-    batchUpdate(recordMapList: _Cond<T>[]): Promise<void>;
+    batchDelete(recordIdList: number[]): Promise<BatchResult>;
+    batchDelete(recordList: _Cond<T>[]): Promise<BatchResult>;
+    batchUpdate(recordMapList: _Cond<T>[]): Promise<BatchResult>;
     useUserAuth(): this;
     useSystemAuth(): this;
 }