@digital-alchemy/hass 24.11.4 → 25.2.1

package/src/dynamic.mts

@@ -2,7 +2,6 @@
 /* eslint-disable sonarjs/redundant-type-aliases */
 /* eslint-disable @cspell/spellchecker */
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-/* eslint-disable sonarjs/no-redundant-type-constituents */
 /* eslint-disable @typescript-eslint/no-empty-object-type */
 
 // @ts-nocheck
@@ -14,6 +13,7 @@ import {
   NotificationData,
   PICK_ENTITY,
 } from "./helpers/index.mts";
+import { DynamicMergeAttributes } from "./merge.mts";
 
 type PICK_FROM_PLATFORM<ID extends TPlatformId, DOMAIN extends TRawDomains = TRawDomains> = Extract<
   REGISTRY_SETUP["platform"][`_${ID}`],
@@ -25,16 +25,17 @@ export type ENTITY_SETUP = {
   "button.example": {
     state: string;
     entity_id: "button.example";
-    attributes: {
-      friendly_name: "Example button";
-    };
+    attributes: DynamicMergeAttributes<"button.example", { friendly_name: "Example button" }>;
   };
   "binary_sensor.hass_e2e_online": {
-    attributes: {
-      friendly_name: "hass_e2e online";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "binary_sensor.hass_e2e_online",
+      {
+        friendly_name: "hass_e2e online";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSBGW129NV7WY8MMG1E";
       parent_id: null;
@@ -45,119 +46,134 @@ export type ENTITY_SETUP = {
     state: "unavailable";
   };
   "binary_sensor.toggles": {
-    attributes: {
-      friendly_name: "toggles";
-      icon: "mdi:toggle-switch-variant-off";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "binary_sensor.toggles",
+      {
+        friendly_name: "toggles";
+        icon: "mdi:toggle-switch-variant-off";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSB43FF1R6FX0QEE4Z6";
       parent_id: null;
       user_id: null;
     };
     entity_id: "binary_sensor.toggles";
-
     state: "unavailable";
   };
   "calendar.united_states_tx": {
-    attributes: {
-      all_day: true;
-      description: "";
-      end_time: "2024-05-28 00:00:00";
-      friendly_name: "United States, TX";
-      location: "United States, TX";
-      message: "Memorial Day";
-      start_time: "2024-05-27 00:00:00";
-    };
+    attributes: DynamicMergeAttributes<
+      "calendar.united_states_tx",
+      {
+        all_day: true;
+        description: "";
+        end_time: "2024-05-28 00:00:00";
+        friendly_name: "United States, TX";
+        location: "United States, TX";
+        message: "Memorial Day";
+        start_time: "2024-05-27 00:00:00";
+      }
+    >;
     context: {
       id: "01HWXTYEEFBB7QQC1CSM6PAR36";
       parent_id: null;
       user_id: null;
     };
     entity_id: "calendar.united_states_tx";
-
     state: "off";
   };
   "light.bedroom_ceiling_fan": {
-    attributes: {
-      brightness: null;
-      color_mode: null;
-      color_temp: null;
-      color_temp_kelvin: null;
-      friendly_name: "Bedroom Ceiling Fan";
-      hs_color: null;
-      icon: "mdi:lightbulb-group";
-      max_color_temp_kelvin: 6535;
-      max_mireds: 500;
-      min_color_temp_kelvin: 2000;
-      min_mireds: 153;
-      rgb_color: null;
-      supported_color_modes: ["color_temp", "xy"];
-      supported_features: 40;
-      xy_color: null;
-    };
+    attributes: DynamicMergeAttributes<
+      "light.bedroom_ceiling_fan",
+      {
+        brightness: null;
+        color_mode: null;
+        color_temp: null;
+        color_temp_kelvin: null;
+        friendly_name: "Bedroom Ceiling Fan";
+        hs_color: null;
+        icon: "mdi:lightbulb-group";
+        max_color_temp_kelvin: 6535;
+        max_mireds: 500;
+        min_color_temp_kelvin: 2000;
+        min_mireds: 153;
+        rgb_color: null;
+        supported_color_modes: ["color_temp", "xy"];
+        supported_features: 40;
+        xy_color: null;
+      }
+    >;
     context: {
       id: "01HX722Y1JFS6KN2MDERK0VJ2D";
       parent_id: null;
       user_id: null;
     };
     entity_id: "light.bedroom_ceiling_fan";
-
     state: "off";
   };
   "person.digital_alchemy": {
-    attributes: {
-      device_trackers: [];
-      editable: true;
-      friendly_name: "digital-alchemy";
-      id: "digital_alchemy";
-      user_id: "4dd1cf7e93e94f3fbaf419501f9a3d59";
-    };
+    attributes: DynamicMergeAttributes<
+      "person.digital_alchemy",
+      {
+        device_trackers: [];
+        editable: true;
+        friendly_name: "digital-alchemy";
+        id: "digital_alchemy";
+        user_id: "4dd1cf7e93e94f3fbaf419501f9a3d59";
+      }
+    >;
     context: {
       id: "01HWXTSCSBRKJ9T2KV1JNER5KQ";
       parent_id: null;
       user_id: null;
     };
     entity_id: "person.digital_alchemy";
-
     state: "unknown";
   };
   "scene.games_room_auto": {
-    attributes: {
-      "Managed By": "home_automation";
-      friendly_name: "bedroom off";
-    };
+    attributes: DynamicMergeAttributes<
+      "scene.games_room_auto",
+      {
+        "Managed By": "home_automation";
+        friendly_name: "bedroom off";
+      }
+    >;
     context: {
       id: "01HWXW289S8HP5MSGNNTNB2CBG";
       parent_id: null;
       user_id: null;
     };
     entity_id: "scene.games_room_auto";
-
     state: "unknown";
   };
   "sensor.magic": {
-    attributes: {
-      friendly_name: "magic";
-      icon: "mdi:satellite-uplink";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.magic",
+      {
+        friendly_name: "magic";
+        icon: "mdi:satellite-uplink";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSBW34BP3R20RJ09CVZ";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.magic";
-
     state: string;
   };
   "sensor.sun_next_dawn": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next dawn";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_dawn",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next dawn";
+      }
+    >;
     context: {
       id: "01HWXTS8W1SRTPT5K1XM0G491X";
       parent_id: null;
@@ -168,133 +184,152 @@ export type ENTITY_SETUP = {
     state: "2024-05-03T03:24:45+00:00";
   };
   "sensor.sun_next_dusk": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next dusk";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_dusk",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next dusk";
+      }
+    >;
     context: {
       id: "01HWXTS8W1S95P1MVHDGHSQEB2";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.sun_next_dusk";
-
     state: "2024-05-03T19:51:10+00:00";
   };
   "sensor.sun_next_midnight": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next midnight";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_midnight",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next midnight";
+      }
+    >;
     context: {
       id: "01HWXTS8W1YQCPA3WZ69Y9JSPD";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.sun_next_midnight";
-
     state: "2024-05-03T23:37:12+00:00";
   };
   "sensor.sun_next_noon": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next noon";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_noon",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next noon";
+      }
+    >;
     context: {
       id: "01HWXTS8W28MVV48CQ31JB2WKC";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.sun_next_noon";
-
     state: "2024-05-03T11:37:19+00:00";
   };
   "sensor.sun_next_rising": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next rising";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_rising",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next rising";
+      }
+    >;
     context: {
       id: "01HWXTS8W2MMADKGWE4A5BMH51";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.sun_next_rising";
-
     state: "2024-05-03T04:05:17+00:00";
   };
   "sensor.sun_next_setting": {
-    attributes: {
-      device_class: "timestamp";
-      friendly_name: "Sun Next setting";
-    };
+    attributes: DynamicMergeAttributes<
+      "sensor.sun_next_setting",
+      {
+        device_class: "timestamp";
+        friendly_name: "Sun Next setting";
+      }
+    >;
     context: {
       id: "01HWXTS8W24KWTHR2B6V32NCXG";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sensor.sun_next_setting";
-
     state: "2024-05-03T19:10:21+00:00";
   };
   "sun.sun": {
-    attributes: {
-      azimuth: 0.35;
-      elevation: -21.86;
-      friendly_name: "Sun";
-      next_dawn: "2024-05-03T03:24:45.747945+00:00";
-      next_dusk: "2024-05-03T19:51:10.358970+00:00";
-      next_midnight: "2024-05-03T23:37:12+00:00";
-      next_noon: "2024-05-03T11:37:19+00:00";
-      next_rising: "2024-05-03T04:05:17.926549+00:00";
-      next_setting: "2024-05-03T19:10:21.280558+00:00";
-      rising: true;
-    };
+    attributes: DynamicMergeAttributes<
+      "sun.sun",
+      {
+        azimuth: 0.35;
+        elevation: -21.86;
+        friendly_name: "Sun";
+        next_dawn: "2024-05-03T03:24:45.747945+00:00";
+        next_dusk: "2024-05-03T19:51:10.358970+00:00";
+        next_midnight: "2024-05-03T23:37:12+00:00";
+        next_noon: "2024-05-03T11:37:19+00:00";
+        next_rising: "2024-05-03T04:05:17.926549+00:00";
+        next_setting: "2024-05-03T19:10:21.280558+00:00";
+        rising: true;
+      }
+    >;
     context: {
       id: "01HWXTS8W1J2TDGMN7KKNWP8DV";
       parent_id: null;
       user_id: null;
     };
     entity_id: "sun.sun";
-
     state: "below_horizon";
   };
   "switch.bedroom_lamp": {
-    attributes: {
-      friendly_name: "bedroom_lamp";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "switch.bedroom_lamp",
+      {
+        friendly_name: "bedroom_lamp";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSB7BK003CH3AYYVXCB";
       parent_id: null;
       user_id: null;
     };
     entity_id: "switch.bedroom_lamp";
-
     state: "unavailable";
   };
   "switch.kitchen_cabinets": {
-    attributes: {
-      friendly_name: "kitchen_cabinets";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "switch.kitchen_cabinets",
+      {
+        friendly_name: "kitchen_cabinets";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSBM9Y3SRQTFJ5CVK6H";
       parent_id: null;
       user_id: null;
     };
     entity_id: "switch.kitchen_cabinets";
-
     state: "unavailable";
   };
   "switch.living_room_mood_lights": {
-    attributes: {
-      friendly_name: "living_room_mood_lights";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "switch.living_room_mood_lights",
+      {
+        friendly_name: "living_room_mood_lights";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSBS5B586JJ7VFH10SX";
       parent_id: null;
@@ -305,65 +340,73 @@ export type ENTITY_SETUP = {
     state: "unavailable";
   };
   "switch.porch_light": {
-    attributes: {
-      friendly_name: "porch_light";
-      restored: true;
-      supported_features: 0;
-    };
+    attributes: DynamicMergeAttributes<
+      "switch.porch_light",
+      {
+        friendly_name: "porch_light";
+        restored: true;
+        supported_features: 0;
+      }
+    >;
     context: {
       id: "01HWXTSCSBFTSZR1M5XAK7XSR8";
       parent_id: null;
       user_id: null;
     };
     entity_id: "switch.porch_light";
-
     state: string;
   };
   "todo.shopping_list": {
-    attributes: {
-      friendly_name: "Shopping List";
-      supported_features: 15;
-    };
+    attributes: DynamicMergeAttributes<
+      "todo.shopping_list",
+      {
+        friendly_name: "Shopping List";
+        supported_features: 15;
+      }
+    >;
     context: {
       id: "01HWXTS8X3D417XC4YJTG8QJWB";
       parent_id: null;
       user_id: null;
     };
     entity_id: "todo.shopping_list";
-
     state: "0";
   };
   "tts.google_en_com": {
-    attributes: {
-      friendly_name: "Google en com";
-    };
+    attributes: DynamicMergeAttributes<
+      "tts.google_en_com",
+      {
+        friendly_name: "Google en com";
+      }
+    >;
     context: {
       id: "01HWXTS8XMPQ236CDJ6X7C6E60";
       parent_id: null;
       user_id: null;
     };
     entity_id: "tts.google_en_com";
-
     state: "unknown";
   };
   "zone.home": {
-    attributes: {
-      editable: true;
-      friendly_name: "Home";
-      icon: "mdi:home";
-      latitude: 52.373_133_9;
-      longitude: 4.890_314_7;
-      passive: false;
-      persons: [];
-      radius: 100;
-    };
+    attributes: DynamicMergeAttributes<
+      "zone.home",
+      {
+        editable: true;
+        friendly_name: "Home";
+        icon: "mdi:home";
+        latitude: 52.373_133_9;
+        longitude: 4.890_314_7;
+        passive: false;
+        persons: [];
+        radius: 100;
+      }
+    >;
     context: {
       id: "01HWXTS8GMB4ZW20P8MGMX0QSN";
       parent_id: null;
       user_id: null;
     };
     entity_id: "zone.home";
-
     state: "0";
   };
 };

package/src/helpers/utility.mts

@@ -97,7 +97,7 @@ export type GetDomain<ENTITY extends ANY_ENTITY> = ENTITY extends `${infer domai
   ? domain
   : never;
 
-function isDomain<DOMAIN extends ALL_DOMAINS>(
+export function isDomain<DOMAIN extends ALL_DOMAINS>(
   entity: string,
   domain: DOMAIN | DOMAIN[],
 ): entity is PICK_ENTITY<DOMAIN> {
@@ -105,7 +105,6 @@ function isDomain<DOMAIN extends ALL_DOMAINS>(
   return [domain].flat().includes(test);
 }
 
-is.domain = isDomain;
 is.removeFn = (remove: () => void) => {
   const out = remove as RemoveCallback;
   out.remove = remove;

package/src/merge.mts

@@ -0,0 +1,9 @@
+import { PICK_ENTITY } from "./index.mts";
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface EntityMergeAttributes {}
+
+export type DynamicMergeAttributes<MAYBE_ENTITY extends string, SCANNED extends object> =
+  MAYBE_ENTITY extends Extract<PICK_ENTITY, keyof EntityMergeAttributes>
+    ? SCANNED & EntityMergeAttributes[MAYBE_ENTITY]
+    : SCANNED;

package/src/mock_assistant/services/entity.service.mts

@@ -1,4 +1,4 @@
-import { deepExtend, InternalError, is, sleep, TServiceParams } from "@digital-alchemy/core";
+import { deepExtend, InternalError, sleep, TServiceParams } from "@digital-alchemy/core";
 
 import { TRawEntityIds } from "../../dynamic.mts";
 import { ENTITY_STATE, PICK_ENTITY } from "../../helpers/index.mts";
@@ -11,6 +11,7 @@ export function MockEntityExtension({
   config,
   mock_assistant,
 }: TServiceParams) {
+  const { is } = internal.utils;
   let entities = new Map<TRawEntityIds, ENTITY_STATE<TRawEntityIds>>();
 
   const origGetAll = hass.fetch.getAllEntities;

package/src/mock_assistant/services/fixtures.service.mts

@@ -1,4 +1,4 @@
-import { BootstrapException, is, TServiceParams } from "@digital-alchemy/core";
+import { BootstrapException, TServiceParams } from "@digital-alchemy/core";
 import { existsSync, readFileSync } from "fs";
 
 import { ANY_ENTITY, ENTITY_STATE } from "../../helpers/index.mts";
@@ -17,6 +17,7 @@ export function MockFixtures({
   context,
   mock_assistant,
 }: TServiceParams) {
+  const { is } = internal.utils;
   // This file DELIBERATELY breaks some rules
   // Setup actions that depend on config are not NORMALLY expected to run inside constructor
 

package/src/services/backup.service.mts

@@ -1,4 +1,4 @@
-import { is, SECOND, sleep, TServiceParams } from "@digital-alchemy/core";
+import { SECOND, sleep, TServiceParams } from "@digital-alchemy/core";
 
 import {
   BackupResponse,
@@ -7,7 +7,14 @@ import {
   SignRequestResponse,
 } from "../helpers/index.mts";
 
-export function Backup({ logger, hass, config }: TServiceParams): HassBackupService {
+export function Backup({
+  logger,
+  hass,
+  config,
+  internal: {
+    utils: { is },
+  },
+}: TServiceParams): HassBackupService {
   async function download(slug: string, destination: string): Promise<void> {
     const result = await hass.socket.sendMessage<SignRequestResponse>({
       path: `/api/backup/download/${slug}`,

package/src/services/call-proxy.service.mts

@@ -1,4 +1,4 @@
-import { is, TServiceParams } from "@digital-alchemy/core";
+import { TServiceParams } from "@digital-alchemy/core";
 
 import { iCallService } from "../dynamic.mts";
 import { ALL_SERVICE_DOMAINS, PICK_SERVICE, PICK_SERVICE_PARAMETERS } from "../helpers/index.mts";
@@ -10,6 +10,7 @@ export function CallProxy({
   hass,
   config,
 }: TServiceParams): iCallService {
+  const { is } = internal.utils;
   let loaded = false;
   const rawProxy = {} as Record<string, Record<string, unknown>>;
   /**

package/src/services/config.service.mts

@@ -1,13 +1,5 @@
 /* eslint-disable @typescript-eslint/no-magic-numbers */
-import {
-  asyncNoop,
-  INCREMENT,
-  is,
-  SECOND,
-  sleep,
-  START,
-  TServiceParams,
-} from "@digital-alchemy/core";
+import { asyncNoop, INCREMENT, SECOND, sleep, START, TServiceParams } from "@digital-alchemy/core";
 import { env } from "process";
 
 import { iCallService } from "../dynamic.mts";
@@ -31,6 +23,7 @@ export function Configure({
   config,
   internal,
 }: TServiceParams): HassConfigService {
+  const { is } = internal.utils;
   lifecycle.onPreInit(() => {
     // HASSIO_TOKEN provided by home assistant to addons
     // SUPERVISOR_TOKEN used as alias elsewhere

package/src/services/entity.service.mts

@@ -3,7 +3,6 @@ import {
   each,
   eachSeries,
   INCREMENT,
-  is,
   SECOND,
   sleep,
   START,
@@ -38,6 +37,7 @@ export function EntityManager({
   context,
   internal,
 }: TServiceParams): HassEntityManager {
+  const { is } = internal.utils;
   // #MARK: Local vars
   /**
    * MASTER_STATE.switch.desk_light = {entity_id,state,attributes,...}