feat(theme): optimize ApiList calls and use data loader for Api organism

[Romakita]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced dynamic loading and processing of API data, enhancing the <Api /> component's data binding.
  • Added new mapping functions for API references to streamline data transformation.

• Bug Fixes

  • Improved error handling in the <ApiList /> component to prevent runtime errors.

• Style

  • Updated styles for the search component to enhance visual presentation and responsiveness.

• Chores

  • Increased coverage thresholds for tests to ensure higher quality assurance standards.

[coderabbitai]

Warning

Rate limit exceeded

@Romakita has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 84cccf4 and 5e5e4a2.

Walkthrough

The pull request introduces several changes, including the addition of new files and modifications to existing ones. A new file api.data.ts is created to handle API data loading and processing in VitePress, defining an interface Data and a loader function. The docs/api.md file is updated to bind dynamic data to the <Api /> component. Additional changes include new functions in mapApiReferences, modifications to the useApiContent logic, and updates to various components and tests to accommodate these changes.

Changes

File	Change Summary
docs/api.data.ts	Introduced a new file with an interface Data, a constant data, and a default loader for JSON data.
docs/api.md	Replaced static <Api /> component data with dynamic binding from api.data.
docs/interface.test.ts	Added a new empty interface ApiResponse.
packages/theme/composables/api/mappers/mapApiReferences.d.ts	Introduced two new functions: mapSymbol and mapApiReferences.
packages/theme/composables/api/mappers/mapApiReferences.js	Created a new file with implementations for mapSymbol and mapApiReferences.
packages/theme/composables/api/useApiContent.ts	Added caching logic and replaced mapSymbol with mapApiReferences in the data mapping process.
packages/theme/composables/api/useApiLink.ts	Changed the logic to use only apiRedirectUrl for constructing URLs.
packages/theme/molecules/api-anchor/ApiAnchorQuery.spec.ts	Updated import statement for mapSymbol to reflect its new location.
packages/theme/molecules/api-list/ApiList.vue	Enhanced error handling in computed property using optional chaining.
packages/theme/organisms/api/Api.spec.ts	Updated test setup to use mapApiReferences for rendering the <Api /> component.
packages/theme/organisms/api/Api.stories.ts	Modified the story to use dynamic data from mapApiReferences.
packages/theme/organisms/api/Api.vue	Streamlined component logic and removed unnecessary state checks.
packages/theme/organisms/github-contributors/GithubContributors.stories.ts	Commented out the color property in the Storybook configuration.
packages/theme/styles/algolia.css	Modified styles for the .DocSearch component to improve visual presentation.
vitest.config.ts	Updated coverage thresholds for statements, branches, functions, and lines.

Possibly related PRs

• fix(theme): fix exports defined in package.json #100: The changes in the main PR involve the introduction of a new file api.data.ts that defines an interface Data extending ApiResponse, which is also referenced in the retrieved PR that adds a new interface ApiResponse in docs/interface.test.ts. This indicates a direct connection through the shared use of the ApiResponse interface.

Poem

In the meadow where data flows,
New interfaces and loaders grow.
With symbols mapped and links refined,
A vibrant API we now can find.
So hop along, let’s celebrate,
These changes make our code first-rate! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Romakita]

🎉 This PR is included in version 1.2.0 🎉

The release is available on:

• v1.2.0
• GitHub release

Your semantic-release bot 📦🚀