@capgo/nativegeocoder 0.1.12 → 0.1.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Capgo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -54,12 +54,16 @@ This API requires the following permissions be added to your `AndroidManifest.xm
 reverseGeocode(options: reverseOptions) => Promise<{ addresses: Adress[]; }>
 ```
 
+Convert latitude and longitude to an address
+
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#reverseoptions">reverseOptions</a></code> |
 
 **Returns:** <code>Promise&lt;{ addresses: Adress[]; }&gt;</code>
 
+**Since:** 0.0.1
+
 --------------------
 
 
@@ -69,12 +73,16 @@ reverseGeocode(options: reverseOptions) => Promise<{ addresses: Adress[]; }>
 forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Adress[]; }>
 ```
 
+Convert an address to latitude and longitude
+
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#forwardoptions">ForwardOptions</a></code> |
 
 **Returns:** <code>Promise&lt;{ addresses: Adress[]; }&gt;</code>
 
+**Since:** 0.0.1
+
 --------------------
 
 
@@ -85,8 +93,8 @@ forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Adress[]; }>
 
 | Prop                        | Type                  |
 | --------------------------- | --------------------- |
-| **`latitude`**              | <code>string</code>   |
-| **`longitude`**             | <code>string</code>   |
+| **`latitude`**              | <code>number</code>   |
+| **`longitude`**             | <code>number</code>   |
 | **`countryCode`**           | <code>string</code>   |
 | **`postalCode`**            | <code>string</code>   |
 | **`administrativeArea`**    | <code>string</code>   |
@@ -101,24 +109,27 @@ forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Adress[]; }>
 
 #### reverseOptions
 
-| Prop                | Type                 |
-| ------------------- | -------------------- |
-| **`latitude`**      | <code>number</code>  |
-| **`longitude`**     | <code>number</code>  |
-| **`useLocale`**     | <code>boolean</code> |
-| **`defaultLocale`** | <code>string</code>  |
-| **`maxResults`**    | <code>number</code>  |
-| **`apiKey`**        | <code>string</code>  |
+| Prop                | Type                 | Description                                                              |
+| ------------------- | -------------------- | ------------------------------------------------------------------------ |
+| **`latitude`**      | <code>number</code>  | latitude is a number representing the latitude of the location.          |
+| **`longitude`**     | <code>number</code>  | longitude is a number representing the longitude of the location.        |
+| **`useLocale`**     | <code>boolean</code> | Localise the results to the given locale.                                |
+| **`defaultLocale`** | <code>string</code>  | locale is a string in the format of language_country, for example en_US. |
+| **`maxResults`**    | <code>number</code>  | Max number of results to return.                                         |
+| **`apiKey`**        | <code>string</code>  | Only used for web platform to use google api                             |
 
 
 #### ForwardOptions
 
-| Prop                | Type                 |
-| ------------------- | -------------------- |
-| **`addressString`** | <code>string</code>  |
-| **`useLocale`**     | <code>boolean</code> |
-| **`defaultLocale`** | <code>string</code>  |
-| **`maxResults`**    | <code>number</code>  |
-| **`apiKey`**        | <code>string</code>  |
+| Prop                | Type                 | Description                                                              |
+| ------------------- | -------------------- | ------------------------------------------------------------------------ |
+| **`addressString`** | <code>string</code>  | address is a string of the address to be geocoded.                       |
+| **`useLocale`**     | <code>boolean</code> | Localise the results to the given locale.                                |
+| **`defaultLocale`** | <code>string</code>  | locale is a string in the format of language_country, for example en_US. |
+| **`maxResults`**    | <code>number</code>  | Max number of results to return.                                         |
+| **`apiKey`**        | <code>string</code>  | Only used for web platform to use google api                             |
 
 </docgen-api>
+
+## Thanks
+To [@sebastianbaar](https://github.com/sebastianbaar) and his work on [cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) what he made was very inspiring

package/dist/docs.json

@@ -16,8 +16,25 @@
           }
         ],
         "returns": "Promise<{ addresses: Adress[]; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "id The bundle id to delete (note, this is the bundle id, NOT the version name)"
+          },
+          {
+            "name": "returns",
+            "text": "an Promise with the list of addresses according to maxResults"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Convert latitude and longitude to an address",
         "complexTypes": [
           "Adress",
           "reverseOptions"
@@ -35,8 +52,21 @@
           }
         ],
         "returns": "Promise<{ addresses: Adress[]; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "an Promise with the list of addresses according to maxResults"
+          },
+          {
+            "name": "throws",
+            "text": "An error if the something went wrong"
+          },
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Convert an address to latitude and longitude",
         "complexTypes": [
           "Adress",
           "ForwardOptions"
@@ -59,14 +89,14 @@
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "number"
         },
         {
           "name": "longitude",
           "tags": [],
           "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "number"
         },
         {
           "name": "countryCode",
@@ -150,42 +180,42 @@
         {
           "name": "latitude",
           "tags": [],
-          "docs": "",
+          "docs": "latitude is a number representing the latitude of the location.",
           "complexTypes": [],
           "type": "number"
         },
         {
           "name": "longitude",
           "tags": [],
-          "docs": "",
+          "docs": "longitude is a number representing the longitude of the location.",
           "complexTypes": [],
           "type": "number"
         },
         {
           "name": "useLocale",
           "tags": [],
-          "docs": "",
+          "docs": "Localise the results to the given locale.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
         {
           "name": "defaultLocale",
           "tags": [],
-          "docs": "",
+          "docs": "locale is a string in the format of language_country, for example en_US.",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "maxResults",
           "tags": [],
-          "docs": "",
+          "docs": "Max number of results to return.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "apiKey",
           "tags": [],
-          "docs": "",
+          "docs": "Only used for web platform to use google api",
           "complexTypes": [],
           "type": "string | undefined"
         }
@@ -201,35 +231,35 @@
         {
           "name": "addressString",
           "tags": [],
-          "docs": "",
+          "docs": "address is a string of the address to be geocoded.",
           "complexTypes": [],
           "type": "string"
         },
         {
           "name": "useLocale",
           "tags": [],
-          "docs": "",
+          "docs": "Localise the results to the given locale.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
         {
           "name": "defaultLocale",
           "tags": [],
-          "docs": "",
+          "docs": "locale is a string in the format of language_country, for example en_US.",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "maxResults",
           "tags": [],
-          "docs": "",
+          "docs": "Max number of results to return.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
           "name": "apiKey",
           "tags": [],
-          "docs": "",
+          "docs": "Only used for web platform to use google api",
           "complexTypes": [],
           "type": "string | undefined"
         }

package/dist/esm/definitions.d.ts

@@ -1,6 +1,6 @@
 export interface Adress {
-    latitude: string;
-    longitude: string;
+    latitude: number;
+    longitude: number;
     countryCode: string;
     postalCode: string;
     administrativeArea: string;
@@ -13,24 +13,72 @@ export interface Adress {
     formatted_address: string;
 }
 export interface ForwardOptions {
+    /**
+     * address is a string of the address to be geocoded.
+     */
     addressString: string;
+    /**
+    * Localise the results to the given locale.
+    */
     useLocale?: boolean;
+    /**
+     * locale is a string in the format of language_country, for example en_US.
+     */
     defaultLocale?: string;
+    /**
+     * Max number of results to return.
+     */
     maxResults?: number;
+    /**
+     * Only used for web platform to use google api
+     */
     apiKey?: string;
 }
 export interface reverseOptions {
+    /**
+     * latitude is a number representing the latitude of the location.
+     */
     latitude: number;
+    /**
+     * longitude is a number representing the longitude of the location.
+     */
     longitude: number;
+    /**
+    * Localise the results to the given locale.
+    */
     useLocale?: boolean;
+    /**
+     * locale is a string in the format of language_country, for example en_US.
+     */
     defaultLocale?: string;
+    /**
+     * Max number of results to return.
+     */
     maxResults?: number;
+    /**
+     * Only used for web platform to use google api
+     */
     apiKey?: string;
 }
 export interface NativeGeocoderPlugin {
+    /**
+     * Convert latitude and longitude to an address
+     *
+     * @param id The bundle id to delete (note, this is the bundle id, NOT the version name)
+     * @returns {Promise<{addresses: Adress[]}>} an Promise with the list of addresses according to maxResults
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     reverseGeocode(options: reverseOptions): Promise<{
         addresses: Adress[];
     }>;
+    /**
+     * Convert an address to latitude and longitude
+     *
+     * @returns {Promise<{addresses: Adress[]}>} an Promise with the list of addresses according to maxResults
+     * @throws An error if the something went wrong
+     * @since 0.0.1
+     */
     forwardGeocode(options: ForwardOptions): Promise<{
         addresses: Adress[];
     }>;

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface Adress {\n  latitude:\tstring\n  longitude:\tstring\n  countryCode:\tstring\n  postalCode:\tstring\n  administrativeArea:\tstring\n  subAdministrativeArea:\tstring\n  locality:\tstring\n  subLocality:\tstring\n  thoroughfare:\tstring\n  subThoroughfare:\tstring\n  areasOfInterest:\tstring[]\n  formatted_address: string\n}\n\nexport interface ForwardOptions {\n  addressString:\tstring\n  useLocale?:\tboolean\n  defaultLocale?:\tstring\n  maxResults?:\tnumber\n  apiKey?:\tstring\n}\nexport interface reverseOptions {\n  latitude:\tnumber\t\n  longitude:\tnumber\n  useLocale?:\tboolean\n  defaultLocale?:\tstring\n  maxResults?:\tnumber\n  apiKey?:\tstring\n}\nexport interface NativeGeocoderPlugin {\n  reverseGeocode(options: reverseOptions): Promise<{ addresses:\tAdress[] }>;\n  forwardGeocode(options: ForwardOptions): Promise<{ addresses:\tAdress[] }>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface Adress {\n  latitude:\tnumber\n  longitude:\tnumber\n  countryCode:\tstring\n  postalCode:\tstring\n  administrativeArea:\tstring\n  subAdministrativeArea:\tstring\n  locality:\tstring\n  subLocality:\tstring\n  thoroughfare:\tstring\n  subThoroughfare:\tstring\n  areasOfInterest:\tstring[]\n  formatted_address: string\n}\n\nexport interface ForwardOptions {\n  /**\n   * address is a string of the address to be geocoded.\n   */\n  addressString:\tstring\n  /**\n  * Localise the results to the given locale.\n  */\n  useLocale?:\tboolean\n  /**\n   * locale is a string in the format of language_country, for example en_US.\n   */\n  defaultLocale?:\tstring\n  /**\n   * Max number of results to return.\n   */\n  maxResults?:\tnumber\n  /**\n   * Only used for web platform to use google api\n   */\n  apiKey?:\tstring\n}\nexport interface reverseOptions {\n  /**\n   * latitude is a number representing the latitude of the location.\n   */\n  latitude:\tnumber\n  /**\n   * longitude is a number representing the longitude of the location.\n   */\n  longitude:\tnumber\n  /**\n  * Localise the results to the given locale.\n  */\n  useLocale?:\tboolean\n  /**\n   * locale is a string in the format of language_country, for example en_US.\n   */\n  defaultLocale?:\tstring\n  /**\n   * Max number of results to return.\n   */\n  maxResults?:\tnumber\n  /**\n   * Only used for web platform to use google api\n   */\n  apiKey?:\tstring\n}\nexport interface NativeGeocoderPlugin {\n  /**\n   * Convert latitude and longitude to an address\n   *\n   * @param id The bundle id to delete (note, this is the bundle id, NOT the version name)\n   * @returns {Promise<{addresses: Adress[]}>} an Promise with the list of addresses according to maxResults\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  reverseGeocode(options: reverseOptions): Promise<{ addresses:\tAdress[] }>;\n  /**\n   * Convert an address to latitude and longitude\n   *\n   * @returns {Promise<{addresses: Adress[]}>} an Promise with the list of addresses according to maxResults\n   * @throws An error if the something went wrong\n   * @since 0.0.1\n   */\n  forwardGeocode(options: ForwardOptions): Promise<{ addresses:\tAdress[] }>;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/nativegeocoder",
-  "version": "0.1.12",
+  "version": "0.1.15",
   "description": "Capacitor plugin for native forward and reverse geocoding",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",