Missing Typescript declarations

[marcospassos]

Describe the bug

The NPM module is missing the type declarations.

How to reproduce

• Install vowpalwabbit/vowpalwabbit
• Import import promise from '@vowpalwabbit/vowpalwabbit';

Version

0.0.7

OS

Macos

Language

Node

Additional context

No response

[JohnLangford]

We discussed this a bit. My understanding is that this doesn't cause a lack of functionality, but would be desirable from a documentation perspective. Do you want to submit a patch for this?

[JohnLangford]

(Closing for now, would be great to have a patch if you want to contribute.)

[marcospassos]

Hi @JohnLangford, you can't use the JS library with Typescript without typing - the project just won't compile. I'd have to re-declare all the types, which would be error-prone and add more maintenance overhead. The fix is simple: just add the declaration files to the NPM module.

I can provide a PR for this if it's welcome.

[JohnLangford]

Yes please---a patch would be great.

[marcospassos]

The current code produces the following typing result:

declare const _default: Promise<unknown>;
export default _default;
//# sourceMappingURL=vw.d.ts.map

This isn't useful at all 😅

I'll work on proper typing and submit a PR, including a declaration file that we can distribute with the package. This will require mapping out the API, so it will take me some time.