@jetbrains/ring-ui 4.1.4 → 5.0.0-beta.1

package/components/analytics/analytics.js

@@ -1,101 +1,87 @@
 /**
  * @name Analytics
  */
-class Analytics {
-  constructor() {
-    this._plugins = [];
-  }
-
-  config(plugins) {
-    this._plugins = plugins;
-  }
-
-  track(rawTrackingData, /* optional */ additionalData) {
-    if (!rawTrackingData) {
-      return;
+export class Analytics {
+    _plugins;
+    constructor() {
+        this._plugins = [];
     }
-
-    let splitIdx = rawTrackingData.indexOf(':');
-    if (splitIdx < 0) {
-      splitIdx = rawTrackingData.indexOf('_');
+    config(plugins) {
+        this._plugins = plugins;
     }
-    if (splitIdx < 0) {
-      splitIdx = rawTrackingData.length;
-    }
-
-    const category = rawTrackingData.substr(0, splitIdx);
-    const subcategory = rawTrackingData.substr(splitIdx + 1);
-
-    this.trackEvent(category, subcategory, additionalData);
-  }
-
-  trackPageView(path) {
-    this._plugins.forEach(plugin => {
-      plugin.trackPageView(path);
-    });
-  }
-
-  trackEvent(category, action, /* optional */ additionalData) {
-    const subaction = additionalData ? action + this._buildSuffix(additionalData) : null;
-    this._plugins.forEach(plugin => {
-      if (plugin.serializeAdditionalInfo) {
-        plugin.trackEvent(category, action);
-        if (subaction) {
-          plugin.trackEvent(category, subaction);
+    track(rawTrackingData, additionalData) {
+        if (!rawTrackingData) {
+            return;
+        }
+        let splitIdx = rawTrackingData.indexOf(':');
+        if (splitIdx < 0) {
+            splitIdx = rawTrackingData.indexOf('_');
         }
-      } else {
-        plugin.trackEvent(category, action, additionalData);
-      }
-    });
-  }
-
-  trackShortcutEvent(category, action, /* optional */ additionalData) {
-    this.trackEvent(category, action, additionalData);
-    this.trackEvent('ring-shortcut', `${category}$${action}`, additionalData);
-  }
-
-  trackEntityProperties(entityName, entity, propertiesNames, /* optional */ additionalData) {
-    for (let i = 0; i < propertiesNames.length; ++i) {
-      const keys = propertiesNames[i].split('.');
-      let value = entity;
-
-      if (!keys.length) {
-        continue;
-      }
-
-      for (let j = 0; j < keys.length; ++j) {
-        if (value.hasOwnProperty(keys[j])) {
-          value = value[keys[j]];
-        } else {
-          value = 'no-value';
-          break;
+        if (splitIdx < 0) {
+            splitIdx = rawTrackingData.length;
         }
-      }
-
-      if (typeof value === 'string') {
-        value = value.toLowerCase().replace(/[._]+/g, '-');
-      }
-
-      const resultAction = `${keys.join('-')}__${value}`;
-      this.trackEvent(entityName, resultAction, additionalData);
+        const category = rawTrackingData.substr(0, splitIdx);
+        const subcategory = rawTrackingData.substr(splitIdx + 1);
+        this.trackEvent(category, subcategory, additionalData);
+    }
+    trackPageView(path) {
+        this._plugins.forEach(plugin => {
+            plugin.trackPageView(path);
+        });
+    }
+    trackEvent(category, action, additionalData) {
+        const subaction = additionalData ? action + this._buildSuffix(additionalData) : null;
+        this._plugins.forEach(plugin => {
+            if (plugin.serializeAdditionalInfo) {
+                plugin.trackEvent(category, action);
+                if (subaction) {
+                    plugin.trackEvent(category, subaction);
+                }
+            }
+            else {
+                plugin.trackEvent(category, action, additionalData);
+            }
+        });
     }
-  }
-
-  _buildSuffix(additionalData) {
-    if (!additionalData) {
-      return '';
+    trackShortcutEvent(category, action, additionalData) {
+        this.trackEvent(category, action, additionalData);
+        this.trackEvent('ring-shortcut', `${category}$${action}`, additionalData);
     }
-
-    let suffix = '';
-    let key;
-    for (key in additionalData) {
-      if (additionalData.hasOwnProperty(key)) {
-        suffix += `__${key}$${additionalData[key]}`;
-      }
+    trackEntityProperties(entityName, entity, propertiesNames, additionalData) {
+        for (let i = 0; i < propertiesNames.length; ++i) {
+            const keys = propertiesNames[i].split('.');
+            let value = entity;
+            if (!keys.length) {
+                continue;
+            }
+            for (let j = 0; j < keys.length; ++j) {
+                if (typeof value === 'object' && value != null && value.hasOwnProperty(keys[j])) {
+                    value = value[keys[j]];
+                }
+                else {
+                    value = 'no-value';
+                    break;
+                }
+            }
+            if (typeof value === 'string') {
+                value = value.toLowerCase().replace(/[._]+/g, '-');
+            }
+            const resultAction = `${keys.join('-')}__${value}`;
+            this.trackEvent(entityName, resultAction, additionalData);
+        }
+    }
+    _buildSuffix(additionalData) {
+        if (!additionalData) {
+            return '';
+        }
+        let suffix = '';
+        let key;
+        for (key in additionalData) {
+            if (additionalData.hasOwnProperty(key)) {
+                suffix += `__${key}$${additionalData[key]}`;
+            }
+        }
+        return suffix;
     }
-
-    return suffix;
-  }
 }
-
 export default new Analytics();

package/components/analytics/analytics__custom-plugin.d.ts

@@ -0,0 +1,39 @@
+import { AnalyticsPlugin } from './analytics';
+export interface AnalyticsCustomPluginData {
+    category: string;
+    action: string;
+}
+export interface AnalyticsCustomPluginConfig {
+    send: (data: AnalyticsCustomPluginData[]) => void;
+    isDevelopment?: boolean | undefined;
+    flushInterval?: number | undefined;
+    flushingAllowedChecker?: (() => boolean) | undefined;
+    flushMaxPackSize?: number | undefined;
+}
+export default class AnalyticsCustomPlugin implements AnalyticsPlugin {
+    _data: AnalyticsCustomPluginData[];
+    private _flush?;
+    private _isDevelopment?;
+    private _flushInterval?;
+    private _flushMaxPackSize?;
+    private _lastPagePath?;
+    private _hasSendSchedule?;
+    private _lastPageViewTime?;
+    constructor(send: AnalyticsCustomPluginConfig['send'], isDevelopment?: AnalyticsCustomPluginConfig['isDevelopment'], flushInterval?: AnalyticsCustomPluginConfig['flushInterval'], flushingAllowedChecker?: AnalyticsCustomPluginConfig['flushingAllowedChecker']);
+    /**
+     * @param config
+     * @property {function} config.send
+     * @property {boolean} config.isDevelopment
+     * @property {number} config.flushInterval
+     * @property {function} config.flushingAllowedChecker
+     * @property {number} config.flushMaxPackSize
+     */
+    config(config: AnalyticsCustomPluginConfig): void;
+    trackEvent(category: string, action: string): void;
+    trackPageView(path: string): void;
+    private _initSendSchedule;
+    private _processEvent;
+    private _trackPageViewAdditionalInfo;
+    private _addDataToFlushingPack;
+    get serializeAdditionalInfo(): boolean;
+}

package/components/analytics/analytics__custom-plugin.js

@@ -1,122 +1,101 @@
 import AnalyticsPluginUtils from './analytics__plugin-utils';
-
 const DEFAULT_FLUSH_INTERVAL = 10000;
 const DEFAULT_FLUSH_MAX_PACK_SIZE = 100;
-
 export default class AnalyticsCustomPlugin {
-  constructor(send, isDevelopment, flushInterval, flushingAllowedChecker) {
-    this._data = [];
-    this.config({
-      send,
-      isDevelopment,
-      flushInterval,
-      flushingAllowedChecker
-    });
-  }
-
-  /**
-   * @param config
-   * @property {function} config.send
-   * @property {boolean} config.isDevelopment
-   * @property {number} config.flushInterval
-   * @property {function} config.flushingAllowedChecker
-   * @property {number} config.flushMaxPackSize
-   */
-  config(config) {
-    let checkFlushingAllowed = config.flushingAllowedChecker;
-    if (typeof checkFlushingAllowed !== 'function') {
-      checkFlushingAllowed = () => true;
-    }
-
-    this._flush = () => {
-      if (this._data.length > 0 && checkFlushingAllowed()) {
-        config.send(this._data);
+    _data;
+    _flush;
+    _isDevelopment;
+    _flushInterval;
+    _flushMaxPackSize;
+    _lastPagePath;
+    _hasSendSchedule;
+    _lastPageViewTime;
+    constructor(send, isDevelopment, flushInterval, flushingAllowedChecker) {
         this._data = [];
-      }
-    };
-
-    this._isDevelopment = config.isDevelopment;
-    this._flushInterval = config.flushInterval || DEFAULT_FLUSH_INTERVAL;
-    this._flushMaxPackSize = config.flushMaxPackSize || DEFAULT_FLUSH_MAX_PACK_SIZE;
-  }
-
-  trackEvent(category, action) {
-    this._processEvent(category, action);
-  }
-
-  trackPageView(path) {
-    if (this._lastPagePath === path) {
-      return;
+        this.config({
+            send,
+            isDevelopment,
+            flushInterval,
+            flushingAllowedChecker
+        });
+    }
+    /**
+     * @param config
+     * @property {function} config.send
+     * @property {boolean} config.isDevelopment
+     * @property {number} config.flushInterval
+     * @property {function} config.flushingAllowedChecker
+     * @property {number} config.flushMaxPackSize
+     */
+    config(config) {
+        const checkFlushingAllowed = typeof config.flushingAllowedChecker === 'function'
+            ? config.flushingAllowedChecker
+            : () => true;
+        this._flush = () => {
+            if (this._data.length > 0 && checkFlushingAllowed()) {
+                config.send(this._data);
+                this._data = [];
+            }
+        };
+        this._isDevelopment = config.isDevelopment;
+        this._flushInterval = config.flushInterval || DEFAULT_FLUSH_INTERVAL;
+        this._flushMaxPackSize = config.flushMaxPackSize || DEFAULT_FLUSH_MAX_PACK_SIZE;
+    }
+    trackEvent(category, action) {
+        this._processEvent(category, action);
+    }
+    trackPageView(path) {
+        if (this._lastPagePath === path) {
+            return;
+        }
+        this._trackPageViewAdditionalInfo(path);
+        this._processEvent('ring-page', path);
+        this._processEvent('ring-navigator_user-agent', AnalyticsPluginUtils.getUserAgentPresentation());
+        this._processEvent('ring-navigator_platform', AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform));
+        this._processEvent('ring-navigator_lang', AnalyticsPluginUtils.npeSaveLowerCase(navigator.language));
+        this._processEvent('ring-device-pixel-ratio', AnalyticsPluginUtils.getDevicePixelRatioPresentation());
+        this._processEvent('ring-screen-width', AnalyticsPluginUtils.getScreenWidthPresentation());
+    }
+    _initSendSchedule() {
+        window.addEventListener('beforeunload', () => {
+            this._trackPageViewAdditionalInfo();
+            return this._flush?.();
+        });
+        if (this._flush != null) {
+            setInterval(this._flush, this._flushInterval);
+        }
+        this._hasSendSchedule = true;
     }
-
-    this._trackPageViewAdditionalInfo(path);
-    this._processEvent('ring-page', path);
-    this._processEvent(
-      'ring-navigator_user-agent',
-      AnalyticsPluginUtils.getUserAgentPresentation()
-    );
-    this._processEvent(
-      'ring-navigator_platform',
-      AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform)
-    );
-    this._processEvent(
-      'ring-navigator_lang',
-      AnalyticsPluginUtils.npeSaveLowerCase(navigator.language)
-    );
-    this._processEvent(
-      'ring-device-pixel-ratio',
-      AnalyticsPluginUtils.getDevicePixelRatioPresentation()
-    );
-    this._processEvent(
-      'ring-screen-width',
-      AnalyticsPluginUtils.getScreenWidthPresentation()
-    );
-  }
-
-  _initSendSchedule() {
-    window.addEventListener('beforeunload', () => {
-      this._trackPageViewAdditionalInfo();
-      return this._flush();
-    });
-
-    setInterval(this._flush, this._flushInterval);
-    this._hasSendSchedule = true;
-  }
-
-  _processEvent(rawCategory, rawAction) {
-    if (!this._hasSendSchedule && this._flush) {
-      this._initSendSchedule();
+    _processEvent(rawCategory, rawAction) {
+        if (!this._hasSendSchedule && this._flush) {
+            this._initSendSchedule();
+        }
+        const category = AnalyticsPluginUtils.reformatString(rawCategory, true);
+        const action = AnalyticsPluginUtils.reformatString(rawAction);
+        if (this._isDevelopment) {
+            console.log('TRACKING DATA = ', category, action); // eslint-disable-line no-console
+        }
+        this._addDataToFlushingPack({ category, action });
     }
-    const category = AnalyticsPluginUtils.reformatString(rawCategory, true);
-    const action = AnalyticsPluginUtils.reformatString(rawAction);
-    if (this._isDevelopment) {
-      console.log('TRACKING DATA = ', category, action); // eslint-disable-line no-console
+    _trackPageViewAdditionalInfo(newPagePath) {
+        const currentTime = (new Date()).getTime();
+        if (this._lastPagePath) {
+            if (this._lastPageViewTime) {
+                const duration = AnalyticsPluginUtils.
+                    getPageViewDurationPresentation(currentTime - this._lastPageViewTime);
+                this._processEvent(`ring-pageview-duration_${this._lastPagePath}`, duration);
+            }
+        }
+        this._lastPageViewTime = currentTime;
+        this._lastPagePath = newPagePath;
     }
-    this._addDataToFlushingPack({category, action});
-  }
-
-  _trackPageViewAdditionalInfo(newPagePath) {
-    const currentTime = (new Date()).getTime();
-    if (this._lastPagePath) {
-      if (this._lastPageViewTime) {
-        const duration = AnalyticsPluginUtils.
-          getPageViewDurationPresentation(currentTime - this._lastPageViewTime);
-        this._processEvent(`ring-pageview-duration_${this._lastPagePath}`, duration);
-      }
+    _addDataToFlushingPack(sendingData) {
+        this._data.push(sendingData);
+        if (this._flushMaxPackSize != null && this._data.length >= this._flushMaxPackSize) {
+            this._flush?.();
+        }
     }
-    this._lastPageViewTime = currentTime;
-    this._lastPagePath = newPagePath;
-  }
-
-  _addDataToFlushingPack(sendingData) {
-    this._data.push(sendingData);
-
-    if (this._data.length >= this._flushMaxPackSize) {
-      this._flush();
+    get serializeAdditionalInfo() {
+        return true;
     }
-  }
-
-  get serializeAdditionalInfo() {
-    return true;
-  }
 }

package/components/analytics/analytics__fus-plugin.d.ts

@@ -0,0 +1,62 @@
+import { AnalyticsPlugin } from './analytics';
+export interface AnalyticsFUSPluginGroup {
+    id: string;
+    version: string;
+    baseline: string;
+}
+export interface AnalyticsFUSPluginConfig {
+    productId?: string | undefined;
+    productBuild?: string | undefined;
+    recorderVersion?: number | string | undefined;
+    isDevelopment?: boolean | undefined;
+    groups?: readonly AnalyticsFUSPluginGroup[] | undefined;
+}
+interface FusraInitParams {
+    recorderCode?: string | undefined;
+    recorderVersion: number | string;
+    productCode?: string | undefined;
+    productBuild?: string | undefined;
+    internal: boolean;
+    eventCountDelay?: number | undefined;
+    reportingFrequency?: number | undefined;
+    groups?: readonly AnalyticsFUSPluginGroup[] | undefined;
+    useForSubdomains?: boolean | undefined;
+}
+interface FusraEventParams {
+    groupId: string;
+    groupVersion?: number | string | undefined;
+    eventData?: Record<string, unknown> | undefined;
+    eventId: string;
+}
+declare global {
+    interface Window {
+        fusra?: {
+            (method: 'init', params: FusraInitParams): void;
+            (method: 'event', params: FusraEventParams): void;
+            query?: ['init' | 'event', FusraInitParams | FusraEventParams][];
+        };
+    }
+}
+/**
+ * @name AnalyticsFUSPlugin
+ *
+ * @param * @param {{
+ *   productId: string,
+ *   productBuild: string,
+ *   recorderVersion: string?,
+ *   isDevelopment: boolean?,
+ *   groups: object[]?
+ * }} config
+ * @constructor
+ */
+export default class AnalyticsFUSPlugin implements AnalyticsPlugin {
+    private _recorderVersion?;
+    private _lastPagePath?;
+    private _groups;
+    constructor({ productId, productBuild, recorderVersion, isDevelopment, groups }: AnalyticsFUSPluginConfig);
+    trackEvent(category: string, action: string, additionalInfo?: Record<string, unknown>): void;
+    trackPageView(path: string): void;
+    get serializeAdditionalInfo(): boolean;
+    private _processEvent;
+}
+export {};

package/components/analytics/analytics__fus-plugin.js

@@ -1,5 +1,4 @@
 import AnalyticsPluginUtils from './analytics__plugin-utils';
-
 /**
  * @name AnalyticsFUSPlugin
  *
@@ -13,81 +12,69 @@ import AnalyticsPluginUtils from './analytics__plugin-utils';
  * @constructor
  */
 export default class AnalyticsFUSPlugin {
-  constructor({
-    productId,
-    productBuild,
-    recorderVersion = '1',
-    isDevelopment = false,
-    groups = []
-  }) {
-    if (!productId && !isDevelopment) {
-      return;
+    _recorderVersion;
+    _lastPagePath;
+    _groups;
+    constructor({ productId, productBuild, recorderVersion = '1', isDevelopment = false, groups = [] }) {
+        if (!productId && !isDevelopment) {
+            return;
+        }
+        ((i, s, o, g, r) => {
+            i[r] = i[r] || function addArgumentsToQueueForWaitingTheScriptLoading(...args) {
+                const fn = i[r];
+                if (fn != null) {
+                    (fn.query = fn.query || []).push(args);
+                }
+            };
+            const script = document.createElement(o);
+            script.async = true;
+            script.src = g;
+            const firstScript = document.getElementsByTagName(o)[0];
+            firstScript.parentNode?.insertBefore(script, firstScript);
+        })(window, document, 'script', '//resources.jetbrains.com/storage/fus/api/fus-reporting-api.js', 'fusra');
+        window.fusra?.('init', {
+            recorderCode: productId,
+            recorderVersion,
+            productCode: productId,
+            productBuild,
+            internal: isDevelopment,
+            groups,
+            useForSubdomains: true
+        });
+        this._recorderVersion = recorderVersion;
+        this._groups = groups;
     }
-    ((i, s, o, g, r) => {
-      i[r] = i[r] || function addArgumentsToQueueForWaitingTheScriptLoading() {
-        (i[r].query = i[r].query || []).push(arguments);
-      };
-      const script = document.createElement(o);
-      script.async = true;
-      script.src = g;
-      const firstScript = document.getElementsByTagName(o)[0];
-      firstScript.parentNode.insertBefore(script, firstScript);
-    })(window, document, 'script', '//resources.jetbrains.com/storage/fus/api/fus-reporting-api.js', 'fusra');
-    /* global fusra */
-    fusra('init', {
-      recorderCode: productId,
-      recorderVersion,
-      productCode: productId,
-      productBuild,
-      internal: isDevelopment,
-      groups,
-      useForSubdomains: true
-    });
-
-    this._recorderVersion = recorderVersion;
-    this._groups = groups;
-  }
-
-  trackEvent(category, action, additionalInfo) {
-    this._processEvent(category, action, additionalInfo);
-  }
-
-  trackPageView(path) {
-    if (this._lastPagePath === path) {
-      return;
+    trackEvent(category, action, additionalInfo) {
+        this._processEvent(category, action, additionalInfo);
     }
-
-    this._lastPagePath = path;
-
-    this._processEvent('ring.page.view', 'open', {
-      path,
-      browser: AnalyticsPluginUtils.getUserAgentPresentation(),
-      platform: AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform),
-      lang: AnalyticsPluginUtils.npeSaveLowerCase(navigator.language),
-      ['page-view-duration']: AnalyticsPluginUtils.getPageViewDurationPresentation(),
-      ['pixel-ratio']: AnalyticsPluginUtils.getDevicePixelRatioPresentation(),
-      screen: AnalyticsPluginUtils.getScreenWidthPresentation()
-    });
-  }
-
-  get serializeAdditionalInfo() {
-    return false;
-  }
-
-  _processEvent(category, action, additionalInfo) {
-    const groupId = category.replace(/[-]/g, '.');
-
-    const group = (this._groups || []).filter(
-      currentGroup => currentGroup.id === groupId
-    )[0];
-
-    if (group && window.fusra) {
-      fusra('event', {
-        groupId,
-        groupVersion: group.version || this._recorderVersion,
-        eventId: action,
-        eventData: additionalInfo
-      });
+    trackPageView(path) {
+        if (this._lastPagePath === path) {
+            return;
+        }
+        this._lastPagePath = path;
+        this._processEvent('ring.page.view', 'open', {
+            path,
+            browser: AnalyticsPluginUtils.getUserAgentPresentation(),
+            platform: AnalyticsPluginUtils.npeSaveLowerCase(navigator.platform),
+            lang: AnalyticsPluginUtils.npeSaveLowerCase(navigator.language),
+            ['page-view-duration']: AnalyticsPluginUtils.getPageViewDurationPresentation(),
+            ['pixel-ratio']: AnalyticsPluginUtils.getDevicePixelRatioPresentation(),
+            screen: AnalyticsPluginUtils.getScreenWidthPresentation()
+        });
+    }
+    get serializeAdditionalInfo() {
+        return false;
+    }
+    _processEvent(category, action, additionalInfo) {
+        const groupId = category.replace(/[-]/g, '.');
+        const group = (this._groups || []).filter(currentGroup => currentGroup.id === groupId)[0];
+        if (group && window.fusra) {
+            window.fusra('event', {
+                groupId,
+                groupVersion: group.version || this._recorderVersion,
+                eventId: action,
+                eventData: additionalInfo
+            });
+        }
     }
-  }
 }

package/components/analytics/analytics__ga-plugin.d.ts

@@ -0,0 +1,17 @@
+import { AnalyticsPlugin } from './analytics';
+declare global {
+    interface Window {
+        'GoogleAnalyticsObject': string;
+    }
+}
+/**
+ *
+ * @param {string?} gaId Google Analytics ID (should be undefined in development)
+ * @constructor
+ */
+export default class AnalyticsGAPlugin implements AnalyticsPlugin {
+    constructor(gaId?: string | undefined, isDevelopment?: boolean | undefined, domain?: string);
+    trackEvent(category: string, action: string): void;
+    trackPageView(path: string): void;
+    get serializeAdditionalInfo(): boolean;
+}