@digital-alchemy/core 0.1.0

package/dist/automation/extensions/sequence-matcher.extension.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SequenceWatcher = void 0;
+const tslib_1 = require("tslib");
+const object_path_1 = tslib_1.__importDefault(require("object-path"));
+const uuid_1 = require("uuid");
+const utilities_1 = require("../../utilities");
+const __1 = require("..");
+// eslint-disable-next-line @typescript-eslint/unbound-method
+const { get } = object_path_1.default;
+function SequenceWatcher({ logger, hass, config }) {
+    const ACTIVE = new Map();
+    const WATCHED_EVENTS = new Map();
+    const EVENT_REMOVAL = new Map();
+    async function onMatch(data) {
+        await data.exec();
+        const reset = data.reset ?? "self";
+        if (reset === "self") {
+            ACTIVE.delete(data);
+            return;
+        }
+        if (!utilities_1.is.object(reset)) {
+            logger.error({ reset: data.reset }, `bad reset type`);
+            return;
+        }
+        const labels = new Set([reset.label].flat().filter(i => !utilities_1.is.empty(i)));
+        [...ACTIVE.keys()].forEach(key => {
+            const item = ACTIVE.get(key);
+            if (labels.has(item.label)) {
+                item.interrupt.kill("stop");
+                ACTIVE.delete(key);
+            }
+        });
+    }
+    function trigger(type, event_data) {
+        WATCHED_EVENTS.get(type).forEach(async (data) => {
+            const allowed = data.filter(event_data);
+            if (!allowed) {
+                return;
+            }
+            // * Identify if it is already being watched
+            const current = ACTIVE.get(data);
+            const match = [];
+            if (current) {
+                // if so, kill the current sleep so it doesn't gc early
+                current.interrupt.kill("stop");
+                // prepend the current matches in to the new list
+                match.push(...current.match);
+            }
+            // * Grab the new value from the event, and add it on the list
+            const value = get(event_data, data.path);
+            match.push(value);
+            // * If the sequence matches, fire the callback
+            if (utilities_1.is.equal(match, data.match)) {
+                await onMatch(data);
+            }
+            // * wait out the match timeout using a sleep that can be cancelled
+            const interrupt = (0, utilities_1.sleep)(config.automation.SEQUENCE_TIMEOUT);
+            ACTIVE.set(data, {
+                interrupt,
+                label: data.label,
+                match,
+                reset: data.reset,
+            });
+            await interrupt;
+            // * New event hasn't come in within time period. >>> GC
+            ACTIVE.delete(data);
+        });
+    }
+    function SequenceWatcher(data) {
+        const { exec, event_type, match, context, label, path, filter } = data;
+        logger.trace({ context }, `setting up sequence watcher`);
+        const id = (0, uuid_1.v4)();
+        // If this is the first watcher for this event, set up a listener
+        let watcher = WATCHED_EVENTS.get(event_type);
+        if (!watcher) {
+            watcher = [];
+            logger.trace({ event_type }, `listening for socket event`);
+            const remover = hass.socket.onEvent({
+                context,
+                event: event_type,
+                exec: eventData => trigger(event_type, eventData),
+                label,
+            });
+            EVENT_REMOVAL.set(event_type, remover);
+        }
+        // Append watcher to list
+        WATCHED_EVENTS.set(event_type, [
+            ...watcher,
+            {
+                context,
+                event_type,
+                exec: () => {
+                    logger.trace({ context, label, match }, `sequence match trigger`);
+                    setImmediate(async () => await utilities_1.ZCC.safeExec({
+                        duration: __1.SEQUENCE_MATCHER_EXECUTION_TIME,
+                        errors: __1.SEQUENCE_MATCHER_ERRORS,
+                        exec: async () => await exec(),
+                        executions: __1.SEQUENCE_MATCHER_EXECUTION_COUNT,
+                        labels: { context, label },
+                    }));
+                },
+                filter: filter,
+                id,
+                label,
+                match,
+                path,
+            },
+        ]);
+        // Return a removal function
+        return () => {
+            const watcher = WATCHED_EVENTS.get(event_type).filter(item => item.id !== id);
+            if (utilities_1.is.empty(watcher)) {
+                logger.debug({ event_type }, `last watcher for event removed, cleaning up socket event listener`);
+                WATCHED_EVENTS.delete(event_type);
+                EVENT_REMOVAL.get(event_type)();
+                EVENT_REMOVAL.delete(event_type);
+                return;
+            }
+            WATCHED_EVENTS.set(event_type, watcher);
+        };
+    }
+    return SequenceWatcher;
+}
+exports.SequenceWatcher = SequenceWatcher;
+//# sourceMappingURL=sequence-matcher.extension.js.map

