@pretto/places 0.20.0 → 0.22.0

package/README.md

@@ -143,6 +143,22 @@ const results = await geolocSearch.get('75010')
 // }]
 ```
 
+For reverse geolocalisation
+
+```typescript
+import { reverseGeolocSearch } from '@pretto/places'
+
+const results = await reverseGeolocSearch.get({ latitude: 48.8932244326416, longitude: 2.289395548568507 })
+// result object format :
+// [{
+//      center: {latitude: 48.8946, longitude: 2.2874}
+//      city: 'Levallois-Perret'
+//      code: '92044',
+//      coordinates: [2.2874, 48.8946],
+//      zipcode: 92300,
+// }]
+```
+
 ### Debounce
 
 `addressSearch`, `municipalitySearch` and `geolocSearch` have defaut debounce value fixed to **300ms**\

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export * as municipalitySearch from './municipalitySearch';
 export * as addressSearch from './addressSearch';
 export * as countrySearch from './countrySearch';
 export * as geolocSearch from './geolocSearch';
+export * as reverseGeolocSearch from './reverseGeolocSearch';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAA;AAC9C,OAAO,KAAK,mBAAmB,MAAM,uBAAuB,CAAA"}

package/dist/index.js

@@ -111,7 +111,7 @@ const responseFormat = (places, country, search, departmentOnly) => {
     });
     return flat__default["default"](allPlaces);
 };
-const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$3 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     const { country = 'fr', limit = 5, departmentOnly = false } = options || {};
     const isNumber = !isNaN(parseInt(search, 10));
     if (!search || (isNumber && search.length < 2))
@@ -144,23 +144,23 @@ const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, functio
         return 'An error occurred.';
     }
 });
-let getDelayedData$2;
-const get$3 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData$2);
+let getDelayedData$3;
+const get$4 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$3);
     return new Promise((resolve, reject) => {
-        getDelayedData$2 = setTimeout(() => {
-            resolve(getData$2(search, options));
+        getDelayedData$3 = setTimeout(() => {
+            resolve(getData$3(search, options));
         }, debounceValue);
     });
 };
 
 var municipalitySearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    getData: getData$2,
-    get: get$3
+    getData: getData$3,
+    get: get$4
 });
 
-const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || search.length < 2)
         return [];
     try {
@@ -193,22 +193,22 @@ const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, functio
         return 'An error occurred.';
     }
 });
-let getDelayedData$1;
-const get$2 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData$1);
+let getDelayedData$2;
+const get$3 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$2);
     return new Promise((resolve, reject) => {
-        getDelayedData$1 = setTimeout(() => {
-            resolve(getData$1(search, options));
+        getDelayedData$2 = setTimeout(() => {
+            resolve(getData$2(search, options));
         }, debounceValue);
     });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    get: get$2
+    get: get$3
 });
 
-const get$1 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const get$2 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search)
         return [];
     const { limit = 5 } = options || {};
@@ -230,7 +230,7 @@ const init = (appId, apiKey, options) => {
         return {
             get(search, options) {
                 return __awaiter(this, void 0, void 0, function* () {
-                    return yield get$1(ALGOLIA_COUNTRIES_API, search, options);
+                    return yield get$2(ALGOLIA_COUNTRIES_API, search, options);
                 });
             },
         };
@@ -249,7 +249,7 @@ var countrySearch = /*#__PURE__*/Object.freeze({
     init: init
 });
 
-const formatData = (results) => results.map(result => ({
+const formatData$1 = (results) => results.map(result => ({
     city: result.nom,
     code: result.code,
     coordinates: result.centre.coordinates,
@@ -257,7 +257,7 @@ const formatData = (results) => results.map(result => ({
 // All french zipcode are only numbers, even particular cases like Corse (2A, 2B > 20), Finistère (29N, 29S > 29x), etc..
 // For more information: https://fr.wikipedia.org/wiki/Code_postal_en_France
 // Kept as string for consistency with geo.api.gouv.fr
-const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$1 = (search) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || !/(\d){5}/.test(search))
         return [];
     try {
@@ -266,7 +266,54 @@ const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
         if (!response.ok)
             return Promise.reject(response);
         const results = yield response.json();
-        return formatData(results);
+        return formatData$1(results);
+    }
+    catch (error) {
+        if (typeof error === 'string')
+            throw new Error(error);
+        throw new Error(error instanceof Error && error.message ? error.message : 'An error occurred.');
+    }
+});
+let getDelayedData$1;
+const get$1 = (search, debounceValue = 300) => {
+    clearTimeout(getDelayedData$1);
+    return new Promise((resolve, reject) => {
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search));
+        }, debounceValue);
+    });
+};
+
+var geolocSearch = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    get: get$1
+});
+
+const formatData = (geoResults, addressResults) => {
+    const district = addressResults.features.length > 0 ? addressResults.features[0].properties.district : null;
+    const postcode = addressResults.features.length > 0 ? addressResults.features[0].properties.postcode : null;
+    return geoResults.map(result => ({
+        center: { latitude: result.centre.coordinates[1], longitude: result.centre.coordinates[0] },
+        city: result.nom,
+        code: result.code,
+        coordinates: result.centre.coordinates,
+        zipcode: result.codesPostaux[0],
+        outline: result.contour.coordinates[0].map(([longitude, latitude]) => ({ longitude, latitude })),
+        district,
+        postcode,
+    }));
+};
+const getData = (search, signal) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const [geoResponse, addressResponse] = yield Promise.all([
+            fetch(`https://geo.api.gouv.fr/communes?lat=${search.latitude}&lon=${search.longitude}&fields=departement,codesPostaux,centre,contour`, { signal }),
+            fetch(`https://api-adresse.data.gouv.fr/reverse/?lat=${search.latitude}&lon=${search.longitude}&limit=1&&autocomplete=0`, { signal }),
+        ]);
+        if (!geoResponse.ok)
+            return Promise.reject(geoResponse);
+        const geoResults = yield geoResponse.json();
+        const addressResults = yield addressResponse.json();
+        return formatData(geoResults, addressResults);
     }
     catch (error) {
         if (typeof error === 'string')
@@ -275,16 +322,16 @@ const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 let getDelayedData;
-const get = (search, debounceValue = 300) => {
+const get = (search, debounceValue = 300, signal) => {
     clearTimeout(getDelayedData);
     return new Promise((resolve, reject) => {
         getDelayedData = setTimeout(() => {
-            resolve(getData(search));
+            resolve(getData(search, signal));
         }, debounceValue);
     });
 };
 
-var geolocSearch = /*#__PURE__*/Object.freeze({
+var reverseGeolocSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get: get
 });
@@ -293,3 +340,4 @@ exports.addressSearch = addressSearch;
 exports.countrySearch = countrySearch;
 exports.geolocSearch = geolocSearch;
 exports.municipalitySearch = municipalitySearch;
+exports.reverseGeolocSearch = reverseGeolocSearch;

package/dist/module.js

@@ -101,7 +101,7 @@ const responseFormat = (places, country, search, departmentOnly) => {
     });
     return flat(allPlaces);
 };
