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

package/context/metadata/components/desktop/recordDetail.d.ts

@@ -1,11 +0,0 @@
-import { Component } from '../common';
-import { SelectFieldType } from '../../types/components';
-import { I18ns } from '../../types/common';
-declare class RecordDetail extends Component {
-    titleAreaText: I18ns;
-    objectApiName: string;
-    selectedFields: SelectFieldType[];
-    constructor(params: Record<string, any>);
-    static parse(input: Record<string, any>): RecordDetail;
-}
-export { RecordDetail, };

package/context/metadata/components/desktop/recordDetail.js

@@ -1,53 +0,0 @@
-"use strict";
-// Copyright 2022 ByteDance Ltd. and/or its affiliates
-// SPDX-License-Identifier: MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecordDetail = void 0;
-const common_1 = require("../common");
-/*
-titleAreaText: i18n;
-objectApiName: string;
-selectedFields: [{
-    fieldPath: [{
-        objectApiName: string;
-        fieldApiName: string;
-    }, ...];
-},...]
- */
-class RecordDetail extends common_1.Component {
-    constructor(params) {
-        super(common_1.componentTypes.desktopRecordDetail);
-        // TODO check
-        this.titleAreaText = params.titleAreaText;
-        this.objectApiName = params.objectApiName;
-        this.selectedFields = params.selectedFields;
-    }
-    static parse(input) {
-        return new RecordDetail({
-            titleAreaText: input.titleLabel,
-            objectApiName: input.objectApiName,
-            selectedFields: getSelectedFields(input),
-        });
-    }
-}
-exports.RecordDetail = RecordDetail;
-function getSelectedFields(input) {
-    if (!input || !input.selectedFields || !Array.isArray(input.selectedFields)) {
-        return [];
-    }
-    let selectedFields = [];
-    for (let selectedField of input.selectedFields) {
-        if (!selectedField || !selectedField.picker || !selectedField.picker.fieldPath) {
-            continue;
-        }
-        let fieldPath = [];
-        for (let field of selectedField.picker.fieldPath) {
-            fieldPath.push({
-                objectApiName: field.objectApiName,
-                fieldApiName: field.fieldApiName,
-            });
-        }
-        selectedFields.push({ fieldPath: fieldPath });
-    }
-    return selectedFields;
-}

package/context/metadata/components/mobile/list.d.ts

@@ -1,24 +0,0 @@
-import { MobileListItem, UIMetaFilterType, UIMetaMobileType } from '../../types/components';
-import { I18ns } from '../../types/common';
-import { Component } from '../common';
-declare class List extends Component {
-    titleAreaText: I18ns;
-    objectApiName: string;
-    listItems: MobileListItem;
-    filter: UIMetaFilterType;
-    sortConditions: object[];
-    pageApiName: string;
-    componentName: string;
-    pageType: ('app' | 'record_page');
-    needPublish: boolean;
-    constructor(params: UIMetaMobileType);
-    static parse(input: Record<string, any>): List;
-    getReqParam(): Record<string, any>;
-    getTableColumn(): {
-        apiName: string;
-    }[];
-    getDescribeFilter(): {
-        filter: string;
-    };
-}
-export { List, };

package/context/metadata/components/mobile/list.js