package/dist/automation/extensions/sequence-matcher.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sequence-matcher.extension.js","sourceRoot":"","sources":["../../../src/automation/extensions/sequence-matcher.extension.ts"],"names":[],"mappings":";;;;AAAA,sEAA8B;AAC9B,+BAA0B;AAG1B,+CAAiD;AACjD,0BAQY;AAEZ,6DAA6D;AAC7D,MAAM,EAAE,GAAG,EAAE,GAAG,qBAAG,CAAC;AAEpB,SAAgB,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAkB;IACtE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyB,CAAC;IAChD,MAAM,cAAc,GAAG,IAAI,GAAG,EAA4B,CAAC;IAC3D,MAAM,aAAa,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEpD,KAAK,UAAU,OAAO,CAAC,IAA0B;QAC/C,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;QACnC,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YACrB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACpB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,cAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,gBAAgB,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,cAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC5B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS,OAAO,CAAC,IAAY,EAAE,UAAkB;QAC/C,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO;YACT,CAAC;YAED,4CAA4C;YAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,OAAO,EAAE,CAAC;gBACZ,uDAAuD;gBACvD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC/B,iDAAiD;gBACjD,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;YAED,8DAA8D;YAC9D,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAElB,+CAA+C;YAC/C,IAAI,cAAE,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YAED,mEAAmE;YACnE,MAAM,SAAS,GAAG,IAAA,iBAAK,EAAC,MAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;gBACf,SAAS;gBACT,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK;gBACL,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC,CAAC;YACH,MAAM,SAAS,CAAC;YAEhB,wDAAwD;YACxD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS,eAAe,CAGtB,IAAuC;QACvC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,6BAA6B,CAAC,CAAC;QACzD,MAAM,EAAE,GAAG,IAAA,SAAE,GAAE,CAAC;QAEhB,iEAAiE;QACjE,IAAI,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,4BAA4B,CAAC,CAAC;YAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;gBAClC,OAAO;gBACP,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBACjD,KAAK;aACN,CAAC,CAAC;YACH,aAAa,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;QAED,yBAAyB;QACzB,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE;YAC7B,GAAG,OAAO;YACV;gBACE,OAAO;gBACP,UAAU;gBACV,IAAI,EAAE,GAAG,EAAE;oBACT,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,wBAAwB,CAAC,CAAC;oBAClE,YAAY,CACV,KAAK,IAAI,EAAE,CACT,MAAM,eAAG,CAAC,QAAQ,CAAC;wBACjB,QAAQ,EAAE,mCAA+B;wBACzC,MAAM,EAAE,2BAAuB;wBAC/B,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,EAAE;wBAC9B,UAAU,EAAE,oCAAgC;wBAC5C,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;qBAC3B,CAAC,CACL,CAAC;gBACJ,CAAC;gBACD,MAAM,EAAE,MAAuB;gBAC/B,EAAE;gBACF,KAAK;gBACL,KAAK;gBACL,IAAI;aACL;SACF,CAAC,CAAC;QAEH,4BAA4B;QAC5B,OAAO,GAAG,EAAE;YACV,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CACnD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CACvB,CAAC;YACF,IAAI,cAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CACV,EAAE,UAAU,EAAE,EACd,mEAAmE,CACpE,CAAC;gBACF,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBAClC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAChC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACjC,OAAO;YACT,CAAC;YACD,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAxID,0CAwIC"}

package/dist/automation/extensions/solar-calc.extension.d.ts

@@ -0,0 +1,20 @@
+import { Dayjs } from "dayjs";
+import { TServiceParams } from "../../boilerplate";
+import { TBlackHole, TContext } from "../../utilities";
+export type SolarEvents = "dawn" | "dusk" | "solarNoon" | "sunrise" | "nightStart" | "nightEnd" | "sunset" | "sunriseEnd" | "sunsetStart";
+/**
+ * Benefits from a persistent cache, like Redis
+ */
+export declare function SolarCalculator({ logger, cache, scheduler, context, hass, lifecycle, }: TServiceParams): SolarReference;
+type OnSolarEvent = {
+    context: TContext;
+    label?: string;
+    eventName: SolarEvents;
+    exec: () => TBlackHole;
+};
+type SolarReference = Record<SolarEvents, Dayjs> & {
+    isBetween: (a: SolarEvents, b: SolarEvents) => boolean;
+    loaded: boolean;
+    onEvent: (options: OnSolarEvent) => TBlackHole;
+};
+export {};

