feat(api): improve nodejs api

[eduardomourar]

In order to make somewhat more extensible to use library with Node.js, we will need to make the following changes:

• Allow the input to be an object (a single schema or multiple schemas either with parsed content or its full path)
• Make the output an plain object containing the readme, input schemas and markdown
• Create TypeScript definition

Related to #300.

[codecov]

Codecov Report

Merging #323 (d52325f) into main (48335c3) will increase coverage by 0.74%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #323      +/-   ##
==========================================
+ Coverage   98.57%   99.31%   +0.74%     
==========================================
  Files          11       11              
  Lines         563      588      +25     
==========================================
+ Hits          555      584      +29     
+ Misses          8        4       -4     

Impacted Files	Coverage Δ
lib/symbols.js	100.00% <ø> (ø)
lib/formatInfo.js	100.00% <100.00%> (ø)
lib/index.js	97.56% <100.00%> (+2.03%)	⬆️
lib/markdownBuilder.js	99.12% <100.00%> (ø)
lib/readmeBuilder.js	100.00% <100.00%> (ø)
lib/schemaProxy.js	100.00% <100.00%> (ø)
lib/writeMarkdown.js	100.00% <100.00%> (+10.00%)	⬆️
lib/writeSchema.js	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48335c3...d52325f. Read the comment docs.

[trieloff]

Thank you for the PR, but I find it too hard to review the unrelated changes and disentangle the substance of the PR.

Please:

• do not change the copyright dates
• do not introduce camel case variable names (open a separate refactoring/style PR if it bothers you too much)
• do not change import orders or import names (same as above)
• make sure the test coverage does not go down

I will review then, as the substance of the PR seems to make sense, it's just hard to see underneath the mountain of other changes.

[trieloff]

Hi @eduardomourar - thanks for the update, I may need until the week after next to review this.

[eduardomourar]

Hi @eduardomourar - thanks for the update, I may need until the week after next to review this.

No rush, we are doing extensive tests against our schemas in the meantime.

[trieloff]

Good, but the comment formatting and copyright dates need to stay the way they've been before.

[trieloff]

🎉 This PR is included in version 7.0.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