Files
mushroom-strategy/src/views/VacuumView.ts
T
DigiLive b3ca5f94f9 Optimize types
The type definitions and interfaces of Home Assistant and Mushroom where
outdated. Also, the type definitions and interfaces of the strategy
could use some refinement.
2025-05-13 12:07:05 +02:00

81 lines
2.2 KiB
TypeScript

import {Helper} from "../Helper";
import {ControllerCard} from "../cards/ControllerCard";
import {AbstractView} from "./AbstractView";
import {views} from "../types/strategy/views";
import {cards} from "../types/strategy/cards";
import {generic} from "../types/strategy/generic";
import SupportedDomains = generic.SupportedDomains;
// noinspection JSUnusedGlobalSymbols Class is dynamically imported.
/**
* Vacuum View Class.
*
* Used to create a view for entities of the vacuum domain.
*
* @class VacuumView
* @extends AbstractView
*/
class VacuumView extends AbstractView {
/**
* Domain of the view's entities.
*
* @type {SupportedDomains}
* @static
* @private
*/
static #domain: SupportedDomains = "vacuum";
/**
* Default configuration of the view.
*
* @type {views.ViewConfig}
* @private
*/
#defaultConfig: views.ViewConfig = {
title: Helper.customLocalize("vacuum.vacuums"),
path: "vacuums",
icon: "mdi:robot-vacuum",
subview: false,
controllerCardOptions: {
iconOn: "mdi:robot-vacuum",
iconOff: "mdi:robot-vacuum-off",
onService: "vacuum.start",
offService: "vacuum.stop",
},
};
/**
* Default configuration of the view's Controller card.
*
* @type {cards.ControllerCardOptions}
* @private
*/
#viewControllerCardConfig: cards.ControllerCardOptions = {
title: Helper.customLocalize("vacuum.all_vacuums"),
subtitle:
`${Helper.getCountTemplate(VacuumView.#domain, "ne", "off")} ${Helper.customLocalize("vacuum.vacuums")} `
+ Helper.customLocalize("generic.busy"),
};
/**
* Class constructor.
*
* @param {views.ViewConfig} [options={}] Options for the view.
*/
constructor(options: views.ViewConfig = {}) {
super(VacuumView.#domain);
this.config = Object.assign(this.config, this.#defaultConfig, options);
// Create a Controller card to switch all entities of the domain.
this.viewControllerCard = new ControllerCard(
this.targetDomain(VacuumView.#domain),
{
...this.#viewControllerCardConfig,
...("controllerCardOptions" in this.config ? this.config.controllerCardOptions : {}) as cards.ControllerCardConfig,
}).createCard();
}
}
export {VacuumView};