@pretto/places 0.12.0 → 0.14.0

package/README.md

@@ -21,7 +21,7 @@ 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 : 
+// result object format :
 [
     {
         "label": "Paris (75001)",
@@ -51,7 +51,7 @@ 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 : 
+// result object format :
 [
     {
         "label": "Paris (75)",
@@ -81,7 +81,7 @@ 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 : 
+// result object format :
 [
     {
         "label": "55 Rue de Paradis 75010 Paris (75010)",
@@ -111,26 +111,34 @@ For country
 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"
-    }
+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',
+  })
 ]
 ```
 
+### Debounce
+
+`addressSearch` and `municipalitySearch` have defaut debounce value fixed to **300ms**\
+You can override this value by passing `debounceValue` as last argument
+
+```jsx
+const debounceValue = 1000 // --- 1000 = 1s
+const results = await countriesApi.get('al', { limit: 10 }, debounceValue)
+```
+
 ### How to publish a new version?
 
 When a branch is merged into master, it will automatically deploy a new version to npm.

package/dist/addressSearch.d.ts

@@ -1,3 +1,12 @@
+interface AddressSearchResult {
+    label: string;
+    value: {
+        city: string;
+        country: string;
+        street: string;
+        zipcode: string;
+    };
+}
 export interface AddressApiResult {
     properties: {
         label: string;
@@ -12,6 +21,7 @@ interface Options {
     country: string;
     limit: number;
 }
-export declare const get: (search: string, options?: Options | undefined, debounceValue?: 300 | undefined) => number;
+declare type DebouncedAddressSearch = (search: string, options?: Options, debounceValue?: number) => Promise<AddressSearchResult[] | string>;
+export declare const get: DebouncedAddressSearch;
 export {};
 //# sourceMappingURL=addressSearch.d.ts.map

package/dist/addressSearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addressSearch.d.ts","sourceRoot":"","sources":["../src/addressSearch.ts"],"names":[],"mappings":"AAUA,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CACd;AAuCD,eAAO,MAAM,GAAG,WAAY,MAAM,2EAQjC,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,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CACd;AAED,aAAK,sBAAsB,GAAG,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,EACjB,aAAa,CAAC,EAAE,MAAM,KACnB,OAAO,CAAC,mBAAmB,EAAE,GAAG,MAAM,CAAC,CAAA;AAuC5C,eAAO,MAAM,GAAG,EAAE,sBAQjB,CAAA"}

package/dist/index.js

@@ -134,12 +134,13 @@ const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, functio
     }
 });
 let getDelayedData$1;
-const get$2 = (search, options, debounceValue) => {
+const get$2 = (search, options, debounceValue = 300) => {
     clearTimeout(getDelayedData$1);
-    getDelayedData$1 = setTimeout(() => {
-        getData$1(search, options);
-    }, debounceValue);
-    return getDelayedData$1;
+    return new Promise((resolve, reject) => {
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search, options));
+        }, debounceValue);
+    });
 };
 
 var municipalitySearch = /*#__PURE__*/Object.freeze({
@@ -149,7 +150,7 @@ var municipalitySearch = /*#__PURE__*/Object.freeze({
 });
 
 const getData = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!search)
+    if (!search || search.length < 2)
         return [];
     try {
         const { country = 'fr', limit = 5 } = options || {};
@@ -182,12 +183,13 @@ const getData = (search, options) => __awaiter(void 0, void 0, void 0, function*
     }
 });
 let getDelayedData;
-const get$1 = (search, options, debounceValue) => {
+const get$1 = (search, options, debounceValue = 300) => {
     clearTimeout(getDelayedData);
-    getDelayedData = setTimeout(() => {
-        getData(search, options);
-    }, debounceValue);
-    return getDelayedData;
+    return new Promise((resolve, reject) => {
+        getDelayedData = setTimeout(() => {
+            resolve(getData(search, options));
+        }, debounceValue);
+    });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({

package/dist/module.js

@@ -124,12 +124,13 @@ const getData$1 = (search, options) => __awaiter(void 0, void 0, void 0, functio
     }
 });
 let getDelayedData$1;
-const get$2 = (search, options, debounceValue) => {
+const get$2 = (search, options, debounceValue = 300) => {
     clearTimeout(getDelayedData$1);
-    getDelayedData$1 = setTimeout(() => {
-        getData$1(search, options);
-    }, debounceValue);
-    return getDelayedData$1;
+    return new Promise((resolve, reject) => {
+        getDelayedData$1 = setTimeout(() => {
+            resolve(getData$1(search, options));
+        }, debounceValue);
+    });
 };
 
 var municipalitySearch = /*#__PURE__*/Object.freeze({
@@ -139,7 +140,7 @@ var municipalitySearch = /*#__PURE__*/Object.freeze({
 });
 
 const getData = (search, options) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!search)
+    if (!search || search.length < 2)
         return [];
     try {
         const { country = 'fr', limit = 5 } = options || {};
@@ -172,12 +173,13 @@ const getData = (search, options) => __awaiter(void 0, void 0, void 0, function*
     }
 });
 let getDelayedData;
-const get$1 = (search, options, debounceValue) => {
+const get$1 = (search, options, debounceValue = 300) => {
     clearTimeout(getDelayedData);
-    getDelayedData = setTimeout(() => {
-        getData(search, options);
-    }, debounceValue);
-    return getDelayedData;
+    return new Promise((resolve, reject) => {
+        getDelayedData = setTimeout(() => {
+            resolve(getData(search, options));
+        }, debounceValue);
+    });
 };
 
 var addressSearch = /*#__PURE__*/Object.freeze({

package/dist/municipalitySearch.d.ts

@@ -19,8 +19,9 @@ interface Options {
     limit?: number;
     departmentOnly?: boolean;
 }
+declare type DebouncedMunicipalitySearch = (search: string, options?: Options, debounceValue?: number) => Promise<MunicipalitySearchResult[] | string>;
 declare type MunicipalitySearch = (search: string, options?: Options) => Promise<MunicipalitySearchResult[] | string>;
 export declare const getData: MunicipalitySearch;
-export declare const get: (search: string, options?: Options | undefined, debounceValue?: 300 | undefined) => number;
+export declare const get: DebouncedMunicipalitySearch;
 export {};
 //# sourceMappingURL=municipalitySearch.d.ts.map

package/dist/municipalitySearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"municipalitySearch.d.ts","sourceRoot":"","sources":["../src/municipalitySearch.ts"],"names":[],"mappings":"AAKA,UAAU,wBAAwB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,YAAY,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,UAAU,OAAO;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,aAAK,kBAAkB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,wBAAwB,EAAE,GAAG,MAAM,CAAC,CAAA;AAmD7G,eAAO,MAAM,OAAO,EAAE,kBAoCrB,CAAA;AAID,eAAO,MAAM,GAAG,WAAY,MAAM,2EAQjC,CAAA"}
+{"version":3,"file":"municipalitySearch.d.ts","sourceRoot":"","sources":["../src/municipalitySearch.ts"],"names":[],"mappings":"AAKA,UAAU,wBAAwB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,YAAY,EAAE,MAAM,EAAE,CAAA;CACvB;AAED,UAAU,OAAO;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,aAAK,2BAA2B,GAAG,CACjC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,EACjB,aAAa,CAAC,EAAE,MAAM,KACnB,OAAO,CAAC,wBAAwB,EAAE,GAAG,MAAM,CAAC,CAAA;AAEjD,aAAK,kBAAkB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,wBAAwB,EAAE,GAAG,MAAM,CAAC,CAAA;AAmD7G,eAAO,MAAM,OAAO,EAAE,kBAoCrB,CAAA;AAID,eAAO,MAAM,GAAG,EAAE,2BAQjB,CAAA"}

package/package.json

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