@datocms/cda-client

👉 Visit the DatoCMS homepage or see What is DatoCMS?

---

@datocms/cda-client

A lightweight, TypeScript-ready package that offers various helpers around the native Fetch API to perform GraphQL requests towards DatoCMS Content Delivery API.

TypeScript Support

This package is built with TypeScript and provides type definitions out of the box. It supports TypedDocumentNode for improved type inference when using gql.tada, GraphQL Code Generator or similar tools.

Examples

Basic Query Execution

import { executeQuery } from "@datocms/cda-client";

const query = `
  query {
    allArticles {
      id
      title
    }
  }
`;

const result = await executeQuery(query, {
  token: "your-api-token-here",
});

console.log(result);

Using with TypeScript and GraphQL Code Generator

import { executeQuery } from "@datocms/cda-client";
import { AllArticlesQuery } from "./generated/graphql";

const result = await executeQuery(AllArticlesQuery, {
  token: "your-api-token-here",
  variables: {
    limit: 10,
  },
});

console.log(result.allArticles);

Installation

npm install @datocms/cda-client

Usage

This package provides several utility functions to help you interact with the DatoCMS Content Delivery API using GraphQL.

executeQuery

The main function to execute a GraphQL query against the DatoCMS Content Delivery API.

import { executeQuery } from "@datocms/cda-client";

const result = await executeQuery(query, options);

Parameters

• query: A GraphQL query string, DocumentNode, or TypedDocumentNode.
• options: An object containing execution options.

Options

Option	Type	Description
token	string	DatoCMS API token (required) Read more
includeDrafts	boolean	If true, return draft versions of records Read more
excludeInvalid	boolean	If true, filter out invalid records Read more
environment	string	Name of the DatoCMS environment for the query Read more
contentLink	'vercel-v1'	If true, embed metadata for Content Link Read more
baseEditingUrl	string	Base URL of your DatoCMS project Read more
returnCacheTags	boolean	If true, receive Cache Tags associated with the query Read more
variables	object	Variables to be sent with the query
fetchFn	function	Custom fetch function (optional)
requestInitOptions	Partial<RequestInit>	Additional request initialization options (optional)
autoRetry	boolean	Automatically retry on rate limit (default: true)

rawExecuteQuery

Similar to executeQuery, but returns both the query result and the full response object. This can be handy when used together with returnCacheTags to actually retrieve the cache tags.

import { rawExecuteQuery } from "@datocms/cda-client";

const [result, response] = await rawExecuteQuery(query, {
  token: "your-api-token-here",
  returnCacheTags: true,
});
const cacheTags = response.headers.get("x-cache-tags");

executeQueryWithAutoPagination

This function comes handy when the query contains a paginated collection: behind the scene, executeQueryWithAutoPagination reworks the passed query and collects the results, so that it's possible to get a collection of records that is longer than Content Delivery API's result limit. That is done with a single API call, in a transparent way.

import { executeQueryWithAutoPagination } from "@datocms/cda-client";

const result = await executeQueryWithAutoPagination(query, options);

Parameters

Parameters are the same available for executeQuery:

• query: A GraphQL query string, DocumentNode, or TypedDocumentNode.
• options: An object containing execution options with the same shape of options for executeQuery.

How does it work?

Suppose you want to execute the following query:

query BuildSitemapUrls {
  allBlogPosts {
    slug
  }

  entries: allSuccessStories(first: 500) {
    ...SuccessStoryUrlFragment
  }
}

fragment SuccessStoryUrlFragment on SuccessStoryRecord {
  slug
}

Well, that's a roadblock: DatoCMS CDA has limitations on the pagination page length (currently 100 item).

That means you should introduce a variable and execute the query multiple times, each time skipping the record that have been returned by the previous query.

executeQueryWithAutoPagination does that on your behalf: the above query is analyzed and rewritten on the fly like this:

