ha-nunjucks 1.3.0 → 1.5.0

package/README.md

@@ -7,13 +7,13 @@
 
 [![Github][github]][github]
 
-A wrapper for [nunjucks](https://www.npmjs.com/package/nunjucks) for use with Home Assistant frontend custom components to render [templates](https://www.home-assistant.io/docs/configuration/templating/) instanteneously at HTML render time. This repository offers an easy way for developers to add templating support to Home Assistant custom cards.
+A wrapper for [nunjucks](https://www.npmjs.com/package/nunjucks) for use with Home Assistant frontend custom components to render [templates](https://www.home-assistant.io/docs/configuration/templating/) instanteneously at HTML render time. This repository offers a fast and easy way for developers to add templating support to Home Assistant custom cards.
 
 ## What is nunjucks?
 
 [Nunjucks](https://mozilla.github.io/nunjucks/) is a templating engine for JavaScript that is heavily inspired by jinja2. Home Assistant uses jinja2 to process templates in card configurations on the backend, so the syntax of jinja2 and Nunjucks is virtually the same. This makes it an excellent alternative to Home Assistant core jinja2 templating for custom cards.
 
-While some Home Assistant native cards support templating for certain fields, implementing proper Home Assistant jinja2 template support in custom cards can be difficult. Additionally Home Assistant jinja2 templates are processed by the Python backend, and can take several seconds to render. Nunjucks templates are processed by the frontend using the frontend [`hass`](https://developers.home-assistant.io/docs/frontend/data/) object before your custom card's HTML is rendered, making nunjucks templating synchronous, instanteous. and much faster than traditional jinja2 templates.
+While some Home Assistant native cards support templating for certain fields, implementing proper Home Assistant jinja2 template support in custom cards can be difficult. Additionally Home Assistant jinja2 templates are processed by the Python backend, and use subscriptions which must be managed and do not play as well with dynamic custom variables. Nunjucks templates are processed by the frontend using the frontend [`hass`](https://developers.home-assistant.io/docs/frontend/data/) object before your custom card's HTML is rendered, making nunjucks templating synchronous, near instanteous, and easier to use than traditional jinja2 templates.
 
 ## Usage
 
@@ -33,7 +33,7 @@ const renderedString = renderTemplate(this.hass, templateString);
 
 That's it! The result of `renderTemplate` is the rendered template for you to use. In unit and integration testing render time is under 1 ms and shouldn't cause any latency in your projects.
 
-Rather than rendering templates on the backend, nunjucks renders templates on the frontend. This repository uses the Home Assistant object present in all custom cards to read entity state data.
+Rather than rendering templates on the backend, nunjucks renders templates on the frontend. This repository uses the Home Assistant object present in all custom cards to read entity state data. A single shared Nunjucks environment is used for the frontend across all custom element instances that use Nunjucks, which helps with initial load times.
 
 You can also provide context to the `renderTemplate` function to pass to nunjucks if you want to make additional variables or project specific functions available to your users for use in templates.
 
@@ -54,6 +54,34 @@ const context = {
 const renderedString = renderTemplate(this.hass, templateString, context);
 ```
 
+`renderTemplate` will try to validate that inputs contain valid templates by default using the exported function `hasTemplate`. You can disable this by setting the fourth argument of `renderTemplate` to `false`. This way you can perform this check yourself before any additional templating setup you perform in your code.
+
+```typescript
+import { hasTemplate, renderTemplate } from 'ha-nunjucks';
+
+if (!hasTemplate(templateString)) {
+  return templateString;
+}
+
+const context = {
+  foo: 'bar',
+  doThing(thing: string) {
+    return `doing ${thing}!`;
+  },
+  config: {
+    entity: 'foo.bar',
+    attribute: 'baz_bah',
+  },
+};
+
+const renderedString = renderTemplate(
+  this.hass,
+  templateString,
+  context,
+  false,
+);
+```
+
 ### Return Types
 
 `renderTemplate` will return a string unless the result is `true` or `false` (_not_ case sensitive), in which case it will return a boolean.
@@ -115,6 +143,10 @@ Functions used to determine an entity's state or an attribute.
 | state_translated      | function, filter | entity_id, state (optional)                 | Returns the formatted and translated state of an entity or provided state using a language that is currently configured in the general settings.                     |
 | attr_name_translated  | function, filter | entity_id, attr_name                        | Returns the formatted and translated attribute name of an entity using a language that is currently configured in the general settings.                              |
 | attr_value_translated | function, filter | entity_id, attr_name, attr_value (optional) | Returns the formatted and translated attribute value of an entity or provided attribute value using a language that is currently configured in the general settings. |
+| number_translated     | function, filter | value                                       | Returns the formatted and translated input number using a language that is currently configured in the general settings.                                             |
+| date_translated       | function, filter | value                                       | Returns the formatted and translated input date or datetime as a date using a language that is currently configured in the general settings.                         |
+| time_translated       | function, filter | value                                       | Returns the formatted and translated input time or datetime as a time using a language that is currently configured in the general settings.                         |
+| datetime_translated   | function, filter | value                                       | Returns the formatted and translated input datetime using a language that is currently configured in the general settings.                                           |
 
 ### [Groups](https://www.home-assistant.io/docs/configuration/templating/#working-with-groups)
 
@@ -164,7 +196,7 @@ Functions used to determine an entity's state or an attribute.
 
 ### [Labels](https://www.home-assistant.io/docs/configuration/templating/#labels)
 
-**NOTE**: Labels are not available in the `hass` object and must be retrieved asynchronously from the Home Assistant backend the first time `renderTemplate` is called. Since this package is otherwise synchronous, this can cause a race condition where no labels are found the first time `renderTemplate` is run. This generally resolves itself once the template re-renders.
+**NOTE**: Labels are not available in the `hass` object and must be retrieved asynchronously from the Home Assistant backend the first time `ha-nunjucks` is imported. Since this package is otherwise synchronous, this can cause a race condition where no labels are found the first time `renderTemplate` is run. This generally resolves itself once the template re-renders.
 
 | Name           | Type             | Arguments               | Description                                                                                |
 | -------------- | ---------------- | ----------------------- | ------------------------------------------------------------------------------------------ |
@@ -223,10 +255,10 @@ In addition to these functions, you have access to [a datetime library](https://
 
 ### [To/From JSON](https://www.home-assistant.io/docs/configuration/templating/#tofrom-json)
 
-| Name      | Type   | Arguments                                  | Description                                                                                                                                                                                                                                                                               |
-| --------- | ------ | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| to_json   | filter | obj, ensure_ascii, pretty_print, sort_keys | Turn an object into a JSON string. `ensure_ascii` converts unicode characters into escape sequences. `pretty_print` formats the output with new lines and an indent of two spaces. `sort_keys` sorts the keys of the JSON object. **Consider using the nunjucks `safe` filter with this** |
-| from_json | filter | value                                      | Parse a string as JSON.                                                                                                                                                                                                                                                                   |
+| Name      | Type   | Arguments                                  | Description                                                                                                                                                                                                                                                                                                                       |
+| --------- | ------ | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| to_json   | filter | obj, ensure_ascii, pretty_print, sort_keys | Turn an object into a JSON string. `ensure_ascii` converts unicode characters into escape sequences. `pretty_print` formats the output with new lines and an indent of two spaces. `sort_keys` sorts the keys of the JSON object. **Consider using the nunjucks `safe` filter with this, or the nunjucks `dump` filter instead.** |
+| from_json | filter | value                                      | Parse a string as JSON.                                                                                                                                                                                                                                                                                                           |
 
 ### [Distance](https://www.home-assistant.io/docs/configuration/templating/#distance)
 
@@ -306,7 +338,7 @@ In addition to these functions, you have access to [a datetime library](https://
 | ------------------- | ------ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
 | match               | test   | value, find                                    | Matches the find string at the beginning of the value string using regex.                                                            |
 | search              | test   | value, find                                    | Matches the find string anywhere in the value string using regex.                                                                    |
-| test                | test   | value, find                                    | Matches the find regular expression in the value string usign regex. Regular expressions should be preceded by r, like `r/foobar/g`. |
+| test                | test   | value, find                                    | Matches the find regular expression in the value string using regex. Regular expressions should be preceded by r, like `r/foobar/g`. |
 | regex_replace       | filter | value, find (default ''), replace (default '') | Replaces the find expression with the replace expression string using RegEx.                                                         |
 | regex_findall       | filter | value, find (default '')                       | Finds all RegEx matches of the find expression in value and returns an array of matches.                                             |
 | regex_findall_index | filter | value, find (default ''), index (default 0)    | Performs a RegEx find all but returns the match at a provided index.                                                                 |
@@ -315,10 +347,10 @@ In addition to these functions, you have access to [a datetime library](https://
 
 Functions that are not from the Home Assistant templating documentation.
 
-| Name        | Arguments     | Description                                                                                                                                           |
-| ----------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| match_media | mediaquery    | Returns the boolean result of the provided [CSS media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries). |
-| str         | value, filter | Return the string representation of the input.                                                                                                        |
+| Name        | Type             | Arguments | Description                                                                                                                                           |
+| ----------- | ---------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| match_media | function         | value     | Returns the boolean result of the provided [CSS media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries). |
+| str         | function, filter | value     | Return the string representation of the input.                                                                                                        |
 
 [last-commit-shield]: https://img.shields.io/github/last-commit/Nerwyn/ha-nunjucks?style=for-the-badge
 [commits]: https://github.com/Nerwyn/ha-nunjucks/commits/main

package/dist/filters.js

@@ -1,4 +1,3 @@
-import { HASS } from '.';
 import { area_devices, area_entities, area_id, area_name } from './utils/areas';
 import { contains } from './utils/contains';
 import { device_attr, device_entities, device_id } from './utils/devices';
@@ -11,7 +10,7 @@ import { label_areas, label_devices, label_entities, label_id, label_name, label
 import { str } from './utils/miscellaneous';
 import { acos, add, asin, atan, atan2, average, bitwise_and, bitwise_not, bitwise_or, bitwise_xor, bool, cos, is_number, log, max, median, min, multiply, ord, sin, sqrt, statistical_mode, tan, } from './utils/numeric';
 import { regex_findall, regex_findall_index, regex_replace, } from './utils/regexp';
-import { attr_name_translated, attr_value_translated, state_translated, } from './utils/state_translated';
+import { attr_name_translated, attr_value_translated, date_translated, datetime_translated, number_translated, state_translated, time_translated, } from './utils/state_translated';
 import { has_value, state_attr, states } from './utils/states';
 import { as_datetime, as_local, as_timestamp, time_since, time_until, timestamp_custom, timestamp_local, timestamp_utc, today_at, } from './utils/time';
 export function addFilters(env) {
@@ -22,7 +21,7 @@ export function addFilters(env) {
     }
     for (const func in HASS_FILTERS) {
         env.addFilter(func, function (...args) {
-            return HASS_FILTERS[func](HASS, ...args);
+            return HASS_FILTERS[func](window.haNunjucks.hass, ...args);
         });
     }
     return env;
@@ -75,6 +74,9 @@ const FILTERS = {
     timestamp_local,
     timestamp_utc,
     timestamp_custom,
+    date_translated,
+    time_translated,
+    datetime_translated,
     // To/From JSON
     to_json,
     from_json,
@@ -108,6 +110,7 @@ const FILTERS = {
     ord,
     multiply,
     add,
+    number_translated,
     // Regular Expressions
     regex_replace,
     regex_findall,

package/dist/globals.js

@@ -1,4 +1,3 @@
-import { HASS } from '.';
 import { area_devices, area_entities, area_id, area_name, areas, } from './utils/areas';
 import { device_attr, device_entities, device_id, is_device_attr, } from './utils/devices';
 import { closest, distance } from './utils/distance';
@@ -10,7 +9,7 @@ import { integration_entities } from './utils/integrations';
 import { label_areas, label_devices, label_entities, label_id, label_name, 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 { attr_name_translated, attr_value_translated, state_translated, } from './utils/state_translated';
+import { attr_name_translated, attr_value_translated, date_translated, datetime_translated, number_translated, state_translated, time_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, today_at, utcnow, } from './utils/time';
 import { list, set } from './utils/type_conversions';
@@ -24,7 +23,7 @@ export function addGlobals(env) {
     }
     for (const func in HASS_GLOBALS) {
         env.addGlobal(func, function (...args) {
-            return HASS_GLOBALS[func](HASS, ...args);
+            return HASS_GLOBALS[func](window.haNunjucks.hass, ...args);
         });
     }
     for (const c in CONST_GLOBALS) {
@@ -96,6 +95,9 @@ const GLOBALS = {
     time_since,
     time_until,
     as_timedelta,
+    date_translated,
+    time_translated,
+    datetime_translated,
     // Numeric,
     float,
     is_number,
@@ -115,6 +117,7 @@ const GLOBALS = {
     average,
     median,
     statistical_mode,
+    number_translated,
     // Type Conversions
     set,
     list,

package/dist/index.d.ts

@@ -1,10 +1,16 @@
-import { HomeAssistant } from './models/hass';
-export declare let HASS: HomeAssistant;
+import { HomeAssistant } from './models/interfaces/hass';
 /**
  * Render a Home Assistant template string using nunjucks
  * @param {HomeAssistant} hass The Home Assistant object
  * @param {string} str The template string to render
  * @param {object} [context] Additional context to expose to nunjucks
+ * @param {boolean} [validate=true] Validate that the input contains a template.
  * @returns {string | boolean} The rendered template string if a string was provided, otherwise the unaltered input
  */
-export declare function renderTemplate(hass: HomeAssistant, str: string, context?: object): string | boolean;
+export declare function renderTemplate(hass: HomeAssistant, str: string, context?: object, validate?: boolean): string | boolean;
+/**
+ * Test if the input contains a valid template
+ * @param {any} str the variable to check
+ * @returns if the input is a string that contains a template
+ */
+export declare function hasTemplate(str: any): boolean;

package/dist/index.js

@@ -4,41 +4,73 @@ import { addGlobals } from './globals';
 import { addTests } from './tests';
 import { fetchLabelRegistry } from './utils/labels';
 import { buildStatesObject } from './utils/states';
-export let HASS;
-nunjucks.installJinjaCompat();
-const env = addTests(addFilters(addGlobals(new nunjucks.Environment())));
+if (!window.haNunjucks) {
+    window.haNunjucks = {
+        states: {},
+        labelRegistry: {},
+    };
+    // Async setup label registry and states object on import
+    const registrySetup = async () => {
+        const ha = document.querySelector('home-assistant');
+        if (!ha ||
+            !ha.hass ||
+            !ha.hass.connected ||
+            !ha.hass.connection ||
+            !ha.hass.connection.connected) {
+            setTimeout(registrySetup, 10);
+            return;
+        }
+        // Number and datetime translators
+        window.haNunjucks.numberFormat = new Intl.NumberFormat(ha.hass.language);
+        window.haNunjucks.dateFormat = new Intl.DateTimeFormat(ha.hass.language, { dateStyle: 'full' });
+        window.haNunjucks.timeFormat = new Intl.DateTimeFormat(ha.hass.language, { timeStyle: 'long' });
+        window.haNunjucks.datetimeFormat = new Intl.DateTimeFormat(ha.hass.language, { dateStyle: 'full', timeStyle: 'long' });
+        // Label registry and states object
+        window.haNunjucks.hass = ha.hass;
+        fetchLabelRegistry();
+        buildStatesObject();
+    };
+    registrySetup();
+    // Initialize global ha-nunjucks environment
+    nunjucks.installJinjaCompat();
+    window.haNunjucks.env = addTests(addFilters(addGlobals(new nunjucks.Environment())));
+}
 /**
  * Render a Home Assistant template string using nunjucks
  * @param {HomeAssistant} hass The Home Assistant object
  * @param {string} str The template string to render
  * @param {object} [context] Additional context to expose to nunjucks
+ * @param {boolean} [validate=true] Validate that the input contains a template.
  * @returns {string | boolean} The rendered template string if a string was provided, otherwise the unaltered input
  */
-export function renderTemplate(hass, str, context) {
-    if (!HASS) {
-        fetchLabelRegistry(hass);
-    }
-    HASS = hass;
-    if (typeof str == 'string' &&
-        ((str.includes('{{') && str.includes('}}')) ||
-            (str.includes('{%') && str.includes('%}')))) {
-        str = env
-            .renderString(structuredClone(str), {
-            hass,
-            _states: buildStatesObject(hass),
-            ...context,
-        })
-            .trim();
-        if ([undefined, null, 'undefined', 'null', 'None'].includes(str)) {
-            return '';
-        }
-        if (str.toLowerCase() == 'true') {
-            return true;
-        }
-        if (str.toLowerCase() == 'false') {
-            return false;
-        }
+export function renderTemplate(hass, str, context, validate = true) {
+    if (validate && !hasTemplate(str)) {
         return str;
     }
+    window.haNunjucks.hass = hass;
+    buildStatesObject();
+    str = window.haNunjucks.env
+        .renderString(structuredClone(str), {
+        hass,
+        _states: window.haNunjucks.states,
+        ...context,
+    })
+        .trim();
+    if ([undefined, null, 'undefined', 'null', 'None'].includes(str)) {
+        return '';
+    }
+    const lowerStr = str.toLowerCase();
+    if (['true', 'false'].includes(lowerStr)) {
+        return lowerStr == 'true';
+    }
     return str;
 }
+const hasTemplateRegex = /{{.*?}}|{%.*?%}/;
+/**
+ * Test if the input contains a valid template
+ * @param {any} str the variable to check
+ * @returns if the input is a string that contains a template
+ */
+export function hasTemplate(str) {
+    return hasTemplateRegex.test(str);
+}

package/dist/models/interfaces/hass.d.ts

@@ -0,0 +1,42 @@
+import { Auth, Connection, HassConfig, HassEntities, HassEntity, HassServices, MessageBase } from 'home-assistant-js-websocket';
+import { AreaRegistryEntry, DeviceRegistryEntry, EntityRegistryDisplayEntry, FloorRegistryEntry } from './registries';
+export interface HomeAssistant {
+    auth: Auth;
+    connection: Connection;
+    connected: boolean;
+    states: HassEntities;
+    entities: {
+        [id: string]: EntityRegistryDisplayEntry;
+    };
+    devices: {
+        [id: string]: DeviceRegistryEntry;
+    };
+    areas: {
+        [id: string]: AreaRegistryEntry;
+    };
+    floors: {
+        [id: string]: FloorRegistryEntry;
+    };
+    services: HassServices;
+    config: HassConfig;
+    panelUrl: string;
+    language: string;
+    selectedLanguage: string | null;
+    suspendWhenHidden: boolean;
+    enableShortcuts: boolean;
+    vibrate: boolean;
+    debugConnection: boolean;
+    dockedSidebar: 'docked' | 'always_hidden' | 'auto';
+    defaultPanel: string;
+    moreInfoEntityId: string | null;
+    callApi<T>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, parameters?: Record<string, any>, headers?: Record<string, string>): Promise<T>;
+    fetchWithAuth(path: string, init?: Record<string, any>): Promise<Response>;
+    sendWS(msg: MessageBase): void;
+    callWS<T>(msg: MessageBase): Promise<T>;
+    formatEntityState(stateObj: HassEntity, state?: string): string;
+    formatEntityAttributeValue(stateObj: HassEntity, attribute: string, value?: any): string;
+    formatEntityAttributeName(stateObj: HassEntity, attribute: string): string;
+}
+export interface HassElement extends HTMLElement {
+    hass: HomeAssistant;
+}

package/dist/models/interfaces/hass.js

@@ -0,0 +1 @@
+export {};

package/dist/models/interfaces/registries.d.ts

@@ -0,0 +1,63 @@
+interface RegistryEntry {
+    created_at: number;
+    modified_at: number;
+}
+export interface AreaRegistryEntry extends RegistryEntry {
+    area_id: string;
+    floor_id: string | null;
+    name: string;
+    picture: string | null;
+    icon: string | null;
+    labels: string[];
+    aliases: string[];
+}
+export interface DeviceRegistryEntry extends RegistryEntry {
+    id: string;
+    config_entries: string[];
+    connections: Array<[string, string]>;
+    identifiers: Array<[string, string]>;
+    manufacturer: string | null;
+    model: string | null;
+    model_id: string | null;
+    name: string | null;
+    labels: string[];
+    sw_version: string | null;
+    hw_version: string | null;
+    serial_number: string | null;
+    via_device_id: string | null;
+    area_id: string | null;
+    name_by_user: string | null;
+    entry_type: 'service' | null;
+    disabled_by: 'user' | 'integration' | 'config_entry' | null;
+    configuration_url: string | null;
+    primary_config_entry: string | null;
+}
+type EntityCategory = 'config' | 'diagnostic';
+export interface EntityRegistryDisplayEntry {
+    entity_id: string;
+    name?: string;
+    icon?: string;
+    device_id?: string;
+    area_id?: string;
+    labels: string[];
+    hidden?: boolean;
+    entity_category?: EntityCategory;
+    translation_key?: string;
+    platform?: string;
+    display_precision?: number;
+}
+export interface FloorRegistryEntry extends RegistryEntry {
+    aliases: string[];
+    floor_id: string;
+    name: string;
+    level?: number;
+    icon?: string;
+}
+export interface LabelRegistryEntry extends RegistryEntry {
+    label_id: string;
+    name: string;
+    icon?: string;
+    color?: string;
+    description?: string;
+}
+export {};

package/dist/models/interfaces/registries.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/areas.d.ts

@@ -1,4 +1,4 @@
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function areas(hass: HomeAssistant): string[];
 export declare function area_id(hass: HomeAssistant, lookup_value: string): string | null | undefined;
 export declare function area_name(hass: HomeAssistant, lookup_value: string): string | undefined;

package/dist/utils/devices.d.ts

@@ -1,5 +1,5 @@
-import { HomeAssistant } from '../models/hass';
-import { DeviceRegistryEntry } from '../models/registries';
+import { HomeAssistant } from '../models/interfaces/hass';
+import { DeviceRegistryEntry } from '../models/interfaces/registries';
 export declare function device_entities(hass: HomeAssistant, device_id: string): string[];
 export declare function device_attr(hass: HomeAssistant, device_or_entity_id: string, attr_name: keyof DeviceRegistryEntry): any;
 export declare function is_device_attr(hass: HomeAssistant, device_or_entity_id: string, attr_name: keyof DeviceRegistryEntry, attr_value: string): boolean;

package/dist/utils/distance.d.ts

@@ -1,4 +1,4 @@
 import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 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;

package/dist/utils/entities.d.ts

@@ -1,2 +1,2 @@
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function is_hidden_entity(hass: HomeAssistant, entity_id: string): boolean;

package/dist/utils/floors.d.ts

@@ -1,4 +1,4 @@
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function floors(hass: HomeAssistant): string[];
 export declare function floor_id(hass: HomeAssistant, lookup_value: string): string | null | undefined;
 export declare function floor_name(hass: HomeAssistant, lookup_value: string): string | undefined;

package/dist/utils/groups.d.ts

@@ -1,3 +1,3 @@
 import { HassEntities, HassEntity } from 'home-assistant-js-websocket';
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function expand(hass: HomeAssistant, ...args: (string | HassEntity | HassEntities)[]): HassEntity[];

package/dist/utils/iif.d.ts

@@ -1,2 +1,2 @@
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function iif(hass: HomeAssistant, condition: string, if_true?: string | Record<string, string>, if_false?: string, if_none?: string): string | boolean;

package/dist/utils/integrations.d.ts

@@ -1,2 +1,2 @@
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function integration_entities(hass: HomeAssistant, integration: string): string[];

package/dist/utils/labels.d.ts

@@ -1,5 +1,5 @@
-import { HomeAssistant } from '../models/hass';
-export declare function fetchLabelRegistry(hass: HomeAssistant): Promise<void>;
+import { HomeAssistant } from '../models/interfaces/hass';
+export declare function fetchLabelRegistry(): Promise<void>;
 export declare function labels(hass: HomeAssistant, lookup_value?: string): string[];
 export declare function label_id(lookup_value: string): string | undefined;
 export declare function label_name(lookup_value: string): string;

package/dist/utils/labels.js

@@ -1,19 +1,16 @@
-const labelRegistry = {};
-export async function fetchLabelRegistry(hass) {
-    if (hass.connection) {
-        const labels = await hass.connection.sendMessagePromise({
-            type: 'config/label_registry/list',
-        });
-        labels.sort((ent1, ent2) => ent1.name.localeCompare(ent2.name));
-        for (const label of labels) {
-            labelRegistry[label.label_id] = label;
-        }
+export async function fetchLabelRegistry() {
+    const labels = await window.haNunjucks.hass.connection.sendMessagePromise({
+        type: 'config/label_registry/list',
+    });
+    labels.sort((ent1, ent2) => ent1.name.localeCompare(ent2.name));
+    for (const label of labels) {
+        window.haNunjucks.labelRegistry[label.label_id] = label;
     }
 }
 export function labels(hass, lookup_value) {
     try {
         if (!lookup_value) {
-            return Object.keys(labelRegistry);
+            return Object.keys(window.haNunjucks.labelRegistry);
         }
         return (hass.entities[lookup_value]?.labels ??
             hass.devices[lookup_value]?.labels ??
@@ -25,22 +22,22 @@ export function labels(hass, lookup_value) {
     }
 }
 export function label_id(lookup_value) {
-    for (const id in labelRegistry) {
-        if (labelRegistry[id].name == lookup_value) {
+    for (const id in window.haNunjucks.labelRegistry) {
+        if (window.haNunjucks.labelRegistry[id].name == lookup_value) {
             return id;
         }
     }
     return undefined;
 }
 export function label_name(lookup_value) {
-    return labelRegistry[lookup_value]?.name;
+    return window.haNunjucks.labelRegistry[lookup_value]?.name;
 }
 export function label_areas(hass, label_name_or_id) {
     try {
         const areaIds = [];
         let labelId = undefined;
         if (label_name_or_id) {
-            if (labelRegistry[label_name_or_id]) {
+            if (window.haNunjucks.labelRegistry[label_name_or_id]) {
                 labelId = label_name_or_id;
             }
             else {
@@ -67,7 +64,7 @@ export function label_devices(hass, label_name_or_id) {
         const deviceIds = [];
         if (label_name_or_id) {
             let labelId = undefined;
-            if (labelRegistry[label_name_or_id]) {
+            if (window.haNunjucks.labelRegistry[label_name_or_id]) {
                 labelId = label_name_or_id;
             }
             else {
@@ -94,7 +91,7 @@ export function label_entities(hass, label_name_or_id) {
         const entityIds = [];
         if (label_name_or_id) {
             let labelId = undefined;
-            if (labelRegistry[label_name_or_id]) {
+            if (window.haNunjucks.labelRegistry[label_name_or_id]) {
                 labelId = label_name_or_id;
             }
             else {

package/dist/utils/state_translated.d.ts

@@ -1,4 +1,9 @@
-import { HomeAssistant } from '../models/hass';
+import { date, datetime, time } from 'ts-py-datetime';
+import { HomeAssistant } from '../models/interfaces/hass';
 export declare function state_translated(hass: HomeAssistant, entity_id: string, state?: string): string;
 export declare function attr_name_translated(hass: HomeAssistant, entity_id: string, attr_name: string): string;
 export declare function attr_value_translated(hass: HomeAssistant, entity_id: string, attr_name: string, attr_value?: string): any;
+export declare function number_translated(value: number): string | number;
+export declare function date_translated(value: date | datetime): string | date | datetime;
+export declare function time_translated(value: time | datetime): string | datetime | time;
+export declare function datetime_translated(value: datetime): string | datetime;

package/dist/utils/state_translated.js

@@ -26,3 +26,33 @@ export function attr_value_translated(hass, entity_id, attr_name, attr_value) {
             undefined);
     }
 }
+export function number_translated(value) {
+    if (isNaN(value)) {
+        return value;
+    }
+    return window.haNunjucks.numberFormat.format(value);
+}
+export function date_translated(value) {
+    try {
+        return window.haNunjucks.dateFormat.format(value.jsDate);
+    }
+    catch {
+        return value;
+    }
+}
+export function time_translated(value) {
+    try {
+        return window.haNunjucks.timeFormat.format(value.jsDate);
+    }
+    catch {
+        return value;
+    }
+}
+export function datetime_translated(value) {
+    try {
+        return window.haNunjucks.datetimeFormat.format(value.jsDate);
+    }
+    catch {
+        return value;
+    }
+}

package/dist/utils/states.d.ts

@@ -1,8 +1,7 @@
-import { HassEntity } from 'home-assistant-js-websocket';
-import { HomeAssistant } from '../models/hass';
+import { HomeAssistant } from '../models/interfaces/hass';
+export declare function buildStatesObject(): void;
 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): boolean;
 export declare function has_value(hass: HomeAssistant, entity_id: string): boolean;
-export declare function buildStatesObject(hass: HomeAssistant): Record<string, Record<string, HassEntity>>;

package/dist/utils/states.js

@@ -1,3 +1,11 @@
+export function buildStatesObject() {
+    for (const entityId in window.haNunjucks.hass.states) {
+        const [domain, id] = entityId.split('.');
+        window.haNunjucks.states[domain] ??= {};
+        window.haNunjucks.states[domain][id] =
+            window.haNunjucks.hass.states[entityId];
+    }
+}
 export function states(hass, entity_id, rounded, with_unit) {
     if (typeof rounded == 'object' && !Array.isArray(rounded)) {
         with_unit = rounded.with_unit ?? with_unit;
@@ -64,12 +72,3 @@ 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;
-}

package/dist/utils/type_checking.d.ts

@@ -2,4 +2,4 @@ import { datetime } from 'ts-py-datetime';
 export declare function list(value: object[]): boolean;
 export declare function set(value: object[]): value is object[] & Set<any>;
 export declare function is_datetime(value: object): value is datetime;
-export declare function string_like(value: object): value is Buffer | Uint8Array | Uint16Array | Uint32Array | ArrayBuffer;
+export declare function string_like(value: object): value is ArrayBuffer | Buffer<ArrayBuffer> | Buffer<any> | Uint8Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ha-nunjucks",
-	"version": "1.3.0",
+	"version": "1.5.0",
 	"description": "Wrapper for nunjucks for use with Home Assistant frontend custom components to render templates",
 	"main": "./dist/index.js",
 	"files": [
@@ -8,7 +8,7 @@
 	],
 	"type": "module",
 	"scripts": {
-		"test": "ts-mocha 'tests/**/*.test.ts'",
+		"test": "ts-mocha tests/**/*.test.ts --require fixtures.cjs",
 		"build": "tsc",
 		"prelint": "tsc --noemit",
 		"lint": "eslint --config ./.eslintrc.config.cjs"
@@ -39,12 +39,14 @@
 		"eslint": "latest",
 		"eslint-config-prettier": "latest",
 		"eslint-plugin-prettier": "latest",
+		"jsdom-global": "latest",
 		"lint-staged": "latest",
+		"mocha": "latest",
 		"prettier": "latest",
 		"prettier-plugin-organize-imports": "latest",
 		"ts-loader": "latest",
 		"ts-mocha": "latest",
-		"ts-node": "latest",
+		"ts-node": "^10.9.2",
 		"tsx": "latest",
 		"typescript": "latest"
 	}