move type

algolia · Mar 22, 2023 · f2cac54 · f2cac54
1 parent c2104d5
commit f2cac54
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 21 deletions.
diff --git a/packages/instantsearch.js/src/middlewares/createInsightsMiddleware.ts b/packages/instantsearch.js/src/middlewares/createInsightsMiddleware.ts
@@ -9,37 +9,21 @@ import {
 
 import type {
   InsightsClient,
+  InsightsEvent as _InsightsEvent,
+  InsightsMethod,
   InsightsMethodMap,
   InternalMiddleware,
-  Hit,
 } from '../types';
 import type {
   AlgoliaSearchHelper,
   PlainSearchParameters,
 } from 'algoliasearch-helper';
 
-// not every method is actually allowed to be called with the insights middleware
-export type InsightsMethod =
-  | 'clickedObjectIDsAfterSearch'
-  | 'clickedObjectIDs'
-  | 'clickedFilters'
-  | 'convertedObjectIDsAfterSearch'
-  | 'convertedObjectIDs'
-  | 'convertedFilters'
-  | 'viewedObjectIDs'
-  | 'viewedFilters';
-
-export type InsightsEvent<TMethod extends InsightsMethod = InsightsMethod> = {
-  insightsMethod?: TMethod;
-  payload: InsightsMethodMap[TMethod][0];
-  widgetType: string;
-  eventType: string; // 'view' | 'click' | 'conversion', but we're not restricting.
-  hits?: Hit[];
-  attribute?: string;
-};
-
 type ProvidedInsightsClient = InsightsClient | null | undefined;
 
+export type InsightsEvent<TMethod extends InsightsMethod = InsightsMethod> =
+  _InsightsEvent<TMethod>;
+
 export type InsightsProps<
   TInsightsClient extends ProvidedInsightsClient = ProvidedInsightsClient
 > = {

diff --git a/packages/instantsearch.js/src/types/insights.ts b/packages/instantsearch.js/src/types/insights.ts
@@ -1,3 +1,4 @@
+import type { Hit } from './results';
 import type {
   InsightsMethodMap as _InsightsMethodMap,
   InsightsClient as _InsightsClient,
@@ -14,6 +15,31 @@ export type {
 export type InsightsMethodMap = _InsightsMethodMap;
 export type InsightsClientMethod = keyof InsightsMethodMap;
 
+/**
+ * Method allowed by the insights middleware.
+ */
+export type InsightsMethod =
+  | 'clickedObjectIDsAfterSearch'
+  | 'clickedObjectIDs'
+  | 'clickedFilters'
+  | 'convertedObjectIDsAfterSearch'
+  | 'convertedObjectIDs'
+  | 'convertedFilters'
+  | 'viewedObjectIDs'
+  | 'viewedFilters';
+
+/**
+ * The event sent to the insights middleware.
+ */
+export type InsightsEvent<TMethod extends InsightsMethod = InsightsMethod> = {
+  insightsMethod?: TMethod;
+  payload: InsightsMethodMap[TMethod][0];
+  widgetType: string;
+  eventType: string; // 'view' | 'click' | 'conversion', but we're not restricting.
+  hits?: Hit[];
+  attribute?: string;
+};
+
 export type InsightsClientPayload = {
   eventName: string;
   queryID: string;