@angelrove/forecast-utils 1.1.1

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

@@ -0,0 +1,13 @@
+/**
+ * @param {string} url
+ */
+export function fetcher(url: string): Promise<any>;
+/**
+ * Get path for OpenMeteo API
+ *
+ * @param {number} lat
+ * @param {number} lon
+ * @param {string} path
+ * @returns {string}
+ */
+export function getPath(lat: number, lon: number, path: string): string;

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

@@ -0,0 +1 @@
+export const fetchParams: string;

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

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+export default function transformer(data: {
+    current: any;
+    daily: any;
+    hourly: any;
+    latitude: number;
+    longitude: number;
+}): Object | null;

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

@@ -0,0 +1,14 @@
+/**
+ * Custom hook to fetch current weather data from OpenMeteo API.
+ *
+ * @param {number} lat
+ * @param {number} lon
+ * @param {number} refreshIntervalMin
+ * @returns {{ data: any, apiUrl: string, isLoading: boolean, isError: any }}
+ */
+export function useForecastCurrent(lat: number, lon: number, refreshIntervalMin?: number): {
+    data: any;
+    apiUrl: string;
+    isLoading: boolean;
+    isError: any;
+};

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

@@ -0,0 +1 @@
+export const fetchParams: string;

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

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+export default function transformer(data: {
+    daily: any;
+}): Object | null;

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

