@raisenow/tamaro-cli 1.0.8 → 1.0.9

package/dist/webpack.config.js

@@ -46,6 +46,7 @@ __export(webpack_config_exports, {
   default: () => webpack_config_default
 });
 var import_path2 = require("path");
+var import_fs2 = require("fs");
 var import_glob = __toESM(require("glob"));
 var import_webpack_config_utils2 = require("webpack-config-utils");
 var import_webpack = __toESM(require("webpack"));
@@ -91,18 +92,17 @@ var InterpolateHtmlPlugin_default = InterpolateHtmlPlugin;
 var import_path = require("path");
 var import_fs = require("fs");
 var import_chalk = __toESM(require("chalk"));
-var import_node_notifier = require("node-notifier");
+var import_node_notifier = __toESM(require("node-notifier"));
 var import_webpack_config_utils = require("webpack-config-utils");
 var import_columnify = __toESM(require("columnify"));
 var import_boxen = __toESM(require("boxen"));
 var import_dotenv_expand = require("dotenv-expand");
 var import_dotenv = require("dotenv");
+var import_open = __toESM(require("open"));
 var import_strip_indent = __toESM(require("strip-indent"));
-var TAMARO_CORE_PACKAGE_NAMES = ["@raisenow/tamaro-core", "demo-tamaro-core"];
-var TAMARO_CONFIGURATIONS_PACKAGE_NAMES = [
-  "@raisenow/tamaro-configurations",
-  "demo-tamaro-configurations"
-];
+var import_execa = require("execa");
+var TAMARO_CORE_PACKAGE_NAMES = ["@raisenow/tamaro-core"];
+var TAMARO_CONFIGURATIONS_PACKAGE_NAMES = ["@raisenow/tamaro-configurations"];
 var getIfCoreFns = () => {
   const corePkgPath = resolveApp("package.json");
   const configsPkgPath = resolveApp("../../package.json");
@@ -118,12 +118,12 @@ var getIfCoreFns = () => {
       return (0, import_webpack_config_utils.getIfUtils)({ core: false }, ["core"]);
     }
   }
-  console.error(import_chalk.default.red((0, import_strip_indent.default)(`      You must run "npx @raisenow/tamaro-cli" commands from:
+  logError((0, import_strip_indent.default)(`      You must run "npx @raisenow/tamaro-cli" commands from:
       1. Root of "${import_chalk.default.bold(TAMARO_CORE_PACKAGE_NAMES[0])}" package folder.
       2. Root of particular customer configuration folder of "${import_chalk.default.bold(TAMARO_CONFIGURATIONS_PACKAGE_NAMES[0])}" package.
       You are currently in "${import_chalk.default.bold((0, import_fs.realpathSync)(process.cwd()))}".
-    `)));
-  process.exit(0);
+    `));
+  process.exit(1);
 };
 var moduleFileExtensions = ["ts", "tsx", "js", "jsx"];
 var extensions = moduleFileExtensions.map((v) => `.${v}`);
@@ -158,6 +158,15 @@ var getPaths = (ifCore) => {
     appTailwindConfig: void 0
   });
 };
+var getRelativePaths = (paths) => {
+  const relativePaths = {};
+  for (const [type, absPath] of Object.entries(paths)) {
+    if (absPath) {
+      relativePaths[type] = (0, import_path.relative)("./", absPath) || ".";
+    }
+  }
+  return relativePaths;
+};
 var getEnvVars = (filePath, ifMin, ifCore, ifLocalCore) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
   (0, import_dotenv_expand.expand)((0, import_dotenv.config)({ path: filePath }));
@@ -208,12 +217,23 @@ var getEnvVars = (filePath, ifMin, ifCore, ifLocalCore) => {
   };
   return { raw, stringified };
 };
