@mharj/openweathermap 0.0.1

package/dist/types/v2/index.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertWeatherDataV2 = exports.isWeatherDataV2 = exports.weatherDataV2Schema = void 0;
+const tslib_1 = require("tslib");
+const Icon_1 = require("./Icon");
+const weatherIdGroup_1 = require("./weatherIdGroup");
+const zod_1 = require("zod");
+tslib_1.__exportStar(require("./Icon"), exports);
+tslib_1.__exportStar(require("./Language"), exports);
+tslib_1.__exportStar(require("./weatherIdGroup"), exports);
+const coordSchema = zod_1.z.object({
+    lon: zod_1.z.number(),
+    lat: zod_1.z.number(),
+});
+const weatherSchema = zod_1.z.object({
+    description: zod_1.z.string(),
+    icon: Icon_1.iconSchema,
+    id: weatherIdGroup_1.weatherIdSchema,
+    main: zod_1.z.string(),
+});
+const mainSchema = zod_1.z.object({
+    grnd_level: zod_1.z.number().optional(),
+    humidity: zod_1.z.number(),
+    pressure: zod_1.z.number(),
+    sea_level: zod_1.z.number().optional(),
+    temp: zod_1.z.number(),
+    temp_max: zod_1.z.number(),
+    temp_min: zod_1.z.number(),
+});
+const windSchema = zod_1.z.object({
+    speed: zod_1.z.number(),
+    deg: zod_1.z.number(),
+});
+const rainSchema = zod_1.z.object({
+    '1h': zod_1.z.number(),
+    '3h': zod_1.z.number(),
+});
+const snowSchema = zod_1.z.object({
+    '1h': zod_1.z.number(),
+    '3h': zod_1.z.number(),
+});
+const sysSchema = zod_1.z.object({
+    country: zod_1.z.string(),
+    id: zod_1.z.number(),
+    message: zod_1.z.number().optional(),
+    sunrise: zod_1.z.number(),
+    sunset: zod_1.z.number(),
+    type: zod_1.z.number(),
+});
+/**
+ * @internal
+ */
+exports.weatherDataV2Schema = zod_1.z.object({
+    base: zod_1.z.string(),
+    clouds: zod_1.z.object({
+        all: zod_1.z.number(),
+    }),
+    cod: zod_1.z.number(),
+    coord: coordSchema,
+    dt: zod_1.z.number(),
+    id: zod_1.z.number(),
+    main: mainSchema,
+    name: zod_1.z.string(),
+    rain: rainSchema.optional(),
+    snow: snowSchema.optional(),
+    sys: sysSchema,
+    timezone: zod_1.z.number(),
+    visibility: zod_1.z.number(),
+    weather: zod_1.z.array(weatherSchema),
+    wind: windSchema,
+});
+function isWeatherDataV2(data) {
+    return exports.weatherDataV2Schema.safeParse(data).success;
+}
+exports.isWeatherDataV2 = isWeatherDataV2;
+function assertWeatherDataV2(data) {
+    exports.weatherDataV2Schema.parse(data);
+}
+exports.assertWeatherDataV2 = assertWeatherDataV2;
+//# sourceMappingURL=index.js.map

