@skedulo/mex-types 1.15.3 → 1.16.0

package/dist/common/CommonTypes.d.ts

@@ -1,5 +1,6 @@
 import { BaseFlatPageViewComponentModel, SkedButtonTheme } from '../view/FlatPageViewComponentModel';
 import { SelectPageOnlineSource } from '../view';
+export type DollarExpressionType = string;
 export type DataExpressionType = string;
 export type ValueExpressionType = string | ValueExpressionLogic[];
 export type LocalizedKey = string;
@@ -134,3 +135,32 @@ export interface OpenSelectorButtonBehaviorComponentModel extends ButtonBehavior
     };
 }
 export type IconName = 'copy' | 'logout' | 'search' | 'searchFilter' | 'alert' | 'attachment' | 'calendar' | 'camera' | 'clock' | 'check' | 'checkCircle' | 'date' | 'debug' | 'delete' | 'edit' | 'email' | 'fieldClear' | 'fieldSearch' | 'file' | 'filter' | 'info' | 'job' | 'launch' | 'location' | 'map' | 'mapLayers' | 'mapPin' | 'mobile' | 'more' | 'newMessage' | 'offline' | 'person' | 'phone' | 'photo' | 'select' | 'settings' | 'shareAndroid' | 'shareIOS' | 'shifts' | 'signature' | 'sms' | 'target' | 'travelDistance';
+/**
+ * @version 1.10.0
+ */
+export type OnlineModeFilter = DollarExpressionType;
+/**
+ * @version 1.10.0
+ */
+export type OnlineModeFields = string[];
+export interface BaseOnlineDataQuery {
+    type: 'default' | 'custom';
+    requestKey: string;
+}
+export interface DefaultOnlineDataQuery extends BaseOnlineDataQuery {
+    type: 'default';
+    fields: OnlineModeFields;
+    objectName: string;
+    filter: OnlineModeFilter;
+}
+/**
+ * @version 1.10.0
+ */
+export interface CustomOnlineDataQuery extends BaseOnlineDataQuery {
+    type: 'custom';
+    function: DataExpressionType;
+}
+/**
+ * @version 1.10.0
+ */
+export type OnlineDataQuery = DefaultOnlineDataQuery | CustomOnlineDataQuery;

package/dist/page/PageComponentModel.d.ts

@@ -1,4 +1,4 @@
-import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OrderByModel, RoutingType, ValueExpressionType } from '../common/CommonTypes';
+import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionType, GroupByFeatureModel, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OnlineDataQuery, OrderByModel, RoutingType, ValueExpressionType } from '../common/CommonTypes';
 import { BaseListPageViewComponentModel } from '../view/ListPageViewComponentModel';
 import { BaseComponentModel } from '../common/BaseComponentModel';
 import { BaseFlatPageViewComponentModel } from '../view/FlatPageViewComponentModel';
