home-assistant-javascript-templates - npm Package Compare versions

Comparing version 4.0.0 to 5.0.0

dist/esm/index.d.ts

@@ -0,1 +1,6 @@
+interface Options {
+    throwErrors?: boolean;
+    throwWarnings?: boolean;
+}
+type RenderingFunction = (result?: any) => void;
 interface Area {
@@ -35,16 +40,31 @@ area_id: string;
 }
-interface Tracked {
-    entities: string[];
-    domains: string[];
+interface HassConnection {
+    conn: {
+        subscribeMessage: <T>(callback: (response: T) => void, options: Record<string, unknown>) => void;
+    };
 }
-declare class HomeAssistantJavaScriptTemplates {
-    constructor(ha: HomeAssistant, throwErrors?: boolean, trackNonExistent?: boolean);
+declare global {
+    interface Window {
+        hassConnection: Promise<HassConnection>;
+    }
+}
+declare class HomeAssistantJavaScriptTemplatesRenderer {
+    constructor(ha: HomeAssistant, options: Options);
+    private _throwErrors;
+    private _throwWarnings;
+    private _subscriptions;
     private _scopped;
-    private _errors;
+    private _watchForEntitiesChange;
+    private _entityWatchCallback;
+    private _storeTracked;
     renderTemplate(template: string): any;
-    get tracked(): Tracked;
-    cleanTrackedEntities(): void;
-    cleanTrackedDomains(): void;
-    cleanTracked(): void;
+    trackTemplate(template: string, renderingFunction: RenderingFunction): void;
+    cleanTracked(entityId?: string): void;
 }
-export { HomeAssistantJavaScriptTemplates as default, HomeAssistant, Hass };
+declare class HomeAssistantJavaScriptTemplates {
+    constructor(ha: HomeAssistant, options?: Options);
+    private _renderer;
+    getRenderer(): Promise<HomeAssistantJavaScriptTemplatesRenderer>;
+}
+export { HomeAssistantJavaScriptTemplates as default };
+export type { HomeAssistant, HomeAssistantJavaScriptTemplatesRenderer, HassConnection, Hass };

dist/esm/index.js

@@ -1,1 +0,1 @@
-var e,t,i="[home-assistant-javascript-templates]",n=/^([a-z_]+)\.(\w+)$/;!function(e){e.UNKNOWN="unknown",e.UNAVAILABLE="unavailable"}(e||(e={})),function(e){e.AREA_ID="area_id",e.NAME="name"}(t||(t={}));var s=function(e){return e.reduce((function(e,t){var i=t[0],s=t[1];return e[i.replace(n,"$2")]=s,e}),{})},r=function(e){return e.includes(".")};function a(n,a){var c=function(){return Object.entries(n.hass.areas)},o=function(){return Object.entries(n.hass.entities)},d=new Set,u=new Set,_=function(e){(a||n.hass.states[e])&&d.add(e)},p=function(e){u.add(e)};return{get hass(){return n.hass},states:new Proxy((function(e){var t;if(r(e))return _(e),null===(t=n.hass.states[e])||void 0===t?void 0:t.state;throw SyntaxError("".concat(i,": states method cannot be used with a domain, use it as an object instead."))}),{get:function(e,t){if(r(t))return _(t),n.hass.states[t];var i=Object.entries(n.hass.states).filter((function(e){return e[0].startsWith(t)}));return(a||i.length)&&p(t),new Proxy(s(i),{get:function(e,i){return _("".concat(t,".").concat(i)),e[i]}})}}),is_state:function(e,t){var i;return _(e),(null===(i=n.hass.states[e])||void 0===i?void 0:i.state)===t},state_attr:function(e,t){var i,s;return _(e),null===(s=null===(i=n.hass.states[e])||void 0===i?void 0:i.attributes)||void 0===s?void 0:s[t]},is_state_attr:function(e,t,i){return this.state_attr(e,t)===i},has_value:function(t){return!!this.states(t)&&!(this.is_state(t,e.UNKNOWN)||this.is_state(t,e.UNAVAILABLE))},entities:new Proxy((function(e){if(void 0===e)return n.hass.entities;if(r(e))return _(e),n.hass.entities[e];var t=o().filter((function(t){return t[0].startsWith(e)}));return(a||t.length)&&p(e),new Proxy(s(t),{get:function(t,i){return _("".concat(e,".").concat(i)),t[i]}})}),{get:function(e,t){return e(t)}}),entity_prop:function(e,t){var i;return _(e),null===(i=n.hass.entities[e])||void 0===i?void 0:i[t]},is_entity_prop:function(e,t,i){return this.entity_prop(e,t)===i},devices:new Proxy((function(e){if(void 0===e)return n.hass.devices;if(r(e))throw SyntaxError("".concat(i,": devices method cannot be used with an entity id, you should use a device id instead."));return n.hass.devices[e]}),{get:function(e,t){if(r(t))throw SyntaxError("".concat(i,": devices cannot be accesed using an entity id, you should use a device id instead."));return n.hass.devices[t]}}),device_attr:function(e,t){var i;return null===(i=n.hass.devices[e])||void 0===i?void 0:i[t]},is_device_attr:function(e,t,i){return this.device_attr(e,t)===i},device_id:function(e){var t;return _(e),null===(t=n.hass.entities[e])||void 0===t?void 0:t.device_id},areas:function(){return c().map((function(e){return e[1].area_id}))},area_id:function(e){var i;if(e in n.hass.devices)return this.device_attr(e,t.AREA_ID);var s=this.device_id(e);if(s)return this.device_attr(s,t.AREA_ID);var r=c().find((function(t){return t[1].name===e}));return null===(i=null==r?void 0:r[1])||void 0===i?void 0:i.area_id},area_name:function(e){var i,s;e in n.hass.devices&&(s=this.device_attr(e,t.AREA_ID));var r=this.device_id(e);r&&(s=this.device_attr(r,t.AREA_ID));var a=c().find((function(t){var i=t[1];return i.area_id===e||i.area_id===s}));return null===(i=null==a?void 0:a[1])||void 0===i?void 0:i.name},area_entities:function(e){var t=c().find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?o().filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[0]})):[]},area_devices:function(e){var t=c().find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?Object.entries(n.hass.devices).filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[1].id})):[]},get user_name(){return n.hass.user.name},get user_is_admin(){return n.hass.user.is_admin},get user_is_owner(){return n.hass.user.is_owner},get user_agent(){return window.navigator.userAgent},tracked:{get entities(){return Array.from(d)},get domains(){return Array.from(u)}},cleanTrackedEntities:function(){d.clear()},cleanTrackedDomains:function(){u.clear()}}}var c=function(){function e(e,t,i){void 0===t&&(t=!1),void 0===i&&(i=!1),this._scopped=a(e,i),this._errors=t}return e.prototype.renderTemplate=function(e){try{var t=e.includes("return")?e:"return ".concat(e);return new Function("hass","states","is_state","state_attr","is_state_attr","has_value","entities","entity_prop","is_entity_prop","devices","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","user_agent","".concat('"use strict";'," ").concat(t))(this._scopped.hass,this._scopped.states,this._scopped.is_state.bind(this._scopped),this._scopped.state_attr.bind(this._scopped),this._scopped.is_state_attr.bind(this._scopped),this._scopped.has_value.bind(this._scopped),this._scopped.entities,this._scopped.entity_prop,this._scopped.is_entity_prop.bind(this._scopped),this._scopped.devices,this._scopped.device_attr.bind(this._scopped),this._scopped.is_device_attr.bind(this._scopped),this._scopped.device_id.bind(this._scopped),this._scopped.areas.bind(this._scopped),this._scopped.area_id.bind(this._scopped),this._scopped.area_name.bind(this._scopped),this._scopped.area_entities.bind(this._scopped),this._scopped.area_devices.bind(this._scopped),this._scopped.user_name,this._scopped.user_is_admin,this._scopped.user_is_owner,this._scopped.user_agent)}catch(e){if(this._errors)throw e;return void console.warn(e)}},Object.defineProperty(e.prototype,"tracked",{get:function(){return this._scopped.tracked},enumerable:!1,configurable:!0}),e.prototype.cleanTrackedEntities=function(){this._scopped.cleanTrackedEntities()},e.prototype.cleanTrackedDomains=function(){this._scopped.cleanTrackedDomains()},e.prototype.cleanTracked=function(){this._scopped.cleanTrackedEntities(),this._scopped.cleanTrackedDomains()},e}();export{c as default};
+var t,e,i="[home-assistant-javascript-templates]",n=/^([a-z_]+)\.(\w+)$/;!function(t){t.UNKNOWN="unknown",t.UNAVAILABLE="unavailable"}(t||(t={})),function(t){t.AREA_ID="area_id",t.NAME="name"}(e||(e={}));var s=function(t){return t.reduce((function(t,e){var i=e[0],s=e[1];return t[i.replace(n,"$2")]=s,t}),{})},r=function(t){return t.includes(".")};function a(n,a){var o=function(){return Object.entries(n.hass.areas)},c=function(){return Object.entries(n.hass.entities)},u=new Set,d=function(t,e){a&&console.warn("".concat(t," ").concat(e," used in a JavaScript template doesn't exist"))},_=function(t){return d("Entity",t)},h=function(t){return d("Domain",t)},p=function(t){n.hass.states[t]?u.add(t):_(t)};return{get hass(){return n.hass},states:new Proxy((function(t){var e;if(r(t))return p(t),null===(e=n.hass.states[t])||void 0===e?void 0:e.state;throw SyntaxError("".concat(i,": states method cannot be used with a domain, use it as an object instead."))}),{get:function(t,e){if(r(e))return p(e),n.hass.states[e];var i=Object.entries(n.hass.states).filter((function(t){return t[0].startsWith(e)}));return i.length||h(e),new Proxy(s(i),{get:function(t,i){return p("".concat(e,".").concat(i)),t[i]}})}}),is_state:function(t,e){var i;return p(t),(null===(i=n.hass.states[t])||void 0===i?void 0:i.state)===e},state_attr:function(t,e){var i,s;return p(t),null===(s=null===(i=n.hass.states[t])||void 0===i?void 0:i.attributes)||void 0===s?void 0:s[e]},is_state_attr:function(t,e,i){return this.state_attr(t,e)===i},has_value:function(e){return this.states(e)?!(this.is_state(e,t.UNKNOWN)||this.is_state(e,t.UNAVAILABLE)):(_(e),!1)},entities:new Proxy((function(t){if(void 0===t)return n.hass.entities;if(r(t))return p(t),n.hass.entities[t];var e=c().filter((function(e){return e[0].startsWith(t)}));return e.length||h(t),new Proxy(s(e),{get:function(e,i){return p("".concat(t,".").concat(i)),e[i]}})}),{get:function(t,e){return t(e)}}),entity_prop:function(t,e){var i;return p(t),null===(i=n.hass.entities[t])||void 0===i?void 0:i[e]},is_entity_prop:function(t,e,i){return this.entity_prop(t,e)===i},devices:new Proxy((function(t){if(void 0===t)return n.hass.devices;if(r(t))throw SyntaxError("".concat(i,": devices method cannot be used with an entity id, you should use a device id instead."));return n.hass.devices[t]}),{get:function(t,e){if(r(e))throw SyntaxError("".concat(i,": devices cannot be accesed using an entity id, you should use a device id instead."));return n.hass.devices[e]}}),device_attr:function(t,e){var i;return null===(i=n.hass.devices[t])||void 0===i?void 0:i[e]},is_device_attr:function(t,e,i){return this.device_attr(t,e)===i},device_id:function(t){var e;return p(t),null===(e=n.hass.entities[t])||void 0===e?void 0:e.device_id},areas:function(){return o().map((function(t){return t[1].area_id}))},area_id:function(t){var i,s;if(t in n.hass.devices)return this.device_attr(t,e.AREA_ID);var r=null===(i=n.hass.entities[t])||void 0===i?void 0:i.device_id;if(r)return this.device_attr(r,e.AREA_ID);var a=o().find((function(e){return e[1].name===t}));return null===(s=null==a?void 0:a[1])||void 0===s?void 0:s.area_id},area_name:function(t){var i,s,r;t in n.hass.devices&&(r=this.device_attr(t,e.AREA_ID));var a=null===(i=n.hass.entities[t])||void 0===i?void 0:i.device_id;a&&(r=this.device_attr(a,e.AREA_ID));var c=o().find((function(e){var i=e[1];return i.area_id===t||i.area_id===r}));return null===(s=null==c?void 0:c[1])||void 0===s?void 0:s.name},area_entities:function(t){var e=o().find((function(e){var i=e[1];return i.area_id===t||i.name===t}));return e?c().filter((function(t){return t[1].area_id===e[1].area_id})).map((function(t){return t[0]})):[]},area_devices:function(t){var e=o().find((function(e){var i=e[1];return i.area_id===t||i.name===t}));return e?Object.entries(n.hass.devices).filter((function(t){return t[1].area_id===e[1].area_id})).map((function(t){return t[1].id})):[]},get user_name(){return n.hass.user.name},get user_is_admin(){return n.hass.user.is_admin},get user_is_owner(){return n.hass.user.is_owner},get user_agent(){return window.navigator.userAgent},get tracked(){return u},cleanTracked:function(){u.clear()}}}var o=function(){function t(t,e){var i=e.throwErrors,n=void 0!==i&&i,s=e.throwWarnings,r=void 0===s||s;this._throwErrors=n,this._throwWarnings=r,this._subscriptions=new Map,this._scopped=a(t,r),this._watchForEntitiesChange()}return t.prototype._watchForEntitiesChange=function(){var t=this;window.hassConnection.then((function(e){e.conn.subscribeMessage((function(e){return t._entityWatchCallback(e)}),{type:"subscribe_events",event_type:"state_changed"})}))},t.prototype._entityWatchCallback=function(t){var e=this;if(this._subscriptions.size){var i=t.data.entity_id;this._subscriptions.has(i)&&this._subscriptions.get(i).forEach((function(t,i){e.trackTemplate(i,t)}))}},t.prototype._storeTracked=function(t,e){var i=this;this._scopped.tracked.forEach((function(n){if(i._subscriptions.has(n)){var s=i._subscriptions.get(n);s.has(t)||s.set(t,e)}else i._subscriptions.set(n,new Map([[t,e]]))}))},t.prototype.renderTemplate=function(t){try{var e=t.includes("return")?t:"return ".concat(t);return new Function("hass","states","is_state","state_attr","is_state_attr","has_value","entities","entity_prop","is_entity_prop","devices","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","user_agent","".concat('"use strict";'," ").concat(e))(this._scopped.hass,this._scopped.states,this._scopped.is_state.bind(this._scopped),this._scopped.state_attr.bind(this._scopped),this._scopped.is_state_attr.bind(this._scopped),this._scopped.has_value.bind(this._scopped),this._scopped.entities,this._scopped.entity_prop,this._scopped.is_entity_prop.bind(this._scopped),this._scopped.devices,this._scopped.device_attr.bind(this._scopped),this._scopped.is_device_attr.bind(this._scopped),this._scopped.device_id.bind(this._scopped),this._scopped.areas.bind(this._scopped),this._scopped.area_id.bind(this._scopped),this._scopped.area_name.bind(this._scopped),this._scopped.area_entities.bind(this._scopped),this._scopped.area_devices.bind(this._scopped),this._scopped.user_name,this._scopped.user_is_admin,this._scopped.user_is_owner,this._scopped.user_agent)}catch(t){if(this._throwErrors)throw t;return void(this._throwWarnings&&console.warn(t))}},t.prototype.trackTemplate=function(t,e){this._scopped.cleanTracked();var i=this.renderTemplate(t);this._storeTracked(t,e),e(i)},t.prototype.cleanTracked=function(t){t?this._subscriptions.has(t)&&this._subscriptions.delete(t):this._subscriptions.clear()},t}(),c=function(){function t(t,e){var i,n;void 0===e&&(e={}),this._renderer=(i=function(){return t.hass},n=function(t){return!!(t&&t.areas&&t.devices&&t.entities&&t.states&&t.user)},new Promise((function(t,e){var s=0,r=function(){var a=i();n(a)?t(a):++s<100?setTimeout(r,50):e()};r()}))).then((function(){return new o(t,e)})).catch((function(){throw new Error("The provided element doesn't contain a proper or initialised hass object")}))}return t.prototype.getRenderer=function(){return this._renderer},t}();export{c as default};

