@refinitiv-ui/efx-grid 6.0.0-next.0

package/lib/tr-grid-util/es6/formula/RealtimeService.js

@@ -0,0 +1,203 @@
+import {Util} from "../Util.js";
+import {Formula} from "./Formula.js";
+
+/** @namespace */
+var RealtimeService = {};
+
+/** @type {Object}
+* @private
+*/
+RealtimeService._quotes2 = null;
+/** @type {Object.<string, Object>}
+* @private
+*/
+RealtimeService._cache = {};
+/** @type {string}
+* @private
+*/
+RealtimeService._udipServiceUrl = "/Apps/UdipApi/GetFields";
+/** @type {string}
+* @public
+*/
+RealtimeService.uuid = "";
+
+/** @public
+* @return {Object}
+*/
+RealtimeService.create = function() {
+	var quotes2 = RealtimeService._quotes2;
+	if (!quotes2) {
+		var j = window ? window["JET"] : null;
+		if (j && j["Quotes2"]) {
+			quotes2 = j["Quotes2"];
+			RealtimeService._quotes2 = quotes2;
+		} else {
+			return null;
+		}
+	}
+	return quotes2['create']();
+};
+
+/** @public
+* @param {Object} quotes2
+*/
+RealtimeService.setQuote2 = function(quotes2) {
+	RealtimeService._quotes2 = quotes2;
+};
+
+/** @public
+* @param {string} fid
+* @return {string|null}
+*/
+RealtimeService.getResolvedFieldName = function(fid) {
+	var cache = RealtimeService._cache[fid];
+	if(cache) {
+		if(cache.value != null) {
+			return /** @type{string} */(cache.value);
+		}
+	}
+	return null;
+};
+
+// @param {Formula} formula External formula object
+/** Resolve numeric field id to text field name
+* @public
+* @param {string} fid String of numeric field id
+* @param {Object=} obj Listener object. Usually, this is External Formula formula object
+* @return {!Promise}
+*/
+RealtimeService.resolveFieldId = function(fid, obj) {
+	fid = fid + ""; // Cast to string
+	var cache = RealtimeService._cache[fid];
+	if(cache) {
+		if(cache.value != null) {
+			return Promise.resolve(cache.value);
+		}
+	} else {
+		cache = RealtimeService._cache[fid] = {"fid": fid}; // Prevent duplicate request
+	}
+
+	// The request has not been resolved. Put any listener to the queue
+	if(obj) {
+		var q = cache.queue;
+		if(!q) {
+			q = cache.queue = [];
+		}
+		if(q.indexOf(obj) < 0) { // WANRING: this will be called multiple times
+			q.push(obj);
+		}
+	}
+
+	if(cache.promise) { // The request has been sent. we will wait for the response
+		return cache.promise; // Original promise
+	}
+
+	// At this point there is no pending request (no promise) for the given fid
+	var payload = {
+		"universe": [
+			"Public",
+			"PublicPrivate"
+		],
+		"UUID": RealtimeService.uuid,
+		"sources": [
+			"RT"
+		],
+		"language": "en-US",
+		"sortBy": "relevance",
+		"searchText": fid
+	};
+
+	var prom = cache.promise = Util.post(RealtimeService._udipServiceUrl, payload)
+		.then(RealtimeService._onSuccessfulResolving.bind(null, cache))
+		.catch(RealtimeService._onFailedResolving.bind(null, cache));
+
+	return prom;
+};
+
+/** @private
+* @function
+* @param {Object} cache Bound cache object from global cache
+* @param {Object} json
+* @return {string}
+*/
+RealtimeService._onSuccessfulResolving = function(cache, json) {
+	cache.value = ""; // value can be empty due to the given invalid json structure
+	var data = json["data"];
+	if(data) {
+		var fields = data["fields"];
+		if(fields) {
+			var info = fields[0];
+			if(info) {
+				if(info["oid"] === cache.fid) {
+					cache.value = info["path"]; // Cache the value
+				}
+			}
+		}
+	}
+
+	RealtimeService._onResponseEnd(cache);
+	return cache.value;
+};
+/** @private
+* @function
+* @param {Object} cache Bound cache object from global cache
+* @param {Object} err
+* @return {string}
+*/
+RealtimeService._onFailedResolving = function(cache, err) {
+	if(err.response) {
+		if(err.response.status === 200) {
+			cache.value = "";
+		} else { // Server error retry another round
+			cache.retry = cache.retry ? cache.retry + 1 : 1;
+
+			if(cache.retry >= 3) {
+				if(!cache.timerId) {
+					cache.timerId = setTimeout(
+						RealtimeService._onCacheClearing.bind(null, cache),
+						300000 // Clear cache after 5 minutes
+					);
+				}
+			}
+			return Promise.reject("Server error");
+		}
+	} else {  // Successful response but no data due to internal error
+		cache.value = "";
+	}
+	RealtimeService._onResponseEnd(cache);
+	return ""; // This is resolved as success
+};
+/** Clean up cache once the promise has been fulfilled
+* @private
+* @function
+* @param {Object} cache Bound cache object from global cache
+*/
+RealtimeService._onResponseEnd = function(cache) {
+	cache.promise = null; // Promise has been fulfilled
+	var q = cache.queue;
+	if(q) { // Notify any object that is waiting for the response
+		var len = q.length;
+		for(var i = 0; i < len; ++i) {
+			var obj = q[i];
+			if(obj instanceof Formula) { // WARNING: Referencing external object
+				obj.dispatchDataChanged(); // Force data re-calculation
+			}
+		}
+		cache.queue = null;
+	}
+};
+/** Delete cache
+* @private
+* @function
+* @param {Object} cache Bound cache object from global cache
+*/
+RealtimeService._onCacheClearing = function(cache) {
+	if (cache.fid) {
+		delete RealtimeService._cache[cache.fid];
+	}
+	cache.value = null;
+	cache.timerId = 0;
+	RealtimeService._onResponseEnd(cache);
+};
+
+export {RealtimeService};