@@ -0,0 +1,14 @@
+/**
+ * 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 {{ data: any, isLoading: boolean, isError: any }}
+ */
+export function useForecastDaily(lat: number, lon: number, refreshIntervalMin?: number): {
+    data: any;
+    isLoading: boolean;
+    isError: any;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Get the start and end dates based on the number of days from today.
+ *
+ * @param {number} numDay
+ * @returns {{startDate: string, endDate: string}} - An object containing the start and end dates in YYYY-MM-DD format.
+ */
+export function getDatesFromNumDays(numDay: number): {
+    startDate: string;
+    endDate: string;
+};

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

@@ -0,0 +1 @@
+export const fetchParams: string;

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

@@ -0,0 +1,15 @@
+/**
+ * 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 {{ data: any, isLoading: boolean, isError: any }}
+ */
+export function useForecastHourly(location: {
+    latitude: number;
+    longitude: number;
+}, dayNum: number): {
+    data: any;
+    isLoading: boolean;
+    isError: any;
+};

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

@@ -0,0 +1,43 @@
+/**
+ * WMO Weather interpretation codes (WW)
+ *
+ * @link https://open-meteo.com/en/docs?hourly=temperature_2m,weather_code&daily=weather_code#weather_variable_documentation
+ * @link https://www.meteomatics.com/en/api/available-parameters/derived-weather-and-convenience-parameters/general-weather-state/
+ *
+ * Code	      Description
+ * 0          Clear sky
+ * 1, 2, 3    Mainly clear, partly cloudy, and overcast
+ * 45, 48	    Fog and depositing rime fog
+ * 51, 53, 55	Drizzle: Light, moderate, and dense intensity
+ * 56, 57	    Freezing Drizzle: Light and dense intensity
+ * 61, 63, 65	Rain: Slight, moderate and heavy intensity
+ * 66, 67	    Freezing Rain: Light and heavy intensity
+ * 71, 73, 75	Snow fall: Slight, moderate, and heavy intensity
+ * 77	        Snow grains
+ * 80, 81, 82	Rain showers: Slight, moderate, and violent
+ * 85, 86	    Snow showers slight and heavy
+ * 95 *	      Thunderstorm: Slight or moderate
+ * 96, 99 *	  Thunderstorm with slight and heavy hail
+ */
+/**
+ * @typedef {Object} WeatherCodeEntry
+ * @property {number} code - WMO Weather interpretation codes (WW).
+ * @property {string} icon - Icon name.
+ * @property {string} description - Description.
+ */
+/** @type {WeatherCodeEntry[]} */
+export const weatherCodes: WeatherCodeEntry[];
+export type WeatherCodeEntry = {
+    /**
+     * - WMO Weather interpretation codes (WW).
+     */
+    code: number;
+    /**
+     * - Icon name.
+     */
+    icon: string;
+    /**
+     * - Description.
+     */
+    description: string;
+};

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

@@ -0,0 +1,43 @@
+/**
+ * WMO Weather interpretation codes (WW)
+ *
+ * @link https://open-meteo.com/en/docs?hourly=temperature_2m,weather_code&daily=weather_code#weather_variable_documentation
+ * @link https://www.meteomatics.com/en/api/available-parameters/derived-weather-and-convenience-parameters/general-weather-state/
+ *
+ * Code	      Description
+ * 0          Clear sky
+ * 1, 2, 3    Mainly clear, partly cloudy, and overcast
+ * 45, 48	    Fog and depositing rime fog
+ * 51, 53, 55	Drizzle: Light, moderate, and dense intensity
+ * 56, 57	    Freezing Drizzle: Light and dense intensity
+ * 61, 63, 65	Rain: Slight, moderate and heavy intensity
+ * 66, 67	    Freezing Rain: Light and heavy intensity
+ * 71, 73, 75	Snow fall: Slight, moderate, and heavy intensity
+ * 77	        Snow grains
+ * 80, 81, 82	Rain showers: Slight, moderate, and violent
+ * 85, 86	    Snow showers slight and heavy
+ * 95 *	      Thunderstorm: Slight or moderate
+ * 96, 99 *	  Thunderstorm with slight and heavy hail
+ */
+/**
+ * @typedef {Object} WeatherCodeEntry
+ * @property {number} code - WMO Weather interpretation codes (WW).
+ * @property {string} icon - Icon name.
+ * @property {string} description - Description.
+ */
+/** @type {WeatherCodeEntry[]} */
+export const weatherCodes: WeatherCodeEntry[];
+export type WeatherCodeEntry = {
+    /**
+     * - WMO Weather interpretation codes (WW).
+     */
+    code: number;
+    /**
+     * - Icon name.
+     */
+    icon: string;
+    /**
+     * - Description.
+     */
+    description: string;
+};

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

@@ -0,0 +1,7 @@
+/**
+ * Returns weather code info o undefined if not found.
+ *
+ * @param {number} code - WMO Weather interpretation code.
+ * @returns {WeatherCodeEntry | undefined}
+ */
+export function getWeatherCodeEntry(code: number): any | undefined;

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

@@ -0,0 +1,13 @@
+/**
+ * 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 }}
+ */
+export function weatherSymbol(code: any, precipitation?: number | undefined, night?: boolean, dark?: boolean): {
+    icon: string;
+    description: string;
+};

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

@@ -0,0 +1,63 @@
+export default MoonCalc;
+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}
+ */
+declare function data(latitude: number, longitude: number, date?: Date | undefined, language?: string | undefined): MoonData;
+/**
+ * Información de la luna para una fecha y hora dadas.
+ * La fecha y hora se devolverán en la zona horaria local.
+ *
+ * @param {number} latitude
+ * @param {number} longitude
+ * @param {Date} [date=new Date()]
+ * @param {string} [language=es-ES]
+ * @returns {{ date: string, time: string, illumination: string, phase: string, phaseId: string, emoji: string, parallacticAngle: number, angle: number, position: AstroPosition, next: object }}
+ */
+declare function dataExt(latitude: number, longitude: number, date?: Date | undefined, language?: string | undefined): {
+    date: string;
+    time: string;
+    illumination: string;
+    phase: string;
+    phaseId: string;
+    emoji: string;
+    parallacticAngle: number;
+    angle: number;
+    position: AstroPosition;
+    next: object;
+};
+/**
+ * @param {number} latitude
+ * @param {number} longitude
+ * @param {string} timezoneId
+ * @param {Date} date
+ * @returns {{rise: string, set: string, highest: string}}
+ */
+declare function times(latitude: number, longitude: number, timezoneId: string, date?: Date): {
+    rise: string;
+    set: string;
+    highest: string;
+};
+/**
+ * @param {number} latitude
+ * @param {number} longitude
+ * @param {Date} [date=new Date()]
+ * @returns {string} - Emoji of the moon phase
+ */
+declare function emoji(latitude: number, longitude: number, date?: Date | undefined): string;
+/**
+ * @param {number} altitude
+ * @param {Date} highest
+ * @returns {string} - Up or down emoji
+ */
+declare function getUpOrDown(altitude: number, highest: Date): string;

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

@@ -0,0 +1,8 @@
+/**
+ * Parse basic data from SunCalc
+ *
+ * @param {any} data
+ * @param {string} language
+ * @returns {MoonData}
+ */
+export function parseBasicData(data: any, language: string): MoonData;

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

