@availity/analytics-core 4.0.5 → 4.1.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [4.1.0](https://github.com/Availity/sdk-js/compare/@availity/analytics-core@4.0.5...@availity/analytics-core@4.1.0) (2024-03-07)
+
+
+### Features
+
+* **analytics-core:** add telemetry plugin ([5c5dfa1](https://github.com/Availity/sdk-js/commit/5c5dfa13e47813a6b5cfaa37caa70ebe744591bb))
+
+
+
 ## [4.0.5](https://github.com/Availity/sdk-js/compare/@availity/analytics-core@4.0.4...@availity/analytics-core@4.0.5) (2024-02-19)
 
 

package/dist/index.d.mts

@@ -71,6 +71,18 @@ declare class AvSplunkAnalytics extends AvAnalyticsPlugin {
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 
+declare class AvTelemetryAnalytics extends AvAnalyticsPlugin {
+  constructor(AvLogMessages: any, enabled?: boolean, source_system: string, contact: string, sessionId?: string);
+
+  trackEvent(properties: any): any;
+
+  trackPageView(url: string): any;
+}
+
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+
 declare class AvDmaAnalytics extends AvAnalyticsPlugin {
   constructor(AvLogMessages: any, enabled?: boolean);
 
@@ -79,4 +91,4 @@ declare class AvDmaAnalytics extends AvAnalyticsPlugin {
   trackPageView(url: string): any;
 }
 
-export { AvAnalytics, AvAnalyticsPlugin, AvDmaAnalytics, AvSplunkAnalytics };
+export { AvAnalytics, AvAnalyticsPlugin, AvDmaAnalytics, AvSplunkAnalytics, AvTelemetryAnalytics };

package/dist/index.d.ts

@@ -71,6 +71,18 @@ declare class AvSplunkAnalytics extends AvAnalyticsPlugin {
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 
+declare class AvTelemetryAnalytics extends AvAnalyticsPlugin {
+  constructor(AvLogMessages: any, enabled?: boolean, source_system: string, contact: string, sessionId?: string);
+
+  trackEvent(properties: any): any;
+
+  trackPageView(url: string): any;
+}
+
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+
 declare class AvDmaAnalytics extends AvAnalyticsPlugin {
   constructor(AvLogMessages: any, enabled?: boolean);
 
@@ -79,4 +91,4 @@ declare class AvDmaAnalytics extends AvAnalyticsPlugin {
   trackPageView(url: string): any;
 }
 
-export { AvAnalytics, AvAnalyticsPlugin, AvDmaAnalytics, AvSplunkAnalytics };
+export { AvAnalytics, AvAnalyticsPlugin, AvDmaAnalytics, AvSplunkAnalytics, AvTelemetryAnalytics };

package/dist/index.js

@@ -19,6 +19,18 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -51,7 +63,8 @@ __export(src_exports, {
   AvAnalytics: () => AvAnalytics,
   AvAnalyticsPlugin: () => AvAnalyticsPlugin,
   AvDmaAnalytics: () => AvDmaAnalytics,
-  AvSplunkAnalytics: () => AvSplunkAnalytics
+  AvSplunkAnalytics: () => AvSplunkAnalytics,
+  AvTelemetryAnalytics: () => AvTelemetryAnalytics
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -256,6 +269,49 @@ var AvSplunkAnalytics = class extends AvAnalyticsPlugin {
   }
 };
 
+// src/telemetry.js
+var import_uuid = require("uuid");
+var AvTelemetryAnalytics = class extends AvAnalyticsPlugin {
+  constructor(AvLogMessages, enabled, source_system, contact, sessionId) {
+    super(enabled);
+    this.AvLogMessages = AvLogMessages;
+    if (!source_system)
+      throw new Error("source_system is required");
+    if (!contact)
+      throw new Error("contact is required");
+    this.source_system = source_system;
+    this.contact = contact;
+    this.sessionId = sessionId || (0, import_uuid.v4)();
+  }
+  trackEvent(_a) {
+    var _b = _a, { customerId, level, payerId } = _b, properties = __objRest(_b, ["customerId", "level", "payerId"]);
+    const payload = {
+      customerId,
+      contact: this.contact,
+      source_system: this.source_system,
+      version: "v1",
+      sessionId: this.sessionId,
+      telemetryBody: {
+        level: level || "info",
+        entries: __spreadValues({}, properties)
+      }
+    };
+    if (payerId)
+      payload.payerId = payerId;
+    return this.AvLogMessages[payload.telemetryBody.level](payload);
+  }
+  trackPageView(url) {
+    return this.trackEvent({
+      event: "page",
+      action: "load",
+      category: this.source_system,
+      label: "page-load",
+      url,
+      customerId: "0000"
+    });
+  }
+};
+
 // src/dma.js
 var yup = __toESM(require("yup"));
 var schema = yup.object().shape({
@@ -297,5 +353,6 @@ var AvDmaAnalytics = class extends AvAnalyticsPlugin {
   AvAnalytics,
   AvAnalyticsPlugin,
   AvDmaAnalytics,
-  AvSplunkAnalytics
+  AvSplunkAnalytics,
+  AvTelemetryAnalytics
 });

package/dist/index.mjs

@@ -14,6 +14,18 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
@@ -220,6 +232,49 @@ var AvSplunkAnalytics = class extends AvAnalyticsPlugin {
   }
 };
 
+// src/telemetry.js
+import { v4 as uuidv4 } from "uuid";
+var AvTelemetryAnalytics = class extends AvAnalyticsPlugin {
+  constructor(AvLogMessages, enabled, source_system, contact, sessionId) {
+    super(enabled);
+    this.AvLogMessages = AvLogMessages;
+    if (!source_system)
+      throw new Error("source_system is required");
+    if (!contact)
+      throw new Error("contact is required");
+    this.source_system = source_system;
+    this.contact = contact;
+    this.sessionId = sessionId || uuidv4();
+  }
+  trackEvent(_a) {
+    var _b = _a, { customerId, level, payerId } = _b, properties = __objRest(_b, ["customerId", "level", "payerId"]);
+    const payload = {
+      customerId,
+      contact: this.contact,
+      source_system: this.source_system,
+      version: "v1",
+      sessionId: this.sessionId,
+      telemetryBody: {
+        level: level || "info",
+        entries: __spreadValues({}, properties)
+      }
+    };
+    if (payerId)
+      payload.payerId = payerId;
+    return this.AvLogMessages[payload.telemetryBody.level](payload);
+  }
+  trackPageView(url) {
+    return this.trackEvent({
+      event: "page",
+      action: "load",
+      category: this.source_system,
+      label: "page-load",
+      url,
+      customerId: "0000"
+    });
+  }
+};
+
 // src/dma.js
 import * as yup from "yup";
 var schema = yup.object().shape({
@@ -260,5 +315,6 @@ export {
   AvAnalytics,
   AvAnalyticsPlugin,
   AvDmaAnalytics,
-  AvSplunkAnalytics
+  AvSplunkAnalytics,
+  AvTelemetryAnalytics
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/analytics-core",
-  "version": "4.0.5",
+  "version": "4.1.0",
   "description": "Analytics base configuration for sdk-js",
   "keywords": [
     "availity",
@@ -28,10 +28,11 @@
     "publish": "yarn npm publish --tolerate-republish --access public"
   },
   "dependencies": {
+    "uuid": "^9.0.1",
     "yup": "^0.32.11"
   },
   "devDependencies": {
-    "@availity/api-axios": "8.0.4",
+    "@availity/api-axios": "8.0.5",
     "tsup": "^7.2.0",
     "typescript": "^5.1.6"
   },

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export { default as AvAnalytics } from './analytics';
 export { default as AvAnalyticsPlugin } from './plugin';
 export { default as AvSplunkAnalytics } from './splunk';
+export { default as AvTelemetryAnalytics } from './telemetry';
 export { default as AvDmaAnalytics } from './dma';

package/src/index.js

@@ -1,4 +1,5 @@
 export { default as AvAnalytics } from './analytics';
 export { default as AvAnalyticsPlugin } from './plugin';
 export { default as AvSplunkAnalytics } from './splunk';
+export { default as AvTelemetryAnalytics } from './telemetry';
 export { default as AvDmaAnalytics } from './dma';

package/src/telemetry.d.ts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import AvAnalyticsPlugin from './plugin';
+
+declare class AvTelemetryAnalytics extends AvAnalyticsPlugin {
+  constructor(AvLogMessages: any, enabled?: boolean, source_system: string, contact: string, sessionId?: string);
+
+  trackEvent(properties: any): any;
+
+  trackPageView(url: string): any;
+}
+
+export default AvTelemetryAnalytics;

package/src/telemetry.js

@@ -0,0 +1,46 @@
+import { v4 as uuidv4 } from 'uuid';
+import AvAnalyticsPlugin from './plugin';
+
+export default class AvTelemetryAnalytics extends AvAnalyticsPlugin {
+  constructor(AvLogMessages, enabled, source_system, contact, sessionId) {
+    super(enabled);
+    this.AvLogMessages = AvLogMessages;
+
+    if (!source_system) throw new Error('source_system is required');
+    if (!contact) throw new Error('contact is required');
+    this.source_system = source_system;
+    this.contact = contact;
+    this.sessionId = sessionId || uuidv4();
+  }
+
+  trackEvent({ customerId, level, payerId, ...properties }) {
+    const payload = {
+      customerId,
+      contact: this.contact,
+      source_system: this.source_system,
+      version: 'v1',
+      sessionId: this.sessionId,
+      telemetryBody: {
+        level: level || 'info',
+        entries: {
+          ...properties,
+        },
+      },
+    };
+
+    if (payerId) payload.payerId = payerId;
+
+    return this.AvLogMessages[payload.telemetryBody.level](payload);
+  }
+
+  trackPageView(url) {
+    return this.trackEvent({
+      event: 'page',
+      action: 'load',
+      category: this.source_system,
+      label: 'page-load',
+      url,
+      customerId: '0000',
+    });
+  }
+}

package/src/tests/telmetry.test.ts

@@ -0,0 +1,98 @@
+import { AvTelemetryAnalytics } from '..';
+
+describe('AvTelemetryAnalytics', () => {
+  let mockLog: { info: () => void; test: () => void };
+  let mockAvTelemetryAnalytics: AvTelemetryAnalytics;
+
+  beforeEach(() => {
+    mockLog = {
+      info: jest.fn(),
+      test: jest.fn(),
+    };
+
+    mockAvTelemetryAnalytics = new AvTelemetryAnalytics(mockLog, false, 'testApp', 'AVOSS@availity.com', '1234');
+  });
+
+  test('AvTelemetryAnalytics should be defined', () => {
+    expect(mockAvTelemetryAnalytics).toBeDefined();
+  });
+
+  test('trackEvent should call AvLogMessages[level]', () => {
+    let level = 'info';
+    mockAvTelemetryAnalytics.trackEvent({ level });
+    expect(mockLog.info).toHaveBeenCalledTimes(1);
+    expect(mockLog.test).toHaveBeenCalledTimes(0);
+    level = 'test';
+    mockAvTelemetryAnalytics.trackEvent({ level });
+    expect(mockLog.info).toHaveBeenCalledTimes(1);
+    expect(mockLog.test).toHaveBeenCalledTimes(1);
+  });
+
+  test("trackEvent should default level to 'info'", () => {
+    mockAvTelemetryAnalytics.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: string; url: string; level?: string; customerId: string } = {
+      message: 'hello world',
+      url: window.location.href || 'N/A',
+      customerId: '0000',
+    };
+    let expectedCall = {
+      contact: 'AVOSS@availity.com',
+      customerId: '0000',
+      sessionId: '1234',
+      source_system: 'testApp',
+      telemetryBody: {
+        entries: {
+          message: startingObject.message,
+          url: window.location.href || 'N/A',
+        },
+        level: 'info',
+      },
+      version: 'v1',
+    };
+    mockAvTelemetryAnalytics.trackEvent(startingObject);
+    expect(mockLog.info).toHaveBeenCalledWith(expectedCall);
+
+    startingObject = {
+      message: 'hello world',
+      url: 'testUrl',
+      level: 'test',
+      customerId: '0000',
+    };
+
+    expectedCall = {
+      contact: 'AVOSS@availity.com',
+      customerId: '0000',
+      sessionId: '1234',
+      source_system: 'testApp',
+      telemetryBody: {
+        entries: {
+          message: 'hello world',
+          url: 'testUrl',
+        },
+        level: 'test',
+      },
+      version: 'v1',
+    };
+    mockAvTelemetryAnalytics.trackEvent(startingObject);
+    expect(mockLog.test).toHaveBeenCalledWith(expectedCall);
+  });
+
+  test("trackPageView should call trackEvent with event 'page' and passed in url", () => {
+    const testUrl = 'testUrl';
+    mockAvTelemetryAnalytics.trackEvent = jest.fn();
+    mockAvTelemetryAnalytics.trackPageView(testUrl);
+    expect(mockAvTelemetryAnalytics.trackEvent).toHaveBeenCalledWith({
+      action: 'load',
+      category: 'testApp',
+      customerId: '0000',
+      event: 'page',
+      label: 'page-load',
+      url: testUrl,
+    });
+  });
+});