@digital-alchemy/hass 0.2.0

package/dist/extensions/fetch-api.extension.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FetchAPI = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@digital-alchemy/core");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const __1 = require("..");
+function FetchAPI({ logger, lifecycle, context, config, }) {
+    let fetcher;
+    let downloader;
+    // Load configurations
+    lifecycle.onPostConfig(() => {
+        const fetch = core_1.ZCC.createFetcher({
+            baseUrl: config.hass.BASE_URL,
+            context,
+            headers: { Authorization: `Bearer ${config.hass.TOKEN}` },
+        });
+        fetcher = fetch.fetch;
+        downloader = fetch.download;
+    }, __1.PostConfigPriorities.FETCH);
+    async function calendarSearch({ calendar, start = (0, dayjs_1.default)(), end, }) {
+        if (Array.isArray(calendar)) {
+            const list = await Promise.all(calendar.map(async (cal) => await calendarSearch({ calendar: cal, end, start })));
+            return list
+                .flat()
+                .sort((a, b) => a.start.isSame(b.start)
+                ? core_1.NO_CHANGE
+                : a.start.isAfter(b.start)
+                    ? core_1.UP
+                    : core_1.DOWN);
+        }
+        const params = { end: end.toISOString(), start: start.toISOString() };
+        const events = await fetcher({
+            params,
+            url: `/api/calendars/${calendar}`,
+        });
+        logger.trace({ ...params }, `%s search found %s events`, calendar, events.length);
+        return events.map(({ start, end, ...extra }) => ({
+            ...extra,
+            end: (0, dayjs_1.default)(end.dateTime),
+            start: (0, dayjs_1.default)(start.dateTime),
+        }));
+    }
+    async function callService(serviceName, data) {
+        const [domain, service] = serviceName.split(".");
+        return await fetcher({
+            body: data,
+            method: "post",
+            url: `/api/services/${domain}/${service}`,
+        });
+    }
+    async function checkConfig() {
+        logger.trace(`check config`);
+        return await fetcher({
+            method: `post`,
+            url: `/api/config/core/check_config`,
+        });
+    }
+    async function download(destination, fetchWith) {
+        await downloader({
+            ...fetchWith,
+            baseUrl: config.hass.BASE_URL,
+            destination,
+            headers: { Authorization: `Bearer ${config.hass.TOKEN}` },
+        });
+    }
+    async function fetchEntityCustomizations(entityId) {
+        return await fetcher({
+            url: `/api/config/customize/config/${entityId}`,
+        });
+    }
+    async function fetchEntityHistory(entity_id, from, to, extra = {}) {
+        logger.info({ entity_id, from: from.toISOString(), to: to.toISOString() }, `fetch entity history`);
+        const result = await fetcher({
+            params: {
+                end_time: to.toISOString(),
+                filter_entity_id: entity_id,
+                ...extra,
+            },
+            url: `/api/history/period/${from.toISOString()}`,
+        });
+        if (!Array.isArray(result)) {
+            logger.error({ result }, `unexpected return result`);
+            return [];
+        }
+        const [out] = result;
+        return out;
+    }
+    async function fireEvent(event, data) {
+        logger.trace({ name: event, ...data }, `Firing event`);
+        const response = await fetcher({
+            // body: data,
+            body: {},
+            method: "post",
+            url: `/api/events/${event}`,
+        });
+        if (response?.message !== `Event ${event} fired.`) {
+            logger.debug({ response }, `unexpected response from firing event`);
+        }
+    }
+    async function getAllEntities() {
+        logger.trace(`get all entities`);
+        return await fetcher({ url: `/api/states` });
+    }
+    async function getHassConfig() {
+        logger.trace(`get config`);
+        return await fetcher({ url: `/api/config` });
+    }
+    async function getLogs() {
+        logger.trace(`get logs`);
+        const results = await fetcher({
+            url: `/api/error/all`,
+        });
+        return results.map(i => {
+            i.timestamp = Math.floor(i.timestamp * core_1.SECOND);
+            i.first_occurred = Math.floor(i.first_occurred * core_1.SECOND);
+            return i;
+        });
+    }
+    async function getRawLogs() {
+        logger.trace(`get raw logs`);
+        return await fetcher({ process: "text", url: `/api/error_log` });
+    }
+    async function listServices() {
+        logger.trace(`list services`);
+        return await fetcher({ url: `/api/services` });
+    }
+    async function updateEntity(entity_id, { attributes, state }) {
+        const body = {};
+        if (state !== undefined) {
+            body.state = state;
+        }
+        if (!core_1.is.empty(attributes)) {
+            body.attributes = attributes;
+        }
+        logger.trace({ ...body, name: entity_id }, `set entity state`);
+        await fetcher({ body, method: "post", url: `/api/states/${entity_id}` });
+    }
+    async function webhook(name, data = {}) {
+        logger.trace({ ...data, name }, `webhook`);
+        await fetcher({
+            body: data,
+            method: "post",
+            process: "text",
+            url: `/api/webhook/${name}`,
+        });
+    }
+    async function checkCredentials() {
+        logger.trace(`check credentials`);
+        return await fetcher({
+            url: `/api/`,
+        });
+    }
+    return {
+        calendarSearch,
+        callService,
+        checkConfig,
+        checkCredentials,
+        download,
+        fetch: fetcher,
+        fetchEntityCustomizations,
+        fetchEntityHistory,
+        fireEvent,
+        getAllEntities,
+        getConfig: getHassConfig,
+        getLogs,
+        getRawLogs,
+        listServices,
+        updateEntity,
+        webhook,
+    };
+}
+exports.FetchAPI = FetchAPI;
+//# sourceMappingURL=fetch-api.extension.js.map

