ha-nunjucks 1.7.3 → 1.7.5

package/dist/filters.js

@@ -45,6 +45,9 @@ const HASS_FILTERS = {
     state_translated,
     attr_name_translated,
     attr_value_translated,
+    number_translated,
+    date_translated,
+    datetime_translated,
     // Groups
     expand,
     // Devices
@@ -92,9 +95,7 @@ const FILTERS = {
     timestamp_local,
     timestamp_utc,
     timestamp_custom,
-    date_translated,
     time_translated,
-    datetime_translated,
     // To/From JSON
     to_json,
     from_json,
@@ -136,7 +137,6 @@ const FILTERS = {
     ord,
     multiply,
     add,
-    number_translated,
     // Type conversions
     str,
     // Functions and Filters to Process Raw Data

package/dist/globals.js

@@ -58,6 +58,9 @@ const HASS_GLOBALS = {
     state_translated,
     attr_name_translated,
     attr_value_translated,
+    number_translated,
+    date_translated,
+    datetime_translated,
     // Groups
     expand,
     // Entities
@@ -116,9 +119,7 @@ const GLOBALS = {
     time_since,
     time_until,
     as_timedelta,
-    date_translated,
     time_translated,
-    datetime_translated,
     // Version
     version,
     // Numeric,
@@ -144,7 +145,6 @@ const GLOBALS = {
     mod,
     wrap,
     remap,
-    number_translated,
     // Type Conversions
     set,
     list,

package/dist/index.js

@@ -4,10 +4,11 @@ import { addFilters } from './filters';
 import { addGlobals } from './globals';
 import { handleWhenReady } from './helpers';
 import { addTests } from './tests';
-import { fetchConfigEntries } from './utils/config_entry';
+import { subscribeConfigEntries } from './utils/config_entry';
 import { fetchEntityRegistry } from './utils/entities';
 import { fetchRepairsIssues } from './utils/issues';
 import { fetchLabelRegistry } from './utils/labels';
+import { getNumberFormatter, getTimeFormatter } from './utils/state_translated';
 import { buildStatesObject } from './utils/states';
 import { version } from './utils/version';
 window.haNunjucks ||= {};
@@ -29,33 +30,30 @@ if (version(packageInfo.version).compare(window.haNunjucks.version || '0.0.0') >
             ...window.haNunjucks,
             hass: ha.hass,
             labelRegistry: {
-                event: 'label_registry_updated',
+                updateEvent: 'label_registry_updated',
                 fetchRegistry: fetchLabelRegistry,
                 labelId: {},
                 name2LabelId: {},
             },
             entityRegistry: {
-                event: 'entity_registry_updated',
+                updateEvent: 'entity_registry_updated',
                 fetchRegistry: fetchEntityRegistry,
                 entityId2ConfigEntryId: {},
                 configEntryId2EntityIds: {},
             },
-            configEntries: {
-                event: 'config_entries/subscribe',
-                fetchRegistry: fetchConfigEntries,
-                entryId: {},
-                title2EntryId: {},
-            },
             repairsIssues: {
-                event: 'repairs/list_issues',
+                updateEvent: 'repairs_issue_registry_updated',
                 fetchRegistry: fetchRepairsIssues,
                 issues: {},
             },
+            configEntries: {
+                entryId: {},
+                title2EntryId: {},
+            },
         };
         const registries = [
             'labelRegistry',
             'entityRegistry',
-            'configEntries',
             'repairsIssues',
         ];
         for (const registry of registries) {
@@ -65,21 +63,20 @@ if (version(packageInfo.version).compare(window.haNunjucks.version || '0.0.0') >
                 window.haNunjucks[registry].timeout = setTimeout(() => {
                     window.haNunjucks[registry].fetchRegistry(ha.hass);
                 }, 500);
-            }, window.haNunjucks[registry].event);
+            }, window.haNunjucks[registry].updateEvent);
         }
+        subscribeConfigEntries(ha.hass);
         // States object
         buildStatesObject();
         // Number and datetime translators
-        window.haNunjucks.numberFormat = new Intl.NumberFormat(ha.hass.language);
+        window.haNunjucks.numberFormat = getNumberFormatter(ha.hass);
         window.haNunjucks.dateFormat = new Intl.DateTimeFormat(ha.hass.language, {
-            dateStyle: 'full',
-        });
-        window.haNunjucks.timeFormat = new Intl.DateTimeFormat(ha.hass.language, {
-            timeStyle: 'long',
+            dateStyle: 'long',
         });
-        window.haNunjucks.datetimeFormat = new Intl.DateTimeFormat(ha.hass.language, { dateStyle: 'full', timeStyle: 'long' });
+        window.haNunjucks.timeFormat = getTimeFormatter(ha.hass);
         window.haNunjucks.ordinalFormat = new Intl.PluralRules('en-US', // ha.hass.language, // Use english for proper numeric suffixes
         { type: 'ordinal' });
+        console.info(`%c HA-NUNJUCKS v${packageInfo.version}`, 'color: white; font-weight: bold; background: darkgreen');
     }, () => {
         const ha = document.querySelector('home-assistant');
         return ha?.hass?.connected && ha?.hass?.connection?.connected;

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

@@ -22,6 +22,7 @@ export interface HomeAssistant {
     panelUrl: string;
     language: string;
     selectedLanguage: string | null;
+    locale: FrontendLocaleData;
     suspendWhenHidden: boolean;
     enableShortcuts: boolean;
     vibrate: boolean;
@@ -40,3 +41,48 @@ export interface HomeAssistant {
 export interface HassElement extends HTMLElement {
     hass: HomeAssistant;
 }
+interface FrontendLocaleData {
+    language: string;
+    number_format: NumberFormat;
+    time_format: TimeFormat;
+    date_format: DateFormat;
+    first_weekday: FirstWeekday;
+    time_zone: TimeZone;
+}
+export declare enum NumberFormat {
+    language = "language",
+    system = "system",
+    comma_decimal = "comma_decimal",
+    decimal_comma = "decimal_comma",
+    quote_decimal = "quote_decimal",
+    space_comma = "space_comma",
+    none = "none"
+}
+export declare enum TimeFormat {
+    language = "language",
+    system = "system",
+    am_pm = "12",
+    twenty_four = "24"
+}
+export declare enum TimeZone {
+    local = "local",
+    server = "server"
+}
+export declare enum DateFormat {
+    language = "language",
+    system = "system",
+    DMY = "DMY",
+    MDY = "MDY",
+    YMD = "YMD"
+}
+export declare enum FirstWeekday {
+    language = "language",
+    monday = "monday",
+    tuesday = "tuesday",
+    wednesday = "wednesday",
+    thursday = "thursday",
+    friday = "friday",
+    saturday = "saturday",
+    sunday = "sunday"
+}
+export {};

package/dist/models/interfaces/hass.js

@@ -1 +1,41 @@
-export {};
+export var NumberFormat;
+(function (NumberFormat) {
+    NumberFormat["language"] = "language";
+    NumberFormat["system"] = "system";
+    NumberFormat["comma_decimal"] = "comma_decimal";
+    NumberFormat["decimal_comma"] = "decimal_comma";
+    NumberFormat["quote_decimal"] = "quote_decimal";
+    NumberFormat["space_comma"] = "space_comma";
+    NumberFormat["none"] = "none";
+})(NumberFormat || (NumberFormat = {}));
+export var TimeFormat;
+(function (TimeFormat) {
+    TimeFormat["language"] = "language";
+    TimeFormat["system"] = "system";
+    TimeFormat["am_pm"] = "12";
+    TimeFormat["twenty_four"] = "24";
+})(TimeFormat || (TimeFormat = {}));
+export var TimeZone;
+(function (TimeZone) {
+    TimeZone["local"] = "local";
+    TimeZone["server"] = "server";
+})(TimeZone || (TimeZone = {}));
+export var DateFormat;
+(function (DateFormat) {
+    DateFormat["language"] = "language";
+    DateFormat["system"] = "system";
+    DateFormat["DMY"] = "DMY";
+    DateFormat["MDY"] = "MDY";
+    DateFormat["YMD"] = "YMD";
+})(DateFormat || (DateFormat = {}));
+export var FirstWeekday;
+(function (FirstWeekday) {
+    FirstWeekday["language"] = "language";
+    FirstWeekday["monday"] = "monday";
+    FirstWeekday["tuesday"] = "tuesday";
+    FirstWeekday["wednesday"] = "wednesday";
+    FirstWeekday["thursday"] = "thursday";
+    FirstWeekday["friday"] = "friday";
+    FirstWeekday["saturday"] = "saturday";
+    FirstWeekday["sunday"] = "sunday";
+})(FirstWeekday || (FirstWeekday = {}));

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

@@ -153,6 +153,10 @@ export interface ConfigEntry {
     error_reason_translation_key?: string;
     error_reason_translation_placeholders?: Record<string, string>;
 }
+export interface ConfigEntryUpdate {
+    type: null | 'added' | 'removed' | 'updated';
+    entry: ConfigEntry;
+}
 export interface RepairsIssue {
     domain: string;
     issue_domain?: string;

package/dist/utils/config_entry.d.ts

@@ -1,5 +1,5 @@
 import { HomeAssistant } from '../models/interfaces/hass';
-export declare function fetchConfigEntries(hass: HomeAssistant): Promise<void>;
+export declare function subscribeConfigEntries(hass: HomeAssistant): Promise<void>;
 export declare function config_entry_id(entity_id: string): string;
 declare const ConfigEntryAttributes: readonly ["domain", "title", "state", "source", "disabled_by"];
 type ConfigEntryAttribute = (typeof ConfigEntryAttributes)[number];

package/dist/utils/config_entry.js

@@ -1,19 +1,37 @@
-export async function fetchConfigEntries(hass) {
-    const entries = await hass.callWS({
-        type: 'config_entries/get',
+export async function subscribeConfigEntries(hass) {
+    await hass.connection.subscribeMessage((updates) => {
+        const entryId = window.haNunjucks.configEntries.entryId || {};
+        const title2EntryId = window.haNunjucks.configEntries.title2EntryId || {};
+        for (const update of updates) {
+            if (update.type == 'removed') {
+                delete entryId[update.entry.entry_id];
+                if (title2EntryId[update.entry.title]) {
+                    title2EntryId[update.entry.title] = title2EntryId[update.entry.title].filter((id) => id != update.entry.entry_id);
+                    if (!title2EntryId[update.entry.title].length) {
+                        delete title2EntryId[update.entry.title];
+                    }
+                }
+            }
+            else {
+                if (entryId[update.entry.entry_id] &&
+                    entryId[update.entry.entry_id].title != update.entry.title) {
+                    delete title2EntryId[entryId[update.entry.entry_id].title];
+                }
+                entryId[update.entry.entry_id] = update.entry;
+                title2EntryId[update.entry.title] ??= [];
+                if (!title2EntryId[update.entry.title].includes(update.entry.entry_id)) {
+                    title2EntryId[update.entry.title].push(update.entry.entry_id);
+                }
+            }
+        }
+        window.haNunjucks.configEntries = {
+            ...window.haNunjucks.configEntries,
+            entryId,
+            title2EntryId,
+        };
+    }, {
+        type: 'config_entries/subscribe',
     });
-    const entryId = {};
-    const title2EntryId = {};
-    for (const entry of entries) {
-        entryId[entry.entry_id] = entry;
-        title2EntryId[entry.title] ??= [];
-        title2EntryId[entry.title].push(entry.entry_id);
-    }
-    window.haNunjucks.configEntries = {
-        ...window.haNunjucks.configEntries,
-        entryId,
-        title2EntryId,
-    };
 }
 export function config_entry_id(entity_id) {
     return window.haNunjucks.entityRegistry.entityId2ConfigEntryId[entity_id];

package/dist/utils/issues.js

@@ -4,7 +4,9 @@ export async function fetchRepairsIssues(hass) {
     })).issues;
     const issues = {};
     for (const issue of repairsIssues) {
-        issues[`${issue.issue_domain || issue.domain},${issue.issue_id}`] = issue;
+        if (!issue.ignored) {
+            issues[`${issue.issue_domain || issue.domain},${issue.issue_id}`] = issue;
+        }
     }
     window.haNunjucks.repairsIssues.issues = issues;
 }

package/dist/utils/state_translated.d.ts

@@ -3,7 +3,9 @@ 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, precision?: 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;
+export declare function getNumberFormatter(hass: HomeAssistant): Intl.NumberFormat;
+export declare function number_translated(hass: HomeAssistant, value: number, precision?: number): string | number;
+export declare function date_translated(hass: HomeAssistant, value: date | datetime | Date | string): string | date | datetime | Date;
+export declare function getTimeFormatter(hass: HomeAssistant): Intl.DateTimeFormat;
+export declare function time_translated(value: time | datetime | Date | string): string | datetime | Date | time;
+export declare function datetime_translated(hass: HomeAssistant, value: datetime | Date | string): string | datetime | Date;

package/dist/utils/state_translated.js

@@ -1,3 +1,4 @@
+import { DateFormat, NumberFormat, TimeFormat, TimeZone, } from '../models/interfaces/hass';
 export function state_translated(hass, entity_id, state) {
     try {
         return hass.formatEntityState(hass.states[entity_id], state);
@@ -11,9 +12,7 @@ export function attr_name_translated(hass, entity_id, attr_name) {
         return hass.formatEntityAttributeName(hass.states[entity_id], attr_name);
     }
     catch {
-        return (attr_name ??
-            hass.states[entity_id]?.attributes?.[attr_name] ??
-            undefined);
+        return (attr_name ?? hass.states[entity_id]?.attributes?.[attr_name] ?? undefined);
     }
 }
 export function attr_value_translated(hass, entity_id, attr_name, attr_value) {
@@ -21,43 +20,151 @@ export function attr_value_translated(hass, entity_id, attr_name, attr_value) {
         return hass.formatEntityAttributeValue(hass.states[entity_id], attr_name, attr_value);
     }
     catch {
-        return (attr_value ??
-            hass.states[entity_id]?.attributes?.[attr_name] ??
-            undefined);
+        return (attr_value ?? hass.states[entity_id]?.attributes?.[attr_name] ?? undefined);
     }
 }
-export function number_translated(value, precision) {
+export function getNumberFormatter(hass) {
+    // https://github.com/home-assistant/frontend/blob/52ac052baf139e94b7ed6891eb0beace7e2f47d3/src/common/number/format_number.ts#L24
+    let language;
+    switch (hass.locale.number_format) {
+        case NumberFormat.comma_decimal:
+            language = ['en-US', 'en']; // Use United States with fallback to English formatting 1,234,567.89
+            break;
+        case NumberFormat.decimal_comma:
+            language = ['de', 'es', 'it']; // Use German with fallback to Spanish then Italian formatting 1.234.567,89
+            break;
+        case NumberFormat.space_comma:
+            language = ['fr', 'sv', 'cs']; // Use French with fallback to Swedish and Czech formatting 1 234 567,89
+            break;
+        case NumberFormat.quote_decimal:
+            language = ['de-CH']; // Use German (Switzerland) formatting 1'234'567.89
+            break;
+        default:
+            language = hass.locale.language ?? hass.language;
+            break;
+    }
+    return new Intl.NumberFormat(language);
+}
+export function number_translated(hass, value, precision) {
     value = Number(value);
     if (isNaN(value)) {
         return value;
     }
     if (precision) {
-        return value.toLocaleString(window.haNunjucks.hass.language, {
+        return value.toLocaleString(hass.locale.language ?? hass.language, {
             minimumFractionDigits: precision,
             maximumFractionDigits: precision,
         });
     }
     return window.haNunjucks.numberFormat.format(value);
 }
-export function date_translated(value) {
+export function date_translated(hass, value) {
+    // https://github.com/home-assistant/frontend/blob/52ac052baf139e94b7ed6891eb0beace7e2f47d3/src/common/datetime/format_date.ts#L59
     try {
-        return window.haNunjucks.dateFormat.format(value.jsDate);
+        let date;
+        if (typeof value === 'string') {
+            date = new Date(`${value}T00:00:00`);
+        }
+        else if (value instanceof Date) {
+            date = value;
+        }
+        else {
+            date = value.jsDate;
+        }
+        let order;
+        switch (hass.locale.date_format) {
+            case DateFormat.DMY:
+                order = ['day', 'month', 'year'];
+                break;
+            case DateFormat.MDY:
+                order = ['month', 'day', 'year'];
+                break;
+            case DateFormat.YMD:
+                order = ['year', 'month', 'day'];
+                break;
+            default:
+                return window.haNunjucks.dateFormat.format(date);
+        }
+        const parts = window.haNunjucks.dateFormat.formatToParts(date);
+        const partsObj = {
+            literal: parts.find((value) => value.type === 'literal')?.value,
+            day: parts.find((value) => value.type === 'day')?.value,
+            month: parts.find((value) => value.type === 'month')?.value,
+            year: parts.find((value) => value.type === 'year')?.value,
+        };
+        const lastPart = parts[parts.length - 1];
+        partsObj.lastLiteral = lastPart?.type === 'literal' ? lastPart?.value : '';
+        if (hass.locale.language === 'bg' &&
+            hass.locale.date_format === DateFormat.YMD) {
+            partsObj.lastLiteral = '';
+        }
+        return `${partsObj[order[0]]}${partsObj.literal}${partsObj[order[1]]}${partsObj.literal}${partsObj[order[2]]}${partsObj.lastLiteral}`;
     }
     catch {
         return value;
     }
 }
+function useAmPm(hass) {
+    // https://github.com/home-assistant/frontend/blob/52ac052baf139e94b7ed6891eb0beace7e2f47d3/src/common/datetime/use_am_pm.ts
+    if (hass.locale.time_format === TimeFormat.language ||
+        hass.locale.time_format === TimeFormat.system) {
+        const testLanguage = hass.locale.time_format === TimeFormat.language
+            ? hass.locale.language
+            : undefined;
+        const test = new Date('January 1, 2023 22:00:00').toLocaleString(testLanguage);
+        return test.includes('10');
+    }
+    return hass.locale.time_format === TimeFormat.am_pm;
+}
+function resolveTimeZone(hass) {
+    // https://github.com/home-assistant/frontend/blob/dev/src/common/datetime/resolve-time-zone.ts#L9
+    const intlTZ = Intl.DateTimeFormat?.().resolvedOptions?.().timeZone;
+    const localTZ = intlTZ ?? 'UTC';
+    return hass.locale.time_zone === TimeZone.local && intlTZ
+        ? localTZ
+        : hass.config.time_zone;
+}
+export function getTimeFormatter(hass) {
+    const AMPM = useAmPm(hass);
+    const options = {
+        hour: AMPM ? 'numeric' : '2-digit',
+        minute: '2-digit',
+        hourCycle: AMPM ? 'h12' : 'h23',
+        timeZone: resolveTimeZone(hass),
+    };
+    return new Intl.DateTimeFormat(hass.locale.language ?? hass.language, options);
+}
 export function time_translated(value) {
     try {
-        return window.haNunjucks.timeFormat.format(value.jsDate);
+        let time;
+        if (typeof value === 'string') {
+            time = new Date(`1970-01-01T${value}`);
+        }
+        else if (value instanceof Date) {
+            time = value;
+        }
+        else {
+            time = value.jsDate;
+        }
+        return window.haNunjucks.timeFormat.format(time);
     }
     catch {
         return value;
     }
 }
-export function datetime_translated(value) {
+export function datetime_translated(hass, value) {
     try {
-        return window.haNunjucks.datetimeFormat.format(value.jsDate);
+        let datetime;
+        if (typeof value === 'string') {
+            datetime = new Date(value);
+        }
+        else if (value instanceof Date) {
+            datetime = value;
+        }
+        else {
+            datetime = value.jsDate;
+        }
+        return `${date_translated(hass, datetime)} at ${time_translated(datetime)}`;
     }
     catch {
         return value;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ha-nunjucks",
-	"version": "1.7.3",
+	"version": "1.7.5",
 	"description": "Wrapper for nunjucks for use with Home Assistant frontend custom components to render templates",
 	"main": "./dist/index.js",
 	"files": [