@resconet/jsbridge 17.1.0-beta.2 → 17.1.0-beta.4

package/package.json

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

package/src/JSBridge.d.ts

@@ -1,6 +1,12 @@
 // JSBridge.js TypeScript definition file
 // (c) 2023 Resco
 
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/prefer-namespace-keyword */
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable no-var */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 declare namespace MobileCRM {
 	class Size {
 		width: string;
@@ -1588,6 +1594,40 @@ declare module MobileCRM.Services {
 		responseText: string;
 		responseType: string;
 	}
+
+	class GeoFencingService {
+		/** Indicates whether the service is active. */
+		isEnabled: boolean;
+		/** Indicates whether the events should be delivered realtime using Resco forwarding service.*/
+		realtimeFlushing: boolean;
+		/** Defines logging verbosity (0=Normal, 1=Diagnostic, -1=None) */
+		logLevel: number;
+		/** Defines event mask for showing notifications (0=None, 1=WhenArrived, 2=WhenExited, 3=Always) */
+		notificationMask: number;
+		/** Business hours interval (default value is '9:00-17:00') */
+		businessHours: string;
+		/** Business days mask (the lowest bit is Sunday, the next Monday, ...) */
+		businessDaysMask: number;
+
+		updateGeoFences(records: GeoFenceRecord[]);
+	}
+
+	interface GeoFenceRecord {
+		/** Defines numeric mask for geo fence events (Enter = 1, Exit = 2, Both = 3).*/
+		eventTypeMask: number;
+		/** Unique id of geo-fence record. If it is associated with some entity record, it must have form logicalname:id (e.g. appointment:4595AA3E-9873-4DC4-B723-C94DE27B82BE).*/
+		id: string;
+		/** Human-readable name of record used for notifications.*/
+		name: string;
+		/** Latitude of geo-fence center.*/
+		latitude: number;
+		/** Longitude of geo-fence center.*/
+		longitude: number;
+		/** Geo-fence radius in meters.*/
+		radius: number;
+		/** Geo-fence expiration in seconds.*/
+		expiration: number;
+	}
 }
 declare module MobileCRM.Services.AddressBookService {
 	class AddressBookRecord {
@@ -2776,9 +2816,9 @@ declare module MobileCRM.UI {
 
 		addView(entityName: string, viewName: string, isDefault?: boolean);
 		addEntityFilter(entityName: string, filterXML: string);
+		addEntityFilter(entityName: string, filterXml);
 		show(success: (obj?: MobileCRM.Reference) => void, failed?: (err: string) => void, scope?: any);
 		showAsync(): Promise<Reference>;
-		addEntityFilter(entityName: string, filterXml);
 	}
 
 	class MultiLookupForm {

package/src/JSBridge.js

@@ -25,6 +25,21 @@
 		}
 		return null;
 	};
+	var _normalizeArray = function (arr, convertCallback) {
+		var retVal = undefined;
+		if (arr instanceof Array && arr.length > 0) {
+			const normArr = [];
+			for (const o of arr) {
+				if (o) {
+					normArr.push(convertCallback(o));
+				}
+			}
+			if (normArr.length > 0) {
+				retVal = normArr;
+			}
+		}
+		return retVal;
+	};
 	var _addProperty = function (obj, name, writable, value) {
 		if (!obj._privVals) {
 			obj._privVals = {};
@@ -156,7 +171,7 @@
 			}
 		};
 	};
-	var _global = window || global;
+	var _global = typeof window == "undefined" ? global : window;
 	var MobileCrmException = _global.MobileCrmException;
 	if (typeof MobileCrmException === "undefined") {
 		_global.MobileCrmException = MobileCrmException = function (msg) {
@@ -398,11 +413,19 @@
 					/// <field name="entity" type="MobileCRM.FetchXml.Entity">An entity object.</field>
 					/// <field name="page" type="int">1-based index of the data page to retrieve.</field>
 					/// <field name="distinct" type="Boolean">Whether to return only distinct (different) values.</field>
-					this.entity = entity;
-					this.count = count;
-					this.page = page;
+					if (entity) {
+						this.entity = entity;
+					}
+					if (typeof count !== "undefined") {
+						this.count = count;
+					}
+					if (typeof page !== "undefined") {
+						this.page = page;
+					}
 					this.aggregate = false;
-					this.distinct = distinct;
+					if (typeof distinct !== "undefined") {
+						this.distinct = distinct;
+					}
 				},
 				Entity: function (name) {
 					/// <summary>Represents a FetchXml query root entity.</summary>
@@ -412,25 +435,23 @@
 					/// <field name="linkentities" type="Array">An array of <see cref="MobileCRM.FetchXml.LinkEntity">MobileCRM.FetchXml.LinkEntity</see> objects.</field>
 					/// <field name="name" type="String">An entity logical name.</field>
 					/// <field name="order" type="Array">An array of <see cref="MobileCRM.FetchXml.Order">MobileCRM.FetchXml.Order</see> objects.</field>
-					this.name = name;
+					if (name) {
+						this.name = name;
+					}
 					this.attributes = [];
 					this.order = [];
 					this.filter = null;
 					this.linkentities = [];
 				},
-				LinkEntity: function (name) {
+				LinkEntity: function () {
 					/// <summary>Represents a FetchXml query linked entity.</summary>
 					/// <remarks>This object is derived from <see cref="MobileCRM.FetchXml.Entity">MobileCRM.FetchXml.Entity</see></remarks>
+					/// <param name="name" type="String">An entity name</param>
 					/// <field name="alias" type="String">A link alias.</field>
 					/// <field name="from" type="String">The "from" field (if parent then target entity primary key).</field>
 					/// <field name="linkType" type="String">The link (join) type ("inner" or "outer").</field>
-					/// <param name="name" type="String">An entity name</param>
 					/// <field name="to" type="String">The "to" field.</field>
 					MobileCRM.FetchXml.LinkEntity.superproto.constructor.apply(this, arguments);
-					this.from = null;
-					this.to = null;
-					this.linktype = null;
-					this.alias = null;
 				},
 				Attribute: function (name) {
 					/// <summary>Represents a FetchXml select statement (CRM field).</summary>
@@ -440,11 +461,10 @@
 					/// <field name="dategrouping" type="String">A date group by modifier (year, quarter, month, week, day).</field>
 					/// <field name="groupby" type="Boolean">Indicates whether to group by this attribute.</field>
 					/// <field name="name" type="String">A lower-case entity attribute name (CRM logical field name).</field>
-					this.name = name;
-					this.aggregate = null;
+					if (name) {
+						this.name = name;
+					}
 					this.groupby = false;
-					this.alias = null;
-					this.dategrouping = null;
 				},
 				Order: function (attribute, descending) {
 					/// <summary>Represents a FetchXml order statement.</summary>
@@ -453,8 +473,9 @@
 					/// <field name="alias" type="String">Defines an order alias.</field>
 					/// <field name="attribute" type="String">An attribute name (CRM logical field name).</field>
 					/// <field name="descending" type="Boolean">true, for descending order; false, for ascending order.</field>
-					this.attribute = attribute;
-					this.alias = null;
+					if (attribute) {
+						this.attribute = attribute;
+					}
 					this.descending = descending ? true : false;
 				},
 				Filter: function () {
@@ -462,7 +483,6 @@
 					/// <field name="conditions" type="Array">An array of <see cref="MobileCRM.FetchXml.Condition">Condition</see> objects.</field>
 					/// <field name="filters" type="Array">An array of <see cref="MobileCRM.FetchXml.Filter">Filter</see> objects representing child-filters.</field>
 					/// <field name="type" type="String">Defines the filter operator ("or" / "and").</field>
-					this.type = null;
 					this.conditions = [];
 					this.filters = [];
 				},
@@ -474,15 +494,10 @@
 					/// <field name="uitype" type="String">The lookup target entity logical name.</field>
 					/// <field name="value" type="">The value to compare to.</field>
 					/// <field name="values" type="Array">The list of values to compare to.</field>
-					this.attribute = null;
-					this.operator = null;
-					this.uitype = null;
-					this.uiname = null;
-					this.value = null;
 					this.values = [];
 				},
 			},
-			Platform: function (props) {
+			Platform: function () {
 				/// <summary>Represents object for querying platform specific information and executing platform integrated actions.</summary>
 				/// <remarks>This object cannot be created directly. To obtain/modify this object, use <see cref="MobileCRM.Platform.requestObject">MobileCRM.Platform.requestObject</see> function.</remarks>
 				/// <field name="capabilities" type="Number">Gets the mask of capability flags supported by this device (MakePhoneCalls=1; HasMapView=2).</field>
@@ -544,7 +559,7 @@
 			},
 			UI: {
 				FormManager: {},
-				EntityForm: function (props) {
+				EntityForm: function () {
 					/// <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>
@@ -572,11 +587,11 @@
 					/// <field name="relationship" type="MobileCRM.Relationship">Gets the relation source and related entity. &quot;null&quot;, if there is no relationship.</field>
 					MobileCRM.UI.QuestionnaireForm.superproto.constructor.apply(this, arguments);
 				},
-				EntityChart: function (props) {
+				EntityChart: function () {
 					/// <summary>[13.0] Represents the Javascript equivalent of native entity chart object.</summary>
 					MobileCRM.UI.EntityChart.superproto.constructor.apply(this, arguments);
 				},
-				EntityList: function (props) {
+				EntityList: function () {
 					/// <summary>[v9.2] Represents the Javascript equivalent of native entity list object.</summary>
 					/// <field name="allowAddExisting" type="Boolean">Gets or sets whether adding an existing entity is allowed.</field>
 					/// <field name="allowCreateNew" type="Boolean">Gets or sets whether create a new entity (or managing the N:N entities in the case of N:N list) is allowed.</field>
@@ -604,7 +619,7 @@
 					/// <field name="uniqueName" type="Number">Gets or sets the unique name of the list. Used to save/load list specific settings.</field>
 					MobileCRM.UI.EntityList.superproto.constructor.apply(this, arguments);
 				},
-				HomeForm: function (props) {
+				HomeForm: function () {
 					/// <summary>[v8.0] Represents the Javascript equivalent of the home form object which contains the Home/UI replacement iFrame.</summary>
 					/// <remarks><p>This class works only from Home/UI replacement iFrame.</p><p>This object cannot be created directly. To obtain/modify this object, use <see cref="MobileCRM.UI.HomeForm.requestObject">MobileCRM.UI.HomeForm.requestObject</see> function.</p></remarks>
 					/// <field name="form" type="MobileCRM.UI.Form">Gets the top level form.</field>
@@ -1048,6 +1063,38 @@
 					this.url = "";
 					this.serviceType = "Azure"; // [v12.3] supports only azure service, used as default.
 				},
+				GeoFencingService: function () {
+					/// <summary>[v17.1] Represents geo-fencing service.</summary>
+					/// <field name="isEnabled" type="Boolean">Indicates whether the service is active.</field>
+					/// <field name="realtimeFlushing" type="Boolean">Indicates whether the events should be delivered realtime using Resco forwarding service.</field>
+					/// <field name="logLevel" type="number">Defines logging verbosity (0=Normal, 1=Diagnostic, -1=None)</field>
+					/// <field name="notificationMask" type="number">Defines event mask for showing notifications (0=None, 1=WhenArrived, 2=WhenExited, 3=Always)</field>
+					/// <field name="businessHours" type="String">Business hours interval (e.g. '9:00-17:00')</field>
+					/// <field name="businessDaysMask" type="number">Business days mask (the lowest bit is Sunday, the next Monday, ...)</field>
+					this.isEnabled = false;
+					this.realtimeFlushing = true;
+					this.logLevel = 0;
+					this.notificationMask = 1;
+					this.businessHours = null;
+					this.businessDaysMask = -1;
+				},
+				GeoFenceRecord: function (eventTypeMask, id, name, latitude, longitude, radius, expiration) {
+					/// <summary>[v17.1] Represents geo-fence definition record.</summary>
+					/// <field name="eventTypeMask" type="number">Defines numeric mask for geo fence events (Enter = 1, Exit = 2, Both = 3).</field>
+					/// <field name="id" type="String">Unique id of geo-fence record. If it is associated with some entity record, it must have form logicalname:id (e.g. appointment:4595AA3E-9873-4DC4-B723-C94DE27B82BE).</field>
+					/// <field name="name" type="String">Human-readable name of record used for notifications.</field>
+					/// <field name="latitude" type="number">Latitude of geo-fence center.</field>
+					/// <field name="longitude" type="number">Longitude of geo-fence center.</field>
+					/// <field name="radius" type="number">Geo-fence radius in meters.</field>
+					/// <field name="expiration" type="number">Geo-fence expiration in seconds.</field>
+					this.eventTypeMask = eventTypeMask;
+					this.id = id;
+					this.name = name;
+					this.latitude = latitude;
+					this.longitude = longitude;
+					this.radius = radius;
+					this.expiration = expiration;
+				},
 			},
 		};
 
@@ -1420,7 +1467,7 @@
 					callback.call(scope);
 				}
 			});
-			window.setTimeout(function () {
+			_global.setTimeout(function () {
 				var nextWorker = _alertQueue.splice(0, 1);
 				nextWorker[0]();
 			});
@@ -2277,7 +2324,7 @@
 			}
 			var cmdParams = JSON.stringify(request);
 			var self = this;
-			window.MobileCRM.bridge.command(
+			_global.MobileCRM.bridge.command(
 				"entitysave",
 				cmdParams,
 				function (res) {
@@ -2493,7 +2540,134 @@
 			/// <param name="success" type="function(result)">A callback function for successful asynchronous result. The <b>result</b> argument will carry the objects array of type specified by <b>resultformat</b> XML attribute (Array, JSON, XML or DynamicEntities).</param>
 			/// <param name="failed" type="function(error)">A callback function for command failure. The <b>error</b> argument will carry the error message.</param>
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
-			window.MobileCRM.bridge.command("fetchXML", fetchXmlData, success, failed, scope);
+			_global.MobileCRM.bridge.command("fetchXML", fetchXmlData, success, failed, scope);
+		};
+		MobileCRM.FetchXml.Condition._constructConditionParams = function (condition) {
+			if (condition) {
+				var conditionParams = {};
+				if (condition.attribute) {
+					conditionParams.attribute = condition.attribute;
+				}
+				if (condition.operator) {
+					conditionParams.operator = condition.operator;
+				}
+				if (condition.uiname) {
+					conditionParams.uiname = condition.uiname;
+				}
+				if (condition.uitype) {
+					conditionParams.uitype = condition.uitype;
+				}
+				if (typeof condition.value !== "undefined") {
+					conditionParams.value = condition.value;
+				}
+				if (condition.values instanceof Array && condition.values.length > 0) {
+					conditionParams.values = condition.values;
+				}
+				return conditionParams;
+			} else {
+				return undefined;
+			}
+		};
+		MobileCRM.FetchXml.Filter._constructFilterParams = function (filter) {
+			if (filter) {
+				var filterParams = {};
+				if (filter.type) {
+					filterParams.type = filter.type;
+				}
+				filterParams.conditions = _normalizeArray(filter.conditions, MobileCRM.FetchXml.Condition._constructConditionParams);
+				filterParams.filters = _normalizeArray(filter.filters, MobileCRM.FetchXml.Filter._constructFilterParams);
+				return filterParams;
+			} else {
+				return undefined;
+			}
+		};
+		MobileCRM.FetchXml.Order._constructOrderParams = function (order) {
+			if (order) {
+				var orderParams = { attribute: order.attribute };
+				if (typeof order.descending != "undefined") {
+					orderParams.descending = order.descending;
+				}
+				if (order.alias) {
+					orderParams.alias = order.alias;
+				}
+				return orderParams;
+			} else {
+				return undefined;
+			}
+		};
+		MobileCRM.FetchXml.Attribute._constructAttributeParams = function (attribute) {
+			if (attribute) {
+				var attrParams = {};
+				if (attribute.name) {
+					attrParams.name = attribute.name;
+				}
+				if (attribute.aggregate) {
+					attrParams.aggregate = attribute.aggregate;
+				}
+				if (typeof attribute.groupby != "undefined") {
+					attrParams.groupby = attribute.groupby;
+				}
+				if (attribute.alias) {
+					attrParams.alias = attribute.alias;
+				}
+				if (attribute.dategrouping) {
+					attrParams.dategrouping = attribute.dategrouping;
+				}
+				return attrParams;
+			} else {
+				return undefined;
+			}
+		};
+		MobileCRM.FetchXml.Entity._constructEntityParams = function (entity) {
+			if (entity) {
+				var entityParams = {};
+				if (entity.name) {
+					entityParams.name = entity.name;
+				}
+				entityParams.attributes = _normalizeArray(entity.attributes, MobileCRM.FetchXml.Attribute._constructAttributeParams);
+				entityParams.order = _normalizeArray(entity.order, MobileCRM.FetchXml.Order._constructOrderParams);
+				if (entity.filter) {
+					entityParams.filter = MobileCRM.FetchXml.Filter._constructFilterParams(entity.filter);
+				}
+				entityParams.linkentities = _normalizeArray(entity.linkentities, MobileCRM.FetchXml.LinkEntity._constructLinkParams);
+				return entityParams;
+			} else {
+				return undefined;
+			}
+		};
+		MobileCRM.FetchXml.LinkEntity._constructLinkParams = function (linkEntity) {
+			var linkParams = MobileCRM.FetchXml.Entity._constructEntityParams(linkEntity);
+			if (linkParams) {
+				if (linkEntity.alias) {
+					linkParams.alias = linkEntity.alias;
+				}
+				if (linkEntity.from) {
+					linkParams.from = linkEntity.from;
+				}
+				if (linkEntity.to) {
+					linkParams.to = linkEntity.to;
+				}
+				if (linkEntity.linkType) {
+					linkParams.linkType = linkEntity.linkType;
+				}
+			}
+			return linkParams;
+		};
+		MobileCRM.FetchXml.Fetch.prototype._constructFetchParams = function () {
+			var reqParams = { entity: MobileCRM.FetchXml.Entity._constructEntityParams(this.entity) };
+			if (typeof this.page !== "undefined") {
+				reqParams.page = this.page;
+			}
+			if (typeof this.count !== "undefined") {
+				reqParams.count = this.count;
+			}
+			if (typeof this.aggregate !== "undefined") {
+				reqParams.aggregate = this.aggregate;
+			}
+			if (this.distinct) {
+				reqParams.distinct = this.distinct;
+			}
+			return reqParams;
 		};
 		MobileCRM.FetchXml.Fetch.prototype.execute = function (output, success, failed, scope) {
 			/// <summary>Performs the asynchronous CRM Fetch request.</summary>
@@ -2501,15 +2675,11 @@
 			/// <param name="success" type="function(result)">A callback function for successful asynchronous result. The <b>result</b> argument will carry the objects array of type specified by <b>output</b> argument.</param>
 			/// <param name="failed" type="function(error)">A callback function for command failure. The <b>error</b> argument will carry the error message.</param>
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
-			var reqParams = JSON.stringify({
-				entity: this.entity,
-				resultformat: output,
-				page: this.page,
-				count: this.count,
-				aggregate: this.aggregate,
-				distinct: this.distinct,
-			});
-			MobileCRM.bridge.command("fetch", reqParams, success, failed, scope);
+			var reqParams = this._constructFetchParams();
+			if (output) {
+				reqParams.resultformat = output;
+			}
+			MobileCRM.bridge.command("fetch", JSON.stringify(reqParams), success, failed, scope);
 		};
 		MobileCRM.FetchXml.Fetch.prototype.executeOnline = function (output, success, failed, scope) {
 			/// <summary>[v8.0] Performs the online CRM Fetch request regardless of the app online/offline mode.</summary>
@@ -2573,13 +2743,13 @@
 			/// <param name="success" type="function(String)">A callback function for successful asynchronous result. The <b>result</b> argument will carry the XML representation of the Fetch object.</param>
 			/// <param name="failed" type="function(error)">A callback function for command failure. The <b>error</b> argument will carry the error message.</param>
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
-			var reqParams = JSON.stringify({ entity: this.entity, page: this.page, count: this.count, aggregate: this.aggregate, distinct: this.distinct });
+			var reqParams = this._constructFetchParams();
 			MobileCRM.bridge.command("fetchToXml", reqParams, success, failed, scope);
 		};
 		MobileCRM.FetchXml.Fetch.prototype.serializeToXmlAsync = function () {
 			/// <summary>[v10.0] Serializes the Fetch object to XML.</summary>
 			/// <returns type="Promise&lt;string&gt;">A Promise object which will be resolved with the XML representation of this Fetch object.</returns>
-			var reqParams = JSON.stringify({ entity: this.entity, page: this.page, count: this.count, aggregate: this.aggregate, distinct: this.distinct });
+			var reqParams = this._constructFetchParams();
 			return MobileCRM.bridge.invokeCommandPromise("fetchToXml", reqParams);
 		};
 		// MobileCRM.FetchXml.Entity
@@ -6094,6 +6264,30 @@
 				scope
 			);
 		};
+
+		MobileCRM.Services.GeoFencingService.prototype.updateGeoFences = function (geoFences, errorCallback) {
+			/// <summary>[v17.1] Updates geo-fences being monitored.</summary>
+			/// <param name="geoFences" type="Array">An array of GeoFenceRecord objects.</field>
+			var cfg = {
+				isEnabled: !!this.isEnabled,
+				realtimeFlushing: !!this.realtimeFlushing,
+			};
+			if (this.logLevel >= -1 && this.logLevel <= 1) {
+				cfg.logLevel = this.logLevel;
+			}
+			if (this.notificationMask >= 0 && this.notificationMask <= 4) {
+				cfg.notificationMask = this.notificationMask;
+			}
+			if (this.businessHours) {
+				cfg.businessHours = this.businessHours;
+			}
+			if (this.businessDaysMask) {
+				cfg.businessDaysMask = this.businessDaysMask;
+			}
+			cfg.geoFences = geoFences;
+			MobileCRM.bridge.command("geofencing", JSON.stringify(cfg), null, errorCallback);
+		};
+
 		MobileCRM.Services.DynamicsReport.prototype.download = function (fileName, format, success, failed, scope) {
 			/// <summary>Downloads the MS Dynamics report into a file.</summary>
 			/// <param name="fileName" type="String">A file name for resulting file. Leave &quot;null&quot; to let app to safely generate the file name and extension.</param>
@@ -6192,7 +6386,7 @@
 			/// <param name="success" type="function(string)">A callback function for successful asynchronous result. The <b>result</b> argument will carry the serialized response from the server.</param>
 			/// <param name="failed" type="function(error)">A callback function for command failure. The <b>error</b> argument will carry the error message.</param>
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
-			window.MobileCRM.bridge.command(
+			_global.MobileCRM.bridge.command(
 				"executeWorkflowAction",
 				JSON.stringify({ actionName: actionName, actionParameters: JSON.stringify(parameters) }),
 				success,