@availity/analytics-core 3.1.5 → 3.1.6

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.6](https://github.com/availity/sdk-js/compare/@availity/analytics-core@3.1.5...@availity/analytics-core@3.1.6) (2021-12-21)
+
+**Note:** Version bump only for package @availity/analytics-core
+
+
+
+
+
 ## 3.1.5 (2021-12-01)
 
 

package/README.md

@@ -1,6 +1,10 @@
-# Analytics Core
+# @availity/analytics-core
+
+> analytics package for tracking user behavior on the dom
 
 [![Version](https://img.shields.io/npm/v/@availity/analytics-core.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/analytics-core)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/analytics-core.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/analytics-core)
+[![Dependecy Status](https://img.shields.io/librariesio/release/npm/@availity/analytics-core?style=for-the-badge)](https://github.com/Availity/sdk-js/blob/master/packages/analytics-core/package.json)
 
 ## Install
 
@@ -16,4 +20,6 @@ npm install @availity/analytics-core
 yarn add @availity/analytics-core
 ```
 
-## [Documentation](https://availity.github.io/sdk-js/resources/analytics)
+## Documentation
+
+Check out more documentation at [availity.github.io](https://availity.github.io/sdk-js/resources/analytics)

package/lib/analytics.js

@@ -15,6 +15,12 @@ require("core-js/modules/es.object.keys.js");
 
 require("core-js/modules/es.array.filter.js");
 
+require("core-js/modules/esnext.async-iterator.filter.js");
+
+require("core-js/modules/esnext.iterator.constructor.js");
+
+require("core-js/modules/esnext.iterator.filter.js");
+
 require("core-js/modules/es.function.name.js");
 
 require("core-js/modules/es.array.slice.js");

package/lib/dma.js

@@ -10,6 +10,8 @@ require("core-js/modules/es.weak-map.js");
 
 require("core-js/modules/esnext.weak-map.delete-all.js");
 
+require("core-js/modules/esnext.weak-map.emplace.js");
+
 require("core-js/modules/web.dom-collections.iterator.js");
 
 require("core-js/modules/es.object.get-own-property-descriptor.js");

package/package.json

@@ -1,22 +1,40 @@
 {
   "name": "@availity/analytics-core",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "description": "Analytics base configuration for sdk-js",
+  "keywords": [
+    "availity",
+    "analytics"
+  ],
+  "homepage": "https://availity.github.io/sdk-js/resources/analytics",
+  "bugs": {
+    "url": "https://github.com/availity/sdk-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/availity/sdk-js.git",
+    "directory": "packages/analytics-core"
+  },
+  "license": "MIT",
+  "author": "Kasey Powers <kasey.powers@availity.com>",
   "main": "lib/index.js",
   "module": "src/index.js",
   "types": "types/index.d.ts",
-  "author": "Kasey Powers <kasey.powers@availity.com>",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "scripts": {
+    "build": "yarn clean && yarn transpile",
+    "clean": "rimraf ./lib",
+    "transpile": "babel --root-mode upward src -d lib --ignore **/*.test.js"
   },
-  "gitHead": "9e866c001205ac3765a3385ac8ed4a8b66962372",
   "dependencies": {
-    "@babel/runtime": "^7.15.4",
+    "@babel/runtime": "^7.16.5",
     "core-js": "^3.12.1",
     "yup": "^0.32.9"
   },
   "devDependencies": {
-    "@availity/api-axios": "^6.0.5"
-  }
+    "@availity/api-axios": "^6.0.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "1c3e8c8045b16fc5111f941d863600f0a97cdbff"
 }

package/types/analytics.d.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 declare class AvAnalytics {
   constructor(
     plugins: any[],

package/types/dma.d.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import AvAnalyticsPlugin from './plugin';
 
 declare class AvDmaAnalytics extends AvAnalyticsPlugin {

package/types/plugin.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 declare class AvAnalyticsPlugin {
   constructor(enabled?: boolean);
 

package/types/splunk.d.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import AvAnalyticsPlugin from './plugin';
 
 declare class AvSplunkAnalytics extends AvAnalyticsPlugin {

package/src/tests/analytics.test.js

@@ -1,184 +0,0 @@
-import { AvAnalytics } from '..';
-
-function makePlugin() {
-  return {
-    isEnabled: jest.fn(() => true),
-    init: jest.fn(),
-    trackEvent: jest.fn(),
-    trackPageView: jest.fn(),
-  };
-}
-
-describe('AvAnalytics', () => {
-  let mockAvAnalytics;
-
-  test('AvAnalytics should be defined', () => {
-    const plugins = [makePlugin()];
-    mockAvAnalytics = new AvAnalytics(plugins, Promise, true);
-    expect(mockAvAnalytics).toBeDefined();
-    mockAvAnalytics = new AvAnalytics(plugins, Promise);
-    expect(mockAvAnalytics).toBeDefined();
-  });
-
-  test('AvAnalytics should throw error without plugins or Promise', () => {
-    expect(() => {
-      mockAvAnalytics = new AvAnalytics();
-    }).toThrow('[plugins] and [promise] must be defined');
-  });
-
-  test('AvAnalytics should cast plugins to an array', () => {
-    const plugin = makePlugin();
-    mockAvAnalytics = new AvAnalytics(plugin, Promise);
-    expect(mockAvAnalytics.plugins).toEqual([plugin]);
-  });
-
-  test('AvAnalytics should use custom configs', () => {
-    mockAvAnalytics = new AvAnalytics([], Promise, true, true, {
-      attributePrefix: 'some-attr',
-      recursive: true,
-    });
-    expect(mockAvAnalytics.attributePrefix).toBe('some-attr');
-    expect(mockAvAnalytics.recursive).toBe(true);
-  });
-
-  describe('setPageTracking', () => {
-    beforeEach(() => {
-      const plugins = [makePlugin()];
-      mockAvAnalytics = new AvAnalytics(plugins, Promise);
-    });
-
-    test('passing in argument should change value of pageTracking', () => {
-      const initialTracking = true;
-      const setPageTracking = !initialTracking;
-
-      mockAvAnalytics.pageTracking = initialTracking;
-
-      mockAvAnalytics.setPageTracking(setPageTracking);
-      expect(mockAvAnalytics.pageTracking).toBe(setPageTracking);
-    });
-
-    test('isPageTracking will not change without start/stop pageTracking functions defined', () => {
-      mockAvAnalytics.startPageTracking = undefined;
-      mockAvAnalytics.setPageTracking(true);
-      expect(mockAvAnalytics.isPageTracking).toBe(false);
-      mockAvAnalytics.setPageTracking(false);
-      expect(mockAvAnalytics.isPageTracking).toBe(false);
-    });
-
-    test('with functions defined, will only call if pageTracking is opposite isPageTracking', () => {
-      mockAvAnalytics.startPageTracking = jest.fn();
-      mockAvAnalytics.stopPageTracking = jest.fn();
-
-      let testValue = true;
-      mockAvAnalytics.pageTracking = testValue;
-      mockAvAnalytics.isPageTracking = testValue;
-      mockAvAnalytics.setPageTracking();
-      expect(mockAvAnalytics.startPageTracking).not.toHaveBeenCalled();
-      expect(mockAvAnalytics.stopPageTracking).not.toHaveBeenCalled();
-
-      testValue = false;
-      mockAvAnalytics.pageTracking = testValue;
-      mockAvAnalytics.isPageTracking = testValue;
-      mockAvAnalytics.setPageTracking();
-      expect(mockAvAnalytics.startPageTracking).not.toHaveBeenCalled();
-      expect(mockAvAnalytics.stopPageTracking).not.toHaveBeenCalled();
-    });
-
-    test('with functions defined, will start/stop tracking based on pageTracking value', () => {
-      mockAvAnalytics.startPageTracking = jest.fn();
-      mockAvAnalytics.stopPageTracking = jest.fn();
-
-      let testValue = true;
-      mockAvAnalytics.pageTracking = testValue;
-      mockAvAnalytics.isPageTracking = !testValue;
-
-      mockAvAnalytics.setPageTracking();
-      expect(mockAvAnalytics.startPageTracking).toHaveBeenCalledTimes(1);
-      expect(mockAvAnalytics.stopPageTracking).toHaveBeenCalledTimes(0);
-      expect(mockAvAnalytics.isPageTracking).toBe(testValue);
-
-      testValue = false;
-      mockAvAnalytics.pageTracking = testValue;
-      mockAvAnalytics.isPageTracking = !testValue;
-
-      mockAvAnalytics.setPageTracking();
-      expect(mockAvAnalytics.startPageTracking).toHaveBeenCalledTimes(1);
-      expect(mockAvAnalytics.stopPageTracking).toHaveBeenCalledTimes(1);
-      expect(mockAvAnalytics.isPageTracking).toBe(testValue);
-    });
-  });
-
-  describe('init', () => {
-    let plugins;
-    beforeEach(() => {
-      plugins = [makePlugin(), makePlugin()];
-      mockAvAnalytics = new AvAnalytics(plugins, Promise);
-      mockAvAnalytics.setPageTracking = jest.fn();
-    });
-
-    test('should call setPageTracking', () => {
-      mockAvAnalytics.init();
-      expect(mockAvAnalytics.setPageTracking).toHaveBeenCalled();
-    });
-
-    test('should check each plugin is enabled', () => {
-      mockAvAnalytics.init();
-      for (const plugin of plugins) {
-        expect(plugin.isEnabled).toHaveBeenCalled();
-      }
-    });
-
-    test('should call init on enabled plugins', () => {
-      mockAvAnalytics.init();
-      for (const plugin of plugins) {
-        expect(plugin.init).toHaveBeenCalledTimes(1);
-      }
-
-      plugins[0].isEnabled.mockImplementationOnce(() => false);
-      mockAvAnalytics.init();
-      expect(plugins[0].init).toHaveBeenCalledTimes(1);
-      expect(plugins[1].init).toHaveBeenCalledTimes(2);
-    });
-
-    test('should skip plugins without init function', () => {
-      plugins[1].init = 'test';
-      mockAvAnalytics.init();
-      expect(plugins[0].init).toHaveBeenCalled();
-    });
-  });
-
-  describe('event tracking', () => {
-    let plugins;
-    beforeEach(() => {
-      plugins = [makePlugin(), makePlugin(), makePlugin()];
-
-      mockAvAnalytics = new AvAnalytics(plugins, Promise);
-
-      plugins[0].isEnabled.mockImplementation(() => false);
-      plugins[1].trackEvent = 'test';
-      plugins[2].trackPageView = 'test';
-    });
-
-    test('trackEvent should call trackEvent on enabled plugins with properties', async () => {
-      const mockProperties = {};
-      await mockAvAnalytics.trackEvent(mockProperties);
-      expect(plugins[0].trackEvent).not.toHaveBeenCalled();
-      expect(plugins[2].trackEvent).toHaveBeenCalledWith(mockProperties);
-    });
-
-    test('trackEvent should call trackEvent on enabled plugins with url', async () => {
-      const mockProperties = {};
-      await mockAvAnalytics.trackEvent(mockProperties);
-      expect(plugins[0].trackEvent).not.toHaveBeenCalled();
-      expect(mockProperties.url).toBeDefined();
-      expect(plugins[2].trackEvent).toHaveBeenCalledWith(mockProperties);
-    });
-
-    test('trackPageView should call trackPageView on enabled plugins with properties', async () => {
-      const mockUrl = 'testProperties';
-      await mockAvAnalytics.trackPageView(mockUrl);
-      expect(plugins[0].trackPageView).not.toHaveBeenCalled();
-      expect(plugins[1].trackPageView).toHaveBeenCalledWith(mockUrl);
-    });
-  });
-});

package/src/tests/dma.test.js

@@ -1,31 +0,0 @@
-import { avLogMessagesApiV2 } from '@availity/api-axios';
-import { AvDmaAnalytics } from '..';
-
-jest.mock('@availity/api-axios');
-
-describe('AvSplunkAnalytics', () => {
-  let mockAvSplunkAnalytics;
-
-  beforeEach(() => {
-    avLogMessagesApiV2.sendBeacon = jest.fn();
-    // avLogMessagesApiV2.info = jest.fn;
-    mockAvSplunkAnalytics = new AvDmaAnalytics(avLogMessagesApiV2);
-  });
-
-  test('AvSplunkAnalytics should be defined', () => {
-    expect(mockAvSplunkAnalytics).toBeDefined();
-  });
-
-  test('trackEvent should call AvLogMessages.send', () => {
-    const level = 'info';
-    mockAvSplunkAnalytics.trackEvent({ level, label: 'test' });
-    expect(avLogMessagesApiV2.info).toHaveBeenCalledTimes(1);
-  });
-
-  test('trackEvent should not allow unknown keys', () => {
-    const level = 'info';
-    expect(() => {
-      mockAvSplunkAnalytics.trackEvent({ level, test: 'test' });
-    }).toThrow();
-  });
-});

package/src/tests/plugin.test.js

@@ -1,22 +0,0 @@
-import { AvAnalyticsPlugin } from '..';
-
-describe('AvAnalyticsPlugin', () => {
-  let mockPlugin;
-
-  test('AvAnalyticsPlugin should be defined', () => {
-    mockPlugin = new AvAnalyticsPlugin();
-    expect(mockPlugin).toBeDefined();
-  });
-
-  test('should default enabled to true', () => {
-    mockPlugin = new AvAnalyticsPlugin();
-    expect(mockPlugin.enabled).toBe(true);
-    mockPlugin = new AvAnalyticsPlugin(false);
-    expect(mockPlugin.enabled).toBe(false);
-  });
-
-  test('isEnabled should return enabled value', () => {
-    mockPlugin = new AvAnalyticsPlugin();
-    expect(mockPlugin.isEnabled()).toBe(mockPlugin.enabled);
-  });
-});

package/src/tests/splunk.test.js

@@ -1,68 +0,0 @@
-import { AvSplunkAnalytics } from '..';
-
-describe('AvSplunkAnalytics', () => {
-  let mockLog;
-  let mockAvSplunkAnalytics;
-
-  beforeEach(() => {
-    mockLog = {
-      info: jest.fn(),
-      test: jest.fn(),
-    };
-
-    mockAvSplunkAnalytics = new AvSplunkAnalytics(mockLog);
-  });
-
-  test('AvSplunkAnalytics should be defined', () => {
-    expect(mockAvSplunkAnalytics).toBeDefined();
-  });
-
-  test('trackEvent should call AvLogMessages[level]', () => {
-    let level = 'info';
-    mockAvSplunkAnalytics.trackEvent({ level });
-    expect(mockLog.info).toHaveBeenCalledTimes(1);
-    expect(mockLog.test).toHaveBeenCalledTimes(0);
-    level = 'test';
-    mockAvSplunkAnalytics.trackEvent({ level });
-    expect(mockLog.info).toHaveBeenCalledTimes(1);
-    expect(mockLog.test).toHaveBeenCalledTimes(1);
-  });
-
-  test("trackEvent should default level to 'info'", () => {
-    mockAvSplunkAnalytics.trackEvent({});
-    expect(mockLog.info).toHaveBeenCalledTimes(1);
-    expect(mockLog.test).toHaveBeenCalledTimes(0);
-  });
-
-  test("trackEvent should default properties.url to location.href or 'N/A'", () => {
-    let startingObject = {
-      message: 'hello world',
-      url: window.location.href || 'N/A',
-    };
-    const expectedCall = {
-      ...startingObject,
-      url: window.location.href || 'N/A',
-      level: 'info',
-    };
-    mockAvSplunkAnalytics.trackEvent(startingObject);
-    expect(mockLog.info).toHaveBeenCalledWith(expectedCall);
-
-    startingObject = {
-      message: 'hello world',
-      url: 'testUrl',
-      level: 'test',
-    };
-    mockAvSplunkAnalytics.trackEvent(startingObject);
-    expect(mockLog.test).toHaveBeenCalledWith(startingObject);
-  });
-
-  test("trackPageView should call trackEvent with event 'page' and passed in url", () => {
-    const testUrl = 'testUrl';
-    mockAvSplunkAnalytics.trackEvent = jest.fn();
-    mockAvSplunkAnalytics.trackPageView(testUrl);
-    expect(mockAvSplunkAnalytics.trackEvent).toHaveBeenCalledWith({
-      event: 'page',
-      url: testUrl,
-    });
-  });
-});

package/src/tests/util.test.js

@@ -1,52 +0,0 @@
-import {
-  camelCase,
-  getComposedPath,
-  isLeftClickEvent,
-  isModifiedEvent,
-  isPluginEnabled,
-  isValidEventTypeOnTarget,
-} from '../util';
-
-describe('analytics-core utils', () => {
-  test('isLeftClickEvent', () => {
-    expect(isLeftClickEvent({ button: 0 })).toBeTruthy();
-    expect(isLeftClickEvent({ button: 1 })).toBeFalsy();
-  });
-
-  test('isModifiedEvent', () => {
-    expect(isModifiedEvent({ metaKey: 1 })).toBeTruthy();
-    expect(isModifiedEvent({ altKey: 1 })).toBeTruthy();
-    expect(isModifiedEvent({ ctrlKey: 1 })).toBeTruthy();
-    expect(isModifiedEvent({ shiftKey: 1 })).toBeTruthy();
-    expect(isModifiedEvent({ key: 1 })).toBeFalsy();
-  });
-
-  test('isValidEventTypeOnTarget', () => {
-    expect(isValidEventTypeOnTarget({ target: { nodeName: 'click' }, type: 'click' })).toBeTruthy();
-    expect(isValidEventTypeOnTarget({ target: { nodeName: 'select' }, type: 'click' })).toBeFalsy();
-  });
-
-  test('isPluginEnabled', () => {
-    expect(isPluginEnabled({ isEnabled: () => true })).toBeTruthy();
-    expect(isPluginEnabled({ isEnabled: () => false })).toBeFalsy();
-    expect(isPluginEnabled({ isEnabled: true })).toBeTruthy();
-    expect(isPluginEnabled({ isEnabled: false })).toBeFalsy();
-  });
-
-  test('camelCase', () => {
-    expect(camelCase('foo')).toBe('foo');
-    expect(camelCase('foo-bar')).toBe('fooBar');
-    expect(camelCase('foo-bar-baz')).toBe('fooBarBaz');
-  });
-
-  test('getComposedPath', () => {
-    expect(getComposedPath({}).length).toBe(1);
-    expect(getComposedPath({ parentNode: {} }).length).toBe(2);
-    expect(getComposedPath({ host: {} }).length).toBe(2);
-    expect(getComposedPath({ defaultView: {} }).length).toBe(2);
-
-    const result = '[{"parentNode":{"host":{"defaultView":{}}}},{"host":{"defaultView":{}}},{"defaultView":{}},{}]';
-    const nested = getComposedPath({ parentNode: { host: { defaultView: {} } } });
-    expect(JSON.stringify(nested)).toEqual(result);
-  });
-});