@envive-ai/react-hooks 0.3.68 → 0.3.69

package/src/contexts/pageContext/pageContext.tsx

@@ -20,9 +20,11 @@ import { useAtom, useAtomValue } from 'jotai';
 import { VariantTypeEnum } from 'src/application/models';
 import CommerceApiClient from 'src/application/commerce-api';
 import Logger from 'src/application/logging/logger';
+import { parseHref } from 'src/application/utils/urlsParser';
 import { PageVisitCategory, UserEventCategory } from '@spiffy-ai/commerce-api-client';
 import { EnviveMetricsEventName, useAmplitude } from 'src/contexts/amplitudeContext';
 import { mapApiUserEventToUserEvent, mapUrlResolverResponseToVariantInfo } from './mapping';
+import { extractPageViewedContext } from './pageViewedContext';
 import { PageDetails } from './types';
 
 const logger = new Logger('pageContext');
@@ -43,6 +45,15 @@ export const PageProvider: React.FC<{
   onUrlResolverNotReady?: (error: Error) => Promise<unknown> | void;
 }> = ({ children, previewMode = false, onUrlResolverNotReady }) => {
   const [pageUrl, setPageUrl] = useState<string | undefined>(undefined);
+  // Merchant-tagged on-site placement (?envive_placement=…) for entry-source attribution,
+  // captured on first render: theme/consent scripts can rewrite the URL (replaceState) before
+  // the Page Viewed event fires after URL resolution. Empty/absent → undefined (key omitted).
+  const [initialEnvivePlacement] = useState(
+    () =>
+      parseHref(typeof window !== 'undefined' ? window.location.href : '').urlSearchParams?.get(
+        'envive_placement',
+      ) || undefined,
+  );
   const [urlResolverResponse, setUrlResolverResponse] = useAtom(urlResolverAtom);
   const [isLoading, setIsLoading] = useState(false);
   const [variantInfo, setVariantInfo] = useAtom(pageVariantInfoAtom);
@@ -197,36 +208,9 @@ export const PageProvider: React.FC<{
       return;
     }
 
-    let pageType: string;
-    let pageId: string;
-
-    switch (variantInfo.variantType) {
-      case VariantTypeEnum.Pdp:
-        pageType = 'pdp';
-        pageId = variantInfo.productId;
-        break;
-      case VariantTypeEnum.Plp:
-        pageType = 'plp';
-        pageId = variantInfo.plpId;
-        break;
-      case VariantTypeEnum.Home:
-        pageType = 'homepage';
-        pageId = variantInfo.url;
-        break;
-      case VariantTypeEnum.Other:
-        pageType = 'other';
-        pageId = variantInfo.url;
-        break;
-      case VariantTypeEnum.PageVisit:
-        pageType = 'other';
-        pageId = variantInfo.url;
-        break;
-      case VariantTypeEnum.FullPageSalesAgent:
-        pageType = 'adaptive_storefront';
-        pageId = variantInfo.url;
-        break;
-      default:
-        return;
+    const pageViewedContext = extractPageViewedContext(variantInfo);
+    if (!pageViewedContext) {
+      return;
     }
 
     pageViewedFired.current = true;
@@ -234,14 +218,23 @@ export const PageProvider: React.FC<{
     trackEvent({
       eventName: EnviveMetricsEventName.PageViewed,
       eventProps: {
-        'context.page_type': pageType,
-        'context.page_id': pageId,
+        'context.page_type': pageViewedContext.page_type,
+        'context.page_id': pageViewedContext.page_id,
         'context.supported': isSupported,
         'context.ready': isSupported,
         'context.page_variant_id': resolvedVariantInfo.variantId,
+        ...(initialEnvivePlacement ? { 'context.envive_placement': initialEnvivePlacement } : {}),
       },
     });
-  }, [isLoading, isSupported, hasParsedVariantInfo, variantInfo, resolvedVariantInfo, trackEvent]);
+  }, [
+    isLoading,
+    isSupported,
+    hasParsedVariantInfo,
+    variantInfo,
+    resolvedVariantInfo,
+    trackEvent,
+    initialEnvivePlacement,
+  ]);
 
   const setPageUrlStable = useCallback((url: string) => {
     setPageUrl(url);

package/src/contexts/pageContext/pageViewedContext.ts

@@ -0,0 +1,59 @@
+import { VariantTypeEnum } from 'src/application/models';
+import {
+  FullPageSalesAgentVariantInfo,
+  HomeVariantInfo,
+  OtherVariantInfo,
+  PDPPageVariantInfo,
+  PLPPageVariantInfo,
+  PageVariantInfo,
+  VisitPageVariantInfo,
+} from './types';
+
+export interface PageViewedContext {
+  page_type: string;
+  page_id: string;
+}
+
+/**
+ * Maps a resolved page variant to the `context.page_type` / `context.page_id` pair sent on
+ * [Envive] Page Viewed. Single source of truth for that mapping — returns null for variant
+ * types that don't emit the event.
+ */
+export const extractPageViewedContext = (
+  pageVariant: PageVariantInfo,
+): PageViewedContext | null => {
+  switch (pageVariant.variantType) {
+    case VariantTypeEnum.Pdp:
+      return {
+        page_type: 'pdp',
+        page_id: (pageVariant as PDPPageVariantInfo).productId,
+      };
+    case VariantTypeEnum.Plp:
+      return {
+        page_type: 'plp',
+        page_id: (pageVariant as PLPPageVariantInfo).plpId,
+      };
+    case VariantTypeEnum.Home:
+      return {
+        page_type: 'homepage',
+        page_id: (pageVariant as HomeVariantInfo).url,
+      };
+    case VariantTypeEnum.Other:
+      return {
+        page_type: 'other',
+        page_id: (pageVariant as OtherVariantInfo).url,
+      };
+    case VariantTypeEnum.PageVisit:
+      return {
+        page_type: 'other',
+        page_id: (pageVariant as VisitPageVariantInfo).url,
+      };
+    case VariantTypeEnum.FullPageSalesAgent:
+      return {
+        page_type: 'adaptive_storefront',
+        page_id: (pageVariant as FullPageSalesAgentVariantInfo).url,
+      };
+    default:
+      return null;
+  }
+};

package/src/hooks/PageViewedEvent/usePageViewedEvent.ts

@@ -1,69 +1,24 @@
 import { useAtomValue } from 'jotai';
 import { useEffect, useRef } from 'react';
-import { VariantTypeEnum } from 'src/application/models';
 import { getQueryParam } from 'src/application/utils/urlsParser';
 import { hasParsedVariantInfoAtom, variantInfoAtom } from 'src/atoms/app/variant';
 import { EnviveMetricsEventName, useAmplitude } from 'src/contexts/amplitudeContext';
 import { usePage } from 'src/contexts/pageContext';
-import {
-  FullPageSalesAgentVariantInfo,
-  HomeVariantInfo,
-  OtherVariantInfo,
-  PDPPageVariantInfo,
-  PLPPageVariantInfo,
-  PageVariantInfo,
-  VisitPageVariantInfo,
-} from 'src/contexts/pageContext/types';
+import { extractPageViewedContext } from 'src/contexts/pageContext/pageViewedContext';
 
-interface PageViewedContext {
-  page_type: string;
-  page_id: string;
-}
-
-export const extractPageViewedContext = (
-  pageVariant: PageVariantInfo,
-): PageViewedContext | null => {
-  switch (pageVariant.variantType) {
-    case VariantTypeEnum.Pdp:
-      return {
-        page_type: 'pdp',
-        page_id: (pageVariant as PDPPageVariantInfo).productId,
-      };
-    case VariantTypeEnum.Plp:
-      return {
-        page_type: 'plp',
-        page_id: (pageVariant as PLPPageVariantInfo).plpId,
-      };
-    case VariantTypeEnum.Home:
-      return {
-        page_type: 'homepage',
-        page_id: (pageVariant as HomeVariantInfo).url,
-      };
-    case VariantTypeEnum.Other:
-      return {
-        page_type: 'other',
-        page_id: (pageVariant as OtherVariantInfo).url,
-      };
-    case VariantTypeEnum.PageVisit:
-      return {
-        page_type: 'other',
-        page_id: (pageVariant as VisitPageVariantInfo).url,
-      };
-    case VariantTypeEnum.FullPageSalesAgent:
-      return {
-        page_type: 'adaptive_storefront',
-        page_id: (pageVariant as FullPageSalesAgentVariantInfo).url,
-      };
-    default:
-      return null;
-  }
-};
+// Re-exported for compatibility with the public ./hooks/PageViewedEvent subpath.
+export { extractPageViewedContext };
 
 /**
  * Fires the [Envive] Page Viewed event once per page load when page context data is ready.
  *
  * This event captures page context information and is intended to eventually replace
  * the [Amplitude] Page Viewed event.
+ *
+ * @deprecated `PageProvider` (contexts/pageContext) already fires [Envive] Page Viewed;
+ * mounting this hook alongside it double-fires the event. Not used by the injection
+ * bundle. Retained only for compatibility with the public `./hooks/PageViewedEvent`
+ * subpath and will be removed in a future breaking release.
  */
 export const usePageViewedEvent = () => {
   const hasFired = useRef(false);