feat: all the things!

[soldair]

types for npm related objects!

[soldair]

ping @chrisdickinson
i think this is ready to merge/review =)

/cc @ofrobots

[chrisdickinson]

❤️ This is great! 1 Q: would you mind if I rename Person to Maintainer?

[soldair]

i will fix this. perfect suggestion.

I was also wondering i think there is a third type of document? pacote has a method called "manifest" i wanted to make sure that AbbreviatedDocument (corgi) is not also the manifest cached by pacote

[soldair]

let me know if there is anything else you think i should do before you publish =)

[zkat]

@soldair pacote.manifest() returns corgis by default, and the full manifest if you do opts = { fullMetadata: true }

[soldair]

oh thanks @zkat
in that case i would like to rename AbbreviatedPackument to Manifest its an extremely better name

whatcha think?

[soldair]

ok. i intend to change AbbreviatedPackument to Manifest 😉

[chrisdickinson]

Thank you so much for this! Publishing as @npm/types @ 1.0.0.

[soldair]

curl https://registry.npmjs.org/@npm%2ftypes
{"error":"Not found"}

maybe went private?

[chrisdickinson]

Ack! Good catch. I have made the package public (at 1.0.1 because reasons ✨)

[styfle]

Any reason why these types are not shipped with pacote or npm?

[zkat]

Because we don't do typescript ourselves and I wasn't about to go through the trouble? I'll take a PR, though :)

[styfle]

@zkat It's actually quite easy to ship your .d.ts files alongside your .js source. All you need to do is make sure the pacote.d.ts file gets published (as you would expect) and add a single line to your package.json file such as "types": "./pacote.d.ts".

Now if you want to test the .d.ts file then you will need to add typescript to your devDependencies (as seen in this PR).

But shipping them together would prevent it from getting out of sync and also give end-users a MUCH better experience because they do import * as npm from 'npm' and it "just works" without any other packages.

[soldair]

I hope we can import these into the d.ts files of other projects to reduce duplicated effort. This is just one step.

…

On Fri, Aug 31, 2018, 1:22 PM Steven ***@***.***> wrote: @zkat <https://github.com/zkat> It's actually quite easy to ship your .d.ts files alongside your .js source. All you need to do is make sure the pacote.d.ts file gets published (as you would expect) and add a single line to your package.json file such as "types": "./pacote.d.ts". Now if you want to test the .d.ts file then you will need to add typescript to your devDependencies (as seen in this PR). But shipping them together would prevent it from getting out of sync and also give end-users a MUCH better experience because they do import * as npm from 'npm' and it "just works" without any other packages. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAHUX-98YSllEcrjf5BJL2OXJwLT7D7Uks5uWZrrgaJpZM4WSaHb> .

[zkat]

@styfle it is non zero amounts of work for me in a storm of priorities. It doesn't matter if it's easy. If it's easy, all the more reason to get a PR from someone