@skedulo/mex-types 1.3.10 → 1.3.12

package/dist/common/BaseComponentModel.d.ts

@@ -1,3 +1,6 @@
 export interface BaseComponentModel {
+    /**
+     * @label Type
+     */
     type: string;
 }

package/dist/common/CommonTypes.d.ts

@@ -14,7 +14,13 @@ export type ImageDefinition = {
     name: string;
 };
 export type ListPageAddNewDefaultDataType = {
+    /**
+     * @label Object name
+     */
     objectName: string;
+    /**
+     * @label Data
+     */
     data: any;
 } & any;
 export type RoutingType = string | RoutingPageDef;
@@ -33,8 +39,32 @@ export type Routing = {
     transferData?: any;
 };
 export interface ButtonGroupItemComponentModel {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
+    /**
+     * @label Theme
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Success', value: 'success'},
+     *  {label: 'Primary', value: 'primary'},
+     *  {label: 'Default', value: 'default'}
+     * ]
+     */
     theme?: SkedButtonTheme;
+    /**
+     * @label Behavior
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Custom', value: 'custom'},
+     *  {label: 'SMS', value: 'sms'},
+     *  {label: 'Phone', value: 'phone'},
+     *  {label: 'Open URL', value: 'openUrl'},
+     *  {label: 'Email', value: 'email'},
+     *  {label: 'Open Selector', value: 'openSelector'}
+     * ]
+     */
     behavior: ButtonBehaviorComponentModel;
 }
 export interface ButtonBehaviorComponentModel {

package/dist/common/MexDefs.d.ts

@@ -9,7 +9,7 @@ export declare enum DefStatus {
     /**
      * Just uploaded, not in use
      */
-    Pending = "Pending",
+    Draft = "Draft",
     /**
      * Build succed
      */
@@ -36,10 +36,30 @@ export declare enum DefStatus {
     Failed = "Failed"
 }
 type MexBaseMetadata = {
+    /**
+     * @label Summary
+     */
     summary?: string;
+    /**
+     * @label Email
+     * @hidden true
+     */
     email?: string;
+    /**
+     * @label Mobile display order
+     * @tooltip Please choose a number to determine the display priority of the form within the mobile app. A higher number will result in a lower display position for the form in the mobile app
+     * @hidden true
+     */
     displayOrder: number;
+    /**
+     * @label Attachment destination
+     * @placeholder Enter object name
+     * @tooltip Provide the name of the object where you intend to store attachments when using the Attachments component in this form
+     */
     hasAttachments?: string[];
+    /**
+     * @label Static resources
+     */
     staticResourcesId?: string;
     [key: string]: any;
 };
@@ -47,53 +67,105 @@ type MexBaseMetadata = {
  * @area Metadata
  */
 interface MexMetadataForJob extends MexBaseMetadata {
+    /**
+     * @label Form type
+     * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
+     * @tooltip A global form will display in the user profile page
+     * @dataType singleselect
+     * @readonly true
+     */
     contextObject: 'Jobs';
+    /**
+     * @label ShowIf expression
+     */
     showIf?: string;
+    /**
+     * @label MandatoryIf
+     */
     mandatoryIf?: string;
+    /**
+     * @label Mandatory expression
+     */
     mandatoryExpression?: string;
 }
 /**
  * @area Metadata
  */
 interface MexMetadataForResource extends MexBaseMetadata {
+    /**
+     * @label Form type
+     * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
+     * @tooltip A global form will display in the user profile page
+     * @dataType singleselect
+     * @readonly true
+     */
     contextObject: 'Resources';
 }
 export interface MexMetadataFormBuilder extends MexBaseMetadata {
     /**
-     * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Resources', value: 'Resources'}]
+     * @label Form type
+     * @options [{label: 'Jobs', value: 'Jobs'}, {label: 'Global', value: 'Resources'}]
+     * @tooltip A global form will display in the user profile page
      * @dataType singleselect
+     * @readonly true
      */
     contextObject: 'Jobs' | 'Resources';
 }
 export type MexMetadataPayload = MexMetadataForJob | MexMetadataForResource;
 /**
+ * @area area
+ * @label UID
+ * @readonly true
+ * @requried true
+ * @options [{label: 'UID', value: 'uid'}]
+ * @placeholder Please input the value
+ * @tooltip Explain more details for this field
+ * @hidden true
+ * @readonly true
+ * @min 0
+ * @max 999
+ * @minLength 0
+ * @maxLength 20
+ * @limitItems 10
+ * @typeAdhoc singleselect
+ */
+/**
+ * MexDef
  * @area MexDef
  * @outputType object
  */
 export interface MexDef {
     /**
      * Auto generated UID
+     * @hidden true
      */
     uid: string;
     /**
-     * Tenant Id
+     * @hidden true
      */
     tenantId: string;
     /**
      * Form definition name
+     * @label Form name
+     * @minLength 0
+     * @maxLength 999
      */
     name: string;
     /**
      * The definition id, will be generated for the first time.
      * It is used for definition update action
+     * @label Form ID
+     * @readonly true
      */
     defId: string;
     /**
      * A long number version value, [defId - version] is unique pair
+     * @hidden true
      */
     version: number;
     /**
      * Semver version of compatible engine version
+     * @hidden true
      */
     engineVersion: string;
     /**
@@ -107,12 +179,14 @@ export interface MexDef {
     /**
      * Similar to formdef, but it stores the formdef value after validating, for example:
      * a customFunctionMetadata should be an aws lambda arn instead of a pure js function
+     * @hidden true
      */
     internalMetadata?: InternalFormDef;
     /**
      * Form definition status
+     * @readonly true
      * @options [
-     * {label: 'Pending', value: 'Pending'},
+     * {label: 'Draft', value: 'Draft'},
      * {label: 'Validated', value: 'Validated'},
      * {label: 'Installed', value: 'Installed'},
      * {label: 'Deactivated', value: 'Deactivated'},
@@ -120,31 +194,36 @@ export interface MexDef {
      * {label: 'InstallInProgress', value: 'InstallInProgress'},
      * {label: 'Failed', value: 'Failed'}
      * ]
-     *
+     * @label Status
      * @dataType singleselect
      */
     status: DefStatus;
     /**
      * Form uploaded timestamp
      * @dataType datetime
+     * @hidden true
      */
     uploadedAt: Date;
     /**
      * Form installed timestamp
      * @dataType datetime
+     * @hidden true
      */
     installedAt?: Date;
     /**
      * Form built timestamp
      * @dataType datetime
+     * @hidden true
      */
     builtAt?: Date;
     /**
      * This form definition has been uploaded by
+     * @hidden true
      */
     uploadedBy: string;
     /**
      * This form definition has been installed by
+     * @hidden true
      */
     installedBy?: string;
 }

package/dist/common/MexDefs.js

@@ -13,7 +13,7 @@ var DefStatus;
     /**
      * Just uploaded, not in use
      */
-    DefStatus["Pending"] = "Pending";
+    DefStatus["Draft"] = "Draft";
     /**
      * Build succed
      */

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

package/dist/page/PageComponentModel.d.ts

@@ -7,7 +7,16 @@ import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
  * @area formProperties
  */
 export type UIDefinition = {
+    /**
+     * @label First page
+     * @placeholder Enter a page name
+     * @tooltip Enter the name of the page you want to set as the initial page for the form
+     */
     firstPage: string;
+    /**
+     * @label Readonly
+     * @tooltip If true, the entire form will be shown in read-only mode within the mobile app
+     */
     readonly?: boolean;
     pages: AllPageComponentModel[];
 };

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -3,41 +3,89 @@ import { ButtonGroupItemComponentModel, DataExpressionType, FunctionExpressionTy
 import { SelectPageOnlineSource, SelectPageSearchBarConfig } from './SearchPage';
 import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
 export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
+    /**
+     * @label Show if expression
+     * @placeholder Enter expression
+     */
     showIfExpression: DataExpressionType;
 }
 export type KeyboardType = 'default' | 'email-address' | 'numeric' | 'phone-pad' | 'number-pad' | 'decimal-pad';
 export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator?: ValidatorDefinitionModel;
     /**
-     * @typeAdhoc DataExpressionType
+     * @label Mandatory
+     * @typeAdhoc boolean
      */
     mandatory?: boolean | DataExpressionType;
     /**
-     * @typeAdhoc DataExpressionType
+     * @label Readonly
+     * @typeAdhoc boolean
      */
     readonly?: boolean | DataExpressionType;
+    /**
+     * @label Editor events
+     */
     editorEvents?: CommonEditorEvents;
 }
 export interface CommonEditorEvents {
+    /**
+     * @label On value changed
+     * @placeholder Enter expression
+     */
     onValueChanged?: FunctionExpressionType;
 }
 export interface CommonEditorWithPlaceholder {
+    /**
+     * @label Placeholder
+     */
     placeholder: LocalizedKey;
 }
 /**
  * @area Components
  */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * TODO: need no enhance to remove typeAdhoc
+     * @label Keyboard type
+     * @typeAdhoc singleselect
+     * @options [
+     *  {label: 'Default', value: 'default'},
+     *  {label: 'Email address', value: 'email-address'},
+     *  {label: 'Numeric', value: 'numeric'},
+     *  {label: 'Phone pad', value: 'phone-pad'},
+     *  {label: 'Number pad', value: 'number-pad'},
+     *  {label: 'Decimal pad', value: 'decimal-pad'}
+     * ]
+     */
     keyboardType?: KeyboardType;
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * @label Editable
+     */
     editable?: boolean;
+    /**
+     * @label Multiline
+     */
     multiline?: boolean;
 }
 /**
  * @area Components
  */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
 }
 export type SkedButtonTheme = 'success' | 'primary' | 'default';
