docs: update types and documentation

[jboix]

Description

Resolves #216 by enhancing type constraints and definitions.

This update provides improved type constraints and definitions, allowing developers to leverage stronger type checking. Integrators using typescript will also benefit from the stronger type checking.

For better control over types they are now defined in standalone typescript file instead of using jsdoc generation. Some types are still completed using jsdoc.

Changes made

• Migrate existing jsdoc type definitions to typescript.
• Added types for the MediaComposition generated from the Swagger API definition.
• Defined types for all existing components.
• Added better-docs as a dev dependency to accurately parse TypeScript documentation for API site generation.

[github-actions[bot]]

PR Preview Action v1.4.7 :---: Preview removed because the pull request was closed. 2024-03-06 08:15 UTC

[github-actions[bot]]

Coverage report

St.:grey_question:	Category	Percentage	Covered / Total
🟢	Statements	98.78%	569/576
🟢	Branches	95.55%	279/292
🟢	Functions	99.39%	162/163
🟢	Lines	99.27%	541/545

Test suite run success

186 tests passing in 9 suites.

Report generated by 🧪jest coverage report action from 6ab270712ddf0e858dd7b0397593451074767a58

[github-actions[bot]]

:tada: This PR is included in version 1.3.0 :tada:

The release is available on:

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

Your semantic-release bot :package::rocket: