@byted-apaas/server-sdk-node 0.0.1-beta.3

package/context/metadata/objects/fields.ts

@@ -0,0 +1,457 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+import {
+    BaseFieldType,
+    FieldType, FilterType,
+    SortConditionType,
+    SubOptionType
+} from "../types/objects";
+import * as fieldsUtil from './fields.util'
+import {I18ns} from "../types/common";
+import {getSettingsSort} from "./fields.util";
+
+class MetadataField {
+    type: string;
+    apiName: string;
+    label: I18ns;
+
+    constructor(type: string, field: FieldType) {
+        this.type = type;
+        this.apiName = field.api_name;
+        this.label = field.label;
+    }
+}
+
+class KText extends MetadataField {
+    required: boolean;      // 默认值：false
+    unique: boolean;        // 默认值：false
+    caseSensitive: boolean;      // unique 为 false 时生效，默认值：true
+    multiline: boolean;          // 默认值：false
+    maxLength: number;           // 默认值：1000
+    validationRegex: string;     // 正则校验的表达式
+    errorMsg: I18ns;
+
+    constructor(field: FieldType) {
+        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 = fieldsUtil.getRegexpErrMsg(field);
+    }
+}
+
+class RichText extends MetadataField {
+    maxLength: number;
+    required: boolean;
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("richText", field);
+
+        this.maxLength = fieldsUtil.getMaxLength(field);
+        this.required = field.required;
+    }
+}
+
+class Multilingual extends MetadataField {
+    required: boolean;         // 默认值：false
+    unique: boolean;           // 默认值：false
+    caseSensitive: boolean;    // unique 为 ture 时生效，默认值：true
+    multiline: boolean;        // 默认值：false
+    maxLength: number;         // 默认值：1000
+
+    constructor(field: FieldType) {
+        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);
+    }
+}
+
+class Number extends MetadataField {
+    required: boolean;        // 默认值：false
+    unique: boolean;          // 默认值：false
+    displayAsPercentage: boolean;  // 默认值：false
+    decimalPlacesNumber: number;
+
+    constructor(field: FieldType) {
+        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);
+    }
+}
+
+class KDate extends MetadataField {
+    required: boolean;        // 默认值：false
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("date", field);
+        this.required = field.required;
+    }
+}
+
+class DateTime extends MetadataField {
+    required: boolean;        // 默认值：false
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("dateTime", field);
+        this.required = field.required;
+    }
+}
+
+class Option extends MetadataField {
+    required: boolean;        // 默认值：false
+    multiple: boolean;        // 默认值：false
+    optionSource: ("custom" | "global");         // 对应选项字段的「选项来源」属性（分为「自定义选项」和「使用全局选项）, 默认值："custom"
+    globalOptionApiName: string;  // 关联全局选项的 apiName（创建字段时，设定 optionSource 为 "custom"，则无需传入，且生成的元数据中不包含该属性）
+    optionList: SubOptionType[];
+
+    constructor(field: FieldType) {
+        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);
+    }
+}
+
+class Email extends MetadataField {
+    required: boolean;        // 默认值：false
+    unique: boolean;        // 默认值：false
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("email", field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+
+class MobileNumber extends MetadataField {
+    required: boolean;        // 默认值：false
+    unique: boolean;        // 默认值：false
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("mobileNumber", field);
+        this.required = field.required;
+        this.unique = fieldsUtil.getUnique(field);
+    }
+}
+
+class Boolean extends MetadataField {
+    descriptionWhenTrue: I18ns;
+    descriptionWhenFalse: I18ns;
+    defaultValue: boolean;
+    unique: boolean; // 文档没有
+
+    constructor(field: FieldType) {
+        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);
+    }
+}
+
+class AvatarOrLogo extends MetadataField {
+    displayStyle: ("square" | "round");  // 默认值："square"
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("avatarOrLogo", field);
+        this.displayStyle = fieldsUtil.getDisplayStyle(field) as any;
+    }
+}
+
+class Lookup extends MetadataField {
+    required: boolean;                         // 默认值：false
+    multiple: boolean;                         // 默认值：false，对应查找字段的「关联记录数」属性（分为「单条」和「多条」）
+    objectApiName: string;                     // 字段 look up 的对象
+    hierarchy: boolean;                        // 默认值：false，multiple 为 false 时生效
+    displayStyle: ("search" | "dropDown" | "tree");   // 默认值："dropDown"，对应查找字段的「关联记录展示方式」属性，仅当 hierarchy 为 true 时才可设置为 "tree"
+    sortConditions: SortConditionType[];
+    filter: FilterType[];
+
+    constructor(field: FieldType) {
+        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) as any;
+        // TODO
+        this.sortConditions = fieldsUtil.getSettingsSort(field);
+        this.filter = [];
+    }
+}
+
+class Formula extends MetadataField {
+    returnType: string;            // 对应公式字段的「公式返回值类型」属性
+    formula: I18ns;
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("formula", field);
+        this.returnType = fieldsUtil.getReturnType(field);
+        // TODO 由于下游提供仍是 api ID 版本，因此禁用
+        this.formula = null; //fieldsUtil.getFormula(field);
+    }
+}
+
+class AutoID extends MetadataField {
+    generateMethod: ("random" | "incremental");  // 默认值: "random"
+    digitsNumber: number;
+    prefix: string;
+    suffix: string;
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("autoId", field);
+        this.generateMethod = fieldsUtil.getGenerateMethod(field) as any;
+        this.digitsNumber = fieldsUtil.getDigitsNumber(field);
+        this.prefix = fieldsUtil.getPrefix(field);
+        this.suffix = fieldsUtil.getSuffix(field);
+    }
+}
+
+class ReferenceField extends MetadataField {
+    guideFieldApiName: string;
+    fieldApiName: string;
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("referenceField", field);
+        // TODO: check objectApiName to guideFieldApiName
+        this.guideFieldApiName = fieldsUtil.getReferenceObjectApiName(field);
+        this.fieldApiName = fieldsUtil.getReferenceFieldApiName(field);
+    }
+}
+
+class File extends MetadataField {
+    required: boolean;     // 默认值: false
+    multiple: boolean;     // 默认值: false
+    fileTypes: string[];    // 支持 "jpeg"|"jpg"|"png"|"gif"|"pdf"|"docx"|"doc"|"xlsx"|"xls"|"pptx"|"ppt"|"csv"|"txt"|"json"|"mp4"|"zip"|"rar"，同时支持 "*.doc" 的描述方式，当为空数组，或 null、undefined 时，默认支持「全部类型」
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("file", field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getFileMultiple(field);
+        this.fileTypes = fieldsUtil.getFileTypes(field);
+    }
+}
+
+class BackLookup extends MetadataField {
+    // objectApiName: string; // TODO 由于下游提供仍是 api ID 版本，因此禁用
+    // fieldApiName: string; //  由于下游提供仍是 api ID 版本，因此禁用
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("backLookup", field);
+        // TODO 由于下游提供仍是 api ID 版本，因此禁用
+        // this.objectApiName = fieldsUtil.getBackLookupObjectApiName(field);
+        // this.fieldApiName = fieldsUtil.getBackLookupFieldApiName(field); // TODO metadata返回值为空
+    }
+}
+
+class CompositeType extends MetadataField {
+    compositeTypeApiName: string;    // 关联组合类型的 apiName，「主子对象」需求调整后，将不存在该 key
+    subFields: BaseFieldType[];    // 组合类型中的子字段的元数据
+    required: boolean;               // 默认值: false
+    multiple: boolean;               // 默认值: false
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("compositeType", field);
+        this.required = field.required;
+        this.multiple = fieldsUtil.getSettingsMultiple(field);
+        this.compositeTypeApiName = fieldsUtil.getCompositeTypeApiName(field);
+        // TODO 字段类型转换
+        this.subFields = parseFields(fieldsUtil.getCompositeTypeSubFields(field));
+    }
+}
+
+class ExtractSingleRecord extends MetadataField {
+    compositeTypeApiName: string;    // 关联组合类型的 apiName，「主子对象」需求调整后，将调整为「子表单」类型字段的 apiName
+    subFields: BaseFieldType[];    // 组合类型中的子字段的元数据
+    filter: FilterType[];
+    sortConditions: SortConditionType[];
+    recordPosition: number;          // 默认值: 1，对应多值取单值字段的「返回记录」（分为「第一条」、「最后一条」和「第 {{n}} 条」），取值为正整数时为相应位置的记录，取值为 -1 时为「最后一条」记录
+
+    constructor(field: FieldType) {
+        if (!field) {
+            return;
+        }
+        super("extractSingleRecord", field);
+        this.compositeTypeApiName = fieldsUtil.getCompositeTypeApiName(field);
+        // TODO 字段类型转换
+        this.subFields = parseFields(fieldsUtil.getCompositeTypeSubFields(field));
+        this.filter = fieldsUtil.getSettingsFilter(field);
+        this.sortConditions = fieldsUtil.getSettingsSort(field);
+        this.recordPosition = fieldsUtil.getRecordPosition(field);
+    }
+}
+
+function getCompositeTypeClass(field: FieldType): any {
+    if (field && field.type && field.type.settings && field.type.settings.is_extract) {
+        return ExtractSingleRecord;
+    }
+    return CompositeType;
+}
+
+function parseFields(inputFields: Record<string, any>): BaseFieldType[] {
+    if (!inputFields || !Array.isArray(inputFields)) {
+        return [];
+    }
+
+    let fields = [];
+    for (let field of inputFields) {
+        let FieldClass = getFieldClass(field);
+        if (!FieldClass) {
+            continue;
+        }
+
+        fields.push(new FieldClass(field));
+    }
+    return fields;
+}
+
+function parseField(field: FieldType): BaseFieldType {
+    let FieldClass = getFieldClass(field);
+    if (FieldClass) {
+        return new FieldClass(field);
+    }
+    return null;
+}
+
+function getFieldClass(field: FieldType): any {
+    if (field && field.type && field.type.name) {
+        if (field.type.name === "compositeType") {
+            return getCompositeTypeClass(field);
+        }
+        return type2fieldType[field.type.name];
+    }
+    return null;
+}
+
+const type2fieldType: Record<string, any> = {
+    "text": KText,
+    "multilingual": Multilingual,
+    "float": Number,
+    "date": KDate,
+    "datetime": DateTime,
+    "enum": Option,
+    "email": Email,
+    "phone": MobileNumber,
+    "boolean": Boolean,
+    "avatar": AvatarOrLogo,
+    "lookup": Lookup,
+    "formula": Formula,
+    "auto_number": AutoID,
+    "reference_field": ReferenceField,
+    "attachment": File,
+    "back_lookup": BackLookup,
+    "richText": RichText,
+}
+
+const fieldTypeMap: Record<string, string> = {
+    "text": "text",
+    "multilingual": "multilingual",
+    "number": "float",
+    "date": "date",
+    "dateTime": "datetime",
+    "option": "enum",
+    "email": "email",
+    "mobileNumber": "phone",
+    "boolean": "boolean",
+    "avatarOrLogo": "avatar",
+    "lookup": "lookup",
+    "formula": "formula",
+    "autoId": "auto_number",
+    "referenceField": "reference_field",
+    "file": "attachment",
+    "backLookup": "back_lookup",
+    "compositeType": "compositeType",
+    "extractSingleRecord": "compositeType",
+    "richText": "richText",
+}
+
+export {
+    KText as Text,
+    Multilingual,
+    Number,
+    KDate as Date,
+    DateTime,
+    Option,
+    Email,
+    MobileNumber,
+    Boolean,
+    AvatarOrLogo,
+    Lookup,
+    Formula,
+    AutoID,
+    ReferenceField,
+    File,
+    BackLookup,
+    CompositeType,
+    ExtractSingleRecord,
+    RichText,
+
+    parseFields,
+    parseField,
+    getFieldClass,
+}