package/dist/extensions/fetch-api.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-api.extension.js","sourceRoot":"","sources":["../../src/extensions/fetch-api.extension.ts"],"names":[],"mappings":";;;;AAAA,gDAY+B;AAC/B,0DAA0B;AAE1B,0BAaY;AAUZ,SAAgB,QAAQ,CAAC,EACvB,MAAM,EACN,SAAS,EACT,OAAO,EACP,MAAM,GACS;IACf,IAAI,OAAe,CAAC;IACpB,IAAI,UAAqB,CAAC;IAE1B,sBAAsB;IACtB,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE;QAC1B,MAAM,KAAK,GAAG,UAAG,CAAC,aAAa,CAAC;YAC9B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ;YAC7B,OAAO;YACP,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE;SAC1D,CAAC,CAAC;QACH,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;QACtB,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC,EAAE,wBAAoB,CAAC,KAAK,CAAC,CAAC;IAE/B,KAAK,UAAU,cAAc,CAAC,EAC5B,QAAQ,EACR,KAAK,GAAG,IAAA,eAAK,GAAE,EACf,GAAG,GACkB;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5B,QAAQ,CAAC,GAAG,CACV,KAAK,EAAC,GAAG,EAAC,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CACjE,CACF,CAAC;YACF,OAAO,IAAI;iBACR,IAAI,EAAE;iBACN,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACb,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;gBACrB,CAAC,CAAC,gBAAS;gBACX,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;oBACxB,CAAC,CAAC,SAAE;oBACJ,CAAC,CAAC,WAAI,CACX,CAAC;QACN,CAAC;QAED,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QACtE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAqB;YAC/C,MAAM;YACN,GAAG,EAAE,kBAAkB,QAAQ,EAAE;SAClC,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CACV,EAAE,GAAG,MAAM,EAAE,EACb,2BAA2B,EAC3B,QAAQ,EACR,MAAM,CAAC,MAAM,CACd,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YAC/C,GAAG,KAAK;YACR,GAAG,EAAE,IAAA,eAAK,EAAC,GAAG,CAAC,QAAQ,CAAC;YACxB,KAAK,EAAE,IAAA,eAAK,EAAC,KAAK,CAAC,QAAQ,CAAC;SAC7B,CAAC,CAAC,CAAC;IACN,CAAC;IAED,KAAK,UAAU,WAAW,CACxB,WAAoB,EACpB,IAAsC;QAEtC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjD,OAAO,MAAM,OAAO,CAAC;YACnB,IAAI,EAAE,IAAkB;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,iBAAiB,MAAM,IAAI,OAAO,EAAE;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,WAAW;QACxB,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7B,OAAO,MAAM,OAAO,CAAC;YACnB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,+BAA+B;SACrC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,QAAQ,CACrB,WAAmB,EACnB,SAAiC;QAEjC,MAAM,UAAU,CAAC;YACf,GAAG,SAAS;YACZ,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ;YAC7B,WAAW;YACX,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE;SAC1D,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,yBAAyB,CAKtC,QAA2B;QAC3B,OAAO,MAAM,OAAO,CAAI;YACtB,GAAG,EAAE,gCAAgC,QAAQ,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,kBAAkB,CAI/B,SAAiB,EACjB,IAAU,EACV,EAAQ,EACR,QAAmC,EAAE;QAErC,MAAM,CAAC,IAAI,CACT,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE,EAC7D,sBAAsB,CACvB,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAQ;YAClC,MAAM,EAAE;gBACN,QAAQ,EAAE,EAAE,CAAC,WAAW,EAAE;gBAC1B,gBAAgB,EAAE,SAAS;gBAC3B,GAAG,KAAK;aACT;YACD,GAAG,EAAE,uBAAuB,IAAI,CAAC,WAAW,EAAE,EAAE;SACjD,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,0BAA0B,CAAC,CAAC;YACrD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,UAAU,SAAS,CACtB,KAAa,EACb,IAAW;QAEX,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAsB;YAClD,cAAc;YACd,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,eAAe,KAAK,EAAE;SAC5B,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE,OAAO,KAAK,SAAS,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,uCAAuC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,KAAK,UAAU,cAAc;QAC3B,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACjC,OAAO,MAAM,OAAO,CAA8B,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,KAAK,UAAU,aAAa;QAC1B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC3B,OAAO,MAAM,OAAO,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,UAAU,OAAO;QACpB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAA+B;YAC1D,GAAG,EAAE,gBAAgB;SACtB,CAAC,CAAC;QACH,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACrB,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,GAAG,aAAM,CAAC,CAAC;YAC/C,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,GAAG,aAAM,CAAC,CAAC;YACzD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,UAAU;QACvB,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7B,OAAO,MAAM,OAAO,CAAS,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,UAAU,YAAY;QACzB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,OAAO,MAAM,OAAO,CAAmB,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,UAAU,YAAY,CAIzB,SAAsB,EACtB,EAAE,UAAU,EAAE,KAAK,EAA+B;QAElD,MAAM,IAAI,GAAoB,EAAE,CAAC;QACjC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,SAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,kBAAkB,CAAC,CAAC;QAC/D,MAAM,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,SAAS,EAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,UAAU,OAAO,CAAC,IAAY,EAAE,OAAe,EAAE;QACpD,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;QAC3C,MAAM,OAAO,CAAC;YACZ,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,MAAM;YACf,GAAG,EAAE,gBAAgB,IAAI,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,gBAAgB;QAC7B,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAClC,OAAO,MAAM,OAAO,CAAC;YACnB,GAAG,EAAE,OAAO;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,cAAc;QACd,WAAW;QACX,WAAW;QACX,gBAAgB;QAChB,QAAQ;QACR,KAAK,EAAE,OAAO;QACd,yBAAyB;QACzB,kBAAkB;QAClB,SAAS;QACT,cAAc;QACd,SAAS,EAAE,aAAa;QACxB,OAAO;QACP,UAAU;QACV,YAAY;QACZ,YAAY;QACZ,OAAO;KACR,CAAC;AACJ,CAAC;AAzOD,4BAyOC"}

