Add preview to Threshold config & option flow

[jpbede]

Proposed change

Add the preview function to the Threshold helper config flow and option flow

Core PR: home-assistant/core#111043 home-assistant/core#117181

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• New Features

  • Introduced threshold preview functionality for home assistant environments.
  • Added a custom element for previewing thresholds in a flow with user-friendly interface and error handling.

• Improvements

  • Enhanced data subscription for threshold previews with new parameters and a promise-based return type.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new module for threshold previews in a Home Assistant environment and a new custom element for threshold flow previews. The threshold preview functionality includes subscribing to updates and handling preview data. The custom element FlowPreviewThreshold provides an interface for previewing thresholds, displaying errors, and managing updates, enhancing user interaction.

Changes

Files / Directories	Summary of Changes
src/data/threshold.ts	Added new file for subscribing to threshold previews with interfaces and a subscription function.
.../config-flow/previews/flow-preview-threshold.ts	Added new custom element for previewing thresholds in a flow, with various properties and state changes for handling previews and errors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlowPreviewThreshold
    participant ThresholdAPI
    participant HomeAssistant

    User ->>+ FlowPreviewThreshold: Interact with preview
    FlowPreviewThreshold ->>+ ThresholdAPI: subscribePreviewThreshold(flow_id, flow_type, user_input, callback)
    ThresholdAPI ->>+ HomeAssistant: Subscribe to preview updates
    HomeAssistant ->>- ThresholdAPI: Return unsubscribable function
    ThresholdAPI ->>- FlowPreviewThreshold: Return unsubscribable function
    
    Note over FlowPreviewThreshold: Handle updates, display previews, or show errors

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 6e78c28 and 242ad55.

Files selected for processing (2)

• src/data/threshold.ts (1 hunks)
• src/dialogs/config-flow/previews/flow-preview-threshold.ts (1 hunks)

Additional context used

Biome

src/data/threshold.ts

[error] 6-6: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

---

[error] 13-13: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

src/dialogs/config-flow/previews/flow-preview-threshold.ts

[error] 26-26: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

---

[error] 91-91: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

Additional comments not posted (2)

src/data/threshold.ts (1)

9-21: Well-implemented subscription logic.

The function subscribePreviewThreshold is well implemented, handling the subscription logic to the threshold previews effectively. Ensure that the websocket connection and message types are correctly configured in the backend to match these frontend expectations.

Tools

Biome

[error] 13-13: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

src/dialogs/config-flow/previews/flow-preview-threshold.ts (1)

34-101: Well-implemented lifecycle and preview subscription logic.

The methods including disconnectedCallback, willUpdate, and _subscribePreview are well implemented, handling component lifecycle and subscription logic effectively. Ensure that the backend appropriately supports the operations expected here, especially the error handling and event firing.

Tools

Biome

[error] 91-91: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 4

[frenck]

Backend merged.