@@ -51,63 +99,160 @@ export interface ButtonGroupViewComponentModel extends BaseFlatPageViewComponent
  * @area Components
  */
 export interface SubListEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Add New button
+     */
     addNew: {
+        /**
+         * @label Text
+         */
         text: string;
+        /**
+         * @label Destination page
+         */
         destinationPage: string;
+        /**
+         * @label Default data
+         */
         defaultData: ListPageAddNewDefaultDataType;
     };
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Empty text
+     */
     emptyText: LocalizedKey;
+    /**
+     * @label Item layout
+     */
     itemLayout: BaseSublistViewComponentModel;
+    /**
+     * TODO: handle for remove typeAdhoc for union type
+     * @label Item click destination
+     * @typeAdhoc string
+     */
     itemClickDestination: RoutingType;
 }
 /**
  * @area Components
  */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
 }
 /**
  * @area Components
  */
 export interface BodyMapViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
 }
 /**
  * @area Components
  */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Attachment category name
+     */
     attachmentCategoryName: string;
+    /**
+     * @label Enable full name
+     */
     enableFullName: true;
 }
 /**
  * @area Components
  */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
+    /**
+     * @label Items
+     */
     items: ToggleEditorItemModel[];
+    /**
+     * @label Mode
+     */
     mode: 'radio' | 'checkbox' | 'switch';
 }
 export interface ToggleEditorItemModel {
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * @label On Value
+     */
     onValue: any;
+    /**
+     * @label Off Value
+     */
     offValue: any;
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
 }
 /**
  * @area Components
  */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
