implement widgetType

src/types/widget.ts

@@ -418,6 +418,7 @@ export type Widget<
     | 'ais.index'
     | 'ais.infiniteHits'
     | 'ais.menu'
+    | 'ais.menuSelect'
     | 'ais.numericMenu'
     | 'ais.pagination'
     | 'ais.places'

src/widgets/analytics/analytics.ts

@@ -225,6 +225,7 @@ For the migration, visit https://www.algolia.com/doc/guides/building-search-ui/u
 
   return {
     $$type: 'ais.analytics',
+    $$widgetType: 'ais.analytics',
 
     init() {
       if (triggerOnUIInteraction === true) {

src/widgets/breadcrumb/breadcrumb.tsx

@@ -167,6 +167,7 @@ const breadcrumb: BreadcrumbWidget = function breadcrumb(widgetOptions) {
 
   return {
     ...makeWidget({ attributes, separator, rootPath, transformItems }),
+    $$widgetType: 'ais.breadcrumb',
   };
 };
 

src/widgets/clear-refinements/clear-refinements.tsx

@@ -134,6 +134,7 @@ const clearRefinements: ClearRefinementsWidget = widgetOptions => {
       excludedAttributes,
       transformItems,
     }),
+    $$widgetType: 'ais.clearRefinements',
   };
 };
 

src/widgets/configure-related-items/configure-related-items.ts

@@ -21,6 +21,7 @@ const configureRelatedItems: ConfigureRelatedItemsWidget = function configureRel
 
   return {
     ...makeWidget(widgetParams),
+    $$widgetType: 'ais.configureRelatedItems',
   };
 };
 

src/widgets/configure/configure.ts

@@ -27,6 +27,7 @@ const configure: ConfigureWidget = function configure(widgetParams) {
 
   return {
     ...makeWidget({ searchParameters: widgetParams }),
+    $$widgetType: 'ais.configure',
   };
 };
 

src/widgets/current-refinements/current-refinements.tsx

@@ -129,6 +129,7 @@ const currentRefinements: CurrentRefinementsWidget = function currentRefinements
       excludedAttributes,
       transformItems,
     }),
+    $$widgetType: 'ais.currentRefinements',
   };
 };
 

src/widgets/geo-search/geo-search.js

@@ -230,6 +230,7 @@ const geoSearch = widgetOptions => {
       enableClearMapRefinement,
       enableRefineControl,
     }),
+    $$widgetType: 'ais.geoSearch',
   };
 };
 

src/widgets/hierarchical-menu/hierarchical-menu.js

@@ -248,5 +248,6 @@ export default function hierarchicalMenu(widgetOptions) {
       sortBy,
       transformItems,
     }),
+    $$widgetType: 'ais.hierarchicalMenu',
   };
 }

src/widgets/hits-per-page/hits-per-page.tsx

@@ -104,6 +104,7 @@ const hitsPerPage: HitsPerPageWidget = function hitsPerPage(widgetOptions) {
 
   return {
     ...makeWidget({ items, transformItems }),
+    $$widgetType: 'ais.hitsPerPage',
   };
 };
 

src/widgets/hits/hits.tsx

@@ -163,6 +163,7 @@ const hits: HitsWidget = function hits(widgetOptions) {
 
   return {
     ...makeWidget({ escapeHTML, transformItems }),
+    $$widgetType: 'ais.hits',
   };
 };
 

src/widgets/index/index.ts

@@ -194,6 +194,7 @@ const index = (props: IndexProps): Index => {
 
   return {
     $$type: 'ais.index',
+    $$widgetType: 'ais.index',
 
     getIndexName() {
       return indexName;

src/widgets/infinite-hits/infinite-hits.tsx

@@ -236,6 +236,7 @@ const infiniteHits: InfiniteHitsWidget = widgetOptions => {
       showPrevious,
       cache,
     }),
+    $$widgetType: 'ais.infiniteHits',
   };
 };
 

src/widgets/menu-select/menu-select.js

@@ -122,5 +122,6 @@ export default function menuSelect(widgetOptions) {
 
   return {
     ...makeWidget({ attribute, limit, sortBy, transformItems }),
+    $$widgetType: 'ais.menuSelect',
   };
 }

src/widgets/menu/menu.js

@@ -182,5 +182,6 @@ export default function menu(widgetOptions) {
       sortBy,
       transformItems,
     }),
+    $$widgetType: 'ais.menu',
   };
 }

src/widgets/numeric-menu/numeric-menu.tsx

@@ -215,6 +215,7 @@ const numericMenu: NumericMenuWidget = function numericMenu(widgetOptions) {
       items,
       transformItems,
     }),
+    $$widgetType: 'ais.numericMenu',
   };
 };
 

