@byted-apaas/server-sdk-node 0.0.2-beta.1

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

@@ -0,0 +1,360 @@
+import * as common from '@byted-apaas/server-common-node'
+import {FieldType, FilterType, SortConditionType, SubOptionType} from "../types/objects";
+import {I18ns, isNullOrUndefined} from "../types/common";
+
+const commonConstants = common.constants;
+const commonUtils = common.utils;
+
+/*
+UniqueEnumNone                              = 1
+UniqueEnumMultilingualCaseSensitive         = 2
+UniqueEnumMultilingualCaseInsensitive       = 3
+UniqueEnumTextCaseSensitive                 = 4
+UniqueEnumTextCaseInsensitive               = 5
+UniqueEnumUniqueEmail                       = 6
+UniqueEnumUniquePhoneNumber                 = 7
+UniqueEnumUniqueNumber                      = 8
+UniqueEnumUniqueAutoNumberCaseSensitive     = 9
+UniqueEnumUniqueAutoNumberCaseInsensitive   = 10
+ */
+
+function getUnique(field: FieldType): boolean {
+    if (field && !isNullOrUndefined(field.unique_type)) {
+        return field.unique_type > 1;
+    }
+    return false;
+}
+
+function getCaseSensitive(field: FieldType): boolean {
+    if (field && !isNullOrUndefined(field.unique_type)) {
+        return [2, 4, 9].includes(field.unique_type);
+    }
+    return true;
+}
+
+function getMultiline(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.multiline)) {
+        return field.type.settings.multiline;
+    }
+    return false;
+}
+
+function getMaxLength(field: FieldType): number {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.max_length)) {
+        return field.type.settings.max_length;
+    }
+    return 255;
+}
+
+function getRegexpExpression(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.regexp_expression)) {
+        return field.type.settings.regexp_expression;
+    }
+    return null;
+}
+
+function getRegexpErrMsg(field: FieldType): I18ns {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.regexp_err_msg)) {
+        return field.type.settings.regexp_err_msg;
+    }
+    return null;
+}
+
+function getDisplayAsPercentage(field: FieldType) {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.display_as_percentage)) {
+        return field.type.settings.display_as_percentage;
+    }
+    return false;
+}
+
+function getDecimalPlaces(field: FieldType) {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.decimal_places)) {
+        return field.type.settings.decimal_places;
+    }
+    return 0;
+}
+
+function getMultiple(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.is_array)) {
+        return field.type.settings.is_array;
+    }
+    return false;
+}
+
+// 开发者感知 custom, global
+// 底层存储  local, global
+function getOptionSource(field: FieldType): ("custom" | "global") {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.option_type)) {
+        if (field.type.settings.option_type === 'local') {
+            return "custom";
+        } else if (field.type.settings.option_type === 'global') {
+            return "global";
+        }
+    }
+    return "custom";
+}
+
+function getGlobalOptionApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && field.type.settings.related_to_global_option && !isNullOrUndefined(field.type.settings.related_to_global_option.apiName)) {
+        return field.type.settings.related_to_global_option.apiName;
+    }
+    return "";
+}
+
+function getOptionList(field: FieldType): SubOptionType[] {
+    if (!field || !field.type || !field.type.settings || !field.type.settings.options || !Array.isArray(field.type.settings.options)) {
+        return [];
+    }
+
+    let options: SubOptionType[] = [];
+    for (let option of field.type.settings.options) {
+        options.push({
+            label: option.name,
+            apiName: option.api_name,
+            description: option.description,
+            color: commonUtils.getColorNameById(option.color_id) as any,
+            active: !!option.active,
+        });
+    }
+
+    return options;
+}
+
+function getDescriptionWhenTrue(field: FieldType): I18ns {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.description_if_true)) {
+        return field.type.settings.description_if_true;
+    }
+    return [];
+}
+
+function getDescriptionWhenFalse(field: FieldType): I18ns {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.description_if_false)) {
+        return field.type.settings.description_if_false;
+    }
+    return [];
+}
+
+function getDefaultValue(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.default_value)) {
+        return field.type.settings.default_value;
+    }
+    return false;
+}
+
+function getDisplayStyle(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.display_style)) {
+        return field.type.settings.display_style;
+    }
+    return "square";
+}
+
+function getLookupRefObjectApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.referenced_object_api_name)) {
+        return field.type.settings.referenced_object_api_name;
+    }
+    return "";
+}
+
+function getLookupIsHierarchy(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.is_hierarchy)) {
+        return field.type.settings.is_hierarchy;
+    }
+    return false;
+}
+
+// "search"|"dropDown"|"tree"
+function getLookupDisplayStyle(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.display_style)) {
+        return field.type.settings.display_style;
+    }
+    return "dropDown";
+}
+
+function getReturnType(field: FieldType): string {
+    // TODO: check returnType to return_type
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.return_type)) {
+        return field.type.settings.return_type;
+    }
+    return "";
+}
+
+function getFormula(field: FieldType): I18ns {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.formulas)) {
+        return field.type.settings.formulas;
+    }
+    return [];
+}
+
+// "random"|"incremental"
+function getGenerateMethod(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.generation_method)) {
+        return field.type.settings.generation_method;
+    }
+    return "random";
+}
+
+function getDigitsNumber(field: FieldType): number {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.digits)) {
+        return field.type.settings.digits;
+    }
+    return 6;
+}
+
+function getPrefix(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.prefix)) {
+        return field.type.settings.prefix;
+    }
+    return "";
+}
+
+function getSuffix(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.suffix)) {
+        return field.type.settings.suffix;
+    }
+    return "";
+}
+
+function getReferenceObjectApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.target_referenced_object_api_name)) {
+        return field.type.settings.target_referenced_object_api_name;
+    }
+    return "";
+}
+
+function getReferenceFieldApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.target_reference_field_api_name)) {
+        return field.type.settings.target_reference_field_api_name;
+    }
+    return "";
+}
+
+function getFileMultiple(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.multiple)) {
+        return field.type.settings.multiple;
+    }
+    return false;
+}
+
+function getFileTypes(field: FieldType): string[] {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.mime_types)) {
+        return field.type.settings.mime_types;
+    }
+    return [];
+}
+
+function getBackLookupObjectApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.related_to_object_api_name)) {
+        return field.type.settings.related_to_object_api_name;
+    }
+    return "";
+}
+
+function getBackLookupFieldApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.related_to_field_api_name)) {
+        return field.type.settings.related_to_field_api_name;
+    }
+    return "";
+}
+
+function getSettingsMultiple(field: FieldType): boolean {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.multiple)) {
+        return field.type.settings.multiple;
+    }
+    return false;
+}
+
+function getCompositeTypeApiName(field: FieldType): string {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.related_to_api_name)) {
+        return field.type.settings.related_to_api_name;
+    }
+    return "";
+}
+
+function getCompositeTypeSubFields(field: FieldType): object[] {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.related_to_fields)) {
+        return field.type.settings.related_to_fields;
+    }
+    return [];
+}
+
+// TODO 结构转换
+function getSettingsFilter(field: FieldType): FilterType[] {
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.filter)) {
+        return field.type.settings.filter;
+    }
+    return [];
+}
+
+// TODO 结构转换
+function getSettingsSort(field: FieldType): SortConditionType[] {
+    let res: SortConditionType[] = [];
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.sort)) {
+        for (const s of field.type.settings.sort) {
+            res.push(({
+                fieldApiName: s.field,
+                sort: s.direction,
+            }))
+        }
+        return res;
+    }
+    return [];
+}
+
+function getRecordPosition(field: FieldType): number {
+    let pos: number = 1;
+    if (field && field.type && field.type.settings && !isNullOrUndefined(field.type.settings.filter_record)) {
+        // first, last, specified
+        switch (field.type.settings.filter_record.type) {
+            case "first":
+                pos = 1;
+                break;
+            case "last":
+                pos = -1;
+                break;
+            case "specified":
+                pos = field.type.settings.filter_record.index;
+                break;
+        }
+    }
+    return pos;
+}
+
+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,
+}

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

