@refinitiv-ui/efx-grid 6.0.44 → 6.0.46

package/lib/tr-grid-util/es6/jet/Adc.js

@@ -0,0 +1,268 @@
+import { DataGenerator } from "./DataGenerator.js";
+import { invalidFieldDict } from "./MockUtil.js";
+import { DateTime } from "../DateTime.js";
+
+var dataGen = new DataGenerator();
+
+/** @private
+* @namespace
+*/
+var Adc = {};
+
+/** @private
+* @function
+* @param {Object} payload
+* @param {Object=} mockResponse
+* @return {Promise}
+*/
+Adc.request = function (payload, mockResponse) {
+	if (mockResponse) {
+		return Promise.resolve(JSON.stringify(mockResponse));
+	}
+
+	// build row header
+	var rows = [];
+	var i, f, len, row, j;
+	var identifiers, formula, fields, invalidDict;
+	if(payload.output === "Col,date|,Row,In|,va,T,NoEmptyTickers") {
+
+		identifiers = payload.identifiers;
+		formula =  payload.formula.trim().split(/(?=,TR.)/);// TODO: check each field with another way, this doesn't work when user use some comma (,) formula
+		fields = [];
+
+		// invalidFieldDict is a dictionary of non exist field
+		// so we must remove invalid field to make "mocking api" return result more like a "real api".
+		invalidDict = invalidFieldDict;
+		for (i = 0; i < formula.length; i++) {
+			f = formula[i];
+			if (!invalidDict[f]) {
+				fields.push(f);
+			}
+		}
+
+		var fieldCount = fields.length;
+		// formula = payload.formula.trim().split(",TR"); // TODO: split wit
+
+		rows.push([
+			{
+				"h": true,
+				"i": "instrument",
+				"v": "Instrument"
+			},
+			{
+				"h": true,
+				"i": "date",
+				"v": "Date"
+			}
+		]);
+
+		for (var index = 0; index < fieldCount; index++) {
+			var timeSeriesField = fields[index];
+
+			var regex = /TR.(.*)(?=\()/;
+			var result = timeSeriesField.match(regex);
+			var field = result[0].replace("TR.", "");
+			var phrase = timeSeriesField.toLowerCase();
+			var startDateRegex = /sdate=(.*)[,]/;
+			var endDateRegex = /edate=(.*)[)]/;
+			var startDateMatch = phrase.match(startDateRegex);
+			var endDateMatch = phrase.match(endDateRegex);
+
+			var startDate = startDateMatch ? startDateMatch[1] : DateTime.format(new Date(), "YYYY-MM-DD");
+			var endDate = endDateMatch[1];
+
+			var swapDateTmp;
+			if(startDate > endDate) {
+				swapDateTmp = startDate;
+				startDate = endDate;
+				endDate = swapDateTmp;
+			}
+
+			var msBetweenDate = (+new Date(endDate)) - (+new Date(startDate));
+
+			var msInDay = 1000 * 60 * 60 * 24;
+			var betweenDay = msBetweenDate / msInDay;
+			// var betweenDay = Math.floor(Math.random() * 10); // For random length
+
+
+			for (i = 0; i <= betweenDay; i++) {
+				var date = new Date(new Date(startDate).setDate(new Date(startDate).getDate() + i));
+				var fieldValue = {
+					"h": true,
+					"v": DateTime.format(date, "YYYY-MM-DDT00:00:00")
+				};
+				if(index === 0) { // add header 1 time
+					rows[0].push(fieldValue);
+				}
+			}
+
+			var rics = identifiers;
+			for (i = 0; i < rics.length; i++) {
+
+				var ric = rics[i];
+				var rowValue = [
+					ric,
+					field
+				];
+				for (j = 1; j <= betweenDay + 1; j++) {
+					var generatedValue = DataGenerator.generateRecord(field);
+					rowValue.push(generatedValue[field]);
+
+				}
+				rows.push(rowValue);
+			}
+			// The example rows should be look like
+			/*
+			[
+				[
+				{
+					"h": true,
+					"i": "instrument",
+					"v": "Instrument"
+				},
+				{
+					"h": true,
+					"i": "date",
+					"v": "Date"
+				},
+				{
+					"h": true,
+					"v": "2011-08-11T00:00:00"
+				},
+				{
+					"h": true,
+					"v": "2011-08-12T00:00:00"
+				},
+				{
+					"h": true,
+					"v": "2011-08-15T00:00:00"
+				}
+				],
+				[
+				"IBM",
+				"Price Close", // NOTE: this cannot be detech we join it with space Ex. PriceClose
+				159.25449372,
+				160.6585848,
+				165.23382036
+				],
+				[
+				"GOOGL.O",
+				"Price Close",
+				14.066881653,
+				14.107921423,
+				13.944262828
+				]
+			]
+			*/
+		}
+
+	} else {
+
+		identifiers = payload.identifiers;
+		formula = Adc.splitFields(payload.formula);
+		fields = [];
+
+		// invalidFieldDict is a dictionary of non exist field
+		// so we must remove invalid field to make "mocking api" return result more like a "real api".
+		invalidDict = invalidFieldDict;
+		for (i = 0; i < formula.length; i++) {
+			f = formula[i];
+			if (!invalidDict[f]) {
+				fields.push(f);
+			}
+		}
+
+		rows[0] = [{
+			"h": true,
+			"i": "instrument",
+			"v": "Instrument"
+		}];
+		for (i = 0; i < fields.length; i++) {
+			f = fields[i];
+			rows[0].push({
+				"h": true,
+				"r": f.toUpperCase().trim()
+				// "v": "Price Close", // Doesn't use
+				// "p": "I_TRP_PH_PriceClose" // Doesn't use this property
+			});
+		}
+
+		// build data
+		var rowMap = {};
+
+		len = identifiers.length;
+		var rowData = dataGen.generate(fields, len);
+		for (i = 0; i < len; ++i) {
+			var inst = identifiers[i];
+			row = rowMap[inst];
+			if (!row) {
+				row = rowMap[inst] = rowData[i];
+				row.unshift(inst); // prepend instrument on each row
+			}
+			rows.push(row);
+		}
+
+		// There is a chance that rtk will return multiple row data per instrument
+		// so we must create mock up for this case
+		if (rows.length > 0) {
+			var chance = dataGen.randInt(1, 10);
+			if (chance <= 3) { // chance 30%
+				var pos = dataGen.randInt(0, rows.length - 1); // random row pos
+				row = rows[pos];
+				len = row.length;
+				var mockupRow = new Array(len);
+				mockupRow[0] = row[0]; // 1st index is for instrument
+				for (i = 1; i < len; i++) {
+					mockupRow[i] = ''; // real case will return null or empty string
+				}
+				rows.splice(pos + 1, 0, mockupRow);
+			}
+		}
+	}
+
+
+	/*
+	response type is :
+	{
+		cols: number,
+		faults: Array<obj>,
+		rows: Array<obj>,
+		status: string
+	}
+	Currently, we use only the rows property for cache ADC data
+	*/
+	return Promise.resolve(JSON.stringify({
+		rows: rows
+		// TODO : supports faults property
+	}));
+};
+
+/**
+ * Splits a string of comma-separated fields into an array of individual field names with optional parentheses and contents.
+ *
+ * @param {string} strFields - The string of comma-separated fields to split.
+ * @returns {Array<string>} - An array of individual field names with optional parentheses and contents.
+ */
+Adc.splitFields = function(strFields) {
+	 if(!strFields) {
+		return [];
+	 }
+
+	// Split the input string using the regular expression
+	// regex is match commas that are not inside parentheses
+	/*
+		,          		- matches a comma
+		(?![^()]*\) 	- negative lookahead assertion that matches if the comma is not followed by:
+			[^()]*   	- any characters that are not opening or closing parentheses
+			\)			- a closing parenthesis
+		)          		- ending delimiter of the regular expression
+	*/
+	var fields = strFields.split(/,(?![^()]*\))/);
+	fields = fields.map(function(field) {
+		return field.trim();
+	});
+
+	return fields;
+};
+
+export { Adc };