dist/index.d.ts

@@ -0,1 +1,6 @@
+interface Options {
+    throwErrors?: boolean;
+    throwWarnings?: boolean;
+}
+type RenderingFunction = (result?: any) => void;
 interface Area {
@@ -35,16 +40,31 @@ area_id: string;
 }
-interface Tracked {
-    entities: string[];
-    domains: string[];
+interface HassConnection {
+    conn: {
+        subscribeMessage: <T>(callback: (response: T) => void, options: Record<string, unknown>) => void;
+    };
 }
-declare class HomeAssistantJavaScriptTemplates {
-    constructor(ha: HomeAssistant, throwErrors?: boolean, trackNonExistent?: boolean);
+declare global {
+    interface Window {
+        hassConnection: Promise<HassConnection>;
+    }
+}
+declare class HomeAssistantJavaScriptTemplatesRenderer {
+    constructor(ha: HomeAssistant, options: Options);
+    private _throwErrors;
+    private _throwWarnings;
+    private _subscriptions;
     private _scopped;
-    private _errors;
+    private _watchForEntitiesChange;
+    private _entityWatchCallback;
+    private _storeTracked;
     renderTemplate(template: string): any;
-    get tracked(): Tracked;
-    cleanTrackedEntities(): void;
-    cleanTrackedDomains(): void;
-    cleanTracked(): void;
+    trackTemplate(template: string, renderingFunction: RenderingFunction): void;
+    cleanTracked(entityId?: string): void;
 }
-export { HomeAssistantJavaScriptTemplates as default, HomeAssistant, Hass };
+declare class HomeAssistantJavaScriptTemplates {
+    constructor(ha: HomeAssistant, options?: Options);
+    private _renderer;
+    getRenderer(): Promise<HomeAssistantJavaScriptTemplatesRenderer>;
+}
+export { HomeAssistantJavaScriptTemplates as default };
+export type { HomeAssistant, HomeAssistantJavaScriptTemplatesRenderer, HassConnection, Hass };

dist/index.js

@@ -1,1 +0,1 @@
-"use strict";var e,t,i="[home-assistant-javascript-templates]",n=/^([a-z_]+)\.(\w+)$/;!function(e){e.UNKNOWN="unknown",e.UNAVAILABLE="unavailable"}(e||(e={})),function(e){e.AREA_ID="area_id",e.NAME="name"}(t||(t={}));var s=function(e){return e.reduce((function(e,t){var i=t[0],s=t[1];return e[i.replace(n,"$2")]=s,e}),{})},r=function(e){return e.includes(".")};function a(n,a){var c=function(){return Object.entries(n.hass.areas)},o=function(){return Object.entries(n.hass.entities)},d=new Set,u=new Set,_=function(e){(a||n.hass.states[e])&&d.add(e)},p=function(e){u.add(e)};return{get hass(){return n.hass},states:new Proxy((function(e){var t;if(r(e))return _(e),null===(t=n.hass.states[e])||void 0===t?void 0:t.state;throw SyntaxError("".concat(i,": states method cannot be used with a domain, use it as an object instead."))}),{get:function(e,t){if(r(t))return _(t),n.hass.states[t];var i=Object.entries(n.hass.states).filter((function(e){return e[0].startsWith(t)}));return(a||i.length)&&p(t),new Proxy(s(i),{get:function(e,i){return _("".concat(t,".").concat(i)),e[i]}})}}),is_state:function(e,t){var i;return _(e),(null===(i=n.hass.states[e])||void 0===i?void 0:i.state)===t},state_attr:function(e,t){var i,s;return _(e),null===(s=null===(i=n.hass.states[e])||void 0===i?void 0:i.attributes)||void 0===s?void 0:s[t]},is_state_attr:function(e,t,i){return this.state_attr(e,t)===i},has_value:function(t){return!!this.states(t)&&!(this.is_state(t,e.UNKNOWN)||this.is_state(t,e.UNAVAILABLE))},entities:new Proxy((function(e){if(void 0===e)return n.hass.entities;if(r(e))return _(e),n.hass.entities[e];var t=o().filter((function(t){return t[0].startsWith(e)}));return(a||t.length)&&p(e),new Proxy(s(t),{get:function(t,i){return _("".concat(e,".").concat(i)),t[i]}})}),{get:function(e,t){return e(t)}}),entity_prop:function(e,t){var i;return _(e),null===(i=n.hass.entities[e])||void 0===i?void 0:i[t]},is_entity_prop:function(e,t,i){return this.entity_prop(e,t)===i},devices:new Proxy((function(e){if(void 0===e)return n.hass.devices;if(r(e))throw SyntaxError("".concat(i,": devices method cannot be used with an entity id, you should use a device id instead."));return n.hass.devices[e]}),{get:function(e,t){if(r(t))throw SyntaxError("".concat(i,": devices cannot be accesed using an entity id, you should use a device id instead."));return n.hass.devices[t]}}),device_attr:function(e,t){var i;return null===(i=n.hass.devices[e])||void 0===i?void 0:i[t]},is_device_attr:function(e,t,i){return this.device_attr(e,t)===i},device_id:function(e){var t;return _(e),null===(t=n.hass.entities[e])||void 0===t?void 0:t.device_id},areas:function(){return c().map((function(e){return e[1].area_id}))},area_id:function(e){var i;if(e in n.hass.devices)return this.device_attr(e,t.AREA_ID);var s=this.device_id(e);if(s)return this.device_attr(s,t.AREA_ID);var r=c().find((function(t){return t[1].name===e}));return null===(i=null==r?void 0:r[1])||void 0===i?void 0:i.area_id},area_name:function(e){var i,s;e in n.hass.devices&&(s=this.device_attr(e,t.AREA_ID));var r=this.device_id(e);r&&(s=this.device_attr(r,t.AREA_ID));var a=c().find((function(t){var i=t[1];return i.area_id===e||i.area_id===s}));return null===(i=null==a?void 0:a[1])||void 0===i?void 0:i.name},area_entities:function(e){var t=c().find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?o().filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[0]})):[]},area_devices:function(e){var t=c().find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?Object.entries(n.hass.devices).filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[1].id})):[]},get user_name(){return n.hass.user.name},get user_is_admin(){return n.hass.user.is_admin},get user_is_owner(){return n.hass.user.is_owner},get user_agent(){return window.navigator.userAgent},tracked:{get entities(){return Array.from(d)},get domains(){return Array.from(u)}},cleanTrackedEntities:function(){d.clear()},cleanTrackedDomains:function(){u.clear()}}}var c=function(){function e(e,t,i){void 0===t&&(t=!1),void 0===i&&(i=!1),this._scopped=a(e,i),this._errors=t}return e.prototype.renderTemplate=function(e){try{var t=e.includes("return")?e:"return ".concat(e);return new Function("hass","states","is_state","state_attr","is_state_attr","has_value","entities","entity_prop","is_entity_prop","devices","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","user_agent","".concat('"use strict";'," ").concat(t))(this._scopped.hass,this._scopped.states,this._scopped.is_state.bind(this._scopped),this._scopped.state_attr.bind(this._scopped),this._scopped.is_state_attr.bind(this._scopped),this._scopped.has_value.bind(this._scopped),this._scopped.entities,this._scopped.entity_prop,this._scopped.is_entity_prop.bind(this._scopped),this._scopped.devices,this._scopped.device_attr.bind(this._scopped),this._scopped.is_device_attr.bind(this._scopped),this._scopped.device_id.bind(this._scopped),this._scopped.areas.bind(this._scopped),this._scopped.area_id.bind(this._scopped),this._scopped.area_name.bind(this._scopped),this._scopped.area_entities.bind(this._scopped),this._scopped.area_devices.bind(this._scopped),this._scopped.user_name,this._scopped.user_is_admin,this._scopped.user_is_owner,this._scopped.user_agent)}catch(e){if(this._errors)throw e;return void console.warn(e)}},Object.defineProperty(e.prototype,"tracked",{get:function(){return this._scopped.tracked},enumerable:!1,configurable:!0}),e.prototype.cleanTrackedEntities=function(){this._scopped.cleanTrackedEntities()},e.prototype.cleanTrackedDomains=function(){this._scopped.cleanTrackedDomains()},e.prototype.cleanTracked=function(){this._scopped.cleanTrackedEntities(),this._scopped.cleanTrackedDomains()},e}();module.exports=c;
+"use strict";var t,e,i="[home-assistant-javascript-templates]",n=/^([a-z_]+)\.(\w+)$/;!function(t){t.UNKNOWN="unknown",t.UNAVAILABLE="unavailable"}(t||(t={})),function(t){t.AREA_ID="area_id",t.NAME="name"}(e||(e={}));var s=function(t){return t.reduce((function(t,e){var i=e[0],s=e[1];return t[i.replace(n,"$2")]=s,t}),{})},r=function(t){return t.includes(".")};function a(n,a){var o=function(){return Object.entries(n.hass.areas)},c=function(){return Object.entries(n.hass.entities)},u=new Set,d=function(t,e){a&&console.warn("".concat(t," ").concat(e," used in a JavaScript template doesn't exist"))},_=function(t){return d("Entity",t)},h=function(t){return d("Domain",t)},p=function(t){n.hass.states[t]?u.add(t):_(t)};return{get hass(){return n.hass},states:new Proxy((function(t){var e;if(r(t))return p(t),null===(e=n.hass.states[t])||void 0===e?void 0:e.state;throw SyntaxError("".concat(i,": states method cannot be used with a domain, use it as an object instead."))}),{get:function(t,e){if(r(e))return p(e),n.hass.states[e];var i=Object.entries(n.hass.states).filter((function(t){return t[0].startsWith(e)}));return i.length||h(e),new Proxy(s(i),{get:function(t,i){return p("".concat(e,".").concat(i)),t[i]}})}}),is_state:function(t,e){var i;return p(t),(null===(i=n.hass.states[t])||void 0===i?void 0:i.state)===e},state_attr:function(t,e){var i,s;return p(t),null===(s=null===(i=n.hass.states[t])||void 0===i?void 0:i.attributes)||void 0===s?void 0:s[e]},is_state_attr:function(t,e,i){return this.state_attr(t,e)===i},has_value:function(e){return this.states(e)?!(this.is_state(e,t.UNKNOWN)||this.is_state(e,t.UNAVAILABLE)):(_(e),!1)},entities:new Proxy((function(t){if(void 0===t)return n.hass.entities;if(r(t))return p(t),n.hass.entities[t];var e=c().filter((function(e){return e[0].startsWith(t)}));return e.length||h(t),new Proxy(s(e),{get:function(e,i){return p("".concat(t,".").concat(i)),e[i]}})}),{get:function(t,e){return t(e)}}),entity_prop:function(t,e){var i;return p(t),null===(i=n.hass.entities[t])||void 0===i?void 0:i[e]},is_entity_prop:function(t,e,i){return this.entity_prop(t,e)===i},devices:new Proxy((function(t){if(void 0===t)return n.hass.devices;if(r(t))throw SyntaxError("".concat(i,": devices method cannot be used with an entity id, you should use a device id instead."));return n.hass.devices[t]}),{get:function(t,e){if(r(e))throw SyntaxError("".concat(i,": devices cannot be accesed using an entity id, you should use a device id instead."));return n.hass.devices[e]}}),device_attr:function(t,e){var i;return null===(i=n.hass.devices[t])||void 0===i?void 0:i[e]},is_device_attr:function(t,e,i){return this.device_attr(t,e)===i},device_id:function(t){var e;return p(t),null===(e=n.hass.entities[t])||void 0===e?void 0:e.device_id},areas:function(){return o().map((function(t){return t[1].area_id}))},area_id:function(t){var i,s;if(t in n.hass.devices)return this.device_attr(t,e.AREA_ID);var r=null===(i=n.hass.entities[t])||void 0===i?void 0:i.device_id;if(r)return this.device_attr(r,e.AREA_ID);var a=o().find((function(e){return e[1].name===t}));return null===(s=null==a?void 0:a[1])||void 0===s?void 0:s.area_id},area_name:function(t){var i,s,r;t in n.hass.devices&&(r=this.device_attr(t,e.AREA_ID));var a=null===(i=n.hass.entities[t])||void 0===i?void 0:i.device_id;a&&(r=this.device_attr(a,e.AREA_ID));var c=o().find((function(e){var i=e[1];return i.area_id===t||i.area_id===r}));return null===(s=null==c?void 0:c[1])||void 0===s?void 0:s.name},area_entities:function(t){var e=o().find((function(e){var i=e[1];return i.area_id===t||i.name===t}));return e?c().filter((function(t){return t[1].area_id===e[1].area_id})).map((function(t){return t[0]})):[]},area_devices:function(t){var e=o().find((function(e){var i=e[1];return i.area_id===t||i.name===t}));return e?Object.entries(n.hass.devices).filter((function(t){return t[1].area_id===e[1].area_id})).map((function(t){return t[1].id})):[]},get user_name(){return n.hass.user.name},get user_is_admin(){return n.hass.user.is_admin},get user_is_owner(){return n.hass.user.is_owner},get user_agent(){return window.navigator.userAgent},get tracked(){return u},cleanTracked:function(){u.clear()}}}var o=function(){function t(t,e){var i=e.throwErrors,n=void 0!==i&&i,s=e.throwWarnings,r=void 0===s||s;this._throwErrors=n,this._throwWarnings=r,this._subscriptions=new Map,this._scopped=a(t,r),this._watchForEntitiesChange()}return t.prototype._watchForEntitiesChange=function(){var t=this;window.hassConnection.then((function(e){e.conn.subscribeMessage((function(e){return t._entityWatchCallback(e)}),{type:"subscribe_events",event_type:"state_changed"})}))},t.prototype._entityWatchCallback=function(t){var e=this;if(this._subscriptions.size){var i=t.data.entity_id;this._subscriptions.has(i)&&this._subscriptions.get(i).forEach((function(t,i){e.trackTemplate(i,t)}))}},t.prototype._storeTracked=function(t,e){var i=this;this._scopped.tracked.forEach((function(n){if(i._subscriptions.has(n)){var s=i._subscriptions.get(n);s.has(t)||s.set(t,e)}else i._subscriptions.set(n,new Map([[t,e]]))}))},t.prototype.renderTemplate=function(t){try{var e=t.includes("return")?t:"return ".concat(t);return new Function("hass","states","is_state","state_attr","is_state_attr","has_value","entities","entity_prop","is_entity_prop","devices","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","user_agent","".concat('"use strict";'," ").concat(e))(this._scopped.hass,this._scopped.states,this._scopped.is_state.bind(this._scopped),this._scopped.state_attr.bind(this._scopped),this._scopped.is_state_attr.bind(this._scopped),this._scopped.has_value.bind(this._scopped),this._scopped.entities,this._scopped.entity_prop,this._scopped.is_entity_prop.bind(this._scopped),this._scopped.devices,this._scopped.device_attr.bind(this._scopped),this._scopped.is_device_attr.bind(this._scopped),this._scopped.device_id.bind(this._scopped),this._scopped.areas.bind(this._scopped),this._scopped.area_id.bind(this._scopped),this._scopped.area_name.bind(this._scopped),this._scopped.area_entities.bind(this._scopped),this._scopped.area_devices.bind(this._scopped),this._scopped.user_name,this._scopped.user_is_admin,this._scopped.user_is_owner,this._scopped.user_agent)}catch(t){if(this._throwErrors)throw t;return void(this._throwWarnings&&console.warn(t))}},t.prototype.trackTemplate=function(t,e){this._scopped.cleanTracked();var i=this.renderTemplate(t);this._storeTracked(t,e),e(i)},t.prototype.cleanTracked=function(t){t?this._subscriptions.has(t)&&this._subscriptions.delete(t):this._subscriptions.clear()},t}(),c=function(){function t(t,e){var i,n;void 0===e&&(e={}),this._renderer=(i=function(){return t.hass},n=function(t){return!!(t&&t.areas&&t.devices&&t.entities&&t.states&&t.user)},new Promise((function(t,e){var s=0,r=function(){var a=i();n(a)?t(a):++s<100?setTimeout(r,50):e()};r()}))).then((function(){return new o(t,e)})).catch((function(){throw new Error("The provided element doesn't contain a proper or initialised hass object")}))}return t.prototype.getRenderer=function(){return this._renderer},t}();module.exports=c;