package/dist/automation/extensions/solar-calc.extension.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SolarCalculator = void 0;
+const tslib_1 = require("tslib");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const node_cache_1 = require("node-cache");
+const utilities_1 = require("../../utilities");
+const __1 = require("..");
+const solarEvents = [
+    "dawn",
+    "sunriseEnd",
+    "sunsetStart",
+    "dusk",
+    "nightStart",
+    "nightEnd",
+    "sunrise",
+    "sunset",
+    "solarNoon",
+];
+const CACHE_KEY = "SOLAR_CALC_CONFIG_CACHE";
+const degreesBelowHorizon = {
+    goldenHour: -6,
+    nauticalTwilight: 12,
+    night: 18,
+    sunrise: 0.833,
+    sunriseEnd: 0.3,
+    twilight: 6,
+};
+const UNLIMITED = 0;
+/**
+ * Benefits from a persistent cache, like Redis
+ */
+function SolarCalculator({ logger, cache, scheduler, context, hass, lifecycle, }) {
+    let config;
+    const event = new node_cache_1.EventEmitter();
+    event.setMaxListeners(UNLIMITED);
+    let lastEventAttachment;
+    lifecycle.onBootstrap(async () => {
+        config = await cache.get(CACHE_KEY);
+        if (!config) {
+            // Hold up bootstrapping for it
+            logger.info(`no lat/long on hand, fetching from Home Assistant`);
+            await updateLocation();
+            return;
+        }
+        // Background update, just in case
+        // Not expecting it to change, so it can be done in
+        setImmediate(async () => await updateLocation());
+    });
+    // Rebuild references hourly
+    //
+    scheduler.cron({
+        context,
+        exec: () => PopulateReferences(),
+        schedule: utilities_1.CronExpression.EVERY_HOUR,
+    });
+    async function updateLocation() {
+        config = await hass.fetch.getConfig();
+        await cache.set(CACHE_KEY, config);
+        PopulateReferences();
+    }
+    const solarReference = {};
+    async function PopulateReferences() {
+        solarReference.dawn = (0, dayjs_1.default)((0, __1.calcSunriseSet)(true, degreesBelowHorizon.twilight, config.latitude, config.longitude));
+        solarReference.sunriseEnd = (0, dayjs_1.default)((0, __1.calcSunriseSet)(true, degreesBelowHorizon.sunriseEnd, config.latitude, config.longitude));
+        solarReference.sunsetStart = (0, dayjs_1.default)((0, __1.calcSunriseSet)(false, degreesBelowHorizon.sunriseEnd, config.latitude, config.longitude));
+        solarReference.dusk = (0, dayjs_1.default)((0, __1.calcSunriseSet)(false, degreesBelowHorizon.twilight, config.latitude, config.longitude));
+        solarReference.nightStart = (0, dayjs_1.default)((0, __1.calcSunriseSet)(false, degreesBelowHorizon.night, config.latitude, config.longitude));
+        solarReference.nightEnd = (0, dayjs_1.default)((0, __1.calcSunriseSet)(true, degreesBelowHorizon.night, config.latitude, config.longitude));
+        solarReference.sunrise = (0, dayjs_1.default)((0, __1.calcSunriseSet)(true, degreesBelowHorizon.sunrise, config.latitude, config.longitude));
+        solarReference.sunset = (0, dayjs_1.default)((0, __1.calcSunriseSet)(false, degreesBelowHorizon.sunrise, config.latitude, config.longitude));
+        solarReference.solarNoon = (0, dayjs_1.default)((0, __1.calcSolNoon)(config.longitude));
+        solarReference.loaded = true;
+        const now = (0, dayjs_1.default)();
+        const today = now.format("YYYY-MM-DD");
+        if (lastEventAttachment !== today) {
+            lastEventAttachment = today;
+            solarEvents.forEach((i) => {
+                if (solarReference[i].isBefore(now)) {
+                    return;
+                }
+                setTimeout(() => event.emit(i), Math.abs(now.diff(solarReference[i], "ms")));
+            });
+        }
+    }
+    solarReference.loaded = false;
+    solarReference.isBetween = (a, b) => {
+        const now = (0, dayjs_1.default)();
+        return now.isBetween(solarReference[a], solarReference[b]);
+    };
+    solarReference.onEvent = ({ context, eventName, label, exec, }) => {
+        event.on(eventName, async () => {
+            await utilities_1.ZCC.safeExec({
+                duration: undefined,
+                errors: undefined,
+                exec: async () => await exec(),
+                executions: undefined,
+                labels: { context, label },
+            });
+        });
+    };
+    return solarReference;
+}
+exports.SolarCalculator = SolarCalculator;
+//# sourceMappingURL=solar-calc.extension.js.map

