@resconet/jsbridge 17.2.1 → 18.0.0-beta.2

package/package.json

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

package/src/JSBridge.d.ts

@@ -1114,6 +1114,13 @@ declare module MobileCRM.FetchXml {
 		 * @param scope A scope for calling the callbacks. Set to call the callbacks in global scope.
 		 */
 		public static executeFromXML(fetchXmlData: string, success: (res: any[]) => void, failed?: (error: string) => void, scope?: any);
+		/**
+		 * Executes fetch XML asynchronously.
+		 * The format of result output is controlled by internal XML attribute "resultformat" on root fetch XML element.
+		 * @param fetchXmlData CRM fetch in XML representation.
+		 * @returns A promise object fulfilled with the array of objects having type specified by resultformat XML attribute (Array, JSON, XML or DynamicEntities).
+		 */
+		public static executeFromXmlAsync(fetchXmlData: string): Promise<any[]>;
 		/**
 		 * @since 10.0
 		 * Deserializes XML to the Fetch object.
@@ -1452,6 +1459,10 @@ declare module MobileCRM.Services {
 		mimeType: string;
 		nextInfo: FileInfo;
 	}
+	class ZebraScanner {
+		static connect: (success: (result: string) => void, failed?: (err: string) => void, scope?: any) => void;
+		static onScan: (handler: (questionnaireForm: QuestionnaireForm) => void, bind: boolean, scope?: any) => void;
+	}
 	class DocumentService {
 		/**Gets or sets the maximum captured image size. If captured image size is greater, the image is resized to specified maximum size. [640x480,1024x768,1600x1200,2048x1536,2592x1936].*/
 		maxImageSize: string;
@@ -2128,7 +2139,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.2;
+	var _scriptVersion = 18.0;
 	// Private objects & functions
 	var _inherit = (function () {
 		function _() {
@@ -420,14 +420,14 @@
 					if (entity) {
 						this.entity = entity;
 					}
-					if (typeof count !== "undefined") {
+					if (count !== undefined && count !== null) {
 						this.count = count;
 					}
-					if (typeof page !== "undefined") {
+					if (page) {
 						this.page = page;
 					}
 					this.aggregate = !!aggregate;
-					if (typeof distinct !== "undefined") {
+					if (distinct !== undefined && distinct !== null) {
 						this.distinct = distinct;
 					}
 				},
@@ -990,6 +990,9 @@
 				},
 			},
 			Services: {
+				ZebraScanner: function () {
+					/// <summary>Represents a service for scanning barcodes using Zebra scanner.</summary>
+				},
 				FileInfo: function (filePath, url, mimeType, nextInfo) {
 					/// <summary>Carries the result of a DocumentService operation.</summary>
 					/// <remarks>In case of canceled document service operation, all properties in this object will be set to &quot;null&quot;.</remarks>
@@ -1178,6 +1181,46 @@
 				return typeof result == "string" ? result : JSON.stringify(result);
 			}
 		};
+
+		MobileCRM.Services.ZebraScanner.onScan = function (handler, bind, scope) {
+			/// <summary>Registers the handler for the scan event.</summary>
+			/// <param name="handler" type="function(data)">The handler function that is called when the scan event is raised.</param>
+			/// <param name="bind" type="Boolean">Indicates whether to bind the handler to the event.</param>
+			/// <param name="scope" type="Object">The scope in which the handler function is called.</param>
+			let handlerName = "onScan";
+			let handlers = MobileCRM.Services.ZebraScanner._handlers[handlerName];
+
+			if (!handlers) {
+				MobileCRM.Services.ZebraScanner._handlers[handlerName] = handlers = [];
+			}
+
+			const register = handlers.length == 0;
+			_bindHandler(handler, handlers, bind, scope);
+
+			if (register) {
+				MobileCRM.bridge.command("registerEvents", handlerName);
+			}
+		};
+
+		MobileCRM.Services.ZebraScanner.connect = function (successCallback, errorCallback, scope) {
+			/// <summary>Connects to the Zebra scanner.</summary>
+			/// <param name="successCallback" type="function">The callback function that is called when the connection is established.</param>
+			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called in case of error.</param>
+			/// <param name="scope" type="Object">The scope in which the callback function is called.</param>
+			MobileCRM.bridge.command("initZebra", null, successCallback, errorCallback, scope);
+		};
+
+		MobileCRM.Services.ZebraScanner._callHandlers = function (event, data) {
+			/// <summary>Invokes the registered handlers for the specified event.</summary>
+			const handlers = MobileCRM.Services.ZebraScanner._handlers[event];
+
+			if (handlers && handlers.length > 0) {
+				return _callHandlers(handlers, data);
+			}
+
+			return null;
+		};
+
 		// MobileCRM.UI._MediaTab
 		MobileCRM.UI.MediaTab.prototype._onCommand = function (commandIndex, errorCallback) {
 			/// <summary>Executes the MediaTab command by index.</summary>
@@ -2617,6 +2660,13 @@
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 			_global.MobileCRM.bridge.command("fetchXML", fetchXmlData, success, failed, scope);
 		};
+		MobileCRM.FetchXml.Fetch.executeFromXmlAsync = function (fetchXmlData) {
+			/// <summary>Executes fetch XML asynchronously.</summary>
+			/// <remarks>The format of result output is controlled by internal XML attribute &quot;resultformat&quot; on root fetch XML element.</remarks>
+			/// <param name="fetchXmlData" type="String">CRM fetch in XML representation.</param>
+			/// <returns type="Promise">A promise object fulfilled with the array of objects having type specified by resultformat XML attribute (Array, JSON, XML or DynamicEntities).</returns>
+			return MobileCRM.bridge.invokeCommandPromise("fetchXML", fetchXmlData);
+		};
 		MobileCRM.FetchXml.Condition._constructConditionParams = function (condition) {
 			if (condition) {
 				var conditionParams = {};
@@ -2736,13 +2786,13 @@
 		};
 		MobileCRM.FetchXml.Fetch.prototype._constructFetchParams = function () {
 			var reqParams = { entity: MobileCRM.FetchXml.Entity._constructEntityParams(this.entity) };
-			if (typeof this.page !== "undefined") {
+			if (this.page) {
 				reqParams.page = this.page;
 			}
-			if (typeof this.count !== "undefined") {
+			if (this.count !== undefined && this.count !== null) {
 				reqParams.count = this.count;
 			}
-			if (typeof this.aggregate !== "undefined") {
+			if (this.aggregate !== undefined && this.aggregate !== null) {
 				reqParams.aggregate = this.aggregate;
 			}
 			if (this.distinct) {
@@ -4941,6 +4991,7 @@
 			/// <param name="entities" type="Array[MobileCRM.DynamicEntity]">A chunk (array) of <see cref="MobileCRM.DynamicEntity">DynamicEntities</see> that has to be passed back to the native code to fill in to the list view.</param>
 			MobileCRM.bridge.command(this._chunkReadyCmdId, JSON.stringify(entities));
 		};
+		MobileCRM.Services.ZebraScanner._handlers = { onScan: [] };
 		// MobileCRM.UI.QuestionnaireForm
 		_inherit(MobileCRM.UI.QuestionnaireForm, MobileCRM.ObservableObject);
 		MobileCRM.UI.QuestionnaireForm._handlers = { onChange: [], onSave: [], onPostSave: [], onRepeatGroup: [], onDeleteGroup: [] };
@@ -5761,6 +5812,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>