Property 'noticeError' does not exist on type 'MicroAgent'

[jamesarosen]

The types for MicroAgent don't include noticeError despite that appearing in the docs.

Description

The README has this code:

const microAgent1 = new MicroAgent(options_1)
// ...
// manually handle a JavaScript Error with microAgent1
try{
  ...
} catch(err) {
  microAgent1.noticeError(err)
}

But when I try that locally, TypeScript complains:

Property 'noticeError' does not exist on type 'MicroAgent'.ts(2339)

Steps to Reproduce

1. Install @newrelic/[email protected]
2. Create a TypeScript file with the following contents:

import { MicroAgent } from "@newrelic/browser-agent/loaders/micro-agent";

const agent = new MicroAgent({ /* some configuration */ });

try {
  throw new Error('test')
} catch (e) {
  agent.noticeError(error);
}

Expected Behavior

The code compiles

Your Environment

I haven't yet gotten to a runtime environment, but it will be running in Fastly's Compute@Edge, which mimics a ServiceWorker environment.

[workato-integration]

https://issues.newrelic.com/browse/NR-139951

[jamesarosen]

This sort of works:

import { MicroAgent } from "@newrelic/browser-agent/loaders/micro-agent";
import type { setAPI } from "@newrelic/browser-agent/loaders/api/api";

type NewRelicAPI = ReturnType<typeof setAPI>;

const agent = new MicroAgent({ /* config */ })
(agent as unknown as NewRelicAPI).noticeError(error, {});

A minor issue is that the second argument -- customAttributes -- isn't optional in the TypeScript types.

[cwli24]

Hi @jamesarosen , all the code excerpts in the README are in JS, as we do not have support for TS.

There's however a community-created typings for our agent's interface at: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/new-relic-browser . Please note we're not responsible for this typing. For more, see thread on this: https://forum.newrelic.com/s/hubtopic/aAX8W0000008YeBWAU/typescript-for-browser-agent.

[jamesarosen]

we do not have support for TS

You might want to remove this from your package.json then:

"types": "./dist/types/index.d.ts",
"typesVersions": {
  ">=4.2": {
    "*": [
      "dist/types/*"
    ]
  }
},

Having that in the published package.json implies (1) that you do support TypeScript and (2) that consumers don't need to rely on DefinitelyTyped for this package.

[patrickhousley]

Typescript types generation cannot determine the actual types due to the dynamic nature of the agent. I will look into fixing the types generation in our build process.

[jamesarosen]

Typescript types generation cannot determine the actual types due to the dynamic nature of the agent

I think you actually can by applying type predicates when mixing in the capabilities in configure/configure and api/api, though that would probably require writing the library in TypeScript rather than trying to generate types during the build process.