Skip to content

Commit c8f143c

Browse files
HaroenvHaroenv
authored
fix(geoSearch): hasMapMovedSinceLastRefine (#6470)
The property that is exposed is called `hasMapMovedSinceLastRefine`, no longer `hasMapMoveSinceLastRefine` BREAKING CHANGE: replace `hasMapMoveSinceLastRefine` in your code base with `hasMapMovedSinceLastRefine`
1 parent 9e85cf1 commit c8f143c

File tree

8 files changed

+79
-78
lines changed

8 files changed

+79
-78
lines changed

‎packages/instantsearch-core/src/connectors/__tests__/connectGeoSearch.test.ts‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,15 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
176176
toggleRefineOnMapMove: expect.any(Function),
177177
isRefineOnMapMove: expect.any(Function),
178178
setMapMoveSinceLastRefine: expect.any(Function),
179-
hasMapMoveSinceLastRefine: expect.any(Function),
179+
hasMapMovedSinceLastRefine: expect.any(Function),
180180
widgetParams: {},
181181
instantSearchInstance,
182182
},
183183
true
184184
);
185185

186186
expect(lastRenderArgs(render).isRefineOnMapMove()).toBe(true);
187-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
187+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
188188
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
189189

190190
widget.render!(
@@ -222,7 +222,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
222222
);
223223

224224
expect(lastRenderArgs(render).isRefineOnMapMove()).toBe(true);
225-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
225+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
226226
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
227227
});
228228

@@ -496,13 +496,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
496496
);
497497

498498
expect(render).toHaveBeenCalledTimes(3);
499-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
499+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
500500
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
501501

502502
lastRenderArgs(render).setMapMoveSinceLastRefine();
503503

504504
expect(render).toHaveBeenCalledTimes(4);
505-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
505+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
506506
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
507507

508508
helper.setQueryParameter('aroundLatLng', '14,16');
@@ -515,7 +515,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
515515
);
516516

517517
expect(render).toHaveBeenCalledTimes(5);
518-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
518+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
519519
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
520520
});
521521

@@ -574,13 +574,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
574574
);
575575

576576
expect(render).toHaveBeenCalledTimes(3);
577-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
577+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
578578
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
579579

580580
lastRenderArgs(render).setMapMoveSinceLastRefine();
581581

582582
expect(render).toHaveBeenCalledTimes(4);
583-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
583+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
584584
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
585585

586586
helper.setQueryParameter('aroundLatLng', '10,12');
@@ -593,7 +593,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
593593
);
594594

595595
expect(render).toHaveBeenCalledTimes(5);
596-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
596+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
597597
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
598598
});
599599

@@ -653,13 +653,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
653653
);
654654

655655
expect(render).toHaveBeenCalledTimes(3);
656-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
656+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
657657
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
658658

659659
lastRenderArgs(render).setMapMoveSinceLastRefine();
660660

661661
expect(render).toHaveBeenCalledTimes(4);
662-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
662+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
663663
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
664664

665665
helper.setQueryParameter('insideBoundingBox', undefined);
@@ -672,7 +672,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
672672
);
673673

674674
expect(render).toHaveBeenCalledTimes(5);
675-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
675+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
676676
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
677677
});
678678

@@ -732,13 +732,13 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
732732
);
733733

734734
expect(render).toHaveBeenCalledTimes(3);
735-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
735+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
736736
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
737737

738738
lastRenderArgs(render).setMapMoveSinceLastRefine();
739739

740740
expect(render).toHaveBeenCalledTimes(4);
741-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
741+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
742742
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
743743

744744
// @ts-ignore
@@ -752,7 +752,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
752752
);
753753

754754
expect(render).toHaveBeenCalledTimes(5);
755-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
755+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
756756
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
757757
});
758758

@@ -938,7 +938,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
938938
);
939939

940940
expect(render).toHaveBeenCalledTimes(1);
941-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
941+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
942942
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
943943
expect(helper.state.insideBoundingBox).toBe(undefined);
944944
expect(helper.search).not.toHaveBeenCalled();
@@ -953,7 +953,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
953953
);
954954

955955
expect(render).toHaveBeenCalledTimes(2);
956-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
956+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
957957
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
958958
expect(helper.state.insideBoundingBox).toEqual('12,10,40,42');
959959
expect(helper.search).toHaveBeenCalledTimes(1);
@@ -999,7 +999,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
999999
);
10001000

10011001
expect(render).toHaveBeenCalledTimes(2);
1002-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1002+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
10031003
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
10041004
expect(helper.state.insideBoundingBox).toBe(undefined);
10051005
expect(helper.search).not.toHaveBeenCalled();
@@ -1014,7 +1014,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
10141014
);
10151015

