Regression: LDSingleKindContext type not exported in 9.6.1

[klippx]

Is this a support request?

No

Describe the bug

My code:

import type { LDSingleKindContext } from '@launchdarkly/node-server-sdk';

This has pretty much always worked, and still works in 9.6.0. But when renovate want to merge a patch update to 9.6.1 then this is no longer available and breaks our build.

To reproduce

I think you can figure it out :)

Expected behavior

All types that were exported before shall still be exported in a patch version, and if you intended to remove LDSingleKindContext then it should go in the major 10.x release.

Logs

Not needed

SDK version

9.6.1

Language version, developer tools

Node v22.9.0
TypeScript 5.6.3

OS/platform

Any OS

Additional context

Not needed

[kinyoklion]

Hey @klippx,

Thank you for the report. There isn't any intention to remove this type, so we will check into how it isn't being exported.

Thank you,
Ryan

[kinyoklion]

Hello @klippx,

This seems to be working fine when I attempt to reproduce. I also see in the .d.ts files that the type is still exported.

My initial suspicion would be perhaps that the other associated packages are not getting their correct patch versions. I would make sure you are not explicitly depending on any of the common packages used by the SDK, for instance.

What specific error does it produce? Does it say it isn't exported?

Failing that if you could provide potentially a tsconfig file. Additionally please let me know if your project is commonjs or esm. The server package itself is still cjs, but we did add ESM support to some common packages, so I would like to validate that.

The typescript code I used:

import { init } from '@launchdarkly/node-server-sdk';
import type { LDSingleKindContext } from '@launchdarkly/node-server-sdk';

// Set sdkKey to your LaunchDarkly SDK key.
const sdkKey = "";

const client = init(sdkKey);

client.once('ready', async function () {
  showMessage("SDK successfully initialized!");
  const context: LDSingleKindContext = {kind: 'user', key: 'bob'};
  const res = await client.variation('my-boolean-flag', context, false);
  console.log("The result", res);
});

And the package.json that went with it:

{
  "name": "hello-node-typescript",
  "version": "1.0.0",
  "description": "Hello LaunchDarkly for Node.js with TypeScript",
  "main": "index.ts",
  "scripts": {
    "start": "ts-node ./index.ts"
  },
  "author": "LaunchDarkly <[email protected]>",
  "license": "Apache-2.0",
  "devDependencies": {
    "@types/node": "*",
    "ts-node": "*",
    "typescript": "5.6.3"
  },
  "dependencies": {
    "@launchdarkly/node-server-sdk": "9.6.1"
  }
}

And the very basic tsconfig.

{
  "compilerOptions": {
    "module": "commonjs",
    "strict": true
  }
}

Thank you,
Ryan

[thyming]

for what it's worth, i'm also experiencing this.
possibly related to this change? node-server-sdk-v9.6.0...node-server-sdk-v9.6.1#diff-3049555cc0014f748c79249fb17086aad4ef2778fb9a30e34a0228a57400109d

[kinyoklion]

Hello @thyming,

Would you by chance be able to share your tsconfig?

Also the link may not be taking me to what you intended to point out. Maybe a screenshot of the relevant part of the diff?

Thank you,
Ryan

[kinyoklion]

Also is it with a dependabot update, such as the original, or from manually updating the version?

[kinyoklion]

Eventually it does show me this file:

Which is not a file which is used in the server-sdk. That said there is a similar change in the main common library.

It generates .cjs and .mjs independently though, and the .d.ts files are the same. If I can figure out what makes your packages have a problem. Either the tsconfig, or your module is a package, etc. Then I could reproduce and see.

[kinyoklion]

Theoretically this section should cause the tooling to do the correct thing.

  "exports": {
    "types": "./dist/index.d.ts",
    "require": "./dist/index.cjs",
    "import": "./dist/index.mjs"
  },

[thyming]

the relevant part is:

{
  "extends": "@tsconfig/node20/tsconfig.json"
}

[kinyoklion]

Ok. Great. Thank you.

[alexframe]

@kinyoklion, the LDLogger type is also no longer exported in 9.6.1 - is that intentional?

[kinyoklion]

There are not any removed types in 9.6.1.

The problem here is the way that multi-type bundles work and I am working to fix it at the moment. If module resolution is set to node16 or higher, then types are not working correctly. When a package supports both CJS and ESM the typing files themselves now need to be .d.ts for esm and .d.cts for the commonjs bundle. In testing we were using module resolution 'node'. So we were not aware of this.

Our common library is now being used for client and server and needs ESM to support tree shaking and other features.

[kinyoklion]

I've set 9.6.0 to be tagged latest in NPM. I am not sure if dependabot is going to respect it, but you should remain on 9.6.0 until the issue is resolved.

Thank you.

[kinyoklion]

@thyming @klippx @alexframe

I have published a pre-release version:
"@launchdarkly/node-server-sdk": "9.6.2-beta.1"

If one of you could try this and let me know, that would be great. It has resolved the issue when I test locally using @tsconfig/node20 as well as node22. It also works with the legacy node resolution.

Details of the change are in this PR: #627

Sorry for the issue.

Thank you,
Ryan

[kinyoklion]

Fixed in 9.7.0. Please let me know if you encounter any additional issues.

Thank you,
Ryan