@raisenow/tamaro-cli 1.0.8 → 1.0.11

package/.eslintignore

@@ -1,2 +1,3 @@
 dist/*
 node_modules/*
+tsconfig.json

package/{.eslintrc.js → .eslintrc.cjs}

@@ -1,8 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const {resolve} = require('path')
-
-///////////////////////////////////////////////////////////////////////////////
-
 module.exports = {
   root: true,
   env: {
@@ -21,33 +16,26 @@ module.exports = {
     'eslint:recommended',
     'plugin:node/recommended',
     'plugin:promise/recommended',
-    // 'plugin:unicorn/recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
+    'prettier',
   ],
   plugins: [],
   rules: {
     curly: 1,
-
     'node/no-unsupported-features/es-syntax': 0,
     'node/no-missing-import': 0,
     'node/shebang': 0,
     'no-process-exit': 0,
-
     '@typescript-eslint/ban-ts-comment': 0,
     '@typescript-eslint/no-explicit-any': 0,
     '@typescript-eslint/no-non-null-assertion': 0,
     '@typescript-eslint/prefer-optional-chain': 1,
-
-    'prettier/prettier': 1,
-    'arrow-body-style': 0,
-    'prefer-arrow-callback': 0,
   },
   overrides: [
     {
       files: ['*.ts', '*.tsx'],
       parserOptions: {
-        project: resolve(__dirname, 'tsconfig.json'),
+        project: 'tsconfig.json',
       },
     },
   ],

package/.gitignore

@@ -1,14 +1,13 @@
 /*
 !src
 !.eslintignore
-!.eslintrc.js
+!.eslintrc.cjs
 !.gitignore
 !.nvmrc
 !.prettierignore
-!.prettierrc.js
-!global.d.ts
+!.prettierrc.cjs
 !package.json
 !package-lock.json
-!readme.html
-!readme.md
 !tsconfig.json
+!readme.html
+!README.md

package/.nvmrc

@@ -1 +1 @@
-16.13.2
+16.14.0

package/.prettierignore

@@ -1,2 +1,3 @@
 dist/*
 node_modules/*
+tsconfig.json

package/README.md

@@ -0,0 +1,229 @@
+# Getting started
+
+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 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.
+
+```bash
+npx -y @raisenow/tamaro-cli
+```
+
+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 information about.
+
+# Commands
+
+Available commands:
+
+- [`dev`](#dev)
+- [`build`](#build)
+- [`serve`](#serve)
+- [`deploy`](#deploy)
+- [`list-deployed`](#list-deployed)
+- [`deploy-email-config`](#deploy-email-config)
+
+## `dev`
+
+Runs the local development server for _Tamaro Core_ or a particular customer configuration.
+
+### Options
+
+- `--local-core` – Load _Tamaro Core_ from localhost:1234 instead of the CDN
+- `--port <port>` – Web server port (default: 1234)
+
+### 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 local server using a locally running Tamaro Core
+
+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 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 an optimised (minified) bundle of _Tamaro Core_ or a customer configuration.
+
+### Options
+
+- `--local-core` – Load _Tamaro Core_ from localhost:1234 instead of the CDN
+- `--analyze` – Generate bundle statistics to `reports` folder
+- `--serve` – Run the generated bundle with a local web server
+- `--port <port>` – Web server port (default: 1234)
+- `--deploy` – Deploy _Tamaro Core_ or a customer configuration bundle to AWS S3
+- `--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 a 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, the bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/latest/
+
+### Build and deploy a customer configuration with a specific 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, the bundle should be deployed to: https://tamaro.raisenow.com/example-02-typical-customisations/WEB-123/
+
+### Build and serve a customer configuration
+
+Build and serve an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration.
+
+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
+```
+
+## `serve`
+
+Run a local web server for pre-built bundle.
+
+### Example
+
+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, see console output).
+
+    ```bash
+    npx -y @raisenow/tamaro-cli serve
+    ```
+
+## `deploy`
+
+Deploy a pre-built _Tamaro Core_ or customer configuration bundle to AWS S3.
+
+### Options
+
+- `--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 a previous build.
+
+### Example
+
+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.  Deploy it
+
+    ```bash
+    npx -y @raisenow/tamaro-cli deploy
+    ```
+
+3.  Optionally, deploy it with the _WEB-123_ tag
+
+    ```bash
+    npx -y @raisenow/tamaro-cli deploy --tag WEB-123
+    ```
+
+## `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 the proper `node` and `npm` versions.
+
+- `node: ">= 16"`
+- `npm: ">= 8"`
+
+Clone the repository and install its dependencies:
+
+```bash
+git clone git@bitbucket.org:raisenow/tamaro-cli.git
+cd tamaro-cli
+npm ci
+```
+
+Link package source to be able to run its local version:
+
+```bash
+npm link .
+```
+
+Run the `build:watch` script to watch source files and automatically rebuild on changes. It must be running during the _Tamaro CLI_ development process.
+
+```bash
+npm run build:watch
+```
+
+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
+```

package/dist/chunk-PIEFLCDU.js

@@ -0,0 +1,144 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+
+// node_modules/tsup/assets/esm_shims.js
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+
+// src/lib/logging.ts
+import chalk from "chalk";
+import stripIndent from "strip-indent";
+import columnify from "columnify";
+var logTitle = (title) => {
+  console.log(`${chalk.bold(title)}`);
+};
+var logError = (message) => {
+  if (message) {
+    console.log(chalk.red(message));
+  }
+};
+var logCommand = (cmd) => {
+  console.log(`
+${chalk.dim(stripIndent(cmd).trim())}
+`);
+};
+var logDataTable = (data) => {
+  console.log(columnify(data, { showHeaders: false }));
+  console.log("");
+};
+
+// src/lib/resolve.ts
+import { createRequire } from "module";
+import { basename, dirname, join, relative, resolve } from "path";
+import { existsSync, realpathSync } from "fs";
+import { getIfUtils } from "webpack-config-utils";
+import stripIndent2 from "strip-indent";
+import chalk2 from "chalk";
+var require2 = createRequire(import.meta.url);
+var moduleFileExtensions = ["ts", "tsx", "js", "jsx"];
+var extensions = moduleFileExtensions.map((v) => `.${v}`);
+var TAMARO_CORE_PACKAGE_NAMES = ["@raisenow/tamaro-core"];
+var TAMARO_CONFIGURATIONS_PACKAGE_NAMES = ["@raisenow/tamaro-configurations"];
+var resolveApp = (relativePath) => resolve(realpathSync(process.cwd()), relativePath);
+var resolveOwn = (relativePath) => resolve(__dirname, "..", relativePath);
+var resolveModule = (resolveFn, filePath) => {
+  const extension = moduleFileExtensions.find((extension2) => existsSync(resolveFn(`${filePath}.${extension2}`)));
+  if (extension) {
+    return resolveFn(`${filePath}.${extension}`);
+  }
+  return resolveFn(`${filePath}.js`);
+};
+var resolveBin = (name) => {
+  const pkgPath = require2.resolve(`${name}/package.json`);
+  const { bin } = require2(pkgPath);
+  const dir = dirname(pkgPath);
+  const binPath = typeof bin === "object" ? bin[name] : bin;
+  return join(dir, binPath);
+};
+var getWidgetUuid = () => basename(resolveApp("."));
+var getPaths = (ifCore) => {
+  return ifCore({
+    app: resolveApp("."),
+    appEntry: resolveModule(resolveApp, "src/index"),
+    appDist: resolveApp("dist"),
+    appNodeModules: resolveApp("node_modules"),
+    appTsConfig: resolveApp("tsconfig.json"),
+    appHtml: resolveApp("src/*.html"),
+    appEnv: resolveApp(".env"),
+    appTailwindConfig: resolveApp("tailwind.config.js")
+  }, {
+    app: resolveApp("."),
+    appEntry: resolveModule(resolveApp, "widget"),
+    appDist: resolveApp(`../../dist/${getWidgetUuid()}`),
+    appNodeModules: resolveApp("../../node_modules"),
+    appTsConfig: resolveApp("tsconfig.json"),
+    appHtml: resolveApp("*.html"),
+    appEnv: resolveApp(".env"),
+    appTailwindConfig: void 0
+  });
+};
+var getRelativePaths = (paths) => {
+  const relativePaths = {};
+  for (const [type, absPath] of Object.entries(paths)) {
+    if (absPath) {
+      relativePaths[type] = relative("./", absPath) || ".";
+    }
+  }
+  return relativePaths;
+};
+var getIfCoreFns = () => {
+  const corePkgPath = resolveApp("package.json");
+  const configsPkgPath = resolveApp("../../package.json");
+  if (existsSync(corePkgPath)) {
+    const { name } = require2(corePkgPath);
+    if (TAMARO_CORE_PACKAGE_NAMES.includes(name)) {
+      return getIfUtils({ core: true }, ["core"]);
+    }
+  }
+  if (existsSync(configsPkgPath)) {
+    const { name } = require2(configsPkgPath);
+    if (TAMARO_CONFIGURATIONS_PACKAGE_NAMES.includes(name)) {
+      return getIfUtils({ core: false }, ["core"]);
+    }
+  }
+  logError(stripIndent2(`      You must run "npx @raisenow/tamaro-cli" commands from:
+      1. Root of "${chalk2.bold(TAMARO_CORE_PACKAGE_NAMES[0])}" package folder.
+      2. Root of particular customer configuration folder of "${chalk2.bold(TAMARO_CONFIGURATIONS_PACKAGE_NAMES[0])}" package.
+      You are currently in "${chalk2.bold(realpathSync(process.cwd()))}".
+    `));
+  process.exit(1);
+};
+
+export {
+  __spreadValues,
+  logTitle,
+  logError,
+  logCommand,
+  logDataTable,
+  moduleFileExtensions,
+  extensions,
+  resolveApp,
+  resolveOwn,
+  resolveBin,
+  getWidgetUuid,
+  getPaths,
+  getRelativePaths,
+  getIfCoreFns
+};