update README with all extensions implemented and their types (and TO…

…DO implementations), add HA backend like states object named _states, distance and groups tests to work with _states
Nerwyn · Sep 21, 2024 · 65ae2e7 · 65ae2e7
1 parent db39341
commit 65ae2e7
Show file tree

Hide file tree

Showing 25 changed files with 575 additions and 166 deletions.
diff --git a/README.md b/README.md
diff --git a/dist/globals.js b/dist/globals.js
@@ -9,10 +9,10 @@ import { integration_entities } from './utils/integrations';
 import { label_areas, label_devices, label_entities, labels, } from './utils/labels';
 import { match_media, str } from './utils/miscellaneous';
 import { acos, asin, atan, atan2, average, bool, cos, e, float, inf, int, is_number, log, max, median, min, pi, sin, sqrt, statistical_mode, tan, tau, } from './utils/numeric';
-import { list, set } from './utils/set';
 import { attr_name_translated, attr_value_translated, state_translated, } from './utils/state_translated';
 import { has_value, is_state, is_state_attr, state_attr, states, } from './utils/states';
 import { as_datetime, as_local, as_timedelta, as_timestamp, now, strptime, time_since, time_until, timedelta, today_at, utcnow, } from './utils/time';
+import { list, set } from './utils/type';
 import { zip } from './utils/zip';
 import { Template } from 'nunjucks';
 export function addGlobals(env) {
@@ -114,7 +114,7 @@ const GLOBALS = {
     list,
     // Iterating Multiple Objects
     zip,
-    // Other
+    // Miscellaneous
     match_media,
     str,
 };

diff --git a/dist/index.js b/dist/index.js
@@ -2,6 +2,7 @@ import nunjucks from 'nunjucks';
 import { addFilters } from './filters';
 import { addGlobals } from './globals';
 import { addTests } from './tests';
+import { buildStatesObject } from './utils/states';
 nunjucks.installJinjaCompat();
 const env = addTests(addFilters(addGlobals(new nunjucks.Environment())));
 /**
@@ -18,6 +19,7 @@ export function renderTemplate(hass, str, context) {
         str = env
             .renderString(structuredClone(str), {
             hass,
+            _states: buildStatesObject(hass),
             ...context,
         })
             .trim();

diff --git a/dist/tests.js b/dist/tests.js
@@ -1,4 +1,9 @@
 import { Template } from 'nunjucks';
+import { contains } from './utils/contains';
+import { is_device_attr } from './utils/devices';
+import { is_hidden_entity } from './utils/entities';
+import { match, search } from './utils/regexp';
+import { has_value, is_state, is_state_attr } from './utils/states';
 export function addTests(env) {
     for (const t in TESTS) {
         env.addTest(t, function (...args) {
@@ -15,6 +20,19 @@ export function addTests(env) {
     }
     return env;
 }
-// TODO add tests
-const HASS_TESTS = {};
+const HASS_TESTS = {
+    // States
+    is_state,
+    is_state_attr,
+    has_value,
+    // Entities
+    is_hidden_entity,
+    // Devices
+    is_device_attr,
+    // Contains
+    contains,
+    // Regular Expressions
+    match,
+    search,
+};
 const TESTS = {};
diff --git a/dist/utils/distance.d.ts b/dist/utils/distance.d.ts
@@ -1,4 +1,4 @@
 import { HomeAssistant } from 'custom-card-helpers';
 import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
-export declare function distance(hass: HomeAssistant, ...args: (string | number)[]): number | null | undefined;
+export declare function distance(hass: HomeAssistant, ...args: (string | HassEntity | number)[]): number | null | undefined;
 export declare function closest(hass: HomeAssistant, ...args: (string | string[] | HassEntity | HassEntities)[]): HassEntity | null;
diff --git a/dist/utils/distance.js b/dist/utils/distance.js
@@ -91,6 +91,11 @@ export function distance(hass, ...args) {
             lon1 = hass.states[args[0]].attributes.longitude;
             i = 1;
         }
+        else if (typeof args[0] == 'object' && !Array.isArray(args[0])) {
+            lat1 = args[0].attributes.latitude;
+            lon1 = args[0].attributes.longitude;
+            i = 1;
+        }
         else if (typeof args[0] == 'number') {
             if (!(typeof args[1] == 'number')) {
                 throw Error('Latitude provided but not longitude 1');
@@ -106,6 +111,10 @@ export function distance(hass, ...args) {
             lat2 = hass.states[args[i]].attributes.latitude;
             lon2 = hass.states[args[i]].attributes.longitude;
         }
+        else if (typeof args[0] == 'object' && !Array.isArray(args[0])) {
+            lat2 = args[i].attributes.latitude;
+            lon2 = args[i].attributes.longitude;
+        }
         else if (typeof args[i] == 'number') {
             if (!(typeof args[i + 1] == 'number')) {
                 throw Error('Latitude provided but not longitude 2');
@@ -158,10 +167,10 @@ export function closest(hass, ...args) {
         start = 2;
     }
     else if (typeof args[0] == 'object') {
-        if (Array.isArray(args[0])) {
+        if (Array.isArray(args[0]) || !args[0].attributes) {
             return null;
         }
-        // Assume is stateobj
+        // Is state object
         home = [
             args[0].attributes.latitude,
             args[0].attributes.longitude,
@@ -194,7 +203,15 @@ export function closest(hass, ...args) {
                 }
             }
             else {
-                entityIds0 = Object.keys(args[i]);
+                const entities = Object.keys(args[i]);
+                if (args[i][entities[0]].entity_id) {
+                    entityIds0 = entities.map((key) => args[i][key].entity_id);
+                }
+                else {
+                    for (const domain of entities) {
+                        entityIds0.push(...Object.keys(args[i][domain]).map((key) => args[i][domain][key].entity_id));
+                    }
+                }
             }
             for (const entity of entityIds0) {
                 entityIds.push(...getEntityIdsByString(entity));

diff --git a/dist/utils/groups.d.ts b/dist/utils/groups.d.ts
@@ -1,3 +1,3 @@
 import { HomeAssistant } from 'custom-card-helpers';
-import { HassEntity } from 'home-assistant-js-websocket';
-export declare function expand(hass: HomeAssistant, ...args: (string | HassEntity)[]): HassEntity[];
+import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
+export declare function expand(hass: HomeAssistant, ...args: (string | HassEntity | HassEntities)[]): HassEntity[];
diff --git a/dist/utils/groups.js b/dist/utils/groups.js
@@ -8,13 +8,37 @@ export function expand(hass, ...args) {
             if (Array.isArray(entity.attributes?.entity_id)) {
                 res.push(...expand(hass, ...entity.attributes?.entity_id));
             }
-            else if (entity.attributes?.persons) {
-                res.push(...expand(hass, ...entity.attributes?.persons));
+            else if (entity?.attributes?.persons) {
+                res.push(...expand(hass, ...entity.attributes.persons));
             }
             else {
-                res.push(entity);
+                if (entity.entity_id) {
+                    res.push(entity);
+                }
+                else {
+                    const entities = Object.values(entity);
+                    if (entities[0]?.entity_id) {
+                        res.push(...entities);
+                    }
+                    else {
+                        for (const domain of entities) {
+                            const stateObjects = Object.values(domain);
+                            for (const stateObj of stateObjects) {
+                                if (stateObj?.attributes?.persons) {
+                                    res.push(...expand(hass, ...stateObj.attributes.persons));
+                                }
+                                else {
+                                    res.push(stateObj);
+                                }
+                            }
+                        }
+                    }
+                }
             }
         }
     }
-    return Array.from(new Set(res)).sort((a, b) => a.entity_id.localeCompare(b.entity_id));
+    return res
+        .filter((value, index, self) => index ==
+        self.findIndex((obj) => obj.entity_id == value.entity_id))
+        .sort((a, b) => a.entity_id.localeCompare(b.entity_id));
 }
diff --git a/dist/utils/json.js b/dist/utils/json.js
@@ -1,8 +1,8 @@
-export function to_json(obj, ensure_ascii = true, pretty_print = false, sort_keys = false) {
+export function to_json(obj, ensure_ascii = false, pretty_print = false, sort_keys = false) {
     if (typeof ensure_ascii == 'object' && !Array.isArray(ensure_ascii)) {
         sort_keys = ensure_ascii.sort_keys ?? sort_keys;
         pretty_print = ensure_ascii.pretty_print ?? pretty_print;
-        ensure_ascii = ensure_ascii.ensure_ascii ?? ensure_ascii;
+        ensure_ascii = ensure_ascii.ensure_ascii ?? false;
     }
     if (sort_keys) {
         obj = Object.keys(obj)

diff --git a/dist/utils/states.d.ts b/dist/utils/states.d.ts
@@ -1,6 +1,8 @@
 import { HomeAssistant } from 'custom-card-helpers';
+import { HassEntity } from 'home-assistant-js-websocket';
 export declare function states(hass: HomeAssistant, entity_id: string, rounded?: boolean | Record<string, boolean>, with_unit?: boolean): string | undefined;
 export declare function is_state(hass: HomeAssistant, entity_id: string, value: string | string[]): boolean;
 export declare function state_attr(hass: HomeAssistant, entity_id: string, attribute: string): any;
 export declare function is_state_attr(hass: HomeAssistant, entity_id: string, attribute: string, value: string | string[]): boolean;
 export declare function has_value(hass: HomeAssistant, entity_id: string): boolean;
+export declare function buildStatesObject(hass: HomeAssistant): Record<string, Record<string, HassEntity>>;
diff --git a/dist/utils/states.js b/dist/utils/states.js
@@ -6,7 +6,6 @@ export function states(hass, entity_id, rounded, with_unit) {
     try {
         const stateObj = hass.states[entity_id];
         let state = stateObj?.state;
-        // https://www.home-assistant.io/docs/configuration/templating/#formatting-sensor-states
         if (with_unit && rounded == undefined) {
             rounded = true;
         }
@@ -74,3 +73,12 @@ export function has_value(hass, entity_id) {
         return false;
     }
 }
+export function buildStatesObject(hass) {
+    const states = {};
+    for (const entityId in hass.states) {
+        const [domain, entity] = entityId.split('.');
+        states[domain] = states[domain] ?? {};
+        states[domain][entity] = hass.states[entityId];
+    }
+    return states;
+}
diff --git a/dist/utils/type.d.ts b/dist/utils/type.d.ts
@@ -0,0 +1,2 @@
+export declare function set(...args: string[]): Set<string>;
+export declare function list(...args: string[][]): FlatArray<string[], 0 | 1 | 2 | 16 | 4 | 3 | -1 | 6 | 5 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 17 | 18 | 19 | 20>[];
diff --git a/dist/utils/type.js b/dist/utils/type.js
@@ -0,0 +1,7 @@
+// TODO - validate and possibly add https://www.home-assistant.io/docs/configuration/templating/#complex-type-checking
+export function set(...args) {
+    return new Set(args.flat(Infinity));
+}
+export function list(...args) {
+    return args.map((arg) => Array.from(arg)).flat(Infinity);
+}
diff --git a/src/globals.ts b/src/globals.ts
@@ -48,7 +48,6 @@ import {
 	tan,
 	tau,
 } from './utils/numeric';
-import { list, set } from './utils/set';
 import {
 	attr_name_translated,
 	attr_value_translated,
@@ -74,6 +73,7 @@ import {
 	today_at,
 	utcnow,
 } from './utils/time';
+import { list, set } from './utils/type';
 import { zip } from './utils/zip';
 
 import { Environment, Template } from 'nunjucks';
@@ -149,6 +149,7 @@ const HASS_GLOBALS: Record<string, CallableFunction> = {
 	label_areas,
 	label_devices,
 	label_entities,
+
 	// Immediate If
 	iif,
 
@@ -198,7 +199,7 @@ const GLOBALS: Record<string, CallableFunction> = {
 	// Iterating Multiple Objects
 	zip,
 
-	// Other
+	// Miscellaneous
 	match_media,
 	str,
 };

diff --git a/src/index.ts b/src/index.ts
@@ -4,6 +4,7 @@ import nunjucks from 'nunjucks';
 import { addFilters } from './filters';
 import { addGlobals } from './globals';
 import { addTests } from './tests';
+import { buildStatesObject } from './utils/states';
 
 nunjucks.installJinjaCompat();
 const env = addTests(addFilters(addGlobals(new nunjucks.Environment())));
@@ -28,6 +29,7 @@ export function renderTemplate(
 		str = env
 			.renderString(structuredClone(str), {
 				hass,
+				_states: buildStatesObject(hass),
 				...context,
 			})
 			.trim();

diff --git a/src/tests.ts b/src/tests.ts
@@ -1,4 +1,9 @@
 import { Environment, Template } from 'nunjucks';
+import { contains } from './utils/contains';
+import { is_device_attr } from './utils/devices';
+import { is_hidden_entity } from './utils/entities';
+import { match, search } from './utils/regexp';
+import { has_value, is_state, is_state_attr } from './utils/states';
 
 export function addTests(env: Environment) {
 	for (const t in TESTS) {
@@ -28,8 +33,24 @@ export function addTests(env: Environment) {
 	return env;
 }
 
-// TODO add tests
+const HASS_TESTS: Record<string, CallableFunction> = {
+	// States
+	is_state,
+	is_state_attr,
+	has_value,
 
-const HASS_TESTS: Record<string, CallableFunction> = {};
+	// Entities
+	is_hidden_entity,
+
+	// Devices
+	is_device_attr,
+
+	// Contains
+	contains,
+
+	// Regular Expressions
+	match,
+	search,
+};
 
 const TESTS: Record<string, CallableFunction> = {};
diff --git a/src/utils/distance.ts b/src/utils/distance.ts
@@ -105,14 +105,21 @@ function vincenty(
 	return s;
 }
 
-export function distance(hass: HomeAssistant, ...args: (string | number)[]) {
+export function distance(
+	hass: HomeAssistant,
+	...args: (string | HassEntity | number)[]
+) {
 	try {
 		let lat1, lat2, lon1, lon2: number;
 		let i: number = 0;
 		if (typeof args[0] == 'string') {
 			lat1 = hass.states[args[0]].attributes.latitude;
 			lon1 = hass.states[args[0]].attributes.longitude;
 			i = 1;
+		} else if (typeof args[0] == 'object' && !Array.isArray(args[0])) {
+			lat1 = (args[0] as HassEntity).attributes.latitude;
+			lon1 = (args[0] as HassEntity).attributes.longitude;
+			i = 1;
 		} else if (typeof args[0] == 'number') {
 			if (!(typeof args[1] == 'number')) {
 				throw Error('Latitude provided but not longitude 1');
@@ -124,8 +131,11 @@ export function distance(hass: HomeAssistant, ...args: (string | number)[]) {
 			return null;
 		}
 		if (typeof args[i] == 'string') {
-			lat2 = hass.states[args[i]].attributes.latitude;
-			lon2 = hass.states[args[i]].attributes.longitude;
+			lat2 = hass.states[args[i] as string].attributes.latitude;
+			lon2 = hass.states[args[i] as string].attributes.longitude;
+		} else if (typeof args[0] == 'object' && !Array.isArray(args[0])) {
+			lat2 = (args[i] as HassEntity).attributes.latitude;
+			lon2 = (args[i] as HassEntity).attributes.longitude;
 		} else if (typeof args[i] == 'number') {
 			if (!(typeof args[i + 1] == 'number')) {
 				throw Error('Latitude provided but not longitude 2');
@@ -188,10 +198,10 @@ export function closest(
 		home = [args[0], args[1]];
 		start = 2;
 	} else if (typeof args[0] == 'object') {
-		if (Array.isArray(args[0])) {
+		if (Array.isArray(args[0]) || !(args[0] as HassEntity).attributes) {
 			return null;
 		}
-		// Assume is stateobj
+		// Is state object
 		home = [
 			(args[0] as HassEntity).attributes.latitude,
 			(args[0] as HassEntity).attributes.longitude,
@@ -222,7 +232,29 @@ export function closest(
 					entityIds.push(args[i] as string);
 				}
 			} else {
-				entityIds0 = Object.keys(args[i]);
+				const entities = Object.keys(args[i]);
+				if ((args[i] as HassEntities)[entities[0]].entity_id) {
+					entityIds0 = entities.map(
+						(key) => (args[i] as HassEntities)[key].entity_id,
+					);
+				} else {
+					for (const domain of entities) {
+						entityIds0.push(
+							...Object.keys(
+								(args[i] as HassEntities)[
+									domain
+								] as unknown as HassEntities,
+							).map(
+								(key) =>
+									(
+										(args[i] as HassEntities)[
+											domain
+										] as unknown as HassEntities
+									)[key].entity_id,
+							),
+						);
+					}
+				}
 			}
 			for (const entity of entityIds0) {
 				entityIds.push(...getEntityIdsByString(entity));