@byted-apaas/server-sdk-node 1.0.15 → 1.0.17

package/README.md

@@ -1,5 +1,16 @@
 ## aPaaS @byted-apaas/server-sdk-node 版本说明：
 
+-------
+### 版本：1.0.17｜兼容升级
+优化：废弃 flow.variables & flow.updateVariable 相关 API
+
+-------
+### 版本：1.0.16|兼容升级
+新功能：支持模糊查询 fuzzySearch
+```js
+await context.db.object("obj").fuzzySearch("keyword", ["field1", "field2"]).find();
+```
+
 -------
 ### 版本：1.0.15｜兼容升级
 新功能：数据操作接口支持指定鉴权身份

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

@@ -249,6 +249,16 @@ export interface _IKQuery<T> {
      * 设置查询条件
      */
     where(): Omit<_IKQuery<T>, 'findAll'>;
+    /**
+     * 模糊查询：与 where 之间是与关系
+     * @param keyword 模糊查询的关键字，必填且不可以为空串
+     * @param fieldAPINames 『可搜索字段』的字段列表，不可为空
+     * @example
+     * ```
+     * context.db.object("_user").fuzzySearch("张三", ["_name"]).find()
+     * ```
+     */
+    fuzzySearch(keyword: string, fieldAPINames: string[]): Omit<_IKQuery<T>, 'findAll'>;
     /**
      * 指定分页查询的数量
      * @param limit 分页查询的数量

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

@@ -72,6 +72,7 @@ declare class _KObjectQuery<T> implements _IKQuery<T> {
     select<K extends keyof T>(...fieldApiNames: K[]): _KQuery<T>;
     where(conditionMap: _WhereCond<T>): _KQuery<T>;
     where(): _KQuery<T>;
+    fuzzySearch(keyword: string, fieldAPINames: string[]): _KQuery<T>;
     limit(limit: number): _KQuery<T>;
     offset(offset: number): _KQuery<T>;
     count(): Promise<number>;
@@ -102,6 +103,7 @@ declare class _KQuery<T> implements _IKQuery<T> {
     select<K extends keyof T>(...fieldApiNames: K[]): this;
     where(conditionMap: _WhereCond<T>): this;
     where(): this;
+    fuzzySearch(keyword: string, fieldAPINames: string[]): this;
     limit(limit: number): this;
     offset(offset: number): this;
     count(): Promise<number>;

package/context/db/impl/object.js

@@ -339,6 +339,9 @@ 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);
+    }
     // limit, offset, count
     limit(limit) {
         return new _KQuery(this.apiName, this.appCtx, this.authType).limit(limit);
@@ -397,7 +400,7 @@ class _KQuery {
         }
         else {
             const criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
-            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), false, this.authType);
+            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), false, this.authType);
         }
     }
     ;
@@ -482,7 +485,7 @@ class _KQuery {
             }
             else {
                 let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), [new order_1.Order("_id", "asc")], false, queryBuilder.getSelect(), 0, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, [new order_1.Order("_id", "asc")], false, queryBuilder.getSelect(), 0, newLimit, false, this.authType);
             }
             queryCount += rs.length;
             rs.forEach((r) => {
@@ -552,7 +555,7 @@ class _KQuery {
             }
             else {
                 let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), orders, false, selectFields, i, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, orders, false, selectFields, i, newLimit, false, this.authType);
             }
             queryCount += rs.length;
             try {
@@ -590,7 +593,8 @@ class _KQuery {
             }
             else {
                 let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), [new order_1.Order("_id", "asc")], false, queryBuilder.getSelect(), 0, queryBuilder_1.defaultLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), null, // FindAll 不再迭代
+                [new order_1.Order("_id", "asc")], false, queryBuilder.getSelect(), 0, queryBuilder_1.defaultLimit, false, this.authType);
             }
             rs.forEach((r) => {
                 maxId = r._id > maxId ? r._id : maxId;
@@ -660,6 +664,26 @@ class _KQuery {
         }
         return this;
     }
+    fuzzySearch(keyword, fieldAPINames) {
+        const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        if (queryV2) {
+            throw new server_common_node_1.exceptions.InvalidParamError(`OpenSDK does not implement FuzzySearch`);
+        }
+        if (queryBuilder.fuzzySearch) {
+            throw new server_common_node_1.exceptions.InvalidParamError(`FuzzySearch can only be called once`);
+        }
+        if (!keyword) {
+            throw new server_common_node_1.exceptions.InvalidParamError(`FuzzySearch's keyword can not be empty`);
+        }
+        if (!fieldAPINames || fieldAPINames.length === 0) {
+            throw new server_common_node_1.exceptions.InvalidParamError(`FuzzySearch's fieldAPINames can not be empty`);
+        }
+        queryBuilder.fuzzySearch = {
+            keyword: keyword,
+            fieldAPINames: fieldAPINames,
+        };
+        return this;
+    }
     limit(limit) {
         const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
         limit = Number(limit);
@@ -702,7 +726,7 @@ class _KQuery {
         }
         else {
             let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
-            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), true, this.authType);
+            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), true, this.authType);
         }
     }
     ;

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

@@ -14,6 +14,7 @@ export declare class QueryBuilder {
     offset: number;
     order: Order[];
     logic: Logic;
+    fuzzySearch: object;
     constructor(objectApiName: string);
     addLogic(logic: Logic): void;
     getLogic(): Logic;

package/package.json

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

package/request/innerapi.d.ts

@@ -17,7 +17,7 @@ export declare class RequestRpc implements IInnerAPIRequest {
     createRecordsBySync(objectApiName: string, records: object[], authType: string): any;
     updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>, authType: string): any;
     deleteRecordsBySync(objectApiName: string, recordIDs: number[], authType: string): any;
-    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, fuzzySearch: any, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
     updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): Promise<void>;
     uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
     downloadFileByID(fileID: string, filePath?: string): Promise<Buffer | void>;

package/request/innerapi.js

@@ -331,10 +331,7 @@ async function deleteRecordsBySync(objectApiName, recordIDs, authType) {
     });
     return { err_map: errMap };
 }
-async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
-    if (limit > 10000) {
-        limit = 10000;
-    }
+async function getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearch, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     // 1.check
     if (!objectApiName) {
         throw new exceptions.InvalidParamError("objectApiName is empty");
@@ -361,6 +358,7 @@ async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ign
     param.FieldAPIAPIAliases = fieldApiNames;
     param.NeedFilterUserPermission = false;
     param.NeedTotalCount = needCount;
+    param.FuzzySearch = fuzzySearch;
     // 4.发起请求
     let resp;
     try {
@@ -1114,7 +1112,7 @@ class RequestRpc {
     }
     deleteRecordsBySync(objectApiName, recordIDs, authType) {
     }
-    getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
+    getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearch, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     }
     async updateWorkflowVariables(ctx, instanceId, variables, variableTypes) {
     }

package/request/interface.d.ts

@@ -41,7 +41,7 @@ export interface IInnerAPIBaseRequest {
     createRecordsBySync(objectApiName: string, records: object[], authType: string): any;
     updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>, authType: string): any;
     deleteRecordsBySync(objectApiName: string, recordIDs: number[], authType: string): any;
-    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, fuzzySearch: any, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
     updateWorkflowVariables(ctx: any, instanceId: number, variables: object, variableTypes: object): Promise<void>;
     uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
     downloadFileByID(fileID: string, filePath?: string): Promise<Buffer | void>;

package/request/openapi.d.ts

@@ -19,7 +19,7 @@ export declare class RequestHttp implements IInnerAPIRequest {
     createRecordsBySync(objectApiName: string, records: object[], authType: string): any;
     updateRecordsBySync(objectApiName: string, recordMap: Record<number, object>, authType: string): any;
     deleteRecordsBySync(objectApiName: string, recordIDs: number[], authType: string): any;
-    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
+    getRecordsOrCountByCriterion(objectApiName: string, criterion: string | Criterion, order: Order[], fuzzySearch: any, ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string): any;
     uploadFile(data: Stream, expire: number): Promise<UploadFileResp>;
     downloadFileByID(fileID: string, filePath?: string): Promise<void | Buffer>;
     downloadFileByToken(fileToken: string, filePath?: string): Promise<Buffer | void>;

package/request/openapi.js

@@ -261,10 +261,7 @@ function handleResponse(data, needCount) {
         return [];
     }
 }
-async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
-    if (limit > 10000) {
-        limit = 10000;
-    }
+async function getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearch, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     // 1.check
     if (!objectApiName) {
         throw new exceptions.InternalError("objectApiName is empty");
@@ -283,6 +280,7 @@ async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ign
         "limit": limit,
         "need_filter_user_permission": false,
         "need_total_count": needCount,
+        "fuzzySearch": fuzzySearch,
     };
     authType = (0, utils_1.formatAuthType)(authType);
     options.headers["User"] = utils.getUserIDFromCtx() + "";
@@ -793,7 +791,7 @@ class RequestHttp {
     }
     deleteRecordsBySync(objectApiName, recordIDs, authType) {
     }
-    getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
+    getRecordsOrCountByCriterion(objectApiName, criterion, order, fuzzySearch, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     }
     uploadFile(data, expire) {
         return null;