package.json

 {
   "name": "home-assistant-javascript-templates",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "A JavaScript utility to render Home Assistant JavaScript templates",
@@ -49,12 +49,12 @@ "keywords": [
     "@rollup/plugin-terser": "^0.4.4",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^22.5.0",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.5.5",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "rollup": "^4.21.0",
+    "rollup": "^4.21.3",
     "rollup-plugin-ts": "^3.4.5",
     "ts-jest": "^29.2.5",
     "tslib": "^2.7.0",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   }
 }

README.md

@@ -37,7 +37,13 @@ # home-assistant-javascript-templates
 
-const renderer = new HomeAssistantJavaScriptTemplates(
+const haJsTemplates = new HomeAssistantJavaScriptTemplates(
     document.querySelector('home-assistant')
 );
 
-renderer.renderTemplate('... template string ...');
+haJsTemplates.getRenderer()
+    then((renderer) => {
+        renderer.renderTemplate('... template string ...');
+        renderer.trackTemplate('... template string ...', () => {
+            // execute this function every time that en entity used in the template changes
+        });
+    });
 ```
@@ -50,7 +56,13 @@
 
-const renderer = new HomeAssistantJavaScriptTemplates(
+const haJsTemplates = new HomeAssistantJavaScriptTemplates(
     document.querySelector('home-assistant')
 );
 
-renderer.renderTemplate('... template string ...');
+haJsTemplates.getRenderer()
+    then((renderer) => {
+        renderer.renderTemplate('... template string ...');
+        renderer.trackTemplate('... template string ...', () => {
+            // execute this function every time that en entity used in the template changes
+        });
+    });
 ```
@@ -60,3 +72,3 @@
 
-The package exposes a class that needs to be instantiated and is this instance the one that you need to use in your code.
+The package exposes a class that needs to be instantiated and the resolved promise that returns the `getRenderer` method of this instance is what you need to use in your code to render `JavaScript` templates.
 
@@ -70,4 +82,3 @@ ### HomeAssistantJavaScriptTemplates class
     ha,
-    throwErrors = false,
-    trackNonExistent = false
+    options
 );
