@skedulo/mex-types 1.32.0 → 1.33.1

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.
@@ -16,6 +16,13 @@ export type AsyncExpressionType = {
16
16
  expression: DataExpressionType;
17
17
  query: OnlineFetchDataQuery;
18
18
  };
19
+ /**
20
+ * @version: 1.14.0
21
+ */
22
+ export interface DynamicContent {
23
+ type: 'dynamicContent';
24
+ contentDataExpression: DataExpressionType;
25
+ }
19
26
  export type TimezoneType = 'none' | 'job' | 'local';
20
27
  export type ValueExpressionLogic = {
21
28
  condition?: DataExpressionType;
@@ -50,7 +57,7 @@ export type RoutingPageDef = {
50
57
  };
51
58
  };
52
59
  export type RoutingPageUI = {
53
- items: BaseFlatPageViewComponentModel[];
60
+ items: (BaseFlatPageViewComponentModel | DynamicContent)[];
54
61
  description?: LocalizedKey;
55
62
  submitText?: LocalizedKey;
56
63
  };
@@ -1,4 +1,4 @@
1
- import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OnlineDeleteDataQuery, OnlineFetchDataQuery, OnlineFetchListDataQuery, OnlineUpsertDataQuery, OrderByModel, RoutingType, ValueExpressionType } from '../common';
1
+ import { ButtonGroupItemComponentModel, DataExpressionType, DynamicContent, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OnlineDeleteDataQuery, OnlineFetchDataQuery, OnlineFetchListDataQuery, OnlineUpsertDataQuery, OrderByModel, RoutingType, ValueExpressionType } from '../common';
2
2
  import { BaseListPageViewComponentModel } from '../view';
3
3
  import { BaseComponentModel } from '../common';
4
4
  import { BaseFlatPageViewComponentModel } from '../view';
@@ -11,15 +11,24 @@ export type UIDefinition = {
11
11
  * @label First page
12
12
  * @placeholder Enter a page name
13
13
  * @tooltip Enter the name of the page you want to set as the initial page for the form
14
+ * @deprecated Use content from { UIDefinition.content.firstPage }
14
15
  */
15
- firstPage: string;
16
+ firstPage?: string;
16
17
  /**
18
+ * @deprecated Use content from { UIDefinition.content.readonly }
17
19
  * @label Prevent form submission on job statuses
18
20
  * @placeholder Select job statuses
19
21
  * @tooltip Users will not be able to submit this form when the job is in any of the chosen job statuses
20
22
  */
21
23
  readonly?: boolean;
22
- pages: AllPageComponentModel[];
24
+ /**
25
+ * @deprecated Use content from { UIDefinition.content.pages }
26
+ */
27
+ pages?: AllPageComponentModel[];
28
+ /**
29
+ * @version 1.14.0
30
+ */
31
+ content?: UIDefinitionContent | DynamicContent;
23
32
  events?: {
24
33
  onDataInitialized?: FunctionExpressionType;
25
34
  };
@@ -34,7 +43,34 @@ export type UIDefinition = {
34
43
  * @version 1.10.0
35
44
  */
36
45
  entryValidator?: ValidatorDefinitionModel;
46
+ /**
47
+ * This property is used to trigger form data fetch when user first enter the form
48
+ * @availability: online
49
+ * @version 1.14.0
50
+ */
51
+ formDataExpression?: AdvancedPageDataExpression;
52
+ /**
53
+ * @version 1.14.0
54
+ */
55
+ extras?: {
56
+ localesDataExpression?: DataExpressionType;
57
+ };
37
58
  };
59
+ /**
60
+ * @version 1.14.0
61
+ */
62
+ export interface UIDefinitionContent {
63
+ pages: {
64
+ [key: string]: AllPageComponentModel;
65
+ };
66
+ /**
67
+ * @label Prevent form submission on job statuses
68
+ * @placeholder Select job statuses
69
+ * @tooltip Users will not be able to submit this form when the job is in any of the chosen job statuses
70
+ */
71
+ readonly?: boolean;
72
+ firstPage: string;
73
+ }
38
74
  export interface BasePageComponentModel extends BaseComponentModel {
39
75
  /**
40
76
  * @label Title
@@ -261,7 +297,7 @@ export interface ListPageAdvancedFilterModel extends WithAdvancedFilterUI {
261
297
  };
262
298
  }
263
299
  export type ListPageAdvancedFilterUI = {
264
- items: BaseFlatPageViewComponentModel[];
300
+ items: (BaseFlatPageViewComponentModel | DynamicContent)[];
265
301
  description?: LocalizedKey;
266
302
  submitText?: LocalizedKey;
267
303
  };
@@ -335,7 +371,7 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
335
371
  * @hidden true
336
372
  * @deprecated Use items in { FlatPageComponentModel.singleDef.flatComponents }
337
373
  */
338
- items?: BaseFlatPageViewComponentModel[];
374
+ items?: (BaseFlatPageViewComponentModel | DynamicContent)[];
339
375
  header?: FlatPageHeaderModel;
340
376
  /**
341
377
  * @label Description
@@ -393,7 +429,7 @@ export type FlatPageStepModel = {
393
429
  stepRecognizedOnInitCondition?: DataExpressionType;
394
430
  };
395
431
  export type FlatPageStepUIModel = {
396
- items: BaseFlatPageViewComponentModel[];
432
+ items: (BaseFlatPageViewComponentModel | DynamicContent)[];
397
433
  validator?: ValidatorDefinitionModel;
398
434
  };
399
435
  export type FlatPageStepRoutingLogic = {
@@ -1,5 +1,5 @@
1
1
  import { BaseComponentModel } from '../common/BaseComponentModel';
2
- import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, IconName, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OrderByModel, RoutingType, TimezoneType, ValueExpressionType } from '../common/CommonTypes';
2
+ import { ButtonGroupItemComponentModel, DataExpressionType, DynamicContent, FunctionExpressionType, GroupByFeatureModel, IconName, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OrderByModel, RoutingType, TimezoneType, ValueExpressionType } from '../common/CommonTypes';
3
3
  import { SelectPageOnlineSource, SelectPageSearchBarConfig } from './SearchPage';
4
4
  import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
5
5
  export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
@@ -379,7 +379,7 @@ export interface SectionViewComponentModel extends BaseFlatPageViewComponentMode
379
379
  /**
380
380
  * @label items
381
381
  */
382
- items: BaseFlatPageViewComponentModel[];
382
+ items: (BaseFlatPageViewComponentModel | DynamicContent)[];
383
383
  }
384
384
  /**
385
385
  * @area Components
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skedulo/mex-types",
3
- "version": "1.32.0",
3
+ "version": "1.33.1",
4
4
  "engines": {
5
5
  "node": "18"
6
6
  },