@skedulo/mex-types 1.3.11 → 1.3.13

package/dist/common/BaseComponentModel.d.ts

@@ -1,3 +1,6 @@
 export interface BaseComponentModel {
+    /**
+     * @label Type
+     */
     type: string;
 }

package/dist/common/CommonTypes.d.ts

@@ -14,7 +14,13 @@ export type ImageDefinition = {
     name: string;
 };
 export type ListPageAddNewDefaultDataType = {
+    /**
+     * @label Object name
+     */
     objectName: string;
+    /**
+     * @label Data
+     */
     data: any;
 } & any;
 export type RoutingType = string | RoutingPageDef;
@@ -33,8 +39,32 @@ export type Routing = {
     transferData?: any;
 };
 export interface ButtonGroupItemComponentModel {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
+    /**
+     * @label Theme
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Success', value: 'success'},
+     *  {label: 'Primary', value: 'primary'},
+     *  {label: 'Default', value: 'default'}
+     * ]
+     */
     theme?: SkedButtonTheme;
+    /**
+     * @label Behavior
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Custom', value: 'custom'},
+     *  {label: 'SMS', value: 'sms'},
+     *  {label: 'Phone', value: 'phone'},
+     *  {label: 'Open URL', value: 'openUrl'},
+     *  {label: 'Email', value: 'email'},
+     *  {label: 'Open Selector', value: 'openSelector'}
+     * ]
+     */
     behavior: ButtonBehaviorComponentModel;
 }
 export interface ButtonBehaviorComponentModel {

package/dist/page/PageComponentModel.d.ts

@@ -43,6 +43,8 @@ export type AddNewButtonData = {
 };
 /**
  * @area Pages
+ * @label List
+ * @value List
  */
 export interface ListPageComponentModel extends BasePageComponentModel {
     headerTitle?: LocalizedKey;
@@ -85,6 +87,8 @@ export interface OrderByModel {
 export type OrderByExpressionType = string[];
 /**
  * @area Pages
+ * @label Standard
+ * @value
  */
 export interface FlatPageComponentModel extends BasePageComponentModel {
     delete: {

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -3,41 +3,89 @@ import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionTy
 import { SelectPageOnlineSource, SelectPageSearchBarConfig } from './SearchPage';
 import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
 export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
+    /**
+     * @label Show if expression
+     * @placeholder Enter expression
+     */
     showIfExpression: DataExpressionType;
 }
 export type KeyboardType = 'default' | 'email-address' | 'numeric' | 'phone-pad' | 'number-pad' | 'decimal-pad';
 export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator?: ValidatorDefinitionModel;
     /**
-     * @typeAdhoc DataExpressionType
+     * @label Mandatory
+     * @typeAdhoc boolean
      */
     mandatory?: boolean | DataExpressionType;
     /**
-     * @typeAdhoc DataExpressionType
+     * @label Readonly
+     * @typeAdhoc boolean
      */
     readonly?: boolean | DataExpressionType;
+    /**
+     * @label Editor events
+     */
     editorEvents?: CommonEditorEvents;
 }
 export interface CommonEditorEvents {
+    /**
+     * @label On value changed
+     * @placeholder Enter expression
+     */
     onValueChanged?: FunctionExpressionType;
 }
 export interface CommonEditorWithPlaceholder {
+    /**
+     * @label Placeholder
+     */
     placeholder: LocalizedKey;
 }
 /**
  * @area Components
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * TODO: need no enhance to remove typeAdhoc
+     * @label Keyboard type
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Default', value: 'default'},
+     *  {label: 'Email address', value: 'email-address'},
+     *  {label: 'Numeric', value: 'numeric'},
+     *  {label: 'Phone pad', value: 'phone-pad'},
+     *  {label: 'Number pad', value: 'number-pad'},
+     *  {label: 'Decimal pad', value: 'decimal-pad'}
+     * ]
+     */
     keyboardType?: KeyboardType;
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * @label Editable
+     */
     editable?: boolean;
+    /**
+     * @label Multiline
+     */
     multiline?: boolean;
 }
 /**
  * @area Components
  */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
 }
 export type SkedButtonTheme = 'success' | 'primary' | 'default';
@@ -51,63 +99,160 @@ export interface ButtonGroupViewComponentModel extends BaseFlatPageViewComponent
  * @area Components
  */
 export interface SubListEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Add New button
+     */
     addNew: {
+        /**
+         * @label Text
+         */
         text: string;
+        /**
+         * @label Destination page
+         */
         destinationPage: string;
+        /**
+         * @label Default data
+         */
         defaultData: ListPageAddNewDefaultDataType;
     };
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Empty text
+     */
     emptyText: LocalizedKey;
+    /**
+     * @label Item layout
+     */
     itemLayout: BaseSublistViewComponentModel;
+    /**
+     * TODO: handle for remove typeAdhoc for union type
+     * @label Item click destination
+     * @typeAdhoc string
+     */
     itemClickDestination: RoutingType;
 }
 /**
  * @area Components
  */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
 }
 /**
  * @area Components
  */
 export interface BodyMapViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
 }
 /**
  * @area Components
  */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