package/dist/extensions/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./call-proxy.extension";
+export * from "./config.extension";
+export * from "./entity-manager.extension";
+export * from "./fetch-api.extension";
+export * from "./utilities.extension";
+export * from "./websocket-api.extension";

package/dist/extensions/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./call-proxy.extension"), exports);
+tslib_1.__exportStar(require("./config.extension"), exports);
+tslib_1.__exportStar(require("./entity-manager.extension"), exports);
+tslib_1.__exportStar(require("./fetch-api.extension"), exports);
+tslib_1.__exportStar(require("./utilities.extension"), exports);
+tslib_1.__exportStar(require("./websocket-api.extension"), exports);
+//# sourceMappingURL=index.js.map

package/dist/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":";;;AAAA,iEAAuC;AACvC,6DAAmC;AACnC,qEAA2C;AAC3C,gEAAsC;AACtC,gEAAsC;AACtC,oEAA0C"}

package/dist/extensions/utilities.extension.d.ts

@@ -0,0 +1,9 @@
+import { TServiceParams } from "@digital-alchemy/core";
+import { BackupResponse, HomeAssistantBackup } from "..";
+export declare function Utilities({ logger, hass }: TServiceParams): {
+    backup: {
+        generate: () => Promise<HomeAssistantBackup>;
+        list: () => Promise<BackupResponse>;
+        remove: (slug: string) => Promise<void>;
+    };
+};