package/dist/types/v2/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./src/","sources":["types/v2/index.ts"],"names":[],"mappings":";;;;AAAA,iCAAkC;AAClC,qDAAiD;AACjD,6BAAsB;AACtB,iDAAuB;AACvB,qDAA2B;AAC3B,2DAAiC;AAEjC,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,IAAI,EAAE,iBAAU;IAChB,EAAE,EAAE,gCAAe;IACnB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;QAChB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;KACf,CAAC;IACF,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,WAAW;IAClB,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;IACd,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,SAAS;IACd,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,aAAa,CAAC;IAC/B,IAAI,EAAE,UAAU;CAChB,CAAC,CAAC;AAIH,SAAgB,eAAe,CAAC,IAAa;IAC5C,OAAO,2BAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;AACpD,CAAC;AAFD,0CAEC;AAED,SAAgB,mBAAmB,CAAC,IAAa;IAChD,2BAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAFD,kDAEC","sourcesContent":["import {iconSchema} from './Icon';\nimport {weatherIdSchema} from './weatherIdGroup';\nimport {z} from 'zod';\nexport * from './Icon';\nexport * from './Language';\nexport * from './weatherIdGroup';\n\nconst coordSchema = z.object({\n\tlon: z.number(),\n\tlat: z.number(),\n});\n\nconst weatherSchema = z.object({\n\tdescription: z.string(),\n\ticon: iconSchema,\n\tid: weatherIdSchema,\n\tmain: z.string(),\n});\n\nconst mainSchema = z.object({\n\tgrnd_level: z.number().optional(),\n\thumidity: z.number(),\n\tpressure: z.number(),\n\tsea_level: z.number().optional(),\n\ttemp: z.number(),\n\ttemp_max: z.number(),\n\ttemp_min: z.number(),\n});\n\nconst windSchema = z.object({\n\tspeed: z.number(),\n\tdeg: z.number(),\n});\n\nconst rainSchema = z.object({\n\t'1h': z.number(),\n\t'3h': z.number(),\n});\n\nconst snowSchema = z.object({\n\t'1h': z.number(),\n\t'3h': z.number(),\n});\n\nconst sysSchema = z.object({\n\tcountry: z.string(),\n\tid: z.number(),\n\tmessage: z.number().optional(),\n\tsunrise: z.number(),\n\tsunset: z.number(),\n\ttype: z.number(),\n});\n\n/**\n * @internal\n */\nexport const weatherDataV2Schema = z.object({\n\tbase: z.string(),\n\tclouds: z.object({\n\t\tall: z.number(),\n\t}),\n\tcod: z.number(),\n\tcoord: coordSchema,\n\tdt: z.number(),\n\tid: z.number(),\n\tmain: mainSchema,\n\tname: z.string(),\n\train: rainSchema.optional(),\n\tsnow: snowSchema.optional(),\n\tsys: sysSchema,\n\ttimezone: z.number(),\n\tvisibility: z.number(),\n\tweather: z.array(weatherSchema),\n\twind: windSchema,\n});\n\nexport type WeatherDataV2 = z.infer<typeof weatherDataV2Schema>;\n\nexport function isWeatherDataV2(data: unknown): data is WeatherDataV2 {\n\treturn weatherDataV2Schema.safeParse(data).success;\n}\n\nexport function assertWeatherDataV2(data: unknown): asserts data is WeatherDataV2 {\n\tweatherDataV2Schema.parse(data);\n}\n"]}

package/dist/types/v2/weatherIdGroup.d.ts

@@ -0,0 +1,262 @@
+import { Option } from 'mharj-result';
+import { z } from 'zod';
+/**
+ * This is a list of weather ids, groups and descriptions from OpenWeatherMap API
+ */
+export 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";
+}];
+export type WeatherID = (typeof weatherIdGroup)[number]['id'];
+/**
+ * WeatherGroup:  "clouds" | "rain" | "snow" | "thunderstorm" | "drizzle" | "atmosphere" | "clear"
+ */
+export 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',
+ *  ...
+ * }
+ */
+export type WeatherDescription = (typeof weatherIdGroup)[number]['description'];
+/**
+ * Weather id schema
+ * @internal
+ */
+export declare const weatherIdSchema: z.ZodType<771 | 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 | 781 | 800 | 801 | 802 | 803 | 804, z.ZodTypeDef, 771 | 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 | 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>
+ *   );
+ * }
+ */
+export declare function getWeatherV2Description(id: WeatherID | undefined): Option<WeatherDescription>;

package/dist/types/v2/weatherIdGroup.js