@@ -0,0 +1,73 @@
+export default SunCalc;
+declare namespace SunCalc {
+    export { all };
+    export { times };
+    export { getSolarTime };
+    export { position };
+    export { getIsNight };
+    export { getPhase };
+}
+/**
+ * @param {Date} date
+ * @param {number} latitude
+ * @param {number} longitude
+ * @param {string} timezoneId
+ * @returns {{ sunTimes: object, sunPosition: object, sunPhase: string }}
+ */
+declare function all(date: Date, latitude: number, longitude: number, timezoneId: string): {
+    sunTimes: object;
+    sunPosition: object;
+    sunPhase: string;
+};
+/**
+ * @param {Date} date
+ * @param {number} latitude
+ * @param {number} longitude
+ * @param {string} timezoneId
+ * @returns {{ date: Date, sunrise: string, sunset: string, noon: string, dawn: string, dusk: string }}
+ */
+declare function times(date: Date, latitude: number, longitude: number, timezoneId: string): {
+    date: Date;
+    sunrise: string;
+    sunset: string;
+    noon: string;
+    dawn: string;
+    dusk: string;
+};
+/**
+ * @param {Date} date
+ * @param {number} lng
+ * @param {string} offsetSign - "+" or "-"
+ * @param {number} offset - UTC offset in hours
+ * @returns {string} - Local time in "HH:mm" format
+ */
+declare 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}}
+ */
+declare function position(latitude: number, longitude: number, date?: Date, language?: string): {
+    date: string;
+    azimuth: number;
+    direction: string;
+    direction_full: string;
+    altitude: number;
+    zenith: number;
+    declination: number;
+};
+/**
+ * @param {number} lat
+ * @param {number} lon
+ * @param {string} timezoneId
+ * @param {number | Date} date
+ * @param {string} dateStr
+ * @returns {boolean} - true if it's night, false otherwise
+ */
+declare 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
+ */
+declare function getPhase(altitude: number, noon: string): string;

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

@@ -0,0 +1,10 @@
+/**
+ * Google API: Get local time from any location
+ *
+ * @param {string} apiKey - GoogleMaps API key.
+ * @param {number} lat
+ * @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.
+ */
+export function getLocalTimeInfo(apiKey: string, lat: number, lng: number): Promise<any | LocalTimeData>;

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

@@ -0,0 +1,27 @@
+/**
+ * @module astronomy/time-date
+ */
+/**
+ * Formatea una fecha a un string legible.
+ *
+ * @param {Date} [date]
+ * @param {boolean} [sec=false]
+ * @returns {string} La fecha formateada.
+ */
+export function timeString(date?: Date | undefined, sec?: boolean | undefined): string;
+export function nowString(sec?: boolean): string;
+/**
+ * Formatea una fecha a un string legible.
+ *
+ * @param {Date} [date=new Date()] La fecha a formatear.
+ * @returns {string} La fecha formateada.
+ */
+export function dateFormat(date?: Date | undefined): string;
+/**
+ * Get local time from timezone
+ *
+ * @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.
+ */
+export function getLocalTimeFromTz(timeZone: string, date?: number | Date | undefined): string;

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

