@shopify/hydrogen-react 2024.10.0 → 2024.10.2
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/AddToCartButton.mjs.map +1 -1
- package/dist/browser-dev/BuyNowButton.mjs.map +1 -1
- package/dist/browser-dev/CartCost.mjs.map +1 -1
- package/dist/browser-dev/CartProvider.mjs.map +1 -1
- package/dist/browser-dev/ExternalVideo.mjs.map +1 -1
- package/dist/browser-dev/ProductPrice.mjs.map +1 -1
- package/dist/browser-dev/RichText.mjs.map +1 -1
- package/dist/browser-dev/ShopifyProvider.mjs +19 -1
- package/dist/browser-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-dev/analytics.mjs +4 -5
- package/dist/browser-dev/analytics.mjs.map +1 -1
- package/dist/browser-dev/cart-hooks.mjs +25 -7
- package/dist/browser-dev/cart-hooks.mjs.map +1 -1
- package/dist/browser-dev/cookies-utils.mjs +4 -4
- package/dist/browser-dev/cookies-utils.mjs.map +1 -1
- package/dist/browser-dev/getProductOptions.mjs +239 -0
- package/dist/browser-dev/getProductOptions.mjs.map +1 -0
- package/dist/browser-dev/index.mjs +10 -0
- package/dist/browser-dev/index.mjs.map +1 -1
- package/dist/browser-dev/packages/hydrogen-react/package.json.mjs +1 -1
- package/dist/browser-dev/tracking-utils.mjs +92 -0
- package/dist/browser-dev/tracking-utils.mjs.map +1 -0
- package/dist/browser-dev/useSelectedOptionInUrlParam.mjs +30 -0
- package/dist/browser-dev/useSelectedOptionInUrlParam.mjs.map +1 -0
- package/dist/browser-dev/useShopifyCookies.mjs +98 -9
- package/dist/browser-dev/useShopifyCookies.mjs.map +1 -1
- package/dist/browser-prod/AddToCartButton.mjs.map +1 -1
- package/dist/browser-prod/BuyNowButton.mjs.map +1 -1
- package/dist/browser-prod/CartCost.mjs.map +1 -1
- package/dist/browser-prod/CartProvider.mjs.map +1 -1
- package/dist/browser-prod/ExternalVideo.mjs.map +1 -1
- package/dist/browser-prod/ProductPrice.mjs.map +1 -1
- package/dist/browser-prod/RichText.mjs.map +1 -1
- package/dist/browser-prod/ShopifyProvider.mjs +19 -1
- package/dist/browser-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/browser-prod/analytics.mjs +4 -5
- package/dist/browser-prod/analytics.mjs.map +1 -1
- package/dist/browser-prod/cart-hooks.mjs +25 -7
- package/dist/browser-prod/cart-hooks.mjs.map +1 -1
- package/dist/browser-prod/cookies-utils.mjs +4 -4
- package/dist/browser-prod/cookies-utils.mjs.map +1 -1
- package/dist/browser-prod/getProductOptions.mjs +239 -0
- package/dist/browser-prod/getProductOptions.mjs.map +1 -0
- package/dist/browser-prod/index.mjs +10 -0
- package/dist/browser-prod/index.mjs.map +1 -1
- package/dist/browser-prod/packages/hydrogen-react/package.json.mjs +1 -1
- package/dist/browser-prod/tracking-utils.mjs +92 -0
- package/dist/browser-prod/tracking-utils.mjs.map +1 -0
- package/dist/browser-prod/useSelectedOptionInUrlParam.mjs +30 -0
- package/dist/browser-prod/useSelectedOptionInUrlParam.mjs.map +1 -0
- package/dist/browser-prod/useShopifyCookies.mjs +98 -9
- package/dist/browser-prod/useShopifyCookies.mjs.map +1 -1
- package/dist/node-dev/AddToCartButton.js.map +1 -1
- package/dist/node-dev/AddToCartButton.mjs.map +1 -1
- package/dist/node-dev/BuyNowButton.js.map +1 -1
- package/dist/node-dev/BuyNowButton.mjs.map +1 -1
- package/dist/node-dev/CartCost.js.map +1 -1
- package/dist/node-dev/CartCost.mjs.map +1 -1
- package/dist/node-dev/CartProvider.js.map +1 -1
- package/dist/node-dev/CartProvider.mjs.map +1 -1
- package/dist/node-dev/ExternalVideo.js.map +1 -1
- package/dist/node-dev/ExternalVideo.mjs.map +1 -1
- package/dist/node-dev/ProductPrice.js.map +1 -1
- package/dist/node-dev/ProductPrice.mjs.map +1 -1
- package/dist/node-dev/RichText.js.map +1 -1
- package/dist/node-dev/RichText.mjs.map +1 -1
- package/dist/node-dev/ShopifyProvider.js +19 -1
- package/dist/node-dev/ShopifyProvider.js.map +1 -1
- package/dist/node-dev/ShopifyProvider.mjs +19 -1
- package/dist/node-dev/ShopifyProvider.mjs.map +1 -1
- package/dist/node-dev/analytics.js +4 -5
- package/dist/node-dev/analytics.js.map +1 -1
- package/dist/node-dev/analytics.mjs +4 -5
- package/dist/node-dev/analytics.mjs.map +1 -1
- package/dist/node-dev/cart-hooks.js +24 -6
- package/dist/node-dev/cart-hooks.js.map +1 -1
- package/dist/node-dev/cart-hooks.mjs +25 -7
- package/dist/node-dev/cart-hooks.mjs.map +1 -1
- package/dist/node-dev/cookies-utils.js +4 -4
- package/dist/node-dev/cookies-utils.js.map +1 -1
- package/dist/node-dev/cookies-utils.mjs +4 -4
- package/dist/node-dev/cookies-utils.mjs.map +1 -1
- package/dist/node-dev/getProductOptions.js +239 -0
- package/dist/node-dev/getProductOptions.js.map +1 -0
- package/dist/node-dev/getProductOptions.mjs +239 -0
- package/dist/node-dev/getProductOptions.mjs.map +1 -0
- package/dist/node-dev/index.js +10 -0
- package/dist/node-dev/index.js.map +1 -1
- package/dist/node-dev/index.mjs +10 -0
- package/dist/node-dev/index.mjs.map +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.json.js +1 -1
- package/dist/node-dev/packages/hydrogen-react/package.json.mjs +1 -1
- package/dist/node-dev/tracking-utils.js +92 -0
- package/dist/node-dev/tracking-utils.js.map +1 -0
- package/dist/node-dev/tracking-utils.mjs +92 -0
- package/dist/node-dev/tracking-utils.mjs.map +1 -0
- package/dist/node-dev/useSelectedOptionInUrlParam.js +30 -0
- package/dist/node-dev/useSelectedOptionInUrlParam.js.map +1 -0
- package/dist/node-dev/useSelectedOptionInUrlParam.mjs +30 -0
- package/dist/node-dev/useSelectedOptionInUrlParam.mjs.map +1 -0
- package/dist/node-dev/useShopifyCookies.js +96 -7
- package/dist/node-dev/useShopifyCookies.js.map +1 -1
- package/dist/node-dev/useShopifyCookies.mjs +98 -9
- package/dist/node-dev/useShopifyCookies.mjs.map +1 -1
- package/dist/node-prod/AddToCartButton.js.map +1 -1
- package/dist/node-prod/AddToCartButton.mjs.map +1 -1
- package/dist/node-prod/BuyNowButton.js.map +1 -1
- package/dist/node-prod/BuyNowButton.mjs.map +1 -1
- package/dist/node-prod/CartCost.js.map +1 -1
- package/dist/node-prod/CartCost.mjs.map +1 -1
- package/dist/node-prod/CartProvider.js.map +1 -1
- package/dist/node-prod/CartProvider.mjs.map +1 -1
- package/dist/node-prod/ExternalVideo.js.map +1 -1
- package/dist/node-prod/ExternalVideo.mjs.map +1 -1
- package/dist/node-prod/ProductPrice.js.map +1 -1
- package/dist/node-prod/ProductPrice.mjs.map +1 -1
- package/dist/node-prod/RichText.js.map +1 -1
- package/dist/node-prod/RichText.mjs.map +1 -1
- package/dist/node-prod/ShopifyProvider.js +19 -1
- package/dist/node-prod/ShopifyProvider.js.map +1 -1
- package/dist/node-prod/ShopifyProvider.mjs +19 -1
- package/dist/node-prod/ShopifyProvider.mjs.map +1 -1
- package/dist/node-prod/analytics.js +4 -5
- package/dist/node-prod/analytics.js.map +1 -1
- package/dist/node-prod/analytics.mjs +4 -5
- package/dist/node-prod/analytics.mjs.map +1 -1
- package/dist/node-prod/cart-hooks.js +24 -6
- package/dist/node-prod/cart-hooks.js.map +1 -1
- package/dist/node-prod/cart-hooks.mjs +25 -7
- package/dist/node-prod/cart-hooks.mjs.map +1 -1
- package/dist/node-prod/cookies-utils.js +4 -4
- package/dist/node-prod/cookies-utils.js.map +1 -1
- package/dist/node-prod/cookies-utils.mjs +4 -4
- package/dist/node-prod/cookies-utils.mjs.map +1 -1
- package/dist/node-prod/getProductOptions.js +239 -0
- package/dist/node-prod/getProductOptions.js.map +1 -0
- package/dist/node-prod/getProductOptions.mjs +239 -0
- package/dist/node-prod/getProductOptions.mjs.map +1 -0
- package/dist/node-prod/index.js +10 -0
- package/dist/node-prod/index.js.map +1 -1
- package/dist/node-prod/index.mjs +10 -0
- package/dist/node-prod/index.mjs.map +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.json.js +1 -1
- package/dist/node-prod/packages/hydrogen-react/package.json.mjs +1 -1
- package/dist/node-prod/tracking-utils.js +92 -0
- package/dist/node-prod/tracking-utils.js.map +1 -0
- package/dist/node-prod/tracking-utils.mjs +92 -0
- package/dist/node-prod/tracking-utils.mjs.map +1 -0
- package/dist/node-prod/useSelectedOptionInUrlParam.js +30 -0
- package/dist/node-prod/useSelectedOptionInUrlParam.js.map +1 -0
- package/dist/node-prod/useSelectedOptionInUrlParam.mjs +30 -0
- package/dist/node-prod/useSelectedOptionInUrlParam.mjs.map +1 -0
- package/dist/node-prod/useShopifyCookies.js +96 -7
- package/dist/node-prod/useShopifyCookies.js.map +1 -1
- package/dist/node-prod/useShopifyCookies.mjs +98 -9
- package/dist/node-prod/useShopifyCookies.mjs.map +1 -1
- package/dist/types/CartProvider.d.ts +4 -3
- package/dist/types/ShopifyProvider.d.ts +5 -0
- package/dist/types/cookies-utils.d.ts +4 -0
- package/dist/types/getProductOptions.d.ts +49 -0
- package/dist/types/index.d.cts +3 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/storefront-api-response.types.d.ts +5 -5
- package/dist/types/tracking-utils.d.ts +22 -0
- package/dist/types/useSelectedOptionInUrlParam.d.ts +2 -0
- package/dist/types/useShopifyCookies.d.ts +28 -2
- package/dist/umd/hydrogen-react.dev.js +623 -175
- package/dist/umd/hydrogen-react.dev.js.map +1 -1
- package/dist/umd/hydrogen-react.prod.js +18 -18
- package/dist/umd/hydrogen-react.prod.js.map +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
import { isOptionValueCombinationInEncodedVariant } from "./optionValueDecoder.mjs";
|
|
2
|
+
function mapProductOptions(options) {
|
|
3
|
+
return options.map((option) => {
|
|
4
|
+
return Object.assign(
|
|
5
|
+
{},
|
|
6
|
+
...(option == null ? void 0 : option.optionValues) ? option.optionValues.map((value, index) => {
|
|
7
|
+
return { [value.name]: index };
|
|
8
|
+
}) : []
|
|
9
|
+
);
|
|
10
|
+
});
|
|
11
|
+
}
|
|
12
|
+
function mapSelectedProductOptionToObject(options) {
|
|
13
|
+
return Object.assign(
|
|
14
|
+
{},
|
|
15
|
+
...options.map((key) => {
|
|
16
|
+
return { [key.name]: key.value };
|
|
17
|
+
})
|
|
18
|
+
);
|
|
19
|
+
}
|
|
20
|
+
function mapSelectedProductOptionToObjectAsString(options) {
|
|
21
|
+
return JSON.stringify(mapSelectedProductOptionToObject(options));
|
|
22
|
+
}
|
|
23
|
+
function encodeSelectedProductOptionAsKey(selectedOption, productOptionMappings) {
|
|
24
|
+
if (Array.isArray(selectedOption)) {
|
|
25
|
+
return JSON.stringify(
|
|
26
|
+
selectedOption.map((key, index) => {
|
|
27
|
+
return productOptionMappings[index][key.value];
|
|
28
|
+
})
|
|
29
|
+
);
|
|
30
|
+
} else {
|
|
31
|
+
return JSON.stringify(
|
|
32
|
+
Object.keys(selectedOption).map((key, index) => {
|
|
33
|
+
return productOptionMappings[index][selectedOption[key]];
|
|
34
|
+
})
|
|
35
|
+
);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
function mapVariants(variants, productOptionMappings) {
|
|
39
|
+
return Object.assign(
|
|
40
|
+
{},
|
|
41
|
+
...variants.map((variant) => {
|
|
42
|
+
const variantKey = encodeSelectedProductOptionAsKey(
|
|
43
|
+
variant.selectedOptions || [],
|
|
44
|
+
productOptionMappings
|
|
45
|
+
);
|
|
46
|
+
return { [variantKey]: variant };
|
|
47
|
+
})
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
const PRODUCT_INPUTS = [
|
|
51
|
+
"options",
|
|
52
|
+
"selectedOrFirstAvailableVariant",
|
|
53
|
+
"adjacentVariants"
|
|
54
|
+
];
|
|
55
|
+
const PRODUCT_INPUTS_EXTRA = [
|
|
56
|
+
"handle",
|
|
57
|
+
"encodedVariantExistence",
|
|
58
|
+
"encodedVariantAvailability"
|
|
59
|
+
];
|
|
60
|
+
function logErrorAndReturnFalse(key) {
|
|
61
|
+
console.error(
|
|
62
|
+
`[h2:error:getProductOptions] product.${key} is missing. Make sure you query for this field from the Storefront API.`
|
|
63
|
+
);
|
|
64
|
+
return false;
|
|
65
|
+
}
|
|
66
|
+
function checkProductParam(product, checkAll = false) {
|
|
67
|
+
var _a;
|
|
68
|
+
let validParam = true;
|
|
69
|
+
const productKeys = Object.keys(product);
|
|
70
|
+
(checkAll ? [...PRODUCT_INPUTS, ...PRODUCT_INPUTS_EXTRA] : PRODUCT_INPUTS).forEach((key) => {
|
|
71
|
+
if (!productKeys.includes(key)) {
|
|
72
|
+
validParam = logErrorAndReturnFalse(key);
|
|
73
|
+
}
|
|
74
|
+
});
|
|
75
|
+
if (product.options) {
|
|
76
|
+
const firstOption = product == null ? void 0 : product.options[0];
|
|
77
|
+
if (checkAll && !(firstOption == null ? void 0 : firstOption.name)) {
|
|
78
|
+
validParam = logErrorAndReturnFalse("options.name");
|
|
79
|
+
}
|
|
80
|
+
if ((_a = product == null ? void 0 : product.options[0]) == null ? void 0 : _a.optionValues) {
|
|
81
|
+
const firstOptionValues = product.options[0].optionValues[0];
|
|
82
|
+
if (checkAll && !(firstOptionValues == null ? void 0 : firstOptionValues.name)) {
|
|
83
|
+
validParam = logErrorAndReturnFalse("options.optionValues.name");
|
|
84
|
+
}
|
|
85
|
+
if (firstOptionValues == null ? void 0 : firstOptionValues.firstSelectableVariant) {
|
|
86
|
+
validParam = checkProductVariantParam(
|
|
87
|
+
firstOptionValues.firstSelectableVariant,
|
|
88
|
+
"options.optionValues.firstSelectableVariant",
|
|
89
|
+
validParam,
|
|
90
|
+
checkAll
|
|
91
|
+
);
|
|
92
|
+
} else {
|
|
93
|
+
validParam = logErrorAndReturnFalse(
|
|
94
|
+
"options.optionValues.firstSelectableVariant"
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
} else {
|
|
98
|
+
validParam = logErrorAndReturnFalse("options.optionValues");
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
if (product.selectedOrFirstAvailableVariant) {
|
|
102
|
+
validParam = checkProductVariantParam(
|
|
103
|
+
product.selectedOrFirstAvailableVariant,
|
|
104
|
+
"selectedOrFirstAvailableVariant",
|
|
105
|
+
validParam,
|
|
106
|
+
checkAll
|
|
107
|
+
);
|
|
108
|
+
}
|
|
109
|
+
if (!!product.adjacentVariants && product.adjacentVariants[0]) {
|
|
110
|
+
validParam = checkProductVariantParam(
|
|
111
|
+
product.adjacentVariants[0],
|
|
112
|
+
"adjacentVariants",
|
|
113
|
+
validParam,
|
|
114
|
+
checkAll
|
|
115
|
+
);
|
|
116
|
+
}
|
|
117
|
+
return validParam ? product : {};
|
|
118
|
+
}
|
|
119
|
+
function checkProductVariantParam(variant, key, currentValidParamState, checkAll) {
|
|
120
|
+
var _a;
|
|
121
|
+
let validParam = currentValidParamState;
|
|
122
|
+
if (checkAll && !((_a = variant.product) == null ? void 0 : _a.handle)) {
|
|
123
|
+
validParam = logErrorAndReturnFalse(`${key}.product.handle`);
|
|
124
|
+
}
|
|
125
|
+
if (variant.selectedOptions) {
|
|
126
|
+
const firstSelectedOption = variant.selectedOptions[0];
|
|
127
|
+
if (!(firstSelectedOption == null ? void 0 : firstSelectedOption.name)) {
|
|
128
|
+
validParam = logErrorAndReturnFalse(`${key}.selectedOptions.name`);
|
|
129
|
+
}
|
|
130
|
+
if (!(firstSelectedOption == null ? void 0 : firstSelectedOption.value)) {
|
|
131
|
+
validParam = logErrorAndReturnFalse(`${key}.selectedOptions.value`);
|
|
132
|
+
}
|
|
133
|
+
} else {
|
|
134
|
+
validParam = logErrorAndReturnFalse(`${key}.selectedOptions`);
|
|
135
|
+
}
|
|
136
|
+
return validParam;
|
|
137
|
+
}
|
|
138
|
+
function getAdjacentAndFirstAvailableVariants(product) {
|
|
139
|
+
const checkedProduct = checkProductParam(product);
|
|
140
|
+
if (!checkedProduct.options)
|
|
141
|
+
return [];
|
|
142
|
+
const availableVariants = {};
|
|
143
|
+
checkedProduct.options.map((option) => {
|
|
144
|
+
var _a;
|
|
145
|
+
(_a = option.optionValues) == null ? void 0 : _a.map((value) => {
|
|
146
|
+
if (value.firstSelectableVariant) {
|
|
147
|
+
const variantKey = mapSelectedProductOptionToObjectAsString(
|
|
148
|
+
value.firstSelectableVariant.selectedOptions
|
|
149
|
+
);
|
|
150
|
+
availableVariants[variantKey] = value.firstSelectableVariant;
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
});
|
|
154
|
+
checkedProduct.adjacentVariants.map((variant) => {
|
|
155
|
+
const variantKey = mapSelectedProductOptionToObjectAsString(
|
|
156
|
+
variant.selectedOptions
|
|
157
|
+
);
|
|
158
|
+
availableVariants[variantKey] = variant;
|
|
159
|
+
});
|
|
160
|
+
const selectedVariant = checkedProduct.selectedOrFirstAvailableVariant;
|
|
161
|
+
if (selectedVariant) {
|
|
162
|
+
const variantKey = mapSelectedProductOptionToObjectAsString(
|
|
163
|
+
selectedVariant.selectedOptions
|
|
164
|
+
);
|
|
165
|
+
availableVariants[variantKey] = selectedVariant;
|
|
166
|
+
}
|
|
167
|
+
return Object.values(availableVariants);
|
|
168
|
+
}
|
|
169
|
+
function getProductOptions(product) {
|
|
170
|
+
const checkedProduct = checkProductParam(product, true);
|
|
171
|
+
if (!checkedProduct.options)
|
|
172
|
+
return [];
|
|
173
|
+
const {
|
|
174
|
+
options,
|
|
175
|
+
selectedOrFirstAvailableVariant: selectedVariant,
|
|
176
|
+
adjacentVariants,
|
|
177
|
+
encodedVariantExistence,
|
|
178
|
+
encodedVariantAvailability,
|
|
179
|
+
handle: productHandle
|
|
180
|
+
} = checkedProduct;
|
|
181
|
+
const productOptionMappings = mapProductOptions(options);
|
|
182
|
+
const variants = mapVariants(
|
|
183
|
+
selectedVariant ? [selectedVariant, ...adjacentVariants] : adjacentVariants,
|
|
184
|
+
productOptionMappings
|
|
185
|
+
);
|
|
186
|
+
const selectedOptions = mapSelectedProductOptionToObject(
|
|
187
|
+
selectedVariant ? selectedVariant.selectedOptions : []
|
|
188
|
+
);
|
|
189
|
+
const productOptions = options.map((option, optionIndex) => {
|
|
190
|
+
return {
|
|
191
|
+
...option,
|
|
192
|
+
optionValues: option.optionValues.map((value) => {
|
|
193
|
+
var _a;
|
|
194
|
+
const targetOptionParams = { ...selectedOptions };
|
|
195
|
+
targetOptionParams[option.name] = value.name;
|
|
196
|
+
const targetKey = encodeSelectedProductOptionAsKey(
|
|
197
|
+
targetOptionParams || [],
|
|
198
|
+
productOptionMappings
|
|
199
|
+
);
|
|
200
|
+
const topDownKey = JSON.parse(targetKey).slice(
|
|
201
|
+
0,
|
|
202
|
+
optionIndex + 1
|
|
203
|
+
);
|
|
204
|
+
const exists = isOptionValueCombinationInEncodedVariant(
|
|
205
|
+
topDownKey,
|
|
206
|
+
encodedVariantExistence || ""
|
|
207
|
+
);
|
|
208
|
+
const available = isOptionValueCombinationInEncodedVariant(
|
|
209
|
+
topDownKey,
|
|
210
|
+
encodedVariantAvailability || ""
|
|
211
|
+
);
|
|
212
|
+
const variant = variants[targetKey] || value.firstSelectableVariant;
|
|
213
|
+
const variantOptionParam = mapSelectedProductOptionToObject(
|
|
214
|
+
variant.selectedOptions || []
|
|
215
|
+
);
|
|
216
|
+
const searchParams = new URLSearchParams(variantOptionParam);
|
|
217
|
+
const handle = (_a = variant == null ? void 0 : variant.product) == null ? void 0 : _a.handle;
|
|
218
|
+
return {
|
|
219
|
+
...value,
|
|
220
|
+
variant,
|
|
221
|
+
handle,
|
|
222
|
+
variantUriQuery: searchParams.toString(),
|
|
223
|
+
selected: selectedOptions[option.name] === value.name,
|
|
224
|
+
exists,
|
|
225
|
+
available,
|
|
226
|
+
isDifferentProduct: handle !== productHandle
|
|
227
|
+
};
|
|
228
|
+
})
|
|
229
|
+
};
|
|
230
|
+
});
|
|
231
|
+
return productOptions;
|
|
232
|
+
}
|
|
233
|
+
export {
|
|
234
|
+
checkProductParam,
|
|
235
|
+
getAdjacentAndFirstAvailableVariants,
|
|
236
|
+
getProductOptions,
|
|
237
|
+
mapSelectedProductOptionToObject
|
|
238
|
+
};
|
|
239
|
+
//# sourceMappingURL=getProductOptions.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getProductOptions.mjs","sources":["../../src/getProductOptions.ts"],"sourcesContent":["import {isOptionValueCombinationInEncodedVariant} from './optionValueDecoder.js';\nimport type {\n Product,\n ProductOption,\n ProductOptionValue,\n ProductVariant,\n SelectedOption,\n} from './storefront-api-types';\n\nexport type RecursivePartial<T> = {\n [P in keyof T]?: RecursivePartial<T[P]>;\n};\ntype ProductOptionsMapping = Record<string, number>;\ntype ProductOptionValueState = {\n variant: ProductVariant;\n handle: string;\n variantUriQuery: string;\n selected: boolean;\n exists: boolean;\n available: boolean;\n isDifferentProduct: boolean;\n};\ntype MappedProductOptionValue = ProductOptionValue & ProductOptionValueState;\n\n/**\n * Creates a mapping of product options to their index for matching encoded values\n * For example, a product option of\n * [\n * \\{\n * name: 'Color',\n * optionValues: [\\{name: 'Red'\\}, \\{name: 'Blue'\\}]\n * \\},\n * \\{\n * name: 'Size',\n * optionValues: [\\{name: 'Small'\\}, \\{name: 'Medium'\\}, \\{name: 'Large'\\}]\n * \\}\n * ]\n * Would return\n * [\n * \\{Red: 0, Blue: 1\\},\n * \\{Small: 0, Medium: 1, Large: 2\\}\n * ]\n */\nfunction mapProductOptions(options: ProductOption[]): ProductOptionsMapping[] {\n return options.map((option: ProductOption) => {\n return Object.assign(\n {},\n ...(option?.optionValues\n ? option.optionValues.map((value, index) => {\n return {[value.name]: index};\n })\n : []),\n ) as ProductOptionsMapping;\n });\n}\n\n/**\n * Converts the product option into an Object\\<key, value\\> for building query params\n * For example, a selected product option of\n * [\n * \\{\n * name: 'Color',\n * value: 'Red',\n * \\},\n * \\{\n * name: 'Size',\n * value: 'Medium',\n * \\}\n * ]\n * Would return\n * \\{\n * Color: 'Red',\n * Size: 'Medium',\n * \\}\n */\nexport function mapSelectedProductOptionToObject(\n options: Pick<SelectedOption, 'name' | 'value'>[],\n): Record<string, string> {\n return Object.assign(\n {},\n ...options.map((key) => {\n return {[key.name]: key.value};\n }),\n ) as Record<string, string>;\n}\n\n/**\n * Returns the JSON stringify result of mapSelectedProductOptionToObject\n */\nfunction mapSelectedProductOptionToObjectAsString(\n options: Pick<SelectedOption, 'name' | 'value'>[],\n): string {\n return JSON.stringify(mapSelectedProductOptionToObject(options));\n}\n\n/**\n * Encode the selected product option as a key for mapping to the encoded variants\n * For example, a selected product option of\n * [\n * \\{\n * name: 'Color',\n * value: 'Red',\n * \\},\n * \\{\n * name: 'Size',\n * value: 'Medium',\n * \\}\n * ]\n * Would return\n * [0,1]\n *\n * Also works with the result of mapSelectedProductOption. For example:\n * \\{\n * Color: 'Red',\n * Size: 'Medium',\n * \\}\n * Would return\n * [0,1]\n *\n * @param selectedOption - The selected product option\n * @param productOptionMappings - The result of product option mapping from mapProductOptions\n * @returns\n */\nfunction encodeSelectedProductOptionAsKey(\n selectedOption:\n | Pick<SelectedOption, 'name' | 'value'>[]\n | Record<string, string>,\n productOptionMappings: ProductOptionsMapping[],\n): string {\n if (Array.isArray(selectedOption)) {\n return JSON.stringify(\n selectedOption.map((key, index) => {\n return productOptionMappings[index][key.value];\n }),\n );\n } else {\n return JSON.stringify(\n Object.keys(selectedOption).map((key, index) => {\n return productOptionMappings[index][selectedOption[key]];\n }),\n );\n }\n}\n\n/**\n * Takes an array of product variants and maps them to an object with the encoded selected option values as the key.\n * For example, a product variant of\n * [\n * \\{\n * id: 1,\n * selectedOptions: [\n * \\{name: 'Color', value: 'Red'\\},\n * \\{name: 'Size', value: 'Small'\\},\n * ],\n * \\},\n * \\{\n * id: 2,\n * selectedOptions: [\n * \\{name: 'Color', value: 'Red'\\},\n * \\{name: 'Size', value: 'Medium'\\},\n * ],\n * \\}\n * ]\n * Would return\n * \\{\n * '[0,0]': \\{id: 1, selectedOptions: [\\{name: 'Color', value: 'Red'\\}, \\{name: 'Size', value: 'Small'\\}]\\},\n * '[0,1]': \\{id: 2, selectedOptions: [\\{name: 'Color', value: 'Red'\\}, \\{name: 'Size', value: 'Medium'\\}]\\},\n * \\}\n */\nfunction mapVariants(\n variants: ProductVariant[],\n productOptionMappings: ProductOptionsMapping[],\n): Record<string, ProductVariant> {\n return Object.assign(\n {},\n ...variants.map((variant) => {\n const variantKey = encodeSelectedProductOptionAsKey(\n variant.selectedOptions || [],\n productOptionMappings,\n );\n return {[variantKey]: variant};\n }),\n ) as Record<string, ProductVariant>;\n}\n\nexport type MappedProductOptions = Omit<ProductOption, 'optionValues'> & {\n optionValues: MappedProductOptionValue[];\n};\n\nconst PRODUCT_INPUTS = [\n 'options',\n 'selectedOrFirstAvailableVariant',\n 'adjacentVariants',\n];\n\nconst PRODUCT_INPUTS_EXTRA = [\n 'handle',\n 'encodedVariantExistence',\n 'encodedVariantAvailability',\n];\n\nfunction logErrorAndReturnFalse(key: string): boolean {\n console.error(\n `[h2:error:getProductOptions] product.${key} is missing. Make sure you query for this field from the Storefront API.`,\n );\n return false;\n}\n\nexport function checkProductParam(\n product: RecursivePartial<Product>,\n checkAll = false,\n): Product {\n let validParam = true;\n const productKeys = Object.keys(product);\n\n // Check product input\n (checkAll\n ? [...PRODUCT_INPUTS, ...PRODUCT_INPUTS_EXTRA]\n : PRODUCT_INPUTS\n ).forEach((key) => {\n if (!productKeys.includes(key)) {\n validParam = logErrorAndReturnFalse(key);\n }\n });\n\n // Check for nested options requirements\n if (product.options) {\n const firstOption = product?.options[0];\n\n if (checkAll && !firstOption?.name) {\n validParam = logErrorAndReturnFalse('options.name');\n }\n\n // Check for options.optionValues\n if (product?.options[0]?.optionValues) {\n const firstOptionValues = product.options[0].optionValues[0];\n\n // Check for options.optionValues.name\n if (checkAll && !firstOptionValues?.name) {\n validParam = logErrorAndReturnFalse('options.optionValues.name');\n }\n\n // Check for options.optionValues.firstSelectableVariant\n if (firstOptionValues?.firstSelectableVariant) {\n // check product variant\n validParam = checkProductVariantParam(\n firstOptionValues.firstSelectableVariant,\n 'options.optionValues.firstSelectableVariant',\n validParam,\n checkAll,\n );\n } else {\n validParam = logErrorAndReturnFalse(\n 'options.optionValues.firstSelectableVariant',\n );\n }\n } else {\n validParam = logErrorAndReturnFalse('options.optionValues');\n }\n }\n\n // Check for nested selectedOrFirstAvailableVariant requirements\n if (product.selectedOrFirstAvailableVariant) {\n validParam = checkProductVariantParam(\n product.selectedOrFirstAvailableVariant,\n 'selectedOrFirstAvailableVariant',\n validParam,\n checkAll,\n );\n }\n\n // Check for nested adjacentVariants requirements\n if (!!product.adjacentVariants && product.adjacentVariants[0]) {\n validParam = checkProductVariantParam(\n product.adjacentVariants[0],\n 'adjacentVariants',\n validParam,\n checkAll,\n );\n }\n\n return (validParam ? product : {}) as Product;\n}\n\nfunction checkProductVariantParam(\n variant: RecursivePartial<ProductVariant>,\n key: string,\n currentValidParamState: boolean,\n checkAll: boolean,\n): boolean {\n let validParam = currentValidParamState;\n\n if (checkAll && !variant.product?.handle) {\n validParam = logErrorAndReturnFalse(`${key}.product.handle`);\n }\n if (variant.selectedOptions) {\n const firstSelectedOption = variant.selectedOptions[0];\n if (!firstSelectedOption?.name) {\n validParam = logErrorAndReturnFalse(`${key}.selectedOptions.name`);\n }\n if (!firstSelectedOption?.value) {\n validParam = logErrorAndReturnFalse(`${key}.selectedOptions.value`);\n }\n } else {\n validParam = logErrorAndReturnFalse(`${key}.selectedOptions`);\n }\n\n return validParam;\n}\n\n/**\n * Finds all the variants provided by adjacentVariants, options.optionValues.firstAvailableVariant,\n * and selectedOrFirstAvailableVariant and return them in a single array\n */\nexport function getAdjacentAndFirstAvailableVariants(\n product: RecursivePartial<Product>,\n): ProductVariant[] {\n // Checks for valid product input\n const checkedProduct = checkProductParam(product);\n\n if (!checkedProduct.options) return [];\n\n const availableVariants: Record<string, ProductVariant> = {};\n checkedProduct.options.map((option) => {\n option.optionValues?.map((value) => {\n if (value.firstSelectableVariant) {\n const variantKey = mapSelectedProductOptionToObjectAsString(\n value.firstSelectableVariant.selectedOptions,\n );\n availableVariants[variantKey] = value.firstSelectableVariant;\n }\n });\n });\n\n checkedProduct.adjacentVariants.map((variant) => {\n const variantKey = mapSelectedProductOptionToObjectAsString(\n variant.selectedOptions,\n );\n availableVariants[variantKey] = variant;\n });\n\n const selectedVariant = checkedProduct.selectedOrFirstAvailableVariant;\n if (selectedVariant) {\n const variantKey = mapSelectedProductOptionToObjectAsString(\n selectedVariant.selectedOptions,\n );\n availableVariants[variantKey] = selectedVariant;\n }\n\n return Object.values(availableVariants);\n}\n\n/**\n * Returns a product options array with its relevant information\n * about the variant\n */\nexport function getProductOptions(\n product: RecursivePartial<Product>,\n): MappedProductOptions[] {\n // Checks for valid product input\n const checkedProduct = checkProductParam(product, true);\n\n if (!checkedProduct.options) return [];\n\n const {\n options,\n selectedOrFirstAvailableVariant: selectedVariant,\n adjacentVariants,\n encodedVariantExistence,\n encodedVariantAvailability,\n handle: productHandle,\n } = checkedProduct;\n // Get a mapping of product option names to their index for matching encoded values\n const productOptionMappings = mapProductOptions(options);\n\n // Get the adjacent variants mapped to the encoded selected option values\n const variants = mapVariants(\n selectedVariant ? [selectedVariant, ...adjacentVariants] : adjacentVariants,\n productOptionMappings,\n );\n\n // Get the key:value version of selected options for building url query params\n const selectedOptions = mapSelectedProductOptionToObject(\n selectedVariant ? selectedVariant.selectedOptions : [],\n );\n\n const productOptions = options.map((option, optionIndex) => {\n return {\n ...option,\n optionValues: option.optionValues.map((value) => {\n const targetOptionParams = {...selectedOptions}; // Clones the selected options\n\n // Modify the selected option value to the current option value\n targetOptionParams[option.name] = value.name;\n\n // Encode the new selected option values as a key for mapping to the product variants\n const targetKey = encodeSelectedProductOptionAsKey(\n targetOptionParams || [],\n productOptionMappings,\n );\n\n // Top-down option check for existence and availability\n const topDownKey = (JSON.parse(targetKey) as number[]).slice(\n 0,\n optionIndex + 1,\n );\n const exists = isOptionValueCombinationInEncodedVariant(\n topDownKey,\n encodedVariantExistence || '',\n );\n const available = isOptionValueCombinationInEncodedVariant(\n topDownKey,\n encodedVariantAvailability || '',\n );\n\n // Get the variant for the current option value if exists, else use the first selectable variant\n const variant: ProductVariant =\n variants[targetKey] || value.firstSelectableVariant;\n\n // Build the query params for this option value\n const variantOptionParam = mapSelectedProductOptionToObject(\n variant.selectedOptions || [],\n );\n const searchParams = new URLSearchParams(variantOptionParam);\n const handle = variant?.product?.handle;\n\n return {\n ...value,\n variant,\n handle,\n variantUriQuery: searchParams.toString(),\n selected: selectedOptions[option.name] === value.name,\n exists,\n available,\n isDifferentProduct: handle !== productHandle,\n };\n }),\n };\n });\n\n return productOptions;\n}\n"],"names":[],"mappings":";AA2CA,SAAS,kBAAkB,SAAmD;AACrE,SAAA,QAAQ,IAAI,CAAC,WAA0B;AAC5C,WAAO,OAAO;AAAA,MACZ,CAAC;AAAA,MACD,IAAI,iCAAQ,gBACR,OAAO,aAAa,IAAI,CAAC,OAAO,UAAU;AACxC,eAAO,EAAC,CAAC,MAAM,IAAI,GAAG,MAAK;AAAA,MAC5B,CAAA,IACD,CAAC;AAAA,IAAA;AAAA,EACP,CACD;AACH;AAqBO,SAAS,iCACd,SACwB;AACxB,SAAO,OAAO;AAAA,IACZ,CAAC;AAAA,IACD,GAAG,QAAQ,IAAI,CAAC,QAAQ;AACtB,aAAO,EAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAK;AAAA,IAAA,CAC9B;AAAA,EAAA;AAEL;AAKA,SAAS,yCACP,SACQ;AACR,SAAO,KAAK,UAAU,iCAAiC,OAAO,CAAC;AACjE;AA8BA,SAAS,iCACP,gBAGA,uBACQ;AACJ,MAAA,MAAM,QAAQ,cAAc,GAAG;AACjC,WAAO,KAAK;AAAA,MACV,eAAe,IAAI,CAAC,KAAK,UAAU;AACjC,eAAO,sBAAsB,KAAK,EAAE,IAAI,KAAK;AAAA,MAAA,CAC9C;AAAA,IAAA;AAAA,EACH,OACK;AACL,WAAO,KAAK;AAAA,MACV,OAAO,KAAK,cAAc,EAAE,IAAI,CAAC,KAAK,UAAU;AAC9C,eAAO,sBAAsB,KAAK,EAAE,eAAe,GAAG,CAAC;AAAA,MAAA,CACxD;AAAA,IAAA;AAAA,EAEL;AACF;AA2BA,SAAS,YACP,UACA,uBACgC;AAChC,SAAO,OAAO;AAAA,IACZ,CAAC;AAAA,IACD,GAAG,SAAS,IAAI,CAAC,YAAY;AAC3B,YAAM,aAAa;AAAA,QACjB,QAAQ,mBAAmB,CAAC;AAAA,QAC5B;AAAA,MAAA;AAEF,aAAO,EAAC,CAAC,UAAU,GAAG;IAAO,CAC9B;AAAA,EAAA;AAEL;AAMA,MAAM,iBAAiB;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AACF;AAEA,MAAM,uBAAuB;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AACF;AAEA,SAAS,uBAAuB,KAAsB;AAC5C,UAAA;AAAA,IACN,wCAAwC,GAAG;AAAA,EAAA;AAEtC,SAAA;AACT;AAEgB,SAAA,kBACd,SACA,WAAW,OACF;;AACT,MAAI,aAAa;AACX,QAAA,cAAc,OAAO,KAAK,OAAO;AAGtC,GAAA,WACG,CAAC,GAAG,gBAAgB,GAAG,oBAAoB,IAC3C,gBACF,QAAQ,CAAC,QAAQ;AACjB,QAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,mBAAa,uBAAuB,GAAG;AAAA,IACzC;AAAA,EAAA,CACD;AAGD,MAAI,QAAQ,SAAS;AACb,UAAA,cAAc,mCAAS,QAAQ;AAEjC,QAAA,YAAY,EAAC,2CAAa,OAAM;AAClC,mBAAa,uBAAuB,cAAc;AAAA,IACpD;AAGA,SAAI,wCAAS,QAAQ,OAAjB,mBAAqB,cAAc;AACrC,YAAM,oBAAoB,QAAQ,QAAQ,CAAC,EAAE,aAAa,CAAC;AAGvD,UAAA,YAAY,EAAC,uDAAmB,OAAM;AACxC,qBAAa,uBAAuB,2BAA2B;AAAA,MACjE;AAGA,UAAI,uDAAmB,wBAAwB;AAEhC,qBAAA;AAAA,UACX,kBAAkB;AAAA,UAClB;AAAA,UACA;AAAA,UACA;AAAA,QAAA;AAAA,MACF,OACK;AACQ,qBAAA;AAAA,UACX;AAAA,QAAA;AAAA,MAEJ;AAAA,IAAA,OACK;AACL,mBAAa,uBAAuB,sBAAsB;AAAA,IAC5D;AAAA,EACF;AAGA,MAAI,QAAQ,iCAAiC;AAC9B,iBAAA;AAAA,MACX,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAGA,MAAI,CAAC,CAAC,QAAQ,oBAAoB,QAAQ,iBAAiB,CAAC,GAAG;AAChD,iBAAA;AAAA,MACX,QAAQ,iBAAiB,CAAC;AAAA,MAC1B;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAEQ,SAAA,aAAa,UAAU;AACjC;AAEA,SAAS,yBACP,SACA,KACA,wBACA,UACS;;AACT,MAAI,aAAa;AAEjB,MAAI,YAAY,GAAC,aAAQ,YAAR,mBAAiB,SAAQ;AAC3B,iBAAA,uBAAuB,GAAG,GAAG,iBAAiB;AAAA,EAC7D;AACA,MAAI,QAAQ,iBAAiB;AACrB,UAAA,sBAAsB,QAAQ,gBAAgB,CAAC;AACjD,QAAA,EAAC,2DAAqB,OAAM;AACjB,mBAAA,uBAAuB,GAAG,GAAG,uBAAuB;AAAA,IACnE;AACI,QAAA,EAAC,2DAAqB,QAAO;AAClB,mBAAA,uBAAuB,GAAG,GAAG,wBAAwB;AAAA,IACpE;AAAA,EAAA,OACK;AACQ,iBAAA,uBAAuB,GAAG,GAAG,kBAAkB;AAAA,EAC9D;AAEO,SAAA;AACT;AAMO,SAAS,qCACd,SACkB;AAEZ,QAAA,iBAAiB,kBAAkB,OAAO;AAEhD,MAAI,CAAC,eAAe;AAAS,WAAO;AAEpC,QAAM,oBAAoD,CAAA;AAC3C,iBAAA,QAAQ,IAAI,CAAC,WAAW;;AAC9B,iBAAA,iBAAA,mBAAc,IAAI,CAAC,UAAU;AAClC,UAAI,MAAM,wBAAwB;AAChC,cAAM,aAAa;AAAA,UACjB,MAAM,uBAAuB;AAAA,QAAA;AAEb,0BAAA,UAAU,IAAI,MAAM;AAAA,MACxC;AAAA,IAAA;AAAA,EACD,CACF;AAEc,iBAAA,iBAAiB,IAAI,CAAC,YAAY;AAC/C,UAAM,aAAa;AAAA,MACjB,QAAQ;AAAA,IAAA;AAEV,sBAAkB,UAAU,IAAI;AAAA,EAAA,CACjC;AAED,QAAM,kBAAkB,eAAe;AACvC,MAAI,iBAAiB;AACnB,UAAM,aAAa;AAAA,MACjB,gBAAgB;AAAA,IAAA;AAElB,sBAAkB,UAAU,IAAI;AAAA,EAClC;AAEO,SAAA,OAAO,OAAO,iBAAiB;AACxC;AAMO,SAAS,kBACd,SACwB;AAElB,QAAA,iBAAiB,kBAAkB,SAAS,IAAI;AAEtD,MAAI,CAAC,eAAe;AAAS,WAAO;AAE9B,QAAA;AAAA,IACJ;AAAA,IACA,iCAAiC;AAAA,IACjC;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,EACN,IAAA;AAEE,QAAA,wBAAwB,kBAAkB,OAAO;AAGvD,QAAM,WAAW;AAAA,IACf,kBAAkB,CAAC,iBAAiB,GAAG,gBAAgB,IAAI;AAAA,IAC3D;AAAA,EAAA;AAIF,QAAM,kBAAkB;AAAA,IACtB,kBAAkB,gBAAgB,kBAAkB,CAAC;AAAA,EAAA;AAGvD,QAAM,iBAAiB,QAAQ,IAAI,CAAC,QAAQ,gBAAgB;AACnD,WAAA;AAAA,MACL,GAAG;AAAA,MACH,cAAc,OAAO,aAAa,IAAI,CAAC,UAAU;;AACzC,cAAA,qBAAqB,EAAC,GAAG;AAGZ,2BAAA,OAAO,IAAI,IAAI,MAAM;AAGxC,cAAM,YAAY;AAAA,UAChB,sBAAsB,CAAC;AAAA,UACvB;AAAA,QAAA;AAIF,cAAM,aAAc,KAAK,MAAM,SAAS,EAAe;AAAA,UACrD;AAAA,UACA,cAAc;AAAA,QAAA;AAEhB,cAAM,SAAS;AAAA,UACb;AAAA,UACA,2BAA2B;AAAA,QAAA;AAE7B,cAAM,YAAY;AAAA,UAChB;AAAA,UACA,8BAA8B;AAAA,QAAA;AAIhC,cAAM,UACJ,SAAS,SAAS,KAAK,MAAM;AAG/B,cAAM,qBAAqB;AAAA,UACzB,QAAQ,mBAAmB,CAAC;AAAA,QAAA;AAExB,cAAA,eAAe,IAAI,gBAAgB,kBAAkB;AACrD,cAAA,UAAS,wCAAS,YAAT,mBAAkB;AAE1B,eAAA;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,UACA,iBAAiB,aAAa,SAAS;AAAA,UACvC,UAAU,gBAAgB,OAAO,IAAI,MAAM,MAAM;AAAA,UACjD;AAAA,UACA;AAAA,UACA,oBAAoB,WAAW;AAAA,QAAA;AAAA,MACjC,CACD;AAAA,IAAA;AAAA,EACH,CACD;AAEM,SAAA;AACT;"}
|
package/dist/node-dev/index.js
CHANGED
|
@@ -16,6 +16,7 @@ const codegen_helpers = require("./codegen.helpers.js");
|
|
|
16
16
|
const cookiesUtils = require("./cookies-utils.js");
|
|
17
17
|
const ExternalVideo = require("./ExternalVideo.js");
|
|
18
18
|
const flattenConnection = require("./flatten-connection.js");
|
|
19
|
+
const getProductOptions = require("./getProductOptions.js");
|
|
19
20
|
const Image = require("./Image.js");
|
|
20
21
|
const loadScript = require("./load-script.js");
|
|
21
22
|
const MediaFile = require("./MediaFile.js");
|
|
@@ -29,7 +30,9 @@ const RichText = require("./RichText.js");
|
|
|
29
30
|
const ShopifyProvider = require("./ShopifyProvider.js");
|
|
30
31
|
const ShopPayButton = require("./ShopPayButton.js");
|
|
31
32
|
const storefrontClient = require("./storefront-client.js");
|
|
33
|
+
const trackingUtils = require("./tracking-utils.js");
|
|
32
34
|
const useMoney = require("./useMoney.js");
|
|
35
|
+
const useSelectedOptionInUrlParam = require("./useSelectedOptionInUrlParam.js");
|
|
33
36
|
const useShopifyCookies = require("./useShopifyCookies.js");
|
|
34
37
|
const Video = require("./Video.js");
|
|
35
38
|
exports.AddToCartButton = AddToCartButton.AddToCartButton;
|
|
@@ -58,6 +61,9 @@ exports.storefrontApiCustomScalars = codegen_helpers.storefrontApiCustomScalars;
|
|
|
58
61
|
exports.getShopifyCookies = cookiesUtils.getShopifyCookies;
|
|
59
62
|
exports.ExternalVideo = ExternalVideo.ExternalVideo;
|
|
60
63
|
exports.flattenConnection = flattenConnection.flattenConnection;
|
|
64
|
+
exports.getAdjacentAndFirstAvailableVariants = getProductOptions.getAdjacentAndFirstAvailableVariants;
|
|
65
|
+
exports.getProductOptions = getProductOptions.getProductOptions;
|
|
66
|
+
exports.mapSelectedProductOptionToObject = getProductOptions.mapSelectedProductOptionToObject;
|
|
61
67
|
exports.IMAGE_FRAGMENT = Image.IMAGE_FRAGMENT;
|
|
62
68
|
exports.Image = Image.Image;
|
|
63
69
|
exports.useLoadScript = loadScript.useLoadScript;
|
|
@@ -75,7 +81,11 @@ exports.ShopifyProvider = ShopifyProvider.ShopifyProvider;
|
|
|
75
81
|
exports.useShop = ShopifyProvider.useShop;
|
|
76
82
|
exports.ShopPayButton = ShopPayButton.ShopPayButton;
|
|
77
83
|
exports.createStorefrontClient = storefrontClient.createStorefrontClient;
|
|
84
|
+
exports.SHOPIFY_UNIQUE_TOKEN_HEADER = trackingUtils.SHOPIFY_UNIQUE_TOKEN_HEADER;
|
|
85
|
+
exports.SHOPIFY_VISIT_TOKEN_HEADER = trackingUtils.SHOPIFY_VISIT_TOKEN_HEADER;
|
|
86
|
+
exports.getTrackingValues = trackingUtils.getTrackingValues;
|
|
78
87
|
exports.useMoney = useMoney.useMoney;
|
|
88
|
+
exports.useSelectedOptionInUrlParam = useSelectedOptionInUrlParam.useSelectedOptionInUrlParam;
|
|
79
89
|
exports.useShopifyCookies = useShopifyCookies.useShopifyCookies;
|
|
80
90
|
exports.Video = Video.Video;
|
|
81
91
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/dist/node-dev/index.mjs
CHANGED
|
@@ -14,6 +14,7 @@ import { customerAccountApiCustomScalars, storefrontApiCustomScalars } from "./c
|
|
|
14
14
|
import { getShopifyCookies } from "./cookies-utils.mjs";
|
|
15
15
|
import { ExternalVideo } from "./ExternalVideo.mjs";
|
|
16
16
|
import { flattenConnection } from "./flatten-connection.mjs";
|
|
17
|
+
import { getAdjacentAndFirstAvailableVariants, getProductOptions, mapSelectedProductOptionToObject } from "./getProductOptions.mjs";
|
|
17
18
|
import { IMAGE_FRAGMENT, Image } from "./Image.mjs";
|
|
18
19
|
import { useLoadScript } from "./load-script.mjs";
|
|
19
20
|
import { MediaFile } from "./MediaFile.mjs";
|
|
@@ -27,7 +28,9 @@ import { RichText } from "./RichText.mjs";
|
|
|
27
28
|
import { ShopifyProvider, useShop } from "./ShopifyProvider.mjs";
|
|
28
29
|
import { ShopPayButton } from "./ShopPayButton.mjs";
|
|
29
30
|
import { createStorefrontClient } from "./storefront-client.mjs";
|
|
31
|
+
import { SHOPIFY_UNIQUE_TOKEN_HEADER, SHOPIFY_VISIT_TOKEN_HEADER, getTrackingValues } from "./tracking-utils.mjs";
|
|
30
32
|
import { useMoney } from "./useMoney.mjs";
|
|
33
|
+
import { useSelectedOptionInUrlParam } from "./useSelectedOptionInUrlParam.mjs";
|
|
31
34
|
import { useShopifyCookies } from "./useShopifyCookies.mjs";
|
|
32
35
|
import { Video } from "./Video.mjs";
|
|
33
36
|
export {
|
|
@@ -54,6 +57,8 @@ export {
|
|
|
54
57
|
SHOPIFY_STOREFRONT_ID_HEADER,
|
|
55
58
|
SHOPIFY_STOREFRONT_S_HEADER,
|
|
56
59
|
SHOPIFY_STOREFRONT_Y_HEADER,
|
|
60
|
+
SHOPIFY_UNIQUE_TOKEN_HEADER,
|
|
61
|
+
SHOPIFY_VISIT_TOKEN_HEADER,
|
|
57
62
|
SHOPIFY_Y,
|
|
58
63
|
ShopPayButton,
|
|
59
64
|
ShopifyProvider,
|
|
@@ -63,9 +68,13 @@ export {
|
|
|
63
68
|
customerAccountApiCustomScalars,
|
|
64
69
|
decodeEncodedVariant,
|
|
65
70
|
flattenConnection,
|
|
71
|
+
getAdjacentAndFirstAvailableVariants,
|
|
66
72
|
getClientBrowserParameters,
|
|
73
|
+
getProductOptions,
|
|
67
74
|
getShopifyCookies,
|
|
75
|
+
getTrackingValues,
|
|
68
76
|
isOptionValueCombinationInEncodedVariant,
|
|
77
|
+
mapSelectedProductOptionToObject,
|
|
69
78
|
parseGid,
|
|
70
79
|
parseMetafield,
|
|
71
80
|
sendShopifyAnalytics,
|
|
@@ -75,6 +84,7 @@ export {
|
|
|
75
84
|
useLoadScript,
|
|
76
85
|
useMoney,
|
|
77
86
|
useProduct,
|
|
87
|
+
useSelectedOptionInUrlParam,
|
|
78
88
|
useShop,
|
|
79
89
|
useShopifyCookies
|
|
80
90
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
+
const SHOPIFY_VISIT_TOKEN_HEADER = "X-Shopify-VisitToken";
|
|
4
|
+
const SHOPIFY_UNIQUE_TOKEN_HEADER = "X-Shopify-UniqueToken";
|
|
5
|
+
const cachedTrackingValues = { current: null };
|
|
6
|
+
function getTrackingValues(cookieString) {
|
|
7
|
+
var _a, _b, _c;
|
|
8
|
+
let trackingValues;
|
|
9
|
+
if (typeof window !== "undefined" && typeof window.performance !== "undefined") {
|
|
10
|
+
try {
|
|
11
|
+
const resourceRE = /^https?:\/\/([^/]+)(\/api\/(?:unstable|2\d{3}-\d{2})\/graphql\.json(?=$|\?))?/;
|
|
12
|
+
const entries = performance.getEntriesByType(
|
|
13
|
+
"resource"
|
|
14
|
+
);
|
|
15
|
+
let matchedValues;
|
|
16
|
+
for (let i = entries.length - 1; i >= 0; i--) {
|
|
17
|
+
const entry = entries[i];
|
|
18
|
+
if (entry.initiatorType !== "fetch")
|
|
19
|
+
continue;
|
|
20
|
+
const currentHost = window.location.host;
|
|
21
|
+
const match = entry.name.match(resourceRE);
|
|
22
|
+
if (!match)
|
|
23
|
+
continue;
|
|
24
|
+
const [, matchedHost, sfapiPath] = match;
|
|
25
|
+
const isMatch = (
|
|
26
|
+
// Same origin (exact host match)
|
|
27
|
+
matchedHost === currentHost || // Subdomain with SFAPI path
|
|
28
|
+
sfapiPath && (matchedHost == null ? void 0 : matchedHost.endsWith(`.${currentHost}`))
|
|
29
|
+
);
|
|
30
|
+
if (isMatch) {
|
|
31
|
+
const values = extractFromPerformanceEntry(entry);
|
|
32
|
+
if (values) {
|
|
33
|
+
matchedValues = values;
|
|
34
|
+
break;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
if (matchedValues) {
|
|
39
|
+
trackingValues = matchedValues;
|
|
40
|
+
}
|
|
41
|
+
if (trackingValues) {
|
|
42
|
+
cachedTrackingValues.current = trackingValues;
|
|
43
|
+
} else if (cachedTrackingValues.current) {
|
|
44
|
+
trackingValues = cachedTrackingValues.current;
|
|
45
|
+
}
|
|
46
|
+
if (!trackingValues) {
|
|
47
|
+
const navigationEntries = performance.getEntriesByType(
|
|
48
|
+
"navigation"
|
|
49
|
+
)[0];
|
|
50
|
+
trackingValues = extractFromPerformanceEntry(navigationEntries, false);
|
|
51
|
+
}
|
|
52
|
+
} catch {
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
if (!trackingValues) {
|
|
56
|
+
const cookie = typeof cookieString === "string" ? cookieString : typeof document !== "undefined" ? document.cookie : "";
|
|
57
|
+
trackingValues = {
|
|
58
|
+
uniqueToken: ((_a = cookie.match(/\b_shopify_y=([^;]+)/)) == null ? void 0 : _a[1]) || "",
|
|
59
|
+
visitToken: ((_b = cookie.match(/\b_shopify_s=([^;]+)/)) == null ? void 0 : _b[1]) || "",
|
|
60
|
+
consent: ((_c = cookie.match(/\b_tracking_consent=([^;]+)/)) == null ? void 0 : _c[1]) || ""
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
return trackingValues;
|
|
64
|
+
}
|
|
65
|
+
function extractFromPerformanceEntry(entry, isConsentRequired = true) {
|
|
66
|
+
let uniqueToken = "";
|
|
67
|
+
let visitToken = "";
|
|
68
|
+
let consent = "";
|
|
69
|
+
const serverTiming = entry.serverTiming;
|
|
70
|
+
if (serverTiming && serverTiming.length >= 3) {
|
|
71
|
+
for (let i = serverTiming.length - 1; i >= 0; i--) {
|
|
72
|
+
const { name, description } = serverTiming[i];
|
|
73
|
+
if (!name || !description)
|
|
74
|
+
continue;
|
|
75
|
+
if (name === "_y") {
|
|
76
|
+
uniqueToken = description;
|
|
77
|
+
} else if (name === "_s") {
|
|
78
|
+
visitToken = description;
|
|
79
|
+
} else if (name === "_cmp") {
|
|
80
|
+
consent = description;
|
|
81
|
+
}
|
|
82
|
+
if (uniqueToken && visitToken && consent)
|
|
83
|
+
break;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
return uniqueToken && visitToken && (isConsentRequired ? consent : true) ? { uniqueToken, visitToken, consent } : void 0;
|
|
87
|
+
}
|
|
88
|
+
exports.SHOPIFY_UNIQUE_TOKEN_HEADER = SHOPIFY_UNIQUE_TOKEN_HEADER;
|
|
89
|
+
exports.SHOPIFY_VISIT_TOKEN_HEADER = SHOPIFY_VISIT_TOKEN_HEADER;
|
|
90
|
+
exports.cachedTrackingValues = cachedTrackingValues;
|
|
91
|
+
exports.getTrackingValues = getTrackingValues;
|
|
92
|
+
//# sourceMappingURL=tracking-utils.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracking-utils.js","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\nexport type 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// Cache values to avoid losing them when performance\n// entries are cleared from the buffer over time.\nexport const cachedTrackingValues: {\n current: null | TrackingValues;\n} = {current: null};\n\n/**\n * Retrieves user session tracking values for analytics\n * and marketing from the browser environment.\n * @param cookieString - Optional cookie string to parse for deprecated cookie fallback.\n * Used internally by getShopifyCookies for backward compatibility.\n */\nexport function getTrackingValues(cookieString?: string): TrackingValues {\n // Overall behavior: Tracking values are returned in Server-Timing headers from\n // Storefront API responses, and we want to find and return these tracking values.\n //\n // Search recent fetches for SFAPI requests matching either: same origin (proxy case)\n // or a subdomain of the current host (eg: checkout subdomain, if there is no proxy).\n // We consider SF API-like endpoints (/api/.../graphql.json) on subdomains, as well as\n // any same-origin request. The reason for the latter is that Hydrogen server collects\n // tracking values and returns them in any non-cached response, not just direct SF API\n // responses. For example, a cart mutation in a server action could return tracking values.\n //\n // If we didn't find tracking values in fetch requests, we fall back to checking cached values,\n // then the initial page navigation entry, and finally the deprecated `_shopify_s` and `_shopify_y`.\n\n let trackingValues: TrackingValues | undefined;\n\n if (\n typeof window !== 'undefined' &&\n typeof window.performance !== 'undefined'\n ) {\n try {\n // RE to extract host and optionally match SFAPI pathname.\n // Group 1: host (e.g. \"checkout.mystore.com\")\n // Group 2: SFAPI path if present (e.g. \"/api/2024-01/graphql.json\")\n const resourceRE =\n /^https?:\\/\\/([^/]+)(\\/api\\/(?:unstable|2\\d{3}-\\d{2})\\/graphql\\.json(?=$|\\?))?/;\n\n // Search backwards through resource entries to find the most recent match.\n // Match criteria (first one with _y and _s values wins):\n // - Same origin (exact host match) with tracking values, OR\n // - Subdomain + SFAPI pathname with tracking values\n const entries = performance.getEntriesByType(\n 'resource',\n ) as PerformanceResourceTiming[];\n\n let matchedValues: ReturnType<typeof extractFromPerformanceEntry>;\n\n for (let i = entries.length - 1; i >= 0; i--) {\n const entry = entries[i];\n\n if (entry.initiatorType !== 'fetch') continue;\n\n const currentHost = window.location.host;\n const match = entry.name.match(resourceRE);\n if (!match) continue;\n\n const [, matchedHost, sfapiPath] = match;\n\n const isMatch =\n // Same origin (exact host match)\n matchedHost === currentHost ||\n // Subdomain with SFAPI path\n (sfapiPath && matchedHost?.endsWith(`.${currentHost}`));\n\n if (isMatch) {\n const values = extractFromPerformanceEntry(entry);\n if (values) {\n matchedValues = values;\n break;\n }\n }\n }\n\n if (matchedValues) {\n trackingValues = matchedValues;\n }\n\n // Resource entries have a limited buffer and are removed over time.\n // Cache the latest values for future calls if we find them.\n // A cached resource entry is always newer than a navigation entry.\n if (trackingValues) {\n cachedTrackingValues.current = trackingValues;\n } else if (cachedTrackingValues.current) {\n // Fallback to cached values from previous calls:\n trackingValues = cachedTrackingValues.current;\n }\n\n if (!trackingValues) {\n // Fallback to navigation entry from full page rendering load:\n const navigationEntries = performance.getEntriesByType(\n 'navigation',\n )[0] as PerformanceNavigationTiming;\n\n // Navigation entries might omit consent when the Hydrogen server generates it.\n // In this case, we skip consent requirement and only extract _y and _s values.\n trackingValues = extractFromPerformanceEntry(navigationEntries, false);\n }\n // eslint-disable-next-line no-empty\n } catch {}\n }\n\n // Fallback to deprecated cookies to support transitioning:\n if (!trackingValues) {\n const cookie =\n typeof cookieString === 'string'\n ? cookieString\n : typeof document !== 'undefined'\n ? document.cookie\n : '';\n\n trackingValues = {\n uniqueToken: cookie.match(/\\b_shopify_y=([^;]+)/)?.[1] || '',\n visitToken: cookie.match(/\\b_shopify_s=([^;]+)/)?.[1] || '',\n consent: cookie.match(/\\b_tracking_consent=([^;]+)/)?.[1] || '',\n };\n }\n\n return trackingValues;\n}\n\nfunction extractFromPerformanceEntry(\n entry: PerformanceNavigationTiming | PerformanceResourceTiming,\n isConsentRequired = true,\n): TrackingValues | undefined {\n let uniqueToken = '';\n let visitToken = '';\n let consent = '';\n\n const serverTiming = entry.serverTiming;\n // Quick check: we need at least 3 entries (_y, _s, _cmp)\n if (serverTiming && serverTiming.length >= 3) {\n // Iterate backwards since our headers are typically at the end\n for (let i = serverTiming.length - 1; i >= 0; i--) {\n const {name, description} = serverTiming[i];\n if (!name || !description) continue;\n\n if (name === '_y') {\n uniqueToken = description;\n } else if (name === '_s') {\n visitToken = description;\n } else if (name === '_cmp') {\n // _cmp (consent management platform) holds the consent value\n // used by consent-tracking-api and privacy-banner scripts.\n consent = description;\n }\n\n if (uniqueToken && visitToken && consent) break;\n }\n }\n\n return uniqueToken && visitToken && (isConsentRequired ? consent : true)\n ? {uniqueToken, visitToken, consent}\n : undefined;\n}\n"],"names":[],"mappings":";;AACO,MAAM,6BAA6B;AAEnC,MAAM,8BAA8B;AAa9B,MAAA,uBAET,EAAC,SAAS,KAAI;AAQX,SAAS,kBAAkB,cAAuC;;AAcnE,MAAA;AAEJ,MACE,OAAO,WAAW,eAClB,OAAO,OAAO,gBAAgB,aAC9B;AACI,QAAA;AAIF,YAAM,aACJ;AAMF,YAAM,UAAU,YAAY;AAAA,QAC1B;AAAA,MAAA;AAGE,UAAA;AAEJ,eAAS,IAAI,QAAQ,SAAS,GAAG,KAAK,GAAG,KAAK;AACtC,cAAA,QAAQ,QAAQ,CAAC;AAEvB,YAAI,MAAM,kBAAkB;AAAS;AAE/B,cAAA,cAAc,OAAO,SAAS;AACpC,cAAM,QAAQ,MAAM,KAAK,MAAM,UAAU;AACzC,YAAI,CAAC;AAAO;AAEZ,cAAM,GAAG,aAAa,SAAS,IAAI;AAE7B,cAAA;AAAA;AAAA,UAEJ,gBAAgB;AAAA,UAEf,cAAa,2CAAa,SAAS,IAAI,WAAW;AAAA;AAErD,YAAI,SAAS;AACL,gBAAA,SAAS,4BAA4B,KAAK;AAChD,cAAI,QAAQ;AACM,4BAAA;AAChB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,UAAI,eAAe;AACA,yBAAA;AAAA,MACnB;AAKA,UAAI,gBAAgB;AAClB,6BAAqB,UAAU;AAAA,MAAA,WACtB,qBAAqB,SAAS;AAEvC,yBAAiB,qBAAqB;AAAA,MACxC;AAEA,UAAI,CAAC,gBAAgB;AAEnB,cAAM,oBAAoB,YAAY;AAAA,UACpC;AAAA,UACA,CAAC;AAIc,yBAAA,4BAA4B,mBAAmB,KAAK;AAAA,MACvE;AAAA,IAAA,QAEM;AAAA,IAAC;AAAA,EACX;AAGA,MAAI,CAAC,gBAAgB;AACb,UAAA,SACJ,OAAO,iBAAiB,WACpB,eACA,OAAO,aAAa,cACpB,SAAS,SACT;AAEW,qBAAA;AAAA,MACf,eAAa,YAAO,MAAM,sBAAsB,MAAnC,mBAAuC,OAAM;AAAA,MAC1D,cAAY,YAAO,MAAM,sBAAsB,MAAnC,mBAAuC,OAAM;AAAA,MACzD,WAAS,YAAO,MAAM,6BAA6B,MAA1C,mBAA8C,OAAM;AAAA,IAAA;AAAA,EAEjE;AAEO,SAAA;AACT;AAEA,SAAS,4BACP,OACA,oBAAoB,MACQ;AAC5B,MAAI,cAAc;AAClB,MAAI,aAAa;AACjB,MAAI,UAAU;AAEd,QAAM,eAAe,MAAM;AAEvB,MAAA,gBAAgB,aAAa,UAAU,GAAG;AAE5C,aAAS,IAAI,aAAa,SAAS,GAAG,KAAK,GAAG,KAAK;AACjD,YAAM,EAAC,MAAM,YAAW,IAAI,aAAa,CAAC;AACtC,UAAA,CAAC,QAAQ,CAAC;AAAa;AAE3B,UAAI,SAAS,MAAM;AACH,sBAAA;AAAA,MAAA,WACL,SAAS,MAAM;AACX,qBAAA;AAAA,MAAA,WACJ,SAAS,QAAQ;AAGhB,kBAAA;AAAA,MACZ;AAEA,UAAI,eAAe,cAAc;AAAS;AAAA,IAC5C;AAAA,EACF;AAEO,SAAA,eAAe,eAAe,oBAAoB,UAAU,QAC/D,EAAC,aAAa,YAAY,QAC1B,IAAA;AACN;;;;;"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
const SHOPIFY_VISIT_TOKEN_HEADER = "X-Shopify-VisitToken";
|
|
2
|
+
const SHOPIFY_UNIQUE_TOKEN_HEADER = "X-Shopify-UniqueToken";
|
|
3
|
+
const cachedTrackingValues = { current: null };
|
|
4
|
+
function getTrackingValues(cookieString) {
|
|
5
|
+
var _a, _b, _c;
|
|
6
|
+
let trackingValues;
|
|
7
|
+
if (typeof window !== "undefined" && typeof window.performance !== "undefined") {
|
|
8
|
+
try {
|
|
9
|
+
const resourceRE = /^https?:\/\/([^/]+)(\/api\/(?:unstable|2\d{3}-\d{2})\/graphql\.json(?=$|\?))?/;
|
|
10
|
+
const entries = performance.getEntriesByType(
|
|
11
|
+
"resource"
|
|
12
|
+
);
|
|
13
|
+
let matchedValues;
|
|
14
|
+
for (let i = entries.length - 1; i >= 0; i--) {
|
|
15
|
+
const entry = entries[i];
|
|
16
|
+
if (entry.initiatorType !== "fetch")
|
|
17
|
+
continue;
|
|
18
|
+
const currentHost = window.location.host;
|
|
19
|
+
const match = entry.name.match(resourceRE);
|
|
20
|
+
if (!match)
|
|
21
|
+
continue;
|
|
22
|
+
const [, matchedHost, sfapiPath] = match;
|
|
23
|
+
const isMatch = (
|
|
24
|
+
// Same origin (exact host match)
|
|
25
|
+
matchedHost === currentHost || // Subdomain with SFAPI path
|
|
26
|
+
sfapiPath && (matchedHost == null ? void 0 : matchedHost.endsWith(`.${currentHost}`))
|
|
27
|
+
);
|
|
28
|
+
if (isMatch) {
|
|
29
|
+
const values = extractFromPerformanceEntry(entry);
|
|
30
|
+
if (values) {
|
|
31
|
+
matchedValues = values;
|
|
32
|
+
break;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
if (matchedValues) {
|
|
37
|
+
trackingValues = matchedValues;
|
|
38
|
+
}
|
|
39
|
+
if (trackingValues) {
|
|
40
|
+
cachedTrackingValues.current = trackingValues;
|
|
41
|
+
} else if (cachedTrackingValues.current) {
|
|
42
|
+
trackingValues = cachedTrackingValues.current;
|
|
43
|
+
}
|
|
44
|
+
if (!trackingValues) {
|
|
45
|
+
const navigationEntries = performance.getEntriesByType(
|
|
46
|
+
"navigation"
|
|
47
|
+
)[0];
|
|
48
|
+
trackingValues = extractFromPerformanceEntry(navigationEntries, false);
|
|
49
|
+
}
|
|
50
|
+
} catch {
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
if (!trackingValues) {
|
|
54
|
+
const cookie = typeof cookieString === "string" ? cookieString : typeof document !== "undefined" ? document.cookie : "";
|
|
55
|
+
trackingValues = {
|
|
56
|
+
uniqueToken: ((_a = cookie.match(/\b_shopify_y=([^;]+)/)) == null ? void 0 : _a[1]) || "",
|
|
57
|
+
visitToken: ((_b = cookie.match(/\b_shopify_s=([^;]+)/)) == null ? void 0 : _b[1]) || "",
|
|
58
|
+
consent: ((_c = cookie.match(/\b_tracking_consent=([^;]+)/)) == null ? void 0 : _c[1]) || ""
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
return trackingValues;
|
|
62
|
+
}
|
|
63
|
+
function extractFromPerformanceEntry(entry, isConsentRequired = true) {
|
|
64
|
+
let uniqueToken = "";
|
|
65
|
+
let visitToken = "";
|
|
66
|
+
let consent = "";
|
|
67
|
+
const serverTiming = entry.serverTiming;
|
|
68
|
+
if (serverTiming && serverTiming.length >= 3) {
|
|
69
|
+
for (let i = serverTiming.length - 1; i >= 0; i--) {
|
|
70
|
+
const { name, description } = serverTiming[i];
|
|
71
|
+
if (!name || !description)
|
|
72
|
+
continue;
|
|
73
|
+
if (name === "_y") {
|
|
74
|
+
uniqueToken = description;
|
|
75
|
+
} else if (name === "_s") {
|
|
76
|
+
visitToken = description;
|
|
77
|
+
} else if (name === "_cmp") {
|
|
78
|
+
consent = description;
|
|
79
|
+
}
|
|
80
|
+
if (uniqueToken && visitToken && consent)
|
|
81
|
+
break;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
return uniqueToken && visitToken && (isConsentRequired ? consent : true) ? { uniqueToken, visitToken, consent } : void 0;
|
|
85
|
+
}
|
|
86
|
+
export {
|
|
87
|
+
SHOPIFY_UNIQUE_TOKEN_HEADER,
|
|
88
|
+
SHOPIFY_VISIT_TOKEN_HEADER,
|
|
89
|
+
cachedTrackingValues,
|
|
90
|
+
getTrackingValues
|
|
91
|
+
};
|
|
92
|
+
//# sourceMappingURL=tracking-utils.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracking-utils.mjs","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\nexport type 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// Cache values to avoid losing them when performance\n// entries are cleared from the buffer over time.\nexport const cachedTrackingValues: {\n current: null | TrackingValues;\n} = {current: null};\n\n/**\n * Retrieves user session tracking values for analytics\n * and marketing from the browser environment.\n * @param cookieString - Optional cookie string to parse for deprecated cookie fallback.\n * Used internally by getShopifyCookies for backward compatibility.\n */\nexport function getTrackingValues(cookieString?: string): TrackingValues {\n // Overall behavior: Tracking values are returned in Server-Timing headers from\n // Storefront API responses, and we want to find and return these tracking values.\n //\n // Search recent fetches for SFAPI requests matching either: same origin (proxy case)\n // or a subdomain of the current host (eg: checkout subdomain, if there is no proxy).\n // We consider SF API-like endpoints (/api/.../graphql.json) on subdomains, as well as\n // any same-origin request. The reason for the latter is that Hydrogen server collects\n // tracking values and returns them in any non-cached response, not just direct SF API\n // responses. For example, a cart mutation in a server action could return tracking values.\n //\n // If we didn't find tracking values in fetch requests, we fall back to checking cached values,\n // then the initial page navigation entry, and finally the deprecated `_shopify_s` and `_shopify_y`.\n\n let trackingValues: TrackingValues | undefined;\n\n if (\n typeof window !== 'undefined' &&\n typeof window.performance !== 'undefined'\n ) {\n try {\n // RE to extract host and optionally match SFAPI pathname.\n // Group 1: host (e.g. \"checkout.mystore.com\")\n // Group 2: SFAPI path if present (e.g. \"/api/2024-01/graphql.json\")\n const resourceRE =\n /^https?:\\/\\/([^/]+)(\\/api\\/(?:unstable|2\\d{3}-\\d{2})\\/graphql\\.json(?=$|\\?))?/;\n\n // Search backwards through resource entries to find the most recent match.\n // Match criteria (first one with _y and _s values wins):\n // - Same origin (exact host match) with tracking values, OR\n // - Subdomain + SFAPI pathname with tracking values\n const entries = performance.getEntriesByType(\n 'resource',\n ) as PerformanceResourceTiming[];\n\n let matchedValues: ReturnType<typeof extractFromPerformanceEntry>;\n\n for (let i = entries.length - 1; i >= 0; i--) {\n const entry = entries[i];\n\n if (entry.initiatorType !== 'fetch') continue;\n\n const currentHost = window.location.host;\n const match = entry.name.match(resourceRE);\n if (!match) continue;\n\n const [, matchedHost, sfapiPath] = match;\n\n const isMatch =\n // Same origin (exact host match)\n matchedHost === currentHost ||\n // Subdomain with SFAPI path\n (sfapiPath && matchedHost?.endsWith(`.${currentHost}`));\n\n if (isMatch) {\n const values = extractFromPerformanceEntry(entry);\n if (values) {\n matchedValues = values;\n break;\n }\n }\n }\n\n if (matchedValues) {\n trackingValues = matchedValues;\n }\n\n // Resource entries have a limited buffer and are removed over time.\n // Cache the latest values for future calls if we find them.\n // A cached resource entry is always newer than a navigation entry.\n if (trackingValues) {\n cachedTrackingValues.current = trackingValues;\n } else if (cachedTrackingValues.current) {\n // Fallback to cached values from previous calls:\n trackingValues = cachedTrackingValues.current;\n }\n\n if (!trackingValues) {\n // Fallback to navigation entry from full page rendering load:\n const navigationEntries = performance.getEntriesByType(\n 'navigation',\n )[0] as PerformanceNavigationTiming;\n\n // Navigation entries might omit consent when the Hydrogen server generates it.\n // In this case, we skip consent requirement and only extract _y and _s values.\n trackingValues = extractFromPerformanceEntry(navigationEntries, false);\n }\n // eslint-disable-next-line no-empty\n } catch {}\n }\n\n // Fallback to deprecated cookies to support transitioning:\n if (!trackingValues) {\n const cookie =\n typeof cookieString === 'string'\n ? cookieString\n : typeof document !== 'undefined'\n ? document.cookie\n : '';\n\n trackingValues = {\n uniqueToken: cookie.match(/\\b_shopify_y=([^;]+)/)?.[1] || '',\n visitToken: cookie.match(/\\b_shopify_s=([^;]+)/)?.[1] || '',\n consent: cookie.match(/\\b_tracking_consent=([^;]+)/)?.[1] || '',\n };\n }\n\n return trackingValues;\n}\n\nfunction extractFromPerformanceEntry(\n entry: PerformanceNavigationTiming | PerformanceResourceTiming,\n isConsentRequired = true,\n): TrackingValues | undefined {\n let uniqueToken = '';\n let visitToken = '';\n let consent = '';\n\n const serverTiming = entry.serverTiming;\n // Quick check: we need at least 3 entries (_y, _s, _cmp)\n if (serverTiming && serverTiming.length >= 3) {\n // Iterate backwards since our headers are typically at the end\n for (let i = serverTiming.length - 1; i >= 0; i--) {\n const {name, description} = serverTiming[i];\n if (!name || !description) continue;\n\n if (name === '_y') {\n uniqueToken = description;\n } else if (name === '_s') {\n visitToken = description;\n } else if (name === '_cmp') {\n // _cmp (consent management platform) holds the consent value\n // used by consent-tracking-api and privacy-banner scripts.\n consent = description;\n }\n\n if (uniqueToken && visitToken && consent) break;\n }\n }\n\n return uniqueToken && visitToken && (isConsentRequired ? consent : true)\n ? {uniqueToken, visitToken, consent}\n : undefined;\n}\n"],"names":[],"mappings":"AACO,MAAM,6BAA6B;AAEnC,MAAM,8BAA8B;AAa9B,MAAA,uBAET,EAAC,SAAS,KAAI;AAQX,SAAS,kBAAkB,cAAuC;AAzBlE;AAuCD,MAAA;AAEJ,MACE,OAAO,WAAW,eAClB,OAAO,OAAO,gBAAgB,aAC9B;AACI,QAAA;AAIF,YAAM,aACJ;AAMF,YAAM,UAAU,YAAY;AAAA,QAC1B;AAAA,MAAA;AAGE,UAAA;AAEJ,eAAS,IAAI,QAAQ,SAAS,GAAG,KAAK,GAAG,KAAK;AACtC,cAAA,QAAQ,QAAQ,CAAC;AAEvB,YAAI,MAAM,kBAAkB;AAAS;AAE/B,cAAA,cAAc,OAAO,SAAS;AACpC,cAAM,QAAQ,MAAM,KAAK,MAAM,UAAU;AACzC,YAAI,CAAC;AAAO;AAEZ,cAAM,GAAG,aAAa,SAAS,IAAI;AAE7B,cAAA;AAAA;AAAA,UAEJ,gBAAgB;AAAA,UAEf,cAAa,2CAAa,SAAS,IAAI,WAAW;AAAA;AAErD,YAAI,SAAS;AACL,gBAAA,SAAS,4BAA4B,KAAK;AAChD,cAAI,QAAQ;AACM,4BAAA;AAChB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAEA,UAAI,eAAe;AACA,yBAAA;AAAA,MACnB;AAKA,UAAI,gBAAgB;AAClB,6BAAqB,UAAU;AAAA,MAAA,WACtB,qBAAqB,SAAS;AAEvC,yBAAiB,qBAAqB;AAAA,MACxC;AAEA,UAAI,CAAC,gBAAgB;AAEnB,cAAM,oBAAoB,YAAY;AAAA,UACpC;AAAA,UACA,CAAC;AAIc,yBAAA,4BAA4B,mBAAmB,KAAK;AAAA,MACvE;AAAA,IAAA,QAEM;AAAA,IAAC;AAAA,EACX;AAGA,MAAI,CAAC,gBAAgB;AACb,UAAA,SACJ,OAAO,iBAAiB,WACpB,eACA,OAAO,aAAa,cACpB,SAAS,SACT;AAEW,qBAAA;AAAA,MACf,eAAa,YAAO,MAAM,sBAAsB,MAAnC,mBAAuC,OAAM;AAAA,MAC1D,cAAY,YAAO,MAAM,sBAAsB,MAAnC,mBAAuC,OAAM;AAAA,MACzD,WAAS,YAAO,MAAM,6BAA6B,MAA1C,mBAA8C,OAAM;AAAA,IAAA;AAAA,EAEjE;AAEO,SAAA;AACT;AAEA,SAAS,4BACP,OACA,oBAAoB,MACQ;AAC5B,MAAI,cAAc;AAClB,MAAI,aAAa;AACjB,MAAI,UAAU;AAEd,QAAM,eAAe,MAAM;AAEvB,MAAA,gBAAgB,aAAa,UAAU,GAAG;AAE5C,aAAS,IAAI,aAAa,SAAS,GAAG,KAAK,GAAG,KAAK;AACjD,YAAM,EAAC,MAAM,YAAW,IAAI,aAAa,CAAC;AACtC,UAAA,CAAC,QAAQ,CAAC;AAAa;AAE3B,UAAI,SAAS,MAAM;AACH,sBAAA;AAAA,MAAA,WACL,SAAS,MAAM;AACX,qBAAA;AAAA,MAAA,WACJ,SAAS,QAAQ;AAGhB,kBAAA;AAAA,MACZ;AAEA,UAAI,eAAe,cAAc;AAAS;AAAA,IAC5C;AAAA,EACF;AAEO,SAAA,eAAe,eAAe,oBAAoB,UAAU,QAC/D,EAAC,aAAa,YAAY,QAC1B,IAAA;AACN;"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
+
const React = require("react");
|
|
4
|
+
const getProductOptions = require("./getProductOptions.js");
|
|
5
|
+
function useSelectedOptionInUrlParam(selectedOptions) {
|
|
6
|
+
React.useEffect(() => {
|
|
7
|
+
const optionsSearchParams = new URLSearchParams(
|
|
8
|
+
getProductOptions.mapSelectedProductOptionToObject(selectedOptions || [])
|
|
9
|
+
);
|
|
10
|
+
const currentSearchParams = new URLSearchParams(window.location.search);
|
|
11
|
+
const combinedSearchParams = new URLSearchParams({
|
|
12
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
13
|
+
// @ts-ignore
|
|
14
|
+
...Object.fromEntries(currentSearchParams),
|
|
15
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
16
|
+
// @ts-ignore
|
|
17
|
+
...Object.fromEntries(optionsSearchParams)
|
|
18
|
+
});
|
|
19
|
+
if (combinedSearchParams.size > 0) {
|
|
20
|
+
window.history.replaceState(
|
|
21
|
+
{},
|
|
22
|
+
"",
|
|
23
|
+
`${window.location.pathname}?${combinedSearchParams.toString()}`
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
}, [JSON.stringify(selectedOptions)]);
|
|
27
|
+
return null;
|
|
28
|
+
}
|
|
29
|
+
exports.useSelectedOptionInUrlParam = useSelectedOptionInUrlParam;
|
|
30
|
+
//# sourceMappingURL=useSelectedOptionInUrlParam.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useSelectedOptionInUrlParam.js","sources":["../../src/useSelectedOptionInUrlParam.tsx"],"sourcesContent":["import {useEffect} from 'react';\nimport {mapSelectedProductOptionToObject} from './getProductOptions.js';\nimport {SelectedOption} from './storefront-api-types.js';\n\nexport function useSelectedOptionInUrlParam(\n selectedOptions: Pick<SelectedOption, 'name' | 'value'>[],\n): null {\n useEffect(() => {\n const optionsSearchParams = new URLSearchParams(\n mapSelectedProductOptionToObject(selectedOptions || []),\n );\n const currentSearchParams = new URLSearchParams(window.location.search);\n\n // ts ignoring the URLSearchParams not iterable error for now\n // https://stackoverflow.com/questions/72522489/urlsearchparams-not-accepting-string#answer-72522838\n // TODO: update ts lib\n const combinedSearchParams = new URLSearchParams({\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n ...Object.fromEntries(currentSearchParams),\n // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n // @ts-ignore\n ...Object.fromEntries(optionsSearchParams),\n });\n\n if (combinedSearchParams.size > 0) {\n window.history.replaceState(\n {},\n '',\n `${window.location.pathname}?${combinedSearchParams.toString()}`,\n );\n }\n // eslint-disable-next-line react-hooks/exhaustive-deps\n }, [JSON.stringify(selectedOptions)]);\n\n return null;\n}\n"],"names":["useEffect","mapSelectedProductOptionToObject"],"mappings":";;;;AAIO,SAAS,4BACd,iBACM;AACNA,QAAAA,UAAU,MAAM;AACd,UAAM,sBAAsB,IAAI;AAAA,MAC9BC,kBAAA,iCAAiC,mBAAmB,EAAE;AAAA,IAAA;AAExD,UAAM,sBAAsB,IAAI,gBAAgB,OAAO,SAAS,MAAM;AAKhE,UAAA,uBAAuB,IAAI,gBAAgB;AAAA;AAAA;AAAA,MAG/C,GAAG,OAAO,YAAY,mBAAmB;AAAA;AAAA;AAAA,MAGzC,GAAG,OAAO,YAAY,mBAAmB;AAAA,IAAA,CAC1C;AAEG,QAAA,qBAAqB,OAAO,GAAG;AACjC,aAAO,QAAQ;AAAA,QACb,CAAC;AAAA,QACD;AAAA,QACA,GAAG,OAAO,SAAS,QAAQ,IAAI,qBAAqB,UAAU;AAAA,MAAA;AAAA,IAElE;AAAA,KAEC,CAAC,KAAK,UAAU,eAAe,CAAC,CAAC;AAE7B,SAAA;AACT;;"}
|