@byted-apaas/server-sdk-node 0.0.2-beta.2 → 0.0.2-beta.5

package/context/metadata/metadata.ts

@@ -1,175 +0,0 @@
-import * as components from './components/components'
-import {BaseFieldType} from "./types/objects";
-import * as common from '@byted-apaas/server-common-node'
-import {RecordDetail} from "./components/desktop/recordDetail";
-import {List as DesktopList} from "./components/desktop/list";
-import {List as MobileList} from "./components/mobile/list";
-import {metadataMap} from "../../data";
-import * as fields from './objects/fields'
-import * as Request from '../../request/interface'
-
-const commonExceptions = common.exceptions;
-
-// interface ---------------------------------------------------------------------------------------
-
-interface IMetaData<mt> {
-    /**
-     * 操作指定对象的元数据信息
-     * @param objectApiName 指定对象的 ApiName
-     * @example
-     * ```
-     * context.metadata.object("test").getFields()
-     * ```
-     */
-    object<T extends keyof mt>(objectApiName: T): IKObject<mt[T]>;
-}
-
-interface IKObject<T> {
-    /**
-     * 读取对象的字段列表
-     */
-    getFields(): Promise<BaseFieldType[]>;
-
-    /**
-     * 读取某字段的元数据信息
-     * @param fieldApiName 字段的 ApiName
-     */
-    getField<K extends keyof T>(fieldApiName: K): Promise<BaseFieldType>;
-}
-
-interface IPage {
-    getRecordDetail(componentName: string): Promise<RecordDetail>
-
-    getList(componentName: string): Promise<DesktopList>
-
-    getId(): Promise<number>
-
-    getMobileList(componentName: string): Promise<MobileList>
-
-    updateMobileList(componentName: string, params: any): Promise<void>
-}
-
-// interface ---------------------------------------------------------------------------------------
-
-class MetaData<mt> implements IMetaData<mt> {
-    ctx: any;
-
-    constructor(ctx: any) {
-        this.ctx = ctx;
-    }
-
-    object<T>(objectApiName: keyof mt): IKObject<T> {
-        if (!objectApiName) {
-            throw new commonExceptions.InvalidParamError("objectApiName is empty");
-        }
-        return new KObject<T>(this.ctx, objectApiName as string);
-    }
-
-    page(apiName: string, objectApiName: string, type: string): Page {
-        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(this.ctx, apiName, objectApiName, type);
-    }
-}
-
-function metadata<mt>(ctx: any): IMetaData<mt> {
-    return new MetaData<mt>(ctx);
-}
-
-class KObject<T> implements IKObject<T> {
-    private ctx: any;
-    private objectApiName: string;
-
-    constructor(ctx: any, objectApiName: string) {
-        this.ctx = ctx;
-        this.objectApiName = objectApiName;
-    }
-
-    async getFields(): Promise<BaseFieldType[]> {
-        let res = await Request.GetInstance().getFields(this.objectApiName);
-        return fields.parseFields(res.fields);
-    }
-
-    async getField<K extends keyof T>(fieldApiName: K): Promise<BaseFieldType> {
-        let res = await Request.GetInstance().getField(this.objectApiName, fieldApiName as string);
-        return fields.parseField(res);
-    }
-}
-
-class Page implements IPage {
-    ctx: any;
-    pageApiName: string;
-    objectApiName: string;
-    type: 'app' | 'record_page';
-
-    /**
-     *
-     * @param ctx
-     * @param pageApiName: 页面apiName
-     * @param objectApiName：对象apiName
-     * @param type：app 或 record_page
-     */
-    constructor(ctx: any, pageApiName: string, objectApiName: string, type: string) {
-        this.ctx = ctx;
-        this.pageApiName = pageApiName;
-        this.objectApiName = objectApiName;
-        this.type = type as any;
-    }
-
-    async getRecordDetail(componentName: string): Promise<RecordDetail> {
-        // return await openapi.getDesktopRecordDetail(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type);
-        return null;
-    }
-
-    async getList(componentName: string): Promise<DesktopList> {
-        // return await openapi.getDesktopList(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type);
-        return null;
-    }
-
-    async getId(): Promise<number> {
-        // return await openapi.getIdByApiName(this.ctx, this.objectApiName, this.pageApiName, "RecordPage");
-        return null;
-    }
-
-    async getMobileList(componentName: string): Promise<MobileList> {
-        // return await openapi.getMobileList(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type) as any;
-        return null;
-
-    }
-
-    async updateMobileList(componentName: string, params: any): Promise<void> {
-        // params.pageApiName = this.pageApiName;
-        // params.objectApiName = this.objectApiName;
-        // params.componentName = componentName;
-        // params.pageType = this.type;
-        // return await openapi.updateMobileList(this.ctx, params);
-        return null;
-    }
-}
-
-function metaType(): any {
-    return {
-        pageComponent: {
-            desktop: {},
-            mobile: {
-                List: components.mobile.List,
-            },
-        }
-    }
-}
-
-export {
-    IMetaData,
-    IKObject,
-    IPage,
-    MetaData,
-    metadata,
-    metaType,
-}

package/context/metadata/objects/fields.ts

@@ -1,454 +0,0 @@
-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,
-}