@resconet/jsbridge 17.1.5 → 17.2.0-beta.1

package/package.json

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

package/src/JSBridge.d.ts

@@ -70,6 +70,16 @@ declare namespace MobileCRM {
 		public static requestObject(callback: (config: Configuration) => void, erroCallback?: (error: string) => void, scope?: any);
 	}
 
+	class GlobalConstants {
+		/**Gets the JSON object representing the GlobalConstants variables. */
+		public static getAllAsync(): Promise<Object>;
+		/**
+		 *Gets the constant associated with specified key in the GlobalConstants variables.
+		 * @param key The key of the constant to get.
+		 */
+		public static getAsync(key: String): Promise<Object>;
+	}
+
 	class Settings {
 		/**Gets the absolute URL (including the CrmOrganization).*/
 		absoluteUrl: string;
@@ -1042,7 +1052,7 @@ declare namespace MobileCRM {
 		 * @param failed A callback which is called in case of error.
 		 * @param scope The scope for callbacks.
 		 */
-		static showForm(report: MobileCRM.Reference, source: Array<MobileCRM.Reference>, fetchXml: string, failed?: (err: string) => void, scope?: any);
+		static showForm(report: MobileCRM.Reference, source: MobileCRM.Reference[], fetchXml: string, failed?: (err: string) => void, scope?: any);
 		/**
 		 * @since 16.0
 		 * Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.
@@ -1055,7 +1065,7 @@ declare namespace MobileCRM {
 		 */
 		static showFormWithConfiguration(
 			report: MobileCRM.Reference,
-			source: Array<MobileCRM.Reference>,
+			source: MobileCRM.Reference[],
 			fetchXml: string,
 			paramString: string,
 			failed?: (err: string) => void,
@@ -1075,13 +1085,20 @@ declare module MobileCRM.FetchXml {
 	/**
 	 * @class Represents a FetchXml
 	 * @property entity {MobileCRM.FetchXml.Entity} An entity object.
-	 * @property  count {number} The maximum number of records to retrieve.
-	 * @property  page {number} 1-based index of the data page to retrieve.
-	 * @property  aggregate {boolean} Indicates whether the fetch is aggregated.
-	 * @property  distinct {boolean} Indicates whether to return only distinct (different) values.
+	 * @property count {number} The maximum number of records to retrieve.
+	 * @property page {number} 1-based index of the data page to retrieve.
+	 * @property aggregate {boolean} Indicates whether the fetch is aggregated.
+	 * @property distinct {boolean} Indicates whether to return only distinct (different) values.
 	 */
 	class Fetch {
-		constructor(entity?: MobileCRM.FetchXml.Entity, count?: number, page?: number, distinct?: boolean);
+		/** Constructs Fetch object
+		 * @param entity {MobileCRM.FetchXml.Entity} An entity object.
+		 * @param count {number} The maximum number of records to retrieve.
+		 * @param page {number} 1-based index of the data page to retrieve.
+		 * @param distinct {boolean} Indicates whether to return only distinct (different) values.
+		 * @param aggregate {boolean} Indicates whether the fetch is aggregated.
+		 */
+		constructor(entity?: MobileCRM.FetchXml.Entity, count?: number, page?: number, distinct?: boolean, aggregate?: boolean);
 
 		public entity: MobileCRM.FetchXml.Entity;
 		count: number;
@@ -1096,7 +1113,7 @@ declare module MobileCRM.FetchXml {
 		 * @param failed A callback function for command failure. The error argument will carry the error message.
 		 * @param scope A scope for calling the callbacks. Set to call the callbacks in global scope.
 		 */
-		public static executeFromXML(fetchXmlData: string, success: (res: Array<any>) => void, failed?: (error: string) => void, scope?: any);
+		public static executeFromXML(fetchXmlData: string, success: (res: any[]) => void, failed?: (error: string) => void, scope?: any);
 		/**
 		 * @since 10.0
 		 * Deserializes XML to the Fetch object.
@@ -1134,7 +1151,7 @@ declare module MobileCRM.FetchXml {
 		 * @param failed A callback function for command failure. The error argument will carry the error message.
 		 * @param scope A scope for calling the callbacks. Set to call the callbacks in global scope.
 		 */
-		public execute(output: string, success: (res: Array<any>) => void, failed?: (err: string) => void, scope?: any);
+		public execute(output: string, success: (res: any[]) => void, failed?: (err: string) => void, scope?: any);
 		/**
 		 * @since 8.0
 		 * Performs the online CRM Fetch request regardless of the app online/offline mode.
@@ -1143,7 +1160,7 @@ declare module MobileCRM.FetchXml {
 		 * @param failed A callback function for command failure. The error argument will carry the error message.
 		 * @param scope A scope for calling the callbacks. Set to call the callbacks in global scope.
 		 */
-		public executeOnline(output: string, success: (res: Array<any>) => void, failed?: (error: string) => void, scope?: any);
+		public executeOnline(output: string, success: (res: any[]) => void, failed?: (error: string) => void, scope?: any);
 		/**
 		 * @since 8.0
 		 * Performs the offline CRM Fetch request regardless of the app online/offline mode.
@@ -1152,7 +1169,7 @@ declare module MobileCRM.FetchXml {
 		 * @param failed A callback function for command failure. The error argument will carry the error message.
 		 * @param scope A scope for calling the callbacks. Set to call the callbacks in global scope.
 		 */
-		public executeOffline(output: string, success: (res: Array<any>) => void, failed?: (error: string) => void, scope?: any);
+		public executeOffline(output: string, success: (res: any[]) => void, failed?: (error: string) => void, scope?: any);
 		/**
 		 * Performs the asynchronous CRM Fetch request.
 		 * @param output A string defining the output format: Array, JSON, XML or DynamicEntities.
@@ -1164,19 +1181,32 @@ declare module MobileCRM.FetchXml {
 	/**
 	 * @class Represents a FetchXml query root entity.
 	 * @param name {string} An entity logical name.
-	 * @property attributes {Array<Attribute>}  An array of <see cref="MobileCRM.FetchXml.Attribute">MobileCRM.FetchXml.Attribute</see> objects.
-	 * @property order {Array<Order>} An array of {MobileCRM.FetchXml.Order} objects
+	 * @property attributes {Attribute[]}  An array of <see cref="MobileCRM.FetchXml.Attribute">MobileCRM.FetchXml.Attribute</see> objects.
+	 * @property order {Order[]} An array of {MobileCRM.FetchXml.Order} objects
 	 * @property filter {Filter} A query filter.
-	 * @property linkentities {Array<LinkEntity>} An array of {MobileCRM.FetchXml.LinkEntity} objects.
+	 * @property linkentities {LinkEntity[]} An array of {MobileCRM.FetchXml.LinkEntity} objects.
 	 */
 	class Entity {
-		constructor(name: string);
+		/**
+		 * Constructs Entity object
+		 * @param name An entity logical name.
+		 * @param attributes An array of Attribute objects or "*" for all attributes.
+		 * @param order An array of Order objects.
+		 * @param filter A query filter.
+		 * @param linkentities An array of LinkEntity objects.
+		 */
+		constructor(name: string, attributes?: Attribute[] | "*", order?: Order[], filter?: Filter, linkentities?: LinkEntity[]);
 
+		/** An entity logical name. */
 		name: string;
-		attributes: Array<Attribute>;
-		order: Array<Order>;
+		/** An array of Attribute objects. */
+		attributes: Attribute[];
+		/** An array of Order objects. */
+		order: Order[];
+		/** A query filter. */
 		filter: Filter;
-		linkentities: Array<LinkEntity>;
+		/** An array of LinkEntity objects. */
+		linkentities: LinkEntity[];
 
 		/**
 		 * Adds an order by statement to the fetch query.
@@ -1240,7 +1270,28 @@ declare module MobileCRM.FetchXml {
 	 * @property  alias {string} Defines an order alias.
 	 */
 	class LinkEntity extends Entity {
-		constructor(name: string);
+		/** Constructs LinkEntity object.
+		 * @param name An entity logical name.
+		 * @param attributes An array of Attribute objects or "*" for all attributes.
+		 * @param order An array of Order objects.
+		 * @param filter A query filter.
+		 * @param linkentities An array of LinkEntity objects.
+		 * @param  from {number} The "from" field (if parent then target entity primary key).
+		 * @param  to {number}
+		 * @param  alias {string} Defines an order alias.
+		 * @param  linktype {boolean} The link (join) type ("inner" or "outer").
+		 */
+		constructor(
+			name: string,
+			attributes?: Attribute[] | "*",
+			order?: Order[],
+			filter?: Filter,
+			linkentities?: LinkEntity[],
+			from?: string,
+			to?: string,
+			alias?: string,
+			linkType?: string
+		);
 
 		from: string;
 		to: string;
@@ -1257,7 +1308,16 @@ declare module MobileCRM.FetchXml {
 	 * @property  dategrouping {string} A date group by modifier (year, quarter, month, week, day).
 	 */
 	class Attribute {
-		constructor(name: string);
+		/**
+		 * Constructs Attribute object.
+		 * @param name A lower-case entity attribute name (CRM logical field name).
+		 * @param alias Defines an order alias.
+		 * @param aggregate An aggregation function.
+		 * @param groupBy Indicates whether to group by this attribute.
+		 * @param dateGrouping A date group by modifier (year, quarter, month, week, day).
+		 */
+		constructor(name: string, alias?: string, aggregate?: boolean, groupBy?: boolean, dateGrouping?: string);
+
 		name: string;
 		aggregate: string;
 		groupby: boolean;
@@ -1271,7 +1331,13 @@ declare module MobileCRM.FetchXml {
 	 * @property  descending {boolean} true, for descending order; false, for ascending order
 	 */
 	class Order {
-		constructor(attribute?: string, descending?: boolean);
+		/**
+		 * Constructs Order object
+		 * @param attribute An attribute name (CRM logical field name).
+		 * @param descending true, for descending order; false, for ascending order
+		 * @param alias Defines an order alias.
+		 */
+		constructor(attribute?: string, descending?: boolean, alias?: string);
 		attribute: string;
 		alias: string;
 		descending: boolean;
@@ -1279,13 +1345,21 @@ declare module MobileCRM.FetchXml {
 	/**
 	 * @class Represents a FetchXml filter statement. A logical combination of {Condition} and child-filters.
 	 * @property  type {string} Defines the filter operator ("or" / "and").
-	 * @property  conditions {Array<Condition>} An array of {Condition} objects.
-	 * @property  filters { Array<Filter>} An array of <see cref="MobileCRM.FetchXml.Filter"/> objects representing child-filters.
+	 * @property  conditions {Condition[]} An array of {Condition} objects.
+	 * @property  filters {Filter[]} An array of {Filter} objects representing child-filters.
 	 */
 	class Filter {
+		/**
+		 * Constructs {Filter} object.
+		 * @param type Defines the filter operator ("or" / "and").
+		 * @param conditions  An array of {Condition} objects.
+		 * @param filters  An array of {Filter} objects representing child-filters.
+		 */
+		constructor(type?: string, conditions?: Condition[], filters?: Filter[]);
+
 		type: string;
-		conditions: Array<Condition>;
-		filters: Array<Filter>;
+		conditions: Condition[];
+		filters: Filter[];
 		/**
 		 * Adds a attribute condition to the filter.
 		 * @param attribute The attribute name (CRM logical field name).
@@ -1338,16 +1412,27 @@ declare module MobileCRM.FetchXml {
 	 * @property  uitype {string} The lookup target entity display name.
 	 * @property  uiname {string} The lookup target entity logical name.
 	 * @property  value {any} The value to compare to.
-	 * @property  values {Array<any>} The list of values to compare to.
+	 * @property  values {any[]} The list of values to compare to.
 	 */
 	class Condition {
+		/**
+		 * Constructs {Condition} object.
+		 * @param attribute The attribute name (CRM logical field name).
+		 * @param operator The condition operator. "eq", "ne", "in", "not-in", "between", "not-between", "lt", "le", "gt", "ge", "like", "not-like", "null", "not-null", "eq-userid", "eq-userteams", "today", "yesterday", "tomorrow", "this-year", "last-week", "last-x-hours", "next-x-years", "olderthan-x-months", ...
+		 * @param value The value (or values) to compare to.
+		 * @param entityName The link name or alias to which this condition is relative to.
+		 * @param refTarget The lookup target entity logical name.
+		 * @param refLabel The lookup target entity display name.
+		 */
+		constructor(attribute?: string, operator?: string, value?: any | any[], entityName?: string, refTarget?: string, refLabel?: string);
+
 		attribute: string;
 		entityname: string;
 		operator: string;
 		uitype: string;
 		uiname: string;
 		value: any;
-		values: Array<any>;
+		values: any[];
 	}
 }
 declare module MobileCRM.Services {

package/src/JSBridge.js

@@ -219,6 +219,9 @@
 				/// <field name="settings" type="MobileCRM._Settings">Gets the application settings.</field>
 				/// <field name="storageDirectory" type="String">Gets the root folder of the application storage.</field>
 			},
+			GlobalConstants: function () {
+				/// <summary>Provides access to the global constants.</summary>
+			},
 			CultureInfo: function () {
 				/// <summary>[v10.2] Provides information about current device culture. The information includes the names for the culture, the writing system, the calendar used, and formatting for dates.</summary>
 				/// <field name="name" type="String">Gets the culture name in the format languageCode/region (e.g. &quot;en-US&quot;). languageCode is a lowercase two-letter code derived from ISO 639-1. regioncode is derived from ISO 3166 and usually consists of two uppercase letters.</field>
@@ -402,12 +405,13 @@
 				/// <field name="isSingularParty" type="Boolean">Gets whether the property represents a singular activity party property. These properties exists as both a Lookup property on the entity and an ActivytParty record.</field>
 			},
 			FetchXml: {
-				Fetch: function (entity, count, page, distinct) {
+				Fetch: function (entity, count, page, distinct, aggregate) {
 					/// <summary>Represents a FetchXml query object.</summary>
 					/// <param name="entity" type="MobileCRM.FetchXml.Entity">An entity object.</param>
 					/// <param name="count" type="int">the maximum number of records to retrieve.</param>
 					/// <param name="page" type="int">1-based index of the data page to retrieve.</param>
 					/// <param name="distinct" type="bool">Whether to return only distinct (different) values.</param>
+					/// <param name="aggregate" type="bool">Indicates whether the fetch is aggregated.</param>
 					/// <field name="aggregate" type="Boolean">Indicates whether the fetch is aggregated.</field>
 					/// <field name="count" type="int">the maximum number of records to retrieve.</field>
 					/// <field name="entity" type="MobileCRM.FetchXml.Entity">An entity object.</field>
@@ -422,12 +426,12 @@
 					if (typeof page !== "undefined") {
 						this.page = page;
 					}
-					this.aggregate = false;
+					this.aggregate = !!aggregate;
 					if (typeof distinct !== "undefined") {
 						this.distinct = distinct;
 					}
 				},
-				Entity: function (name) {
+				Entity: function (name, attributes, order, filter, linkentities) {
 					/// <summary>Represents a FetchXml query root entity.</summary>
 					/// <param name="name" type="String">An entity logical name.</param>
 					/// <field name="allattributes" type="Boolean">Indicates whether to fetch all attributes instead of explicitly chosen set.</field>
@@ -439,22 +443,42 @@
 					if (name) {
 						this.name = name;
 					}
-					this.attributes = [];
-					this.order = [];
-					this.filter = null;
-					this.linkentities = [];
+					if (attributes) {
+						if (attributes == "*") {
+							this.allattributes = true;
+						} else {
+							this.attributes = attributes;
+						}
+					} else {
+						this.attributes = [];
+					}
+					this.order = order instanceof Array ? order : [];
+					this.filter = filter ? filter : null;
+					this.linkentities = linkentities ? linkentities : [];
 				},
-				LinkEntity: function () {
+				LinkEntity: function (name, attributes, order, filter, linkentities, from, to, alias, linkType) {
 					/// <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>
+					/// <field name="linktype" type="String">The link (join) type ("inner" or "outer").</field>
 					/// <field name="to" type="String">The "to" field.</field>
 					MobileCRM.FetchXml.LinkEntity.superproto.constructor.apply(this, arguments);
+					if (from) {
+						this.from = from;
+					}
+					if (to) {
+						this.to = to;
+					}
+					if (alias) {
+						this.alias = alias;
+					}
+					if (linkType) {
+						this.linktype = linkType;
+					}
 				},
-				Attribute: function (name) {
+				Attribute: function (name, alias, aggregate, groupBy, dateGrouping) {
 					/// <summary>Represents a FetchXml select statement (CRM field).</summary>
 					/// <param name="name" type="String">A lower-case entity attribute name (CRM logical field name).</param>
 					/// <field name="aggregate" type="String">An aggregation function.</field>
@@ -465,9 +489,18 @@
 					if (name) {
 						this.name = name;
 					}
-					this.groupby = false;
+					if (alias) {
+						this.alias = alias;
+					}
+					this.groupby = !!groupBy;
+					if (aggregate) {
+						this.aggregate = aggregate;
+					}
+					if (dateGrouping) {
+						this.dategrouping = dateGrouping;
+					}
 				},
-				Order: function (attribute, descending) {
+				Order: function (attribute, descending, alias) {
 					/// <summary>Represents a FetchXml order statement.</summary>
 					/// <param name="attribute" type="String">An attribute name (CRM logical field name).</param>
 					/// <param name="descending" type="Boolean">true, for descending order; false, for ascending order</param>
@@ -478,16 +511,22 @@
 						this.attribute = attribute;
 					}
 					this.descending = descending ? true : false;
+					if (alias) {
+						this.alias = alias;
+					}
 				},
-				Filter: function () {
+				Filter: function (type, conditions, filters) {
 					/// <summary>Represents a FetchXml filter statement. A logical combination of <see cref="MobileCRM.FetchXml.Condition">Conditions</see> and child-filters.</summary>
 					/// <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.conditions = [];
-					this.filters = [];
+					if (type) {
+						this.type = type;
+					}
+					this.conditions = conditions instanceof Array ? conditions : [];
+					this.filters = filters instanceof Array ? filters : [];
 				},
-				Condition: function () {
+				Condition: function (attribute, operator, value, entityName, refTarget, refLabel) {
 					/// <summary>Represents a FetchXml attribute condition statement.</summary>
 					/// <field name="attribute" type="String">The attribute name (CRM logical field name).</field>
 					/// <field name="operator" type="String">The condition operator. "eq", "ne", "in", "not-in", "between", "not-between", "lt", "le", "gt", "ge", "like", "not-like", "null", "not-null", "eq-userid", "eq-userteams", "today", "yesterday", "tomorrow", "this-year", "last-week", "last-x-hours", "next-x-years", "olderthan-x-months", ...</field>
@@ -496,7 +535,29 @@
 					/// <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>
+					if (attribute) {
+						this.attribute = attribute;
+					}
+					if (operator) {
+						this.operator = operator;
+					}
 					this.values = [];
+					if (value) {
+						if (value instanceof Array) {
+							this.values = value;
+						} else {
+							this.value = value;
+						}
+					}
+					if (entityName) {
+						this.entityname = entityName;
+					}
+					if (refTarget) {
+						this.uitype = refTarget;
+					}
+					if (refLabel) {
+						this.uiname = refLabel;
+					}
 				},
 			},
 			Platform: function () {
@@ -1622,6 +1683,18 @@
 				scope
 			);
 		};
+		//MobileCRM.GlobalConstants
+		MobileCRM.GlobalConstants.getAllAsync = function () {
+			/// <summary>Asynchronously returns the JSON object representing the GlobalConstants variables.</summary>
+			/// <returns type="Promise&lt;Object&gt;">A Promise object that will be resolved with the properties representing the constant variables.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("getGlobalConstants");
+		};
+		MobileCRM.GlobalConstants.getAsync = function (key) {
+			/// <summary>Asynchronously returns the constant associated with the specified key in the GlobalConstants variables.</summary>
+			/// <param name="key" type="String">The key of the constant to get.</param>
+			/// <returns type="Promise&lt;Object&gt;">A Promise object that will be resolved with an object representing the constant variable.</returns>
+			return MobileCRM.bridge.invokeCommandPromise("getGlobalConstants", key);
+		};
 		// MobileCRM._Settings
 		MobileCRM._Settings = {
 			/// <summary>MobileCRM configuration settings class.</summary>