@skedulo/mex-types 1.28.4 → 1.30.0

package/dist/common/CommonTypes.d.ts

@@ -1,4 +1,4 @@
-import { BaseFlatPageViewComponentModel, SkedButtonTheme } from '../view/FlatPageViewComponentModel';
+import { BaseFlatPageViewComponentModel, SkedButtonTheme } from '../view';
 import { SelectPageOnlineSource } from '../view';
 export type DollarExpressionType = string;
 export type DataExpressionType = string;
@@ -6,6 +6,16 @@ export type ValueExpressionType = string | ValueExpressionLogic[];
 export type LocalizedKey = string;
 export type OneLevelBindingObject = any;
 export type FunctionExpressionType = string;
+/**
+ * @version 1.24.0
+ * @description online mode only
+ * Call the API using the query prop, then execute the expression with the data context and response from that API
+ * Used in mandatoryExpression
+ */
+export type AsyncExpressionType = {
+    expression: DataExpressionType;
+    query: OnlineFetchDataQuery;
+};
 export type TimezoneType = 'none' | 'job' | 'local';
 export type ValueExpressionLogic = {
     condition?: DataExpressionType;

package/dist/common/MexDefs.d.ts

@@ -1,4 +1,5 @@
 import { UIDefinition } from 'src/page';
+import { AsyncExpressionType } from './CommonTypes';
 /**
  * Form definition status.
  * State flow:
@@ -109,7 +110,7 @@ interface MexMetadataForJob extends MexBaseMetadata {
      * @tooltip Job types where this form will be mandatory
      * @hidden true
      */
-    mandatoryExpression?: string;
+    mandatoryExpression?: string | AsyncExpressionType;
 }
 /**
  * @area Metadata

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;AAgQD,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;;;AAKjD;;;;;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;AAgQD,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}

package/dist/page/PageComponentModel.d.ts

@@ -1,8 +1,8 @@
-import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OnlineDeleteDataQuery, OnlineFetchDataQuery, OnlineFetchListDataQuery, OnlineUpsertDataQuery, OrderByModel, RoutingType, ValueExpressionType } from '../common/CommonTypes';
-import { BaseListPageViewComponentModel } from '../view/ListPageViewComponentModel';
-import { BaseComponentModel } from '../common/BaseComponentModel';
-import { BaseFlatPageViewComponentModel } from '../view/FlatPageViewComponentModel';
-import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
+import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OnlineDeleteDataQuery, OnlineFetchDataQuery, OnlineFetchListDataQuery, OnlineUpsertDataQuery, OrderByModel, RoutingType, ValueExpressionType } from '../common';
+import { BaseListPageViewComponentModel } from '../view';
+import { BaseComponentModel } from '../common';
+import { BaseFlatPageViewComponentModel } from '../view';
+import { ValidatorDefinitionModel } from '../validator';
 /**
  * @area formProperties
  */
@@ -168,11 +168,7 @@ export interface TagItemModel {
  * @label List
  * @value list
  */
-export interface ListPageComponentModel extends BasePageComponentModel {
-    /**
-     * @label List header
-     */
-    header?: ListPageHeaderModel;
+export interface ListPageComponentModel extends BasePageComponentModel, SublistOfFlatPageComponentModel {
     /**
      * @label List header title
      * @deprecated Use title in { ListPageComponentModel.header.title }
@@ -183,53 +179,19 @@ export interface ListPageComponentModel extends BasePageComponentModel {
      * @deprecated Use description in { ListPageComponentModel.header.description }
      */
     headerDescription?: LocalizedKey;
-    /**
-     * @label Add New button
-     */
-    addNew: AddNewButtonData;
     /**
      * @label Button group
      * @deprecated Use buttonGroup in { ListPageComponentModel.header.buttonGroup }
      */
     buttonGroup?: ButtonGroupViewComponentModel;
-    /**
-     * @label Data Source
-     * @description Define only when using offline mode
-     */
-    sourceExpression?: DataExpressionType;
     /**
      * @label Enable Search
      */
     search?: ListPageSearchComponentModel;
-    /**
-     * @label Empty text
-     */
-    emptyText: LocalizedKey;
-    /**
-     * @label Layout
-     */
-    itemLayout: BaseListPageViewComponentModel;
     /**
      * @label Footer text
      */
     footerText?: string;
-    /**
-     * @label Click Destination
-     */
-    itemClickDestination: RoutingType;
-    /**
-     * @label Add a section
-     */
-    hasSection?: GroupByFeatureModel;
-    /**
-     * @label Order by
-     */
-    orderBy?: OrderByModel;
-    /**
-     * @label Online mode definition
-     * @version 1.10.0
-     */
-    onlineMode?: ListPageOnlineModeModel;
 }
 /**
  * @version 1.10.0
@@ -371,6 +333,7 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
     /**
      * @label Items
      * @hidden true
+     * @deprecated Use items in { FlatPageComponentModel.singleDef.flatComponents }
      */
     items?: BaseFlatPageViewComponentModel[];
     header?: FlatPageHeaderModel;
@@ -385,6 +348,10 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
     };
     mode?: FlatPageMode;
     stepDef?: FlatPageStepModeDefModel;
+    /**
+     * @version 1.13.0
+     */
+    singleDef?: FlatPageSingleModeDefModel;
 }
 /**
  * @version 1.10.0
@@ -400,6 +367,13 @@ export type ReloadRequest = {
     key: string;
     args: OneLevelBindingObject;
 };
+/**
+ * @version 1.13.0
+ */
+export type FlatPageSingleModeDefModel = {
+    flatComponents?: BaseFlatPageViewComponentModel[];
+    list?: SublistOfFlatPageComponentModel;
+};
 export type FlatPageStepModeDefModel = {
     stepValue: DataExpressionType;
     autoSubmit?: DataExpressionType | boolean;
@@ -435,6 +409,46 @@ export interface BasePageHeaderModel {
      */
     messageAlert?: MessageAlertModel;
 }
+export interface SublistOfFlatPageComponentModel {
+    /**
+     * @label List header
+     */
+    header?: ListPageHeaderModel;
+    /**
+     * @label Add New button
+     */
+    addNew: AddNewButtonData;
+    /**
+     * @label Data Source
+     * @description Define only when using offline mode
+     */
+    sourceExpression?: DataExpressionType;
+    /**
+     * @label Empty text
+     */
+    emptyText: LocalizedKey;
+    /**
+     * @label Layout
+     */
+    itemLayout: BaseListPageViewComponentModel;
+    /**
+     * @label Click Destination
+     */
+    itemClickDestination: RoutingType;
+    /**
+     * @label Add a section
+     */
+    hasSection?: GroupByFeatureModel;
+    /**
+     * @label Order by
+     */
+    orderBy?: OrderByModel;
+    /**
+     * @label Online mode definition
+     * @version 1.10.0
+     */
+    onlineMode?: ListPageOnlineModeModel;
+}
 export interface ListPageHeaderModel extends BasePageHeaderModel {
     buttonGroup?: ButtonGroupViewComponentModel;
 }

package/package.json

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