@raisenow/tamaro-cli 1.0.8 → 1.0.11

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.0.8",
+  "version": "1.0.11",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
   },
-  "main": "dist/cli.js",
+  "type": "module",
   "scripts": {
     "prepare": "npm run build",
     "start": "npm run dev",
-    "dev": "npm run build -- --watch --ignore-watch .idea",
-    "build": "tsup src/cli.ts src/webpack.config.ts --format cjs",
+    "build": "tsup src/cli.ts src/webpack.config.ts --clean --format esm",
+    "build:watch": "npm run build -- --watch --ignore-watch .idea",
     "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,75 @@
     "npm": ">=8"
   },
   "dependencies": {
-    "@babel/cli": "^7.16.8",
-    "@babel/core": "^7.16.12",
-    "@babel/plugin-proposal-decorators": "^7.16.7",
+    "@babel/cli": "^7.17.3",
+    "@babel/core": "^7.17.5",
+    "@babel/plugin-proposal-decorators": "^7.17.2",
     "@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.2",
     "@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.21",
     "@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.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
     "autoprefixer": "^10.4.2",
     "babel-loader": "^8.2.3",
     "babel-plugin-lodash": "^3.3.4",
-    "boxen": "^5.1.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.0.0",
     "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.1",
+    "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",
-    "element-closest": "^3.0.2",
-    "escape-string-regexp": "^4.0.0",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
+    "dotenv": "^16.0.0",
+    "dotenv-expand": "^8.0.1",
+    "escape-string-regexp": "^5.0.0",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^8.4.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",
+    "eslint-webpack-plugin": "^3.1.1",
+    "execa": "^6.1.0",
     "file-loader": "^6.2.0",
-    "fork-ts-checker-webpack-plugin": "^6.5.0",
+    "fork-ts-checker-webpack-plugin": "^7.2.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",
     "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-loader": "^12.4.0",
+    "sass": "^1.49.8",
+    "sass-loader": "^12.6.0",
     "source-map-loader": "^3.0.1",
-    "strip-indent": "^3.0.0",
+    "strip-indent": "^4.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.69.1",
     "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.html

@@ -40,7 +40,7 @@
         name: '@raisenow/tamaro-cli',
         // themeColor: '#537397',
         maxLevel: 2,
-        homepage: './readme.md',
+        homepage: './README.md',
         coverpage: false,
       }
     </script>

package/src/cli.ts

@@ -2,10 +2,22 @@
 
 import {createCommand} from 'commander'
 import pkg from '../package.json'
+import {
+  DEFAULT_AWS_PROFILE,
+  DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET,
+  DEFAULT_PORT,
+  DEFAULT_TAG,
+} from 'lib/constants'
+import {logError} from 'lib/logging'
 import {dev, DevOptions} from 'commands/dev'
 import {build, BuildOptions} from 'commands/build'
 import {deploy, DeployOptions} from 'commands/deploy'