package/dist/extensions/utilities.extension.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utilities = void 0;
+const core_1 = require("@digital-alchemy/core");
+const __1 = require("..");
+function Utilities({ logger, hass }) {
+    async function generate() {
+        let current = await list();
+        // const originalLength = current.backups.length;
+        if (current.backing_up) {
+            logger.warn(`a backup is currently in progress. Waiting for that to complete instead.`);
+        }
+        else {
+            logger.info("initiating new backup");
+            hass.socket.sendMessage({
+                type: __1.HASSIO_WS_COMMAND.generate_backup,
+            });
+            while (current.backing_up === false) {
+                logger.debug("... waiting");
+                await (0, core_1.sleep)(core_1.HALF * core_1.SECOND);
+                current = await list();
+            }
+        }
+        while (current.backing_up === true) {
+            logger.debug("... waiting");
+            await (0, core_1.sleep)(core_1.HALF * core_1.SECOND);
+            current = await list();
+        }
+        logger.info(`backup complete`);
+        return current.backups.pop();
+    }
+    async function list() {
+        return await hass.socket.sendMessage({
+            type: __1.HASSIO_WS_COMMAND.backup_info,
+        });
+    }
+    async function remove(slug) {
+        await hass.socket.sendMessage({ slug, type: __1.HASSIO_WS_COMMAND.remove_backup }, false);
+    }
+    return { backup: { generate, list, remove } };
+}
+exports.Utilities = Utilities;
+//# sourceMappingURL=utilities.extension.js.map

package/dist/extensions/utilities.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.extension.js","sourceRoot":"","sources":["../../src/extensions/utilities.extension.ts"],"names":[],"mappings":";;;AAAA,gDAA4E;AAE5E,0BAA4E;AAE5E,SAAgB,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAkB;IACxD,KAAK,UAAU,QAAQ;QACrB,IAAI,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,iDAAiD;QACjD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CACT,0EAA0E,CAC3E,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,qBAAiB,CAAC,eAAe;aACxC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;gBACpC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAC5B,MAAM,IAAA,YAAK,EAAC,WAAI,GAAG,aAAM,CAAC,CAAC;gBAC3B,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC5B,MAAM,IAAA,YAAK,EAAC,WAAI,GAAG,aAAM,CAAC,CAAC;YAC3B,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;QACzB,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED,KAAK,UAAU,IAAI;QACjB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAiB;YACnD,IAAI,EAAE,qBAAiB,CAAC,WAAW;SACpC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,UAAU,MAAM,CAAC,IAAY;QAChC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAC3B,EAAE,IAAI,EAAE,IAAI,EAAE,qBAAiB,CAAC,aAAa,EAAE,EAC/C,KAAK,CACN,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC;AAChD,CAAC;AA1CD,8BA0CC"}

