opening_hours 3.12.0 → 3.14.0

package/package.json

@@ -3,7 +3,7 @@
   "type": "commonjs",
   "types": "./types/index.d.ts",
   "description": "Library to parse and process opening_hours tag from OpenStreetMap data",
-  "version": "3.12.0",
+  "version": "3.14.0",
   "main": "./build/opening_hours.js",
   "module": "./build/opening_hours.esm.mjs",
   "sideEffects": false,
@@ -66,38 +66,40 @@
     "check-updates": "npm-check-updates --upgrade"
   },
   "dependencies": {
-    "i18next": "^25.8.13",
-    "suncalc": "^1.9.0"
+    "i18next": "^26.3.6",
+    "suncalc": "^2.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.4.2",
-    "@commitlint/config-conventional": "^20.4.2",
-    "@eslint/js": "^9.32.0",
-    "@eslint/markdown": "^7.5.1",
-    "@rollup/plugin-commonjs": "^29.0.0",
+    "@commitlint/cli": "^21.2.1",
+    "@commitlint/config-conventional": "^21.2.0",
+    "@eslint/js": "^10.0.1",
+    "@eslint/markdown": "^8.0.3",
+    "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-yaml": "^4.1.2",
-    "@stylistic/eslint-plugin": "^5.9.0",
-    "commit-and-tag-version": "^12.6.1",
-    "commitizen": "^4.3.1",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-yaml": "^5.0.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "cldr-dates-full": "^48.2.0",
+    "cldr-localenames-full": "^48.2.0",
+    "commit-and-tag-version": "^12.7.3",
+    "commitizen": "^4.3.2",
     "cz-conventional-changelog": "^3.3.0",
-    "doctoc": "^2.3.0",
-    "eslint": "^9.32.0",
-    "full-icu": "^1.5.0",
+    "doctoc": "^2.5.0",
+    "eslint": "^10.7.0",
+    "full-icu": "^1.6.0",
     "glob": "^13.0.6",
-    "globals": "^17.4.0",
+    "globals": "^17.7.0",
     "husky": "^9.1.7",
-    "lint-staged": "^16.3.1",
-    "npm-check-updates": "^19.6.3",
+    "lint-staged": "^17.0.8",
+    "npm-check-updates": "^22.2.9",
     "package-json-validator-cli": "^0.1.11",
-    "rollup": "^4.59.0",
-    "terser": "^5.46.0",
+    "rollup": "^4.62.2",
+    "terser": "^5.49.0",
     "timekeeper": "^2.3.1",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.56.1",
-    "yaml": "^2.8.2",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.63.0",
+    "yaml": "^2.9.0",
     "yargs": "^18.0.0"
   },
   "engines": {

package/site/js/countryToLanguageMapping.js

@@ -1,4 +1,8 @@
 /*
+ * SPDX-FileCopyrightText: © 2015 Robin Schneider <ypid@riseup.net>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ *
  * Upstream source: https://wiki.openstreetmap.org/wiki/Nominatim/Country_Codes
  */
 export const countryToLanguageMapping = {

package/site/js/helpers.js

@@ -1,5 +1,10 @@
+/**
+ * SPDX-FileCopyrightText: © 2014 Robin Schneider <ypid@riseup.net>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ */
 // Import dependencies
-import i18next from '../../node_modules/i18next/dist/esm/i18next.bundled.js';
+import i18next from '../../node_modules/i18next/dist/esm/i18next.js';
 import { OpeningHoursTable } from './opening_hours_table.js';
 import { mapCountryToLanguage } from './countryToLanguageMapping.js';
 import { updateTimeButtonLabels } from './main.js';
@@ -46,15 +51,18 @@ export function josm(url_param) {
 }
 // }}}
 
-// add calculation for calendar week to date {{{
-export function dateAtWeek(date, week) {
-    const minutes_in_day = 60 * 24;
-    const msec_in_day    = 1000 * 60 * minutes_in_day;
-    const msec_in_week   = msec_in_day * 7;
+// ISO 8601 calendar week number {{{
+export function getISOWeekNumber(date) {
+    const millisecondsPerDay = 24 * 60 * 60 * 1000;
+    const utcDate = new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate()));
+
+    // ISO week uses Monday=1..Sunday=7 and anchors weeks on Thursday.
+    const isoDay = utcDate.getUTCDay() || 7;
+    utcDate.setUTCDate(utcDate.getUTCDate() + 4 - isoDay);
 
-    const tmpdate = new Date(date.getFullYear(), 0, 1);
-    tmpdate.setDate(1 - (tmpdate.getDay() + 6) % 7 + week * 7); // start of week n where week starts on Monday
-    return Math.floor((date - tmpdate) / msec_in_week);
+    const isoYearStart = new Date(Date.UTC(utcDate.getUTCFullYear(), 0, 1));
+    const dayOfYear = Math.floor((utcDate - isoYearStart) / millisecondsPerDay) + 1;
+    return Math.ceil(dayOfYear / 7);
 }
 // }}}
 

package/site/js/i18n-resources.js

@@ -1,5 +1,10 @@
+/**
+ * SPDX-FileCopyrightText: © 2013 Robin Schneider <ypid@riseup.net>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ */
 // Import i18next for use in helper functions
-import i18next from '../../node_modules/i18next/dist/esm/i18next.bundled.js';
+import i18next from '../../node_modules/i18next/dist/esm/i18next.js';
 
 // localization {{{
 export const resources = { // English is fallback language.

package/site/js/main.js

@@ -1,7 +1,12 @@
+/**
+ * SPDX-FileCopyrightText: © 2025 Kristjan ESPERANTO <https://github.com/KristjanESPERANTO>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ */
 // Import all required modules
-import i18next from '../../node_modules/i18next/dist/esm/i18next.bundled.js';
+import i18next from '../../node_modules/i18next/dist/esm/i18next.js';
 import { resources, detectLanguage, getUserSelectTranslateHTMLCode, changeLanguage } from './i18n-resources.js';
-import { Evaluate, EX, josm, toggle, dateAtWeek, newValue, currentDateTime } from './helpers.js';
+import { Evaluate, EX, josm, toggle, getISOWeekNumber, newValue, currentDateTime } from './helpers.js';
 
 // Configuration constants
 window.default_lat = 48.7769;
@@ -72,7 +77,7 @@ export function updateTimeButtonLabels(date) {
     if (minuteLabel) minuteLabel.textContent = u2(currentDateTime.minute);
 
     if (weekLabel && date) {
-        weekLabel.textContent = `W${u2(dateAtWeek(date, 0) + 1)}`;
+        weekLabel.textContent = `W${u2(getISOWeekNumber(date))}`;
     }
 
     if (wdayDisplay && date) {

package/site/js/opening_hours_table.js

@@ -1,5 +1,10 @@
+/**
+ * SPDX-FileCopyrightText: © 2013 Robin Schneider <ypid@riseup.net>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ */
 // Import dependencies
-import i18next from '../../node_modules/i18next/dist/esm/i18next.bundled.js';
+import i18next from '../../node_modules/i18next/dist/esm/i18next.js';
 
 export const OpeningHoursTable = {
 
@@ -12,6 +17,16 @@ export const OpeningHoursTable = {
         return date.toLocaleString(i18next.language, { weekday: 'short' });
     },
 
+    // Returns a date's local time as a percentage of the day (0–100).
+    dayPercent(date) {
+        return (date.getHours() * 60 + date.getMinutes()) / 1440 * 100;
+    },
+
+    // Formats a date's local time as "HH:MM".
+    formatHM(date) {
+        return date.toLocaleString('en', { hourCycle: 'h23', hour: '2-digit', minute: '2-digit' });
+    },
+
     formatdate (now, nextchange, from) {
         const now_daystart = new Date(now.getFullYear(), now.getMonth(), now.getDate());
         const nextdays = (nextchange.getTime() - now_daystart.getTime()) / 1000 / 60 / 60 / 24;
@@ -113,7 +128,7 @@ export const OpeningHoursTable = {
         // Calculate current time position for "now" marker (percentage of day)
         // Use evalDate instead of new Date() to show the evaluation time, not browser time
         const now = evalDate || new Date();
-        const nowPercent = ((now.getHours() * 60 + now.getMinutes()) / (24 * 60)) * 100;
+        const nowPercent = this.dayPercent(now);
 
         const tableData = [];
 
@@ -137,30 +152,23 @@ export const OpeningHoursTable = {
             while (has_next_change && it.advance() && curdate.getTime() - date.getTime() < 24 * 60 * 60 * 1000) {
                 curdate = it.getDate();
 
-                let fr = prevdate.getTime() - date.getTime();
-                let to = curdate.getTime() - date.getTime();
+                // Use local clock time (not elapsed ms) so bars stay aligned
+                // with labels on DST transition days.
+                const crossesMidnight = prevdate.getDay() !== curdate.getDay();
 
-                if (to > 24 * 60 * 60 * 1000) {
-                    to = 24 * 60 * 60 * 1000;
-                }
-
-                fr *= 100 / 1000 / 60 / 60 / 24;
-                to *= 100 / 1000 / 60 / 60 / 24;
+                const from = this.dayPercent(prevdate);
+                const to = crossesMidnight ? 100 : this.dayPercent(curdate);
 
                 const stateClass = is_open ? 'open' : (unknown ? 'unknown' : 'closed');
-                // Always use 24h format with HH:MM
-                const timeFrom = `${String(prevdate.getHours()).padStart(2, '0')}:${String(prevdate.getMinutes()).padStart(2, '0')}`;
-                const timeToDate = prevdate.getDay() !== curdate.getDay() ? null : curdate;
-                const timeTo = timeToDate
-                    ? `${String(timeToDate.getHours()).padStart(2, '0')}:${String(timeToDate.getMinutes()).padStart(2, '0')}`
-                    : '24:00';
+                const timeFrom = this.formatHM(prevdate);
+                const timeTo = crossesMidnight ? '24:00' : this.formatHM(curdate);
 
                 // Use current state_string for this period (before advancing)
                 const currentStateString = state_string;
                 const tooltip = `${i18next.t(`words.${currentStateString}`)}: ${timeFrom} - ${timeTo}`;
 
                 rowData.times.push(
-                    `<div class="timebar ${stateClass}" style="width:${to - fr}%" title="${tooltip}"></div>`
+                    `<div class="timebar ${stateClass}" style="width:${to - from}%" title="${tooltip}"></div>`
                 );
 
                 if (is_open || unknown) {
@@ -232,14 +240,6 @@ export const OpeningHoursTable = {
         return `<table class="opening-hours-table">${headerRow}${rows}</table>`;
     },
 
-    getReadableState (startString, endString, oh, past) {
-        if (past === true) past = 'd';
-        else past = '';
-
-        const output = '';
-        return `${startString + output + endString}.`;
-    },
-
     drawTableAndComments (oh, it, evalDate) {
         const prevdate          = it.getDate();
         const unknown           = it.getUnknown();
@@ -357,10 +357,7 @@ export const OpeningHoursTable = {
         const change_daystart = new Date(changeDate.getFullYear(), changeDate.getMonth(), changeDate.getDate());
         const daysDiff = Math.round((change_daystart.getTime() - now_daystart.getTime()) / (1000 * 60 * 60 * 24));
 
-        // Always use 24h format with HH:MM
-        const hours = String(changeDate.getHours()).padStart(2, '0');
-        const minutes = String(changeDate.getMinutes()).padStart(2, '0');
-        const timeStr = `${hours}:${minutes}`;
+        const timeStr = this.formatHM(changeDate);
 
         if (daysDiff === 0) {
             return `${i18next.t('words.today')} ${timeStr}`;

package/site/js/theme.js

@@ -44,12 +44,8 @@
     const theme = getThemePreference();
     setTheme(theme);
 
-    // Set up toggle button when DOM is ready
-    if (document.readyState === 'loading') {
-        document.addEventListener('DOMContentLoaded', initToggleButton);
-    } else {
-        initToggleButton();
-    }
+    // Set up toggle button (script loads with defer, so DOM is ready)
+    initToggleButton();
 
     function initToggleButton() {
         const toggleBtn = document.getElementById('theme-toggle');

package/site/js/yohours_model.js

@@ -1,4 +1,7 @@
 /*
+ * SPDX-FileCopyrightText: Adrien PAVIE
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ *
  * This file is part of YoHours.
  * 
  * YoHours is free software: you can redistribute it and/or modify

package/src/locales/i18n.js

@@ -1,62 +1,102 @@
-import opening_hours_resources from './opening_hours_resources.yaml';
+/**
+ * SPDX-FileCopyrightText: © 2025 Kristjan ESPERANTO <https://github.com/KristjanESPERANTO>
+ *
+ * SPDX-License-Identifier: LGPL-3.0-only
+ */
+import resources from './translations.yaml';
 
-const resources = opening_hours_resources;
-
-// Simple i18n object compatible with the minimal features used in src/index.js
-const i18n = {
-    language: 'en',
-    isInitialized: true,
-
-    t: function(key, variables) {
-        return this._translate(this.language, key, variables);
-    },
-
-    getFixedT: function(locale) {
-        const self = this;
-        return function(key, variables) {
-            return self._translate(locale, key, variables);
-        };
-    },
-
-    _translate: function(locale, key, variables) {
-        // Handle array of keys (fallback mechanism)
-        const keys = Array.isArray(key) ? key : [key];
+/**
+ * Replace `{{varName}}` (or `{{-varName}}`) placeholders in a translation string.
+ * The `-` prefix is a legacy i18next no-HTML-escape marker; it has no effect here.
+ *
+ * @param {string} str  - Translation string containing `{{…}}` placeholders.
+ * @param {Object} vars - Map of placeholder names to replacement values.
+ * @returns {string}
+ */
+function interpolate(str, vars) {
+    return str.replace(/{{-?([^{}]*)}}/g, function(match, varName) {
+        const name = varName.trim();
+        if (name in vars) {
+            return vars[name];
+        }
+        return match;
+    });
+}
 
-        for (const k of keys) {
-            // Parse namespace:path notation (e.g., "opening_hours:pretty.off")
-            const parts = k.split(':');
-            const namespace = parts.length > 1 ? parts[0] : 'opening_hours';
-            const path = parts.length > 1 ? parts[1] : parts[0];
+/**
+ * Extract the base language subtag from a locale tag (e.g. 'de-DE' → 'de').
+ *
+ * Accepts BCP 47 tags (e.g. 'de-DE') and POSIX identifiers per ISO 15897 (e.g. 'de_DE').
+ * For non-strings, returns 'en' (the default fallback locale).
+ *
+ * @param {string|null|undefined} locale - Locale tag.
+ * @returns {string} Base language, e.g. 'de'.
+ */
+function baseLanguage(locale) {
+    if (locale && typeof locale === 'string') {
+        return locale.split(/[-_]/)[0];
+    }
+    return 'en';
+}
 
-            // Try to get translation
-            const translation = this._getNestedValue(resources, [locale, namespace, ...path.split('.')]);
+/**
+ * Build the locale fallback chain for a given locale tag.
+ *
+ * 'de-DE' → ['de-DE', 'de', 'en']
+ * 'de'    → ['de', 'en']
+ * null    → ['en']
+ *
+ * @param {string|null|undefined} locale - BCP 47 locale tag.
+ * @returns {string[]}
+ */
+function localeChain(locale) {
+    const base = baseLanguage(locale);
+    // Deduplicate entries like ['de', 'de', 'en'] or ['en', 'en'].
+    return [...new Set([locale, base, 'en'].filter(Boolean))];
+}
 
-            if (translation !== undefined) {
-                // Replace variables like {{variable}} or {{-variable}}
-                // The minus prefix means "don't escape HTML" (compatibility feature)
-                if (typeof translation === 'string' && variables) {
-                    return translation.replace(/{{-?([^{}]*)}}/g, function (match, varName) {
-                        const trimmed = varName.trim();
-                        return typeof variables[trimmed] !== 'undefined' ? variables[trimmed] : match;
-                    });
-                }
-                return translation;
-            }
-        }
+/**
+ * Walk the resource tree for the first locale in the fallback chain that has
+ * a translation for the given key.
+ *
+ * Tree shape: resources[locale][section][…key segments]
+ *
+ * @param {string|null|undefined} locale  - BCP 47 locale tag.
+ * @param {string}                section - 'texts' or 'pretty'.
+ * @param {string}                key     - Translation key (dot-separated for nesting).
+ * @returns {*} Matched value, or `undefined` if not found anywhere in the chain.
+ */
+function lookup(locale, section, key) {
+    const keyPath = key.split('.');
+    for (const loc of localeChain(locale)) {
+        let value = resources[loc]?.[section];
+        for (const segment of keyPath) value = value?.[segment];
+        // Return as soon as we find a value defined by the resource tree.
+        if (value !== undefined) return value;
+    }
+    return undefined;
+}
 
-        // Fallback: return the last key if no translation found
-        const lastKey = keys[keys.length - 1];
-        return lastKey.includes(':') ? lastKey.split(':')[1] : lastKey;
-    },
+/**
+ * Translate a key into the requested locale, falling back through the locale
+ * chain to English. Returns the key itself when no translation is found.
+ *
+ * @param {string|null|undefined} locale  - BCP 47 locale tag (e.g. 'de', 'de-DE').
+ * @param {string}                section - 'texts' (error/warning messages) or
+ *                                          'pretty' (prettified output tokens).
+ * @param {string}                key     - Translation key (dot-separated for nesting).
+ * @param {Object}               [vars]   - Variables to interpolate via `{{varName}}`.
+ * @returns {string}
+ */
+export function translate(locale, section, key, vars) {
+    const result = lookup(locale, section, key);
 
-    _getNestedValue: function(obj, path) {
-        let current = obj;
-        for (const key of path) {
-            if (current === undefined || current === null) return undefined;
-            current = current[key];
+    if (typeof result === 'string') {
+        if (vars) {
+            return interpolate(result, vars);
         }
-        return current;
+        return result;
     }
-};
 
-export default i18n;
+    return key;
+}

package/types/index.d.ts

@@ -1,4 +1,45 @@
 declare module 'opening_hours' {
+  export type opening_hours_warning_type =
+    | 'adding_0'
+    | 'additional_rule_separator_not_used_after_time_wrapping_midnight'
+    | 'additional_rule_which_evaluates_to_closed'
+    | 'ambiguous_word'
+    | 'combine_rules'
+    | 'default_state'
+    | 'empty_comment'
+    | 'hour_min_separator'
+    | 'interpreted_as_year'
+    | 'no_colon_after'
+    | 'nothing_useful'
+    | 'omit_ko'
+    | 'period_one'
+    | 'period_one_year_plus'
+    | 'please_use_ok_for_ko'
+    | 'public_holiday'
+    | 'rant_degree_sign_used_for_zero'
+    | 'separator_for_readability'
+    | 'strange_24_7'
+    | 'switched'
+    | 'use_multi'
+    | 'vague'
+    | 'value_ends_with_token'
+    | 'without_minutes'
+    | 'word_error_correction'
+    | 'year_past'
+    | 'zero_calculation'
+
+  export interface opening_hours_warning {
+    type: opening_hours_warning_type
+    message: string
+    /** The string the `position` offset refers to. This is the input value,
+     * except for selector-reordering warnings where it is the prettified value. */
+    value: string
+    /** Character offset into `value` where the warning points (the spot the
+     * `<--- ` marker is placed at in `getWarnings()`). `null` if it could not
+     * be determined. */
+    position: number | null
+  }
+
   export class opening_hours {
     constructor(
       value: string,
@@ -31,6 +72,7 @@ declare module 'opening_hours' {
       date?: Date
     ): [boolean, Date, boolean, string | undefined, number | undefined]
     getWarnings(): string[]
+    getStructuredWarnings(): opening_hours_warning[]
     isEqualTo(
       second_oh_object: opening_hours,
       start_date?: Date