Migrate OpenWeather to Open-Meteo

OpenWeather Call API is no longer free.
darekkay · Aug 13, 2024 · 4b8be9f · 4b8be9f
1 parent c0c4b5f
commit 4b8be9f
Show file tree

Hide file tree

Showing 17 changed files with 291 additions and 456 deletions.
diff --git a/app/src/api/routes.d.ts b/app/src/api/routes.d.ts
@@ -42,27 +42,22 @@ export interface UnsplashImage {
   altText?: string;
   [key: string]: any;
 }
+export declare enum WeatherIcon {
+  Sun = "sun",
+  CloudSun = "cloud-sun",
+  CloudSunRain = "cloud-sun-rain",
+  Moon = "moon",
+  CloudMoon = "cloud-moon",
+  CloudMoonRain = "cloud-moon-rain",
+  Clouds = "clouds",
+  CloudShowers = "cloud-showers",
+  Thunderstorm = "thunderstorm",
+  Snow = "snow",
+  Fog = "fog",
+}
 export interface WeatherCondition {
   description: string;
-  icon:
-    | "01d"
-    | "02d"
-    | "03d"
-    | "04d"
-    | "09d"
-    | "10d"
-    | "11d"
-    | "13d"
-    | "50d"
-    | "01n"
-    | "02n"
-    | "03n"
-    | "04n"
-    | "09n"
-    | "10n"
-    | "11n"
-    | "13n"
-    | "50n";
+  icon: WeatherIcon;
   [key: string]: any;
 }
 export interface WeatherData {

diff --git a/app/src/api/routes.js b/app/src/api/routes.js
@@ -9,6 +9,20 @@
  * ---------------------------------------------------------------
  */
 
+export var WeatherIcon;
+(function (WeatherIcon) {
+  WeatherIcon["Sun"] = "sun";
+  WeatherIcon["CloudSun"] = "cloud-sun";
+  WeatherIcon["CloudSunRain"] = "cloud-sun-rain";
+  WeatherIcon["Moon"] = "moon";
+  WeatherIcon["CloudMoon"] = "cloud-moon";
+  WeatherIcon["CloudMoonRain"] = "cloud-moon-rain";
+  WeatherIcon["Clouds"] = "clouds";
+  WeatherIcon["CloudShowers"] = "cloud-showers";
+  WeatherIcon["Thunderstorm"] = "thunderstorm";
+  WeatherIcon["Snow"] = "snow";
+  WeatherIcon["Fog"] = "fog";
+})(WeatherIcon || (WeatherIcon = {}));
 import axios from "axios";
 export var ContentType;
 (function (ContentType) {

diff --git a/app/src/components/icon/custom/index.tsx b/app/src/components/icon/custom/index.tsx
@@ -1,6 +1,5 @@
 import React from "react";
 
-import { ReactComponent as Cloud } from "./weather/cloud.svg";
 import { ReactComponent as Clouds } from "./weather/clouds.svg";
 import { ReactComponent as CloudMoon } from "./weather/cloud-moon.svg";
 import { ReactComponent as CloudMoonRain } from "./weather/cloud-moon-rain.svg";
@@ -14,50 +13,33 @@ import { ReactComponent as Sun } from "./weather/sun.svg";
 import { ReactComponent as Thunderstorm } from "./weather/thunderstorm.svg";
 
 export type CustomIconName =
-  | "01d"
-  | "02d"
-  | "03d"
-  | "04d"
-  | "09d"
-  | "10d"
-  | "11d"
-  | "13d"
-  | "50d"
-  | "01n"
-  | "02n"
-  | "03n"
-  | "04n"
-  | "09n"
-  | "10n"
-  | "11n"
-  | "13n"
-  | "50n";
+  | "sun"
+  | "cloud-sun"
+  | "cloud-sun-rain"
+  | "moon"
+  | "cloud-moon"
+  | "cloud-moon-rain"
+  | "clouds"
+  | "cloud-showers"
+  | "thunderstorm"
+  | "snow"
+  | "fog";
 
 const icons: Record<
   CustomIconName,
   React.FunctionComponent<React.SVGProps<SVGSVGElement>>
 > = {
-  // day variants
-  "01d": Sun,
-  "02d": CloudSun,
-  "03d": Cloud,
-  "04d": Clouds,
-  "09d": CloudShowers,
-  "10d": CloudSunRain,
-  "11d": Thunderstorm,
-  "13d": Snow,
-  "50d": Fog,
-
-  // night variants
-  "01n": Moon,
-  "02n": CloudMoon,
-  "03n": Cloud,
-  "04n": Clouds,
-  "09n": CloudShowers,
-  "10n": CloudMoonRain,
-  "11n": Thunderstorm,
-  "13n": Snow,
-  "50n": Fog,
+  sun: Sun,
+  "cloud-sun": CloudSun,
+  "cloud-sun-rain": CloudSunRain,
+  moon: Moon,
+  "cloud-moon": CloudMoon,
+  "cloud-moon-rain": CloudMoonRain,
+  clouds: Clouds,
+  "cloud-showers": CloudShowers,
+  thunderstorm: Thunderstorm,
+  snow: Snow,
+  fog: Fog,
 };
 
 export default icons;
diff --git a/app/src/components/icon/custom/weather/cloud.svg b/app/src/components/icon/custom/weather/cloud.svg
diff --git a/app/src/widgets/weather/__stories__/index.stories.tsx b/app/src/widgets/weather/__stories__/index.stories.tsx
@@ -12,24 +12,17 @@ export default {
 };
 
 const weatherIcons = [
-  "01d",
-  "02d",
-  "03d",
-  "04d",
-  "09d",
-  "10d",
-  "11d",
-  "13d",
-  "50d",
-  "01n",
-  "02n",
-  "03n",
-  "04n",
-  "09n",
-  "10n",
-  "11n",
-  "13n",
-  "50n",
+  "sun",
+  "cloud-sun",
+  "cloud-sun-rain",
+  "moon",
+  "cloud-moon",
+  "cloud-moon-rain",
+  "clouds",
+  "cloud-showers",
+  "thunderstorm",
+  "snow",
+  "fog",
 ] as const;
 
 const createForecast = () => {
@@ -69,7 +62,7 @@ export const Variants = () => {
               temperature: 24,
               condition: {
                 description: "clear sky",
-                icon: "01d",
+                icon: "sun",
               },
             },
             forecast: createForecast(),

diff --git a/app/src/widgets/weather/__tests__/index.test.tsx b/app/src/widgets/weather/__tests__/index.test.tsx
@@ -2,6 +2,7 @@ import React from "react";
 
 import { render, screen } from "common/testing";
 import { widgetContentProps, widgetStatusDisplay } from "common/utils/mock";
+import type { WeatherIcon } from "api";
 
 import Weather from "../index";
 
@@ -12,15 +13,15 @@ const commonProps = {
     temperature: 24,
     condition: {
       description: "clear sky",
-      icon: "01d" as const,
+      icon: "sun" as WeatherIcon,
     },
   },
   forecast: [
     {
       date: 1598180400,
       condition: {
         description: "overcast clouds",
-        icon: "04d" as const,
+        icon: "clouds" as WeatherIcon,
       },
       temperatureMin: 18,
       temperatureMax: 30,

diff --git a/app/src/widgets/weather/configuration.tsx b/app/src/widgets/weather/configuration.tsx
@@ -51,6 +51,15 @@ const Configuration = ({
         }
         options={["metric", "imperial"] as const}
       />
+      <div className="text-right text-1">
+        <Trans
+          i18nKey="common.poweredBy"
+          values={{ name: "Open-Meteo" }}
+          components={{
+            alink: <Link href="https://open-meteo.com/">{""}</Link>,
+          }}
+        />
+      </div>
     </div>
   );
 };

diff --git a/docs/changelog/README.md b/docs/changelog/README.md
@@ -3,6 +3,7 @@
 ## Current development
 
 - :boom: Remove Twitter integration.
+- :boom: Switch from OpenWeather to [[Open-Meteo](https://open-meteo.com).
 - :boom: Drop Node 16 support.
 - :sparkles: New widget: [Weather](https://dashboard.darekkay.com/docs/widgets/weather.html).
 - :sparkles: New widget: [Day Countdown](https://dashboard.darekkay.com/docs/widgets/day-countdown.html).

diff --git a/docs/development/README.md b/docs/development/README.md
@@ -18,7 +18,6 @@ Recommended:
 Some widgets require a 3rd-party API key:
 
 - [Unsplash](https://unsplash.com/documentation)
-- [OpenWeatherMap](https://openweathermap.org/api)
 - [YouTube](https://developers.google.com/youtube/v3/getting-started)
 
 Those keys need to be stored at `server/.env` (copy `server/.env.example` as a template). The project will run with missing API keys, but the affected widgets will not work.

diff --git a/server/.env.example b/server/.env.example
@@ -1,4 +1,3 @@
 SAVE_AXIOS_RESPONSES=false
-API_OPEN_WEATHER_MAP=
 API_UNSPLASH=
 API_YOUTUBE=
diff --git a/server/.env.test b/server/.env.test
@@ -1,3 +1,2 @@
-API_OPEN_WEATHER_MAP=mock-api-key
 API_UNSPLASH=mock-api-key
 API_YOUTUBE=mock-api-key
diff --git a/server/src/api/routes.ts b/server/src/api/routes.ts
@@ -51,11 +51,16 @@ const models: TsoaRoute.Models = {
         "additionalProperties": true,
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "WeatherIcon": {
+        "dataType": "refAlias",
+        "type": {"dataType":"union","subSchemas":[{"dataType":"enum","enums":["sun"]},{"dataType":"enum","enums":["cloud-sun"]},{"dataType":"enum","enums":["cloud-sun-rain"]},{"dataType":"enum","enums":["moon"]},{"dataType":"enum","enums":["cloud-moon"]},{"dataType":"enum","enums":["cloud-moon-rain"]},{"dataType":"enum","enums":["clouds"]},{"dataType":"enum","enums":["cloud-showers"]},{"dataType":"enum","enums":["thunderstorm"]},{"dataType":"enum","enums":["snow"]},{"dataType":"enum","enums":["fog"]}],"validators":{}},
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "WeatherCondition": {
         "dataType": "refObject",
         "properties": {
             "description": {"dataType":"string","required":true},
-            "icon": {"dataType":"union","subSchemas":[{"dataType":"enum","enums":["01d"]},{"dataType":"enum","enums":["02d"]},{"dataType":"enum","enums":["03d"]},{"dataType":"enum","enums":["04d"]},{"dataType":"enum","enums":["09d"]},{"dataType":"enum","enums":["10d"]},{"dataType":"enum","enums":["11d"]},{"dataType":"enum","enums":["13d"]},{"dataType":"enum","enums":["50d"]},{"dataType":"enum","enums":["01n"]},{"dataType":"enum","enums":["02n"]},{"dataType":"enum","enums":["03n"]},{"dataType":"enum","enums":["04n"]},{"dataType":"enum","enums":["09n"]},{"dataType":"enum","enums":["10n"]},{"dataType":"enum","enums":["11n"]},{"dataType":"enum","enums":["13n"]},{"dataType":"enum","enums":["50n"]}],"required":true},
+            "icon": {"ref":"WeatherIcon","required":true},
         },
         "additionalProperties": true,
     },

diff --git a/server/src/api/swagger.json b/server/src/api/swagger.json
@@ -87,33 +87,29 @@
 				"type": "object",
 				"additionalProperties": true
 			},
+			"WeatherIcon": {
+				"type": "string",
+				"enum": [
+					"sun",
+					"cloud-sun",
+					"cloud-sun-rain",
+					"moon",
+					"cloud-moon",
+					"cloud-moon-rain",
+					"clouds",
+					"cloud-showers",
+					"thunderstorm",
+					"snow",
+					"fog"
+				]
+			},
 			"WeatherCondition": {
 				"properties": {
 					"description": {
 						"type": "string"
 					},
 					"icon": {
-						"type": "string",
-						"enum": [
-							"01d",
-							"02d",
-							"03d",
-							"04d",
-							"09d",
-							"10d",
-							"11d",
-							"13d",
-							"50d",
-							"01n",
-							"02n",
-							"03n",
-							"04n",
-							"09n",
-							"10n",
-							"11n",
-							"13n",
-							"50n"
-						]
+						"$ref": "#/components/schemas/WeatherIcon"
 					}
 				},
 				"required": [

diff --git a/server/src/config.ts b/server/src/config.ts
@@ -13,7 +13,6 @@ const config = {
   port: process.env.PORT ?? 3401,
   saveAxiosResponses: process.env.SAVE_AXIOS_RESPONSES === "true",
   api: {
-    openWeatherMap: process.env.API_OPEN_WEATHER_MAP,
     unsplash: process.env.API_UNSPLASH,
     youtube: process.env.API_YOUTUBE,
   },