Source: client.js

  1. import GraphQLJSClient from './graphql-client';
  2. import Config from './config';
  3. import ProductResource from './product-resource';
  4. import CollectionResource from './collection-resource';
  5. import ShopResource from './shop-resource';
  6. import CheckoutResource from './checkout-resource';
  7. import ImageResource from './image-resource';
  8. import {version} from '../package.json';
  10. // GraphQL
  11. import types from '../schema.json';
  13. /**
  14.  * The JS Buy SDK Client.
  15.  * @class
  16.  *
  17.  * @property {ProductResource} product The property under which product fetching methods live.
  18.  * @property {CollectionResource} collection The property under which collection fetching methods live.
  19.  * @property {ShopResource} shop The property under which shop fetching methods live.
  20.  * @property {CartResource} cart The property under which shop fetching and mutating methods live.
  21.  * @property {ImageResource} image The property under which image helper methods live.
  22.  */
  23. class Client {
  25.   /**
  26.    * Primary entry point for building a new Client.
  27.    */
  28.   static buildClient(config, fetchFunction) {
  29.     const newConfig = new Config(config);
  30.     const client = new Client(newConfig, GraphQLJSClient, fetchFunction);
  32.     client.config = newConfig;
  34.     return client;
  35.   }
  37.   /**
  38.    * @constructs Client
  39.    * @param {Config} config An instance of {@link Config} used to configure the Client.
  40.    */
  41.   constructor(config, GraphQLClientClass = GraphQLJSClient, fetchFunction) {
  42.     const url = `https://${config.domain}/api/2025-01/graphql`;
  44.     const headers = {
  45.       'X-SDK-Variant': 'javascript',
  46.       'X-SDK-Version': version,
  47.       'X-Shopify-Storefront-Access-Token': config.storefrontAccessToken
  48.     };
  50.     if (config.source) {
  51.       headers['X-SDK-Variant-Source'] = config.source;
  52.     }
  54.     const languageHeader = config.language ? config.language : '*';
  56.     headers['Accept-Language'] = languageHeader;
  58.     if (fetchFunction) {
  59.       headers['Content-Type'] = 'application/json';
  60.       headers.Accept = 'application/json';
  62.       this.graphQLClient = new GraphQLClientClass(types, {
  63.         fetcher: function fetcher(graphQLParams) {
  64.           return fetchFunction(url, {
  65.             body: JSON.stringify(graphQLParams),
  66.             method: 'POST',
  67.             mode: 'cors',
  68.             headers
  69.           }).then((response) => response.json());
  70.         }
  71.       });
  72.     } else {
  73.       this.graphQLClient = new GraphQLClientClass(types, {
  74.         url,
  75.         fetcherOptions: {headers}
  76.       });
  77.     }
  79.     this.product = new ProductResource(this.graphQLClient);
  80.     this.collection = new CollectionResource(this.graphQLClient);
  81.     this.shop = new ShopResource(this.graphQLClient);
  82.     this.checkout = new CheckoutResource(this.graphQLClient);
  83.     this.image = new ImageResource(this.graphQLClient);
  84.   }
  86.   /**
  87.    * Fetches the next page of models
  88.    *
  89.    * @example
  90.    * client.fetchNextPage(products).then((nextProducts) => {
  91.    *   // Do something with the products
  92.    * });
  93.    *
  94.    * @param {models} [Array] The paginated set to fetch the next page of
  95.    * @return {Promise|GraphModel[]} A promise resolving with an array of `GraphModel`s of the type provided.
  96.    */
  97.   fetchNextPage(models) {
  98.     return this.graphQLClient.fetchNextPage(models);
  99.   }
  100. }
  102. export default Client;