Add missing args

vtex · Dec 13, 2024 · 65686ce · 65686ce
1 parent 375eaa8
commit 65686ce
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 44 deletions.
diff --git a/packages/core/src/sdk/analytics/platform/vtex/index.ts b/packages/core/src/sdk/analytics/platform/vtex/index.ts
@@ -1,7 +1,7 @@
 import type { AnalyticsEvent } from '@faststore/sdk'
 
-import handleSearchEvent from './search'
 import handleRCEvent from './rc'
+import handleSearchEvent from './search'
 
 export default function sendEvent(event: AnalyticsEvent) {
   // VTEX RC

diff --git a/packages/core/src/sdk/analytics/platform/vtex/rc.ts b/packages/core/src/sdk/analytics/platform/vtex/rc.ts
@@ -1,4 +1,5 @@
 import { AnalyticsEvent, PageViewEvent } from '@faststore/sdk'
+import { ServerProductQueryQuery } from '@generated/graphql'
 import {
   CategoryView,
   DepartmentView,
@@ -7,7 +8,7 @@ import {
   InternalSiteSearchView,
   OtherView,
   ProductView,
-  SearchSelectItemEvent,
+  SearchEvents,
 } from '../../types'
 
 const EventNames = {
@@ -19,58 +20,67 @@ const EventNames = {
   PRODUCT_VIEW: 'productView',
 } as const
 
-type EventNames = (typeof EventNames)[keyof typeof EventNames]
-type EventParams =
+type RequestCaptureEventNames = (typeof EventNames)[keyof typeof EventNames]
+type RequestCaptureEvent =
   | HomeView
   | CategoryView
   | DepartmentView
   | InternalSiteSearchView
   | ProductView
   | OtherView
 
-const sendEvent = (eventName: EventNames, eventParams: EventParams) => {
+const sendEvent = (
+  eventName: RequestCaptureEventNames,
+  eventParams: RequestCaptureEvent
+) => {
   window?.sendrc?.(eventName, eventParams)
 }
 
-const handleEvent = (
-  event: AnalyticsEvent | SearchSelectItemEvent | IntelligentSearchQueryEvent
-) => {
+const handleEvent = (event: AnalyticsEvent | SearchEvents) => {
   let eventParams
   switch (event.name) {
-    //TODO: add missing events - eg 'add_to_cart' and 'view_cart'
     case 'page_view':
       eventParams = (event as PageViewEvent).params
-      switch (eventParams.type) {
+      const pageType = eventParams?.page?.type ?? eventParams?.type
+
+      switch (pageType) {
         case 'plp':
+          if (!eventParams?.page_location?.includes('fuzzy')) {
+            // Skip when there is no fuzzy parameters on the URL,
+            // otherwise it'll be sent twice (once without fuzzy and once with fuzzy)
+            break
+          }
           const collection = eventParams?.data?.collection
           const collectionCategoryList =
             collection?.breadcrumbList?.itemListElement
           if (collectionCategoryList.length > 1) {
-            // console.log('✨ Category View Event:', eventParams)
             sendEvent(EventNames.CATEGORY_VIEW, {
-              //TODO: add missing arg - categoryId
-              departmentId: collection?.id,
               departmentName: collectionCategoryList[0]?.name,
+              categoryId: collection?.id,
               categoryName:
                 collectionCategoryList[collectionCategoryList.length - 1]?.name,
             })
           } else {
-            // console.log('✨ Department View Event:', eventParams)
             sendEvent(EventNames.DEPARTMENT_VIEW, {
               departmentId: collection?.id,
               departmentName: collectionCategoryList[0]?.name,
             })
           }
+
           break
+
         case 'pdp':
-          // console.log('✨ Product View Event: ', eventParams)
-          const product = eventParams?.data?.product
-          const offers = product?.offers
+          const product = eventParams?.data
+            ?.product as ServerProductQueryQuery['product']
           const productCategoryList = product?.breadcrumbList?.itemListElement
+          const offers = product?.offers?.offers
+          const sellerIds = offers.map((offer) => offer.seller.identifier)
+          const skusOutOfStock = offers.filter(
+            (offer) => offer.availability === 'https://schema.org/OutOfStock'
+          )
+
           sendEvent(EventNames.PRODUCT_VIEW, {
-            //TODO: add missing args - skuStockOutFromProductDetail, productReferenceId,
-            // productEans, skuStocks, productBrandId, productDepartmentId,
-            // productCategoryId, productListPrice, sellerIds
+            skuStockOutFromProductDetail: skusOutOfStock,
             productId: product?.isVariantOf?.productGroupID,
             productName: product?.isVariantOf?.name,
             productBrandName: product?.brand?.name,
@@ -81,29 +91,36 @@ const handleEvent = (
               productCategoryList.length > 1
                 ? productCategoryList[productCategoryList.length - 2]?.name
                 : '',
-            productPrice: offers?.price,
-            sellerId: offers?.seller?.id,
+            productPrice: offers[0]?.price,
+            productListPrice: offers[0]?.listPrice,
+            sellerId: offers[0]?.seller?.identifier,
+            sellerIds: sellerIds.join(','),
           })
           break
+
+        case 'home':
+          sendEvent(EventNames.HOME_VIEW, {})
+          break
+
+        case 'search':
+          // This one is skipped because the event related to search view is being
+          // sent using the intelligent_search_query event due to its parameters
+          break
+
         default:
-          if (eventParams?.page?.type === 'home') {
-            // console.log('✨ Home View Event:', eventParams)
-            sendEvent(EventNames.HOME_VIEW, {})
-          } else {
-            // console.log('✨ Other View Event:', eventParams)
-            sendEvent(EventNames.OTHER_VIEW, {})
-          }
+          sendEvent(EventNames.OTHER_VIEW, {})
       }
       break
+
     case 'intelligent_search_query':
-      console.log('✨ Internal Site Search View Event:', event)
       eventParams = (event as IntelligentSearchQueryEvent).params
       sendEvent(EventNames.INTERNAL_SITE_SEARCH_VIEW, {
         siteSearchTerm: eventParams.term,
         siteSearchForm: eventParams.url,
         siteSearchResults: eventParams.totalCount,
       })
       break
+
     default:
   }
 }

diff --git a/packages/core/src/sdk/analytics/platform/vtex/search.ts b/packages/core/src/sdk/analytics/platform/vtex/search.ts
@@ -2,12 +2,7 @@
  * More info at: https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless
  */
 import type { AnalyticsEvent } from '@faststore/sdk'
-import type {
-  IntelligentSearchAutocompleteClickEvent,
-  IntelligentSearchAutocompleteQueryEvent,
-  IntelligentSearchQueryEvent,
-  SearchSelectItemEvent,
-} from '../../types'
+import type { SearchEvents } from '../../types'
 
 import config from '../../../../../discovery.config'
 import { getCookie } from '../../../../utils/getCookie'
@@ -103,14 +98,7 @@ const isFullTextSearch = (url: URL) =>
   typeof url.searchParams.get('q') === 'string' &&
   /^\/s(\/)?$/g.test(url.pathname)
 
-const handleEvent = (
-  event:
-    | AnalyticsEvent
-    | SearchSelectItemEvent
-    | IntelligentSearchQueryEvent
-    | IntelligentSearchAutocompleteQueryEvent
-    | IntelligentSearchAutocompleteClickEvent
-) => {
+const handleEvent = (event: AnalyticsEvent | SearchEvents) => {
   switch (event.name) {
     case 'search_select_item': {
       const url = new URL(event.params.url)

diff --git a/packages/core/src/sdk/analytics/types.ts b/packages/core/src/sdk/analytics/types.ts
@@ -60,6 +60,13 @@ export interface IntelligentSearchAutocompleteClickEvent {
   name: 'intelligent_search_autocomplete_click'
   params: IntelligentSearchAutocompleteClickParams
 }
+
+export type SearchEvents =
+  | SearchSelectItemEvent
+  | IntelligentSearchQueryEvent
+  | IntelligentSearchAutocompleteQueryEvent
+  | IntelligentSearchAutocompleteClickEvent
+
 /**
  * RC event types
  * Types copied from Request Capture App: https://github.com/vtex/request-capture-app/blob/1becac32c002cb03a57bf36c8a7f9400eab8b933/react/typings/rcevents.d.ts