@@ -0,0 +1,317 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWeatherV2Description = exports.weatherIdSchema = exports.weatherIdGroup = void 0;
+const mharj_result_1 = require("mharj-result");
+const zod_1 = require("zod");
+/**
+ * This is a list of weather ids, groups and descriptions from OpenWeatherMap API
+ */
+exports.weatherIdGroup = [
+    {
+        id: 200,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_light_rain',
+    },
+    {
+        id: 201,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_rain',
+    },
+    {
+        id: 202,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_heavy_rain',
+    },
+    {
+        id: 210,
+        group: 'thunderstorm',
+        description: 'light_thunderstorm',
+    },
+    {
+        id: 211,
+        group: 'thunderstorm',
+        description: 'thunderstorm',
+    },
+    {
+        id: 212,
+        group: 'thunderstorm',
+        description: 'heavy_thunderstorm',
+    },
+    {
+        id: 221,
+        group: 'thunderstorm',
+        description: 'ragged_thunderstorm',
+    },
+    {
+        id: 230,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_light_drizzle',
+    },
+    {
+        id: 231,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_drizzle',
+    },
+    {
+        id: 232,
+        group: 'thunderstorm',
+        description: 'thunderstorm_with_heavy_drizzle',
+    },
+    {
+        id: 300,
+        group: 'drizzle',
+        description: 'light_intensity_drizzle',
+    },
+    {
+        id: 301,
+        group: 'drizzle',
+        description: 'drizzle',
+    },
+    {
+        id: 302,
+        group: 'drizzle',
+        description: 'heavy_intensity_drizzle',
+    },
+    {
+        id: 310,
+        group: 'drizzle',
+        description: 'light_intensity_drizzle_rain',
+    },
+    {
+        id: 311,
+        group: 'drizzle',
+        description: 'drizzle_rain',
+    },
+    {
+        id: 312,
+        group: 'drizzle',
+        description: 'heavy_intensity_drizzle_rain',
+    },
+    {
+        id: 313,
+        group: 'drizzle',
+        description: 'shower_rain_and_drizzle',
+    },
+    {
+        id: 314,
+        group: 'drizzle',
+        description: 'heavy_shower_rain_and_drizzle',
+    },
+    {
+        id: 321,
+        group: 'drizzle',
+        description: 'shower_drizzle',
+    },
+    {
+        id: 500,
+        group: 'rain',
+        description: 'light_rain',
+    },
+    {
+        id: 501,
+        group: 'rain',
+        description: 'moderate_rain',
+    },
+    {
+        id: 502,
+        group: 'rain',
+        description: 'heavy_intensity_rain',
+    },
+    {
+        id: 503,
+        group: 'rain',
+        description: 'very_heavy_rain',
+    },
+    {
+        id: 504,
+        group: 'rain',
+        description: 'extreme_rain',
+    },
+    {
+        id: 511,
+        group: 'rain',
+        description: 'freezing_rain',
+    },
+    {
+        id: 520,
+        group: 'rain',
+        description: 'light_intensity_shower_rain',
+    },
+    {
+        id: 521,
+        group: 'rain',
+        description: 'shower_rain',
+    },
+    {
+        id: 522,
+        group: 'rain',
+        description: 'heavy_intensity_shower_rain',
+    },
+    {
+        id: 531,
+        group: 'rain',
+        description: 'ragged_shower_rain',
+    },
+    {
+        id: 600,
+        group: 'snow',
+        description: 'light_snow',
+    },
+    {
+        id: 601,
+        group: 'snow',
+        description: 'snow',
+    },
+    {
+        id: 602,
+        group: 'snow',
+        description: 'heavy_snow',
+    },
+    {
+        id: 611,
+        group: 'snow',
+        description: 'sleet',
+    },
+    {
+        id: 612,
+        group: 'snow',
+        description: 'light_shower_sleet',
+    },
+    {
+        id: 613,
+        group: 'snow',
+        description: 'shower_sleet',
+    },
+    {
+        id: 615,
+        group: 'snow',
+        description: 'light_rain_and_snow',
+    },
+    {
+        id: 616,
+        group: 'snow',
+        description: 'rain_and_snow',
+    },
+    {
+        id: 620,
+        group: 'snow',
+        description: 'light_shower_snow',
+    },
+    {
+        id: 621,
+        group: 'snow',
+        description: 'shower_snow',
+    },
+    {
+        id: 622,
+        group: 'snow',
+        description: 'heavy_shower_snow',
+    },
+    {
+        id: 701,
+        group: 'atmosphere',
+        description: 'mist',
+    },
+    {
+        id: 711,
+        group: 'atmosphere',
+        description: 'smoke',
+    },
+    {
+        id: 721,
+        group: 'atmosphere',
+        description: 'haze',
+    },
+    {
+        id: 731,
+        group: 'atmosphere',
+        description: 'sand_dust_whirls',
+    },
+    {
+        id: 741,
+        group: 'atmosphere',
+        description: 'fog',
+    },
+    {
+        id: 751,
+        group: 'atmosphere',
+        description: 'sand',
+    },
+    {
+        id: 761,
+        group: 'atmosphere',
+        description: 'dust',
+    },
+    {
+        id: 762,
+        group: 'atmosphere',
+        description: 'volcanic_ash',
+    },
+    {
+        id: 771,
+        group: 'atmosphere',
+        description: 'squalls',
+    },
+    {
+        id: 781,
+        group: 'atmosphere',
+        description: 'tornado',
+    },
+    {
+        id: 800,
+        group: 'clear',
+        description: 'clear_sky',
+    },
+    {
+        id: 801,
+        group: 'clouds',
+        description: 'few_clouds_11-25_percent',
+    },
+    {
+        id: 802,
+        group: 'clouds',
+        description: 'scattered_clouds_25-50_percent',
+    },
+    {
+        id: 803,
+        group: 'clouds',
+        description: 'broken_clouds_51-84_percent',
+    },
+    {
+        id: 804,
+        group: 'clouds',
+        description: 'overcast_clouds_85-100_percent',
+    },
+];
+/**
+ * Weather id schema
+ * @internal
+ */
+exports.weatherIdSchema = zod_1.z.custom((val) => {
+    if (typeof val !== 'number') {
+        return { message: 'Expected a number', success: false };
+    }
+    if (!exports.weatherIdGroup.find((x) => x.id === val)) {
+        return { message: 'Expected a valid weather id', success: false };
+    }
+    return val;
+});
+/**
+ * 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>
+ *   );
+ * }
+ */
+function getWeatherV2Description(id) {
+    return (0, mharj_result_1.undefinedOptionWrap)(exports.weatherIdGroup.find((x) => x.id === id)?.description);
+}
+exports.getWeatherV2Description = getWeatherV2Description;
+//# sourceMappingURL=weatherIdGroup.js.map

