@pretto/places 0.15.0 → 0.17.0

package/README.md

@@ -129,9 +129,23 @@ const results = await countriesApi.get('al', { limit: 10 })[
 ]
 ```
 
+For geolocalisation
+
+```typescript
+import { geolocSearch } from '@pretto/places'
+
+const results = await geolocSearch.get('75010')
+// result object format :
+// [{
+//      city: 'Paris'
+//      code: '75010',
+//      coordinates: [2.347, 48.8589],
+// }]
+```
+
 ### Debounce
 
-`addressSearch` and `municipalitySearch` have defaut debounce value fixed to **300ms**\
+`addressSearch`, `municipalitySearch` and `geolocSearch` have defaut debounce value fixed to **300ms**\
 You can override this value by passing debounce value as last argument
 
 ```jsx

package/dist/geolocSearch.d.ts

@@ -0,0 +1,7 @@
+declare type GeolocSearchResult = {
+    code: string;
+    coordinates: [number, number];
+};
+export declare const get: (search: string, debounceValue?: number) => Promise<GeolocSearchResult[]>;
+export {};
+//# sourceMappingURL=geolocSearch.d.ts.map

package/dist/geolocSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocSearch.d.ts","sourceRoot":"","sources":["../src/geolocSearch.ts"],"names":[],"mappings":"AAAA,aAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC9B,CAAA;AAyCD,eAAO,MAAM,GAAG,WAAY,MAAM,kBAAiB,MAAM,KAAS,QAAQ,kBAAkB,EAAE,CAQ7F,CAAA"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * as municipalitySearch from './municipalitySearch';
 export * as addressSearch from './addressSearch';
 export * as countrySearch from './countrySearch';
+export * as geolocSearch from './geolocSearch';
 //# 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"}
+{"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"}

package/dist/index.js

@@ -100,7 +100,7 @@ const responseFormat = (places, country, search, departmentOnly) => {
     });
     return flat__default["default"](allPlaces);
 };
-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* () {
     const { country = 'fr', limit = 5, departmentOnly = false } = options || {};
     const isNumber = !isNaN(parseInt(search, 10));
     if (!search || (isNumber && search.length < 2))
@@ -133,23 +133,23 @@ 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 municipalitySearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    getData: getData$1,
-    get: get$2
+    getData: getData$2,
+    get: get$3
 });
 
-const getData = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || search.length < 2)
         return [];
     try {
@@ -182,22 +182,22 @@ const getData = (search, options) => __awaiter(void 0, void 0, void 0, function*
         return 'An error occurred.';
     }
 });
-let getDelayedData;
-const get$1 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData);
+let getDelayedData$1;
+const get$2 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$1);
     return new Promise((resolve, reject) => {
-        getDelayedData = setTimeout(() => {
-            resolve(getData(search, options));
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search, options));
         }, debounceValue);
     });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    get: get$1
+    get: get$2
 });
 
-const get = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const get$1 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search)
         return [];
     const { limit = 5 } = options || {};
@@ -219,7 +219,7 @@ const init = (appId, apiKey, options) => {
         return {
             get(search, options) {
                 return __awaiter(this, void 0, void 0, function* () {
-                    return yield get(ALGOLIA_COUNTRIES_API, search, options);
+                    return yield get$1(ALGOLIA_COUNTRIES_API, search, options);
                 });
             },
         };
@@ -238,6 +238,47 @@ var countrySearch = /*#__PURE__*/Object.freeze({
     init: init
 });
 
+const formatData = (results) => results.map(result => ({
+    city: result.nom,
+    code: result.code,
+    coordinates: result.centre.coordinates,
+}));
+// 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* () {
+    if (!search || !/(\d){5}/.test(search))
+        return [];
+    try {
+        const formattedSearch = encodeURIComponent(search);
+        const response = yield fetch(`https://geo.api.gouv.fr/communes?codePostal=${formattedSearch}&fields=centre`);
+        if (!response.ok)
+            return Promise.reject(response);
+        const results = yield response.json();
+        return formatData(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;
+const get = (search, debounceValue = 300) => {
+    clearTimeout(getDelayedData);
+    return new Promise((resolve, reject) => {
+        getDelayedData = setTimeout(() => {
+            resolve(getData(search));
+        }, debounceValue);
+    });
+};
+
+var geolocSearch = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    get: get
+});
+
 exports.addressSearch = addressSearch;
 exports.countrySearch = countrySearch;
+exports.geolocSearch = geolocSearch;
 exports.municipalitySearch = municipalitySearch;

package/dist/module.js

@@ -90,7 +90,7 @@ const responseFormat = (places, country, search, departmentOnly) => {
     });
     return flat(allPlaces);
 };
-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* () {
     const { country = 'fr', limit = 5, departmentOnly = false } = options || {};
     const isNumber = !isNaN(parseInt(search, 10));
     if (!search || (isNumber && search.length < 2))
@@ -123,23 +123,23 @@ 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 municipalitySearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    getData: getData$1,
-    get: get$2
+    getData: getData$2,
+    get: get$3
 });
 
-const getData = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search || search.length < 2)
         return [];
     try {
@@ -172,22 +172,22 @@ const getData = (search, options) => __awaiter(void 0, void 0, void 0, function*
         return 'An error occurred.';
     }
 });
-let getDelayedData;
-const get$1 = (search, options, debounceValue = 300) => {
-    clearTimeout(getDelayedData);
+let getDelayedData$1;
+const get$2 = (search, options, debounceValue = 300) => {
+    clearTimeout(getDelayedData$1);
     return new Promise((resolve, reject) => {
-        getDelayedData = setTimeout(() => {
-            resolve(getData(search, options));
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search, options));
         }, debounceValue);
     });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    get: get$1
+    get: get$2
 });
 
-const get = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
+const get$1 = (instance, search, options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!search)
         return [];
     const { limit = 5 } = options || {};
@@ -209,7 +209,7 @@ const init = (appId, apiKey, options) => {
         return {
             get(search, options) {
                 return __awaiter(this, void 0, void 0, function* () {
-                    return yield get(ALGOLIA_COUNTRIES_API, search, options);
+                    return yield get$1(ALGOLIA_COUNTRIES_API, search, options);
                 });
             },
         };
@@ -228,4 +228,44 @@ var countrySearch = /*#__PURE__*/Object.freeze({
     init: init
 });
 
-export { addressSearch, countrySearch, municipalitySearch };
+const formatData = (results) => results.map(result => ({
+    city: result.nom,
+    code: result.code,
+    coordinates: result.centre.coordinates,
+}));
+// 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* () {
+    if (!search || !/(\d){5}/.test(search))
+        return [];
+    try {
+        const formattedSearch = encodeURIComponent(search);
+        const response = yield fetch(`https://geo.api.gouv.fr/communes?codePostal=${formattedSearch}&fields=centre`);
+        if (!response.ok)
+            return Promise.reject(response);
+        const results = yield response.json();
+        return formatData(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;
+const get = (search, debounceValue = 300) => {
+    clearTimeout(getDelayedData);
+    return new Promise((resolve, reject) => {
+        getDelayedData = setTimeout(() => {
+            resolve(getData(search));
+        }, debounceValue);
+    });
+};
+
+var geolocSearch = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    get: get
+});
+
+export { addressSearch, countrySearch, geolocSearch, municipalitySearch };

package/package.json

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