feat(dynamicWidgets): mark as stable (#4899)

DX-2422
algolia · Sep 7, 2021 · f97468f · f97468f
1 parent 3eea6ba
commit f97468f
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/src/connectors/index.ts b/src/connectors/index.ts
@@ -26,4 +26,12 @@ export { default as connectQueryRules } from './query-rules/connectQueryRules';
 export { default as connectVoiceSearch } from './voice-search/connectVoiceSearch';
 export { default as EXPERIMENTAL_connectAnswers } from './answers/connectAnswers';
 export { default as connectRelevantSort } from './relevant-sort/connectRelevantSort';
-export { default as EXPERIMENTAL_connectDynamicWidgets } from './dynamic-widgets/connectDynamicWidgets';
+
+import connectDynamicWidgets from './dynamic-widgets/connectDynamicWidgets';
+export { connectDynamicWidgets };
+import { deprecate } from '../lib/utils';
+/** @deprecated use connectDynamicWidgets */
+export const EXPERIMENTAL_connectDynamicWidgets = deprecate(
+  connectDynamicWidgets,
+  'use connectDynamicWidgets'
+);
diff --git a/src/widgets/__tests__/index.test.ts b/src/widgets/__tests__/index.test.ts
@@ -128,9 +128,9 @@ function initiateAllWidgets(): Array<[WidgetNames, Widget | IndexWidget]> {
           attributes: ['attr1', 'attr2'],
         });
       }
+      case 'dynamicWidgets':
       case 'EXPERIMENTAL_dynamicWidgets': {
-        const EXPERIMENTAL_dynamicWidgets =
-          widget as Widgets['EXPERIMENTAL_dynamicWidgets'];
+        const EXPERIMENTAL_dynamicWidgets = widget as Widgets['dynamicWidgets'];
         return EXPERIMENTAL_dynamicWidgets({
           transformItems(items) {
             return items;

diff --git a/src/widgets/index.ts b/src/widgets/index.ts
@@ -5,7 +5,16 @@ export { default as configure } from './configure/configure';
 export { default as currentRefinements } from './current-refinements/current-refinements';
 export { default as EXPERIMENTAL_answers } from './answers/answers';
 export { default as EXPERIMENTAL_configureRelatedItems } from './configure-related-items/configure-related-items';
-export { default as EXPERIMENTAL_dynamicWidgets } from './dynamic-widgets/dynamic-widgets';
+
+import dynamicWidgets from './dynamic-widgets/dynamic-widgets';
+export { dynamicWidgets };
+import { deprecate } from '../lib/utils';
+/** @deprecated use dynamicWidgets */
+export const EXPERIMENTAL_dynamicWidgets = deprecate(
+  dynamicWidgets,
+  'use dynamicWidgets'
+);
+
 export { default as geoSearch } from './geo-search/geo-search';
 export { default as hierarchicalMenu } from './hierarchical-menu/hierarchical-menu';
 export { default as hits } from './hits/hits';