package/lib/tr-grid-util/es6/jet/MockQuotes2.js

@@ -10,6 +10,46 @@ var _joinSubKeys = function(subA, subB) {
 	return subA.ric + "_" + subB.ric;
 };
 
+/** @private
+* @param {string} ric
+* @return {boolean}
+*/
+var _isDynamicChain = function(ric) {
+	// Dynamic chain will be 2 . (dot) for example .PG.PA
+	return ric.match(/\./g).length > 1;
+};
+
+/** @private
+* @param {Array<Object>} arr sub children
+* @return {Array<Object>}
+*/
+var _shuffleArray = function(arr) {
+	var arrayShuffled = arr; // Modify original array
+	var i, randNumber, tmp;
+	// Shuffle the array randomly using the Fisher-Yates algorithm
+	for (i = arrayShuffled.length - 1; i > 0; i--) {
+		randNumber = Math.floor(Math.random() * (i + 1)); // TODO: it can be use this._dataGen.randInt(min, max) range
+		tmp = arrayShuffled[i];
+		arrayShuffled[i] = arrayShuffled[randNumber];
+		arrayShuffled[randNumber] = tmp;
+	}
+
+	// TODO: merge into 1 loop
+	// Update the CHILD_ORDER property based on the new index
+	arrayShuffled.forEach(_assignChildOrder);
+	arrayShuffled = arrayShuffled.sort(_childOrderSort);
+
+	return arrayShuffled;
+};
+
+var _assignChildOrder = function(obj, index) {
+	obj["CHILD_ORDER"] = index;
+};
+
+var _childOrderSort = function(a, b) {
+	return a["CHILD_ORDER"] - b["CHILD_ORDER"];
+};
+
 /** @constructor */
 var MockQuotes2 = function() {
 
@@ -442,7 +482,7 @@ MockSubscriptions.prototype._addSymbol = function(ric, asChain, subId) {
 				childSub["dataId"] = subId + childSub["ric"];
 				childSub["parent"] = sub; // This does not exist in real subscription
 				sub["children"].push(childSub);
-
+				childSub["CHILD_ORDER"] = i;
 				this._dataMap.addItem(_joinSubKeys(sub, childSub), childSub);
 			}
 		} else {
@@ -489,7 +529,7 @@ MockSubscriptions.simpleDigest = function(str) {
 MockSubscriptions.prototype._connect = function() {
 	if(this._working && !this._timerId) {
 		var delay = this._dataGen.randInt(this._minInterval, this._maxInterval);
-		this._timerId = window.setTimeout(this._onSubscriptionResponse, delay);
+		this._timerId = window.setTimeout(this._onSubscriptionResponse, delay); // This will be async for fire event to user
 	}
 };
 
@@ -498,7 +538,7 @@ MockSubscriptions.prototype._onSubscriptionResponse = function() {
 	this._timerId = 0;
 
 	var keys = this._dataMap.getAllKeys(); // list of all rics
-	var len = keys ? keys.length : 0;
+	var len = keys ? keys.length : 0; // len include all row index (Constituent and normal ric)
 	if(!len) { // No symbol has been added
 		this._connect();
 		return;
@@ -516,16 +556,63 @@ MockSubscriptions.prototype._onSubscriptionResponse = function() {
 		var subs = this._dataMap.getItems(key); // Get all subs with the same RIC
 
 		var sub = subs[0]; // Only the first sub is need to generate data
-		var values = this._generateQuoteData(sub, fields);
+		var subParent = sub.parent;
+		var updatePosition = this._dataGen.randBoolean(); // Flag for change CHILD_ORDER position
+
+		var values, j, jLen;
+		if(_isDynamicChain(key) && subParent && updatePosition) { // subParent in header of dynamic chain is behavior like a normal ric
+			// TODO: support rate of ordering is changed
+			var children = subParent.children;
+
+			children = _shuffleArray(children);
+			var childrenLen = children.length;
+			var subIndex = children.indexOf(sub);
+			sub["CHILD_ORDER"] = subIndex;
+
+			values = this._generateQuoteData(sub, fields);
+
+			jLen = subs.length;
+			for(j = 0; j < jLen; ++j) { // It could be same ric and it need to dispatch with same ric number
+				for (var k = 0; k < childrenLen; k++) {
+					var child = children[k];
+					if(subs[j] === child) {
+						values["CHILD_ORDER"] = child["CHILD_ORDER"];
+						this._dispatchDataChanged(subs[j], values);
+					} else {
+						var currentChild = child["CHILD_ORDER"];
+						this._dispatchDataChanged(child, {
+							X_RIC_NAME: child.ric,
+							CHILD_ORDER: currentChild
+						});
+					}
+				}
+				this._dispatchPostUpdate({ childOrderChange: true });
+			}
 
-		var jLen = subs.length;
-		for(var j = 0; j < jLen; ++j) {
-			this._dispatchDataChanged(subs[j], values);
+		} else {
+			values = this._generateQuoteData(sub, fields);
+			jLen = subs.length;
+			for(j = 0; j < jLen; ++j) { // It could be same ric and it need to dispatch with same ric number
+				var childOrder = subs[j]["CHILD_ORDER"];
+				if(childOrder != null) { // Children of chain will have a CHILD_ORDER
+					values["CHILD_ORDER"] = childOrder;
+				}
+				this._dispatchDataChanged(subs[j], values);
+			}
 		}
 	}
 
 	this._connect();
 };
+
+/** @private
+* @param {Object} obj
+*/
+MockSubscriptions.prototype._dispatchPostUpdate = function (obj) {
+	// TODO: handlded another property of "postUpdate" event
+	this._dispatch("postUpdate", obj);
+};
+
 /** @private
 * @param {Object} sub
 * @param {Object} fields
@@ -605,6 +692,7 @@ MockSubscriptions.prototype._updateDuplicateSymbol = function(ric) {
 		for(i = 1; i < subCount; ++i) {
 			var sub = subs[i];
 			if(!sub["prevData"]) {
+				// TODO: check in duplicate dynamic chain
 				this._dispatchDataChanged(sub, prevData);
 			}
 		}
@@ -630,6 +718,7 @@ MockSubscriptions.prototype._updateDuplicateSymbol = function(ric) {
 			var childSub2 = this._getChildSubByRic(sub2, childRic);
 			if(childSub && childSub2) {
 				if(childSub["prevData"]) {
+					// TODO: check in duplicate dynamic chain
 					this._dispatchDataChanged(childSub2, childSub["prevData"]);
 				}
 			}

package/lib/tr-grid-util/es6/jet/MockUtil.d.ts

@@ -0,0 +1,7 @@
+
+
+declare const invalidFieldDict: any;
+
+declare function setInvalidFields(fields: (string)[]|string|null): void;
+
+export { invalidFieldDict, setInvalidFields };

package/lib/tr-grid-util/es6/jet/MockUtil.js

@@ -0,0 +1,25 @@
+/**
+* @public
+* @type {Object}
+*/
+var invalidFieldDict = {
+	'TR.NonExistField': true,
+	'TR.NotExistField': true,
+	'CF_IGNORE_FIELD': true
+};
+
+/** to mock invalid fields.
+* @public
+* @param {Array<string>|string} fields ex. TR.NonExistField, CF_IGNORE_FIELD
+*/
+function setInvalidFields(fields) {
+	if (fields && typeof fields === 'string') {
+		invalidFieldDict[fields] = true;
+	} else if (Array.isArray(fields)) {
+		for (var i = 0; i < fields.length; i++) {
+			invalidFieldDict[fields[i]] = true;
+		}
+	}
+}
+
+export { invalidFieldDict, setInvalidFields };

package/lib/tr-grid-util/es6/jet/mockDataAPI.d.ts

@@ -1,12 +1,11 @@
+import { Adc } from "./Adc.js";
 import { DataGenerator } from "./DataGenerator.js";
-import { DateTime } from "../DateTime.js";
+import { invalidFieldDict, setInvalidFields } from "./MockUtil.js";
 
 declare namespace DataGrid {
 
 }
 
-declare function setInvalidFields(fields: (string)[]|string|null): void;
-
 declare function mockDataAPI(dataType: string): Promise<any>|null;
 
 export { mockDataAPI, DataGrid, Adc, setInvalidFields };