@angelrove/forecast-utils 1.1.13 → 1.1.15

package/README.md

@@ -1,3 +1,13 @@
+# @forecast-utils
+
+Several utility libraries for my "tierracolora.com" project.
+
+Includes directory `images/ws` with weather images (symbols)
+
+I use private libraries for the following:
+- Astronomy calculations: `suncalc3`
+
+# Documentation
 ## Modules
 
 <dl>
@@ -17,7 +27,8 @@ Con excepción de &#39;getSolarTime()&#39;: recibe la hora local correspondiente
 <dt><a href="#module_Geolocation">Geolocation</a></dt>
 <dd></dd>
 <dt><a href="#module_OpenMeteo">OpenMeteo</a></dt>
-<dd></dd>
+<dd><p>Use the OpenWeather forecast API</p>
+</dd>
 <dt><a href="#module_Utils">Utils</a></dt>
 <dd></dd>
 <dt><a href="#module_Utils/TimeDateStr">Utils/TimeDateStr</a></dt>
@@ -298,8 +309,9 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 ## Geolocation
 
 * [Geolocation](#module_Geolocation)
-    * [.exports.getGeolocation()](#module_Geolocation.exports.getGeolocation) ⇒ <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code>
+    * [.exports.getGeolocation()](#module_Geolocation.exports.getGeolocation) ⇒ <code>Promise.&lt;ResolvedLocation&gt;</code>
     * [.exports.timeFromLocation(apiKey, lat, lng)](#module_Geolocation.exports.timeFromLocation) ⇒ <code>Promise.&lt;(any\|LocalTimeData)&gt;</code>
+    * [.ResolvedLocation](#module_Geolocation.ResolvedLocation) : <code>Object</code>
     * [.LocalTimeData](#module_Geolocation.LocalTimeData) : <code>Object</code>
 
 
@@ -307,11 +319,11 @@ Con excepción de 'getSolarTime()': recibe la hora local correspondiente a la lo
 
 <a name="module_Geolocation.exports.getGeolocation"></a>
 
-### Geolocation.exports.getGeolocation() ⇒ <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code>
+### Geolocation.exports.getGeolocation() ⇒ <code>Promise.&lt;ResolvedLocation&gt;</code>
 Get the current geolocation of the device and reverse geocode it to get the address.
 
 **Kind**: static method of [<code>Geolocation</code>](#module_Geolocation)  
-**Returns**: <code>Promise.&lt;{latitude: number, longitude: number, formatted\_address: string}&gt;</code> - Promise  
+**Returns**: <code>Promise.&lt;ResolvedLocation&gt;</code> - Promise  
 **Throws**:
 
 - <code>Error</code> If geolocation is not supported or permission is denied.
@@ -338,6 +350,25 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 | lng | <code>number</code> |  |
 
 
+* * *
+
+<a name="module_Geolocation.ResolvedLocation"></a>
+
+### Geolocation.ResolvedLocation : <code>Object</code>
+**Kind**: static typedef of [<code>Geolocation</code>](#module_Geolocation)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| latitude | <code>number</code> |  |
+| longitude | <code>number</code> | // Address |
+| sublocality | <code>string</code> |  |
+| locality | <code>string</code> |  |
+| country | <code>string</code> |  |
+| country_short | <code>string</code> |  |
+| formatted_address | <code>string</code> |  |
+
+
 * * *
 
 <a name="module_Geolocation.LocalTimeData"></a>
@@ -362,6 +393,8 @@ Get local time from a given location (lat, lng) using 'GoogleMaps TimeZone' API.
 <a name="module_OpenMeteo"></a>
 
 ## OpenMeteo
+Use the OpenWeather forecast API
+
 
 * [OpenMeteo](#module_OpenMeteo)
     * [.exports.useForecastCurrent(lat, lon, refreshIntervalMin)](#module_OpenMeteo.exports.useForecastCurrent) ⇒ <code>ForecastData</code>
@@ -394,6 +427,7 @@ Custom hook to fetch current weather data from OpenMeteo API.
 
 ### OpenMeteo.exports.useForecastDaily(lat, lon, refreshIntervalMin) ⇒ <code>ForecastData</code>
 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
 
 **Kind**: static method of [<code>OpenMeteo</code>](#module_OpenMeteo)  

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

@@ -1,12 +1,32 @@
+/**
+ * @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
+ */
 /**
  * Get the current geolocation of the device and reverse geocode it to get the address.
  *
- * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>} Promise
- * @throws {Error} If geolocation is not supported or permission is denied.
  * @memberof module:Geolocation
+ * @returns {Promise<ResolvedLocation>} Promise
+ * @throws {Error} If geolocation is not supported or permission is denied.
  */
-export function getGeolocation(): Promise<{
+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;
-}>;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Jose Angel Romero Vegas",
   "name": "@angelrove/forecast-utils",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "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"
+    "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 -!!!"
   },
   "types": "dist/types/index.d.ts",
   "exports": {

package/src/OpenMeteo/index.js

@@ -1,4 +1,5 @@
 /**
+ * Use the OpenWeather forecast API
  * @module OpenMeteo
  *
  */

package/src/geolocation/getGeolocation.js

@@ -1,15 +1,28 @@
 import geolocationCapacitor from "./lib/geolocation.js";
 import reverseGeocoding from "./lib/reversegeocoding.js";
 
+/**
+ * @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
+ */
+
 /**
  * Get the current geolocation of the device and reverse geocode it to get the address.
  *
- * @returns {Promise<{latitude: number, longitude: number, formatted_address: string}>} Promise
- * @throws {Error} If geolocation is not supported or permission is denied.
  * @memberof module:Geolocation
+ * @returns {Promise<ResolvedLocation>} Promise
+ * @throws {Error} If geolocation is not supported or permission is denied.
  */
 export async function getGeolocation() {
-  let location = null;
+  let location;
   let address = null;
 
   // Location ---
@@ -33,6 +46,10 @@ export async function getGeolocation() {
     const message = error instanceof Error ? error.message : error;
     console.log("reverseGeocoding - error: ", message);
     address = {
+      sublocality: "",
+      locality: "",
+      country: "",
+      country_short: "",
       formatted_address:
         "[" + location.latitude + ", " + location.longitude + "]",
     };
@@ -40,8 +57,13 @@ export async function getGeolocation() {
 
   // Return data ---
   return {
-    ...location,
-    ...address,
+    latitude: location.latitude,
+    longitude: location.longitude,
+    sublocality: address.sublocality,
+    locality: address.locality,
+    country: address.country,
+    country_short: address.country_short,
+    formatted_address: address.formatted_address,
   };
 }
 //--------------------------------------------

package/src/index.js

@@ -1,14 +1,3 @@
-/**
- * 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
- */
-
 // Astronomy
 export { default as MoonCalc } from "./astronomy/moon/MoonCalc.js";
 export { default as SunCalc } from "./astronomy/sun/SunCalc.js";