@refinitiv-ui/efx-grid 6.0.126 → 6.0.128

package/lib/core/es6/data/DataCache.d.ts

@@ -7,30 +7,12 @@ declare class DataCache extends EventDispatcher {
 
     public dispose(): void;
 
-    public setSubscriptions(subs: any): void;
-
-    public getSubscriptions(): any;
-
-    public addSubscription(sub: any, opt_primaryRic?: string|null, opt_values?: any): void;
-
-    public removeSubscription(sub: any): void;
-
-    public startAllSubscriptions(): void;
-
-    public stopAllSubscriptions(): void;
-
-    public getSubscription(sub_id: string): any;
-
-    public getPrimaryRic(sub_id: string): string;
-
     public clearAllData(opt_suppressEvent?: boolean|null): void;
 
     public clearColumnData(colId: (string)[]|string|null, opt_suppressEvent?: boolean|null): void;
 
     public getData(rid: string, cid: string): any;
 
-    public getAllRics(): { [key: string]:  any }|null;
-
     public getAllRowIds(): (string)[]|null;
 
     public hasRowId(rid: string): boolean;

package/lib/core/es6/data/DataCache.js

@@ -1,8 +1,7 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
 import EventDispatcher from "../grid/event/EventDispatcher.js";
 
-/**
- * Trigger when data within the table has been changed
+/** @description Trigger when data within the table has been changed
  * @event DataCache#dataChanged
  * @property {boolean} globalChange Indicates a big change. User should expect all data has been change
  * @property {string} type Type of changes. Possible values are "inserted", "removed", "updated", and undefined
@@ -10,32 +9,34 @@ import EventDispatcher from "../grid/event/EventDispatcher.js";
  * @property {Object.<string, *>} rowData Column values of the changed row in JSON object format
  */
 
-/**
- * Trigger before DataCache#dataChanged. Perform any data update during the event will NOT cause more dataChanged events
+/** @description Trigger before DataCache#dataChanged. Perform any data update during the event will NOT cause more dataChanged events
  * @event DataCache#dataComposed
  */
 
-/**
+/** Class for caching data and firing event when data is changed
  * @constructor
  * @extends {EventDispatcher}
  */
 let DataCache = function () {
-	let _t = this;
-
-	_t._rows = {};
-	_t._subs = {};
-	_t._onInsert = _t._onInsert.bind(_t);
-	_t._onUpdate = _t._onUpdate.bind(_t);
-	_t._onDelete = _t._onDelete.bind(_t);
-	_t._onQ2DataChanged = _t._onQ2DataChanged.bind(_t);
-	_t._onQ2SubAdded = _t._onQ2SubAdded.bind(_t);
-	_t._onQ2SubRemoved = _t._onQ2SubRemoved.bind(_t);
-
-	_t._addEvent("dataComposed");
-	_t._addEvent("dataChanged");
+	this._rows = {};
+
+	this._addEvent("dataComposed");
+	this._addEvent("dataChanged");
 };
 Ext.inherits(DataCache, EventDispatcher);
 
+/** @protected
+ * @ignore
+ * @type {!Object.<string, Object>}
+ */
+DataCache.prototype._rows;
+
+/** @protected
+ * @ignore
+ * @type {boolean}
+ */
+DataCache.prototype._composing = false;
+
 //#region Public
 /**
  * @public
@@ -43,162 +44,64 @@ Ext.inherits(DataCache, EventDispatcher);
 DataCache.prototype.dispose = function () {
 	this.unlistenAll();
 	this.clearAllData(true);
-	this._quotes2 = null;
 };
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility. This API supports only Quotes2's "Subscriptions" object.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @param {Object} subs Subscriptions object from JET.Quotes2
+ * @ignore
  */
-DataCache.prototype.setSubscriptions = function (subs) {
-	if (this._quotes2) {
-		this._quotes2["removeEventListener"]("dataChanged", this._onQ2DataChanged);
-		this._quotes2["removeEventListener"]("subscriptionAdded", this._onQ2SubAdded);
-		this._quotes2["removeEventListener"]("subscriptionRemoved", this._onQ2SubRemoved);
-	}
-
-	this._quotes2 = subs;
-
-	if (this._quotes2) {
-		this._quotes2["addEventListener"]("dataChanged", this._onQ2DataChanged);
-		this._quotes2["addEventListener"]("subscriptionAdded", this._onQ2SubAdded);
-		this._quotes2["addEventListener"]("subscriptionRemoved", this._onQ2SubRemoved);
-	}
-};
+DataCache.prototype.setSubscriptions = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.This API supports only Quotes2's
- * "Subscriptions" object.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @return {Object} subs Subscriptions object from JET.Quotes2
+ * @ignore
+ * @return {Object} Always returns null
  */
-DataCache.prototype.getSubscriptions = function () {
-	return this._quotes2;
-};
+DataCache.prototype.getSubscriptions = function () { return null; };
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @param {Object} sub Subscription object from JET.Quote
- * @param {string=} opt_primaryRic Main RIC for creating Id or recalling subscription. This is because subscription
- * object does not provide a way to access its data
- * @param {Object=} opt_values Initial values
+ * @ignore
  */
-DataCache.prototype.addSubscription = function (sub, opt_primaryRic, opt_values) {
-	if (this.getSubscription(sub["id"])) {
-		return;
-	}
-
-	let internalSub = {"s": sub, "rics": {}};
-
-	this._subs[sub["id"]] = internalSub;
+DataCache.prototype.addSubscription = function () {};
 
-	if (!this._quotes2) {
-		sub["onNewRow"](this._onInsert);
-		sub["onUpdate"](this._onUpdate);
-		sub["onRemoveRow"](this._onDelete);
-	}
-
-	if (opt_primaryRic) {
-		internalSub["primary"] = opt_primaryRic;
-
-		if (!opt_values) {
-			opt_values = {};
-		}
-
-		this._onInsert(sub, opt_primaryRic, opt_values);
-	}
-};
-
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @param {Object} sub Subscription object from JET.Quote
+ * @ignore
  */
-DataCache.prototype.removeSubscription = function (sub) { // All RICs associated to the subscription are removed
-	let subId = sub["id"];
-
-	if (!sub || !this._subs[subId]) {
-		return;
-	}
-
-	if (!this._quotes2) {
-		sub["stop"]();
-	}
-
-	let rics = this._subs[subId]["rics"];
-
-	for (let ric in rics) {
-		this.setRowData(subId + ric, null); // No subscription attached
-	}
-
-	delete this._subs[subId];
-};
+DataCache.prototype.removeSubscription = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
+ * @ignore
  */
-DataCache.prototype.startAllSubscriptions = function () {
-	if (this._quotes2) {
-		this._quotes2["start"]();
-	} else {
-		for (let key in this._subs) {
-			this._subs[key]["s"]["start"]();
-		}
-	}
-};
+DataCache.prototype.startAllSubscriptions = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
+ * @ignore
  */
-DataCache.prototype.stopAllSubscriptions = function () {
-	if (this._quotes2) {
-		this._quotes2["stop"]();
-	} else {
-		for (let key in this._subs) {
-			this._subs[key]["s"]["stop"]();
-		}
-	}
-};
+DataCache.prototype.stopAllSubscriptions = function () {};
 
-/**
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @param {string} sub_id
- * @return {Object} Subscription object from JET.Quote
+ * @ignore
+ * @return {Object} Always returns null
  */
-DataCache.prototype.getSubscription = function (sub_id) {
-	return (this._subs[sub_id]) ? this._subs[sub_id]["s"] : null;
-};
+DataCache.prototype.getSubscription = function () { return null; };
 
-/**
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @param {string} sub_id
- * @return {string} ric that has been input when calling addSubscription
+ * @ignore
+ * @return {string} Always returns empty string
  */
-DataCache.prototype.getPrimaryRic = function (sub_id) {
-	let subDef = this._subs[sub_id];
-	if (subDef) {
-		return subDef["primary"];
-	}
-	return "";
-};
+DataCache.prototype.getPrimaryRic = function () { return ""; };
 
-/**
- * @public
+/** @public
  * @param {boolean=} opt_suppressEvent
  * @fires DataCache#dataChanged
  */
-DataCache.prototype.clearAllData = function (opt_suppressEvent) { // All subscriptions are also removed
-	if (this._quotes2) {
-		this._quotes2["removeAllSubscriptions"]();
-	} else {
-		this.stopAllSubscriptions();
-	}
-
-	this._subs = {};
+DataCache.prototype.clearAllData = function (opt_suppressEvent) {
 	this._rows = {};
 
 	if (!opt_suppressEvent) {
@@ -242,28 +145,12 @@ DataCache.prototype.getData = function (rid, cid) {
 	return (row) ? row[cid] : null;
 };
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
- * @return {Object.<string, Array.<string>>} Map of Array of subscription object
+ * @ignore
+ * @return {Object.<string, Array.<string>>} Always returns null
  */
-DataCache.prototype.getAllRics = function () { // Slow
-	let ricMap = {};
-
-	for (let subId in this._subs) {
-		let rics = this._subs[subId]["rics"];
-
-		for (let ric in rics) {
-			if (!ricMap[ric]) {
-				ricMap[ric] = [];
-			}
-
-			ricMap[ric].push(subId);
-		}
-	}
-
-	return ricMap; // No duplicate ric
-};
+DataCache.prototype.getAllRics = function () { return null; };
 
 /**
  * @public
@@ -462,27 +349,22 @@ DataCache.prototype.cloneRowData = function (rid) {
 /** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
- * @suppress {checkTypes}
  */
 DataCache.prototype.addStaticFields = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
- * @suppress {checkTypes}
  */
 DataCache.prototype.removeStaticFields = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
  */
 DataCache.prototype.resetStaticFields = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
  */
@@ -523,40 +405,29 @@ DataCache.prototype.log = function (opt_options) {
 	console.table(this.dump(opt_options));
 };
 
-//#region ADC
 /** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
- * @param {string} userId
- * @param {string} productId
- * @param {string} url
- * @param {string=} opt_lang
  */
-DataCache.prototype.setDataCloudSettings = function (userId, productId, url, opt_lang) {};
+DataCache.prototype.setDataCloudSettings = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
  */
 DataCache.prototype.getDataCloudFields = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
- * @param {Array.<string>|string} fields
  */
-DataCache.prototype.addDataCloudFields = function (fields) {};
+DataCache.prototype.addDataCloudFields = function () {};
 
-/**
- * Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
+/** Deprecated. Built-in Data Service is deprecated due to the lack of flexibility.
  * @public
  * @ignore
- * @param {string} field
  */
-DataCache.prototype.removeDataCloudField = function (field) {};
-//#endregion ADC
+DataCache.prototype.removeDataCloudField = function () {};
 //#endregion Public
 
 /**
@@ -693,161 +564,5 @@ DataCache.constructTable = function (dataset, opt_options, opt_rowIds) {
 };
 
 
-//#region Private
-/**
- * For Quotes2 only
- * @private
- * @param {string} subId
- * @param {string} ric
- * @param {Object.<string, *>} values
- */
-DataCache.prototype._insertRic = function (subId, ric, values) {
-	// HACK: Some chain may have 0# symbol in there chain index (e.g. 0#CL:)
-	ric = ric.replace("0#", "");
-
-	let rid = subId + ric;
-
-	let rowData = this.getRowData(rid);
-	if (!rowData) { // Ensure that we have subscription id and ric from Quotes2
-		let tmp = values;
-
-		values = {}; // Clone a new object for duplicated ric
-
-		for (let key in tmp) { // Slow
-			values[key] = tmp[key];
-		}
-
-		values["SUB_ID"] = subId;
-		values["RIC"] = ric;
-	} else {
-		let rowDef = rowData["ROW_DEF"];
-		if(rowDef && rowDef.isChain()){
-			values["SUB_ID"] = subId;
-		}
-	}
-
-	this.setRowData(rid, values);
-};
-
-/**
- * @private
- * @param {Object} e
- */
-DataCache.prototype._onQ2DataChanged = function (e) {
-	let subId = e["subId"];
-	let ric = e["ric"];
-	let values = /** @type{Object.<string, *>} */(e["values"]);
-
-	if (values) {
-		this._insertRic(subId, ric, values);
-	} else { // Remove ric
-		delete this._subs[subId]["rics"][ric];
-
-		this.setRowData(subId + ric, null);
-	}
-};
-
-/**
- * @private
- * @param {Object} e
- */
-DataCache.prototype._onQ2SubAdded = function (e) {
-	let subs = e["subs"];
-	let len = subs.length;
-
-	for (let i = 0; i < len; ++i) {
-		let sub = subs[i];
-
-		// chain subId fires twice, one with "_ci_" and one without "_ci_"
-		// the subId with "_ci_" should be ignore
-		if(sub["id"].indexOf("_ci_") < 0){
-			this.addSubscription(sub, sub["ric"]);
-		}
-	}
-};
-
-/**
- * @private
- * @param {Object} e
- */
-DataCache.prototype._onQ2SubRemoved = function (e) {
-	let subs = e["subs"];
-	let len = subs.length;
-
-	for (let i = 0; i < len; ++i) {
-		let sub = subs[i];
-
-		// chain subId fires twice, one with "_ci_" and one without "_ci_"
-		// the subId with "_ci_" should be ignore
-		if(sub["id"].indexOf("_ci_") < 0){
-			this.removeSubscription(sub);
-		}
-	}
-};
-
-/**
- * @private
- * @param {Object} sub Subscription object from JET.Quote
- * @param {string} ric
- * @param {Object.<string, *>} values
- */
-DataCache.prototype._onInsert = function (sub, ric, values/*, rowN*/) {
-	let subId = sub["id"];
-
-	if (this._quotes2) {
-		this._insertRic(subId, ric, values);
-	} else {
-		this.setRowData(subId + ric, values, {"subscription": sub, "ric": ric});
-	}
-};
-
-/**
- * @private
- * @function
- */
-DataCache.prototype._onUpdate = DataCache.prototype._onInsert;
-
-/**
- * This is a legacy code and should be deprecated
- * @private
- * @param {Object} sub Subscription object from JET.Quote
- * @param {string} ric
- * @param {Array.<string, *>} values
- */
-DataCache.prototype._onDelete = function (sub, ric, values/*, rowN*/) {
-	delete this._subs[sub["id"]]["rics"][ric];
-
-	// We cannot cache event arguments because user may want to collect all the updates
-	this.setRowData(sub["id"] + ric, null, {"subscription": sub, "ric": ric});
-};
-
-/** @protected
- * @ignore
- * @type {!Object.<string, Object>}
- */
-DataCache.prototype._rows;
-
-/**
- * @private
- * @type {!Object.<string, Object>}
- */
-DataCache.prototype._subs;
-
-/**
- * @private
- * @type {Object}
- */
-DataCache.prototype._quotes2 = null;
-
-/** @protected
- * @ignore
- * @type {boolean}
- */
-DataCache.prototype._composing = false;
-
-//#endregion Private
-
-DataCache._proto = DataCache.prototype;
-
 export default DataCache;
 export { DataCache };

package/lib/core/es6/grid/Core.js

@@ -621,7 +621,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.124";
+	return "5.1.125";
 };
 /** {@link ElementWrapper#dispose}
 * @override

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.126" };
+window.EFX_GRID = { version: "6.0.128" };