@coveo/shopify 1.1.1-pre.fe37143864 → 1.2.0-pre.7b4dd8aaef

package/dist/headless.d.ts

@@ -25,10 +25,11 @@ export interface AppProxyResponse {
  *          environment, and tracking ID.
  */
 export declare function fetchAppProxyConfig({ appProxyUrl, marketId, }: AppProxyOptions): Promise<AppProxyResponse>;
+type ShopifyCustomEnvironment = Omit<CustomEnvironment, 'storage' | 'generateUUID'>;
 interface BuildShopifyCommerceEngineOptions {
     commerceEngineOptions: CommerceEngineOptions;
     shopifyCookie?: string;
-    environment?: CustomEnvironment;
+    environment?: ShopifyCustomEnvironment;
 }
 /**
  * Builds the commerce engine for a Shopify store.
@@ -39,6 +40,11 @@ interface BuildShopifyCommerceEngineOptions {
  * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
  * - Building and returning the commerce engine with the provided options.
  *
+ * @remarks
+ * The `generateUUID` and `storage` properties are omitted from the custom environment for Shopify
+ * to ensure that client IDs are generated consistently across web pixels and storefronts. This is
+ * critical for maintaining a unified tracking and personalization experience.
+ *
  * @param commerceEngineOptions - Options to configure the commerce engine.
  * @param shopifyCookie - Optional value of the "_shopify_y" cookie. If not provided, it will attempt to retrieve it from the browser's cookies.
  * @param environment - Optional browser environment; if not provided, a default one is created. Mainly useful when not running in a browser environment.

package/dist/headless.esm.js

@@ -20,10 +20,7 @@
 import {
   buildCommerceEngine
 } from "@coveo/headless/commerce";
-import {
-  buildBrowserEnvironment,
-  clientIdKey
-} from "@coveo/relay";
+import { buildBrowserEnvironment } from "@coveo/relay";
 
 // src/utilities.ts
 import { v5 } from "uuid";
@@ -47,15 +44,26 @@ function buildShopifyCommerceEngine({
   shopifyCookie,
   environment
 }) {
-  const browserEnvironment = environment || buildBrowserEnvironment();
+  const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
   const cookie = shopifyCookie || getShopifyCookie();
   if (!cookie) {
     throw new Error(
       "Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store."
     );
   }
-  browserEnvironment.storage.setItem(clientIdKey, getClientId(cookie));
-  return buildCommerceEngine(commerceEngineOptions);
+  const clientId = getClientId(cookie);
+  const engine = buildCommerceEngine(commerceEngineOptions);
+  engine.relay.updateConfig({
+    environment: {
+      ...customEnvironment,
+      generateUUID: () => clientId
+    }
+  });
+  return engine;
+}
+function getShopifyCustomEnvironment(environment) {
+  const { storage, generateUUID, ...rest } = environment;
+  return rest;
 }
 function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
   const match = document.cookie.match(

package/dist/headless.js

@@ -1,5 +1,5 @@
 import { buildCommerceEngine, } from '@coveo/headless/commerce';
-import { buildBrowserEnvironment, clientIdKey, } from '@coveo/relay';
+import { buildBrowserEnvironment } from '@coveo/relay';
 import { getClientId } from './utilities';
 export * from '@coveo/headless/commerce';
 export * from './utilities';
@@ -28,6 +28,11 @@ export async function fetchAppProxyConfig({ appProxyUrl = '/apps/coveo', marketI
  * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
  * - Building and returning the commerce engine with the provided options.
  *
+ * @remarks
+ * The `generateUUID` and `storage` properties are omitted from the custom environment for Shopify
+ * to ensure that client IDs are generated consistently across web pixels and storefronts. This is
+ * critical for maintaining a unified tracking and personalization experience.
+ *
  * @param commerceEngineOptions - Options to configure the commerce engine.
  * @param shopifyCookie - Optional value of the "_shopify_y" cookie. If not provided, it will attempt to retrieve it from the browser's cookies.
  * @param environment - Optional browser environment; if not provided, a default one is created. Mainly useful when not running in a browser environment.
@@ -35,14 +40,24 @@ export async function fetchAppProxyConfig({ appProxyUrl = '/apps/coveo', marketI
  * @throws Error if the required "_shopify_y" cookie is not found, ensuring the code runs within a Shopify store.
  */
 export function buildShopifyCommerceEngine({ commerceEngineOptions, shopifyCookie, environment, }) {
-    const browserEnvironment = environment || buildBrowserEnvironment();
+    const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
     const cookie = shopifyCookie || getShopifyCookie();
     if (!cookie) {
         throw new Error('Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store.');
     }
-    // TODO: Once headless is updated to support custom relay environments, we should instead pass in a generateUUID function
-    browserEnvironment.storage.setItem(clientIdKey, getClientId(cookie));
-    return buildCommerceEngine(commerceEngineOptions);
+    const clientId = getClientId(cookie);
+    const engine = buildCommerceEngine(commerceEngineOptions);
+    engine.relay.updateConfig({
+        environment: {
+            ...customEnvironment,
+            generateUUID: () => clientId,
+        },
+    });
+    return engine;
+}
+function getShopifyCustomEnvironment(environment) {
+    const { storage, generateUUID, ...rest } = environment;
+    return rest;
 }
 /**
  * Retrieves the value of a specified Shopify cookie by its name.

package/package.json

@@ -8,7 +8,7 @@
   "main": "./dist/headless.esm.js",
   "module": "./dist/headless.esm.js",
   "license": "Apache-2.0",
-  "version": "1.1.1-pre.fe37143864",
+  "version": "1.2.0-pre.7b4dd8aaef",
   "files": [
     "dist/"
   ],
@@ -46,8 +46,8 @@
     "vitest": "3.1.2"
   },
   "dependencies": {
-    "@coveo/headless": "3.23.2-pre.fe37143864",
-    "@coveo/relay": "1.1.3",
+    "@coveo/headless": "3.24.0-pre.7b4dd8aaef",
+    "@coveo/relay": "1.2.0",
     "uuid": "^11.0.0"
   },
   "engines": {