@skedulo/mex-types 1.37.1 → 1.39.0

package/dist/common/CommonTypes.d.ts

@@ -265,3 +265,30 @@ export type OnlineDeleteDataQuery = StandardDeleteOnlineDataQuery | CustomOnline
  * @version 1.23.1
  */
 export type OnlineDataQuery = BaseStandardOnlineDataQuery | CustomOnlineDataQuery;
+/**
+ * @version 1.14.8
+ */
+export interface SkedRemoteImage {
+    /**
+     * @version 1.14.8
+     * @description: Fetching list attachments then use filterExpression to get only 1 to display
+     */
+    singleAttachment?: {
+        parentId: DataExpressionType;
+        filterExpression: DataExpressionType;
+    };
+    /**
+     * @description: Fetching image from a Skedulo FilePtr
+     */
+    filePtr?: DataExpressionType;
+    /**
+     * @version: 1.14.x
+     * @description: Fetching image from an absolute url
+     */
+    imageUrl?: DataExpressionType;
+    /**
+     * @version: 1.14.x
+     * @description: Fetching image from a user id, this approach will fetch resource profile picture
+     */
+    profilePicFromUserId?: DataExpressionType;
+}

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -1,5 +1,5 @@
 import { BaseComponentModel } from '../common/BaseComponentModel';
-import { ButtonGroupItemComponentModel, DataExpressionType, DynamicContent, FunctionExpressionType, GroupByFeatureModel, IconName, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OrderByModel, RoutingType, TimezoneType, ValueExpressionType } from '../common/CommonTypes';
+import { ButtonGroupItemComponentModel, DataExpressionType, DynamicContent, FunctionExpressionType, GroupByFeatureModel, IconName, ListPageAddNewDefaultDataType, LocalizedKey, OneLevelBindingObject, OrderByModel, RoutingType, SkedRemoteImage, TimezoneType, ValueExpressionType } from '../common/CommonTypes';
 import { SelectPageOnlineSource, SelectPageSearchBarConfig } from './SearchPage';
 import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
 export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
@@ -9,7 +9,7 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
      */
     showIfExpression?: DataExpressionType;
 }
-export type FlatPageViewComponentTypes = TextViewComponentModel | TextEditorViewComponentModel | ReadonlyTextViewComponentModel | ButtonGroupViewComponentModel | AttachmentsEditorViewComponentModel | SignatureEditorViewComponentModel | ToggleEditorViewComponentModel | DateTimePickerViewComponentModel | SectionViewComponentModel | MenuListViewComponentModel | SelectEditorViewComponentModel | MultiSelectEditorViewComponentModel | ChartViewComponentTypes | AddressSelectEditorViewComponentModel;
+export type FlatPageViewComponentTypes = TextViewComponentModel | TextEditorViewComponentModel | TextAreaEditorViewComponentModel | ReadonlyTextViewComponentModel | ButtonGroupViewComponentModel | AttachmentsEditorViewComponentModel | SignatureEditorViewComponentModel | ToggleEditorViewComponentModel | DateTimePickerViewComponentModel | SectionViewComponentModel | MenuListViewComponentModel | SelectEditorViewComponentModel | MultiSelectEditorViewComponentModel | ChartViewComponentTypes | AddressSelectEditorViewComponentModel | ImageViewComponentModel;
 /**
  * @area Components
  * @value textView
@@ -17,12 +17,7 @@ export type FlatPageViewComponentTypes = TextViewComponentModel | TextEditorView
  * @label Read-only
  * @fieldOrders ['title', 'caption', 'text', 'showIfExpression']
  */
-export interface TextViewComponentModel extends BaseFlatPageViewComponentModel {
-    /**
-     * @label Heading
-     * @tooltip Text added here will be shown as the header of the paragraph
-     */
-    title?: LocalizedKey;
+export interface TextViewComponentModel extends BaseViewOnlyComponentModel {
     /**
      * @typeAdhoc textarea
      * @label Text to display
@@ -31,6 +26,20 @@ export interface TextViewComponentModel extends BaseFlatPageViewComponentModel {
     text: LocalizedKey;
     type: 'textView';
 }
+/**
+ * @version 1.14.8
+ */
+export interface ImageViewComponentModel extends BaseViewOnlyComponentModel {
+    type: 'imageView';
+    image: SkedRemoteImage;
+    aspectRatio?: number;
+}
+/**
+ * @version 1.14.8
+ */
+export interface BaseViewOnlyComponentModel extends BaseFlatPageViewComponentModel {
+    title: LocalizedKey;
+}
 export type KeyboardType = 'default' | 'email-address' | 'numeric' | 'phone-pad' | 'number-pad' | 'decimal-pad';
 export type TextEditorDataType = 'string' | 'integer' | 'decimal';
 export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponentModel {
@@ -85,9 +94,9 @@ export interface WithTitle {
 /**
  * @area Components
  * @value textEditor
- * @description Enable users to input data from mobile app
+ * @description Standard single line text entry field
  * @label Text input
- * @fieldOrders ['title', 'caption', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
+ * @fieldOrders ['title', 'caption', 'keyboardType', 'placeholder', 'mandatory', 'showIfExpression']
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, WithPlaceholder, WithTitle {
     /**
@@ -131,6 +140,15 @@ export interface TextEditorViewComponentModel extends CommonEditorViewComponentM
      */
     leftSymbol: LocalizedKey;
 }
+/**
+ * @area Components
+ * @value textAreaEditor
+ * @description Multiline text entry field
+ * @label Text area
+ * @fieldOrders ['title', 'caption', 'keyboardType', 'placeholder', 'mandatory', 'multiline', 'showIfExpression']
+ */
+export interface TextAreaEditorViewComponentModel extends TextEditorViewComponentModel {
+}
 export interface TextEditorFeaturesModel {
     /**
      * @label: Use Barcode and QR Scanner
@@ -658,7 +676,7 @@ export type ChartTypeTheme = 'default' | 'success' | 'primary' | 'danger' | 'war
 /**
  * @version 1.12.0
  */
-export interface ChartViewComponentModel extends BaseFlatPageViewComponentModel {
+export interface ChartViewComponentModel extends BaseViewOnlyComponentModel {
     type: 'chart';
     chartType: ChartType;
     colorDescriptor?: ChartColorDescriptorModel[];

package/dist/view/ListPageViewComponentModel.d.ts

@@ -1,5 +1,5 @@
 import { BaseComponentModel } from '../common/BaseComponentModel';
-import { DataExpressionType, LocalizedKey } from '../common/CommonTypes';
+import { LocalizedKey, SkedRemoteImage } from '../common/CommonTypes';
 import { TagModel } from '../page';
 export interface BaseListPageViewComponentModel extends BaseComponentModel {
     /**
@@ -19,23 +19,7 @@ export interface TitleAndCaptionViewComponentModel extends BaseListPageViewCompo
     headerContent?: ListItemHeaderContent;
 }
 export interface ListItemHeaderContent {
-    image?: SkedRemoteAttachment;
-}
-export interface SkedRemoteAttachment {
-    /**
-     * @description: Fetching image from a Skedulo FilePtr
-     */
-    filePtr?: DataExpressionType;
-    /**
-     * @version: 1.14.x
-     * @description: Fetching image from an absolute url
-     */
-    imageUrl?: DataExpressionType;
-    /**
-     * @version: 1.14.x
-     * @description: Fetching image from a user id, this approach will fetch resource profile picture
-     */
-    profilePicFromUserId?: DataExpressionType;
+    image?: SkedRemoteImage;
 }
 export interface UseAttachments {
     /**

package/package.json

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