@@ -1,145 +0,0 @@
-"use strict";
-// Copyright 2022 ByteDance Ltd. and/or its affiliates
-// SPDX-License-Identifier: MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.List = void 0;
-const common_1 = require("../../types/common");
-const common_2 = require("../common");
-/*
-titleAreaText: i18n;
-objectApiName: string;
-listItems: {
-    avatar: {
-        active: boolean;
-        fieldApiName: string;
-    },
-    titleFields: [{
-        fieldApiName: string;
-    },...]
-    tagFields: [{
-        fieldApiName: string;
-        color: 'grey'|'blue'|'cyan'|'green'|'yellow'|'orange'|'red'|'magenta'|'purple'|'blueMagenta';
-    },...]
-    subtitleFields: [{
-        fieldApiName: string;
-        hiddenWhenEmpty: boolean;
-    },...],
-    detailFields: [{
-        fieldApiName: string;
-        hiddenWhenEmpty: boolean;
-    },...]
-};
-filter: {
-    conditions: object[];
-    logic: string;
-};
-sortConditions: object[];
- */
-class List extends common_2.Component {
-    constructor(params) {
-        super(common_2.componentTypes.mobileList);
-        // TODO prd缺少
-        this.pageApiName = params.pageApiName;
-        this.componentName = params.componentName;
-        this.pageType = params.pageType; // app | record_page
-        this.needPublish = true;
-        // TODO check params
-        this.titleAreaText = params.titleAreaText;
-        this.objectApiName = params.objectApiName;
-        this.listItems = params.listItems;
-        this.filter = params.filter;
-        this.sortConditions = params.sortConditions;
-    }
-    static parse(input) {
-        return {
-            pageApiName: input.appApiName,
-            componentName: input.componentName,
-            titleAreaText: [],
-            objectApiName: input.objectApiName,
-            listItems: {
-                avatar: {},
-                titleFields: [],
-                tagFields: [],
-                subtitleFields: [],
-                detailFields: getDetailFields(input),
-            },
-            filter: getFilter(input),
-            sortConditions: [], // TODO 下游缺少
-        };
-    }
-    getReqParam() {
-        let reqParam = {
-            appApiName: this.pageApiName,
-            componentName: this.componentName,
-            objectApiName: this.objectApiName,
-            tableColumn: this.getTableColumn(),
-            describeFilter: this.getDescribeFilter(),
-            pageType: this.pageType,
-            needPublish: this.needPublish,
-        };
-        if (this.getDescribeFilter()) {
-            reqParam.describeFilter = this.getDescribeFilter();
-        }
-        if (this.pageType) {
-            reqParam.pageType = this.pageType;
-        }
-        if (this.needPublish) {
-            reqParam.needPublish = this.needPublish;
-        }
-        return reqParam;
-    }
-    getTableColumn() {
-        if (!this.listItems || !this.listItems.detailFields || !Array.isArray(this.listItems.detailFields)) {
-            return [];
-        }
-        let values = [];
-        for (let detailField of this.listItems.detailFields) {
-            if (!detailField || !detailField.fieldApiName) {
-                continue;
-            }
-            values.push({ apiName: detailField.fieldApiName });
-        }
-        return values;
-    }
-    getDescribeFilter() {
-        if ((0, common_1.isNullOrUndefined)(this.filter)) {
-            return null;
-        }
-        try {
-            return { filter: JSON.stringify(this.filter) };
-        }
-        catch (e) {
-            // TODO 抛出业务错误
-            return null;
-        }
-    }
-}
-exports.List = List;
-function getDetailFields(input) {
-    if (!input || !input.tableColumn || !Array.isArray(input.tableColumn)) {
-        return [];
-    }
-    let values = [];
-    for (let col of input.tableColumn) {
-        if (!col || !col.apiName) {
-            continue;
-        }
-        values.push({ fieldApiName: col.apiName });
-    }
-    return values;
-}
-function getFilter(input) {
-    if (!input || !input.describeFilter || (0, common_1.isNullOrUndefined)(input.describeFilter.filter)) {
-        return {};
-    }
-    try {
-        let inputFilter = JSON.parse(input.describeFilter.filter);
-        return {
-            conditions: inputFilter.conditions,
-            logic: inputFilter.logic,
-        };
-    }
-    catch (err) {
-        return {};
-    }
-}

package/context/metadata/metadata.d.ts

