@bigcommerce/stencil-cli 8.2.0 → 8.4.0

package/lib/store-settings-api-client.js

@@ -1,15 +1,13 @@
-require('colors');
-const NetworkUtils = require('./utils/NetworkUtils');
+import 'colors';
+import NetworkUtils from './utils/NetworkUtils.js';
 
 const networkUtils = new NetworkUtils();
-
 async function getStoreSettingsLocale({ apiHost, storeHash, accessToken }) {
     try {
         const response = await networkUtils.sendApiRequest({
             url: `${apiHost}/stores/${storeHash}/v3/settings/store/locale`,
             accessToken,
         });
-
         if (!response.data.data) {
             throw new Error('Received empty store locale in the server response'.red);
         } else if (!response.data.data.default_shopper_language) {
@@ -21,14 +19,13 @@ async function getStoreSettingsLocale({ apiHost, storeHash, accessToken }) {
                 'Received empty shopper_language_selection_method field in the server response'.red,
             );
         }
-
         return response.data.data;
     } catch (err) {
         err.name = 'StoreSettingsLocaleError';
         throw err;
     }
 }
-
-module.exports = {
+export { getStoreSettingsLocale };
+export default {
     getStoreSettingsLocale,
 };

package/lib/template-assembler.js

@@ -1,8 +1,8 @@
-const _ = require('lodash');
-const async = require('async');
-const fs = require('graceful-fs');
-const path = require('path');
-const upath = require('upath');
+import * as _ from 'lodash-es';
+import async from 'async';
+import fs from 'graceful-fs';
+import path from 'path';
+import upath from 'upath';
 
 const partialRegex = /\{\{>\s*([_|\-|a-zA-Z0-9@'"/]+)[^{]*?}}/g;
 const partialWithoutBracketsRegex = /[^>{{}}\s*]+/g;
@@ -11,7 +11,6 @@ const includeRegex = /{{2}>\s*([_|\-|a-zA-Z0-9/]+)[^{]*?}{2}/g;
 const pathStringRegex = /^["'].+["']$/;
 const packageMarker = 'external/';
 const partialBlock = '@partial-block';
-
 /**
  * indicates if a template source is a node modules dependency
  *
@@ -27,14 +26,11 @@ const applyExternalPath = (templateName, templates) => {
 };
 const modifyNestedPartial = (partial) => {
     const partialFragments = partial.match(partialWithoutBracketsRegex);
-
     if (partialFragments) {
         return [`${partialFragments.shift()}'`, ...partialFragments].join(' ');
     }
-
     return partialFragments;
 };
-
 const replacePartialNames = (content, partialRoute) => {
     return content.replace(
         includeRegex,
@@ -42,14 +38,12 @@ const replacePartialNames = (content, partialRoute) => {
             `{{> '${defineBaseRoute(partialRoute)}/${modifyNestedPartial(partialName)} }}`,
     );
 };
-
 const trimPartial = (partial) => {
     if (pathStringRegex.test(partial)) {
         return partial.slice(1, -1);
     }
     return partial;
 };
-
 /**
  * Takes a templates folder and template name. It returns simple path for custom template if it's available
  *  or use default folder instead
@@ -60,7 +54,6 @@ const trimPartial = (partial) => {
 function getCustomPath(templatesFolder, templateName) {
     let customTemplatesDir;
     let customTemplateName;
-
     if (templateName.startsWith(packageMarker)) {
         customTemplatesDir = templatesFolder.replace('templates', 'node_modules');
         customTemplateName = templateName.slice(packageMarker.length);
@@ -68,10 +61,8 @@ function getCustomPath(templatesFolder, templateName) {
         customTemplatesDir = templatesFolder;
         customTemplateName = templateName;
     }
-
     return path.join(customTemplatesDir, `${customTemplateName}.html`);
 }
-
 /**
  * Takes a list of templates and grabs their content. It returns simple key/val pair
  * of filename => content
@@ -86,24 +77,20 @@ function getContent(templatesFolder, templatePaths, callback) {
         {},
         (acc, templatePath, reduceCallback) => {
             const file = getCustomPath(templatesFolder, templatePath);
-
             fs.readFile(file, { encoding: 'utf-8' }, (err, content) => {
                 if (err) {
                     reduceCallback(err);
                     return;
                 }
-
                 acc[templatePath] = templatePath.startsWith(packageMarker)
                     ? replacePartialNames(content, templatePath)
                     : content;
-
                 reduceCallback(null, acc);
             });
         },
         callback,
     );
 }
-
 /**
  * Parses the passed in templates and returns all of the partials for each one
  *
@@ -117,23 +104,18 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
         // eslint-disable-next-line no-param-reassign
         callback = options;
     }
-
     let templatePaths = [];
     const missingTemplates = [];
-
     if (!templates) {
         callback(null);
         return;
     }
-
     const normalizedTemplates = Array.isArray(templates) ? templates : [templates];
-
     // eslint-disable-next-line no-use-before-define
     async.each(normalizedTemplates, resolvePartials, (err) => {
         if (err) {
             return callback(err);
         }
-
         if (missingTemplates.length > 0) {
             return callback(
                 new Error(
@@ -144,29 +126,22 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
         if (options.bundle) {
             templatePaths = templatePaths.map((ele) => upath.toUnix(ele));
         }
-
         return callback(null, templatePaths);
     });
-
     function resolvePartials(t, cb2) {
         const templateName = trimPartial(t);
         const templatePath = getCustomPath(templatesFolder, templateName);
-
         fs.readFile(templatePath, { encoding: 'utf-8' }, (err, content) => {
             const componentPaths = [];
             let matches = [];
-
             if (err) {
                 missingTemplates.push(templateName);
                 cb2();
                 return;
             }
-
             templatePaths.push(templateName);
-
             let match = partialRegex.exec(content);
             let partialPath;
-
             while (match !== null) {
                 [, partialPath] = match;
                 if (!templatePaths.includes(partialPath)) {
@@ -176,16 +151,13 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
                 }
                 match = partialRegex.exec(content);
             }
-
             match = dynamicComponentRegex.exec(content);
-
             while (match !== null) {
                 if (componentPaths.indexOf(match[1]) === -1) {
                     componentPaths.push(match[1]);
                 }
                 match = dynamicComponentRegex.exec(content);
             }
-
             async.each(
                 componentPaths,
                 (componentPath, cb3) => {
@@ -194,7 +166,6 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
                             cb3(err3);
                             return;
                         }
-
                         matches = _.reduce(
                             files,
                             (acc, file) => {
@@ -203,12 +174,10 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
                                 if (templatePaths.indexOf(partialPath) === -1) {
                                     acc.push(partialPath);
                                 }
-
                                 return acc;
                             },
                             matches,
                         );
-
                         cb3();
                     });
                 },
@@ -217,18 +186,15 @@ function getTemplatePaths(templatesFolder, templates, options, callback) {
                         cb2(err2);
                         return;
                     }
-
                     if (isExternalTemplate(templateName)) {
                         matches = applyExternalPath(templateName, matches);
                     }
-
                     async.each(matches, resolvePartials, cb2);
                 },
             );
         });
     }
 }
-
 /**
  * Parses the passed in templates and resolves all of their partials.
  *
@@ -242,11 +208,9 @@ function assemble(templatesFolder, templates, callback) {
             callback(err);
             return;
         }
-
         getContent(templatesFolder, templatePaths, callback);
     });
 }
-
 /**
  * Parses the passed in template and resolves all of their partials for bundling
  * @param templatesFolder
@@ -255,17 +219,14 @@ function assemble(templatesFolder, templates, callback) {
  */
 function assembleAndBundle(templatesFolder, templates, callback) {
     const options = { bundle: true };
-
     getTemplatePaths(templatesFolder, templates, options, (err, templatePaths) => {
         if (err) {
             callback(err);
             return;
         }
-
         getContent(templatesFolder, templatePaths, callback);
     });
 }
-
 /**
  * Get template content
  * @param templatesFolder
@@ -276,7 +237,7 @@ function getTemplateContentSync(templatesFolder, templateFile) {
     return fs.readFileSync(templatePath).toString();
 }
 
-module.exports = {
+export default {
     packageMarker,
     partialRegex,
     dynamicComponentRegex,

package/lib/theme-api-client.js

@@ -1,12 +1,11 @@
-require('colors');
-const fs = require('fs');
-const path = require('path');
-const FormData = require('form-data');
-const NetworkUtils = require('./utils/NetworkUtils');
-const { PACKAGE_INFO } = require('../constants');
+import 'colors';
+import fs from 'fs';
+import path from 'path';
+import FormData from 'form-data';
+import NetworkUtils from './utils/NetworkUtils.js';
+import { PACKAGE_INFO } from '../constants.js';
 
 const networkUtils = new NetworkUtils();
-
 /**
  * @param {object} options
  * @param {string} options.storeUrl
@@ -25,7 +24,6 @@ async function getStoreHash({ storeUrl }) {
         throw err;
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.storeUrl
@@ -35,7 +33,6 @@ async function getStoreHash({ storeUrl }) {
 async function checkCliVersion({ storeUrl, currentCliVersion = PACKAGE_INFO.version }) {
     const url = new URL(`/stencil-version-check?v=${currentCliVersion}`, storeUrl).toString();
     let payload;
-
     try {
         const response = await networkUtils.sendApiRequest({ url });
         payload = response.data;
@@ -61,7 +58,6 @@ async function checkCliVersion({ storeUrl, currentCliVersion = PACKAGE_INFO.vers
     }
     return payload;
 }
-
 /**
  * @param {object} options
  * @param {string} options.variationId
@@ -103,7 +99,6 @@ async function activateThemeByVariationId({
         throw err;
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.themeId
@@ -119,7 +114,6 @@ async function deleteThemeById({ themeId, accessToken, apiHost, storeHash }) {
         method: 'DELETE',
     });
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -146,7 +140,6 @@ async function getJob({ accessToken, apiHost, storeHash, jobId, resultFilter })
         err.name = 'JobCompletionStatusCheckError';
         throw err;
     }
-
     if (response.status !== 200 || (payload.data && payload.data.status === 'FAILED')) {
         const error = new Error('Job Failed');
         error.name = 'JobCompletionStatusCheckError';
@@ -158,10 +151,8 @@ async function getJob({ accessToken, apiHost, storeHash, jobId, resultFilter })
         error.name = 'JobCompletionStatusCheckPendingError';
         throw error;
     }
-
     return resultFilter ? resultFilter(payload.data.result) : payload.data.result;
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -176,7 +167,6 @@ async function getThemes({ accessToken, apiHost, storeHash }) {
     });
     return response.data.data;
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -198,7 +188,6 @@ async function getChannelActiveTheme({ accessToken, apiHost, storeHash, channelI
         );
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -224,7 +213,6 @@ async function getStoreChannels({ accessToken, apiHost, storeHash }) {
                     );
                 }
             });
-
         if (channelsResponse) {
             return sitesResponse.data.data.filter(
                 (site) =>
@@ -232,13 +220,11 @@ async function getStoreChannels({ accessToken, apiHost, storeHash }) {
                         .length > 0,
             );
         }
-
         return sitesResponse.data.data;
     } catch (err) {
         throw new Error(`Could not fetch a list of the store channels: ${err.message}`);
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -271,7 +257,6 @@ async function getThemeConfiguration({
         throw new Error(`Could not fetch theme configuration: ${err.message}`);
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.themeId
@@ -292,7 +277,6 @@ async function getVariationsByThemeId({ accessToken, apiHost, storeHash, themeId
         throw err;
     }
 }
-
 /**
  * @param {object} options
  * @param {string} options.bundleZipPath
@@ -307,7 +291,6 @@ async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash, uploa
     formData.append('file', fs.createReadStream(bundleZipPath), {
         filename: path.basename(bundleZipPath),
     });
-
     const response = await networkUtils.sendApiRequest({
         url: `${apiHost}/stores/${storeHash}/v3/themes`,
         method: 'POST',
@@ -320,7 +303,6 @@ async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash, uploa
         validateStatus: () => true, // Wanna handle the statuses manually later
     });
     const payload = response.data;
-
     if (response.status === 409) {
         // This status code is overloaded, so we need to check the message to determine
         // if we want to trigger the theme deletion flow.
@@ -333,25 +315,20 @@ async function postTheme({ bundleZipPath, accessToken, apiHost, storeHash, uploa
         ) {
             return { themeLimitReached: true };
         }
-
         const message =
             'You already have a theme upload in progress. You will need to wait for it to finish processing before uploading a new one.';
         throw new Error((payload && payload.title) || message);
     }
-
     if (response.status === 413) {
         const message =
             'Your theme bundle is too large. Please reduce the size of your assets to bring the zip file size under 50MB.';
         throw new Error((payload && payload.title) || message);
     }
-
     if (response.status !== 201) {
         throw new Error((payload && payload.title) || 'Server Error');
     }
-
     return { jobId: payload.job_id };
 }
-
 /**
  * @param {object} options
  * @param {string} options.accessToken
@@ -383,7 +360,7 @@ async function downloadTheme({ accessToken, apiHost, storeHash, themeId }) {
     }
 }
 
-module.exports = {
+export default {
     getStoreHash,
     checkCliVersion,
     activateThemeByVariationId,