@resconet/jsbridge 14.2.0 → 15.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resconet/jsbridge",
-  "version": "14.2.0",
+  "version": "15.1.1",
   "main": "./src/JSBridge.js",
   "types": "./src/JSBridge.d.ts",
   "description": "Install npm JSBridge module",

package/src/JSBridge.d.ts

@@ -1,6 +1,6 @@
 // JSBridge.js TypeScript definition file
-// v13.1
-// (c) 2020 Resco
+// v15.1
+// (c) 2022 Resco
 
 declare module MobileCRM {
 
@@ -53,7 +53,9 @@ declare module MobileCRM {
     
     class Settings {
         /**Gets the absolute URL (including the CrmOrganization).*/
-        absoluteUrl: string;
+		absoluteUrl: string;
+		/**Gets or sets the currently selected Application ID.*/
+		activeAppID: string;
         /**Gets or sets the last active entity in the ActivityList.*/
         activityListInitialEntity: number;
         /**Gets or sets the application lock state (0=None, 1=Soft, 2=Permanent).*/
@@ -603,6 +605,17 @@ declare module MobileCRM {
 		*/
 		public static email(address: string, subject: string, body: string, errorCallback?: () => void, scope?: any);
 		/**
+		* @since 15.0
+		* Opens the platform-specific e-mail message form with pre-filled data.
+		* @param address Recipients email address.
+		* @param subject An e-mail subject.
+		* @param body A string with email body.
+	    * @param mimeType Body content MIME type.
+		* @param errorCallback The errorCallback which is called asynchronously in case of error.
+		* @param scope The scope for errorCallback.
+		*/
+		public static sendEmail(address: string, subject: string, body: string, mimeType: string, errorCallback?: () => void, scope?: any);
+		/**
 		* @since 9.1
 		* Sends a list of files (full paths or IReferences to blobs) as email attachments.
 		* This method either open the CRM Email form or the native mail client (depending on application settings).
@@ -1422,12 +1435,39 @@ declare module MobileCRM.UI {
 		 */
 		addItemToGrid(gridName: string, item: MobileCRM.UI.DetailViewItems.Item, column?: number, row?: number, colSpan?: number, rowSpan?: number);
 	}
+	/** Represents bulk update item status. */
+	enum BulkUpdateItemStatus {
+		Registered = 0,
+		LoadFailed = 1,
+		Loaded = 2,
+		ValidateFailed = 3,
+		Validated = 4,
+		SaveFailed = 5,
+		Saved = 6,
+	}
+	/** Represents bulk update item.*/
+	interface BulkUpdateItem {
+		/** Record id.*/
+		id: string;
+		/** Holds record. Can be null for records that aren't loaded yet (status Registered or LoadFailed).*/
+		record: DynamicEntity;
+		/** Gets bulk update item status.*/
+		status: BulkUpdateItemStatus;
+		/** Gets human-readable error or warning description.*/
+		statusMessage: string;
+		/** Indicates whether there was an error loading or saving item. */
+		hasError: boolean;
+		/** Indicates whether there item was saved with a warning. */
+		hasWarning: boolean;
+	}
 	/**
 	* Represents the Javascript equivalent of native entity form object.
 	*/
 	class EntityForm {
 		/** Gets the associated views as an array of MobileCRM.UI.IEntityList objects.*/
 		associatedViews: Array<IEntityList>;
+		/** A list of entity records editted on this bulk update form.*/
+		bulkUpdateItems: Array<BulkUpdateItem>;
 		/** Gets whether the form can be edited.*/
 		canEdit: boolean;
 		/** Determines if form can be closed, i.e. there are no unsaved data being edited.*/
@@ -1446,6 +1486,8 @@ declare module MobileCRM.UI {
 		form: Form;
 		/** Carries the custom parameters that can be specified when opening the form using { MobileCRM.UI.FormManager } */
 		iFrameOptions: any;
+		/** Indicates whether the form is bulk update form.*/
+		isBulkUpdateForm: boolean;
 		/** Indicates whether the form  has unsaved data. */
 		isDirty: boolean;
 		/** Defines relationship with parent entity. */
@@ -1467,6 +1509,13 @@ declare module MobileCRM.UI {
 		*/
 		getController(name: string): _Controller;
 		/**
+		* Returns the entity list by its view name.
+		* This method looks for plain associated views but also for controllers that can be flipped into a list (in addition to map or chart).
+		* @param name A name of associated view.
+		* @returns IEntityList
+		*/
+		getEntityList(name: string): IEntityList;
+		/**
 		* Sets the address fields according to the current geo-location from platform-specific location service.
 		* @param latitude The latitude from geo-location from platform-specific location service
 		* @param longitude longitude from geo-location from platform-specific location service
@@ -1556,6 +1605,14 @@ declare module MobileCRM.UI {
 		*/
 		public static onChange(handler: (entityForm: EntityForm) => void, bind: boolean, scope?: any);
 		/**
+		* @since 15.1
+		* Binds or unbinds the handler for onProcessLoaded event on EntityForm.
+		* @param handler The handler function that has to be bound or unbound.
+		* @param bind Determines whether to bind or unbind the handler.
+		* @param scope The scope for callbacks.
+		*/
+		public static onProcessLoaded(handler: (entityForm: EntityForm) => void, bind: boolean, scope?: any);
+		/**
 		* @since 11.2 
 		* Binds or unbinds the handler for specific item change event on EntityForm.
 	    * @param itemName The name of desired detail item (mostly logical name of the field).
@@ -2311,6 +2368,20 @@ declare module MobileCRM.UI {
 		 * @param scope The scope for callback.
 		 */
 		changeProccess(callback: (processReference: MobileCRM.Reference) => void, errorCallback?: (err: string) => void, scope?: any);
+		/**
+		* @since 15.0
+		* Progresses to the next stage of the active process.
+		* @param errorCallback The errorCallback which is called asynchronously in case of error
+		* @param scope The scope for callback.
+		*/
+		MoveToPreviousStage(errorCallback?: (err: string) => void, scope?: any);
+		/**
+		* @since 15.0
+		* Moves to the previous stage of the active process.
+		* @param errorCallback The errorCallback which is called asynchronously in case of error
+		* @param scope The scope for callback.
+		*/
+		MoveToNextStage(errorCallback?: (err: string) => void, scope?: any);
 	}
 
 	class ViewDefinition {
@@ -2359,7 +2430,6 @@ declare module MobileCRM.UI {
 		entities: Array<string>;
 		source: MobileCRM.Relationship;
 		dataSource: Array<MobileCRM.Reference>;
-		prevSelection: MobileCRM.Reference;
 		allowNull: boolean;
 
 		show(success: (obj?: MobileCRM.Reference) => void, failed?: (err: string) => void, scope?: any);

package/src/JSBridge.js

@@ -1,6 +1,6 @@
-// v14.2
+// v15.1
 (function () {
-	var _scriptVersion = 14.2
+	var _scriptVersion = 15.1
 	// Private objects & functions
 	var _inherit = (function () {
 		function _() { }
@@ -540,11 +540,13 @@
 					/// <summary>Represents the Javascript equivalent of native entity form object.</summary>
 					/// <remarks>This object cannot be created directly. To obtain/modify this object, use <see cref="MobileCRM.UI.EntityForm.requestObject">MobileCRM.UI.EntityForm.requestObject</see> function.</remarks>
 					/// <field name="associatedViews" type="Array">Gets the associated views as an array of <see cref="MobileCRM.UI._EntityList">MobileCRM.UI._EntityList</see> objects.</field>
+					/// <field name="bulkUpdateItems" type="Array">A list of entity records editted on this bulk update form.</field>
 					/// <field name="canEdit" type="Boolean">Gets whether the form can be edited.</field>
 					/// <field name="canClose" type="Boolean">Determines if form can be closed, i.e. there are no unsaved data being edited.</field>
 					/// <field name="context" type="Object">Gets the specific context object for onChange and onSave handlers. The onChange context contains single property &quot;changedItem&quot; with the name of the changed detail item and the onSave context contains property &quot;errorMessage&quot; which can be used to break the save process with certain error message.</field>
 					/// <field name="controllers" type="Array">Gets the form controllers (map, web) as an array of <see cref="MobileCRM.UI._Controller">MobileCRM.UI._Controller</see> objects.</field>
 					/// <field name="detailViews" type="Array">Gets the detailView controls  as an array of <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> objects.</field>
+					/// <field name="isBulkUpdateForm" type="Boolean">Indicates whether the form is bulk update form.</field>
 					/// <field name="entity" type="MobileCRM.DynamicEntity">Gets or sets the entity instance the form is showing.</field>
 					/// <field name="form" type="MobileCRM.UI.Form">Gets the top level form.</field>
 					/// <field name="iFrameOptions" type="Object">Carries the custom parameters that can be specified when opening the form using <see cref="MobileCRM.UI.FormManager">MobileCRM.UI.FormManager</see>.</field>
@@ -721,9 +723,7 @@
 					/// <field name="entities" type="Array">An array of allowed entity kinds (schema names).</field>
 					/// <field name="source" type="MobileCRM.Relationship">The entity whose property will be set to the chosen value.</field>
 					/// <field name="dataSource" type="MobileCRM.Reference[]">The list of entities that should be displayed as selected.</field>
-					/// <field name="prevSelection" type="MobileCRM.Reference">The entity whose property will be set to the chosen value.</field>
 					/// <field name="allowNull" type="Boolean">Whether to allow selecting no entity.</field>
-					/// <field name="preventClose" type="Boolean">Whether to prevent closing form without choosing a value.</field>
 					MobileCRM.UI.MultiLookupForm.superproto.constructor.apply(this, arguments);
 					this.dataSource = [];
 				},
@@ -2684,6 +2684,18 @@
 	        var emailContent = { Address: address, Subject: subject, Body: body };
 	        _executePlatformAction(1, emailContent, null, errorCallback, scope);
 	    };
+		MobileCRM.Platform.sendEmail = function (address, subject, body, mimeType, errorCallback, scope) {
+			/// <summary>[v15.0] Opens the platform-specific e-mail message form with pre-filled data.</summary>
+			/// <param name="address" type="String">Recipient&#39;s email address.</param>
+			/// <param name="subject" type="String">An e-mail subject.</param>
+			/// <param name="body" type="String">A string with email body.</param>
+			/// <param name="mimeType" type="String">Body content MIME type.</param>
+			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called asynchronously in case of error.</param>
+			/// <param name="scope" type="Object">The scope for errorCallback.</param>
+
+			var emailContent = { Address: address, Subject: subject, Body: body, MimeType: mimeType };
+			_executePlatformAction(1, emailContent, null, errorCallback, scope);
+		};
 	    MobileCRM.Platform.openDocument = function (path, mimeType, args, errorCallback, scope) {
 	        /// <summary>[v8.1] Opens specified document in associated program.</summary>
 	        /// <remarks>Apple security policy doesn&amp;t allow this functionality on iOS.</remarks>
@@ -3612,7 +3624,25 @@
 	        var controller = MobileCRM.bridge.exposeObjectAsync("EntityForm.GetController", [this.view.name]);
 	        controller.invokeMethodAsync("ChangeProcessTo", [processRef], function () { }, errorCallback, scope);
 	        controller.release();
-	    };
+		};
+
+		MobileCRM.UI.ProcessController.prototype.moveToPreviousStage = function (errorCallback, scope) {
+			/// <summary>[15.0] Moves to the previous stage of the active process.</summary>
+			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called asynchronously in case of error.</param>
+			/// <param name="scope" type="Object">The scope for callback.</param>
+			var controller = MobileCRM.bridge.exposeObjectAsync("EntityForm.GetController", [this.view.name]);
+			controller.invokeMethodAsync("MoveToPreviousStage", [], function () { }, errorCallback, scope);
+			controller.release();
+		};
+
+		MobileCRM.UI.ProcessController.prototype.moveToNextStage = function ( errorCallback, scope) {
+			/// <summary>[15.0] Progresses to the next stage of the active process.</summary>
+			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called asynchronously in case of error.</param>
+			/// <param name="scope" type="Object">The scope for callback.</param>
+			var controller = MobileCRM.bridge.exposeObjectAsync("EntityForm.GetController", [this.view.name]);
+			controller.invokeMethodAsync("MoveToNextStage", [], function () { }, errorCallback, scope);
+			controller.release();
+		};
 		
 	    // MobileCRM.UI.ViewDefinition
 	    MobileCRM.UI.ViewDefinition.loadEntityViews = function (entityName, callback, errorCallback, scope) {
@@ -4738,7 +4768,7 @@
 
 	    // MobileCRM.UI.EntityForm
 	    _inherit(MobileCRM.UI.EntityForm, MobileCRM.ObservableObject);
-	    MobileCRM.UI.EntityForm._handlers = { onChange: [], onSave: [], onPostSave: [], onDetailCollectionChange: [], onSelectedViewChanged: [] };
+		MobileCRM.UI.EntityForm._handlers = { onChange: [], onSave: [], onPostSave: [], onDetailCollectionChange: [], onSelectedViewChanged: [], onProcessLoaded: [] };
 
 	    MobileCRM.UI.EntityForm.prototype.getDetailView = function (name) {
 	        /// <summary>Returns the DetailView by its name.</summary>
@@ -4970,6 +5000,17 @@
 	        if (register)
 	            MobileCRM.bridge.command("registerEvents", "onChange");
 	    }
+		MobileCRM.UI.EntityForm.onProcessLoaded = function (handler, bind, scope) {
+			/// <summary>Binds or unbinds the handler for onProcessLoaded event on EntityForm.</summary>
+			/// <param name="handler" type="function(entityForm)">The handler function that has to be bound or unbound.</param>
+			/// <param name="bind" type="Boolean">Determines whether to bind or unbind the handler.</param>
+			/// <param name="scope" type="Object">The scope for handler calls.</param>
+			var handlers = MobileCRM.UI.EntityForm._handlers.onProcessLoaded;
+			var register = handlers.length == 0;
+			_bindHandler(handler, handlers, bind, scope);
+			if (register)
+				MobileCRM.bridge.command("registerEvents", "onProcessLoaded");
+		}
 		MobileCRM.UI.EntityForm.onItemChange = function (itemName, handler, bind, scope) {
 			/// <summary>[v11.2] Binds or unbinds the handler for specific item change event on EntityForm.</summary>
 			/// <param name="itemName" type="String">The name of desired detail item (mostly logical name of the field).</param>