TypeScript Error

[dcc530]

Bugsnag version: 7.22.2

import Bugsnag from '@bugsnag/js';
Bugsnag.start({
apiKey: 'YOUR_API_KEY'
});

Error: Property 'start' does not exist on type 'typeof import("node_modules/@bugsnag/js/types")'.

Any thoughts?

[isimisi]

did you find the fix?

[hannah-smartbear]

Hi @isimisi,

Unfortunately we are unable to reproduce this issue. If you’re experiencing the same issue, please could you send us the contents of your package.json file for our further investigation? Feel free to write in to us at support@bugsnag.com if you don’t want to share your package.json publicly here.

[isimisi]

Hi @hannah-smartbear

System

Node version: 22.11.0
OS: MacOS 15.1.1
Chip: Apple M3

Error

When I build my project I get:

start/bugsnag.ts:5:11 - error TS2339: Property 'start' does not exist on type 'typeof import("~/Documents/Scheduler/node_modules/@bugsnag/js/types")'.

5   Bugsnag.start({
            ~~~~~

Package.json

{
  "name": "adonis-scheduler",
  "version": "0.0.0",
  "private": true,
  "type": "module",
  "license": "UNLICENSED",
  "scripts": {
    "start": "node bin/server.js",
    "build": "node ace build",
    "dev": "node ace serve --watch",
    "dev2": "PORT=3344 node ace serve",
    "test": "node ace test",
    "lint": "eslint .",
    "format": "prettier --write .",
    "typecheck": "tsc --noEmit"
  },
  "imports": {
    "#controllers/*": "./app/controllers/*.js",
    "#exceptions/*": "./app/exceptions/*.js",
    "#models/*": "./app/models/*.js",
    "#mails/*": "./app/mails/*.js",
    "#services/*": "./app/services/*.js",
    "#listeners/*": "./app/listeners/*.js",
    "#events/*": "./app/events/*.js",
    "#middleware/*": "./app/middleware/*.js",
    "#validators/*": "./app/validators/*.js",
    "#providers/*": "./providers/*.js",
    "#policies/*": "./app/policies/*.js",
    "#abilities/*": "./app/abilities/*.js",
    "#database/*": "./database/*.js",
    "#start/*": "./start/*.js",
    "#tests/*": "./tests/*.js",
    "#config/*": "./config/*.js"
  },
  "devDependencies": {
    "@adonisjs/assembler": "^7.1.1",
    "@adonisjs/eslint-config": "^1.2.1",
    "@adonisjs/prettier-config": "^1.2.1",
    "@adonisjs/tsconfig": "^1.2.1",
    "@japa/assert": "^2.1.0",
    "@japa/plugin-adonisjs": "^3.0.0",
    "@japa/runner": "^3.1.1",
    "@swc/core": "^1.3.107",
    "@types/luxon": "^3.4.2",
    "@types/node": "^20.11.10",
    "eslint": "^8.56.0",
    "pino-pretty": "^10.3.1",
    "prettier": "^3.2.4",
    "ts-node": "^10.9.2",
    "typescript": "^5.3.3"
  },
  "dependencies": {
    "@adonisjs/core": "^6.2.2",
    "@adonisjs/lock": "^1.0.0",
    "@adonisjs/redis": "^8.0.1",
    "@bugsnag/js": "^8.1.2",
    "@vinejs/vine": "^1.8.0",
    "croner": "^8.0.2",
    "luxon": "^3.4.4",
    "reflect-metadata": "^0.2.1"
  }
}

Implementation

import Bugsnag from "@bugsnag/js";
import env from "./env.js";

if (env.get("NODE_ENV") === "production") {
  Bugsnag.start({
    apiKey: env.get("BUGSNAG"),
  });
}

[clr182]

Hi @isimisi,

thanks for your patience while we looked into this.

We are currently working on a release to publish the JavaScript notifier as an ES modules, which should also address this problem. While we don’t have an ETA we can share at the moment, a viable workaround would be to use

Bugsnag.default.start()

which should fix the the problem. Please let us know whether this works for you.

[isimisi]

Hi @clr182,

Thanks for the update!

I think it's solely a TypeScript issue, as I am able to use the library as usual.

Currently I've done the following to essentially ignore the TypeScript errors:

declare module "@bugsnag/js" {
  const Bugsnag: any;
  export default Bugsnag;
}

Not sure why your types.d.ts isn't recognized, or perhaps I've misconfigured something?

[rossipedia]

Not sure why your types.d.ts isn't recognized, or perhaps I've misconfigured something?

You didn't misconfigure something. The package isn't published correctly:

https://arethetypeswrong.github.io/?p=@bugsnag/js@8.2.0

The resolved types use export default where the JavaScript file appears to use module.exports =. This will cause TypeScript under the node16 module mode to think an extra .default property access is required, but that will likely fail at runtime. These types should use export = instead of export default.

[clr182]

Hi @isimisi

@rossipedia is correct - the issue is entirely related to types. We do have work on our backlog aimed at fixing this issue.

In the meantime, we recommend using one of the workarounds mentioned above. We'll make sure to update this thread as soon as a fix is available. Thanks for your patience!

[bengourley]

Another workaround that keeps type safety:

import Bugsnag, { type BugsnagStatic } from '@bugsnag/js'

;(Bugsnag as unknown as BugsnagStatic).start({
// ... options
})

[alcohol]

Copilot came up with this solution for one of our little applications that integrated bugsnag;

// file: types/bugsnag.d.ts

// @bugsnag/js ships as a CJS package (module.exports = require('@bugsnag/node')) but its
// type declarations use the ESM `export default` syntax. TypeScript NodeNext resolves this
// as the module namespace rather than the exported value, so `import Bugsnag from '@bugsnag/js'`
// yields the wrong type. Redeclaring the module with `export =` (the correct CJS idiom) and
// `esModuleInterop` lets the documented ES-module-style default import work as expected.
declare module '@bugsnag/js' {
  interface Config {
    apiKey: string
    [key: string]: unknown
  }
  interface Client {}
  interface BugsnagStatic {
    start(apiKeyOrOpts: string | Config): Client
    createClient(apiKeyOrOpts: string | Config): Client
  }
  const Bugsnag: BugsnagStatic
  export = Bugsnag
}