@skedulo/mex-types 1.20.0 → 1.21.0

package/dist/common/MexDefs.d.ts

@@ -99,11 +99,6 @@ interface MexMetadataForJob extends MexBaseMetadata {
  * @area Metadata
  */
 interface MexMetadataForResource extends MexBaseMetadata {
-    /**
-     * @label Visible for resource category
-     * @tooltip Resource types where this form will be visible
-     */
-    showIf?: string;
     /**
      * @label Form type
      * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
@@ -112,6 +107,11 @@ interface MexMetadataForResource extends MexBaseMetadata {
      * @readonly true
      */
     contextObject: 'Resources';
+    /**
+     * @label Visible for resource category
+     * @tooltip Resource types where this form will be visible
+     */
+    showIf?: string;
 }
 export interface MexMetadataFormBuilder extends MexBaseMetadata {
     /**
@@ -167,6 +167,7 @@ export interface MexDef {
      * The definition id, will be generated for the first time.
      * It is used for definition update action
      * @label Form ID
+     * @required false
      * @readonly true
      */
     defId: string;

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;AA6OD,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

@@ -18,11 +18,13 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
  */
 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
      */
@@ -64,7 +66,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;
 }
@@ -100,7 +103,7 @@ export interface TextEditorViewComponentModel extends CommonEditorViewComponentM
      */
     editable?: boolean;
     /**
-     * @label Multiline
+     * @label Multi-line
      */
     multiline?: boolean;
     /**
@@ -301,7 +304,7 @@ export interface ToggleEditorItemModel {
  * @value dateTimeEditor
  * @description Allow selecting date and time
  * @label Date & time
- * @fieldOrders ['title', 'placeholder' ,'mandatory', 'showIfExpression']
+ * @fieldOrders ['title' ,'mandatory', 'showIfExpression']
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -458,7 +461,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,7 +471,7 @@ export interface BaseSelectEditor {
  * @area Components
  * @value selectEditor
  * @description Select a single item from a list
- * @label Drop down
+ * @label Drop-down
  * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
@@ -492,7 +495,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
  * @area Components
  * @value multiSelectEditor
  * @description Select one or more items from a list
- * @label Multi-select drop down
+ * @label Multi-select drop-down
  * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {

package/package.json

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