@coveo/shopify 0.1.0-pre.ed9ef9fb5e → 1.1.0-pre.5a73a68b8f

package/dist/headless.d.ts

@@ -0,0 +1,59 @@
+import { CommerceEngineOptions } from '@coveo/headless/commerce';
+import { CustomEnvironment } from '@coveo/relay';
+export * from '@coveo/headless/commerce';
+export * from './utilities';
+export declare const SHOPIFY_COOKIE_KEY = "_shopify_y";
+export interface AppProxyOptions {
+    appProxyUrl?: string;
+    marketId: string;
+}
+export interface AppProxyResponse {
+    accessToken: string;
+    organizationId: string;
+    environment: CommerceEngineOptions['configuration']['environment'];
+    trackingId: string;
+}
+/**
+ * Fetches configuration from the app proxy.
+ *
+ * Performs an HTTP GET request to retrieve the app proxy configuration using the provided marketId.
+ * The fetched response is parsed as JSON and returned.
+ *
+ * @param appProxyUrl - The URL template for the app proxy endpoint. Defaults to '/apps/coveo'.
+ * @param marketId - The unique market identifier used as a query parameter.
+ * @returns A promise that resolves to an object containing the access token, organization ID,
+ *          environment, and tracking ID.
+ */
+export declare function fetchAppProxyConfig({ appProxyUrl, marketId, }: AppProxyOptions): Promise<AppProxyResponse>;
+interface BuildShopifyCommerceEngineOptions {
+    commerceEngineOptions: CommerceEngineOptions;
+    shopifyCookie?: string;
+    environment?: CustomEnvironment;
+}
+/**
+ * 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.
+ * - 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.
+ *
+ * @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<{}>;
+/**
+ * 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;

package/dist/headless.js

@@ -0,0 +1,60 @@
+import { buildCommerceEngine, } from '@coveo/headless/commerce';
+import { buildBrowserEnvironment, clientIdKey, } from '@coveo/relay';
+import { getClientId } from './utilities';
+export * from '@coveo/headless/commerce';
+export * from './utilities';
+export const SHOPIFY_COOKIE_KEY = '_shopify_y';
+/**
+ * Fetches configuration from the app proxy.
+ *
+ * Performs an HTTP GET request to retrieve the app proxy configuration using the provided marketId.
+ * The fetched response is parsed as JSON and returned.
+ *
+ * @param appProxyUrl - The URL template for the app proxy endpoint. Defaults to '/apps/coveo'.
+ * @param marketId - The unique market identifier used as a query parameter.
+ * @returns A promise that resolves to an object containing the access token, organization ID,
+ *          environment, and tracking ID.
+ */
+export async function fetchAppProxyConfig({ appProxyUrl = '/apps/coveo', marketId, }) {
+    const response = await fetch(`${appProxyUrl}?marketId=${marketId}]`);
+    return response.json();
+}
+/**
+ * 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.
+ * - 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.
+ *
+ * @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 browserEnvironment = environment || 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);
+}
+/**
+ * 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;
+}

package/dist/utilities.d.ts

@@ -0,0 +1,12 @@
+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.js

@@ -0,0 +1,15 @@
+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);
+}

package/package.json

@@ -7,23 +7,25 @@
   },
   "main": "./dist/headless.esm.js",
   "module": "./dist/headless.esm.js",
-  "types": "./dist/definitions/index.d.ts",
   "license": "Apache-2.0",
-  "version": "0.1.0-pre.ed9ef9fb5e",
+  "version": "1.1.0-pre.5a73a68b8f",
   "files": [
     "dist/"
   ],
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/headless.d.ts",
       "import": "./dist/headless.esm.js",
       "default": "./dist/headless.esm.js"
     },
     "./headless": {
+      "types": "./dist/headless.d.ts",
       "import": "./dist/headless.esm.js",
       "default": "./dist/headless.esm.js"
     },
     "./utilities": {
+      "types": "./dist/utilities.d.ts",
       "import": "./dist/utilities.esm.js",
       "default": "./dist/utilities.esm.js"
     }
@@ -32,6 +34,7 @@
     "dev": "npm run build:bundles -- dev",
     "build": "nx build",
     "build:bundles": "node esbuild.mjs",
+    "build:definitions": "tsc -p src/tsconfig.build.json && node ./scripts/copy-types.mjs",
     "test": "vitest run",
     "clean": "rimraf -rf dist/* && rimraf -rf cdn/",
     "publish:npm": "npm run-script -w=@coveo/ci npm-publish",
@@ -43,7 +46,7 @@
     "vitest": "3.1.2"
   },
   "dependencies": {
-    "@coveo/headless": "3.23.1-pre.ed9ef9fb5e",
+    "@coveo/headless": "3.23.1-pre.5a73a68b8f",
     "@coveo/relay": "1.1.3",
     "uuid": "^11.0.0"
   },