package/dist/automation/extensions/solar-calc.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solar-calc.extension.js","sourceRoot":"","sources":["../../../src/automation/extensions/solar-calc.extension.ts"],"names":[],"mappings":";;;;AAAA,0DAAqC;AACrC,2CAA0C;AAI1C,+CAA4E;AAC5E,0BAAiD;AAajD,MAAM,WAAW,GAAG;IAClB,MAAM;IACN,YAAY;IACZ,aAAa;IACb,MAAM;IACN,YAAY;IACZ,UAAU;IACV,SAAS;IACT,QAAQ;IACR,WAAW;CACK,CAAC;AAEnB,MAAM,SAAS,GAAG,yBAAyB,CAAC;AAE5C,MAAM,mBAAmB,GAAG;IAC1B,UAAU,EAAE,CAAC,CAAC;IACd,gBAAgB,EAAE,EAAE;IACpB,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,GAAG;IACf,QAAQ,EAAE,CAAC;CACZ,CAAC;AACF,MAAM,SAAS,GAAG,CAAC,CAAC;AAEpB;;GAEG;AACH,SAAgB,eAAe,CAAC,EAC9B,MAAM,EACN,KAAK,EACL,SAAS,EACT,OAAO,EACP,IAAI,EACJ,SAAS,GACM;IACf,IAAI,MAAkB,CAAC;IACvB,MAAM,KAAK,GAAG,IAAI,yBAAY,EAAE,CAAC;IACjC,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACjC,IAAI,mBAA2B,CAAC;IAEhC,SAAS,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;QAC/B,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,+BAA+B;YAC/B,MAAM,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;YACjE,MAAM,cAAc,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QACD,kCAAkC;QAClC,mDAAmD;QACnD,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,cAAc,EAAE,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,4BAA4B;IAC5B,EAAE;IACF,SAAS,CAAC,IAAI,CAAC;QACb,OAAO;QACP,IAAI,EAAE,GAAG,EAAE,CAAC,kBAAkB,EAAE;QAChC,QAAQ,EAAE,0BAAc,CAAC,UAAU;KACpC,CAAC,CAAC;IAEH,KAAK,UAAU,cAAc;QAC3B,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;QACtC,MAAM,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnC,kBAAkB,EAAE,CAAC;IACvB,CAAC;IAED,MAAM,cAAc,GAA4B,EAAE,CAAC;IAEnD,KAAK,UAAU,kBAAkB;QAC/B,cAAc,CAAC,IAAI,GAAG,IAAA,eAAK,EACzB,IAAA,kBAAc,EACZ,IAAI,EACJ,mBAAmB,CAAC,QAAQ,EAC5B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,UAAU,GAAG,IAAA,eAAK,EAC/B,IAAA,kBAAc,EACZ,IAAI,EACJ,mBAAmB,CAAC,UAAU,EAC9B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,WAAW,GAAG,IAAA,eAAK,EAChC,IAAA,kBAAc,EACZ,KAAK,EACL,mBAAmB,CAAC,UAAU,EAC9B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,IAAI,GAAG,IAAA,eAAK,EACzB,IAAA,kBAAc,EACZ,KAAK,EACL,mBAAmB,CAAC,QAAQ,EAC5B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,UAAU,GAAG,IAAA,eAAK,EAC/B,IAAA,kBAAc,EACZ,KAAK,EACL,mBAAmB,CAAC,KAAK,EACzB,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,QAAQ,GAAG,IAAA,eAAK,EAC7B,IAAA,kBAAc,EACZ,IAAI,EACJ,mBAAmB,CAAC,KAAK,EACzB,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,OAAO,GAAG,IAAA,eAAK,EAC5B,IAAA,kBAAc,EACZ,IAAI,EACJ,mBAAmB,CAAC,OAAO,EAC3B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,MAAM,GAAG,IAAA,eAAK,EAC3B,IAAA,kBAAc,EACZ,KAAK,EACL,mBAAmB,CAAC,OAAO,EAC3B,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,SAAS,CACjB,CACF,CAAC;QAEF,cAAc,CAAC,SAAS,GAAG,IAAA,eAAK,EAAC,IAAA,eAAW,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAChE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;QAE7B,MAAM,GAAG,GAAG,IAAA,eAAK,GAAE,CAAC;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,mBAAmB,KAAK,KAAK,EAAE,CAAC;YAClC,mBAAmB,GAAG,KAAK,CAAC;YAC5B,WAAW,CAAC,OAAO,CAAC,CAAC,CAAc,EAAE,EAAE;gBACrC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO;gBACT,CAAC;gBACD,UAAU,CACR,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EACnB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAC5C,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,cAAc,CAAC,MAAM,GAAG,KAAK,CAAC;IAE9B,cAAc,CAAC,SAAS,GAAG,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE;QAC5D,MAAM,GAAG,GAAG,IAAA,eAAK,GAAE,CAAC;QACpB,OAAO,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,cAAc,CAAC,OAAO,GAAG,CAAC,EACxB,OAAO,EACP,SAAS,EACT,KAAK,EACL,IAAI,GACS,EAAE,EAAE;QACjB,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,eAAG,CAAC,QAAQ,CAAC;gBACjB,QAAQ,EAAE,SAAS;gBACnB,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,EAAE;gBAC9B,UAAU,EAAE,SAAS;gBACrB,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,cAAgC,CAAC;AAC1C,CAAC;AA9JD,0CA8JC"}

