Fix all typedoc warnings

[zefir-git]

No description provided.

[coderabbitai]

Walkthrough

This change updates the visibility and public API of several type aliases and utility types across multiple modules. In src/Component.ts, the type aliases ElementToTagName and HtmlTagString are now exported, making them accessible outside the module. Similarly, in src/ElementComponent.ts, the utility types WritableKeys and ReadableKeys are exported. Additionally, a JSDoc comment for the replaceClass method is clarified, and the JSDoc tag for DocumentComponent.tag is changed from @warning to @remarks in src/DocumentComponent.ts, with no effect on implementation. In src/index.ts, the new exports are added to the main public API, ensuring ReadableKeys, WritableKeys, ElementToTagName, and HtmlTagString are available for external use.

Possibly related PRs

• Fix export order #19: Updates the order of exports in src/index.ts, which is related to changes in export statements but does not add or modify exported entities.
• Prevent type expansion in docs #18: Introduces and modifies the HtmlTagString type and updates the Component.from method signature in src/Component.ts, directly relating to the types exported in this PR.

Suggested reviewers

• kai-gitt

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 710230d and 515d75b.

📒 Files selected for processing (4)

• src/Component.ts (1 hunks)
• src/DocumentComponent.ts (1 hunks)
• src/ElementComponent.ts (3 hunks)
• src/index.ts (1 hunks)

🔇 Additional comments (7)

src/Component.ts (2)

19-21: Good improvement to public API surface

Exporting the ElementToTagName utility type enhances the library's public API by making this type accessible to consumers. This is particularly valuable since this type is used in the Component constructor parameter and would be needed for proper TypeScript typing when using the library.

---

23-25: Proper export of HtmlTagString type

Exporting the HtmlTagString type correctly exposes an important part of the API that's used in the Component.from static method. This change ensures that library consumers have access to all necessary type definitions, improving the developer experience and type safety.

src/DocumentComponent.ts (1)

31-32: Improved JSDoc tag usage

Converting from @warning to the standard @remarks tag is a good change that maintains the same semantic meaning while adhering to JSDoc standards. This will ensure the warning about XSS vulnerabilities is properly displayed in generated documentation.

src/ElementComponent.ts (3)

22-30: Good export of WritableKeys utility type

Exporting the WritableKeys type enhances the public API by making this utility type available to consumers. Since this type is used in the set method signature, exposing it allows developers to better understand the API constraints.

🧰 Tools

🪛 Biome (1.9.4)

[error] 29-29: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

---

35-37: Appropriate export of ReadableKeys type

Exporting the ReadableKeys type is a good addition to the public API. This type is used in the get method signature, and making it public improves type documentation and developer understanding of the API.

🧰 Tools

🪛 Biome (1.9.4)

[error] 36-36: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

---

109-110: Improved parameter reference formatting

Changing from {@link oldClasses} to inline code formatting with backticks is the correct approach. The {@link} tag is meant for referencing other documented entities, while parameters are better formatted with code backticks.

src/index.ts (1)

20-21: Complete exports of utility types

Adding the newly exported types to the main index file ensures they're properly accessible as part of the public API. This change correctly exposes ReadableKeys, WritableKeys, ElementToTagName, and HtmlTagString to library consumers, completing the public API surface improvements.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[zefir-git]

@CodeRabbit how does this PR affect semver

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@zefir-git This PR should result in a MINOR version increment according to semver.

The changes expose previously internal types (ElementToTagName, HtmlTagString, WritableKeys, and ReadableKeys) by making them part of the public API. In semantic versioning:

• Adding new exports to the public API, even when they're just TypeScript types, warrants a MINOR version bump as it extends functionality in a backward-compatible way.
• The JSDoc changes alone would only require a PATCH increment, but the API expansion takes precedence.

Since you're not removing or modifying existing functionality in a breaking way, a MAJOR version increment is not needed.

🐰 thoughtfully scribbles in notebook

---

✏️ Learnings added

Learnt from: zefir-git
URL: https://github.com/cloudnode-pro/components/pull/77

Timestamp: 2025-04-27T21:05:12.706Z
Learning: For the cloudnode-pro/components repository, adding new type exports to the public API is considered a MINOR version increment according to semantic versioning, as it extends the API surface in a backward-compatible way.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.