@shopify/hydrogen-react 2026.4.3 → 2026.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-dev/analytics-schema-custom-storefront-customer-tracking.mjs +1 -1
- package/dist/browser-dev/load-script.mjs +5 -5
- package/dist/browser-dev/load-script.mjs.map +1 -1
- package/dist/browser-dev/packages/hydrogen-react/package.mjs +1 -1
- package/dist/browser-dev/packages/hydrogen-react/package.mjs.map +1 -1
- package/dist/browser-dev/tracking-utils.mjs +17 -58
- package/dist/browser-dev/tracking-utils.mjs.map +1 -1
- package/dist/browser-dev/useShopifyCookies.mjs +34 -97
- package/dist/browser-dev/useShopifyCookies.mjs.map +1 -1
- package/dist/browser-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-prod/analytics-schema-custom-storefront-customer-tracking.mjs +1 -1
- package/dist/browser-prod/load-script.mjs +5 -5
- package/dist/browser-prod/load-script.mjs.map +1 -1
- package/dist/browser-prod/packages/hydrogen-react/package.mjs +1 -1
- package/dist/browser-prod/packages/hydrogen-react/package.mjs.map +1 -1
- package/dist/browser-prod/tracking-utils.mjs +17 -58
- package/dist/browser-prod/tracking-utils.mjs.map +1 -1
- package/dist/browser-prod/useShopifyCookies.mjs +34 -97
- package/dist/browser-prod/useShopifyCookies.mjs.map +1 -1
- package/dist/node-dev/ShopifyProvider.js.map +1 -1
- package/dist/node-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/node-dev/analytics-schema-custom-storefront-customer-tracking.js +1 -1
- package/dist/node-dev/analytics-schema-custom-storefront-customer-tracking.mjs +1 -1
- package/dist/node-dev/load-script.js +6 -4
- package/dist/node-dev/load-script.js.map +1 -1
- package/dist/node-dev/load-script.mjs +5 -5
- package/dist/node-dev/load-script.mjs.map +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.js +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.js.map +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.mjs +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.mjs.map +1 -1
- package/dist/node-dev/tracking-utils.js +17 -58
- package/dist/node-dev/tracking-utils.js.map +1 -1
- package/dist/node-dev/tracking-utils.mjs +17 -58
- package/dist/node-dev/tracking-utils.mjs.map +1 -1
- package/dist/node-dev/useShopifyCookies.js +34 -97
- package/dist/node-dev/useShopifyCookies.js.map +1 -1
- package/dist/node-dev/useShopifyCookies.mjs +34 -97
- package/dist/node-dev/useShopifyCookies.mjs.map +1 -1
- package/dist/node-prod/ShopifyProvider.js.map +1 -1
- package/dist/node-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/node-prod/analytics-schema-custom-storefront-customer-tracking.js +1 -1
- package/dist/node-prod/analytics-schema-custom-storefront-customer-tracking.mjs +1 -1
- package/dist/node-prod/load-script.js +6 -4
- package/dist/node-prod/load-script.js.map +1 -1
- package/dist/node-prod/load-script.mjs +5 -5
- package/dist/node-prod/load-script.mjs.map +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.js +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.js.map +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.mjs +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.mjs.map +1 -1
- package/dist/node-prod/tracking-utils.js +17 -58
- package/dist/node-prod/tracking-utils.js.map +1 -1
- package/dist/node-prod/tracking-utils.mjs +17 -58
- package/dist/node-prod/tracking-utils.mjs.map +1 -1
- package/dist/node-prod/useShopifyCookies.js +34 -97
- package/dist/node-prod/useShopifyCookies.js.map +1 -1
- package/dist/node-prod/useShopifyCookies.mjs +34 -97
- package/dist/node-prod/useShopifyCookies.mjs.map +1 -1
- package/dist/types/ShopifyProvider.d.ts +3 -0
- package/dist/types/tracking-utils.d.ts +5 -4
- package/dist/types/useShopifyCookies.d.ts +14 -33
- package/dist/umd/hydrogen-react.dev.js +59 -166
- package/dist/umd/hydrogen-react.dev.js.map +1 -1
- package/dist/umd/hydrogen-react.prod.js +4 -4
- package/dist/umd/hydrogen-react.prod.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,84 +1,49 @@
|
|
|
1
|
-
import { SHOPIFY_S, SHOPIFY_Y } from "./cart-constants.mjs";
|
|
2
1
|
import { SHOPIFY_UNIQUE_TOKEN_HEADER, SHOPIFY_VISIT_TOKEN_HEADER, getTrackingValues } from "./tracking-utils.mjs";
|
|
3
|
-
import { buildUUID } from "./cookies-utils.mjs";
|
|
4
2
|
import { useEffect, useRef, useState } from "react";
|
|
5
|
-
import { stringify } from "worktop/cookie";
|
|
6
3
|
//#region src/useShopifyCookies.tsx
|
|
7
|
-
var
|
|
8
|
-
var shortTermLength = 1800;
|
|
4
|
+
var CONSENT_MANAGEMENT_MARKER_HEADER = "Shopify-Storefront-Consent-Management";
|
|
9
5
|
/**
|
|
10
|
-
*
|
|
11
|
-
*
|
|
6
|
+
* Optionally refreshes backend-managed cookies for standalone integrations.
|
|
7
|
+
* The Customer Privacy API owns tracking values and legacy cookie expiration.
|
|
12
8
|
*
|
|
13
|
-
* If `fetchTrackingValues` is true,
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* For example, set it to `true` if you are using `hydrogen-react` only with
|
|
18
|
-
* a different framework and still need to make a same-domain request to
|
|
19
|
-
* Storefront API to set cookies.
|
|
9
|
+
* If `fetchTrackingValues` is true, this sends a consent request through the
|
|
10
|
+
* Storefront API proxy, retrying against `checkoutDomain` if provided. Hydrogen's
|
|
11
|
+
* built-in analytics already delegates consent initialization to the Customer
|
|
12
|
+
* Privacy API and does not use this hook.
|
|
20
13
|
*
|
|
21
|
-
*
|
|
22
|
-
* Useful when you only want to use the newer tracking values and not rely on the deprecated ones.
|
|
23
|
-
*
|
|
24
|
-
* @returns `true` when cookies are set and ready.
|
|
14
|
+
* @returns `true` when the consent request has settled and cookies are ready.
|
|
25
15
|
* @publicDocs
|
|
26
16
|
*/
|
|
27
17
|
function useShopifyCookies(options) {
|
|
28
|
-
const {
|
|
29
|
-
const
|
|
30
|
-
|
|
31
|
-
fetchTrackingValues,
|
|
32
|
-
checkoutDomain
|
|
33
|
-
});
|
|
18
|
+
const { checkoutDomain, storefrontAccessToken, fetchTrackingValues = false } = options ?? {};
|
|
19
|
+
const [cookiesReady, setCookiesReady] = useState(!fetchTrackingValues);
|
|
20
|
+
const hasFetchedTrackingValues = useRef(false);
|
|
34
21
|
useEffect(() => {
|
|
35
|
-
if (
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
*
|
|
39
|
-
* If no domain is provided, the cookie will be set for the current host.
|
|
40
|
-
* For Shopify, we need to ensure this domain is set with a leading dot.
|
|
41
|
-
*/
|
|
42
|
-
let currentDomain = domain || window.location.host;
|
|
43
|
-
if (checkoutDomain) {
|
|
44
|
-
const checkoutDomainParts = checkoutDomain.split(".").reverse();
|
|
45
|
-
const currentDomainParts = currentDomain.split(".").reverse();
|
|
46
|
-
const sameDomainParts = [];
|
|
47
|
-
checkoutDomainParts.forEach((part, index) => {
|
|
48
|
-
if (part === currentDomainParts[index]) sameDomainParts.push(part);
|
|
49
|
-
});
|
|
50
|
-
currentDomain = sameDomainParts.reverse().join(".");
|
|
51
|
-
}
|
|
52
|
-
if (/^localhost/.test(currentDomain)) currentDomain = "";
|
|
53
|
-
const domainWithLeadingDot = currentDomain ? /^\./.test(currentDomain) ? currentDomain : `.${currentDomain}` : "";
|
|
54
|
-
/**
|
|
55
|
-
* Set user and session cookies and refresh the expiry time
|
|
56
|
-
*/
|
|
57
|
-
if (hasUserConsent) {
|
|
58
|
-
const trackingValues = getTrackingValues();
|
|
59
|
-
if ((trackingValues.uniqueToken || trackingValues.visitToken || "").startsWith("00000000-")) return;
|
|
60
|
-
setCookie(SHOPIFY_Y, trackingValues.uniqueToken || buildUUID(), longTermLength, domainWithLeadingDot);
|
|
61
|
-
setCookie(SHOPIFY_S, trackingValues.visitToken || buildUUID(), shortTermLength, domainWithLeadingDot);
|
|
62
|
-
} else {
|
|
63
|
-
setCookie(SHOPIFY_Y, "", 0, domainWithLeadingDot);
|
|
64
|
-
setCookie(SHOPIFY_S, "", 0, domainWithLeadingDot);
|
|
22
|
+
if (!fetchTrackingValues) {
|
|
23
|
+
setCookiesReady(true);
|
|
24
|
+
return;
|
|
65
25
|
}
|
|
26
|
+
if (hasFetchedTrackingValues.current) return;
|
|
27
|
+
hasFetchedTrackingValues.current = true;
|
|
28
|
+
const fetchConsentValues = async () => {
|
|
29
|
+
try {
|
|
30
|
+
return await fetchTrackingValuesFromBrowser(storefrontAccessToken);
|
|
31
|
+
} catch (sameOriginError) {
|
|
32
|
+
if (!checkoutDomain) throw sameOriginError;
|
|
33
|
+
return fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain);
|
|
34
|
+
}
|
|
35
|
+
};
|
|
36
|
+
fetchConsentValues().catch((error) => {
|
|
37
|
+
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
38
|
+
}).finally(() => {
|
|
39
|
+
setCookiesReady(true);
|
|
40
|
+
});
|
|
66
41
|
}, [
|
|
67
|
-
coreCookiesReady,
|
|
68
|
-
hasUserConsent,
|
|
69
|
-
domain,
|
|
70
42
|
checkoutDomain,
|
|
71
|
-
|
|
43
|
+
fetchTrackingValues,
|
|
44
|
+
storefrontAccessToken
|
|
72
45
|
]);
|
|
73
|
-
return
|
|
74
|
-
}
|
|
75
|
-
function setCookie(name, value, maxage, domain) {
|
|
76
|
-
document.cookie = stringify(name, value, {
|
|
77
|
-
maxage,
|
|
78
|
-
domain,
|
|
79
|
-
samesite: "Lax",
|
|
80
|
-
path: "/"
|
|
81
|
-
});
|
|
46
|
+
return cookiesReady;
|
|
82
47
|
}
|
|
83
48
|
async function fetchTrackingValuesFromBrowser(storefrontAccessToken, storefrontApiDomain = "") {
|
|
84
49
|
const { uniqueToken, visitToken } = getTrackingValues();
|
|
@@ -87,43 +52,15 @@ async function fetchTrackingValuesFromBrowser(storefrontAccessToken, storefrontA
|
|
|
87
52
|
headers: {
|
|
88
53
|
"Content-Type": "application/json",
|
|
89
54
|
...storefrontAccessToken && { "X-Shopify-Storefront-Access-Token": storefrontAccessToken },
|
|
55
|
+
...storefrontApiDomain ? void 0 : { [CONSENT_MANAGEMENT_MARKER_HEADER]: "1" },
|
|
90
56
|
...visitToken || uniqueToken ? {
|
|
91
57
|
[SHOPIFY_VISIT_TOKEN_HEADER]: visitToken,
|
|
92
58
|
[SHOPIFY_UNIQUE_TOKEN_HEADER]: uniqueToken
|
|
93
59
|
} : void 0
|
|
94
60
|
},
|
|
95
|
-
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { cookieDomain } } }" })
|
|
61
|
+
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { trackingConsentCookie cookieDomain shopifyUnique shopifyVisit } } }" })
|
|
96
62
|
});
|
|
97
63
|
if (!response.ok) throw new Error(`Failed to fetch consent from browser: ${response.status} ${response.statusText}`);
|
|
98
|
-
await response.json();
|
|
99
|
-
getTrackingValues();
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Gets http-only cookies from Storefront API via same-origin fetch request.
|
|
103
|
-
* Falls back to checkout domain if provided to at least obtain the tracking
|
|
104
|
-
* values via server-timing headers.
|
|
105
|
-
*/
|
|
106
|
-
function useCoreShopifyCookies({ checkoutDomain, storefrontAccessToken, fetchTrackingValues = false }) {
|
|
107
|
-
const [cookiesReady, setCookiesReady] = useState(!fetchTrackingValues);
|
|
108
|
-
const hasFetchedTrackingValues = useRef(false);
|
|
109
|
-
useEffect(() => {
|
|
110
|
-
if (!fetchTrackingValues) {
|
|
111
|
-
setCookiesReady(true);
|
|
112
|
-
return;
|
|
113
|
-
}
|
|
114
|
-
if (hasFetchedTrackingValues.current) return;
|
|
115
|
-
hasFetchedTrackingValues.current = true;
|
|
116
|
-
fetchTrackingValuesFromBrowser(storefrontAccessToken).catch((error) => checkoutDomain ? fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain) : Promise.reject(error)).catch((error) => {
|
|
117
|
-
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
118
|
-
}).finally(() => {
|
|
119
|
-
setCookiesReady(true);
|
|
120
|
-
});
|
|
121
|
-
}, [
|
|
122
|
-
checkoutDomain,
|
|
123
|
-
fetchTrackingValues,
|
|
124
|
-
storefrontAccessToken
|
|
125
|
-
]);
|
|
126
|
-
return cookiesReady;
|
|
127
64
|
}
|
|
128
65
|
//#endregion
|
|
129
66
|
export { useShopifyCookies };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useShopifyCookies.mjs","names":[],"sources":["../../src/useShopifyCookies.tsx"],"sourcesContent":["import {useEffect, useRef, useState} from 'react';\n// @ts-ignore - worktop/cookie types not properly exported\nimport {stringify} from 'worktop/cookie';\nimport {SHOPIFY_Y, SHOPIFY_S} from './cart-constants.js';\nimport {buildUUID} from './cookies-utils.js';\nimport {\n getTrackingValues,\n SHOPIFY_UNIQUE_TOKEN_HEADER,\n SHOPIFY_VISIT_TOKEN_HEADER,\n} from './tracking-utils.js';\n\nconst longTermLength = 60 * 60 * 24 * 360 * 1; // ~1 year expiry\nconst shortTermLength = 60 * 30; // 30 mins\n\ntype UseShopifyCookiesOptions = CoreShopifyCookiesOptions & {\n /**\n * If set to `false`, Shopify cookies will be removed.\n * If set to `true`, Shopify unique user token cookie will have cookie expiry of 1 year.\n * Defaults to false.\n **/\n hasUserConsent?: boolean;\n /**\n * The domain scope of the cookie. Defaults to empty string.\n **/\n domain?: string;\n /**\n * The checkout domain of the shop. Defaults to empty string. If set, the cookie domain will check if it can be set with the checkout domain.\n */\n checkoutDomain?: string;\n /**\n * If set to `true`, it skips modifying the deprecated shopify_y and shopify_s cookies.\n */\n ignoreDeprecatedCookies?: boolean;\n};\n\n/**\n * Sets the `shopify_y` and `shopify_s` cookies in the browser based on user consent\n * for backward compatibility support.\n *\n * If `fetchTrackingValues` is true, it makes a request to Storefront API\n * to fetch or refresh Shopiy analytics and marketing cookies and tracking values.\n * Generally speaking, this should only be needed if you're not using Hydrogen's\n * built-in analytics components and hooks that already handle this automatically.\n * For example, set it to `true` if you are using `hydrogen-react` only with\n * a different framework and still need to make a same-domain request to\n * Storefront API to set cookies.\n *\n * If `ignoreDeprecatedCookies` is true, it skips setting the deprecated cookies entirely.\n * Useful when you only want to use the newer tracking values and not rely on the deprecated ones.\n *\n * @returns `true` when cookies are set and ready.\n * @publicDocs\n */\nexport function useShopifyCookies(options?: UseShopifyCookiesOptions): boolean {\n const {\n hasUserConsent,\n domain = '',\n checkoutDomain = '',\n storefrontAccessToken,\n fetchTrackingValues,\n ignoreDeprecatedCookies = false,\n } = options || {};\n\n const coreCookiesReady = useCoreShopifyCookies({\n storefrontAccessToken,\n fetchTrackingValues,\n checkoutDomain,\n });\n\n useEffect(() => {\n // Skip setting JS cookies until http-only cookies and server-timing\n // are ready so that we have values synced in JS and http-only cookies.\n if (ignoreDeprecatedCookies || !coreCookiesReady) return;\n\n /**\n * Setting cookie with domain\n *\n * If no domain is provided, the cookie will be set for the current host.\n * For Shopify, we need to ensure this domain is set with a leading dot.\n */\n\n // Use override domain or current host\n let currentDomain = domain || window.location.host;\n\n if (checkoutDomain) {\n const checkoutDomainParts = checkoutDomain.split('.').reverse();\n const currentDomainParts = currentDomain.split('.').reverse();\n const sameDomainParts: Array<string> = [];\n checkoutDomainParts.forEach((part, index) => {\n if (part === currentDomainParts[index]) {\n sameDomainParts.push(part);\n }\n });\n\n currentDomain = sameDomainParts.reverse().join('.');\n }\n\n // Reset domain if localhost\n if (/^localhost/.test(currentDomain)) currentDomain = '';\n\n // Shopify checkout only consumes cookies set with leading dot domain\n const domainWithLeadingDot = currentDomain\n ? /^\\./.test(currentDomain)\n ? currentDomain\n : `.${currentDomain}`\n : '';\n\n /**\n * Set user and session cookies and refresh the expiry time\n */\n if (hasUserConsent) {\n const trackingValues = getTrackingValues();\n if (\n (\n trackingValues.uniqueToken ||\n trackingValues.visitToken ||\n ''\n ).startsWith('00000000-')\n ) {\n // Skip writing cookies when tracking values signal we don't have consent yet\n return;\n }\n\n setCookie(\n SHOPIFY_Y,\n trackingValues.uniqueToken || buildUUID(),\n longTermLength,\n domainWithLeadingDot,\n );\n setCookie(\n SHOPIFY_S,\n trackingValues.visitToken || buildUUID(),\n shortTermLength,\n domainWithLeadingDot,\n );\n } else {\n setCookie(SHOPIFY_Y, '', 0, domainWithLeadingDot);\n setCookie(SHOPIFY_S, '', 0, domainWithLeadingDot);\n }\n }, [\n coreCookiesReady,\n hasUserConsent,\n domain,\n checkoutDomain,\n ignoreDeprecatedCookies,\n ]);\n\n return coreCookiesReady;\n}\n\nfunction setCookie(\n name: string,\n value: string,\n maxage: number,\n domain: string,\n): void {\n document.cookie = stringify(name, value, {\n maxage,\n domain,\n samesite: 'Lax',\n path: '/',\n });\n}\n\nasync function fetchTrackingValuesFromBrowser(\n storefrontAccessToken?: string,\n storefrontApiDomain = '',\n): Promise<void> {\n // These values might come from server-timing or old cookies.\n // If consent cannot be initially assumed, these tokens\n // will be dropped in SFAPI and it will return a mock token\n // starting with '00000000-'.\n // However, if consent can be assumed initially, these tokens\n // will be used to create proper cookies and continue our flow.\n const {uniqueToken, visitToken} = getTrackingValues();\n\n const response = await fetch(\n // TODO: update this endpoint when it becomes stable\n `${storefrontApiDomain.replace(/\\/+$/, '')}/api/unstable/graphql.json`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n ...(storefrontAccessToken && {\n 'X-Shopify-Storefront-Access-Token': storefrontAccessToken,\n }),\n ...(visitToken || uniqueToken\n ? {\n [SHOPIFY_VISIT_TOKEN_HEADER]: visitToken,\n [SHOPIFY_UNIQUE_TOKEN_HEADER]: uniqueToken,\n }\n : undefined),\n },\n body: JSON.stringify({\n query:\n // This query ensures we get _cmp (consent) server-timing header, which is not available in other queries.\n // This value can be passed later to consent-tracking-api and privacy-banner scripts to avoid extra requests.\n 'query ensureCookies { consentManagement { cookies(visitorConsent:{}) { cookieDomain } } }',\n }),\n },\n );\n\n if (!response.ok) {\n throw new Error(\n `Failed to fetch consent from browser: ${response.status} ${response.statusText}`,\n );\n }\n\n // Consume the body to complete the request and\n // ensure server-timing is available in performance API\n await response.json();\n\n // Ensure we cache the latest tracking values from resources timing\n getTrackingValues();\n}\n\ntype CoreShopifyCookiesOptions = {\n storefrontAccessToken?: string;\n fetchTrackingValues?: boolean;\n checkoutDomain?: string;\n};\n\n/**\n * Gets http-only cookies from Storefront API via same-origin fetch request.\n * Falls back to checkout domain if provided to at least obtain the tracking\n * values via server-timing headers.\n */\nfunction useCoreShopifyCookies({\n checkoutDomain,\n storefrontAccessToken,\n fetchTrackingValues = false,\n}: CoreShopifyCookiesOptions) {\n const [cookiesReady, setCookiesReady] = useState(!fetchTrackingValues);\n const hasFetchedTrackingValues = useRef(false);\n\n useEffect(() => {\n if (!fetchTrackingValues) {\n // Backend did the work, or proxy is disabled.\n setCookiesReady(true);\n return;\n }\n\n // React runs effects twice in dev mode, avoid double fetching\n if (hasFetchedTrackingValues.current) return;\n hasFetchedTrackingValues.current = true;\n\n // Fetch consent from browser via proxy\n fetchTrackingValuesFromBrowser(storefrontAccessToken)\n .catch((error) =>\n checkoutDomain\n ? // Retry with checkout domain if available to at least\n // get the server-timing values for tracking.\n fetchTrackingValuesFromBrowser(\n storefrontAccessToken,\n checkoutDomain,\n )\n : Promise.reject(error),\n )\n .catch((error) => {\n console.warn(\n '[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: ' +\n (error instanceof Error ? error.message : String(error)),\n );\n })\n .finally(() => {\n // Proceed even on errors, degraded tracking is better than no app\n setCookiesReady(true);\n });\n }, [checkoutDomain, fetchTrackingValues, storefrontAccessToken]);\n\n return cookiesReady;\n}\n"],"mappings":";;;;;;AAWA,IAAM,iBAAiB,OAAU,KAAK,MAAM;AAC5C,IAAM,kBAAkB;;;;;;;;;;;;;;;;;;;AAyCxB,SAAgB,kBAAkB,SAA6C;CAC7E,MAAM,EACJ,gBACA,SAAS,IACT,iBAAiB,IACjB,uBACA,qBACA,0BAA0B,UACxB,WAAW,EAAE;CAEjB,MAAM,mBAAmB,sBAAsB;EAC7C;EACA;EACA;EACD,CAAC;AAEF,iBAAgB;AAGd,MAAI,2BAA2B,CAAC,iBAAkB;;;;;;;EAUlD,IAAI,gBAAgB,UAAU,OAAO,SAAS;AAE9C,MAAI,gBAAgB;GAClB,MAAM,sBAAsB,eAAe,MAAM,IAAI,CAAC,SAAS;GAC/D,MAAM,qBAAqB,cAAc,MAAM,IAAI,CAAC,SAAS;GAC7D,MAAM,kBAAiC,EAAE;AACzC,uBAAoB,SAAS,MAAM,UAAU;AAC3C,QAAI,SAAS,mBAAmB,OAC9B,iBAAgB,KAAK,KAAK;KAE5B;AAEF,mBAAgB,gBAAgB,SAAS,CAAC,KAAK,IAAI;;AAIrD,MAAI,aAAa,KAAK,cAAc,CAAE,iBAAgB;EAGtD,MAAM,uBAAuB,gBACzB,MAAM,KAAK,cAAc,GACvB,gBACA,IAAI,kBACN;;;;AAKJ,MAAI,gBAAgB;GAClB,MAAM,iBAAiB,mBAAmB;AAC1C,QAEI,eAAe,eACf,eAAe,cACf,IACA,WAAW,YAAY,CAGzB;AAGF,aACE,WACA,eAAe,eAAe,WAAW,EACzC,gBACA,qBACD;AACD,aACE,WACA,eAAe,cAAc,WAAW,EACxC,iBACA,qBACD;SACI;AACL,aAAU,WAAW,IAAI,GAAG,qBAAqB;AACjD,aAAU,WAAW,IAAI,GAAG,qBAAqB;;IAElD;EACD;EACA;EACA;EACA;EACA;EACD,CAAC;AAEF,QAAO;;AAGT,SAAS,UACP,MACA,OACA,QACA,QACM;AACN,UAAS,SAAS,UAAU,MAAM,OAAO;EACvC;EACA;EACA,UAAU;EACV,MAAM;EACP,CAAC;;AAGJ,eAAe,+BACb,uBACA,sBAAsB,IACP;CAOf,MAAM,EAAC,aAAa,eAAc,mBAAmB;CAErD,MAAM,WAAW,MAAM,MAErB,GAAG,oBAAoB,QAAQ,QAAQ,GAAG,CAAC,6BAC3C;EACE,QAAQ;EACR,SAAS;GACP,gBAAgB;GAChB,GAAI,yBAAyB,EAC3B,qCAAqC,uBACtC;GACD,GAAI,cAAc,cACd;KACG,6BAA6B;KAC7B,8BAA8B;IAChC,GACD,KAAA;GACL;EACD,MAAM,KAAK,UAAU,EACnB,OAGE,6FACH,CAAC;EACH,CACF;AAED,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,yCAAyC,SAAS,OAAO,GAAG,SAAS,aACtE;AAKH,OAAM,SAAS,MAAM;AAGrB,oBAAmB;;;;;;;AAcrB,SAAS,sBAAsB,EAC7B,gBACA,uBACA,sBAAsB,SACM;CAC5B,MAAM,CAAC,cAAc,mBAAmB,SAAS,CAAC,oBAAoB;CACtE,MAAM,2BAA2B,OAAO,MAAM;AAE9C,iBAAgB;AACd,MAAI,CAAC,qBAAqB;AAExB,mBAAgB,KAAK;AACrB;;AAIF,MAAI,yBAAyB,QAAS;AACtC,2BAAyB,UAAU;AAGnC,iCAA+B,sBAAsB,CAClD,OAAO,UACN,iBAGI,+BACE,uBACA,eACD,GACD,QAAQ,OAAO,MAAM,CAC1B,CACA,OAAO,UAAU;AAChB,WAAQ,KACN,gFACG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,EAC1D;IACD,CACD,cAAc;AAEb,mBAAgB,KAAK;IACrB;IACH;EAAC;EAAgB;EAAqB;EAAsB,CAAC;AAEhE,QAAO"}
|
|
1
|
+
{"version":3,"file":"useShopifyCookies.mjs","names":[],"sources":["../../src/useShopifyCookies.tsx"],"sourcesContent":["import {useEffect, useRef, useState} from 'react';\nimport {\n getTrackingValues,\n SHOPIFY_UNIQUE_TOKEN_HEADER,\n SHOPIFY_VISIT_TOKEN_HEADER,\n} from './tracking-utils.js';\n\n// Marks the same-origin consent request so the backend can identify\n// headless consent-management traffic. A custom header on the cross-origin\n// checkout retry would fail its CORS preflight, so it is never sent there.\n// NOTE: packages/hydrogen/src/constants.ts defines the same header name\n// (STOREFRONT_CONSENT_MANAGEMENT_HEADER) for the server-side proxy\n// forwarding; keep the two in sync.\nconst CONSENT_MANAGEMENT_MARKER_HEADER =\n 'Shopify-Storefront-Consent-Management';\n\ntype UseShopifyCookiesOptions = {\n storefrontAccessToken?: string;\n fetchTrackingValues?: boolean;\n /** @deprecated No longer used. The Customer Privacy API manages Shopify cookies. */\n hasUserConsent?: boolean;\n /** @deprecated No longer used. The Customer Privacy API manages cookie domains. */\n domain?: string;\n /** The checkout domain used if the same-origin consent request fails. */\n checkoutDomain?: string;\n /** @deprecated No longer used. The Customer Privacy API expires deprecated cookies. */\n ignoreDeprecatedCookies?: boolean;\n};\n\n/**\n * Optionally refreshes backend-managed cookies for standalone integrations.\n * The Customer Privacy API owns tracking values and legacy cookie expiration.\n *\n * If `fetchTrackingValues` is true, this sends a consent request through the\n * Storefront API proxy, retrying against `checkoutDomain` if provided. Hydrogen's\n * built-in analytics already delegates consent initialization to the Customer\n * Privacy API and does not use this hook.\n *\n * @returns `true` when the consent request has settled and cookies are ready.\n * @publicDocs\n */\nexport function useShopifyCookies(options?: UseShopifyCookiesOptions): boolean {\n const {\n checkoutDomain,\n storefrontAccessToken,\n fetchTrackingValues = false,\n } = options ?? {};\n const [cookiesReady, setCookiesReady] = useState(!fetchTrackingValues);\n const hasFetchedTrackingValues = useRef(false);\n\n useEffect(() => {\n if (!fetchTrackingValues) {\n // Backend did the work, or proxy is disabled.\n setCookiesReady(true);\n return;\n }\n\n // React runs effects twice in dev mode, avoid double fetching\n if (hasFetchedTrackingValues.current) return;\n hasFetchedTrackingValues.current = true;\n\n const fetchConsentValues = async () => {\n try {\n return await fetchTrackingValuesFromBrowser(storefrontAccessToken);\n } catch (sameOriginError) {\n if (!checkoutDomain) throw sameOriginError;\n // Retry with checkout domain if the same-origin proxy failed.\n return fetchTrackingValuesFromBrowser(\n storefrontAccessToken,\n checkoutDomain,\n );\n }\n };\n\n fetchConsentValues()\n .catch((error) => {\n console.warn(\n '[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: ' +\n (error instanceof Error ? error.message : String(error)),\n );\n })\n .finally(() => {\n // Proceed even on errors, degraded tracking is better than no app\n setCookiesReady(true);\n });\n }, [checkoutDomain, fetchTrackingValues, storefrontAccessToken]);\n\n return cookiesReady;\n}\n\nasync function fetchTrackingValuesFromBrowser(\n storefrontAccessToken?: string,\n storefrontApiDomain = '',\n): Promise<void> {\n // Forward the current CTA tokens or legacy cookies to preserve the session.\n // CTA suppresses token generation while its async consent is loading.\n const {uniqueToken, visitToken} = getTrackingValues();\n\n const response = await fetch(\n // TODO: update this endpoint when it becomes stable\n `${storefrontApiDomain.replace(/\\/+$/, '')}/api/unstable/graphql.json`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n ...(storefrontAccessToken && {\n 'X-Shopify-Storefront-Access-Token': storefrontAccessToken,\n }),\n // The marker header goes on the same-origin request only, where the\n // Hydrogen server proxy can act on it.\n ...(storefrontApiDomain\n ? undefined\n : {[CONSENT_MANAGEMENT_MARKER_HEADER]: '1'}),\n ...(visitToken || uniqueToken\n ? {\n [SHOPIFY_VISIT_TOKEN_HEADER]: visitToken,\n [SHOPIFY_UNIQUE_TOKEN_HEADER]: uniqueToken,\n }\n : undefined),\n },\n body: JSON.stringify({\n query:\n // The empty `visitorConsent` refreshes cookies without changing\n // the stored consent.\n 'query ensureCookies { consentManagement { cookies(visitorConsent:{}) { trackingConsentCookie cookieDomain shopifyUnique shopifyVisit } } }',\n }),\n },\n );\n\n if (!response.ok) {\n throw new Error(\n `Failed to fetch consent from browser: ${response.status} ${response.statusText}`,\n );\n }\n}\n"],"mappings":";;;AAaA,IAAM,mCACJ;;;;;;;;;;;;;AA2BF,SAAgB,kBAAkB,SAA6C;CAC7E,MAAM,EACJ,gBACA,uBACA,sBAAsB,UACpB,WAAW,EAAE;CACjB,MAAM,CAAC,cAAc,mBAAmB,SAAS,CAAC,oBAAoB;CACtE,MAAM,2BAA2B,OAAO,MAAM;AAE9C,iBAAgB;AACd,MAAI,CAAC,qBAAqB;AAExB,mBAAgB,KAAK;AACrB;;AAIF,MAAI,yBAAyB,QAAS;AACtC,2BAAyB,UAAU;EAEnC,MAAM,qBAAqB,YAAY;AACrC,OAAI;AACF,WAAO,MAAM,+BAA+B,sBAAsB;YAC3D,iBAAiB;AACxB,QAAI,CAAC,eAAgB,OAAM;AAE3B,WAAO,+BACL,uBACA,eACD;;;AAIL,sBAAoB,CACjB,OAAO,UAAU;AAChB,WAAQ,KACN,gFACG,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,EAC1D;IACD,CACD,cAAc;AAEb,mBAAgB,KAAK;IACrB;IACH;EAAC;EAAgB;EAAqB;EAAsB,CAAC;AAEhE,QAAO;;AAGT,eAAe,+BACb,uBACA,sBAAsB,IACP;CAGf,MAAM,EAAC,aAAa,eAAc,mBAAmB;CAErD,MAAM,WAAW,MAAM,MAErB,GAAG,oBAAoB,QAAQ,QAAQ,GAAG,CAAC,6BAC3C;EACE,QAAQ;EACR,SAAS;GACP,gBAAgB;GAChB,GAAI,yBAAyB,EAC3B,qCAAqC,uBACtC;GAGD,GAAI,sBACA,KAAA,IACA,GAAE,mCAAmC,KAAI;GAC7C,GAAI,cAAc,cACd;KACG,6BAA6B;KAC7B,8BAA8B;IAChC,GACD,KAAA;GACL;EACD,MAAM,KAAK,UAAU,EACnB,OAGE,8IACH,CAAC;EACH,CACF;AAED,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MACR,yCAAyC,SAAS,OAAO,GAAG,SAAS,aACtE"}
|
|
@@ -31,6 +31,9 @@ export interface ShopifyProviderBase {
|
|
|
31
31
|
/**
|
|
32
32
|
* Uses the current window.location.origin for Storefront API requests.
|
|
33
33
|
* This requires setting up a proxy for Storefront API requests in your domain.
|
|
34
|
+
* Without the proxy, cart requests still work, but visitor analytics and
|
|
35
|
+
* session attribution do not,
|
|
36
|
+
* [notice](https://shopify.dev/changelog/posts/tracking-cookie-deprecation-hydrogen).
|
|
34
37
|
*/
|
|
35
38
|
sameDomainForStorefrontApi?: boolean;
|
|
36
39
|
}
|
|
@@ -10,11 +10,12 @@ type TrackingValues = {
|
|
|
10
10
|
/** Represents the consent given by the user or the default region consent configured in Admin */
|
|
11
11
|
consent: string;
|
|
12
12
|
};
|
|
13
|
-
export declare const cachedTrackingValues: {
|
|
14
|
-
current: null | TrackingValues;
|
|
15
|
-
};
|
|
16
13
|
/**
|
|
17
|
-
* Retrieves user session tracking values for analytics and marketing from the
|
|
14
|
+
* Retrieves user session tracking values for analytics and marketing from the
|
|
15
|
+
* browser environment. Customer Privacy API token readers are authoritative
|
|
16
|
+
* when available, including when consent denies tracking. Deprecated
|
|
17
|
+
* `_shopify_y`/`_shopify_s` cookies are read only without an API token reader.
|
|
18
|
+
* Consent comes from CTA's cache or the legacy `_tracking_consent` cookie.
|
|
18
19
|
* @publicDocs
|
|
19
20
|
*/
|
|
20
21
|
export declare function getTrackingValues(): TrackingValues;
|
|
@@ -1,45 +1,26 @@
|
|
|
1
|
-
type UseShopifyCookiesOptions =
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
* Defaults to false.
|
|
6
|
-
**/
|
|
1
|
+
type UseShopifyCookiesOptions = {
|
|
2
|
+
storefrontAccessToken?: string;
|
|
3
|
+
fetchTrackingValues?: boolean;
|
|
4
|
+
/** @deprecated No longer used. The Customer Privacy API manages Shopify cookies. */
|
|
7
5
|
hasUserConsent?: boolean;
|
|
8
|
-
/**
|
|
9
|
-
* The domain scope of the cookie. Defaults to empty string.
|
|
10
|
-
**/
|
|
6
|
+
/** @deprecated No longer used. The Customer Privacy API manages cookie domains. */
|
|
11
7
|
domain?: string;
|
|
12
|
-
/**
|
|
13
|
-
* The checkout domain of the shop. Defaults to empty string. If set, the cookie domain will check if it can be set with the checkout domain.
|
|
14
|
-
*/
|
|
8
|
+
/** The checkout domain used if the same-origin consent request fails. */
|
|
15
9
|
checkoutDomain?: string;
|
|
16
|
-
/**
|
|
17
|
-
* If set to `true`, it skips modifying the deprecated shopify_y and shopify_s cookies.
|
|
18
|
-
*/
|
|
10
|
+
/** @deprecated No longer used. The Customer Privacy API expires deprecated cookies. */
|
|
19
11
|
ignoreDeprecatedCookies?: boolean;
|
|
20
12
|
};
|
|
21
13
|
/**
|
|
22
|
-
*
|
|
23
|
-
*
|
|
14
|
+
* Optionally refreshes backend-managed cookies for standalone integrations.
|
|
15
|
+
* The Customer Privacy API owns tracking values and legacy cookie expiration.
|
|
24
16
|
*
|
|
25
|
-
* If `fetchTrackingValues` is true,
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* For example, set it to `true` if you are using `hydrogen-react` only with
|
|
30
|
-
* a different framework and still need to make a same-domain request to
|
|
31
|
-
* Storefront API to set cookies.
|
|
17
|
+
* If `fetchTrackingValues` is true, this sends a consent request through the
|
|
18
|
+
* Storefront API proxy, retrying against `checkoutDomain` if provided. Hydrogen's
|
|
19
|
+
* built-in analytics already delegates consent initialization to the Customer
|
|
20
|
+
* Privacy API and does not use this hook.
|
|
32
21
|
*
|
|
33
|
-
*
|
|
34
|
-
* Useful when you only want to use the newer tracking values and not rely on the deprecated ones.
|
|
35
|
-
*
|
|
36
|
-
* @returns `true` when cookies are set and ready.
|
|
22
|
+
* @returns `true` when the consent request has settled and cookies are ready.
|
|
37
23
|
* @publicDocs
|
|
38
24
|
*/
|
|
39
25
|
export declare function useShopifyCookies(options?: UseShopifyCookiesOptions): boolean;
|
|
40
|
-
type CoreShopifyCookiesOptions = {
|
|
41
|
-
storefrontAccessToken?: string;
|
|
42
|
-
fetchTrackingValues?: boolean;
|
|
43
|
-
checkoutDomain?: string;
|
|
44
|
-
};
|
|
45
26
|
export {};
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
};
|
|
179
179
|
return y;
|
|
180
180
|
}
|
|
181
|
-
var l
|
|
181
|
+
var l = function(t, n) {
|
|
182
182
|
return t.actions.forEach((function(e) {
|
|
183
183
|
var r = e.exec;
|
|
184
184
|
return r && r(t.context, n);
|
|
@@ -188,7 +188,7 @@
|
|
|
188
188
|
var r = t.initialState, i = n.NotStarted, o = /* @__PURE__ */ new Set(), c = {
|
|
189
189
|
_machine: t,
|
|
190
190
|
send: function(e) {
|
|
191
|
-
i === n.Running && (r = t.transition(r, e), l
|
|
191
|
+
i === n.Running && (r = t.transition(r, e), l(r, u(e)), o.forEach((function(t) {
|
|
192
192
|
return t(r);
|
|
193
193
|
})));
|
|
194
194
|
},
|
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
matches: a(u.value)
|
|
211
211
|
};
|
|
212
212
|
} else r = t.initialState;
|
|
213
|
-
return i = n.Running, l
|
|
213
|
+
return i = n.Running, l(r, e), c;
|
|
214
214
|
},
|
|
215
215
|
stop: function() {
|
|
216
216
|
return i = n.Stopped, o.clear(), c;
|
|
@@ -715,68 +715,27 @@
|
|
|
715
715
|
var SHOPIFY_VISIT_TOKEN_HEADER = "X-Shopify-VisitToken";
|
|
716
716
|
/** Storefront API header for UniqueToken */
|
|
717
717
|
var SHOPIFY_UNIQUE_TOKEN_HEADER = "X-Shopify-UniqueToken";
|
|
718
|
-
var cachedTrackingValues = { current: null };
|
|
719
718
|
/**
|
|
720
|
-
* Retrieves user session tracking values for analytics and marketing from the
|
|
719
|
+
* Retrieves user session tracking values for analytics and marketing from the
|
|
720
|
+
* browser environment. Customer Privacy API token readers are authoritative
|
|
721
|
+
* when available, including when consent denies tracking. Deprecated
|
|
722
|
+
* `_shopify_y`/`_shopify_s` cookies are read only without an API token reader.
|
|
723
|
+
* Consent comes from CTA's cache or the legacy `_tracking_consent` cookie.
|
|
721
724
|
* @publicDocs
|
|
722
725
|
*/
|
|
723
726
|
function getTrackingValues() {
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
if (matchedHost === currentHost || sfapiPath && matchedHost?.endsWith(`.${currentHost}`)) {
|
|
737
|
-
const values = extractFromPerformanceEntry(entry);
|
|
738
|
-
if (values) {
|
|
739
|
-
matchedValues = values;
|
|
740
|
-
break;
|
|
741
|
-
}
|
|
742
|
-
}
|
|
743
|
-
}
|
|
744
|
-
if (matchedValues) trackingValues = matchedValues;
|
|
745
|
-
if (trackingValues) cachedTrackingValues.current = trackingValues;
|
|
746
|
-
else if (cachedTrackingValues.current) trackingValues = cachedTrackingValues.current;
|
|
747
|
-
if (!trackingValues) {
|
|
748
|
-
const navigationEntries = performance.getEntriesByType("navigation")[0];
|
|
749
|
-
trackingValues = extractFromPerformanceEntry(navigationEntries, false);
|
|
750
|
-
}
|
|
751
|
-
} catch {}
|
|
752
|
-
if (!trackingValues) {
|
|
753
|
-
const cookie = typeof arguments[0] === "string" ? arguments[0] : typeof document !== "undefined" ? document.cookie : "";
|
|
754
|
-
trackingValues = {
|
|
755
|
-
uniqueToken: cookie.match(/\b_shopify_y=([^;]+)/)?.[1] || "",
|
|
756
|
-
visitToken: cookie.match(/\b_shopify_s=([^;]+)/)?.[1] || "",
|
|
757
|
-
consent: cookie.match(/\b_tracking_consent=([^;]+)/)?.[1] || ""
|
|
758
|
-
};
|
|
759
|
-
}
|
|
760
|
-
return trackingValues;
|
|
761
|
-
}
|
|
762
|
-
function extractFromPerformanceEntry(entry, isConsentRequired = true) {
|
|
763
|
-
let uniqueToken = "";
|
|
764
|
-
let visitToken = "";
|
|
765
|
-
let consent = "";
|
|
766
|
-
const serverTiming = entry.serverTiming;
|
|
767
|
-
if (serverTiming && serverTiming.length >= 3) for (let i = serverTiming.length - 1; i >= 0; i--) {
|
|
768
|
-
const { name, description } = serverTiming[i];
|
|
769
|
-
if (!name || !description) continue;
|
|
770
|
-
if (name === "_y") uniqueToken = description;
|
|
771
|
-
else if (name === "_s") visitToken = description;
|
|
772
|
-
else if (name === "_cmp") consent = description;
|
|
773
|
-
if (uniqueToken && visitToken && consent) break;
|
|
774
|
-
}
|
|
775
|
-
return uniqueToken && visitToken && (isConsentRequired ? consent : true) ? {
|
|
776
|
-
uniqueToken,
|
|
777
|
-
visitToken,
|
|
778
|
-
consent
|
|
779
|
-
} : void 0;
|
|
727
|
+
const cookie = typeof arguments[0] === "string" ? arguments[0] : typeof document !== "undefined" ? document.cookie : "";
|
|
728
|
+
const customerPrivacy = typeof window === "undefined" ? void 0 : window.Shopify?.customerPrivacy;
|
|
729
|
+
const internal = customerPrivacy?.__internal;
|
|
730
|
+
const tokenOptions = {
|
|
731
|
+
generateFallback: customerPrivacy?.config?.asyncConsent === true,
|
|
732
|
+
tag: "hydrogen:classic"
|
|
733
|
+
};
|
|
734
|
+
return {
|
|
735
|
+
uniqueToken: internal?.uniqueToken ? internal.uniqueToken(tokenOptions) ?? "" : cookie.match(/\b_shopify_y=([^;]+)/)?.[1] ?? "",
|
|
736
|
+
visitToken: internal?.visitToken ? internal.visitToken(tokenOptions) ?? "" : cookie.match(/\b_shopify_s=([^;]+)/)?.[1] ?? "",
|
|
737
|
+
consent: customerPrivacy?.cachedConsent ?? cookie.match(/\b_tracking_consent=([^;]+)/)?.[1] ?? ""
|
|
738
|
+
};
|
|
780
739
|
}
|
|
781
740
|
//#endregion
|
|
782
741
|
//#region src/cart-hooks.tsx
|
|
@@ -2061,7 +2020,7 @@
|
|
|
2061
2020
|
const payloadWithPrivacy = payload;
|
|
2062
2021
|
return {
|
|
2063
2022
|
source: payload.shopifySalesChannel || ShopifySalesChannel.headless,
|
|
2064
|
-
asset_version_id: payload.assetVersionId || "2026.4.
|
|
2023
|
+
asset_version_id: payload.assetVersionId || "2026.4.5",
|
|
2065
2024
|
hydrogenSubchannelId: payload.storefrontId || payload.hydrogenSubchannelId || "0",
|
|
2066
2025
|
is_persistent_cookie: payload.hasUserConsent,
|
|
2067
2026
|
deprecated_visit_token: payload.visitToken,
|
|
@@ -3410,6 +3369,10 @@
|
|
|
3410
3369
|
const script = document.createElement("script");
|
|
3411
3370
|
if (options?.module) script.type = "module";
|
|
3412
3371
|
else script.type = "text/javascript";
|
|
3372
|
+
const attributes = options?.attributes;
|
|
3373
|
+
if (attributes) Object.keys(attributes).forEach((key) => {
|
|
3374
|
+
script.setAttribute(key, attributes[key]);
|
|
3375
|
+
});
|
|
3413
3376
|
script.src = src;
|
|
3414
3377
|
script.onload = () => {
|
|
3415
3378
|
resolve(true);
|
|
@@ -3419,10 +3382,6 @@
|
|
|
3419
3382
|
};
|
|
3420
3383
|
if (options?.in === "head") document.head.appendChild(script);
|
|
3421
3384
|
else document.body.appendChild(script);
|
|
3422
|
-
const attributes = options?.attributes;
|
|
3423
|
-
if (attributes) Object.keys(attributes).forEach((key) => {
|
|
3424
|
-
script.setAttribute(key, attributes[key]);
|
|
3425
|
-
});
|
|
3426
3385
|
});
|
|
3427
3386
|
SCRIPTS_LOADED[src] = promise;
|
|
3428
3387
|
return promise;
|
|
@@ -3992,88 +3951,50 @@
|
|
|
3992
3951
|
return null;
|
|
3993
3952
|
}
|
|
3994
3953
|
//#endregion
|
|
3995
|
-
//#region ../../node_modules/.pnpm/worktop@0.7.3/node_modules/worktop/cookie/index.mjs
|
|
3996
|
-
function l(a, r, e = {}) {
|
|
3997
|
-
let t = a + "=" + encodeURIComponent(r);
|
|
3998
|
-
return e.expires && (t += "; Expires=" + new Date(e.expires).toUTCString()), e.maxage != null && e.maxage >= 0 && (t += "; Max-Age=" + (e.maxage | 0)), e.domain && (t += "; Domain=" + e.domain), e.path && (t += "; Path=" + e.path), e.samesite && (t += "; SameSite=" + e.samesite), (e.secure || e.samesite === "None") && (t += "; Secure"), e.httponly && (t += "; HttpOnly"), t;
|
|
3999
|
-
}
|
|
4000
|
-
//#endregion
|
|
4001
3954
|
//#region src/useShopifyCookies.tsx
|
|
4002
|
-
var
|
|
4003
|
-
var shortTermLength = 1800;
|
|
3955
|
+
var CONSENT_MANAGEMENT_MARKER_HEADER = "Shopify-Storefront-Consent-Management";
|
|
4004
3956
|
/**
|
|
4005
|
-
*
|
|
4006
|
-
*
|
|
4007
|
-
*
|
|
4008
|
-
* If `fetchTrackingValues` is true, it makes a request to Storefront API
|
|
4009
|
-
* to fetch or refresh Shopiy analytics and marketing cookies and tracking values.
|
|
4010
|
-
* Generally speaking, this should only be needed if you're not using Hydrogen's
|
|
4011
|
-
* built-in analytics components and hooks that already handle this automatically.
|
|
4012
|
-
* For example, set it to `true` if you are using `hydrogen-react` only with
|
|
4013
|
-
* a different framework and still need to make a same-domain request to
|
|
4014
|
-
* Storefront API to set cookies.
|
|
3957
|
+
* Optionally refreshes backend-managed cookies for standalone integrations.
|
|
3958
|
+
* The Customer Privacy API owns tracking values and legacy cookie expiration.
|
|
4015
3959
|
*
|
|
4016
|
-
* If `
|
|
4017
|
-
*
|
|
3960
|
+
* If `fetchTrackingValues` is true, this sends a consent request through the
|
|
3961
|
+
* Storefront API proxy, retrying against `checkoutDomain` if provided. Hydrogen's
|
|
3962
|
+
* built-in analytics already delegates consent initialization to the Customer
|
|
3963
|
+
* Privacy API and does not use this hook.
|
|
4018
3964
|
*
|
|
4019
|
-
* @returns `true` when
|
|
3965
|
+
* @returns `true` when the consent request has settled and cookies are ready.
|
|
4020
3966
|
* @publicDocs
|
|
4021
3967
|
*/
|
|
4022
3968
|
function useShopifyCookies(options) {
|
|
4023
|
-
const {
|
|
4024
|
-
const
|
|
4025
|
-
|
|
4026
|
-
fetchTrackingValues,
|
|
4027
|
-
checkoutDomain
|
|
4028
|
-
});
|
|
3969
|
+
const { checkoutDomain, storefrontAccessToken, fetchTrackingValues = false } = options ?? {};
|
|
3970
|
+
const [cookiesReady, setCookiesReady] = (0, react.useState)(!fetchTrackingValues);
|
|
3971
|
+
const hasFetchedTrackingValues = (0, react.useRef)(false);
|
|
4029
3972
|
(0, react.useEffect)(() => {
|
|
4030
|
-
if (
|
|
4031
|
-
|
|
4032
|
-
|
|
4033
|
-
*
|
|
4034
|
-
* If no domain is provided, the cookie will be set for the current host.
|
|
4035
|
-
* For Shopify, we need to ensure this domain is set with a leading dot.
|
|
4036
|
-
*/
|
|
4037
|
-
let currentDomain = domain || window.location.host;
|
|
4038
|
-
if (checkoutDomain) {
|
|
4039
|
-
const checkoutDomainParts = checkoutDomain.split(".").reverse();
|
|
4040
|
-
const currentDomainParts = currentDomain.split(".").reverse();
|
|
4041
|
-
const sameDomainParts = [];
|
|
4042
|
-
checkoutDomainParts.forEach((part, index) => {
|
|
4043
|
-
if (part === currentDomainParts[index]) sameDomainParts.push(part);
|
|
4044
|
-
});
|
|
4045
|
-
currentDomain = sameDomainParts.reverse().join(".");
|
|
4046
|
-
}
|
|
4047
|
-
if (/^localhost/.test(currentDomain)) currentDomain = "";
|
|
4048
|
-
const domainWithLeadingDot = currentDomain ? /^\./.test(currentDomain) ? currentDomain : `.${currentDomain}` : "";
|
|
4049
|
-
/**
|
|
4050
|
-
* Set user and session cookies and refresh the expiry time
|
|
4051
|
-
*/
|
|
4052
|
-
if (hasUserConsent) {
|
|
4053
|
-
const trackingValues = getTrackingValues();
|
|
4054
|
-
if ((trackingValues.uniqueToken || trackingValues.visitToken || "").startsWith("00000000-")) return;
|
|
4055
|
-
setCookie(SHOPIFY_Y, trackingValues.uniqueToken || buildUUID(), longTermLength, domainWithLeadingDot);
|
|
4056
|
-
setCookie(SHOPIFY_S, trackingValues.visitToken || buildUUID(), shortTermLength, domainWithLeadingDot);
|
|
4057
|
-
} else {
|
|
4058
|
-
setCookie(SHOPIFY_Y, "", 0, domainWithLeadingDot);
|
|
4059
|
-
setCookie(SHOPIFY_S, "", 0, domainWithLeadingDot);
|
|
3973
|
+
if (!fetchTrackingValues) {
|
|
3974
|
+
setCookiesReady(true);
|
|
3975
|
+
return;
|
|
4060
3976
|
}
|
|
3977
|
+
if (hasFetchedTrackingValues.current) return;
|
|
3978
|
+
hasFetchedTrackingValues.current = true;
|
|
3979
|
+
const fetchConsentValues = async () => {
|
|
3980
|
+
try {
|
|
3981
|
+
return await fetchTrackingValuesFromBrowser(storefrontAccessToken);
|
|
3982
|
+
} catch (sameOriginError) {
|
|
3983
|
+
if (!checkoutDomain) throw sameOriginError;
|
|
3984
|
+
return fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain);
|
|
3985
|
+
}
|
|
3986
|
+
};
|
|
3987
|
+
fetchConsentValues().catch((error) => {
|
|
3988
|
+
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
3989
|
+
}).finally(() => {
|
|
3990
|
+
setCookiesReady(true);
|
|
3991
|
+
});
|
|
4061
3992
|
}, [
|
|
4062
|
-
coreCookiesReady,
|
|
4063
|
-
hasUserConsent,
|
|
4064
|
-
domain,
|
|
4065
3993
|
checkoutDomain,
|
|
4066
|
-
|
|
3994
|
+
fetchTrackingValues,
|
|
3995
|
+
storefrontAccessToken
|
|
4067
3996
|
]);
|
|
4068
|
-
return
|
|
4069
|
-
}
|
|
4070
|
-
function setCookie(name, value, maxage, domain) {
|
|
4071
|
-
document.cookie = l(name, value, {
|
|
4072
|
-
maxage,
|
|
4073
|
-
domain,
|
|
4074
|
-
samesite: "Lax",
|
|
4075
|
-
path: "/"
|
|
4076
|
-
});
|
|
3997
|
+
return cookiesReady;
|
|
4077
3998
|
}
|
|
4078
3999
|
async function fetchTrackingValuesFromBrowser(storefrontAccessToken, storefrontApiDomain = "") {
|
|
4079
4000
|
const { uniqueToken, visitToken } = getTrackingValues();
|
|
@@ -4082,43 +4003,15 @@
|
|
|
4082
4003
|
headers: {
|
|
4083
4004
|
"Content-Type": "application/json",
|
|
4084
4005
|
...storefrontAccessToken && { "X-Shopify-Storefront-Access-Token": storefrontAccessToken },
|
|
4006
|
+
...storefrontApiDomain ? void 0 : { [CONSENT_MANAGEMENT_MARKER_HEADER]: "1" },
|
|
4085
4007
|
...visitToken || uniqueToken ? {
|
|
4086
4008
|
[SHOPIFY_VISIT_TOKEN_HEADER]: visitToken,
|
|
4087
4009
|
[SHOPIFY_UNIQUE_TOKEN_HEADER]: uniqueToken
|
|
4088
4010
|
} : void 0
|
|
4089
4011
|
},
|
|
4090
|
-
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { cookieDomain } } }" })
|
|
4012
|
+
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { trackingConsentCookie cookieDomain shopifyUnique shopifyVisit } } }" })
|
|
4091
4013
|
});
|
|
4092
4014
|
if (!response.ok) throw new Error(`Failed to fetch consent from browser: ${response.status} ${response.statusText}`);
|
|
4093
|
-
await response.json();
|
|
4094
|
-
getTrackingValues();
|
|
4095
|
-
}
|
|
4096
|
-
/**
|
|
4097
|
-
* Gets http-only cookies from Storefront API via same-origin fetch request.
|
|
4098
|
-
* Falls back to checkout domain if provided to at least obtain the tracking
|
|
4099
|
-
* values via server-timing headers.
|
|
4100
|
-
*/
|
|
4101
|
-
function useCoreShopifyCookies({ checkoutDomain, storefrontAccessToken, fetchTrackingValues = false }) {
|
|
4102
|
-
const [cookiesReady, setCookiesReady] = (0, react.useState)(!fetchTrackingValues);
|
|
4103
|
-
const hasFetchedTrackingValues = (0, react.useRef)(false);
|
|
4104
|
-
(0, react.useEffect)(() => {
|
|
4105
|
-
if (!fetchTrackingValues) {
|
|
4106
|
-
setCookiesReady(true);
|
|
4107
|
-
return;
|
|
4108
|
-
}
|
|
4109
|
-
if (hasFetchedTrackingValues.current) return;
|
|
4110
|
-
hasFetchedTrackingValues.current = true;
|
|
4111
|
-
fetchTrackingValuesFromBrowser(storefrontAccessToken).catch((error) => checkoutDomain ? fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain) : Promise.reject(error)).catch((error) => {
|
|
4112
|
-
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
4113
|
-
}).finally(() => {
|
|
4114
|
-
setCookiesReady(true);
|
|
4115
|
-
});
|
|
4116
|
-
}, [
|
|
4117
|
-
checkoutDomain,
|
|
4118
|
-
fetchTrackingValues,
|
|
4119
|
-
storefrontAccessToken
|
|
4120
|
-
]);
|
|
4121
|
-
return cookiesReady;
|
|
4122
4015
|
}
|
|
4123
4016
|
//#endregion
|
|
4124
4017
|
exports.AddToCartButton = AddToCartButton;
|