TypeScript Not Working When Package.json type is "module"

[Lozoute]

Describe the bug
When installing Nylas SDK 7 to a new repo, using TypeScript 5 and type "module" in package.json, TypeScript throws the error This expression is not constructable. adding type: "module" into the package.json of Nylas fixes the problem but then commonjs requires do not work anymore.

To Reproduce
1 Create a new repo

2 Add this package.json

{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "type": "module",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "tsc && node nylas.mjs"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "nylas": "^7.2.1"
  },
  "devDependencies": {
    "typescript": "^5.4.2"
  }
}

3. Add this tsconfig.json

{
  "compilerOptions": {
    "target": "esnext",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "declaration": true,
    "esModuleInterop": false,
    "forceConsistentCasingInFileNames": true,
    "strict": false,
    "noImplicitAny": false,
    "strictNullChecks": false,
    "strictFunctionTypes": false,
    "strictBindCallApply": false,
    "strictPropertyInitialization": false,
    "skipLibCheck": true,
    "resolvePackageJsonExports": true,
  },
  "exclude": ["modules/clients/**/*"]
}

4. Add this nylas.mts file

import Nylas from 'nylas';


const apiKey = 'YOUR_API_KEY';
const apiUri = 'https://api.eu.nylas.com';

const nylas = new Nylas({
  apiKey: apiKey,
  apiUri: apiUri
});


const result = await nylas.messages.list({
  identifier: "YOUR_GRANT",
  queryParams: {
    limit: 20,
  },
});

console.log(result);

5. npm install && npm start

Expected behavior
Well I guess we should have no error but the tsc compiler throws the error This expression is not constructable.

SDK Version:
7.2.1

Additional context
Add any other context about the problem here.

[mrashed-dev]

Thanks for opening this issue @Lozoute, we'll take a look and provide you an update as soon as we get one.

[mrashed-dev]

Hey @Lozoute, we're still looking into this internally and trying to find the best course of action here that won't break anything for cjs users. Until then, during my testing I found that if you use new Nylas.default({... it should work and it does give you full typing support. I'm not suggesting this as a final solution, but only a temporary workaround until we have something flushed out that can satisfy everyone. Hybrid projects in TS are always a little tricky. Sorry for the delay on this, but we're looking to resolve this fully soon.

[Lozoute]

Hello @mrashed-dev
It may work for TypeScript but once compiled, this code won't work:

{
  "errorType": "TypeError",
  "errorMessage": "Nylas.default is not a constructor",
  "trace": [
    "TypeError: Nylas.default is not a constructor",
    "    at file:///var/task/src/index.mjs:9:15",
    "    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)"
  ]
}

I think it's crazy that the first thing we have on the NodeJs SDK Documentation is this:

import Nylas from "nylas";

const nylas = new Nylas({
  apiKey: "<NYLAS_API_KEY>",
  apiUri: "<NYLAS_API_URI>"
})  

And it doesn't even work properly.

[Lozoute]

My only working solution for now is to do this:

// @ts-expect-error Some comment so next dev can understand...
const nylas = new Nylas({
  apiKey: nylasApiKey,
  apiUri: nylasApiBaseUrl
}) as Nylas.default

[a-gasior]

@mrashed-dev this is still not resolved. The hack suggested by @Lozoute still works.

[TheForsakenSpirit]

Same issue on 7.8.0.

[kdawgwilk]

I think the simple non-breaking change to make to this package is just to export both a default export of the Nylas class and a named export Nylas. That is what most other packages are doing that I have seen

[ericvandever]

Can you consider adding the exports property to package.json for environments that do not support the non-standard module field?

https://docs.npmjs.com/cli/v11/configuring-npm/package-json#exports
https://nodejs.org/api/packages.html#conditional-exports

{
  "exports": {
    "require": "lib/cjs/nylas.js",
    "types": "lib/types/nylas.d.ts",
    "import": "lib/esm/nylas.js"
  }
}

[AaronDDM]

Hey folks - going to take a look at this. Apologies for the delay!

[AaronDDM]

Hey folks - I was not able to reproduce this in the latest version of our SDK. I put up an example however to showcase this:
#664

Closing.