@digital-alchemy/hass 24.9.2 → 24.9.4

package/package.json

@@ -1,15 +1,16 @@
 {
+  "type": "module",
   "name": "@digital-alchemy/hass",
   "repository": "https://github.com/Digital-Alchemy-TS/hass",
   "homepage": "https://docs.digital-alchemy.app",
-  "version": "24.9.2",
+  "version": "24.9.4",
   "description": "Typescript APIs for Home Assistant. Includes rest & websocket bindings",
   "scripts": {
     "build": "rm -rf dist/; tsc",
     "lint": "eslint src",
     "test": "./scripts/test.sh",
     "prepublishOnly": "yarn build",
-    "upgrade": "ncu -f '@digital-alchemy/*' -u; yarn"
+    "upgrade": "yarn up '@digital-alchemy/*'"
   },
   "bugs": {
     "email": "bugs@digital-alchemy.app",
@@ -51,60 +52,71 @@
     ".": "./dist/index.js",
     "./mock-assistant": "./dist/mock_assistant/index.js"
   },
-  "dependencies": {
-    "dayjs": "^1.11.11",
-    "prom-client": "^15.1.2",
-    "semver": "^7.6.3",
-    "validator": "^13.12.0",
-    "ws": "^8.17.0"
-  },
   "license": "MIT",
   "devDependencies": {
-    "@cspell/eslint-plugin": "^8.8.4",
-    "@digital-alchemy/core": "^24.8.4",
+    "@cspell/eslint-plugin": "^8.14.4",
+    "@digital-alchemy/core": "^24.9.3",
     "@digital-alchemy/synapse": "^24.9.3",
-    "@digital-alchemy/type-writer": "^24.9.1",
-    "@types/figlet": "^1.5.8",
-    "@types/jest": "^29.5.12",
+    "@digital-alchemy/type-writer": "^24.9.2",
+    "@eslint/compat": "^1.1.1",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.11.1",
+    "@faker-js/faker": "^9.0.2",
+    "@types/jest": "^29.5.13",
     "@types/js-yaml": "^4.0.9",
-    "@types/minimist": "^1.2.5",
-    "@types/mute-stream": "^0.0.4",
-    "@types/node": "^20.14.2",
+    "@types/node": "^22.6.1",
+    "@types/node-cron": "^3",
     "@types/semver": "^7.5.8",
-    "@types/uuid": "^9.0.8",
-    "@types/validator": "^13.11.10",
-    "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "7.13.0",
-    "@typescript-eslint/parser": "7.13.0",
-    "eslint": "8.57.0",
+    "@types/uuid": "^10.0.0",
+    "@types/ws": "^8.5.12",
+    "@typescript-eslint/eslint-plugin": "8.7.0",
+    "@typescript-eslint/parser": "8.7.0",
+    "dayjs": "^1.11.13",
+    "dotenv": "^16.4.5",
+    "eslint": "9.11.1",
     "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsonc": "^2.15.1",
-    "eslint-plugin-no-unsanitized": "^4.0.2",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-security": "^3.0.0",
-    "eslint-plugin-simple-import-sort": "^12.1.0",
-    "eslint-plugin-sonarjs": "^0.25.1",
+    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-jsonc": "^2.16.0",
+    "eslint-plugin-no-unsanitized": "^4.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-sonarjs": "^2.0.2",
     "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "eslint-plugin-unicorn": "^52.0.0",
+    "eslint-plugin-unicorn": "^55.0.0",
+    "globals": "^15.9.0",
     "jest": "^29.7.0",
     "jest-environment-node": "^29.7.0",
-    "npm-check-updates": "^16.14.20",
-    "prettier": "^3.3.2",
-    "ts-jest": "^29.1.4",
-    "tsx": "^4.15.3",
-    "type-fest": "^4.20.0",
-    "typescript": "^5.4.5"
+    "node-cron": "^3.0.3",
+    "prettier": "^3.3.3",
+    "semver": "^7.6.3",
+    "ts-jest": "^29.2.5",
+    "tsx": "^4.19.1",
+    "type-fest": "^4.26.1",
+    "typescript": "^5.6.2",
+    "uuid": "^10.0.0",
+    "ws": "^8.18.0"
   },
   "peerDependencies": {
-    "@digital-alchemy/core": "*"
+    "@digital-alchemy/core": "*",
+    "dayjs": "^1",
+    "semver": "^7",
+    "uuid": "^10",
+    "ws": "^8"
   },
   "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "collectCoverage": true,
     "coverageReporters": [
       "text",
       "cobertura"
     ],
+    "coveragePathIgnorePatterns": [
+      "testing/",
+      "src/mock_assistant"
+    ],
     "preset": "ts-jest",
     "testEnvironment": "node",
     "moduleFileExtensions": [
@@ -114,16 +126,20 @@
       "node"
     ],
     "testMatch": [
-      "**/?(*.)+(spec|test).ts"
+      "**/testing/?(*.)+(spec|test).ts"
+    ],
+    "setupFiles": [
+      "<rootDir>/test-setup.ts"
     ],
     "transform": {
       "^.+\\.ts$": [
         "ts-jest",
         {
-          "tsconfig": "tsconfig.spec.json"
+          "tsconfig": "tsconfig.spec.json",
+          "useESM": true
         }
       ]
     }
   },
