[WEB-4025] Rectify IconName type generation

[jamiehenson]

Jira Ticket Link / Motivation

Very small fix. After this PR, the IconName type wasn't being created quite right, I found this when using the package in Voltaire.

This change allows IconName to be generated from the constructed iconNames object, instead of from the underlying generated JSON. I'm not quite sure why the other approach didn't work and this does, but I'll leave that to the mystery of TypeScript. A guess would be because the JSON file isn't TypeScript and so TSC has less visibility over it.

Summary of changes

How do you manually test this?

Reviewer Tasks (optional)

Merge/Deploy Checklist

• Written automated tests for implemented features/fixed bugs
• Rebased and squashed commits
• Commits have clear descriptions of their changes
• Checked for any performance regressions

Frontend Checklist

• No frontend changes in this PR
• Added before/after screenshots for changes
• Tested on different platforms/browsers with Browserstack
• Compared with the initial design / our brand guidelines
• Checked the code for accessibility issues (VoiceOver User Guide)?

Summary by CodeRabbit

• New Features

  • Updated version number to 14.7.1 for improved version tracking.

• Refactor

  • Changed the source of the IconName type definition from computedIcons to iconNames, while retaining the same properties.

[coderabbitai]

Walkthrough

The pull request includes updates to the package.json file for the @ably/ui project, changing the version number from 14.7.0 to 14.7.1. Additionally, the IconName type declaration in src/core/Icon/types.ts has been modified to derive its values from the iconNames object instead of the computedIcons object, while keeping the same set of properties.

Changes

File	Change Summary
package.json	Version updated from 14.7.0 to 14.7.1.
src/core/Icon/types.ts	IconName type updated to derive values from iconNames instead of computedIcons.

Possibly related PRs

• [WEB-3979] Additional modification props for Encapsulated icons #488: This PR also updates the package.json file, specifically changing the version number, which is directly related to the version update in the main PR.
• [WEB-4041] Bump to 14.6.9, update pricing and consumption cards copy #511: Similar to the main PR, this PR updates the package.json file to change the version number, indicating a connection through version management.
• [WEB-4025] Autogenerate icon manifests #512: This PR modifies the src/core/Icon/types.ts file, which is relevant as the main PR also changes the IconName type in the same file, indicating a direct relationship in the context of icon type definitions.

Suggested reviewers

• kennethkalmer
• aralovelace

🐇 In the garden, I hop and play,
With version numbers on display.
From fourteen point seven, I take a leap,
To fourteen point one, in code we keep!
Icons shift, but all stays bright,
In our project, everything feels right! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 960dbd2 and 8599033.

📒 Files selected for processing (2)

• package.json (1 hunks)
• src/core/Icon/types.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• package.json
• src/core/Icon/types.ts

---

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/core/Icon/types.ts (1)

12-18: LGTM! Consider adding a comment for clarity.

The change from computedIcons to iconNames in the IconName type definition is a good refactor. It improves code organization by using the explicitly defined iconNames object, which is more descriptive and consistent with the file's structure.

Consider adding a brief comment explaining the purpose of this type definition and its relationship to the iconNames object. This could improve code maintainability. For example:

/**
 * Defines all possible icon names across different categories.
 * This type is derived from the keys of the `iconNames` object.
 */
export type IconName =
  | (typeof iconNames.gui)[number]
  | (typeof iconNames.display)[number]
  | (typeof iconNames.social)[number]
  | (typeof iconNames.other)[number]
  | (typeof iconNames.tech)[number]
  | (typeof iconNames.product)[number];

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8ef79cc and 960dbd2.

📒 Files selected for processing (2)

• package.json (1 hunks)
• src/core/Icon/types.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• package.json

🧰 Additional context used

[kennethkalmer]

I'm not quite sure why the other approach didn't work and this does, but I'll leave that to the mystery of TypeScript. A guess would be because the JSON file isn't TypeScript and so TSC has less visibility over it.