@newrelic/video-core 5.0.2 → 5.1.0

package/src/{eventAggregator.js → eventAggregator.ts}

@@ -1,15 +1,29 @@
 import Log from "./log";
 import Constants from "./constants";
 import { dataSize } from "./utils";
+import { EventAttributes } from "./utils/eventBuilder";
 
 const { MAX_PAYLOAD_SIZE, MAX_EVENTS_PER_BATCH } = Constants;
 
+export type SmartHarvestCallback = (reason: "overflow" | "smart", percentage: number) => void;
+
 /**
  * Enhanced event buffer that manages video events with unified priority handling
  * and automatic size management. All events are treated with equal priority
  * unless explicitly specified otherwise.
  */
 export class NrVideoEventAggregator {
+  buffer: EventAttributes[];
+  maxPayloadSize: number;
+  maxEventsPerBatch: number;
+  currentPayloadSize: number;
+  totalEvents: number;
+  smartHarvestPayloadThreshold: number;
+  overflowPayloadThreshold: number;
+  smartHarvestEventThreshold: number;
+  overflowEventThreshold: number;
+  onSmartHarvestTrigger: SmartHarvestCallback | null;
+
   constructor() {
     // Simplified to single priority queue for equal treatment
 
@@ -39,7 +53,7 @@ export class NrVideoEventAggregator {
    * @param {object} eventObject - The event object to add or use as replacement. Should contain an actionName property.
    * @returns {boolean} True if the operation succeeded, false if an error occurred
    */
-  addOrReplaceByActionName(actionName, eventObject) {
+  addOrReplaceByActionName(actionName: string, eventObject: EventAttributes): boolean {
       const i = this.buffer.findIndex(e => e.actionName === actionName);
 
       try {
@@ -49,7 +63,7 @@ export class NrVideoEventAggregator {
               this.add(eventObject, i);
           }
           return true;
-      } catch (error) {
+      } catch (error: any) {
           Log.error("Failed to set or replace the event to buffer:", error.message);
           return false;
       }
@@ -63,7 +77,7 @@ export class NrVideoEventAggregator {
    * @param {object} eventObject - The event object to add or use as replacement.
    * @returns {boolean} True if the operation succeeded, false if an error occurred
    */
-  addOrReplaceByActionNameAndViewId(actionName, viewId, eventObject) {
+  addOrReplaceByActionNameAndViewId(actionName: string, viewId: string, eventObject: EventAttributes): boolean {
       const i = this.buffer.findIndex(
           e => e.actionName === actionName && e.viewId === viewId
       );
@@ -74,7 +88,7 @@ export class NrVideoEventAggregator {
               this.add(eventObject, i);
           }
           return true;
-      } catch (error) {
+      } catch (error: any) {
           Log.error("Failed to set or replace the event to buffer:", error.message);
           return false;
       }
@@ -86,7 +100,7 @@ export class NrVideoEventAggregator {
    * @param {string} viewId
    * @returns {object|null}
    */
-  findByActionNameAndViewId(actionName, viewId) {
+  findByActionNameAndViewId(actionName: string, viewId: string): EventAttributes | null {
       const event = this.buffer.find(
           e => e.actionName === actionName && e.viewId === viewId
       );
@@ -98,7 +112,7 @@ export class NrVideoEventAggregator {
    * @param {string} actionName
    * @returns {object|null}
    */
-  findByActionName(actionName) {
+  findByActionName(actionName: string): EventAttributes | null {
       const event = this.buffer.find(e => e.actionName === actionName);
       return event || null;
   }
@@ -109,10 +123,10 @@ export class NrVideoEventAggregator {
    * @param {object} eventObject - The event to add
    * @param {number} index - index at which the event should be replaced with
    */
-  add(eventObject, index) {
+  add(eventObject: EventAttributes, index?: number): boolean {
     try {
       // Calculate event payload size
-      const eventSize = dataSize(eventObject);
+      const eventSize = dataSize(eventObject) ?? 0;
 
       // Check if we need to make room based on EITHER payload size OR event count limits
       const wouldExceedPayload =
@@ -126,7 +140,7 @@ export class NrVideoEventAggregator {
 
       if(index !== undefined && index !== null && index > -1) {
           // replace in unified buffer
-          const previousPayloadSize = dataSize(this.buffer[index]);
+          const previousPayloadSize = dataSize(this.buffer[index]) ?? 0;
           this.buffer[index] = eventObject;
           // Updating the payload size for the replaced event
           this.currentPayloadSize += eventSize - previousPayloadSize;
@@ -141,7 +155,7 @@ export class NrVideoEventAggregator {
       this.checkSmartHarvestTrigger();
 
       return true;
-    } catch (error) {
+    } catch (error: any) {
       Log.error("Failed to add event to buffer:", error.message);
       return false;
     }
@@ -154,7 +168,7 @@ export class NrVideoEventAggregator {
    * - 90% of payload size (900KB) OR 90% of event count (900 events)
    * @private
    */
-  checkSmartHarvestTrigger() {
+  checkSmartHarvestTrigger(): void {
     const payloadPercentage = this.currentPayloadSize / this.maxPayloadSize;
     const eventPercentage = this.totalEvents / this.maxEventsPerBatch;
 
@@ -209,7 +223,7 @@ export class NrVideoEventAggregator {
    * Sets the callback function for smart harvest triggers.
    * @param {Function} callback - Function to call when smart harvest is triggered
    */
-  setSmartHarvestCallback(callback) {
+  setSmartHarvestCallback(callback: SmartHarvestCallback): void {
     this.onSmartHarvestTrigger = callback;
   }
 
@@ -218,7 +232,7 @@ export class NrVideoEventAggregator {
    * No limits needed since buffer already manages size via makeRoom() and smart harvest triggers.
    * @returns {Array} Array of events in order they were added
    */
-  drain() {
+  drain(): EventAttributes[] {
     try {
       // Drain ALL events - buffer size is already managed by makeRoom() and smart harvest
       const events = this.buffer.splice(0);
@@ -228,7 +242,7 @@ export class NrVideoEventAggregator {
       this.currentPayloadSize = 0;
 
       return events;
-    } catch (error) {
+    } catch (error: any) {
       Log.error("Failed to drain events from buffer:", error.message);
       return [];
     }
@@ -238,7 +252,7 @@ export class NrVideoEventAggregator {
    * Checks if the buffer is empty.
    * @returns {boolean} True if all buffers are empty
    */
-  isEmpty() {
+  isEmpty(): boolean {
     return this.totalEvents === 0;
   }
 
@@ -246,14 +260,14 @@ export class NrVideoEventAggregator {
    * Gets the total number of events across all buffers.
    * @returns {number} Total event count
    */
-  size() {
+  size(): number {
     return this.totalEvents;
   }
 
   /**
    * Clears the entire buffer.
    */
-  clear() {
+  clear(): void {
     this.buffer = [];
     this.totalEvents = 0;
   }
@@ -263,7 +277,7 @@ export class NrVideoEventAggregator {
    * Uses FIFO approach - removes the first (oldest) event.
    * @private
    */
-  makeRoom(newEventSize) {
+  makeRoom(newEventSize: number): void {
     // Before the while loop in makeRoom()
     if (newEventSize > this.maxPayloadSize) {
       Log.error("Event dropped: Event size exceeds maximum payload size.");
@@ -281,7 +295,7 @@ export class NrVideoEventAggregator {
         const removed = this.buffer.shift(); // Remove the oldest event (FIFO)
 
         // Recalculate size and count after removal
-        const removedSize = dataSize(removed);
+        const removedSize = dataSize(removed) ?? 0;
         this.totalEvents--;
         this.currentPayloadSize -= removedSize;
 

package/src/global.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Ambient global augmentation for the two configuration slots the library
+ * writes at runtime — see videoConfiguration.ts::initializeGlobalConfig,
+ * which is the single source of truth for these shapes.
+ */
+
+import type {
+  NrVideoBrowserInfo,
+  NrVideoBrowserConfig,
+  NrVideoCdInfo,
+  NrVideoCdConfig,
+} from "./videoConfiguration";
+
+declare global {
+  interface Window {
+    NRVIDEO?: { info: NrVideoBrowserInfo; config: NrVideoBrowserConfig };
+  }
+
+  // eslint-disable-next-line no-var
+  var __NRVIDEO_CD__:
+    | { info: NrVideoCdInfo; config: NrVideoCdConfig }
+    | undefined;
+}
+
+export {};

package/src/{log.js → log.ts}

@@ -5,12 +5,18 @@
  * @static
  */
 class Log {
+  static Levels: Record<string, number>;
+  static level: number | string;
+  static colorful: boolean;
+  static includeTime: boolean;
+  static prefix: string;
+
   /**
    * Sends an error console log.
    * @param {...any} [msg] Message to show
    * @static
    */
-  static error(...msg) {
+  static error(...msg: any[]) {
     _report(msg, Log.Levels.ERROR, "darkred");
   }
 
@@ -20,7 +26,7 @@ class Log {
    * @static
    * @param {...any} msg Message to show
    */
-  static warn(...msg) {
+  static warn(...msg: any[]) {
     _report(msg, Log.Levels.WARNING, "darkorange");
   }
 
@@ -30,7 +36,7 @@ class Log {
    * @static
    * @param {...any} msg Message to show
    */
-  static notice(...msg) {
+  static notice(...msg: any[]) {
     _report([].slice.call(arguments), Log.Levels.NOTICE, "darkcyan");
   }
 
@@ -40,7 +46,7 @@ class Log {
    * @static
    * @param {...any} msg Message to show
    */
-  static debug(...msg) {
+  static debug(...msg: any[]) {
     _report(msg, Log.Levels.DEBUG, "indigo");
   }
 
@@ -63,12 +69,12 @@ class Log {
    * @param {function} [report] Callback function called to report events.
    * Default calls Log.debug()
    */
-  static debugCommonVideoEvents(o, extraEvents, report) {
+  static debugCommonVideoEvents(o: any, extraEvents?: any[], report?: (e: any) => void) {
     try {
-      if (Log.level <= Log.Levels.DEBUG) {
+      if ((Log.level as any) <= Log.Levels.DEBUG) {
         report =
           report ||
-          function (e) {
+          function (e: any) {
             Log.debug("Event: " + e.type);
           };
 
@@ -186,7 +192,7 @@ Log.prefix = "[nrvideo]";
  * @param {string} [color='darkgreen'] Color of the header
  * @see {@link Log.level}
  */
-function _report(msg, level, color) {
+function _report(msg: any[], level?: number | string, color?: string) {
   level = level || Log.Levels.NOTICE;
   color = color || "darkcyan";
 
@@ -195,23 +201,23 @@ function _report(msg, level, color) {
   prefix += _level2letter(level) + ":";
 
   // Show messages in actual console if level is enought
-  if (Log.level <= level && level !== Log.Levels.SILENT) {
+  if ((Log.level as any) <= level && level !== Log.Levels.SILENT) {
     if (
       !Log.colorful ||
-      (typeof document !== "undefined" && document.documentMode)
+      (typeof document !== "undefined" && (document as any).documentMode)
     ) {
       // document.documentMode exits only in IE
       _plainReport(msg, prefix);
     } else {
       // choose log method
-      var logMethod;
+      var logMethod: (...args: any[]) => void;
       if (level === Log.Levels.ERROR && console.error) {
         logMethod = console.error;
       } else if (level === Log.Levels.WARNING && console.warn) {
         logMethod = console.warn;
       } else if (level === Log.Levels.DEBUG && console.debug) {
         // NOTE: for some reason console.debug doesn't work on CAF Receivers.
-        if (window.cast == undefined) {
+        if ((window as any).cast == undefined) {
           logMethod = console.debug;
         } else {
           logMethod = console.log;
@@ -233,7 +239,7 @@ function _report(msg, level, color) {
  * @private
  * @return {string} Current time.
  */
-function _getCurrentTime() {
+function _getCurrentTime(): string {
   var d = new Date();
   var hh = ("0" + d.getDate()).slice(-2);
   var mm = ("0" + d.getMinutes()).slice(-2);
@@ -249,7 +255,7 @@ function _getCurrentTime() {
  * @param {(string|object|array)} msg Message string, object or array of messages.
  * @param {string} prefix Prefix of the message.
  */
-function _plainReport(msg, prefix) {
+function _plainReport(msg: any, prefix: string) {
   if (msg instanceof Array) {
     for (var m in msg) {
       _plainReport(msg[m], prefix);
@@ -264,7 +270,7 @@ function _plainReport(msg, prefix) {
   }
 }
 
-const _letters = {
+const _letters: Record<number, string> = {
   4: "e", // Error
   3: "w", // Warning
   2: "n", // Notice
@@ -277,8 +283,8 @@ const _letters = {
  * @private
  * @param {sLog.Level} level Level of the message
  */
-function _level2letter(level) {
-  return _letters[level];
+function _level2letter(level: number | string): string {
+  return _letters[level as number];
 }
 
 /**

package/src/{obfuscate.js → obfuscate.ts}

@@ -1,5 +1,10 @@
 import Log from "./log";
 
+export interface ObfuscationRule {
+  regex: string | RegExp;
+  replacement: string;
+}
+
 /**
  * Applies obfuscation rules to a JSON string before sending to the collector.
  * Each rule replaces matches of `regex` with `replacement` in the string.
@@ -8,7 +13,7 @@ import Log from "./log";
  * @param {Array<{regex: string|RegExp, replacement: string}>} rules - Obfuscation rules
  * @returns {string} Obfuscated string
  */
-export function applyObfuscationRules(jsonString, rules) {
+export function applyObfuscationRules(jsonString: string, rules?: ObfuscationRule[]): string {
   if (!rules || rules.length === 0) return jsonString;
 
   return rules.reduce((str, rule) => {

package/src/{optimizedHttpClient.js → optimizedHttpClient.ts}

@@ -2,6 +2,30 @@ import { shouldRetry } from "./utils";
 import Log from "./log";
 import { applyObfuscationRules } from "./obfuscate";
 
+export interface HttpRequestOptions {
+  url: string;
+  payload: { body: any };
+  options?: { isFinalHarvest?: boolean };
+}
+
+export interface HttpResultCallback {
+  (result: { retry?: boolean; status: number; statusText?: string; error?: string }): void;
+}
+
+interface InternalRequest {
+  url: string;
+  payload: { body: any };
+  options: { isFinalHarvest?: boolean };
+  callback: HttpResultCallback;
+}
+
+interface RequestResult {
+  success: boolean;
+  status: number;
+  statusText?: string;
+  error?: string;
+}
+
 /**
  * Optimized HTTP client for video analytics data transmission with
  * performance monitoring and efficient request handling.
@@ -16,7 +40,7 @@ export class OptimizedHttpClient {
    * @param {Function} callback - Callback function for handling response
    * @returns {Promise<void>}
    */
-  async send(requestOptions, callback) {
+  async send(requestOptions: HttpRequestOptions, callback: HttpResultCallback): Promise<void> {
     const { url, payload, options = {} } = requestOptions;
 
     try {
@@ -26,7 +50,7 @@ export class OptimizedHttpClient {
       }
 
       // Create request object
-      const request = {
+      const request: InternalRequest = {
         url,
         payload,
         options,
@@ -35,7 +59,7 @@ export class OptimizedHttpClient {
 
       // Execute request immediately
       await this.executeRequest(request);
-    } catch (error) {
+    } catch (error: any) {
       Log.error("Failed to send request:", error.message);
       callback({ retry: false, status: 0, error: error.message });
     }
@@ -46,7 +70,7 @@ export class OptimizedHttpClient {
    * @param {object} request - Request object
    * @private
    */
-  async executeRequest(request) {
+  async executeRequest(request: InternalRequest): Promise<void> {
     const { url, payload, options, callback } = request;
     const startTime = Date.now();
 
@@ -59,7 +83,7 @@ export class OptimizedHttpClient {
       // Handle final harvest with sendBeacon
       if (options.isFinalHarvest && navigator.sendBeacon) {
         const success = await this.sendWithBeacon(url, requestBody);
-        const result = { success, status: success ? 204 : 0 };
+        const result: RequestResult = { success, status: success ? 204 : 0 };
         this.handleRequestComplete(request, result, startTime);
         return;
       }
@@ -78,15 +102,15 @@ export class OptimizedHttpClient {
         10000
       );
 
-      const result = {
+      const result: RequestResult = {
         success: response.ok,
         status: response.status,
         statusText: response.statusText,
       };
 
       this.handleRequestComplete(request, result, startTime);
-    } catch (error) {
-      const result = {
+    } catch (error: any) {
+      const result: RequestResult = {
         success: false,
         status: 0,
         error: error.message,
@@ -104,7 +128,7 @@ export class OptimizedHttpClient {
    * @param {string} endpoint - The endpoint that was used for the request
    * @private
    */
-  handleRequestComplete(request, result) {
+  handleRequestComplete(request: InternalRequest, result: RequestResult, startTime?: number): void {
     const { callback } = request;
 
     // Use smart retry logic based on HTTP status codes
@@ -127,10 +151,10 @@ export class OptimizedHttpClient {
    * @returns {Promise<boolean>} True if successful
    * @private
    */
-  async sendWithBeacon(url, body) {
+  async sendWithBeacon(url: string, body: string): Promise<boolean> {
     try {
       return navigator.sendBeacon(url, body);
-    } catch (error) {
+    } catch (error: any) {
       Log.warn("sendBeacon failed, falling back to fetch:", error.message);
       return false;
     }
@@ -145,7 +169,7 @@ export class OptimizedHttpClient {
    * @returns {Promise<Response>} Fetch response
    * @private
    */
-  async fetchWithTimeout(url, options, timeout) {
+  async fetchWithTimeout(url: string, options: RequestInit, timeout: number): Promise<Response> {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), timeout);
 
@@ -156,7 +180,7 @@ export class OptimizedHttpClient {
       });
       clearTimeout(timeoutId);
       return response;
-    } catch (error) {
+    } catch (error: any) {
       clearTimeout(timeoutId);
       if (error.name === "AbortError") {
         throw new Error(`Request timeout after ${timeout}ms`);

package/src/{recordEvent.js → recordEvent.ts}

@@ -1,6 +1,8 @@
-import Constants from "./constants.js";
-import Log from "./log.js";
-import { dispatchRecordEvent } from "./utils/eventBuilder";
+import Constants from "./constants";
+import Log from "./log";
+import { dispatchRecordEvent, EventAttributes, Harvester } from "./utils/eventBuilder";
+
+export type { EventAttributes, Harvester };
 
 /**
  * Registry-based recordEvent (split build).
@@ -8,7 +10,7 @@ import { dispatchRecordEvent } from "./utils/eventBuilder";
  * No static harvester imports. Each harvester self-registers under a key
  * (`'Browser'` or `'Vega'`) at module load time via `registerHarvester`.
  */
-const harvesters = Object.create(null);
+const harvesters: Record<string, Harvester> = Object.create(null);
 
 /**
  * Register a harvester implementation under a routing key.
@@ -18,7 +20,7 @@ const harvesters = Object.create(null);
  * @param {string} key  Routing key matching `attributes.src`.
  * @param {{ addEvent: function }} harvester
  */
-export function registerHarvester(key, harvester) {
+export function registerHarvester(key: string, harvester: Harvester): void {
   harvesters[key] = harvester;
 }
 
@@ -39,11 +41,11 @@ export function registerHarvester(key, harvester) {
  * @param {string} key
  * @returns {{ addEvent: function }|undefined}
  */
-export function getRegisteredHarvester(key) {
+export function getRegisteredHarvester(key: string): Harvester | undefined {
   return harvesters[key];
 }
 
-export function recordEvent(eventType, attributes = {}) {
+export function recordEvent(eventType: string, attributes: EventAttributes = {}): boolean | undefined {
   try {
     if (!Constants.VALID_EVENT_TYPES.includes(eventType)) {
       Log.warn("Invalid event type provided to recordEvent", { eventType });
@@ -67,10 +69,10 @@ export function recordEvent(eventType, attributes = {}) {
       : w?.NRVIDEO?.config?.qoeAggregate;
 
     return dispatchRecordEvent(
-      eventType, attributes, info, harvester, qoeEnabled,
+      eventType, attributes, info, harvester, !!qoeEnabled,
       { addTimeSinceLoad: !isVega }
     );
-  } catch (error) {
+  } catch (error: any) {
     Log.error("Failed to record event:", error.message);
     return false;
   }

package/src/{retryQueueHandler.js → retryQueueHandler.ts}

@@ -1,6 +1,7 @@
 import Log from "./log";
 import { dataSize } from "./utils";
 import Constants from "./constants";
+import { EventAttributes } from "./utils/eventBuilder";
 
 const { MAX_PAYLOAD_SIZE, MAX_EVENTS_PER_BATCH } = Constants;
 
@@ -9,6 +10,10 @@ const { MAX_PAYLOAD_SIZE, MAX_EVENTS_PER_BATCH } = Constants;
  * backoff strategies, and persistent storage capabilities.
  */
 export class RetryQueueHandler {
+  retryQueue: EventAttributes[];
+  maxQueueSize: number;
+  maxQueueSizeBytes: number;
+
   constructor() {
     this.retryQueue = [];
     this.maxQueueSize = MAX_EVENTS_PER_BATCH; // Max 1000 events
@@ -19,7 +24,7 @@ export class RetryQueueHandler {
    * Adds failed events to the retry queue for retry processing.
    * @param {Array|object} events - Failed event(s) to add to retry queue
    */
-  addFailedEvents(events) {
+  addFailedEvents(events: EventAttributes | EventAttributes[]): void {
     try {
       const eventsArray = Array.isArray(events) ? events : [events];
 
@@ -34,15 +39,15 @@ export class RetryQueueHandler {
         }
 
         // Check queue memory size and make room if necessary
-        const eventSize = dataSize(event);
-        while (dataSize(this.retryQueue) + eventSize > this.maxQueueSizeBytes) {
+        const eventSize = dataSize(event) ?? 0;
+        while ((dataSize(this.retryQueue) ?? 0) + eventSize > this.maxQueueSizeBytes) {
           this.evictOldestEvent();
         }
 
         // Store event directly - no wrapper needed
         this.retryQueue.push({ ...event });
       }
-    } catch (err) {
+    } catch (err: any) {
       Log.error("Failed to add events to retry queue:", err.message);
     }
   }
@@ -53,7 +58,7 @@ export class RetryQueueHandler {
    * @param {string} reason - Reason for discarding
    * @private
    */
-  discardEvent(event, reason) {
+  discardEvent(event: EventAttributes, reason: string): void {
     Log.warn(`Discarded event`, {
       reason,
       eventType: event.eventType,
@@ -64,10 +69,10 @@ export class RetryQueueHandler {
    * Evicts the oldest event from the queue to make room.
    * @private
    */
-  evictOldestEvent() {
+  evictOldestEvent(): void {
     if (this.retryQueue.length > 0) {
       const oldest = this.retryQueue.shift();
-      this.discardEvent(oldest, "Queue full - evicted oldest");
+      this.discardEvent(oldest as EventAttributes, "Queue full - evicted oldest");
     }
   }
 
@@ -78,8 +83,8 @@ export class RetryQueueHandler {
    * @param {number} availableEventCount - Available event count
    * @returns {Array} Array of events that fit within limits
    */
-  getRetryEventsToFit(availableSpace, availableEventCount) {
-    const retryEvents = [];
+  getRetryEventsToFit(availableSpace: number, availableEventCount: number): EventAttributes[] {
+    const retryEvents: EventAttributes[] = [];
     let usedSpace = 0;
     let eventCount = 0;
 
@@ -90,7 +95,7 @@ export class RetryQueueHandler {
 
       if (eventCount >= availableEventCount) break;
 
-      const eventSize = dataSize(event);
+      const eventSize = dataSize(event) ?? 0;
       if (usedSpace + eventSize > availableSpace) break;
 
       // Add to beginning of retryEvents to maintain chronological order (oldest first)
@@ -109,14 +114,14 @@ export class RetryQueueHandler {
    * Gets the current retry queue size.
    * @returns {number} Queue size
    */
-  getQueueSize() {
+  getQueueSize(): number {
     return this.retryQueue.length;
   }
 
   /**
    * Clears the retry queue.
    */
-  clear() {
+  clear(): void {
     this.retryQueue = [];
   }
 }