@newrelic/browser-agent 1.302.0-rc.3 → 1.302.0-rc.4

package/dist/cjs/common/constants/env.cdn.js

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.302.0-rc.3";
+const VERSION = exports.VERSION = "1.302.0-rc.4";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/common/constants/env.npm.js

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.302.0-rc.3";
+const VERSION = exports.VERSION = "1.302.0-rc.4";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/features/generic_events/aggregate/index.js

@@ -35,13 +35,13 @@ class Aggregate extends _aggregateBase.AggregateBase {
         return;
       }
       this.#trackSupportabilityMetrics();
-      (0, _registerHandler.registerHandler)('api-recordCustomEvent', (timestamp, eventType, attributes) => {
+      (0, _registerHandler.registerHandler)('api-recordCustomEvent', (timestamp, eventType, attributes, target) => {
         if (_constants.RESERVED_EVENT_TYPES.includes(eventType)) return (0, _console.warn)(46);
         this.addEvent({
           eventType,
           timestamp: this.toEpoch(timestamp),
           ...attributes
-        });
+        }, target);
       }, this.featureName, this.ee);
       if (agentRef.init.page_action.enabled) {
         (0, _registerHandler.registerHandler)('api-addPageAction', (timestamp, name, attributes, target) => {

package/dist/cjs/interfaces/registered-entity.js

@@ -54,6 +54,16 @@ class RegisteredEntity {
     (0, _console.warn)(35, 'addPageAction');
   }
 
+  /**
+     * Records a custom event with a specified eventType and attributes.
+     * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+     * @param {string} eventType The eventType to store the event as.
+     * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+     */
+  recordCustomEvent(eventType, attributes) {
+    (0, _console.warn)(35, 'recordCustomEvent');
+  }
+
   /**
    * Adds a user-defined attribute name and value to subsequent events on the page for the registered target. Note -- the persist flag does not work with the register API.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}

package/dist/cjs/loaders/api/recordCustomEvent.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.recordCustomEvent = recordCustomEvent;
 exports.setupRecordCustomEventAPI = setupRecordCustomEventAPI;
 var _handle = require("../../common/event-emitter/handle");
 var _now = require("../../common/timing/now");
@@ -15,7 +16,8 @@ var _sharedHandlers = require("./sharedHandlers");
  */
 
 function setupRecordCustomEventAPI(agent) {
-  (0, _sharedHandlers.setupAPI)(_constants.RECORD_CUSTOM_EVENT, function () {
-    (0, _handle.handle)(_constants.prefix + _constants.RECORD_CUSTOM_EVENT, [(0, _now.now)(), ...arguments], undefined, _features.FEATURE_NAMES.genericEvents, agent.ee);
-  }, agent);
+  (0, _sharedHandlers.setupAPI)(_constants.RECORD_CUSTOM_EVENT, (eventType, attributes) => recordCustomEvent(eventType, attributes, agent), agent);
+}
+function recordCustomEvent(eventType, attributes = {}, agentRef, target, timestamp = (0, _now.now)()) {
+  (0, _handle.handle)(_constants.prefix + _constants.RECORD_CUSTOM_EVENT, [timestamp, eventType, attributes, target], undefined, _features.FEATURE_NAMES.genericEvents, agentRef.ee);
 }

package/dist/cjs/loaders/api/register-api-types.js

@@ -10,19 +10,19 @@ exports.default = void 0;
  */
 /**
  * @typedef {Object} RegisterAPI
- * @property {Function} addPageAction - Add a page action for the registered entity.
- * @property {Function} log - Capture a log for the registered entity.
- * @property {Function} noticeError - Notice an error for the registered entity.
- * @property {Function} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
- * @property {Function} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
- * @property {Function} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
+ * @property {(name: string, attributes?: object) => void} addPageAction - Add a page action for the registered entity.
+ * @property {(message: string, options?: { customAttributes?: object, level?: 'ERROR' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN'}) => void} log - Capture a log for the registered entity.
+ * @property {(error: Error | string, customAttributes?: object) => void} noticeError - Notice an error for the registered entity.
+ * @property {(eventType: string, attributes?: Object) => void} recordCustomEvent - Record a custom event for the registered entity.
+ * @property {(value: string | null) => void} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
+ * @property {(name: string, value: string | number | boolean | null, persist?: boolean) => void} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
+ * @property {(value: string | null) => void} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
  * @property {RegisterAPIMetadata} metadata - The metadata object containing the custom attributes and target information for the registered entity.
  */
 /**
  * @typedef {Object} RegisterAPIConstructor
- * @property {Object} opts - The options for the registered entity.
- * @property {string} opts.id - The unique id for the registered entity. This will be assigned to any synthesized entities.
- * @property {string} opts.name - The readable name for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string|number} id - The unique id for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string} name - The readable name for the registered entity. This will be assigned to any synthesized entities.
  */
 /**
  * @typedef {Object} RegisterAPIMetadata

package/dist/cjs/loaders/api/register.js

@@ -17,6 +17,7 @@ var _log = require("./log");
 var _addPageAction = require("./addPageAction");
 var _noticeError = require("./noticeError");
 var _invoke = require("../../common/util/invoke");
+var _recordCustomEvent = require("./recordCustomEvent");
 /**
  * Copyright 2020-2025 New Relic, Inc. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
@@ -104,6 +105,10 @@ function buildRegisterApi(agentRef, target) {
       ...attrs,
       ...attributes
     }, agentRef], target),
+    recordCustomEvent: (eventType, attributes = {}) => report(_recordCustomEvent.recordCustomEvent, [eventType, {
+      ...attrs,
+      ...attributes
+    }, agentRef], target),
     setApplicationVersion: value => setLocalValue('application.version', value),
     setCustomAttribute: (key, value) => setLocalValue(key, value),
     setUserId: value => setLocalValue('enduser.id', value),

package/dist/cjs/loaders/api-base.js

@@ -37,11 +37,8 @@ class ApiBase {
    * It is not recommended for use in production environments and will not receive support for issues.
    *
    * Registers an external caller to report through the base agent to a different target than the base agent.
-   * @param {object} target the target object to report data to
-   * @param {string} target.licenseKey The licenseKey to report data to
-   * @param {string} target.applicationID The applicationID to report data to
-   * @param {string=} target.entityGuid The entityGuid to report data to
-   * @returns {object} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
+   * @param {import('./api/register-api-types').RegisterAPIConstructor} target the target object to report data to
+  @returns {import('./api/register-api-types').RegisterAPI} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
    */
   register(target) {
     return this.#callMethod(_constants.REGISTER, target);
@@ -51,7 +48,7 @@ class ApiBase {
    * Records a custom event with a specified eventType and attributes.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
    * @param {string} eventType The eventType to store the event as.
-   * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+   * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
    */
   recordCustomEvent(eventType, attributes) {
     return this.#callMethod(_constants.RECORD_CUSTOM_EVENT, eventType, attributes);

package/dist/esm/common/constants/env.cdn.js

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.302.0-rc.3";
+export const VERSION = "1.302.0-rc.4";
 
 /**
  * Exposes the build type of the agent

package/dist/esm/common/constants/env.npm.js

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.302.0-rc.3";
+export const VERSION = "1.302.0-rc.4";
 
 /**
  * Exposes the build type of the agent

package/dist/esm/features/generic_events/aggregate/index.js

@@ -28,13 +28,13 @@ export class Aggregate extends AggregateBase {
         return;
       }
       this.#trackSupportabilityMetrics();
-      registerHandler('api-recordCustomEvent', (timestamp, eventType, attributes) => {
+      registerHandler('api-recordCustomEvent', (timestamp, eventType, attributes, target) => {
         if (RESERVED_EVENT_TYPES.includes(eventType)) return warn(46);
         this.addEvent({
           eventType,
           timestamp: this.toEpoch(timestamp),
           ...attributes
-        });
+        }, target);
       }, this.featureName, this.ee);
       if (agentRef.init.page_action.enabled) {
         registerHandler('api-addPageAction', (timestamp, name, attributes, target) => {

package/dist/esm/interfaces/registered-entity.js

@@ -48,6 +48,16 @@ export class RegisteredEntity {
     warn(35, 'addPageAction');
   }
 
+  /**
+     * Records a custom event with a specified eventType and attributes.
+     * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+     * @param {string} eventType The eventType to store the event as.
+     * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+     */
+  recordCustomEvent(eventType, attributes) {
+    warn(35, 'recordCustomEvent');
+  }
+
   /**
    * Adds a user-defined attribute name and value to subsequent events on the page for the registered target. Note -- the persist flag does not work with the register API.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}

package/dist/esm/loaders/api/recordCustomEvent.js

@@ -8,7 +8,8 @@ import { FEATURE_NAMES } from '../features/features';
 import { prefix, RECORD_CUSTOM_EVENT } from './constants';
 import { setupAPI } from './sharedHandlers';
 export function setupRecordCustomEventAPI(agent) {
-  setupAPI(RECORD_CUSTOM_EVENT, function () {
-    handle(prefix + RECORD_CUSTOM_EVENT, [now(), ...arguments], undefined, FEATURE_NAMES.genericEvents, agent.ee);
-  }, agent);
+  setupAPI(RECORD_CUSTOM_EVENT, (eventType, attributes) => recordCustomEvent(eventType, attributes, agent), agent);
+}
+export function recordCustomEvent(eventType, attributes = {}, agentRef, target, timestamp = now()) {
+  handle(prefix + RECORD_CUSTOM_EVENT, [timestamp, eventType, attributes, target], undefined, FEATURE_NAMES.genericEvents, agentRef.ee);
 }

package/dist/esm/loaders/api/register-api-types.js

@@ -5,20 +5,20 @@
 
 /**
  * @typedef {Object} RegisterAPI
- * @property {Function} addPageAction - Add a page action for the registered entity.
- * @property {Function} log - Capture a log for the registered entity.
- * @property {Function} noticeError - Notice an error for the registered entity.
- * @property {Function} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
- * @property {Function} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
- * @property {Function} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
+ * @property {(name: string, attributes?: object) => void} addPageAction - Add a page action for the registered entity.
+ * @property {(message: string, options?: { customAttributes?: object, level?: 'ERROR' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN'}) => void} log - Capture a log for the registered entity.
+ * @property {(error: Error | string, customAttributes?: object) => void} noticeError - Notice an error for the registered entity.
+ * @property {(eventType: string, attributes?: Object) => void} recordCustomEvent - Record a custom event for the registered entity.
+ * @property {(value: string | null) => void} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
+ * @property {(name: string, value: string | number | boolean | null, persist?: boolean) => void} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
+ * @property {(value: string | null) => void} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
  * @property {RegisterAPIMetadata} metadata - The metadata object containing the custom attributes and target information for the registered entity.
  */
 
 /**
  * @typedef {Object} RegisterAPIConstructor
- * @property {Object} opts - The options for the registered entity.
- * @property {string} opts.id - The unique id for the registered entity. This will be assigned to any synthesized entities.
- * @property {string} opts.name - The readable name for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string|number} id - The unique id for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string} name - The readable name for the registered entity. This will be assigned to any synthesized entities.
  */
 
 /**

package/dist/esm/loaders/api/register.js

@@ -14,6 +14,7 @@ import { log } from './log';
 import { addPageAction } from './addPageAction';
 import { noticeError } from './noticeError';
 import { single } from '../../common/util/invoke';
+import { recordCustomEvent } from './recordCustomEvent';
 
 /**
  * @typedef {import('./register-api-types').RegisterAPI} RegisterAPI
@@ -97,6 +98,10 @@ export function buildRegisterApi(agentRef, target) {
       ...attrs,
       ...attributes
     }, agentRef], target),
+    recordCustomEvent: (eventType, attributes = {}) => report(recordCustomEvent, [eventType, {
+      ...attrs,
+      ...attributes
+    }, agentRef], target),
     setApplicationVersion: value => setLocalValue('application.version', value),
     setCustomAttribute: (key, value) => setLocalValue(key, value),
     setUserId: value => setLocalValue('enduser.id', value),

package/dist/esm/loaders/api-base.js

@@ -31,11 +31,8 @@ export class ApiBase {
    * It is not recommended for use in production environments and will not receive support for issues.
    *
    * Registers an external caller to report through the base agent to a different target than the base agent.
-   * @param {object} target the target object to report data to
-   * @param {string} target.licenseKey The licenseKey to report data to
-   * @param {string} target.applicationID The applicationID to report data to
-   * @param {string=} target.entityGuid The entityGuid to report data to
-   * @returns {object} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
+   * @param {import('./api/register-api-types').RegisterAPIConstructor} target the target object to report data to
+  @returns {import('./api/register-api-types').RegisterAPI} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
    */
   register(target) {
     return this.#callMethod(REGISTER, target);
@@ -45,7 +42,7 @@ export class ApiBase {
    * Records a custom event with a specified eventType and attributes.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
    * @param {string} eventType The eventType to store the event as.
-   * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+   * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
    */
   recordCustomEvent(eventType, attributes) {
     return this.#callMethod(RECORD_CUSTOM_EVENT, eventType, attributes);

package/dist/types/interfaces/registered-entity.d.ts

@@ -25,6 +25,13 @@ export class RegisteredEntity {
      * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}. The key is reported as its own PageAction attribute with the specified values.
      */
     addPageAction(name: string, attributes?: object): void;
+    /**
+       * Records a custom event with a specified eventType and attributes.
+       * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+       * @param {string} eventType The eventType to store the event as.
+       * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+       */
+    recordCustomEvent(eventType: string, attributes?: Object): void;
     /**
      * Adds a user-defined attribute name and value to subsequent events on the page for the registered target. Note -- the persist flag does not work with the register API.
      * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}

package/dist/types/interfaces/registered-entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registered-entity.d.ts","sourceRoot":"","sources":["../../../src/interfaces/registered-entity.js"],"names":[],"mappings":"AAMA;;;;GAIG;AAEH;;;;;;GAMG;AACH;IAOE;;;OAGG;IACH,kBAFW,sBAAsB,EAShC;IAjBD,kCAAkC;IAClC,UADW,mBAAmB,CAI7B;IAeD;;;;;OAKG;IACH,oBAHW,MAAM,eACN,MAAM,QAKhB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,YAC1B,OAAO,QAKjB;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,qBACZ,MAAM,QAKhB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,QAKrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,QAOrB;IAED;;;;;MAKE;IACF,aAHW,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,QAKpF;CACF;0BAnGY,OAAO,mCAAmC,EAAE,WAAW;kCACvD,OAAO,mCAAmC,EAAE,mBAAmB;qCAC/D,OAAO,mCAAmC,EAAE,sBAAsB"}
+{"version":3,"file":"registered-entity.d.ts","sourceRoot":"","sources":["../../../src/interfaces/registered-entity.js"],"names":[],"mappings":"AAMA;;;;GAIG;AAEH;;;;;;GAMG;AACH;IAOE;;;OAGG;IACH,kBAFW,sBAAsB,EAShC;IAjBD,kCAAkC;IAClC,UADW,mBAAmB,CAI7B;IAeD;;;;;OAKG;IACH,oBAHW,MAAM,eACN,MAAM,QAKhB;IAED;;;;;SAKK;IACL,6BAHa,MAAM,eACN,MAAM,QAIlB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,YAC1B,OAAO,QAKjB;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,qBACZ,MAAM,QAKhB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,QAKrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,QAOrB;IAED;;;;;MAKE;IACF,aAHW,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,QAKpF;CACF;0BA7GY,OAAO,mCAAmC,EAAE,WAAW;kCACvD,OAAO,mCAAmC,EAAE,mBAAmB;qCAC/D,OAAO,mCAAmC,EAAE,sBAAsB"}

package/dist/types/loaders/api/recordCustomEvent.d.ts

@@ -1,2 +1,3 @@
 export function setupRecordCustomEventAPI(agent: any): void;
+export function recordCustomEvent(eventType: any, attributes: {} | undefined, agentRef: any, target: any, timestamp?: number): void;
 //# sourceMappingURL=recordCustomEvent.d.ts.map

package/dist/types/loaders/api/recordCustomEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recordCustomEvent.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/recordCustomEvent.js"],"names":[],"mappings":"AAUA,4DAIC"}
+{"version":3,"file":"recordCustomEvent.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/recordCustomEvent.js"],"names":[],"mappings":"AAUA,4DAEC;AAED,oIAEC"}

package/dist/types/loaders/api/register-api-types.d.ts

@@ -4,27 +4,34 @@ export type RegisterAPI = {
     /**
      * - Add a page action for the registered entity.
      */
-    addPageAction: Function;
+    addPageAction: (name: string, attributes?: object) => void;
     /**
      * - Capture a log for the registered entity.
      */
-    log: Function;
+    log: (message: string, options?: {
+        customAttributes?: object;
+        level?: "ERROR" | "TRACE" | "DEBUG" | "INFO" | "WARN";
+    }) => void;
     /**
      * - Notice an error for the registered entity.
      */
-    noticeError: Function;
+    noticeError: (error: Error | string, customAttributes?: object) => void;
+    /**
+     * - Record a custom event for the registered entity.
+     */
+    recordCustomEvent: (eventType: string, attributes?: Object) => void;
     /**
      * - Add an application.version attribute to all outgoing data for the registered entity.
      */
-    setApplicationVersion: Function;
+    setApplicationVersion: (value: string | null) => void;
     /**
      * - Add a custom attribute to outgoing data for the registered entity.
      */
-    setCustomAttribute: Function;
+    setCustomAttribute: (name: string, value: string | number | boolean | null, persist?: boolean) => void;
     /**
      * - Add an enduser.id attribute to all outgoing API data for the registered entity.
      */
-    setUserId: Function;
+    setUserId: (value: string | null) => void;
     /**
      * - The metadata object containing the custom attributes and target information for the registered entity.
      */
@@ -32,12 +39,13 @@ export type RegisterAPI = {
 };
 export type RegisterAPIConstructor = {
     /**
-     * - The options for the registered entity.
+     * - The unique id for the registered entity. This will be assigned to any synthesized entities.
      */
-    opts: {
-        id: string;
-        name: string;
-    };
+    id: string | number;
+    /**
+     * - The readable name for the registered entity. This will be assigned to any synthesized entities.
+     */
+    name: string;
 };
 export type RegisterAPIMetadata = {
     /**

package/dist/types/loaders/api/register-api-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register-api-types.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register-api-types.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAac,mBAAmB;;;;;;UAM9B;QAAwB,EAAE,EAAf,MAAM;QACO,IAAI,EAAjB,MAAM;KACnB;;;;;;sBAIa,MAAM;;;;YAEjB;QAA0B,UAAU,EAAzB,MAAM;QACS,EAAE,EAAjB,MAAM;QACS,IAAI,EAAnB,MAAM;KACnB"}
+{"version":3,"file":"register-api-types.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register-api-types.js"],"names":[],"mappings":";;;;;;mBAOc,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;SAC3C,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,KAAK,IAAI;;;;iBACxH,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,IAAI;;;;uBAC1D,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;2BAChD,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI;;;;wBAC9B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI;;;;eAClF,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI;;;;cAC9B,mBAAmB;;;;;;QAKnB,MAAM,GAAC,MAAM;;;;UACb,MAAM;;;;;;sBAKN,MAAM;;;;YAEjB;QAA0B,UAAU,EAAzB,MAAM;QACS,EAAE,EAAjB,MAAM;QACS,IAAI,EAAnB,MAAM;KACnB"}

package/dist/types/loaders/api/register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register.js"],"names":[],"mappings":"AAiBA;;GAEG;AAEH;;;;GAIG;AACH,mDAIC;AAED;;;;;;;;;;GAUG;AACH,2CARW,MAAM,UAGd;IAAwB,UAAU;IACX,EAAE,EAAjB,MAAM;IACS,IAAI,EAAnB,MAAM;CACd,GAAU,WAAW,CAmGvB;0BA1HY,OAAO,sBAAsB,EAAE,WAAW"}
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register.js"],"names":[],"mappings":"AAkBA;;GAEG;AAEH;;;;GAIG;AACH,mDAIC;AAED;;;;;;;;;;GAUG;AACH,2CARW,MAAM,UAGd;IAAwB,UAAU;IACX,EAAE,EAAjB,MAAM;IACS,IAAI,EAAnB,MAAM;CACd,GAAU,WAAW,CAoGvB;0BA3HY,OAAO,sBAAsB,EAAE,WAAW"}

package/dist/types/loaders/api-base.d.ts

@@ -15,24 +15,17 @@ export class ApiBase {
      * It is not recommended for use in production environments and will not receive support for issues.
      *
      * Registers an external caller to report through the base agent to a different target than the base agent.
-     * @param {object} target the target object to report data to
-     * @param {string} target.licenseKey The licenseKey to report data to
-     * @param {string} target.applicationID The applicationID to report data to
-     * @param {string=} target.entityGuid The entityGuid to report data to
-     * @returns {object} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
-     */
-    register(target: {
-        licenseKey: string;
-        applicationID: string;
-        entityGuid?: string | undefined;
-    }): object;
+     * @param {import('./api/register-api-types').RegisterAPIConstructor} target the target object to report data to
+    @returns {import('./api/register-api-types').RegisterAPI} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
+     */
+    register(target: import("./api/register-api-types").RegisterAPIConstructor): import("./api/register-api-types").RegisterAPI;
     /**
      * Records a custom event with a specified eventType and attributes.
      * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
      * @param {string} eventType The eventType to store the event as.
-     * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+     * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
      */
-    recordCustomEvent(eventType: string, attributes?: object): any;
+    recordCustomEvent(eventType: string, attributes?: Object): any;
     /**
      * Groups page views to help URL structure or to capture the URL's routing information.
      * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setpageviewname/}

package/dist/types/loaders/api-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-base.d.ts","sourceRoot":"","sources":["../../../src/loaders/api-base.js"],"names":[],"mappings":"AAOA;;GAEG;AACH;IAQE;;;;;OAKG;IACH,oBAHW,MAAM,eACN,MAAM,OAIhB;IAED;;;;;;;;;;;OAWG;IACH,iBALG;QAAuB,UAAU,EAAzB,MAAM;QACS,aAAa,EAA5B,MAAM;QACU,UAAU,GAA1B,MAAM,YAAC;KACf,GAAU,MAAM,CAIlB;IAED;;;;;OAKG;IACH,6BAHW,MAAM,eACN,MAAM,OAIhB;IAED;;;;;OAKG;IACH,sBAHW,MAAM,SACN,MAAM,OAIhB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,YAC1B,OAAO,OAIjB;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,qBACZ,MAAM,OAIhB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,OAIrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,OAMrB;IAED;;;;OAIG;IACH,0BAFW,CAAC,KAAK,EAAE,KAAK,GAAC,MAAM,KAAK,OAAO,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,OAI9D;IAED;;;;;OAKG;IACH,iBAHW,MAAM,MACN,MAAM,OAIhB;IAED;;;;;MAKE;IACF,aAHW,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,OAIpF;IAED;;;OAGG;IACH,aAEC;IAED;;;;OAIG;IACH,qBAFW,MAAM,OAIhB;IAED;;;;OAIG;IACH,oBAEC;IAED;;;;;OAKG;IACH,mBAEC;IAED;;;;;;;;;;OAUG;IACH,6BARW;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,OAUrF;IAED;;;;;OAKG;IACH,0BAHW,MAAM,OAKhB;IAED;;;;;;;;MAQE;IACF,mBALG;QAAuB,UAAU;KACjC,GAAU,mBAAmB,CAM/B;IAED;;;;;;MAME;IACF,mBAJW,MAAM,gBACN,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,OAIpF;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,MAAM,OAAC,GACL;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAC,CAIpF;;CACF;kCA9NY,OAAO,yBAAyB,EAAE,mBAAmB"}
+{"version":3,"file":"api-base.d.ts","sourceRoot":"","sources":["../../../src/loaders/api-base.js"],"names":[],"mappings":"AAOA;;GAEG;AACH;IAQE;;;;;OAKG;IACH,oBAHW,MAAM,eACN,MAAM,OAIhB;IAED;;;;;;;;OAQG;IACH,iBAHW,OAAO,0BAA0B,EAAE,sBAAsB,GAC1D,OAAO,0BAA0B,EAAE,WAAW,CAIvD;IAED;;;;;OAKG;IACH,6BAHW,MAAM,eACN,MAAM,OAIhB;IAED;;;;;OAKG;IACH,sBAHW,MAAM,SACN,MAAM,OAIhB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,YAC1B,OAAO,OAIjB;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,qBACZ,MAAM,OAIhB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,OAIrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,OAMrB;IAED;;;;OAIG;IACH,0BAFW,CAAC,KAAK,EAAE,KAAK,GAAC,MAAM,KAAK,OAAO,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,OAI9D;IAED;;;;;OAKG;IACH,iBAHW,MAAM,MACN,MAAM,OAIhB;IAED;;;;;MAKE;IACF,aAHW,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,OAIpF;IAED;;;OAGG;IACH,aAEC;IAED;;;;OAIG;IACH,qBAFW,MAAM,OAIhB;IAED;;;;OAIG;IACH,oBAEC;IAED;;;;;OAKG;IACH,mBAEC;IAED;;;;;;;;;;OAUG;IACH,6BARW;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,OAUrF;IAED;;;;;OAKG;IACH,0BAHW,MAAM,OAKhB;IAED;;;;;;;;MAQE;IACF,mBALG;QAAuB,UAAU;KACjC,GAAU,mBAAmB,CAM/B;IAED;;;;;;MAME;IACF,mBAJW,MAAM,gBACN,MAAM,YACN;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM,CAAA;KAAC,OAIpF;IAED;;;;;;OAMG;IACH,cAJW,MAAM,WACN,MAAM,OAAC,GACL;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAC,CAIpF;;CACF;kCA3NY,OAAO,yBAAyB,EAAE,mBAAmB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/browser-agent",
-  "version": "1.302.0-rc.3",
+  "version": "1.302.0-rc.4",
   "private": false,
   "author": "New Relic Browser Agent Team <browser-agent@newrelic.com>",
   "description": "New Relic Browser Agent",

package/src/features/generic_events/aggregate/index.js

@@ -33,13 +33,13 @@ export class Aggregate extends AggregateBase {
 
       this.#trackSupportabilityMetrics()
 
-      registerHandler('api-recordCustomEvent', (timestamp, eventType, attributes) => {
+      registerHandler('api-recordCustomEvent', (timestamp, eventType, attributes, target) => {
         if (RESERVED_EVENT_TYPES.includes(eventType)) return warn(46)
         this.addEvent({
           eventType,
           timestamp: this.toEpoch(timestamp),
           ...attributes
-        })
+        }, target)
       }, this.featureName, this.ee)
 
       if (agentRef.init.page_action.enabled) {

package/src/interfaces/registered-entity.js

@@ -48,6 +48,16 @@ export class RegisteredEntity {
     warn(35, 'addPageAction')
   }
 
+  /**
+     * Records a custom event with a specified eventType and attributes.
+     * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+     * @param {string} eventType The eventType to store the event as.
+     * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+     */
+  recordCustomEvent (eventType, attributes) {
+    warn(35, 'recordCustomEvent')
+  }
+
   /**
    * Adds a user-defined attribute name and value to subsequent events on the page for the registered target. Note -- the persist flag does not work with the register API.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}

package/src/loaders/api/recordCustomEvent.js

@@ -9,7 +9,9 @@ import { prefix, RECORD_CUSTOM_EVENT } from './constants'
 import { setupAPI } from './sharedHandlers'
 
 export function setupRecordCustomEventAPI (agent) {
-  setupAPI(RECORD_CUSTOM_EVENT, function () {
-    handle(prefix + RECORD_CUSTOM_EVENT, [now(), ...arguments], undefined, FEATURE_NAMES.genericEvents, agent.ee)
-  }, agent)
+  setupAPI(RECORD_CUSTOM_EVENT, (eventType, attributes) => recordCustomEvent(eventType, attributes, agent), agent)
+}
+
+export function recordCustomEvent (eventType, attributes = {}, agentRef, target, timestamp = now()) {
+  handle(prefix + RECORD_CUSTOM_EVENT, [timestamp, eventType, attributes, target], undefined, FEATURE_NAMES.genericEvents, agentRef.ee)
 }

package/src/loaders/api/register-api-types.js

@@ -5,20 +5,20 @@
 
 /**
  * @typedef {Object} RegisterAPI
- * @property {Function} addPageAction - Add a page action for the registered entity.
- * @property {Function} log - Capture a log for the registered entity.
- * @property {Function} noticeError - Notice an error for the registered entity.
- * @property {Function} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
- * @property {Function} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
- * @property {Function} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
+ * @property {(name: string, attributes?: object) => void} addPageAction - Add a page action for the registered entity.
+ * @property {(message: string, options?: { customAttributes?: object, level?: 'ERROR' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN'}) => void} log - Capture a log for the registered entity.
+ * @property {(error: Error | string, customAttributes?: object) => void} noticeError - Notice an error for the registered entity.
+ * @property {(eventType: string, attributes?: Object) => void} recordCustomEvent - Record a custom event for the registered entity.
+ * @property {(value: string | null) => void} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
+ * @property {(name: string, value: string | number | boolean | null, persist?: boolean) => void} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
+ * @property {(value: string | null) => void} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.
  * @property {RegisterAPIMetadata} metadata - The metadata object containing the custom attributes and target information for the registered entity.
  */
 
 /**
  * @typedef {Object} RegisterAPIConstructor
- * @property {Object} opts - The options for the registered entity.
- * @property {string} opts.id - The unique id for the registered entity. This will be assigned to any synthesized entities.
- * @property {string} opts.name - The readable name for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string|number} id - The unique id for the registered entity. This will be assigned to any synthesized entities.
+ * @property {string} name - The readable name for the registered entity. This will be assigned to any synthesized entities.
  */
 
 /**

package/src/loaders/api/register.js

@@ -14,6 +14,7 @@ import { log } from './log'
 import { addPageAction } from './addPageAction'
 import { noticeError } from './noticeError'
 import { single } from '../../common/util/invoke'
+import { recordCustomEvent } from './recordCustomEvent'
 
 /**
  * @typedef {import('./register-api-types').RegisterAPI} RegisterAPI
@@ -79,6 +80,7 @@ export function buildRegisterApi (agentRef, target) {
     addPageAction: (name, attributes = {}) => report(addPageAction, [name, { ...attrs, ...attributes }, agentRef], target),
     log: (message, options = {}) => report(log, [message, { ...options, customAttributes: { ...attrs, ...(options.customAttributes || {}) } }, agentRef], target),
     noticeError: (error, attributes = {}) => report(noticeError, [error, { ...attrs, ...attributes }, agentRef], target),
+    recordCustomEvent: (eventType, attributes = {}) => report(recordCustomEvent, [eventType, { ...attrs, ...attributes }, agentRef], target),
     setApplicationVersion: (value) => setLocalValue('application.version', value),
     setCustomAttribute: (key, value) => setLocalValue(key, value),
     setUserId: (value) => setLocalValue('enduser.id', value),

package/src/loaders/api-base.js

@@ -32,11 +32,8 @@ export class ApiBase {
    * It is not recommended for use in production environments and will not receive support for issues.
    *
    * Registers an external caller to report through the base agent to a different target than the base agent.
-   * @param {object} target the target object to report data to
-   * @param {string} target.licenseKey The licenseKey to report data to
-   * @param {string} target.applicationID The applicationID to report data to
-   * @param {string=} target.entityGuid The entityGuid to report data to
-   * @returns {object} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
+   * @param {import('./api/register-api-types').RegisterAPIConstructor} target the target object to report data to
+  @returns {import('./api/register-api-types').RegisterAPI} Returns an object that contains the available API methods and configurations to use with the external caller. See loaders/api/api.js for more information.
    */
   register (target) {
     return this.#callMethod(REGISTER, target)
@@ -46,7 +43,7 @@ export class ApiBase {
    * Records a custom event with a specified eventType and attributes.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
    * @param {string} eventType The eventType to store the event as.
-   * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+   * @param {Object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
    */
   recordCustomEvent (eventType, attributes) {
     return this.#callMethod(RECORD_CUSTOM_EVENT, eventType, attributes)