@resconet/jsbridge 18.0.0-beta.3 → 18.0.0-beta.5

package/package.json

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

package/src/JSBridge.d.ts

@@ -1,5 +1,5 @@
 // JSBridge.js TypeScript definition file
-// (c) 2023 Resco
+// (c) 2024 Resco
 
 /* eslint-disable @typescript-eslint/ban-types */
 /* eslint-disable @typescript-eslint/prefer-namespace-keyword */
@@ -1001,6 +1001,7 @@ declare namespace MobileCRM {
 	 */
 	class MobileReport {
 		/**
+		 * @deprecated Please use {@link generateReportAsync} instead.
 		 * @since 9.1
 		 * 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.
@@ -1025,6 +1026,7 @@ declare namespace MobileCRM {
 			scope?: any
 		);
 		/**
+		 * @deprecated Please use {@link generateReportAsync} instead.
 		 * @since 9.1
 		 * 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.
@@ -1043,6 +1045,50 @@ declare namespace MobileCRM {
 			isOnline: boolean,
 			outputFile: string
 		): Promise<string>;
+
+		/**
+		 * The request class specifying behavior of {@link generateReportAsync} function.
+		 */
+		static GenerateReportRequest = class {
+			/** The identifier of report source record(s) as {@link MobileCRM.Reference} or fetch in its xml representation. */
+			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. */
+			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}. */
+			customNameOrPath: string;
+			/** Optional iso code (e.g. 'en-US') of report language. Currently it only works for reports on localized Questionnaires. */
+			languageCode: string | undefined;
+			/** 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. */
+			waitMessage: string | undefined;
+			/** Optionally specifies if report should be created in Online, or Offline mode. If undefined, the mode in which app is currently running is used. */
+			isOnline: boolean | undefined;
+			/** A {@link MobileCRM.Reference} to parent record. If provided, method will generate new attachment record and link it to the parent record. */
+			attachTo: Reference | undefined;
+			/**
+			 * When {@link attachmentRecord} is provided, optionally specifies the type of attachment entity.
+			 * If not specified, the default attachment entity is created. */
+			attachmentEntity: string | undefined;
+		};
+		/**
+		 * The result class for {@link generateReportAsync} function.
+		 */
+		static GenerateReportResult = class {
+			/** The full file path to generated report. Not present if {@link GenerateReportRequest.attachTo} is provided. */
+			outputReportPath: string | undefined;
+			/** The reference to attachment record containing the generated report. Only present if {@link GenerateReportRequest.attachTo} is provided.*/
+			attachmentRecord: Reference | undefined;
+		};
+		/**
+		 * @since 18.0
+		 * Generates the mobile report based on provided request parameters. The generated report will be saved to file system or attached to a record.
+		 * @param request The request specifying the details of how the report will be created.
+		 * @returns The promise with the result object.
+		 */
+		static generateReportAsync(request: MobileCRM.MobileReport.GenerateReportRequest): Promise<MobileCRM.MobileReport.GenerateReportResult>;
 		/**
 		 * @since 10.1
 		 * Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.
@@ -1853,9 +1899,16 @@ declare module MobileCRM.UI {
 		 * @param index Item index on the view.
 		 * @param dialogSetup Lookup setup for modal lookup dialog.
 		 * @param inlinePickSetup Optional setup for inline lookup picker. Leave empty to use the same setup as modal dialog.
-		 * @param dialogOnly Indicates whether to allow the inline picker. Set "true" to disable the inline picker and always use the modal dialog. Set false to allow the inline picker.
+		 * @param dialogOnly Optional - indicates whether to allow the inline picker. Set "true" to disable the inline picker and always use the modal dialog. Set "false" to allow the inline picker. Default value is "false".
+		 * @param allowCreateNew Optional - [18.0+] indicates whether to allow creation of new items. Default value is "true".
 		 */
-		updateLinkItemViews(index: number, dialogSetup: DetailViewItems.LookupSetup, inlinePickSetup?: DetailViewItems.LookupSetup, dialogOnly?: boolean);
+		updateLinkItemViews(
+			index: number,
+			dialogSetup: DetailViewItems.LookupSetup,
+			inlinePickSetup?: DetailViewItems.LookupSetup,
+			dialogOnly?: boolean = false,
+			allowCreateNew?: boolean = true
+		);
 		/**
 		 * @since 13.1
 		 * Add detail item to desired position in to grid.
@@ -2088,6 +2141,21 @@ declare module MobileCRM.UI {
 			errorCallback?: (err: string) => void,
 			scope?: any
 		);
+		/**
+		 * @since 18.0
+		 * Sets the field value on entity record shown on this EntityForm.
+		 * @param fieldName Logical name of the field that has to be changed.
+		 * @param value New value of entity field with given name.
+		 * @returns A promise resolved with boolean result of native field setter.
+		 */
+		public static setFieldValue(fieldName: string, value: any): Promise<boolean>;
+		/**
+		 * @since 18.0
+		 * Sets several field values on entity record loaded on this EntityForm.
+		 * @param changes An object defining field changes that has to be done on form entity.
+		 * @returns A promise resolved with boolean result of native field setter.
+		 */
+		public static setFieldValues(changes: { [fieldName: string]: any }): Promise<boolean>;
 		/**
 		 * Binds or unbinds the handler for EntityForm command.
 		 * @param command The name of the EntityForm command.
@@ -2255,6 +2323,7 @@ declare module MobileCRM.UI {
 		 */
 		public static requestObject(callback: (entityList: EntityList) => void, errorCallback?: (err: string) => void, scope?: any);
 		/**
+		 * @deprecated Use {@link setDataSourceFactory} instead.
 		 * Sets the entity list data source replacement.
 		 * @see Data source must be set during the document load stage and must not be delayed. It is used only if the entity view iFrame is marked as data source provider in Woodford.
 		 * @param dataSource A data source object implementing the DynamicEntity list loading routine.
@@ -2489,6 +2558,11 @@ declare module MobileCRM.UI {
 		questionnaire: DynamicEntity;
 		/** Custom event context */
 		context: any;
+		/**
+		 * @since 18.0
+		 * Language of the questionnaire
+		 */
+		language: string;
 
 		/**
 		 * Stops the onSave validation and optionally causes an error message to be displayed.

package/src/JSBridge.js

@@ -2892,13 +2892,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 = this._constructFetchParams();
+			var reqParams = JSON.stringify(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 = this._constructFetchParams();
+			var reqParams = JSON.stringify(this._constructFetchParams());
 			return MobileCRM.bridge.invokeCommandPromise("fetchToXml", reqParams);
 		};
 		// MobileCRM.FetchXml.Entity
@@ -3927,17 +3927,22 @@
 			//this.items[index].value = defaultValue !== undefined ? defaultValue : listDataSource[Object.keys(listDataSource)[0]];
 			MobileCRM.bridge.command("detailViewAction", JSON.stringify(data));
 		};
-		MobileCRM.UI._DetailView.prototype.updateLinkItemViews = function (index, dialogSetup, inlinePickSetup, dialogOnly) {
+		MobileCRM.UI._DetailView.prototype.updateLinkItemViews = function (index, dialogSetup, inlinePickSetup, dialogOnly, allowCreateNew) {
 			/// <summary>[v10.1] Changes the <see cref="MobileCRM.UI.DetailViewItems.ComboBoxItem">ComboBoxItem</see> views and/or filters.</summary>
 			/// <param name="index" type="Number">Item index on the view.</param>
 			/// <param name="dialogSetup" type="MobileCRM.UI.DetailViewItems.LookupSetup">Lookup setup for modal lookup dialog.</param>
 			/// <param name="inlinePickSetup" type="MobileCRM.UI.DetailViewItems.LookupSetup">Optional setup for inline lookup picker. Leave empty to use the same setup as modal dialog.</param>
-			/// <param name="dialogOnly" type="Boolean">Indicates whether to allow the inline picker. Set &quot;true&quot; to disable the inline picker and always use the modal dialog. Set &quot;false&quot; to allow the inline picker.<param>
+			/// <param name="dialogOnly" type="Boolean">Optional - indicates whether to allow the inline picker. Set **true** to disable the inline picker and always use the modal dialog. Set **false**; to allow the inline picker. Default value is **true**</param>
+			/// <param name="allowCreateNew" type="Boolean">Optional - [v18.0] Indicates whether to allow creation of new items. Default value is **true**.</param>
 			var xml = "<lookup>";
 			xml += dialogSetup._serialize();
 			if (!dialogOnly && inlinePickSetup) {
 				xml += inlinePickSetup._serialize();
 			}
+			if (allowCreateNew === undefined || allowCreateNew === null) {
+				allowCreateNew = true;
+			}
+			xml += "<createNew>" + (allowCreateNew ? 1 : 0) + "</createNew>";
 			xml += "<dialog>" + (dialogOnly ? 1 : 0) + "</dialog>";
 			xml += "</lookup>";
 			var data = {
@@ -4470,7 +4475,7 @@
 			MobileCRM.bridge.command("showReport", JSON.stringify(params), success, failed, scope);
 		};
 		MobileCRM.MobileReport.runReport = function (fetch, reportXML, reportFormat, isExportOnly, isOnline, outputFile, success, failed, scope) {
-			/// <summary>[v9.1] Executes the mobile reporting request which produces the mobile report document of given format.</summary>
+			/// <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>
@@ -4490,7 +4495,7 @@
 			MobileCRM.bridge.command("runMobileReportAsync", JSON.stringify(params), success, failed, scope);
 		};
 		MobileCRM.MobileReport.runReportAsync = function (fetch, reportXML, reportFormat, isExportOnly, isOnline, outputFile) {
-			/// <summary>[v9.1] Executes the mobile reporting request which produces the mobile report document of given format.</summary>
+			/// <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>
@@ -4504,6 +4509,42 @@
 				});
 			});
 		};
+
+		MobileCRM.MobileReport.GenerateReportRequest = function () {
+			/// <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="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>
+			/// <param name="isOnline" type="Boolean">Optionally specifies if report should be created in Online, or Offline mode. If undefined, the mode in which app is currently running is used.</param>
+			/// <param name="attachTo" type="MobileCRM.Reference">A MobileCRM.Reference to parent record. If provided, method will generate new attachment record and link it to the parent record.</param>
+			/// <param name="attachmentEntity" type="String">When attachmentRecord is provided, optionally specifies the type of attachment entity. If not specified, the default attachment entity is created.</param>
+			this.source = undefined;
+			this.template = undefined;
+			this.format = "Pdf";
+			this.customNameOrPath = undefined;
+			this.languageCode = undefined;
+			this.waitMessage = undefined;
+			this.isOnline = undefined;
+			this.attachTo = undefined;
+			this.attachmentEntity = undefined;
+		};
+		MobileCRM.MobileReport.GenerateReportResult = function () {
+			/// <summary>[v18.0] The result class for MobileCRM.MobileReport.generateReportAsync function.</summary>
+			/// <param name="outputReportPath" type="String">The full file path to generated report. Not present if MobileCRM.MobileReport.GenerateReportRequest.attachTo is provided.</param>
+			/// <param name="attachmentRecord" type="MobileCRM.Reference">The reference to attachment record containing the generated report. Only present if MobileCRM.MobileReport.GenerateReportRequest.attachTo is provided.</param>
+			this.outputReportPath = undefined;
+			this.attachmentRecord = undefined;
+		};
+		MobileCRM.MobileReport.generateReportAsync = async function (request) {
+			/// <summary>[v18.0] Generates the mobile report based on provided request parameters. The generated report will be saved to file system or attached to a record.</summary>
+			/// <param name="request" type="MobileCRM.MobileReport.GenerateReportRequest">The request specifying the details of how the report will be created.</param>
+			/// <returns type="MobileCRM.MobileReport.GenerateReportResult">The promise with <see cref="MobileCRM.MobileReport.GenerateReportResult">GenerateReportResult</see> object.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("generateMobileReportAsync", JSON.stringify(request));
+		};
+
 		MobileCRM.MobileReport.showForm = function (report, source, fetchXml, failed, scope) {
 			/// <summary>[v10.1] Shows new MobileReport form. Source for the report can be defined either as list of <see cref="MobileCRM.Reference">MobileCRM.Reference</see> objects or as FetchXML query.</summary>
 			/// <remarks>If both types of source are passed, user can select which one to use.</remarks>
@@ -4840,7 +4881,7 @@
 			);
 		};
 		MobileCRM.UI.EntityList.setDataSource = function (dataSource) {
-			/// <summary>Sets the entity list data source replacement.</summary>
+			/// <summary>Deprecated: Please use setDataSourceFactory instead. Sets the entity list data source replacement.</summary>
 			/// <remarks><p>Data source must be set during the document load stage and must not be delayed.</p><p>It is used only if the entity view iFrame is marked as data source provider in Woodford.</p></remarks>
 			/// <param name="dataSource" type="MobileCRM.UI.ListDataSource">A data source object implementing the DynamicEntity list loading routine.</param>
 			MobileCRM.UI.EntityList._dataSource = dataSource;
@@ -4994,7 +5035,7 @@
 		// MobileCRM.UI.ListDataSource
 		MobileCRM.UI.ListDataSource = function () {
 			/// <summary>The data source loading routine implementation.</summary>
-			/// <remarks><p>An instance of this object can be used to supply the data source for <see cref="MobileCRM.UI.EntityList.setDataSource">MobileCRM.UI.EntityList.setDataSource</see> function.</p><p>The instance of this object is valid only if the method loadNextChunk is implemented. See example <see cref="MobileCRM.UI.EntityList.setDataSource">here</see>.</p></remarks>
+			/// <remarks><p>An instance of this object can be used to supply the data source for <see cref="MobileCRM.UI.EntityList.setDataSourceFactory">MobileCRM.UI.EntityList.setDataSourceFactory</see> function.</p><p>The instance of this object is valid only if the method loadNextChunk is implemented. See example <see cref="MobileCRM.UI.EntityList.setDataSourceFactory">here</see>.</p></remarks>
 			/// <field name="chunkSize" type="Number">Controls the number of entities loaded in once.</field>
 			/// <field name="fetch" type="MobileCRM.FetchXml.Fetch">Gets the original fetch request for this list view.</field>
 			/// <field name="loadNextChunk" type="function(page, count)">Controls the number of entities loaded in once. It is called from native code to get chunk (array) of <see cref="MobileCRM.DynamicEntity">DynamicEntities</see>. The chunk is defined by 1-based page number and the desired count which corresponds to the value of chunkSize property.</field>
@@ -5689,6 +5730,21 @@
 			/// <param name="scope" type="Object">The scope for callback.</param>
 			MobileCRM.bridge.invokeMethodAsync("EntityForm", "LoadView", [tabName, load], undefined, errorCallback, scope);
 		};
+		MobileCRM.UI.EntityForm.setFieldValue = function (fieldName, value) {
+			/// <summary>[v18.0] Sets the field value on entity record shown on this EntityForm.</summary>
+			/// <param name="fieldName" type="String">Logical name of the field that has to be changed.</param>
+			/// <param name="value" type="any">New value of entity field with given name.</param>
+			/// <returns type="Promise&lt;boolean&gt;">A promise resolved with boolean result of native field setter.</returns>
+			var obj = {};
+			obj[fieldName] = value;
+			return MobileCRM.UI.EntityForm.setFieldValues(obj);
+		};
+		MobileCRM.UI.EntityForm.setFieldValues = function (changes) {
+			/// <summary>[v18.0] Sets several field values on entity record loaded on this EntityForm.</summary>
+			/// <param name="changes" type="{ [fieldName: string]: any }">An object defining field changes that has to be done on form entity record.</param>
+			/// <returns type="Promise&lt;boolean&gt;">A promise resolved with boolean result of native field setter.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("setFormEntityFields", JSON.stringify(changes));
+		};
 		MobileCRM.UI.EntityForm.requestObject = function (callback, errorCallback, scope) {
 			/// <summary>Requests the managed EntityForm object.</summary>
 			/// <remarks>Method initiates an asynchronous request which either ends with calling the <b>errorCallback</b> or with calling the <b>callback</b> with Javascript version of EntityForm object. See <see cref="MobileCRM.Bridge.requestObject">MobileCRM.Bridge.requestObject</see> for further details.</remarks>