@@ -0,0 +1,43 @@
+type AstroPosition = {
+    altitude: number;
+    azimuth: number;
+    direction: string;
+    direction_full: string;
+};
+type MoonData = {
+    position: AstroPosition;
+    next: {
+        newMoon: string;
+        fullMoon: string;
+    };
+};
+type LocalTimeData = {
+    /**
+     * - The local time.
+     */
+    time: Date;
+    /**
+     * - The formatted local time string.
+     */
+    timeStr: string;
+    /**
+     * - The timezone name.
+     */
+    timezone: string;
+    /**
+     * - The timezone ID.
+     */
+    timezoneId: string;
+    /**
+     * - The UTC offset in hours.
+     */
+    offset: number;
+    /**
+     * - The sign of the offset ('+' or '-').
+     */
+    offsetSign: string;
+    /**
+     * - The DST offset in hours.
+     */
+    dstOffset: number;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ */
+export function getGeolocation(): Promise<{
+    latitude: number;
+    longitude: number;
+    formatted_address: string;
+}>;

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

@@ -0,0 +1,10 @@
+/**
+ * Get the current geolocation of the device with the browser.
+ *
+ * @returns {Promise<{latitude: number, longitude: number}>}
+ * @throws {Error} If geolocation is not supported or permission is denied.
+ */
+export default function geolocation(): Promise<{
+    latitude: number;
+    longitude: number;
+}>;

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

@@ -0,0 +1,10 @@
+/**
+ * Get the current GPS location of the device with Capacitor.
+ *
+ * @returns {Promise<{latitude: number, longitude: number}>}
+ * @throws {Error} If geolocation is not supported or permission is denied.
+ */
+export default function geolocationCapacitor(): Promise<{
+    latitude: number;
+    longitude: number;
+}>;

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

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ * @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;
+}>;

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export { default as MoonCalc } from "./astronomy/moon/MoonCalc.js";
+export { default as SunCalc } from "./astronomy/sun/SunCalc.js";
+export { getLocalTimeInfo as getLocalTime } from "./astronomy/timeZoneInfo.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 { dateFormat, getLocalTimeFromTz, nowString, timeString } from "./astronomy/timehelpers.js";
+export { getWarning, getWarningByDays } from "./utils/warning.js";

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

@@ -0,0 +1,11 @@
+/**
+ * Convert degrees to compass designation
+ *
+ * @param {number} degrees
+ * @param {string} language - Language code ("en-US", "es-ES", "auto")
+ * @returns {{short: string, full: string}}
+ */
+export function degreesToCompass(degrees: number, language?: string): {
+    short: string;
+    full: string;
+};

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

@@ -0,0 +1,46 @@
+/**
+ * Get warning by today and tomorrow
+ *
+ * @param {number} precipitationSumToday
+ * @param {number} precipitationSumTomorrow
+ * @param {number} showersSumToday
+ * @param {number} showersSumTomorrow
+ * @returns {{ levelNum: number, level: string, message: string, day: number } | null}
+ */
+export function getWarningByDays(precipitationSumToday: number, precipitationSumTomorrow: number, showersSumToday: number, showersSumTomorrow: number): {
+    levelNum: number;
+    level: string;
+    message: string;
+    day: number;
+} | null;
+/**
+ * Get warning by precipitation and showers
+ *
+ * @export
+ * @param {number} precipitation
+ * @param {number} showers
+ * @returns {{ levelNum: number, level: string, message: string } | null}
+ */
+export function getWarning(precipitation: number, showers: number): {
+    levelNum: number;
+    level: string;
+    message: string;
+} | null;
+export type AlertLevel = {
+    /**
+     * - The alert level number.
+     */
+    levelNum: number;
+    /**
+     * - The alert level string (e.g., "red", "orange", "yellow").
+     */
+    level: string;
+    /**
+     * - The precipitation threshold for the alert level.
+     */
+    precipitation: number;
+    /**
+     * - The showers threshold for the alert level.
+     */
+    showers: number;
+};

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

@@ -0,0 +1,32 @@
+/**
+ * @module utils:WindArrow
+ */
+/**
+ * @typedef {Object} WindArrowProps
+ * @property {number} props.deg - Wind direction in degrees
+ * @property {string} [props.size] - Size of the arrow (Tailwind CSS size: 'size-10')
+ * @property {number} [props.strokeWidth] - Stroke width of the arrow (1 to 6)
+ * @property {string} [props.className]
+ */
+/**
+ * Wind direction arrow component (svg image).
+ *
+ * @component
+ * @param {WindArrowProps} props
+ */
+export function WindArrow({ deg, size, strokeWidth, className, }: WindArrowProps): any;
+export type WindArrowProps = {
+    /**
+     * - Wind direction in degrees
+     */
+    deg: number;
+    /**
+     * - Size of the arrow (Tailwind CSS size: 'size-10')
+     */
+    size?: string;
+    /**
+     * - Stroke width of the arrow (1 to 6)
+     */
+    strokeWidth?: number;
+    className?: string;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * @module utils
+ */
+/**
+ * Convert wind direction in degrees to an arrow representation.
+ *
+ * @param {number} deg - Wind direction in degrees.
+ */
+export function windArrowTx(deg: number): "deg?" | "↓" | "↙" | "←" | "↖" | "↑" | "↗" | "→" | "↘" | undefined;

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

@@ -0,0 +1,29 @@
+/**
+ * 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
+ */
+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;
+};