@angelrove/forecast-utils 1.1.17 → 1.1.19

package/dist/types/geolocation/index.d.ts

@@ -1,2 +1,5 @@
+/**
+ * @module Geolocation
+ */
 export { getGeolocation } from "./getGeolocation.js";
 export { timeFromLocation } from "./timeFromLocation.js";

package/dist/types/geolocation/timeFromLocation.d.ts

@@ -1,6 +1,6 @@
 /**
  * @memberof module:Geolocation
- * @typedef {Object} LocalTimeData
+ * @typedef {object} LocalTimeData
  * @property {Date} time - The local time.
  * @property {string} timeStr - The formatted local time string.
  * @property {string} timezone - The timezone name.

package/dist/types/index.d.ts

@@ -1,14 +1,14 @@
-export { default as MoonCalc } from "./astronomy/moon/MoonCalc.js";
-export { default as SunCalc } from "./astronomy/sun/SunCalc.js";
-export { timeFromLocation } from "./geolocation/timeFromLocation.js";
-export { default as TimeDateStr } from "./utils/timehelpers.js";
-export { getGeolocation } from "./geolocation/getGeolocation.js";
-export { useForecastCurrent } from "./OpenMeteo/current/useForecastCurrent.js";
-export { useForecastDaily } from "./OpenMeteo/daily/useForecastDaily.js";
-export { useForecastHourly } from "./OpenMeteo/hourly/useForecastHourly.js";
-export { weatherSymbol } from "./OpenMeteo/weatherSymbol/weatherSymbol.js";
-export { degreesToCompass } from "./utils/degreesToCompass.js";
-export { WindArrow } from "./utils/wind/WindArrow.jsx";
-export { windArrowTx } from "./utils/wind/windArrowTx.js";
-export { getWindLevel } from "./utils/wind/windLevel.js";
-export { getWarning, getWarningByDays } from "./utils/warning.js";
+export { default as MoonCalc } from "./astronomy/moon/MoonCalc";
+export { default as SunCalc } from "./astronomy/sun/SunCalc";
+export { timeFromLocation } from "./geolocation/timeFromLocation";
+export { default as TimeDateStr } from "./utils/timehelpers";
+export { getGeolocation } from "./geolocation/getGeolocation";
+export { useForecastCurrent } from "./OpenMeteo/current/useForecastCurrent";
+export { useForecastDaily } from "./OpenMeteo/daily/useForecastDaily";
+export { useForecastHourly } from "./OpenMeteo/hourly/useForecastHourly";
+export { weatherSymbol } from "./OpenMeteo/weatherSymbol/weatherSymbol";
+export { degreesToCompass } from "./utils/degreesToCompass";
+export { getWarning, getWarningByDays } from "./utils/warning";
+export { WindArrow } from "./utils/wind/WindArrow";
+export { windArrowTx } from "./utils/wind/windArrowTx";
+export { getWindLevel } from "./utils/wind/windLevel";

package/dist/types/utils/index.d.ts

@@ -1,6 +1,9 @@
+/**
+ * @module Utils
+ */
 export { degreesToCompass } from "./degreesToCompass.js";
 export { default as TimeDateStr } from "./timehelpers.js";
+export { getWarning, getWarningByDays } from "./warning.js";
 export { WindArrow } from "./wind/WindArrow.jsx";
 export { windArrowTx } from "./wind/windArrowTx.js";
 export { getWindLevel } from "./wind/windLevel.js";
-export { getWarning, getWarningByDays } from "./warning.js";

package/dist/types/utils/wind/WindArrow.d.ts

@@ -2,7 +2,7 @@
  * SVG arrow indicating wind direction.
  *
  * @component JSX
- * @param {Object} props - Component props.
+ * @param {object} props - Component props.
  * @param {number} props.deg - Wind direction in degrees (0 = North, 90 = East, etc.).
  * @param {string} [props.size] - Tailwind CSS size class (e.g., 'size-10')
  * @param {number} [props.strokeWidth] - Stroke width of the arrow (range: 1–6).

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jose Angel Romero Vegas",
   "name": "@angelrove/forecast-utils",
