@skedulo/mex-types 1.3.18 → 1.3.19

package/dist/common/BaseComponentModel.d.ts

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

package/dist/page/PageComponentModel.d.ts

@@ -21,9 +21,22 @@ export type UIDefinition = {
     pages: AllPageComponentModel[];
 };
 export interface BasePageComponentModel extends BaseComponentModel {
+    /**
+     * @label Title
+     * @placeholder Enter page title
+     */
     title?: LocalizedKey;
+    /**
+     * @label Page data expression
+     */
     pageDataExpression?: DataExpressionType;
+    /**
+     * @label Wipe existing data
+     */
     wipeExistingData: boolean;
+    /**
+     * @label Default page data
+     */
     defaultPageData: DefaultPageData;
     events?: {
         onInitialized?: FunctionExpressionType;
@@ -32,13 +45,31 @@ export interface BasePageComponentModel extends BaseComponentModel {
     };
 }
 export type DefaultPageData = {
+    /**
+     * @label Object Name
+     */
     objectName?: string;
+    /**
+     * @label Data
+     */
     data: OneLevelBindingObject;
 };
 export type AddNewButtonData = {
+    /**
+     * @label Label
+     */
     text: string;
+    /**
+     * @label Destination page
+     */
     destinationPage: string;
+    /**
+     * @label Default data
+     */
     defaultData: ListPageAddNewDefaultDataType;
+    /**
+     * @label Display condition
+     */
     showIfExpression: DataExpressionType;
 };
 /**
@@ -47,22 +78,67 @@ export type AddNewButtonData = {
  * @value list
  */
 export interface ListPageComponentModel extends BasePageComponentModel {
+    /**
+     * @label List header
+     */
     headerTitle?: LocalizedKey;
+    /**
+     * @label List description
+     */
     headerDescription?: LocalizedKey;
+    /**
+     * @label Add New button
+     */
     addNew: AddNewButtonData;
+    /**
+     * @label Button group
+     */
     buttonGroup?: ButtonGroupViewComponentModel;
+    /**
+     * @label Data Source
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Enable Search
+     */
     search?: ListPageSearchComponentModel;
+    /**
+     * @label Empty text
+     */
     emptyText: LocalizedKey;
+    /**
+     * @label Layout
+     */
     itemLayout: BaseListPageViewComponentModel;
+    /**
+     * @label Footer text
+     */
     footerText?: string;
+    /**
+     * @label Click Destination
+     */
     itemClickDestination: RoutingType;
+    /**
+     * @label Add a section
+     */
     hasSection?: ListPageSectionComponentModel;
+    /**
+     * @label Order by
+     */
     orderBy?: OrderByModel;
 }
 export interface ListPageSearchComponentModel {
+    /**
+     * @label Placeholder text
+     */
     placeholder: LocalizedKey;
+    /**
+     * @label Filter on Properties
+     */
     filterOnProperties: string[];
+    /**
+     * @label Advanced filter
+     */
     advancedFilter: ListPageAdvancedFilterModel;
 }
 export interface ListPageAdvancedFilterModel {
@@ -78,10 +154,19 @@ interface ButtonGroupViewComponentModel {
     items: ButtonGroupItemComponentModel[];
 }
 export interface ListPageSectionComponentModel {
+    /**
+     * @label Group by
+     */
     sectionTitleProperty: DataExpressionType;
+    /**
+     * @label Section title
+     */
     sectionTitleText: LocalizedKey;
 }
 export interface OrderByModel {
+    /**
+     * @label Expression
+     */
     expression: OrderByExpressionType;
 }
 export type OrderByExpressionType = string[];
@@ -91,25 +176,62 @@ export type OrderByExpressionType = string[];
  * @value flat
  */
 export interface FlatPageComponentModel extends BasePageComponentModel {
+    /**
+     * @label Delete Button
+     */
     delete: {
+        /**
+         * @label Show Delete button condition
+         */
         canDeleteExpression: DataExpressionType;
+        /**
+         * @label Label
+         */
         text: LocalizedKey;
+        /**
+         * @label Confirm
+         */
         confirm: {
+            /**
+             * @label Confirm pop-up title
+             */
             title: LocalizedKey;
+            /**
+             * @label Confirm message
+             */
             description: LocalizedKey;
+            /**
+             * @label Yes button label
+             */
             yesBtn?: LocalizedKey;
+            /**
+             * @label No button label
+             */
             noBtn?: LocalizedKey;
         };
     };
+    /**
+     * @label Add Upsert page
+     */
     upsert: {
         insertTitle: LocalizedKey;
         updateTitle: LocalizedKey;
         insertButtonText: LocalizedKey;
         defaultDataForNewObject: OneLevelBindingObject;
         validator?: ValidatorDefinitionModel;
+        /**
+         * @label Read Only condition
+         */
         readonly: DataExpressionType | boolean;
     };
+    /**
+     * @label Items
+     * @hidden true
+     */
     items: BaseFlatPageViewComponentModel[];
+    /**
+     * @label Description
+     */
     description: LocalizedKey;
     flatPageEvents?: {
         onSubmitted?: FunctionExpressionType;

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -51,6 +51,7 @@ export interface CommonEditorWithPlaceholder {
 /**
  * @area Components
  * @value textEditor
+ * @description Enable users to input data from mobile app
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -83,6 +84,7 @@ export interface TextEditorViewComponentModel extends CommonEditorViewComponentM
 /**
  * @area Components
  * @value readonlyTextView
+ * @description To display information on the mobile app as readonly
  */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -141,6 +143,8 @@ export interface SubListEditorViewComponentModel extends CommonEditorViewCompone
 }
 /**
  * @area Components
+ * @value attachment
+ * @description Adding attachments or take photo from mobile app
  */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -173,6 +177,7 @@ export interface BodyMapViewComponentModel extends CommonEditorViewComponentMode
 /**
  * @area Components
  * @value signatureEditor
+ * @description Capturing signatures on the field
  */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -195,6 +200,7 @@ export interface SignatureEditorViewComponentModel extends CommonEditorViewCompo
 /**
  * @area Components
  * @value toggleEditor
+ * @description Allow users to toggle between two states
  */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -237,6 +243,7 @@ export interface ToggleEditorItemModel {
 /**
  * @area Components
  * @value dateTimeEditor
+ * @description Allow selecting date and time
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -364,6 +371,7 @@ export interface BaseSelectEditor {
 /**
  * @area Components
  * @value selectEditor
+ * @description Allow selecting a single value from a pre-defined list of options
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -388,6 +396,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
 /**
  * @area Components
  * @value multiSelectEditor
+ * @description Allow selecting one or more values from a pre-defined list of options
  */
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     displayDataInSearchPageExpression: DataExpressionType;

package/dist/view/ListPageViewComponentModel.d.ts

@@ -1,11 +1,23 @@
 import { BaseComponentModel } from '../common/BaseComponentModel';
 import { ValueExpressionType, LocalizedKey } from '../common/CommonTypes';
 export interface BaseListPageViewComponentModel extends BaseComponentModel {
+    /**
+     * @label Use attachments
+     */
     useAttachments?: UseAttachments;
+    /**
+     * @label Tags
+     */
     tags: ListItemTagModel;
 }
 export interface ListItemTagModel {
+    /**
+     * @label Type
+     */
     type: 'fixed' | 'dynamic';
+    /**
+     * @label Items
+     */
     items: ListItemTagItemModel[];
 }
 export interface ListItemTagItemModel {
@@ -17,6 +29,12 @@ export interface TitleAndCaptionViewComponentModel extends BaseListPageViewCompo
     caption: LocalizedKey;
 }
 export interface UseAttachments {
+    /**
+     * @label Category name
+     */
     categoryName?: string;
+    /**
+     * @label Style
+     */
     style?: 'singleBig' | 'singleSmall';
 }

package/package.json

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