DigiLive/mushroom-strategy
1
0
Fork 1
mirror of https://github.com/DigiLive/mushroom-strategy.git synced 2025-08-04 20:14:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add typeguard isTargetableChip

Browse Source
This commit is contained in:
DigiLive
2025-04-27 10:35:04 +02:00
parent ba26cd127f
commit 016d94ed69
2 changed files with 26 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/chips/AbstractChip.ts
View File

@@ -1,7 +1,7 @@
import { HassServiceTarget } from 'home-assistant-js-websocket';
import { Registry } from '../Registry';
import { LovelaceChipConfig } from '../types/lovelace-mushroom/utils/lovelace/chip/types';
import { isCallServiceActionConfig } from '../types/strategy/strategy-generics';
import { isCallServiceActionConfig, isTargetableChip } from '../types/strategy/strategy-generics';
import { logMessage, lvlFatal, lvlWarn } from '../utilities/debug';
abstract class AbstractChip {
@@ -52,7 +52,7 @@ abstract class AbstractChip {
* @param {HassServiceTarget} target Target of the tap action.
*/
setTapActionTarget(target: HassServiceTarget) {
if ('tap_action' in this.configuration && isCallServiceActionConfig(this.configuration.tap_action)) {
if (isTargetableChip(this.configuration) && isCallServiceActionConfig(this.configuration.tap_action)) {
this.configuration.tap_action.target = target;
return;

32
src/types/strategy/strategy-generics.ts
View File

@@ -1,4 +1,3 @@
import { HassServiceTarget } from 'home-assistant-js-websocket';
import { AreaRegistryEntry } from '../homeassistant/data/area_registry';
import { DeviceRegistryEntry } from '../homeassistant/data/device_registry';
import { EntityRegistryEntry } from '../homeassistant/data/entity_registry';
@@ -7,7 +6,13 @@ import { LovelaceCardConfig } from '../homeassistant/data/lovelace/config/card';
import { LovelaceConfig } from '../homeassistant/data/lovelace/config/types';
import { LovelaceViewConfig, LovelaceViewRawConfig } from '../homeassistant/data/lovelace/config/view';
import { HomeAssistant } from '../homeassistant/types';
import { LovelaceChipConfig } from '../lovelace-mushroom/utils/lovelace/chip/types';
import {
BackChipConfig,
ConditionalChipConfig,
LovelaceChipConfig,
MenuChipConfig,
SpacerChipConfig,
} from '../lovelace-mushroom/utils/lovelace/chip/types';
import { StrategyHeaderCardConfig } from './strategy-cards';
/**
@@ -303,13 +308,24 @@ export function isCallServiceActionConfig(object?: ActionConfig): object is Call
}
/**
* Type guard to check if an object matches the HassServiceTarget interface.
*
* @param {any} [object] - The object to check.
* @returns {boolean} - True if the object represents a valid service action target.
* List of chip types that are not considered "targetable".
* These chips do not support tap_action or similar targeting logic.
*/
export function isCallServiceActionTarget(object?: HassServiceTarget): object is HassServiceTarget {
return !!object && ['entity_id', 'device_id', 'area_id'].some((key) => key in object);
const NON_TARGETABLE_CHIP_TYPES = ['back', 'menu', 'conditional', 'spacer'] as const;
/**
* Type guard to check if a LovelaceChipConfig is "targetable".
*
* A targetable chip supports actions like tap_action.
* This function excludes chips of type "back", "menu", "conditional", and "spacer".
*
* @param object - The chip configuration object to check.
* @returns True if the chip is targetable; false otherwise.
*/
export function isTargetableChip(
object: LovelaceChipConfig,
): object is Exclude<LovelaceChipConfig, BackChipConfig | MenuChipConfig | ConditionalChipConfig | SpacerChipConfig> {
return !NON_TARGETABLE_CHIP_TYPES.includes(object.type as (typeof NON_TARGETABLE_CHIP_TYPES)[number]);
}
/**