Make storefrontApiVersion optional (#984)

* Make storefrontApiVersion optional and remove it by default in examples * Changesets
Shopify · Jun 7, 2023 · 442f602 · 442f602
1 parent d8c905c
commit 442f602
Show file tree

Hide file tree

Showing 23 changed files with 9 additions and 25 deletions.
diff --git a/.changeset/mean-balloons-lick.md b/.changeset/mean-balloons-lick.md
@@ -0,0 +1,7 @@
+---
+'@shopify/hydrogen-react': patch
+'@shopify/hydrogen': patch
+'demo-store': patch
+---
+
+Make `storefrontApiVersion` parameter optional. By default, it will use the current version of Hydrogen as the Storefront API version.
diff --git a/examples/express/.env b/examples/express/.env
@@ -1,4 +1,3 @@
 SESSION_SECRET="foobar"
 PUBLIC_STOREFRONT_API_TOKEN="3b580e70970c4528da70c98e097c2fa0"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="hydrogen-preview.myshopify.com"
diff --git a/examples/express/remix.env.d.ts b/examples/express/remix.env.d.ts
@@ -21,7 +21,6 @@ declare module '@remix-run/node' {
       SESSION_SECRET: string;
       PUBLIC_STOREFRONT_API_TOKEN: string;
       PRIVATE_STOREFRONT_API_TOKEN: string;
-      PUBLIC_STOREFRONT_API_VERSION: string;
       PUBLIC_STORE_DOMAIN: string;
       PUBLIC_STOREFRONT_ID: string;
     };

diff --git a/examples/express/server.js b/examples/express/server.js
@@ -88,7 +88,6 @@ async function getContext(req) {
     publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
     privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
     storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
-    storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION || '2023-04',
     storefrontId: env.PUBLIC_STOREFRONT_ID,
     storefrontHeaders: {
       requestGroupId: req.get('request-id'),

diff --git a/packages/hydrogen-react/docs/staticPages/authenticate.client.js b/packages/hydrogen-react/docs/staticPages/authenticate.client.js
@@ -3,6 +3,5 @@ import {createStorefrontClient} from '@shopify/hydrogen-react';
 export const client = createStorefrontClient({
   // load environment variables according to your framework and runtime
   storeDomain: process.env.PUBLIC_STORE_DOMAIN,
-  storefrontApiVersion: process.env.PUBLIC_STOREFRONT_API_VERSION,
   publicStorefrontToken: process.env.PUBLIC_STOREFRONT_API_TOKEN,
 });
diff --git a/packages/hydrogen-react/docs/staticPages/authenticate.env.example b/packages/hydrogen-react/docs/staticPages/authenticate.env.example
@@ -2,5 +2,4 @@
 
 PUBLIC_STOREFRONT_API_TOKEN="public_token"
 PRIVATE_STOREFRONT_API_TOKEN="private_token"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="store_id.myshopify.com"
diff --git a/packages/hydrogen-react/src/storefront-client.ts b/packages/hydrogen-react/src/storefront-client.ts
@@ -8,7 +8,7 @@ export type StorefrontClientProps = {
   /** The Storefront API access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) documentation for more details. */
   publicStorefrontToken?: string;
   /** The Storefront API version. This should almost always be the same as the version Hydrogen React was built for. Learn more about Shopify [API versioning](https://shopify.dev/api/usage/versioning) for more details.  */
-  storefrontApiVersion: string;
+  storefrontApiVersion?: string;
   /**
    * Customizes which `"content-type"` header is added when using `getPrivateTokenHeaders()` and `getPublicTokenHeaders()`. When fetching with a `JSON.stringify()`-ed `body`, use `"json"`. When fetching with a `body` that is a plain string, use `"graphql"`. Defaults to `"json"`
    *
@@ -29,7 +29,7 @@ export function createStorefrontClient(
     storeDomain,
     privateStorefrontToken,
     publicStorefrontToken,
-    storefrontApiVersion,
+    storefrontApiVersion = SFAPI_VERSION,
     contentType,
   } = props;
 

diff --git a/packages/hydrogen/docs/staticPages/authenticate.env.example b/packages/hydrogen/docs/staticPages/authenticate.env.example
@@ -5,5 +5,4 @@
 
 SESSION_SECRET="foobar"
 PUBLIC_STOREFRONT_API_TOKEN="3b580e70970c4528da70c98e097c2fa0"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="hydrogen-preview.myshopify.com"
diff --git a/packages/hydrogen/docs/staticPages/authenticate.server.js b/packages/hydrogen/docs/staticPages/authenticate.server.js
@@ -16,7 +16,6 @@ const {storefront} = createStorefrontClient({
   publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
   privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
   storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
-  storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION || '2023-04',
   storefrontId: env.PUBLIC_STOREFRONT_ID,
   storefrontHeaders: getStorefrontHeaders(request),
 });
diff --git a/packages/hydrogen/hydrogen.config.d.ts b/packages/hydrogen/hydrogen.config.d.ts
@@ -13,7 +13,6 @@ declare global {
     SESSION_SECRET: string;
     PUBLIC_STOREFRONT_API_TOKEN: string;
     PRIVATE_STOREFRONT_API_TOKEN: string;
-    PUBLIC_STOREFRONT_API_VERSION: string;
     PUBLIC_STORE_DOMAIN: string;
     PUBLIC_STOREFRONT_ID: string;
   }

diff --git a/packages/hydrogen/src/routing/storefrontRedirect.example.js b/packages/hydrogen/src/routing/storefrontRedirect.example.js
@@ -12,7 +12,6 @@ export default {
       waitUntil: (p) => executionContext.waitUntil(p),
       privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
       publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
-      storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION,
       storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
       storefrontHeaders: getStorefrontHeaders(request),
     });

diff --git a/packages/hydrogen/src/routing/storefrontRedirect.example.ts b/packages/hydrogen/src/routing/storefrontRedirect.example.ts
@@ -12,7 +12,6 @@ export default {
       waitUntil: (p: Promise<unknown>) => executionContext.waitUntil(p),
       privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
       publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
-      storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION,
       storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
       storefrontHeaders: getStorefrontHeaders(request),
     });

diff --git a/packages/hydrogen/src/storefrontClient.example.js b/packages/hydrogen/src/storefrontClient.example.js
@@ -15,8 +15,6 @@ export default {
       privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
       /* Public Storefront API token for your store */
       publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
-      /* Desired Storefront API version to use */
-      storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION,
       /* Your store domain: "https://{shop}.myshopify.com" */
       storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
       /**

diff --git a/packages/hydrogen/src/storefrontClient.example.ts b/packages/hydrogen/src/storefrontClient.example.ts
@@ -21,8 +21,6 @@ export default {
       privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
       /* Public Storefront API token for your store */
       publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
-      /* Desired Storefront API version to use */
-      storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION,
       /* Your store domain: "https://{shop}.myshopify.com" */
       storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
       /**

diff --git a/templates/demo-store/.env b/templates/demo-store/.env
@@ -2,5 +2,4 @@
 
 SESSION_SECRET="foobar"
 PUBLIC_STOREFRONT_API_TOKEN="3b580e70970c4528da70c98e097c2fa0"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="hydrogen-preview.myshopify.com"
diff --git a/templates/demo-store/remix.env.d.ts b/templates/demo-store/remix.env.d.ts
@@ -19,7 +19,6 @@ declare global {
     SESSION_SECRET: string;
     PUBLIC_STOREFRONT_API_TOKEN: string;
     PRIVATE_STOREFRONT_API_TOKEN: string;
-    PUBLIC_STOREFRONT_API_VERSION: string;
     PUBLIC_STORE_DOMAIN: string;
     PUBLIC_STOREFRONT_ID: string;
   }

diff --git a/templates/demo-store/server.ts b/templates/demo-store/server.ts
@@ -42,7 +42,6 @@ export default {
         publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
         privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
         storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
-        storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION || '2023-04',
         storefrontId: env.PUBLIC_STOREFRONT_ID,
         storefrontHeaders: getStorefrontHeaders(request),
       });

diff --git a/templates/hello-world/.env b/templates/hello-world/.env
@@ -2,5 +2,4 @@
 
 SESSION_SECRET="foobar"
 PUBLIC_STOREFRONT_API_TOKEN="3b580e70970c4528da70c98e097c2fa0"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="hydrogen-preview.myshopify.com"
diff --git a/templates/hello-world/remix.env.d.ts b/templates/hello-world/remix.env.d.ts
@@ -18,7 +18,6 @@ declare global {
     SESSION_SECRET: string;
     PUBLIC_STOREFRONT_API_TOKEN: string;
     PRIVATE_STOREFRONT_API_TOKEN: string;
-    PUBLIC_STOREFRONT_API_VERSION: string;
     PUBLIC_STORE_DOMAIN: string;
     PUBLIC_STOREFRONT_ID: string;
   }

diff --git a/templates/hello-world/server.ts b/templates/hello-world/server.ts
@@ -42,7 +42,6 @@ export default {
         publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
         privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
         storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
-        storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION || '2023-04',
         storefrontId: env.PUBLIC_STOREFRONT_ID,
         storefrontHeaders: getStorefrontHeaders(request),
       });

diff --git a/templates/skeleton/.env b/templates/skeleton/.env
@@ -2,5 +2,4 @@
 
 SESSION_SECRET="foobar"
 PUBLIC_STOREFRONT_API_TOKEN="3b580e70970c4528da70c98e097c2fa0"
-PUBLIC_STOREFRONT_API_VERSION="2023-04"
 PUBLIC_STORE_DOMAIN="hydrogen-preview.myshopify.com"
diff --git a/templates/skeleton/remix.env.d.ts b/templates/skeleton/remix.env.d.ts
@@ -18,7 +18,6 @@ declare global {
     SESSION_SECRET: string;
     PUBLIC_STOREFRONT_API_TOKEN: string;
     PRIVATE_STOREFRONT_API_TOKEN: string;
-    PUBLIC_STOREFRONT_API_VERSION: string;
     PUBLIC_STORE_DOMAIN: string;
     PUBLIC_STOREFRONT_ID: string;
   }

diff --git a/templates/skeleton/server.ts b/templates/skeleton/server.ts
@@ -42,7 +42,6 @@ export default {
         publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
         privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
         storeDomain: `https://${env.PUBLIC_STORE_DOMAIN}`,
-        storefrontApiVersion: env.PUBLIC_STOREFRONT_API_VERSION || '2023-04',
         storefrontId: env.PUBLIC_STOREFRONT_ID,
         storefrontHeaders: getStorefrontHeaders(request),
       });