@skedulo/mex-types 1.15.2 → 1.15.4

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.
@@ -98,9 +98,15 @@ export interface ListPageComponentModel extends BasePageComponentModel {
98
98
  /**
99
99
  * @label List header
100
100
  */
101
+ header?: ListPageHeaderModel;
102
+ /**
103
+ * @label List header title
104
+ * @deprecated Use title in { ListPageComponentModel.header.title }
105
+ */
101
106
  headerTitle?: LocalizedKey;
102
107
  /**
103
108
  * @label List description
109
+ * @deprecated Use description in { ListPageComponentModel.header.description }
104
110
  */
105
111
  headerDescription?: LocalizedKey;
106
112
  /**
@@ -109,6 +115,7 @@ export interface ListPageComponentModel extends BasePageComponentModel {
109
115
  addNew: AddNewButtonData;
110
116
  /**
111
117
  * @label Button group
118
+ * @deprecated Use buttonGroup in { ListPageComponentModel.header.buttonGroup }
112
119
  */
113
120
  buttonGroup?: ButtonGroupViewComponentModel;
114
121
  /**
@@ -273,10 +280,15 @@ export type FlatPageStepRoutingLogic = {
273
280
  key: string;
274
281
  };
275
282
  export type FlatPageMode = 'single' | 'steps';
276
- export type FlatPageHeaderModel = {
283
+ export interface BasePageHeaderModel {
277
284
  title?: LocalizedKey;
278
285
  description?: LocalizedKey;
286
+ }
287
+ export interface ListPageHeaderModel extends BasePageHeaderModel {
288
+ buttonGroup?: ButtonGroupViewComponentModel;
289
+ }
290
+ export interface FlatPageHeaderModel extends BasePageHeaderModel {
279
291
  tags?: TagModel;
280
- };
292
+ }
281
293
  export type AllPageComponentModel = ListPageComponentModel | FlatPageComponentModel;
282
294
  export {};
@@ -9,6 +9,13 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
9
9
  */
10
10
  showIfExpression?: DataExpressionType;
11
11
  }
12
+ /**
13
+ * @area Components
14
+ * @value textView
15
+ * @description Content for users to read
16
+ * @label Text view
17
+ * @fieldOrders ['title', 'text', 'showIfExpression']
18
+ */
12
19
  export interface TextViewComponentModel extends BaseFlatPageViewComponentModel {
13
20
  title?: LocalizedKey;
14
21
  text: LocalizedKey;
@@ -59,7 +66,7 @@ export interface CommonEditorWithPlaceholder {
59
66
  * @value textEditor
60
67
  * @description Enable users to input data from mobile app
61
68
  * @label Text input
62
- * @fieldOrders ['title', 'keyboardType', 'placeholder', 'mandatory', 'multiline']
69
+ * @fieldOrders ['title', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
63
70
  */
64
71
  export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
65
72
  /**
@@ -104,7 +111,7 @@ export interface TextEditorFeaturesModel {
104
111
  * @value readonlyTextView
105
112
  * @description Content for users to read
106
113
  * @label Read-only label
107
- * @fieldOrders ['title', 'text']
114
+ * @fieldOrders ['title', 'text', 'showIfExpression']
108
115
  */
109
116
  export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
110
117
  /**
@@ -167,7 +174,7 @@ export interface SubListEditorViewComponentModel extends CommonEditorViewCompone
167
174
  * @value attachmentsEditor
168
175
  * @description Add a file or photo from a mobile device
169
176
  * @label Attachment
170
- * @fieldOrders ['title', 'mandatory']
177
+ * @fieldOrders ['title', 'mandatory', 'showIfExpression']
171
178
  */
172
179
  export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
173
180
  /**
@@ -203,7 +210,7 @@ export interface BodyMapViewComponentModel extends CommonEditorViewComponentMode
203
210
  * @value signatureEditor
204
211
  * @description Capture a signature on a mobile device
205
212
  * @label Signature
206
- * @fieldOrders ['title', 'enableFullName']
213
+ * @fieldOrders ['title', 'enableFullName', 'showIfExpression']
207
214
  */
208
215
  export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
209
216
  /**
@@ -231,7 +238,7 @@ export interface SignatureEditorViewComponentModel extends CommonEditorViewCompo
231
238
  * @value toggleEditor
232
239
  * @description Switch between two opposing states
233
240
  * @label Toggle
234
- * @fieldOrders []
241
+ * @fieldOrders ['showIfExpression']
235
242
  */
236
243
  export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
237
244
  /**
@@ -276,7 +283,7 @@ export interface ToggleEditorItemModel {
276
283
  * @value dateTimeEditor
277
284
  * @description Allow selecting date and time
278
285
  * @label Date & time
279
- * @fieldOrders ['title', 'placeholder' ,'mandatory']
286
+ * @fieldOrders ['title', 'placeholder' ,'mandatory', 'showIfExpression']
280
287
  */
281
288
  export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
282
289
  /**
@@ -441,7 +448,7 @@ export interface BaseSelectEditor {
441
448
  * @value selectEditor
442
449
  * @description Select a single item from a list
443
450
  * @label Drop down
444
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options']
451
+ * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
445
452
  */
446
453
  export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
447
454
  /**
@@ -465,7 +472,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
465
472
  * @value multiSelectEditor
466
473
  * @description Select one or more items from a list
467
474
  * @label Multi-select drop down
468
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options']
475
+ * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
469
476
  */
470
477
  export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
471
478
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skedulo/mex-types",
3
- "version": "1.15.2",
3
+ "version": "1.15.4",
4
4
  "engines": {
5
5
  "node": "18"
6
6
  },