feat: add object and propName to onDereference callback

toomuchdesign commented 11 months ago

This is an implementation proposal to add 2 new arguments to dereference.onDereference options.

The 2 new arguments are:

parent: The parent of the dereferenced object
parentPropName: The prop name of the parent object whose value was dereferenced

In other words: the current 2nd onDereference argument (the inlined schema) would be the result of object[propName].

Extra info

Exposing a callback with 4 arguments is probably sub optimal in terms of API. In a next major release the callback could be refactored to accept an object to provide named arguments.

The idea behind this PR was born while developing openapi-ts-json-schema, where json-schema-ref-parser's onDereference callback is used to append meta data to the dereferenced objects. This would sensibly provide more flexibility and power to the callback.

I'm aware it could be quite niche use case and I'll be fine whatever decision you are going to take about this PR. Happy to update this PR based on you feedback, if the case.

Thank you so much for the priceless work you are doing here! 🙌 Cheers!