@digital-alchemy/hass 24.10.1 → 24.11.1

package/src/helpers/entity-state.helper.ts

@@ -11,6 +11,7 @@ import {
   ENTITY_STATE,
   GetDomain,
   PICK_ENTITY,
+  RemoveCallback,
 } from "./utility.helper";
 
 export interface HassEntityContext {
@@ -40,9 +41,7 @@ export type TEntityUpdateCallback<ENTITY_ID extends ANY_ENTITY> = (
 
 export type RemovableCallback<ENTITY_ID extends ANY_ENTITY> = (
   callback: TEntityUpdateCallback<ENTITY_ID>,
-) => {
-  remove: () => void;
-};
+) => RemoveCallback;
 
 export type ByIdProxy<ENTITY_ID extends ANY_ENTITY> = ENTITY_STATE<ENTITY_ID> & {
   entity_id: ENTITY_ID;
@@ -57,7 +56,7 @@ export type ByIdProxy<ENTITY_ID extends ANY_ENTITY> = ENTITY_STATE<ENTITY_ID> &
   /**
    * Run callback once, for next update
    */
-  once: (callback: TEntityUpdateCallback<ENTITY_ID>) => void;
+  once: (callback: TEntityUpdateCallback<ENTITY_ID>) => RemoveCallback;
   /**
    * Will resolve with the next state of the next value. No time limit
    */
@@ -71,9 +70,15 @@ export type ByIdProxy<ENTITY_ID extends ANY_ENTITY> = ENTITY_STATE<ENTITY_ID> &
    */
   previous: ENTITY_STATE<ENTITY_ID>;
   /**
-   * Remove all `.onUpdate` listeners for this entity
+   * add a listener that can be removed with the removeAllListeners call
+   *
+   * for use by other libraries
+   */
+  addListener: (remove: RemoveCallback) => void;
+  /**
+   * Remove all resources related to this particular proxy
    *
-   * If you want to remove a particular one, use use the return value of the `.onUpdate` call instead
+   * Will interrupt methods like "nextState", causing them to never return
    */
   removeAllListeners: () => void;
 } & (GetDomain<ENTITY_ID> extends ALL_SERVICE_DOMAINS

package/src/helpers/interfaces.helper.ts

@@ -43,6 +43,7 @@ import {
   PICK_FROM_FLOOR,
   PICK_FROM_LABEL,
   PICK_FROM_PLATFORM,
+  RemoveCallback,
 } from "./utility.helper";
 import {
   EntityHistoryDTO,
@@ -124,7 +125,7 @@ export type HassWebsocketAPI = {
   /**
    * run a callback when the socket finishes (re)connecting
    */
-  onConnect: (callback: () => TBlackHole) => void;
+  onConnect: (callback: () => TBlackHole) => RemoveCallback;
   /**
    * Attach to the incoming stream of socket events. Do your own filtering and processing from there
    *
@@ -135,7 +136,7 @@ export type HassWebsocketAPI = {
     event,
     once,
     exec,
-  }: OnHassEventOptions<DATA>) => () => void;
+  }: OnHassEventOptions<DATA>) => RemoveCallback;
   /**
    * @internal
    *
@@ -179,7 +180,7 @@ export type HassWebsocketAPI = {
     event_type,
     context,
     exec,
-  }: SocketSubscribeOptions<EVENT>) => Promise<void>;
+  }: SocketSubscribeOptions<EVENT>) => Promise<RemoveCallback>;
   /**
    * remove the current socket connection to home assistant
    *
@@ -280,12 +281,12 @@ export type HassEntityManager = {
 export type SimpleCallback = () => TBlackHole;
 
 export type HassEventsService = {
-  onAreaRegistryUpdate: (callback: SimpleCallback) => void;
-  onDeviceRegistryUpdate: (callback: SimpleCallback) => void;
-  onEntityRegistryUpdate: (callback: SimpleCallback) => void;
-  onFloorRegistryUpdate: (callback: SimpleCallback) => void;
-  onLabelRegistryUpdate: (callback: SimpleCallback) => void;
-  onZoneRegistryUpdate: (callback: SimpleCallback) => void;
+  onAreaRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
+  onDeviceRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
+  onEntityRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
+  onFloorRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
+  onLabelRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
+  onZoneRegistryUpdate: (callback: SimpleCallback) => RemoveCallback;
 };
 
 export type HassFloorService = {

package/src/helpers/utility.helper.ts

@@ -106,6 +106,13 @@ function isDomain<DOMAIN extends ALL_DOMAINS>(
 }
 
 is.domain = isDomain;
+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" {
   export interface IsIt {
@@ -113,6 +120,7 @@ declare module "@digital-alchemy/core" {
      * Check to see if an entity matches
      */
     domain: typeof isDomain;
+    removeFn: (remove: () => void) => RemoveCallback;
   }
 }
 

package/src/mock_assistant/mock-assistant.module.ts

@@ -85,6 +85,13 @@ export const createTestRunner = () =>
     .configure({
       boilerplate: { IS_TEST: true },
     })
+    .setOptions({
+      configSources: {
+        argv: false,
+        env: false,
+        file: false,
+      },
+    })
     .appendLibrary(LIB_MOCK_ASSISTANT);
 
 export const hassTestRunner = createTestRunner();

package/src/testing/fetch-api.spec.ts

@@ -28,7 +28,7 @@ describe("FetchAPI", () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
         lifecycle.onReady(async () => {
-          const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+          const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
             return {
               text: () => "[]",
             } as unknown as Response;
@@ -54,7 +54,7 @@ describe("FetchAPI", () => {
     it("should format calendarSearch properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "[]",
           } as unknown as Response;
@@ -78,7 +78,7 @@ describe("FetchAPI", () => {
     it("should format callService properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -103,7 +103,7 @@ describe("FetchAPI", () => {
     it("should format checkConfig properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -166,7 +166,7 @@ describe("FetchAPI", () => {
     it("should format fetchEntityCustomizations properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -186,7 +186,7 @@ describe("FetchAPI", () => {
     it("should format fetchEntityHistory properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -207,7 +207,7 @@ describe("FetchAPI", () => {
       expect.assertions(1);
       const body = { magic: true };
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -276,7 +276,7 @@ describe("FetchAPI", () => {
     it("should format getLogs properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "[]",
           } as unknown as Response;
@@ -296,7 +296,7 @@ describe("FetchAPI", () => {
     it("should format getRawLogs properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -317,7 +317,7 @@ describe("FetchAPI", () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass, mock_assistant }) => {
         lifecycle.onReady(async () => {
-          const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+          const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
             return {
               text: () => "{}",
             } as unknown as Response;
@@ -337,7 +337,7 @@ describe("FetchAPI", () => {
     it("should format updateEntity properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -369,7 +369,7 @@ describe("FetchAPI", () => {
         magic: true,
       };
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;
@@ -390,7 +390,7 @@ describe("FetchAPI", () => {
     it("should format checkCredentials properly", async () => {
       expect.assertions(1);
       await hassTestRunner.run(({ lifecycle, hass }) => {
-        const spy = jest.spyOn(global, "fetch").mockImplementation(async () => {
+        const spy = jest.spyOn(globalThis, "fetch").mockImplementation(async () => {
           return {
             text: () => "{}",
           } as unknown as Response;