@bigcommerce/stencil-cli 3.8.3 → 3.9.1

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 3.9.1 (2022-01-25)
+
+-   fix: strf-9612 Fix stencil pull when there is 1 channel ([859](https://github.com/bigcommerce/stencil-cli/pull/859))
+
+### 3.9.0 (2022-01-21)
+
+-   fix: return channel id as an iterable when a store only has a single storefront ([849](https://github.com/bigcommerce/stencil-cli/pull/849))
+-   feat: warn npm users if npm is above 7 version ([846](https://github.com/bigcommerce/stencil-cli/pull/846))
+
+### 3.8.5 (2022-01-18)
+
+-   fix(storefront): strf-9594 loosed frontmatter refex ([841](https://github.com/bigcommerce/stencil-cli/pull/841))
+
+### 3.8.4 (2022-01-13)
+
+-   fix: `stencil init` command including `apiHost` option is now recognized ([830](https://github.com/bigcommerce/stencil-cli/pull/830))
+-   feat: `stencil push` command allows to push a theme to multiple channels ([825](https://github.com/bigcommerce/stencil-cli/pull/825))
+
 ### 3.8.3 (2022-01-12)
 
 -   fix: add activate sass engine name logic ([837](https://github.com/bigcommerce/stencil-cli/pull/837))

package/README.md

@@ -56,7 +56,9 @@ This is useful for tracking your changes in your Theme, and is the tool we use t
 
 Run `stencil push` to bundle the local theme and upload it to your store, so it will be available in My Themes.
 To push the theme and also activate it, use `stencil push -a`. To automatically delete the oldest theme if you are at
-your theme limit, use `stencil push -d`. These can be used together, as `stencil push -a -d`.
+your theme limit, use `stencil push -d`. These can be used together, as `stencil push -a -d`. You can apply the theme to
+multiple storefronts, just specify ids of desired storefronts/channels after `-c` option `stencil push -a -c 123 456 789`.
+If you want to apply theme to all available storefronts, just use `-allc` option: `stencil push -a -allc`.
 
 Run `stencil pull` to sync changes to your theme configuration from your live store. For example, if Page Builder has
 been used to change certain theme settings, this will update those settings in config.json in your theme files so you

package/bin/stencil-init.js

@@ -11,6 +11,7 @@ program
     .option('-u, --url [url]', 'Store URL')
     .option('-t, --token [token]', 'Access Token')
     .option('-p, --port [port]', 'Port')
+    .option('-h, --apiHost [host]', 'API Host')
     .parse(process.argv);
 
 checkNodeVersion();
@@ -22,5 +23,6 @@ new StencilInit()
         normalStoreUrl: cliOptions.url,
         accessToken: cliOptions.token,
         port: cliOptions.port,
+        apiHost: cliOptions.apiHost,
     })
     .catch(printCliResultErrorAndExit);

package/bin/stencil-push.js

@@ -15,10 +15,10 @@ program
     .option('-a, --activate [variationname]', 'specify the variation of the theme to activate')
     .option('-d, --delete', 'delete oldest private theme if upload limit reached')
     .option(
-        '-c, --channel_id [channelId]',
-        'specify the channel ID of the storefront to push the theme to',
-        parseInt,
+        '-c, --channel_ids <channelIds...>',
+        'specify the channel IDs of the storefront to push the theme to',
     )
+    .option('-allc, --all_channels', 'push a theme to all available channels')
     .parse(process.argv);
 
 checkNodeVersion();
@@ -26,11 +26,12 @@ checkNodeVersion();
 const cliOptions = program.opts();
 const options = {
     apiHost: cliOptions.host,
-    channelId: cliOptions.channel_id,
+    channelIds: cliOptions.channel_ids,
     bundleZipPath: cliOptions.file,
     activate: cliOptions.activate,
     saveBundleName: cliOptions.save,
     deleteOldest: cliOptions.delete,
+    allChannels: cliOptions.all_channels,
 };
 stencilPush(options, (err, result) => {
     if (err) {

package/constants.js

@@ -15,17 +15,11 @@ const DEFAULT_CUSTOM_LAYOUTS_CONFIG = {
 
 /// /////////////////////////////////////////   Other   //////////////////////////////////////// ///
 
-const DEV_API_HOST = 'https://api.service.bcdev';
-const INTG_API_HOST = 'https://api.integration.zone';
-const STG_API_HOST = 'https://api.staging.zone';
 const API_HOST = 'https://api.bigcommerce.com';
 
 module.exports = {
     PACKAGE_INFO,
     THEME_PATH,
     DEFAULT_CUSTOM_LAYOUTS_CONFIG,
-    DEV_API_HOST,
-    INTG_API_HOST,
-    STG_API_HOST,
     API_HOST,
 };

package/lib/stencil-init.js

@@ -4,13 +4,7 @@ const inquirerModule = require('inquirer');
 
 const serverConfigModule = require('../server/config');
 const StencilConfigManager = require('./StencilConfigManager');
-const {
-    DEFAULT_CUSTOM_LAYOUTS_CONFIG,
-    API_HOST,
-    INTG_API_HOST,
-    STG_API_HOST,
-    DEV_API_HOST,
-} = require('../constants');
+const { DEFAULT_CUSTOM_LAYOUTS_CONFIG, API_HOST } = require('../constants');
 
 class StencilInit {
     /**
@@ -71,20 +65,21 @@ class StencilInit {
     }
 
     /**
-     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string)}} stencilConfig
-     * @returns {{port: (number), normalStoreUrl: (string), accessToken: (string)}}
+     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string), apiHost: (string)}} stencilConfig
+     * @returns {{port: (number), normalStoreUrl: (string), accessToken: (string), apiHost: (string)}}
      */
     getDefaultAnswers(stencilConfig) {
         return {
             normalStoreUrl: stencilConfig.normalStoreUrl,
             accessToken: stencilConfig.accessToken,
             port: stencilConfig.port || this._serverConfig.get('/server/port'),
+            apiHost: API_HOST,
         };
     }
 
     /**
-     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string)}} defaultAnswers
-     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string)}} cliOptions
+     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string), apiHost: (string)}} defaultAnswers
+     * @param {{port: (number), normalStoreUrl: (string), accessToken: (string), apiHost: (string)}} cliOptions
      * @returns {{object[]}}
      */
     getQuestions(defaultAnswers, cliOptions) {
@@ -110,6 +105,15 @@ class StencilInit {
             });
         }
 
+        if (!cliOptions.apiHost) {
+            prompts.push({
+                type: 'input',
+                name: 'apiHost',
+                message: 'What API Host would you like to use?',
+                default: defaultAnswers.apiHost,
+            });
+        }
+
         if (!cliOptions.port) {
             prompts.push({
                 type: 'input',
@@ -139,27 +143,12 @@ class StencilInit {
         return questions.length ? this._inquirer.prompt(questions) : {};
     }
 
-    apiHostFromStoreUrl(storeUrl) {
-        let host = null;
-        if (storeUrl !== undefined) {
-            if (storeUrl.includes('service.bcdev')) {
-                host = DEV_API_HOST;
-            }
-            if (storeUrl.includes('my-integration.zone')) {
-                host = INTG_API_HOST;
-            }
-            if (storeUrl.includes('my-staging.zone')) {
-                host = STG_API_HOST;
-            }
-        }
-
-        if (host === null) {
-            host = API_HOST;
-        }
+    updateApiHost(stencilConfig, cliOptions) {
+        const host = cliOptions.apiHost || API_HOST;
 
         console.log('Set API host to: ' + host);
 
-        return host;
+        return { ...stencilConfig, apiHost: host };
     }
 
     /**
@@ -169,13 +158,10 @@ class StencilInit {
      * @returns {object}
      */
     applyAnswers(stencilConfig, answers, cliOptions) {
-        const storeUrl =
-            answers.normalStoreUrl || cliOptions.normalStoreUrl || stencilConfig.normalStoreUrl;
-
+        const config = this.updateApiHost(stencilConfig, cliOptions);
         return {
             customLayouts: DEFAULT_CUSTOM_LAYOUTS_CONFIG,
-            apiHost: this.apiHostFromStoreUrl(storeUrl),
-            ...stencilConfig,
+            ...config,
             ...cliOptions,
             ...answers,
         };

package/lib/stencil-push.js

@@ -18,7 +18,7 @@ function stencilPush(options = {}, callback) {
             utils.pollForJobCompletion((data) => ({ themeId: data.theme_id })),
             utils.promptUserWhetherToApplyTheme,
             utils.getChannels,
-            utils.promptUserForChannel,
+            utils.promptUserForChannels,
             utils.getVariations,
             utils.promptUserForVariation,
             utils.requestToApplyVariationWithRetrys(),

package/lib/stencil-push.utils.js

@@ -275,13 +275,14 @@ utils.getChannels = async (options) => {
     const {
         config: { accessToken },
         channelId,
+        channelIds,
         storeHash,
         applyTheme,
     } = options;
 
     const apiHost = options.apiHost || options.config.apiHost;
 
-    if (!applyTheme || channelId) {
+    if (!applyTheme || channelIds || channelId) {
         return options;
     }
 
@@ -338,6 +339,43 @@ utils.getVariations = async (options) => {
     return { ...options, variations };
 };
 
+utils.promptUserForChannels = async (options) => {
+    const { applyTheme, channelIds, channels, allChannels } = options;
+
+    if (!applyTheme || channelIds) {
+        return options;
+    }
+
+    if (allChannels) {
+        const allIds = channels.map((chanel) => chanel.channel_id);
+        return { ...options, channelIds: allIds };
+    }
+
+    const selectedChannelIds = await utils.promptUserToSelectChannels(channels);
+    return { ...options, channelIds: selectedChannelIds };
+};
+
+utils.promptUserToSelectChannels = async (channels) => {
+    if (channels.length < 2) {
+        return [channels[0].channel_id];
+    }
+
+    const questions = [
+        {
+            type: 'checkbox',
+            name: 'channelIds',
+            message: 'Which channel(s) would you like to use?',
+            choices: channels.map((channel) => ({
+                name: channel.url,
+                value: channel.channel_id,
+            })),
+        },
+    ];
+
+    const answer = await Inquirer.prompt(questions);
+    return answer.channelIds;
+};
+
 utils.promptUserForChannel = async (options) => {
     const { applyTheme, channelId, channels } = options;
 
@@ -414,18 +452,18 @@ utils.requestToApplyVariation = async (options) => {
         config: { accessToken },
         storeHash,
         variationId,
-        channelId,
+        channelIds,
     } = options;
 
     const apiHost = options.apiHost || options.config.apiHost;
 
     if (options.applyTheme) {
         await themeApiClient.activateThemeByVariationId({
-            accessToken,
+            variationId,
+            channelIds,
             apiHost,
             storeHash,
-            variationId,
-            channelId,
+            accessToken,
         });
     }
 

package/lib/theme-api-client.js

@@ -65,33 +65,36 @@ async function checkCliVersion({ storeUrl, currentCliVersion = PACKAGE_INFO.vers
 /**
  * @param {object} options
  * @param {string} options.variationId
- * @param {string} options.channelId
+ * @param {array} options.channelIds
  * @param {string} options.apiHost
  * @param {string} options.storeHash
  * @param {string} options.accessToken
- * @returns {Promise<any>}
+ * @returns {Promise<Object[]>}
  */
 async function activateThemeByVariationId({
     variationId,
-    channelId,
+    channelIds,
     apiHost,
     storeHash,
     accessToken,
 }) {
     try {
-        return await networkUtils.sendApiRequest({
-            url: `${apiHost}/stores/${storeHash}/v3/themes/actions/activate`,
-            headers: {
-                'content-type': 'application/json',
-            },
-            method: 'POST',
-            accessToken,
-            data: {
-                variation_id: variationId,
-                channel_id: channelId,
-                which: 'original',
-            },
-        });
+        const promises = channelIds.map((id) =>
+            networkUtils.sendApiRequest({
+                url: `${apiHost}/stores/${storeHash}/v3/themes/actions/activate`,
+                headers: {
+                    'content-type': 'application/json',
+                },
+                method: 'POST',
+                accessToken,
+                data: {
+                    variation_id: variationId,
+                    channel_id: Number(id),
+                    which: 'original',
+                },
+            }),
+        );
+        return Promise.all(promises);
     } catch (err) {
         err.name =
             err.response && err.response.status === 504

package/lib/utils/frontmatter.js

@@ -1,4 +1,4 @@
-const frontmatterRegex = /---\r?\n(?:.|\s)*?\r?\n---\r?\n/g;
+const frontmatterRegex = /---[\s\S]+?---/g;
 
 /**
  *

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/stencil-cli",
-  "version": "3.8.3",
+  "version": "3.9.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@bigcommerce/stencil-cli",
-  "version": "3.8.3",
+  "version": "3.9.1",
   "description": "CLI tool to run BigCommerce Stores locally for theme development.",
   "main": "index.js",
   "engines": {
-    "node": "^10.17 || ^12"
+    "node": "^10.17 || ^12",
+    "npm": ">=v6.11.3 <7.0.0"
   },
   "scripts": {
     "lint": "eslint . && prettier --check . --ignore-unknown",