fix(widgets): remove analytics widget (#6398)

* fix(widgets): remove analytics widget The analytics widget has long been deprecated, and is removed with the insights middleware as alternative. You can use the `onEvent` hook to use a different service. BREAKING CHANGE: the analytics widget no longer exists * !fixup stories
algolia · Oct 18, 2024 · 3840673 · 3840673
1 parent 09540a4
commit 3840673
Show file tree

Hide file tree

Showing 7 changed files with 1 addition and 357 deletions.
diff --git a/packages/instantsearch.js/src/types/render-state.ts b/packages/instantsearch.js/src/types/render-state.ts
@@ -23,7 +23,6 @@ import type { SortByWidgetDescription } from '../connectors/sort-by/connectSortB
 import type { StatsWidgetDescription } from '../connectors/stats/connectStats';
 import type { ToggleRefinementWidgetDescription } from '../connectors/toggle-refinement/connectToggleRefinement';
 import type { VoiceSearchWidgetDescription } from '../connectors/voice-search/connectVoiceSearch';
-import type { AnalyticsWidgetDescription } from '../widgets/analytics/analytics';
 import type { PlacesWidgetDescription } from '../widgets/places/places';
 
 type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'] &
@@ -52,8 +51,7 @@ type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'] &
   ToggleRefinementWidgetDescription['indexRenderState'] &
   VoiceSearchWidgetDescription['indexRenderState'];
 
-type WidgetRenderStates = AnalyticsWidgetDescription['indexRenderState'] &
-  PlacesWidgetDescription['indexRenderState'];
+type WidgetRenderStates = PlacesWidgetDescription['indexRenderState'];
 
 export type IndexRenderState = Partial<
   ConnectorRenderStates & WidgetRenderStates

diff --git a/packages/instantsearch.js/src/types/widget.ts b/packages/instantsearch.js/src/types/widget.ts
@@ -56,7 +56,6 @@ export type DisposeOptions = {
 
 // @MAJOR: Remove these exported types if we don't need them
 export type BuiltinTypes =
-  | 'ais.analytics'
   | 'ais.answers'
   | 'ais.autocomplete'
   | 'ais.breadcrumb'
@@ -95,7 +94,6 @@ export type BuiltinTypes =
   | 'ais.voiceSearch';
 
 export type BuiltinWidgetTypes =
-  | 'ais.analytics'
   | 'ais.answers'
   | 'ais.autocomplete'
   | 'ais.breadcrumb'

diff --git a/packages/instantsearch.js/src/widgets/__tests__/index.test.ts b/packages/instantsearch.js/src/widgets/__tests__/index.test.ts
@@ -100,12 +100,6 @@ function initiateAllWidgets(): Array<[WidgetNames, Widget | IndexWidget]> {
           items: [{ label: 'x', value: 'x' }],
         });
       }
-      case 'analytics': {
-        const analytics = widget as Widgets['analytics'];
-        return analytics({
-          pushFunction() {},
-        });
-      }
       case 'queryRuleContext': {
         const queryRuleContext = widget as Widgets['queryRuleContext'];
         return queryRuleContext({

diff --git a/packages/instantsearch.js/src/widgets/analytics/__tests__/analytics-test.ts b/packages/instantsearch.js/src/widgets/analytics/__tests__/analytics-test.ts
diff --git a/packages/instantsearch.js/src/widgets/analytics/analytics.ts b/packages/instantsearch.js/src/widgets/analytics/analytics.ts
diff --git a/packages/instantsearch.js/src/widgets/index.ts b/packages/instantsearch.js/src/widgets/index.ts
@@ -23,7 +23,6 @@ export const EXPERIMENTAL_dynamicWidgets = deprecate(
 );
 export { dynamicWidgets };
 
-export { default as analytics } from './analytics/analytics';
 export { default as breadcrumb } from './breadcrumb/breadcrumb';
 export { default as clearRefinements } from './clear-refinements/clear-refinements';
 export { default as configure } from './configure/configure';