Skip to content

Commit 7b053d3

Browse files
authored
fix(support): deprecate answers & places (#6057)
1 parent 6ef8d2a commit 7b053d3

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

packages/instantsearch.js/src/connectors/answers/connectAnswers.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@ export type AnswersConnector = Connector<
105105
AnswersConnectorParams
106106
>;
107107

108+
/**
109+
* @deprecated the answers service is no longer offered, and this widget will be removed in InstantSearch.js v5
110+
*/
108111
const connectAnswers: AnswersConnector = function connectAnswers(
109112
renderFn,
110113
unmountFn = noop

packages/instantsearch.js/src/widgets/answers/answers.tsx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { component } from '../../lib/suit';
99
import { prepareTemplateProps } from '../../lib/templating';
1010
import {
1111
createDocumentationMessageGenerator,
12+
deprecate,
1213
getContainerNode,
1314
} from '../../lib/utils';
1415

@@ -139,6 +140,9 @@ export type AnswersWidget = WidgetFactory<
139140
AnswersWidgetParams
140141
>;
141142

143+
/**
144+
* @deprecated the answers service is no longer offered, and this widget will be removed in InstantSearch.js v5
145+
*/
142146
const answersWidget: AnswersWidget = (widgetParams) => {
143147
const {
144148
container,
@@ -192,4 +196,7 @@ const answersWidget: AnswersWidget = (widgetParams) => {
192196
};
193197
};
194198

195-
export default answersWidget;
199+
export default deprecate(
200+
answersWidget,
201+
'The answers widget is deprecated and will be removed in InstantSearch.js 5.0'
202+
);

packages/instantsearch.js/src/widgets/places/places.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { deprecate } from '../../lib/utils';
2+
13
import type { WidgetFactory, WidgetRenderState } from '../../types';
24
/* Places.js is an optional dependency, no error should be reported if the package is missing */
35
/** @ts-ignore */
@@ -54,6 +56,7 @@ export type PlacesWidget = WidgetFactory<
5456
/**
5557
* This widget sets the geolocation value for the search based on the selected
5658
* result in the Algolia Places autocomplete.
59+
* @deprecated the places service is no longer offered, and this widget will be removed in InstantSearch.js v5
5760
*/
5861
const placesWidget: PlacesWidget = (widgetParams) => {
5962
const {
@@ -172,4 +175,7 @@ const placesWidget: PlacesWidget = (widgetParams) => {
172175
};
173176
};
174177

175-
export default placesWidget;
178+
export default deprecate(
179+
placesWidget,
180+
'The places widget is deprecated and will be removed in InstantSearch.js 5.0.'
181+
);

0 commit comments

Comments
 (0)