@newrelic/browser-agent 1.302.0-rc.0 → 1.302.0-rc.10

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

@@ -17,15 +17,22 @@ import { timeToFirstByte } from '../../../common/vitals/time-to-first-byte'
 import { now } from '../../../common/timing/now'
 import { TimeKeeper } from '../../../common/timing/time-keeper'
 import { applyFnToProps } from '../../../common/util/traverse'
+import { send } from '../../../common/harvest/harvester'
+import { FEATURE_NAMES, FEATURE_TO_ENDPOINT } from '../../../loaders/features/features'
+import { getSubmitMethod } from '../../../common/util/submit-data'
 
 export class Aggregate extends AggregateBase {
   static featureName = CONSTANTS.FEATURE_NAME
+
   constructor (agentRef) {
     super(agentRef, CONSTANTS.FEATURE_NAME)
 
+    this.sentRum = false // flag to facilitate calling sendRum() once externally (by the consent API in agent-session.js)
+
     this.timeToFirstByte = 0
     this.firstByteToWindowLoad = 0 // our "frontend" duration
     this.firstByteToDomContent = 0 // our "dom processing" duration
+    this.retries = 0
 
     if (!isValid(agentRef.info)) {
       this.ee.abort()
@@ -52,9 +59,8 @@ export class Aggregate extends AggregateBase {
    *
    * @param {Function} cb A function to run once the RUM call has finished - Defaults to activateFeatures
    * @param {*} customAttributes custom attributes to attach to the RUM call - Defaults to info.js
-   * @param {*} target The target to harvest to
    */
-  sendRum (customAttributes = this.agentRef.info.jsAttributes, target = { licenseKey: this.agentRef.info.licenseKey, applicationID: this.agentRef.info.applicationID }) {
+  sendRum (customAttributes = this.agentRef.info.jsAttributes) {
     const info = this.agentRef.info
     const measures = {}
 
@@ -107,24 +113,26 @@ export class Aggregate extends AggregateBase {
     queryParameters.fp = firstPaint.current.value
     queryParameters.fcp = firstContentfulPaint.current.value
 
-    const timeKeeper = this.agentRef.runtime.timeKeeper
-    if (timeKeeper?.ready) {
-      queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(now()))
+    this.queryStringsBuilder = () => { // this will be called by AggregateBase.makeHarvestPayload every time harvest is triggered to be qs
+      this.rumStartTime = now() // this should be reset at the beginning of each RUM call for proper timeKeeper calculation in coordination with postHarvestCleanup
+      const timeKeeper = this.agentRef.runtime.timeKeeper
+      if (timeKeeper?.ready) {
+        queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(this.rumStartTime))
+      }
+      return queryParameters
     }
+    this.events.add(body)
 
-    this.rumStartTime = now()
-
-    this.agentRef.runtime.harvester.triggerHarvestFor(this, {
-      directSend: {
-        target,
-        payload: { qs: queryParameters, body }
-      },
-      needResponse: true,
+    if (this.agentRef.runtime.harvester.triggerHarvestFor(this, {
       sendEmptyBody: true
-    })
+    }).ranSend) this.sentRum = true
+  }
+
+  serializer (eventBuffer) { // this is necessary because PVE sends a single item rather than an array; in the case of undefined, this prevents sending [null] as body
+    return eventBuffer[0]
   }
 
-  postHarvestCleanup ({ status, responseText, xhr }) {
+  postHarvestCleanup ({ sent, status, responseText, xhr, retry }) {
     const rumEndTime = now()
     let app, flags
     try {
@@ -134,8 +142,63 @@ export class Aggregate extends AggregateBase {
       warn(53, error)
     }
 
+    super.postHarvestCleanup({ sent, retry }) // this will set isRetrying & re-buffer the body if request is to be retried
+    if (this.isRetrying && this.retries++ < 1) { // Only retry once
+      setTimeout(() => this.agentRef.runtime.harvester.triggerHarvestFor(this, {
+        sendEmptyBody: true
+      }), 5000) // Retry sending the RUM event after 5 seconds
+      return
+    }
     if (status >= 400 || status === 0) {
       warn(18, status)
+      this.blocked = true
+
+      // Get estimated payload size of our backlog
+      const textEncoder = new TextEncoder()
+      const payloadSize = Object.values(newrelic.ee.backlog).reduce((acc, value) => {
+        if (!value) return acc
+
+        const encoded = textEncoder.encode(value)
+        return acc + encoded.byteLength
+      }, 0)
+
+      // Send SMs about failed RUM request
+      const body = {
+        sm: [{
+          params: {
+            name: `Browser/Supportability/BCS/Error/${status}`
+          },
+          stats: {
+            c: 1
+          }
+        },
+        {
+          params: {
+            name: 'Browser/Supportability/BCS/Error/Dropped/Bytes'
+          },
+          stats: {
+            c: 1,
+            t: payloadSize
+          }
+        },
+        {
+          params: {
+            name: 'Browser/Supportability/BCS/Error/Duration/Ms'
+          },
+          stats: {
+            c: 1,
+            t: rumEndTime - this.rumStartTime
+          }
+        }]
+      }
+
+      send(this.agentRef, {
+        endpoint: FEATURE_TO_ENDPOINT[FEATURE_NAMES.metrics],
+        payload: { body },
+        submitMethod: getSubmitMethod(),
+        featureName: FEATURE_NAMES.metrics
+      })
+
       // Adding retry logic for the rum call will be a separate change; this.blocked will need to be changed since that prevents another triggerHarvestFor()
       this.ee.abort()
       return
@@ -155,6 +218,7 @@ export class Aggregate extends AggregateBase {
       }
     } catch (error) {
       this.ee.abort()
+      this.blocked = true
       warn(17, error)
       return
     }

package/src/features/page_view_event/instrument/index.js

@@ -2,7 +2,6 @@
  * Copyright 2020-2025 New Relic, Inc. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { handle } from '../../../common/event-emitter/handle'
 import { setupSetPageViewNameAPI } from '../../../loaders/api/setPageViewName'
 import { InstrumentBase } from '../../utils/instrument-base'
 import * as CONSTANTS from '../constants'
@@ -21,9 +20,6 @@ export class Instrument extends InstrumentBase {
     /** feature specific APIs */
     setupSetPageViewNameAPI(agentRef)
 
-    /** messages from the register API that can trigger a new RUM call */
-    this.ee.on('api-send-rum', (attrs, target) => handle('send-rum', [attrs, target], undefined, this.featureName, this.ee))
-
     this.importAggregator(agentRef, () => import(/* webpackChunkName: "page_view_event-aggregate" */ '../aggregate'))
   }
 

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

@@ -7,7 +7,7 @@
  */
 
 import { registerHandler } from '../../../common/event-emitter/register-handler'
-import { ABORT_REASONS, FEATURE_NAME, QUERY_PARAM_PADDING, RRWEB_EVENT_TYPES, SR_EVENT_EMITTER_TYPES, TRIGGERS } from '../constants'
+import { ABORT_REASONS, ERROR_DURING_REPLAY, FEATURE_NAME, QUERY_PARAM_PADDING, RRWEB_EVENT_TYPES, TRIGGERS } from '../constants'
 import { AggregateBase } from '../../utils/aggregate-base'
 import { sharedChannel } from '../../../common/constants/shared-channel'
 import { obj as encodeObj } from '../../../common/url/encode'
@@ -21,6 +21,7 @@ import { now } from '../../../common/timing/now'
 import { MAX_PAYLOAD_SIZE } from '../../../common/constants/agent-constants'
 import { cleanURL } from '../../../common/url/clean-url'
 import { canEnableSessionTracking } from '../../utils/feature-gates'
+import { PAUSE_REPLAY } from '../../../loaders/api/constants'
 
 export class Aggregate extends AggregateBase {
   static featureName = FEATURE_NAME
@@ -77,11 +78,11 @@ export class Aggregate extends AggregateBase {
       this.mode = data.sessionReplayMode
     })
 
-    registerHandler(SR_EVENT_EMITTER_TYPES.PAUSE, () => {
+    registerHandler(PAUSE_REPLAY, () => {
       this.forceStop(this.mode === MODE.FULL)
     }, this.featureName, this.ee)
 
-    registerHandler(SR_EVENT_EMITTER_TYPES.ERROR_DURING_REPLAY, e => {
+    registerHandler(ERROR_DURING_REPLAY, e => {
       this.handleError(e)
     }, this.featureName, this.ee)
 

package/src/features/session_replay/constants.js

@@ -7,11 +7,7 @@ import { FEATURE_NAMES } from '../../loaders/features/features'
 
 export const FEATURE_NAME = FEATURE_NAMES.sessionReplay
 
-export const SR_EVENT_EMITTER_TYPES = {
-  RECORD: 'recordReplay',
-  PAUSE: 'pauseReplay',
-  ERROR_DURING_REPLAY: 'errorDuringReplay'
-}
+export const ERROR_DURING_REPLAY = 'errorDuringReplay'
 
 export const AVG_COMPRESSION = 0.12
 export const RRWEB_EVENT_TYPES = {

package/src/features/session_replay/instrument/index.js

@@ -10,9 +10,10 @@ import { handle } from '../../../common/event-emitter/handle'
 import { DEFAULT_KEY, MODE, PREFIX } from '../../../common/session/constants'
 import { InstrumentBase } from '../../utils/instrument-base'
 import { hasReplayPrerequisite, isPreloadAllowed } from '../shared/utils'
-import { FEATURE_NAME, SR_EVENT_EMITTER_TYPES, TRIGGERS } from '../constants'
+import { ERROR_DURING_REPLAY, FEATURE_NAME, TRIGGERS } from '../constants'
 import { setupRecordReplayAPI } from '../../../loaders/api/recordReplay'
 import { setupPauseReplayAPI } from '../../../loaders/api/pauseReplay'
+import { RECORD_REPLAY } from '../../../loaders/api/constants'
 
 export class Instrument extends InstrumentBase {
   static featureName = FEATURE_NAME
@@ -34,7 +35,7 @@ export class Instrument extends InstrumentBase {
     } catch (err) { }
 
     if (hasReplayPrerequisite(agentRef.init)) {
-      this.ee.on(SR_EVENT_EMITTER_TYPES.RECORD, () => this.#apiStartOrRestartReplay())
+      this.ee.on(RECORD_REPLAY, () => this.#apiStartOrRestartReplay())
     }
 
     if (this.#canPreloadRecorder(session)) {
@@ -50,7 +51,7 @@ export class Instrument extends InstrumentBase {
       if (this.blocked) return
       if (this.agentRef.runtime.isRecording) {
         this.errorNoticed = true
-        handle(SR_EVENT_EMITTER_TYPES.ERROR_DURING_REPLAY, [e], undefined, this.featureName, this.ee)
+        handle(ERROR_DURING_REPLAY, [e], undefined, this.featureName, this.ee)
       }
     })
   }

package/src/features/utils/agent-session.js

@@ -56,6 +56,18 @@ export function setupAgentSession (agentRef) {
     agentRef.runtime.session.syncCustomAttribute(key, value)
   }, 'session', sharedEE)
 
+  registerHandler('api-consent', (accept) => {
+    agentRef.runtime.session.write({ consent: accept === undefined ? true : accept })
+
+    // call sendRum if it wasn't called yet
+    agentRef.features.page_view_event.onAggregateImported.then((loaded) => {
+      const pveAgg = agentRef.features.page_view_event.featAggregate
+      if (loaded && !pveAgg.sentRum) {
+        pveAgg.sendRum()
+      }
+    })
+  }, 'session', sharedEE)
+
   drain(agentRef.agentIdentifier, 'session')
 
   return agentRef.runtime.session

package/src/features/utils/instrument-base.js

@@ -49,7 +49,10 @@ export class InstrumentBase extends FeatureBase {
      * @type {Promise} Assigned immediately after @see importAggregator runs. Serves as a signal for when the inner async fn finishes execution. Useful for features to await
      * one another if there are inter-features dependencies.
     */
-    this.onAggregateImported = undefined
+    this.loadedSuccessfully = undefined
+    this.onAggregateImported = new Promise(resolve => {
+      this.loadedSuccessfully = resolve
+    })
 
     /**
      * used in conjunction with newrelic.start() to defer harvesting in features
@@ -83,11 +86,6 @@ export class InstrumentBase extends FeatureBase {
   importAggregator (agentRef, fetchAggregator, argsObjFromInstrument = {}) {
     if (this.featAggregate) return
 
-    let loadedSuccessfully
-    this.onAggregateImported = new Promise(resolve => {
-      loadedSuccessfully = resolve
-    })
-
     const importLater = async () => {
       // wait for the deferred promise to resolve before proceeding
       // this will resolve immediately if the feature is auto-started,
@@ -113,20 +111,20 @@ export class InstrumentBase extends FeatureBase {
       try {
         if (!this.#shouldImportAgg(this.featureName, session, agentRef.init)) {
           drain(this.agentIdentifier, this.featureName)
-          loadedSuccessfully(false) // aggregate module isn't loaded at all
+          this.loadedSuccessfully(false) // aggregate module isn't loaded at all
           return
         }
         const { Aggregate } = await fetchAggregator()
         this.featAggregate = new Aggregate(agentRef, argsObjFromInstrument)
 
         agentRef.runtime.harvester.initializedAggregates.push(this.featAggregate) // "subscribe" the feature to future harvest intervals (PVE will start the timer)
-        loadedSuccessfully(true)
+        this.loadedSuccessfully(true)
       } catch (e) {
         warn(34, e)
         this.abortHandler?.() // undo any important alterations made to the page
         // not supported yet but nice to do: "abort" this agent's EE for this feature specifically
         drain(this.agentIdentifier, this.featureName, true)
-        loadedSuccessfully(false)
+        this.loadedSuccessfully(false)
         if (this.ee) this.ee.abort()
       }
     }

package/src/interfaces/registered-entity.js

@@ -48,6 +48,27 @@ 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')
+  }
+
+  /**
+   * Measures a task that is recorded as a BrowserPerformance event.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/measure/}
+   * @param {string} name The name of the task
+   * @param {{start: number, end: number, duration: number, customAttributes: object}} [options] An object used to control the way the measure API operates
+   * @returns {{start: number, end: number, duration: number, customAttributes: object}} Measurement details
+   */
+  measure (name, options) {
+    warn(35, 'measure')
+  }
+
   /**
    * 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/agent.js

@@ -23,6 +23,7 @@ import { setupSetCustomAttributeAPI } from './api/setCustomAttribute'
 import { setupSetUserIdAPI } from './api/setUserId'
 import { setupSetApplicationVersionAPI } from './api/setApplicationVersion'
 import { setupStartAPI } from './api/start'
+import { setupConsentAPI } from './api/consent'
 
 /**
  * @typedef {Object} AgentOptions
@@ -70,6 +71,7 @@ export class Agent extends AgentBase {
     setupSetUserIdAPI(this)
     setupSetApplicationVersionAPI(this)
     setupStartAPI(this)
+    setupConsentAPI(this)
 
     this.run()
   }

package/src/loaders/api/consent.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2020-2025 New Relic, Inc. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { prefix, CONSENT } from './constants'
+import { setupAPI } from './sharedHandlers'
+import { handle } from '../../common/event-emitter/handle'
+import { warn } from '../../common/util/console'
+
+export function setupConsentAPI (agent) {
+  setupAPI(CONSENT, function (accept) {
+    if (accept !== undefined && typeof accept !== 'boolean') {
+      warn(65, typeof accept)
+      return
+    }
+    handle(prefix + CONSENT, [accept], undefined, 'session', agent.ee)
+  }, agent)
+}

package/src/loaders/api/constants.js

@@ -25,3 +25,4 @@ export const SET_USER_ID = 'setUserId'
 export const START = 'start'
 export const WRAP_LOGGER = 'wrapLogger'
 export const MEASURE = 'measure'
+export const CONSENT = 'consent'

package/src/loaders/api/measure.js

@@ -10,44 +10,45 @@ import { prefix, MEASURE } from './constants'
 import { setupAPI } from './sharedHandlers'
 
 export function setupMeasureAPI (agent) {
-  setupAPI(MEASURE, function (name, options) {
-    const n = now()
-    const { start, end, customAttributes } = options || {}
-    const returnObj = { customAttributes: customAttributes || {} }
+  setupAPI(MEASURE, (name, options) => measure(name, options, agent), agent)
+}
+
+export function measure (name, options, agentRef, target, timestamp = now()) {
+  const { start, end, customAttributes } = options || {}
+  const returnObj = { customAttributes: customAttributes || {} }
 
-    if (typeof returnObj.customAttributes !== 'object' || typeof name !== 'string' || name.length === 0) {
-      warn(57)
-      return
-    }
+  if (typeof returnObj.customAttributes !== 'object' || typeof name !== 'string' || name.length === 0) {
+    warn(57)
+    return
+  }
 
-    /**
+  /**
      * getValueFromTiming - Helper function to extract a numeric value from a supplied option.
      * @param {Number|PerformanceMark} [timing] The timing value
      * @param {Number} [d] The default value to return if timing is invalid
      * @returns {Number} The timing value or the default value
      */
-    const getValueFromTiming = (timing, d) => {
-      if (timing == null) return d
-      if (typeof timing === 'number') return timing
-      if (timing instanceof PerformanceMark) return timing.startTime
-      return Number.NaN
-    }
-
-    returnObj.start = getValueFromTiming(start, 0)
-    returnObj.end = getValueFromTiming(end, n)
-    if (Number.isNaN(returnObj.start) || Number.isNaN(returnObj.end)) {
-      warn(57)
-      return
-    }
-
-    returnObj.duration = returnObj.end - returnObj.start
-    if (returnObj.duration < 0) {
-      warn(58)
-      return
-    }
-
-    handle(prefix + MEASURE, [returnObj, name], undefined, FEATURE_NAMES.genericEvents, agent.ee)
-
-    return returnObj
-  }, agent)
+  const getValueFromTiming = (timing, d) => {
+    if (timing == null) return d
+    if (typeof timing === 'number') return timing
+    if (timing instanceof PerformanceMark) return timing.startTime
+    return Number.NaN
+  }
+
+  returnObj.start = getValueFromTiming(start, 0)
+  returnObj.end = getValueFromTiming(end, timestamp)
+  if (Number.isNaN(returnObj.start) || Number.isNaN(returnObj.end)) {
+    warn(57)
+    return
+  }
+
+  returnObj.duration = returnObj.end - returnObj.start
+  if (returnObj.duration < 0) {
+    warn(58)
+    return
+  }
+
+  handle(prefix + MEASURE, [returnObj, name, target], undefined, FEATURE_NAMES.genericEvents, agentRef.ee)
+
+  return returnObj
 }

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,21 @@
 
 /**
  * @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 {(eventType: string, options?: {start: number, end: number, duration: number, customAttributes: object}) => {{start: number, end: number, duration: number, customAttributes: object}}} measure - Measures a task that is recorded as a BrowserPerformance event.
+ * @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

@@ -4,7 +4,7 @@
  */
 import { handle } from '../../common/event-emitter/handle'
 import { warn } from '../../common/util/console'
-import { isValidMFETarget } from '../../common/util/mfe'
+import { hasValidValue, isValidMFETarget } from '../../common/util/mfe'
 import { FEATURE_NAMES } from '../features/features'
 import { now } from '../../common/timing/now'
 import { SUPPORTABILITY_METRIC_CHANNEL } from '../../features/metrics/constants'
@@ -14,6 +14,8 @@ import { log } from './log'
 import { addPageAction } from './addPageAction'
 import { noticeError } from './noticeError'
 import { single } from '../../common/util/invoke'
+import { measure } from './measure'
+import { recordCustomEvent } from './recordCustomEvent'
 
 /**
  * @typedef {import('./register-api-types').RegisterAPI} RegisterAPI
@@ -73,12 +75,17 @@ export function buildRegisterApi (agentRef, target) {
   /** primary cases that can block the register API from working at init time */
   if (!agentRef.init.api.allow_registered_children) block(single(() => warn(55)))
   if (!isValidMFETarget(target)) block(single(() => warn(48, target)))
+  if (!hasValidValue(target.id) || !hasValidValue(target.name)) {
+    block(single(() => warn(48, target)))
+  }
 
   /** @type {RegisterAPI} */
   const api = {
     addPageAction: (name, attributes = {}) => report(addPageAction, [name, { ...attrs, ...attributes }, agentRef], target),
     log: (message, options = {}) => report(log, [message, { ...options, customAttributes: { ...attrs, ...(options.customAttributes || {}) } }, agentRef], target),
+    measure: (name, options = {}) => report(measure, [name, { ...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

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { warn } from '../common/util/console'
-import { ADD_PAGE_ACTION, ADD_RELEASE, ADD_TO_TRACE, FINISHED, INTERACTION, LOG, NOTICE_ERROR, PAUSE_REPLAY, RECORD_CUSTOM_EVENT, RECORD_REPLAY, REGISTER, SET_APPLICATION_VERSION, SET_CURRENT_ROUTE_NAME, SET_CUSTOM_ATTRIBUTE, SET_ERROR_HANDLER, SET_PAGE_VIEW_NAME, SET_USER_ID, START, WRAP_LOGGER, MEASURE } from './api/constants'
+import { ADD_PAGE_ACTION, ADD_RELEASE, ADD_TO_TRACE, CONSENT, FINISHED, INTERACTION, LOG, NOTICE_ERROR, PAUSE_REPLAY, RECORD_CUSTOM_EVENT, RECORD_REPLAY, REGISTER, SET_APPLICATION_VERSION, SET_CURRENT_ROUTE_NAME, SET_CUSTOM_ATTRIBUTE, SET_ERROR_HANDLER, SET_PAGE_VIEW_NAME, SET_USER_ID, START, WRAP_LOGGER, MEASURE } from './api/constants'
 
 /**
  * @typedef {import('./api/interaction-types').InteractionInstance} InteractionInstance
@@ -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)
@@ -222,10 +219,20 @@ export class ApiBase {
    * Measures a task that is recorded as a BrowserPerformance event.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/measure/}
    * @param {string} name The name of the task
-   * @param {object?} options An object used to control the way the measure API operates
+   * @param {{start: number, end: number, duration: number, customAttributes: object}} [options] An object used to control the way the measure API operates
    * @returns {{start: number, end: number, duration: number, customAttributes: object}} Measurement details
    */
   measure (name, options) {
     return this.#callMethod(MEASURE, name, options)
   }
+
+  /**
+   * Accepts or rejects consent when the agent is configured to require consent before harvesting.
+   * The consent state is stored in session storage inside the NRBA_SESSION object.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/consent/}
+   * @param {boolean?} accept Whether to accept or reject consent. Defaults to true (accept) if left undefined.
+   */
+  consent (accept) {
+    return this.#callMethod(CONSENT, accept)
+  }
 }