Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
496 lines (399 loc) · 23.2 KB

README.md

File metadata and controls

496 lines (399 loc) · 23.2 KB
Raw

Storefront API Client

The Storefront API Client manages the API's authentication information and provides various methods that enables devs to interacts with the API.

Getting started

Using your preferred package manager, install this package in a project:

yarn add @shopify/storefront-api-client
npm install @shopify/storefront-api-client --s
pnpm add @shopify/storefront-api-client

CDN

The UMD builds of each release version are available via the unpkg CDN

// The minified `0.2.3` version of the Storefront API Client
<script src="https://unpkg.com/@shopify/[email protected]/dist/umd/storefront-api-client.min.js"></script>


<script>
const client = ShopifyStorefrontAPIClient.createStorefrontApiClient({...});
</script>

Initialization

Public access token client initialization

import {createStorefrontApiClient} from '@shopify/storefront-api-client';

const client = createStorefrontApiClient({
  storeDomain: 'http://your-shop-name.myshopify.com',
  apiVersion: '2023-10',
  publicAccessToken: 'your-storefront-public-access-token',
});

Create a server enabled client using a private access token and a custom Fetch API

Warning

Private Storefront API delegate access tokens should only be used in server-to-server implementations and not within a browser environment.

In order to use the client within a server, a server enabled JS Fetch API will need to be provided to the client at initialization.

import {createStorefrontApiClient, CustomFetchApi} from '@shopify/storefront-api-client';
import {fetch as nodeFetch} from 'node-fetch';

const client = createStorefrontApiClient({
  storeDomain: 'http://your-shop-name.myshopify.com',
  apiVersion: '2023-10',
  privateAccessToken: 'your-storefront-private-access-token',
  customFetchApi: nodeFetch,
});

createStorefrontApiClient() parameters

Property Type Description
storeDomain string The domain of the store. It can be the Shopify myshopify.com domain or a custom store domain.
apiVersion string The requested Storefront API version
publicAccessToken? string Storefront API public access token. Either publicAccessToken or privateAccessToken must be provided at initialization.
privateAccessToken? string Storefront API private access token. Either publicAccessToken or privateAccessToken must be provided at initialization.
Important: Storefront API private delegate access tokens should only be used in a server-to-server implementation.
clientName? string Name of the client
retries? number The number of HTTP request retries if the request was abandoned or the server responded with a Too Many Requests (429) or Service Unavailable (503) response. Default value is 0. Maximum value is 3.
customFetchAPI? (url: string, init?: {method?: string, headers?: HeaderInit, body?: string}) => Promise<Response> A replacement fetch function that will be used in all client network requests. By default, the client uses window.fetch().
logger? (logContent: UnsupportedApiVersionLog |HTTPResponseLog|HTTPRetryLog) => void A logger function that accepts log content objects. This logger will be called in certain conditions with contextual information.

Client properties

Property Type Description
config StorefrontApiClientConfig Configuration for the client
getHeaders (headers?: Record<string, string | string[]>) => Record<string, string | string[]> Returns Storefront API specific headers needed to interact with the API. If additional headers are provided, the custom headers will be included in the returned headers object.
getApiUrl (apiVersion?: string) => string Returns the shop specific API url. If an API version is provided, the returned URL will include the provided version, else the URL will include the API version set at client initialization.
fetch (operation: string, options?: ApiClientRequestOptions) => Promise<Response> Fetches data from Storefront API using the provided GQL operation string and ApiClientRequestOptions object and returns the network response.
request <TData>(operation: string, options?: ApiClientRequestOptions) => Promise<ClientResponse<TData>> Requests data from Storefront API using the provided GQL operation string and ApiClientRequestOptions object and returns a normalized response object.
requestStream <TData>(operation: string, options?: RequestOptions) => Promise <AsyncIterator<ClientStreamResponse<TData>>> Fetches GQL operations (eg. @defer directive) that can result in a streamed response from the Storefront API . The function returns an async iterator and the iterator will return normalized stream response objects as data becomes available through the stream.

StorefrontApiClientConfig properties

Name Type Description
storeDomain string The secure store domain
apiVersion string The Storefront API version to use in the API request
publicAccessToken string | never The provided public access token. If privateAccessToken was provided, publicAccessToken will not be available.
privateAccessToken string | never The provided private access token. If publicAccessToken was provided, privateAccessToken will not be available.
headers Record<string, string | string[]> The headers generated by the client during initialization
apiUrl string The API URL generated from the provided store domain and api version
clientName? string The provided client name
retries? number The number of retries the client will attempt when the API responds with a Too Many Requests (429) or Service Unavailable (503) response

