@pretto/places 0.6.0 → 0.9.0

package/README.md

@@ -0,0 +1,145 @@
+# @pretto/places
+
+[![npm version](https://img.shields.io/npm/v/@pretto/places.svg?style=flat)](https://www.npmjs.com/package/@pretto/places)
+
+Allows you to search for an address, a postcode or a French department.
+You can also search a country.
+
+## FAQ
+
+### How to implement the library?
+
+```sh
+yarn add @pretto/places
+```
+
+For municipality and zipcode
+
+```jsx
+import { municipalitySearch } from '@pretto/places'
+
+const result = await municipalitySearch.get("paris", { limit: 21 })
+
+// expected result : Paris (75001), Paris (75002), Paris (75003), ..., Paris (75020)
+// result object format : 
+[
+    {
+        "label": "Paris (75001)",
+        "value": {
+            "city": "Paris",
+            "country": "fr",
+            "zipcode": "75001"
+        }
+    },
+    {
+        "label": "Paris (75002)",
+        "value": {
+            "city": "Paris",
+            "country": "fr",
+            "zipcode": "75002"
+        }
+    },
+    ...
+]
+```
+
+For department only
+
+```jsx
+import { municipalitySearch } from '@pretto/places'
+
+const result = await municipalitySearch.get("paris", { departmentOnly: true, limit: 21 })
+
+// expected result : Paris (75), Parisot(81), Parisot (82), Cormeilles-en-Parisis (95), ...
+// result object format : 
+[
+    {
+        "label": "Paris (75)",
+        "value": {
+            "city": "Paris",
+            "country": "fr",
+            "zipcode": "75"
+        }
+    },
+    {
+        "label": "Parisot (81)",
+        "value": {
+            "city": "Parisot",
+            "country": "fr",
+            "zipcode": "81"
+        }
+    },
+    ...
+]
+```
+
+For Address (France only)
+
+```jsx
+import { addressSearch } from '@pretto/places'
+
+const result = await addressSearch.get("55 rue de paradis", { limit: 10 })
+
+// expected result : 55 Rue de Paradis 75010 Paris (75010), 55 Rue de Paradis 51160 Hautvillers (51160)...
+// result object format : 
+[
+    {
+        "label": "55 Rue de Paradis 75010 Paris (75010)",
+        "value": {
+            "city": "Paris",
+            "country": "fr",
+            "street": "55 Rue de Paradis",
+            "zipcode": "75010"
+        }
+    },
+    {
+        "label": "55 Rue de Paradis 51160 Hautvillers (51160)",
+        "value": {
+            "city": "Hautvillers",
+            "country": "fr",
+            "street": "55 Rue de Paradis",
+            "zipcode": "51160"
+        }
+    },
+    ...
+]
+```
+
+For country
+
+```jsx
+import { countrySearch } from '@pretto/places'
+
+const countriesApi = countrySearch.init(ALGOLIA_COUNTRIES_APP_ID, ALGOLIA_COUNTRIES_API_KEY)
+const results = await countriesApi.get("al", { limit: 10 })
+
+// expected result : Allemagne (99109), Albanie (99125), Algerie (99352)
+// result object format : 
+[
+    {
+        "label": "Allemagne (99109)",
+        "value": "de"
+    },
+    {
+        "label": "Albanie (99125)",
+        "value": "al"
+    },
+    {
+        "label": "Algerie (99352)",
+        "value": "dz"
+    }
+]
+```
+
+### How to publish a new version?
+
+When a branch is merged into master, it will automatically deploy a new version to npm.
+
+### How it works?
+
+This library is based on the API of data.gouv.
+These data are quite precise and are regularly updated:
+![title](https://adresse.data.gouv.fr/_next/image?url=%2Fimages%2Fdonnees-nationales%2Fschema-donnees-ban.svg&w=1080&q=75)
+
+- https://adresse.data.gouv.fr/
+- https://api.gouv.fr/

package/dist/addressSearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addressSearch.d.ts","sourceRoot":"","sources":["../src/addressSearch.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CACd;AAED,aAAK,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,mBAAmB,EAAE,GAAG,MAAM,CAAC,CAAA;AAEnG,eAAO,MAAM,GAAG,EAAE,aA4BjB,CAAA"}
+{"version":3,"file":"addressSearch.d.ts","sourceRoot":"","sources":["../src/addressSearch.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CACd;AAED,aAAK,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,mBAAmB,EAAE,GAAG,MAAM,CAAC,CAAA;AAEnG,eAAO,MAAM,GAAG,EAAE,aAiCjB,CAAA"}

package/dist/index.js

@@ -149,17 +149,22 @@ const get$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* (
         if (!response.ok)
             return Promise.reject(response);
         const result = yield response.json();
-        return result.features.map(({ properties }) => {
-            return {
-                label: `${properties.label} (${properties.postcode})`,
-                value: {
-                    city: properties.city,
-                    country,
-                    street: `${properties.housenumber} ${properties.street}`,
-                    zipcode: properties.postcode,
+        return result.features.reduce((acc, { properties }) => {
+            if (!properties.street)
+                return acc;
+            return [
+                ...acc,
+                {
+                    label: `${properties.label} (${properties.postcode})`,
+                    value: {
+                        city: properties.city,
+                        country,
+                        street: `${properties.housenumber || ''} ${properties.street}`,
+                        zipcode: properties.postcode,
+                    },
                 },
-            };
-        });
+            ];
+        }, []);
     }
     catch (error) {
         if (typeof error === 'string')

package/dist/module.js

@@ -139,17 +139,22 @@ const get$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* (
         if (!response.ok)
             return Promise.reject(response);
         const result = yield response.json();
-        return result.features.map(({ properties }) => {
-            return {
-                label: `${properties.label} (${properties.postcode})`,
-                value: {
-                    city: properties.city,
-                    country,
-                    street: `${properties.housenumber} ${properties.street}`,
-                    zipcode: properties.postcode,
+        return result.features.reduce((acc, { properties }) => {
+            if (!properties.street)
+                return acc;
+            return [
+                ...acc,
+                {
+                    label: `${properties.label} (${properties.postcode})`,
+                    value: {
+                        city: properties.city,
+                        country,
+                        street: `${properties.housenumber || ''} ${properties.street}`,
+                        zipcode: properties.postcode,
+                    },
                 },
-            };
-        });
+            ];
+        }, []);
     }
     catch (error) {
         if (typeof error === 'string')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretto/places",
-  "version": "0.6.0",
+  "version": "0.9.0",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",