@resconet/jsbridge 18.1.0-beta.2 → 18.1.9

package/package.json

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

package/src/JSBridge.d.ts

@@ -1006,7 +1006,7 @@ declare namespace MobileCRM {
 		 * Executes the mobile reporting request which produces the mobile report document of given format.
 		 * @param fetch The fetch XML defining the entity (entities) query used as report input.
 		 * @param reportXML The mobile report XML definition which can be loaded from the resco_report entity or constructed dynamically. Ignored if IsExportOnly parameter is true.
-		 * @param reportFormat Report format: Pdf (default), Html, Excel, Text.
+		 * @param reportFormat Report format: Pdf (default), Html, Excel, Word.
 		 * @param isExportOnly If true then ReportXml is optional. The default is false.
 		 * @param isOnline Indicates whether the report should be run against the online data or local database. The default is current application mode.
 		 * @param outputFile The full path to the output file. If omitted a temp file is created. The output path is always passed to the success callback.
@@ -1031,7 +1031,7 @@ declare namespace MobileCRM {
 		 * Executes the mobile reporting request which produces the mobile report document of given format.
 		 * @param fetch The fetch XML defining the entity (entities) query used as report input.
 		 * @param reportXML The mobile report XML definition which can be loaded from the resco_report entity or constructed dynamically. Ignored if IsExportOnly parameter is true.
-		 * @param reportFormat Report format: Pdf (default), Html, Excel, Text.
+		 * @param reportFormat Report format: Pdf (default), Html, Excel, Word.
 		 * @param isExportOnly If true then ReportXml is optional. The default is false.
 		 * @param isOnline Indicates whether the report should be run against the online data or local database. The default is current application mode.
 		 * @param outputFile The full path to the output file. If omitted a temp file is created. The output path is always passed to the success callback.
@@ -1054,7 +1054,7 @@ declare namespace MobileCRM {
 			source: string | Reference;
 			/** The identifier of report template as its string record ID, exact logical name, {@link MobileCRM.Reference} or actual xml definition of report.*/
 			template: string | Reference;
-			/** Optional code of report format. Supported values are: Pdf (default), Html, Excel, Text. */
+			/** Optional code of report format. Supported values are: Pdf (default), Html, Excel, Word. */
 			format = "Pdf";
 			/** Optional custom name of report file or its full path. If not provided, default report name and path are used.
 			 * When using full path, it is recommended to place it in {@link MobileCRM.Configuration.storageDirectory}. */
@@ -2210,18 +2210,22 @@ declare module MobileCRM.UI {
 		public static openSalesEntityDetail(detail: MobileCRM.DynamicEntity, errorCallback: (err?: string) => void);
 		/**
 		 * @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.
+		 * Provides means to control concurrent access to data by form logic and background sync.
+		 * This method obtains a clearance to perform data manipulation. The clearance will be obtained when background sync is not running, or form sync behavior is configured as 'No action'.
+		 * 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'", the clearance is not obtained.
+		 * Each obtained clearance must be dutifully released using leaveUiTransaction().
+		 * It is possible to call this method multiple times, but each call reserves its own internal clearance, so there must be the same number of calls to leaveUiTransaction to properly release clearance and allow background sync.
 		 * @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.
+		 * Provides means to control concurrent access to data by form logic and background sync.
+		 * This method releases the last clearance obtained by successful call to tryEnterUiTransaction.
+		 * Can be called even if all clearances are already released or were not obtained at all.
+		 * See tryEnterUiTransaction for more info.
 		 */
-		public static leaveUiTransaction(): Promise;
+		public static leaveUiTransaction(): Promise<void>;
 		/**
 		 * @since 9.3
 		 * Binds or unbinds the handler for onSelectedViewChanged event on EntityForm.

package/src/JSBridge.js

@@ -4479,7 +4479,7 @@
 			/// <summary>[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.</summary>
 			/// <param name="fetch" type="String">The fetch XML defining the entity (entities) query used as report input.</param>
 			/// <param name="reportXML" type="String">The mobile report XML definition which can be loaded from the resco_report entity or constructed dynamically. Ignored if IsExportOnly parameter is true.</param>
-			/// <param name="reportFormat" type="String">Report format: Pdf (default), Html, Excel, Text.</param>
+			/// <param name="reportFormat" type="String">Report format: Pdf (default), Html, Excel, Word.</param>
 			/// <param name="isExportOnly" type="Boolean">If true then ReportXml is optional. The default is false.</param>
 			/// <param name="isOnline" type="Boolean">Indicates whether the report should be run against the online data or local database. The default is current application mode.</param>
 			/// <param name="outputFile" type="String">The full path to the output file. If omitted a temp file is created. The output path is always passed to the success callback.</param>
@@ -4499,7 +4499,7 @@
 			/// <summary>[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.</summary>
 			/// <param name="fetch" type="String">The fetch XML defining the entity (entities) query used as report input.</param>
 			/// <param name="reportXML" type="String">The mobile report XML definition which can be loaded from the resco_mobilereport entity or constructed dynamically. Ignored if IsExportOnly parameter is true.</param>
-			/// <param name="reportFormat" type="String">Report format: Pdf (default), Html, Excel, Text.</param>
+			/// <param name="reportFormat" type="String">Report format: Pdf (default), Html, Excel, Word.</param>
 			/// <param name="isExportOnly" type="Boolean">If true then ReportXml is optional. The default is false.</param>
 			/// <param name="isOnline" type="Boolean">Indicates whether the report should be run against the online data or local database. The default is current application mode.</param>
 			/// <param name="outputFile" type="String">The full path to the output file. If omitted a temp file is created.</param>
@@ -4515,7 +4515,7 @@
 			/// <summary>[v18.0] The request class specifying behavior of MobileCRM.MobileReport.generateReportAsync function.</summary>
 			/// <param name="source" type="String | MobileCRM.Reference">The identifier of report source record(s) as MobileCRM.Reference or fetch in its xml representation.</param>
 			/// <param name="template" type="String | MobileCRM.Reference">The identifier of report template as its string record ID, exact logical name, MobileCRM.Reference or actual xml definition of report.</param>
-			/// <param name="format" type="String">Optional code of report format. Supported values are: Pdf (default), Html, Excel, Text.</param>
+			/// <param name="format" type="String">Optional code of report format. Supported values are: Pdf (default), Html, Excel, Word.</param>
 			/// <param name="customNameOrPath" type="String">Optional custom name of report file or its full path. If not provided, default report name and path are used. When using full path, it is recommended to place it in MobileCRM.Configuration.storageDirectory.</param>
 			/// <param name="languageCode" type="String">Optional iso code (e.g. "en-US") of report language. Currently it only works for reports on localized Questionnaires.</param>
 			/// <param name="waitMessage" type="String">Optional custom message displayed to user while report is being generated. When null or empty string is provided, default message is shown. When undefined, shows no wait message.</param>
@@ -5905,18 +5905,14 @@
 			/// <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 () {
+			/// <summary>[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method obtains a clearance to perform data manipulation. The clearance will be obtained when background sync is not running, or form sync behavior is configured as 'No action'. 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'", the clearance is not obtained. Each obtained clearance must be dutifully released using leaveUiTransaction(). It is possible to call this method multiple times, but each call reserves its own internal clearance, so there must be the same number of calls to leaveUiTransaction to properly release clearance and allow background sync.</summary>
+			/// <returns type="Promise&lt;boolean&gt;">Returns true if clearance is obtained, false if it is not possible at this time.</returns>
 			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 () {
+			/// <summary>[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method releases the last clearance obtained by successful call to tryEnterUiTransaction. Can be called even if all clearances are already released or were not obtained at all. See tryEnterUiTransaction for more info.</summary>
+			/// <returns type="Promise&lt;void&gt;">Returns an awaitable promise.</returns>
 			return MobileCRM.bridge.invokeCommandPromise("leaveUiTransaction");
 		};
 		// MobileCRM.UI.EntityForm.DetailCollection