feat: add onBundle callback

[aeworxet]

This PR adds functionality, as well as an options object, for the bundle method, which consists of:

• The onBundle callback.
• The excludedPathMatcher callback.

Closes #346

[aeworxet]

This functionality mimics the onDereference callback along with the test, which is likely why the test fails: the bundle method should have different test conditions.

@jonluca, could you please advise what the test should be?

[jonluca]

Hello,

The logic looks sound, I think you just need to fix the test comparison. The bundle traversal is stable, right? The tests aren't failing based on platform, so just make sure yarn test returns 100% on your local machine.

[aeworxet]

Manual execution has shown that correct $refs are pushed to calls array, but vitest's expect operates on the changed $refs, which is why the test fails.
The debugger showed that the alteration of the $refs is the responsibility of the remap() function.
With remap() commented out, the $refs don't get altered before the app finishes execution, and the test passes.

I'm wary of saying that this is a bug in the remap() function because someone would already have noticed such an obvious difference in expected results, and, additionally, I get correct results when using my production app.

@jonluca, could you please clarify whether this behavior of remap() is specific to vitest and testing conditions, or if it is still a flaw in remap()'s execution?

[jonluca]

this is missing a comma and closing quote

[jonluca]

That is not the issue, the issue is that there is a syntax error in your code. https://github.com/APIDevTools/json-schema-ref-parser/pull/391/files#r2181747158

The original error is that your deep expect is incorrect. https://github.com/APIDevTools/json-schema-ref-parser/actions/runs/16018336530/job/45189942210

If you fix the hardcoded object it should pass.

Please run the tests locally before submitting an update and verify they all succeed.

[aeworxet]

Apologies, I didn't push the test I was debugging.
With this version of the test, I get correct results with my production app, but a failing test with yarn test.

screenshots

[jonluca]

Awesome, can you remove the console log? Otherwise looks good

[aeworxet]

Removed.

[aeworxet]

There it is: a failed test.
With remap() commented out, the $refs don't get altered before the app finishes execution, and the test passes.

[jonluca]

Can you change the test to just calls.push(JSON.parse(JSON.stringify({ path, value, parent, parentPropName }))); instead, to keep it stable?

Modifying the refs is how the internal bundler works, it's up to the caller of the onBundle passer to know that. Or we could change the caller of onBundle to pass a new version of the objects as well.