@commercetools-frontend/mc-scripts 21.5.0 → 21.8.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 commercetools GmbH
+Copyright (c) commercetools GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,45 +4,4 @@
   <a href="https://www.npmjs.com/package/@commercetools-frontend/mc-scripts"><img src="https://badgen.net/npm/v/@commercetools-frontend/mc-scripts" alt="Latest release (latest dist-tag)" /></a> <a href="https://www.npmjs.com/package/@commercetools-frontend/mc-scripts"><img src="https://badgen.net/npm/v/@commercetools-frontend/mc-scripts/next" alt="Latest release (next dist-tag)" /></a> <a href="https://bundlephobia.com/result?p=@commercetools-frontend/mc-scripts"><img src="https://badgen.net/bundlephobia/minzip/@commercetools-frontend/mc-scripts" alt="Minified + GZipped size" /></a> <a href="https://github.com/commercetools/merchant-center-application-kit/blob/main/LICENSE"><img src="https://badgen.net/github/license/commercetools/merchant-center-application-kit" alt="GitHub license" /></a>
 </p>
 
-Configuration and scripts for developing a Custom Application.
-
-## Install
-
-```bash
-$ npm install --save @commercetools-frontend/mc-scripts
-```
-
-## Usage
-
-The CLI provides some commands. See https://docs.commercetools.com/custom-applications/development/available-scripts.
-
-## Using dotenv files (`.env`)
-
-Now the `mc-scripts` CLI has the dotenv features built-in.
-
-By default, the following dotenv files are loaded according to the current environment values specified on each command: `process.MC_APP_ENV` or `process.NODE_ENV`. The priority of how the files are merged and overwritten goes from top to bottom (highest defined variable overrides lower).
-
-- `.env.development.local`, `.env.test.local`, `.env.production.local`: Local overrides of environment-specific settings.
-- `.env.development`, `.env.test`, `.env.production`: Environment-specific settings.
-- `.env.local`: Local overrides. **This file is loaded for all environments except test.**
-- `.env`
-
-Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details.
-
-Furthermore, you can pass additional dotenv files by using the following option:
-
-- `--env <path>`: Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.
-
-These files will take higher priority over the standard environment dotenv files.
-
-## API usage
-
-The package exports some functions to configure Webpack:
-
-```js
-const {
-  createWebpackConfigForDevelopment,
-  createWebpackConfigForProduction,
-  vendorsToCompile,
-} = require('@commercetools-frontend/mc-scripts');
-```
+Check out the [documentation](https://docs.commercetools.com/custom-applications/api-reference/cli) for more information.

package/application-runtime/dist/commercetools-frontend-mc-scripts-application-runtime.cjs.d.ts

@@ -0,0 +1 @@
+export * from "../../dist/declarations/src/application-runtime";

package/application-runtime/dist/commercetools-frontend-mc-scripts-application-runtime.cjs.dev.js

@@ -0,0 +1,7 @@
+'use strict';
+
+/* eslint-disable */
+// Dynamically inject webpack `publicPath`, for resolving assets locations.
+// https://webpack.js.org/guides/public-path/#on-the-fly
+// https://webpack.js.org/configuration/output/#output-publicpath
+if (process.env.NODE_ENV !== 'test') __webpack_public_path__ = "".concat(window.app.cdnUrl.replace(/\/$/, ''), "/");

package/application-runtime/dist/commercetools-frontend-mc-scripts-application-runtime.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./commercetools-frontend-mc-scripts-application-runtime.cjs.prod.js");
+} else {
+  module.exports = require("./commercetools-frontend-mc-scripts-application-runtime.cjs.dev.js");
+}

package/{build/config/application-runtime.js → application-runtime/dist/commercetools-frontend-mc-scripts-application-runtime.cjs.prod.js}

@@ -1,7 +1,7 @@
-"use strict";
+'use strict';
 
 /* eslint-disable */
 // Dynamically inject webpack `publicPath`, for resolving assets locations.
 // https://webpack.js.org/guides/public-path/#on-the-fly
 // https://webpack.js.org/configuration/output/#output-publicpath
-if (process.env.NODE_ENV !== 'test') __webpack_public_path__ = `${window.app.cdnUrl.replace(/\/$/, '')}/`;
+__webpack_public_path__ = "".concat(window.app.cdnUrl.replace(/\/$/, ''), "/");