@@ -0,0 +1,11 @@
+import { I18ns } from "../types/common";
+declare class Objects {
+    label: I18ns;
+    apiName: string;
+    displayName: string;
+    searchSupplementaryInfo: any[];
+    searchableFields: any[];
+    fields: any[];
+    constructor(obj: Record<string, any>);
+}
+export { Objects as Object, };

package/context/metadata/objects/objects.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Object = void 0;
+const fields = require("./fields");
+class Objects {
+    constructor(obj) {
+        if (!obj) {
+            return;
+        }
+        this.label = obj.label;
+        this.apiName = obj.api_name;
+        this.displayName = "";
+        this.searchSupplementaryInfo = [];
+        this.searchableFields = [];
+        this.fields = fields.parseFields(obj.fields);
+    }
+}
+exports.Object = Objects;
+//# sourceMappingURL=objects.js.map

package/context/metadata/objects/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["objects.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAGlC,MAAM,OAAO;IAQT,YAAY,GAAwB;QAChC,IAAI,CAAC,GAAG,EAAE;YACN,OAAO;SACV;QACD,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,uBAAuB,GAAG,EAAE,CAAC;QAClC,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;CACJ;AAGc,yBAAM"}

package/context/metadata/objects/objects.ts

@@ -0,0 +1,27 @@
+import * as fields from './fields'
+import {I18ns} from "../types/common";
+
+class Objects {
+    label: I18ns;
+    apiName: string;
+    displayName: string;
+    searchSupplementaryInfo: any[];
+    searchableFields: any[];
+    fields: any[];
+
+    constructor(obj: Record<string, any>) {
+        if (!obj) {
+            return;
+        }
+        this.label = obj.label;
+        this.apiName = obj.api_name;
+        this.displayName = "";
+        this.searchSupplementaryInfo = [];
+        this.searchableFields = [];
+        this.fields = fields.parseFields(obj.fields);
+    }
+}
+
+export {
+    Objects as Object,
+}