package/dist/automation/helpers/events.helper.d.ts

@@ -0,0 +1,33 @@
+import { PICK_ENTITY } from "../../hass";
+import { TContext } from "../../utilities";
+export declare const LOCATION_UPDATED = "LOCATION_UPDATED";
+export declare const SCENE_CHANGE: <T extends string = string>(room: T) => string;
+export declare const SCENE_SET_ENTITY = "SCENE_SET_ENTITY";
+export declare const ANIMATION_INTERRUPT = "ANIMATION_INTERRUPT";
+export declare const DETERMINISTIC_SWITCH_CHANGED = "DETERMINISTIC_SWITCH_CHANGED";
+export type DeterministicSwitchChangedData = {
+    entity_id: PICK_ENTITY<"switch"> | PICK_ENTITY<"switch">[];
+    state: "on" | "off";
+};
+export declare const AGGRESSIVE_SCENES_ADJUSTMENT = "AGGRESSIVE_SCENES_ADJUSTMENT";
+export type AggressiveScenesAdjustmentTypes = "light_brightness" | "light_color" | "light_temperature" | "light_on_off" | "switch_on_off";
+export type AggressiveScenesAdjustmentData = {
+    entity_id: PICK_ENTITY<"switch" | "light">;
+    type: AggressiveScenesAdjustmentTypes;
+};
+export declare const ROOM_SET_SCENE = "ROOM_SET_SCENE";
+export type RoomSetSceneData = {
+    room: string;
+    scene: string;
+};
+export declare const SEQUENCE_WATCHER_TRIGGER = "SEQUENCE_WATCHER_TRIGGER";
+export type SequenceWatcherTriggerData = {
+    context: TContext;
+    label?: string;
+    time: number;
+};
+export declare const SOLAR_EVENT_TRIGGER = "SOLAR_EVENT_TRIGGER";
+export type SolarEventTriggerData = {
+    context: TContext;
+    event: string;
+};

package/dist/automation/helpers/events.helper.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOLAR_EVENT_TRIGGER = exports.SEQUENCE_WATCHER_TRIGGER = exports.ROOM_SET_SCENE = exports.AGGRESSIVE_SCENES_ADJUSTMENT = exports.DETERMINISTIC_SWITCH_CHANGED = exports.ANIMATION_INTERRUPT = exports.SCENE_SET_ENTITY = exports.SCENE_CHANGE = exports.LOCATION_UPDATED = void 0;
+exports.LOCATION_UPDATED = "LOCATION_UPDATED";
+const SCENE_CHANGE = (room) => `SCENE_CHANGE:${room}`;
+exports.SCENE_CHANGE = SCENE_CHANGE;
+exports.SCENE_SET_ENTITY = "SCENE_SET_ENTITY";
+exports.ANIMATION_INTERRUPT = "ANIMATION_INTERRUPT";
+exports.DETERMINISTIC_SWITCH_CHANGED = "DETERMINISTIC_SWITCH_CHANGED";
+exports.AGGRESSIVE_SCENES_ADJUSTMENT = "AGGRESSIVE_SCENES_ADJUSTMENT";
+exports.ROOM_SET_SCENE = "ROOM_SET_SCENE";
+exports.SEQUENCE_WATCHER_TRIGGER = "SEQUENCE_WATCHER_TRIGGER";
+exports.SOLAR_EVENT_TRIGGER = "SOLAR_EVENT_TRIGGER";
+//# sourceMappingURL=events.helper.js.map

package/dist/automation/helpers/events.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.helper.js","sourceRoot":"","sources":["../../../src/automation/helpers/events.helper.ts"],"names":[],"mappings":";;;AAGa,QAAA,gBAAgB,GAAG,kBAAkB,CAAC;AAE5C,MAAM,YAAY,GAAG,CAA4B,IAAO,EAAE,EAAE,CACjE,gBAAgB,IAAI,EAAE,CAAC;AADZ,QAAA,YAAY,gBACA;AACZ,QAAA,gBAAgB,GAAG,kBAAkB,CAAC;AACtC,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,4BAA4B,GAAG,8BAA8B,CAAC;AAM9D,QAAA,4BAA4B,GAAG,8BAA8B,CAAC;AAY9D,QAAA,cAAc,GAAG,gBAAgB,CAAC;AAMlC,QAAA,wBAAwB,GAAG,0BAA0B,CAAC;AAOtD,QAAA,mBAAmB,GAAG,qBAAqB,CAAC"}