10161016
expect(render).toHaveBeenCalledTimes(3);
1017-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1017+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
10181018
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
10191019
expect(helper.state.insideBoundingBox).toEqual('12,10,40,42');
10201020
expect(helper.search).toHaveBeenCalledTimes(1);
@@ -1055,7 +1055,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
10551055
);
10561056

10571057
expect(render).toHaveBeenCalledTimes(1);
1058-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1058+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
10591059
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
10601060
expect(helper.state.insideBoundingBox).toBe(undefined);
10611061
expect(helper.search).not.toHaveBeenCalled();
@@ -1070,7 +1070,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
10701070
);
10711071

10721072
expect(render).toHaveBeenCalledTimes(2);
1073-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1073+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
10741074
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
10751075
expect(helper.state.insideBoundingBox).toEqual('12,10,40,42');
10761076
expect(helper.search).toHaveBeenCalledTimes(1);
@@ -1085,7 +1085,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
10851085
);
10861086

10871087
expect(render).toHaveBeenCalledTimes(3);
1088-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1088+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
10891089
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
10901090
expect(helper.state.insideBoundingBox).toBe(undefined);
10911091
expect(helper.search).toHaveBeenCalledTimes(2);
@@ -1131,7 +1131,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
11311131
);
11321132

11331133
expect(render).toHaveBeenCalledTimes(2);
1134-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1134+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
11351135
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
11361136
expect(helper.state.insideBoundingBox).toBe(undefined);
11371137
expect(helper.search).not.toHaveBeenCalled();
@@ -1146,7 +1146,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
11461146
);
11471147

11481148
expect(render).toHaveBeenCalledTimes(3);
1149-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1149+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
11501150
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(true);
11511151
expect(helper.state.insideBoundingBox).toEqual('12,10,40,42');
11521152
expect(helper.search).toHaveBeenCalledTimes(1);
@@ -1161,7 +1161,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
11611161
);
11621162

11631163
expect(render).toHaveBeenCalledTimes(4);
1164-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1164+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
11651165
expect(lastRenderArgs(render).isRefinedWithMap()).toBe(false);
11661166
expect(helper.state.insideBoundingBox).toBe(undefined);
11671167
expect(helper.search).toHaveBeenCalledTimes(2);
@@ -1262,12 +1262,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
12621262
widget.init!(createInitOptions());
12631263

12641264
expect(render).toHaveBeenCalledTimes(1);
1265-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1265+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
12661266

12671267
lastRenderArgs(render).setMapMoveSinceLastRefine();
12681268

12691269
expect(render).toHaveBeenCalledTimes(1);
1270-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
1270+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
12711271

12721272
widget.render!(
12731273
createRenderOptions({
@@ -1280,7 +1280,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
12801280
);
12811281

12821282
expect(render).toHaveBeenCalledTimes(2);
1283-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
1283+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
12841284
expect(firstRenderArgs(render).setMapMoveSinceLastRefine).toBe(
12851285
lastRenderArgs(render).setMapMoveSinceLastRefine
12861286
);
@@ -1318,12 +1318,12 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
13181318
);
13191319

13201320
expect(render).toHaveBeenCalledTimes(2);
1321-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1321+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
13221322

13231323
lastRenderArgs(render).setMapMoveSinceLastRefine();
13241324

13251325
expect(render).toHaveBeenCalledTimes(3);
1326-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
1326+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
13271327
expect(firstRenderArgs(render).setMapMoveSinceLastRefine).toBe(
13281328
lastRenderArgs(render).setMapMoveSinceLastRefine
13291329
);
@@ -1361,17 +1361,17 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
13611361
);
13621362

13631363
expect(render).toHaveBeenCalledTimes(2);
1364-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(false);
1364+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(false);
13651365

13661366
lastRenderArgs(render).setMapMoveSinceLastRefine();
13671367

13681368
expect(render).toHaveBeenCalledTimes(3);
1369-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
1369+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
13701370

13711371
lastRenderArgs(render).setMapMoveSinceLastRefine();
13721372

