RobinTail / zod-sockets / 8442874013 / 2

100%

main: 100%

push

github

FEAT: Using AsyncAPI for generating documentation (#81)

* Preparing the interfaces and draft builder.

* Corrections to the AsyncMessageObject::payload type.

* Descriptions for AsyncChannelObject fields and removing redundant BaseParameterObject.

* Making base document to have empty channels.

* Ref: only using types of openapi3-ts package.

* Partially adopting documentation helpers: no examples, no date, no custom errors, no lazy, no references.

* FEAT: fist functional draft.

* AsyncAPI validation workflow.

* Add channel bindings.

* Fix: moving todo.

* Introducing protocol constraints.

* Fix EIO param type.

* More jsdoc.

* Fix date transformation.

* Hack: tuples as numerically indexed objects.

* Add unique messageId (fixed warning).

* Add operationId.

* Adding title to the messages.

* Add defaultContentType.

* Add draft documenent ID by URN spec.

* Add other recommended fields.

* Automatic secure protocol detection.

* Handle the rest on tuples.

* Ref: easier secure protocol detection.

* Implementing acknowledgements by extending bindings for Socket.IO.

* Sorting out bindingVersion.

* Combining files.

* Reducing nesting.

* Switching to the custom protocol completely.

* Correction on query params of the Engine.IO protocol.

* Adding handshake path to the example.

* Adjusting URN and arranging the metadata.

* Testing documentation helpers and removing some redundant code.

* Moving tests for common helpers.

* Improving intersection coverage.

* Basic documentation test.

* Testing bending version.

* Removing redundant methods from builder.

* Builder test.

* Feat: Exposing Documentation.

* Update src/documentation.spec.ts

* Second basic test.

* Complete basic tests.

* Restoring the coverage.

* Readme: tech stack update.

* Readme: listing the feature.

* Changelog: 0.11.0.

* Notice of tuples.

* Fix handshake path.

* ... (continued)

236 of 262 branches covered (90.08%)

452 of 452 relevant lines covered (100.0%)

41.8 hits per line