-  "version": "1.1.17",
+  "version": "1.1.19",
   "description": "Utilities for obtaining weather and astronomy forecast data.",
   "license": "MIT",
   "publishConfig": {
@@ -32,10 +32,10 @@
     "JavaScript"
   ],
   "peerDependencies": {
+    "@capacitor/geolocation": "^7.1.2",
     "react": "^19.1.0",
     "suncalc3": "^2.0.5",
-    "swr": "^2.3.3",
-    "@capacitor/geolocation": "^7.1.2"
+    "swr": "^2.3.3"
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",
@@ -43,6 +43,5 @@
     "@types/react-dom": "^19.1.9",
     "jsdoc-to-markdown": "^9.1.2",
     "typescript": "^5.9.2"
-  },
-  "dependencies": {}
+  }
 }

package/src/OpenMeteo/conf.js

@@ -39,7 +39,7 @@ export function getPath(lat, lon, path) {
  * @param {string} url
  */
 function devLog(title, url) {
-  // @ts-ignore
+  /* @ts-expect-error */
   if (import.meta.env.MODE === "development") {
     // console.log('%c> fetch [' + title + ']:', 'color:#9e9', url);
     console.log("> fetch [" + title + "]:", url);

package/src/OpenMeteo/current/transformer.js

@@ -2,7 +2,7 @@
  * Transforms the OpenMeteo API data into a more usable format.
  *
  * @param {{current: any, daily: any, hourly: any, latitude: number, longitude: number}} data - The data object to transform.
- * @returns {Object|null} - The transformed data object or null if the input is invalid.
+ * @returns {object|null} - The transformed data object or null if the input is invalid.
  */
 export default function transformer(data) {
   if (!data) return null;

package/src/OpenMeteo/current/{useForecastCurrent.js → useForecastCurrent.ts}

@@ -1,23 +1,23 @@
-// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
+import type { ForecastData } from "../types";
 import { fetchParams } from "./fetchParams.js";
 import transformer from "./transformer.js";
 
 /**
  * Custom hook to fetch current weather data from OpenMeteo API.
- *
- * @param {number} lat
- * @param {number} lon
- * @param {number} refreshIntervalMin
- * @returns {ForecastData} {data, isLoading, isError, apiUrl}
- * @memberof module:OpenMeteo
  */
-export function useForecastCurrent(lat, lon, refreshIntervalMin = 0) {
-  if (!lat || !lon) {
+export function useForecastCurrent(
+  lat: number | undefined,
+  lon: number | undefined,
+  refreshIntervalMin: number = 0): ForecastData
+  {
+  // Validate --
+  if (lat == null || lon == null) {
     throw new Error("useForecastCurrent: invalid coordinates");
   }
 
+  // Fetch ---
   const apiUrl = getPath(lat, lon, fetchParams);
   const { data, error, isLoading } = useSWR(apiUrl, fetcher, {
     refreshInterval: refreshIntervalMin * 60 * 1000,

package/src/OpenMeteo/daily/transformer.js

@@ -2,7 +2,7 @@
  * Transforms the OpenMeteo API data into a more usable format.
  *
  * @param {{daily: any}} data - The data object to transform.
- * @returns {Object|null} - The transformed data object or null if the input is invalid.
+ * @returns {object|null} - The transformed data object or null if the input is invalid.
  */
 export default function transformer(data) {
   if (!data) return null;

package/src/OpenMeteo/daily/{useForecastDaily.js → useForecastDaily.ts}

@@ -1,23 +1,20 @@
-// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
+import type { ForecastData } from "../types";
 import { fetchParams } from "./fetchParams.js";
 import transformer from "./transformer.js";
 
 /**
  * Custom hook to fetch daily forecast (10 days) data from OpenMeteo API.
- *
  * https://api.open-meteo.com/v1/forecast?timezone=auto&latitude=36.6644363&longitude=-4.5108962&forecast_days=10&daily=weathercode
- *
- * @param {number} lat
- * @param {number} lon
- * @param {number} refreshIntervalMin
- * @returns {ForecastData} {data, isLoading, isError, apiUrl}
- * @memberof module:OpenMeteo
  */
-export function useForecastDaily(lat, lon, refreshIntervalMin = 0) {
+export function useForecastDaily(
+  lat: number | undefined,
+  lon: number | undefined,
+  refreshIntervalMin: number = 0): ForecastData
+  {
   // Validate --
-  if (!lat || !lon) {
+  if (lat == null || lon == null) {
     throw new Error("useForecastDaily: invalid coordinates");
   }
 

package/src/OpenMeteo/hourly/{useForecastHourly.js → useForecastHourly.ts}

@@ -1,20 +1,21 @@
-// @ts-nocheck
 import useSWR from "swr";
 import { fetcher, getPath } from "../conf.js";
 import { getDatesFromNumDays } from "../helpers.js";
+import type { ForecastData } from "../types";
 import { fetchParams } from "./fetchParams.js";
 
 /**
  * Custom hook to fetch hourly forecast data for a given location and number of days from OpenMeteo API.
- *
- * @param {{ latitude: number, longitude: number }} location
- * @param {number} dayNum Number of days from today: -1 = 24 hours, 0 = today, 1 = tomorrow, ...
- * @returns {ForecastData} {data, isLoading, isError, apiUrl}
- * @memberof module:OpenMeteo
  */
-export function useForecastHourly(location, dayNum) {
-  if (!location.latitude || !location.longitude) {
-    throw new Error("useForecastHourly: invalid coordinates");
+export function useForecastHourly(
+  lat: number,
+  lon: number,
+  dayNum: number): ForecastData
+  {
+
+  // Validate --
+  if (lat == null || lon == null) {
+    throw new Error("useForecastHourly: invalid coordinates: ["+lon+"]["+lat+"]");
   }
 
   // Fetch ---
@@ -28,7 +29,7 @@ export function useForecastHourly(location, dayNum) {
     dates.endDate +
     "&" +
     fetchParams;
-  apiUrl = getPath(location.latitude, location.longitude, apiUrl);
+  apiUrl = getPath(lat, lon, apiUrl);
 
   const { data, error, isLoading } = useSWR(apiUrl, fetcher);
 

package/src/OpenMeteo/index.ts

@@ -0,0 +1,11 @@
+/**
+ * Use the OpenWeather forecast API
+ * @package OpenMeteo
+ *
+ */
+
+export { useForecastCurrent } from "./current/useForecastCurrent";
+export { useForecastDaily } from "./daily/useForecastDaily";
+export { useForecastHourly } from "./hourly/useForecastHourly";
+export { weatherSymbol } from "./weatherSymbol/weatherSymbol";
+

package/src/OpenMeteo/types.ts

@@ -0,0 +1,15 @@
+/**
+ * @memberof module:OpenMeteo
+ */
+
+export type ForecastData = {
+  data: any; // 👈 Cambiar al tipo real que devuelve `transformer`
+  apiUrl: string;
+  isLoading: boolean;
+  isError: unknown;
+};
+
+export type WeatherSymbol = {
+  icon: string;
+  description: string;
+};

package/src/OpenMeteo/weatherSymbol/lib/WeatherCodesEn.js

@@ -21,7 +21,7 @@
  */
 
 /**
- * @typedef {Object} WeatherCodeEntry
+ * @typedef {object} WeatherCodeEntry
  * @property {number} code - WMO Weather interpretation codes (WW).
  * @property {string} icon - Icon name.
  * @property {string} description - Description.

package/src/OpenMeteo/weatherSymbol/lib/WeatherCodesEs.js

@@ -21,7 +21,7 @@
  */
 
 /**
- * @typedef {Object} WeatherCodeEntry
+ * @typedef {object} WeatherCodeEntry
  * @property {number} code - WMO Weather interpretation codes (WW).
  * @property {string} icon - Icon name.
  * @property {string} description - Description.

package/src/OpenMeteo/weatherSymbol/{weatherSymbol.js → weatherSymbol.ts}

@@ -1,22 +1,17 @@
+import type { WeatherSymbol } from "../types";
 import { getWeatherCodeEntry } from "./lib/getWeatherCodeEntry.js";
 
 /**
  * Get weather symbol and description based on the weather code.
- *
- * @param {any} code
- * @param {number} [precipitation]
- * @param {boolean} night
- * @param {boolean} dark
- * @returns {{ icon: string, description: string }}
- * { icon: string, description: string }
  * @memberof module:OpenMeteo
  */
 export function weatherSymbol(
-  code,
-  precipitation = undefined,
-  night = false,
-  dark = false,
-) {
+  code: any,
+  precipitation: number | undefined = undefined,
+  night: boolean = false,
+  dark: boolean = false,
+): WeatherSymbol
+{
   // Parse code ---
   let msgPlus = "";
   let theCode = code;

package/src/astronomy/moon/MoonCalc.js

@@ -9,7 +9,7 @@
  * @module Astronomy/MoonCalc
  */
 
-// @ts-ignore
+/* @ts-expect-error */
 import SunCalc from "suncalc3";
 import TimeDateStr from "../../utils/timehelpers.js";
 import { parseBasicData } from "./parseBasicData.js";
@@ -29,7 +29,7 @@ export default MoonCalc;
 
 /**
  * @memberof module:Astronomy
- * @typedef {Object} AstroPosition
+ * @typedef {object} AstroPosition
  * @property {number} altitude
  * @property {number} azimuth
  * @property {string} direction
@@ -38,7 +38,7 @@ export default MoonCalc;
 
 /**
  * @memberof module:Astronomy/MoonCalc
- * @typedef {Object} MoonDataExt
+ * @typedef {object} MoonDataExt
  * @property {string} date
  * @property {string} time
  * @property {string} illumination
@@ -48,14 +48,14 @@ export default MoonCalc;
  * @property {number} parallacticAngle
  * @property {number} angle
  * @property {AstroPosition} position
- * @property {Object} next
+ * @property {object} next
  */
 
 /**
  * @memberof module:Astronomy/MoonCalc
- * @typedef {Object} MoonData
+ * @typedef {object} MoonData
  * @property {AstroPosition} position
- * @property {Object} next
+ * @property {object} next
  * @property {string} next.newMoon - Date of the next new moon.
  * @property {string} next.fullMoon - Date of the next full moon.
  */

package/src/astronomy/sun/SunCalc.js

@@ -10,7 +10,7 @@
  * @module Astronomy/SunCalc
  */
 
-// @ts-ignore
+/* @ts-expect-error */
 import { default as SunCalc3 } from "suncalc3";
 import { degreesToCompass } from "../../utils/degreesToCompass.js";
 import TimeDateStr from "../../utils/timehelpers.js";
@@ -35,8 +35,8 @@ export default SunCalc;
  * @param {number} latitude
  * @param {number} longitude
  * @param {string} timezoneId
- * @returns {{ sunTimes: Object, sunPosition: Object, sunPhase: string }}
- * { sunTimes: Object, sunPosition: Object, sunPhase: string }
+ * @returns {{ sunTimes: object, sunPosition: object, sunPhase: string }}
+ * { sunTimes: object, sunPosition: object, sunPhase: string }
  * @memberof module:Astronomy/SunCalc
  */
 function all(date, latitude, longitude, timezoneId) {

package/src/geolocation/getGeolocation.js

@@ -3,7 +3,7 @@ import reverseGeocoding from "./lib/reversegeocoding.js";
 
 /**
  * @memberof module:Geolocation
- * @typedef {Object} ResolvedLocation
+ * @typedef {object} ResolvedLocation
  * @property {number} latitude
  * @property {number} longitude
  * // Address
@@ -39,7 +39,7 @@ export async function getGeolocation() {
     address = await reverseGeocoding(
       location.latitude,
       location.longitude,
-      // @ts-ignore
+      /* @ts-expect-error */
       import.meta.env.VITE_googlemaps_api_key,
     );
   } catch (error) {

package/src/geolocation/lib/geolocation.js

@@ -31,15 +31,15 @@ export default async function geolocation() {
   } catch (error) {
     console.error(error);
 
-    // @ts-ignore
+    /* @ts-expect-error */
     if (error.code === error.PERMISSION_DENIED) {
       throw new Error("Geolocation: permission denied");
     }
-    // @ts-ignore
+    /* @ts-expect-error */
     if (error.code === error.POSITION_UNAVAILABLE) {
       throw new Error("Geolocation: position unavailable");
     }
-    // @ts-ignore
+    /* @ts-expect-error */
     if (error.code === error.TIMEOUT) {
       throw new Error("Geolocation: timeout");
     }

package/src/geolocation/lib/reversegeocoding.js

@@ -102,7 +102,7 @@ export default async function reverseGeocoding(latitude, longitude, api_key) {
  * @param {any} url
  */
 function devLog(title, url) {
-  // @ts-ignore
+  /* @ts-expect-error */
   if (import.meta.env.MODE === "development") {
     console.log(`> fetch [${title}]:`, url);
   }

package/src/geolocation/timeFromLocation.js

@@ -3,7 +3,7 @@ import TimeDateStr from "../utils/timehelpers.js";
 
 /**
  * @memberof module:Geolocation
- * @typedef {Object} LocalTimeData
+ * @typedef {object} LocalTimeData
  * @property {Date} time - The local time.
  * @property {string} timeStr - The formatted local time string.
  * @property {string} timezone - The timezone name.
@@ -55,7 +55,7 @@ export async function timeFromLocation(apiKey, lat, lng) {
 //------------------------------------------------------
 /**
  * @private
- * @param {Object} timezoneInfo - The timezone Google API information.
+ * @param {object} timezoneInfo - The timezone Google API information.
  * @param {number} timezoneInfo.rawOffset - The raw offset in seconds.
  * @param {number} timezoneInfo.dstOffset - The DST offset in seconds.
  * @param {string} timezoneInfo.timeZoneName - The name of the timezone.

package/src/index.ts

@@ -0,0 +1,22 @@
+// Astronomy
+export { default as MoonCalc } from "./astronomy/moon/MoonCalc";
+export { default as SunCalc } from "./astronomy/sun/SunCalc";
+export { timeFromLocation } from "./geolocation/timeFromLocation";
+export { default as TimeDateStr } from "./utils/timehelpers";
+
+// Geolocation
+export { getGeolocation } from "./geolocation/getGeolocation";
+
+// OpenMeteo
+export { useForecastCurrent } from "./OpenMeteo/current/useForecastCurrent";
+export { useForecastDaily } from "./OpenMeteo/daily/useForecastDaily";
+export { useForecastHourly } from "./OpenMeteo/hourly/useForecastHourly";
+export { weatherSymbol } from "./OpenMeteo/weatherSymbol/weatherSymbol";
+
+// utils
+export { degreesToCompass } from "./utils/degreesToCompass";
+export { getWarning, getWarningByDays } from "./utils/warning";
+export { WindArrow } from "./utils/wind/WindArrow";
+export { windArrowTx } from "./utils/wind/windArrowTx";
+export { getWindLevel } from "./utils/wind/windLevel";
+

package/src/utils/degreesToCompass.js

@@ -3,7 +3,7 @@
  */
 
 /**
- * @typedef {Object} Compass
+ * @typedef {object} Compass
  * @property {string} short - Short compass designation
  * @property {string} full - Full compass designation
  * @memberof module:Utils

package/src/utils/timehelpers.js

@@ -30,7 +30,7 @@ function dateFormat(date = new Date()) {
     day: "numeric",
     month: "short",
   };
-  // @ts-ignore
+  /* @ts-expect-error */
   return date.toLocaleDateString([], options);
 }
 //------------------------------------------------------

package/src/utils/warning.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {Object} AlertLevel
+ * @typedef {object} AlertLevel
  * @property {number} levelNum - The alert level number.
  * @property {string} level - The alert level string (e.g., "red", "orange", "yellow").
  * @property {number} precipitation - The precipitation threshold for the alert level.

package/src/utils/wind/WindArrow.jsx

@@ -2,7 +2,7 @@
  * SVG arrow indicating wind direction.
  *
  * @component JSX
- * @param {Object} props - Component props.
+ * @param {object} props - Component props.
  * @param {number} props.deg - Wind direction in degrees (0 = North, 90 = East, etc.).
  * @param {string} [props.size] - Tailwind CSS size class (e.g., 'size-10')
  * @param {number} [props.strokeWidth] - Stroke width of the arrow (range: 1–6).
@@ -17,13 +17,12 @@ export function WindArrow({
 }) {
   if (deg == null) {
     // console.warn("WindArrow: deg is undefined");
-    /* @ts-ignore */
     return <div>deg?</div>;
   }
 
   // Render arrow ---
   return (
-    /* @ts-ignore */
+    /*·@ts-expect-error·*/
     <svg
       className={`${size} ${className}`}
       style={{ transform: `rotate(${deg}deg)` }}

package/src/utils/wind/windLevel.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {Object} WindLevel
+ * @typedef {object} WindLevel
  * @property {number} id - Level ID
  * @property {number} speed - Minimum wind speed for this level
  * @property {string} color - Color representing this level

package/src/OpenMeteo/index.js

@@ -1,10 +0,0 @@
-/**
- * Use the OpenWeather forecast API
- * @module OpenMeteo
- *
- */
-
-export { useForecastCurrent } from "./current/useForecastCurrent.js";
-export { useForecastDaily } from "./daily/useForecastDaily.js";
-export { useForecastHourly } from "./hourly/useForecastHourly.js";
-export { weatherSymbol } from "./weatherSymbol/weatherSymbol.js";

package/src/OpenMeteo/types.js

@@ -1,8 +0,0 @@
-/**
- * @memberof module:OpenMeteo
- * @typedef {Object} ForecastData
- * @property {any} data - Forecast data
- * @property {boolean} isLoading - Loading state
- * @property {any} isError - Error state
- * @property {string} apiUrl - API URL
- */

package/src/index.js

@@ -1,21 +0,0 @@
-// Astronomy
-export { default as MoonCalc } from "./astronomy/moon/MoonCalc.js";
-export { default as SunCalc } from "./astronomy/sun/SunCalc.js";
-export { timeFromLocation } from "./geolocation/timeFromLocation.js";
-export { default as TimeDateStr } from "./utils/timehelpers.js";
-
-// Geolocation
-export { getGeolocation } from "./geolocation/getGeolocation.js";
-
-// OpenMeteo
-export { useForecastCurrent } from "./OpenMeteo/current/useForecastCurrent.js";
-export { useForecastDaily } from "./OpenMeteo/daily/useForecastDaily.js";
-export { useForecastHourly } from "./OpenMeteo/hourly/useForecastHourly.js";
-export { weatherSymbol } from "./OpenMeteo/weatherSymbol/weatherSymbol.js";
-
-// utils
-export { degreesToCompass } from "./utils/degreesToCompass.js";
-export { getWarning, getWarningByDays } from "./utils/warning.js";
-export { WindArrow } from "./utils/wind/WindArrow.jsx";
-export { windArrowTx } from "./utils/wind/windArrowTx.js";
-export { getWindLevel } from "./utils/wind/windLevel.js";