package/dist/extensions/websocket-api.extension.d.ts

@@ -0,0 +1,39 @@
+import { TBlackHole, TServiceParams } from "@digital-alchemy/core";
+import { HASSIO_WS_COMMAND, OnHassEventOptions } from "..";
+export declare const SOCKET_CONNECTED = "SOCKET_CONNECTED";
+export declare function WebsocketAPI({ context, event, hass, config, lifecycle, logger, scheduler, }: TServiceParams): {
+    /**
+     * Convenient wrapper for sendMessage
+     */
+    fireEvent: (event_type: string, event_data?: object) => Promise<unknown>;
+    getConnectionActive: () => boolean;
+    /**
+     * Set up a new websocket connection to home assistant
+     *
+     * This doesn't normally need to be called by applications, the extension self manages
+     */
+    init: () => Promise<void>;
+    onConnect: (callback: () => TBlackHole) => void;
+    /**
+     * Attach to the incoming stream of socket events. Do your own filtering and processing from there
+     *
+     * Returns removal function
+     */
+    onEvent: <DATA extends object>({ context, label, event, once, exec, }: OnHassEventOptions<DATA>) => () => void;
+    /**
+     * Send a message to home assistant via the socket connection
+     *
+     * Applications probably want a higher level function than this
+     */
+    sendMessage: <RESPONSE_VALUE extends unknown = unknown>(data: {
+        [key: string]: unknown;
+        type: `${HASSIO_WS_COMMAND}`;
+        id?: number;
+    }, waitForResponse?: boolean, subscription?: () => void) => Promise<RESPONSE_VALUE>;
+    /**
+     * remove the current socket connection to home assistant
+     *
+     * will need to call init() again to start up
+     */
+    teardown: () => Promise<void>;
+};

package/dist/extensions/websocket-api.extension.js