@@ -79,25 +90,21 @@ ```
 | `ha`               | no            | An HTML element that has the `hass` object as a property (e.g. the `home-assistant` custom element). |
-| `throwErrors`      | yes           | Indicates if the library should throw if the template contains any error. If not it will log the errors as a warning in the console and return `undefined` instead. |
-| `trackNonExistent` | yes           | Indicates if the library should track those domains and entities that doesn't exist. |
+| `options`          | yes           | An object containing the configuration options. |
 
-### Properties
+#### Configuration options
 
-#### tracked
+| Parameter          | Optional      | Default | Description                                        |
+| ------------------ | ------------- | ------- | -------------------------------------------------- |
+| `throwErrors`      | yes           | false   | Indicates if the library should throw if the template contains any error. If not, it will log the errors as a warning in the console and return `undefined` instead. |
+| `throwWarnings`    | yes           | true    | Indicates if the library should throw warnings in the console, either when there is an error in the templates and `throwErrors` is configured in `false`, or when a non-existent entity or domain is used in the templates. |
 
-```typescript
-interface Tracked {
-    entities: string[];
-    domains: string[];
-}
+### Methods
 
-get tracked(): Tracked
-```
+#### getRenderer
 
-This property will return an object with two properties (`entities` and `domains`). Each of these properties will be an array containing the entities or ids that have been tracked when the templates have been rendered. If some domain or entity was not reached because it was inside a condition that never met, then it will not be included in the `tracked` property. Only those entities or domains that were called during the rendering by the code using [states](#states), [is_state](#is_state), [state_attr](#state_attr), [is_state_attr](#is_state_attr), [has_value](#has_value) [entities](#entities), [entity_prop](#entity_prop), [is_entity_prop](#is_entity_prop) or [device_id](#device_id) will be included.
+Returns a `Promise` than once it resolved returns an instance of the [HomeAssistantJavaScriptTemplatesRenderer](#homeassistantjavascripttemplatesrenderer-class) class.
 
->Notes:
-> 1. Take into account that in the case of `states`, the domains will be tracked only if `states` is used as an object to acces a domain, for example `states('device_tracker.paulus')` or `states['device_tracker.paulus']` will track the entity `device_tracker.paulus` but not the domain `device_tracker` but `states.device_tracker.paulus` will track both, the domain `device_tracker` and the entity `device_tracker.paulus`.
-> 2. In the case of `entities`, both, the method and the object will track a domain if a domain is used, for example `entities('device_tracker.paulus')` or `entities['device_tracker.paulus']` will track the entity `device_tracker.paulus` but not the domain `device_tracker`. On the other hand, `entities('device_tracker')` will track the domain `device_tracker` and `entities.device_tracker.paulus` will track both, the domain `device_tracker` and the entity `device_tracker.paulus`.
-> 3. The rest of the methods will track only entities.
+### HomeAssistantJavaScriptTemplatesRenderer class
 
+This class is only exported as a type in the package, you cannot import it directly. An instance of this class will be returned by the promise that is returned by the [getRenderer method](#getrenderer) of the [HomeAssistantJavaScriptTemplates class](#homeassistantjavascripttemplates-class).
+
 ### Methods
@@ -111,27 +118,24 @@
 
-This is the main method to render `JavaScript` templates, it needs a string as a parameter. Inside this string you can use [several objects and methods](#objects-and-methods-available-in-the-templates). It returns whatever the `JavaScript` code returns, because of that it is typed as `any`.
+This method renders a `JavaScript` template and return its result. It needs a string as a parameter. Inside this string you can use [several objects and methods](#objects-and-methods-available-in-the-templates). It returns whatever the `JavaScript` code returns, because of that it is typed as `any`.
 
-#### cleanTrackedEntities
+#### trackTemplate
 
 ```typescript