src/widgets/pagination/pagination.js

@@ -223,5 +223,6 @@ export default function pagination(widgetOptions) {
 
   return {
     ...makeWidget({ totalPages, padding }),
+    $$widgetType: 'ais.pagination',
   };
 }

src/widgets/places/places.ts

@@ -60,6 +60,7 @@ const placesWidget: PlacesWidget = (widgetParams: PlacesWidgetParams) => {
 
   return {
     $$type: 'ais.places',
+    $$widgetType: 'ais.places',
 
     init({ helper }) {
       placesAutocomplete.on('change', (eventOptions: ChangeEvent) => {

src/widgets/powered-by/powered-by.js

@@ -89,5 +89,6 @@ export default function poweredBy(widgetOptions) {
 
   return {
     ...makeWidget({ theme }),
+    $$widgetType: 'ais.poweredBy',
   };
 }

src/widgets/query-rule-context/query-rule-context.tsx

@@ -33,6 +33,7 @@ const queryRuleContext: QueryRuleContext = (
     ...connectQueryRules<QueryRuleContextWidgetParams>(noop)(widgetParams),
 
     $$type: 'ais.queryRuleContext',
+    $$widgetType: 'ais.queryRuleContext',
   };
 };
 

src/widgets/query-rule-custom-data/query-rule-custom-data.tsx

@@ -97,6 +97,7 @@ const queryRuleCustomData: QueryRuleCustomDataWidget = widgetOptions => {
     }),
 
     $$type: 'ais.queryRuleCustomData',
+    $$widgetType: 'ais.queryRuleCustomData',
   };
 };
 

src/widgets/range-input/__tests__/range-input-test.ts

@@ -43,7 +43,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/range-input
 
       expect(widget).toEqual(
         expect.objectContaining({
-          $$type: 'ais.range',
+          $$type: 'ais.rangeInput',
           $$widgetType: 'ais.rangeInput',
         })
       );

src/widgets/range-input/range-input.js

@@ -169,6 +169,7 @@ export default function rangeInput(widgetOptions) {
       precision,
     }),
 
+    $$type: 'ais.rangeInput',
     $$widgetType: 'ais.rangeInput',
   };
 }

src/widgets/range-slider/__tests__/range-slider-test.ts

@@ -63,7 +63,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/range-slide
 
       expect(widget).toEqual(
         expect.objectContaining({
-          $$type: 'ais.range',
+          $$type: 'ais.rangeSlider',
           $$widgetType: 'ais.rangeSlider',
         })
       );

src/widgets/range-slider/range-slider.js

@@ -150,6 +150,7 @@ export default function rangeSlider(widgetOptions) {
   return {
     ...makeWidget({ attribute, min, max, precision }),
 
+    $$type: 'ais.rangeSlider',
     $$widgetType: 'ais.rangeSlider',
   };
 }

src/widgets/rating-menu/rating-menu.js

@@ -166,5 +166,6 @@ export default function ratingMenu(widgetOptions) {
 
   return {
     ...makeWidget({ attribute, max }),
+    $$widgetType: 'ais.ratingMenu',
   };
 }

src/widgets/refinement-list/refinement-list.js

@@ -313,5 +313,6 @@ export default function refinementList(widgetOptions) {
       escapeFacetValues,
       transformItems,
     }),
+    $$widgetType: 'ais.refinementList',
   };
 }

src/widgets/search-box/search-box.js

@@ -162,5 +162,6 @@ export default function searchBox(widgetOptions) {
 
   return {
     ...makeWidget({ queryHook }),
+    $$widgetType: 'ais.searchBox',
   };
 }

src/widgets/sort-by/sort-by.js

@@ -103,5 +103,6 @@ export default function sortBy(widgetOptions) {
 
   return {
     ...makeWidget({ items, transformItems }),
+    $$widgetType: 'ais.sortBy',
   };
 }

src/widgets/stats/stats.js

@@ -131,5 +131,6 @@ export default function stats(widgetOptions) {
 
   return {
     ...makeWidget(),
+    $$widgetType: 'ais.stats',
   };
 }

src/widgets/toggle-refinement/toggle-refinement.js

@@ -140,5 +140,6 @@ export default function toggleRefinement(widgetOptions) {
 
   return {
     ...makeWidget({ attribute, on, off }),
+    $$widgetType: 'ais.toggleRefinement',
   };
 }

src/widgets/voice-search/voice-search.tsx

@@ -127,6 +127,7 @@ const voiceSearch: VoiceSearch = widgetOptions => {
       additionalQueryParameters,
       createVoiceSearchHelper,
     }),
+    $$widgetType: 'ais.voiceSearch',
   };
 };