@taurgis/sfccdx/lib/api/request/createOCAPIDataRequestDef.js

SFCCDX is a command line interface (CLI) for Salesforce Commerce Cloud. It can be used to easily manage (meta)data (import/export) in relation to your project.

// Initialize local libraries
const buildOCAPIUrl = require('./buildOCAPIUrl');
const addBearerToken = require('./addBearerToken');
const addGenericHeader = require('./addGenericHeader');

/**
 * @function _createOCAPIDataRequestDef
 * @description Helper function to create a stubbed-out OCAPI data-definition request
 *
 * @param {String} ocapiUrlSuffix Represents the OCAPI Data API Url suffix
 * @param {String} accessToken Represents the access token used to auth this request
 * @param {Boolean} [includeBMSite] Describes if the Business Manager site should be included in the url
 * @return {Object} Returns an instance of the request definition object leveraged by axios
 */
module.exports = (ocapiUrlSuffix, accessToken, includeBMSite = true) => {
    // Initialize the request definition
    let output = {
        url: buildOCAPIUrl('data', 'v21_10', ocapiUrlSuffix, includeBMSite),
        headers: {},
    };

    // Add-in the headers expected by the request
    const headers = {
        'Content-Type': 'application/json',
        'Cache-Control': 'no-cache',
        Connection: 'keep-alive',
    };

    // Apply each of the headers outlined to the current request
    Object.keys(headers).forEach((header) => addGenericHeader(output, header, headers[header]));

    // Add the credential-encoded string as an authorization header
    output = addBearerToken(output, accessToken);

    // Return the output variable
    return output;
};