@resconet/jsbridge 15.2.0 → 15.3.0

package/package.json

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

package/src/JSBridge.d.ts

@@ -1,5 +1,4 @@
 // JSBridge.js TypeScript definition file
-// v15.2
 // (c) 2022 Resco
 
 declare module MobileCRM {
@@ -50,7 +49,7 @@ declare module MobileCRM {
 
 		public static requestObject(callback: (config: Configuration) => void, erroCallback?: (error: string) => void, scope?: any);
 	}
-    
+
     class Settings {
         /**Gets the absolute URL (including the CrmOrganization).*/
 		absoluteUrl: string;
@@ -127,7 +126,7 @@ declare module MobileCRM {
         forcedFullSyncDate: Date;
         /**Prevents remembered password to be used for next login.*/
         forgetPassword: boolean;
-        /**Gets or sets the option for generating the entity full name (contact, lead) 
+        /**Gets or sets the option for generating the entity full name (contact, lead)
         e.g. how to combine the first, middle and last name (0="L,F", 1="F L", 2="L,F m", 3="F m L", 4="L,F M", 5="F M L", 6="L F", 7="LF").*/
         fullNameConventionCode: number;
         /**Gets whether there were any synchronization errors encountered.*/
@@ -150,7 +149,7 @@ declare module MobileCRM {
 		isDemoUser: boolean;
         /**Gets whether the login is for a CRM Online instance.*/
         isCrmOnline: boolean
-        /**Gets whether the login information is valid and complete. 
+        /**Gets whether the login information is valid and complete.
         Indicates whether the user name and password are non-empty.
         Whether they are correct is up to the we service. Also checks whether the web service url is non-empty.*/
         isValid: boolean;
@@ -661,12 +660,12 @@ declare module MobileCRM {
 	}
 
 	class Application {
-		public static synchronize(backgroundOnly: boolean, ifNotSyncedBefore: Date);
-		public static synchronizeOnForeground(forceLogin: boolean);
-		public static getAppColor(colName: string, success: (url: string) => void, failed?: (err: string) => void, scope?: any);
-		public static getAppImage(imageName: string, colorize: string, success: (url: string) => void, failed?: (err: string) => void, scope?: any);
+		static synchronize(backgroundOnly: boolean, ifNotSyncedBefore: Date);
+		static synchronizeOnForeground(forceLogin: boolean);
+		static getAppColor(colName: string, success: (url: string) => void, failed?: (err: string) => void, scope?: any);
+		static getAppImage(imageName: string, colorize: string, success: (url: string) => void, failed?: (err: string) => void, scope?: any);
 		/** Display application login form. */
-		public static showAppLogin();
+		static showAppLogin();
 		/**
 		 * Sets the application colors.
 		 * @since 11.2.2
@@ -675,7 +674,7 @@ declare module MobileCRM {
 		 * @param failed The error callback which is called asynchronously in case of error.
 		 * @param scope  The scope for callbacks.
 		 */
-		public static setAppColors(colors: { [colorName: string]: number | string }, success?: () => void, failed?: (err: string) => void, scope?: any);
+		static setAppColors(colors: { [colorName: string]: number | string }, success?: () => void, failed?: (err: string) => void, scope?: any);
 		/**
 		 * Gets the last detected time change.
 		 * @since 13.3.1
@@ -683,19 +682,42 @@ declare module MobileCRM {
 		 * @param failed The error callback which is called asynchronously in case of error.
 		 * @param scope Optional scope for callbacks.
 		 */
-		public static getLastSignificantTimeChange(success: (timeChange: ITimeChange) => void, failed?: (err: string) => void, scope?: any);
-		public static fileExists(path: string, success: (exist: boolean) => void, failed?: (err: string) => void, scope?: any);
-		public static directoryExists(path: string, success: (exist: boolean) => void, failed?: (err: string) => void, scope?: any);
-		public static createDirectory(path: string, success?: () => void, failed?: (err: string) => void, scope?: any);
-		public static deleteDirectory(path: string, success?: () => void, failed?: (err: string) => void, scope?: any);
-		public static getDirectories(path: string, success: (directoriesList: Array<string>) => void, failed?: (err: string) => void, scope?: any);
-		public static deleteFile(path: string, success?: () => void, failed?: (error: string) => void, scope?: any);
-		public static getFiles(path: string, success: (filesList: Array<string>) => void, failed?: (err: string) => void, scope?: any);
-		public static moveFile(src: string, dst: string, success?: () => void, failed?: (err: string) => void, scope?: any);
-		public static readFile(path: string, success: (fileContent: string) => void, failed?: (err: string) => void, scope?: any);
-		public static writeFile(path: string, text: string, append: boolean, success?: () => void, failed?: (err: string) => void, scope?: any);
-		public static readFileAsBase64(path: string, success: (base64: string) => void, failed?: (err: string) => void, scope?: any);
-		public static writeFileFromBase64(path: string, base64: string, success?: () => void, failed?: (err: string) => void, scope?: any);
+		static getLastSignificantTimeChange(success: (timeChange: ITimeChange) => void, failed?: (err: string) => void, scope?: any);
+		static fileExists(path: string, success: (exist: boolean) => void, failed?: (err: string) => void, scope?: any);
+		static fileExistsAsync(path: string): Promise<boolean>;
+		static directoryExists(path: string, success: (exist: boolean) => void, failed?: (err: string) => void, scope?: any);
+		static directoryExistsAsync(path: string): Promise<boolean>;
+		static createDirectory(path: string, success?: () => void, failed?: (err: string) => void, scope?: any);
+		static createDirectoryAsync(path: string): Promise<void>;
+		static deleteDirectory(path: string, success?: () => void, failed?: (err: string) => void, scope?: any);
+		static deleteDirectoryAsync(path: string): Promise<void>;
+		static getDirectories(path: string, success: (directoriesList: Array<string>) => void, failed?: (err: string) => void, scope?: any);
+		static getDirectoriesAsync(path: string): Promise<string[]>;
+		static deleteFile(path: string, success?: () => void, failed?: (error: string) => void, scope?: any);
+		static deleteFileAsync(path: string): Promise<void>;
+		static getFiles(path: string, success: (filesList: Array<string>) => void, failed?: (err: string) => void, scope?: any);
+		static getFilesAsync(path: string): Promise<string[]>;
+		static moveFile(src: string, dst: string, success?: () => void, failed?: (err: string) => void, scope?: any);
+		static moveFileAsync(src: string, dst: string): Promise<void>;
+		static readFile(path: string, success: (fileContent: string) => void, failed?: (err: string) => void, scope?: any);
+		/**
+		 * @since 15.3
+		 * Reads the file from the application local data and asynchronously gets its content.
+		 * @param path Defines the relative path of the file in the application local data.
+		 * @param encoding Defines the text encoding for file content (default is UTF8). Use base64 for binary files. Supported values: UTF8, UTF16 ASCII, BASE64.
+		 */
+		static readFileAsync(path: string, encoding?: "UTF8" | "UTF16" | "ASCII" | "base64"): Promise<string>;
+		static writeFile(path: string, text: string, append: boolean, success?: () => void, failed?: (err: string) => void, scope?: any);
+		/**
+		 * @since 15.3
+		 * Asynchronously writes data into the file from the application local data.
+		 * @param path Defines the relative path of the file in the application local data.
+		 * @param text Defines the file content (in corresponding text encoding) to be written.
+		 * @param encoding Defines the text encoding for file content (default is UTF8). Use base64 for binary files. Supported values: UTF8, UTF16 ASCII, BASE64.
+		 */
+		static writeFileAsync(path: string, text: string, encoding?: "UTF8" | "UTF16" | "ASCII" | "base64"): Promise<void>;
+		static readFileAsBase64(path: string, success: (base64: string) => void, failed?: (err: string) => void, scope?: any);
+		static writeFileFromBase64(path: string, base64: string, success?: () => void, failed?: (err: string) => void, scope?: any);
 		/**
 		 * @since 9.0.2
 		 * Asynchronously writes the text into the file from the application local data.
@@ -707,7 +729,7 @@ declare module MobileCRM {
 		 * @param errorCallback The errorCallback which is called asynchronously in case of error.
 		 * @param scope The scope for callback.
 		 */
-		public static writeFileWithEncoding(path: string, text: string, encoding: string, append: boolean, success: () => void, failed?: (err: string) => void, scope?: any);
+		static writeFileWithEncoding(path: string, text: string, encoding: string, append: boolean, success: () => void, failed?: (err: string) => void, scope?: any);
 		/**
 		 * @since 12.1
 		 * Asynchronously refresh access token using saved token in protected settings and send serialized token to success callback
@@ -716,7 +738,7 @@ declare module MobileCRM {
 		 * @param errorCallback The errorCallback which is called asynchronously in case of error.
 		 * @param scope The scope for callback.
 		 */
-		public static getAccessToken(resource, success: (textAccessToken: string) => void, failed?: (err: string) => void, scope?: any);
+		static getAccessToken(resource, success: (textAccessToken: string) => void, failed?: (err: string) => void, scope?: any);
 		/**
 		 * Checks whether the current user is member of the passed roles. Role can be either the Guid (aeb33d0f-89b4-e111-9c9a-00155d0b710a) or the role Name.
 		 * @param roles Defines the roles to check.
@@ -724,7 +746,7 @@ declare module MobileCRM {
 		 * @param failed A callback function for command failure. The error argument will carry the error message.
 		 * @param scope A scope for calling the callback.
 		 */
-		public static checkUserRoles(roles: [string], success?: (roles: number) => void, failed?: (err: string) => void, scope?: any);
+		static checkUserRoles(roles: [string], success?: (roles: number) => void, failed?: (err: string) => void, scope?: any);
 	}
 
 	class AboutInfo {
@@ -742,13 +764,13 @@ declare module MobileCRM {
 
 	/**
 	 * @since 13.0
-	 * Encapsulate methods and properties what can be used for integration. 
+	 * Encapsulate methods and properties what can be used for integration.
 	 */
 	class Integration {
 		/**
 		 * @since 13.0
 		 * Asynchronously gets the token using passed OAuth settings and parameters. Configuration name is used to find already settings.
-		 * @param configurationName Define the name of oauth configuration, what is key for saved setting if any. 
+		 * @param configurationName Define the name of oauth configuration, what is key for saved setting if any.
 		 * @param oauthSettings Defines the OAuth settings for authentication.
 		 * @param prompt Whether to force the user to enter credentials again.
 		 * @param success A callback function for successful asynchronous result. The <b>result</b> will carry a string with the access token.
@@ -759,8 +781,8 @@ declare module MobileCRM {
 	}
 
 	/**
-	 * @since 13.0 
-	 * Represents the settings what are used to authenticate using OAuth server account 
+	 * @since 13.0
+	 * Represents the settings what are used to authenticate using OAuth server account
 	 */
 	class OAuthSettings {
 		/**
@@ -768,7 +790,6 @@ declare module MobileCRM {
 		 * @param configName The Configuration name.
 		 */
 		constructor();
-		
 		/** Gets or sets the OAuth token url. */
 		public authorityEndPoint: string;
 		/** Gets or sets the authorization url to get authorization code. */
@@ -1538,7 +1559,7 @@ declare module MobileCRM.UI {
 		*/
 		cancelValidation(errorMsg: string);
 		/**
-		* @since 8.0 
+		* @since 8.0
 		* Selects the form tab by its name.
 		* @param tabName The name of the tab.
 		* @param errorCallback The errorCallback which is called asynchronously in case of error.
@@ -1546,7 +1567,7 @@ declare module MobileCRM.UI {
 		*/
         selectTab(tabName: string, errorCallback?: (err: string) => void, scope?: any);
         /**
-        * @since 8.0 
+        * @since 8.0
         * Selects the form tab by its name using static method.
         * @param tabName The name of the tab.
         * @param errorCallback The errorCallback which is called asynchronously in case of error.
@@ -1604,7 +1625,7 @@ declare module MobileCRM.UI {
 		/**
 		* Binds or unbinds the handler for onSave event on EntityForm.
 		* @param handler The handler function that has to be bound or unbound.
-		* @param bind Determines whether to bind or unbind the handler.	
+		* @param bind Determines whether to bind or unbind the handler.
 		* @param scope The scope for callbacks.
 		*/
 		public static onSave(handler: (entityForm: EntityForm) => void, bind: boolean, scope?: any);
@@ -1624,7 +1645,7 @@ declare module MobileCRM.UI {
 		*/
 		public static onProcessLoaded(handler: (entityForm: EntityForm) => void, bind: boolean, scope?: any);
 		/**
-		* @since 11.2 
+		* @since 11.2
 		* Binds or unbinds the handler for specific item change event on EntityForm.
 	    * @param itemName The name of desired detail item (mostly logical name of the field).
 		* @param handler The handler function that has to be bound or unbound.
@@ -2083,7 +2104,7 @@ declare module MobileCRM.UI {
 		public static trySetAnswer(questionName: string, answer: any, errorCallback?: (err: string) => void, scope?: any);
 		/**
 		 * Asynchronously sets the image as answer value for this question
-		 * @param imageQuestionName 
+		 * @param imageQuestionName
 		 * @param base64Data A value that us used to create image answer.
 		 * @param mimeType The valid mime type of corresponding base64Data.
 		 * @param errorCallback A callback which is called in case of error.
@@ -2135,7 +2156,7 @@ declare module MobileCRM.UI {
 		/**
 		* Binds or unbinds the handler for onSave event on QuestionnaireForm.
 		* @param handler The handler function that has to be bound or unbound.
-		* @param bind Determines whether to bind or unbind the handler.	
+		* @param bind Determines whether to bind or unbind the handler.
 		* @param scope The scope for callbacks.
 		*/
 		public static onSave(handler: (questionnaireForm: QuestionnaireForm) => void, bind: boolean, scope?: any);
@@ -2147,7 +2168,7 @@ declare module MobileCRM.UI {
 		*/
 		public static onChange(handler: (questionnaireForm: QuestionnaireForm) => void, bind: boolean, scope?: any);
 		/**
-		* @since 11.2 
+		* @since 11.2
 		* Binds or unbinds the handler for specific question change event on QuestionnaireForm.
 	    * @param questionName The name of desired question.
 		* @param handler The handler function that has to be bound or unbound.

package/src/JSBridge.js

@@ -1,6 +1,5 @@
-// v15.2
 (function () {
-	var _scriptVersion = 15.2
+	var _scriptVersion = 15.3
 	// Private objects & functions
 	var _inherit = (function () {
 		function _() { }
@@ -2883,6 +2882,11 @@
 	        /// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.FileExists", [path], success, failed, scope);
 	    };
+	    MobileCRM.Application.fileExistsAsync = function (path) {
+	        /// <summary>Checks whether the file with given path exists in application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the file located in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.FileExists", [path]);
+	    };
 
 	    MobileCRM.Application.directoryExists = function (path, success, failed, scope) {
 	        /// <summary>Checks whether the directory with given path exists in the application local data.</summary>
@@ -2892,6 +2896,11 @@
 	        /// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DirectoryExists", [path], success, failed, scope);
 	    };
+	    MobileCRM.Application.directoryExistsAsync = function (path) {
+	        /// <summary>Checks whether the directory with given path exists in the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the directory located in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DirectoryExists", [path]);
+	    };
 
 	    MobileCRM.Application.createDirectory = function (path, success, failed, scope) {
 	        /// <summary>Asynchronously creates the directory in the application local data.</summary>
@@ -2901,6 +2910,11 @@
 	        /// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.CreateDirectory", [path], success, failed, scope);
 	    };
+	    MobileCRM.Application.createDirectoryAsync = function (path) {
+	        /// <summary>Asynchronously creates the directory in the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the directory in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.CreateDirectory", [path]);
+	    };
 
 	    MobileCRM.Application.deleteDirectory = function (path, success, failed, scope) {
 	        /// <summary>Asynchronously deletes the empty directory from the application local data.</summary>
@@ -2910,7 +2924,13 @@
 	        /// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DeleteDirectory", [path], success, failed, scope);
 	    };
-	    MobileCRM.Application.getDirectories = function (path, success, failed, scope) {
+	    MobileCRM.Application.deleteDirectoryAsync = function (path) {
+	        /// <summary>Asynchronously deletes the empty directory from the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the directory in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DeleteDirectory", [path]);
+	    };
+
+		MobileCRM.Application.getDirectories = function (path, success, failed, scope) {
 	        /// <summary>Asynchronously gets the list of directories from the application local data.</summary>
 	        /// <param name="path" type="String">Defines the relative path of the Directory in the application local data.</param>
 	        /// <param name="success" type="function(result)">A callback function which carry the array of directories names.</param>
@@ -2919,6 +2939,11 @@
 
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.GetDirectories", [path], success, failed, scope);
 	    };
+		MobileCRM.Application.getDirectoriesAsync = function (path) {
+	        /// <summary>Asynchronously gets the list of directories from the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the Directory in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.GetDirectories", [path]);
+	    };
 
 	    MobileCRM.Application.deleteFile = function (path, success, failed, scope) {
 	        /// <summary>Asynchronously deletes the file from the application local data.</summary>
@@ -2929,6 +2954,11 @@
 
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DeleteFile", [path], success, failed, scope);
 	    };
+	    MobileCRM.Application.deleteFileAsync = function (path) {
+	        /// <summary>Asynchronously deletes the file from the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the file in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.DeleteFile", [path]);
+	    };
 
 	    MobileCRM.Application.getFiles = function (path, success, failed, scope) {
 	        /// <summary>Asynchronously gets the list of files from the application local data.</summary>
@@ -2939,6 +2969,11 @@
 
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.GetFiles", [path], success, failed, scope);
 	    };
+	    MobileCRM.Application.getFilesAsync = function (path) {
+	        /// <summary>Asynchronously gets the list of files from the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the Directory in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.GetFiles", [path]);
+	    };
 
 	    MobileCRM.Application.moveFile = function (src, dst, success, failed, scope) {
 	        /// <summary>Asynchronously moves the application local file to another location.</summary>
@@ -2949,6 +2984,12 @@
 	        /// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 	        MobileCRM.bridge.invokeStaticMethodAsync("MobileCrm.Data", "MobileCrm.Configuration", "Instance.MoveFile", [src, dst], success, failed, scope);
 	    };
+	    MobileCRM.Application.moveFileAsync = function (src, dst) {
+	        /// <summary>Asynchronously moves the application local file to another location.</summary>
+	        /// <param name="src" type="String">Defines the relative path of the source file in the application local data.</param>
+	        /// <param name="dst" type="String">Defines the relative path of the destination file in the application local data.</param>
+	        return MobileCRM.bridge.invokeStaticMethodPromise("MobileCrm.Data", "MobileCrm.Configuration", "Instance.MoveFile", [src, dst]);
+	    };
 
 	    MobileCRM.Application.readFile = function (path, success, failed, scope) {
 	        /// <summary>Reads the file from the application local data and asynchronously gets its content.</summary>
@@ -2971,6 +3012,12 @@
 	            reader.release();
 	        }
 	    };
+		MobileCRM.Application.readFileAsync = function(path, encoding) {
+	        /// <summary>[v15.3] Reads the file from the application local data and asynchronously gets its content.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the file in the application local data.</param>
+	        /// <param name="encoding" type="String">Defines the text encoding for file content (default is UTF8). Use base64 for binary files. Supported values: UTF8, UTF16 ASCII, BASE64.</param>
+			return MobileCRM.bridge.invokeCommandPromise("readFromLocalStorage", JSON.stringify({path: path, encoding: encoding}));
+		};
 
 	    MobileCRM.Application.writeFile = function (path, text, append, success, failed, scope) {
 	        /// <summary>Asynchronously writes the text into the file from the application local data.</summary>
@@ -2993,6 +3040,13 @@
 	            reader.release();
 	        }
 	    };
+		MobileCRM.Application.writeFileAsync = function(path, text, encoding) {
+	        /// <summary>[v15.3] Asynchronously writes data into the file from the application local data.</summary>
+	        /// <param name="path" type="String">Defines the relative path of the file in the application local data.</param>
+	        /// <param name="text" type="String">Defines the file content (in corresponding text encoding) to be written.</param>
+	        /// <param name="encoding" type="String">Defines the text encoding for file content data. Use base64 for binary files. Supported values: UTF8, ASCII, BASE64.</param>
+			return MobileCRM.bridge.invokeCommandPromise("writeToLocalStorage", JSON.stringify({path: path, text: text, encoding: encoding}));
+		};
 
 	    MobileCRM.Application.writeFileWithEncoding = function (path, text, encoding, append, success, failed, scope) {
 	        /// <summary>[v9.0.2] Asynchronously writes the text into the file from the application local data.</summary>