package/application-runtime/dist/commercetools-frontend-mc-scripts-application-runtime.esm.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+// Dynamically inject webpack `publicPath`, for resolving assets locations.
+// https://webpack.js.org/guides/public-path/#on-the-fly
+// https://webpack.js.org/configuration/output/#output-publicpath
+if (process.env.NODE_ENV !== 'test') __webpack_public_path__ = "".concat(window.app.cdnUrl.replace(/\/$/, ''), "/");

package/application-runtime/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "dist/commercetools-frontend-mc-scripts-application-runtime.cjs.js",
+  "module": "dist/commercetools-frontend-mc-scripts-application-runtime.esm.js"
+}

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../build/bin/cli');
+require('@commercetools-frontend/mc-scripts/cli').run();

package/cli/dist/commercetools-frontend-mc-scripts-cli.cjs.d.ts

@@ -0,0 +1 @@
+export * from "../../dist/declarations/src/cli";

package/cli/dist/commercetools-frontend-mc-scripts-cli.cjs.dev.js

@@ -0,0 +1,354 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _toConsumableArray = require('@babel/runtime-corejs3/helpers/toConsumableArray');
+var _asyncToGenerator = require('@babel/runtime-corejs3/helpers/asyncToGenerator');
+var _Array$isArray = require('@babel/runtime-corejs3/core-js-stable/array/is-array');
+var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
+var _forEachInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/for-each');
+var _regeneratorRuntime = require('@babel/runtime-corejs3/regenerator');
+var fs = require('fs');
+var path = require('path');
+var cac = require('cac');
+var dotenv = require('dotenv');
+var dotenvExpand = require('dotenv-expand');
+var _package = require('../../dist/package-aaf61bf0.cjs.dev.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var _Array$isArray__default = /*#__PURE__*/_interopDefault(_Array$isArray);
+var _filterInstanceProperty__default = /*#__PURE__*/_interopDefault(_filterInstanceProperty);
+var _forEachInstanceProperty__default = /*#__PURE__*/_interopDefault(_forEachInstanceProperty);
+var _regeneratorRuntime__default = /*#__PURE__*/_interopDefault(_regeneratorRuntime);
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var path__default = /*#__PURE__*/_interopDefault(path);
+var dotenv__default = /*#__PURE__*/_interopDefault(dotenv);
+var dotenvExpand__default = /*#__PURE__*/_interopDefault(dotenvExpand);
+
+var cli = cac.cac('mc-scripts'); // Makes the script crash on unhandled rejections instead of silently
+// ignoring them. In the future, promise rejections that are not handled will
+// terminate the Node.js process with a non-zero exit code.
+
+process.on('unhandledRejection', function (err) {
+  throw err;
+}); // Get the current directory where the CLI is executed from. Usually this is the application folder.
+
+var applicationDirectory = fs__default["default"].realpathSync(process.cwd());
+
+var run = function run() {
+  cli.help();
+  cli.version(_package.pkgJson.version);
+  cli.option('--env <path>', "(optional) Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed."); // Default command
+
+  cli.command('').action(function () {
+    cli.outputHelp();
+  }); // Command: start
+
+  cli.command('start', 'Starts the application in development mode using Webpack Dev Server.').alias('dev').action( /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee(options) {
+      var shouldUseExperimentalBundler, startCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.BABEL_ENV = 'development';
+              process.env.NODE_ENV = 'development';
+              shouldUseExperimentalBundler = process.env.ENABLE_EXPERIMENTAL_VITE_BUNDLER === 'true';
+
+              if (shouldUseExperimentalBundler) {
+                console.log('Experimental Vite bundler enabled! 🚀');
+                console.log('');
+              }
+
+              if (!shouldUseExperimentalBundler) {
+                _context.next = 11;
+                break;
+              }
+
+              _context.next = 8;
+              return Promise.resolve().then(function () { return require('../../dist/start-vite-737bacca.cjs.dev.js'); });
+
+            case 8:
+              _context.t0 = _context.sent;
+              _context.next = 14;
+              break;
+
+            case 11:
+              _context.next = 13;
+              return Promise.resolve().then(function () { return require('../../dist/start-2b953ab0.cjs.dev.js'); });
+
+            case 13:
+              _context.t0 = _context.sent;
+
+            case 14:
+              startCommand = _context.t0;
+              _context.next = 17;
+              return startCommand.default();
+
+            case 17:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }()); // Command: build
+
+  cli.command('build', 'Bundles the application in production mode. Outputs a "public" folder.').option('--build-only', '(optional) If defined, the command only creates the production bundles without compiling the "index.html".').action( /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee2(options) {
+      var shouldUseExperimentalBundler, buildCommand, shouldAlsoCompile, compileHtmlCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.BABEL_ENV = 'production';
+              process.env.NODE_ENV = 'production';
+              shouldUseExperimentalBundler = process.env.ENABLE_EXPERIMENTAL_VITE_BUNDLER === 'true';
+
+              if (shouldUseExperimentalBundler) {
+                console.log('Experimental Vite bundler enabled! 🚀');
+                console.warn('NOTE that the "cdnURL" value is not supported at the moment when using Vite.');
+                console.log('');
+              }
+
+              if (!shouldUseExperimentalBundler) {
+                _context2.next = 11;
+                break;
+              }
+
+              _context2.next = 8;
+              return Promise.resolve().then(function () { return require('../../dist/build-vite-6c987a60.cjs.dev.js'); });
+
+            case 8:
+              _context2.t0 = _context2.sent;
+              _context2.next = 14;
+              break;
+
+            case 11:
+              _context2.next = 13;
+              return Promise.resolve().then(function () { return require('../../dist/build-97278377.cjs.dev.js'); });
+
+            case 13:
+              _context2.t0 = _context2.sent;
+
+            case 14:
+              buildCommand = _context2.t0;
+              _context2.next = 17;
+              return buildCommand.default();
+
+            case 17:
+              shouldAlsoCompile = !options['build-only'];
+
+              if (!shouldAlsoCompile) {
+                _context2.next = 25;
+                break;
+              }
+
+              console.log('');
+              _context2.next = 22;
+              return Promise.resolve().then(function () { return require('../../dist/compile-html-0c588a89.cjs.dev.js'); });
+
+            case 22:
+              compileHtmlCommand = _context2.sent;
+              _context2.next = 25;
+              return compileHtmlCommand.default();
+
+            case 25:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+
+    return function (_x2) {
+      return _ref2.apply(this, arguments);
+    };
+  }()); // Command: compile-html
+
+  cli.command('compile-html', 'Compiles "index.html.template" file into a "index.html" with all the required runtime configuration. The security headers are also compiled and injected into the "index.html".').option('--transformer <path>', '(optional) The path to a JS module that can be used to generate a configuration for a specific cloud provider (e.g. Vercel, Netlify).').option('--print-security-headers', '(optional) If defined, the compiled security headers are printed to stdout.').action( /*#__PURE__*/function () {
+    var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee3(options) {
+      var compileHtmlCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.NODE_ENV = 'production';
+              _context3.next = 4;
+              return Promise.resolve().then(function () { return require('../../dist/compile-html-0c588a89.cjs.dev.js'); });
+
+            case 4:
+              compileHtmlCommand = _context3.sent;
+              _context3.next = 7;
+              return compileHtmlCommand.default(options);
+
+            case 7:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3);
+    }));
+
+    return function (_x3) {
+      return _ref3.apply(this, arguments);
+    };
+  }()); // Command: serve
+
+  cli.command('serve', 'Serves previously built and compiled application from the "public" folder.').action( /*#__PURE__*/function () {
+    var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee4(options) {
+      var serveCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee4$(_context4) {
+        while (1) {
+          switch (_context4.prev = _context4.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.NODE_ENV = 'production';
+              _context4.next = 4;
+              return Promise.resolve().then(function () { return require('../../dist/serve-12de323b.cjs.dev.js'); });
+
+            case 4:
+              serveCommand = _context4.sent;
+              _context4.next = 7;
+              return serveCommand.default();
+
+            case 7:
+            case "end":
+              return _context4.stop();
+          }
+        }
+      }, _callee4);
+    }));
+
+    return function (_x4) {
+      return _ref4.apply(this, arguments);
+    };
+  }()); // Command: login
+
+  cli.command('login', 'Log in to your Merchant Center account through the CLI, using the cloud environment information from the Custom Application config file. An API token is generated and stored in a configuration file for the related cloud environment, and valid for 36 hours.').action( /*#__PURE__*/function () {
+    var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee5(options) {
+      var loginCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.NODE_ENV = 'production';
+              _context5.next = 4;
+              return Promise.resolve().then(function () { return require('../../dist/login-779552b7.cjs.dev.js'); });
+
+            case 4:
+              loginCommand = _context5.sent;
+              _context5.next = 7;
+              return loginCommand.default();
+
+            case 7:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5);
+    }));
+
+    return function (_x5) {
+      return _ref5.apply(this, arguments);
+    };
+  }()); // Command: config:sync
+
+  cli.command('config:sync', 'Synchronizes the local Custom Application config with the Merchant Center. A new Custom Application will be created if none existed, otherwise it will be updated.').option('--dry-run', '(optional) Executes the command but does not send any mutation request.').action( /*#__PURE__*/function () {
+    var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime__default["default"].mark(function _callee6(options) {
+      var configSyncCommand;
+      return _regeneratorRuntime__default["default"].wrap(function _callee6$(_context6) {
+        while (1) {
+          switch (_context6.prev = _context6.next) {
+            case 0:
+              // Load dotenv files into the process environment.
+              // This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+              loadDotEnvFiles(options); // Do this as the first thing so that any code reading it knows the right env.
+
+              process.env.NODE_ENV = 'production';
+              _context6.next = 4;
+              return Promise.resolve().then(function () { return require('../../dist/config-sync-d52e73f6.cjs.dev.js'); });
+
+            case 4:
+              configSyncCommand = _context6.sent;
+              _context6.next = 7;
+              return configSyncCommand.default(options);
+
+            case 7:
+            case "end":
+              return _context6.stop();
+          }
+        }
+      }, _callee6);
+    }));
+
+    return function (_x6) {
+      return _ref6.apply(this, arguments);
+    };
+  }());
+  cli.parse();
+}; // Load dotenv files into the process environment.
+// This is essentially what `dotenv-cli` does, but it's now built into this CLI.
+// Inspired also by https://create-react-app.dev/docs/adding-custom-environment-variables/#what-other-env-files-can-be-used
+
+
+function loadDotEnvFiles(globalOptions) {
+  var _context7;
+
+  var environment = process.env.MC_APP_ENV || process.env.NODE_ENV;
+  var dotenvFiles = []; // Custom dotenv files specified by the `--env` option takes precedence.
+
+  if (typeof globalOptions.env === 'string') {
+    dotenvFiles.push(globalOptions.env);
+  } else if (_Array$isArray__default["default"](globalOptions.env)) {
+    // Multiple `--env` options are allowed.
+    dotenvFiles.push.apply(dotenvFiles, _toConsumableArray(globalOptions.env));
+  } // https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
+
+
+  dotenvFiles.push.apply(dotenvFiles, _toConsumableArray(_filterInstanceProperty__default["default"](_context7 = [".env.".concat(environment, ".local"), // Don't include `.env.local` for `test` environment
+  // since normally you expect tests to produce the same
+  // results for everyone
+  process.env.NODE_ENV !== 'test' && ".env.local", ".env.".concat(environment), '.env']).call(_context7, Boolean))); // Load environment variables from .env* files. Suppress warnings using silent
+  // if this file is missing. dotenv will never modify any environment variables
+  // that have already been set.  Variable expansion is supported in .env files.
+  // https://github.com/motdotla/dotenv
+  // https://github.com/motdotla/dotenv-expand
+
+  _forEachInstanceProperty__default["default"](dotenvFiles).call(dotenvFiles, function (dotenvFile) {
+    var dotenvFilePath = path__default["default"].resolve(path__default["default"].join(applicationDirectory, dotenvFile));
+
+    if (fs__default["default"].existsSync(dotenvFilePath)) {
+      dotenvExpand__default["default"].expand(dotenv__default["default"].config({
+        path: dotenvFilePath
+      }));
+    }
+  });
+}
+
+exports.loadDotEnvFiles = loadDotEnvFiles;
+exports.run = run;

package/cli/dist/commercetools-frontend-mc-scripts-cli.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./commercetools-frontend-mc-scripts-cli.cjs.prod.js");
+} else {
+  module.exports = require("./commercetools-frontend-mc-scripts-cli.cjs.dev.js");
+}