@angelrove/forecast-utils 1.1.2 → 1.1.3

package/src/astronomy/timehelpers.js

@@ -1,7 +1,3 @@
-/**
- * @module astronomy/time-date
- */
-
 //------------------------------------------------------
 /**
  * Formatea una fecha a un string legible.
@@ -9,6 +5,7 @@
  * @param {Date} [date]
  * @param {boolean} [sec=false]
  * @returns {string} La fecha formateada.
+ * @memberof module:Astronomy
  */
 export function timeString(date = new Date(), sec = false) {
   if (sec) {
@@ -27,6 +24,12 @@ export function timeString(date = new Date(), sec = false) {
   });
 }
 //------------------------------------------------------
+/**
+ *
+ * @param {boolean} sec
+ * @returns {String}
+ * @memberof module:Astronomy
+ */
 export function nowString(sec = false) {
   return timeString(new Date(), sec);
 }
@@ -36,6 +39,7 @@ export function nowString(sec = false) {
  *
  * @param {Date} [date=new Date()] La fecha a formatear.
  * @returns {string} La fecha formateada.
+ * @memberof module:Astronomy
  */
 export function dateFormat(date = new Date()) {
   const options = {
@@ -53,6 +57,7 @@ export function dateFormat(date = new Date()) {
  * @param {string} timeZone - The timezone string (e.g., 'America/New_York').
  * @param {Date | number} [date=new Date()] - The date object to format. Defaults to the current date.
  * @returns {string} - The formatted local time string.
+ * @memberof module:Astronomy
  */
 export function getLocalTimeFromTz(timeZone, date = new Date()) {
   // Timezone example

package/src/astronomy/types.js

@@ -1,8 +1,5 @@
 /**
- * @module astronomy/types
- */
-
-/**
+ * @memberof module:Astronomy
  * @typedef {Object} AstroPosition
  * @property {number} altitude
  * @property {number} azimuth
@@ -11,14 +8,7 @@
  */
 
 /**
- * @typedef {Object} MoonData
- * @property {AstroPosition} position
- * @property {Object} next
- * @property {string} next.newMoon - Date of the next new moon.
- * @property {string} next.fullMoon - Date of the next full moon.
- */
-
-/**
+ * @memberof module:Astronomy
  * @typedef {Object} LocalTimeData
  * @property {Date} time - The local time.
  * @property {string} timeStr - The formatted local time string.

package/src/geolocation/getGeolocation.js

@@ -1,16 +1,16 @@
 /**
- * @module Geolocation
+ * Get the current geolocation of the device and reverse geocode it to get the address.
  */
 
 import geolocationCapacitor from "./lib/geolocation.js";
 import reverseGeocoding from "./lib/reversegeocoding.js";
 
 /**
- * Get the current geolocation of the device and reverse
- * geocode it to get the address.
+ * Get the current geolocation of the device and reverse geocode it to get the address.
  *
  * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>}
  * @throws {Error} If geolocation is not supported or permission is denied.
+ * @memberof module:Geolocation
  */
 export async function getGeolocation() {
   let location = null;
@@ -21,7 +21,8 @@ export async function getGeolocation() {
     location = await geolocationCapacitor();
     // location.latitude = '25.90197748117876'; location.longitude = '-65.71650426928204';
   } catch (error) {
-    throw new Error("Geolocation error: " + error.message);
+    const message = error instanceof Error ? error.message : error;
+    throw new Error("Geolocation error: " + message);
   }
 
   // Address ---
@@ -33,7 +34,8 @@ export async function getGeolocation() {
       import.meta.env.VITE_googlemaps_api_key,
     );
   } catch (error) {
-    console.log("reverseGeocoding - error: ", error.message);
+    const message = error instanceof Error ? error.message : error;
+    console.log("reverseGeocoding - error: ", message);
     address = {
       formatted_address:
         "[" + location.latitude + ", " + location.longitude + "]",

package/src/geolocation/index.js

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

package/src/index.js

@@ -1,10 +1,9 @@
 /**
- * @author: Jose Angel Romero Vegas
- * @license: MIT
- * @description:
  * Several utility libraries for the Tierracolora project:
  * - Forecast API (OpenWeather)
  * - Astronomy utilities
+ * - Geolocation
+ * - Another utilities.
  *
  * I use public libraries for the following:
  * - Astronomy calculations: suncalc3

package/src/utils/degreesToCompass.js

@@ -1,7 +1,22 @@
 /**
- * @module utils
+ * Convert degrees to compass designation
+ */
+
+/**
+ * @typedef {Object} Compass
+ * @property {string} short - Short compass designation
+ * @property {string} full - Full compass designation
+ * @memberof module:Utils
  */
 
+/**
+ * English compass designations
+ * @type {Compass[]}
+ * @constant
+ * @property {string} short - Short compass designation
+ * @property {string} full - Full compass designation
+ * @memberof module:Utils
+ */
 const directions = [
   { short: "N", full: "North" },
   { short: "NE", full: "Northeast" },
@@ -13,6 +28,14 @@ const directions = [
   { short: "NW", full: "Northwest" },
 ];
 
+/**
+ * Spanish compass designations
+ * @type {Compass[]}
+ * @constant
+ * @property {string} short - Short compass designation
+ * @property {string} full - Full compass designation
+ * @memberof module:Utils
+ */
 const directionsEs = [
   { short: "N", full: "Norte" },
   { short: "NE", full: "Noreste" },
@@ -30,6 +53,7 @@ const directionsEs = [
  * @param {number} degrees
  * @param {string} language - Language code ("en-US", "es-ES", "auto")
  * @returns {{short: string, full: string}}
+ * @memberof module:Utils
  */
 export function degreesToCompass(degrees, language = "auto") {
   if (degrees == null) return { short: "?", full: "?" };

package/src/utils/index.js

@@ -0,0 +1,9 @@
+/**
+ * @module Utils
+ */
+
+export { degreesToCompass } from "./degreesToCompass.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";

package/src/utils/warning.js

@@ -1,21 +1,17 @@
-/**
- * @module utils
- */
-
-// AEMET (12 horas)
-
 /**
  * @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.
  * @property {number} showers - The showers threshold for the alert level.
+ * @memberof module:Utils
  */
 
 /**
  * Alert levels for rain and showers
  *
  * @type {AlertLevel[]}
+ * @memberof module:Utils
  */
 const ALERT_LEVEL = [
   { levelNum: 3, level: "red", precipitation: 120, showers: 60 },
@@ -31,6 +27,7 @@ const ALERT_LEVEL = [
  * @param {number} showersSumToday
  * @param {number} showersSumTomorrow
  * @returns {{ levelNum: number, level: string, message: string, day: number } | null}
+ * @memberof module:Utils
  */
 export function getWarningByDays(
   precipitationSumToday,
@@ -66,6 +63,7 @@ export function getWarningByDays(
  * @param {number} precipitation
  * @param {number} showers
  * @returns {{ levelNum: number, level: string, message: string } | null}
+ * @memberof module:Utils
  */
 export function getWarning(precipitation, showers) {
   const warningRain = getWarningRain(precipitation);
@@ -93,7 +91,7 @@ export function getWarning(precipitation, showers) {
 //----------------------------------------------------------------
 /**
  * Get warning by rain
- *
+ * @private
  * @param {number} precipitation
  * @returns {{ levelNum: number, level: string, message: string } | null}
  */
@@ -113,6 +111,7 @@ function getWarningRain(precipitation) {
 /**
  * Get warning by showers
  *
+ * @private
  * @param {number} showers
  * @returns {{ levelNum: number, level: string, message: string } | null}
  */

package/src/utils/wind/WindArrow.jsx

@@ -1,5 +1,5 @@
 /**
- * @module utils:WindArrow
+ * Wind direction arrow component (svg image).
  */
 
 /**
@@ -15,6 +15,7 @@
  *
  * @component
  * @param {WindArrowProps} props
+ * @memberof module:Utils
  */
 export function WindArrow({
   deg,

package/src/utils/wind/windArrowTx.js

@@ -1,11 +1,12 @@
 /**
- * @module utils
+ * Convert wind direction in degrees to an arrow representation.
  */
 
 /**
  * Convert wind direction in degrees to an arrow representation.
  *
  * @param {number} deg - Wind direction in degrees.
+ * @memberof module:Utils
  */
 export function windArrowTx(deg) {
   if (deg == null) {

package/src/utils/wind/windLevel.js

@@ -1,5 +1,5 @@
 /**
- * @module utils
+ * Ordered list of wind levels.
  */
 
 /**
@@ -9,12 +9,14 @@
  * @property {string} color - Color representing this level
  * @property {string} tx - Text representing this level
  * @property {string} txEn - Text representing this level
+ * @memberof module:Utils
  */
 
 /**
  * Ordered list of wind levels.
  *
  * @type {WindLevel[]}
+ * @memberof module:Utils
  */
 const WIND_LEVELS = [
   { id: 1, speed: 8, color: "green", tx: "Brisa", txEn: "Breeze" },
@@ -36,6 +38,7 @@ const WIND_LEVELS = [
  *
  * @param {number} speed Wind speed in km/h
  * @return {WindLevel | null} Wind level object or null if speed is null
+ * @memberof module:Utils
  */
 export function getWindLevel(speed) {
   if (typeof speed !== "number") return null;