@globalpayments/vega 2.22.0 → 2.23.0

package/dist/collection/helpers/skeleton-loader/tests/vega-skeleton-loader-controller.test.js

@@ -2,6 +2,8 @@ jest.mock('../../../utils/misc', () => ({
   generateUUID: () => 'TEST_UUID',
 }));
 import { VegaSkeletonLoader } from '../vega-skeleton-loader-controller';
+import VegaTelemetryRuntimeMetricsManager from '@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index';
+import { sleep } from '../../../utils/test-utils';
 describe('vega-skeleton-loader-controller', () => {
   beforeEach(() => {
     document.body.innerHTML = `
@@ -136,4 +138,57 @@ describe('vega-skeleton-loader-controller', () => {
 		</body>
 	`);
   });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call load', () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    VegaSkeletonLoader.load({
+      target: '.target-class',
+      type: 'image',
+      width: '200px',
+      height: '100px',
+    });
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'VegaSkeletonLoaderController',
+        data: {
+          IS_LOAD_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call unLoad', () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    const key = VegaSkeletonLoader.load({
+      target: '.target-class',
+      type: 'image',
+      width: '200px',
+      height: '100px',
+    });
+    VegaSkeletonLoader.unLoad(key);
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'VegaSkeletonLoaderController',
+        data: {
+          IS_UNLOAD_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call unLoadAll', () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    VegaSkeletonLoader.load({
+      target: '.target-class',
+      type: 'image',
+      width: '200px',
+      height: '100px',
+    });
+    VegaSkeletonLoader.unLoadAll();
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'VegaSkeletonLoaderController',
+        data: {
+          IS_UNLOADALL_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
 });

package/dist/collection/helpers/skeleton-loader/vega-skeleton-loader-controller.js

