feat(insights): allow to pass init params (#1230)

* feat(insights): allow to pass init params * bundlesize * add link to param
algolia · Jan 12, 2024 · 186ff9b · 186ff9b
1 parent 7f5ba08
commit 186ff9b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 3 deletions.
diff --git a/bundlesize.config.json b/bundlesize.config.json
@@ -6,15 +6,15 @@
     },
     {
       "path": "packages/autocomplete-js/dist/umd/index.production.js",
-      "maxSize": "21 kB"
+      "maxSize": "21.25 kB"
     },
     {
       "path": "packages/autocomplete-preset-algolia/dist/umd/index.production.js",
       "maxSize": "2.5 kB"
     },
     {
       "path": "packages/autocomplete-plugin-algolia-insights/dist/umd/index.production.js",
-      "maxSize": "3.25 kB"
+      "maxSize": "3.5 kB"
     },
     {
       "path": "packages/autocomplete-plugin-redirect-url/dist/umd/index.production.js",

diff --git a/...es/autocomplete-plugin-algolia-insights/src/__tests__/createAlgoliaInsightsPlugin.test.ts b/...es/autocomplete-plugin-algolia-insights/src/__tests__/createAlgoliaInsightsPlugin.test.ts
@@ -228,6 +228,28 @@ describe('createAlgoliaInsightsPlugin', () => {
     ]);
   });
 
+  test('does not call `init` if `insightsInitParams` not passed', () => {
+    const insightsClient = jest.fn();
+    createAlgoliaInsightsPlugin({
+      insightsClient,
+    });
+
+    expect(insightsClient).not.toHaveBeenCalled();
+  });
+
+  test('initializes insights with `insightsInitParams` if passed', () => {
+    const insightsClient = jest.fn();
+    createAlgoliaInsightsPlugin({
+      insightsClient,
+      insightsInitParams: { userToken: 'user' },
+    });
+
+    expect(insightsClient).toHaveBeenCalledWith('init', {
+      partial: true,
+      userToken: 'user',
+    });
+  });
+
   describe('automatic pulling', () => {
     const consoleError = jest
       .spyOn(console, 'error')

diff --git a/packages/autocomplete-plugin-algolia-insights/src/createAlgoliaInsightsPlugin.ts b/packages/autocomplete-plugin-algolia-insights/src/createAlgoliaInsightsPlugin.ts
@@ -20,6 +20,7 @@ import {
   AlgoliaInsightsHit,
   AutocompleteInsightsApi,
   InsightsClient,
+  InsightsMethodMap,
   OnActiveParams,
   OnItemsChangeParams,
   OnSelectParams,
@@ -57,6 +58,12 @@ export type CreateAlgoliaInsightsPluginParams = {
    * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-plugin-algolia-insights/createAlgoliaInsightsPlugin/#param-insightsclient
    */
   insightsClient?: InsightsClient;
+  /**
+   * Insights parameters to forward to the Insights client’s init method.
+   *
+   * @link https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-plugin-algolia-insights/createAlgoliaInsightsPlugin/#param-insightsinitparams
+   */
+  insightsInitParams?: Partial<InsightsMethodMap['init'][0]>;
   /**
    * Hook to send an Insights event when the items change.
    *
@@ -94,6 +101,7 @@ export function createAlgoliaInsightsPlugin(
 ): AutocompletePlugin<any, undefined> {
   const {
     insightsClient: providedInsightsClient,
+    insightsInitParams,
     onItemsChange,
     onSelect: onSelectEvent,
     onActive: onActiveEvent,
@@ -137,6 +145,10 @@ export function createAlgoliaInsightsPlugin(
     return {};
   }
 
+  if (insightsInitParams) {
+    insightsClient('init', { partial: true, ...insightsInitParams });
+  }
+
   const insights = createSearchInsightsApi(insightsClient);
   const previousItems = createRef<AlgoliaInsightsHit[]>([]);
 

diff --git a/packages/autocomplete-plugin-algolia-insights/src/types/InsightsClient.ts b/packages/autocomplete-plugin-algolia-insights/src/types/InsightsClient.ts
@@ -1,5 +1,5 @@
 import type {
-  InsightsMethodMap,
+  InsightsMethodMap as _InsightsMethodMap,
   InsightsClient as _InsightsClient,
 } from 'search-insights';
 
@@ -11,6 +11,7 @@ export type {
   OnUserTokenChange as InsightsOnUserTokenChange,
 } from 'search-insights';
 
+export type InsightsMethodMap = _InsightsMethodMap;
 export type InsightsClientMethod = keyof InsightsMethodMap;
 
 export type InsightsClientPayload = {