@raisenow/tamaro-cli 1.0.10 → 1.0.13

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "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 . --fix && prettier --write ."
   },
@@ -20,80 +20,71 @@
     "npm": ">=8"
   },
   "dependencies": {
-    "@babel/cli": "^7.17.0",
-    "@babel/core": "^7.17.0",
-    "@babel/plugin-proposal-decorators": "^7.17.0",
+    "@babel/cli": "^7.17.6",
+    "@babel/core": "^7.17.8",
+    "@babel/plugin-proposal-decorators": "^7.17.8",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
     "@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.17.0",
+    "@babel/runtime-corejs3": "^7.17.8",
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.4",
     "@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.16",
+    "@types/lodash": "^4.14.181",
+    "@types/node": "^17.0.23",
     "@types/node-notifier": "^8.0.2",
     "@types/resolve-bin": "^0.4.1",
     "@types/webpack-config-utils": "^2.3.1",
-    "@typescript-eslint/eslint-plugin": "^5.11.0",
-    "@typescript-eslint/parser": "^5.11.0",
-    "autoprefixer": "^10.4.2",
-    "babel-loader": "^8.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "autoprefixer": "^10.4.4",
+    "babel-loader": "^8.2.4",
     "babel-plugin-lodash": "^3.3.4",
-    "boxen": "^5.1.2",
-    "chalk": "^4.1.2",
+    "chalk": "^5.0.1",
     "clean-webpack-plugin": "^4.0.0",
     "columnify": "^1.6.0",
-    "commander": "^9.0.0",
+    "commander": "^9.1.0",
     "copy-webpack-plugin": "^10.2.4",
-    "core-js": "^3.21.0",
-    "css-loader": "^6.6.0",
+    "core-js": "^3.21.1",
+    "css-loader": "^6.7.1",
     "css-minimizer-webpack-plugin": "^3.4.1",
-    "current-script-polyfill": "^1.0.0",
     "dotenv": "^16.0.0",
-    "dotenv-expand": "^8.0.1",
-    "element-closest": "^3.0.2",
-    "escape-string-regexp": "^4.0.0",
-    "eslint": "^8.8.0",
-    "eslint-config-prettier": "^8.3.0",
+    "dotenv-expand": "^8.0.3",
+    "escape-string-regexp": "^5.0.0",
+    "eslint": "^8.12.0",
+    "eslint-config-prettier": "^8.5.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": "^7.1.1",
+    "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",
+    "mini-css-extract-plugin": "^2.6.0",
     "node-notifier": "^10.0.1",
-    "open": "^8.4.0",
     "portfinder": "^1.0.28",
-    "postcss": "^8.4.6",
-    "postcss-custom-properties": "^12.1.4",
+    "postcss": "^8.4.12",
+    "postcss-custom-properties": "^12.1.5",
     "postcss-loader": "^6.2.1",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.1",
     "react-refresh": "^0.11.0",
-    "resolve-bin": "^1.0.0",
     "resolve-url-loader": "^5.0.0",
-    "sass": "^1.49.7",
-    "sass-loader": "^12.4.0",
+    "sass": "^1.49.10",
+    "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",
     "tsconfig-paths-webpack-plugin": "^3.5.2",
-    "tsup": "^5.11.13",
-    "typescript": "^4.5.5",
-    "unfetch": "^4.2.0",
+    "tsup": "^5.12.1",
+    "typescript": "^4.6.3",
     "url-loader": "^4.1.1",
-    "webpack": "^5.68.0",
+    "webpack": "^5.70.0",
     "webpack-cli": "^4.9.2",
     "webpack-config-utils": "^2.3.1",
     "webpack-dev-server": "^4.7.4",

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,18 +2,22 @@
 
 import {createCommand} from 'commander'
 import pkg from '../package.json'
-import {logError} from 'lib/helpers'
+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 {DEFAULT_TAG, deploy, DeployOptions} from 'commands/deploy'
-import {serve} from 'commands/serve'
+import {deploy, DeployOptions} from 'commands/deploy'
+import {serve, ServeOptions} from 'commands/serve'
 import {listDeployed, ListDeployedOptions} from 'commands/list-deployed'
 import {
-  DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET,
   deployEmailConfig,
   DeployEmailConfigOptions,
 } from 'commands/deploy-email-config'
-import {DEFAULT_AWS_PROFILE} from 'lib/aws'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -42,9 +46,11 @@ cli
   )
   .option(
     '--local-core',
-    'Load Tamaro Core from localhost instead of the CDN',
+    'Load Tamaro Core from localhost:1234 instead of the CDN',
     false,
   )
+  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
+  .option('--env <env>', 'Environment (dev, stage, prod)')
   .action(async (options: DevOptions) => {
     await dev(options)
   })
