@raisenow/tamaro-cli 1.1.7 → 1.1.9

package/src/cli.ts

@@ -1,178 +0,0 @@
-#!/usr/bin/env node
-
-import {createCommand} from 'commander'
-import {build, type BuildOptions} from 'commands/build'
-import {deploy, type DeployOptions} from 'commands/deploy'
-import {
-  deployEmailConfig,
-  type DeployEmailConfigOptions,
-} from 'commands/deploy-email-config'
-import {dev, type DevOptions} from 'commands/dev'
-import {listDeployed, type ListDeployedOptions} from 'commands/list-deployed'
-import {serve, type ServeOptions} from 'commands/serve'
-import {halt} from 'lib/command'
-import {DEFAULT_PORT, DEFAULT_TAG} from 'lib/constants'
-import {logError, logTitle} from 'lib/logging'
-import pkg from '../package.json'
-
-///////////////////////////////////////////////////////////////////////////////
-
-/**
- * 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', (error) => {
-  throw error
-})
-
-// Exit on ctrl+c
-process.on('SIGINT', () => {
-  halt()
-})
-
-///////////////////////////////////////////////////////////////////////////////
-
-const cli = createCommand().name(pkg.name).version(pkg.version, '-v, --version')
-
-///////////////////////////////////////////////////////////////////////////////
-
-cli
-  .command('dev')
-  .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(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option('--env <env>', 'Environment (dev, stage, prod)')
-  .option('--nolint', 'Disable ESLint', false)
-  .action(async (options: DevOptions) => {
-    await dev(options)
-  })
-
-cli
-  .command('build')
-  .description(
-    '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('--analyze', 'Generate bundle statistics to "reports" folder', false)
-  .option('--serve', 'Run the generated bundle with a local web server', false)
-  .option(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option('--env <env>', 'Environment (dev, stage, prod)')
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--deploy',
-    '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('--nolint', 'Disable ESLint', false)
-  .action(async (options: BuildOptions & ServeOptions & DeployOptions) => {
-    await build(options)
-
-    if (options.serve) {
-      await serve(options)
-    }
-
-    if (options.deploy) {
-      await deploy(options)
-    }
-  })
-
-cli
-  .command('serve')
-  .description('Run a local web server for pre-built bundle')
-  .option('--port <port>', 'Web server port', `${DEFAULT_PORT}`)
-  .option(
-    '--https',
-    'Let local web server serve Tamaro with SSL encryption',
-    false,
-  )
-  .action(async (options: ServeOptions) => {
-    await serve(options)
-  })
-
-cli
-  .command('deploy')
-  .description(
-    'Deploy a pre-built Tamaro Core or customer configuration bundle to AWS S3',
-  )
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--tag <tag>',
-    'Tag which should be used for the deployment of the bundle',
-    DEFAULT_TAG,
-  )
-  .action(async (options: DeployOptions) => {
-    await deploy(options)
-  })
-
-cli
-  .command('list-deployed')
-  .description(
-    'List deployments of Tamaro Core or a particular customer configuration',
-  )
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option(
-    '--config <config>',
-    'Configuration name (default: current customer configuration)',
-  )
-  .action(async (options: ListDeployedOptions) => {
-    await listDeployed(options)
-  })
-
-cli
-  .command('deploy-email-config')
-  .description("Deploy a widget's email configuration to AWS S3")
-  .option('--profile <profile>', 'AWS profile')
-  .option('--ci', 'CI environment', false)
-  .option('--bucket <bucket>', 'AWS bucket for email configs')
-  .action(async (options: DeployEmailConfigOptions) => {
-    await deployEmailConfig(options)
-  })
-
-///////////////////////////////////////////////////////////////////////////////
-
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-;(async () => {
-  try {
-    logTitle(`${pkg.name} ${pkg.version}\n`)
-
-    await cli.parseAsync(process.argv)
-  } catch (error: any) {
-    if (error.signal === 'SIGINT' && error.signalDescription) {
-      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-      logError(`\n${error.signalDescription}`)
-    } else {
-      // eslint-disable-next-line no-console
-      console.log('')
-      logError(error.stack)
-    }
-  }
-})()

package/src/commands/build.ts

@@ -1,131 +0,0 @@
-import {type DeployOptions} from 'commands/deploy'
-import {assertProfilesPresent, assertProfileValid, promptProfile} from 'lib/aws'
-import {halt, runCommandSync} from 'lib/command'
-import {CORE_CONFIG_NAME} from 'lib/constants'
-import {applyEnv, assertEnvValid} from 'lib/env'
-import {assertCrtExists} from 'lib/https'
-import {logCommand, logTitle} from 'lib/logging'
-import {notify} from 'lib/notifier'
-import {
-  getIfCoreFns,
-  getPaths,
-  getWidgetUuid,
-  resolveBin,
-  resolveOwn,
-} from 'lib/resolve'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type BuildOptions = {
-  localCore: boolean
-  analyze: boolean
-  https: boolean
-  serve: boolean
-  deploy: boolean
-  env?: string
-  nolint: boolean
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const build = async (
-  options: BuildOptions & DeployOptions,
-): Promise<void> => {
-  const {env} = options
-
-  applyEnv(env)
-
-  if (options.deploy && !options.profile && !options.ci) {
-    assertProfilesPresent()
-    options.profile = await promptProfile()
-  }
-
-  assertOptionsValid(options)
-
-  const flags = prepareFlags(options)
-  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.`)
-  // eslint-disable-next-line no-console
-  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, https, deploy, env, profile} = options
-  const {ifCore} = getIfCoreFns()
-
-  if (ifCore() && localCore) {
-    halt('Flag "--local-core" is redundant if running in Tamaro Core context.')
-  }
-
-  if (localCore && deploy) {
-    halt('Flags "--local-core" and "--deploy" must not be used together.')
-  }
-
-  if (https) {
-    assertCrtExists()
-  }
-
-  if (profile) {
-    assertProfileValid(profile)
-  }
-
-  assertEnvValid(env)
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const prepareFlags = (options: BuildOptions) => {
-  const flags: string[] = []
-  const {localCore, analyze, https, nolint} = options
-
-  if (localCore) {
-    flags.push('--env localCore')
-  }
-
-  if (analyze) {
-    flags.push('--env analyze')
-  }
-
-  if (https) {
-    flags.push('--env https')
-  }
-
-  if (nolint) {
-    flags.push('--env nolint')
-  }
-
-  return flags.join(' ')
-}

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

@@ -1,159 +0,0 @@
-import {existsSync} from 'fs'
-// eslint-disable-next-line import/no-named-as-default
-import prompts from 'prompts'
-import {
-  assertProfilesPresent,
-  assertProfileValid,
-  awsAuthenticate,
-  type AwsOptions,
-  prepareFlags,
-  promptProfile,
-} from 'lib/aws'
-import {halt, runCommandSync} from 'lib/command'
-import {
-  AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD,
-  AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_STAGE,
-} from 'lib/constants'
-import {logCommand, logDataTable, logTitle} from 'lib/logging'
-import {notify} from 'lib/notifier'
-import {getIfCoreFns, getPaths, getWidgetUuid} from 'lib/resolve'
-
-///////////////////////////////////////////////////////////////////////////////
-
-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`
-
-  assertIsNotCore()
-  assertEmailConfigPathExists(emailConfigPath)
-
-  if (!options.profile && !options.ci) {
-    assertProfilesPresent()
-    options.profile = await promptProfile()
-  }
-
-  if (!options.bucket) {
-    options.bucket = options.ci
-      ? AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD
-      : await promptBucketTamaroEmailConfig()
-  }
-
-  assertOptionsValid(options)
-  awsAuthenticate(options)
-
-  const flags = prepareFlags(options)
-  const configName = getWidgetUuid()
-  const deployUrl = `s3://${options.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 {
-    runCommandSync(cmd, {stdout: 'inherit'})
-  } catch (error: any) {
-    halt(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 {profile, bucket} = options
-
-  if (profile) {
-    assertProfileValid(profile)
-  }
-
-  if (bucket) {
-    assertBucketValid(bucket)
-  }
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertEmailConfigPathExists = (distPath: string) => {
-  if (!existsSync(distPath)) {
-    halt('Email config folder does not exists. Nothing to deploy.')
-  }
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertIsNotCore = () => {
-  const {ifCore} = getIfCoreFns()
-
-  if (ifCore()) {
-    halt('You cannot deploy widget email configuration for Tamaro Core.')
-  }
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertBucketValid = (bucket: string) => {
-  const buckets = [
-    AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_STAGE,
-    AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD,
-  ] as const
-
-  if (!buckets.includes(bucket as any)) {
-    halt('Invalid bucket name.')
-  }
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const promptBucketTamaroEmailConfig = async (): Promise<string> => {
-  const buckets = [
-    {title: 'stage', value: AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_STAGE},
-    {title: 'prod', value: AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD},
-  ]
-
-  const {bucket} = await prompts(
-    [
-      {
-        type: 'select',
-        name: 'bucket',
-        message: 'Select environment',
-        choices: buckets,
-      },
-    ],
-    {
-      onCancel: () => halt(),
-    },
-  )
-
-  return bucket
-}

package/src/commands/deploy.ts

@@ -1,164 +0,0 @@
-import {existsSync} from 'fs'
-import stripIndent from 'strip-indent'
-import {
-  assertProfilesPresent,
-  assertProfileValid,
-  awsAuthenticate,
-  type AwsOptions,
-  prepareFlags,
-  promptProfile,
-} from 'lib/aws'
-import {halt, runCommandSync} from 'lib/command'
-import {
-  AWS_CLOUDFRONT_DISTRIBUTION_ID,
-  AWS_S3_BUCKET_TAMARO,
-  CORE_CONFIG_NAME,
-} from 'lib/constants'
-import {logCommand, logDataTable, logTitle} from 'lib/logging'
-import {notify} from 'lib/notifier'
-import {getIfCoreFns, getPaths, getWidgetUuid} from 'lib/resolve'
-
-///////////////////////////////////////////////////////////////////////////////
-
-export type DeployOptions = AwsOptions & {
-  tag: string
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-export const deploy = async (options: DeployOptions): Promise<void> => {
-  const {ifCore} = getIfCoreFns()
-  const paths = getPaths(ifCore)
-
-  assertDistPathExists(paths.appDist)
-
-  if (!options.profile && !options.ci) {
-    assertProfilesPresent()
-    options.profile = await promptProfile()
-  }
-
-  assertOptionsValid(options)
-  awsAuthenticate(options)
-
-  const flags = prepareFlags(options)
-  const {tag} = options
-  const configName = ifCore(CORE_CONFIG_NAME, getWidgetUuid())
-  const deployUrl = `s3://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}`
-  const entryFilename = ifCore('index.js', 'widget.js')
-
-  /**
-   * Sync all files except entrypoint (without deleting old files)
-   */
-  const cmdSyncAll = `
-    aws s3 sync ${paths.appDist} ${deployUrl}
-      --acl public-read
-      --exclude ${paths.appDist}/${entryFilename}
-      --cache-control max-age=31536000
-      ${flags}
-  `
-  logTitle('Deploying to AWS S3 …')
-  logCommand(cmdSyncAll)
-
-  try {
-    runCommandSync(cmdSyncAll, {stdout: 'inherit'})
-  } catch (error: any) {
-    halt(error.stderr)
-  }
-
-  /**
-   * Copy entrypoint
-   */
-  const cmdCpEntry = `
-    aws s3 cp ${paths.appDist}/${entryFilename} ${deployUrl}/${entryFilename}
-      --acl public-read
-      --cache-control max-age=64800
-      ${flags}
-  `
-  logCommand(cmdCpEntry)
-
-  try {
-    runCommandSync(cmdCpEntry, {stdout: 'inherit'})
-  } catch (error: any) {
-    halt(error.stderr)
-  }
-
-  /**
-   * Invalidate cloudfront cache
-   */
-  const cmdInvalidateCache = `
-    aws cloudfront create-invalidation
-      --distribution-id ${AWS_CLOUDFRONT_DISTRIBUTION_ID}
-      --paths /${configName}/${tag}/*
-      ${flags}
-  `
-  logTitle('\nInvalidating edge cache …')
-  logCommand(cmdInvalidateCache)
-
-  try {
-    // ignore output
-    runCommandSync(cmdInvalidateCache)
-  } catch (error: any) {
-    halt(error.stderr)
-  }
-
-  /////////////////////////////////////////////////////////////////////////////
-
-  const demoPage = `https://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}/index.html`
-  const entryPoint = `https://${AWS_S3_BUCKET_TAMARO}/${configName}/${tag}/${entryFilename}`
-
-  logTitle(`\nBundle for "${configName}" is deployed with tag "${tag}".`)
-  logDataTable({
-    'Demo page:': demoPage,
-    'Entry point:': entryPoint,
-  })
-
-  /////////////////////////////////////////////////////////////////////////////
-
-  process.on('exit', () => {
-    notify({
-      title: 'deploy',
-      message: `
-        Bundle for "${configName}" is deployed with tag "${tag}".
-        Demo page: ${demoPage}
-        Entry point: ${entryPoint}
-      `,
-    })
-  })
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertOptionsValid = (options: DeployOptions) => {
-  const {profile, tag} = options
-
-  if (profile) {
-    assertProfileValid(profile)
-  }
-
-  assertTagValid(tag)
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertDistPathExists = (distPath: string) => {
-  if (!existsSync(distPath)) {
-    halt(
-      stripIndent(`
-        Dist folder does not exists.
-        Make sure you have built the bundle before trying to deploy it.
-      `),
-    )
-  }
-}
-
-///////////////////////////////////////////////////////////////////////////////
-
-const assertTagValid = (tag: string) => {
-  const regex = /^[a-zA-Z0-9-_.]+$/
-
-  if (!regex.test(tag)) {
-    halt(
-      `Flag "--tag" has forbidden format. Allowed format: ${regex.toString()}.`,
-    )
-  }
-}