@byted-apaas/server-sdk-node 1.1.18-beta.6 → 1.1.18-beta.8

package/context/metadata/metadata.d.ts

@@ -40,7 +40,6 @@ declare function metadata<mt>(ctx: any): IMetaData<mt>;
 declare class MetaDataV3<mt> implements IMetaData<mt> {
     constructor(ctx: any);
     object<T>(objectApiName: keyof mt): IKObject<T>;
-    page(apiName: string, objectApiName: string, type: string): Page;
 }
 declare function metadataV3<mt>(ctx: any): IMetaData<mt>;
 declare class Page implements IPage {

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,36 +44,34 @@ class MetaDataV3 {
         if (!objectApiName) {
             throw new commonExceptions.InvalidParamError('objectApiName is empty');
         }
-        return new KObject(objectApiName);
-    }
-    page(apiName, objectApiName, type) {
-        if (!apiName) {
-            throw new commonExceptions.InvalidParamError('apiName is empty');
-        }
-        if (!objectApiName) {
-            throw new commonExceptions.InvalidParamError('objectApiName is empty');
-        }
-        if (!type) {
-            throw new commonExceptions.InvalidParamError('type is empty');
-        }
-        return new Page(apiName, objectApiName, type);
+        const appCtx = {
+            dataVersion: "v3",
+        };
+        return new KObject(objectApiName, appCtx);
     }
 }
 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/fields.util.d.ts

