@angelrove/forecast-utils 1.1.19 → 1.1.20

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

@@ -1,9 +1,10 @@
 /**
  * Use the OpenWeather forecast API
- * @package OpenMeteo
+ * @module OpenMeteo
  *
  */
 export { useForecastCurrent } from "./current/useForecastCurrent";
 export { useForecastDaily } from "./daily/useForecastDaily";
 export { useForecastHourly } from "./hourly/useForecastHourly";
+export type { ForecastData, WeatherSymbol } from "./types";
 export { weatherSymbol } from "./weatherSymbol/weatherSymbol";

package/dist/types/OpenMeteo/types.d.ts

@@ -1,5 +1,4 @@
 /**
- * @memberof module:OpenMeteo
  */
 export type ForecastData = {
     data: any;

package/dist/types/OpenMeteo/weatherSymbol/weatherSymbol.d.ts

@@ -1,6 +1,5 @@
 import type { WeatherSymbol } from "../types";
 /**
  * Get weather symbol and description based on the weather code.
- * @memberof module:OpenMeteo
  */
 export declare function weatherSymbol(code: any, precipitation?: number | undefined, night?: boolean, dark?: boolean): WeatherSymbol;

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

@@ -1,2 +1,7 @@
-export { default as MoonCalc } from "./moon/MoonCalc.js";
-export { default as SunCalc } from "./sun/SunCalc.js";
+/**
+ * @module Astronomy
+ *
+ */
+export { MoonCalc } from "./moon/MoonCalc";
+export type { AstroPosition, MoonData, MoonDataExt, MoonTimes } from "./moon/types";
+export { SunCalc } from "./sun/SunCalc";

package/dist/types/astronomy/moon/MoonCalc.d.ts

@@ -1,85 +1,31 @@
-export default MoonCalc;
-export type AstroPosition = {
-    altitude: number;
-    azimuth: number;
-    direction: string;
-    /**
-     * ``
-     */
-    direction_full: string;
-};
-export type MoonDataExt = {
-    date: string;
-    time: string;
-    illumination: string;
-    phase: string;
-    phaseId: string;
-    emoji: string;
-    parallacticAngle: number;
-    angle: number;
-    position: AstroPosition;
-    next: object;
-};
-export type MoonData = {
-    position: AstroPosition;
-    next: {
-        newMoon: string;
-        fullMoon: string;
-    };
-};
-declare namespace MoonCalc {
-    export { data };
-    export { dataExt };
-    export { times };
-    export { emoji };
-    export { getUpOrDown };
-}
 /**
- * @param {number} latitude
- * @param {number} longitude
- * @param {Date} [date=new Date()]
- * @param {string} [language=es-ES]
- * @returns {MoonData} Moon info object
- * @memberof module:Astronomy/MoonCalc
- */
-declare function data(latitude: number, longitude: number, date?: Date, language?: string): MoonData;
-/**
- * Información de la luna para una fecha y hora dadas.
- * La fecha y hora se devolverán en la zona horaria local.
+ * MoonCalc for calculating moon times, positions, and phases.
+ *
+ *   import { MoonCalc } from ...
+ *
+ * Importante!:
+ * ¡Solo proporcionar HORA LOCAL DEL SISTEMA!: 'new Date()'
  *
- * @param {number} latitude
- * @param {number} longitude
- * @param {Date} [date=new Date()]
- * @param {string} [language=es-ES]
- * @returns {MoonDataExt} Full information
- * @memberof module:Astronomy/MoonCalc
  */
-declare function dataExt(latitude: number, longitude: number, date?: Date, language?: string): MoonDataExt;
+import type { MoonData, MoonDataExt, MoonTimes } from "./types.js";
 /**
- * @param {number} latitude
- * @param {number} longitude
- * @param {string} timezoneId
- * @param {Date} date
- * @returns {{rise: string, set: string, highest: string}} Moon times
- * @memberof module:Astronomy/MoonCalc
+ * MoonCalc.
+ * @ignore
  */
-declare function times(latitude: number, longitude: number, timezoneId: string, date?: Date): {
-    rise: string;
-    set: string;
-    highest: string;
+export declare const MoonCalc: {
+    data: typeof data;
+    dataExt: typeof dataExt;
+    times: typeof times;
+    emoji: typeof emoji;
+    getUpOrDown: typeof getUpOrDown;
 };
+export declare function data(latitude: number, longitude: number, date?: Date, language?: string): MoonData;
 /**
- * @param {number} latitude
- * @param {number} longitude
- * @param {Date} [date=new Date()]
- * @returns {string} Emoji of the moon phase
- * @memberof module:Astronomy/MoonCalc
- */
-declare function emoji(latitude: number, longitude: number, date?: Date): string;
-/**
- * @param {number} altitude
- * @param {Date} highest
- * @returns {string} - Up or down emoji
- * @memberof module:Astronomy/MoonCalc
+ * Información de la luna para una fecha y hora dadas.
+ * La fecha y hora se devolverán en la zona horaria local.
+ *
  */
-declare function getUpOrDown(altitude: number, highest: Date): string;
+export declare function dataExt(latitude: number, longitude: number, date?: Date, language?: string): MoonDataExt;
+export declare function emoji(latitude: number, longitude: number, date?: Date): string;
+export declare function times(latitude: number, longitude: number, timezoneId: string, date?: Date): MoonTimes;
+export declare function getUpOrDown(altitude: number, highest: Date): string;

package/dist/types/astronomy/moon/types.d.ts

@@ -0,0 +1,33 @@
+export type AstroPosition = {
+    altitude: number;
+    azimuth: number;
+    direction: string;
+    direction_full: string;
+};
+export type MoonDataExt = {
+    date: string;
+    time: string;
+    illumination: string;
+    phase: string;
+    phaseId: string;
+    emoji: string;
+    parallacticAngle: number;
+    angle: number;
+    position: AstroPosition;
+    next: {
+        newMoon: string;
+        fullMoon: string;
+    };
+};
+export type MoonData = {
+    position: AstroPosition;
+    next: {
+        newMoon: string;
+        fullMoon: string;
+    };
+};
+export type MoonTimes = {
+    rise: string;
+    set: string;
+    highest: string;
+};

package/dist/types/astronomy/sun/SunCalc.d.ts

@@ -1,12 +1,3 @@
-export default SunCalc;
-declare namespace SunCalc {
-    export { all };
-    export { times };
-    export { getSolarTime };
-    export { position };
-    export { getIsNight };
-    export { getPhase };
-}
 /**
  * @param {Date} date
  * @param {number} latitude
@@ -14,9 +5,8 @@ declare namespace SunCalc {
  * @param {string} timezoneId
  * @returns {{ sunTimes: object, sunPosition: object, sunPhase: string }}
  * { sunTimes: object, sunPosition: object, sunPhase: string }
- * @memberof module:Astronomy/SunCalc
  */
-declare function all(date: Date, latitude: number, longitude: number, timezoneId: string): {
+export function all(date: Date, latitude: number, longitude: number, timezoneId: string): {
     sunTimes: object;
     sunPosition: object;
     sunPhase: string;
@@ -28,9 +18,8 @@ declare function all(date: Date, latitude: number, longitude: number, timezoneId
  * @param {string} timezoneId
  * @returns {{ date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }}
  * { date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }
- * @memberof module:Astronomy/SunCalc
  */
-declare function times(date: Date, latitude: number, longitude: number, timezoneId: string): {
+export function times(date: Date, latitude: number, longitude: number, timezoneId: string): {
     date: Date;
     sunrise: string;
     sunset: string;
@@ -44,17 +33,15 @@ declare function times(date: Date, latitude: number, longitude: number, timezone
  * @param {string} offsetSign "+" or "-"
  * @param {number} offset UTC offset in hours
  * @returns {string} Local time in "HH:mm" format
- * @memberof module:Astronomy/SunCalc
  */
-declare function getSolarTime(date: Date, lng: number, offsetSign: string, offset: number): string;
+export function getSolarTime(date: Date, lng: number, offsetSign: string, offset: number): string;
 /**
  * @param {number} latitude
  * @param {number} longitude
  * @returns {{date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}}
  * {date: string, azimuth: number, direction: string, direction_full: string, altitude: number, zenith: number, declination: number}
- * @memberof module:Astronomy/SunCalc
  */
-declare function position(latitude: number, longitude: number, date?: Date, language?: string): {
+export function position(latitude: number, longitude: number, date?: Date, language?: string): {
     date: string;
     azimuth: number;
     direction: string;
@@ -70,13 +57,19 @@ declare function position(latitude: number, longitude: number, date?: Date, lang
  * @param {number | Date} date
  * @param {string} dateStr
  * @returns {boolean} true if it's night, false otherwise
- * @memberof module:Astronomy/SunCalc
  */
-declare function getIsNight(lat: number, lon: number, timezoneId: string, date: number | Date, dateStr: string): boolean;
+export function getIsNight(lat: number, lon: number, timezoneId: string, date: number | Date, dateStr: string): boolean;
 /**
  * @param {number} altitude
  * @param {string} noon
  * @returns {string} The phase of the sun based on its altitude
- * @memberof module:Astronomy/SunCalc
  */
-declare function getPhase(altitude: number, noon: string): string;
+export function getPhase(altitude: number, noon: string): string;
+export namespace SunCalc {
+    export { all };
+    export { times };
+    export { getSolarTime };
+    export { position };
+    export { getIsNight };
+    export { getPhase };
+}

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

@@ -1,32 +1,8 @@
-/**
- * @memberof module:Geolocation
- * @typedef {object} ResolvedLocation
- * @property {number} latitude
- * @property {number} longitude
- * // Address
- * @property {string} sublocality
- * @property {string} locality
- * @property {string} country
- * @property {string} country_short
- * @property {string} formatted_address
- */
+import type { ResolvedLocation } from "./types";
 /**
  * Get the current geolocation of the device and reverse geocode it to get the address.
  *
- * @memberof module:Geolocation
- * @returns {Promise<ResolvedLocation>} Promise
+ * @returns {Promise<ResolvedLocation>} Resolved location object.
  * @throws {Error} If geolocation is not supported or permission is denied.
  */
-export function getGeolocation(): Promise<ResolvedLocation>;
-export type ResolvedLocation = {
-    latitude: number;
-    /**
-     * // Address
-     */
-    longitude: number;
-    sublocality: string;
-    locality: string;
-    country: string;
-    country_short: string;
-    formatted_address: string;
-};
+export declare function getGeolocation(): Promise<ResolvedLocation>;

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

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

package/dist/types/geolocation/lib/reversegeocoding.d.ts

@@ -1,19 +1,11 @@
+import type { GeocodingAddress } from "../types";
 /**
  * Reverse Geocoding with GoogleMaps API
  *
  * @see https://developers.google.com/maps/documentation/geocoding/requests-reverse-geocoding?hl=es-419
  * @see https://maps.googleapis.com/maps/api/geocode/json?latlng=36.7248,-4.541&key=[api_key]&result_type=sublocality
  *
- * @param {number} latitude - Latitude of the location.
- * @param {number} longitude - Longitude of the location.
- * @param {string} api_key - Google Maps API key.
- * @returns {Promise<{ sublocality: string; locality: string; country: string; country_short: string; formatted_address: string; }>} - The address components.
+ * @returns {Promise<GeocodingAddress>} - The address components.
  * @throws {Error} - If the API key is invalid or the request fails.
  */
-export default function reverseGeocoding(latitude: number, longitude: number, api_key: string): Promise<{
-    sublocality: string;
-    locality: string;
-    country: string;
-    country_short: string;
-    formatted_address: string;
-}>;
+export default function reverseGeocoding(latitude: number, longitude: number, api_key: string): Promise<GeocodingAddress>;

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

@@ -1,5 +1,4 @@
 /**
- * @memberof module:Geolocation
  * @typedef {object} LocalTimeData
  * @property {Date} time - The local time.
  * @property {string} timeStr - The formatted local time string.
@@ -17,7 +16,6 @@
  * @param {number} lng
  * @returns {Promise<any | LocalTimeData>} An object containing the local time and timezone information:
  * @throws {Error} If the API request fails or returns an error status.
- * @memberof module:Geolocation
  */
 export function timeFromLocation(apiKey: string, lat: number, lng: number): Promise<any | LocalTimeData>;
 export type LocalTimeData = {

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

@@ -0,0 +1,16 @@
+export type GeocodingAddress = {
+    sublocality: string;
+    locality: string;
+    country: string;
+    country_short: string;
+    formatted_address: string;
+};
+export type ResolvedLocation = {
+    latitude: number;
+    longitude: number;
+    sublocality: string;
+    locality: string;
+    country: string;
+    country_short: string;
+    formatted_address: string;
+};

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-export { default as MoonCalc } from "./astronomy/moon/MoonCalc";
-export { default as SunCalc } from "./astronomy/sun/SunCalc";
+export { MoonCalc } from "./astronomy/moon/MoonCalc";
+export { SunCalc } from "./astronomy/sun/SunCalc";
 export { timeFromLocation } from "./geolocation/timeFromLocation";
-export { default as TimeDateStr } from "./utils/timehelpers";
+export { TimeDateStr } from "./utils/timehelpers";
 export { getGeolocation } from "./geolocation/getGeolocation";
 export { useForecastCurrent } from "./OpenMeteo/current/useForecastCurrent";
 export { useForecastDaily } from "./OpenMeteo/daily/useForecastDaily";

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

@@ -4,7 +4,6 @@
  * @param {number} degrees
  * @param {string} language - Language code ("en-US", "es-ES", "auto")
  * @returns {{short: string, full: string}} {short: string, full: string}
- * @memberof module:Utils
  */
 export function degreesToCompass(degrees: number, language?: string): {
     short: string;

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

@@ -1,9 +1,10 @@
 /**
  * @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 { degreesToCompass } from "./degreesToCompass";
+export { TimeDateStr } from "./timehelpers";
+export { getWarning, getWarningByDays } from "./warning";
+export { WindArrow } from "./wind/WindArrow";
+export { windArrowTx } from "./wind/windArrowTx";
+export { getWindLevel } from "./wind/windLevel";
+export type { WindLevel } from "./wind/windLevel";

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

@@ -1,5 +1,4 @@
-export default TimeDateStr;
-declare namespace TimeDateStr {
+export namespace TimeDateStr {
     export { dateFormat };
     export { nowString };
     export { timeString };
@@ -10,7 +9,6 @@ declare namespace TimeDateStr {
  *
  * @param {Date} [date=new Date()] La fecha a formatear.
  * @returns {string} La fecha formateada.
- * @memberof module:Utils/TimeDateStr
  */
 declare function dateFormat(date?: Date): string;
 /**
@@ -18,7 +16,6 @@ declare function dateFormat(date?: Date): string;
  *
  * @param {boolean} sec
  * @returns {String} now time as a formated string
- * @memberof module:Utils/TimeDateStr
  */
 declare function nowString(sec?: boolean): string;
 /**
@@ -27,7 +24,6 @@ declare function nowString(sec?: boolean): string;
  * @param {Date} [date]
  * @param {boolean} [sec=false]
  * @returns {string} La fecha formateada.
- * @memberof module:Utils/TimeDateStr
  */
 declare function timeString(date?: Date, sec?: boolean): string;
 /**
@@ -36,6 +32,6 @@ declare function timeString(date?: Date, sec?: boolean): string;
  * @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:Utils/TimeDateStr
  */
 declare function getLocalTimeFromTz(timeZone: string, date?: Date | number): string;
+export {};

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

@@ -7,7 +7,6 @@
  * @param {number} showersSumTomorrow
  * @returns {{ levelNum: number, level: string, message: string, day: number } | null}
  * {{ levelNum: number, level: string, message: string, day: number } | null}
- * @memberof module:Utils
  */
 export function getWarningByDays(precipitationSumToday: number, precipitationSumTomorrow: number, showersSumToday: number, showersSumTomorrow: number): {
     levelNum: number;
@@ -18,12 +17,10 @@ export function getWarningByDays(precipitationSumToday: number, precipitationSum
 /**
  * Get warning by precipitation and showers
  *
- * @export
  * @param {number} precipitation
  * @param {number} showers
  * @returns {{ levelNum: number, level: string, message: string } | null}
  * {{ levelNum: number, level: string, message: string } | null}
- * @memberof module:Utils
  */
 export function getWarning(precipitation: number, showers: number): {
     levelNum: number;

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

@@ -1,13 +1,11 @@
 /**
  * SVG arrow indicating wind direction.
  *
- * @component JSX
  * @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).
  * @param {string} [props.className] - Additional CSS classes.
- * @memberof module:Utils
  */
 export function WindArrow({ deg, size, strokeWidth, className, }: {
     deg: number;

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

@@ -3,6 +3,5 @@
  *
  * @param {number} deg - Wind direction in degrees.
  * @returns {string} Arrow representation of the wind direction.
- * @memberof module:Utils
  */
 export function windArrowTx(deg: number): string;

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

@@ -1,30 +1,14 @@
-/**
- * Return the wind level based on the speed.
- *
- * @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: number): WindLevel | null;
 export type WindLevel = {
-    /**
-     * - Level ID
-     */
     id: number;
-    /**
-     * - Minimum wind speed for this level
-     */
     speed: number;
-    /**
-     * - Color representing this level
-     */
     color: string;
-    /**
-     * - Text representing this level
-     */
     tx: string;
-    /**
-     * - Text representing this level
-     */
     txEn: string;
 };
+/**
+ * Return the wind level based on the speed.
+ *
+ * @param speed Wind speed in km/h
+ * @return Wind level object or null if speed is null
+ */
+export declare function getWindLevel(speed: number): WindLevel | null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jose Angel Romero Vegas",
   "name": "@angelrove/forecast-utils",
-  "version": "1.1.19",
+  "version": "1.1.20",
   "description": "Utilities for obtaining weather and astronomy forecast data.",
   "license": "MIT",
   "publishConfig": {
@@ -10,7 +10,7 @@
   "homepage": "https://github.com/angelrove/forecast-utils",
   "type": "module",
   "scripts": {
-    "docs:md": "bunx jsdoc2md --separators $(cat jsdoc-files.txt) > README.md ; cat README_HEAD.md README.md > temp && mv temp README.md; echo Remember add new files to - jsdoc-files.txt -!!!"
+    "docs": "typedoc"
   },
   "types": "dist/types/index.d.ts",
   "exports": {
@@ -41,7 +41,10 @@
     "@biomejs/biome": "2.2.4",
     "@types/react": "^19.1.12",
     "@types/react-dom": "^19.1.9",
-    "jsdoc-to-markdown": "^9.1.2",
     "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "typedoc": "^0.28.12",
+    "typedoc-plugin-markdown": "^4.8.1"
   }
 }

package/src/OpenMeteo/index.ts

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

package/src/OpenMeteo/types.ts

@@ -1,5 +1,4 @@
 /**
- * @memberof module:OpenMeteo
  */
 
 export type ForecastData = {

package/src/OpenMeteo/weatherSymbol/weatherSymbol.ts

@@ -3,7 +3,6 @@ import { getWeatherCodeEntry } from "./lib/getWeatherCodeEntry.js";
 
 /**
  * Get weather symbol and description based on the weather code.
- * @memberof module:OpenMeteo
  */
 export function weatherSymbol(
   code: any,

package/src/astronomy/index.ts

@@ -1,2 +1,9 @@
-export { default as MoonCalc } from "./moon/MoonCalc.js";
-export { default as SunCalc } from "./sun/SunCalc.js";
+/**
+ * @module Astronomy
+ *
+ */
+
+export { MoonCalc } from "./moon/MoonCalc";
+export type { AstroPosition, MoonData, MoonDataExt, MoonTimes } from "./moon/types";
+export { SunCalc } from "./sun/SunCalc";
+