-cleanTrackedEntities(): void
+trackTemplate(
+    template: string,
+    renderingFunction: (result?: any) => void
+): void
 ```
 
-This method will clean all the tracked entities until the moment, so after being called, the `tracked` property will return an empty array as `entities`.
+This method registers a template tracking. It executes the `renderingFunction` sent to the method with the result of the rendered `template` and will execute `renderingFunction` with an updated result of the rendered `template` every time that the entities used in the template update. You can use [several objects and methods](#objects-and-methods-available-in-the-templates) inside the `template` string.
 
-#### cleanTrackedDomains
+If some entity was not reached in the template code because it was inside a condition that never met, then it will not be tracked, so if its state changes it will not trigger the `renderingFunction`. Only those entities that were called during the rendering using [states](#states), [is_state](#is_state), [state_attr](#state_attr), [is_state_attr](#is_state_attr), [has_value](#has_value) [entities](#entities), [entity_prop](#entity_prop), [is_entity_prop](#is_entity_prop) or [device_id](#device_id) will be included.
 
-```typescript
-cleanTrackedDomains(): void
-```
-
-This method will clean all the tracked domains until the moment, so after being called, the `tracked` property will return an empty array as `domains`.
-
 #### cleanTracked
 
 ```typescript
-cleanTracked(): void
+cleanTracked(entityId?: string): void
 ```
 
-This method will clean all the tracked entities and domains until the moment. It is the same as calling `cleanTrackedEntities` and `cleanTrackedDomains` consecutively.
+This method will clean the template tracking for a specific entity or will clean all the template trackings if no entity id is specified.
 
@@ -348,3 +352,3 @@ ### Objects and methods available in the templates
 
-const renderer = new HomeAssistantJavaScriptTemplates(
+const haJsTemplates = new HomeAssistantJavaScriptTemplates(
     document.querySelector('home-assistant')
@@ -359,10 +363,15 @@ );
  */
-renderer.renderTemplate(`
-    const deviceId = device_id("binary_sensor.koffiezetapparaat_aan");
-    const serialNumber = device_attr(deviceId, "serial_number");
-    return "sn:" + serialNumber;
-`);
+haJsTemplates.getRenderer()
+    .then((renderer) => {
+        const result = renderer.renderTemplate(`
+            const deviceId = device_id("binary_sensor.koffiezetapparaat_aan");
+            const serialNumber = device_attr(deviceId, "serial_number");
+            return "sn:" + serialNumber;
+        `);
+        console.log(result);
+    });
+
 ```
 