query BuildSitemapUrls {
  allBlogPosts {
    slug
  }
  splitted_0_entries: allSuccessStories(first: 100, skip: 0) {
    ...SuccessStoryUrlFragment
  }
  splitted_100_entries: allSuccessStories(first: 100, skip: 100) {
    ...SuccessStoryUrlFragment
  }
  splitted_200_entries: allSuccessStories(first: 100, skip: 200) {
    ...SuccessStoryUrlFragment
  }
  splitted_300_entries: allSuccessStories(first: 100, skip: 300) {
    ...SuccessStoryUrlFragment
  }
  splitted_400_entries: allSuccessStories(first: 100, skip: 400) {
    ...SuccessStoryUrlFragment
  }
}

fragment SuccessStoryUrlFragment on SuccessStoryRecord {
  slug
}

Once executed, the results get collected and recomposed as if nothing happened.

Limitations

executeQueryWithAutoPagination works only when the query contains only one selection that has an oversized first: argument (i.e. first: argument surpasses the Content Delivery API's result limit). If two or more fields have oversiaed patination, the function triggers an error.

The rewritten query must still respect the complexity cost.

rawExecuteQueryWithAutoPagination

As for executeQuery, also executeQueryWithAutoPagination has a pair raw version that returns both the query result and the full response object. This can be handy when used together with returnCacheTags to actually retrieve the cache tags.

import { rawExecuteQueryWithAutoPagination } from "@datocms/cda-client";

const [result, response] = await rawExecuteQueryWithAutoPagination(query, {
  token: "your-api-token-here",
  returnCacheTags: true,
});
const cacheTags = response.headers.get("x-cache-tags");

buildRequestHeaders

Builds request headers for a GraphQL query towards the DatoCMS Content Delivery API.

import { buildRequestHeaders } from "@datocms/cda-client";

const headers = buildRequestHeaders(options);

Options

The buildRequestHeaders function accepts the same options as executeQuery, except for variables, fetchFn, and autoRetry.

buildRequestInit

Builds the request initialization object for a GraphQL query towards the DatoCMS Content Delivery API.

import { buildRequestInit } from "@datocms/cda-client";

const requestInit = buildRequestInit(query, options);

Parameters

• query: A GraphQL query string or DocumentNode.
• options: An object containing execution options (same as executeQuery).

Error Handling

In case a query fails (either with an HTTP status code outside of the 2xx range, or for an error in the query), an ApiError exception will be thrown by the client. This error contains all the details of the request and response, allowing you to debug and handle errors effectively.

Example

import { executeQuery, ApiError } from "@datocms/cda-client";

const query = `
  query {
    allArticles {
      id
      title
    }
  }
`;

try {
  const result = await executeQuery(query, {
    token: "your-api-token-here",
  });
  console.log(result);
} catch (e) {
  if (e instanceof ApiError) {
    // Information about the failed request
    console.log(e.query);
    console.log(e.options);

    // Information about the response
    console.log(e.response.status);
    console.log(e.response.statusText);
    console.log(e.response.headers);
    console.log(e.response.body);
  } else {
    // Handle other types of errors
    throw e;
  }
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

---

What is DatoCMS?

DatoCMS is the REST & GraphQL Headless CMS for the modern web.

Trusted by over 25,000 enterprise businesses, agency partners, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our developers, content editors and marketers!

Quick links:

• ⚡️ Get started with a free DatoCMS account
• 🔖 Go through the docs
• ⚙️ Get support from us and the community
• 🆕 Stay up to date on new features and fixes on the changelog

Our featured repos:

• datocms/react-datocms: React helper components for images, Structured Text rendering, and more
• datocms/js-rest-api-clients: Node and browser JavaScript clients for updating and administering your content. For frontend fetches, we recommend using our GraphQL Content Delivery API instead.
• datocms/cli: Command-line interface that includes our Contentful importer and Wordpress importer
• datocms/plugins: Example plugins we've made that extend the editor/admin dashboard
• DatoCMS Starters has examples for various Javascript frontend frameworks

Or see all our public repos