+    /**
+     * @label Mode
+     * @typeAdhoc singleselect
+     * @options [
+     * {label: 'Date and time', value: 'datetime'},
+     * {label: 'Date', value: 'date'},
+     * {label: 'Time', value: 'time'}
+     * ]
+     */
     mode: 'datetime' | 'date' | 'time';
+    /**
+     * @label Date time options
+     */
     datetimeOptions?: {
+        /**
+         * @label Timezone
+         */
         timezone?: TimezoneType;
     };
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
 }
 export interface BaseSublistViewComponentModel extends BaseComponentModel {
@@ -116,9 +261,21 @@ export interface BaseSublistViewComponentModel extends BaseComponentModel {
  * @area Components
  */
 export interface SectionViewComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Body
+     */
     body: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * @label items
+     */
     items: BaseFlatPageViewComponentModel[];
 }
 /**
@@ -128,22 +285,69 @@ export interface MenuListViewComponentModel extends BaseFlatPageViewComponentMod
     items: MenuListItem[];
 }
 export interface MenuListItem extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Text
+     */
     text: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type
+     * @label Item click destination
+     * @typeAdhoc string
+     */
     itemClickDestination: RoutingType;
+    /**
+     * @label Badge Text
+     */
     badgeText: LocalizedKey;
 }
 export interface BaseSelectEditor {
+    /**
+     * @label Structure expression
+     */
     structureExpression: DataExpressionType;
+    /**
+     * @label Source expression
+     */
     sourceExpression: DataExpressionType;
+    /**
+     * @label Display expression
+     */
     displayExpression: DataExpressionType;
+    /**
+     * @label Filter expression
+     */
     filterExpression: DataExpressionType;
+    /**
+     * @label Online source
+     */
     onlineSource?: SelectPageOnlineSource;
+    /**
+     * @label Select page
+     */
     selectPage: {
+        /**
+         * @label Item title
+         */
         itemTitle: LocalizedKey;
+        /**
+         * @label Item caption
+         */
         itemCaption: LocalizedKey;
+        /**
+         * @label Empty text
+         */
         emptyText: LocalizedKey;
+        /**
+         * @label Title
+         */
         title: LocalizedKey;
+        /**
+         * @label searchBar
+         */
         searchBar: SelectPageSearchBarConfig;
     };
 }