package/dist/types/v2/weatherIdGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weatherIdGroup.js","sourceRoot":"./src/","sources":["types/v2/weatherIdGroup.ts"],"names":[],"mappings":";;;AAAA,+CAAyD;AACzD,6BAAsB;AAEtB;;GAEG;AACU,QAAA,cAAc,GAAG;IAC7B;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,8BAA8B;KAC3C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,wBAAwB;KACrC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,8BAA8B;KAC3C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,oBAAoB;KACjC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,cAAc;KAC3B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,oBAAoB;KACjC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,qBAAqB;KAClC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,iCAAiC;KAC9C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,2BAA2B;KACxC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,iCAAiC;KAC9C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,yBAAyB;KACtC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,SAAS;KACtB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,yBAAyB;KACtC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,8BAA8B;KAC3C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,cAAc;KAC3B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,8BAA8B;KAC3C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,yBAAyB;KACtC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,+BAA+B;KAC5C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,gBAAgB;KAC7B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,YAAY;KACzB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,eAAe;KAC5B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,sBAAsB;KACnC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,iBAAiB;KAC9B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,cAAc;KAC3B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,eAAe;KAC5B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,6BAA6B;KAC1C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,aAAa;KAC1B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,6BAA6B;KAC1C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,oBAAoB;KACjC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,YAAY;KACzB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,MAAM;KACnB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,YAAY;KACzB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,OAAO;KACpB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,oBAAoB;KACjC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,cAAc;KAC3B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,qBAAqB;KAClC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,eAAe;KAC5B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,mBAAmB;KAChC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,aAAa;KAC1B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,mBAAmB;KAChC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,MAAM;KACnB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,OAAO;KACpB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,MAAM;KACnB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,kBAAkB;KAC/B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,KAAK;KAClB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,MAAM;KACnB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,MAAM;KACnB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,cAAc;KAC3B;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,SAAS;KACtB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,SAAS;KACtB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,OAAO;QACd,WAAW,EAAE,WAAW;KACxB;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,0BAA0B;KACvC;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,gCAAgC;KAC7C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,6BAA6B;KAC1C;IACD;QACC,EAAE,EAAE,GAAG;QACP,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,gCAAgC;KAC7C;CACQ,CAAC;AAqBX;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAY,CAAC,GAAG,EAAE,EAAE;IAC1D,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC5B,OAAO,EAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,KAAK,EAAC,CAAC;KACtD;IACD,IAAI,CAAC,sBAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE;QAC9C,OAAO,EAAC,OAAO,EAAE,6BAA6B,EAAE,OAAO,EAAE,KAAK,EAAC,CAAC;KAChE;IACD,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,SAAgB,uBAAuB,CAAC,EAAyB;IAChE,OAAO,IAAA,kCAAmB,EAAC,sBAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC;AAClF,CAAC;AAFD,0DAEC","sourcesContent":["import {Option, undefinedOptionWrap} from 'mharj-result';\nimport {z} from 'zod';\n\n/**\n * This is a list of weather ids, groups and descriptions from OpenWeatherMap API\n */\nexport const weatherIdGroup = [\n\t{\n\t\tid: 200,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_light_rain',\n\t},\n\t{\n\t\tid: 201,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_rain',\n\t},\n\t{\n\t\tid: 202,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_heavy_rain',\n\t},\n\t{\n\t\tid: 210,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'light_thunderstorm',\n\t},\n\t{\n\t\tid: 211,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm',\n\t},\n\t{\n\t\tid: 212,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'heavy_thunderstorm',\n\t},\n\t{\n\t\tid: 221,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'ragged_thunderstorm',\n\t},\n\t{\n\t\tid: 230,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_light_drizzle',\n\t},\n\t{\n\t\tid: 231,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_drizzle',\n\t},\n\t{\n\t\tid: 232,\n\t\tgroup: 'thunderstorm',\n\t\tdescription: 'thunderstorm_with_heavy_drizzle',\n\t},\n\t{\n\t\tid: 300,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'light_intensity_drizzle',\n\t},\n\t{\n\t\tid: 301,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'drizzle',\n\t},\n\t{\n\t\tid: 302,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'heavy_intensity_drizzle',\n\t},\n\t{\n\t\tid: 310,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'light_intensity_drizzle_rain',\n\t},\n\t{\n\t\tid: 311,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'drizzle_rain',\n\t},\n\t{\n\t\tid: 312,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'heavy_intensity_drizzle_rain',\n\t},\n\t{\n\t\tid: 313,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'shower_rain_and_drizzle',\n\t},\n\t{\n\t\tid: 314,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'heavy_shower_rain_and_drizzle',\n\t},\n\t{\n\t\tid: 321,\n\t\tgroup: 'drizzle',\n\t\tdescription: 'shower_drizzle',\n\t},\n\t{\n\t\tid: 500,\n\t\tgroup: 'rain',\n\t\tdescription: 'light_rain',\n\t},\n\t{\n\t\tid: 501,\n\t\tgroup: 'rain',\n\t\tdescription: 'moderate_rain',\n\t},\n\t{\n\t\tid: 502,\n\t\tgroup: 'rain',\n\t\tdescription: 'heavy_intensity_rain',\n\t},\n\t{\n\t\tid: 503,\n\t\tgroup: 'rain',\n\t\tdescription: 'very_heavy_rain',\n\t},\n\t{\n\t\tid: 504,\n\t\tgroup: 'rain',\n\t\tdescription: 'extreme_rain',\n\t},\n\t{\n\t\tid: 511,\n\t\tgroup: 'rain',\n\t\tdescription: 'freezing_rain',\n\t},\n\t{\n\t\tid: 520,\n\t\tgroup: 'rain',\n\t\tdescription: 'light_intensity_shower_rain',\n\t},\n\t{\n\t\tid: 521,\n\t\tgroup: 'rain',\n\t\tdescription: 'shower_rain',\n\t},\n\t{\n\t\tid: 522,\n\t\tgroup: 'rain',\n\t\tdescription: 'heavy_intensity_shower_rain',\n\t},\n\t{\n\t\tid: 531,\n\t\tgroup: 'rain',\n\t\tdescription: 'ragged_shower_rain',\n\t},\n\t{\n\t\tid: 600,\n\t\tgroup: 'snow',\n\t\tdescription: 'light_snow',\n\t},\n\t{\n\t\tid: 601,\n\t\tgroup: 'snow',\n\t\tdescription: 'snow',\n\t},\n\t{\n\t\tid: 602,\n\t\tgroup: 'snow',\n\t\tdescription: 'heavy_snow',\n\t},\n\t{\n\t\tid: 611,\n\t\tgroup: 'snow',\n\t\tdescription: 'sleet',\n\t},\n\t{\n\t\tid: 612,\n\t\tgroup: 'snow',\n\t\tdescription: 'light_shower_sleet',\n\t},\n\t{\n\t\tid: 613,\n\t\tgroup: 'snow',\n\t\tdescription: 'shower_sleet',\n\t},\n\t{\n\t\tid: 615,\n\t\tgroup: 'snow',\n\t\tdescription: 'light_rain_and_snow',\n\t},\n\t{\n\t\tid: 616,\n\t\tgroup: 'snow',\n\t\tdescription: 'rain_and_snow',\n\t},\n\t{\n\t\tid: 620,\n\t\tgroup: 'snow',\n\t\tdescription: 'light_shower_snow',\n\t},\n\t{\n\t\tid: 621,\n\t\tgroup: 'snow',\n\t\tdescription: 'shower_snow',\n\t},\n\t{\n\t\tid: 622,\n\t\tgroup: 'snow',\n\t\tdescription: 'heavy_shower_snow',\n\t},\n\t{\n\t\tid: 701,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'mist',\n\t},\n\t{\n\t\tid: 711,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'smoke',\n\t},\n\t{\n\t\tid: 721,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'haze',\n\t},\n\t{\n\t\tid: 731,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'sand_dust_whirls',\n\t},\n\t{\n\t\tid: 741,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'fog',\n\t},\n\t{\n\t\tid: 751,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'sand',\n\t},\n\t{\n\t\tid: 761,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'dust',\n\t},\n\t{\n\t\tid: 762,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'volcanic_ash',\n\t},\n\t{\n\t\tid: 771,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'squalls',\n\t},\n\t{\n\t\tid: 781,\n\t\tgroup: 'atmosphere',\n\t\tdescription: 'tornado',\n\t},\n\t{\n\t\tid: 800,\n\t\tgroup: 'clear',\n\t\tdescription: 'clear_sky',\n\t},\n\t{\n\t\tid: 801,\n\t\tgroup: 'clouds',\n\t\tdescription: 'few_clouds_11-25_percent',\n\t},\n\t{\n\t\tid: 802,\n\t\tgroup: 'clouds',\n\t\tdescription: 'scattered_clouds_25-50_percent',\n\t},\n\t{\n\t\tid: 803,\n\t\tgroup: 'clouds',\n\t\tdescription: 'broken_clouds_51-84_percent',\n\t},\n\t{\n\t\tid: 804,\n\t\tgroup: 'clouds',\n\t\tdescription: 'overcast_clouds_85-100_percent',\n\t},\n] as const;\n\nexport type WeatherID = (typeof weatherIdGroup)[number]['id'];\n\n/**\n * WeatherGroup:  \"clouds\" | \"rain\" | \"snow\" | \"thunderstorm\" | \"drizzle\" | \"atmosphere\" | \"clear\"\n */\nexport type WeatherGroup = (typeof weatherIdGroup)[number]['group'];\n\n/**\n * List for weather description key types from OpenWeatherMap API based on weather id.\n *\n * This list of keys can be used to translate weather id to human readable description with different languages.\n * @example\n * const i18Weather: Record<WeatherDescription, string> = {\n *  clear_sky: 'Clear sky',\n *  ...\n * }\n */\nexport type WeatherDescription = (typeof weatherIdGroup)[number]['description'];\n\n/**\n * Weather id schema\n * @internal\n */\nexport const weatherIdSchema = z.custom<WeatherID>((val) => {\n\tif (typeof val !== 'number') {\n\t\treturn {message: 'Expected a number', success: false};\n\t}\n\tif (!weatherIdGroup.find((x) => x.id === val)) {\n\t\treturn {message: 'Expected a valid weather id', success: false};\n\t}\n\treturn val;\n});\n\n/**\n * get weather description key from weather id\n * @param id - weather id\n * @returns {Option<WeatherDescription>}  option for weather description key\n * @example\n * const weatherComponent = ({data}) => {\n *   const key = getWeatherV2Description(data.weather[0]?.id).unwrapOr('unknown');\n *   return (\n *     <div>\n *       {t(`weather:${key}`}\n *     </div>\n *   );\n * }\n */\nexport function getWeatherV2Description(id: WeatherID | undefined): Option<WeatherDescription> {\n\treturn undefinedOptionWrap(weatherIdGroup.find((x) => x.id === id)?.description);\n}\n"]}