@skedulo/mex-types 1.21.0 → 1.22.0

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -14,7 +14,7 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
  * @value textView
  * @description Content for users to read
  * @label Read-only
- * @fieldOrders ['title', 'text', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'text', 'showIfExpression']
  */
 export interface TextViewComponentModel extends BaseFlatPageViewComponentModel {
     /**
@@ -55,6 +55,12 @@ export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponen
      * @label Editor events
      */
     editorEvents?: CommonEditorEvents;
+    /**
+     * @label Caption
+     * @typeAdhoc textarea
+     * @maxLength 1000
+     * @tooltip Enter a description or guideline to provide more context. This text will display under the component label
+     */
     caption?: LocalizedKey;
 }
 export interface CommonEditorEvents {
@@ -76,7 +82,7 @@ export interface CommonEditorWithPlaceholder {
  * @value textEditor
  * @description Enable users to input data from mobile app
  * @label Text input
- * @fieldOrders ['title', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -122,7 +128,7 @@ export interface TextEditorFeaturesModel {
  * @value readonlyTextView
  * @description Content for users to read
  * @label Read-only label
- * @fieldOrders ['title', 'text', 'showIfExpression']
+ * @fieldOrders ['title', 'text', 'caption', 'showIfExpression']
  */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -185,7 +191,7 @@ export interface SubListEditorViewComponentModel extends CommonEditorViewCompone
  * @value attachmentsEditor
  * @description Add a file or photo from a mobile device
  * @label Attachment
- * @fieldOrders ['title', 'mandatory', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'mandatory', 'showIfExpression']
  */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -231,7 +237,7 @@ export interface BodyMapViewComponentModel extends CommonEditorViewComponentMode
  * @value signatureEditor
  * @description Capture a signature on a mobile device
  * @label Signature
- * @fieldOrders ['title', 'mandatory', 'enableFullName', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'mandatory', 'enableFullName', 'showIfExpression']
  */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -259,7 +265,7 @@ export interface SignatureEditorViewComponentModel extends CommonEditorViewCompo
  * @value toggleEditor
  * @description Switch between two opposing states
  * @label Toggle
- * @fieldOrders ['showIfExpression']
+ * @fieldOrders ['caption', 'showIfExpression']
  */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -304,7 +310,7 @@ export interface ToggleEditorItemModel {
  * @value dateTimeEditor
  * @description Allow selecting date and time
  * @label Date & time
- * @fieldOrders ['title' ,'mandatory', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'mandatory', 'showIfExpression']
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -357,6 +363,9 @@ export interface SectionViewComponentModel extends BaseFlatPageViewComponentMode
     body: LocalizedKey;
     /**
      * @label Caption
+     * @typeAdhoc textarea
+     * @maxLength 1000
+     * @tooltip Enter a description or guideline to provide more context. This text will display under the component label
      */
     caption: LocalizedKey;
     /**
@@ -380,6 +389,9 @@ export interface MenuListItem extends BaseFlatPageViewComponentModel {
     text: LocalizedKey;
     /**
      * @label Caption
+     * @typeAdhoc textarea
+     * @maxLength 1000
+     * @tooltip Enter a description or guideline to provide more context. This text will display under the component label
      */
     caption: LocalizedKey;
     /**
@@ -472,7 +484,7 @@ export interface BaseSelectEditor {
  * @value selectEditor
  * @description Select a single item from a list
  * @label Drop-down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -496,7 +508,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
  * @value multiSelectEditor
  * @description Select one or more items from a list
  * @label Multi-select drop-down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -521,7 +533,7 @@ export interface MultiSelectEditorViewComponentModel extends CommonEditorViewCom
  * @value numberEditor
  * @description Standard number input field
  * @label Number input
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'placeholder', 'mandatory', 'showIfExpression']
  */
 export interface NumberEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -554,6 +566,9 @@ export interface ContactDetailsLayoutComponentModel extends BaseFlatPageViewComp
     title: LocalizedKey;
     /**
      * @label Caption
+     * @typeAdhoc textarea
+     * @maxLength 1000
+     * @tooltip Enter a description or guideline to provide more context. This text will display under the component label
      */
     caption: LocalizedKey;
     /**

package/package.json

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