-import {serve} from 'commands/serve'
+import {serve, ServeOptions} from 'commands/serve'
+import {listDeployed, ListDeployedOptions} from 'commands/list-deployed'
+import {
+  deployEmailConfig,
+  DeployEmailConfigOptions,
+} from 'commands/deploy-email-config'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -18,7 +30,7 @@ process.on('unhandledRejection', (error) => {
 
 // Exit on ctrl+c
 process.on('SIGINT', () => {
-  process.exit(0)
+  process.exit(1)
 })
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -29,8 +41,15 @@ const cli = createCommand().name(pkg.name).version(pkg.version, '-v, --version')
 
 cli
   .command('dev')
-  .description('Run dev web-server for Tamaro Core or customer configuration')
-  .option('--local-core', 'Load Tamaro Core from localhost instead of CDN')
+  .description(
+    'Run the local development server for Tamaro Core or a particular customer configuration',
+  )
+  .option(
+    '--local-core',
+    'Load Tamaro Core from localhost:1234 instead of the CDN',
+    false,
+  )
+  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
   .action(async (options: DevOptions) => {
     await dev(options)
   })
@@ -38,46 +57,115 @@ cli
 cli
   .command('build')
   .description(
-    'Build optimised (minified) bundle of Tamaro Core or customer configuration for production',
+    'Build an optimised (minified) bundle of Tamaro Core or a customer configuration',
+  )
+  .option(
+    '--local-core',
+    'Load Tamaro Core from localhost:1234 instead of the CDN',
+    false,
   )
-  .option('--local-core', 'Load Tamaro Core from localhost instead of CDN')
-  .option('--analyze', 'Generate bundle statistics to "reports" folder')
+  .option('--analyze', 'Generate bundle statistics to "reports" folder', false)
+  .option('--serve', 'Run the generated bundle with a local web server', false)
+  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
   .option(
     '--deploy',
-    'Deploy Tamaro Core or customer configuration bundle to AWS',
+    'Deploy Tamaro Core or a customer configuration bundle to AWS S3',
+    false,
+  )
+  .option(
+    '--tag <tag>',
+    'Tag which should be used for the deployment of the bundle',
+    DEFAULT_TAG,
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of the bundle',
+    DEFAULT_AWS_PROFILE,
   )
-  .option('--serve', 'Run web-server for the bundle')
-  .option('--tag <tag>', 'Tag which will be used for deployment of the bundle')
-  .action(async (options: BuildOptions) => {
+  .action(async (options: BuildOptions & ServeOptions & DeployOptions) => {
     await build(options)
 
+    if (options.serve) {
+      await serve(options)
+    }
+
     if (options.deploy) {
       await deploy(options)
     }
+  })
 
-    if (options.serve) {
-      await serve()
-    }
+cli
+  .command('serve')
+  .description('Run a local web server for pre-built bundle')
+  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
+  .action(async (options: ServeOptions) => {
+    await serve(options)
   })
 
 cli
   .command('deploy')
   .description(
-    'Deploy prebuilt Tamaro Core or customer configuration bundle to AWS',
+    'Deploy a pre-built Tamaro Core or customer configuration bundle to AWS S3',
+  )
+  .option(
+    '--tag <tag>',
+    'Tag which should be used for the deployment of the bundle',
+    DEFAULT_TAG,
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of the bundle',
+    DEFAULT_AWS_PROFILE,
   )
-  .option('--tag <tag>', 'Tag which will be used for deployment of the bundle')
   .action(async (options: DeployOptions) => {
     await deploy(options)
   })
 
 cli
-  .command('serve')
-  .description('Run web-server for prebuilt bundle')
-  .action(async () => {
-    await serve()
+  .command('list-deployed')
+  .description(
+    'List deployments of Tamaro Core or a particular customer configuration',
+  )
+  .option(
+    '--config <config>',
+    'Configuration name (default: current customer configuration)',
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for fetching deployments',
+    DEFAULT_AWS_PROFILE,
+  )
+  .action(async (options: ListDeployedOptions) => {
+    await listDeployed(options)
+  })
+
+cli
+  .command('deploy-email-config')
+  .description('Deploy a widget’s email configuration to AWS S3')
+  .option(
+    '--bucket <bucket>',
+    'AWS S3 bucket where it should be deployed',
+    DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET,
+  )
+  .option(
+    '--profile <profile>',
+    'AWS profile which should be used for the deployment of email configuration',
+    DEFAULT_AWS_PROFILE,
+  )
+  .action(async (options: DeployEmailConfigOptions) => {
+    await deployEmailConfig(options)
   })
 
 ///////////////////////////////////////////////////////////////////////////////
 ;(async () => {
-  await cli.parseAsync(process.argv)
+  try {
+    await cli.parseAsync(process.argv)
+  } catch (error: any) {
+    if (error.signal === 'SIGINT' && error.signalDescription) {
+      logError(`\n${error.signalDescription}`)
+    } else {
+      console.log('')
+      logError(error.stack)
+    }
+  }
 })()

package/src/commands/build.ts

@@ -0,0 +1,99 @@
+import {CORE_CONFIG_NAME} from 'lib/constants'
+import {assertProfileValid} from 'lib/aws'
+import {
+  getIfCoreFns,
+  getPaths,
+  getWidgetUuid,
+  resolveBin,
+  resolveOwn,
+} from 'lib/resolve'
+import {logCommand, logTitle} from 'lib/logging'
+import {notify} from 'lib/notifier'
+import {fail, runCommandSync} from 'lib/command'
+import {DeployOptions} from 'commands/deploy'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type BuildOptions = {
+  localCore: boolean
+  analyze: boolean
+  serve: boolean
+  deploy: boolean
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const build = async (
+  options: BuildOptions & DeployOptions,
+): Promise<void> => {
+  assertOptionsValid(options)
+
+  const flags = prepareFlags([], options).join(' ')
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
+  const title = ifCore(
+    'Building optimised (minified) bundle of Tamaro Core …',
+    `Building optimised (minified) bundle of “${configName}” customer configuration …`,
+  )
+
+  const wpBin = resolveBin('webpack')
+  const wpConfig = resolveOwn('dist/webpack.config.js')
+  const cmd = `
+    ${wpBin}
+      --config ${wpConfig}
+      --env min
+      ${flags}
+  `
+
+  logTitle(title)
+  logCommand(cmd)
+  runCommandSync(cmd, {stdio: 'inherit'})
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  logTitle(`\nBundle for “${configName}” customer configuration is done.`)
+  console.log(`Path: ${paths.appDist}\n`)
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  process.on('exit', () => {
+    notify({
+      title: 'build',
+      message: `Bundle for “${configName}” customer configuration is done.`,
+    })
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: BuildOptions & DeployOptions) => {
+  const {localCore, deploy, profile} = options
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore() && localCore) {
+    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+  }
+
+  if (localCore && deploy) {
+    fail('Flags "--local-core" and "--deploy" must not be used together.')
+  }
+
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (flags: string[], options: BuildOptions): string[] => {
+  const {localCore, analyze} = options
+
+  if (localCore) {
+    flags.push('--env localCore')
+  }
+
+  if (analyze) {
+    flags.push('--env analyze')
+  }
+
+  return flags
+}

package/src/commands/deploy-email-config.ts

@@ -0,0 +1,115 @@
+import {existsSync} from 'fs'
+import {
+  assertProfileValid,
+  AwsOptions,
+  withAwsAuthenticate,
+  prepareFlags as prepareAwsFlags,
+} from 'lib/aws'
+import {logCommand, logDataTable, logTitle} from 'lib/logging'
+import {getIfCoreFns, getPaths, getWidgetUuid} from 'lib/resolve'
+import {notify} from 'lib/notifier'
+import {fail, runCommandSync} from 'lib/command'
+
+///////////////////////////////////////////////////////////////////////////////
+
+export type DeployEmailConfigOptions = AwsOptions & {
+  bucket: string
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+export const deployEmailConfig = async (
+  options: DeployEmailConfigOptions,
+): Promise<void> => {
+  const {ifCore} = getIfCoreFns()
+  const paths = getPaths(ifCore)
+  const emailConfigPath = `${paths.app}/email-config`
+
+  assertOptionsValid(options)
+  assertEmailConfigPathExists(emailConfigPath)
+  assertIsNotCore()
+
+  const flags = prepareFlags([], options).join(' ')
+  const {bucket} = options
+  const configName = getWidgetUuid()
+  const deployUrl = `s3://${bucket}/${configName}`
+
+  const cmd = `
+    aws s3 sync ${emailConfigPath} ${deployUrl}
+      --delete
+      --exact-timestamps
+      ${flags}
+  `
+  logTitle(
+    `Deploying email configuration for “${configName}” customer configuration to AWS S3 …`,
+  )
+  logCommand(cmd)
+
+  try {
+    withAwsAuthenticate(() => runCommandSync(cmd, {stdout: 'inherit'}), options)
+  } catch (error: any) {
+    fail(error.stderr)
+  }
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  logTitle(
+    `Email configuration for “${configName}” customer configuration is deployed.`,
+  )
+  logDataTable({'Deploy URL:': deployUrl})
+
+  /////////////////////////////////////////////////////////////////////////////
+
+  process.on('exit', () => {
+    notify({
+      title: `deploy-email-config`,
+      message: `Email configuration for “${configName}” customer configuration is deployed.`,
+    })
+  })
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertOptionsValid = (options: DeployEmailConfigOptions) => {
+  const {bucket, profile} = options
+
+  assertBucketValid(bucket)
+  assertProfileValid(profile)
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertEmailConfigPathExists = (distPath: string) => {
+  if (!existsSync(distPath)) {
+    fail('Email config folder does not exists. Nothing to deploy.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertBucketValid = (tag: string) => {
+  const regex = /^[a-zA-Z0-9-_]+$/
+
+  if (!regex.test(tag)) {
+    fail(`Flag "--bucket" has forbidden format. Allowed format: ${regex}.`)
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const assertIsNotCore = () => {
+  const {ifCore} = getIfCoreFns()
+
+  if (ifCore()) {
+    fail('You cannot deploy widget email configuration for Tamaro Core.')
+  }
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (
+  flags: string[],
+  options: DeployEmailConfigOptions,
+): string[] => {
+  return prepareAwsFlags(flags, options)
+}