@coveo/shopify 1.5.2-pre.d64c8a48cb → 1.6.0-pre.39a35b416e

package/README.md

@@ -6,7 +6,7 @@ It includes functions to fetch app proxy configurations and build a commerce eng
 
 ## Benefits
 
-Using the `@coveo/shopify` package ensures that the commerce engine will emit events using the same `clientId` both inside and outside Shopify Web Pixels. This provides consistent tracking and analytics across the entire Shopify ecosystem. When initializing the commerce engine, a custom event is emitted using the `coveo_shopify_config` key. This event enables Shopify Web Pixels to access the app proxy configuration, ensuring consistent tracking and personalization across storefronts and pixels.
+Using the `@coveo/shopify` package ensures that the commerce engine will activate Shopify Web Pixels by emitting an event that contains everything they need to ensure consistent tracking and personalization across storefronts and pixels.
 
 ## Installation
 
@@ -56,8 +56,6 @@ Builds a commerce engine instance configured for Shopify.
 #### Parameters
 
 - `commerceEngineOptions` (required): Options for the commerce engine.
-- `shopifyCookie` (optional): The value of the Shopify `_shopify_y` cookie. If not provided, it will attempt to retrieve it from the browser's cookies.
-- `environment` (optional): A custom environment configuration (useful for testing & SSR).
 
 #### Returns
 
