@resconet/jsbridge 17.1.0-beta.1 → 17.1.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resconet/jsbridge",
-  "version": "17.1.0-beta.1",
+  "version": "17.1.0-beta.3",
   "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

@@ -156,8 +156,10 @@
 			}
 		};
 	};
+	var _global = typeof window == "undefined" ? global : window;
+	var MobileCrmException = _global.MobileCrmException;
 	if (typeof MobileCrmException === "undefined") {
-		MobileCrmException = function (msg) {
+		_global.MobileCrmException = MobileCrmException = function (msg) {
 			this.message = msg;
 			this.name = "MobileCrmException";
 		};
@@ -169,8 +171,9 @@
 		return "message" in err ? err.message : "Message" in err ? err.Message : err.toString();
 	}
 	// MobileCRM object definition
+	var MobileCRM = _global.MobileCRM;
 	if (typeof MobileCRM === "undefined") {
-		MobileCRM = {
+		_global.MobileCRM = MobileCRM = {
 			/// <summary>An entry point for Mobile CRM data model.</summary>
 			/// <field name="bridge" type="MobileCRM.Bridge">Singleton instance of <see cref="MobileCRM.Bridge">MobileCRM.Bridge</see> providing the management of the Javascript/native code cross-calls.</field>
 			bridge: null,
@@ -1045,6 +1048,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;
+				},
 			},
 		};
 
@@ -1417,7 +1452,7 @@
 					callback.call(scope);
 				}
 			});
-			window.setTimeout(function () {
+			_global.setTimeout(function () {
 				var nextWorker = _alertQueue.splice(0, 1);
 				nextWorker[0]();
 			});
@@ -2274,7 +2309,7 @@
 			}
 			var cmdParams = JSON.stringify(request);
 			var self = this;
-			window.MobileCRM.bridge.command(
+			_global.MobileCRM.bridge.command(
 				"entitysave",
 				cmdParams,
 				function (res) {
@@ -2490,7 +2525,7 @@
 			/// <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.Fetch.prototype.execute = function (output, success, failed, scope) {
 			/// <summary>Performs the asynchronous CRM Fetch request.</summary>
@@ -6091,6 +6126,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>
@@ -6189,7 +6248,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,

package/src/README.md

@@ -1,49 +1,71 @@
-# JSBridge Source
+# JSBridge
 
-The repository is used to publish **public** npm package to ... https://registry.npmjs.org/
+JSBridge - Javascript API for Resco Mobile CRM
 
-The homepage of package : https://www.npmjs.com/package/@resconet/jsbridge
+Getting started with working and debugging of an offline HTML solution.  
+https://www.resco.net/debugging-offline-html-solution/
 
-The package can be installed using following command **npm i @resconet/jsbridge**@[version of package]
+## Introduction
 
-The directory contains:
-* javascript **.js** and typescript **.d.ts** source file
-* readme file **README.md**
+Resco Mobile CRM application functionality can be extended using HTML + Javascript code.
+Your html file containing custom code can be executed both online and offline.
+Offline html files are part of Woodford customization project.
 
-# Install package in project
+Watch webinars for intro to OfflineHTML in Resco MobileCRM.
+<br />[Webinar Offline HTML in Resco Mobile CRM - Part 1/2 (Intro)](https://www.youtube.com/watch?v=cplZLC_mAc0&list=PLPMCnAPD5b56XNEiGTcy5VBxdP8rcB86b&index=12)  
+[Webinar Offline HTML in Resco Mobile CRM - Part 2/2 (Data Access)](https://www.youtube.com/watch?v=R7GpdC_y17Y&t=1s)
+
+Release contains the debugging/development build(s) of the Resco Mobile CRM application.  
+Per platform application packages are available.
+
+## IFrame
+
+You can put a web browser, known as IFrame, in various components in the app.
+IFrames can be used within EntityForm, EntityList or within HomeForm.
+IFrame points to your custom html code file.
+
+## Documentation
+
+Description of the methods and objects defined in Resco JavaScript Bridge.  
+[Latest Reference](https://www.resco.net/javascript-bridge-reference/)  
+[Guide](http://www.resco.net/mobilecrm/support/jsbridge.aspx)
+
+## Installing the package
 
 In your project directory use **npm init** to set up a new or existing npm package. If you want to create default package json file then use --yes parameter. For more information please visit https://docs.npmjs.com/cli/init
 
-* install package **npm i @resconet/jsbridge**
-## Include npm module in project
+- install package **npm i @resconet/jsbridge**
+
+## Using the library
 
-* **Javascript file**
-You can use require to include npm module from installed package. For example
+- **Javascript file**
+  You can use require to include the module from installed packages. For example
 
 ```javascript
-require ("@resconet/jsbridge/src/JSBridge");
+require("@resconet/jsbridge");
 
-function testAlert(){
-    MobileCRM.bridge.alert("Test");
+function testAlert() {
+  MobileCRM.bridge.alert("Test");
 }
 ```
 
-* **Typescript file**
-You can use import to include npm module from installed package. For example
+- **Typescript file**
+  You can use import to include the module from installed packages. For example
 
 ```javascript
-import "@resconet/jsbridge/src/JSBridge"
+import "@resconet/jsbridge";
 
-function testAlert(){
-    MobileCRM.bridge.alert("Test");
+function testAlert() {
+  MobileCRM.bridge.alert("Test");
 }
 ```
 
 ## Versioning
 
 The package.json defines the version of JSBridge. e.g. "version": "12.3.1", it means
-* 12.3: Major revision (copies the version of underlying Mobile CRM app)
-* 1: Bug fix release
+
+- 12.3: Major revision (copies the version of underlying Mobile CRM app)
+- 1: Bug fix release
 
 **important** first two numbers mirror the latest version of Mobile CRM native application that supports the features.
 
@@ -58,4 +80,5 @@ The Package is published to npm registry page on release publish event.
 The Bug fix release number is automatically updated when new js or ts file is pushed.
 
 ## Contact
+
 For any questions or any specific circumstances, please contact us on the email mobilecrm@resco.net