musora-content-services 1.5.0 → 1.6.0

package/src/services/algolia.js

@@ -0,0 +1,64 @@
+/**
+ * @module Search-Engine-Services
+ */
+
+import { globalConfig } from './config'
+import { algoliasearch } from 'algoliasearch'
+
+/**
+ * Sends an event through the search engine API (as of now, algolia)
+ *
+ * @param {string} index - The index to which the event will be sent.
+ * @param {string} queryId - The unique identifier for the search query.
+ * @param {string[]} objectIDs - An array of object IDs that were clicked.
+ * @param {number[]} positions - An array of positions corresponding to the object IDs clicked.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the event is sent.
+ *
+ * @example
+ * ```
+ * sendAlgoliaClickEvent(
+ *   'production_sanity_all',
+ *   '43b15df305339e827f0ac0bdc5ebcaa7',
+ *   ['9780545139700', '9780439784542'],
+ *   [7, 6]
+ * );
+ * ```
+ */
+export async function sendAlgoliaClickEvent(index, queryId, objectIDs, positions) {
+  if (!queryId || !objectIDs || !positions) {
+    throw new Error('queryId, objectIDs, and positions are required parameters.')
+  }
+
+  if (objectIDs.length !== positions.length) {
+    throw new Error('objectIDs and positions must have the same length.')
+  }
+
+  const searchEngine = algoliasearch(
+    globalConfig.searchEngineConfig.applicationId,
+    globalConfig.searchEngineConfig.apiKey
+  ).initInsights({
+    region: 'us',
+  })
+
+  try {
+    await searchEngine.pushEvents({
+      events: [
+        {
+          eventType: 'click',
+          eventName: 'Content Clicked',
+          index: index,
+          userToken: globalConfig.railcontentConfig.userId.toString(),
+          authenticatedUserToken: globalConfig.railcontentConfig.authToken,
+          timestamp: new Date().getTime(),
+          objectIDs: objectIDs,
+          queryID: queryId,
+          positions: positions,
+        },
+      ],
+    })
+  } catch (error) {
+    // Don't throw as it is not a blocker
+    console.error('Error sending search event:', error)
+  }
+}

package/src/services/config.js

@@ -8,6 +8,7 @@ export let globalConfig = {
   sanityConfig: {},
   railcontentConfig: {},
   recommendationsConfig: {},
+  searchEngineConfig: {},
   localStorage: null,
   isMA: false,
   localTimezoneString: null, // In format: America/Vancouver
@@ -40,6 +41,8 @@ const excludeFromGeneratedIndex = []
  * @param {string} config.railcontentConfig.authToken - The bearer authorization token.
  * @param {string} config.recommendationsConfig.token - The token for authenticating recommendation requests.
  * @param {string} config.recommendationsConfig.baseUrl - The url for the recommendation server.
+ * @param {string} config.searchEngineConfig.applicationId - The application ID for the search engine (e.g., Algolia).
+ * @param {string} config.searchEngineConfig.apiKey - The API key for the search engine.
  * @param {Object} config.localStorage - Cache to use for localStorage
  * @param {boolean} config.isMA - Variable that tells if the library is used by MA or FEW
  * @param {string} config.localTimezoneString - The local timezone string in format: America/Vancouver
@@ -60,7 +63,7 @@ const excludeFromGeneratedIndex = []
  *     token: 'your-user-api-token',
  *     userId: 'current-user-id',
  *     baseUrl: 'https://web-staging-one.musora.com',
- *     authToken 'your-auth-token',
+ *     authToken: 'your-auth-token',
  *   },
  *   recommendationsConfig: {
  *     token: 'your-user-api-token',
@@ -77,6 +80,7 @@ export function initializeService(config) {
   globalConfig.isMA = config.isMA || false
   globalConfig.localTimezoneString = config.localTimezoneString || null
   globalConfig.recommendationsConfig = config.recommendationsConfig
+  globalConfig.searchEngineConfig = config.searchEngineConfig
 }
 
 export function setUserMetadata(userMetaData) {