From 7d6defcdbb554c039be3f041aeb3a5196ef4c3c6 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Fri, 14 Jan 2022 14:57:42 -0700 Subject: [PATCH 1/8] dx: rename graphqlApiVersion to storefrontApiVersion BREAKING CHANGE: In shopify.config.js, rename the "graphqlApiVersion" property to "storefrontApiVersion" Close #462 --- examples/template-hydrogen-default/shopify.config.js | 1 + .../add/shopifyConfig/templates/shopify-config-js.ts | 1 + .../shopifyProvider/templates/shopify-config-js.ts | 1 + .../hydrogen/src/components/CartProvider/hooks.tsx | 6 +++--- .../foundation/ShopifyProvider/ShopifyContext.tsx | 3 ++- .../ShopifyProvider/tests/ShopifyProvider.test.tsx | 10 +++++----- .../hydrogen/src/foundation/ShopifyProvider/types.ts | 2 +- packages/hydrogen/src/foundation/useShop/README.md | 12 ++++++------ .../src/foundation/useShop/docs/1-return-value.md | 12 ++++++------ packages/hydrogen/src/framework/middleware.ts | 4 ++-- packages/hydrogen/src/hooks/useShopQuery/hooks.ts | 6 +++--- packages/hydrogen/src/types.ts | 2 +- .../hydrogen/src/utilities/tests/shopifyMount.tsx | 2 +- .../server-components-worker/shopify.config.js | 2 +- .../playground/server-components/shopify.config.js | 2 +- 15 files changed, 35 insertions(+), 31 deletions(-) diff --git a/examples/template-hydrogen-default/shopify.config.js b/examples/template-hydrogen-default/shopify.config.js index 782e7b3392..59861da1f4 100644 --- a/examples/template-hydrogen-default/shopify.config.js +++ b/examples/template-hydrogen-default/shopify.config.js @@ -1,4 +1,5 @@ export default { storeDomain: 'hydrogen-preview.myshopify.com', storefrontToken: '3b580e70970c4528da70c98e097c2fa0', + storefrontApiVersion: 'unstable', }; diff --git a/packages/cli/src/commands/add/shopifyConfig/templates/shopify-config-js.ts b/packages/cli/src/commands/add/shopifyConfig/templates/shopify-config-js.ts index 44ab9469bf..fa8ca330d0 100644 --- a/packages/cli/src/commands/add/shopifyConfig/templates/shopify-config-js.ts +++ b/packages/cli/src/commands/add/shopifyConfig/templates/shopify-config-js.ts @@ -5,6 +5,7 @@ export default function ({storeDomain, storefrontToken}: TemplateOptions) { module.exports = { storeDomain: '${storeDomain}', storefrontToken: '${storefrontToken}', + storefrontApiVersion: 'unstable', }; `; } diff --git a/packages/cli/src/commands/add/shopifyProvider/templates/shopify-config-js.ts b/packages/cli/src/commands/add/shopifyProvider/templates/shopify-config-js.ts index 44ab9469bf..fa8ca330d0 100644 --- a/packages/cli/src/commands/add/shopifyProvider/templates/shopify-config-js.ts +++ b/packages/cli/src/commands/add/shopifyProvider/templates/shopify-config-js.ts @@ -5,6 +5,7 @@ export default function ({storeDomain, storefrontToken}: TemplateOptions) { module.exports = { storeDomain: '${storeDomain}', storefrontToken: '${storefrontToken}', + storefrontApiVersion: 'unstable', }; `; } diff --git a/packages/hydrogen/src/components/CartProvider/hooks.tsx b/packages/hydrogen/src/components/CartProvider/hooks.tsx index b6b8b5be27..4f0c80542b 100644 --- a/packages/hydrogen/src/components/CartProvider/hooks.tsx +++ b/packages/hydrogen/src/components/CartProvider/hooks.tsx @@ -10,7 +10,7 @@ import { import {Cart} from './types'; export function useCartFetch() { - const {storeDomain, graphqlApiVersion, storefrontToken} = useShop(); + const {storeDomain, storefrontApiVersion, storefrontToken} = useShop(); return React.useCallback( ({ @@ -21,7 +21,7 @@ export function useCartFetch() { variables: T; }): Promise<{data: K | undefined; error: any}> => { return fetch( - `https://${storeDomain}/api/${graphqlApiVersion}/graphql.json`, + `https://${storeDomain}/api/${storefrontApiVersion}/graphql.json`, { method: 'POST', headers: { @@ -42,7 +42,7 @@ export function useCartFetch() { }; }); }, - [storeDomain, graphqlApiVersion, storefrontToken] + [storeDomain, storefrontApiVersion, storefrontToken] ); } diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx b/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx index eced8133a3..0ebdc0e245 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx +++ b/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx @@ -13,6 +13,7 @@ export function makeShopifyContext( locale: shopifyConfig.defaultLocale ?? DEFAULT_LOCALE, storeDomain: shopifyConfig?.storeDomain?.replace(/^https?:\/\//, ''), storefrontToken: shopifyConfig.storefrontToken, - graphqlApiVersion: shopifyConfig.graphqlApiVersion ?? DEFAULT_API_VERSION, + storefrontApiVersion: + shopifyConfig.storefrontApiVersion ?? DEFAULT_API_VERSION, }; } diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx index 798efc158d..98902735ac 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx +++ b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx @@ -72,13 +72,13 @@ describe('', () => { }); }); - it('contains graphqlApiVersion from shopifyConfig', () => { + it('contains storefrontApiVersion from shopifyConfig', () => { const provider = mount( @@ -87,12 +87,12 @@ describe('', () => { expect(provider).toContainReactComponent(ShopifyContext.Provider, { value: expect.objectContaining({ - graphqlApiVersion: '2022-04', + storefrontApiVersion: '2022-04', }), }); }); - it('contains DEFAULT_API_VERSION as graphqlApiVersion when it is not specify in shopifyConfig', () => { + it('contains DEFAULT_API_VERSION as storefrontApiVersion when it is not specify in shopifyConfig', () => { const provider = mount( ', () => { expect(provider).toContainReactComponent(ShopifyContext.Provider, { value: expect.objectContaining({ - graphqlApiVersion: DEFAULT_API_VERSION, + storefrontApiVersion: DEFAULT_API_VERSION, }), }); }); diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/types.ts b/packages/hydrogen/src/foundation/ShopifyProvider/types.ts index bbd85eeede..8a950f6f04 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/types.ts +++ b/packages/hydrogen/src/foundation/ShopifyProvider/types.ts @@ -4,7 +4,7 @@ export type ShopifyContextValue = { locale: string; storeDomain: ShopifyConfig['storeDomain']; storefrontToken: ShopifyConfig['storefrontToken']; - graphqlApiVersion: string; + storefrontApiVersion: string; }; export type ShopifyProviderProps = { diff --git a/packages/hydrogen/src/foundation/useShop/README.md b/packages/hydrogen/src/foundation/useShop/README.md index 70d6f4e9a9..239fb9ad3d 100644 --- a/packages/hydrogen/src/foundation/useShop/README.md +++ b/packages/hydrogen/src/foundation/useShop/README.md @@ -18,12 +18,12 @@ export default function MyPage() { The `useShop` hook returns an object with the following keys: -| Key | Description | -| ------------------- | --------------------------------------------------------------------------------------- | -| `locale` | The application locale. Default to `defaultLocale` in `shopify.config.js` then `en-us`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `graphqlApiVersion` | The GraphQL API version set in `shopify.config.js`. Default to `unstable`. | +| Key | Description | +| ---------------------- | --------------------------------------------------------------------------------------- | +| `locale` | The application locale. Default to `defaultLocale` in `shopify.config.js` then `en-us`. | +| `storeDomain` | The store domain set in `shopify.config.js`. | +| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | +| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. Default to `unstable`. | ## Related components diff --git a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md index 3e1da663ae..1adf743534 100644 --- a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md +++ b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md @@ -2,9 +2,9 @@ The `useShop` hook returns an object with the following keys: -| Key | Description | -| ------------------- | ---------------------------------------------------- | -| `locale` | The locale set in `shopify.config.js`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `graphqlApiVersion` | The GraphQL API version set in `shopify.config.js`. | +| Key | Description | +| ---------------------- | ---------------------------------------------------- | +| `locale` | The locale set in `shopify.config.js`. | +| `storeDomain` | The store domain set in `shopify.config.js`. | +| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | +| `storefrontApiVersion` | The GraphQL API version set in `shopify.config.js`. | diff --git a/packages/hydrogen/src/framework/middleware.ts b/packages/hydrogen/src/framework/middleware.ts index 5fbe414166..4b0b31b539 100644 --- a/packages/hydrogen/src/framework/middleware.ts +++ b/packages/hydrogen/src/framework/middleware.ts @@ -175,14 +175,14 @@ async function respondWithGraphiql( ); } - const {storeDomain, storefrontToken, graphqlApiVersion} = shopifyConfig; + const {storeDomain, storefrontToken, storefrontApiVersion} = shopifyConfig; response.setHeader('Content-Type', 'text/html'); response.end( graphiqlHtml( storeDomain?.replace(/^https?:\/\//, ''), storefrontToken, - graphqlApiVersion + storefrontApiVersion ) ); } diff --git a/packages/hydrogen/src/hooks/useShopQuery/hooks.ts b/packages/hydrogen/src/hooks/useShopQuery/hooks.ts index 3bb50ad2f3..dee7d64107 100644 --- a/packages/hydrogen/src/hooks/useShopQuery/hooks.ts +++ b/packages/hydrogen/src/hooks/useShopQuery/hooks.ts @@ -96,11 +96,11 @@ function createShopRequest(body: string, locale?: string) { const { storeDomain, storefrontToken, - graphqlApiVersion, + storefrontApiVersion, locale: defaultLocale, } = useShop(); - const url = `https://${storeDomain}/api/${graphqlApiVersion}/graphql.json`; + const url = `https://${storeDomain}/api/${storefrontApiVersion}/graphql.json`; return { request: new Request(url, { @@ -112,6 +112,6 @@ function createShopRequest(body: string, locale?: string) { }, body, }), - key: [storeDomain, graphqlApiVersion, body, locale], + key: [storeDomain, storefrontApiVersion, body, locale], }; } diff --git a/packages/hydrogen/src/types.ts b/packages/hydrogen/src/types.ts index 23eb801f5e..7024d5a5ed 100644 --- a/packages/hydrogen/src/types.ts +++ b/packages/hydrogen/src/types.ts @@ -47,7 +47,7 @@ export type ShopifyConfig = { defaultLocale?: string; storeDomain: string; storefrontToken: string; - graphqlApiVersion?: string; + storefrontApiVersion?: string; }; export type Hook = ( diff --git a/packages/hydrogen/src/utilities/tests/shopifyMount.tsx b/packages/hydrogen/src/utilities/tests/shopifyMount.tsx index 8831748718..ecc9eeab50 100644 --- a/packages/hydrogen/src/utilities/tests/shopifyMount.tsx +++ b/packages/hydrogen/src/utilities/tests/shopifyMount.tsx @@ -30,6 +30,6 @@ export function getShopifyConfig(config: Partial = {}) { locale: config.defaultLocale ?? DEFAULT_LOCALE, storeDomain: config.storeDomain ?? 'notashop.myshopify.io', storefrontToken: config.storefrontToken ?? 'abc123', - graphqlApiVersion: config.graphqlApiVersion ?? DEFAULT_API_VERSION, + storefrontApiVersion: config.storefrontApiVersion ?? DEFAULT_API_VERSION, }; } diff --git a/packages/playground/server-components-worker/shopify.config.js b/packages/playground/server-components-worker/shopify.config.js index 3e7b1afc51..7546d0f831 100644 --- a/packages/playground/server-components-worker/shopify.config.js +++ b/packages/playground/server-components-worker/shopify.config.js @@ -2,5 +2,5 @@ export default { locale: 'en-us', storeDomain: 'hydrogen-preview.myshopify.com', storefrontToken: '3b580e70970c4528da70c98e097c2fa0', - graphqlApiVersion: 'unstable', + storefrontApiVersion: 'unstable', }; diff --git a/packages/playground/server-components/shopify.config.js b/packages/playground/server-components/shopify.config.js index 3e7b1afc51..7546d0f831 100644 --- a/packages/playground/server-components/shopify.config.js +++ b/packages/playground/server-components/shopify.config.js @@ -2,5 +2,5 @@ export default { locale: 'en-us', storeDomain: 'hydrogen-preview.myshopify.com', storefrontToken: '3b580e70970c4528da70c98e097c2fa0', - graphqlApiVersion: 'unstable', + storefrontApiVersion: 'unstable', }; From 4d1bbaa9e80f70bbe2ef06d8c5fbee1d1290aaf8 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Fri, 14 Jan 2022 15:01:56 -0700 Subject: [PATCH 2/8] docs: update changelog --- packages/hydrogen/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/hydrogen/CHANGELOG.md b/packages/hydrogen/CHANGELOG.md index d32d5ec0b8..a8acdc0988 100644 --- a/packages/hydrogen/CHANGELOG.md +++ b/packages/hydrogen/CHANGELOG.md @@ -10,6 +10,7 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). - Warn instead of error when a page server component is missing valid exports - Adopt upstream version of React Server Components. See [#498](https://github.com/Shopify/hydrogen/pull/498) for breaking changes. - The 'locale' option in shopify.config.js had been renamed to 'defaultLocale' +- dx: rename `graphqlApiVersion` to `storefrontApiVersion` in `shopify.config.js` ## 0.9.1 - 2022-01-20 From 97130b154283de4f1f850f3b2c67934d09184d79 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Fri, 14 Jan 2022 15:04:06 -0700 Subject: [PATCH 3/8] docs: fix readme wording for storefrontApiVersion --- .../src/foundation/useShop/docs/1-return-value.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md index 1adf743534..10b8af30b2 100644 --- a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md +++ b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md @@ -2,9 +2,9 @@ The `useShop` hook returns an object with the following keys: -| Key | Description | -| ---------------------- | ---------------------------------------------------- | -| `locale` | The locale set in `shopify.config.js`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The GraphQL API version set in `shopify.config.js`. | +| Key | Description | +| ---------------------- | ------------------------------------------------------ | +| `locale` | The locale set in `shopify.config.js`. | +| `storeDomain` | The store domain set in `shopify.config.js`. | +| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | +| `storefrontApiVersion` | The Storefront API version set in `shopify.config.js`. | From d2298ad49d5129b036ac6fb2d7dc97510af3f449 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Mon, 24 Jan 2022 10:58:09 -0700 Subject: [PATCH 4/8] dx: make storefrontApiVersion required --- .../ShopifyProvider/ShopifyContext.tsx | 5 ++--- .../tests/ShopifyProvider.test.tsx | 19 ------------------- packages/hydrogen/src/types.ts | 2 +- 3 files changed, 3 insertions(+), 23 deletions(-) diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx b/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx index 0ebdc0e245..a7116a5c13 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx +++ b/packages/hydrogen/src/foundation/ShopifyProvider/ShopifyContext.tsx @@ -1,5 +1,5 @@ import {createContext} from 'react'; -import {DEFAULT_API_VERSION, DEFAULT_LOCALE} from '../constants'; +import {DEFAULT_LOCALE} from '../constants'; import type {ShopifyContextValue} from './types'; import type {ShopifyConfig} from '../../types'; @@ -13,7 +13,6 @@ export function makeShopifyContext( locale: shopifyConfig.defaultLocale ?? DEFAULT_LOCALE, storeDomain: shopifyConfig?.storeDomain?.replace(/^https?:\/\//, ''), storefrontToken: shopifyConfig.storefrontToken, - storefrontApiVersion: - shopifyConfig.storefrontApiVersion ?? DEFAULT_API_VERSION, + storefrontApiVersion: shopifyConfig.storefrontApiVersion, }; } diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx index 98902735ac..0932640a23 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx +++ b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx @@ -91,25 +91,6 @@ describe('', () => { }), }); }); - - it('contains DEFAULT_API_VERSION as storefrontApiVersion when it is not specify in shopifyConfig', () => { - const provider = mount( - - - - ); - - expect(provider).toContainReactComponent(ShopifyContext.Provider, { - value: expect.objectContaining({ - storefrontApiVersion: DEFAULT_API_VERSION, - }), - }); - }); }); }); diff --git a/packages/hydrogen/src/types.ts b/packages/hydrogen/src/types.ts index 7024d5a5ed..ac2fbda723 100644 --- a/packages/hydrogen/src/types.ts +++ b/packages/hydrogen/src/types.ts @@ -47,7 +47,7 @@ export type ShopifyConfig = { defaultLocale?: string; storeDomain: string; storefrontToken: string; - storefrontApiVersion?: string; + storefrontApiVersion: string; }; export type Hook = ( From 1fa5dd83e3c4d090cafd1eb68c0003e2edb37621 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Mon, 24 Jan 2022 11:12:52 -0700 Subject: [PATCH 5/8] Update packages/hydrogen/src/foundation/useShop/README.md Co-authored-by: Michelle Chen --- packages/hydrogen/src/foundation/useShop/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/hydrogen/src/foundation/useShop/README.md b/packages/hydrogen/src/foundation/useShop/README.md index 239fb9ad3d..d030e4d672 100644 --- a/packages/hydrogen/src/foundation/useShop/README.md +++ b/packages/hydrogen/src/foundation/useShop/README.md @@ -23,7 +23,7 @@ The `useShop` hook returns an object with the following keys: | `locale` | The application locale. Default to `defaultLocale` in `shopify.config.js` then `en-us`. | | `storeDomain` | The store domain set in `shopify.config.js`. | | `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. Default to `unstable`. | +| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. | ## Related components From 3b0bf63f425ee6707d888fc75e1ffe9fae02dbae Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Mon, 24 Jan 2022 11:24:27 -0700 Subject: [PATCH 6/8] dx: remove default version and use 'unstable' Fix formatting issue Fix issue where storefrontApiVersion wasn't being passed in tests --- .../ShopifyProvider/tests/ShopifyProvider.test.tsx | 5 ++++- .../src/foundation/ShopifyProvider/tests/fixtures.ts | 4 ++-- packages/hydrogen/src/foundation/constants.ts | 1 - packages/hydrogen/src/foundation/useShop/README.md | 2 +- packages/hydrogen/src/framework/graphiql.ts | 4 +--- packages/hydrogen/src/utilities/tests/shopifyMount.tsx | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx index 0932640a23..4fda556718 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx +++ b/packages/hydrogen/src/foundation/ShopifyProvider/tests/ShopifyProvider.test.tsx @@ -3,7 +3,7 @@ import React from 'react'; import {mount} from '@shopify/react-testing'; import {ShopifyProvider} from '../ShopifyProvider'; import {ShopifyContext} from '../ShopifyContext'; -import {DEFAULT_API_VERSION, DEFAULT_LOCALE} from '../../constants'; +import {DEFAULT_LOCALE} from '../../constants'; import {SHOPIFY_CONFIG} from './fixtures'; describe('', () => { @@ -25,6 +25,7 @@ describe('', () => { defaultLocale: 'zh-TW', storeDomain: 'hydrogen-preview.myshopify.com', storefrontToken: '1234', + storefrontApiVersion: 'unstable', }} > @@ -42,6 +43,7 @@ describe('', () => { shopifyConfig={{ storeDomain: 'hydrogen-preview.myshopify.com', storefrontToken: '1234', + storefrontApiVersion: 'unstable', }} > @@ -59,6 +61,7 @@ describe('', () => { shopifyConfig={{ storeDomain: 'https://hydrogen-preview.myshopify.com', storefrontToken: '1234', + storefrontApiVersion: 'unstable', }} > diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/tests/fixtures.ts b/packages/hydrogen/src/foundation/ShopifyProvider/tests/fixtures.ts index 43df9d12ba..ae26419f93 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/tests/fixtures.ts +++ b/packages/hydrogen/src/foundation/ShopifyProvider/tests/fixtures.ts @@ -1,8 +1,8 @@ -import {DEFAULT_API_VERSION, DEFAULT_LOCALE} from '../../constants'; +import {DEFAULT_LOCALE} from '../../constants'; export const SHOPIFY_CONFIG = { locale: DEFAULT_LOCALE, storeDomain: 'notashop.myshopify.io', storefrontToken: 'abc123', - apiVersion: DEFAULT_API_VERSION, + storefrontApiVersion: 'unstable', }; diff --git a/packages/hydrogen/src/foundation/constants.ts b/packages/hydrogen/src/foundation/constants.ts index 98971a2546..99c80dd4e7 100644 --- a/packages/hydrogen/src/foundation/constants.ts +++ b/packages/hydrogen/src/foundation/constants.ts @@ -1,4 +1,3 @@ // Note: do not mix this export with other app-only logic // to avoid importing unnecessary code in the plugins. -export const DEFAULT_API_VERSION = 'unstable'; export const DEFAULT_LOCALE = 'en-us'; diff --git a/packages/hydrogen/src/foundation/useShop/README.md b/packages/hydrogen/src/foundation/useShop/README.md index d030e4d672..2bf4c71139 100644 --- a/packages/hydrogen/src/foundation/useShop/README.md +++ b/packages/hydrogen/src/foundation/useShop/README.md @@ -23,7 +23,7 @@ The `useShop` hook returns an object with the following keys: | `locale` | The application locale. Default to `defaultLocale` in `shopify.config.js` then `en-us`. | | `storeDomain` | The store domain set in `shopify.config.js`. | | `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. | +| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. | ## Related components diff --git a/packages/hydrogen/src/framework/graphiql.ts b/packages/hydrogen/src/framework/graphiql.ts index 192434139b..9ac2529bef 100644 --- a/packages/hydrogen/src/framework/graphiql.ts +++ b/packages/hydrogen/src/framework/graphiql.ts @@ -1,9 +1,7 @@ -import {DEFAULT_API_VERSION} from '../foundation/constants'; - export function graphiqlHtml( shop: string, token: string, - apiVersion = DEFAULT_API_VERSION + apiVersion = 'unstable' ) { return ` diff --git a/packages/hydrogen/src/utilities/tests/shopifyMount.tsx b/packages/hydrogen/src/utilities/tests/shopifyMount.tsx index ecc9eeab50..67dee2337e 100644 --- a/packages/hydrogen/src/utilities/tests/shopifyMount.tsx +++ b/packages/hydrogen/src/utilities/tests/shopifyMount.tsx @@ -1,6 +1,6 @@ import React from 'react'; import {createMount} from '@shopify/react-testing'; -import {DEFAULT_API_VERSION, DEFAULT_LOCALE} from '../../foundation/constants'; +import {DEFAULT_LOCALE} from '../../foundation/constants'; import {ShopifyConfig} from '../../types'; import {ShopifyProvider} from '../../foundation/ShopifyProvider'; @@ -30,6 +30,6 @@ export function getShopifyConfig(config: Partial = {}) { locale: config.defaultLocale ?? DEFAULT_LOCALE, storeDomain: config.storeDomain ?? 'notashop.myshopify.io', storefrontToken: config.storefrontToken ?? 'abc123', - storefrontApiVersion: config.storefrontApiVersion ?? DEFAULT_API_VERSION, + storefrontApiVersion: config.storefrontApiVersion ?? 'unstable', }; } From 6a5891bf8124ea6695e28bbe6e24ea5f2a6ca3d6 Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Mon, 24 Jan 2022 11:46:57 -0700 Subject: [PATCH 7/8] dx: fix types and docs --- packages/hydrogen/src/foundation/useShop/README.md | 2 +- .../src/foundation/useShop/docs/1-return-value.md | 12 ++++++------ packages/hydrogen/src/framework/graphiql.ts | 6 +----- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/packages/hydrogen/src/foundation/useShop/README.md b/packages/hydrogen/src/foundation/useShop/README.md index 2bf4c71139..8d8e279ee9 100644 --- a/packages/hydrogen/src/foundation/useShop/README.md +++ b/packages/hydrogen/src/foundation/useShop/README.md @@ -23,7 +23,7 @@ The `useShop` hook returns an object with the following keys: | `locale` | The application locale. Default to `defaultLocale` in `shopify.config.js` then `en-us`. | | `storeDomain` | The store domain set in `shopify.config.js`. | | `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The Storefront GraphQL API version set in `shopify.config.js`. | +| `storefrontApiVersion` | The GraphQL Storefront API version set in `shopify.config.js`. | ## Related components diff --git a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md index 10b8af30b2..99ff06135b 100644 --- a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md +++ b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md @@ -2,9 +2,9 @@ The `useShop` hook returns an object with the following keys: -| Key | Description | -| ---------------------- | ------------------------------------------------------ | -| `locale` | The locale set in `shopify.config.js`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The Storefront API version set in `shopify.config.js`. | +| Key | Description | +| ---------------------- | ----------------------------------------------------------------------------- | +| `locale` | The locale set in `shopify.config.js`. | +| `storeDomain` | The store domain set in `shopify.config.js`. | +| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | +| `storefrontApiVersion` | The Storefront API version set in `shopify.config.js`. Defaults to `unstable` | diff --git a/packages/hydrogen/src/framework/graphiql.ts b/packages/hydrogen/src/framework/graphiql.ts index 9ac2529bef..5856e543db 100644 --- a/packages/hydrogen/src/framework/graphiql.ts +++ b/packages/hydrogen/src/framework/graphiql.ts @@ -1,8 +1,4 @@ -export function graphiqlHtml( - shop: string, - token: string, - apiVersion = 'unstable' -) { +export function graphiqlHtml(shop: string, token: string, apiVersion: string) { return ` Shopify Storefront API From fbee6ff25814cf4e2fdcc7b33f4426bb7a6ae5da Mon Sep 17 00:00:00 2001 From: Anthony Frehner Date: Mon, 24 Jan 2022 11:47:29 -0700 Subject: [PATCH 8/8] dx: remove default mention --- .../src/foundation/useShop/docs/1-return-value.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md index 99ff06135b..10b8af30b2 100644 --- a/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md +++ b/packages/hydrogen/src/foundation/useShop/docs/1-return-value.md @@ -2,9 +2,9 @@ The `useShop` hook returns an object with the following keys: -| Key | Description | -| ---------------------- | ----------------------------------------------------------------------------- | -| `locale` | The locale set in `shopify.config.js`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `storefrontApiVersion` | The Storefront API version set in `shopify.config.js`. Defaults to `unstable` | +| Key | Description | +| ---------------------- | ------------------------------------------------------ | +| `locale` | The locale set in `shopify.config.js`. | +| `storeDomain` | The store domain set in `shopify.config.js`. | +| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | +| `storefrontApiVersion` | The Storefront API version set in `shopify.config.js`. |