[pull] master from marmelab:master

[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Improve TypeScript type safety across core hooks, inference, and UI components; replace enum with string constants in Rich Text ColorButtons; bump TypeScript to 5.8.3 with erasableSyntaxOnly

Enhancements:

• Add type guard predicates (e.g., isUrl, isEmail, isDate) and enhance array predicate return types in assertion utilities
• Refactor usePreference and useStore hooks to use TypeScript overloads and explicit return types
• Replace ColorType enum in Rich Text ColorButtons with string constants and corresponding type
• Introduce explicit property declarations and assignments in HttpError and InferredElement classes
• Add explicit type annotations for inference functions’ parameters and cast GraphQL variable types in buildVariables
• Strengthen typing and default handling in useTrackScrollPosition, useTranslatable, usePreferenceInput, and localStorage store methods

Build:

• Bump TypeScript version to 5.8.3 and enable erasableSyntaxOnly compiler option

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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

[sourcery-ai]

Reviewer's Guide

This PR strengthens TypeScript typings across core utilities and hooks, simplifies internal enums, fixes subclass and inference patterns, updates GraphQL type casting, adjusts project configuration, and bumps TypeScript dependencies.

Updated Class Diagram for HttpError

classDiagram
  Error <|-- HttpError
  class HttpError {
    +status: any
    +body: any
    +constructor(message: string, status: any, body?: any)
  }
  class Error{
    <<Superclass>>
    message: string
  }

Loading

Class Diagram for assertions.ts Type Predicate Updates

classDiagram
  class TypeAssertions {
    <<Utility>>
    +isUrl(value: any): value is string
    +isImageUrl(value: any): value is string
    +isEmail(value: any): value is string
    +isArray(value: any): value is Array~any~
    +valuesAreArray(values: any[]): values is Array~any~[]
    +isDate(value: any): value is Date
    +valuesAreDate(values: any[]): values is Date[]
    +isDateString(value: any): value is string
    +valuesAreDateString(values: any[]): values is string[]
    +isObject(value: any): value is object
    +valuesAreObject(values: any[]): values is Array~object~
  }

Loading

Class Diagram for ColorButtons.tsx - ColorType Refactoring

classDiagram
  class ColorButtonsConstants {
    <<Constants>>
    FONT: "font"
    BACKGROUND: "background"
  }
  class ColorType {
    <<TypeAlias>>
    type: "font" | "background"
  }
  class ColorButtons {
    - colorType: ColorType
    - editor: any
    - translate: any
    - showColorChoiceDialog: boolean
    - setColorType: Function
    + displayColorChoiceDialog(type: ColorType): void
    + onClickFontButton(): void
    + onClickHighlightButton(): void
  }
  class ColorChoiceDialog {
    + editor: any
    + open: boolean
    + anchorEl: any
    + colorType: ColorType
    + onClose: Function
    + selectColor(color: string): void
  }
  ColorButtons ..> ColorType : uses
  ColorChoiceDialog ..> ColorType : uses
  ColorButtons ..> ColorButtonsConstants : uses
  ColorChoiceDialog ..> ColorButtonsConstants : uses

Loading

File-Level Changes

Change	Details	Files
Add precise type predicates to assertion functions	Convert isUrl, isImageUrl, isEmail to 'value is string' guards Update valuesAreX functions to narrow return types Refine isArray, isDate, isDateString, isObject signatures	packages/ra-core/src/inference/assertions.ts
Refactor usePreference and useStore hooks with overloads	Switch from arrow exports to overloaded function declarations Enforce mandatory key and defaultValue in signatures Refine generic return types and export style	packages/ra-core/src/preferences/usePreference.ts packages/ra-core/src/store/useStore.ts
Replace ColorType enum with constants and union type	Define FONT and BACKGROUND constants Use type alias instead of enum Update state defaults and event handlers to constants	packages/ra-input-rich-text/src/buttons/ColorButtons.tsx
Fix HttpError subclassing pattern	Declare status and body properties on the class Assign properties inside constructor	packages/ra-core/src/dataProvider/HttpError.ts
Declare class fields in InferredElement	Move type, props, children to class field declarations Simplify constructor to parameter assignment	packages/ra-core/src/inference/InferredElement.ts
Add explicit GraphQL type casting in buildVariables	Cast getFinalType results to IntrospectionType	packages/ra-data-graphql-simple/src/buildVariables.ts
Enhance useTrackScrollPosition hook typing	Add explicit generic argument Define return type signature	packages/ra-core/src/routing/useRestoreScrollPosition.ts
Update project TypeScript configuration	Add erasableSyntaxOnly to tsconfig.json Bump Typescript version in package.json	tsconfig.json package.json
Default selectedLocale to 'en' in i18n hook	Fallback selectedLocale to 'en' when undefined	packages/ra-core/src/i18n/useTranslatable.ts
Type-annotate inference function parameters	Explicitly type values parameters as any[] in inferElementFromValues Do the same in inferTypeFromValues	packages/ra-core/src/inference/inferElementFromValues.tsx packages/ra-core/src/inference/inferTypeFromValues.ts
Tighten usePreferenceInput signature	Require key parameter instead of optional Keep defaultValue optional	packages/ra-core/src/preferences/usePreferenceInput.ts
Adjust store getItem return types	Change getItem to return T	undefined Update interface and localStorageStore implementation
Refine PageTitleConfigurable conditional check	Check typeof titleFromPreferences==='string' instead of truthiness	packages/ra-ui-materialui/src/layout/PageTitleConfigurable.tsx

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.