@@ -56,16 +62,18 @@ cli
   )
   .option(
     '--local-core',
-    'Load Tamaro Core from localhost instead of the CDN',
+    'Load Tamaro Core from localhost:1234 instead of the CDN',
     false,
   )
   .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('--env <env>', 'Environment (dev, stage, prod)')
   .option(
     '--deploy',
     'Deploy Tamaro Core or a customer configuration bundle to AWS S3',
     false,
   )
-  .option('--serve', 'Run the generated bundle with a local web server', false)
   .option(
     '--tag <tag>',
     'Tag which should be used for the deployment of the bundle',
@@ -76,16 +84,24 @@ cli
     'AWS profile which should be used for the deployment of the bundle',
     DEFAULT_AWS_PROFILE,
   )
-  .action(async (options: BuildOptions & DeployOptions) => {
+  .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
@@ -107,13 +123,6 @@ cli
     await deploy(options)
   })
 
-cli
-  .command('serve')
-  .description('Run a local web server for pre-built bundle')
-  .action(async () => {
-    await serve()
-  })
-
 cli
   .command('list-deployed')
   .description(
@@ -156,6 +165,9 @@ cli
   } catch (error: any) {
     if (error.signal === 'SIGINT' && error.signalDescription) {
       logError(`\n${error.signalDescription}`)
+    } else {
+      console.log('')
+      logError(error.stack)
     }
   }
 })()

package/src/commands/build.ts

@@ -1,26 +1,26 @@
-import resolveBin from 'resolve-bin'
+import {CORE_CONFIG_NAME} from 'lib/constants'
+import {assertProfileValid} from 'lib/aws'
 import {
-  fail,
   getIfCoreFns,
   getPaths,
   getWidgetUuid,
-  logCommand,
-  logDataTable,
-  logTitle,
-  notify,
+  resolveBin,
   resolveOwn,
-  runCommandSync,
-} from 'lib/helpers'
-import {assertProfileValid} from 'lib/aws'
-import {CORE_CONFIG_NAME, DeployOptions} from 'commands/deploy'
+} from 'lib/resolve'
+import {assertEnvValid} from 'lib/env'
+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
-  deploy: boolean
   serve: boolean