package/context/metadata/types/common.d.ts

@@ -0,0 +1,6 @@
+export declare type I18n = {
+    language_code: number;
+    text: string;
+};
+export declare type I18ns = I18n[];
+export declare function isNullOrUndefined(param: any): boolean;

package/context/metadata/types/common.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNullOrUndefined = void 0;
+function isNullOrUndefined(param) {
+    return param === null || param === undefined;
+}
+exports.isNullOrUndefined = isNullOrUndefined;
+//# sourceMappingURL=common.js.map

package/context/metadata/types/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":";;;AAOA,SAAgB,iBAAiB,CAAC,KAAU;IACxC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AACjD,CAAC;AAFD,8CAEC"}

package/context/metadata/types/common.ts

@@ -0,0 +1,10 @@
+export type I18n = {
+    language_code: number,
+    text: string,
+}
+
+export type I18ns = I18n[]
+
+export function isNullOrUndefined(param: any): boolean {
+    return param === null || param === undefined;
+}

package/context/metadata/types/components.d.ts

@@ -0,0 +1,90 @@
+import { I18ns } from "./common";
+export declare type SelectFieldType = {
+    fieldPath: {
+        objectApiName: string;
+        fieldApiName: string;
+    }[];
+};
+export declare type FieldApiType = {
+    type?: string;
+    fieldApiName: string;
+    alias?: I18ns;
+    concatText?: {
+        zh_CN?: Object[];
+        en_US?: Object[];
+    };
+    color?: string;
+};
+export declare type UIMetaFilterType = {
+    conditions: Object[];
+    logic: string;
+};
+export declare type UIMetaSortConditionsType = {
+    fieldApiName: string;
+    sort: string;
+};
+export declare type DeskListTitleField = {
+    fieldApiName: string;
+};
+export declare type DeskListSubtitleField = {
+    type?: ("field" | "concatText");
+    fieldApiName: string;
+    alias: I18ns;
+    concatText?: {
+        zh_CN: ConcatTextType[];
+        en_US: ConcatTextType[];
+    };
+};
+export declare type DeskListDetailField = {
+    fieldApiName: string;
+    alias: I18ns;
+};
+export declare type UIMetaDesktopType = {
+    isCompositeType: boolean;
+    titleAreaText: I18ns;
+    objectApiName: string;
+    titleFields: FieldApiType[];
+    subtitleFields: FieldApiType[];
+    detailFields: FieldApiType[];
+    filter: UIMetaFilterType;
+    sortConditions: UIMetaSortConditionsType[];
+};
+export declare type UIMetaLangType = {
+    dataType: string;
+    fieldApiName: string;
+    text: string;
+};
+export declare type ConcatTextType = {
+    dataType: "fieldApiName" | "text";
+    fieldApiName: string;
+    text: string;
+};
+export declare type UIMetaMobileType = {
+    pageType?: ("app" | "record_page");
+    pageApiName: string;
+    componentName: string;
+    titleAreaText: I18ns;
+    objectApiName: string;
+    listItems: MobileListItem;
+    filter: UIMetaFilterType;
+    sortConditions: UIMetaSortConditionsType[];
+};
+export declare type MobileListField = {
+    fieldApiName: string;
+    hiddenWhenEmpty?: boolean;
+};
+export declare type MobileListItem = {
+    avatar: {
+        active: boolean;
+        fieldApiName: string;
+    };
+    titleFields: {
+        fieldApiName: string;
+    }[];
+    tagFields: {
+        fieldApiName: string;
+        color: "grey" | "blue" | "cyan" | "green" | "yellow" | "orange" | "red" | "magenta" | "purple" | "blueMagenta";
+    }[];
+    subtitleFields: MobileListField[];
+    detailFields: MobileListField[];
+};