-#### Get all the available updates
+#### Get all the available updates and update an HTML element with the result with entity changes
 
@@ -372,14 +381,24 @@ ```javascript
 
-const renderer = new HomeAssistantJavaScriptTemplates(
+const haJsTemplates = new HomeAssistantJavaScriptTemplates(
     document.querySelector('home-assistant')
 );
 
-renderer.renderTemplate(`
-    const udatesEntities = states.update;
-    const updateEntitiesValues = Object.values(udatesEntities);
-    const updatesEntitiesOn = updateEntitiesValues.filter((entity) => entity.state === 'on');
-    return updatesEntitiesOn.length;
-`);
+haJsTemplates.getRenderer()
+    .then((renderer) => {
+        const element = document.querySelector('#my-element');
+        renderer.trackTemplate(
+            `
+            const udatesEntities = states.update;
+            const updateEntitiesValues = Object.values(udatesEntities);
+            const updatesEntitiesOn = updateEntitiesValues.filter((entity) => entity.state === 'on');
+            return updatesEntitiesOn.length;
+            `,
+            (result) => {
+                element.innerHTML = result;
+            }
+        );
+    });
+
 ```
 
 [Optional chaining operator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining

No alert changes

Improved metrics

Total package byte prevSize

44842

increased by12.17%

Lines of code

194

increased by34.72%

Number of lines in readme file

395

increased by5.05%

No dependency changes