@@ -102,31 +100,8 @@ console.log(engine);
 </script>
 ```
 
-### `getClientId`
-
-Generates a unique client identifier for the Shopify store, based on the value of the Shopify `_shopify_y` cookie. This ensures consistent identification of users across storefronts and Shopify Web Pixels.
-
-#### Parameters
-
-- `shopifyCookie` (required): The value of the Shopify `_shopify_y` cookie.
-
-#### Returns
-
-A version 5 UUID string uniquely representing the client.
-
-#### Example
-
-```typescript
-import {getClientId, getShopifyCookie} from '@coveo/shopify/utilities';
-
-const shopifyCookie = getShopifyCookie();
-const clientId = getClientId(shopifyCookie!);
-console.log(clientId);
-```
-
 **Key constants:**
 
-- `SHOPIFY_COOKIE_KEY`: The name of the Shopify cookie used for client identification (`_shopify_y`).
 - `COVEO_SHOPIFY_CONFIG_KEY`: The key for the custom event and cookie used to share app proxy configuration (`coveo_shopify_config`).
 
 ---

package/dist/constants.d.ts

@@ -1,4 +1,3 @@
-export declare const SHOPIFY_COOKIE_KEY = "_shopify_y";
 /**
  * The key used for storing and emitting the app proxy configuration.
  *

package/dist/constants.js

@@ -1,4 +1,3 @@
-export const SHOPIFY_COOKIE_KEY = '_shopify_y';
 /**
  * The key used for storing and emitting the app proxy configuration.
  *

package/dist/headless/commerce.d.ts

@@ -1,47 +1,19 @@
 import { CommerceEngineOptions } from '@coveo/headless/commerce';
-import { ShopifyCustomEnvironment } from '../types';
-export { SHOPIFY_COOKIE_KEY, COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
+export { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
 export * from '@coveo/headless/commerce';
 export * from '../utilities';
-export type { AppProxyConfig, AppProxyResponse, ShopifyCustomEnvironment, } from '../types';
-/**
- * Options for building a Shopify commerce engine.
- *
- * @typedef BuildShopifyCommerceEngineOptions
- * @property {CommerceEngineOptions} commerceEngineOptions - The core options for configuring the commerce engine.
- * @property {ShopifyCustomEnvironment} [environment] - Optional browser environment; if not provided, a default one is created. Mainly useful when not running in a browser environment.
- * @property {string} [shopifyCookie] - Optional value of the "_shopify_y" cookie. If not provided, it will attempt to retrieve it from the browser's cookies.
- *
- * @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.
- *
- */
+export type { AppProxyConfig, AppProxyResponse } from '../types';
 export interface BuildShopifyCommerceEngineOptions {
     commerceEngineOptions: CommerceEngineOptions;
-    shopifyCookie?: string;
-    environment?: ShopifyCustomEnvironment;
 }
 /**
  * Builds the commerce engine for a Shopify store.
  *
  * This function initializes a commerce engine instance specific to a Shopify store by:
- * - Creating or using an existing browser environment.
- * - Retrieving the "_shopify_y" cookie to confirm it is running in a Shopify context.
- * - Emitting a custom event with the app proxy response to enable tracking and analytics with shopify webpixels.
- * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
+ * - Emitting a custom event to enable tracking and analytics with shopify webpixels.
  * - 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.
  * @returns The constructed commerce engine instance.
- * @throws Error if the required "_shopify_y" cookie is not found, ensuring the code runs within a Shopify store.
  */
-export declare function buildShopifyCommerceEngine({ commerceEngineOptions, shopifyCookie, environment, }: BuildShopifyCommerceEngineOptions): import("@coveo/headless/commerce").CommerceEngine<{}>;
+export declare function buildShopifyCommerceEngine({ commerceEngineOptions, }: BuildShopifyCommerceEngineOptions): import("@coveo/headless/commerce").CommerceEngine<{}>;

package/dist/headless/commerce.esm.js

@@ -20,32 +20,11 @@
 import {
   buildCommerceEngine
 } from "@coveo/headless/commerce";
-import { buildBrowserEnvironment } from "@coveo/relay";
 
 // src/constants.ts
-var SHOPIFY_COOKIE_KEY = "_shopify_y";
 var COVEO_SHOPIFY_CONFIG_KEY = "coveo_shopify_config";
 
-// src/types.ts
-function getShopifyCustomEnvironment(environment) {
-  const { storage, generateUUID, ...rest } = environment;
-  return rest;
-}
-
-// src/utilities/clientid.ts
-import { v5 } from "uuid";
-var UUID_NAMESPACE = "c2db3701-991e-424d-b117-03e30d43b651";
-function getClientId(shopifyCookie) {
-  return v5(shopifyCookie, UUID_NAMESPACE);
-}
-
 // src/utilities/shopify.ts
-function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
-  const match = document.cookie.match(
-    new RegExp("(?:^|;\\s*)" + name + "=([^;]*)")
-  );
-  return match ? decodeURIComponent(match[1]) : null;
-}
 function publishCustomShopifyEvent(key, customData) {
   if (typeof window.Shopify?.analytics?.publish === "function") {
     window.Shopify.analytics.publish(key, customData);
@@ -66,55 +45,25 @@ async function fetchAppProxyConfig({
 
 // src/headless/commerce.ts
 function buildShopifyCommerceEngine({
-  commerceEngineOptions,
-  shopifyCookie,
-  environment
+  commerceEngineOptions
 }) {
-  const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
-  const cookie = shopifyCookie || getShopifyCookie();
-  if (!commerceEngineOptions.configuration.analytics.trackingId) {
-    throw new Error(
-      "The configuration for the commerce engine must include an analytics tracking ID."
-    );
-  }
-  if (!cookie) {
-    throw new Error(
-      "Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store."
-    );
-  }
-  if (!commerceEngineOptions.navigatorContextProvider) {
-    commerceEngineOptions.navigatorContextProvider = () => ({
-      clientId: getClientId(cookie),
-      referrer: document.referrer,
-      userAgent: navigator.userAgent,
-      location: window.location.href
-    });
-  }
   const appProxyResponse = {
     accessToken: commerceEngineOptions.configuration.accessToken,
     organizationId: commerceEngineOptions.configuration.organizationId,
     environment: commerceEngineOptions.configuration.environment,
     trackingId: commerceEngineOptions.configuration.analytics.trackingId
   };
-  publishCustomShopifyEvent(
-    COVEO_SHOPIFY_CONFIG_KEY,
-    appProxyResponse
-  );
-  const clientId = getClientId(cookie);
   const engine = buildCommerceEngine(commerceEngineOptions);
-  engine.relay.updateConfig({
-    environment: {
-      ...customEnvironment,
-      generateUUID: () => clientId
-    }
+  const clientId = engine.relay.getMeta("").clientId;
+  publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, {
+    ...appProxyResponse,
+    clientId
   });
   return engine;
 }
 export {
   COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY,
   buildShopifyCommerceEngine,
   fetchAppProxyConfig,
-  getClientId,
-  getShopifyCookie
+  publishCustomShopifyEvent
 };

package/dist/headless/commerce.js

@@ -1,65 +1,31 @@
 import { buildCommerceEngine, } from '@coveo/headless/commerce';
-import { buildBrowserEnvironment } from '@coveo/relay';
 import { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
-import { getShopifyCustomEnvironment, } from '../types';
-import { getClientId } from '../utilities/clientid';
 import { publishCustomShopifyEvent } from '../utilities/shopify';
-import { getShopifyCookie } from '../utilities/shopify';
-export { SHOPIFY_COOKIE_KEY, COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
+export { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
 export * from '@coveo/headless/commerce';
 export * from '../utilities';
 /**
  * Builds the commerce engine for a Shopify store.
  *
  * This function initializes a commerce engine instance specific to a Shopify store by:
- * - Creating or using an existing browser environment.
- * - Retrieving the "_shopify_y" cookie to confirm it is running in a Shopify context.
- * - Emitting a custom event with the app proxy response to enable tracking and analytics with shopify webpixels.
- * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
+ * - Emitting a custom event to enable tracking and analytics with shopify webpixels.
  * - 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.
  * @returns The constructed commerce engine instance.
- * @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 customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
-    const cookie = shopifyCookie || getShopifyCookie();
-    if (!commerceEngineOptions.configuration.analytics.trackingId) {
-        throw new Error('The configuration for the commerce engine must include an analytics tracking ID.');
-    }
-    if (!cookie) {
-        throw new Error('Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store.');
-    }
-    if (!commerceEngineOptions.navigatorContextProvider) {
-        commerceEngineOptions.navigatorContextProvider = () => ({
-            clientId: getClientId(cookie),
-            referrer: document.referrer,
-            userAgent: navigator.userAgent,
-            location: window.location.href,
-        });
-    }
+export function buildShopifyCommerceEngine({ commerceEngineOptions, }) {
     const appProxyResponse = {
         accessToken: commerceEngineOptions.configuration.accessToken,
         organizationId: commerceEngineOptions.configuration.organizationId,
         environment: commerceEngineOptions.configuration.environment,
         trackingId: commerceEngineOptions.configuration.analytics.trackingId,
     };
-    publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, appProxyResponse);
-    const clientId = getClientId(cookie);
     const engine = buildCommerceEngine(commerceEngineOptions);
-    engine.relay.updateConfig({
-        environment: {
-            ...customEnvironment,
-            generateUUID: () => clientId,
-        },
+    const clientId = engine.relay.getMeta('').clientId;
+    publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, {
+        ...appProxyResponse,
+        clientId,
     });
     return engine;
 }

package/dist/headless/search.d.ts

@@ -1,47 +1,20 @@
 import { SearchEngineOptions } from '@coveo/headless';
-import { ShopifyCustomEnvironment } from '../types';
-export { SHOPIFY_COOKIE_KEY, COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
-export type { AppProxyConfig, AppProxyResponse, ShopifyCustomEnvironment, } from '../types';
+export { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
+export type { AppProxyConfig, AppProxyResponse } from '../types';
 export * from '@coveo/headless';
 export * from '../utilities';
-/**
- * Options for building a Shopify search engine instance.
- *
- * @typedef BuildShopifySearchEngineOptions
- * @property {SearchEngineOptions} searchEngineOptions - The core options for configuring the search engine.
- * @property {ShopifyCustomEnvironment} [environment] - Optional browser environment; if not provided, a default one is created. Mainly useful when not running in a browser environment.
- * @property {string} [shopifyCookie] - Optional value of the "_shopify_y" cookie. If not provided, it will attempt to retrieve it from the browser's cookies.
- *
- * @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.
- *
- */
 export interface BuildShopifySearchEngineOptions {
     searchEngineOptions: SearchEngineOptions;
-    environment?: ShopifyCustomEnvironment;
-    shopifyCookie?: string;
 }
 /**
  * Builds the search engine for a Shopify store.
  *
  * This function initializes a search engine instance specific to a Shopify store by:
- * - Creating or using an existing browser environment.
- * - Retrieving the "_shopify_y" cookie to confirm it is running in a Shopify context.
  * - Emitting a custom event with the app proxy response to enable tracking and analytics with shopify webpixels.
- * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
  * - Building and returning the search 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 searchEngineOptions - Options to configure the search 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.
  * @returns The constructed search engine instance.
  * @throws Error if the required "_shopify_y" cookie is not found, ensuring the code runs within a Shopify store.
  */
-export declare function buildShopifySearchEngine({ searchEngineOptions, environment, shopifyCookie, }: BuildShopifySearchEngineOptions): import("@coveo/headless").SearchEngine<{}>;
+export declare function buildShopifySearchEngine({ searchEngineOptions, }: BuildShopifySearchEngineOptions): import("@coveo/headless").SearchEngine<{}>;

package/dist/headless/search.esm.js

@@ -18,32 +18,11 @@
 
 // src/headless/search.ts
 import { buildSearchEngine } from "@coveo/headless";
-import { buildBrowserEnvironment } from "@coveo/relay";
 
 // src/constants.ts
-var SHOPIFY_COOKIE_KEY = "_shopify_y";
 var COVEO_SHOPIFY_CONFIG_KEY = "coveo_shopify_config";
 
-// src/types.ts
-function getShopifyCustomEnvironment(environment) {
-  const { storage, generateUUID, ...rest } = environment;
-  return rest;
-}
-
-// src/utilities/clientid.ts
-import { v5 } from "uuid";
-var UUID_NAMESPACE = "c2db3701-991e-424d-b117-03e30d43b651";
-function getClientId(shopifyCookie) {
-  return v5(shopifyCookie, UUID_NAMESPACE);
-}
-
 // src/utilities/shopify.ts
-function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
-  const match = document.cookie.match(
-    new RegExp("(?:^|;\\s*)" + name + "=([^;]*)")
-  );
-  return match ? decodeURIComponent(match[1]) : null;
-}
 function publishCustomShopifyEvent(key, customData) {
   if (typeof window.Shopify?.analytics?.publish === "function") {
     window.Shopify.analytics.publish(key, customData);
@@ -64,55 +43,30 @@ async function fetchAppProxyConfig({
 
 // src/headless/search.ts
 function buildShopifySearchEngine({
-  searchEngineOptions,
-  environment,
-  shopifyCookie
+  searchEngineOptions
 }) {
-  const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
-  const cookie = shopifyCookie || getShopifyCookie();
   if (!searchEngineOptions.configuration.analytics?.trackingId) {
     throw new Error(
       "The configuration for the search engine must include an analytics tracking ID."
     );
   }
-  if (!cookie) {
-    throw new Error(
-      "Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store."
-    );
-  }
-  if (!searchEngineOptions.navigatorContextProvider) {
-    searchEngineOptions.navigatorContextProvider = () => ({
-      clientId: getClientId(cookie),
-      referrer: document.referrer,
-      userAgent: navigator.userAgent,
-      location: window.location.href
-    });
-  }
   const appProxyResponse = {
     accessToken: searchEngineOptions.configuration.accessToken,
     organizationId: searchEngineOptions.configuration.organizationId,
     environment: searchEngineOptions.configuration.environment,
     trackingId: searchEngineOptions.configuration.analytics.trackingId
   };
-  publishCustomShopifyEvent(
-    COVEO_SHOPIFY_CONFIG_KEY,
-    appProxyResponse
-  );
-  const clientId = getClientId(cookie);
   const engine = buildSearchEngine(searchEngineOptions);
-  engine.relay.updateConfig({
-    environment: {
-      ...customEnvironment,
-      generateUUID: () => clientId
-    }
+  const clientId = engine.relay.getMeta("").clientId;
+  publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, {
+    ...appProxyResponse,
+    clientId
   });
   return engine;
 }
 export {
   COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY,
   buildShopifySearchEngine,
   fetchAppProxyConfig,
-  getClientId,
-  getShopifyCookie
+  publishCustomShopifyEvent
 };

package/dist/headless/search.js

@@ -1,65 +1,35 @@
 import { buildSearchEngine } from '@coveo/headless';
-import { buildBrowserEnvironment } from '@coveo/relay';
 import { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
-import { getShopifyCustomEnvironment, } from '../types';
-import { getClientId } from '../utilities/clientid';
 import { publishCustomShopifyEvent } from '../utilities/shopify';
-import { getShopifyCookie } from '../utilities/shopify';
-export { SHOPIFY_COOKIE_KEY, COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
+export { COVEO_SHOPIFY_CONFIG_KEY } from '../constants';
 export * from '@coveo/headless';
 export * from '../utilities';
 /**
  * Builds the search engine for a Shopify store.
  *
  * This function initializes a search engine instance specific to a Shopify store by:
- * - Creating or using an existing browser environment.
- * - Retrieving the "_shopify_y" cookie to confirm it is running in a Shopify context.
  * - Emitting a custom event with the app proxy response to enable tracking and analytics with shopify webpixels.
- * - Storing a client identifier derived from the shop and cookie value in the browser environment's storage.
  * - Building and returning the search 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 searchEngineOptions - Options to configure the search 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.
  * @returns The constructed search engine instance.
  * @throws Error if the required "_shopify_y" cookie is not found, ensuring the code runs within a Shopify store.
  */
-export function buildShopifySearchEngine({ searchEngineOptions, environment, shopifyCookie, }) {
-    const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
-    const cookie = shopifyCookie || getShopifyCookie();
+export function buildShopifySearchEngine({ searchEngineOptions, }) {
     if (!searchEngineOptions.configuration.analytics?.trackingId) {
         throw new Error('The configuration for the search engine must include an analytics tracking ID.');
     }
-    if (!cookie) {
-        throw new Error('Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store.');
-    }
-    if (!searchEngineOptions.navigatorContextProvider) {
-        searchEngineOptions.navigatorContextProvider = () => ({
-            clientId: getClientId(cookie),
-            referrer: document.referrer,
-            userAgent: navigator.userAgent,
-            location: window.location.href,
-        });
-    }
     const appProxyResponse = {
         accessToken: searchEngineOptions.configuration.accessToken,
         organizationId: searchEngineOptions.configuration.organizationId,
         environment: searchEngineOptions.configuration.environment,
         trackingId: searchEngineOptions.configuration.analytics.trackingId,
     };
-    publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, appProxyResponse);
-    const clientId = getClientId(cookie);
     const engine = buildSearchEngine(searchEngineOptions);
-    engine.relay.updateConfig({
-        environment: {
-            ...customEnvironment,
-            generateUUID: () => clientId,
-        },
+    const clientId = engine.relay.getMeta('').clientId;
+    publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, {
+        ...appProxyResponse,
+        clientId,
     });
     return engine;
 }

package/dist/headless.esm.js

@@ -37,52 +37,27 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var index_exports = {};
 __export(index_exports, {
   COVEO_SHOPIFY_CONFIG_KEY: () => COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY: () => SHOPIFY_COOKIE_KEY,
   buildShopifyCommerceEngine: () => buildShopifyCommerceEngine,
   fetchAppProxyConfig: () => fetchAppProxyConfig,
-  getClientId: () => getClientId,
-  getShopifyCookie: () => getShopifyCookie
+  publishCustomShopifyEvent: () => publishCustomShopifyEvent
 });
 
 // src/headless/commerce.ts
 var commerce_exports = {};
 __export(commerce_exports, {
   COVEO_SHOPIFY_CONFIG_KEY: () => COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY: () => SHOPIFY_COOKIE_KEY,
   buildShopifyCommerceEngine: () => buildShopifyCommerceEngine,
   fetchAppProxyConfig: () => fetchAppProxyConfig,
-  getClientId: () => getClientId,
-  getShopifyCookie: () => getShopifyCookie
+  publishCustomShopifyEvent: () => publishCustomShopifyEvent
 });
 import {
   buildCommerceEngine
 } from "@coveo/headless/commerce";
-import { buildBrowserEnvironment } from "@coveo/relay";
 
 // src/constants.ts
-var SHOPIFY_COOKIE_KEY = "_shopify_y";
 var COVEO_SHOPIFY_CONFIG_KEY = "coveo_shopify_config";
 
-// src/types.ts
-function getShopifyCustomEnvironment(environment) {
-  const { storage, generateUUID, ...rest } = environment;
-  return rest;
-}
-
-// src/utilities/clientid.ts
-import { v5 } from "uuid";
-var UUID_NAMESPACE = "c2db3701-991e-424d-b117-03e30d43b651";
-function getClientId(shopifyCookie) {
-  return v5(shopifyCookie, UUID_NAMESPACE);
-}
-
 // src/utilities/shopify.ts
-function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
-  const match = document.cookie.match(
-    new RegExp("(?:^|;\\s*)" + name + "=([^;]*)")
-  );
-  return match ? decodeURIComponent(match[1]) : null;
-}
 function publishCustomShopifyEvent(key, customData) {
   if (typeof window.Shopify?.analytics?.publish === "function") {
     window.Shopify.analytics.publish(key, customData);
@@ -104,47 +79,19 @@ async function fetchAppProxyConfig({
 
 // src/headless/commerce.ts
 function buildShopifyCommerceEngine({
-  commerceEngineOptions,
-  shopifyCookie,
-  environment
+  commerceEngineOptions
 }) {
-  const customEnvironment = environment ?? getShopifyCustomEnvironment(buildBrowserEnvironment());
-  const cookie = shopifyCookie || getShopifyCookie();
-  if (!commerceEngineOptions.configuration.analytics.trackingId) {
-    throw new Error(
-      "The configuration for the commerce engine must include an analytics tracking ID."
-    );
-  }
-  if (!cookie) {
-    throw new Error(
-      "Unable to find the _shopify_y cookie. Please ensure you are running this code in a Shopify store."
-    );
-  }
-  if (!commerceEngineOptions.navigatorContextProvider) {
-    commerceEngineOptions.navigatorContextProvider = () => ({
-      clientId: getClientId(cookie),
-      referrer: document.referrer,
-      userAgent: navigator.userAgent,
-      location: window.location.href
-    });
-  }
   const appProxyResponse = {
     accessToken: commerceEngineOptions.configuration.accessToken,
     organizationId: commerceEngineOptions.configuration.organizationId,
     environment: commerceEngineOptions.configuration.environment,
     trackingId: commerceEngineOptions.configuration.analytics.trackingId
   };
-  publishCustomShopifyEvent(
-    COVEO_SHOPIFY_CONFIG_KEY,
-    appProxyResponse
-  );
-  const clientId = getClientId(cookie);
   const engine = buildCommerceEngine(commerceEngineOptions);
-  engine.relay.updateConfig({
-    environment: {
-      ...customEnvironment,
-      generateUUID: () => clientId
-    }
+  const clientId = engine.relay.getMeta("").clientId;
+  publishCustomShopifyEvent(COVEO_SHOPIFY_CONFIG_KEY, {
+    ...appProxyResponse,
+    clientId
   });
   return engine;
 }
@@ -153,9 +100,7 @@ function buildShopifyCommerceEngine({
 __reExport(index_exports, commerce_exports);
 export {
   COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY,
   buildShopifyCommerceEngine,
   fetchAppProxyConfig,
-  getClientId,
-  getShopifyCookie
+  publishCustomShopifyEvent
 };

package/dist/types.d.ts

@@ -1,5 +1,4 @@
 import { CommerceEngineOptions } from '@coveo/headless/commerce';
-import { CustomEnvironment } from '@coveo/relay';
 export interface AppProxyConfig {
     appProxyUrl?: string;
     marketId: string;
@@ -10,5 +9,6 @@ export interface AppProxyResponse {
     environment: CommerceEngineOptions['configuration']['environment'];
     trackingId: string;
 }
-export type ShopifyCustomEnvironment = Omit<CustomEnvironment, 'storage' | 'generateUUID'>;
-export declare function getShopifyCustomEnvironment(environment: CustomEnvironment): ShopifyCustomEnvironment;
+export type CoveoShopifyCustomEvent = AppProxyResponse & {
+    clientId: string;
+};

package/dist/types.js

@@ -1,4 +1 @@
-export function getShopifyCustomEnvironment(environment) {
-    const { storage, generateUUID, ...rest } = environment;
-    return rest;
-}
+export {};

package/dist/utilities/index.d.ts

@@ -1,4 +1,4 @@
-export { getClientId } from './clientid';
-export { getShopifyCookie } from './shopify';
+export type { CoveoShopifyCustomEvent } from '../types';
+export { publishCustomShopifyEvent } from './shopify';
 export { fetchAppProxyConfig } from './app-proxy';
 export * from '../constants';

package/dist/utilities/index.js

@@ -1,4 +1,3 @@
-export { getClientId } from './clientid';
-export { getShopifyCookie } from './shopify';
+export { publishCustomShopifyEvent } from './shopify';
 export { fetchAppProxyConfig } from './app-proxy';
 export * from '../constants';

package/dist/utilities/shopify.d.ts

@@ -1,22 +1,12 @@
-export type CustomEvent = Record<string, string>;
-/**
- * Retrieves the value of a specified Shopify cookie by its name.
- *
- * @remarks
- * This function is intended for use in browser environments only, as it relies on the `document.cookie` API.
- * Attempting to use this function in non-browser environments will result in an error or undefined behavior.
- *
- * @param name - The name of the Shopify cookie to retrieve. Defaults to `'_shopify_y'`.
- * @returns The value of the specified cookie, or `null` if the cookie is not found.
- */
-export declare function getShopifyCookie(name?: string): string | null;
+import { CoveoShopifyCustomEvent } from '../types';
+export type { CoveoShopifyCustomEvent } from '../types';
 declare global {
     interface Window {
         Shopify?: {
             analytics: {
-                publish: (eventName: string, eventData: CustomEvent) => void;
+                publish: (eventName: string, eventData: CoveoShopifyCustomEvent) => void;
             };
         };
     }
 }
-export declare function publishCustomShopifyEvent(key: string, customData: CustomEvent): void;
+export declare function publishCustomShopifyEvent(key: string, customData: CoveoShopifyCustomEvent): void;

package/dist/utilities/shopify.js

@@ -1,18 +1,3 @@
-import { SHOPIFY_COOKIE_KEY } from '../constants';
-/**
- * Retrieves the value of a specified Shopify cookie by its name.
- *
- * @remarks
- * This function is intended for use in browser environments only, as it relies on the `document.cookie` API.
- * Attempting to use this function in non-browser environments will result in an error or undefined behavior.
- *
- * @param name - The name of the Shopify cookie to retrieve. Defaults to `'_shopify_y'`.
- * @returns The value of the specified cookie, or `null` if the cookie is not found.
- */
-export function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
-    const match = document.cookie.match(new RegExp('(?:^|;\\s*)' + name + '=([^;]*)'));
-    return match ? decodeURIComponent(match[1]) : null;
-}
 export function publishCustomShopifyEvent(key, customData) {
     if (typeof window.Shopify?.analytics?.publish === 'function') {
         window.Shopify.analytics.publish(key, customData);

package/dist/utilities.esm.js

@@ -16,23 +16,11 @@
  * limitations under the License.
  */
 
-// src/utilities/clientid.ts
-import { v5 } from "uuid";
-var UUID_NAMESPACE = "c2db3701-991e-424d-b117-03e30d43b651";
-function getClientId(shopifyCookie) {
-  return v5(shopifyCookie, UUID_NAMESPACE);
-}
-
-// src/constants.ts
-var SHOPIFY_COOKIE_KEY = "_shopify_y";
-var COVEO_SHOPIFY_CONFIG_KEY = "coveo_shopify_config";
-
 // src/utilities/shopify.ts
-function getShopifyCookie(name = SHOPIFY_COOKIE_KEY) {
-  const match = document.cookie.match(
-    new RegExp("(?:^|;\\s*)" + name + "=([^;]*)")
-  );
-  return match ? decodeURIComponent(match[1]) : null;
+function publishCustomShopifyEvent(key, customData) {
+  if (typeof window.Shopify?.analytics?.publish === "function") {
+    window.Shopify.analytics.publish(key, customData);
+  }
 }
 
 // src/utilities/app-proxy.ts
@@ -43,10 +31,11 @@ async function fetchAppProxyConfig({
   const response = await fetch(`${appProxyUrl}?marketId=${marketId}]`);
   return response.json();
 }
+
+// src/constants.ts
+var COVEO_SHOPIFY_CONFIG_KEY = "coveo_shopify_config";
 export {
   COVEO_SHOPIFY_CONFIG_KEY,
-  SHOPIFY_COOKIE_KEY,
   fetchAppProxyConfig,
-  getClientId,
-  getShopifyCookie
+  publishCustomShopifyEvent
 };

package/package.json

@@ -8,7 +8,7 @@
   "main": "./dist/headless.esm.js",
   "module": "./dist/headless.esm.js",
   "license": "Apache-2.0",
-  "version": "1.5.2-pre.d64c8a48cb",
+  "version": "1.6.0-pre.39a35b416e",
   "files": [
     "dist/"
   ],
@@ -53,11 +53,10 @@
   },
   "devDependencies": {
     "@coveo/ci": "1.0.0",
-    "vitest": "3.2.1"
+    "vitest": "3.2.3"
   },
   "dependencies": {
-    "@coveo/headless": "3.26.1-pre.d64c8a48cb",
-    "@coveo/relay": "1.2.1",
+    "@coveo/headless": "3.26.1-pre.39a35b416e",
     "uuid": "^11.0.0"
   },
   "engines": {

package/dist/utilities/clientid.d.ts

@@ -1,12 +0,0 @@
-export declare const UUID_NAMESPACE = "c2db3701-991e-424d-b117-03e30d43b651";
-/**
- * Generates a unique client identifier for the Shopify store.
- *
- * This function creates a version 5 UUID based on the provided
- * shop-specific data and the Shopify cookie value.
- *
- * @param shop - The identifier of the Shopify store.
- * @param shopifyCookie - The value of the Shopify _shopify_y cookie.
- * @returns A version 5 UUID string uniquely representing the client.
- */
-export declare function getClientId(shopifyCookie: string): string;

package/dist/utilities/clientid.js

@@ -1,15 +0,0 @@
-import { v5 } from 'uuid';
-export const UUID_NAMESPACE = 'c2db3701-991e-424d-b117-03e30d43b651';
-/**
- * Generates a unique client identifier for the Shopify store.
- *
- * This function creates a version 5 UUID based on the provided
- * shop-specific data and the Shopify cookie value.
- *
- * @param shop - The identifier of the Shopify store.
- * @param shopifyCookie - The value of the Shopify _shopify_y cookie.
- * @returns A version 5 UUID string uniquely representing the client.
- */
-export function getClientId(shopifyCookie) {
-    return v5(shopifyCookie, UUID_NAMESPACE);
-}