Contentful Algolia Adapter

A Node JS library that lets you export your ecommerce catalog from Contentuful and makes it ready to be imported into Algolia.

What is Commerce Layer?

Commerce Layer is a headless platform that lets you easily build enterprise-grade ecommerce into any website, by using the language, CMS, and tools you already master and love.

Table of contents

• How it works
• Getting started
  • Installation
  • Import
• Usage
  • The adapter function
  • The returned array

How it works

This adapter assumes that you've already imported a set of products, based on a specific content model — both brought to you by Commerce Layer — into your Contentful space. Please find below the correct workflow, with all the preliminary steps included:

1. import the content model into Contentful using our dedicated content model importer
2. populate the content model with some data (feel free to use our Contentful Seeder)
3. add at least one catalog and one country to the content model in Contentful
4. run this adapter
5. import your catalog into Algolia by using our importer.

This adapter is built for Node.js and doesn't run in the browser.

Getting Started

To be ready to use the Contentful Algolia Adapter, you need to install it and then get the credentials that will allow you to manage your space in Contentful.

Installation

Contentful Algolia Adapter is available as an npm package:

// npm
npm install @commercelayer/contentful-algolia-adapter

// yarn
yarn add @commercelayer/contentful-algolia-adapter

Import

You can use the ES6 default import as follows:

import adapter from '@commercelayer/contentful-algolia-adapter'

Usage

The adapter function

The adapter function returns a promise and you need to pass to it as a parameter an object containing:

• accessToken: string - your Contentful content delivery token
• spaceId: string - your Contentful space ID (required)

adapter({
  accessToken: 'your-content-delivery-token',
  spaceId: 'your-space-id',
}).then((result) => {
  console.log(result)
})

The returned array

The promise returned by the adapter function is an array of objects, ready to be set as the items parameter of our Algolia importer.

License

This repository is published under the MIT license.