@skedulo/mex-types 1.3.9 → 1.3.11

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,58 +36,136 @@ 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;
 };
+/**
+ * @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;
     /**
@@ -101,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'},
@@ -114,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;AAwID,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skedulo/mex-types",
-  "version": "1.3.9",
+  "version": "1.3.11",
   "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"
   },