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

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

@@ -0,0 +1,145 @@
+"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/components/mobile/list.ts

@@ -0,0 +1,179 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+import {
+    DeskListDetailField,
+    MobileListField,
+    MobileListItem,
+    UIMetaFilterType,
+    UIMetaMobileType
+} from "../../types/components";
+import {I18ns, isNullOrUndefined} from "../../types/common";
+import {Component, componentTypes} from "../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 Component {
+    titleAreaText: I18ns;
+    objectApiName: string;
+    listItems: MobileListItem;
+    filter: UIMetaFilterType;
+    sortConditions: object[];
+
+    pageApiName: string;
+    componentName: string;
+    pageType: ("app" | "record_page");
+    needPublish: boolean;
+
+    constructor(params: UIMetaMobileType) {
+        super(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 as MobileListItem;
+        this.filter = params.filter;
+        this.sortConditions = params.sortConditions;
+    }
+
+    static parse(input: Record<string, any>): List {
+        return {
+            pageApiName: input.appApiName,
+            componentName: input.componentName,
+
+            titleAreaText: [], // TODO 下游缺少
+            objectApiName: input.objectApiName,
+            listItems: {
+                avatar: {} as any, // TODO 下游缺少
+                titleFields: [], // TODO 下游缺少
+                tagFields: [], // TODO 下游缺少
+                subtitleFields: [], // TODO 下游缺少
+                detailFields: getDetailFields(input),
+            },
+            filter: getFilter(input),
+            sortConditions: [], // TODO 下游缺少
+        } as List;
+    }
+
+    getReqParam(): Record<string, any> {
+        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(): { apiName: string }[] {
+        if (!this.listItems || !this.listItems.detailFields || !Array.isArray(this.listItems.detailFields)) {
+            return [];
+        }
+
+        let values: { apiName: string }[] = [];
+        for (let detailField of this.listItems.detailFields) {
+            if (!detailField || !detailField.fieldApiName) {
+                continue;
+            }
+            values.push({apiName: detailField.fieldApiName});
+        }
+        return values;
+    }
+
+    getDescribeFilter(): { filter: string } {
+        if (isNullOrUndefined(this.filter)) {
+            return null;
+        }
+
+        try {
+            return {filter: JSON.stringify(this.filter)};
+        } catch (e) {
+            // TODO 抛出业务错误
+            return null;
+        }
+    }
+}
+
+function getDetailFields(input: Record<string, any>): MobileListField[] {
+    if (!input || !input.tableColumn || !Array.isArray(input.tableColumn)) {
+        return [];
+    }
+
+    let values: MobileListField[] = [];
+    for (let col of input.tableColumn) {
+        if (!col || !col.apiName) {
+            continue;
+        }
+        values.push({fieldApiName: col.apiName});
+    }
+    return values;
+}
+
+function getFilter(input: Record<string, any>): UIMetaFilterType {
+    if (!input || !input.describeFilter || isNullOrUndefined(input.describeFilter.filter)) {
+        return {} as UIMetaFilterType;
+    }
+
+    try {
+        let inputFilter = JSON.parse(input.describeFilter.filter);
+        return {
+            conditions: inputFilter.conditions,
+            logic: inputFilter.logic,
+        }
+    } catch (err) {
+        return {} as UIMetaFilterType;
+    }
+}
+
+export {
+    List,
+}

package/context/metadata/metadata.d.ts

@@ -0,0 +1,61 @@
+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
+     * ```
+     * 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>;
+}
+declare class MetaData<mt> implements IMetaData<mt> {
+    ctx: any;
+    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 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);
+    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, };

package/context/metadata/metadata.js

@@ -0,0 +1,103 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+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 Request = require("../../request/interface");
+const commonExceptions = common.exceptions;
+// interface ---------------------------------------------------------------------------------------
+class MetaData {
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    object(objectApiName) {
+        if (!objectApiName) {
+            throw new commonExceptions.InvalidParamError("objectApiName is empty");
+        }
+        return new KObject(this.ctx, 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(this.ctx, apiName, objectApiName, type);
+    }
+}
+exports.MetaData = MetaData;
+function metadata(ctx) {
+    return new MetaData(ctx);
+}
+exports.metadata = metadata;
+class KObject {
+    constructor(ctx, objectApiName) {
+        this.ctx = ctx;
+        this.objectApiName = objectApiName;
+    }
+    async getFields() {
+        let res = await Request.GetInstance().getFields(this.objectApiName);
+        return fields.parseFields(res.fields);
+    }
+    async getField(fieldApiName) {
+        let res = await Request.GetInstance().getField(this.objectApiName, fieldApiName);
+        return fields.parseField(res);
+    }
+}
+class Page {
+    /**
+     *
+     * @param ctx
+     * @param pageApiName: 页面apiName
+     * @param objectApiName：对象apiName
+     * @param type：app 或 record_page
+     */
+    constructor(ctx, pageApiName, objectApiName, type) {
+        this.ctx = ctx;
+        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/metadata.ts

@@ -0,0 +1,178 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+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,
+}