@skedulo/mex-types 1.2.2 → 1.3.0

package/README.md

@@ -80,5 +80,6 @@ The table below shows which commit message gets you which release type when **se
 - If add new property, interface, type defs,  must release in minor type
 - Break change (TBD)
 
-
+### Trigger release manually
+Please follow this [guidelines](https://skedulo.atlassian.net/wiki/spaces/RS/pages/2647785497/Mex-Types+Trigger+release+pipeline) to trigger release manually
 

package/dist/common/CommonTypes.d.ts

@@ -57,7 +57,7 @@ export interface EmailButtonBehaviorComponentModel extends ButtonBehaviorCompone
 }
 export type SelectPageConfig = {
     searchBar: {
-        filterOnProperties: string[] | undefined;
+        filterOnProperties?: string[];
         placeholder: LocalizedKey;
     };
     itemCaption: LocalizedKey;
@@ -65,14 +65,14 @@ export type SelectPageConfig = {
     dataSourceExpression: DataExpressionType;
     emptyText: LocalizedKey;
     filterExpression?: DataExpressionType;
-    singleSelectionConfig: {
+    singleSelectionConfig?: {
         dismissPageAfterChosen: boolean;
-    } | undefined;
+    };
     isMultiSelect?: boolean;
-    header: {
+    header?: {
         title: LocalizedKey;
         hasClearBtn: boolean;
-    } | undefined;
+    };
     onlineSource?: SelectPageOnlineSource;
     selectedDataExpression?: DataExpressionType;
 };

package/dist/common/MexDefs.d.ts

@@ -0,0 +1,198 @@
+import { UIDefinition } from 'src/page';
+/**
+ * Form definition status.
+ * State flow:
+ * - Pending -> BuildInProgress -> Validated/Failed -> InstallInProgress -> Installed/Failed
+ * - Pending -> ... -> Deactivated
+ */
+export declare enum DefStatus {
+    /**
+     * Just uploaded, not in use
+     */
+    Pending = "Pending",
+    /**
+     * Build succed
+     */
+    Validated = "Validated",
+    /**
+     * Form has been installed, already in use
+     */
+    Installed = "Installed",
+    /**
+     * This form has been deactivated
+     */
+    Deactivated = "Deactivated",
+    /**
+     * The form build and validation are in progress
+     */
+    BuildInProgress = "BuildInProgress",
+    /**
+     * The form installation is in progress
+     */
+    InstallInProgress = "InstallInProgress",
+    /**
+     * This form has been failed by any reason
+     */
+    Failed = "Failed"
+}
+/**
+ * @area formDefs
+ */
+export interface MexDef {
+    /**
+     * Auto generated UID
+     */
+    uid: string;
+    /**
+     * Tenant Id
+     */
+    tenantId: string;
+    /**
+     * Form definition name
+     */
+    name: string;
+    /**
+     * The definition id, will be generated for the first time.
+     * It is used for definition update action
+     */
+    defId: string;
+    /**
+     * A long number version value, [defId - version] is unique pair
+     */
+    version: number;
+    /**
+     * Semver version of compatible engine version
+     */
+    engineVersion: string;
+    /**
+     * Form definition metadata in JSON format
+     */
+    metadata: any;
+    /**
+     * Form definition information
+     */
+    formdef: FormDef;
+    /**
+     * 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
+     */
+    internalMetadata?: InternalFormDef;
+    /**
+     * Form definition status
+     */
+    status: DefStatus;
+    /**
+     * Form uploaded timestamp
+     */
+    uploadedAt: Date;
+    /**
+     * Form installed timestamp
+     */
+    installedAt?: Date;
+    /**
+     * Form built timestamp
+     */
+    builtAt?: Date;
+    /**
+     * This form definition has been uploaded by
+     */
+    uploadedBy: string;
+    /**
+     * This form definition has been installed by
+     */
+    installedBy?: string;
+}
+export type MexFetchPayload = GraphQlRequestPayload | CustomFetchPayload | UnknownFetchPayload;
+export type UnknownFetchPayload = {
+    [key: string]: any;
+};
+export type CustomFetchPayload = {
+    type: FetchRequestType.CUSTOM;
+    variables?: Variables;
+};
+export type GraphQlRequestPayload = {
+    type: FetchRequestType.GRAPHQL;
+    [key: string]: any;
+};
+export declare enum FetchRequestType {
+    GRAPHQL = "GraphQl",
+    CUSTOM = "CUSTOM"
+}
+export type Variables = {
+    [variable: string]: string;
+};
+export type MexInstanceSavePayload = {
+    type: FetchRequestType.CUSTOM;
+    variables?: Variables;
+};
+export interface MexMetadataPayload {
+    [key: string]: unknown;
+}
+export type CustomFunctionFeatures = {
+    fetchFunction?: boolean;
+    saveFunction?: boolean;
+    validateFunction?: boolean;
+    staticFunction?: boolean;
+    searchFunction?: boolean;
+};
+export type CustomFunctionMetadataType = {
+    libVersion?: string;
+    has: CustomFunctionFeatures;
+    arn: string;
+    [others: string]: any;
+};
+export interface InternalFormDef {
+    /**
+     * Custom function metadata
+     */
+    customFunctionMetadata?: CustomFunctionMetadataType;
+    /**
+     * The custom function built of this Mex Def which uploaded by Dev
+     * It should be just a file name on S3
+     */
+    customFunctionBuild?: any;
+    /**
+     * The custom function source of this Mex Def which uploaded by Dev.
+     * It should be just a file name on S3
+     */
+    customFunctionSource?: string;
+    /**
+     * Some more detail information in the special cases such as: Mex definition build failed
+     */
+    detailInformation?: string;
+}
+export interface FormDef {
+    /**
+     * Form definition UI. In JSON format
+     */
+    ui: UIDefinition;
+    /**
+     * Static fetch configuration. In JSON format
+     */
+    staticFetch: MexFetchPayload;
+    /**
+     * Instance fetch configuration. In JSON format
+     */
+    instanceFetch: MexFetchPayload;
+    /**
+     * Instance save parameters. Normally will be used in the custom save methods
+     */
+    instanceSave?: MexInstanceSavePayload;
+    /**
+     * A pure bundled javascript file for frontend side
+     */
+    feCustomFunction?: string;
+    /**
+     * Online search details
+     */
+    searchDefinition?: MexSearchPayload;
+}
+export type MexSearchPayload = {
+    type: FetchRequestType;
+} & {
+    [label: string]: {
+        object: string;
+        fields: string[];
+        filter?: string;
+    };
+};

package/dist/common/MexDefs.js

@@ -0,0 +1,47 @@
+"use strict";
+// 10:40 Copy from native-form-backend 10/10/2023
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchRequestType = exports.DefStatus = void 0;
+/**
+ * Form definition status.
+ * State flow:
+ * - Pending -> BuildInProgress -> Validated/Failed -> InstallInProgress -> Installed/Failed
+ * - Pending -> ... -> Deactivated
+ */
+var DefStatus;
+(function (DefStatus) {
+    /**
+     * Just uploaded, not in use
+     */
+    DefStatus["Pending"] = "Pending";
+    /**
+     * Build succed
+     */
+    DefStatus["Validated"] = "Validated";
+    /**
+     * Form has been installed, already in use
+     */
+    DefStatus["Installed"] = "Installed";
+    /**
+     * This form has been deactivated
+     */
+    DefStatus["Deactivated"] = "Deactivated";
+    /**
+     * The form build and validation are in progress
+     */
+    DefStatus["BuildInProgress"] = "BuildInProgress";
+    /**
+     * The form installation is in progress
+     */
+    DefStatus["InstallInProgress"] = "InstallInProgress";
+    /**
+     * This form has been failed by any reason
+     */
+    DefStatus["Failed"] = "Failed";
+})(DefStatus || (exports.DefStatus = DefStatus = {}));
+var FetchRequestType;
+(function (FetchRequestType) {
+    FetchRequestType["GRAPHQL"] = "GraphQl";
+    FetchRequestType["CUSTOM"] = "CUSTOM";
+})(FetchRequestType || (exports.FetchRequestType = FetchRequestType = {}));
+//# sourceMappingURL=MexDefs.js.map

package/dist/common/MexDefs.js.map

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

package/dist/page/PageComponentModel.d.ts

@@ -3,19 +3,27 @@ import { BaseListPageViewComponentModel } from '../view/ListPageViewComponentMod
 import { BaseComponentModel } from '../common/BaseComponentModel';
 import { BaseFlatPageViewComponentModel } from '../view/FlatPageViewComponentModel';
 import { ValidatorDefinitionModel } from '../validator/ValidatorModel';
+/**
+ * @area formProperties
+ */
 export type UIDefinition = {
     firstPage: string;
-    readonly: boolean | undefined;
+    readonly?: boolean;
     pages: AllPageComponentModel[];
 };
 export interface BasePageComponentModel extends BaseComponentModel {
-    title: LocalizedKey | undefined;
-    pageDataExpression: DataExpressionType | undefined;
+    title?: LocalizedKey;
+    pageDataExpression?: DataExpressionType;
     wipeExistingData: boolean;
     defaultPageData: DefaultPageData;
+    events?: {
+        onInitialized?: FunctionExpressionType;
+        onPreDataSave?: FunctionExpressionType;
+        onPreDataLoad?: FunctionExpressionType;
+    };
 }
 export type DefaultPageData = {
-    objectName: string | undefined;
+    objectName?: string;
     data: OneLevelBindingObject;
 };
 export type AddNewButtonData = {
@@ -24,6 +32,9 @@ export type AddNewButtonData = {
     defaultData: ListPageAddNewDefaultDataType;
     showIfExpression: DataExpressionType;
 };
+/**
+ * @area pageComponent
+ */
 export interface ListPageComponentModel extends BasePageComponentModel {
     headerTitle?: LocalizedKey;
     headerDescription?: LocalizedKey;
@@ -33,7 +44,7 @@ export interface ListPageComponentModel extends BasePageComponentModel {
     search?: ListPageSearchComponentModel;
     emptyText: LocalizedKey;
     itemLayout: BaseListPageViewComponentModel;
-    footerText: string | undefined;
+    footerText?: string;
     itemClickDestination: RoutingType;
     hasSection?: ListPageSectionComponentModel;
     orderBy?: OrderByModel;
@@ -63,6 +74,9 @@ export interface OrderByModel {
     expression: OrderByExpressionType;
 }
 export type OrderByExpressionType = string[];
+/**
+ * @area pageComponent
+ */
 export interface FlatPageComponentModel extends BasePageComponentModel {
     delete: {
         canDeleteExpression: DataExpressionType;
@@ -79,13 +93,12 @@ export interface FlatPageComponentModel extends BasePageComponentModel {
         updateTitle: LocalizedKey;
         insertButtonText: LocalizedKey;
         defaultDataForNewObject: OneLevelBindingObject;
-        validator: ValidatorDefinitionModel | undefined;
+        validator?: ValidatorDefinitionModel;
         readonly: DataExpressionType | boolean;
     };
     items: BaseFlatPageViewComponentModel[];
     description: LocalizedKey;
-    events?: {
-        onInitialized?: FunctionExpressionType;
+    flatPageEvents?: {
         onSubmitted?: FunctionExpressionType;
         onRemoved?: FunctionExpressionType;
     };

package/dist/view/FlatPageViewComponentModel.d.ts

@@ -8,9 +8,9 @@ export interface BaseFlatPageViewComponentModel extends BaseComponentModel {
 export type KeyboardType = 'default' | 'email-address' | 'numeric' | 'phone-pad' | 'number-pad' | 'decimal-pad';
 export interface CommonEditorViewComponentModel extends BaseFlatPageViewComponentModel {
     title: LocalizedKey;
-    validator: ValidatorDefinitionModel | undefined;
-    mandatory: boolean | DataExpressionType | undefined;
-    readonly: boolean | DataExpressionType | undefined;
+    validator?: ValidatorDefinitionModel;
+    mandatory?: boolean | DataExpressionType;
+    readonly?: boolean | DataExpressionType;
     editorEvents?: CommonEditorEvents;
 }
 export interface CommonEditorEvents {
@@ -19,19 +19,31 @@ export interface CommonEditorEvents {
 export interface CommonEditorWithPlaceholder {
     placeholder: LocalizedKey;
 }
+/**
+ * @area viewComponent
+ */
 export interface TextEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
-    keyboardType: KeyboardType | undefined;
+    keyboardType?: KeyboardType;
     valueExpression: DataExpressionType;
-    editable: boolean | undefined;
-    multiline: boolean | undefined;
+    editable?: boolean;
+    multiline?: boolean;
 }
+/**
+ * @area viewComponent
+ */
 export interface ReadonlyTextViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     text: LocalizedKey;
 }
 export type SkedButtonTheme = 'success' | 'primary' | 'default';
+/**
+ * @area viewComponent
+ */
 export interface ButtonGroupViewComponentModel extends BaseFlatPageViewComponentModel, CommonEditorWithPlaceholder {
     items: ButtonGroupItemComponentModel[];
 }
+/**
+ * @area viewComponent
+ */
 export interface SubListEditorViewComponentModel extends CommonEditorViewComponentModel {
     addNew: {
         text: string;
@@ -43,21 +55,33 @@ export interface SubListEditorViewComponentModel extends CommonEditorViewCompone
     itemLayout: BaseSublistViewComponentModel;
     itemClickDestination: RoutingType;
 }
+/**
+ * @area viewComponent
+ */
 export interface AttachmentsEditorViewComponentModel extends CommonEditorViewComponentModel {
     sourceExpression: DataExpressionType;
     title: LocalizedKey;
     attachmentCategoryName: string;
 }
+/**
+ * @area viewComponent
+ */
 export interface BodyMapViewComponentModel extends CommonEditorViewComponentModel {
     sourceExpression: DataExpressionType;
     attachmentCategoryName: string;
 }
+/**
+ * @area viewComponent
+ */
 export interface SignatureEditorViewComponentModel extends CommonEditorViewComponentModel {
     sourceExpression: DataExpressionType;
     title: LocalizedKey;
     attachmentCategoryName: string;
     enableFullName: true;
 }
+/**
+ * @area viewComponent
+ */
 export interface ToggleEditorViewComponentModel extends CommonEditorViewComponentModel {
     title: LocalizedKey;
     validator: ValidatorDefinitionModel;
@@ -70,6 +94,9 @@ export interface ToggleEditorItemModel {
     offValue: any;
     text: LocalizedKey;
 }
+/**
+ * @area viewComponent
+ */
 export interface DateTimePickerViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder {
     mode: 'datetime' | 'date' | 'time';
     datetimeOptions?: {
@@ -79,12 +106,18 @@ export interface DateTimePickerViewComponentModel extends CommonEditorViewCompon
 }
 export interface BaseSublistViewComponentModel extends BaseComponentModel {
 }
+/**
+ * @area viewComponent
+ */
 export interface SectionViewComponentModel extends BaseFlatPageViewComponentModel {
     title: LocalizedKey;
     body: LocalizedKey;
     caption: LocalizedKey;
     items: BaseFlatPageViewComponentModel[];
 }
+/**
+ * @area viewComponent
+ */
 export interface MenuListViewComponentModel extends BaseFlatPageViewComponentModel {
     items: MenuListItem[];
 }
@@ -108,12 +141,18 @@ export interface BaseSelectEditor {
         searchBar: SelectPageSearchBarConfig;
     };
 }
+/**
+ * @area viewComponent
+ */
 export interface SelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     caption: LocalizedKey;
     valueExpression: DataExpressionType;
     validator: ValidatorDefinitionModel;
     constructResultObject?: ConstructResultObject;
 }
+/**
+ * @area viewComponent
+ */
 export interface MultiSelectEditorViewComponentModel extends CommonEditorViewComponentModel, CommonEditorWithPlaceholder, BaseSelectEditor {
     displayDataInSearchPageExpression: DataExpressionType;
     constructResultObject: ConstructResultObject;
@@ -124,6 +163,9 @@ export interface ConstructResultObject {
     objectName: string;
     compareProperty: string;
 }
+/**
+ * @area viewComponent
+ */
 export interface ContactDetailsLayoutComponentModel extends BaseFlatPageViewComponentModel {
     title: LocalizedKey;
     caption: LocalizedKey;

package/dist/view/ListPageViewComponentModel.d.ts

@@ -1,7 +1,7 @@
 import { BaseComponentModel } from '../common/BaseComponentModel';
 import { ValueExpressionType, LocalizedKey } from '../common/CommonTypes';
 export interface BaseListPageViewComponentModel extends BaseComponentModel {
-    useAttachments: UseAttachments | undefined;
+    useAttachments?: UseAttachments;
     tags: ListItemTagModel;
 }
 export interface ListItemTagModel {
@@ -12,11 +12,14 @@ export interface ListItemTagItemModel {
     themeValueExpression: ValueExpressionType;
     text: LocalizedKey;
 }
+/**
+ * @area pageComponent
+ */
 export interface TitleAndCaptionViewComponentModel extends BaseListPageViewComponentModel {
     title: LocalizedKey;
     caption: LocalizedKey;
 }
 export interface UseAttachments {
-    categoryName: string | undefined;
+    categoryName?: string;
     style?: 'singleBig' | 'singleSmall';
 }

package/dist/view/SublistViewComponentModel.d.ts

@@ -5,6 +5,6 @@ interface BaseSublistViewComponentModel extends BaseComponentModel {
 export interface SublistTitleAndCaptionViewComponentModel extends BaseSublistViewComponentModel {
     title: LocalizedKey;
     caption: LocalizedKey;
-    image?: ImageDefinition | undefined;
+    image?: ImageDefinition;
 }
 export {};

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@skedulo/mex-types",
+  "version": "1.3.0",
+  "engines": {
+    "node": "18"
+  },
   "description": "A central repository store for all the interfaces, type definitions of MEX engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "version": "1.2.2",
   "scripts": {
     "bootstrap": "rm -rf node_modules && yarn install --pure-lockfile --peer",
     "lint": "tslint 'src/**/*.ts'",
@@ -11,7 +14,12 @@
     "build": "npm run compile",
     "clean": "rm -rf tsconfig.tsbuildinfo dist coverage",
     "commit": "npx cz",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "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",
+    "get-semver": "ts-node-dev scripts/get-semver.ts",
+    "save-parser": "ts-node-dev scripts/save-parser-to-backend.ts"
   },
   "files": [
     "dist/",
@@ -31,12 +39,15 @@
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
+    "@types/node": "^20.5.7",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
+    "prettier": "^3.0.3",
+    "semantic-release": "^21.1.1",
+    "ts-node-dev": "^2.0.0",
     "tslint": "^6.1.3",
     "tslint-microsoft-contrib": "^6.2.0",
-    "typescript": "^5.1.6",
-    "semantic-release": "^21.1.1"
+    "typescript": "^5.1.6"
   },
   "config": {
     "commitizen": {
@@ -45,5 +56,10 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.1",
+    "axios": "^1.5.0",
+    "isolated-vm": "^4.6.0"
   }
 }