+    /**
+     * @label Enable full name
+     */
     enableFullName: true;
 }
 /**
  * @area Components
  */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
+    /**
+     * @label Items
+     */
     items: ToggleEditorItemModel[];
+    /**
+     * @label Mode
+     */
     mode: 'radio' | 'checkbox' | 'switch';
 }
 export interface ToggleEditorItemModel {
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * @label On Value
+     */
     onValue: any;
+    /**
+     * @label Off Value
+     */
     offValue: any;
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
 }
 /**
  * @area Components
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * @label Mode
+     * @typeAdhoc singleselect
+     * @options [
+     * {label: 'Date and time', value: 'datetime'},
+     * {label: 'Date', value: 'date'},
+     * {label: 'Time', value: 'time'}
+     * ]
+     */
     mode: 'datetime' | 'date' | 'time';
+    /**
+     * @label Date time options
+     */
     datetimeOptions?: {
+        /**
+         * @label Timezone
+         */
         timezone?: TimezoneType;
     };
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
 }
 export interface BaseSublistViewComponentModel extends BaseComponentModel {
@@ -116,9 +261,21 @@ export interface BaseSublistViewComponentModel extends BaseComponentModel {
  * @area Components
  */
 export interface SectionViewComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Body
+     */
     body: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * @label items
+     */
     items: BaseFlatPageViewComponentModel[];
 }
 /**
@@ -128,22 +285,69 @@ export interface MenuListViewComponentModel extends BaseFlatPageViewComponentMod
     items: MenuListItem[];
 }
 export interface MenuListItem extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type
+     * @label Item click destination
+     * @typeAdhoc string
+     */
     itemClickDestination: RoutingType;
+    /**
+     * @label Badge Text
+     */
     badgeText: LocalizedKey;
 }
 export interface BaseSelectEditor {
+    /**
+     * @label Structure expression
+     */
     structureExpression: DataExpressionType;
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Display expression
+     */
     displayExpression: DataExpressionType;
+    /**
+     * @label Filter expression
+     */
     filterExpression: DataExpressionType;
+    /**
+     * @label Online source
+     */
     onlineSource?: SelectPageOnlineSource;
+    /**
+     * @label Select page
+     */
     selectPage: {
+        /**
+         * @label Item title
+         */
         itemTitle: LocalizedKey;
+        /**
+         * @label Item caption
+         */
         itemCaption: LocalizedKey;
+        /**
+         * @label Empty text
+         */
         emptyText: LocalizedKey;
+        /**
+         * @label Title
+         */
         title: LocalizedKey;
+        /**
+         * @label searchBar
+         */
         searchBar: SelectPageSearchBarConfig;
     };
 }
@@ -151,9 +355,23 @@ export interface BaseSelectEditor {
  * @area Components
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
+    /**
+     * @label Construct result object
+     */
     constructResultObject?: ConstructResultObject;
 }
 /**
@@ -162,34 +380,83 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     displayDataInSearchPageExpression: DataExpressionType;
     constructResultObject: ConstructResultObject;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
 }
 export interface ConstructResultObject {
+    /**
+     * @label Data
+     */
     data: OneLevelBindingObject;
+    /**
+     * @label Object name
+     */
     objectName: string;
+    /**
+     * @label Compare property
+     */
     compareProperty: string;
 }
 /**
  * @area Components
  */
 export interface ContactDetailsLayoutComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type
+     * @label Contact methods
+     * @typeAdhoc any
+     */
     contactMethods: [ContactPhoneMethodModel | ContactSmsMethodModel];
+    /**
+     * @label Profile image
+     */
     profileImage: {
+        /**
+         * @label Name expression
+         */
         nameExpression: DataExpressionType;
+        /**
+         * @label Url expression
+         */
         urlExpression: DataExpressionType;
     };
 }
 export interface ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: ContactMethodType;
 }
 export type ContactMethodType = 'phone' | 'sms';
 export interface ContactPhoneMethodModel extends ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: 'phone';
+    /**
+     * @label Phone number expression
+     */
     phoneNumberExpression: DataExpressionType;
 }
 export interface ContactSmsMethodModel extends ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: 'sms';
+    /**
+     * @label Phone number expression
+     */
     phoneNumberExpression: DataExpressionType;
 }

package/dist/view/SearchPage.d.ts

@@ -1,9 +1,21 @@
 import { DataExpressionType, LocalizedKey, OneLevelBindingObject } from '../common/CommonTypes';
 export type SelectPageOnlineSource = {
+    /**
+     * @label Key
+     */
     key: DataExpressionType;
+    /**
+     * @label Variables
+     */
     variables: OneLevelBindingObject;
 };
 export type SelectPageSearchBarConfig = {
+    /**
+     * @label Filter on properties
+     */
     filterOnProperties: string[];
+    /**
+     * @label Placeholder
+     */
     placeholder: LocalizedKey;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skedulo/mex-types",
-  "version": "1.3.11",
+  "version": "1.3.13",
   "engines": {
     "node": "18"
   },