ApiClientRequestOptions properties

Name Type Description
variables? Record<string, any> Variable values needed in the graphQL operation
apiVersion? string The Storefront API version to use in the API request
headers? Record<string, string | string[]> Customized headers to be included in the API request
retries? number Alternative number of retries for the request. Retries only occur for requests that were abandoned or if the server responds with a Too Many Request (429) or Service Unavailable (503) response. Minimum value is 0 and maximum value is 3.

ClientResponse<TData>

Name Type Description
data? TData | any Data returned from the Storefront API. If TData was provided to the function, the return type is TData, else it returns type any.
errors? ResponseErrors Errors object that contains any API or network errors that occured while fetching the data from the API. It does not include any UserErrors.
extensions? Record<string, any> Additional information on the GraphQL response data and context. It can include the context object that contains the context settings used to generate the returned API response.

ClientStreamResponse<TData>

Name Type Description
data? TData | any Currently available data returned from the Storefront API. If TData was provided to the function, the return type is TData, else it returns type any.
errors? ResponseErrors Errors object that contains any API or network errors that occured while fetching the data from the API. It does not include any UserErrors.
extensions? Record<string, any> Additional information on the GraphQL response data and context. It can include the context object that contains the context settings used to generate the returned API response.
hasNext boolean Flag to indicate whether the response stream has more incoming data

ResponseErrors

Name Type Description
networkStatusCode? number HTTP response status code
message? string The provided error message
graphQLErrors? any[] The GraphQL API errors returned by the server
response? Response The raw response object from the network fetch call

Client request() response examples

Successful response

API response

{
  "data": {
    "product": {
      "id": "gid://shopify/Product/12345678912",
      "title": "Sample product # 1"
    }
  },
  "extensions": {
    "context": {
      "country": "US",
      "language": "EN"
    }
  }
}
Error responses

Network error

{
  "errors": {
    "networkStatusCode": 401,
    "message": ""
  }
}

Storefront API graphQL error

{
  "errors": {
    "networkStatusCode": 200,
    "message": "An error occurred while fetching from the API. Review the `graphQLErrors` object for details.",
    "graphQLErrors": [
      {
        "message": "Field 'testField' doesn't exist on type 'Product'",
        "locations": [
          {
            "line": 17,
            "column": 3
          }
        ],
        "path": ["fragment ProductFragment", "testField"],
        "extensions": {
          "code": "undefinedField",
          "typeName": "Product",
          "fieldName": "testField"
        }
      }
    ]
  }
}

Usage examples

Query for a product

const productQuery = `
  query ProductQuery($handle: String) {
    product(handle: $handle) {
      id
      title
      handle
    }
  }
`;

const {data, errors, extensions} = await client.request(productQuery, {
  variables: {
    handle: 'sample-product',
  },
});

Query for product info using the @defer directive

const productQuery = `
  query ProductQuery($handle: String) {
    product(handle: $handle) {
      id
      handle
      ... @defer(label: "deferredFields") {
        title
        description
      }
    }
  }
`;

const responseStream = await client.requestStream(productQuery, {
  variables: {handle: 'sample-product'},
});

// await available data from the async iterator
for await (const response of responseStream) {
  const {data, errors, extensions, hasNext} = response;
}

Create a localized cart

const cartCreateMutation = `
  mutation ($input: CartInput!, $country: CountryCode, $language: LanguageCode)
  @inContext(country: $country, language: $language) {
    cartCreate(input: $input) {
      userErrors {
        message
        code
        field
      }
      cart {
        id
        checkoutUrl
      }
    }
  }
`;

const {data, errors, extensions} = await client.request(cartCreateMutation, {
  variables: {
    input: {},
    country: 'JP',
    language: 'JA',
  },
});

Query for shop information

const shopQuery = `
  query shop {
    shop {
      name
      id
    }
  }
`;

const {data, errors, extensions} = await client.request(shopQuery);

Dynamically set the Storefront API version per request

const productQuery = `
  query ProductQuery($handle: String) {
    product(handle: $handle) {
      id
      title
      handle
    }
  }
`;

