home-assistant-javascript-templates 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -2
- package/dist/esm/index.d.ts +7 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +7 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
A JavaScript utility to render Home Assistant JavaScript templates.
|
|
4
4
|
|
|
5
|
-
[](https://github.com/elchininet/home-assistant-javascript-templates/actions/workflows/deploy.yaml)
|
|
5
|
+
[](https://github.com/elchininet/home-assistant-javascript-templates/actions/workflows/deploy.yaml)
|
|
6
|
+
[](https://coveralls.io/github/elchininet/home-assistant-javascript-templates?branch=master)
|
|
7
|
+
[](https://badge.fury.io/js/home-assistant-javascript-templates)
|
|
6
8
|
|
|
7
9
|
## Install
|
|
8
10
|
|
|
@@ -191,7 +193,33 @@ area_devices('woonkamer')
|
|
|
191
193
|
area_devices('Woonkamer')
|
|
192
194
|
```
|
|
193
195
|
|
|
194
|
-
|
|
196
|
+
#### user_name
|
|
197
|
+
|
|
198
|
+
Property to return the name of the user logged in in Home Assistant. It returns a `string`.
|
|
199
|
+
|
|
200
|
+
```javascript
|
|
201
|
+
user_name
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
#### user_is_admin
|
|
205
|
+
|
|
206
|
+
Property to return if the user logged in in Home Assistant is admin or not. It returns a `boolean`.
|
|
207
|
+
|
|
208
|
+
```javascript
|
|
209
|
+
user_is_admin
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### user_is_owner
|
|
213
|
+
|
|
214
|
+
Property to return if the user logged in in Home Assistant is the owner. It returns a `boolean`.
|
|
215
|
+
|
|
216
|
+
```javascript
|
|
217
|
+
user_is_owner
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
## Examples
|
|
221
|
+
|
|
222
|
+
#### Get a device attribute and return a formatted text with it
|
|
195
223
|
|
|
196
224
|
```javascript
|
|
197
225
|
import HomeAssistantJavaScriptTemplates from 'home-assistant-javascript-templates';
|
|
@@ -211,4 +239,20 @@ renderer.renderTemplate(`
|
|
|
211
239
|
const serialNumber = device_attr(deviceId, "serial_number");
|
|
212
240
|
return "sn:" + serialNumber;
|
|
213
241
|
`);
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
#### Get all the available updates
|
|
245
|
+
|
|
246
|
+
```javascript
|
|
247
|
+
import HomeAssistantJavaScriptTemplates from 'home-assistant-javascript-templates';
|
|
248
|
+
|
|
249
|
+
const renderer = new HomeAssistantJavaScriptTemplates(
|
|
250
|
+
document.querySelector('home-assistant').hass
|
|
251
|
+
);
|
|
252
|
+
|
|
253
|
+
renderer.renderTemplate(`
|
|
254
|
+
const udatesEntities = states['update'];
|
|
255
|
+
const updatesEntitiesOn = udatesEntities?.filter((entity) => entity.state === 'on');
|
|
256
|
+
return updatesEntitiesOn?.length || 0;
|
|
257
|
+
`);
|
|
214
258
|
```
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -16,11 +16,17 @@ interface Entity {
|
|
|
16
16
|
area_id: string | null;
|
|
17
17
|
device_id: string;
|
|
18
18
|
}
|
|
19
|
+
interface User {
|
|
20
|
+
name: string;
|
|
21
|
+
is_admin: boolean;
|
|
22
|
+
is_owner: boolean;
|
|
23
|
+
}
|
|
19
24
|
interface Hass {
|
|
20
25
|
areas: Record<string, Area>;
|
|
21
26
|
devices: Record<string, Device>;
|
|
22
27
|
entities: Record<string, Entity>;
|
|
23
28
|
states: Record<string, State>;
|
|
29
|
+
user: User;
|
|
24
30
|
}
|
|
25
31
|
declare class HomeAssistantJavaScriptTemplates {
|
|
26
32
|
constructor(hass: Hass, throwErrors?: boolean);
|
|
@@ -28,4 +34,4 @@ declare class HomeAssistantJavaScriptTemplates {
|
|
|
28
34
|
private _errors;
|
|
29
35
|
renderTemplate(template: string): string;
|
|
30
36
|
}
|
|
31
|
-
export { HomeAssistantJavaScriptTemplates as default };
|
|
37
|
+
export { HomeAssistantJavaScriptTemplates as default, Hass };
|
package/dist/esm/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
var e,t;!function(e){e.UNKNOWN="unknown",e.UNAVAILABLE="unavailable"}(e||(e={})),function(e){e.AREA_ID="area_id",e.NAME="name"}(t||(t={}));var i="None";function r(e,t,i){if(i||2===arguments.length)for(var r,s=0,n=t.length;s<n;s++)!r&&s in t||(r||(r=Array.prototype.slice.call(t,0,s)),r[s]=t[s]);return e.concat(r||Array.prototype.slice.call(t))}"function"==typeof SuppressedError&&SuppressedError;function s(s){var n=Object.entries(s.areas),a=Object.entries(s.states),d=Object.entries(s.devices),_=Object.entries(s.entities);return{hass:s,states:new Proxy((function(e){var t;return null===(t=s.states[e])||void 0===t?void 0:t.state}),{get:function(e,t){return t.includes(".")?s.states[t]:a.filter((function(e){return e[0].startsWith(t)})).reduce((function(e,t){var i=t[1];return r(r([],e,!0),[i],!1)}),[])}}),is_state:function(e,t){var i;return(null===(i=s.states[e])||void 0===i?void 0:i.state)===t},state_attr:function(e,t){var r,n;return(null===(n=null===(r=s.states[e])||void 0===r?void 0:r.attributes)||void 0===n?void 0:n[t])||i},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))},device_attr:function(e,t){var r;return(null===(r=s.devices[e])||void 0===r?void 0:r[t])||i},is_device_attr:function(e,t,i){return this.device_attr(e,t)===i},device_id:function(e){var t;return(null===(t=s.entities[e])||void 0===t?void 0:t.device_id)||i},areas:function(){return n.map((function(e){return e[1].area_id}))},area_id:function(e){var r;if(e in s.devices)return this.device_attr(e,t.AREA_ID);var a=this.device_id(e);if(a&&a!==i)return this.device_attr(a,t.AREA_ID);var d=n.find((function(t){return t[1].name===e}));return(null===(r=null==d?void 0:d[1])||void 0===r?void 0:r.area_id)||i},area_name:function(e){var r,a;e in s.devices&&(a=this.device_attr(e,t.AREA_ID));var d=this.device_id(e);d&&d!==i&&(a=this.device_attr(d,t.AREA_ID));var _=n.find((function(t){var i=t[1];return i.area_id===e||i.area_id===a}));return(null===(r=null==_?void 0:_[1])||void 0===r?void 0:r.name)||i},area_entities:function(e){var t=n.find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?_.filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[0]})):[]},area_devices:function(e){var t=n.find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?d.filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[1].id})):[]},user_name:s.user.name,user_is_admin:s.user.is_admin,user_is_owner:s.user.is_owner}}var n=function(){function e(e,t){void 0===t&&(t=!1),this._scopped=s(e),this._errors=t}return e.prototype.renderTemplate=function(e){var t=e.includes("return")?e:"return ".concat(e),i=new Function("hass","states","is_state","state_attr","is_state_attr","has_value","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","".concat('"use strict";'," ").concat(t));try{return i(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.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)}catch(e){if(this._errors)throw e;return void console.warn(e)}},e}();export{n as default};
|
package/dist/index.d.ts
CHANGED
|
@@ -16,11 +16,17 @@ interface Entity {
|
|
|
16
16
|
area_id: string | null;
|
|
17
17
|
device_id: string;
|
|
18
18
|
}
|
|
19
|
+
interface User {
|
|
20
|
+
name: string;
|
|
21
|
+
is_admin: boolean;
|
|
22
|
+
is_owner: boolean;
|
|
23
|
+
}
|
|
19
24
|
interface Hass {
|
|
20
25
|
areas: Record<string, Area>;
|
|
21
26
|
devices: Record<string, Device>;
|
|
22
27
|
entities: Record<string, Entity>;
|
|
23
28
|
states: Record<string, State>;
|
|
29
|
+
user: User;
|
|
24
30
|
}
|
|
25
31
|
declare class HomeAssistantJavaScriptTemplates {
|
|
26
32
|
constructor(hass: Hass, throwErrors?: boolean);
|
|
@@ -28,4 +34,4 @@ declare class HomeAssistantJavaScriptTemplates {
|
|
|
28
34
|
private _errors;
|
|
29
35
|
renderTemplate(template: string): string;
|
|
30
36
|
}
|
|
31
|
-
export { HomeAssistantJavaScriptTemplates as default };
|
|
37
|
+
export { HomeAssistantJavaScriptTemplates as default, Hass };
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";
|
|
1
|
+
"use strict";var e,t;!function(e){e.UNKNOWN="unknown",e.UNAVAILABLE="unavailable"}(e||(e={})),function(e){e.AREA_ID="area_id",e.NAME="name"}(t||(t={}));var i="None";function r(e,t,i){if(i||2===arguments.length)for(var r,s=0,n=t.length;s<n;s++)!r&&s in t||(r||(r=Array.prototype.slice.call(t,0,s)),r[s]=t[s]);return e.concat(r||Array.prototype.slice.call(t))}"function"==typeof SuppressedError&&SuppressedError;function s(s){var n=Object.entries(s.areas),a=Object.entries(s.states),d=Object.entries(s.devices),_=Object.entries(s.entities);return{hass:s,states:new Proxy((function(e){var t;return null===(t=s.states[e])||void 0===t?void 0:t.state}),{get:function(e,t){return t.includes(".")?s.states[t]:a.filter((function(e){return e[0].startsWith(t)})).reduce((function(e,t){var i=t[1];return r(r([],e,!0),[i],!1)}),[])}}),is_state:function(e,t){var i;return(null===(i=s.states[e])||void 0===i?void 0:i.state)===t},state_attr:function(e,t){var r,n;return(null===(n=null===(r=s.states[e])||void 0===r?void 0:r.attributes)||void 0===n?void 0:n[t])||i},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))},device_attr:function(e,t){var r;return(null===(r=s.devices[e])||void 0===r?void 0:r[t])||i},is_device_attr:function(e,t,i){return this.device_attr(e,t)===i},device_id:function(e){var t;return(null===(t=s.entities[e])||void 0===t?void 0:t.device_id)||i},areas:function(){return n.map((function(e){return e[1].area_id}))},area_id:function(e){var r;if(e in s.devices)return this.device_attr(e,t.AREA_ID);var a=this.device_id(e);if(a&&a!==i)return this.device_attr(a,t.AREA_ID);var d=n.find((function(t){return t[1].name===e}));return(null===(r=null==d?void 0:d[1])||void 0===r?void 0:r.area_id)||i},area_name:function(e){var r,a;e in s.devices&&(a=this.device_attr(e,t.AREA_ID));var d=this.device_id(e);d&&d!==i&&(a=this.device_attr(d,t.AREA_ID));var _=n.find((function(t){var i=t[1];return i.area_id===e||i.area_id===a}));return(null===(r=null==_?void 0:_[1])||void 0===r?void 0:r.name)||i},area_entities:function(e){var t=n.find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?_.filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[0]})):[]},area_devices:function(e){var t=n.find((function(t){var i=t[1];return i.area_id===e||i.name===e}));return t?d.filter((function(e){return e[1].area_id===t[1].area_id})).map((function(e){return e[1].id})):[]},user_name:s.user.name,user_is_admin:s.user.is_admin,user_is_owner:s.user.is_owner}}var n=function(){function e(e,t){void 0===t&&(t=!1),this._scopped=s(e),this._errors=t}return e.prototype.renderTemplate=function(e){var t=e.includes("return")?e:"return ".concat(e),i=new Function("hass","states","is_state","state_attr","is_state_attr","has_value","device_attr","is_device_attr","device_id","areas","area_id","area_name","area_entities","area_devices","user_name","user_is_admin","user_is_owner","".concat('"use strict";'," ").concat(t));try{return i(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.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)}catch(e){if(this._errors)throw e;return void console.warn(e)}},e}();module.exports=n;
|