@@ -1,5 +1,6 @@
 import { CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
 import { I18ns } from '../types/common';
+import { FilterTypeV3, RegionFilterTypeV3, SubOptionTypeV3 } from '../types/objectsV3';
 declare function getUnique(field: FieldType): boolean;
 declare function getCaseSensitive(field: FieldType): boolean;
 declare function getMultiline(field: FieldType): boolean;
@@ -12,6 +13,7 @@ declare function getMultiple(field: FieldType): boolean;
 declare function getOptionSource(field: FieldType): ('custom' | 'global');
 declare function getGlobalOptionApiName(field: FieldType): string;
 declare function getOptionList(field: FieldType): SubOptionType[];
+declare function getOptionListV3(field: FieldType): SubOptionTypeV3[];
 declare function getDescriptionWhenTrue(field: FieldType): I18ns;
 declare function getDescriptionWhenFalse(field: FieldType): I18ns;
 declare function getDefaultValue(field: FieldType): boolean;
@@ -35,7 +37,9 @@ declare function getSettingsMultiple(field: FieldType): boolean;
 declare function getCompositeTypeApiName(field: FieldType): string;
 declare function getCompositeTypeSubFields(field: FieldType): object[];
 declare function getSettingsFilter(field: FieldType): FilterType[];
+declare function getSettingsFilterV3(field: FieldType): FilterTypeV3[];
 export declare function getRegionSettingsFilter(field: FieldType): RegionFilterType[];
+export declare function getRegionSettingsFilterV3(field: FieldType): RegionFilterTypeV3[];
 declare function getSettingsSort(field: FieldType): SortConditionType[];
 declare function getRecordPosition(field: FieldType): number;
 export declare function getRollupType(field: FieldType): string;
@@ -45,4 +49,4 @@ export declare function getRollupLookupFieldApiName(field: FieldType): string;
 export declare function getRegionOptionLevel(field: FieldType): boolean;
 export declare function getRegionStrictLeve(field: FieldType): number;
 export declare function getRollupFilter(field: FieldType): CriterionType;
-export { getUnique, getCaseSensitive, getMultiline, getMaxLength, getRegexpExpression, getRegexpErrMsg, getDisplayAsPercentage, getDecimalPlaces, getMultiple, getOptionSource, getGlobalOptionApiName, getOptionList, getDescriptionWhenTrue, getDescriptionWhenFalse, getDefaultValue, getDisplayStyle, getLookupRefObjectApiName, getLookupIsHierarchy, getLookupDisplayStyle, getReturnType, getFormula, getGenerateMethod, getDigitsNumber, getPrefix, getSuffix, getReferenceObjectApiName, getReferenceFieldApiName, getFileMultiple, getFileTypes, getBackLookupObjectApiName, getBackLookupFieldApiName, getSettingsMultiple, getCompositeTypeApiName, getCompositeTypeSubFields, getSettingsFilter, getSettingsSort, getRecordPosition, };
+export { getUnique, getCaseSensitive, getMultiline, getMaxLength, getRegexpExpression, getRegexpErrMsg, getDisplayAsPercentage, getDecimalPlaces, getMultiple, getOptionSource, getGlobalOptionApiName, getOptionList, getDescriptionWhenTrue, getDescriptionWhenFalse, getDefaultValue, getDisplayStyle, getLookupRefObjectApiName, getLookupIsHierarchy, getLookupDisplayStyle, getReturnType, getFormula, getGenerateMethod, getDigitsNumber, getPrefix, getSuffix, getReferenceObjectApiName, getReferenceFieldApiName, getFileMultiple, getFileTypes, getBackLookupObjectApiName, getBackLookupFieldApiName, getSettingsMultiple, getCompositeTypeApiName, getCompositeTypeSubFields, getSettingsFilter, getSettingsSort, getRecordPosition, getOptionListV3, getSettingsFilterV3 };

package/context/metadata/objects/fields.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = exports.getRollupFilter = exports.getRegionStrictLeve = exports.getRegionOptionLevel = exports.getRollupLookupFieldApiName = exports.getRollupFieldApiName = exports.getRollupObjectApiName = exports.getRollupType = exports.getRegionSettingsFilter = void 0;
+exports.getSettingsFilterV3 = exports.getOptionListV3 = exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = exports.getRollupFilter = exports.getRegionStrictLeve = exports.getRegionOptionLevel = exports.getRollupLookupFieldApiName = exports.getRollupFieldApiName = exports.getRollupObjectApiName = exports.getRollupType = exports.getRegionSettingsFilterV3 = exports.getRegionSettingsFilter = void 0;
 const common = require("@byted-apaas/server-common-node");
 const common_1 = require("../types/common");
 const commonConstants = common.constants;
@@ -118,6 +118,23 @@ function getOptionList(field) {
     return options;
 }
 exports.getOptionList = getOptionList;
+function getOptionListV3(field) {
+    if (!field || !field.type || !field.type.settings || !field.type.settings.options || !Array.isArray(field.type.settings.options)) {
+        return [];
+    }
+    let options = [];
+    for (let option of field.type.settings.options) {
+        options.push({
+            label: (0, common_1.transI18nsToMultilingualV3)(option.name),
+            apiName: option.api_name,
+            description: (0, common_1.transI18nsToMultilingualV3)(option.description),
+            color: commonUtils.getColorNameById(option.color_id),
+            active: Number(option.active) === 1,
+        });
+    }
+    return options;
+}
+exports.getOptionListV3 = getOptionListV3;
 function getDescriptionWhenTrue(field) {
     if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.description_if_true)) {
         return field.type.settings.description_if_true;
@@ -283,6 +300,22 @@ function getSettingsFilter(field) {
     return [];
 }
 exports.getSettingsFilter = getSettingsFilter;
+function getSettingsFilterV3(field) {
+    if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
+        const res = field.type.settings.filter.map(s => {
+            let tmp;
+            tmp.errorMsg = (0, common_1.transI18nsToMultilingualV3)(s.errorMsg);
+            tmp.criterion = s.criterion;
+            tmp.label = s.label;
+            tmp.needTriggerCriterion = s.needTriggerCriterion;
+            tmp.triggerCriterion = s.triggerCriterion;
+            return tmp;
+        });
+        return res;
+    }
+    return [];
+}
+exports.getSettingsFilterV3 = getSettingsFilterV3;
 function getRegionSettingsFilter(field) {
     if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
         return field.type.settings.filter;
@@ -290,6 +323,22 @@ function getRegionSettingsFilter(field) {
     return [];
 }
 exports.getRegionSettingsFilter = getRegionSettingsFilter;
+function getRegionSettingsFilterV3(field) {
+    if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
+        const res = field.type.settings.filter.map(s => {
+            let tmp;
+            tmp.errorMsg = (0, common_1.transI18nsToMultilingualV3)(s.errorMsg);
+            tmp.criterion = s.criterion;
+            tmp.label = s.label;
+            tmp.needTriggerCriterion = s.needTriggerCriterion;
+            tmp.triggerCriterion = s.triggerCriterion;
+            return s;
+        });
+        return res;
+    }
+    return [];
+}
+exports.getRegionSettingsFilterV3 = getRegionSettingsFilterV3;
 // TODO 结构转换
 function getSettingsSort(field) {
     let res = [];

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

@@ -0,0 +1,159 @@
+import { BaseFieldType, CriterionType, FieldType, FilterType, SortConditionType } from '../types/objects';
+import { MultilingualTypeV3 } from '../types/common';
+import { FilterTypeV3, RegionFilterTypeV3, SubOptionTypeV3 } from '../types/objectsV3';
+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: SubOptionTypeV3[];
+    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: MultilingualTypeV3;
+    descriptionWhenFalse: MultilingualTypeV3;
+    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: RegionFilterTypeV3[];
+    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: FilterTypeV3[];
+    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.getOptionListV3(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 = (0, common_1.transI18nsToMultilingualV3)(fieldsUtil.getDescriptionWhenTrue(field));
+        this.descriptionWhenFalse = (0, common_1.transI18nsToMultilingualV3)(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.getRegionSettingsFilterV3(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.getSettingsFilterV3(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/context/metadata/types/objectsV3.d.ts

@@ -0,0 +1,128 @@
+import { MultilingualTypeV3 } from './common';
+import { CriterionType, SortConditionType } from './objects';
+export interface BaseFieldTypeV3 {
+    type: string;
+    apiName: string;
+    label: MultilingualTypeV3;
+}
+export interface KTextFieldTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+    validationRegex: string;
+    errorMsg: MultilingualTypeV3;
+}
+export interface RichTextTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    maxLength: number;
+}
+export interface KMultilingualTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+}
+export interface NumberTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+}
+export interface KDateTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+}
+export interface DateTimeTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+}
+export type SubOptionTypeV3 = {
+    label: MultilingualTypeV3;
+    apiName: string;
+    description: MultilingualTypeV3;
+    color: ('grey' | 'blue' | 'cyan' | 'green' | 'yellow' | 'orange' | 'red' | 'magenta' | 'purple' | 'blueMagenta');
+    active: boolean;
+};
+export interface OptionTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    optionSource: ('custom' | 'global');
+    globalOptionApiName: string;
+    optionList: SubOptionTypeV3[];
+}
+export interface EmailV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+}
+export interface MobileNumberV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+}
+export interface BooleanV3 extends BaseFieldTypeV3 {
+    descriptionWhenTrue: MultilingualTypeV3;
+    descriptionWhenFalse: MultilingualTypeV3;
+    defaultValue: boolean;
+}
+export interface AvatarOrLogoV3 extends BaseFieldTypeV3 {
+    displayStyle: ('square' | 'round');
+}
+export type FilterTypeV3 = {
+    label: string;
+    needTriggerCriterion: boolean;
+    triggerCriterion: CriterionType;
+    criterion: CriterionType;
+    errorMsg: MultilingualTypeV3;
+};
+export type RegionFilterTypeV3 = {
+    id: string;
+    label: string;
+    errorMessage: MultilingualTypeV3;
+    recordFilter: CriterionType;
+    precondition: object;
+};
+export interface LookupV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    objectApiName: string;
+    hierarchy: boolean;
+    displayStyle: ('search' | 'dropDown' | 'tree');
+    sortConditions: SortConditionType[];
+    filter: FilterTypeV3[];
+}
+export interface FormulaTypeV3 extends BaseFieldTypeV3 {
+    returnType: string;
+    formula: MultilingualTypeV3;
+}
+export interface AutoIDTypeV3 extends BaseFieldTypeV3 {
+    generateMethod: ('random' | 'incremental');
+    digitsNumber: number;
+    prefix: string;
+    suffix: string;
+}
+export interface ReferenceFieldTypeV3 extends BaseFieldTypeV3 {
+    guideFieldApiName: string;
+    fieldApiName: string;
+}
+export interface FileTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    fileTypes: string[];
+}
+export interface BackLookuTypeV3 extends BaseFieldTypeV3 {
+    objectApiName: string;
+    fieldApiName: string;
+}
+export interface CompositeTypeV3 extends BaseFieldTypeV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldTypeV3[];
+    required: boolean;
+    multiple: boolean;
+}
+export interface ExtractSingleRecordTypeV3 extends BaseFieldTypeV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldTypeV3[];
+    filter: FilterTypeV3[];
+    sortConditions: SortConditionType[];
+    recordPosition: number;
+}

package/context/metadata/types/objectsV3.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.18-beta.6",
+  "version": "1.1.18-beta.8",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",