@@ -1,63 +0,0 @@
-import { BaseFieldType } from './types/objects';
-import { RecordDetail } from './components/desktop/recordDetail';
-import { List as DesktopList } from './components/desktop/list';
-import { List as MobileList } from './components/mobile/list';
-interface IMetaData<mt> {
-    /**
-     * 操作指定对象的元数据信息
-     * @param objectApiName 指定对象的 ApiName
-     * @example
-     * ```
-     * application.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>;
-}
-declare class MetaData<mt> implements IMetaData<mt> {
-    constructor(ctx: any);
-    object<T>(objectApiName: keyof mt): IKObject<T>;
-    page(apiName: string, objectApiName: string, type: string): Page;
-}
-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>;
-}
-declare function metadataV3<mt>(ctx: any): IMetaData<mt>;
-declare class Page implements IPage {
-    pageApiName: string;
-    objectApiName: string;
-    type: 'app' | 'record_page';
-    /**
-     *
-     * @param pageApiName: 页面apiName
-     * @param objectApiName：对象apiName
-     * @param type：app 或 record_page
-     */
-    constructor(pageApiName: string, objectApiName: string, type: string);
-    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>;
-}
-declare function metaType(): any;
-export { IMetaData, IKObject, IPage, MetaData, metadata, metaType, MetaDataV3, metadataV3, };

package/context/metadata/metadata.js

