@byted-apaas/server-sdk-node 1.1.18-beta.7 → 1.1.18-beta.9

package/context/metadata/metadata.d.ts

@@ -40,7 +40,6 @@ 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>;
-    page(apiName: string, objectApiName: string, type: string): Page;
 }
 declare function metadataV3<mt>(ctx: any): IMetaData<mt>;
 declare class Page implements IPage {

package/context/metadata/metadata.js

@@ -49,18 +49,6 @@ class MetaDataV3 {
         };
         return new KObject(objectApiName, appCtx);
     }
-    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.MetaDataV3 = MetaDataV3;
 function metadataV3(ctx) {

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

@@ -1,5 +1,6 @@
 import { CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
 import { I18ns } from '../types/common';
+import { FilterTypeV3, RegionFilterTypeV3, SubOptionTypeV3 } from '../types/objectsV3';
 declare function getUnique(field: FieldType): boolean;
 declare function getCaseSensitive(field: FieldType): boolean;
 declare function getMultiline(field: FieldType): boolean;
@@ -12,6 +13,7 @@ declare function getMultiple(field: FieldType): boolean;
 declare function getOptionSource(field: FieldType): ('custom' | 'global');
 declare function getGlobalOptionApiName(field: FieldType): string;
 declare function getOptionList(field: FieldType): SubOptionType[];
+declare function getOptionListV3(field: FieldType): SubOptionTypeV3[];
 declare function getDescriptionWhenTrue(field: FieldType): I18ns;
 declare function getDescriptionWhenFalse(field: FieldType): I18ns;
 declare function getDefaultValue(field: FieldType): boolean;
@@ -35,7 +37,9 @@ declare function getSettingsMultiple(field: FieldType): boolean;
 declare function getCompositeTypeApiName(field: FieldType): string;
 declare function getCompositeTypeSubFields(field: FieldType): object[];
 declare function getSettingsFilter(field: FieldType): FilterType[];
+declare function getSettingsFilterV3(field: FieldType): FilterTypeV3[];
 export declare function getRegionSettingsFilter(field: FieldType): RegionFilterType[];
+export declare function getRegionSettingsFilterV3(field: FieldType): RegionFilterTypeV3[];
 declare function getSettingsSort(field: FieldType): SortConditionType[];
 declare function getRecordPosition(field: FieldType): number;
 export declare function getRollupType(field: FieldType): string;
@@ -45,4 +49,4 @@ export declare function getRollupLookupFieldApiName(field: FieldType): string;
 export declare function getRegionOptionLevel(field: FieldType): boolean;
 export declare function getRegionStrictLeve(field: FieldType): number;
 export declare function getRollupFilter(field: FieldType): CriterionType;
-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, };
+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, getOptionListV3, getSettingsFilterV3 };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = exports.getRollupFilter = exports.getRegionStrictLeve = exports.getRegionOptionLevel = exports.getRollupLookupFieldApiName = exports.getRollupFieldApiName = exports.getRollupObjectApiName = exports.getRollupType = exports.getRegionSettingsFilter = void 0;
+exports.getSettingsFilterV3 = exports.getOptionListV3 = exports.getRecordPosition = exports.getSettingsSort = exports.getSettingsFilter = exports.getCompositeTypeSubFields = exports.getCompositeTypeApiName = exports.getSettingsMultiple = exports.getBackLookupFieldApiName = exports.getBackLookupObjectApiName = exports.getFileTypes = exports.getFileMultiple = exports.getReferenceFieldApiName = exports.getReferenceObjectApiName = exports.getSuffix = exports.getPrefix = exports.getDigitsNumber = exports.getGenerateMethod = exports.getFormula = exports.getReturnType = exports.getLookupDisplayStyle = exports.getLookupIsHierarchy = exports.getLookupRefObjectApiName = exports.getDisplayStyle = exports.getDefaultValue = exports.getDescriptionWhenFalse = exports.getDescriptionWhenTrue = exports.getOptionList = exports.getGlobalOptionApiName = exports.getOptionSource = exports.getMultiple = exports.getDecimalPlaces = exports.getDisplayAsPercentage = exports.getRegexpErrMsg = exports.getRegexpExpression = exports.getMaxLength = exports.getMultiline = exports.getCaseSensitive = exports.getUnique = exports.getRollupFilter = exports.getRegionStrictLeve = exports.getRegionOptionLevel = exports.getRollupLookupFieldApiName = exports.getRollupFieldApiName = exports.getRollupObjectApiName = exports.getRollupType = exports.getRegionSettingsFilterV3 = exports.getRegionSettingsFilter = void 0;
 const common = require("@byted-apaas/server-common-node");
 const common_1 = require("../types/common");
 const commonConstants = common.constants;