-const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$3 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     const { country = 'fr', limit = 5, departmentOnly = false } = options || {};
     const isNumber = !isNaN(parseInt(search, 10));
     if (!search || (isNumber && search.length < 2))
@@ -134,23 +134,23 @@ const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, functio
         return 'An error occurred.';
     }
 });
-let getDelayedData$2;
-const get$3 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData$2);
+let getDelayedData$3;
+const get$4 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$3);
     return new Promise((resolve, reject) => {
-        getDelayedData$2 = setTimeout(() => {
-            resolve(getData$2(search, options));
+        getDelayedData$3 = setTimeout(() => {
+            resolve(getData$3(search, options));
         }, debounceValue);
     });
 };
 
 var municipalitySearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    getData: getData$2,
-    get: get$3
+    getData: getData$3,
+    get: get$4
 });
 
-const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$2 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || search.length < 2)
         return [];
     try {
@@ -183,22 +183,22 @@ const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, functio
         return 'An error occurred.';
     }
 });
-let getDelayedData$1;
-const get$2 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData$1);
+let getDelayedData$2;
+const get$3 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$2);
     return new Promise((resolve, reject) => {
-        getDelayedData$1 = setTimeout(() => {
-            resolve(getData$1(search, options));
+        getDelayedData$2 = setTimeout(() => {
+            resolve(getData$2(search, options));
         }, debounceValue);
     });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    get: get$2
+    get: get$3
 });
 
-const get$1 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const get$2 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search)
         return [];
     const { limit = 5 } = options || {};
