feat(plugins): introduce plugin name (#767)

packages/autocomplete-core/src/types/AutocompletePlugin.ts

@@ -31,4 +31,10 @@ export type AutocompletePlugin<
    * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/#param-data
    */
   data?: TData;
+  /**
+   * A name to identify the plugin.
+   *
+   * @link https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/#param-name
+   */
+  name?: string;
 };

packages/autocomplete-plugin-algolia-insights/src/__tests__/createAlgoliaInsightsPlugin.test.ts

@@ -1,3 +1,13 @@
+import insightsClient from 'search-insights';
+
+import { createAlgoliaInsightsPlugin } from '../createAlgoliaInsightsPlugin';
+
 describe('createAlgoliaInsightsPlugin', () => {
+  test('has a name', () => {
+    const plugin = createAlgoliaInsightsPlugin({ insightsClient });
+
+    expect(plugin.name).toBe('aa.algoliaInsightsPlugin');
+  });
+
   test.todo('tests');
 });

packages/autocomplete-plugin-algolia-insights/src/createAlgoliaInsightsPlugin.ts

@@ -116,6 +116,7 @@ export function createAlgoliaInsightsPlugin({
   }, 0);
 
   return {
+    name: 'aa.algoliaInsightsPlugin',
     subscribe({ setContext, onSelect, onActive }) {
       setContext({ algoliaInsightsPlugin: { insights } });
 

packages/autocomplete-plugin-query-suggestions/src/__tests__/createQuerySuggestionsPlugin.test.ts

@@ -1,4 +1,18 @@
+import { createSearchClient } from '../../../../test/utils';
+import { createQuerySuggestionsPlugin } from '../createQuerySuggestionsPlugin';
+
+const searchClient = createSearchClient();
+
 describe('createQuerySuggestionsPlugin', () => {
+  test('has a name', () => {
+    const plugin = createQuerySuggestionsPlugin({
+      searchClient,
+      indexName: 'indexName',
+    });
+
+    expect(plugin.name).toBe('aa.querySuggestionsPlugin');
+  });
+
   test.todo('adds a source');
 
   test.todo('fills the input with the query item key');

packages/autocomplete-plugin-query-suggestions/src/createQuerySuggestionsPlugin.ts

@@ -81,6 +81,7 @@ export function createQuerySuggestionsPlugin<
   undefined
 > {
   return {
+    name: 'aa.querySuggestionsPlugin',
     getSources({ query, setQuery, refresh, state }) {
       function onTapAhead(item: TItem) {
         setQuery(`${item.query} `);

packages/autocomplete-plugin-recent-searches/src/__tests__/createLocalStorageRecentSearchesPlugin.test.ts

@@ -0,0 +1,11 @@
+import { createLocalStorageRecentSearchesPlugin } from '../createLocalStorageRecentSearchesPlugin';
+
+describe('createLocalStorageRecentSearchesPlugin', () => {
+  test('has a name', () => {
+    const plugin = createLocalStorageRecentSearchesPlugin({
+      key: 'autocomplete',
+    });
+
+    expect(plugin.name).toBe('aa.localStorageRecentSearchesPlugin');
+  });
+});

packages/autocomplete-plugin-recent-searches/src/__tests__/createRecentSearchesPlugin.test.ts

@@ -1,4 +1,16 @@
+import { noop } from '@algolia/autocomplete-shared';
+
+import { createRecentSearchesPlugin } from '../createRecentSearchesPlugin';
+
 describe('createRecentSearchesPlugin', () => {
+  test('has a name', () => {
+    const plugin = createRecentSearchesPlugin({
+      storage: { onAdd: noop, onRemove: noop, getAll: () => [] },
+    });
+
+    expect(plugin.name).toBe('aa.recentSearchesPlugin');
+  });
+
   test.todo('saves the query on select');
 
   test.todo('does not save the query on select without item input value');

packages/autocomplete-plugin-recent-searches/src/createLocalStorageRecentSearchesPlugin.ts

@@ -72,9 +72,14 @@ export function createLocalStorageRecentSearchesPlugin<
     search,
   });
 
-  return createRecentSearchesPlugin({
+  const recentSearchesPlugin = createRecentSearchesPlugin({
     transformSource,
     storage,
     subscribe,
   });
+
+  return {
+    ...recentSearchesPlugin,
+    name: 'aa.localStorageRecentSearchesPlugin',
+  };
 }

packages/autocomplete-plugin-recent-searches/src/createRecentSearchesPlugin.ts

@@ -78,6 +78,7 @@ export function createRecentSearchesPlugin<TItem extends RecentSearchesItem>({
   const lastItemsRef = createRef<MaybePromise<TItem[]>>([]);
 
   return {
+    name: 'aa.recentSearchesPlugin',
     subscribe: subscribe ?? getDefaultSubcribe(store),
     onSubmit({ state }) {
       const { query } = state;

packages/autocomplete-plugin-tags/src/__tests__/createTagsPlugin.test.tsx

@@ -11,6 +11,12 @@ beforeEach(() => {
 });
 
 describe('createTagsPlugin', () => {
+  test('has a name', () => {
+    const tagsPlugin = createTagsPlugin();
+
+    expect(tagsPlugin.name).toBe('aa.tagsPlugin');
+  });
+
   test('adds a tags source', async () => {
     const container = document.createElement('div');
     const panelContainer = document.createElement('div');

packages/autocomplete-plugin-tags/src/createTagsPlugin.tsx

@@ -93,6 +93,7 @@ export function createTagsPlugin<
   const tagsApi = { setTags: tags.set, addTags: tags.add };
 
   return {
+    name: 'aa.tagsPlugin',
     subscribe(params) {
       const { setContext, onSelect, setIsOpen, refresh } = params;
       const subscribers = getTagsSubscribers();