@digital-alchemy/hass 25.2.2 → 25.3.2

package/src/helpers/device.mts

@@ -1,4 +1,4 @@
-import { TDeviceId } from "../dynamic.mts";
+import { TDeviceId } from "../user.mts";
 
 export interface DeviceDetails {
   area_id: null | string;

package/src/helpers/entity-state.mts

@@ -3,22 +3,19 @@ import { Dayjs } from "dayjs";
 import { Except } from "type-fest";
 
 import {
+  ALL_DOMAINS,
+  ANY_ENTITY,
+  GetDomain,
   iCallService,
+  PICK_ENTITY,
   TAreaId,
   TDeviceId,
   TLabelId,
   TPlatformId,
   TRawDomains,
-} from "../dynamic.mts";
+} from "../user.mts";
 import { SensorUnitOfMeasurement } from "./registry.mts";
-import {
-  ALL_DOMAINS,
-  ALL_SERVICE_DOMAINS,
-  ANY_ENTITY,
-  ENTITY_STATE,
-  GetDomain,
-  PICK_ENTITY,
-} from "./utility.mts";
+import { ALL_SERVICE_DOMAINS, ENTITY_STATE } from "./utility.mts";
 
 export interface HassEntityContext {
   id: string | null;

package/src/helpers/fetch/calendar.mts

@@ -1,6 +1,6 @@
 import { Dayjs } from "dayjs";
 
-import { PICK_ENTITY } from "../utility.mts";
+import { PICK_ENTITY } from "../../user.mts";
 
 export type CalendarFetchOptions = {
   /**

package/src/helpers/fetch/configuration.mts

@@ -1,4 +1,4 @@
-import { TAreaId, TFloorId, TLabelId } from "../../dynamic.mts";
+import { TAreaId, TFloorId, TLabelId } from "../../user.mts";
 
 export interface HassUnitSystem {
   length: "mi";

package/src/helpers/fetch/service-list.mts

@@ -1,14 +1,25 @@
-import { TPlatformId } from "../../dynamic.mts";
-import { ALL_DOMAINS } from "../utility.mts";
+import { LiteralUnion } from "type-fest";
+
+import { ALL_DOMAINS, TPlatformId } from "../../user.mts";
+import { ColorMode } from "../features.mts";
 
 export interface ServiceListSelectorTarget {
   domain?: ALL_DOMAINS;
   integration?: TPlatformId;
   multiple?: boolean;
 }
+
 export interface ServiceListSelector {
+  addon?: null;
+  backup_location?: null;
   boolean?: null;
+  color_rgb?: null;
+  color_temp?: { unit: "kelvin"; min: number; max: number };
+  conversation_agent?: null;
+  date?: null;
+  datetime?: null;
   entity?: ServiceListSelectorTarget;
+  icon?: null;
   number?: {
     max: number;
     min: number;
@@ -18,17 +29,26 @@ export interface ServiceListSelector {
   };
   object?: null;
   select?: {
+    custom_value?: boolean;
+    multiple?: boolean;
     options: Record<"label" | "value", string>[] | string[];
   };
-  text?: null;
+  text?: null | { type: "password" };
+  theme?: { include_defaults?: boolean };
   time?: null;
 }
 
+export interface ServiceListFilter {
+  supported_features?: number[];
+  supported_color_modes?: LiteralUnion<`${ColorMode}`, string>[];
+}
+
 export interface ServiceListFieldDescription {
   advanced?: boolean;
   default?: unknown;
   description?: string;
   example?: string | number;
+  filter?: ServiceListFilter;
   name?: string;
   required?: boolean;
   selector?: ServiceListSelector;

package/src/helpers/id-by.mts

@@ -1,23 +1,21 @@
-import {
-  TAreaId,
-  TDeviceId,
-  TFloorId,
-  TLabelId,
-  TPlatformId,
-  TRawEntityIds,
-  TUniqueId,
-  TUniqueIDMapping,
-} from "../dynamic.mts";
 import {
   ALL_DOMAINS,
   ANY_ENTITY,
+  HassUniqueIdMapping,
   PICK_ENTITY,
   PICK_FROM_AREA,
   PICK_FROM_DEVICE,
   PICK_FROM_FLOOR,
   PICK_FROM_LABEL,
   PICK_FROM_PLATFORM,
-} from "./utility.mts";
+  TAreaId,
+  TDeviceId,
+  TFloorId,
+  TLabelId,
+  TPlatformId,
+  TRawEntityIds,
+  TUniqueId,
+} from "../user.mts";
 
 export type IDByInterface = {
   area: <AREA extends TAreaId, DOMAIN extends ALL_DOMAINS>(
@@ -43,8 +41,8 @@ export type IDByInterface = {
   ) => PICK_FROM_PLATFORM<PLATFORM, DOMAIN>[];
   unique_id: <
     UNIQUE_ID extends TUniqueId,
-    ENTITY_ID extends Extract<TUniqueIDMapping[UNIQUE_ID], ANY_ENTITY> = Extract<
-      TUniqueIDMapping[UNIQUE_ID],
+    ENTITY_ID extends Extract<HassUniqueIdMapping[UNIQUE_ID], ANY_ENTITY> = Extract<
+      HassUniqueIdMapping[UNIQUE_ID],
       TRawEntityIds
     >,
   >(

package/src/helpers/interfaces.mts

@@ -3,7 +3,16 @@ import EventEmitter from "events";
 import WS from "ws";
 
 import {
+  ALL_DOMAINS,
+  ANY_ENTITY,
+  HassUniqueIdMapping,
   iCallService,
+  PICK_ENTITY,
+  PICK_FROM_AREA,
+  PICK_FROM_DEVICE,
+  PICK_FROM_FLOOR,
+  PICK_FROM_LABEL,
+  PICK_FROM_PLATFORM,
   TAreaId,
   TDeviceId,
   TFloorId,
@@ -12,13 +21,11 @@ import {
   TRawDomains,
   TRawEntityIds,
   TUniqueId,
-  TUniqueIDMapping,
-} from "../dynamic.mts";
+} from "../user.mts";
 import { BackupResponse, HomeAssistantBackup } from "./backup.mts";
 import { DeviceDetails } from "./device.mts";
 import { ByIdProxy } from "./entity-state.mts";
-import { AreaCreate, AreaDetails, ConfigEntry, HassConfig } from "./fetch/configuration.mts";
-import { HassServiceDTO } from "./fetch/service-list.mts";
+import { AreaCreate, AreaDetails, ConfigEntry, HassConfig, HassServiceDTO } from "./index.mts";
 import {
   EditAliasOptions,
   EditLabelOptions,
@@ -33,18 +40,7 @@ import {
   ZoneDetails,
   ZoneOptions,
 } from "./registry.mts";
-import {
-  ALL_DOMAINS,
-  ALL_SERVICE_DOMAINS,
-  ANY_ENTITY,
-  ENTITY_STATE,
-  PICK_ENTITY,
-  PICK_FROM_AREA,
-  PICK_FROM_DEVICE,
-  PICK_FROM_FLOOR,
-  PICK_FROM_LABEL,
-  PICK_FROM_PLATFORM,
-} from "./utility.mts";
+import { ALL_SERVICE_DOMAINS, ENTITY_STATE } from "./utility.mts";
 import {
   EntityHistoryDTO,
   EntityHistoryResult,
@@ -324,8 +320,8 @@ export type HassReferenceService = {
   ) => ByIdProxy<PICK_FROM_PLATFORM<PLATFORM, DOMAINS>>[];
   unique_id: <
     UNIQUE_ID extends TUniqueId,
-    ENTITY_ID extends Extract<TUniqueIDMapping[UNIQUE_ID], ANY_ENTITY> = Extract<
-      TUniqueIDMapping[UNIQUE_ID],
+    ENTITY_ID extends Extract<HassUniqueIdMapping[UNIQUE_ID], ANY_ENTITY> = Extract<
+      HassUniqueIdMapping[UNIQUE_ID],
       ANY_ENTITY
     >,
   >(

package/src/helpers/registry.mts

@@ -1,5 +1,12 @@
-import { TAreaId, TDeviceId, TFloorId, TLabelId, TPlatformId, TZoneId } from "../dynamic.mts";
-import { ANY_ENTITY } from "./utility.mts";
+import {
+  ANY_ENTITY,
+  TAreaId,
+  TDeviceId,
+  TFloorId,
+  TLabelId,
+  TPlatformId,
+  TZoneId,
+} from "../user.mts";
 
 export type LabelOptions = {
   name: string;

package/src/helpers/utility.mts

@@ -3,31 +3,18 @@ import { Dayjs } from "dayjs";
 import { Get } from "type-fest";
 
 import {
-  ENTITY_SETUP,
+  ALL_DOMAINS,
+  ANY_ENTITY,
+  HassEntitySetupMapping,
   iCallService,
-  REGISTRY_SETUP,
-  TAreaId,
-  TDeviceId,
-  TFloorId,
-  TLabelId,
-  TPlatformId,
-  TRawDomains,
+  PICK_ENTITY,
   TRawEntityIds,
-} from "../dynamic.mts";
+} from "../user.mts";
 import { HassEntityContext } from "./entity-state.mts";
 
-export type ANY_ENTITY = TRawEntityIds;
-
 // ? Casting by domain turns things from "equiv to ANY_ENTITY" to "scene.*" type generics
 // These are no longer valid comparisons against ANY_ENTITY though
 // ? The extract converts those generic types back into real entity ids to make types valid again
-/**
- * Pick any valid entity, optionally limiting by domain
- */
-export type PICK_ENTITY<DOMAIN extends ALL_DOMAINS = ALL_DOMAINS> = Extract<
-  ANY_ENTITY,
-  `${DOMAIN}.${string}`
->;
 
 /**
  * Pick any valid service call, optionally limiting by domain
@@ -62,41 +49,32 @@ export function domain(entity: { entity_id: ANY_ENTITY } | ANY_ENTITY): ALL_DOMA
   return entity_split(entity).shift() as ALL_DOMAINS;
 }
 
-export type ENTITY_PROP<ENTITY_ID extends PICK_ENTITY, PROP extends "state" | "attributes"> = Get<
-  ENTITY_SETUP,
-  `${ENTITY_ID}.${PROP}`
->;
+export type ENTITY_PROP<
+  ENTITY_ID extends PICK_ENTITY,
+  PROP extends "state" | "attributes",
+> = HassEntitySetupMapping[ENTITY_ID][PROP];
 
 /**
  * Type definitions to match a specific entity.
  */
-export type ENTITY_STATE<ENTITY_ID extends ANY_ENTITY> = Omit<
-  ENTITY_SETUP[ENTITY_ID],
+export type ENTITY_STATE<ENTITY_ID extends TRawEntityIds> = Omit<
+  HassEntitySetupMapping[ENTITY_ID],
   "state" | "context" | "last_changed" | "last_updated" | "entity_id" | "attributes"
 > & {
   last_reported: Dayjs;
   last_changed: Dayjs;
   last_updated: Dayjs;
-  attributes: ENTITY_SETUP[ENTITY_ID]["attributes"];
+  attributes: ENTITY_PROP<ENTITY_ID, "attributes">;
   entity_id: ENTITY_ID;
-  state: ENTITY_SETUP[ENTITY_ID]["state"];
+  state: ENTITY_PROP<ENTITY_ID, "state">;
   context: HassEntityContext;
 };
 
-/**
- * Union of all domains that contain entities
- */
-export type ALL_DOMAINS = TRawDomains;
-
 /**
  * Union of all services with callable methods
  */
 export type ALL_SERVICE_DOMAINS = keyof iCallService;
 
-export type GetDomain<ENTITY extends ANY_ENTITY> = ENTITY extends `${infer domain}.${string}`
-  ? domain
-  : never;
-
 export function isDomain<DOMAIN extends ALL_DOMAINS>(
   entity: string,
   domain: DOMAIN | DOMAIN[],
@@ -105,12 +83,6 @@ export function isDomain<DOMAIN extends ALL_DOMAINS>(
   return [domain].flat().includes(test);
 }
 
-is.removeFn = (remove: () => void) => {
-  const out = remove as RemoveCallback;
-  out.remove = remove;
-  return out;
-};
-
 export type RemoveCallback = { remove: () => void; (): void };
 
 declare module "@digital-alchemy/core" {
@@ -119,7 +91,6 @@ declare module "@digital-alchemy/core" {
      * Check to see if an entity matches
      */
     domain: typeof isDomain;
-    removeFn: (remove: () => void) => RemoveCallback;
   }
 }
 
@@ -127,28 +98,3 @@ export const PostConfigPriorities = {
   FETCH: 1,
   VALIDATE: -1,
 } as const;
-
-export type PICK_FROM_AREA<ID extends TAreaId, DOMAIN extends ALL_DOMAINS = ALL_DOMAINS> = Extract<
-  REGISTRY_SETUP["area"][`_${ID}`],
-  PICK_ENTITY<DOMAIN>
->;
-
-export type PICK_FROM_LABEL<
-  ID extends TLabelId,
-  DOMAIN extends ALL_DOMAINS = ALL_DOMAINS,
-> = Extract<REGISTRY_SETUP["label"][`_${ID}`], PICK_ENTITY<DOMAIN>>;
-
-export type PICK_FROM_FLOOR<
-  ID extends TFloorId,
-  DOMAIN extends ALL_DOMAINS = ALL_DOMAINS,
-> = Extract<REGISTRY_SETUP["floor"][`_${ID}`], PICK_ENTITY<DOMAIN>>;
-
-export type PICK_FROM_DEVICE<
-  ID extends TDeviceId,
-  DOMAIN extends ALL_DOMAINS = ALL_DOMAINS,
-> = Extract<REGISTRY_SETUP["device"][`_${ID}`], PICK_ENTITY<DOMAIN>>;
-
-export type PICK_FROM_PLATFORM<
-  ID extends TPlatformId,
-  DOMAIN extends ALL_DOMAINS = ALL_DOMAINS,
-> = Extract<REGISTRY_SETUP["platform"][`_${ID}`], PICK_ENTITY<DOMAIN>>;

package/src/helpers/websocket.mts

@@ -1,9 +1,10 @@
 import { TBlackHole, TContext } from "@digital-alchemy/core";
 import { Dayjs } from "dayjs";
 
+import { ALL_DOMAINS, ANY_ENTITY, PICK_ENTITY } from "../user.mts";
 import { HassSocketMessageTypes } from "./constants.mts";
 import { EntityUpdateEvent } from "./entity-state.mts";
-import { ALL_DOMAINS, ANY_ENTITY, ENTITY_STATE, PICK_ENTITY } from "./utility.mts";
+import { ENTITY_STATE } from "./utility.mts";
 
 export interface SignRequestResponse {
   path: string;

package/src/index.mts

@@ -1,5 +1,6 @@
-export * from "./dynamic.mts";
 export * from "./hass.module.mts";
 export * from "./helpers/index.mts";
+export * from "./merge.mts";
 export * from "./quickboot.module.mts";
 export * from "./services/index.mts";
+export * from "./user.mts";

package/src/mock_assistant/helpers/fixtures.mts

@@ -1,5 +1,4 @@
 import {
-  ANY_ENTITY,
   AreaDetails,
   DeviceDetails,
   ENTITY_STATE,
@@ -9,6 +8,7 @@ import {
   HassServiceDTO as HassServiceDefinition,
   LabelDefinition,
 } from "../../helpers/index.mts";
+import { ANY_ENTITY } from "../../user.mts";
 
 export type ScannerCacheData = {
   areas: AreaDetails[];

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TAreaId } from "../../dynamic.mts";
 import { AreaDetails } from "../../helpers/index.mts";
+import { TAreaId } from "../../user.mts";
 
 export function MockAreaExtension({ mock_assistant }: TServiceParams) {
   let areas = new Map<TAreaId, AreaDetails>();

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TDeviceId } from "../../dynamic.mts";
 import { DEVICE_REGISTRY_UPDATED, DeviceDetails } from "../../helpers/index.mts";
+import { TDeviceId } from "../../user.mts";
 
 export function MockDeviceExtension({ mock_assistant }: TServiceParams) {
   let devices = new Map<TDeviceId, DeviceDetails>();

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TRawEntityIds } from "../../dynamic.mts";
 import { EntityRegistryItem } from "../../helpers/index.mts";
+import { TRawEntityIds } from "../../user.mts";
 
 export function MockEntityRegistryExtension({ mock_assistant, hass }: TServiceParams) {
   let entityRegistry = new Map<TRawEntityIds, EntityRegistryItem<TRawEntityIds>>();

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

@@ -1,7 +1,7 @@
 import { deepExtend, InternalError, sleep, TServiceParams } from "@digital-alchemy/core";
 
-import { TRawEntityIds } from "../../dynamic.mts";
-import { ENTITY_STATE, PICK_ENTITY } from "../../helpers/index.mts";
+import { ENTITY_STATE } from "../../index.mts";
+import { PICK_ENTITY, TRawEntityIds } from "../../user.mts";
 
 export function MockEntityExtension({
   hass,

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

@@ -1,6 +1,7 @@
 import { sleep, TServiceParams } from "@digital-alchemy/core";
 
-import { ANY_ENTITY, ENTITY_STATE, EntityUpdateEvent } from "../../helpers/index.mts";
+import { ENTITY_STATE, EntityUpdateEvent } from "../../index.mts";
+import { ANY_ENTITY } from "../../user.mts";
 
 const SUPER_SHORT = 1;
 

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

@@ -1,7 +1,8 @@
 import { BootstrapException, TServiceParams } from "@digital-alchemy/core";
 import { existsSync, readFileSync } from "fs";
 
-import { ANY_ENTITY, ENTITY_STATE } from "../../helpers/index.mts";
+import { ENTITY_STATE } from "../../index.mts";
+import { ANY_ENTITY } from "../../user.mts";
 import { ScannerCacheData } from "../helpers/index.mts";
 
 type StateOptions = Partial<{

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TFloorId } from "../../dynamic.mts";
 import { FloorDetails } from "../../helpers/index.mts";
+import { TFloorId } from "../../user.mts";
 
 export function MockFloorExtension({ mock_assistant }: TServiceParams) {
   let floors = new Map<TFloorId, FloorDetails>();

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TLabelId } from "../../dynamic.mts";
 import { LabelDefinition } from "../../helpers/index.mts";
+import { TLabelId } from "../../user.mts";
 
 export function MockLabelExtension({ mock_assistant }: TServiceParams) {
   let labels = new Map<TLabelId, LabelDefinition>();

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { TZoneId } from "../../dynamic.mts";
 import { ZoneDetails } from "../../helpers/index.mts";
+import { TZoneId } from "../../user.mts";
 
 export function MockZoneExtension({ mock_assistant }: TServiceParams) {
   let zones = new Map<TZoneId, ZoneDetails>();
@@ -38,15 +38,18 @@ export function MockZoneExtension({ mock_assistant }: TServiceParams) {
     },
   );
 
-  mock_assistant.socket.onMessage<ZoneDetails>("config/zone_registry/update", message => {
-    zones.set(message.id as TZoneId, message);
-    sendUpdate();
-    mock_assistant.socket.sendMessage({
-      id: message.id,
-      result: null,
-      type: "result",
-    });
-  });
+  mock_assistant.socket.onMessage<ZoneDetails>(
+    "config/zone_registry/update",
+    (message: ZoneDetails) => {
+      zones.set(message.id as TZoneId, message);
+      sendUpdate();
+      mock_assistant.socket.sendMessage({
+        id: message.id,
+        result: null,
+        type: "result",
+      });
+    },
+  );
 
   const sendUpdate = () =>
     mock_assistant.socket.sendMessage({

package/src/services/area.service.mts

@@ -1,15 +1,14 @@
 import { debounce, eachSeries, InternalError, TServiceParams } from "@digital-alchemy/core";
 
-import { TAreaId } from "../dynamic.mts";
 import {
-  ANY_ENTITY,
   AREA_REGISTRY_UPDATED,
   AreaCreate,
   AreaDetails,
   EARLY_ON_READY,
   ENTITY_REGISTRY_UPDATED,
   HassAreaService,
-} from "../helpers/index.mts";
+} from "../index.mts";
+import { ANY_ENTITY, TAreaId } from "../user.mts";
 
 export function Area({
   hass,

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

@@ -1,7 +1,7 @@
 import { TServiceParams } from "@digital-alchemy/core";
 
-import { iCallService } from "../dynamic.mts";
 import { ALL_SERVICE_DOMAINS, PICK_SERVICE, PICK_SERVICE_PARAMETERS } from "../helpers/index.mts";
+import { iCallService } from "../user.mts";
 
 export function CallProxy({
   logger,
@@ -86,7 +86,7 @@ export function CallProxy({
   }
 
   function buildCallProxy(): iCallService {
-    return new Proxy(rawProxy as iCallService, {
+    return new Proxy(rawProxy as unknown as iCallService, {
       get: (_, domain: ALL_SERVICE_DOMAINS) => {
         // oddities in the way proxies work
         // this situation isn't testable afaik

package/src/services/config.service.mts

@@ -2,13 +2,13 @@
 import { asyncNoop, INCREMENT, SECOND, sleep, START, TServiceParams } from "@digital-alchemy/core";
 import { env } from "process";
 
-import { iCallService } from "../dynamic.mts";
 import {
   ALL_SERVICE_DOMAINS,
   HassConfigService,
   HassServiceDTO,
   PostConfigPriorities,
 } from "../helpers/index.mts";
+import { iCallService } from "../user.mts";
 
 const MAX_ATTEMPTS = 50;
 const FAILED = 1;

package/src/services/entity.service.mts

@@ -11,8 +11,6 @@ import {
 import dayjs, { Dayjs } from "dayjs";
 
 import {
-  ALL_DOMAINS,
-  ANY_ENTITY,
   EditLabelOptions,
   ENTITY_REGISTRY_UPDATED,
   ENTITY_STATE,
@@ -21,9 +19,9 @@ import {
   EntityHistoryResult,
   EntityRegistryItem,
   HassEntityManager,
-  PICK_ENTITY,
   TMasterState,
-} from "../helpers/index.mts";
+} from "../index.mts";
+import { ALL_DOMAINS, ANY_ENTITY, PICK_ENTITY } from "../user.mts";
 
 const MAX_ATTEMPTS = 10;
 const RECENT = 5;

package/src/services/fetch-api.service.mts

@@ -6,7 +6,6 @@ import { MIN_SUPPORTED_HASS_VERSION } from "../helpers/constants.mts";
 import { FetchArguments, FilteredFetchArguments, TFetchBody } from "../helpers/fetch.mts";
 import {
   ALL_SERVICE_DOMAINS,
-  ANY_ENTITY,
   CalendarEvent,
   CalendarFetchOptions,
   CheckConfigResult,
@@ -19,6 +18,7 @@ import {
   PostConfigPriorities,
   RawCalendarEvent,
 } from "../helpers/index.mts";
+import { ANY_ENTITY } from "../user.mts";
 
 type SendBody<STATE extends string | number = string, ATTRIBUTES extends object = object> = {
   attributes?: ATTRIBUTES;

package/src/services/floor.service.mts

@@ -1,6 +1,5 @@
 import { debounce, TServiceParams } from "@digital-alchemy/core";
 
-import { TFloorId } from "../dynamic.mts";
 import {
   EARLY_ON_READY,
   FLOOR_REGISTRY_UPDATED,
@@ -8,6 +7,7 @@ import {
   FloorDetails,
   HassFloorService,
 } from "../helpers/index.mts";
+import { TFloorId } from "../user.mts";
 
 export function Floor({
   hass,