const {data, errors, extensions} = await client.request(productQuery, {
  variables: {
    handle: 'sample-product',
  },
  apiVersion: '2023-07',
});

Add custom headers to API request

const productQuery = `
  query ProductQuery($handle: String) {
    product(handle: $handle) {
      id
      title
      handle
    }
  }
`;

const {data, errors, extensions} = await client.request(productQuery, {
  variables: {
    handle: 'sample-product',
  },
  headers: {
    'Shopify-Storefront-Id': 'shop-id',
  },
});

Dynamically set the number of retries per request

const productQuery = `
  query ProductQuery($handle: String) {
    product(handle: $handle) {
      id
      title
      handle
    }
  }
`;

const {data, errors, extensions} = await client.request(productQuery, {
  variables: {
    handle: 'sample-product',
  },
  retries: 2,
});

Provide GQL query type to client.request() and client.requestStream()

import {print} from 'graphql/language';

// GQL operation types are usually auto generated during the application build
import {CollectionQuery, CollectionDeferredQuery} from 'types/appTypes';
import collectionQuery from './collectionQuery.graphql';
import collectionDeferredQuery from './collectionDeferredQuery.graphql';

const {data, errors, extensions} = await client.request<CollectionQuery>(
  print(collectionQuery),
  {
    variables: {
      handle: 'sample-collection',
    },
  }
);

const responseStream = await client.requestStream<CollectionDeferredQuery>(
  print(collectionDeferredQuery),
  {
    variables: {handle: 'sample-collection'},
  }
);

Using client.fetch() to get API data

const shopQuery = `
  query shop {
    shop {
      name
      id
    }
  }
`;

const response = await client.fetch(shopQuery);

if (response.ok) {
  const {errors, data, extensions} = await response.json();
}

Typing variables and return objects

This client is compatible with the @shopify/api-codegen-preset package. You can use that package to create types from your operations with the Codegen CLI.

There are different ways to configure codegen with it, but the simplest way is to:

  1. Add the preset package as a dev dependency to your project, for example: 
    npm install --save-dev @shopify/api-codegen-preset
  2. Create a .graphqlrc.ts file in your root containing: 
    import { ApiType, shopifyApiProject } from "@shopify/api-codegen-preset";

export default {
  schema: "https://shopify.dev/storefront-graphql-direct-proxy",
  documents: ["*.ts", "!node_modules"],
  projects: {
    default: shopifyApiProject({
      apiType: ApiType.Storefront,
      apiVersion: "2023-10",
      outputDir: "./types",
    }),
  },
};
  3. Add "graphql-codegen": "graphql-codegen" to your scripts section in package.json.
  4. Tag your operations with #graphql, for example: 
    const {data, errors, extensions} = await client.request(
  `#graphql
  query Shop {
    shop {
      name
    }
  }`
);
console.log(data?.shop.name);
  5. Run npm run graphql-codegen to parse the types from your operations.

Note

Remember to ensure that your tsconfig includes the files under ./types!

Once the script runs, it'll create the file ./types/storefront.generated.d.ts. When TS includes that file, it'll automatically cause the client to detect the types for each query.

Log Content Types

UnsupportedApiVersionLog

This log content is sent to the logger whenever an unsupported API version is provided to the client.

Property Type Description
type LogType['Unsupported_Api_Version'] The type of log content. Is always set to Unsupported_Api_Version
content {apiVersion: string, supportedApiVersions: string[]} Contextual info including the provided API version and the list of currently supported API versions.

HTTPResponseLog

This log content is sent to the logger whenever a HTTP response is received by the client.

Property Type Description
type LogType['HTTP-Response'] The type of log content. Is always set to HTTP-Response
content {requestParams: [url, init?], response: Response} Contextual data regarding the request and received response

HTTPRetryLog

This log content is sent to the logger whenever the client attempts to retry HTTP requests.

Property Type Description
type LogType['HTTP-Retry'] The type of log content. Is always set to HTTP-Retry
content {requestParams: [url, init?], lastResponse?: Response, retryAttempt: number, maxRetries: number} Contextual data regarding the upcoming retry attempt.

requestParams: parameters used in the request
lastResponse: previous response
retryAttempt: the current retry attempt count
maxRetries: the maximum number of retries

RequestParams

Property Type Description
url string Requested URL
init? {method?: string, headers?: HeaderInit, body?: string} The request information