@@ -22,6 +22,12 @@ export type UIDefinition = {
     events?: {
         onDataInitialized?: FunctionExpressionType;
     };
+    /**
+     * @version 1.10.0
+     */
+    settings?: {
+        fullOnlineMode: boolean;
+    };
 };
 export interface BasePageComponentModel extends BaseComponentModel {
     /**
@@ -32,7 +38,7 @@ export interface BasePageComponentModel extends BaseComponentModel {
     /**
      * @label Page data expression
      */
-    pageDataExpression?: DataExpressionType;
+    pageDataExpression?: DataExpressionType | AdvancedPageDataExpression;
     /**
      * @label Wipe existing data
      */
@@ -46,6 +52,67 @@ export interface BasePageComponentModel extends BaseComponentModel {
         onPreDataSave?: FunctionExpressionType;
         onPreDataLoad?: FunctionExpressionType;
     };
+    /**
+     * @version: 1.10.0
+     */
+    dataObserver: DataObserverObject[];
+}
+/**
+ * @version: 1.10.0
+ */
+export interface DataObserverObject {
+    dataExpression: DataExpressionType[];
+    request: DataObserverObjectRequestType;
+}
+/**
+ * @version: 1.10.0
+ */
+type DataObserverObjectRequestType = OnlineDataObserverObjectHandler | LocalDataObserverObjectHandler;
+/**
+ * @version: 1.10.0
+ */
+export interface BaseDataObserverObjectRequest {
+    handler: FunctionExpressionType;
+    type: 'online' | 'local';
+}
+/**
+ * @version: 1.10.0
+ */
+export interface OnlineDataObserverObjectHandler extends BaseDataObserverObjectRequest {
+    query: OnlineDataQuery;
+    type: 'online';
+}
+/**
+ * @version: 1.10.0
+ */
+export interface LocalDataObserverObjectHandler extends BaseDataObserverObjectRequest {
+    type: 'local';
+}
+export interface AdvancedPageDataExpression {
+    requests: (BaseAdvancedPageDataExpressionRequestType)[];
+}
+export type BaseAdvancedPageDataExpressionRequestType = LocalAdvancedPageDataExpressionRequest | OnlineAdvancedPageDataExpressionRequest;
+/**
+ * @version 1.10.0
+ */
+export interface BaseAdvancedPageDataExpressionRequest {
+    type: 'local' | 'online';
+    target: DataExpressionType;
+    condition?: ValueExpressionType;
+}
+/**
+ * @version 1.10.0
+ */
+export interface LocalAdvancedPageDataExpressionRequest extends BaseAdvancedPageDataExpressionRequest {
+    type: 'local';
+    expression: DataExpressionType;
+}
+/**
+ * @version 1.10.0
+ */
+export interface OnlineAdvancedPageDataExpressionRequest extends BaseAdvancedPageDataExpressionRequest {
+    type: 'online';
+    query: OnlineDataQuery;
 }
 export type DefaultPageData = {
     /**
@@ -120,8 +187,9 @@ export interface ListPageComponentModel extends BasePageComponentModel {
     buttonGroup?: ButtonGroupViewComponentModel;
     /**
      * @label Data Source
+     * @description Define only when using offline mode
      */
-    sourceExpression: DataExpressionType;
+    sourceExpression?: DataExpressionType;
     /**
      * @label Enable Search
      */
@@ -150,6 +218,28 @@ export interface ListPageComponentModel extends BasePageComponentModel {
      * @label Order by
      */
     orderBy?: OrderByModel;
+    /**
+     * @label Online mode definition
+     * @version 1.10.0
+     */
+    onlineMode?: ListPageOnlineModeModel;
+}
+/**
+ * @version 1.10.0
+ */
+export interface ListPageOnlineModeModel {
+    /**
+     * @label List query to get list
+     */
+    list: OnlineDataQuery;
+    /**
+     * @label Item query to get an item
+     */
+    item: OnlineDataQuery;
+    /**
+     * @label Reload requests when user pull to refresh
+     */
+    reloadRequests?: ReloadRequest[];
 }
 export interface ListPageSearchComponentModel {
     /**
@@ -220,6 +310,10 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
              */
             noBtn?: LocalizedKey;
         };
+        /**
+         * @version 1.10.0
+         */
+        onlineMode?: CrudRequestOnlineMode;
     };
     /**
      * @label Add Upsert page
@@ -234,6 +328,10 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
          * @label Read Only condition
          */
         readonly?: DataExpressionType | boolean;