@@ -151,9 +355,23 @@ export interface BaseSelectEditor {
  * @area Components
  */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * @label Value expression
+     */
     valueExpression: DataExpressionType;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
+    /**
+     * @label Construct result object
+     */
     constructResultObject?: ConstructResultObject;
 }
 /**
@@ -162,34 +380,83 @@ export interface SelectEditorViewComponentModel extends CommonEditorViewComponen
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     displayDataInSearchPageExpression: DataExpressionType;
     constructResultObject: ConstructResultObject;
+    /**
+     * TODO: Remove typeAdhoc for union type, and dynamic form need to support Array of object
+     * @label Validator
+     * @typeAdhoc BaseValidatorModel
+     */
     validator: ValidatorDefinitionModel;
 }
 export interface ConstructResultObject {
+    /**
+     * @label Data
+     */
     data: OneLevelBindingObject;
+    /**
+     * @label Object name
+     */
     objectName: string;
+    /**
+     * @label Compare property
+     */
     compareProperty: string;
 }
 /**
  * @area Components
  */
 export interface ContactDetailsLayoutComponentModel extends BaseFlatPageViewComponentModel {
+    /**
+     * @label Title
+     */
     title: LocalizedKey;
+    /**
+     * @label Caption
+     */
     caption: LocalizedKey;
+    /**
+     * TODO: Remove typeAdhoc for union type
+     * @label Contact methods
+     * @typeAdhoc any
+     */
     contactMethods: [ContactPhoneMethodModel | ContactSmsMethodModel];
+    /**
+     * @label Profile image
+     */
     profileImage: {
+        /**
+         * @label Name expression
+         */
         nameExpression: DataExpressionType;
+        /**
+         * @label Url expression
+         */
         urlExpression: DataExpressionType;
     };
 }
 export interface ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: ContactMethodType;
 }
 export type ContactMethodType = 'phone' | 'sms';
 export interface ContactPhoneMethodModel extends ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: 'phone';
+    /**
+     * @label Phone number expression
+     */
     phoneNumberExpression: DataExpressionType;
 }
 export interface ContactSmsMethodModel extends ContactMethodModel {
+    /**
+     * @label Type
+     */
     type: 'sms';
+    /**
+     * @label Phone number expression
+     */
     phoneNumberExpression: DataExpressionType;
 }

package/dist/view/SearchPage.d.ts

@@ -1,9 +1,21 @@
 import { DataExpressionType, LocalizedKey, OneLevelBindingObject } from '../common/CommonTypes';
 export type SelectPageOnlineSource = {
+    /**
+     * @label Key
+     */
     key: DataExpressionType;
+    /**
+     * @label Variables
+     */
     variables: OneLevelBindingObject;
 };
 export type SelectPageSearchBarConfig = {
+    /**
+     * @label Filter on properties
+     */
     filterOnProperties: string[];
+    /**
+     * @label Placeholder
+     */
     placeholder: LocalizedKey;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skedulo/mex-types",
-  "version": "1.3.10",
+  "version": "1.3.12",
   "engines": {
     "node": "18"
   },
@@ -18,6 +18,7 @@
     "run-parser": "ts-node-dev --transpile-only scripts/type-defs-parser.ts",
     "run-references-resolver": "ts-node-dev scripts/references-resolver.ts",
     "run-transform": "ts-node-dev scripts/transform.ts",
+    "build-json": "yarn run-parser && yarn run-references-resolver && yarn run-transform",
     "get-semver": "ts-node-dev scripts/get-semver.ts",
     "save-parser": "ts-node-dev scripts/save-parser-to-backend.ts"
   },