@resconet/jsbridge 17.1.9 → 18.0.0-beta.1

package/package.json

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

package/src/JSBridge.d.ts

@@ -70,6 +70,16 @@ declare namespace MobileCRM {
 		public static requestObject(callback: (config: Configuration) => void, erroCallback?: (error: string) => void, scope?: any);
 	}
 
+	class GlobalConstants {
+		/**Gets the JSON object representing the GlobalConstants variables. */
+		public static getAllAsync(): Promise<Object>;
+		/**
+		 *Gets the constant associated with specified key in the GlobalConstants variables.
+		 * @param key The key of the constant to get.
+		 */
+		public static getAsync(key: String): Promise<Object>;
+	}
+
 	class Settings {
 		/**Gets the absolute URL (including the CrmOrganization).*/
 		absoluteUrl: string;
@@ -2118,7 +2128,21 @@ declare module MobileCRM.UI {
 		 */
 		public static openSalesEntityDetail(detail: MobileCRM.DynamicEntity, errorCallback: (err?: string) => void);
 		/**
-		 * @ since 9.3
+		 * @since 18.0
+		 * The clearance must be dutifully released using leaveUiTransaction() when manipulation is finished.
+		 * The clearance will not be obtained if background sync is running and form sync behavior is configured to 'Block save during sync'
+		 * or 'Block save during sync and prevent sync while form is open'".
+		 * If form sync behavior is configured as 'No action', the clearance is always obtained.
+		 * @returns true if form can give the clearance, false if it is not possible at this time.
+		 */
+		public static tryEnterUiTransaction(): Promise<boolean>;
+		/**
+		 * @since 18.0
+		 * Notifies UI form that clearance obtained using successful call to tryEnterUiTransaction() is no longer needed, because data manipulation is complete.
+		 */
+		public static leaveUiTransaction(): Promise;
+		/**
+		 * @since 9.3
 		 * Binds or unbinds the handler for onSelectedViewChanged event on EntityForm.
 		 * @description Bound handler is called with the EntityForm object as an argument. The EntityForm context object contains 'selectedView' property with the name of currently selected view.
 		 * @param handler The handler function that has to be bound or unbound.

package/src/JSBridge.js

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-this-alias */
 /* globals MobileCRM:writable, MobileCrmException:writable, CrmBridge, webkit, chrome */
 (function () {
-	var _scriptVersion = 17.1;
+	var _scriptVersion = 18.0;
 	// Private objects & functions
 	var _inherit = (function () {
 		function _() {
@@ -219,6 +219,9 @@
 				/// <field name="settings" type="MobileCRM._Settings">Gets the application settings.</field>
 				/// <field name="storageDirectory" type="String">Gets the root folder of the application storage.</field>
 			},
+			GlobalConstants: function () {
+				/// <summary>Provides access to the global constants.</summary>
+			},
 			CultureInfo: function () {
 				/// <summary>[v10.2] Provides information about current device culture. The information includes the names for the culture, the writing system, the calendar used, and formatting for dates.</summary>
 				/// <field name="name" type="String">Gets the culture name in the format languageCode/region (e.g. &quot;en-US&quot;). languageCode is a lowercase two-letter code derived from ISO 639-1. regioncode is derived from ISO 3166 and usually consists of two uppercase letters.</field>
@@ -1680,6 +1683,18 @@
 				scope
 			);
 		};
+		//MobileCRM.GlobalConstants
+		MobileCRM.GlobalConstants.getAllAsync = function () {
+			/// <summary>Asynchronously returns the JSON object representing the GlobalConstants variables.</summary>
+			/// <returns type="Promise&lt;Object&gt;">A Promise object that will be resolved with the properties representing the constant variables.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("getGlobalConstants", "");
+		};
+		MobileCRM.GlobalConstants.getAsync = function (key) {
+			/// <summary>Asynchronously returns the constant associated with the specified key in the GlobalConstants variables.</summary>
+			/// <param name="key" type="String">The key of the constant to get.</param>
+			/// <returns type="Promise&lt;Object&gt;">A Promise object that will be resolved with an object representing the constant variable.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("getGlobalConstants", key);
+		};
 		// MobileCRM._Settings
 		MobileCRM._Settings = {
 			/// <summary>MobileCRM configuration settings class.</summary>
@@ -5746,6 +5761,20 @@
 			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called asynchronously in case of error.</param>
 			MobileCRM.bridge.invokeMethodAsync("EntityForm", "ShowEntityDetailDialog", [detail.id], null, errorCallback, null);
 		};
+		/// <summary>[v18.0] Obtains a clearance to perform manipulation with data.
+		/// The clearance must be dutifully released using leaveUiTransaction() when manipulation is finished.
+		/// The clearance will not be obtained if background sync is running and form sync behavior is configured to 'Block save during sync'
+		/// or 'Block save during sync and prevent sync while form is open'".
+		/// If form sync behavior is configured as 'No action', the clearance is always obtained.
+		/// </summary>
+		/// <returns>Returns true if form can give the clearance, false if it is not possible at this time.</returns>
+		MobileCRM.UI.EntityForm.tryEnterUiTransaction = function () {
+			return MobileCRM.bridge.invokeCommandPromise("tryEnterUiTransaction");
+		};
+		/// <summary>[v18.0] Notifies UI form that clearance obtained using successful call to tryEnterUiTransaction() is no longer needed, because data manipulation is complete.</summary>
+		MobileCRM.UI.EntityForm.leaveUiTransaction = function () {
+			return MobileCRM.bridge.invokeCommandPromise("leaveUiTransaction");
+		};
 		// MobileCRM.UI.EntityForm.DetailCollection
 		MobileCRM.UI.EntityForm.DetailCollection = function () {
 			/// <summary>Provides functions accessing the collection of the sales entity details (e.g. Order details)</summary>