Typescript support

[LukeGT]

Are there any plans to write Typescript declarations files for the wink modules? I use Typescript for all JS projects these days, and in order to use wink properly I've had to hack up some declaration files (I know there's the any type, but ew).

I'd be happy to contribute what I've written so far, but I can't promise it's complete or correct. It has been serving me well so far though :)

[sanjayaksaxena]

It will be great if you could contribute. We are not into Typescript, but we will fully support you in this endeavor. Let us discuss possibilities!

[sanjayaksaxena]

@LukeGT closing the issue for now, lets reopen whenever you are ready.

[pimpale]

Hello,

Thanks for this useful library. I have written a Typescript declaration file for wink-nlp and wink-eng-lite-web-mode.
You can view it here: https://gist.github.com/pimpale/9cf9ce5b0e903ddb3089fbf53f5c4bd0
These cover all of the public API that is documented on the website. (If I missed anything, please let me know.)

However, these types don't correctly represent the "defaulting" behavior that happens when you pass in an invalid itsHelper or asHelper, since I couldn't figure out how to represent that kind of behavior in Typescript.

I would like to contribute these files to the project, please let me know how to proceed.

Thanks,
Govind Pimpale

[sanjayaksaxena]

Thanks a ton @pimpale for all the effort and contribution. Would like to know that in web model under peer dependency you have mentioned wink-nlp v1.8.2:

"peerDependencies": {
    "wink-nlp": "^1.8.2"
},

Is it because you are referring to the upcoming version on release of this PR? I noticed, when I was trying to run linting!

[pimpale]

Hi,

That is what I was trying to do, since the current version (1.8.1) doesn't yet export Model and ModelAddon. For linting purposes you can edit it to depend on the current state git repository like so:

"peerDependencies": {
    "wink-nlp": "winkjs/wink-nlp"
},

And then try linting like that.

Sincerely,
Govind Pimpale

[sanjayaksaxena]

Yes, I did that only — thanks once again. Will release in a couple of days and also plan to release the source along with the distribution of model after adding source directory in .npmignore.

[pimpale]

Ok sounds good. Thanks for accepting the PRs!

Thanks,
Govind Pimpale

[sanjayaksaxena]

Thanks again @pimpale, have released the new versions of wink-nlp & wink-eng-lite-web-model. 🥳

[sanjayaksaxena]

Many thanks @pimpale for your contribution — have released the new version 1.8.0. 🎉

[pimpale]

Thanks! Glad I was able to help! :)

[sanjayaksaxena]

Hi @pimpale

Have released a new version v1.10.0 that adds model loading feature to bm25 vectorizer. I have updated the typescript for the same and request you to review it please.

Thanks a lot.

— Sanjaya

[pimpale]

Hi,

It looks good to me.

Thanks,
Govind Pimpale

[dcsan]

how are the typescript defs to be imported?

npm i --save-dev @types/wink-nlp
npm ERR! code E404
npm ERR! 404 Not Found - GET https://registry.npmjs.org/@types%2fwink-nlp - Not found

[rachnachakraborty]

Hi @dcsan

Please check out the resolution in issue#25 from @itPiligrim

Hope this works for you.

Thanks,
Rachna