@commercelayer/contentful-content-model-importer

Contentful Content Model Importer

A Node JS library that lets you import Commerce Layer content model into Contentful.

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 importer function
  • The returned object

How it works

This content model importer is the fastest and easiest way to import a specific content model — brought to you by Commerce Layer — into your Contentful space.

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

Getting Started

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

Installation

Contentful Content Model Importer is available as an npm package:

// npm
npm install @commercelayer/contentful-content-model-importer

// yarn
yarn add @commercelayer/contentful-content-model-importer

Import

You can use the ES6 default import as follows:

import contentModelImporter from '@commercelayer/contentful-content-model-importer'

Usage

The importer function

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

• spaceId: string — your Contentful space ID
• managementToken: string — your Contentful content management token

contentModelImporter({
  spaceId: 'your-space-id',
  managementToken: 'your-content-management-token',
}).then((result) => {
    console.log(result)
})

Please note that this importer automatically publishes the content model into Contentful, setting each content type status to ACTIVE.

The returned object

The promise returned by the contentModelImporter function is an object containing:

• stdout — where the library logs all the Contenful processes triggered during the import
• stderr — where the library logs all the error messages (if any)

{
  stdout: '\n' +
    '...' +
    '...' +
    '...' +
    'The import took a few seconds (8s)\n' +
    'No errors or warnings occurred\n' +
    'The import was successful.\n',
  stderr: ''
}

License

This repository is published under the MIT license.