@bigcommerce/stencil-cli 5.1.0 → 5.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/stencil-cli",
-  "version": "5.1.0",
+  "version": "5.2.1",
   "description": "CLI tool to run BigCommerce Stores locally for theme development.",
   "main": "index.js",
   "engines": {
@@ -88,7 +88,7 @@
   "devDependencies": {
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
-    "axios-mock-adapter": "^1.19.0",
+    "axios-mock-adapter": "^1.21.2",
     "conventional-changelog-cli": "^2.2.2",
     "eslint": "^7.10.0",
     "eslint-config-airbnb-base": "^14.2.0",

package/server/index.js

@@ -33,6 +33,8 @@ function buildManifest(srcManifest, options) {
     pluginsByName['./plugins/renderer/renderer.module'].storeUrl = storeUrl;
     pluginsByName['./plugins/renderer/renderer.module'].storeSettingsLocale =
         options.storeSettingsLocale;
+    pluginsByName['./plugins/renderer/renderer.module'].customLayouts =
+        options.dotStencilFile.customLayouts;
     pluginsByName['./plugins/theme-assets/theme-assets.module'].themePath = options.themePath;
 
     resManifest.register.plugins = _.reduce(

package/server/plugins/renderer/renderer.module.js

@@ -21,6 +21,7 @@ const {
 } = require('../../../lib/utils/frontmatter');
 
 const networkUtils = new NetworkUtils();
+const { DEFAULT_CUSTOM_LAYOUTS_CONFIG } = require('../../../constants');
 
 const internals = {
     options: {},
@@ -70,6 +71,7 @@ internals.sha1sum = (input) => {
  */
 internals.getResponse = async (request) => {
     const storeUrlObj = new URL(request.app.storeUrl);
+    const { customLayouts } = internals.options;
 
     const httpOpts = {
         url: Object.assign(new URL(request.url.toString()), {
@@ -80,7 +82,7 @@ internals.getResponse = async (request) => {
         headers: internals.buildReqHeaders({
             request,
             stencilOptions: { get_template_file: true, get_data_only: true },
-            extraHeaders: { host: storeUrlObj.host },
+            extraHeaders: { host: storeUrlObj.host, stencil_custom_templates: customLayouts },
         }),
         accessToken: internals.options.accessToken,
         data: request.payload,
@@ -140,7 +142,6 @@ internals.getResponse = async (request) => {
         },
         internals.cacheTTL,
     );
-
     return internals.parseResponse(bcAppData, request, response, responseArgs);
 };
 
@@ -151,10 +152,13 @@ internals.getResponse = async (request) => {
  * @param request
  * @param response
  * @param responseArgs
+ * @param customLayouts
  * @returns {*}
  */
 internals.parseResponse = async (bcAppData, request, response, responseArgs) => {
     const { httpOpts, storeUrlObj } = responseArgs;
+    // eslint-disable-next-line camelcase
+    const { stencil_custom_templates } = httpOpts.headers;
 
     if (typeof bcAppData !== 'object' || !('pencil_response' in bcAppData)) {
         delete response.headers['x-frame-options'];
@@ -175,7 +179,10 @@ internals.parseResponse = async (bcAppData, request, response, responseArgs) =>
         request,
         stencilOptions: { get_data_only: true },
         stencilConfig: internals.getResourceConfig(bcAppData, request, configuration),
-        extraHeaders: { host: storeUrlObj.host },
+        extraHeaders: {
+            host: storeUrlObj.host,
+            stencil_custom_templates,
+        },
     });
     httpOpts.responseType = 'json'; // In the second request we always expect json
 
@@ -440,14 +447,21 @@ internals.buildReqHeaders = ({
         ? JSON.parse(request.headers['stencil-options'])
         : {};
 
+    const templates =
+        JSON.stringify(extraHeaders.stencil_custom_templates) ||
+        JSON.stringify(DEFAULT_CUSTOM_LAYOUTS_CONFIG);
+
     const headers = {
         'stencil-options': JSON.stringify({ ...stencilOptions, ...currentOptions }),
         'accept-encoding': 'identity',
+        'stencil-custom-templates': templates,
     };
 
     if (!request.headers['stencil-config'] && stencilConfig) {
         headers['stencil-config'] = JSON.stringify(stencilConfig);
     }
+    // eslint-disable-next-line no-param-reassign
+    delete extraHeaders.stencil_custom_templates;
 
     return { ...request.headers, ...headers, ...extraHeaders };
 };