opening_hours 3.13.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.13.0",
+  "version": "3.14.0",
   "main": "./build/opening_hours.js",
   "module": "./build/opening_hours.esm.mjs",
   "sideEffects": false,
@@ -66,37 +66,39 @@
     "check-updates": "npm-check-updates --upgrade"
   },
   "dependencies": {
-    "i18next": "^26.1.0",
-    "suncalc": "^1.9.0"
+    "i18next": "^26.3.6",
+    "suncalc": "^2.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^21.0.0",
-    "@commitlint/config-conventional": "^21.0.0",
+    "@commitlint/cli": "^21.2.1",
+    "@commitlint/config-conventional": "^21.2.0",
     "@eslint/js": "^10.0.1",
-    "@eslint/markdown": "^8.0.1",
-    "@rollup/plugin-commonjs": "^29.0.2",
+    "@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": "^1.0.0",
-    "@rollup/plugin-yaml": "^4.1.2",
+    "@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.1",
+    "commitizen": "^4.3.2",
     "cz-conventional-changelog": "^3.3.0",
-    "doctoc": "^2.4.1",
-    "eslint": "^10.3.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.6.0",
+    "globals": "^17.7.0",
     "husky": "^9.1.7",
-    "lint-staged": "^17.0.4",
-    "npm-check-updates": "^22.1.1",
+    "lint-staged": "^17.0.8",
+    "npm-check-updates": "^22.2.9",
     "package-json-validator-cli": "^0.1.11",
-    "rollup": "^4.60.3",
-    "terser": "^5.47.1",
+    "rollup": "^4.62.2",
+    "terser": "^5.49.0",
     "timekeeper": "^2.3.1",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.3",
+    "typescript-eslint": "^8.63.0",
     "yaml": "^2.9.0",
     "yargs": "^18.0.0"
   },

package/src/locales/i18n.js

@@ -3,65 +3,100 @@
  *
  * SPDX-License-Identifier: LGPL-3.0-only
  */
-import opening_hours_resources from './opening_hours_resources.yaml';
+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