package/context/metadata/types/components.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=components.js.map

package/context/metadata/types/components.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.js","sourceRoot":"","sources":["components.ts"],"names":[],"mappings":""}

package/context/metadata/types/components.ts

@@ -0,0 +1,105 @@
+import {I18ns} from "./common";
+
+export type SelectFieldType = {
+    fieldPath: {
+        objectApiName: string,
+        fieldApiName: string,
+    }[]
+}
+
+export type FieldApiType = {
+    type?: string,
+    fieldApiName: string,
+    alias?: I18ns,
+    concatText?: {
+        zh_CN?: Object[],
+        en_US?: Object[],
+    },
+    color?: string,
+}
+
+export type UIMetaFilterType = {
+    conditions: Object[],
+    logic: string,
+}
+
+export type UIMetaSortConditionsType = {
+    fieldApiName: string,
+    sort: string
+}
+
+// desktop
+export type DeskListTitleField = {
+    fieldApiName: string;
+}
+
+export type DeskListSubtitleField = {
+    type?: ("field" | "concatText"),
+    fieldApiName: string;
+    alias: I18ns;
+    concatText?: {
+        zh_CN: ConcatTextType[],
+        en_US: ConcatTextType[]
+    }
+}
+
+export type DeskListDetailField = {
+    fieldApiName: string;
+    alias: I18ns;
+}
+
+export type UIMetaDesktopType = {
+    isCompositeType: boolean,
+    titleAreaText: I18ns,
+    objectApiName: string,
+    titleFields: FieldApiType[],
+    subtitleFields: FieldApiType[],
+    detailFields: FieldApiType[],
+    filter: UIMetaFilterType,
+    sortConditions: UIMetaSortConditionsType[],
+}
+
+export type UIMetaLangType = {
+    dataType: string,
+    fieldApiName: string,
+    text: string,
+}
+
+export type ConcatTextType = {
+    dataType: "fieldApiName" | "text"
+    fieldApiName: string;
+    text: string;
+}
+
+// mobile
+export type UIMetaMobileType = {
+    pageType?: ("app" | "record_page")
+    pageApiName: string,
+    componentName: string,
+    titleAreaText: I18ns,
+    objectApiName: string,
+    listItems: MobileListItem,
+    filter: UIMetaFilterType,
+    sortConditions: UIMetaSortConditionsType[],
+}
+
+export type MobileListField = {
+    fieldApiName: string;
+    hiddenWhenEmpty?: boolean;
+}
+
+export type MobileListItem = {
+    avatar: {
+        active: boolean;
+        fieldApiName: string;
+    },
+    titleFields: {
+        fieldApiName: string;
+    }[],
+    tagFields: {
+        fieldApiName: string;
+        color: "grey" | "blue" | "cyan" | "green" | "yellow" | "orange" | "red" | "magenta" | "purple" | "blueMagenta";
+    }[],
+    subtitleFields: MobileListField[],
+    detailFields: MobileListField[],
+}