13731373
expect(render).toHaveBeenCalledTimes(3);
1374-
expect(lastRenderArgs(render).hasMapMoveSinceLastRefine()).toBe(true);
1374+
expect(lastRenderArgs(render).hasMapMovedSinceLastRefine()).toBe(true);
13751375
expect(firstRenderArgs(render).setMapMoveSinceLastRefine).toBe(
13761376
lastRenderArgs(render).setMapMoveSinceLastRefine
13771377
);
@@ -1593,7 +1593,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
15931593
currentRefinement: undefined,
15941594
items: [],
15951595
clearMapRefinement: expect.any(Function),
1596-
hasMapMoveSinceLastRefine: expect.any(Function),
1596+
hasMapMovedSinceLastRefine: expect.any(Function),
15971597
isRefineOnMapMove: expect.any(Function),
15981598
isRefinedWithMap: expect.any(Function),
15991599
refine: expect.any(Function),
@@ -1630,7 +1630,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
16301630
items: [],
16311631
refine: expect.any(Function),
16321632
clearMapRefinement: expect.any(Function),
1633-
hasMapMoveSinceLastRefine: expect.any(Function),
1633+
hasMapMovedSinceLastRefine: expect.any(Function),
16341634
isRefineOnMapMove: expect.any(Function),
16351635
isRefinedWithMap: expect.any(Function),
16361636
setMapMoveSinceLastRefine: expect.any(Function),
@@ -1658,7 +1658,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/geo-search/
16581658
currentRefinement: undefined,
16591659
items: [],
16601660
clearMapRefinement: expect.any(Function),
1661-
hasMapMoveSinceLastRefine: expect.any(Function),
1661+
hasMapMovedSinceLastRefine: expect.any(Function),
16621662
isRefineOnMapMove: expect.any(Function),
16631663
isRefinedWithMap: expect.any(Function),
16641664
refine: expect.any(Function),

‎packages/instantsearch-core/src/connectors/connectGeoSearch.ts‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export type GeoSearchRenderState<THit extends NonNullable<object> = BaseHit> = {
6767
/**
6868
* Return true if the map has move since the last refinement.
6969
*/
70-
hasMapMoveSinceLastRefine: () => boolean;
70+
hasMapMovedSinceLastRefine: () => boolean;
7171
/**
7272
* Return true if the current refinement is set with the map bounds.
7373
*/
@@ -179,8 +179,7 @@ export const connectGeoSearch = function connectGeoSearch<
179179

180180
const widgetState = {
181181
isRefineOnMapMove: enableRefineOnMapMove,
182-
// @MAJOR hasMapMoveSinceLastRefine -> hasMapMovedSinceLastRefine
183-
hasMapMoveSinceLastRefine: false,
182+
hasMapMovedSinceLastRefine: false,
184183
lastRefinePosition: '',
185184
lastRefineBoundingBox: '',
186185
internalToggleRefineOnMapMove: noop,
@@ -207,7 +206,7 @@ export const connectGeoSearch = function connectGeoSearch<
207206
)
208207
.search();
209208

210-
widgetState.hasMapMoveSinceLastRefine = false;
209+
widgetState.hasMapMovedSinceLastRefine = false;
211210
widgetState.lastRefineBoundingBox = boundingBox;
212211
};
213212

@@ -246,17 +245,17 @@ export const connectGeoSearch = function connectGeoSearch<
246245
) =>
247246
() => {
248247
const shouldTriggerRender =
249-
widgetState.hasMapMoveSinceLastRefine !== true;
248+
widgetState.hasMapMovedSinceLastRefine !== true;
250249

251-
widgetState.hasMapMoveSinceLastRefine = true;
250+
widgetState.hasMapMovedSinceLastRefine = true;
252251

253252
if (shouldTriggerRender) {
254253
render(renderOptions);
255254
}
256255
};
257256

258-
const hasMapMoveSinceLastRefine = () =>
259-
widgetState.hasMapMoveSinceLastRefine;
257+
const hasMapMovedSinceLastRefine = () =>
258+
widgetState.hasMapMovedSinceLastRefine;
260259

261260
let sendEvent: SendEventForHits;
262261

@@ -307,7 +306,7 @@ export const connectGeoSearch = function connectGeoSearch<
307306
positionChangedSinceLastRefine ||
308307
boundingBoxChangedSinceLastRefine
309308
) {
310-
widgetState.hasMapMoveSinceLastRefine = false;
309+
widgetState.hasMapMovedSinceLastRefine = false;
311310
}
312311

313312
widgetState.lastRefinePosition = state.aroundLatLng || '';
@@ -369,7 +368,7 @@ export const connectGeoSearch = function connectGeoSearch<
369368
toggleRefineOnMapMove,
370369
isRefineOnMapMove,
371370
setMapMoveSinceLastRefine,
372-
hasMapMoveSinceLastRefine,
371+
hasMapMovedSinceLastRefine,
373372
widgetParams,
374373
};
375374
},

0 commit comments

Comments
 (0)