package/dist/automation/helpers/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./events.helper";
+export * from "./managed-switch.helper";
+export * from "./metrics.helper";
+export * from "./reftimes.helper";
+export * from "./scene.helper";
+export * from "./sequence.helper";
+export * from "./solar.helper";

package/dist/automation/helpers/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./events.helper"), exports);
+tslib_1.__exportStar(require("./managed-switch.helper"), exports);
+tslib_1.__exportStar(require("./metrics.helper"), exports);
+tslib_1.__exportStar(require("./reftimes.helper"), exports);
+tslib_1.__exportStar(require("./scene.helper"), exports);
+tslib_1.__exportStar(require("./sequence.helper"), exports);
+tslib_1.__exportStar(require("./solar.helper"), exports);
+//# sourceMappingURL=index.js.map

package/dist/automation/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/automation/helpers/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,kEAAwC;AACxC,2DAAiC;AACjC,4DAAkC;AAClC,yDAA+B;AAC/B,4DAAkC;AAClC,yDAA+B"}

package/dist/automation/helpers/managed-switch.helper.d.ts

@@ -0,0 +1,41 @@
+import { PICK_ENTITY } from "../../hass";
+import { CronExpression, TBlackHole, TContext } from "../../utilities";
+export type PickASwitch = PICK_ENTITY<"switch"> | {
+    entity_id: PICK_ENTITY<"switch">;
+};
+type EntityUpdate = PICK_ENTITY | {
+    entity_id: PICK_ENTITY;
+} | {
+    onUpdate: (callback: () => TBlackHole) => void;
+    state: unknown;
+    name: string;
+};
+export interface ManagedSwitchOptions {
+    /**
+     * Logging context
+     */
+    context: TContext;
+    /**
+     * Set the state of this switch
+     */
+    entity_id: PickASwitch | PickASwitch[];
+    /**
+     * cron compatible expression
+     *
+     * Default: EVERY_10_MINUTES
+     */
+    schedule?: CronExpression | `${CronExpression}` | string;
+    /**
+     * Check on update of this entity
+     */
+    onUpdate?: EntityUpdate | EntityUpdate[];
+    /**
+     * - return true for on
+     * - return false for off
+     * - return undefined for no change
+     *
+     * Cannot be a promise
+     */
+    shouldBeOn: () => boolean | undefined;
+}
+export {};

package/dist/automation/helpers/managed-switch.helper.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=managed-switch.helper.js.map

