@shopify/hydrogen-react 2026.4.3 → 2026.4.4
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 +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 +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 +2 -0
- package/dist/node-dev/load-script.js.map +1 -1
- package/dist/node-dev/load-script.mjs +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 +2 -0
- package/dist/node-prod/load-script.js.map +1 -1
- package/dist/node-prod/load-script.mjs +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 +55 -162
- 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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tracking-utils.js","names":[],"sources":["../../src/tracking-utils.ts"],"sourcesContent":["/** Storefront API header for VisitToken */\nexport const SHOPIFY_VISIT_TOKEN_HEADER = 'X-Shopify-VisitToken';\n/** Storefront API header for UniqueToken */\nexport const SHOPIFY_UNIQUE_TOKEN_HEADER = 'X-Shopify-UniqueToken';\n\ntype TrackingValues = {\n /** Identifier for the unique user. Equivalent to the deprecated _shopify_y cookie */\n uniqueToken: string;\n /** Identifier for the current visit. Equivalent to the deprecated _shopify_s cookie */\n visitToken: string;\n /** Represents the consent given by the user or the default region consent configured in Admin */\n consent: string;\n};\n\n//
|
|
1
|
+
{"version":3,"file":"tracking-utils.js","names":[],"sources":["../../src/tracking-utils.ts"],"sourcesContent":["/** Storefront API header for VisitToken */\nexport const SHOPIFY_VISIT_TOKEN_HEADER = 'X-Shopify-VisitToken';\n/** Storefront API header for UniqueToken */\nexport const SHOPIFY_UNIQUE_TOKEN_HEADER = 'X-Shopify-UniqueToken';\n\ntype TrackingValues = {\n /** Identifier for the unique user. Equivalent to the deprecated _shopify_y cookie */\n uniqueToken: string;\n /** Identifier for the current visit. Equivalent to the deprecated _shopify_s cookie */\n visitToken: string;\n /** Represents the consent given by the user or the default region consent configured in Admin */\n consent: string;\n};\n\n// Keep the consent-tracking-api token interface out of Hydrogen's public\n// global types since it could change in the future.\ntype CustomerPrivacyWithTracking = {\n config?: {asyncConsent?: boolean};\n cachedConsent?: string;\n __internal?: {\n uniqueToken?: (options?: {\n generateFallback?: boolean;\n tag?: string;\n }) => string | undefined;\n visitToken?: (options?: {\n generateFallback?: boolean;\n tag?: string;\n }) => string | undefined;\n };\n};\n\n/**\n * Retrieves user session tracking values for analytics and marketing from the\n * browser environment. Customer Privacy API token readers are authoritative\n * when available, including when consent denies tracking. Deprecated\n * `_shopify_y`/`_shopify_s` cookies are read only without an API token reader.\n * Consent comes from CTA's cache or the legacy `_tracking_consent` cookie.\n * @publicDocs\n */\nexport function getTrackingValues(): TrackingValues {\n const cookie =\n // Read from arguments to avoid declaring parameters in this function signature.\n // This logic is only used internally from `getShopifyCookies` and will be deprecated.\n typeof arguments[0] === 'string'\n ? arguments[0]\n : typeof document !== 'undefined'\n ? document.cookie\n : '';\n\n const customerPrivacy =\n typeof window === 'undefined'\n ? undefined\n : (window as {Shopify?: {customerPrivacy?: CustomerPrivacyWithTracking}})\n .Shopify?.customerPrivacy;\n\n const internal = customerPrivacy?.__internal;\n // Async consent owns initialization and suppresses fallback generation until\n // it is loaded. Afterwards CTA can refresh expired tokens, as in preview.\n // Standalone hydrogen-react's explicit consent fetch keeps its previous policy.\n const tokenOptions = {\n generateFallback: customerPrivacy?.config?.asyncConsent === true,\n tag: 'hydrogen:classic',\n };\n\n return {\n // An installed CTA reader is authoritative, including undefined on denial.\n // Falling through to a legacy cookie could restore a disallowed token.\n uniqueToken: internal?.uniqueToken\n ? (internal.uniqueToken(tokenOptions) ?? '')\n : (cookie.match(/\\b_shopify_y=([^;]+)/)?.[1] ?? ''),\n visitToken: internal?.visitToken\n ? (internal.visitToken(tokenOptions) ?? '')\n : (cookie.match(/\\b_shopify_s=([^;]+)/)?.[1] ?? ''),\n consent:\n customerPrivacy?.cachedConsent ??\n cookie.match(/\\b_tracking_consent=([^;]+)/)?.[1] ??\n '',\n };\n}\n"],"mappings":";;AACA,IAAa,6BAA6B;;AAE1C,IAAa,8BAA8B;;;;;;;;;AAoC3C,SAAgB,oBAAoC;CAClD,MAAM,SAGJ,OAAO,UAAU,OAAO,WACpB,UAAU,KACV,OAAO,aAAa,cAClB,SAAS,SACT;CAER,MAAM,kBACJ,OAAO,WAAW,cACd,KAAA,IACC,OACE,SAAS;CAElB,MAAM,WAAW,iBAAiB;CAIlC,MAAM,eAAe;EACnB,kBAAkB,iBAAiB,QAAQ,iBAAiB;EAC5D,KAAK;EACN;AAED,QAAO;EAGL,aAAa,UAAU,cAClB,SAAS,YAAY,aAAa,IAAI,KACtC,OAAO,MAAM,uBAAuB,GAAG,MAAM;EAClD,YAAY,UAAU,aACjB,SAAS,WAAW,aAAa,IAAI,KACrC,OAAO,MAAM,uBAAuB,GAAG,MAAM;EAClD,SACE,iBAAiB,iBACjB,OAAO,MAAM,8BAA8B,GAAG,MAC9C;EACH"}
|
|
@@ -3,68 +3,27 @@
|
|
|
3
3
|
var SHOPIFY_VISIT_TOKEN_HEADER = "X-Shopify-VisitToken";
|
|
4
4
|
/** Storefront API header for UniqueToken */
|
|
5
5
|
var SHOPIFY_UNIQUE_TOKEN_HEADER = "X-Shopify-UniqueToken";
|
|
6
|
-
var cachedTrackingValues = { current: null };
|
|
7
6
|
/**
|
|
8
|
-
* Retrieves user session tracking values for analytics and marketing from the
|
|
7
|
+
* Retrieves user session tracking values for analytics and marketing from the
|
|
8
|
+
* browser environment. Customer Privacy API token readers are authoritative
|
|
9
|
+
* when available, including when consent denies tracking. Deprecated
|
|
10
|
+
* `_shopify_y`/`_shopify_s` cookies are read only without an API token reader.
|
|
11
|
+
* Consent comes from CTA's cache or the legacy `_tracking_consent` cookie.
|
|
9
12
|
* @publicDocs
|
|
10
13
|
*/
|
|
11
14
|
function getTrackingValues() {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
if (matchedHost === currentHost || sfapiPath && matchedHost?.endsWith(`.${currentHost}`)) {
|
|
25
|
-
const values = extractFromPerformanceEntry(entry);
|
|
26
|
-
if (values) {
|
|
27
|
-
matchedValues = values;
|
|
28
|
-
break;
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
if (matchedValues) trackingValues = matchedValues;
|
|
33
|
-
if (trackingValues) cachedTrackingValues.current = trackingValues;
|
|
34
|
-
else if (cachedTrackingValues.current) trackingValues = cachedTrackingValues.current;
|
|
35
|
-
if (!trackingValues) {
|
|
36
|
-
const navigationEntries = performance.getEntriesByType("navigation")[0];
|
|
37
|
-
trackingValues = extractFromPerformanceEntry(navigationEntries, false);
|
|
38
|
-
}
|
|
39
|
-
} catch {}
|
|
40
|
-
if (!trackingValues) {
|
|
41
|
-
const cookie = typeof arguments[0] === "string" ? arguments[0] : typeof document !== "undefined" ? document.cookie : "";
|
|
42
|
-
trackingValues = {
|
|
43
|
-
uniqueToken: cookie.match(/\b_shopify_y=([^;]+)/)?.[1] || "",
|
|
44
|
-
visitToken: cookie.match(/\b_shopify_s=([^;]+)/)?.[1] || "",
|
|
45
|
-
consent: cookie.match(/\b_tracking_consent=([^;]+)/)?.[1] || ""
|
|
46
|
-
};
|
|
47
|
-
}
|
|
48
|
-
return trackingValues;
|
|
49
|
-
}
|
|
50
|
-
function extractFromPerformanceEntry(entry, isConsentRequired = true) {
|
|
51
|
-
let uniqueToken = "";
|
|
52
|
-
let visitToken = "";
|
|
53
|
-
let consent = "";
|
|
54
|
-
const serverTiming = entry.serverTiming;
|
|
55
|
-
if (serverTiming && serverTiming.length >= 3) for (let i = serverTiming.length - 1; i >= 0; i--) {
|
|
56
|
-
const { name, description } = serverTiming[i];
|
|
57
|
-
if (!name || !description) continue;
|
|
58
|
-
if (name === "_y") uniqueToken = description;
|
|
59
|
-
else if (name === "_s") visitToken = description;
|
|
60
|
-
else if (name === "_cmp") consent = description;
|
|
61
|
-
if (uniqueToken && visitToken && consent) break;
|
|
62
|
-
}
|
|
63
|
-
return uniqueToken && visitToken && (isConsentRequired ? consent : true) ? {
|
|
64
|
-
uniqueToken,
|
|
65
|
-
visitToken,
|
|
66
|
-
consent
|
|
67
|
-
} : void 0;
|
|
15
|
+
const cookie = typeof arguments[0] === "string" ? arguments[0] : typeof document !== "undefined" ? document.cookie : "";
|
|
16
|
+
const customerPrivacy = typeof window === "undefined" ? void 0 : window.Shopify?.customerPrivacy;
|
|
17
|
+
const internal = customerPrivacy?.__internal;
|
|
18
|
+
const tokenOptions = {
|
|
19
|
+
generateFallback: customerPrivacy?.config?.asyncConsent === true,
|
|
20
|
+
tag: "hydrogen:classic"
|
|
21
|
+
};
|
|
22
|
+
return {
|
|
23
|
+
uniqueToken: internal?.uniqueToken ? internal.uniqueToken(tokenOptions) ?? "" : cookie.match(/\b_shopify_y=([^;]+)/)?.[1] ?? "",
|
|
24
|
+
visitToken: internal?.visitToken ? internal.visitToken(tokenOptions) ?? "" : cookie.match(/\b_shopify_s=([^;]+)/)?.[1] ?? "",
|
|
25
|
+
consent: customerPrivacy?.cachedConsent ?? cookie.match(/\b_tracking_consent=([^;]+)/)?.[1] ?? ""
|
|
26
|
+
};
|
|
68
27
|
}
|
|
69
28
|
//#endregion
|
|
70
29
|
export { SHOPIFY_UNIQUE_TOKEN_HEADER, SHOPIFY_VISIT_TOKEN_HEADER, getTrackingValues };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tracking-utils.mjs","names":[],"sources":["../../src/tracking-utils.ts"],"sourcesContent":["/** Storefront API header for VisitToken */\nexport const SHOPIFY_VISIT_TOKEN_HEADER = 'X-Shopify-VisitToken';\n/** Storefront API header for UniqueToken */\nexport const SHOPIFY_UNIQUE_TOKEN_HEADER = 'X-Shopify-UniqueToken';\n\ntype TrackingValues = {\n /** Identifier for the unique user. Equivalent to the deprecated _shopify_y cookie */\n uniqueToken: string;\n /** Identifier for the current visit. Equivalent to the deprecated _shopify_s cookie */\n visitToken: string;\n /** Represents the consent given by the user or the default region consent configured in Admin */\n consent: string;\n};\n\n//
|
|
1
|
+
{"version":3,"file":"tracking-utils.mjs","names":[],"sources":["../../src/tracking-utils.ts"],"sourcesContent":["/** Storefront API header for VisitToken */\nexport const SHOPIFY_VISIT_TOKEN_HEADER = 'X-Shopify-VisitToken';\n/** Storefront API header for UniqueToken */\nexport const SHOPIFY_UNIQUE_TOKEN_HEADER = 'X-Shopify-UniqueToken';\n\ntype TrackingValues = {\n /** Identifier for the unique user. Equivalent to the deprecated _shopify_y cookie */\n uniqueToken: string;\n /** Identifier for the current visit. Equivalent to the deprecated _shopify_s cookie */\n visitToken: string;\n /** Represents the consent given by the user or the default region consent configured in Admin */\n consent: string;\n};\n\n// Keep the consent-tracking-api token interface out of Hydrogen's public\n// global types since it could change in the future.\ntype CustomerPrivacyWithTracking = {\n config?: {asyncConsent?: boolean};\n cachedConsent?: string;\n __internal?: {\n uniqueToken?: (options?: {\n generateFallback?: boolean;\n tag?: string;\n }) => string | undefined;\n visitToken?: (options?: {\n generateFallback?: boolean;\n tag?: string;\n }) => string | undefined;\n };\n};\n\n/**\n * Retrieves user session tracking values for analytics and marketing from the\n * browser environment. Customer Privacy API token readers are authoritative\n * when available, including when consent denies tracking. Deprecated\n * `_shopify_y`/`_shopify_s` cookies are read only without an API token reader.\n * Consent comes from CTA's cache or the legacy `_tracking_consent` cookie.\n * @publicDocs\n */\nexport function getTrackingValues(): TrackingValues {\n const cookie =\n // Read from arguments to avoid declaring parameters in this function signature.\n // This logic is only used internally from `getShopifyCookies` and will be deprecated.\n typeof arguments[0] === 'string'\n ? arguments[0]\n : typeof document !== 'undefined'\n ? document.cookie\n : '';\n\n const customerPrivacy =\n typeof window === 'undefined'\n ? undefined\n : (window as {Shopify?: {customerPrivacy?: CustomerPrivacyWithTracking}})\n .Shopify?.customerPrivacy;\n\n const internal = customerPrivacy?.__internal;\n // Async consent owns initialization and suppresses fallback generation until\n // it is loaded. Afterwards CTA can refresh expired tokens, as in preview.\n // Standalone hydrogen-react's explicit consent fetch keeps its previous policy.\n const tokenOptions = {\n generateFallback: customerPrivacy?.config?.asyncConsent === true,\n tag: 'hydrogen:classic',\n };\n\n return {\n // An installed CTA reader is authoritative, including undefined on denial.\n // Falling through to a legacy cookie could restore a disallowed token.\n uniqueToken: internal?.uniqueToken\n ? (internal.uniqueToken(tokenOptions) ?? '')\n : (cookie.match(/\\b_shopify_y=([^;]+)/)?.[1] ?? ''),\n visitToken: internal?.visitToken\n ? (internal.visitToken(tokenOptions) ?? '')\n : (cookie.match(/\\b_shopify_s=([^;]+)/)?.[1] ?? ''),\n consent:\n customerPrivacy?.cachedConsent ??\n cookie.match(/\\b_tracking_consent=([^;]+)/)?.[1] ??\n '',\n };\n}\n"],"mappings":";;AACA,IAAa,6BAA6B;;AAE1C,IAAa,8BAA8B;;;;;;;;;AAoC3C,SAAgB,oBAAoC;CAClD,MAAM,SAGJ,OAAO,UAAU,OAAO,WACpB,UAAU,KACV,OAAO,aAAa,cAClB,SAAS,SACT;CAER,MAAM,kBACJ,OAAO,WAAW,cACd,KAAA,IACC,OACE,SAAS;CAElB,MAAM,WAAW,iBAAiB;CAIlC,MAAM,eAAe;EACnB,kBAAkB,iBAAiB,QAAQ,iBAAiB;EAC5D,KAAK;EACN;AAED,QAAO;EAGL,aAAa,UAAU,cAClB,SAAS,YAAY,aAAa,IAAI,KACtC,OAAO,MAAM,uBAAuB,GAAG,MAAM;EAClD,YAAY,UAAU,aACjB,SAAS,WAAW,aAAa,IAAI,KACrC,OAAO,MAAM,uBAAuB,GAAG,MAAM;EAClD,SACE,iBAAiB,iBACjB,OAAO,MAAM,8BAA8B,GAAG,MAC9C;EACH"}
|
|
@@ -1,85 +1,50 @@
|
|
|
1
1
|
require("./_virtual/_rolldown/runtime.js");
|
|
2
|
-
const require_cart_constants = require("./cart-constants.js");
|
|
3
2
|
const require_tracking_utils = require("./tracking-utils.js");
|
|
4
|
-
const require_cookies_utils = require("./cookies-utils.js");
|
|
5
3
|
let react = require("react");
|
|
6
|
-
let worktop_cookie = require("worktop/cookie");
|
|
7
4
|
//#region src/useShopifyCookies.tsx
|
|
8
|
-
var
|
|
9
|
-
var shortTermLength = 1800;
|
|
5
|
+
var CONSENT_MANAGEMENT_MARKER_HEADER = "Shopify-Storefront-Consent-Management";
|
|
10
6
|
/**
|
|
11
|
-
*
|
|
12
|
-
*
|
|
7
|
+
* Optionally refreshes backend-managed cookies for standalone integrations.
|
|
8
|
+
* The Customer Privacy API owns tracking values and legacy cookie expiration.
|
|
13
9
|
*
|
|
14
|
-
* If `fetchTrackingValues` is true,
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* For example, set it to `true` if you are using `hydrogen-react` only with
|
|
19
|
-
* a different framework and still need to make a same-domain request to
|
|
20
|
-
* Storefront API to set cookies.
|
|
10
|
+
* If `fetchTrackingValues` is true, this sends a consent request through the
|
|
11
|
+
* Storefront API proxy, retrying against `checkoutDomain` if provided. Hydrogen's
|
|
12
|
+
* built-in analytics already delegates consent initialization to the Customer
|
|
13
|
+
* Privacy API and does not use this hook.
|
|
21
14
|
*
|
|
22
|
-
*
|
|
23
|
-
* Useful when you only want to use the newer tracking values and not rely on the deprecated ones.
|
|
24
|
-
*
|
|
25
|
-
* @returns `true` when cookies are set and ready.
|
|
15
|
+
* @returns `true` when the consent request has settled and cookies are ready.
|
|
26
16
|
* @publicDocs
|
|
27
17
|
*/
|
|
28
18
|
function useShopifyCookies(options) {
|
|
29
|
-
const {
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
-
fetchTrackingValues,
|
|
33
|
-
checkoutDomain
|
|
34
|
-
});
|
|
19
|
+
const { checkoutDomain, storefrontAccessToken, fetchTrackingValues = false } = options ?? {};
|
|
20
|
+
const [cookiesReady, setCookiesReady] = (0, react.useState)(!fetchTrackingValues);
|
|
21
|
+
const hasFetchedTrackingValues = (0, react.useRef)(false);
|
|
35
22
|
(0, react.useEffect)(() => {
|
|
36
|
-
if (
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
*
|
|
40
|
-
* If no domain is provided, the cookie will be set for the current host.
|
|
41
|
-
* For Shopify, we need to ensure this domain is set with a leading dot.
|
|
42
|
-
*/
|
|
43
|
-
let currentDomain = domain || window.location.host;
|
|
44
|
-
if (checkoutDomain) {
|
|
45
|
-
const checkoutDomainParts = checkoutDomain.split(".").reverse();
|
|
46
|
-
const currentDomainParts = currentDomain.split(".").reverse();
|
|
47
|
-
const sameDomainParts = [];
|
|
48
|
-
checkoutDomainParts.forEach((part, index) => {
|
|
49
|
-
if (part === currentDomainParts[index]) sameDomainParts.push(part);
|
|
50
|
-
});
|
|
51
|
-
currentDomain = sameDomainParts.reverse().join(".");
|
|
52
|
-
}
|
|
53
|
-
if (/^localhost/.test(currentDomain)) currentDomain = "";
|
|
54
|
-
const domainWithLeadingDot = currentDomain ? /^\./.test(currentDomain) ? currentDomain : `.${currentDomain}` : "";
|
|
55
|
-
/**
|
|
56
|
-
* Set user and session cookies and refresh the expiry time
|
|
57
|
-
*/
|
|
58
|
-
if (hasUserConsent) {
|
|
59
|
-
const trackingValues = require_tracking_utils.getTrackingValues();
|
|
60
|
-
if ((trackingValues.uniqueToken || trackingValues.visitToken || "").startsWith("00000000-")) return;
|
|
61
|
-
setCookie(require_cart_constants.SHOPIFY_Y, trackingValues.uniqueToken || require_cookies_utils.buildUUID(), longTermLength, domainWithLeadingDot);
|
|
62
|
-
setCookie(require_cart_constants.SHOPIFY_S, trackingValues.visitToken || require_cookies_utils.buildUUID(), shortTermLength, domainWithLeadingDot);
|
|
63
|
-
} else {
|
|
64
|
-
setCookie(require_cart_constants.SHOPIFY_Y, "", 0, domainWithLeadingDot);
|
|
65
|
-
setCookie(require_cart_constants.SHOPIFY_S, "", 0, domainWithLeadingDot);
|
|
23
|
+
if (!fetchTrackingValues) {
|
|
24
|
+
setCookiesReady(true);
|
|
25
|
+
return;
|
|
66
26
|
}
|
|
27
|
+
if (hasFetchedTrackingValues.current) return;
|
|
28
|
+
hasFetchedTrackingValues.current = true;
|
|
29
|
+
const fetchConsentValues = async () => {
|
|
30
|
+
try {
|
|
31
|
+
return await fetchTrackingValuesFromBrowser(storefrontAccessToken);
|
|
32
|
+
} catch (sameOriginError) {
|
|
33
|
+
if (!checkoutDomain) throw sameOriginError;
|
|
34
|
+
return fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain);
|
|
35
|
+
}
|
|
36
|
+
};
|
|
37
|
+
fetchConsentValues().catch((error) => {
|
|
38
|
+
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
39
|
+
}).finally(() => {
|
|
40
|
+
setCookiesReady(true);
|
|
41
|
+
});
|
|
67
42
|
}, [
|
|
68
|
-
coreCookiesReady,
|
|
69
|
-
hasUserConsent,
|
|
70
|
-
domain,
|
|
71
43
|
checkoutDomain,
|
|
72
|
-
|
|
44
|
+
fetchTrackingValues,
|
|
45
|
+
storefrontAccessToken
|
|
73
46
|
]);
|
|
74
|
-
return
|
|
75
|
-
}
|
|
76
|
-
function setCookie(name, value, maxage, domain) {
|
|
77
|
-
document.cookie = (0, worktop_cookie.stringify)(name, value, {
|
|
78
|
-
maxage,
|
|
79
|
-
domain,
|
|
80
|
-
samesite: "Lax",
|
|
81
|
-
path: "/"
|
|
82
|
-
});
|
|
47
|
+
return cookiesReady;
|
|
83
48
|
}
|
|
84
49
|
async function fetchTrackingValuesFromBrowser(storefrontAccessToken, storefrontApiDomain = "") {
|
|
85
50
|
const { uniqueToken, visitToken } = require_tracking_utils.getTrackingValues();
|
|
@@ -88,43 +53,15 @@ async function fetchTrackingValuesFromBrowser(storefrontAccessToken, storefrontA
|
|
|
88
53
|
headers: {
|
|
89
54
|
"Content-Type": "application/json",
|
|
90
55
|
...storefrontAccessToken && { "X-Shopify-Storefront-Access-Token": storefrontAccessToken },
|
|
56
|
+
...storefrontApiDomain ? void 0 : { [CONSENT_MANAGEMENT_MARKER_HEADER]: "1" },
|
|
91
57
|
...visitToken || uniqueToken ? {
|
|
92
58
|
[require_tracking_utils.SHOPIFY_VISIT_TOKEN_HEADER]: visitToken,
|
|
93
59
|
[require_tracking_utils.SHOPIFY_UNIQUE_TOKEN_HEADER]: uniqueToken
|
|
94
60
|
} : void 0
|
|
95
61
|
},
|
|
96
|
-
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { cookieDomain } } }" })
|
|
62
|
+
body: JSON.stringify({ query: "query ensureCookies { consentManagement { cookies(visitorConsent:{}) { trackingConsentCookie cookieDomain shopifyUnique shopifyVisit } } }" })
|
|
97
63
|
});
|
|
98
64
|
if (!response.ok) throw new Error(`Failed to fetch consent from browser: ${response.status} ${response.statusText}`);
|
|
99
|
-
await response.json();
|
|
100
|
-
require_tracking_utils.getTrackingValues();
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Gets http-only cookies from Storefront API via same-origin fetch request.
|
|
104
|
-
* Falls back to checkout domain if provided to at least obtain the tracking
|
|
105
|
-
* values via server-timing headers.
|
|
106
|
-
*/
|
|
107
|
-
function useCoreShopifyCookies({ checkoutDomain, storefrontAccessToken, fetchTrackingValues = false }) {
|
|
108
|
-
const [cookiesReady, setCookiesReady] = (0, react.useState)(!fetchTrackingValues);
|
|
109
|
-
const hasFetchedTrackingValues = (0, react.useRef)(false);
|
|
110
|
-
(0, react.useEffect)(() => {
|
|
111
|
-
if (!fetchTrackingValues) {
|
|
112
|
-
setCookiesReady(true);
|
|
113
|
-
return;
|
|
114
|
-
}
|
|
115
|
-
if (hasFetchedTrackingValues.current) return;
|
|
116
|
-
hasFetchedTrackingValues.current = true;
|
|
117
|
-
fetchTrackingValuesFromBrowser(storefrontAccessToken).catch((error) => checkoutDomain ? fetchTrackingValuesFromBrowser(storefrontAccessToken, checkoutDomain) : Promise.reject(error)).catch((error) => {
|
|
118
|
-
console.warn("[h2:warn:useShopifyCookies] Failed to fetch tracking values from browser: " + (error instanceof Error ? error.message : String(error)));
|
|
119
|
-
}).finally(() => {
|
|
120
|
-
setCookiesReady(true);
|
|
121
|
-
});
|
|
122
|
-
}, [
|
|
123
|
-
checkoutDomain,
|
|
124
|
-
fetchTrackingValues,
|
|
125
|
-
storefrontAccessToken
|
|
126
|
-
]);
|
|
127
|
-
return cookiesReady;
|
|
128
65
|
}
|
|
129
66
|
//#endregion
|
|
130
67
|
exports.useShopifyCookies = useShopifyCookies;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useShopifyCookies.js","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,EAAA,GAAA,MAAA,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,uBAAA,mBAAmB;AAC1C,QAEI,eAAe,eACf,eAAe,cACf,IACA,WAAW,YAAY,CAGzB;AAGF,aACE,uBAAA,WACA,eAAe,eAAe,sBAAA,WAAW,EACzC,gBACA,qBACD;AACD,aACE,uBAAA,WACA,eAAe,cAAc,sBAAA,WAAW,EACxC,iBACA,qBACD;SACI;AACL,aAAU,uBAAA,WAAW,IAAI,GAAG,qBAAqB;AACjD,aAAU,uBAAA,WAAW,IAAI,GAAG,qBAAqB;;IAElD;EACD;EACA;EACA;EACA;EACA;EACD,CAAC;AAEF,QAAO;;AAGT,SAAS,UACP,MACA,OACA,QACA,QACM;AACN,UAAS,UAAA,GAAA,eAAA,WAAmB,MAAM,OAAO;EACvC;EACA;EACA,UAAU;EACV,MAAM;EACP,CAAC;;AAGJ,eAAe,+BACb,uBACA,sBAAsB,IACP;CAOf,MAAM,EAAC,aAAa,eAAc,uBAAA,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,uBAAA,6BAA6B;KAC7B,uBAAA,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,wBAAA,mBAAmB;;;;;;;AAcrB,SAAS,sBAAsB,EAC7B,gBACA,uBACA,sBAAsB,SACM;CAC5B,MAAM,CAAC,cAAc,oBAAA,GAAA,MAAA,UAA4B,CAAC,oBAAoB;CACtE,MAAM,4BAAA,GAAA,MAAA,QAAkC,MAAM;AAE9C,EAAA,GAAA,MAAA,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.js","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,oBAAA,GAAA,MAAA,UAA4B,CAAC,oBAAoB;CACtE,MAAM,4BAAA,GAAA,MAAA,QAAkC,MAAM;AAE9C,EAAA,GAAA,MAAA,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,uBAAA,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,uBAAA,6BAA6B;KAC7B,uBAAA,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"}
|
|
@@ -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;
|