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

package/context/metadata/objects/objects.js

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

package/context/metadata/objects/objects.ts

@@ -0,0 +1,30 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+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,9 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNullOrUndefined = void 0;
+function isNullOrUndefined(param) {
+    return param === null || param === undefined;
+}
+exports.isNullOrUndefined = isNullOrUndefined;

package/context/metadata/types/common.ts

@@ -0,0 +1,13 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+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,4 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });

package/context/metadata/types/components.ts

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

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

@@ -0,0 +1,226 @@
+import { I18ns } from "./common";
+export interface BaseFieldType {
+    type: string;
+    apiName: string;
+    label: I18ns;
+}
+export interface KTextFieldType extends BaseFieldType {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+    validationRegex: string;
+    errorMsg: I18ns;
+}
+export interface RichTextType extends BaseFieldType {
+    required: boolean;
+    maxLength: number;
+}
+export interface MultilingualType extends BaseFieldType {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+}
+export interface NumberType extends BaseFieldType {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+}
+export interface KDateType extends BaseFieldType {
+    required: boolean;
+}
+export interface DateTimeType extends BaseFieldType {
+    required: boolean;
+}
+export declare type SubOptionType = {
+    label: I18ns;
+    apiName: string;
+    description: I18ns;
+    color: ("grey" | "blue" | "cyan" | "green" | "yellow" | "orange" | "red" | "magenta" | "purple" | "blueMagenta");
+    active: boolean;
+};
+export interface OptionType extends BaseFieldType {
+    required: boolean;
+    multiple: boolean;
+    optionSource: ("custom" | "global");
+    globalOptionApiName: string;
+    optionList: SubOptionType[];
+}
+export interface Email extends BaseFieldType {
+    required: boolean;
+    unique: boolean;
+}
+export interface MobileNumber extends BaseFieldType {
+    required: boolean;
+    unique: boolean;
+}
+export interface Boolean extends BaseFieldType {
+    descriptionWhenTrue: I18ns;
+    descriptionWhenFalse: I18ns;
+    defaultValue: boolean;
+}
+export interface AvatarOrLogo extends BaseFieldType {
+    displayStyle: ("square" | "round");
+}
+export interface SortConditionType {
+    fieldApiName: string;
+    sort: ("asc" | "desc");
+}
+declare type ConditionType = {
+    left: {
+        objectApiName: string;
+        fieldApiName: string;
+    };
+    operator: ("eq" | "neq" | "in" | "notIn" | "empty" | "notEmpty" | "lte" | "gte" | "hasAllOf" | "hasNoneOf" | "hasAnyOf");
+    valueType: ("reference" | "specified");
+    right: (object | string);
+};
+declare type CriterionType = {
+    conditions: ConditionType[];
+    logic: string;
+};
+export declare type FilterType = {
+    label: string;
+    needTriggerCriterion: boolean;
+    triggerCriterion: CriterionType;
+    criterion: CriterionType;
+    errorMsg: I18ns;
+};
+export interface Lookup extends BaseFieldType {
+    required: boolean;
+    multiple: boolean;
+    objectApiName: string;
+    hierarchy: boolean;
+    displayStyle: ("search" | "dropDown" | "tree");
+    sortConditions: SortConditionType[];
+    filter: FilterType[];
+}
+export interface FormulaType extends BaseFieldType {
+    returnType: string;
+    formula: I18ns;
+}
+export interface AutoIDType extends BaseFieldType {
+    generateMethod: ("random" | "incremental");
+    digitsNumber: number;
+    prefix: string;
+    suffix: string;
+}
+export interface ReferenceFieldType extends BaseFieldType {
+    guideFieldApiName: string;
+    fieldApiName: string;
+}
+export interface FileType extends BaseFieldType {
+    required: boolean;
+    multiple: boolean;
+    fileTypes: string[];
+}
+export interface BackLookuType extends BaseFieldType {
+    objectApiName: string;
+    fieldApiName: string;
+}
+export interface CompositeType extends BaseFieldType {
+    compositeTypeApiName: string;
+    subFields: BaseFieldType[];
+    required: boolean;
+    multiple: boolean;
+}
+export interface ExtractSingleRecordType extends BaseFieldType {
+    compositeTypeApiName: string;
+    subFields: BaseFieldType[];
+    filter: FilterType[];
+    sortConditions: SortConditionType[];
+    recordPosition: number;
+}
+export declare type FieldType = {
+    "allow_search": boolean;
+    "api_name": string;
+    "calculated": boolean;
+    "description": I18ns;
+    "domain": number;
+    "encryption_mode": string;
+    "field_permission": number;
+    "formula_id": number;
+    "id": number;
+    "indexed": number;
+    "inherit_settings": object;
+    "is_encrypted": boolean;
+    "is_inherit": boolean;
+    "is_progress_field": boolean;
+    "label": I18ns;
+    "namespace": string;
+    "object_api_name": string;
+    "object_id": number;
+    "order": number;
+    "required": boolean;
+    "tenant_id": number;
+    "type": {
+        "name": string;
+        "settings": {
+            "multiline": boolean;
+            "text_version": number;
+            "decimal_places": number;
+            "display_as_percentage": boolean;
+            "placeholder": object;
+            "max_length": number;
+            "regexp_expression": string;
+            "regexp_err_msg": I18ns;
+            "is_array": boolean;
+            "option_type": string;
+            "related_to_global_option": {
+                "apiName": string;
+                "id": number;
+                "name": string;
+            };
+            "options": {
+                "name": I18ns;
+                "api_name": string;
+                "description": I18ns;
+                "color_id": string;
+                "active": boolean;
+            }[];
+            "description_if_true": I18ns;
+            "description_if_false": I18ns;
+            "display_style": string;
+            "default_value": boolean;
+            "referenced_object_api_name": string;
+            "is_hierarchy": boolean;
+            "return_type": string;
+            "formulas": I18ns;
+            "generation_method": string;
+            "digits": number;
+            "prefix": string;
+            "suffix": string;
+            "target_referenced_object_api_name": string;
+            "target_reference_field_api_name": string;
+            "multiple": boolean;
+            "mime_types": string[];
+            "related_to_object_api_name": string;
+            "related_to_field_api_name": string;
+            "related_to_api_name": string;
+            "related_to_fields": object[];
+            "filter": FilterType[];
+            "sort": {
+                "field": string;
+                "type": "string";
+                "direction": ("asc" | "desc");
+            }[];
+            "filter_record": {
+                "index": number;
+                "type": string;
+            };
+            "is_extract": boolean;
+        };
+    };
+    "unique_type": number;
+    "updated_at": number;
+    "updated_by": {
+        "avatar": object;
+        "id": number;
+        "name": string;
+    };
+};
+export {};

package/context/metadata/types/objects.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });