@skedulo/mex-types 1.20.1 → 1.22.0

package/dist/common/MexDefs.js.map

@@ -1 +1 @@
-{"version":3,"file":"MexDefs.js","sourceRoot":"","sources":["../../src/common/MexDefs.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAIjD;;;;;GAKG;AACH,IAAY,SA6BX;AA7BD,WAAY,SAAS;IACnB;;OAEG;IACH,4BAAe,CAAA;IACf;;OAEG;IACH,oCAAuB,CAAA;IACvB;;OAEG;IACH,oCAAuB,CAAA;IACvB;;OAEG;IACH,wCAA2B,CAAA;IAC3B;;OAEG;IACH,gDAAmC,CAAA;IACnC;;OAEG;IACH,oDAAuC,CAAA;IACvC;;OAEG;IACH,8BAAiB,CAAA;AACnB,CAAC,EA7BW,SAAS,yBAAT,SAAS,QA6BpB;AA8OD,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}
+{"version":3,"file":"MexDefs.js","sourceRoot":"","sources":["../../src/common/MexDefs.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAIjD;;;;;GAKG;AACH,IAAY,SA6BX;AA7BD,WAAY,SAAS;IACnB;;OAEG;IACH,4BAAe,CAAA;IACf;;OAEG;IACH,oCAAuB,CAAA;IACvB;;OAEG;IACH,oCAAuB,CAAA;IACvB;;OAEG;IACH,wCAA2B,CAAA;IAC3B;;OAEG;IACH,gDAAmC,CAAA;IACnC;;OAEG;IACH,oDAAuC,CAAA;IACvC;;OAEG;IACH,8BAAiB,CAAA;AACnB,CAAC,EA7BW,SAAS,yBAAT,SAAS,QA6BpB;AA+OD,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -14,15 +14,17 @@ 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 {
     /**
-     * @label Title
+     * @label Heading
+     * @tooltip Text added here will be shown as the header of the paragraph
      */
     title?: LocalizedKey;
     /**
-     * @label Text
+     * @label Text to display
+     * @tooltip Text added here will be shown in mobile forms as a readonly paragraph
      */
     text: LocalizedKey;
 }
@@ -30,7 +32,7 @@ export type KeyboardType = 'default' | 'email-address' | 'numeric' | 'phone-pad'
 export type TextEditorDataType = 'string' | 'integer' | 'decimal';
 export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponentModel {
     /**
-     * @label Title
+     * @label Label
      */
     title: LocalizedKey;
     /**
@@ -39,7 +41,7 @@ export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponen
      */
     validator?: ValidatorDefinitionModel;
     /**
-     * @label Mandatory
+     * @label Required
      * @typeAdhoc boolean
      * @placeholder Select true or false
      */
@@ -53,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 {
@@ -64,7 +72,8 @@ export interface CommonEditorEvents {
 }
 export interface CommonEditorWithPlaceholder {
     /**
-     * @label Placeholder
+     * @label Placeholder text
+     * @tooltip Enter a short text that informs the users of what to enter in the field.
      */
     placeholder?: LocalizedKey;
 }
@@ -73,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 {
     /**
@@ -100,7 +109,7 @@ export interface TextEditorViewComponentModel extends CommonEditorViewComponentM
      */
     editable?: boolean;
     /**
-     * @label Multiline
+     * @label Multi-line
      */
     multiline?: boolean;
     /**
@@ -119,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 {
     /**
@@ -182,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 {
     /**
@@ -228,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 {
     /**
@@ -256,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 {
     /**
@@ -301,7 +310,7 @@ export interface ToggleEditorItemModel {
  * @value dateTimeEditor
  * @description Allow selecting date and time
  * @label Date & time
- * @fieldOrders ['title', 'placeholder' ,'mandatory', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'mandatory', 'showIfExpression']
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -354,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;
     /**
@@ -377,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;
     /**
@@ -458,7 +473,7 @@ export interface BaseSelectEditor {
      * Apply for Mex survey only
      * This property is used to allow users add choices to the picklist, multi picklist
      * @typeAdhoc textarea
-     * @label Add drop down choices
+     * @label Add drop-down choices
      * @placeholder Each choice must be on a separate line
      * @required true
      */
@@ -468,8 +483,8 @@ export interface BaseSelectEditor {
  * @area Components
  * @value selectEditor
  * @description Select a single item from a list
- * @label Drop down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
+ * @label Drop-down
+ * @fieldOrders ['title', 'caption', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -492,8 +507,8 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
  * @area Components
  * @value multiSelectEditor
  * @description Select one or more items from a list
- * @label Multi-select drop down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
+ * @label Multi-select drop-down
+ * @fieldOrders ['title', 'caption', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -518,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 {
     /**
@@ -551,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.20.1",
+  "version": "1.22.0",
   "engines": {
     "node": "18"
   },