@mharj/openweathermap 0.0.7 → 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,641 @@
+import { z } from 'zod';
+import { IOption, IResult } from '@luolapeikko/result-option';
+import { IAsyncCache } from '@luolapeikko/cache-types';
+import { Loadable } from '@luolapeikko/ts-common';
+
+/**
+ * @internal
+ */
+declare const dayIconListSchema: z.ZodEnum<["01d", "02d", "03d", "04d", "09d", "10d", "11d", "13d", "50d"]>;
+type DayIcon = z.infer<typeof dayIconListSchema>;
+/**
+ * @internal
+ */
+declare const nightIconListSchema: z.ZodEnum<["01n", "02n", "03n", "04n", "09n", "10n", "11n", "13n", "50n"]>;
+type NightIcon = z.infer<typeof nightIconListSchema>;
+/**
+ * @internal
+ */
+declare const iconSchema: z.ZodUnion<[z.ZodEnum<["01d", "02d", "03d", "04d", "09d", "10d", "11d", "13d", "50d"]>, z.ZodEnum<["01n", "02n", "03n", "04n", "09n", "10n", "11n", "13n", "50n"]>]>;
+type Icon = z.infer<typeof iconSchema>;
+
+declare const langCodes: readonly ["af", "al", "ar", "az", "bg", "ca", "cz", "da", "de", "el", "en", "eu", "fa", "fi", "fr", "gl", "he", "hi", "hr", "hu", "id", "it", "ja", "kr", "la", "lt", "mk", "no", "nl", "pl", "pt", "pt", "ro", "ru", "sv", "sk", "sl", "sp", "sr", "th", "tr", "ua", "vi", "zh_cn", "zh_tw", "zu"];
+declare const langCodeSchema: z.ZodEnum<["af", "al", "ar", "az", "bg", "ca", "cz", "da", "de", "el", "en", "eu", "fa", "fi", "fr", "gl", "he", "hi", "hr", "hu", "id", "it", "ja", "kr", "la", "lt", "mk", "no", "nl", "pl", "pt", "pt", "ro", "ru", "sv", "sk", "sl", "sp", "sr", "th", "tr", "ua", "vi", "zh_cn", "zh_tw", "zu"]>;
+type LangCode = z.infer<typeof langCodeSchema>;
+
+/**
+ * This is a list of weather ids, groups and descriptions from OpenWeatherMap API
+ */
+declare const weatherIdGroup: readonly [{
+    readonly id: 200;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_light_rain";
+}, {
+    readonly id: 201;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_rain";
+}, {
+    readonly id: 202;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_heavy_rain";
+}, {
+    readonly id: 210;
+    readonly group: "thunderstorm";
+    readonly description: "light_thunderstorm";
+}, {
+    readonly id: 211;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm";
+}, {
+    readonly id: 212;
+    readonly group: "thunderstorm";
+    readonly description: "heavy_thunderstorm";
+}, {
+    readonly id: 221;
+    readonly group: "thunderstorm";
+    readonly description: "ragged_thunderstorm";
+}, {
+    readonly id: 230;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_light_drizzle";
+}, {
+    readonly id: 231;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_drizzle";
+}, {
+    readonly id: 232;
+    readonly group: "thunderstorm";
+    readonly description: "thunderstorm_with_heavy_drizzle";
+}, {
+    readonly id: 300;
+    readonly group: "drizzle";
+    readonly description: "light_intensity_drizzle";
+}, {
+    readonly id: 301;
+    readonly group: "drizzle";
+    readonly description: "drizzle";
+}, {
+    readonly id: 302;
+    readonly group: "drizzle";
+    readonly description: "heavy_intensity_drizzle";
+}, {
+    readonly id: 310;
+    readonly group: "drizzle";
+    readonly description: "light_intensity_drizzle_rain";
+}, {
+    readonly id: 311;
+    readonly group: "drizzle";
+    readonly description: "drizzle_rain";
+}, {
+    readonly id: 312;
+    readonly group: "drizzle";
+    readonly description: "heavy_intensity_drizzle_rain";
+}, {
+    readonly id: 313;
+    readonly group: "drizzle";
+    readonly description: "shower_rain_and_drizzle";
+}, {
+    readonly id: 314;
+    readonly group: "drizzle";
+    readonly description: "heavy_shower_rain_and_drizzle";
+}, {
+    readonly id: 321;
+    readonly group: "drizzle";
+    readonly description: "shower_drizzle";
+}, {
+    readonly id: 500;
+    readonly group: "rain";
+    readonly description: "light_rain";
+}, {
+    readonly id: 501;
+    readonly group: "rain";
+    readonly description: "moderate_rain";
+}, {
+    readonly id: 502;
+    readonly group: "rain";
+    readonly description: "heavy_intensity_rain";
+}, {
+    readonly id: 503;
+    readonly group: "rain";
+    readonly description: "very_heavy_rain";
+}, {
+    readonly id: 504;
+    readonly group: "rain";
+    readonly description: "extreme_rain";
+}, {
+    readonly id: 511;
+    readonly group: "rain";
+    readonly description: "freezing_rain";
+}, {
+    readonly id: 520;
+    readonly group: "rain";
+    readonly description: "light_intensity_shower_rain";
+}, {
+    readonly id: 521;
+    readonly group: "rain";
+    readonly description: "shower_rain";
+}, {
+    readonly id: 522;
+    readonly group: "rain";
+    readonly description: "heavy_intensity_shower_rain";
+}, {
+    readonly id: 531;
+    readonly group: "rain";
+    readonly description: "ragged_shower_rain";
+}, {
+    readonly id: 600;
+    readonly group: "snow";
+    readonly description: "light_snow";
+}, {
+    readonly id: 601;
+    readonly group: "snow";
+    readonly description: "snow";
+}, {
+    readonly id: 602;
+    readonly group: "snow";
+    readonly description: "heavy_snow";
+}, {
+    readonly id: 611;
+    readonly group: "snow";
+    readonly description: "sleet";
+}, {
+    readonly id: 612;
+    readonly group: "snow";
+    readonly description: "light_shower_sleet";
+}, {
+    readonly id: 613;
+    readonly group: "snow";
+    readonly description: "shower_sleet";
+}, {
+    readonly id: 615;
+    readonly group: "snow";
+    readonly description: "light_rain_and_snow";
+}, {
+    readonly id: 616;
+    readonly group: "snow";
+    readonly description: "rain_and_snow";
+}, {
+    readonly id: 620;
+    readonly group: "snow";
+    readonly description: "light_shower_snow";
+}, {
+    readonly id: 621;
+    readonly group: "snow";
+    readonly description: "shower_snow";
+}, {
+    readonly id: 622;
+    readonly group: "snow";
+    readonly description: "heavy_shower_snow";
+}, {
+    readonly id: 701;
+    readonly group: "atmosphere";
+    readonly description: "mist";
+}, {
+    readonly id: 711;
+    readonly group: "atmosphere";
+    readonly description: "smoke";
+}, {
+    readonly id: 721;
+    readonly group: "atmosphere";
+    readonly description: "haze";
+}, {
+    readonly id: 731;
+    readonly group: "atmosphere";
+    readonly description: "sand_dust_whirls";
+}, {
+    readonly id: 741;
+    readonly group: "atmosphere";
+    readonly description: "fog";
+}, {
+    readonly id: 751;
+    readonly group: "atmosphere";
+    readonly description: "sand";
+}, {
+    readonly id: 761;
+    readonly group: "atmosphere";
+    readonly description: "dust";
+}, {
+    readonly id: 762;
+    readonly group: "atmosphere";
+    readonly description: "volcanic_ash";
+}, {
+    readonly id: 771;
+    readonly group: "atmosphere";
+    readonly description: "squalls";
+}, {
+    readonly id: 781;
+    readonly group: "atmosphere";
+    readonly description: "tornado";
+}, {
+    readonly id: 800;
+    readonly group: "clear";
+    readonly description: "clear_sky";
+}, {
+    readonly id: 801;
+    readonly group: "clouds";
+    readonly description: "few_clouds_11-25_percent";
+}, {
+    readonly id: 802;
+    readonly group: "clouds";
+    readonly description: "scattered_clouds_25-50_percent";
+}, {
+    readonly id: 803;
+    readonly group: "clouds";
+    readonly description: "broken_clouds_51-84_percent";
+}, {
+    readonly id: 804;
+    readonly group: "clouds";
+    readonly description: "overcast_clouds_85-100_percent";
+}];
+type WeatherID = (typeof weatherIdGroup)[number]['id'];
+/**
+ * WeatherGroup:  "clouds" | "rain" | "snow" | "thunderstorm" | "drizzle" | "atmosphere" | "clear"
+ */
+type WeatherGroup = (typeof weatherIdGroup)[number]['group'];
+/**
+ * List for weather description key types from OpenWeatherMap API based on weather id.
+ *
+ * This list of keys can be used to translate weather id to human readable description with different languages.
+ * @example
+ * const i18Weather: Record<WeatherDescription, string> = {
+ *  clear_sky: 'Clear sky',
+ *  ...
+ * }
+ */
+type WeatherDescription = (typeof weatherIdGroup)[number]['description'];
+/**
+ * Weather id schema
+ * @internal
+ */
+declare const weatherIdSchema: z.ZodType<200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804, z.ZodTypeDef, 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804>;
+/**
+ * get weather description key from weather id
+ * @param id - weather id
+ * @returns {Option<WeatherDescription>}  option for weather description key
+ * @example
+ * const weatherComponent = ({data}) => {
+ *   const key = getWeatherV2Description(data.weather[0]?.id).unwrapOr('unknown');
+ *   return (
+ *     <div>
+ *       {t(`weather:${key}`}
+ *     </div>
+ *   );
+ * }
+ */
+declare function getWeatherV2Description(id: WeatherID | undefined): IOption<WeatherDescription>;
+
+/**
+ * @internal
+ */
+declare const weatherDataV2Schema: z.ZodObject<{
+    base: z.ZodString;
+    clouds: z.ZodObject<{
+        all: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        all: number;
+    }, {
+        all: number;
+    }>;
+    cod: z.ZodNumber;
+    coord: z.ZodObject<{
+        lon: z.ZodNumber;
+        lat: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        lon: number;
+        lat: number;
+    }, {
+        lon: number;
+        lat: number;
+    }>;
+    dt: z.ZodNumber;
+    id: z.ZodNumber;
+    main: z.ZodObject<{
+        grnd_level: z.ZodOptional<z.ZodNumber>;
+        humidity: z.ZodNumber;
+        pressure: z.ZodNumber;
+        sea_level: z.ZodOptional<z.ZodNumber>;
+        temp: z.ZodNumber;
+        temp_max: z.ZodNumber;
+        temp_min: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        humidity: number;
+        pressure: number;
+        temp: number;
+        temp_max: number;
+        temp_min: number;
+        grnd_level?: number | undefined;
+        sea_level?: number | undefined;
+    }, {
+        humidity: number;
+        pressure: number;
+        temp: number;
+        temp_max: number;
+        temp_min: number;
+        grnd_level?: number | undefined;
+        sea_level?: number | undefined;
+    }>;
+    name: z.ZodString;
+    rain: z.ZodOptional<z.ZodObject<{
+        '1h': z.ZodOptional<z.ZodNumber>;
+        '3h': z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    }, {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    }>>;
+    snow: z.ZodOptional<z.ZodObject<{
+        '1h': z.ZodOptional<z.ZodNumber>;
+        '3h': z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    }, {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    }>>;
+    sys: z.ZodObject<{
+        country: z.ZodString;
+        id: z.ZodOptional<z.ZodNumber>;
+        message: z.ZodOptional<z.ZodNumber>;
+        sunrise: z.ZodNumber;
+        sunset: z.ZodNumber;
+        type: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        country: string;
+        sunrise: number;
+        sunset: number;
+        message?: number | undefined;
+        type?: number | undefined;
+        id?: number | undefined;
+    }, {
+        country: string;
+        sunrise: number;
+        sunset: number;
+        message?: number | undefined;
+        type?: number | undefined;
+        id?: number | undefined;
+    }>;
+    timezone: z.ZodNumber;
+    visibility: z.ZodNumber;
+    weather: z.ZodArray<z.ZodObject<{
+        description: z.ZodString;
+        icon: z.ZodUnion<[z.ZodEnum<["01d", "02d", "03d", "04d", "09d", "10d", "11d", "13d", "50d"]>, z.ZodEnum<["01n", "02n", "03n", "04n", "09n", "10n", "11n", "13n", "50n"]>]>;
+        id: z.ZodType<200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804, z.ZodTypeDef, 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804>;
+        main: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804;
+        description: string;
+        icon: "01d" | "02d" | "03d" | "04d" | "09d" | "10d" | "11d" | "13d" | "50d" | "01n" | "02n" | "03n" | "04n" | "09n" | "10n" | "11n" | "13n" | "50n";
+        main: string;
+    }, {
+        id: 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804;
+        description: string;
+        icon: "01d" | "02d" | "03d" | "04d" | "09d" | "10d" | "11d" | "13d" | "50d" | "01n" | "02n" | "03n" | "04n" | "09n" | "10n" | "11n" | "13n" | "50n";
+        main: string;
+    }>, "many">;
+    wind: z.ZodObject<{
+        speed: z.ZodNumber;
+        deg: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        speed: number;
+        deg: number;
+    }, {
+        speed: number;
+        deg: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    clouds: {
+        all: number;
+    };
+    id: number;
+    main: {
+        humidity: number;
+        pressure: number;
+        temp: number;
+        temp_max: number;
+        temp_min: number;
+        grnd_level?: number | undefined;
+        sea_level?: number | undefined;
+    };
+    base: string;
+    cod: number;
+    coord: {
+        lon: number;
+        lat: number;
+    };
+    dt: number;
+    name: string;
+    sys: {
+        country: string;
+        sunrise: number;
+        sunset: number;
+        message?: number | undefined;
+        type?: number | undefined;
+        id?: number | undefined;
+    };
+    timezone: number;
+    visibility: number;
+    weather: {
+        id: 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804;
+        description: string;
+        icon: "01d" | "02d" | "03d" | "04d" | "09d" | "10d" | "11d" | "13d" | "50d" | "01n" | "02n" | "03n" | "04n" | "09n" | "10n" | "11n" | "13n" | "50n";
+        main: string;
+    }[];
+    wind: {
+        speed: number;
+        deg: number;
+    };
+    rain?: {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    } | undefined;
+    snow?: {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    } | undefined;
+}, {
+    clouds: {
+        all: number;
+    };
+    id: number;
+    main: {
+        humidity: number;
+        pressure: number;
+        temp: number;
+        temp_max: number;
+        temp_min: number;
+        grnd_level?: number | undefined;
+        sea_level?: number | undefined;
+    };
+    base: string;
+    cod: number;
+    coord: {
+        lon: number;
+        lat: number;
+    };
+    dt: number;
+    name: string;
+    sys: {
+        country: string;
+        sunrise: number;
+        sunset: number;
+        message?: number | undefined;
+        type?: number | undefined;
+        id?: number | undefined;
+    };
+    timezone: number;
+    visibility: number;
+    weather: {
+        id: 200 | 201 | 202 | 210 | 211 | 212 | 221 | 230 | 231 | 232 | 300 | 301 | 302 | 310 | 311 | 312 | 313 | 314 | 321 | 500 | 501 | 502 | 503 | 504 | 511 | 520 | 521 | 522 | 531 | 600 | 601 | 602 | 611 | 612 | 613 | 615 | 616 | 620 | 621 | 622 | 701 | 711 | 721 | 731 | 741 | 751 | 761 | 762 | 771 | 781 | 800 | 801 | 802 | 803 | 804;
+        description: string;
+        icon: "01d" | "02d" | "03d" | "04d" | "09d" | "10d" | "11d" | "13d" | "50d" | "01n" | "02n" | "03n" | "04n" | "09n" | "10n" | "11n" | "13n" | "50n";
+        main: string;
+    }[];
+    wind: {
+        speed: number;
+        deg: number;
+    };
+    rain?: {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    } | undefined;
+    snow?: {
+        '1h'?: number | undefined;
+        '3h'?: number | undefined;
+    } | undefined;
+}>;
+type WeatherDataV2 = z.infer<typeof weatherDataV2Schema>;
+declare function isWeatherDataV2(data: unknown): data is WeatherDataV2;
+declare function assertWeatherDataV2(data: unknown): asserts data is WeatherDataV2;
+
+declare const CountryCodeList: readonly ["af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mk", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "sz", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "us", "um", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw"];
+/**
+ * @internal
+ */
+declare const CountryCodeSchema: z.ZodEnum<["af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mk", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "sz", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "us", "um", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw"]>;
+type CountryCode = z.infer<typeof CountryCodeSchema>;
+
+/**
+ * Interface for OpenWeatherMap API v2 implementation.
+ */
+interface IOpenWeatherV2 {
+    dataWeatherApi: (params: URLSearchParams) => Promise<IResult<WeatherDataV2, SyntaxError | TypeError>>;
+}
+
+/**
+ * Open Weather V2 API Common Options
+ * @default {lang: 'en', units: 'standard'} in API
+ * @example
+ * {lang: 'fi', units: 'metric'}
+ * @since v0.0.1
+ */
+type OpenWeatherV2CommonOptions = {
+    /**
+     * Language code
+     */
+    lang: LangCode;
+    /**
+     * Weather units
+     */
+    units: 'standard' | 'metric' | 'imperial';
+};
+/**
+ * Open Weather V2 API
+ * @example
+ * const weather = new OpenWeatherV2('your-api-key');
+ *
+ * const cache = new ExpireCache<WeatherDataV2>(undefined, undefined, 900000); // data 15 minutes in cache
+ * const weather = new OpenWeatherV2(() => Promise.resolve('your-api-key'), cache);
+ *
+ * const data: WeatherDataV2 = (await weather.getWeatherById(2643743)).unwrap(); // throws if error
+ * const data: WeatherDataV2 | undefined = (await weather.getWeatherByCity('Helsinki', 'fi')).ok();
+ *
+ * const result: Result<WeatherDataV2> = await weather.getWeatherByLatLon(60.1699, 24.9384);
+ * result.match({
+ *  Ok: (data: WeatherDataV2) => console.log(data),
+ *  Err: (err: DOMException | TypeError) => console.error(err),
+ * });
+ *
+ * if(result.isOk) {
+ *   const data: WeatherDataV2 = data.ok();
+ * } else {
+ *   const err: DOMException | TypeError = data.err();
+ * }
+ * @since v0.0.1
+ */
+declare class OpenWeatherV2 {
+    private cache;
+    private loadableApiKey;
+    private apiHandler;
+    private fetchPromiseMap;
+    /**
+     * OpenWeatherV2 constructor
+     * @param {Loadable<string>} loadableApiKey - Loadable API key
+     * @param {ICacheOrAsync<WeatherDataV2>=} cache - optional async cache implementation
+     * @param {IOpenWeatherV2=} apiHandler - optional API handler implementation for mocking
+     */
+    constructor(loadableApiKey: Loadable<string>, cache?: IAsyncCache<WeatherDataV2>, apiHandler?: IOpenWeatherV2);
+    /**
+     * get weather by Id
+     * @param {number} id       - Weather station ID
+     * @param {OpenWeatherV2CommonOptions=} currentOpts - Common options, example ```{lang: 'fi', units: 'metric'}```, defaults ```{lang: 'en', units: 'standard'}```
+     * @return {Promise<Result<WeatherDataV2, DOMException | TypeError>>} Weather data Result Promise
+     * @example
+     * const result: Result<WeatherDataV2, DOMException | TypeError> = await weather.getWeatherResultById(id: 564, {lang: 'fi'});
+     * if (result.isOk) {
+     *   const weatherData: WeatherDataV2 = result.ok();
+     * } else {
+     *   const error: DOMException | TypeError = result.err();
+     * }
+     */
+    getWeatherById(id: number, currentOpts?: Partial<OpenWeatherV2CommonOptions>): Promise<IResult<WeatherDataV2, DOMException | TypeError>>;
+    /**
+     * get weather with city name and optional country code
+     * @param {string} city       - City name
+     * @param {countryCode=} countryCode       - Optional Country code
+     * @param {OpenWeatherV2CommonOptions=} currentOpts - Common options, example ```{lang: 'fi', units: 'metric'}```, defaults ```{lang: 'en', units: 'standard'}```
+     * @return {Promise<Result<WeatherDataV2, DOMException | TypeError>>} Weather data Result Promise
+     * @example
+     * const result: Result<WeatherDataV2, DOMException | TypeError> = await weather.getWeatherByCity('Helsinki', 'fi', {lang: 'fi'});
+     * if (result.isOk) {
+     *   const weatherData: WeatherDataV2 = result.ok();
+     * } else {
+     *   const error: DOMException | TypeError = result.err();
+     * }
+     */
+    getWeatherByCity(city: string, countryCode?: CountryCode, currentOpts?: Partial<OpenWeatherV2CommonOptions>): Promise<IResult<WeatherDataV2, DOMException | TypeError>>;
+    /**
+     * get weather with latitude and longitude with Result
+     * @param {number} lat       - Latitude
+     * @param {number} lon       - Longitude
+     * @param {OpenWeatherV2CommonOptions=} currentOpts - Common options, example ```{lang: 'fi', units: 'metric'}```, defaults ```{lang: 'en', units: 'standard'}```
+     * @return {Promise<Result<WeatherDataV2, DOMException | TypeError>>} Weather data Result Promise
+     * @example
+     * const result: Result<WeatherDataV2, DOMException | TypeError> = await weather.getWeatherByLatLon(60.1699, 24.9384, {lang: 'fi'});
+     * if (result.isOk) {
+     *   const weatherData: WeatherDataV2 = result.ok();
+     * } else {
+     *   const error: DOMException | TypeError = result.err();
+     * }
+     */
+    getWeatherByLatLon(lat: number, lon: number, currentOpts?: Partial<OpenWeatherV2CommonOptions>): Promise<IResult<WeatherDataV2, DOMException | TypeError>>;
+    private buildBaseParams;
+    /**
+     * build base cache key
+     * @param main - main cache key prefix
+     * @param opts -  OpenWeatherV2CommonOptions
+     * @returns {string} cache key
+     */
+    private buildBaseCacheKey;
+    private handleFetch;
+}
+
+/**
+ * Ensures that the error is a DOMException or TypeError.
+ * @internal
+ */
+declare function fetchErrorWrapper(err: unknown): DOMException | TypeError;
+
+export { type CountryCode, CountryCodeList, CountryCodeSchema, type DayIcon, type IOpenWeatherV2, type Icon, type LangCode, type NightIcon, OpenWeatherV2, type OpenWeatherV2CommonOptions, type WeatherDataV2, type WeatherDescription, type WeatherGroup, type WeatherID, assertWeatherDataV2, fetchErrorWrapper, getWeatherV2Description, iconSchema, isWeatherDataV2, langCodeSchema, langCodes, weatherDataV2Schema, weatherIdGroup, weatherIdSchema };