chore: merge master into next-major-spec + fix bug in bundler

[smoya]

Description

This PR, besides merging master into next-major-spec, does the following:

• Fixes a bug in the bundler to -without-$id where $ref pointing to definitions without .json extension fail. For example, "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/title" like the OperationTrait in v3 has now
• It adds support for bindings $id to without-$id transformation. For example http://asyncapi.com/bindings/mqtt/0.1.0/operation.json to bindings-mqtt-0.1.0-operation.

Both matching are now done through regex, since there is no easy silver bullet solution without doing tons of hacks.

Pinging @derberg who made the changes in the bundler for creating schemas without $id. So I expect you can review my last commits where the fix is done.

Warning
Manually merge and not rebase!

[smoya]

@derberg @jonaslagoni I need some help debugging what's the issue with the produced 3.0.0-without-$id.json.
Here you can find the validator error: https://www.jsonschemavalidator.net/s/3OO3lvSb

Could not resolve schema reference '#/operation#/properties/title'. Path 'definitions.operationTrait.properties.title', line 4675, position 26.

However, in the 3.0.0.json file, things like "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/title" do work.

[derberg]

Interesting, it is only with operationTrait, not a serious stuff imho

the oryginal schema has http://asyncapi.com/definitions/3.0.0/operation.json#/properties/title and the no-id bundler is dummy and replace http://asyncapi.com/definitions/3.0.0/operation.json with a local reference. So simple fix is just have an if that if there is a url with anchors, then not only http://asyncapi.com/definitions/3.0.0/operation.json but http://asyncapi.com/definitions/3.0.0/operation.json# should be replaced new local reference so it looks like "$ref": "#/definitions/operation/properties/title"

[smoya]

"$ref": "#/definitions/operation/properties/title"

@derberg The issue is with JSON pointer here and the fact we should scape / characters with ~1, which doesn't look pretty good from DX perspective.

I decided to use - instead now (See the last commit I pushed). For example,http://asyncapi.com/bindings/http/0.1.0/message.json in regular file is bindings-http-0.1.0-message in -without-$id file.

I also added support for testing and validating the schemas without $id which was not added before.

[derberg]

@smoya I don't get why you need ~1? we use it in parser-js only if we need to handle encoding of / in the channel names that may have it. But in case of stuff like "#/definitions/operation/properties/title" there is no need to do any tilde encoding really 🤔

[smoya]

@smoya I don't get why you need ~1? we use it in parser-js only if we need to handle encoding of / in the channel names that may have it. But in case of stuff like "#/definitions/operation/properties/title" there is no need to do any tilde encoding really 🤔

My bad for the confusing explanation. Gonna try again.

1. Bug with #/operation#/properties/title

The issue was that the extra # was not required. That's fixed, and now it is #/operation/properties/title.

2. Bug with definition ids with / characters

Ids can have extra / characters. That's the case for the bindings, for example, where you can find things like http://asyncapi.com/bindings/mqtt/0.1.0/operation.json.
If we convert that to bindings/mqtt/0.1.0/operation, then references will need to use ~, such as "#/definitions/bindings~1mqtt~10.1.0~1operation". Otherwise, the JSON Pointer will try to find in the path definitions.bindings.mqtt.0.1.0.operation. Meaning it will only work if a definition like the following is in the file (which is not our case):

 "bindings": {
            "mqtt": {
                "0.1.0": {
                    "operation": {
                        "type": "object"
                    }
                }   
            }
        },

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[derberg]

"0.1.0

ah yeah, makes a lot of sense

[asyncapi-bot]

🎉 This PR is included in version 6.0.0-next-major-spec.1 🎉

The release is available on:

• npm package (@next-major-spec dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[asyncapi-bot]

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