package/context/metadata/objects/fields.util.d.ts

@@ -0,0 +1,40 @@
+import { FieldType, FilterType, SortConditionType, SubOptionType } from "../types/objects";
+import { I18ns } from "../types/common";
+declare function getUnique(field: FieldType): boolean;
+declare function getCaseSensitive(field: FieldType): boolean;
+declare function getMultiline(field: FieldType): boolean;
+declare function getMaxLength(field: FieldType): number;
+declare function getRegexpExpression(field: FieldType): string;
+declare function getRegexpErrMsg(field: FieldType): I18ns;
+declare function getDisplayAsPercentage(field: FieldType): boolean;
+declare function getDecimalPlaces(field: FieldType): number;
+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 getDescriptionWhenTrue(field: FieldType): I18ns;
+declare function getDescriptionWhenFalse(field: FieldType): I18ns;
+declare function getDefaultValue(field: FieldType): boolean;
+declare function getDisplayStyle(field: FieldType): string;
+declare function getLookupRefObjectApiName(field: FieldType): string;
+declare function getLookupIsHierarchy(field: FieldType): boolean;
+declare function getLookupDisplayStyle(field: FieldType): string;
+declare function getReturnType(field: FieldType): string;
+declare function getFormula(field: FieldType): I18ns;
+declare function getGenerateMethod(field: FieldType): string;
+declare function getDigitsNumber(field: FieldType): number;
+declare function getPrefix(field: FieldType): string;
+declare function getSuffix(field: FieldType): string;
+declare function getReferenceObjectApiName(field: FieldType): string;
+declare function getReferenceFieldApiName(field: FieldType): string;
+declare function getFileMultiple(field: FieldType): boolean;
+declare function getFileTypes(field: FieldType): string[];
+declare function getBackLookupObjectApiName(field: FieldType): string;
+declare function getBackLookupFieldApiName(field: FieldType): string;
+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 getSettingsSort(field: FieldType): SortConditionType[];
+declare function getRecordPosition(field: FieldType): number;
+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, };