Typescript Type Definitions

[jescalan]

There has been a long standing PR to convert this entire library to typescript that has been plagued with a variety of issues stemming from its lack of default exports and two separate exports. In the meantime, perhaps we can bridge the gap by just providing typings. I pulled this out of one I wrote in a consuming typescript library, but I am not great at typescript so any thoughts here appreciated. If this works out, will write one for renderToString and ship it as major, call it a day for now!

[Southclaws]

Nice!

I was trying to debug this for ages last night and it turned out I just passed a field to the wrong object in the params 😂 I added quick typings myself (yes by copying the code into our project 🤠) to identify the issue and fix it so this is going to be super useful!

[jescalan]

I'm feeling pretty good about this. I'm going to cut a prerelease here for testing - since this library uses hooks, running npm link produces a hooks error. Installing the prerelease should make it easier to test for real in live projects. If anyone else wants to take an opportunity to test it, that would be wonderful!

You can try it out with npm i next-mdx-remote@canary

[jescalan]

Just completed a full test on one of my team's typescript apps and everything seemed to work correctly. I'm going to add some docs on the types and give a day for review if anyone else wants to take a look, then move forward with this one. Onwards!