Skip to content

Commit 81599db

Browse files
committed
fix(helpers): remove deprecated helpers (#6403)
BREAKING CHANGE: remove instantsearch.highlight, instantsearch.reverseHighlight, instantsearch.snippet, instantsearch.reverseSnippet. Instead use the `components` available from a template BREAKING CHANGE: remove instantsearch.insights, instead use sendEvent BREAKING CHANGE: remove instantsearch.getInsightsAnonymousUserToken
1 parent 978243a commit 81599db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+67
-3248
lines changed

examples/js/media/src/widgets/Articles.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { formatDistanceToNow } from 'date-fns';
22
import { html, render } from 'htm/preact';
3-
import { Hit } from 'instantsearch.js';
3+
import { Hit as AlgoliaHit } from 'instantsearch.js';
44
import { connectInfiniteHits } from 'instantsearch.js/es/connectors';
55
import { Snippet, Highlight } from 'instantsearch.js/es/helpers/components';
66

7-
type Result = Hit<{
7+
type Result = AlgoliaHit<{
88
slug: string;
99
primary_category: {
1010
slug: string;

packages/instantsearch.js/src/__tests__/index-es-test.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,10 @@ describe('instantsearch()', () => {
4040
`);
4141
});
4242

43-
it('includes the helper functions', () => {
43+
it("includes what's expected", () => {
4444
expect(Object.keys(instantsearch)).toMatchInlineSnapshot(`
4545
[
4646
"version",
47-
"createInfiniteHitsSessionStorageCache",
48-
"highlight",
49-
"reverseHighlight",
50-
"snippet",
51-
"reverseSnippet",
52-
"insights",
53-
"getInsightsAnonymousUserToken",
5447
]
5548
`);
5649
});

packages/instantsearch.js/src/__tests__/index-test.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ describe('instantsearch()', () => {
1919
});
2020
});
2121

22-
it('includes the API and the helper functions', () => {
22+
it('includes the API', () => {
2323
expect(Object.keys(instantsearch)).toMatchInlineSnapshot(`
2424
[
2525
"version",
@@ -30,11 +30,6 @@ describe('instantsearch()', () => {
3030
"stateMappings",
3131
"templates",
3232
"createInfiniteHitsSessionStorageCache",
33-
"highlight",
34-
"reverseHighlight",
35-
"snippet",
36-
"reverseSnippet",
37-
"insights",
3833
]
3934
`);
4035
});

packages/instantsearch.js/src/components/InfiniteHits/InfiniteHits.tsx

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import { cx } from 'instantsearch-ui-components';
44
import { h } from 'preact';
55

6-
import { createInsightsEventHandler } from '../../lib/insights/listener';
76
import { warning } from '../../lib/utils';
87
import Template from '../Template/Template';
98

@@ -80,7 +79,7 @@ const DefaultBanner = ({
8079
const InfiniteHits = ({
8180
results,
8281
hits,
83-
insights,
82+
8483
sendEvent,
8584
hasShowPrevious,
8685
showPrevious,
@@ -91,17 +90,9 @@ const InfiniteHits = ({
9190
templateProps,
9291
banner,
9392
}: InfiniteHitsProps) => {
94-
const handleInsightsClick = createInsightsEventHandler({
95-
insights,
96-
sendEvent,
97-
});
98-
9993
if (results.hits.length === 0) {
10094
return (
101-
<div
102-
className={cx(cssClasses.root, cssClasses.emptyRoot)}
103-
onClick={handleInsightsClick}
104-
>
95+
<div className={cx(cssClasses.root, cssClasses.emptyRoot)}>
10596
{banner &&
10697
(templateProps.templates.banner ? (
10798
<Template
@@ -167,12 +158,10 @@ const InfiniteHits = ({
167158
rootTagName="li"
168159
rootProps={{
169160
className: cssClasses.item,
170-
onClick: (event: MouseEvent) => {
171-
handleInsightsClick(event);
161+
onClick: () => {
172162
sendEvent('click:internal', hit, 'Hit Clicked');
173163
},
174-
onAuxClick: (event: MouseEvent) => {
175-
handleInsightsClick(event);
164+
onAuxClick: () => {
176165
sendEvent('click:internal', hit, 'Hit Clicked');
177166
},
178167
}}

packages/instantsearch.js/src/connectors/hits/__tests__/connectHitsWithInsights-test.ts

Lines changed: 0 additions & 111 deletions
This file was deleted.

packages/instantsearch.js/src/connectors/hits/connectHitsWithInsights.ts

Lines changed: 0 additions & 21 deletions
This file was deleted.

packages/instantsearch.js/src/connectors/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ export { default as connectClearRefinements } from './clear-refinements/connectC
33
export { default as connectCurrentRefinements } from './current-refinements/connectCurrentRefinements';
44
export { default as connectHierarchicalMenu } from './hierarchical-menu/connectHierarchicalMenu';
55
export { default as connectHits } from './hits/connectHits';
6-
export { default as connectHitsWithInsights } from './hits/connectHitsWithInsights';
76
export { default as connectHitsPerPage } from './hits-per-page/connectHitsPerPage';
87
export { default as connectInfiniteHits } from './infinite-hits/connectInfiniteHits';
9-
export { default as connectInfiniteHitsWithInsights } from './infinite-hits/connectInfiniteHitsWithInsights';
108
export { default as connectMenu } from './menu/connectMenu';
119
export { default as connectNumericMenu } from './numeric-menu/connectNumericMenu';
1210
export { default as connectPagination } from './pagination/connectPagination';

packages/instantsearch.js/src/connectors/infinite-hits/__tests__/connectInfiniteHitsWithInsights-test.ts

Lines changed: 0 additions & 131 deletions
This file was deleted.

0 commit comments

Comments
 (0)