@skedulo/mex-types 1.5.1 → 1.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -37,25 +37,24 @@ export declare enum DefStatus {
37
37
  }
38
38
  type MexBaseMetadata = {
39
39
  /**
40
- * @label Summary
40
+ * @label Description
41
41
  */
42
42
  summary?: string;
43
43
  /**
44
44
  * @label Email
45
- * @hidden true
46
45
  */
47
46
  email?: string;
48
47
  /**
49
48
  * @label Mobile display order
50
49
  * @min 0
51
50
  * @max 999
52
- * @tooltip Please choose a number to determine the display priority of the form within the mobile app. A higher number will result in a lower display position for the form in the mobile app
51
+ * @tooltip Enter a lower number to set a higher priority and position on the screen
53
52
  */
54
53
  displayOrder: number;
55
54
  /**
56
55
  * @label Attachment destination
57
56
  * @placeholder Enter object name
58
- * @tooltip Provide the name of the object where you intend to store attachments when using the Attachments component in this form
57
+ * @tooltip Specify the object where attachments will be stored
59
58
  * @hidden true
60
59
  */
61
60
  hasAttachments?: string[];
@@ -73,23 +72,24 @@ interface MexMetadataForJob extends MexBaseMetadata {
73
72
  /**
74
73
  * @label Form type
75
74
  * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
76
- * @tooltip A global form will display in the user profile page
75
+ * @tooltip Job forms display only on jobs whereas global forms will display in the “More” menu of the mobile app
77
76
  * @dataType singleselect
78
77
  * @readonly true
79
78
  */
80
79
  contextObject: 'Jobs';
81
80
  /**
82
- * @label Show for Job Types
83
- * @tooltip The form will be visible on all jobs of the selected types
81
+ * @label Visible for job Types
82
+ * @tooltip Job types where this form will be visible
84
83
  */
85
84
  showIf?: string;
86
85
  /**
87
- * @label Mandatory for Job Types
88
- * @tooltip Filling out the form is required to complete jobs of the selected types
86
+ * @label Mandatory for job Types
87
+ * @tooltip Job types where this form will be mandatory
89
88
  */
90
89
  mandatoryIf?: string;
91
90
  /**
92
91
  * @label Mandatory expression
92
+ * @tooltip Job types where this form will be mandatory
93
93
  * @hidden true
94
94
  */
95
95
  mandatoryExpression?: string;
@@ -101,7 +101,7 @@ interface MexMetadataForResource extends MexBaseMetadata {
101
101
  /**
102
102
  * @label Form type
103
103
  * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
104
- * @tooltip A global form will display in the user profile page
104
+ * @tooltip Job forms display only on jobs whereas global forms will display in the “More” menu of the mobile app
105
105
  * @dataType singleselect
106
106
  * @readonly true
107
107
  */
@@ -111,7 +111,7 @@ export interface MexMetadataFormBuilder extends MexBaseMetadata {
111
111
  /**
112
112
  * @label Form type
113
113
  * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
114
- * @tooltip A global form will display in the user profile page
114
+ * @tooltip Job forms display only on jobs whereas global forms will display in the “More” menu of the mobile app
115
115
  * @dataType singleselect
116
116
  * @readonly true
117
117
  */
@@ -17,7 +17,7 @@ export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponen
17
17
  title: LocalizedKey;
18
18
  /**
19
19
  * @label Validator
20
- * @typeAdhoc BaseValidatorModel
20
+ * @referenceTo ExpressionValidatorModel
21
21
  */
22
22
  validator?: ValidatorDefinitionModel;
23
23
  /**
@@ -218,7 +218,7 @@ export interface ToggleEditorViewComponentModel extends CommonEditorViewComponen
218
218
  /**
219
219
  * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
220
220
  * @label Validator
221
- * @typeAdhoc BaseValidatorModel
221
+ * @referenceTo ExpressionValidatorModel
222
222
  */
223
223
  validator: ValidatorDefinitionModel;
224
224
  /**
@@ -397,7 +397,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
397
397
  /**
398
398
  * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
399
399
  * @label Validator
400
- * @typeAdhoc BaseValidatorModel
400
+ * @referenceTo ExpressionValidatorModel
401
401
  */
402
402
  validator: ValidatorDefinitionModel;
403
403
  /**
@@ -418,7 +418,7 @@ export interface MultiSelectEditorViewComponentModel extends CommonEditorViewCom
418
418
  /**
419
419
  * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
420
420
  * @label Validator
421
- * @typeAdhoc BaseValidatorModel
421
+ * @referenceTo ExpressionValidatorModel
422
422
  */
423
423
  validator: ValidatorDefinitionModel;
424
424
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skedulo/mex-types",
3
- "version": "1.5.1",
3
+ "version": "1.5.3",
4
4
  "engines": {
5
5
  "node": "18"
6
6
  },