datocms-client

DatoCMS JS Client

CLI tool for DatoCMS.

How to integrate DatoCMS with your static website

Please head over our documentation to learn everything you need:

• Hugo
• Metalsmith
• Other generators

API Client

This package also exposes an API client, useful ie. to import existing content in your DatoCMS administrative area. Read our documentation for detailed info.

Development

After checking out the repo, run npm install and bundle install to install dependencies. Then, run npm test to run the tests.

Updating the client when the API changes

The DatoCMS API provides an always up-to-date JSON Hyperschema: the code of this package is generated automatically starting from the schema running rake regenerate.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/datocms/js-datocms-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The package is available as open source under the terms of the MIT License.

Changelog

0.5.4

The big change is that the methods the client makes available are generated at runtime based on the JSON Schema of our CMA. This means any new API endpoint — or changes to existing ones — will instantly be reflected to the client, without the need to upgrade to the latest client version.

We also added a new deserializeResponse option to every call, that you can use if you want to retrieve the exact payload the DatoCMS returns:

import { SiteClient } from 'datocms-client';

const client = new SiteClient('YOUR-API-KEY');

// `deserializeResponse` is true by default:
const accessToken = client.accessTokens.create({
  name: 'New token',
  role: '34',
});

// {
//   id: "312",
//   hardcodedType: null,
//   name: "New token",
//   token: "XXXX",
//   role: "34"
// }

// if `deserializeResponse` is false, this will be the result
const accessToken = client.accessTokens.create(
  { name: 'New token', role: '34' },
  { deserializeResponse: false },
);

// {
//   data: {
//     type: "access_token",
//     id: "312",
//     attributes: {
//       name: "New token",
//       token: "XXXX",
//       hardcoded_type: nil
//     },
//     relationships: {
//       role: {
//         data: {
//           type: "role",
//           id: "34"
//         }
//       }
//     }
//   }
// }

In our doc pages we also added some examples for the super-handy allPages option which was already present since v0.3.29:

// if you want to fetch all the pages with just one call:
client.items.all({ "filter[type]" => "44" }, { allPages: true })