fix: Update typings for interaction API to reflect waitForEnd (#1591)

Co-authored-by: Chunwai Li <cli@newrelic.com>

Author: metal-messiah

.husky/pre-commit

@@ -6,3 +6,4 @@ export FORCE_COLOR=1
 
 npm run lint
 npm run test -- --onlyChanged
+npm run test:types

package.json

@@ -187,7 +187,7 @@
     "test": " NODE_OPTIONS=--max-old-space-size=8192 jest",
     "test:unit": "jest --selectProjects unit",
     "test:component": "jest --selectProjects component",
-    "test:types": "tsd -f ./tests/dts/**/*.ts",
+    "test:types": "npm run npm:build:types && tsd -f ./tests/dts/**/*.ts",
     "wdio": "node --max-old-space-size=8192 tools/wdio/bin/cli.js",
     "wdio:smoke": "node --max-old-space-size=8192 tools/wdio/bin/cli.js -T --concurrent=30",
     "build:all": "npm run cdn:build:local && npm run build:npm && npm run tools:test-builds",

src/loaders/api-base.js

@@ -197,12 +197,14 @@ export class ApiBase {
   /**
    * Returns a new API object that is bound to the current SPA interaction.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/interaction/}
+   * @param {Object} [opts] Options to configure the new or existing interaction with
+   * @param {boolean} [opts.waitForEnd=false] To forcibly keep the interaction open until the `.end` method is called on its handle, set to true. Defaults to false. After an interaction is earmarked with this, it cannot be undone.
    * @returns {InteractionInstance} An API object that is bound to a specific BrowserInteraction event. Each time this method is called for the same BrowserInteraction, a new object is created, but it still references the same interaction.
    *  - Note: Does not apply to MicroAgent
    *  - Deprecation Notice: interaction.createTracer is deprecated.  See https://docs.newrelic.com/eol/2024/04/eol-04-24-24-createtracer/ for more information.
   */
-  interaction () {
-    return this.#callMethod(INTERACTION)
+  interaction (opts) {
+    return this.#callMethod(INTERACTION, opts)
   }
 
   /**

tests/dts/agentoptions.test-d.ts

@@ -56,7 +56,7 @@ const validOptions: AgentOptions = {
       enabled: true,
       autoStart: false
     },
-    obfuscate: [{ pattern: /sensitive/, replacement: '****' }],
+    obfuscate: [{ regex: /sensitive/, replacement: '****' }],
     page_action: {
       enabled: true
     },

tests/dts/api.test-d.ts

@@ -25,7 +25,7 @@ expectType<MicroAgent>(microAgent)
     type?: string;
   }) => any>(agent.addToTrace)
   expectType<(name: string) => any>(agent.setCurrentRouteName)
-  expectType<() => InteractionInstance>(agent.interaction)
+  expectType<(opts?: { waitForEnd?: boolean }) => InteractionInstance>(agent.interaction)
 
   // Base Agent APIs
   expectType<(name: string, attributes?: object) => any>(agent.addPageAction)
@@ -45,7 +45,7 @@ expectType<MicroAgent>(microAgent)
   expectType<(parent: object, functionName: string, options?: { customAttributes?: object, level?: 'ERROR' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN'}) => any>(agent.wrapLogger)
 
   // SPA APIs
-  expectType<() => InteractionInstance>(agent.interaction)
+  expectType<(opts?: { waitForEnd?: boolean }) => InteractionInstance>(agent.interaction)
   expectType<(value: string) => InteractionInstance>(agent.interaction().actionText)
   expectType<(name: string, callback?: ((...args: any[]) => any)) => (...args: any) => any>(agent.interaction().createTracer)
   expectType<() => InteractionInstance>(agent.interaction().end)