@byted-apaas/server-sdk-node 1.1.18-beta.5 → 1.1.18-beta.7

package/common/structs.d.ts

@@ -6,10 +6,10 @@ export interface BatchResult {
 }
 export interface BatchResultData {
     success: boolean;
-    _id: number;
+    _id: number | string;
     errors?: BatchResultDataError[];
 }
 export interface BatchResultDataError {
     code: string;
 }
-export declare function NewBatchResult(recordIDs: number[], errMap: Record<number, string>): BatchResult;
+export declare function NewBatchResult(recordIDs: number[] | string[], errMap: Record<number | string, string>): BatchResult;

package/context/db/db.d.ts

@@ -91,27 +91,7 @@ export interface IDBV3<T, mt> {
      * await tx.commit();
      * ```
      */
-    /**
-     * OQL 操作
-     * @param oql OQL 语句
-     * @example
-     * ```
-     * let users = await application.data.oql('select _email from _user').execute();
-     * ```
-     */
-    oql(oql: string): IOql;
-    /**
-     * OQL 操作
-     * @param oql OQL 语句
-     * @param nameArgs 用于替换 OQL 语句中的占位符
-     * @example
-     * ```
-     * let employees = await application.data.oql('select _email from _user where _type = $user_type',{
-     *     'user_type': '_employee',
-     * }).execute();
-     * ```
-     */
-    oql(oql: string, nameArgs: Record<string, any>): IOql;
+    newTransaction(): ITransactionGetter<T, mt>;
 }
 /**
  * IDBWithCurrentObject 经由 IDBGetter 返回，是 DB 的动态增加的接口结构

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

@@ -27,7 +27,7 @@ export interface _IKSyncEndpoint<T> {
      * application.data.object('_user').delete(123456789123)
      * ```
      */
-    delete(recordID: number | string): Promise<void>;
+    delete(recordID: number): Promise<void>;
     /**
      * 删除记录
      * @param record 用于删除的一条完整记录
@@ -49,7 +49,7 @@ export interface _IKSyncEndpoint<T> {
      * })
      * ```
      */
-    update(_id: number | string, recordMap: _Cond<T>): Promise<void>;
+    update(_id: number, recordMap: _Cond<T>): Promise<void>;
     /**
      * 指定 _id 后，更新对应记录
      * @param recordMap 用于更新的一条记录，需对 _id 赋值
@@ -68,7 +68,7 @@ export interface _IKSyncEndpoint<T> {
      * @param recordMapList 多条用于创建的记录数据组成的数组
      * @paramExample [{_name: 'John', age: 19, gender: 'male'}, {_name: 'Alis', age: 16, gender: 'female'}]
      */
-    batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
+    batchCreate(recordMapList: _Cond<T>[]): Promise<number[] | string[]>;
     /**
      * 批量删除记录
      * @param recordIdList 多个用于删除的记录 ID 组成的数组

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

@@ -68,13 +68,13 @@ export interface _IKSyncEndpointV3<T> {
      * @param recordMapList 多条用于创建的记录数据组成的数组
      * @paramExample [{_name: 'John', age: 19, gender: 'male'}, {_name: 'Alis', age: 16, gender: 'female'}]
      */
-    batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
+    batchCreate(recordMapList: _Cond<T>[]): Promise<number[] | string[]>;
     /**
      * 批量删除记录
      * @param recordIdList 多个用于删除的记录 ID 组成的数组
      * @paramExample [1001, 1002, 1003]
      */
-    batchDelete(recordIdList: number[] | string[]): Promise<BatchResult>;
+    batchDelete(recordIdList: string[]): Promise<BatchResult>;
     /**
      * 批量删除记录
      * @param recordList 多条用于删除的记录数据组成的数组，记录数据需对 _id 赋值

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

@@ -1,6 +1,6 @@
+import { ITransactionGetter } from './transaction';
 import { IDBV3 } from '../db';
 import { metadataMap } from '../../../data/index';
-import { IOql } from './oql/ioql';
 import { _IKAllEndpointV3, _IKQueryV3 } from './IObjectV3';
 export declare class DBV3<T, mt = metadataMap> implements IDBV3<T, mt> {
     objectApiName: string;
@@ -31,14 +31,5 @@ export declare class DBV3<T, mt = metadataMap> implements IDBV3<T, mt> {
      * await tx.commit();
      * ```
      */
-    /**
-     * 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;
+    newTransaction(): ITransactionGetter<T, mt>;
 }

package/context/db/impl/dbV3.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DBV3 = void 0;
 const object_1 = require("./object");
-const oql_1 = require("./oql/oql");
+const index_1 = require("./transaction/index");
 class DBV3 {
     constructor(objectApiName) {
         this.objectApiName = objectApiName;
@@ -24,14 +24,27 @@ class DBV3 {
         return new object_1._KObject(objectApiName, appCtx);
     }
     ;
-    oql(oql, nameArgs) {
+    /**
+     * 创建一个新的空事务
+     * @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",
         };
-        if (nameArgs) {
-            return new oql_1.Oql(oql, nameArgs, appCtx);
-        }
-        return new oql_1.Oql(oql, undefined, appCtx);
+        return new index_1.Transaction(this.objectApiName, appCtx);
     }
+    ;
 }
 exports.DBV3 = DBV3;

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

@@ -35,11 +35,14 @@ declare class _KObjectSync<T> implements _IKSyncEndpoint<T>, _IKSyncEndpointV3<T
     update(_id: number | string, recordMap: _Cond<T>): Promise<void>;
     update(recordMap: _Cond<T>): Promise<void>;
     private updateV3;
-    batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
+    batchCreate(recordMapList: _Cond<T>[]): Promise<number[] | string[]>;
+    private batchCreateV3;
     batchDelete(recordIdList: string[]): Promise<BatchResult>;
     batchDelete(recordIdList: number[]): Promise<BatchResult>;
     batchDelete(recordList: _Cond<T>[]): Promise<BatchResult>;
+    private batchDeleteV3;
     batchUpdate(recordMapList: _Cond<T>[]): Promise<BatchResult>;
+    private batchUpdateV3;
     useUserAuth(): this;
     useSystemAuth(): this;
 }

package/context/db/impl/object.js

@@ -212,6 +212,9 @@ class _KObjectSync {
             }
         }
         recordMapList = permissionUtils.batchDelUnauthField(recordMapList).newRecords;
+        if (this.appCtx && this.appCtx.dataVersion === "v3") {
+            return await this.batchCreateV3(recordMapList);
+        }
         let data = (this.appCtx && this.appCtx.mode == 'openSDK') ?
             await (0, common_1.runCtxForOpenSDK)(this.appCtx, async () => await Request.GetInstance().openSDKCreateRecordsBySync(this.apiName, recordMapList))
             : await Request.GetInstance().createRecordsBySync(this.apiName, recordMapList, this.authType);
@@ -222,6 +225,11 @@ class _KObjectSync {
         return data;
     }
     ;
+    async batchCreateV3(recordMapList) {
+        const dataV3 = await Request.GetInstance().createRecordsV3BySync(this.apiName, recordMapList, this.authType);
+        const ids = (dataV3.items || []).map((item) => item?._id);
+        return ids;
+    }
     async batchDelete(idOrRecordList) {
         // 参数校验、组装
         if (!this.apiName) {
@@ -230,6 +238,9 @@ class _KObjectSync {
         if (!(idOrRecordList instanceof Array) || idOrRecordList.length === 0) {
             throw new server_common_node_1.exceptions.InvalidParamError('param records is not an array or an empty array');
         }
+        if (this.appCtx && this.appCtx.dataVersion === "v3") {
+            return this.batchDeleteV3(idOrRecordList);
+        }
         let recordIDs = [];
         for (let record of idOrRecordList) {
             if (typeof (record) === 'number') {
@@ -251,6 +262,25 @@ class _KObjectSync {
         const errMap = await Request.GetInstance().deleteRecordsBySync(this.apiName, recordIDs, this.authType);
         return (0, structs_1.NewBatchResult)(recordIDs, errMap);
     }
+    async batchDeleteV3(idOrRecordList) {
+        let recordIDs = [];
+        for (let record of idOrRecordList) {
+            if (typeof (record) === 'string') {
+                recordIDs.push(record);
+            }
+            else if (typeof (record) === 'number') {
+                recordIDs.push(record.toString());
+            }
+            else if (server_common_node_1.checkUtils.isObject(record) && record._id && typeof (record._id) === 'string') {
+                recordIDs.push(record._id);
+            }
+            else {
+                throw new server_common_node_1.exceptions.InvalidParamError('record must be string or number or object');
+            }
+        }
+        const errMap = await Request.GetInstance().deleteRecordsV3BySync(this.apiName, recordIDs, this.authType);
+        return (0, structs_1.NewBatchResult)(recordIDs, errMap);
+    }
     async batchUpdate(recordMapList) {
         // 参数校验、组装
         if (!this.apiName) {
@@ -260,6 +290,9 @@ class _KObjectSync {
             throw new server_common_node_1.exceptions.InvalidParamError('param records is not an array or an empty array');
         }
         recordMapList = permissionUtils.batchDelUnauthField(recordMapList).newRecords;
+        if (this.appCtx && this.appCtx.dataVersion === "v3") {
+            return await this.batchUpdateV3(recordMapList);
+        }
         const recordIDs = [];
         let recordMap = {};
         for (let record of recordMapList) {
@@ -286,6 +319,25 @@ class _KObjectSync {
         return (0, structs_1.NewBatchResult)(recordIDs, errMap);
     }
     ;
+    async batchUpdateV3(recordMapList) {
+        const recordIDs = [];
+        let recordMap = {};
+        for (let record of recordMapList) {
+            let recordID;
+            if (typeof record._id === 'number') {
+                recordID = record._id.toString();
+            }
+            else if (typeof record._id === 'string') {
+                recordID = record._id;
+            }
+            if ((typeof recordID !== 'string') || recordID == "") {
+                throw new server_common_node_1.exceptions.InvalidParamError('record._id is empty');
+            }
+            recordIDs.push(recordID);
+        }
+        const errMap = await Request.GetInstance().updateRecordsV3BySync(this.apiName, recordMapList, this.authType);
+        return (0, structs_1.NewBatchResult)(recordIDs, errMap);
+    }
     useUserAuth() {
         this.authType = constants_1.AuthTypeUser;
         return this;
@@ -607,7 +659,7 @@ class _KQuery {
                 criterion.conditions[criterion.conditions.length - 1].right.settings.data = maxId;
                 // 转换成 V3 的 criterion
                 const criterionV3 = (0, logic_1.convertCriterionToCriterionV3)(criterion);
-                rs = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.fuzzySearch, [new order_1.Order('_id', 'asc')], queryBuilder.getSelect(), 0, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.quickQuery, queryBuilder.quickQueryFields, [new order_1.Order('_id', 'asc')], queryBuilder.getSelect(), 0, newLimit, false, this.authType);
             }
             else {
                 // 更新 maxId
@@ -704,7 +756,7 @@ class _KQuery {
                 criterion.conditions[criterion.conditions.length - 1].right.settings.data = maxId;
                 // 转换成 V3 的 criterion
                 const criterionV3 = (0, logic_1.convertCriterionToCriterionV3)(criterion);
-                rs = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.fuzzySearch, orders, selectFields, curOffset, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.quickQuery, queryBuilder.quickQueryFields, orders, selectFields, curOffset, newLimit, false, this.authType);
             }
             else {
                 // 更新 maxId
@@ -843,6 +895,8 @@ class _KQuery {
             keyword: keyword,
             fieldAPINames: fieldAPINames,
         };
+        queryBuilder.quickQuery = keyword;
+        queryBuilder.quickQueryFields = fieldAPINames;
         return this;
     }
     limit(limit) {
@@ -898,14 +952,14 @@ class _KQuery {
     }
     ;
     async findV3(needCount) {
-        const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        const { apiName, queryBuilder } = queryPropertiesStore.get(this);
         let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
         if (queryBuilder.getLogic().logics.length > 0) {
             // console.log("test-----------------------", queryBuilder.getLogic().logics)
             criterion = await (0, logic_1.handleCriterion)(criterion);
         }
         const criterionV3 = (0, logic_1.convertCriterionToCriterionV3)(criterion);
-        const res = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.fuzzySearch, queryBuilder.getOrder(), queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), needCount, this.authType);
+        const res = await Request.GetInstance().getRecordsV3OrCounByCriterion(apiName, criterionV3, queryBuilder.quickQuery, queryBuilder.quickQueryFields, queryBuilder.getOrder(), queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), needCount, this.authType);
         if (needCount) {
             return res;
         }

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

@@ -15,6 +15,8 @@ export declare class QueryBuilder {
     order: Order[];
     logic: Logic;
     fuzzySearch: object;
+    quickQuery: string;
+    quickQueryFields: string[];
     constructor(objectApiName: string);
     addLogic(logic: Logic): void;
     getLogic(): Logic;

package/context/metadata/metadata.js

@@ -6,6 +6,7 @@ exports.metadataV3 = exports.MetaDataV3 = exports.metaType = exports.metadata =
 const components = require("./components/components");
 const common = require("@byted-apaas/server-common-node");
 const fields = require("./objects/fields");
+const fieldsV3 = require("./objects/fieldsV3");
 const Request = require("../../request/interface");
 const commonExceptions = common.exceptions;
 // interface ---------------------------------------------------------------------------------------
@@ -43,7 +44,10 @@ class MetaDataV3 {
         if (!objectApiName) {
             throw new commonExceptions.InvalidParamError('objectApiName is empty');
         }
-        return new KObject(objectApiName);
+        const appCtx = {
+            dataVersion: "v3",
+        };
+        return new KObject(objectApiName, appCtx);
     }
     page(apiName, objectApiName, type) {
         if (!apiName) {
@@ -60,19 +64,26 @@ class MetaDataV3 {
 }
 exports.MetaDataV3 = MetaDataV3;
 function metadataV3(ctx) {
-    return new MetaData(ctx);
+    return new MetaDataV3(ctx);
 }
 exports.metadataV3 = metadataV3;
 class KObject {
-    constructor(objectApiName) {
+    constructor(objectApiName, appCtx) {
         this.objectApiName = objectApiName;
+        this.appCtx = appCtx;
     }
     async getFields() {
         let res = await Request.GetInstance().getFields(this.objectApiName);
+        if (this.appCtx && this.appCtx.dataVersion === "v3") {
+            return fieldsV3.parseFieldsV3(res);
+        }
         return fields.parseFields(res);
     }
     async getField(fieldApiName) {
         let res = await Request.GetInstance().getField(this.objectApiName, fieldApiName);
+        if (this.appCtx && this.appCtx.dataVersion === "v3") {
+            return fieldsV3.parseFieldV3(res);
+        }
         return fields.parseField(res);
     }
 }

package/context/metadata/objects/fieldsV3.d.ts

@@ -0,0 +1,158 @@
+import { BaseFieldType, CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
+import { I18ns, MultilingualTypeV3 } from '../types/common';
+declare class MetadataFieldV3 {
+    type: string;
+    apiName: string;
+    label: MultilingualTypeV3;
+    constructor(type: string, field: FieldType);
+}
+declare class KTextV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+    validationRegex: string;
+    errorMsg: MultilingualTypeV3;
+    constructor(field: FieldType);
+}
+declare class RichTextV3 extends MetadataFieldV3 {
+    maxLength: number;
+    required: boolean;
+    constructor(field: FieldType);
+}
+declare class MultilingualV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+    constructor(field: FieldType);
+}
+declare class NumberV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+    constructor(field: FieldType);
+}
+declare class BigintV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    constructor(field: FieldType);
+}
+declare class DecimalV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+    constructor(field: FieldType);
+}
+declare class KDateV3 extends MetadataFieldV3 {
+    required: boolean;
+    constructor(field: FieldType);
+}
+declare class DateTimeV3 extends MetadataFieldV3 {
+    required: boolean;
+    constructor(field: FieldType);
+}
+declare class OptionV3 extends MetadataFieldV3 {
+    required: boolean;
+    multiple: boolean;
+    optionSource: ('custom' | 'global');
+    globalOptionApiName: string;
+    optionList: SubOptionType[];
+    constructor(field: FieldType);
+}
+declare class EmailV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    constructor(field: FieldType);
+}
+declare class MobileNumberV3 extends MetadataFieldV3 {
+    required: boolean;
+    unique: boolean;
+    constructor(field: FieldType);
+}
+declare class BooleanV3 extends MetadataFieldV3 {
+    descriptionWhenTrue: I18ns;
+    descriptionWhenFalse: I18ns;
+    defaultValue: boolean;
+    unique: boolean;
+    constructor(field: FieldType);
+}
+declare class AvatarOrLogoV3 extends MetadataFieldV3 {
+    displayStyle: ('square' | 'round');
+    constructor(field: FieldType);
+}
+declare class LookupV3 extends MetadataFieldV3 {
+    required: boolean;
+    multiple: boolean;
+    objectApiName: string;
+    hierarchy: boolean;
+    displayStyle: ('search' | 'dropDown' | 'tree');
+    sortConditions: SortConditionType[];
+    filter: FilterType[];
+    constructor(field: FieldType);
+}
+declare class FormulaV3 extends MetadataFieldV3 {
+    returnType: string;
+    formula: MultilingualTypeV3;
+    constructor(field: FieldType);
+}
+declare class AutoIDV3 extends MetadataFieldV3 {
+    generateMethod: ('random' | 'incremental');
+    digitsNumber: number;
+    prefix: string;
+    suffix: string;
+    constructor(field: FieldType);
+}
+declare class ReferenceFieldV3 extends MetadataFieldV3 {
+    guideFieldApiName: string;
+    fieldApiName: string;
+    constructor(field: FieldType);
+}
+declare class RollupV3 extends MetadataFieldV3 {
+    rollupType: string;
+    rollupObjectApiName: string;
+    rollupFieldApiName: string;
+    rollupLookupFieldApiName: string;
+    filter: CriterionType;
+    constructor(field: FieldType);
+}
+declare class RegionV3 extends MetadataFieldV3 {
+    required: boolean;
+    multiple: boolean;
+    optionLevel: boolean;
+    strictLevel: number;
+    filter: RegionFilterType[];
+    constructor(field: FieldType);
+}
+declare class FileV3 extends MetadataFieldV3 {
+    required: boolean;
+    multiple: boolean;
+    fileTypes: string[];
+    constructor(field: FieldType);
+}
+declare class BackLookupV3 extends MetadataFieldV3 {
+    constructor(field: FieldType);
+}
+declare class CompositeTypeV3 extends MetadataFieldV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldType[];
+    required: boolean;
+    multiple: boolean;
+    constructor(field: FieldType);
+}
+declare class ExtractSingleRecordV3 extends MetadataFieldV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldType[];
+    filter: FilterType[];
+    sortConditions: SortConditionType[];
+    recordPosition: number;
+    constructor(field: FieldType);
+}
+declare function parseFieldsV3(inputFields: Record<string, any>): BaseFieldType[];
+declare function parseFieldV3(field: FieldType): BaseFieldType;
+declare function getFieldClassV3(field: FieldType): any;
+export { KTextV3 as TextV3, MultilingualV3, NumberV3, KDateV3 as DateV3, DateTimeV3, OptionV3, EmailV3, MobileNumberV3, BooleanV3, AvatarOrLogoV3, LookupV3, FormulaV3, AutoIDV3, ReferenceFieldV3, FileV3, BackLookupV3, CompositeTypeV3, ExtractSingleRecordV3, RichTextV3, BigintV3, DecimalV3, RegionV3, RollupV3, parseFieldsV3, parseFieldV3, getFieldClassV3, };

package/context/metadata/objects/fieldsV3.js

@@ -0,0 +1,370 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFieldClassV3 = exports.parseFieldV3 = exports.parseFieldsV3 = exports.RollupV3 = exports.RegionV3 = exports.DecimalV3 = exports.BigintV3 = exports.RichTextV3 = exports.ExtractSingleRecordV3 = exports.CompositeTypeV3 = exports.BackLookupV3 = exports.FileV3 = exports.ReferenceFieldV3 = exports.AutoIDV3 = exports.FormulaV3 = exports.LookupV3 = exports.AvatarOrLogoV3 = exports.BooleanV3 = exports.MobileNumberV3 = exports.EmailV3 = exports.OptionV3 = exports.DateTimeV3 = exports.DateV3 = exports.NumberV3 = exports.MultilingualV3 = exports.TextV3 = void 0;
+const fieldsUtil = require("./fields.util");
+const common_1 = require("../types/common");
+class MetadataFieldV3 {
+    constructor(type, field) {
+        this.type = type;
+        this.apiName = field.api_name;
+        this.label = (0, common_1.transI18nsToMultilingualV3)(field.label);
+    }
+}
+class KTextV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('text', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+        this.caseSensitive = fieldsUtil.getCaseSensitive(field);
+        this.multiline = fieldsUtil.getMultiline(field);
+        this.maxLength = fieldsUtil.getMaxLength(field);
+        this.validationRegex = fieldsUtil.getRegexpExpression(field);
+        this.errorMsg = (0, common_1.transI18nsToMultilingualV3)(fieldsUtil.getRegexpErrMsg(field));
+    }
+}
+exports.TextV3 = KTextV3;
+class RichTextV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('richText', field);
+        this.maxLength = fieldsUtil.getMaxLength(field);
+        this.required = field.required;
+    }
+}
+exports.RichTextV3 = RichTextV3;
+class MultilingualV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('multilingual', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+        this.caseSensitive = fieldsUtil.getCaseSensitive(field);
+        this.multiline = fieldsUtil.getMultiline(field);
+        this.maxLength = fieldsUtil.getMaxLength(field);
+    }
+}
+exports.MultilingualV3 = MultilingualV3;
+class NumberV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('number', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+        this.displayAsPercentage = fieldsUtil.getDisplayAsPercentage(field);
+        this.decimalPlacesNumber = fieldsUtil.getDecimalPlaces(field);
+    }
+}
+exports.NumberV3 = NumberV3;
+class BigintV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('bigint', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+exports.BigintV3 = BigintV3;
+class DecimalV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('decimal', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+        this.displayAsPercentage = fieldsUtil.getDisplayAsPercentage(field);
+        this.decimalPlacesNumber = fieldsUtil.getDecimalPlaces(field);
+    }
+}
+exports.DecimalV3 = DecimalV3;
+class KDateV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('date', field);
+        this.required = field.required;
+    }
+}
+exports.DateV3 = KDateV3;
+class DateTimeV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('dateTime', field);
+        this.required = field.required;
+    }
+}
+exports.DateTimeV3 = DateTimeV3;
+class OptionV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('option', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getMultiple(field);
+        this.optionSource = fieldsUtil.getOptionSource(field);
+        this.globalOptionApiName = fieldsUtil.getGlobalOptionApiName(field);
+        this.optionList = fieldsUtil.getOptionList(field);
+    }
+}
+exports.OptionV3 = OptionV3;
+class EmailV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('email', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+exports.EmailV3 = EmailV3;
+class MobileNumberV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('mobileNumber', field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+exports.MobileNumberV3 = MobileNumberV3;
+class BooleanV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('boolean', field);
+        this.unique = fieldsUtil.getUnique(field);
+        this.descriptionWhenTrue = fieldsUtil.getDescriptionWhenTrue(field);
+        this.descriptionWhenFalse = fieldsUtil.getDescriptionWhenFalse(field);
+        this.defaultValue = fieldsUtil.getDefaultValue(field);
+    }
+}
+exports.BooleanV3 = BooleanV3;
+class AvatarOrLogoV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('avatarOrLogo', field);
+        this.displayStyle = fieldsUtil.getDisplayStyle(field);
+    }
+}
+exports.AvatarOrLogoV3 = AvatarOrLogoV3;
+class LookupV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('lookup', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getMultiple(field);
+        this.objectApiName = fieldsUtil.getLookupRefObjectApiName(field);
+        this.hierarchy = fieldsUtil.getLookupIsHierarchy(field);
+        this.displayStyle = fieldsUtil.getLookupDisplayStyle(field);
+        // TODO
+        this.sortConditions = fieldsUtil.getSettingsSort(field);
+        this.filter = [];
+    }
+}
+exports.LookupV3 = LookupV3;
+class FormulaV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('formula', field);
+        this.returnType = fieldsUtil.getReturnType(field);
+        // TODO 由于下游提供仍是 api ID 版本，因此禁用
+        this.formula = null; //fieldsUtil.getFormula(field);
+    }
+}
+exports.FormulaV3 = FormulaV3;
+class AutoIDV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('autoId', field);
+        this.generateMethod = fieldsUtil.getGenerateMethod(field);
+        this.digitsNumber = fieldsUtil.getDigitsNumber(field);
+        this.prefix = fieldsUtil.getPrefix(field);
+        this.suffix = fieldsUtil.getSuffix(field);
+    }
+}
+exports.AutoIDV3 = AutoIDV3;
+class ReferenceFieldV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('referenceField', field);
+        // TODO: check objectApiName to guideFieldApiName
+        this.guideFieldApiName = fieldsUtil.getReferenceObjectApiName(field);
+        this.fieldApiName = fieldsUtil.getReferenceFieldApiName(field);
+    }
+}
+exports.ReferenceFieldV3 = ReferenceFieldV3;
+class RollupV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('rollup', field);
+        this.rollupType = fieldsUtil.getRollupType(field);
+        this.rollupObjectApiName = fieldsUtil.getRollupObjectApiName(field);
+        this.rollupFieldApiName = fieldsUtil.getRollupFieldApiName(field);
+        this.rollupLookupFieldApiName = fieldsUtil.getRollupLookupFieldApiName(field);
+        this.filter = fieldsUtil.getRollupFilter(field);
+    }
+}
+exports.RollupV3 = RollupV3;
+class RegionV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('region', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getSettingsMultiple(field);
+        this.optionLevel = fieldsUtil.getRegionOptionLevel(field);
+        this.strictLevel = fieldsUtil.getRegionStrictLeve(field);
+        this.filter = fieldsUtil.getRegionSettingsFilter(field);
+    }
+}
+exports.RegionV3 = RegionV3;
+class FileV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('file', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getFileMultiple(field);
+        this.fileTypes = fieldsUtil.getFileTypes(field);
+    }
+}
+exports.FileV3 = FileV3;
+class BackLookupV3 extends MetadataFieldV3 {
+    // objectApiName: string; // TODO 由于下游提供仍是 api ID 版本，因此禁用
+    // fieldApiName: string; //  由于下游提供仍是 api ID 版本，因此禁用
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('backLookup', field);
+        // TODO 由于下游提供仍是 api ID 版本，因此禁用
+        // this.objectApiName = fieldsUtil.getBackLookupObjectApiName(field);
+        // this.fieldApiName = fieldsUtil.getBackLookupFieldApiName(field); // TODO metadata返回值为空
+    }
+}
+exports.BackLookupV3 = BackLookupV3;
+class CompositeTypeV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('compositeType', field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getSettingsMultiple(field);
+        this.compositeTypeApiName = fieldsUtil.getCompositeTypeApiName(field);
+        // TODO 字段类型转换
+        this.subFields = parseFieldsV3(fieldsUtil.getCompositeTypeSubFields(field));
+    }
+}
+exports.CompositeTypeV3 = CompositeTypeV3;
+class ExtractSingleRecordV3 extends MetadataFieldV3 {
+    constructor(field) {
+        if (!field) {
+            return;
+        }
+        super('extractSingleRecord', field);
+        this.compositeTypeApiName = fieldsUtil.getCompositeTypeApiName(field);
+        // TODO 字段类型转换
+        this.subFields = parseFieldsV3(fieldsUtil.getCompositeTypeSubFields(field));
+        this.filter = fieldsUtil.getSettingsFilter(field);
+        this.sortConditions = fieldsUtil.getSettingsSort(field);
+        this.recordPosition = fieldsUtil.getRecordPosition(field);
+    }
+}
+exports.ExtractSingleRecordV3 = ExtractSingleRecordV3;
+function getCompositeTypeClass(field) {
+    if (field && field.type && field.type.settings && field.type.settings.is_extract) {
+        return ExtractSingleRecordV3;
+    }
+    return CompositeTypeV3;
+}
+function parseFieldsV3(inputFields) {
+    if (!inputFields || !Array.isArray(inputFields)) {
+        return [];
+    }
+    let fields = [];
+    for (let field of inputFields) {
+        let FieldClass = getFieldClassV3(field);
+        if (!FieldClass) {
+            continue;
+        }
+        fields.push(new FieldClass(field));
+    }
+    return fields;
+}
+exports.parseFieldsV3 = parseFieldsV3;
+function parseFieldV3(field) {
+    let FieldClass = getFieldClassV3(field);
+    if (FieldClass) {
+        return new FieldClass(field);
+    }
+    return null;
+}
+exports.parseFieldV3 = parseFieldV3;
+function getFieldClassV3(field) {
+    if (field && field.type && field.type.name) {
+        if (field.type.name === 'compositeType') {
+            return getCompositeTypeClass(field);
+        }
+        return type2fieldTypeV3[field.type.name];
+    }
+    return null;
+}
+exports.getFieldClassV3 = getFieldClassV3;
+const type2fieldTypeV3 = {
+    'text': KTextV3,
+    'multilingual': MultilingualV3,
+    'float': NumberV3,
+    'date': KDateV3,
+    'datetime': DateTimeV3,
+    'enum': OptionV3,
+    'email': EmailV3,
+    'phone': MobileNumberV3,
+    'boolean': BooleanV3,
+    'avatar': AvatarOrLogoV3,
+    'lookup': LookupV3,
+    'formula': FormulaV3,
+    'auto_number': AutoIDV3,
+    'reference_field': ReferenceFieldV3,
+    'attachment': FileV3,
+    'back_lookup': BackLookupV3,
+    'richText': RichTextV3,
+    'bigint': BigintV3,
+    'decimal': DecimalV3,
+    'rollup': RollupV3,
+    'region': RegionV3,
+};

package/context/metadata/types/common.d.ts

@@ -4,3 +4,8 @@ export type I18n = {
 };
 export type I18ns = I18n[];
 export declare function isNullOrUndefined(param: any): boolean;
+export declare function transI18nsToMultilingualV3(i18ns: I18ns): MultilingualTypeV3;
+export type MultilingualTypeV3 = {
+    zh_CN: string;
+    en_US: string;
+};

package/context/metadata/types/common.js

@@ -2,8 +2,32 @@
 // Copyright 2022 ByteDance Ltd. and/or its affiliates
 // SPDX-License-Identifier: MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNullOrUndefined = void 0;
+exports.transI18nsToMultilingualV3 = exports.isNullOrUndefined = void 0;
 function isNullOrUndefined(param) {
     return param === null || param === undefined;
 }
 exports.isNullOrUndefined = isNullOrUndefined;
+function transI18nsToMultilingualV3(i18ns) {
+    if (i18ns === null || i18ns === undefined) {
+        return null;
+    }
+    let multilingual = { zh_CN: "", en_US: "" };
+    for (const i18n of i18ns) {
+        switch (i18n.language_code) {
+            case languageCode.zh_CN:
+                multilingual.zh_CN = i18n.text;
+                break;
+            case languageCode.en_US:
+                multilingual.en_US = i18n.text;
+                break;
+            default:
+                break;
+        }
+    }
+    return multilingual;
+}
+exports.transI18nsToMultilingualV3 = transI18nsToMultilingualV3;
+const languageCode = {
+    zh_CN: 2052,
+    en_US: 1033
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.18-beta.5",
+  "version": "1.1.18-beta.7",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -13,7 +13,7 @@
     "clean": "tsc --build --clean && rm -rf **/*.js.map"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "2.0.12-beta.3",
+    "@byted-apaas/server-common-node": "2.0.12-beta.4",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",

package/request/interface.d.ts

@@ -55,9 +55,11 @@ export interface IInnerAPIBaseRequest {
     createRecordsBySync: (objectApiName: string, records: object[], authType: string) => any;
     createRecordsV3BySync: (objectApiName: string, records: object[], authType: string) => any;
     updateRecordsBySync: (objectApiName: string, recordMap: Record<number, object>, authType: string) => Promise<Record<number, string>>;
+    updateRecordsV3BySync: (objectApiName: string, recordMap: object[], authType: string) => Promise<Record<string, string>>;
     deleteRecordsBySync: (objectApiName: string, recordIDs: number[], authType: string) => Promise<Record<number, string>>;
+    deleteRecordsV3BySync: (objectApiName: string, recordIDs: string[], authType: string) => Promise<Record<string, string>>;
     getRecordsOrCountByCriterion: (objectApiName: string, criterion: string | Criterion, fuzzySearch: any, order: Order[], ignoreBackLookupField: boolean, fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string) => any;
-    getRecordsV3OrCounByCriterion: (objectApiName: string, criterion: string | CriterionV3, fuzzySearch: any, order: Order[], fieldApiNames: string[], offset: number, limit: number, needCount: boolean, authType: string) => any;
+    getRecordsV3OrCounByCriterion: (objectApiName: string, criterion: string | CriterionV3, quickQuery: string, quickQueryFields: string[], order: Order[], 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, fileName?: string) => Promise<UploadFileResp>;
     downloadFileByID: (fileID: string, filePath?: string) => Promise<Buffer | undefined>;

package/request/openapi.d.ts

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

package/request/openapi.js

@@ -345,7 +345,7 @@ async function updateRecordsV3BySync(objectApiName, records, authType) {
     // todo wby 待确认返回值
     const errMap = {};
     for (let recordID of Object.keys(resp.err_map)) {
-        errMap[Number(recordID)] = resp.err_map[recordID];
+        errMap[String(recordID)] = resp.err_map[recordID];
     }
     return errMap;
 }
@@ -470,7 +470,7 @@ async function getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearc
     let data = await openapi.doRequest(null, urlPath, options);
     return handleResponse(objectApiName, data, needCount);
 }
-async function getRecordsV3OrCountByCriterion(objectApiName, criterion, order, fuzzySearch, fieldApiNames, offset, limit, needCount, authType) {
+async function getRecordsV3OrCountByCriterion(objectApiName, criterion, quickQuery, quickQueryFields, order, fieldApiNames, offset, limit, needCount, authType) {
     // 1.check
     if (!objectApiName) {
         throw new exceptions.InternalError('objectApiName is empty');
@@ -493,6 +493,8 @@ async function getRecordsV3OrCountByCriterion(objectApiName, criterion, order, f
         'order_by': order,
         'need_total_count': needCount,
         'filter': criterion,
+        'quick_query': quickQuery,
+        'quick_query_fields': quickQueryFields,
         // fuzzySearch, // todo wby
         // 只返回 slice 结果，使用 SliceResult
         // 只返回 map 结果，使用 MapResult
@@ -1049,7 +1051,7 @@ class RequestHttp {
     }
     getRecordsOrCountByCriterion(objectApiName, criterion, order, fuzzySearch, ignoreBackLookupField, fieldApiNames, offset, limit, needCount, authType) {
     }
-    getRecordsV3OrCounByCriterion(objectApiName, criterion, order, fuzzySearch, fieldApiNames, offset, limit, needCount, authType) {
+    getRecordsV3OrCounByCriterion(objectApiName, criterion, quickQuery, quickQueryFields, order, fieldApiNames, offset, limit, needCount, authType) {
     }
     uploadFile(data, expire, fileName) {
         return null;