feat(gatsby-source-shopify): Add apiVersion option (#37605)

Co-authored-by: LekoArts <[email protected]>

Author: Saideepak01

packages/gatsby-source-shopify/README.md

@@ -170,6 +170,10 @@ Not set by default. If set to a string (example `My Sales Channel`), only produc
 
 💡 Note: The `salesChannel` plugin option defaults to the value of `process.env.GATBSY_SHOPIFY_SALES_CHANNEL`. If that value is not set the plugin will source only objects that are published to the `online store` sales channel.
 
+`apiVersion: string`
+
+The API version that should be used. More information: https://shopify.dev/docs/api/usage/versioning.
+
 ## Images
 
 You have two options for displaying Shopify images in your Gatsby site. The default option is to use the Shopify CDN along with [gatsby-plugin-image](https://www.gatsbyjs.com/plugins/gatsby-plugin-image/), but you can also opt-in to downloading the images as part of the build process. Your choice will result in differences to the schema. Both options are explained below.

packages/gatsby-source-shopify/src/clients.ts

@@ -9,7 +9,7 @@ const MAX_BACKOFF_MILLISECONDS = 60000
 export function createGraphqlClient(
   options: IShopifyPluginOptions
 ): IGraphQLClient {
-  const url = `https://${options.storeUrl}/admin/api/2021-07/graphql.json`
+  const url = `https://${options.storeUrl}/admin/api/${options.apiVersion}/graphql.json`
 
   async function graphqlFetch<T>(
     query: string,
@@ -46,7 +46,7 @@ export function createGraphqlClient(
 }
 
 export function createRestClient(options: IShopifyPluginOptions): IRestClient {
-  const baseUrl = `https://${options.storeUrl}/admin/api/2021-01`
+  const baseUrl = `https://${options.storeUrl}/admin/api/${options.apiVersion}`
 
   async function shopifyFetch(
     path: string,

packages/gatsby-source-shopify/src/plugin-options-schema.ts

@@ -42,5 +42,10 @@ export function pluginOptionsSchema({ Joi }: PluginOptionsSchemaArgs): unknown {
       .description(
         `Not set by default. If set to a string (example \`MyStore\`) node names will be \`allMyStoreShopifyProducts\` instead of \`allShopifyProducts\``
       ),
+    apiVersion: Joi.string()
+      .default(`2022-04`)
+      .description(
+        `The API version that should be used. More information: https://shopify.dev/docs/api/usage/versioning`
+      ),
   })
 }

packages/gatsby-source-shopify/types/interface.d.ts

@@ -147,7 +147,8 @@ interface IShopifyPluginOptions {
   shopifyConnections: Array<string>
   typePrefix: string
   salesChannel: string
-  prioritize?: boolean
+  prioritize?: boolean,
+  apiVersion: string
 }
 
 interface IGraphQLClient {