+  deploy: boolean
+  env: string
 }
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -30,7 +30,7 @@ export const build = async (
 ): Promise<void> => {
   assertOptionsValid(options)
 
-  const flags = prepareFlags(options)
+  const flags = prepareFlags([], options).join(' ')
   const {ifCore} = getIfCoreFns()
   const paths = getPaths(ifCore)
   const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
@@ -39,7 +39,7 @@ export const build = async (
     `Building optimised (minified) bundle of “${configName}” customer configuration …`,
   )
 
-  const wpBin = resolveBin.sync('webpack')
+  const wpBin = resolveBin('webpack')
   const wpConfig = resolveOwn('dist/webpack.config.js')
   const cmd = `
     ${wpBin}
@@ -54,44 +54,49 @@ export const build = async (
 
   /////////////////////////////////////////////////////////////////////////////
 
-  logDataTable(
-    {'Path:': paths.appDist},
-    `Bundle for “${configName}” customer configuration is done.`,
-  )
+  logTitle(`\nBundle for “${configName}” customer configuration is done.`)
+  console.log(`Path: ${paths.appDist}\n`)
 
   /////////////////////////////////////////////////////////////////////////////
 
-  notify({
-    title: 'build',
-    message: `Bundle for “${configName}” customer configuration is done.`,
+  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 {localCore, deploy, profile, env} = options
   const {ifCore} = getIfCoreFns()
 
   if (ifCore() && localCore) {
-    fail('Flag "--local-core" is redundant if running in Tamaro Core context.')
+    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.')
+    fail('Flags “--local-core” and “--deploy” must not be used together.')
   }
 
   assertProfileValid(profile)
+  assertEnvValid(env)
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-const prepareFlags = (options: BuildOptions): string => {
+const prepareFlags = (flags: string[], options: BuildOptions): string[] => {
   const {localCore, analyze} = options
-  let flags: string[] = []
 
-  flags = localCore ? [...flags, '--env localCore'] : flags
-  flags = analyze ? [...flags, '--env analyze'] : flags
+  if (localCore) {
+    flags.push('--env localCore')
+  }
+
+  if (analyze) {
+    flags.push('--env analyze')
+  }
 
-  return flags.join(' ')
+  return flags
 }

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

@@ -1,15 +1,14 @@
 import {existsSync} from 'fs'
 import {
-  fail,
-  getIfCoreFns,
-  getPaths,
-  getWidgetUuid,
-  logCommand,
-  logDataTable,
-  logTitle,
-  notify,
-} from 'lib/helpers'
-import {assertProfileValid, AwsOptions, runAwsCommandSync} from 'lib/aws'
+  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'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -19,10 +18,6 @@ export type DeployEmailConfigOptions = AwsOptions & {
 
 ///////////////////////////////////////////////////////////////////////////////
 
-export const DEFAULT_AWS_S3_EMAIL_CONFIG_BUCKET = 'rnw-email-service'
-
-///////////////////////////////////////////////////////////////////////////////
-
 export const deployEmailConfig = async (
   options: DeployEmailConfigOptions,
 ): Promise<void> => {
@@ -34,6 +29,7 @@ export const deployEmailConfig = async (
   assertEmailConfigPathExists(emailConfigPath)
   assertIsNotCore()
 
+  const flags = prepareFlags([], options).join(' ')
   const {bucket} = options
   const configName = getWidgetUuid()
   const deployUrl = `s3://${bucket}/${configName}`
@@ -42,6 +38,7 @@ export const deployEmailConfig = async (
     aws s3 sync ${emailConfigPath} ${deployUrl}
       --delete
       --exact-timestamps
+      ${flags}
   `
   logTitle(
     `Deploying email configuration for “${configName}” customer configuration to AWS S3 …`,
@@ -49,23 +46,25 @@ export const deployEmailConfig = async (
   logCommand(cmd)
 
   try {
-    runAwsCommandSync(cmd, {stdout: 'inherit'})
+    withAwsAuthenticate(() => runCommandSync(cmd, {stdout: 'inherit'}), options)
   } catch (error: any) {
     fail(error.stderr)
   }
 
   /////////////////////////////////////////////////////////////////////////////
 
-  logDataTable(
-    {'Deploy URL:': deployUrl},
+  logTitle(
     `Email configuration for “${configName}” customer configuration is deployed.`,
   )
+  logDataTable({'Deploy URL:': deployUrl})
 
   /////////////////////////////////////////////////////////////////////////////
 
-  notify({
-    title: `deploy-email-config`,
-    message: `Email configuration for “${configName}” customer configuration is deployed.`,
+  process.on('exit', () => {
+    notify({
+      title: `deploy-email-config`,
+      message: `Email configuration for “${configName}” customer configuration is deployed.`,
+    })
   })
 }
 
@@ -92,7 +91,7 @@ const assertBucketValid = (tag: string) => {
   const regex = /^[a-zA-Z0-9-_]+$/
 
   if (!regex.test(tag)) {
-    fail(`Flag "--bucket" has forbidden format. Allowed format: ${regex}.`)
+    fail(`Flag “--bucket” has forbidden format. Allowed format: ${regex}.`)
   }
 }
 
@@ -105,3 +104,12 @@ const assertIsNotCore = () => {
     fail('You cannot deploy widget email configuration for Tamaro Core.')
   }
 }
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (
+  flags: string[],
+  options: DeployEmailConfigOptions,
+): string[] => {
+  return prepareAwsFlags(flags, options)
+}

package/src/commands/deploy.ts

@@ -1,16 +1,19 @@
 import {existsSync} from 'fs'
-import stripIndent from 'strip-indent'
 import {
-  fail,
-  getIfCoreFns,
-  getPaths,
-  getWidgetUuid,
-  logCommand,
-  logDataTable,
-  logTitle,
-  notify,
-} from 'lib/helpers'
-import {assertProfileValid, AwsOptions, runAwsCommandSync} from 'lib/aws'
+  AWS_CLOUDFRONT_DISTRIBUTION_ID,
+  AWS_S3_BUCKET,
+  CORE_CONFIG_NAME,
+} from 'lib/constants'
+import {
+  assertProfileValid,
+  AwsOptions,
+  withAwsAuthenticate,
+  prepareFlags as prepareAwsFlags,
+} from 'lib/aws'
+import {getIfCoreFns, getPaths, getWidgetUuid} from 'lib/resolve'
+import {logCommand, logDataTable, logTitle} from 'lib/logging'
+import {notify} from 'lib/notifier'
+import {fail, runCommandSync} from 'lib/command'
 
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -20,13 +23,6 @@ export type DeployOptions = AwsOptions & {
 
 ///////////////////////////////////////////////////////////////////////////////
 
-export const AWS_S3_BUCKET = 'tamaro.raisenow.com'
-export const CORE_CONFIG_NAME = 'tamaro-core'
-const AWS_CLOUDFRONT_DISTRIBUTION_ID = 'EHJ1OM458YQ0I'
-export const DEFAULT_TAG = 'latest'
-
-///////////////////////////////////////////////////////////////////////////////
-
 export const deploy = async (options: DeployOptions): Promise<void> => {
   const {ifCore} = getIfCoreFns()
   const paths = getPaths(ifCore)
@@ -34,6 +30,7 @@ export const deploy = async (options: DeployOptions): Promise<void> => {
   assertOptionsValid(options)
   assertDistPathExists(paths.appDist)
 
+  const flags = prepareFlags([], options).join(' ')
   const {tag} = options
   const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
   const deployUrl = `s3://${AWS_S3_BUCKET}/${configName}/${tag}`
@@ -45,16 +42,20 @@ export const deploy = async (options: DeployOptions): Promise<void> => {
 
   const cmdSyncAll = `
     aws s3 sync ${paths.appDist} ${deployUrl}
+      --quiet
       --acl public-read
-      --size-only
       --exclude ${paths.appDist}/${entryFilename}
       --cache-control max-age=31536000
+      ${flags}
   `
   logTitle('Deploying to AWS S3 …')
   logCommand(cmdSyncAll)
 
   try {
-    runAwsCommandSync(cmdSyncAll, {stdout: 'inherit'})
+    withAwsAuthenticate(
+      () => runCommandSync(cmdSyncAll, {stdout: 'inherit'}),
+      options,
+    )
   } catch (error: any) {
     fail(error.stderr)
   }
@@ -65,13 +66,18 @@ export const deploy = async (options: DeployOptions): Promise<void> => {
 
   const cmdCpEntry = `
     aws s3 cp ${paths.appDist}/${entryFilename} ${deployUrl}/${entryFilename}
+      --quiet
       --acl public-read
       --cache-control max-age=64800
+      ${flags}
   `
   logCommand(cmdCpEntry)
 
   try {
-    runAwsCommandSync(cmdCpEntry, {stdout: 'inherit'})
+    withAwsAuthenticate(
+      () => runCommandSync(cmdCpEntry, {stdout: 'inherit'}),
+      options,
+    )
   } catch (error: any) {
     fail(error.stderr)
   }
@@ -84,13 +90,14 @@ export const deploy = async (options: DeployOptions): Promise<void> => {
     aws cloudfront create-invalidation
       --distribution-id ${AWS_CLOUDFRONT_DISTRIBUTION_ID}
       --paths /${configName}/${tag}/*
+      ${flags}
   `
-  logTitle('Invalidating edge cache …')
+  logTitle('\nInvalidating edge cache …')
   logCommand(cmdInvalidateCache)
 
   try {
     // ignore output
-    runAwsCommandSync(cmdInvalidateCache)
+    withAwsAuthenticate(() => runCommandSync(cmdInvalidateCache), options)
   } catch (error: any) {
     fail(error.stderr)
   }
@@ -100,23 +107,23 @@ export const deploy = async (options: DeployOptions): Promise<void> => {
   const demoPage = `https://${AWS_S3_BUCKET}/${configName}/${tag}/index.html`
   const entryPoint = `https://${AWS_S3_BUCKET}/${configName}/${tag}/${entryFilename}`
 
-  logDataTable(
-    {
-      'Demo page:': demoPage,
-      'Entry point:': entryPoint,
-    },
-    `Bundle for “${configName}” is deployed with tag “${tag}”`,
-  )
+  logTitle(`\nBundle for “${configName}” is deployed with tag “${tag}”.`)
+  logDataTable({
+    'Demo page:': demoPage,
+    'Entry point:': entryPoint,
+  })
 
   /////////////////////////////////////////////////////////////////////////////
 
-  notify({
-    title: 'deploy',
-    message: stripIndent(`
-      Bundle for “${configName}” is deployed with tag “${tag}”.
-      Demo page: ${demoPage}
-    `),
-    target: demoPage,
+  process.on('exit', () => {
+    notify({
+      title: 'deploy',
+      message: `
+        Bundle for “${configName}” is deployed with tag “${tag}”.
+        Demo page: ${demoPage}
+        Entry point: ${entryPoint}
+      `,
+    })
   })
 }
 
@@ -143,9 +150,15 @@ const assertDistPathExists = (distPath: string) => {
 ///////////////////////////////////////////////////////////////////////////////
 
 const assertTagValid = (tag: string) => {
-  const regex = /^[a-zA-Z0-9-_]+$/
+  const regex = /^[a-zA-Z0-9-_.]+$/
 
   if (!regex.test(tag)) {
-    fail(`Flag "--tag" has forbidden format. Allowed format: ${regex}.`)
+    fail(`Flag “--tag” has forbidden format. Allowed format: ${regex}.`)
   }
 }
+
+///////////////////////////////////////////////////////////////////////////////
+
+const prepareFlags = (flags: string[], options: DeployOptions): string[] => {
+  return prepareAwsFlags(flags, options)
+}