feat: introduce typings

[wellwelwel]

Closes #107.

This PR introduces typings (.d.ts files) to quibble.

---

I opted for an easier way to generate the types, which is to change all the extensions to .ts and then generate the compilation. This gives me all the declaration types as any.

Then I undo the changes and start working on each type properly.

---

Notes

• There are no changes in the main code.
• I've added a test that compiles the typings, but it's important to note that this test doesn't reflect in the main code.
  • This test is designed to ensure that no compilation breaks for final users due to quibble typings.
• I used any for external parameters that are outside the quibble's control, so users can freely define their own mocks types (or not).
• Two development dependencies have been added in order to perform the tests:
  • @types/node
  • typescript

I tested it manually in all scenarios listed in the documentation and also my projects that use quibble, just to be sure 🔬

[wellwelwel]

@searls, sorry for the long time.

Please feel free to make suggestions, changes and questions 🙋🏻‍♂️

There are some interesting improvements such as defining types dynamically (for final user), but I've chosen to keep this PR as objective as possible.

[wellwelwel]

A simple visual overview

[searls]

My understanding is that the types ought to be able to be committed to the repo as a single index.d.ts without any changes to the dependencies, build, etc. That would be my preference.

[wellwelwel]

My understanding is that the types ought to be able to be committed to the repo as a single index.d.ts without any changes to the dependencies, build, etc. That would be my preference.

@searls, thanks for the clarification.

I've removed all external changes to index.d.ts and kept only typings for exported methods that reaches the end user, instead of creating typings for all internal files.

A change in package.json has been made to ensure that both editors, CommonJS and ES Modules imports retrieve the same type definitions (also for compatibility):

+  "types": "./index.d.ts",
   "exports": {
     ".": {
       "require": "./lib/quibble.js",
       "import": "./lib/quibble.mjs",
+      "types": "./index.d.ts"
     },
     "./package.json": "./package.json"
   },

---

Could you review it again?

[searls]

Thanks! If there's an issue with these, I'm sure we'll hear about it

[wellwelwel]

Thanks! If there's an issue with these, I'm sure we'll hear about it

I'm watching the repository for issues and PRs. If something new comes up, I can help if necessary 🙋🏻‍♂️

[pksunkara]

@searls Can we please have a release since this was merged?