[PR] Overall Typescript refactor

[LuchoTurtle]

Seeing that @thomaux already did an awesome job with implementing type definitions, I wanted to learn more about generics in Typescript so I'm attempting to rewrite the main index.js file in Typescript so it's friendlier for everyone 😄 .

This is very much a work in progress, as I'm trying to use the pre-existing type definitions in the current package. There's much to be done but I guess this is a start. I'm running every modification against tests so functions that are typed so far should remain functional.

Some tasks:

• Export type definitions (already implemented by @thomaux )
• Rewrite functions to make use of type definitions (index.js -> index.ts)
• Rewrite tests to make use of ts.

If anyone would like to chime in and give some feedback, that would be lovely!

[nelsonic]

@LuchoTurtle thanks very much for opening this PR as we discussed. 👌
100% on-board with a TypeScript re-write of this module for greater TS support. 🎉
(obvs it will still be compiled to JS for full backward compatibility ...)
Please consider opening an issue to outline the work that needs to be done. 🆕
Preferably with a checklist so that it can be worked on over multiple sessions. 👩‍💻
Thanks! 🙏

[thomaux]

Great work, happy to help if time permits and where needed. Seeing as there are some hiccups with the current typings (specifically concerning nested services etc.) don't be too worried about reusing those.

The tests should indeed be a good safety net to avoid regression.

[LuchoTurtle]

@thomaux thank you, sir! I was guided by your awesome type definitions. I try to reuse as much as possible but I gotta admit I'm stumped on some aspects, especially when I constantly get M cannot be used as an index type.

Again, I'm new to this level of TS generics, so I'm just trying to learn. But thank you for the feedback, I'll take that into account 😄

[nelsonic]

Relevant reading: https://blog.liblab.com/typescript-npm-packages-done-right/ 👀

[nelsonic]

@LuchoTurtle remind me why this was paused? ⏸️ 💭 ⏳

[LuchoTurtle]

@nelsonic I was only meant to work on this whenever I "had the time" or "didn't have any outstanding issues to work at", which really hasn't happened since.
Additionally, I'm not particularly well-versed in TS generic types and I keep stumbling upon blocking errors that are a bit beyond me. I'm thinking of doing something like https://www.totaltypescript.com/ to actually sort this PR out but it's a big task and there are other more important tasks to tackle first 👌

[nelsonic]

@LuchoTurtle Thanks for pairing on this during the morning today. 🧑‍💻 👌
Even if it felt like "slow progress", don't worry. 💭
It's a worthy effort if you want to add TypeScript skills 💪
& maintaining/refactoring a highly popular library to your list. ✅

[LuchoTurtle]

@nelsonic

Should it be a major version e.g. v6? 💭

Without a doubt. Because of the combination of the dependencies being updated and how the code is being transpiled from TS to JS, support only works for Node v18 upwards.

[nelsonic]

Ok, cool. Do you want to publish the new version? 📦

[LuchoTurtle]

I feel like you should be the one to do it, I don't want to mess anything up since it's a package that is highly used :p

[nelsonic]

[LuchoTurtle]

I'm not sure how I'd go about it. Wouldn't this need to be merged first for me to create a new version of the package in npm?

[nelsonic]

Nah, you can create & publish a new version on a branch. 📦 🚀

Simply run:

npm version major -m 'Typescript Refactor. see: https://github.com/dwyl/aws-sdk-mock/pull/277"
npm publish
git push && git push --tags

Invited you to maintain:

Will merge as soon as you publish.
If anything goes "wrong" (highly doubt it) message me on Signal. 💬

[LuchoTurtle]

I'm intent on publishing this later. I'm at the airport right now and I've fast-forwarded this branch to the main. I'm publishing it now because I'm hesitant about having some issues. If that's the case, I could only get back to this in 24 hours.

[nelsonic]

Do it. I'm here and check GitHub regularly for messages. Not many people will "upgrade" that quickly.

[LuchoTurtle]

Okay, doing it now (after updating package-lock.json.

[LuchoTurtle]

@nelsonic https://www.npmjs.com/package/aws-sdk-mock version 6.0.0 published.

[nelsonic]

Great work @LuchoTurtle 🎉
Thanks for publishing the new version to NPM. 📦 🚀
Merging.