contentful-resolve-response

What is contentful-resolve-response?

The contentful-resolve-response npm package is designed to help developers work with Contentful's API responses by resolving links and references within the response data. This makes it easier to work with nested content structures and access related entries and assets directly.

What are contentful-resolve-response's main functionalities?

Resolve Links

This feature resolves links within the Contentful API response, making it easier to access related entries and assets directly. The code sample demonstrates how to use the resolveResponse function to resolve links in a sample response.

const { resolveResponse } = require('contentful-resolve-response');

const response = {
  items: [
    {
      sys: { id: '1', type: 'Entry' },
      fields: { title: 'Entry 1', related: { sys: { id: '2', linkType: 'Entry', type: 'Link' } } }
    }
  ],
  includes: {
    Entry: [
      { sys: { id: '2', type: 'Entry' }, fields: { title: 'Entry 2' } }
    ]
  }
};

const resolvedResponse = resolveResponse(response);
console.log(resolvedResponse);

Resolve Assets

This feature resolves asset links within the Contentful API response, making it easier to access related assets directly. The code sample demonstrates how to use the resolveResponse function to resolve asset links in a sample response.

const { resolveResponse } = require('contentful-resolve-response');

const response = {
  items: [
    {
      sys: { id: '1', type: 'Entry' },
      fields: { title: 'Entry 1', image: { sys: { id: '3', linkType: 'Asset', type: 'Link' } } }
    }
  ],
  includes: {
    Asset: [
      { sys: { id: '3', type: 'Asset' }, fields: { file: { url: 'https://example.com/image.jpg' } } }
    ]
  }
};

const resolvedResponse = resolveResponse(response);
console.log(resolvedResponse);

Other packages similar to contentful-resolve-response

contentful

The contentful package is the official Contentful JavaScript SDK. It provides a comprehensive set of tools for interacting with the Contentful API, including fetching entries, assets, and resolving links. Compared to contentful-resolve-response, it offers a broader range of functionalities but may require more setup and configuration.

README

contentful-resolve-response

Suppose you have a Contentful query's response JSON. The links are nice, but what we really usually need is the response with a resolved object graph.

contentful-resolve-response does just that:

var resolveResponse = require('contentful-resolve-response');

var response = {
  items: [
    {
      someValue: 'wow',
      someLink: { sys: { type: 'Link', linkType: 'Entry', id: 'suchId' } }
    }
  ],
  includes: {
    Entry: [
      { sys: { type: 'Entry', id: 'suchId' }, very: 'doge' }
    ]
  }
};

var items = resolveResponse(response)
// Responds with the resolved array of items.

console.log(items);

// produces:
// re`solved` object [Array] of items.
  [
    {
      // Value stays the same
      someValue: 'wow',

      // Link gets replaced by the actual object from `includes.Entry`
      someLink: {sys: {type: 'Entry', id: 'suchId'}, very: 'doge'}
    }
  ]

Note that:

• Multiple links to the same resource will point to the same object
• Circular references are possible, still!!

Changelog

1.8.2 (2024-06-18)

Bug Fixes

• downgrade commit linter (8262f6d)
• ignore resource links with unknown provider (22a663e)
• name change (e5edf02)