@@ -0,0 +1,363 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketAPI = exports.SOCKET_CONNECTED = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@digital-alchemy/core");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const events_1 = tslib_1.__importDefault(require("events"));
+const process_1 = require("process");
+const ws_1 = tslib_1.__importDefault(require("ws"));
+const __1 = require("..");
+let connection;
+const CONNECTION_OPEN = 1;
+let CONNECTION_ACTIVE = false;
+const CLEANUP_INTERVAL = 5;
+const PING_INTERVAL = 10;
+const UNLIMITED = 0;
+let messageCount = core_1.START;
+exports.SOCKET_CONNECTED = "SOCKET_CONNECTED";
+function WebsocketAPI({ context, event, hass, config, lifecycle, logger, scheduler, }) {
+    let AUTH_TIMEOUT;
+    /**
+     * Local attachment points for socket events
+     */
+    const socketEvents = new events_1.default();
+    event.setMaxListeners(UNLIMITED);
+    let connecting;
+    let MESSAGE_TIMESTAMPS = [];
+    const waitingCallback = new Map();
+    // Start the socket
+    lifecycle.onBootstrap(async () => {
+        if (config.hass.AUTO_CONNECT_SOCKET) {
+            logger.debug(`auto starting connection`);
+            await init();
+            attachScheduledFunctions();
+        }
+    });
+    function attachScheduledFunctions() {
+        logger.trace(`attaching interval schedules`);
+        // Set up intervals
+        scheduler.interval({
+            exec: async () => await ping(),
+            interval: PING_INTERVAL * core_1.SECOND,
+        });
+        scheduler.interval({
+            exec: () => {
+                const now = Date.now();
+                MESSAGE_TIMESTAMPS = MESSAGE_TIMESTAMPS.filter(time => time > now - core_1.SECOND);
+            },
+            interval: CLEANUP_INTERVAL * core_1.SECOND,
+        });
+    }
+    lifecycle.onShutdownComplete(async () => {
+        logger.debug(`shutdown - tearing down connection`);
+        await teardown();
+    });
+    async function ping() {
+        if (!CONNECTION_ACTIVE) {
+            return;
+        }
+        try {
+            const pong = await sendMessage({ type: __1.HASSIO_WS_COMMAND.ping });
+            if (pong) {
+                return;
+            }
+            // Tends to happen when HA resets
+            // Resolution is to re-connect when it's up again
+            logger.error(`failed to pong!`);
+        }
+        catch (error) {
+            logger.error({ error }, `ping error`);
+        }
+        logger.debug(`ping teardown`);
+        await teardown();
+        logger.info(`🪃 ping re-init`);
+        await init();
+    }
+    async function teardown() {
+        if (!connection) {
+            return;
+        }
+        if (connection.readyState === CONNECTION_OPEN) {
+            logger.debug(`closing current connection`);
+            CONNECTION_ACTIVE = false;
+            connection.close();
+        }
+        connection = undefined;
+    }
+    async function fireEvent(event_type, event_data) {
+        // logger.debug({ event_data, event_type, type: "fire_event" });
+        return await sendMessage({ event_data, event_type, type: "fire_event" });
+    }
+    async function sendMessage(data, waitForResponse = true, subscription) {
+        if (!connection) {
+            logger.error("cannot send messages before socket is initialized");
+            logger.info("🪃 on error re-init");
+            await init();
+            return undefined;
+        }
+        countMessage();
+        if (data.type !== __1.HASSIO_WS_COMMAND.auth) {
+            if (!CONNECTION_ACTIVE) {
+                logger.error({ data }, `cannot send message, connection is not open`);
+                return undefined;
+            }
+            data.id = messageCount;
+        }
+        const json = JSON.stringify(data);
+        connection.send(json);
+        if (subscription) {
+            return data.id;
+        }
+        if (!waitForResponse) {
+            return undefined;
+        }
+        return new Promise(done => waitingCallback.set(messageCount, done));
+    }
+    function countMessage() {
+        messageCount++;
+        const now = Date.now();
+        MESSAGE_TIMESTAMPS.push(now);
+        const count = MESSAGE_TIMESTAMPS.filter(time => time > now - core_1.SECOND).length;
+        if (count > config.hass.SOCKET_CRASH_REQUESTS_PER_SEC) {
+            logger.fatal(`FATAL ERROR: Exceeded {CRASH_REQUESTS_PER_MIN} threshold.`);
+            (0, process_1.exit)();
+        }
+        if (count > config.hass.SOCKET_WARN_REQUESTS_PER_SEC) {
+            logger.warn(`message traffic ${config.hass.SOCKET_CRASH_REQUESTS_PER_SEC}>${count}>${config.hass.SOCKET_WARN_REQUESTS_PER_SEC}`);
+        }
+    }
+    function getUrl() {
+        const url = new URL(config.hass.BASE_URL);
+        const protocol = url.protocol === `http:` ? `ws:` : `wss:`;
+        const path = url.pathname === "/" ? "" : url.pathname;
+        const port = url.port ? `:${url.port}` : "";
+        return (config.hass.WEBSOCKET_URL ||
+            `${protocol}//${url.hostname}${port}${path}/api/websocket`);
+    }
+    async function init() {
+        const now = (0, dayjs_1.default)();
+        if (connecting) {
+            if (connecting.add(config.hass.RETRY_INTERVAL, "second").isAfter(now)) {
+                logger.debug("stopped, already connecting");
+                return;
+            }
+            connection = undefined;
+        }
+        if (connection) {
+            throw new core_1.InternalError(context, "ExistingConnection", `Destroy the current connection before creating a new one`);
+        }
+        connecting = now;
+        logger.debug(`CONNECTION_ACTIVE = {false}`);
+        const url = getUrl();
+        CONNECTION_ACTIVE = false;
+        try {
+            messageCount = core_1.START;
+            connection = new ws_1.default(url);
+            connection.on("message", async (message) => {
+                try {
+                    await onMessage(JSON.parse(message.toString()));
+                }
+                catch (error) {
+                    // My expectation is `ZCC.safeExec` should trap any application errors
+                    // This try/catch should actually be excessive
+                    // If this error happens, something weird is happening
+                    logger.error({ error }, `💣 error bubbled up from websocket message event handler`);
+                }
+            });
+            connection.on("error", async (error) => {
+                logger.error({ error: error.message || error }, "Socket error");
+                if (!CONNECTION_ACTIVE) {
+                    await (0, core_1.sleep)(config.hass.RETRY_INTERVAL);
+                    await teardown();
+                    logger.info("🪃 on error re-init");
+                    await (0, core_1.sleep)(core_1.SECOND);
+                    await init();
+                }
+            });
+            connection.on("close", async () => {
+                logger.warn("connection closed");
+                await teardown();
+                await (0, core_1.sleep)(config.hass.RETRY_INTERVAL);
+                logger.info("🪃 on close re-init");
+                await init();
+            });
+            return await new Promise(done => {
+                connection.once("open", () => {
+                    connecting = undefined;
+                    done();
+                });
+            });
+        }
+        catch (error) {
+            logger.error({ error, url }, `initConnection error`);
+            connecting = undefined;
+            setTimeout(async () => {
+                logger.debug(`🪃 retry re-init`);
+                await init();
+            }, config.hass.RETRY_INTERVAL);
+        }
+    }
+    /**
+     * Called on incoming message.
+     * Intended to interpret the basic concept of the message,
+     * and route it to the correct callback / global channel / etc
+     *
+     * ## auth_required
+     * Hello message from server, should reply back with an auth msg
+     * ## auth_ok
+     * Follow up with a request to receive all events, and request a current state listing
+     * ## event
+     * Something updated it's state
+     * ## pong
+     * Reply to outgoing ping()
+     * ## result
+     * Response to an outgoing emit
+     */
+    async function onMessage(message) {
+        const id = Number(message.id);
+        switch (message.type) {
+            case __1.HassSocketMessageTypes.auth_required:
+                logger.debug(`sending authentication`);
+                return await sendAuth();
+            case __1.HassSocketMessageTypes.auth_ok:
+                logger.debug(`CONNECTION_ACTIVE = {true}`);
+                // * Flag as valid connection
+                CONNECTION_ACTIVE = true;
+                connecting = undefined;
+                event.emit(exports.SOCKET_CONNECTED);
+                clearTimeout(AUTH_TIMEOUT);
+                logger.debug(`event subscriptions starting`);
+                await sendMessage({ type: __1.HASSIO_WS_COMMAND.subscribe_events }, false);
+                event.emit(__1.ON_SOCKET_AUTH);
+                return;
+            case __1.HassSocketMessageTypes.event:
+                return await onMessageEvent(id, message);
+            case __1.HassSocketMessageTypes.pong:
+                // 🏓
+                if (waitingCallback.has(id)) {
+                    const f = waitingCallback.get(id);
+                    waitingCallback.delete(id);
+                    f(message);
+                }
+                return;
+            case __1.HassSocketMessageTypes.result:
+                return await onMessageResult(id, message);
+            case __1.HassSocketMessageTypes.auth_invalid:
+                logger.debug(`CONNECTION_ACTIVE = {false}`);
+                CONNECTION_ACTIVE = false;
+                logger.fatal(message.message);
+                return;
+            default:
+                // Code error probably
+                logger.error(`unknown websocket message type: ${message.type}`);
+        }
+    }
+    function onMessageEvent(id, message) {
+        if (message.event.event_type === "state_changed") {
+            const { new_state, old_state } = message.event.data;
+            const id = new_state?.entity_id || old_state.entity_id;
+            if (core_1.is.empty(id)) {
+                throw new core_1.InternalError(context, "NO_ID", "Received state change, but could not identify an entity_id");
+            }
+            // ? null = deleted entity
+            // TODO: handle renames properly
+            if (new_state || new_state === null) {
+                hass.entity[__1.ENTITY_UPDATE_RECEIVER](id, new_state, old_state);
+            }
+            else {
+                // FIXME: probably removal / rename?
+                // It's an edge case for sure, and not positive this code should handle it
+                // If you have thoughts, chime in somewhere and we can do more sane things
+                logger.debug({ message }, `no new state for entity, what caused this?`);
+                return;
+            }
+        }
+        if (waitingCallback.has(id)) {
+            const f = waitingCallback.get(id);
+            waitingCallback.delete(id);
+            f(message.event.result);
+        }
+        socketEvents.emit(message.event.event_type, message.event);
+    }
+    function onMessageResult(id, message) {
+        if (waitingCallback.has(id)) {
+            if (message.error) {
+                logger.error({ message });
+            }
+            const f = waitingCallback.get(id);
+            waitingCallback.delete(id);
+            f(message.result);
+        }
+    }
+    async function sendAuth() {
+        AUTH_TIMEOUT = setTimeout(() => {
+            logger.error(`did not receive an auth response, retrying`);
+            sendAuth();
+        }, config.hass.RETRY_INTERVAL);
+        await sendMessage({
+            access_token: config.hass.TOKEN,
+            type: __1.HASSIO_WS_COMMAND.auth,
+        });
+    }
+    function onEvent({ context, label, event, once, exec, }) {
+        logger.trace({ context, event }, `attaching socket event listener`);
+        const callback = async (data) => {
+            await core_1.ZCC.safeExec({
+                duration: __1.SOCKET_EVENT_EXECUTION_TIME,
+                errors: __1.SOCKET_EVENT_ERRORS,
+                exec: async () => await exec(data),
+                executions: __1.SOCKET_EVENT_EXECUTION_COUNT,
+                labels: { context, event, label },
+            });
+        };
+        if (once) {
+            socketEvents.once(event, callback);
+        }
+        else {
+            socketEvents.on(event, callback);
+        }
+        return () => {
+            logger.trace({ context, event }, `removing socket event listener`);
+            socketEvents.removeListener(event, callback);
+        };
+    }
+    return {
+        /**
+         * Convenient wrapper for sendMessage
+         */
+        fireEvent,
+        getConnectionActive: () => CONNECTION_ACTIVE,
+        /**
+         * Set up a new websocket connection to home assistant
+         *
+         * This doesn't normally need to be called by applications, the extension self manages
+         */
+        init,
+        onConnect: (callback) => {
+            event.on(exports.SOCKET_CONNECTED, async () => {
+                await core_1.ZCC.safeExec(async () => await callback());
+            });
+        },
+        /**
+         * Attach to the incoming stream of socket events. Do your own filtering and processing from there
+         *
+         * Returns removal function
+         */
+        onEvent,
+        /**
+         * Send a message to home assistant via the socket connection
+         *
+         * Applications probably want a higher level function than this
+         */
+        sendMessage,
+        /**
+         * remove the current socket connection to home assistant
+         *
+         * will need to call init() again to start up
+         */
+        teardown,
+    };
+}
+exports.WebsocketAPI = WebsocketAPI;
+//# sourceMappingURL=websocket-api.extension.js.map