+var logError = (message) => {
+  if (message) {
+    console.log(import_chalk.default.red(message));
+  }
+};
 var logDataTable = (vars, title) => {
-  const boxTitle = import_chalk.default.bold(`${title}:
-`);
-  const boxTable = (0, import_columnify.default)(vars, { showHeaders: false });
-  console.log((0, import_boxen.default)(`${boxTitle}
-${boxTable}`, {
+  logTable((0, import_columnify.default)(vars, { showHeaders: false }), title);
+};
+var logTable = (text, title) => {
+  let out = "";
+  const boxTitle = title ? import_chalk.default.bold(`${title}`) : void 0;
+  if (boxTitle) {
+    out += `${boxTitle}
+`;
+  }
+  out += text;
+  console.log((0, import_boxen.default)(out, {
     margin: 0,
     padding: {
       top: 0,
@@ -237,7 +257,8 @@ var getWebpackConfig = async (env) => {
   const envVars = getEnvVars(paths.appEnv, ifMin, ifCore, ifLocalCore);
   const { ifHmr } = (0, import_webpack_config_utils2.getIfUtils)({ hmr: process.env.HMR_ENABLED === "true" }, ["hmr"]);
   const port = await (0, import_portfinder.getPortPromise)({ port: 1234 });
-  logDataTable(paths, "Paths");
+  const useTailwind = ifCore() && paths.appTailwindConfig && (0, import_fs2.existsSync)(paths.appTailwindConfig);
+  logDataTable(getRelativePaths(paths), "Paths");
   logDataTable(envVars.raw, "Environment variables");
   const getCssLoaders = (cssOptions = {}) => {
     return (0, import_webpack_config_utils2.removeEmpty)([
@@ -262,7 +283,12 @@ var getWebpackConfig = async (env) => {
         options: {
           postcssOptions: {
             plugins: (0, import_webpack_config_utils2.removeEmpty)([
-              ifCore([require.resolve("tailwindcss"), paths.appTailwindConfig]),
+              useTailwind ? [
+                require.resolve("tailwindcss", {
+                  paths: [paths.appNodeModules]
+                }),
+                paths.appTailwindConfig
+              ] : void 0,
               require.resolve("postcss-custom-properties"),
               require.resolve("autoprefixer")
             ])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
@@ -12,8 +12,7 @@
     "dev": "npm run build -- --watch --ignore-watch .idea",
     "build": "tsup src/cli.ts src/webpack.config.ts --format cjs",
     "docs": "npx -y http-server . --cors -o /readme.html",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint . --fix && prettier --write ."
   },
   "bin": "dist/cli.js",
   "engines": {
@@ -21,83 +20,81 @@
     "npm": ">=8"
   },
   "dependencies": {
-    "@babel/cli": "^7.16.8",
-    "@babel/core": "^7.16.12",
-    "@babel/plugin-proposal-decorators": "^7.16.7",
+    "@babel/cli": "^7.17.0",
+    "@babel/core": "^7.17.0",
+    "@babel/plugin-proposal-decorators": "^7.17.0",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.16.10",
+    "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
-    "@babel/runtime-corejs3": "^7.16.8",
+    "@babel/runtime-corejs3": "^7.17.0",
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.4",
-    "@statoscope/webpack-plugin": "^5.20.0",
-    "@svgr/webpack": "^6.2.0",
+    "@statoscope/webpack-plugin": "^5.20.1",
+    "@svgr/webpack": "^6.2.1",
     "@types/columnify": "^1.5.1",
     "@types/lodash": "^4.14.178",
     "@types/mini-css-extract-plugin": "^2.5.1",
-    "@types/node": "^17.0.12",
+    "@types/node": "^17.0.16",
     "@types/node-notifier": "^8.0.2",
     "@types/resolve-bin": "^0.4.1",
     "@types/webpack-config-utils": "^2.3.1",
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
+    "@typescript-eslint/eslint-plugin": "^5.11.0",
+    "@typescript-eslint/parser": "^5.11.0",
     "autoprefixer": "^10.4.2",
     "babel-loader": "^8.2.3",
     "babel-plugin-lodash": "^3.3.4",
     "boxen": "^5.1.2",
     "chalk": "^4.1.2",
     "clean-webpack-plugin": "^4.0.0",
-    "columnify": "^1.5.4",
-    "commander": "^8.3.0",
-    "copy-webpack-plugin": "^10.2.1",
-    "core-js": "^3.20.3",
-    "css-loader": "^6.5.1",
+    "columnify": "^1.6.0",
+    "commander": "^9.0.0",
+    "copy-webpack-plugin": "^10.2.4",
+    "core-js": "^3.21.0",
+    "css-loader": "^6.6.0",
     "css-minimizer-webpack-plugin": "^3.4.1",
     "current-script-polyfill": "^1.0.0",
-    "dotenv": "^14.3.2",
-    "dotenv-expand": "^6.0.1",
+    "dotenv": "^16.0.0",
+    "dotenv-expand": "^8.0.1",
     "element-closest": "^3.0.2",
     "escape-string-regexp": "^4.0.0",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.8.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-webpack-plugin": "^3.1.0",
     "execa": "^5.1.1",
     "file-loader": "^6.2.0",
-    "fork-ts-checker-webpack-plugin": "^6.5.0",
+    "fork-ts-checker-webpack-plugin": "^7.1.1",
     "glob": "^7.2.0",
     "html-loader": "^3.1.0",
     "html-webpack-plugin": "^5.5.0",
     "json-loader": "^0.5.7",
     "lodash": "^4.17.21",
     "mini-css-extract-plugin": "^2.5.3",
-    "node-notifier": "^10.0.0",
+    "node-notifier": "^10.0.1",
+    "open": "^8.4.0",
     "portfinder": "^1.0.28",
-    "postcss": "^8.4.5",
-    "postcss-custom-properties": "^12.1.3",
+    "postcss": "^8.4.6",
+    "postcss-custom-properties": "^12.1.4",
     "postcss-loader": "^6.2.1",
     "prettier": "^2.5.1",
     "react-refresh": "^0.11.0",
     "resolve-bin": "^1.0.0",
     "resolve-url-loader": "^5.0.0",
-    "sass": "^1.49.0",
+    "sass": "^1.49.7",
     "sass-loader": "^12.4.0",
     "source-map-loader": "^3.0.1",
     "strip-indent": "^3.0.0",
     "style-loader": "^3.3.1",
-    "tailwindcss": "^0.7.4",
     "tsconfig-paths-webpack-plugin": "^3.5.2",
-    "tsup": "^5.11.11",
+    "tsup": "^5.11.13",
     "typescript": "^4.5.5",
     "unfetch": "^4.2.0",
     "url-loader": "^4.1.1",
-    "webpack": "^5.67.0",
+    "webpack": "^5.68.0",
     "webpack-cli": "^4.9.2",
     "webpack-config-utils": "^2.3.1",
-    "webpack-dev-server": "^4.7.3",
+    "webpack-dev-server": "^4.7.4",
     "yaml-loader": "^0.6.0"
   }
 }

package/readme.md

@@ -1,179 +1,206 @@
 # Getting started
 
-It's a command-line interface for all operations with Tamaro customer configurations and *Tamaro Core*.
+It’s a command-line interface for all operations with Tamaro customer configurations and _Tamaro Core_.
 
-You don't need to install it manually. The recommended way is to run it using `npx` command, which must be available along with `node` and `npm` commands.
+You don’t need to install it manually. The recommended way to run it is by using the `npx` command, which comes along with NPM.
 
 # Usage
 
-To see an overview of all possible commands just run the following command without any arguments:
+To see an overview of all possible commands just run the following command without any arguments.
 
 ```bash
 npx -y @raisenow/tamaro-cli
 ```
 
-To see the info about some particular command (for example `dev` command), prepend `help` before the command name:
+To see the informoation about some particular command (for example `dev` command), prepend `help` before the command name:
 
 ```bash
 npx -y @raisenow/tamaro-cli help dev
 ```
 
-Substitute `dev` with the command you want to get info about.
+Substitute `dev` with the command you want to get information about.
 
 # Commands
 
 Available commands:
-- [dev](#dev)
-- [build](#build)
-- [deploy](#deploy)
-- [serve](#serve)
 
-## dev
+- [`dev`](#dev)
+- [`build`](#build)
+- [`deploy`](#deploy)
+- [`serve`](#serve)
+- [`list-deployed`](#list-deployed)
+- [`deploy-email-config`](#deploy-email-config)
 
-Runs development web-server for *Tamaro Core* or particular customer configuration.
+## `dev`
 
-Options:
-- `--local-core` – Load *Tamaro Core* from localhost instead of CDN
+Runs the local development server for _Tamaro Core_ or a particular customer configuration.
 
-### Run development web-server using Tamaro Core from CDN
+### Options
 
-Run development web-server for `example-02-typical-customisations` customer configuration.
+- `--local-core` – Load _Tamaro Core_ from localhost instead of the CDN
 
-After running this command, development web-server should be running on http://localhost:1234/ (port may differ).
+### Run local server using Tamaro Core from CDN
+
+Run the local development server for the _example-02-typical-customisations_ customer configuration. You will be able to access Tamaro on http://localhost:1234 (port may differ, see console output).
 
 ```bash
 cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
 npx -y @raisenow/tamaro-cli dev
 ```
 
-### Run development web-server using locally running Tamaro Core
+### Run local server using a locally running Tamaro Core
 
-1.  Run development web-server for *Tamaro Core* in the first terminal tab.
-    
-    After running this command, development web-server should be running on http://localhost:1234/ (port may differ).
+1.  Run the local development web server for _Tamaro Core_ in the first terminal tab. You will be able to access a default configuration of Tamaro on http://localhost:1234 (port may differ, see console output).
 
     ```bash
     cd /path/to/tamaro-core
     npx -y @raisenow/tamaro-cli dev
     ```
 
-2.  Run development web-server for `example-02-typical-customisations` customer configuration in the second terminal tab.
-    
-    After running this command, development web-server should be running on http://localhost:1235/ (port may differ).
+2.  Run the local development web server for the _example-02-typical-customisations_ customer configuration in the second terminal tab. After running this command, you will able to access the configuration on http://localhost:1235 (port may differ, see console output).
 
     ```bash
     cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
     npx -y @raisenow/tamaro-cli dev --local-core
     ```
 
-## build
+## `build`
 
-Build optimised (minified) bundle of *Tamaro Core* or customer configuration for production.
+Build an optimised (minified) bundle of _Tamaro Core_ or a customer configuration.
 
-Options:
-- `--local-core` – Load *Tamaro Core* from localhost instead of CDN
-- `--analyze` – Generate bundle statistics to `reports` folder
-- `--deploy` – Deploy *Tamaro Core* or customer configuration bundle to AWS
-- `--serve` – Run web-server for the bundle
-- `--tag <tag>` – Tag which will be used for deployment of the bundle
+### Options
 
-Before trying to deploy a bundle, make sure you have proper AWS credentials in your environment, otherwise deployment will fail.
-More info about configuring AWS credentials and profiles is in the [wiki page](https://raisenow.atlassian.net/wiki/spaces/DEVOPS/pages/3201731220).
+- `--local-core` – Load _Tamaro Core_ from localhost instead of the CDN
+- `--analyze` – Generate bundle statistics to `reports` folder
+- `--deploy` – Deploy _Tamaro Core_ or a customer configuration bundle to AWS S3
+- `--serve` – Run the generated bundle with a local web server
+- `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: “latest”)
+- `--profile <profile>` – AWS profile which should be used for the deployment of the bundle (default: “payments-prod-cs-deployer”)
 
-### Build and deploy customer configuration
+### Build and deploy a customer configuration
 
-Build and deploy optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
+Build and deploy an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration.
 
 ```bash
 cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
 npx -y @raisenow/tamaro-cli build --deploy
 ```
 
-As a result bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/latest/index.html
+As a result, the bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/latest/
 
-### Build and deploy customer configuration with a specific tag
+### Build and deploy a customer configuration with a specific tag
 
-Build and deploy optimised (minified) bundle of `example-02-typical-customisations` customer configuration with `WEB-123` tag.
+Build and deploy an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration with the tag _WEB-123_.
 
 ```bash
 cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
 npx -y @raisenow/tamaro-cli build --deploy --tag WEB-123
 ```
 
-As a result bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/WEB-123/index.html
+As a result, the bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/WEB-123/
 
-### Build and serve customer configuration
+### Build and serve a customer configuration
 
-Build and serve optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
+Build and serve an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration.
 
-After running this command, web-server should be running on http://localhost:1234/ (port may differ).
+After running this command, a local web server should be running on http://localhost:1234 (port may differ, see console output).
 
 ```bash
 cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
 npx -y @raisenow/tamaro-cli build --serve
 ```
 
+## `deploy`
 
-## deploy
+Deploy a pre-built _Tamaro Core_ or customer configuration bundle to AWS S3.
 
-Deploy prebuilt Tamaro Core or customer configuration bundle to AWS.
+### Options
 
-Options:
-- `--tag <tag>` – Tag which will be used for deployment of the bundle
+- `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: “latest”)
+- `--profile <profile>` – AWS profile which should be used for the deployment of the bundle (default: “payments-prod-cs-deployer”)
 
-Make sure you have built the bundle before deploying it with this command, otherwise you may mistakenly deploy the bundle from previous build.
+Make sure you have built the bundle before deploying it with this command, otherwise you may mistakenly deploy the bundle from a previous build.
 
-Example:
+### Example
 
-1. Build optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
+1. Build an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration
 
-    ```bash
-    cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-    npx -y @raisenow/tamaro-cli build
-    ```
+   ```bash
+   cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
+   npx -y @raisenow/tamaro-cli build
+   ```
 
-2.  Deploy it:
+2. Deploy it
 
-    ```bash
-    npx -y @raisenow/tamaro-cli deploy
-    ```
+   ```bash
+   npx -y @raisenow/tamaro-cli deploy
+   ```
 
-3.  Optionally deploy it with `WEB-123` tag:
+3. Optionally, deploy it with the _WEB-123_ tag
 
-    ```bash
-    npx -y @raisenow/tamaro-cli deploy --tag WEB-123
-    ```
+   ```bash
+   npx -y @raisenow/tamaro-cli deploy --tag WEB-123
+   ```
 
-## serve
+## `serve`
 
-Run web-server for prebuilt bundle.
+Run a local web server for pre-built bundle.
 
-Example:
+### Example
 
-1.  Build optimised (minified) bundle of `example-02-typical-customisations` customer configuration.
+1.  Build an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration
 
     ```bash
     cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
     npx -y @raisenow/tamaro-cli build
     ```
 
-2.  Serve it.
-
-    After running this command, web-server should be running on http://localhost:1234/ (port may differ).
+2.  Serve it. After running this command, web-server should be running on http://localhost:1234 (port may differ, see console output).
 
     ```bash
     npx -y @raisenow/tamaro-cli serve
     ```
 
+## `list-deployed`
+
+List deployments of _Tamaro Core_ or a particular customer configuration.
+
+### Options
+
+- `--config <config>` – Configuration name (default: current customer configuration)
+- `--profile <profile>` – AWS profile which should be used for fetching deployments (default: “payments-prod-cs-deployer”)
+
+### Example
+
+```bash
+cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
+npx -y @raisenow/tamaro-cli list-deployed
+```
+
+## `deploy-email-config`
+
+Deploy a widget’s email configuration to AWS S3.
+
+### Options
+
+- `--bucket <bucket>` – AWS S3 bucket where it should be deployed (default: “rnw-email-service”)
+- `--profile <profile>` – AWS profile which should be used for the deployment of email configuration (default: “payments-prod-cs-deployer”)
+
+### Example
+
+```bash
+cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
+npx -y @raisenow/tamaro-cli deploy-email-config
+```
 
 # Development
 
-Make sure you have installed and activated proper `node` and `npm` versions.
+Make sure you have installed and activated the proper `node` and `npm` versions.
 
 - `node: ">= 16"`
 - `npm: ">= 8"`
 
-Clone the repo and install its dependencies:
+Clone the repository and install its dependencies:
 
 ```bash
 git clone git@bitbucket.org:raisenow/tamaro-cli.git
@@ -187,14 +214,13 @@ Link package source to be able to run its local version:
 npm link .
 ```
 
-Run the `dev` script to watch source files and automatically rebuild on changes.
-It must be running during *Tamaro CLI* development process. 
+Run the `dev` script to watch source files and automatically rebuild on changes. It must be running during the _Tamaro CLI_ development process.
 
 ```bash
 npm run dev
 ```
 
-To use local linked version of *Tamaro CLI*, use it without `@raisenow/` scope, `-y` flag is also not needed:
+To use the locally linked version of _Tamaro CLI_, use it without `@raisenow/` scope, `-y` flag is also not needed:
 
 ```bash
 npx tamaro-cli dev