@@ -1,125 +0,0 @@
-"use strict";
-// Copyright 2022 ByteDance Ltd. and/or its affiliates
-// SPDX-License-Identifier: MIT
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.metadataV3 = exports.MetaDataV3 = exports.metaType = exports.metadata = exports.MetaData = void 0;
-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 ---------------------------------------------------------------------------------------
-class MetaData {
-    constructor(ctx) {
-    }
-    object(objectApiName) {
-        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);
-    }
-}
-exports.MetaData = MetaData;
-function metadata(ctx) {
-    return new MetaData(ctx);
-}
-exports.metadata = metadata;
-class MetaDataV3 {
-    constructor(ctx) {
-    }
-    object(objectApiName) {
-        if (!objectApiName) {
-            throw new commonExceptions.InvalidParamError('objectApiName is empty');
-        }
-        const appCtx = {
-            dataVersion: 'v3',
-        };
-        return new KObject(objectApiName, appCtx);
-    }
-}
-exports.MetaDataV3 = MetaDataV3;
-function metadataV3(ctx) {
-    return new MetaDataV3(ctx);
-}
-exports.metadataV3 = metadataV3;
-class KObject {
-    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);
-    }
-}
-class Page {
-    /**
-     *
-     * @param pageApiName: 页面apiName
-     * @param objectApiName：对象apiName
-     * @param type：app 或 record_page
-     */
-    constructor(pageApiName, objectApiName, type) {
-        this.pageApiName = pageApiName;
-        this.objectApiName = objectApiName;
-        this.type = type;
-    }
-    async getRecordDetail(componentName) {
-        // return await openapi.getDesktopRecordDetail(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type);
-        return null;
-    }
-    async getList(componentName) {
-        // return await openapi.getDesktopList(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type);
-        return null;
-    }
-    async getId() {
-        // return await openapi.getIdByApiName(this.ctx, this.objectApiName, this.pageApiName, 'RecordPage');
-        return null;
-    }
-    async getMobileList(componentName) {
-        // return await openapi.getMobileList(this.ctx, this.pageApiName, componentName, this.objectApiName, this.type) as any;
-        return null;
-    }
-    async updateMobileList(componentName, params) {
-        // 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() {
-    return {
-        pageComponent: {
-            desktop: {},
-            mobile: {
-                List: components.mobile.List,
-            },
-        }
-    };
-}
-exports.metaType = metaType;

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

@@ -1,158 +0,0 @@
-import { BaseFieldType, CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
-import { I18ns } from '../types/common';
-declare class MetadataField {
-    type: string;
-    apiName: string;
-    label: I18ns;
-    constructor(type: string, field: FieldType);
-}
-declare class KText extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    caseSensitive: boolean;
-    multiline: boolean;
-    maxLength: number;
-    validationRegex: string;
-    errorMsg: I18ns;
-    constructor(field: FieldType);
-}
-declare class RichText extends MetadataField {
-    maxLength: number;
-    required: boolean;
-    constructor(field: FieldType);
-}
-declare class Multilingual extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    caseSensitive: boolean;
-    multiline: boolean;
-    maxLength: number;
-    constructor(field: FieldType);
-}
-declare class Number extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    displayAsPercentage: boolean;
-    decimalPlacesNumber: number;
-    constructor(field: FieldType);
-}
-declare class Bigint extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    constructor(field: FieldType);
-}
-declare class Decimal extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    displayAsPercentage: boolean;
-    decimalPlacesNumber: number;
-    constructor(field: FieldType);
-}
-declare class KDate extends MetadataField {
-    required: boolean;
-    constructor(field: FieldType);
-}
-declare class DateTime extends MetadataField {
-    required: boolean;
-    constructor(field: FieldType);
-}
-declare class Option extends MetadataField {
-    required: boolean;
-    multiple: boolean;
-    optionSource: ('custom' | 'global');
-    globalOptionApiName: string;
-    optionList: SubOptionType[];
-    constructor(field: FieldType);
-}
-declare class Email extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    constructor(field: FieldType);
-}
-declare class MobileNumber extends MetadataField {
-    required: boolean;
-    unique: boolean;
-    constructor(field: FieldType);
-}
-declare class Boolean extends MetadataField {
-    descriptionWhenTrue: I18ns;
-    descriptionWhenFalse: I18ns;
-    defaultValue: boolean;
-    unique: boolean;
-    constructor(field: FieldType);
-}
-declare class AvatarOrLogo extends MetadataField {
-    displayStyle: ('square' | 'round');
-    constructor(field: FieldType);
-}
-declare class Lookup extends MetadataField {
-    required: boolean;
-    multiple: boolean;
-    objectApiName: string;
-    hierarchy: boolean;
-    displayStyle: ('search' | 'dropDown' | 'tree');
-    sortConditions: SortConditionType[];
-    filter: FilterType[];
-    constructor(field: FieldType);
-}
-declare class Formula extends MetadataField {
-    returnType: string;
-    formula: I18ns;
-    constructor(field: FieldType);
-}
-declare class AutoID extends MetadataField {
-    generateMethod: ('random' | 'incremental');
-    digitsNumber: number;
-    prefix: string;
-    suffix: string;
-    constructor(field: FieldType);
-}
-declare class ReferenceField extends MetadataField {
-    guideFieldApiName: string;
-    fieldApiName: string;
-    constructor(field: FieldType);
-}
-declare class Rollup extends MetadataField {
-    rollupType: string;
-    rollupObjectApiName: string;
-    rollupFieldApiName: string;
-    rollupLookupFieldApiName: string;
-    filter: CriterionType;
-    constructor(field: FieldType);
-}
-declare class Region extends MetadataField {
-    required: boolean;
-    multiple: boolean;
-    optionLevel: boolean;
-    strictLevel: number;
-    filter: RegionFilterType[];
-    constructor(field: FieldType);
-}
-declare class File extends MetadataField {
-    required: boolean;
-    multiple: boolean;
-    fileTypes: string[];
-    constructor(field: FieldType);
-}
-declare class BackLookup extends MetadataField {
-    constructor(field: FieldType);
-}
-declare class CompositeType extends MetadataField {
-    compositeTypeApiName: string;
-    subFields: BaseFieldType[];
-    required: boolean;
-    multiple: boolean;
-    constructor(field: FieldType);
-}
-declare class ExtractSingleRecord extends MetadataField {
-    compositeTypeApiName: string;
-    subFields: BaseFieldType[];
-    filter: FilterType[];
-    sortConditions: SortConditionType[];
-    recordPosition: number;
-    constructor(field: FieldType);
-}
-declare function parseFields(inputFields: Record<string, any>): BaseFieldType[];
-declare function parseField(field: FieldType): BaseFieldType;
-declare function getFieldClass(field: FieldType): any;
-export { KText as Text, Multilingual, Number, KDate as Date, DateTime, Option, Email, MobileNumber, Boolean, AvatarOrLogo, Lookup, Formula, AutoID, ReferenceField, File, BackLookup, CompositeType, ExtractSingleRecord, RichText, Bigint, Decimal, Region, Rollup, parseFields, parseField, getFieldClass, };