Mark deprecated components as deprecated using JSDoc/TypeScript

[bradenmacdonald]

Description

On the docs site, many components are marked as deprecated:

This PR updates the types so that those same components will appear as deprecated if used in an IDE:

As you can see, the message about the replacement components is also shown in by VS Code.

Deploy Preview

No discernible changes to the docs site.

Merge Checklist

n/a

Post-merge Checklist

• Verify your changes were released to NPM at the expected version.
• If you'd like, share your contribution in #show-and-tell.
• 🎉 🙌 Celebrate! Thanks for your contribution.

[openedx-webhooks]

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/paragon-working-group. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[netlify]

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	c8035c0
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/670033d914984c0008961c51
😎 Deploy Preview	https://deploy-preview-3240--paragon-openedx.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.27%. Comparing base (020ae21) to head (c8035c0).
Report is 77 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3240   +/-   ##
=======================================
  Coverage   93.27%   93.27%           
=======================================
  Files         249      249           
  Lines        4401     4401           
  Branches     1037     1002   -35     
=======================================
  Hits         4105     4105           
- Misses        290      293    +3     
+ Partials        6        3    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[PKulkoRaccoonGang]

Thank you! I am sure this will be very useful for consumers! 💯

[bradenmacdonald]

Thanks for the quick review @PKulkoRaccoonGang !

[openedx-semantic-release-bot]

🎉 This PR is included in version 22.9.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[openedx-semantic-release-bot]

🎉 This PR is included in version 23.0.0-alpha.7 🎉

The release is available on:

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

Your semantic-release bot 📦🚀