@@ -220,7 +220,7 @@ const init = (appId, apiKey, options) => {
         return {
             get(search, options) {
                 return __awaiter(this, void 0, void 0, function* () {
-                    return yield get$1(ALGOLIA_COUNTRIES_API, search, options);
+                    return yield get$2(ALGOLIA_COUNTRIES_API, search, options);
                 });
             },
         };
@@ -239,7 +239,7 @@ var countrySearch = /*#__PURE__*/Object.freeze({
     init: init
 });
 
-const formatData = (results) => results.map(result => ({
+const formatData$1 = (results) => results.map(result => ({
     city: result.nom,
     code: result.code,
     coordinates: result.centre.coordinates,
@@ -247,7 +247,7 @@ const formatData = (results) => results.map(result => ({
 // All french zipcode are only numbers, even particular cases like Corse (2A, 2B > 20), Finistère (29N, 29S > 29x), etc..
 // For more information: https://fr.wikipedia.org/wiki/Code_postal_en_France
 // Kept as string for consistency with geo.api.gouv.fr
-const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$1 = (search) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || !/(\d){5}/.test(search))
         return [];
     try {
@@ -256,7 +256,54 @@ const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
         if (!response.ok)
             return Promise.reject(response);
         const results = yield response.json();
-        return formatData(results);
+        return formatData$1(results);
+    }
+    catch (error) {
+        if (typeof error === 'string')
+            throw new Error(error);
+        throw new Error(error instanceof Error && error.message ? error.message : 'An error occurred.');
+    }
+});
+let getDelayedData$1;
+const get$1 = (search, debounceValue = 300) => {
+    clearTimeout(getDelayedData$1);
+    return new Promise((resolve, reject) => {
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search));
+        }, debounceValue);
+    });
+};
+
+var geolocSearch = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    get: get$1
+});
+
+const formatData = (geoResults, addressResults) => {
+    const district = addressResults.features.length > 0 ? addressResults.features[0].properties.district : null;
+    const postcode = addressResults.features.length > 0 ? addressResults.features[0].properties.postcode : null;
+    return geoResults.map(result => ({
+        center: { latitude: result.centre.coordinates[1], longitude: result.centre.coordinates[0] },
+        city: result.nom,
+        code: result.code,
+        coordinates: result.centre.coordinates,
+        zipcode: result.codesPostaux[0],
+        outline: result.contour.coordinates[0].map(([longitude, latitude]) => ({ longitude, latitude })),
+        district,
+        postcode,
+    }));
+};
+const getData = (search, signal) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const [geoResponse, addressResponse] = yield Promise.all([
+            fetch(`https://geo.api.gouv.fr/communes?lat=${search.latitude}&lon=${search.longitude}&fields=departement,codesPostaux,centre,contour`, { signal }),
+            fetch(`https://api-adresse.data.gouv.fr/reverse/?lat=${search.latitude}&lon=${search.longitude}&limit=1&&autocomplete=0`, { signal }),
+        ]);
+        if (!geoResponse.ok)
+            return Promise.reject(geoResponse);
+        const geoResults = yield geoResponse.json();
+        const addressResults = yield addressResponse.json();
+        return formatData(geoResults, addressResults);
     }
     catch (error) {
         if (typeof error === 'string')
@@ -265,18 +312,18 @@ const getData = (search) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 let getDelayedData;
-const get = (search, debounceValue = 300) => {
+const get = (search, debounceValue = 300, signal) => {
     clearTimeout(getDelayedData);
     return new Promise((resolve, reject) => {
         getDelayedData = setTimeout(() => {
-            resolve(getData(search));
+            resolve(getData(search, signal));
         }, debounceValue);
     });
 };
 
-var geolocSearch = /*#__PURE__*/Object.freeze({
+var reverseGeolocSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get: get
 });
 
-export { addressSearch, countrySearch, geolocSearch, municipalitySearch };
+export { addressSearch, countrySearch, geolocSearch, municipalitySearch, reverseGeolocSearch };

package/dist/reverseGeolocSearch.d.ts

@@ -0,0 +1,21 @@
+export declare type ReverseGeolocSearchResult = {
+    center: {
+        latitude: number;
+        longitude: number;
+    };
+    city: string;
+    code: string;
+    coordinates: [number, number];
+    outline: Array<{
+        latitude: number;
+        longitude: number;
+    }>;
+    zipcode: string;
+    postcode: string | null;
+    district: string | null;
+};
+export declare const get: (search: {
+    latitude: number;
+    longitude: number;
+}, debounceValue?: number, signal?: AbortSignal | undefined) => Promise<ReverseGeolocSearchResult[]>;
+//# sourceMappingURL=reverseGeolocSearch.d.ts.map

package/dist/reverseGeolocSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reverseGeolocSearch.d.ts","sourceRoot":"","sources":["../src/reverseGeolocSearch.ts"],"names":[],"mappings":"AAAA,oBAAY,yBAAyB,GAAG;IACtC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,OAAO,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACvD,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAuED,eAAO,MAAM,GAAG,WACN;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,kBAChC,MAAM,uCAEpB,QAAQ,yBAAyB,EAAE,CAQrC,CAAA"}

package/package.json

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