@azure/openai 2.0.0-beta2 publishes declaration maps pointing to unpublished sources

[wessberg]

• Package Name: @azure/openai
• Package Version: 2.0.0-beta.2
• Operating system: Mac OS 14.2.1
• nodejs
  • version: 22.9.0
• browser
  • name/version: Not Applicable
• typescript
  • version: 5.6.3
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://learn.microsoft.com

Describe the bug
All current versions of @azure/openai published on NPM in the 2.0.0 branch (all alpha- and beta builds) include declaration maps (.d.ts.map) files. These are intended to be used in packages that also include their source code in the published package, such that consuming code editors can be taken directly to the original source declaration by via the TypeScript language service. However, @azure/openai 2.0.0-beta2 does not include the src folder that the declaration maps map the sources to.

To Reproduce
Steps to reproduce the behavior:

1. Install @azure/openai (or decompress and inspect the .tar archive packed by NPM)
2. Observe that declaration maps (.d.ts.map files) are shipped, pointing to source that are not published along with the package.

Expected behavior
The package should either not include declaration maps, or include the sources.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

[deyaaeldeen]

Hi @wessberg, thank you for reaching out! Yes, @azure/openai is a companion library to openai and is not exporting runtime JS definitions at the moment but it might in the future. Please checkout the current samples folder for examples of how to use it alongside openai: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai/samples/v2-beta

The package should include actual executable code.

Could you share more about your use case and why is this a concern?

[github-actions]

Hi @wessberg. Thank you for opening this issue and giving us the opportunity to assist. To help our team better understand your issue and the details of your scenario please provide a response to the question asked above or the information requested above. This will help us more accurately address your issue.

[wessberg]

@deyaaeldeen

Sure! As described in the issue description:

As a consequence, the section from the Migration guide from v1 to v2 about how to import and construct an AzureKeyCredential with an api token is currently non-functional, both for JavaScript runtimes, but also in the type layer, as @azure/openai does not export any typings either (only via @azure/openai/types, which the migration guide does not describe).

A reported issue that is related to this is: #31170

[deyaaeldeen]

Are you there describing how AzureKeyCredentials were created in the past, and that environment variables should be used going forward

Yes.