Skip to content
This repository was archived by the owner on Mar 3, 2023. It is now read-only.

Commit f8b4774

Browse files
github-actions[bot]frehnerblittle
authored
[ci] release 2023-01 (#135)
* [ci] release 2023-01 * [ci] release 2023-01 * Add release notes documentation * fix link text * Update packages/react/CHANGELOG.md Co-authored-by: Bret Little <[email protected]> * Update packages/react/CHANGELOG.md Co-authored-by: Bret Little <[email protected]> --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Anthony Frehner <[email protected]> Co-authored-by: Bret Little <[email protected]>
1 parent 40438a0 commit f8b4774

File tree

5 files changed

+197
-96
lines changed

5 files changed

+197
-96
lines changed

‎.changeset/sour-months-complain.md

-11
This file was deleted.

‎.changeset/strong-swans-melt.md

-10
This file was deleted.

‎.changeset/tall-laws-relate.md

-74
This file was deleted.

‎packages/react/CHANGELOG.md

+196
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,201 @@
11
# @shopify/hydrogen-react
22

3+
## 2023.1.4
4+
5+
### Major Changes
6+
7+
This is admittedly a strange release.
8+
9+
It has been decided to rename the repo back to `@shopify/hydrogen-react`, and with that we're abandoning the name `@shopify/storefront-kit-react`. Sorry about that, and hopefully it isn't too big of an inconvenience.
10+
11+
Additionally, the renaming offered an opportunity to introduce a couple of breaking changes that normally we wouldn't do in a `patch` release. This is the one and only time that we'll do this, so again, we apologize for the strangeness and inconvenience.
12+
13+
Depending on your upgrade path, here's a summary of the changes you need to be aware of:
14+
15+
- If upgrading from `@shopify/storefront-kit-react`
16+
- Please note the breaking changes below to [`<ShopifyProvider />`](#shopifyprovider) and [`useShop()`](#useshop)
17+
- Please note the breaking changes below to the Analytics components
18+
- If upgrading from an older release of `@shopify/hydrogen-react`
19+
- Please note the breaking changes below to [`<ShopifyProvider />`](#shopifyprovider) and [`useShop()`](#useshop)
20+
- Analytics components were [added in 2023.1.2](#202312), and then were updated in this release
21+
- Please note the breaking changes in the [`2023.1.1`](#202311) release below
22+
23+
---
24+
25+
The detailed changelog now follows:
26+
27+
- 8d8ab13: ## Breaking Changes on Shopify analytics components
28+
29+
- `useShopifyCookies` - if hasUserConsent is `false`, no cookies will be set
30+
- `sendShopifyAnalytics` - if `hasUserConsent` is false, no analytics will be sent
31+
- `ShopifyAppSource` got rename to `ShopifySalesChannel`
32+
- `getClientBrowserParameters` returns empty string for each field key if run on server
33+
- Added documents on analytics components
34+
35+
- 6184517: Added the following components and hooks, which have been a part of this package for a while but weren't actually able to be used/imported.
36+
37+
- `<CartCost />`
38+
- `<CartLinePrice />`
39+
- `<CartLineProvider />`
40+
- `useCartLine()`
41+
42+
- 3309706: `<ShopifyProvider />` and `useShop()` have had a breaking update:
43+
44+
## `ShopifyProvider`
45+
46+
- `<ShopifyProvider />` previously accepted a single `shopifyConfig` object as a prop; now, each of the keys in this object are their own separate props.
47+
- We also removed `country` and `language` as objects, and they are now strings with the names `countryIsoCode` and `languageIsoCode`, respectively.
48+
- The `locale` prop has been removed completely; this was a duplicative prop that was a combination of `countryIsoCode` and `languageIsoCode`, so it made no sense to have to include it as well.
49+
50+
An example:
51+
52+
```tsx
53+
// previously:
54+
55+
<ShopifyProvider
56+
shopifyConfig={{
57+
storeDomain: 'my-store',
58+
storefrontToken: 'abc123',
59+
storefrontApiVersion: '2022-10',
60+
country: {
61+
isoCode: 'CA',
62+
},
63+
language: {
64+
isoCode: 'EN',
65+
},
66+
locale: 'EN-CA',
67+
}}
68+
>
69+
{/* rest of your client-side app */}
70+
</ShopifyProvider>
71+
```
72+
73+
```tsx
74+
// now
75+
76+
<ShopifyProvider
77+
storeDomain="my-store"
78+
storefrontToken="abc123"
79+
storefrontApiVersion="2022-10"
80+
countryIsoCode="CA"
81+
languageIsoCode="EN"
82+
>
83+
{/* rest of your client-side app */}
84+
</ShopifyProvider>
85+
```
86+
87+
## `useShop()`
88+
89+
As noted above, `locale` was removed from the `<ShopifyProvider />` component, and `countryIsoCode` and `languageIsoCode` were renamed. Here's an example of how the return value of `useShop()` was affected
90+
91+
```tsx
92+
// before
93+
94+
const {country, language, locale} = useShop();
95+
96+
console.log(country.isoCode);
97+
console.log(language.isoCode);
98+
console.log(locale);
99+
```
100+
101+
```tsx
102+
// after
103+
104+
const {countryIsoCode, languageIsoCode} = useShop();
105+
106+
console.log(countryIsoCode);
107+
console.log(languageIsoCode);
108+
console.log(`${languageIsoCode}-${countryIsoCode}`);
109+
```
110+
111+
Note that `locale` can be replicated by combining `languageIsoCode` and `countryIsoCode` with a hypthen (`-`) between them.
112+
113+
- 8d8ab13: ## Breaking Changes on Shopify analytics components
114+
115+
- `useShopifyCookies` - if hasUserConsent is `false`, no cookies will be set
116+
- `sendShopifyAnalytics` - if `hasUserConsent` is false, no analytics will be sent
117+
- `ShopifyAppSource` got rename to `ShopifySalesChannel`
118+
- `getClientBrowserParameters` returns empty string for each field key if run on server
119+
- Added documents on analytics components
120+
121+
- 6184517: Added the following components and hooks, which have been a part of this package for awhile but weren't actually able to be used/imported.
122+
123+
- `<CartCost />`
124+
- `<CartLinePrice />`
125+
- `<CartLineProvider />`
126+
- `useCartLine()`
127+
128+
- 3309706: `<ShopifyProvider />` and `useShop()` have had a breaking update:
129+
130+
## `ShopifyProvider`
131+
132+
- `<ShopifyProvider />` previously accepted a single `shopifyConfig` object as a prop; now, each of the keys in this object are their own separate props.
133+
- We also removed `country` and `language` as objects, and they are now strings with the names `countryIsoCode` and `languageIsoCode`, respectively.
134+
- The `locale` prop has been removed completely; this was a duplicative prop that was a combination of `countryIsoCode` and `languageIsoCode`, so it made no sense to have to include it as well.
135+
136+
An example:
137+
138+
```tsx
139+
// previously:
140+
141+
<ShopifyProvider
142+
shopifyConfig={{
143+
storeDomain: 'my-store',
144+
storefrontToken: 'abc123',
145+
storefrontApiVersion: '2022-10',
146+
country: {
147+
isoCode: 'CA',
148+
},
149+
language: {
150+
isoCode: 'EN',
151+
},
152+
locale: 'EN-CA',
153+
}}
154+
>
155+
{/* rest of your client-side app */}
156+
</ShopifyProvider>
157+
```
158+
159+
```tsx
160+
// now
161+
162+
<ShopifyProvider
163+
storeDomain="my-store"
164+
storefrontToken="abc123"
165+
storefrontApiVersion="2022-10"
166+
countryIsoCode="CA"
167+
languageIsoCode="EN"
168+
>
169+
{/* rest of your client-side app */}
170+
</ShopifyProvider>
171+
```
172+
173+
## `useShop()`
174+
175+
As noted above, `locale` was removed from the `<ShopifyProvider />` component, and `countryIsoCode` and `languageIsoCode` were renamed. Here's an example of how the return value of `useShop()` was affected
176+
177+
```tsx
178+
// before
179+
180+
const {country, language, locale} = useShop();
181+
182+
console.log(country.isoCode);
183+
console.log(language.isoCode);
184+
console.log(locale);
185+
```
186+
187+
```tsx
188+
// after
189+
190+
const {countryIsoCode, languageIsoCode} = useShop();
191+
192+
console.log(countryIsoCode);
193+
console.log(languageIsoCode);
194+
console.log(`${languageIsoCode}-${countryIsoCode}`);
195+
```
196+
197+
Note that `locale` can be replicated by combining `languageIsoCode` and `countryIsoCode` with a hypthen (`-`) between them.
198+
3199
## 2023.1.3
4200

5201
### Patch Changes

‎packages/react/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@shopify/hydrogen-react",
3-
"version": "2023.1.3",
3+
"version": "2023.1.4",
44
"description": "React components, hooks, and utilities for creating custom Shopify storefronts",
55
"homepage": "https://github.com/Shopify/hydrogen-react/tree/main/packages/react",
66
"license": "MIT",

0 commit comments

Comments
 (0)