package/lib/tr-grid-util/es6/formula/TSIService.d.ts

@@ -0,0 +1,11 @@
+import {TSISubscription} from "./TSISubscription.js";
+
+declare namespace TSIService {
+
+    function create(): any;
+
+    function setTSISettings(sharedServiceUrl?: string, taServiceUrl?: string): void;
+
+}
+
+export {TSIService};

package/lib/tr-grid-util/es6/formula/TSIService.js

@@ -0,0 +1,51 @@
+import {TSISubscription} from "./TSISubscription.js";
+
+/** @public
+* @namespace
+*/
+var TSIService = {};
+
+/** @type {Object}
+* @private
+*/
+TSIService._tsiSubscription = null;
+
+/** @type {string}
+* @private
+*/
+TSIService._tsiSharedServiceUrl = "/Apps/shared-services/service/TsMultiRICTimeSeries/GetMultiRICTimeSeries";
+/** @type {string}
+* @private
+*/
+TSIService._tsiTaServiceUrl = "/Apps/TAService";
+
+/** @public
+* @return {Object}
+*/
+TSIService.create = function() {
+	var tsiSub = TSIService._tsiSubscription;
+	if (!tsiSub) {
+		tsiSub = new TSISubscription();
+		TSIService._tsiSubscription = tsiSub;
+		TSIService.setTSISettings();
+	}
+	return tsiSub;
+};
+
+/** @public
+* @param {string=} sharedServiceUrl
+* @param {string=} taServiceUrl
+*/
+TSIService.setTSISettings = function(sharedServiceUrl, taServiceUrl) {
+	if(sharedServiceUrl) {
+		TSIService._tsiSharedServiceUrl = sharedServiceUrl;
+	}
+	if(taServiceUrl) {
+		TSIService._tsiTaServiceUrl = taServiceUrl;
+	}
+	if(TSIService._tsiSubscription) { // In case set the settings after the service was created.
+		TSIService._tsiSubscription.setTSISettings(TSIService._tsiSharedServiceUrl, TSIService._tsiTaServiceUrl);
+	}
+};
+
+export {TSIService};

package/lib/tr-grid-util/es6/formula/TSISubscription.d.ts

@@ -0,0 +1,18 @@
+import {Ext} from "../Ext.js";
+import {Util} from "../Util.js";
+import {EventDispatcher} from "../EventDispatcher.js";
+import {RequestQueue} from "../RequestQueue.js";
+
+declare class TSISubscription extends EventDispatcher {
+
+    constructor();
+
+    public setIntervalTime(time: number): void;
+
+    public setTSISettings(sharedServiceUrl?: string, taServiceUrl?: string): void;
+
+    public addSymbolAndFieldToPeriod(symbol: string, field: string, period: string): any;
+
+}
+
+export {TSISubscription};