feat: add support for AsyncAPI 2 and 3 in the split command

[tibisabau]

What/Why/How?

What: Added support for AsyncAPI 2.x and 3.x specifications to the split command, which previously only supported OpenAPI 3.x.

Why: To enable users to split AsyncAPI definition files into modular directory structures, similar to the existing OpenAPI functionality. This addresses issue #2352.

How:

• Extended type definitions to include AsyncAPI 2 and 3 component names (schemas, messages, parameters, channels, operations, etc.)
• Implemented splitAsyncApiDefinition() orchestrator function to handle both AsyncAPI versions
• Added iterateAsyncApiChannels() to split channels into separate files with proper $ref replacements
• Implemented iterateAsyncApiOperations() for AsyncAPI 3 operations splitting
• Created iterateAsyncApiComponents() to handle component extraction with version-specific logic
• Enhanced spec detection in validateDefinitionFileName() to recognize AsyncAPI documents

Reference

Resolves #2352

Testing

• Created test fixtures: tests/e2e/split/asyncapi2-basic/asyncapi.yaml and tests/e2e/split/asyncapi3-basic/asyncapi.yaml
• Ran unit test suite
• Manual verification: Successfully split both AsyncAPI 2 and 3 documents into proper directory structures with correct $ref resolution
• TypeScript compilation passed with no errors
• Code formatted with Prettier

Screenshots (optional)

N/A - CLI functionality

Check yourself

• Code changed? - Tested with Redoc/Realm/Reunite (internal)
• All new/updated code is covered by tests
• New package installed? - Tested in different environments (browser/node)
• Documentation update considered

Security

• The security impact of the change has been considered
• Code follows company security practices and guidelines

[changeset-bot]

🦋 Changeset detected

Latest commit: ac4ad1b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor
@redocly/respect-core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[DmitryAnansky]

@tibisabau
Could you please consider adding happy-path unit tests for the newly added functions?
Alternatively, we could loosen the test coverage requirements for now.

[DmitryAnansky]

@tibisabau
Thanks for adding the e2e examples — they look great!
Could you please add one more e2e example with a more complex structure to help verify that it works well with more advanced specs?

[DmitryAnansky]

@tibisabau
Could you please review the splitted result for operations.
Seems like there is an issue, currently the command produced refs that can't be resolved.
I tested on your complex example and it works well for channels and components, but operations seems to be broken.
e.g. =>

action: receive
channel:
  $ref: '#/channels/userLoggedIn'
messages:
  - $ref: '#/channels/userLoggedIn/messages/UserLoggedIn'

[DmitryAnansky]

I did it with
npm run cli split async3_complex.yaml -- --out-dir=result_split
and you can see with the Redocly VSCode extension or lint results that reference can't be resolved:
npm run cli lint result_split/asyncapi.yaml

[DmitryAnansky]

@tibisabau
Thank you for fixing the issue related to splitted operations.
Could you please also check other defined component objects in Async?

I was able to find similar issues when I make changes to the complex example( add other component objects) related to :

• securitySchemes
• servers
  ...etc

Please check other components and update your complex example.

[DmitryAnansky]

@tibisabau
I’ve found another issue with the Async split, related to the replies component object.
It appears to have a similar problem when it’s split.

  replies:
    DeviceCommandReply:
      address:
        $ref: '#/components/replyAddresses/DeviceCommandReplyAddress'
      channel:
        $ref: '#/channels/deviceCommandReply'
      messages:
        - $ref: '#/channels/deviceCommandReply/messages/CommandResponse'

Splitted file have unresolved references for channels and messages:

address:
  $ref: ../replyAddresses/DeviceCommandReplyAddress.yaml
channel:
  $ref: '#/channels/deviceCommandReply'
messages:
  - $ref: '#/channels/deviceCommandReply/messages/CommandResponse'

Could you please take a look, and add this to the complex example test sample.
Thank you.