weather-i18n 1.0.0

package/README.md

@@ -0,0 +1,146 @@
+# weather-i18n
+
+A lightweight, fully typed TypeScript library for internationalizing, validating, and mapping weather condition codes (WMO 4677) with multilingual descriptions and popular icon sets.
+
+## Features
+
+- 🌐 **Internationalization (i18n)**: Translate WMO 4677 weather codes into multiple languages (`en`, `es`) with day/night phase support (`day` / `night`) and fallback language support.
+- 📐 **Complete Specification**: Comprehensive definitions, human-readable keys (`key`), and reverse mappings for WMO 4677 weather codes.
+- 🛡️ **Zod Validation**: Flexible schema to validate and transform numeric inputs (`95`), string values (`"95"`), or human-readable keys (`"thunderstorm_slight_moderate_no_hail"`).
+- 🎨 **Icon Mapping**: Automatically map weather codes to popular icon packs such as OpenMeteo and Pixelarticons, with both day and night variants.
+- 📦 **Tree-Shaking & Subpath Imports**: Import only what you need or access the raw JSON data directly.
+
+## Installation
+
+```bash
+# Using pnpm
+pnpm add weather-i18n
+
+# Using npm
+npm install weather-i18n
+
+# Using yarn
+yarn add weather-i18n
+```
+
+## Import Options
+
+Once the package is installed, you can import it in different ways depending on your bundling strategy and project architecture.
+
+### 1. Main Import (Full Bundle)
+
+```ts
+import { WMO4677 } from "weather-i18n";
+
+// Unified access to spec, i18n, validator, and icons
+const desc = WMO4677.i18n("es")(95, "day");
+const parsed = WMO4677.validator.parse("95");
+```
+
+### 2. WMO 4677 Module
+
+```ts
+import WMO4677 from "weather-i18n/wmo_4677";
+
+const desc = WMO4677.i18n("en")(3, "night");
+```
+
+### 3. Subpath Imports
+
+To optimize your bundle size or use specific features independently:
+
+```ts
+// Internationalization
+import WMO4677I18n from "weather-i18n/wmo_4677/i18n";
+const getDesc = WMO4677I18n("es", "en");
+console.log(getDesc(95, "day")); // "Thunderstorm"
+
+// Complete specification
+import WMO4677Spec from "weather-i18n/wmo_4677/spec";
+console.log(WMO4677Spec[95].key); // "thunderstorm_slight_moderate_no_hail"
+
+// Zod validator
+import WMO4677Validator from "weather-i18n/wmo_4677/validator";
+const result = WMO4677Validator.parse("05");
+
+// Icons (All)
+import WMO4677Icons from "weather-i18n/wmo_4677/icons";
+console.log(WMO4677Icons.openmeteo(95, "day"));
+
+// Individual icon helpers
+import WMO4677Pixelarticons from "weather-i18n/wmo_4677/icons/pixelarticons";
+import WMO4677OpenMeteo from "weather-i18n/wmo_4677/icons/openmeteo";
+
+console.log(WMO4677Pixelarticons(95, "night"));
+console.log(WMO4677OpenMeteo(95, "day"));
+```
+
+### 4. Direct JSON Imports
+
+You can import the original JSON data files using Import Attributes (or assertions, depending on your environment):
+
+```ts
+import WMO4677I18nEN from "weather-i18n/wmo_4677/data/i18n/en.json" with { format: "json" };
+import WMO4677I18nES from "weather-i18n/wmo_4677/data/i18n/es.json" with { format: "json" };
+import WMO4677OpenMeteo from "weather-i18n/wmo_4677/data/icons/openmeteo.json" with { format: "json" };
+import WMO4677Pixelarticons from "weather-i18n/wmo_4677/data/icons/pixelarticons.json" with { format: "json" };
+```
+
+*(Note: In Node.js v20+/v22+ and modern bundlers, `with { type: "json" }` is also supported.)*
+
+---
+
+## API Overview
+
+### Internationalization (`i18n`)
+
+Create a formatter by specifying the desired language and, optionally, a fallback language:
+
+```ts
+import WMO4677I18n from "weather-i18n/wmo_4677/i18n";
+
+const getDesc = WMO4677I18n("es", "en");
+
+// Get the daytime description for code 95
+const daytimeText = getDesc(95, "day"); // "Tormenta"
+
+// Get the nighttime description
+const nighttimeText = getDesc(95, "night");
+```
+
+### Zod Validator (`validator`)
+
+Parses input values as integers (`0-99`), strings (`"05"`), or human-readable keys (`"haze"`), returning a structured object:
+
+```ts
+import WMO4677Validator from "weather-i18n/wmo_4677/validator";
+
+const data = WMO4677Validator.parse("5");
+// Result:
+// {
+//   code: 5,
+//   key: "haze",
+//   description: "Haze"
+// }
+```
+
+---
+
+## Development & Scripts
+
+If you'd like to contribute or run the local build and validation scripts:
+
+```bash
+# Install dependencies
+pnpm install
+
+# Compile TypeScript into /dist
+pnpm build
+
+# Run tests and validation
+pnpm test
+```
+
+## License
+
+[ISC](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import WMO4677 from "./wmo_4677";
+export { WMO4677 };
+export default WMO4677;
+export * from "./wmo_4677";

package/dist/index.js

@@ -0,0 +1,4 @@
+import WMO4677 from "./wmo_4677";
+export { WMO4677 };
+export default WMO4677;
+export * from "./wmo_4677";

package/dist/wmo_4677/data/i18n/en.json

@@ -0,0 +1,114 @@
+{
+    "0": {
+        "day": "Sunny",
+        "night": "Clear"
+    },
+    "1": {
+        "day": "Mainly Sunny",
+        "night": "Mainly Clear"
+    },
+    "2": {
+        "day": "Partly Cloudy",
+        "night": "Partly Cloudy"
+    },
+    "3": {
+        "day": "Cloudy",
+        "night": "Cloudy"
+    },
+    "45": {
+        "day": "Foggy",
+        "night": "Foggy"
+    },
+    "48": {
+        "day": "Rime Fog",
+        "night": "Rime Fog"
+    },
+    "51": {
+        "day": "Light Drizzle",
+        "night": "Light Drizzle"
+    },
+    "53": {
+        "day": "Drizzle",
+        "night": "Drizzle"
+    },
+    "55": {
+        "day": "Heavy Drizzle",
+        "night": "Heavy Drizzle"
+    },
+    "56": {
+        "day": "Light Freezing Drizzle",
+        "night": "Light Freezing Drizzle"
+    },
+    "57": {
+        "day": "Freezing Drizzle",
+        "night": "Freezing Drizzle"
+    },
+    "61": {
+        "day": "Light Rain",
+        "night": "Light Rain"
+    },
+    "63": {
+        "day": "Rain",
+        "night": "Rain"
+    },
+    "65": {
+        "day": "Heavy Rain",
+        "night": "Heavy Rain"
+    },
+    "66": {
+        "day": "Light Freezing Rain",
+        "night": "Light Freezing Rain"
+    },
+    "67": {
+        "day": "Freezing Rain",
+        "night": "Freezing Rain"
+    },
+    "71": {
+        "day": "Light Snow",
+        "night": "Light Snow"
+    },
+    "73": {
+        "day": "Snow",
+        "night": "Snow"
+    },
+    "75": {
+        "day": "Heavy Snow",
+        "night": "Heavy Snow"
+    },
+    "77": {
+        "day": "Snow Grains",
+        "night": "Snow Grains"
+    },
+    "80": {
+        "day": "Light Showers",
+        "night": "Light Showers"
+    },
+    "81": {
+        "day": "Showers",
+        "night": "Showers"
+    },
+    "82": {
+        "day": "Heavy Showers",
+        "night": "Heavy Showers"
+    },
+    "85": {
+        "day": "Light Snow Showers",
+        "night": "Light Snow Showers"
+    },
+    "86": {
+        "day": "Snow Showers",
+        "night": "Snow Showers"
+    },
+    "95": {
+        "day": "Thunderstorm",
+        "night": "Thunderstorm"
+    },
+    "96": {
+        "day": "Light Thunderstorms With Hail",
+        "night": "Light Thunderstorms With Hail"
+    },
+    "99": {
+        "day": "Thunderstorm With Hail",
+        "night": "Thunderstorm With Hail"
+    }
+}

package/dist/wmo_4677/data/i18n/es.json

@@ -0,0 +1,114 @@
+{
+    "0": {
+        "day": "Soleado",
+        "night": "Despejado"
+    },
+    "1": {
+        "day": "Mayormente soleado",
+        "night": "Mayormente despejado"
+    },
+    "2": {
+        "day": "Parcialmente nublado",
+        "night": "Parcialmente nublado"
+    },
+    "3": {
+        "day": "Nublado",
+        "night": "Nublado"
+    },
+    "45": {
+        "day": "Con niebla",
+        "night": "Con niebla"
+    },
+    "48": {
+        "day": "Niebla con cencellada",
+        "night": "Niebla con cencellada"
+    },
+    "51": {
+        "day": "Llovizna débil",
+        "night": "Llovizna débil"
+    },
+    "53": {
+        "day": "Llovizna",
+        "night": "Llovizna"
+    },
+    "55": {
+        "day": "Llovizna intensa",
+        "night": "Llovizna intensa"
+    },
+    "56": {
+        "day": "Llovizna helada débil",
+        "night": "Llovizna helada débil"
+    },
+    "57": {
+        "day": "Llovizna helada",
+        "night": "Llovizna helada"
+    },
+    "61": {
+        "day": "Lluvia débil",
+        "night": "Lluvia débil"
+    },
+    "63": {
+        "day": "Lluvia",
+        "night": "Lluvia"
+    },
+    "65": {
+        "day": "Lluvia intensa",
+        "night": "Lluvia intensa"
+    },
+    "66": {
+        "day": "Lluvia helada débil",
+        "night": "Lluvia helada débil"
+    },
+    "67": {
+        "day": "Lluvia helada",
+        "night": "Lluvia helada"
+    },
+    "71": {
+        "day": "Nieve débil",
+        "night": "Nieve débil"
+    },
+    "73": {
+        "day": "Nieve",
+        "night": "Nieve"
+    },
+    "75": {
+        "day": "Nevada intensa",
+        "night": "Nevada intensa"
+    },
+    "77": {
+        "day": "Granos de nieve",
+        "night": "Granos de nieve"
+    },
+    "80": {
+        "day": "Chubascos débiles",
+        "night": "Chubascos débiles"
+    },
+    "81": {
+        "day": "Chubascos",
+        "night": "Chubascos"
+    },
+    "82": {
+        "day": "Chubascos intensos",
+        "night": "Chubascos intensos"
+    },
+    "85": {
+        "day": "Chubascos de nieve débiles",
+        "night": "Chubascos de nieve débiles"
+    },
+    "86": {
+        "day": "Chubascos de nieve",
+        "night": "Chubascos de nieve"
+    },
+    "95": {
+        "day": "Tormenta",
+        "night": "Tormenta"
+    },
+    "96": {
+        "day": "Tormenta con granizo débil",
+        "night": "Tormenta con granizo débil"
+    },
+    "99": {
+        "day": "Tormenta con granizo",
+        "night": "Tormenta con granizo"
+    }
+}

package/dist/wmo_4677/data/icons/openmeteo.json

@@ -0,0 +1,114 @@
+{
+    "0": {
+        "day": "http://openweathermap.org/img/wn/01d@2x.png",
+        "night": "http://openweathermap.org/img/wn/01n@2x.png"
+    },
+    "1": {
+        "day": "http://openweathermap.org/img/wn/01d@2x.png",
+        "night": "http://openweathermap.org/img/wn/01n@2x.png"
+    },
+    "2": {
+        "day": "http://openweathermap.org/img/wn/02d@2x.png",
+        "night": "http://openweathermap.org/img/wn/02n@2x.png"
+    },
+    "3": {
+        "day": "http://openweathermap.org/img/wn/03d@2x.png",
+        "night": "http://openweathermap.org/img/wn/03n@2x.png"
+    },
+    "45": {
+        "day": "http://openweathermap.org/img/wn/50d@2x.png",
+        "night": "http://openweathermap.org/img/wn/50n@2x.png"
+    },
+    "48": {
+        "day": "http://openweathermap.org/img/wn/50d@2x.png",
+        "night": "http://openweathermap.org/img/wn/50n@2x.png"
+    },
+    "51": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "53": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "55": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "56": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "57": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "61": {
+        "day": "http://openweathermap.org/img/wn/10d@2x.png",
+        "night": "http://openweathermap.org/img/wn/10n@2x.png"
+    },
+    "63": {
+        "day": "http://openweathermap.org/img/wn/10d@2x.png",
+        "night": "http://openweathermap.org/img/wn/10n@2x.png"
+    },
+    "65": {
+        "day": "http://openweathermap.org/img/wn/10d@2x.png",
+        "night": "http://openweathermap.org/img/wn/10n@2x.png"
+    },
+    "66": {
+        "day": "http://openweathermap.org/img/wn/10d@2x.png",
+        "night": "http://openweathermap.org/img/wn/10n@2x.png"
+    },
+    "67": {
+        "day": "http://openweathermap.org/img/wn/10d@2x.png",
+        "night": "http://openweathermap.org/img/wn/10n@2x.png"
+    },
+    "71": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "73": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "75": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "77": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "80": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "81": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "82": {
+        "day": "http://openweathermap.org/img/wn/09d@2x.png",
+        "night": "http://openweathermap.org/img/wn/09n@2x.png"
+    },
+    "85": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "86": {
+        "day": "http://openweathermap.org/img/wn/13d@2x.png",
+        "night": "http://openweathermap.org/img/wn/13n@2x.png"
+    },
+    "95": {
+        "day": "http://openweathermap.org/img/wn/11d@2x.png",
+        "night": "http://openweathermap.org/img/wn/11n@2x.png"
+    },
+    "96": {
+        "day": "http://openweathermap.org/img/wn/11d@2x.png",
+        "night": "http://openweathermap.org/img/wn/11n@2x.png"
+    },
+    "99": {
+        "day": "http://openweathermap.org/img/wn/11d@2x.png",
+        "night": "http://openweathermap.org/img/wn/11n@2x.png"
+    }
+}

package/dist/wmo_4677/data/icons/pixelarticons.json

@@ -0,0 +1,114 @@
+{
+    "0": {
+        "day": "Sun",
+        "night": "Moon"
+    },
+    "1": {
+        "day": "CloudSun",
+        "night": "CloudMoon"
+    },
+    "2": {
+        "day": "CloudSun",
+        "night": "CloudMoon"
+    },
+    "3": {
+        "day": "Cloud",
+        "night": "Cloud"
+    },
+    "45": {
+        "day": "Waves",
+        "night": "Waves"
+    },
+    "48": {
+        "day": "Waves",
+        "night": "Waves"
+    },
+    "51": {
+        "day": "Rain",
+        "night": "Rain"
+    },
+    "53": {
+        "day": "Rain",
+        "night": "Rain"
+    },
+    "55": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "56": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "57": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "61": {
+        "day": "Rain",
+        "night": "Rain"
+    },
+    "63": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "65": {
+        "day": "CloudThunderRain",
+        "night": "CloudThunderRain"
+    },
+    "66": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "67": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "71": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "73": {
+        "day": "CloudSnow",
+        "night": "CloudSnow"
+    },
+    "75": {
+        "day": "CloudSnow2",
+        "night": "CloudSnow2"
+    },
+    "77": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "80": {
+        "day": "Rain",
+        "night": "Rain"
+    },
+    "81": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "82": {
+        "day": "CloudThunderRain",
+        "night": "CloudThunderRain"
+    },
+    "85": {
+        "day": "Rain2",
+        "night": "Rain2"
+    },
+    "86": {
+        "day": "CloudSnow2",
+        "night": "CloudSnow2"
+    },
+    "95": {
+        "day": "CloudThunder",
+        "night": "CloudThunder"
+    },
+    "96": {
+        "day": "CloudThunderRain",
+        "night": "CloudThunderRain"
+    },
+    "99": {
+        "day": "CloudThunder",
+        "night": "CloudThunder"
+    }
+}

package/dist/wmo_4677/i18n.d.ts

@@ -0,0 +1,2 @@
+import type { DayPhase, Language, WMO4677Code } from "./types";
+export default function WMO4677I18n(language: Language, fallbackLanguage?: Language): (code: WMO4677Code, dayPhase?: DayPhase) => string | undefined;

package/dist/wmo_4677/i18n.js

@@ -0,0 +1,13 @@
+import { default as wmoEnDescription } from "./data/i18n/en.json" with { type: "json" };
+import { default as wmoEsDescription } from "./data/i18n/es.json" with { type: "json" };
+const DESCRIPTIONS_BY_LANGUAGE = {
+    en: wmoEnDescription,
+    es: wmoEsDescription,
+};
+export default function WMO4677I18n(language, fallbackLanguage = "en") {
+    return function getDescription(code, dayPhase = "day") {
+        return DESCRIPTIONS_BY_LANGUAGE[language][code]?.[dayPhase] ??
+            DESCRIPTIONS_BY_LANGUAGE[fallbackLanguage][code]?.[dayPhase] ??
+            undefined;
+    };
+}

package/dist/wmo_4677/icons/index.d.ts

@@ -0,0 +1,7 @@
+import openmeteo from "./openmeteo";
+import pixelarticons from "./pixelarticons";
+declare const _default: {
+    openmeteo: typeof openmeteo;
+    pixelarticons: typeof pixelarticons;
+};
+export default _default;

package/dist/wmo_4677/icons/index.js

@@ -0,0 +1,6 @@
+import openmeteo from "./openmeteo";
+import pixelarticons from "./pixelarticons";
+export default {
+    openmeteo,
+    pixelarticons,
+};

package/dist/wmo_4677/icons/openmeteo.d.ts

@@ -0,0 +1,2 @@
+import type { DayPhase, WMO4677Code } from "../types";
+export default function WMO4677OpenMeteoIcon(code: WMO4677Code, dayPhase?: DayPhase): string | undefined;

package/dist/wmo_4677/icons/openmeteo.js

@@ -0,0 +1,6 @@
+import { default as wmoOpenMeteoIcons } from "../data/icons/openmeteo.json" with {
+    type: "json"
+};
+export default function WMO4677OpenMeteoIcon(code, dayPhase = "day") {
+    return wmoOpenMeteoIcons[code]?.[dayPhase];
+}

package/dist/wmo_4677/icons/pixelarticons.d.ts

@@ -0,0 +1,2 @@
+import type { DayPhase, WMO4677Code } from "../types";
+export default function WMO4677PixelarticonsIcon(code: WMO4677Code, dayPhase?: DayPhase): string | undefined;

package/dist/wmo_4677/icons/pixelarticons.js

@@ -0,0 +1,6 @@
+import { default as wmoPixelarticonsIcons } from "../data/icons/pixelarticons.json" with {
+    type: "json"
+};
+export default function WMO4677PixelarticonsIcon(code, dayPhase = "day") {
+    return wmoPixelarticonsIcons[code]?.[dayPhase];
+}