-  "packageManager": "yarn@4.4.0"
+  "packageManager": "yarn@4.5.0"
 }

package/dist/helpers/metrics.helper.d.ts

@@ -1,29 +0,0 @@
-import { Counter, Gauge, Summary } from "prom-client";
-/**
- * Tracks the number of times a socket event callback has been executed.
- */
-export declare const SOCKET_EVENT_EXECUTION_COUNT: Counter<"event" | "context" | "label">;
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-export declare const SOCKET_EVENT_ERRORS: Counter<"event" | "context" | "label">;
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-export declare const SOCKET_SENT_MESSAGES: Counter<"type">;
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-export declare const SOCKET_RECEIVED_MESSAGES: Counter<"type">;
-/**
- * Summary for Execution Time
- */
-export declare const SOCKET_EVENT_EXECUTION_TIME: Summary<"event" | "context" | "label">;
-/**
- * Show the current state
- */
-export declare const SOCKET_CONNECTION_STATE: Gauge<"state">;
-/**
- * Counter for service calls made through the call proxy
- */
-export declare const CALL_PROXY_SERVICE_CALL: Counter<"service" | "domain">;

package/dist/helpers/metrics.helper.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CALL_PROXY_SERVICE_CALL = exports.SOCKET_CONNECTION_STATE = exports.SOCKET_EVENT_EXECUTION_TIME = exports.SOCKET_RECEIVED_MESSAGES = exports.SOCKET_SENT_MESSAGES = exports.SOCKET_EVENT_ERRORS = exports.SOCKET_EVENT_EXECUTION_COUNT = void 0;
-const prom_client_1 = require("prom-client");
-/**
- * Tracks the number of times a socket event callback has been executed.
- */
-exports.SOCKET_EVENT_EXECUTION_COUNT = new prom_client_1.Counter({
-    help: "Counts the number of times a socket event callback has been executed",
-    labelNames: ["context", "label", "event"],
-    name: "digital_alchemy_hass_socket_event_callback_execution_count",
-});
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-exports.SOCKET_EVENT_ERRORS = new prom_client_1.Counter({
-    help: "Counts the number of errors during socket event callback executions",
-    labelNames: ["context", "label", "event"],
-    name: "digital_alchemy_hass_socket_event_callback_errors",
-});
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-exports.SOCKET_SENT_MESSAGES = new prom_client_1.Counter({
-    help: "Counts the number of outgoing sent messages",
-    labelNames: ["type"],
-    name: "digital_alchemy_hass_socket_sent_messages",
-});
-/**
- * Counts the number of errors occurred during socket event callback executions.
- */
-exports.SOCKET_RECEIVED_MESSAGES = new prom_client_1.Counter({
-    help: "Counts the number of incoming socket messages",
-    labelNames: ["type"],
-    name: "digital_alchemy_hass_socket_received_messages",
-});
-/**
- * Summary for Execution Time
- */
-exports.SOCKET_EVENT_EXECUTION_TIME = new prom_client_1.Summary({
-    help: "Measures the duration of each socket event callback execution",
-    labelNames: ["context", "label", "event"],
-    name: "digital_alchemy_hass_socket_event_callback_execution_time",
-    percentiles: [0.5, 0.9, 0.99],
-});
-/**
- * Show the current state
- */
-exports.SOCKET_CONNECTION_STATE = new prom_client_1.Gauge({
-    help: "The current connection to home assistant state, observable as a metrics",
-    labelNames: ["state"],
-    name: "digital_alchemy_hass_socket_connection_state",
-});
-/**
- * Counter for service calls made through the call proxy
- */
-exports.CALL_PROXY_SERVICE_CALL = new prom_client_1.Counter({
-    help: "Service calls made through the call proxy",
-    labelNames: ["domain", "service"],
-    name: "digital_alchemy_hass_call_proxy_service_call",
-});
-//# sourceMappingURL=metrics.helper.js.map