package/dist/automation/helpers/managed-switch.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"managed-switch.helper.js","sourceRoot":"","sources":["../../../src/automation/helpers/managed-switch.helper.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,13 @@
+import { Counter, Summary } from "prom-client";
+/**
+ * Tracks the number of times a sequence matcher callback has been executed.
+ */
+export declare const SEQUENCE_MATCHER_EXECUTION_COUNT: Counter<"context" | "label">;
+/**
+ * Counts the number of errors occurred during sequence matcher callback executions.
+ */
+export declare const SEQUENCE_MATCHER_ERRORS: Counter<"context" | "label">;
+/**
+ * Summary for Execution Time
+ */
+export declare const SEQUENCE_MATCHER_EXECUTION_TIME: Summary<"context" | "label">;

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEQUENCE_MATCHER_EXECUTION_TIME = exports.SEQUENCE_MATCHER_ERRORS = exports.SEQUENCE_MATCHER_EXECUTION_COUNT = void 0;
+const prom_client_1 = require("prom-client");
+/**
+ * Tracks the number of times a sequence matcher callback has been executed.
+ */
+exports.SEQUENCE_MATCHER_EXECUTION_COUNT = new prom_client_1.Counter({
+    help: "Counts the number of times a sequence matcher callback has been executed",
+    labelNames: ["context", "label"],
+    name: "digital_alchemy_automation_logic_sequence_matcher_callback_execution_count",
+});
+/**
+ * Counts the number of errors occurred during sequence matcher callback executions.
+ */
+exports.SEQUENCE_MATCHER_ERRORS = new prom_client_1.Counter({
+    help: "Counts the number of errors during sequence matcher callback executions",
+    labelNames: ["context", "label"],
+    name: "digital_alchemy_automation_logic_sequence_matcher_callback_errors",
+});
+/**
+ * Summary for Execution Time
+ */
+exports.SEQUENCE_MATCHER_EXECUTION_TIME = new prom_client_1.Summary({
+    help: "Measures the duration of each cron job or interval execution",
+    labelNames: ["context", "label"],
+    name: "digital_alchemy_automation_logic_sequence_matcher_callback_execution_time",
+    percentiles: [0.5, 0.9, 0.99],
+});
+//# sourceMappingURL=metrics.helper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.helper.js","sourceRoot":"","sources":["../../../src/automation/helpers/metrics.helper.ts"],"names":[],"mappings":";;;AAAA,6CAA+C;AAE/C;;GAEG;AACU,QAAA,gCAAgC,GAAG,IAAI,qBAAO,CAAC;IAC1D,IAAI,EAAE,0EAA0E;IAChF,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,4EAA4E;CACnF,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,qBAAO,CAAC;IACjD,IAAI,EAAE,yEAAyE;IAC/E,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,mEAAmE;CAC1E,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,+BAA+B,GAAG,IAAI,qBAAO,CAAC;IACzD,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,CAAU;IACzC,IAAI,EAAE,2EAA2E;IACjF,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;CAC9B,CAAC,CAAC"}

package/dist/automation/helpers/reftimes.helper.d.ts

@@ -0,0 +1,54 @@
+import { Dayjs } from "dayjs";
+export declare function refTimes(times: TimeString[]): Dayjs[];
+type Digit = `${number}`;
+type TimeString = Digit | `${Digit}:${Digit}` | `${Digit}:${Digit}:${Digit}`;
+declare module "../../utilities" {
+    interface ZCCDefinition {
+        /**
+         * Quickly calculate reference points in time.
+         * Times are in reference to 12AM/midnight this morning, and input in 24 hour format.
+         * Values are input from left to right
+         *
+         * > HH[:mm[:ss]]
+         *
+         *
+         * ## Usage Example
+         *
+         * ```typescript
+         * const [AM830, PM3, TOMORROW] = is.refTimes(["8:30", "15", "24"]);
+         * const now = dayjs();
+         * if (!now.isBetween(AM830, PM3)) {
+         *   console.log(
+         *     `${Math.abs(now.diff(TOMORROW, "minute"))} minutes until tomorrow`,
+         *   );
+         * }
+         * ```
+         */
+        refTime(times: TimeString[]): Dayjs[];
+        /**
+         * Quickly calculate reference points in time.
+         * Times are in reference to 12AM/midnight this morning.
+         *
+         * > (AM|PM)[H]H[:(00|15|30|45)]
+         *
+         * Intended for readability and covering 90% of use cases. Use `refTime` for more configurable interface
+         *
+         * ## Usage Example
+         *
+         * ```typescript
+         * const [NOW, AM830, PM3] = is.shortTime(["NOW", "AM8:30", "PM3", "24"]);
+         * if (!NOW.isBetween(AM830, PM3)) {
+         *   console.log(
+         *     `Not in range`,
+         *   );
+         * }
+         * ```
+         */
+        shortTime(times: ShortTime[]): Dayjs[];
+    }
+}
+type ShortTime = `${AmPm}${ShortDigits}${ShortSuffix}` | "NOW" | "TOMORROW";
+type ShortDigits = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
+type AmPm = "AM" | "PM";
+type ShortSuffix = "" | ":00" | ":15" | ":30" | ":45";
+export {};

package/dist/automation/helpers/reftimes.helper.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refTimes = void 0;
+const tslib_1 = require("tslib");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const utilities_1 = require("../../utilities");
+function refTimes(times) {
+    const today = (0, dayjs_1.default)().format("YYYY-MM-DD");
+    return times.map(i => (0, dayjs_1.default)(`${today} ${i}`).millisecond(utilities_1.NONE));
+}
+exports.refTimes = refTimes;
+const SLICE_LENGTH = "AM".length;
+const ROLLOVER = 12;
+utilities_1.ZCC.refTime = refTimes;
+utilities_1.ZCC.shortTime = function (times) {
+    const now = (0, dayjs_1.default)();
+    const today = now.format("YYYY-MM-DD");
+    return times.map(i => {
+        if (i === "NOW") {
+            return now;
+        }
+        if (i === "TOMORROW") {
+            return (0, dayjs_1.default)(`${today} 24`);
+        }
+        let [hour, minute] = i.slice(SLICE_LENGTH).split(":");
+        minute ??= "00";
+        if (i.charAt(utilities_1.START).toLowerCase() === "p") {
+            hour = (Number(hour) + ROLLOVER).toString();
+        }
+        return (0, dayjs_1.default)(`${today} ${hour}:${minute}`).millisecond(utilities_1.NONE);
+    });
+};
+//# sourceMappingURL=reftimes.helper.js.map

package/dist/automation/helpers/reftimes.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reftimes.helper.js","sourceRoot":"","sources":["../../../src/automation/helpers/reftimes.helper.ts"],"names":[],"mappings":";;;;AAAA,0DAAqC;AAErC,+CAAmD;AAEnD,SAAgB,QAAQ,CAAC,KAAmB;IAC1C,MAAM,KAAK,GAAG,IAAA,eAAK,GAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC3C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,eAAK,EAAC,GAAG,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,gBAAI,CAAC,CAAC,CAAC;AAClE,CAAC;AAHD,4BAGC;AA8ED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC;AACjC,MAAM,QAAQ,GAAG,EAAE,CAAC;AACpB,eAAG,CAAC,OAAO,GAAG,QAAQ,CAAC;AAEvB,eAAG,CAAC,SAAS,GAAG,UAAU,KAAkB;IAC1C,MAAM,GAAG,GAAG,IAAA,eAAK,GAAE,CAAC;IACpB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACvC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACnB,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC;YAChB,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;YACrB,OAAO,IAAA,eAAK,EAAC,GAAG,KAAK,KAAK,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,KAAK,IAAI,CAAC;QAChB,IAAI,CAAC,CAAC,MAAM,CAAC,iBAAK,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,EAAE,CAAC;YAC1C,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,IAAA,eAAK,EAAC,GAAG,KAAK,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,gBAAI,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/automation/helpers/scene.helper.d.ts

@@ -0,0 +1,97 @@
+import { ALL_DOMAINS, GetDomain, PICK_ENTITY } from "../../hass";
+import { TContext } from "../../utilities";
+type SceneAwareDomains = "switch" | "light";
+type RGB = [r: number, g: number, b: number];
+export type LightOff = {
+    state: "off";
+};
+export type LightOn = {
+    brightness?: number;
+    kelvin?: number;
+    rgb_color?: RGB;
+    state?: "on";
+};
+type EntitySceneType<DOMAIN extends SceneAwareDomains> = {
+    light: LightOff | LightOn;
+    switch: {
+        state: "on" | "off";
+    };
+}[DOMAIN];
+export type tSceneType<ENTITY extends PICK_ENTITY<SceneAwareDomains>> = EntitySceneType<GetDomain<ENTITY>>;
+export type tScene = {
+    [key in PICK_ENTITY<SceneAwareDomains>]: tSceneType<key>;
+};
+export type SceneDescription<RoomNames extends string = string> = {
+    global: string[];
+    rooms: Partial<Record<RoomNames, string[]>>;
+};
+export interface AutomationLogicModuleConfiguration {
+    global_scenes?: Record<string, boolean>;
+    room_configuration?: Record<string, RoomConfiguration<string>>;
+}
+export type AllowedSceneDomains = Extract<ALL_DOMAINS, "switch" | "light" | "fan">;
+export declare const SCENE_ROOM_OPTIONS = "scene-room";
+export type SceneSwitchState = {
+    state: "on" | "off";
+};
+export type SceneLightStateOn = {
+    /**
+     * Light will probably restore previous value
+     */
+    brightness: number;
+    /**
+     * If not provided, light will attempt to use color temp if possible
+     */
+    rgb_color?: {
+        b: number;
+        g: number;
+        r: number;
+    };
+    state: "on";
+};
+export type SceneLightState = {
+    state: "off";
+} | SceneLightStateOn;
+type MappedDomains = {
+    light: SceneLightState;
+    switch: SceneSwitchState;
+};
+export type SceneDefinition = Partial<{
+    [entity_id in PICK_ENTITY<keyof MappedDomains>]: MappedDomains[GetDomain<entity_id>];
+}>;
+export type SceneList<SCENES extends string> = Record<SCENES, Partial<Record<PICK_ENTITY<AllowedSceneDomains>, SceneDefinition>>>;
+export type RoomConfiguration<SCENES extends string> = {
+    context: TContext;
+    /**
+     * Friendly name
+     */
+    name?: string;
+    /**
+     * Global scenes are required to be declared within the room
+     */
+    scenes: Record<SCENES, RoomScene>;
+};
+export type RoomScene<DEFINITION extends SceneDefinition = SceneDefinition> = {
+    /**
+     * Ensure entities are maintained as the scene says they should be
+     *
+     * - Automatically revert changes made by pesky humans
+     *   - how dare they?!
+     *
+     * - Ensure lights match the brightness / color the scene says they should be
+     *   - sometimes things don't fully make brightness transitions, this will fix
+     *
+     * default: `true` (controlled by config)
+     */
+    aggressive?: boolean;
+    /**
+     * Human understandable description of this scene (long form)
+     */
+    description?: string;
+    /**
+     * Human understandable description of this scene (short form)
+     */
+    friendly_name?: string;
+    definition: DEFINITION;
+};
+export {};

package/dist/automation/helpers/scene.helper.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SCENE_ROOM_OPTIONS = void 0;
+exports.SCENE_ROOM_OPTIONS = "scene-room";
+//# sourceMappingURL=scene.helper.js.map

package/dist/automation/helpers/scene.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene.helper.js","sourceRoot":"","sources":["../../../src/automation/helpers/scene.helper.ts"],"names":[],"mappings":";;;AAyCa,QAAA,kBAAkB,GAAG,YAAY,CAAC"}