+        /**
+         * @version 1.10.0
+         */
+        onlineMode?: CrudRequestOnlineMode;
     };
     /**
      * @label Items
@@ -253,6 +351,20 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
     mode?: FlatPageMode;
     stepDef?: FlatPageStepModeDefModel;
 }
+/**
+ * @version 1.10.0
+ */
+export type CrudRequestOnlineMode = {
+    query: OnlineDataQuery;
+    reloadRequests: ReloadRequest[];
+};
+/**
+ * @version 1.10.0
+ */
+export type ReloadRequest = {
+    key: string;
+    args: OneLevelBindingObject;
+};
 export type FlatPageStepModeDefModel = {
     stepValue: DataExpressionType;
     autoSubmit?: DataExpressionType | boolean;
@@ -283,6 +395,10 @@ export type FlatPageMode = 'single' | 'steps';
 export interface BasePageHeaderModel {
     title?: LocalizedKey;
     description?: LocalizedKey;
+    /**
+     * @version: 1.10.0
+     */
+    messageAlert?: MessageAlertModel;
 }
 export interface ListPageHeaderModel extends BasePageHeaderModel {
     buttonGroup?: ButtonGroupViewComponentModel;
@@ -290,5 +406,16 @@ export interface ListPageHeaderModel extends BasePageHeaderModel {
 export interface FlatPageHeaderModel extends BasePageHeaderModel {
     tags?: TagModel;
 }
+/**
+ * @version: 1.10.0
+ */
+export interface MessageAlertModel {
+    text: LocalizedKey;
+    showIfExpression?: ValueExpressionType;
+    /**
+     * @values: 'Warning' | 'Danger' | 'Default'
+     */
+    theme: ValueExpressionType;
+}
 export type AllPageComponentModel = ListPageComponentModel | FlatPageComponentModel;
 export {};

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -9,6 +9,13 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
      */
     showIfExpression?: DataExpressionType;
 }
+/**
+ * @area Components
+ * @value textView
+ * @description Content for users to read
+ * @label Text view
+ * @fieldOrders ['title', 'text', 'showIfExpression']
+ */
 export interface TextViewComponentModel extends BaseFlatPageViewComponentModel {
     title?: LocalizedKey;
     text: LocalizedKey;
@@ -59,7 +66,7 @@ export interface CommonEditorWithPlaceholder {
  * @value textEditor
  * @description Enable users to input data from mobile app
  * @label Text input
- * @fieldOrders ['title', 'keyboardType', 'placeholder', 'mandatory', 'multiline']
+ * @fieldOrders ['title', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -104,7 +111,7 @@ export interface TextEditorFeaturesModel {
  * @value readonlyTextView
  * @description Content for users to read
  * @label Read-only label
- * @fieldOrders ['title', 'text']
+ * @fieldOrders ['title', 'text', 'showIfExpression']
  */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -167,7 +174,7 @@ export interface SubListEditorViewComponentModel extends CommonEditorViewCompone
  * @value attachmentsEditor
  * @description Add a file or photo from a mobile device
  * @label Attachment
- * @fieldOrders ['title', 'mandatory']
+ * @fieldOrders ['title', 'mandatory', 'showIfExpression']
  */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -203,7 +210,7 @@ export interface BodyMapViewComponentModel extends CommonEditorViewComponentMode
  * @value signatureEditor
  * @description Capture a signature on a mobile device
  * @label Signature
- * @fieldOrders ['title', 'enableFullName']
+ * @fieldOrders ['title', 'enableFullName', 'showIfExpression']
  */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -231,7 +238,7 @@ export interface SignatureEditorViewComponentModel extends CommonEditorViewCompo
  * @value toggleEditor
  * @description Switch between two opposing states
  * @label Toggle
- * @fieldOrders []
+ * @fieldOrders ['showIfExpression']
  */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
     /**
@@ -276,7 +283,7 @@ export interface ToggleEditorItemModel {
  * @value dateTimeEditor
  * @description Allow selecting date and time
  * @label Date & time
- * @fieldOrders ['title', 'placeholder' ,'mandatory']
+ * @fieldOrders ['title', 'placeholder' ,'mandatory', 'showIfExpression']
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     /**
@@ -364,6 +371,9 @@ export interface MenuListItem extends BaseFlatPageViewComponentModel {
      * @label Badge Text
      */
     badgeText: LocalizedKey;
+    /**
+     * @label Icon
+     */
     icon?: IconName;
 }
 export interface BaseSelectEditor {
@@ -441,7 +451,7 @@ export interface BaseSelectEditor {
  * @value selectEditor
  * @description Select a single item from a list
  * @label Drop down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options']
+ * @fieldOrders ['title', 'placeholder', 'mandatory', 'options', 'showIfExpression']
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     /**
@@ -465,7 +475,7 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
  * @value multiSelectEditor
  * @description Select one or more items from a list
  * @label Multi-select drop down
- * @fieldOrders ['title', 'placeholder', 'mandatory', 'options']
+ * @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.15.3",
+  "version": "1.16.0",
   "engines": {
     "node": "18"
   },