package/dist/helpers/metrics.helper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.helper.js","sourceRoot":"","sources":["../../src/helpers/metrics.helper.ts"],"names":[],"mappings":";;;AAAA,6CAAsD;AAEtD;;GAEG;AACU,QAAA,4BAA4B,GAAG,IAAI,qBAAO,CAAC;IACtD,IAAI,EAAE,sEAAsE;IAC5E,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAU;IAClD,IAAI,EAAE,4DAA4D;CACnE,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAI,qBAAO,CAAC;IAC7C,IAAI,EAAE,qEAAqE;IAC3E,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAU;IAClD,IAAI,EAAE,mDAAmD;CAC1D,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,oBAAoB,GAAG,IAAI,qBAAO,CAAC;IAC9C,IAAI,EAAE,6CAA6C;IACnD,UAAU,EAAE,CAAC,MAAM,CAAU;IAC7B,IAAI,EAAE,2CAA2C;CAClD,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,wBAAwB,GAAG,IAAI,qBAAO,CAAC;IAClD,IAAI,EAAE,+CAA+C;IACrD,UAAU,EAAE,CAAC,MAAM,CAAU;IAC7B,IAAI,EAAE,+CAA+C;CACtD,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,2BAA2B,GAAG,IAAI,qBAAO,CAAC;IACrD,IAAI,EAAE,+DAA+D;IACrE,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAU;IAClD,IAAI,EAAE,2DAA2D;IACjE,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;CAC9B,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,mBAAK,CAAC;IAC/C,IAAI,EAAE,yEAAyE;IAC/E,UAAU,EAAE,CAAC,OAAO,CAAU;IAC9B,IAAI,EAAE,8CAA8C;CACrD,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,qBAAO,CAAC;IACjD,IAAI,EAAE,2CAA2C;IACjD,UAAU,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAU;IAC1C,IAAI,EAAE,8CAA8C;CACrD,CAAC,CAAC"}

package/dist/mock_assistant/helpers/utils.d.ts

@@ -1,4 +0,0 @@
-import { ApplicationDefinition, BootstrapOptions, OptionalModuleConfiguration, PartialConfiguration, ServiceFunction, ServiceMap } from "@digital-alchemy/core";
-export declare const SILENT_BOOT: (configuration?: PartialConfiguration, fixtures?: boolean, rewire?: boolean) => BootstrapOptions;
-export declare function CreateTestingApplication(services: ServiceMap): ApplicationDefinition<ServiceMap, import("@digital-alchemy/core").ModuleConfiguration>;
-export declare const CreateTestRunner: <S extends ServiceMap, C extends OptionalModuleConfiguration>(UNIT_TESTING_APP: ApplicationDefinition<S, C>) => (setup: ServiceFunction, Test: ServiceFunction) => Promise<void>;