@@ -118,6 +118,23 @@ function getOptionList(field) {
     return options;
 }
 exports.getOptionList = getOptionList;
+function getOptionListV3(field) {
+    if (!field || !field.type || !field.type.settings || !field.type.settings.options || !Array.isArray(field.type.settings.options)) {
+        return [];
+    }
+    let options = [];
+    for (let option of field.type.settings.options) {
+        options.push({
+            label: (0, common_1.transI18nsToMultilingualV3)(option.name),
+            apiName: option.api_name,
+            description: (0, common_1.transI18nsToMultilingualV3)(option.description),
+            color: commonUtils.getColorNameById(option.color_id),
+            active: Number(option.active) === 1,
+        });
+    }
+    return options;
+}
+exports.getOptionListV3 = getOptionListV3;
 function getDescriptionWhenTrue(field) {
     if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.description_if_true)) {
         return field.type.settings.description_if_true;
@@ -283,6 +300,13 @@ function getSettingsFilter(field) {
     return [];
 }
 exports.getSettingsFilter = getSettingsFilter;
+function getSettingsFilterV3(field) {
+    if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
+        return field.type.settings.filter;
+    }
+    return [];
+}
+exports.getSettingsFilterV3 = getSettingsFilterV3;
 function getRegionSettingsFilter(field) {
     if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
         return field.type.settings.filter;
@@ -290,6 +314,24 @@ function getRegionSettingsFilter(field) {
     return [];
 }
 exports.getRegionSettingsFilter = getRegionSettingsFilter;
+function getRegionSettingsFilterV3(field) {
+    if (field && field.type && field.type.settings && !(0, common_1.isNullOrUndefined)(field.type.settings.filter)) {
+        const res = field.type.settings.filter.map(s => {
+            let f = s;
+            const tmp = {
+                id: f.id,
+                label: f.label,
+                errorMessage: (0, common_1.transI18nsToMultilingualV3)(f.errorMessage),
+                recordFilter: f.recordFilter,
+                precondition: f.precondition,
+            };
+            return tmp;
+        });
+        return res;
+    }
+    return [];
+}
+exports.getRegionSettingsFilterV3 = getRegionSettingsFilterV3;
 // TODO 结构转换
 function getSettingsSort(field) {
     let res = [];

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

@@ -1,5 +1,6 @@
-import { BaseFieldType, CriterionType, FieldType, FilterType, RegionFilterType, SortConditionType, SubOptionType } from '../types/objects';
-import { I18ns, MultilingualTypeV3 } from '../types/common';
+import { BaseFieldType, CriterionType, FieldType, FilterType, SortConditionType } from '../types/objects';
+import { MultilingualTypeV3 } from '../types/common';
+import { FilterTypeV3, RegionFilterTypeV3, SubOptionTypeV3 } from '../types/objectsV3';
 declare class MetadataFieldV3 {
     type: string;
     apiName: string;
@@ -61,7 +62,7 @@ declare class OptionV3 extends MetadataFieldV3 {
     multiple: boolean;
     optionSource: ('custom' | 'global');
     globalOptionApiName: string;
-    optionList: SubOptionType[];
+    optionList: SubOptionTypeV3[];
     constructor(field: FieldType);
 }
 declare class EmailV3 extends MetadataFieldV3 {
@@ -75,8 +76,8 @@ declare class MobileNumberV3 extends MetadataFieldV3 {
     constructor(field: FieldType);
 }
 declare class BooleanV3 extends MetadataFieldV3 {
-    descriptionWhenTrue: I18ns;
-    descriptionWhenFalse: I18ns;
+    descriptionWhenTrue: MultilingualTypeV3;
+    descriptionWhenFalse: MultilingualTypeV3;
     defaultValue: boolean;
     unique: boolean;
     constructor(field: FieldType);
@@ -125,7 +126,7 @@ declare class RegionV3 extends MetadataFieldV3 {
     multiple: boolean;
     optionLevel: boolean;
     strictLevel: number;
-    filter: RegionFilterType[];
+    filter: RegionFilterTypeV3[];
     constructor(field: FieldType);
 }
 declare class FileV3 extends MetadataFieldV3 {
@@ -147,7 +148,7 @@ declare class CompositeTypeV3 extends MetadataFieldV3 {
 declare class ExtractSingleRecordV3 extends MetadataFieldV3 {
     compositeTypeApiName: string;
     subFields: BaseFieldType[];
-    filter: FilterType[];
+    filter: FilterTypeV3[];
     sortConditions: SortConditionType[];
     recordPosition: number;
     constructor(field: FieldType);

package/context/metadata/objects/fieldsV3.js

@@ -120,7 +120,7 @@ class OptionV3 extends MetadataFieldV3 {
         this.multiple = fieldsUtil.getMultiple(field);
         this.optionSource = fieldsUtil.getOptionSource(field);
         this.globalOptionApiName = fieldsUtil.getGlobalOptionApiName(field);
-        this.optionList = fieldsUtil.getOptionList(field);
+        this.optionList = fieldsUtil.getOptionListV3(field);
     }
 }
 exports.OptionV3 = OptionV3;
@@ -153,8 +153,8 @@ class BooleanV3 extends MetadataFieldV3 {
         }
         super('boolean', field);
         this.unique = fieldsUtil.getUnique(field);
-        this.descriptionWhenTrue = fieldsUtil.getDescriptionWhenTrue(field);
-        this.descriptionWhenFalse = fieldsUtil.getDescriptionWhenFalse(field);
+        this.descriptionWhenTrue = (0, common_1.transI18nsToMultilingualV3)(fieldsUtil.getDescriptionWhenTrue(field));
+        this.descriptionWhenFalse = (0, common_1.transI18nsToMultilingualV3)(fieldsUtil.getDescriptionWhenFalse(field));
         this.defaultValue = fieldsUtil.getDefaultValue(field);
     }
 }
@@ -247,7 +247,7 @@ class RegionV3 extends MetadataFieldV3 {
         this.multiple = fieldsUtil.getSettingsMultiple(field);
         this.optionLevel = fieldsUtil.getRegionOptionLevel(field);
         this.strictLevel = fieldsUtil.getRegionStrictLeve(field);
-        this.filter = fieldsUtil.getRegionSettingsFilter(field);
+        this.filter = fieldsUtil.getRegionSettingsFilterV3(field);
     }
 }
 exports.RegionV3 = RegionV3;
@@ -300,7 +300,7 @@ class ExtractSingleRecordV3 extends MetadataFieldV3 {
         this.compositeTypeApiName = fieldsUtil.getCompositeTypeApiName(field);
         // TODO 字段类型转换
         this.subFields = parseFieldsV3(fieldsUtil.getCompositeTypeSubFields(field));
-        this.filter = fieldsUtil.getSettingsFilter(field);
+        this.filter = fieldsUtil.getSettingsFilterV3(field);
         this.sortConditions = fieldsUtil.getSettingsSort(field);
         this.recordPosition = fieldsUtil.getRecordPosition(field);
     }

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

@@ -0,0 +1,128 @@
+import { MultilingualTypeV3 } from './common';
+import { CriterionType, SortConditionType } from './objects';
+export interface BaseFieldTypeV3 {
+    type: string;
+    apiName: string;
+    label: MultilingualTypeV3;
+}
+export interface KTextFieldTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+    validationRegex: string;
+    errorMsg: MultilingualTypeV3;
+}
+export interface RichTextTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    maxLength: number;
+}
+export interface KMultilingualTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    caseSensitive: boolean;
+    multiline: boolean;
+    maxLength: number;
+}
+export interface NumberTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+    displayAsPercentage: boolean;
+    decimalPlacesNumber: number;
+}
+export interface KDateTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+}
+export interface DateTimeTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+}
+export type SubOptionTypeV3 = {
+    label: MultilingualTypeV3;
+    apiName: string;
+    description: MultilingualTypeV3;
+    color: ('grey' | 'blue' | 'cyan' | 'green' | 'yellow' | 'orange' | 'red' | 'magenta' | 'purple' | 'blueMagenta');
+    active: boolean;
+};
+export interface OptionTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    optionSource: ('custom' | 'global');
+    globalOptionApiName: string;
+    optionList: SubOptionTypeV3[];
+}
+export interface EmailV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+}
+export interface MobileNumberV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    unique: boolean;
+}
+export interface BooleanV3 extends BaseFieldTypeV3 {
+    descriptionWhenTrue: MultilingualTypeV3;
+    descriptionWhenFalse: MultilingualTypeV3;
+    defaultValue: boolean;
+}
+export interface AvatarOrLogoV3 extends BaseFieldTypeV3 {
+    displayStyle: ('square' | 'round');
+}
+export type FilterTypeV3 = {
+    label: string;
+    needTriggerCriterion: boolean;
+    triggerCriterion: CriterionType;
+    criterion: CriterionType;
+    errorMsg: MultilingualTypeV3;
+};
+export type RegionFilterTypeV3 = {
+    id: string;
+    label: string;
+    errorMessage: MultilingualTypeV3;
+    recordFilter: CriterionType;
+    precondition: object;
+};
+export interface LookupV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    objectApiName: string;
+    hierarchy: boolean;
+    displayStyle: ('search' | 'dropDown' | 'tree');
+    sortConditions: SortConditionType[];
+    filter: FilterTypeV3[];
+}
+export interface FormulaTypeV3 extends BaseFieldTypeV3 {
+    returnType: string;
+    formula: MultilingualTypeV3;
+}
+export interface AutoIDTypeV3 extends BaseFieldTypeV3 {
+    generateMethod: ('random' | 'incremental');
+    digitsNumber: number;
+    prefix: string;
+    suffix: string;
+}
+export interface ReferenceFieldTypeV3 extends BaseFieldTypeV3 {
+    guideFieldApiName: string;
+    fieldApiName: string;
+}
+export interface FileTypeV3 extends BaseFieldTypeV3 {
+    required: boolean;
+    multiple: boolean;
+    fileTypes: string[];
+}
+export interface BackLookuTypeV3 extends BaseFieldTypeV3 {
+    objectApiName: string;
+    fieldApiName: string;
+}
+export interface CompositeTypeV3 extends BaseFieldTypeV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldTypeV3[];
+    required: boolean;
+    multiple: boolean;
+}
+export interface ExtractSingleRecordTypeV3 extends BaseFieldTypeV3 {
+    compositeTypeApiName: string;
+    subFields: BaseFieldTypeV3[];
+    filter: FilterTypeV3[];
+    sortConditions: SortConditionType[];
+    recordPosition: number;
+}

package/context/metadata/types/objectsV3.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.18-beta.7",
+  "version": "1.1.18-beta.9",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",