feat: refMap

[marbemac]

• Improves documentation / readme with more examples
• Adds refMap property to resolve result. Description in types file.
• Increases test coverage a bit by adding some new tests and removing some unneeded code.

[marbemac]

Ugh, my local git was setup with the wrong commit signer - fixed for future.

[XVincentX]

Ok, thanks a lot. This PR has clarified some important things on the library as well as adding the feature I was looking for. 🚀

[XVincentX]

I get what you mean here, however I'd say "it's a new object with local refs resolved and replaced"

[marbemac]

Not a new object though, it's better than that :). Added a few new test assertions to demonstrate the immutability principles, check them out: https://github.com/stoplightio/json-ref-resolver/blob/feat/ref-map/src/__tests__/resolver.spec.ts#L139-L147

Structural sharing is particularly important for frontend applications like react, that can take advantage of it to re-render less parts of the screen since === will remain true for much of the object (anything that was not a ref).

[XVincentX]

@marbemac

I can't merge this PR — I'm afraid you'll have to do it.

Feel free to address the comments; or just merge it.

[marbemac]

🎉 This PR is included in version 1.2.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