package/dist/mock_assistant/helpers/utils.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateTestRunner = exports.SILENT_BOOT = void 0;
-exports.CreateTestingApplication = CreateTestingApplication;
-const core_1 = require("@digital-alchemy/core");
-const hass_module_1 = require("../../hass.module");
-const mock_assistant_module_1 = require("../mock-assistant.module");
-function Rewire({ hass }) {
-    jest
-        .spyOn(hass.fetch, "getConfig")
-        .mockImplementation(async () => ({ version: "2024.4.1" }));
-}
-const SILENT_BOOT = (configuration = {}, fixtures = false, rewire = true) => ({
-    appendLibrary: fixtures ? mock_assistant_module_1.LIB_MOCK_ASSISTANT : undefined,
-    appendService: rewire ? { Rewire } : undefined,
-    configuration,
-    // quiet time
-    customLogger: {
-        debug: () => { },
-        error: () => { },
-        fatal: () => { },
-        info: () => { },
-        trace: () => { },
-        warn: () => { },
-    },
-});
-exports.SILENT_BOOT = SILENT_BOOT;
-function CreateTestingApplication(services) {
-    return (0, core_1.CreateApplication)({
-        configurationLoaders: [],
-        libraries: [hass_module_1.LIB_HASS],
-        // @ts-expect-error testing
-        name: "testing",
-        services,
-    });
-}
-const CreateTestRunner = (UNIT_TESTING_APP) => {
-    // setup runs at construction
-    // test runs at ready
-    return async function (setup, Test) {
-        function test(params) {
-            params.lifecycle.onReady(async () => await Test(params));
-        }
-        return await UNIT_TESTING_APP.bootstrap({
-            appendLibrary: mock_assistant_module_1.LIB_MOCK_ASSISTANT,
-            appendService: core_1.is.function(setup)
-                ? { Rewire, setup, test }
-                : { Rewire, test },
-            configuration: {
-                boilerplate: { LOG_LEVEL: "error" },
-                hass: { MOCK_SOCKET: true },
-            },
-        });
-    };
-};
-exports.CreateTestRunner = CreateTestRunner;
-//# sourceMappingURL=utils.js.map

package/dist/mock_assistant/helpers/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/mock_assistant/helpers/utils.ts"],"names":[],"mappings":";;;AAuCA,4DASC;AAhDD,gDAU+B;AAE/B,mDAA6C;AAE7C,oEAA8D;AAC9D,SAAS,MAAM,CAAC,EAAE,IAAI,EAAkB;IACtC,IAAI;SACD,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC;SAC9B,kBAAkB,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAe,CAAC,CAAC;AAC7E,CAAC;AACM,MAAM,WAAW,GAAG,CACzB,gBAAsC,EAAE,EACxC,QAAQ,GAAG,KAAK,EAChB,MAAM,GAAG,IAAI,EACK,EAAE,CAAC,CAAC;IACtB,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,0CAAkB,CAAC,CAAC,CAAC,SAAS;IACxD,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;IAC9C,aAAa;IACb,aAAa;IACb,YAAY,EAAE;QACZ,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;QACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;QACf,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;KACf;CACF,CAAC,CAAC;AAjBU,QAAA,WAAW,eAiBrB;AAEH,SAAgB,wBAAwB,CAAC,QAAoB;IAC3D,OAAO,IAAA,wBAAiB,EAAC;QACvB,oBAAoB,EAAE,EAAE;QAExB,SAAS,EAAE,CAAC,sBAAQ,CAAC;QACrB,2BAA2B;QAC3B,IAAI,EAAE,SAAS;QACf,QAAQ;KACT,CAAC,CAAC;AACL,CAAC;AAEM,MAAM,gBAAgB,GAAG,CAI9B,gBAA6C,EAC7C,EAAE;IACF,6BAA6B;IAC7B,qBAAqB;IACrB,OAAO,KAAK,WAAW,KAAsB,EAAE,IAAqB;QAClE,SAAS,IAAI,CAAC,MAAsB;YAClC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,MAAM,gBAAgB,CAAC,SAAS,CAAC;YACtC,aAAa,EAAE,0CAAkB;YACjC,aAAa,EAAE,SAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE;gBACzB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;YACpB,aAAa,EAAE;gBACb,WAAW,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE;gBACnC,IAAI,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;aAC5B;SACF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAvBW,QAAA,gBAAgB,oBAuB3B"}