@@ -1,9 +1,19 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { InjectVegaTelemetrySlimmer } from 'vega-slimmer/core';
+import { VegaSkeletonRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/public-api/VegaSkeletonLoader/runtime-metrics-payload-definition';
 import { generateUUID } from '../../utils/misc';
+import { createPublicAPIRuntimeMetricsSlimmer } from '../slimmers/runtime-metrics/create-public-api-runtime-metrics-slimmer';
 /**
  * Vega Skeleton Loader Controller to show skeletons in the target elements
  */
 class VegaSkeletonLoaderController {
   constructor() {
+    this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(VegaSkeletonLoaderController, ['load', 'unLoad', 'unLoadAll'], VegaSkeletonRuntimeMetricsPayloadDefinition);
     this.loaderMap = new Map();
   }
   /**
@@ -84,4 +94,7 @@ class VegaSkeletonLoaderController {
   }
 }
 VegaSkeletonLoaderController.LOADER_DATA_SET_KEY = 'vegaSkeletonLoaderKey';
+__decorate([
+  InjectVegaTelemetrySlimmer()
+], VegaSkeletonLoaderController.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
 export const VegaSkeletonLoader = new VegaSkeletonLoaderController();

package/dist/collection/helpers/slimmers/runtime-metrics/public-api-runtime-metrics-slimmer-base.js

@@ -1,5 +1,6 @@
-import { VegaSlimmer } from 'vega-slimmer/core';
+import { CurrentlyInvokedMethodName, VegaSlimmer } from 'vega-slimmer/core';
 import { LogUtility } from '../../../utils/log';
+import { isObjectEmpty } from '../../../utils/misc';
 /**
  * The `VegaPublicAPIRuntimeMetricsSlimmerBase` class is used for sending
  * telemetry data to a telemetry service based on defined usage metrics for a public api.
@@ -24,26 +25,28 @@ export class VegaPublicAPIRuntimeMetricsSlimmerBase extends VegaSlimmer {
    * register the observer when the slimmer method called
    *
    * @param {unknown[]} [args] - The `args` parameter passed in when the slimmer method is executed
-   * @param {string} [methodName] - The `methodName` parameter is the actual method name of the public API call.
    */
-  sendPublicAPIPayloadToTelemetry(args, methodName) {
-    // eslint-disable-next-line spellcheck/spell-checker
-    void import('@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index.js').then((
-    // eslint-disable-next-line spellcheck/spell-checker
-    module) => {
-      try {
-        module['default']['emit']('publicAPIMetrics', this.getPublicAPIMetricsPayload(methodName, args));
+  sendPublicAPIPayloadToTelemetry(args) {
+    try {
+      const publicAPIMetricsPayload = this.getPublicAPIMetricsPayload(args);
+      if (publicAPIMetricsPayload) {
+        // eslint-disable-next-line spellcheck/spell-checker
+        void import('@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index.js').then((
+        // eslint-disable-next-line spellcheck/spell-checker
+        module) => {
+          module['default']['emit']('publicAPIMetrics', publicAPIMetricsPayload);
+        });
       }
-      catch (error) {
-        LogUtility.log('Public API payload failed to emit telemetry:', error);
-      }
-    });
+    }
+    catch (error) {
+      LogUtility.log('Public API payload failed to emit telemetry:', error);
+    }
   }
   /**
    * The function `getPublicAPIMetricsPayload` generates a payload containing public api
    * metrics data.
+   * The `CurrentlyInvokedMethodName` is a public API method name, it comes from the `InjectVegaTelemetrySlimmer` definition and assignment
    *
-   * @param {string} [methodName] - The `methodName` parameter is the actual method name of the public API call.
    * @param {unknown[]} [args] - The `args` parameter passed in when the slimmer method is executed
    * @returns {Record<string, unknown>} The `getPublicAPIMetricsPayload` method returns an object with the following
    * structure:
@@ -53,13 +56,16 @@ export class VegaPublicAPIRuntimeMetricsSlimmerBase extends VegaSlimmer {
    * 		'waitForVegaRenderFinished': true,
    * }
    */
-  getPublicAPIMetricsPayload(methodName, args) {
+  getPublicAPIMetricsPayload(args) {
     const payloadData = {};
     this.usageDefinitions
-      .filter((definitions) => definitions.canAccept(this.className, methodName, args))
+      .filter((definitions) => definitions.canAccept(this.className, this[CurrentlyInvokedMethodName], args))
       .forEach((definitions) => {
-      payloadData[definitions.payloadKey] = definitions.payloadValue(this.className, methodName, args);
+      payloadData[definitions.payloadKey] = definitions.payloadValue(args);
     });
+    if (isObjectEmpty(payloadData)) {
+      return null;
+    }
     return {
       publicAPIName: this.className,
       data: payloadData,

package/dist/collection/helpers/slimmers/runtime-metrics/test/public-api-runtime-metrics-slimmer-base.test.js

@@ -8,58 +8,14 @@ import { InjectVegaSlimmer } from '../../../../../../vega-slimmer/src/decorators
 import { createPublicAPIRuntimeMetricsSlimmer } from '../create-public-api-runtime-metrics-slimmer';
 import VegaTelemetryRuntimeMetricsManager from '@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index';
 import { sleep } from '../../../../utils/test-utils';
-const MockPublicAPIRuntimeMetricsPayloadDefinition = [
-  {
-    payloadKey: 'IS_TEST_METHOD_CALLED',
-    payloadDescription: 'Indicate if the method test of public API MockPublicAPI is called',
-    /**
-     * Indicate whether the method is collected when the method been called .
-     *
-     * @returns {boolean} A boolean value
-     */
-    canAccept: () => true,
-    /**
-     * The function checks if the method name is test.
-     *
-     * @param {string} scope - The class name of public api
-     * @param {string} methodName - The method name called by the public api
-     * @returns {boolean} A boolean value
-     */
-    payloadValue: (scope, methodName) => {
-      return scope === 'MockPublicAPI' && methodName === 'test';
-    },
-  },
-];
-class MockPublicAPI {
-  constructor() {
-    this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(MockPublicAPI, ['test'], MockPublicAPIRuntimeMetricsPayloadDefinition);
-  }
-  /**
-   * Load the skeletons in the target elements
-   *
-   * @param { unknown } parameter - Configuration for the loading function
-   */
-  test(parameter) {
-    console.log('parameter', parameter);
-  }
-}
-__decorate([
-  InjectVegaSlimmer()
-], MockPublicAPI.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
-const mockPublicAPI = new MockPublicAPI();
 describe('VegaPublicAPIRuntimeMetricsSlimmerBase', () => {
-  it('should call the emit method of VegaTelemetryRuntimeMetricsManager ', () => {
+  it('should console error log when usageDefinitions is empty ', () => {
     class MockPublicAPI {
       constructor() {
         this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(MockPublicAPI, ['test'], 
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         '');
       }
-      /**
-       * Load the skeletons in the target elements
-       *
-       * @param { unknown } parameter - Configuration for the loading function
-       */
       test(parameter) {
         console.log('parameter', parameter);
       }
@@ -68,13 +24,33 @@ describe('VegaPublicAPIRuntimeMetricsSlimmerBase', () => {
       InjectVegaSlimmer()
     ], MockPublicAPI.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
     const mockPublicAPI = new MockPublicAPI();
-    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    jest.spyOn(console, 'log');
     mockPublicAPI.test('test');
-    void Promise.resolve(sleep(100)).then(async () => {
-      expect(VegaTelemetryRuntimeMetricsManager.emit).not.toBeCalled();
-    });
+    expect(console.log).toBeCalledTimes(1);
   });
   it('should call the emit method of VegaTelemetryRuntimeMetricsManager ', () => {
+    const MockPublicAPIRuntimeMetricsPayloadDefinition = [
+      {
+        payloadKey: 'IS_TEST_METHOD_CALLED',
+        payloadDescription: 'Indicate if the method test of public API MockPublicAPI is called',
+        canAccept: (scope, methodName) => scope === 'MockPublicAPI' && methodName === 'test',
+        payloadValue: () => {
+          return true;
+        },
+      },
+    ];
+    class MockPublicAPI {
+      constructor() {
+        this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(MockPublicAPI, ['test'], MockPublicAPIRuntimeMetricsPayloadDefinition);
+      }
+      test(parameter) {
+        console.log('parameter', parameter);
+      }
+    }
+    __decorate([
+      InjectVegaSlimmer()
+    ], MockPublicAPI.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
+    const mockPublicAPI = new MockPublicAPI();
     jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
     mockPublicAPI.test('test');
     void Promise.resolve(sleep(100)).then(async () => {
@@ -86,4 +62,35 @@ describe('VegaPublicAPIRuntimeMetricsSlimmerBase', () => {
       });
     });
   });
+  it('should not send runtime metrics to telemetry when the public api payload is empty', () => {
+    const MockPublicAPIRuntimeMetricsPayloadDefinition = [
+      {
+        payloadKey: 'IS_TEST_METHOD_CALLED',
+        payloadDescription: 'Indicate if the method test of public API MockPublicAPI is called',
+        canAccept: (scope, methodName) => scope === 'MockPublicAPI' && methodName === 'test',
+        payloadValue: () => {
+          return true;
+        },
+      },
+    ];
+    class MockPublicAPI {
+      constructor() {
+        this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(MockPublicAPI, ['test'], 
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        MockPublicAPIRuntimeMetricsPayloadDefinition);
+      }
+      test(parameter) {
+        console.log('parameter', parameter);
+      }
+    }
+    __decorate([
+      InjectVegaSlimmer()
+    ], MockPublicAPI.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
+    const mockPublicAPI = new MockPublicAPI();
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    mockPublicAPI.test('test');
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).not.toBeCalled();
+    });
+  });
 });

package/dist/collection/helpers/theme/tests/theme-manager-controller.test.js

@@ -1,4 +1,6 @@
 import { VegaThemeManager } from '../theme-manager';
+import VegaTelemetryRuntimeMetricsManager from '@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index';
+import { sleep } from '../../../utils/test-utils';
 const parseResultToArray = (textContent) => {
   return textContent === null || textContent === void 0 ? void 0 : textContent.trim().replace(/\n|\t|:root {|}/g, '').split(';').map((item) => item.split(': ')).filter((item) => item.length === 2).sort();
 };
@@ -507,3 +509,57 @@ describe('Dark mode', () => {
 	`);
   });
 });
+describe('Send Telemetry', () => {
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call overrideColors', async () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    await VegaThemeManager.overrideColors({ actionColor: '#3c9f55', sidebarColor: '#274f1c' });
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'ThemeManager',
+        data: {
+          IS_OVERRIDECOLORS_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call reset', async () => {
+    var _a, _b, _c, _d;
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    await VegaThemeManager.overrideColors({ actionColor: '#3c9f55', sidebarColor: '#274f1c' });
+    expect((_b = (_a = document.querySelector('#vegaCustomOverrideTheme')) === null || _a === void 0 ? void 0 : _a.textContent) === null || _b === void 0 ? void 0 : _b.length).toBeGreaterThan(0);
+    await VegaThemeManager.reset();
+    expect(((_d = (_c = document.querySelector('#vegaCustomOverrideTheme')) === null || _c === void 0 ? void 0 : _c.textContent) === null || _d === void 0 ? void 0 : _d.length) === 0).toBe(true);
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'ThemeManager',
+        data: {
+          IS_RESET_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call overrideColors', async () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    VegaThemeManager.toggleDarkMode(true);
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'ThemeManager',
+        data: {
+          IS_TOGGLEDARKMODE_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+  it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call overrideColors', async () => {
+    jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+    VegaThemeManager.isDarkMode();
+    void Promise.resolve(sleep(100)).then(async () => {
+      expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+        publicAPIName: 'ThemeManager',
+        data: {
+          IS_ISDARKMODE_METHOD_CALLED: true,
+        },
+      });
+    });
+  });
+});

package/dist/collection/helpers/theme/theme-manager.js

@@ -1,9 +1,21 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import { VegaColorSchemaOverridingController } from './controllers/color-schema-overriding-controller';
 import { VegaDarkModeStyleController } from './controllers/dark-mode-style-controller';
+import { InjectVegaTelemetrySlimmer } from 'vega-slimmer/core';
+import { createPublicAPIRuntimeMetricsSlimmer } from '../slimmers/runtime-metrics/create-public-api-runtime-metrics-slimmer';
+import { ThemeManagerRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/public-api/ThemeManager/runtime-metrics-payload-definition';
 /**
  * Vega components theme manager
  */
 class ThemeManager {
+  constructor() {
+    this.vegaPublicAPIRuntimeMetricsSlimmer = createPublicAPIRuntimeMetricsSlimmer(ThemeManager, ['overrideColors', 'reset', 'toggleDarkMode', 'isDarkMode'], ThemeManagerRuntimeMetricsPayloadDefinition);
+  }
   /**
    * It takes the colors you passed in, parses them into the correct format, and then applies them to the theme
    *
@@ -45,4 +57,7 @@ class ThemeManager {
     return document.documentElement.classList.contains('dark');
   }
 }
+__decorate([
+  InjectVegaTelemetrySlimmer()
+], ThemeManager.prototype, "vegaPublicAPIRuntimeMetricsSlimmer", void 0);
 export const VegaThemeManager = new ThemeManager();

package/dist/collection/helpers/ui/element-appender.js

@@ -7,7 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { getPositionBox } from '../../utils/position';
 import ResponsiveFormatFacade from '../formatter/responsive-map-formatter/responsive-format-facade';
 import { isElementVisible } from '../../utils/ui';
-import ZIndexManager from '../zindex/z-index-manager';
+import InternalVegaZIndexManager from '../zindex/internal-vega-z-index-manager';
 import { LogUtility } from '../../utils/log';
 import { InjectVegaSlimmer, createDynamicSlimmer, methodPlaceholder } from 'vega-slimmer/core';
 import { PageResizeObserverSlimmer } from '../slimmers/page-resize-observer-slimmer';
@@ -99,7 +99,7 @@ export class ElementAppender {
       return;
     this.toggleShow(false);
     this.resetContainerPosition();
-    ZIndexManager.removeZIndex(this.showConfig.appendableElement, 'base');
+    InternalVegaZIndexManager.removeZIndex(this.showConfig.appendableElement, 'base');
   }
   /* istanbul ignore next */
   /**
@@ -110,7 +110,7 @@ export class ElementAppender {
     if (!this.showConfig)
       return;
     this.removeVisibleAppendElement(this.showConfig.appendableElement);
-    ZIndexManager.removeZIndex(this.showConfig.appendableElement, 'base');
+    InternalVegaZIndexManager.removeZIndex(this.showConfig.appendableElement, 'base');
     this.showConfig.appendableElement.remove();
     this.disconnectResizeObserver();
   }
@@ -289,7 +289,7 @@ export class ElementAppender {
    * @returns {void}
    */
   setZIndex() {
-    ZIndexManager.setZIndex(this.showConfig.appendableElement, 'base');
+    InternalVegaZIndexManager.setZIndex(this.showConfig.appendableElement, 'base');
   }
   /**
    * If the showConfigCallback is a function, call it and return the result, otherwise return the

package/dist/collection/helpers/vega-telemetry-helper/test/vega-env-manager.test.js

@@ -4,7 +4,7 @@ test('should return the correct vega environment parameters', () => {
   const vegaEnv = VegaEnvManager.getVegaEnv();
   expect(vegaEnv).toEqual({
     framework: 'vanilla-js',
-    version: '2.22.0',
+    version: '2.23.0',
   });
 });
 test('should return the correct vega framework', () => {

package/dist/collection/helpers/vega-telemetry-helper/vega-env-manager.js

@@ -9,9 +9,9 @@ export var FrameworkEnum;
 /** The VegaEnvManager class manages vega environment parameters. */
 class VegaEnvManager {
   constructor() {
-    // The `2.22.0` will be replaced to a version string when running publish script.
+    // The `2.23.0` will be replaced to a version string when running publish script.
     // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-    this.vegaVersion = '2.22.0';
+    this.vegaVersion = '2.23.0';
     this.framework = FrameworkEnum.VanillaJs;
   }
   /**

package/dist/collection/helpers/zindex/{z-index-manager.js → internal-vega-z-index-manager.js}

@@ -7,7 +7,7 @@ export const TOP_BASIC_Z_INDEX = 11000;
  * 	the z-index of current showing element is highly than already show.
  * Top level is for element that always display to top, such as notification.
  */
-class ZIndexManager {
+class InternalVegaZIndexManager {
   constructor() {
     this.baseBasicZIndex = BASE_BASIC_Z_INDEX;
     this.topBasicZIndex = TOP_BASIC_Z_INDEX;
@@ -172,4 +172,4 @@ class ZIndexManager {
     return baseEntry.zIndex >= this.topBasicZIndex;
   }
 }
-export default new ZIndexManager();
+export default new InternalVegaZIndexManager();

package/dist/collection/helpers/zindex/test/{z-index-manager.test.js → internal-vega-z-index-manager.test.js}

@@ -1,5 +1,5 @@
 import { LogUtility } from '../../../utils/log';
-import ZIndexManager from '../z-index-manager';
+import InternalVegaZIndexManager from '../internal-vega-z-index-manager';
 test('zIndexManager should work proper', () => {
   const container = document.createElement('div');
   container.innerHTML = `
@@ -11,17 +11,17 @@ test('zIndexManager should work proper', () => {
     <div id='div-4'></div>
     <div id='div-5'></div>
     `;
-  ZIndexManager.setZIndex(null);
+  InternalVegaZIndexManager.setZIndex(null);
   const div1 = container.querySelector('#div-1');
   const div2 = container.querySelector('#div-2');
   const div3 = container.querySelector('#div-3');
   const div4 = container.querySelector('#div-4');
   const div5 = container.querySelector('#div-5');
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.setZIndex(div2);
-  ZIndexManager.setZIndex(div3);
-  ZIndexManager.setZIndex(div4, 'top');
-  ZIndexManager.setZIndex(div5, 'top');
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div2);
+  InternalVegaZIndexManager.setZIndex(div3);
+  InternalVegaZIndexManager.setZIndex(div4, 'top');
+  InternalVegaZIndexManager.setZIndex(div5, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 10001;">
@@ -33,9 +33,9 @@ test('zIndexManager should work proper', () => {
             <div id="div-5" style="z-index: 11002;"></div>
         </div>
     `);
-  ZIndexManager.removeZIndex(null);
-  ZIndexManager.removeZIndex(div2);
-  ZIndexManager.removeZIndex(div5, 'top');
+  InternalVegaZIndexManager.removeZIndex(null);
+  InternalVegaZIndexManager.removeZIndex(div2);
+  InternalVegaZIndexManager.removeZIndex(div5, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 10001;">
@@ -47,8 +47,8 @@ test('zIndexManager should work proper', () => {
             <div id="div-5"></div>
         </div>
     `);
-  ZIndexManager.setZIndex(div2);
-  ZIndexManager.setZIndex(div5, 'top');
+  InternalVegaZIndexManager.setZIndex(div2);
+  InternalVegaZIndexManager.setZIndex(div5, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 10001;">
@@ -65,13 +65,13 @@ test('zIndexManager should work proper', () => {
     const div = document.createElement('div');
     div.setAttribute('id', `${i}`);
     divCollect.push(div);
-    ZIndexManager.setZIndex(div);
+    InternalVegaZIndexManager.setZIndex(div);
   }
   spyOn(LogUtility, 'warn');
   const div = document.createElement('div');
   divCollect.push(div);
   div.setAttribute('id', `${1000}`);
-  ZIndexManager.setZIndex(div);
+  InternalVegaZIndexManager.setZIndex(div);
   expect(div.style.zIndex).toEqual('11001');
   expect(container).toEqualHtml(`
         <div>
@@ -92,9 +92,9 @@ test('zIndexManager should work proper while remove first element of stack', ()
         <div id="div-1"></div>
     `;
   const div1 = container.querySelector('#div-1');
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.removeZIndex(div1);
-  ZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.removeZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div1);
   expect(container).toEqualHtml(`
         <div>
            <div id="div-1" style="z-index: 10001;"></div>
@@ -113,13 +113,13 @@ test('zIndexManager should work proper while change basic z-index value', () =>
   const div1 = container.querySelector('#div-1');
   const div2 = container.querySelector('#div-2');
   const div3 = container.querySelector('#div-3');
-  ZIndexManager.overrideZIndexBasicValues({
+  InternalVegaZIndexManager.overrideZIndexBasicValues({
     base: 200,
     top: 300,
   });
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.setZIndex(div2);
-  ZIndexManager.setZIndex(div3, 'top');
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div2);
+  InternalVegaZIndexManager.setZIndex(div3, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 201;">
@@ -129,12 +129,12 @@ test('zIndexManager should work proper while change basic z-index value', () =>
             </div>
         </div>
     `);
-  ZIndexManager.overrideZIndexBasicValues({
+  InternalVegaZIndexManager.overrideZIndexBasicValues({
     base: 100,
   });
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.setZIndex(div2);
-  ZIndexManager.setZIndex(div3, 'top');
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div2);
+  InternalVegaZIndexManager.setZIndex(div3, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 101;">
@@ -144,12 +144,12 @@ test('zIndexManager should work proper while change basic z-index value', () =>
             </div>
         </div>
     `);
-  ZIndexManager.overrideZIndexBasicValues({
+  InternalVegaZIndexManager.overrideZIndexBasicValues({
     top: 500,
   });
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.setZIndex(div2);
-  ZIndexManager.setZIndex(div3, 'top');
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div2);
+  InternalVegaZIndexManager.setZIndex(div3, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 101;">
@@ -162,12 +162,12 @@ test('zIndexManager should work proper while change basic z-index value', () =>
 });
 test('ZIndexManager should raise error while change basic z-index with invalid value', () => {
   spyOn(LogUtility, 'error');
-  ZIndexManager.overrideZIndexBasicValues({
+  InternalVegaZIndexManager.overrideZIndexBasicValues({
     base: 'a',
   });
   expect(LogUtility.error).toBeCalledTimes(1);
   expect(LogUtility.error).toHaveBeenCalledWith('Change z-index basic value failed, both base level and top level should be of type number!');
-  ZIndexManager.overrideZIndexBasicValues({
+  InternalVegaZIndexManager.overrideZIndexBasicValues({
     base: 500,
     top: 100,
   });

package/dist/collection/helpers/zindex/test/vega-z-index-manager.test.js

@@ -1,5 +1,7 @@
 import VegaZIndexManager from '../vega-z-index-manager';
-import ZIndexManager from '../z-index-manager';
+import VegaTelemetryRuntimeMetricsManager from '@globalpayments/vega-telemetry-runtime-metrics/runtime-metrics/src/index';
+import { sleep } from '../../../utils/test-utils';
+import InternalVegaZIndexManager from '../internal-vega-z-index-manager';
 test('VegaZIndexManager should work proper', () => {
   const container = document.createElement('div');
   container.innerHTML = `
@@ -8,8 +10,8 @@ test('VegaZIndexManager should work proper', () => {
     `;
   const div1 = container.querySelector('#div-1');
   const div2 = container.querySelector('#div-2');
-  ZIndexManager.setZIndex(div1);
-  ZIndexManager.setZIndex(div2, 'top');
+  InternalVegaZIndexManager.setZIndex(div1);
+  InternalVegaZIndexManager.setZIndex(div2, 'top');
   expect(container).toEqualHtml(`
         <div>
             <div id="div-1" style="z-index: 10001;"></div>
@@ -27,3 +29,18 @@ test('VegaZIndexManager should work proper', () => {
         </div>
     `);
 });
+it('should call the emit method of VegaTelemetryRuntimeMetricsManager when call overrideZIndexBasicValues', () => {
+  jest.spyOn(VegaTelemetryRuntimeMetricsManager, 'emit');
+  VegaZIndexManager.overrideZIndexBasicValues({
+    base: 10001,
+  });
+  void Promise.resolve(sleep(100)).then(async () => {
+    expect(VegaTelemetryRuntimeMetricsManager.emit).toHaveBeenCalledWith('publicAPIMetrics', {
+      publicAPIName: 'VegaZIndexManager',
+      data: {
+        IS_OVERRIDEZINDEXBASICVALUES_METHOD_CALLED: true,
+        zIndexBasicValuesGreatThanTenThousand: true,
+      },
+    });
+  });
+});