demotools

Tools to aid in the process of building demos, scripts, etc. for commercetools.
The Primary focus is on transforming product catalog data and importing into the commercetools platform for standing up demos quickly

Components

commercetools.js

Encapsulation of the "standard" commercetools functions - requestBuilder, client, etc.

Place the commercetools connection parameters in a file named .env in a folder adjacent to your calling script.

execute & requestBuilder

Typically used together to execute a call to commercetools.

Takes the same arguments as the JavaScript SDK client execute

https://commercetools.github.io/nodejs/sdk/api/sdkClient.html#executerequest

and requestBuilder

https://commercetools.github.io/nodejs/sdk/api/apiRequestBuilder.html

with a few additional parameters:

• verbose (true or false) - display (lots of) debug information, including body of results, etc.

• allow404 - don't throw an error if not found, just return null

Usage

const dt = require('@cboyke/demotools');

let result = await dt.execute({
  uri: dt.requestBuilder.products.byKey(key).build(),
  method: 'POST',
  body: {
    version: version,
    actions: [{
      action: 'unpublish'
    }]
  }
});

largeQuery

Issue a query that will potentially return large amounts of data

Pass: same parameters as a query execute call (see above)

Return: an array of results.

If it makes sense to do so, we can read from a cache -- if doing testing, and running the same query repeatedly, for example. The cache argument needs to look like this: {dir: , filename: }

Usage

const dt = require('@cboyke/demotools');

let products = await dt.largeQuery({
  uri: dt.requestBuilder.products.build(),
  cache: {dir: 'cache', filename: 'products.json'}
  callback: callbackFunction // optional - to process 500 rows at a time rather than pull all items and process at end
});

---

transform.js

Data mapping / transformation utils. The heart of this module is the mapFields function, which takes an array of mappers as an argument. A mapper describes mapping of one source field to one (or more) destination fields.

A Mapper has (up to) four fields:

• src: The name of the field in the source object

• dest: The name of the field in the destination object

• convert: (optional) - a conversion operation to perform. One of: slug, category, price, number, boolean, image, list, newline-list

• type: (optional) - the data type of the destination field. One of: attr, array

Examples:

{
  src: 'ProductID',
  dest: 'key',
}

The field ProductID in the source object will be mapped to the field key in the destination object -- no transformations performed (straight copy)

Price

{ src: 'SalePrice', dest: 'prices', convert: 'price' }

Localized Fields:

{
  src: 'ProductName',
  dest: 'name',
  locale: 'en-US'
}

In this case, ProductName in the source will map to a localized field name in the destination, in a structure used by commercetools localized fields.

Attributes

{
  src: 'Department',
  dest: 'department',
  type: 'attr'
}

The source field Department will be copied to an attribute called department in an attributes array of the destination object

Category (reference by key)

Use both a 'convert' (to convert to a reference to a category), and a 'type' (array)

{
  src: 'CategoryID',
  dest: 'categories',
  convert: 'category',
  type: 'array'
}

Images

Convert to an (external) image format

{
  src: 'MainImageURL',
  dest: 'images',
  convert: 'image',
  type: 'array'
}

---
# files.js


## readCSV, writeCSV, readJSON, writeJSON, inspect
TODO: document these

---
# Linking locally

If developing locally, do 'yarn link' in this directory, then 'yarn link @cboyke/demotools' in the dependent folder.

### Notes

This module uses version 2.x of node-fetch, as version 3.x is ESM-only.