Oidc-client-js: Publish the type definition file to @types organization on npm

[shaunluttin]

With TypeScript 2.0, the recommended way to install type definitions is like this:

npm install --save @types/oidc-client
npm install --save @types/oidc-client-js

See: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html
See also: https://blogs.msdn.microsoft.com/typescript/2016/06/15/the-future-of-declaration-files/

You have already added the types to the NPM package, it would be great also to have them in the @types organization repository.

[brockallen]

what's the status on this?

[shaunluttin]

The status is that it would be nice to have this complete. I'm happy to take ownership of this issue if you'd like me to do that.

[brockallen]

yes, please do

[shaunluttin]

Related commit to definitely typed: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/13116. Let me know if you have questions.

[andy-ms]

If a package bundles its own types, we do not recommend having an @types package too.

[shaunluttin]

The PR to definitely typed adds to the list of not needed packages. Does that make sense?

[andy-ms]

I guess we could have called it notNeededAnyLongerPackages.json. We are also updating the pull request template to more forcefully tell people not to do this. DefinitelyTyped/DefinitelyTyped#13448

[shaunluttin]

@andy-ms Let me see if I understand correctly. If a package bundles its own types:

• do not publish an @types package,
• do not add the package to the list of not need packages in definitely typed.

Am I understanding correctly now?

[brockallen]

BTW @shaunluttin once this is all sorted, you will be the official PM for typings for this project :)

[andy-ms]

Exactly. You don't have to "register" your package anywhere, you can just publish it on your own and you're good to go.

[shaunluttin]

@brockallen Yes. I would be happy to manage the typings for this project.

[crh225]

@shaunluttin , I just upgraded oidc-client to 1.3.0 but for some reason visual studio is acting like the typing are not part of the oidc package.

How did you install the typings for oidc-client?

[shaunluttin]

Hi @crh225. Apologies for the slow response. It's been quite some time since I have looked at this. If I recall correctly, the types do not need installation, because they come with the oidc-client. Since time is short right now, I can point you in the direction of this demo: https://github.com/shaunluttin/aurelia-open-id-connect. Please ping me again if that does not illuminate this for you. Best, Shaun

[CKGrafico]

I think you can close this, are not necessary anymore because your library includes typings