@raisenow/tamaro-cli 1.1.8 → 1.1.9

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/tamaro-cli.iml" filepath="$PROJECT_DIR$/.idea/tamaro-cli.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/prettier.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+  </component>
+</project>

package/.idea/runConfigurations/build_watch.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="build:watch" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="build:watch" />
+    </scripts>
+    <node-interpreter value="project" />
+    <package-manager value="pnpm" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/lint_fix.xml

@@ -0,0 +1,13 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="lint:fix" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="lint:fix" />
+    </scripts>
+    <node-interpreter value="project" />
+    <package-manager value="pnpm" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/tscheck.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="tscheck" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="tscheck" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/tamaro-cli.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -2,7 +2,8 @@
 
 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.
+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
 
@@ -12,7 +13,8 @@ To see an overview of all possible commands just run the following command witho
 npx -y @raisenow/tamaro-cli
 ```
 
-To see the information about some particular command (for example `dev` command), prepend `help` before the command name:
+To see the information about some particular command (for example `dev` command), prepend `help` before the command
+name:
 
 ```bash
 npx -y @raisenow/tamaro-cli help dev
@@ -44,7 +46,8 @@ Runs the local development server for _Tamaro Core_ or a particular customer con
 
 ### 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).
+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
@@ -53,14 +56,17 @@ 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).
+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).
+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
@@ -69,7 +75,10 @@ npx -y @raisenow/tamaro-cli dev
 
 ### Use Transport Level Security (HTTPS)
 
-You might want to the local web server to serve Tamaro over HTTPS, for example for testing wallet payments over Google Pay. For that, you have to install [mkcert](https://mkcert.org/), then generate a local certificate and key file and install it into your local trust stores using this command in the root directory of the Tamaro configuration repository (or Tamaro Core):
+You might want to the local web server to serve Tamaro over HTTPS, for example for testing wallet payments over Google
+Pay. For that, you have to install [mkcert](https://mkcert.org/), then generate a local certificate and key file and
+install it into your local trust stores using this command in the root directory of the Tamaro configuration
+repository (or Tamaro Core):
 
 Install `mkcert`:
 
@@ -83,9 +92,11 @@ Generate certificate:
 mkcert -install -cert-file localhost.crt -key-file localhost.key localhost 127.0.0.1 0.0.0.0 ::1
 ```
 
-You will see that the certificate and key files are created. Keep them for yourself. Do not share them or commit them. (They should be ignored by Git.)
+You will see that the certificate and key files are created. Keep them for yourself. Do not share them or commit them. (
+They should be ignored by Git.)
 
-You can then use the flag `--https` with the CLI. If you are using the local Tamaro Core, you also have to serve that over HTTPS. Certificate and key files must be copied to Tamaro Core folder as well.
+You can then use the flag `--https` with the CLI. If you are using the local Tamaro Core, you also have to serve that
+over HTTPS. Certificate and key files must be copied to Tamaro Core folder as well.
 
 ## `build`
 
@@ -115,7 +126,8 @@ As a result, the bundle should be deployed to: <https://tamaro.raisenow.com/exam
 
 ### 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_.
+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
@@ -128,7 +140,14 @@ As a result, the bundle should be deployed to: <https://tamaro.raisenow.com/exam
 
 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).
+After running this command, a local web server should be running on <http://localhost:1234> (port may differ, see
+console output).
+
+### Build and test locally with a Tamaro configuration
+
+1. Build with `pnpm build` (or `pnpm build:watch` for convince).
+2. Navigate to the Tamaro configuration directory you want to use.
+3. Run by specifying the relative path, e.g. `../../tools/tamaro-cli/dist/cli.js dev --https`
 
 ```bash
 cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
@@ -148,7 +167,8 @@ Run a local web server for pre-built bundle.
     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).
+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
@@ -162,7 +182,8 @@ Deploy a pre-built _Tamaro Core_ or customer configuration bundle to AWS S3.
 
 - `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: "latest")
 
-Make sure you have built the bundle before deploying it with this command, otherwise you may mistakenly deploy the bundle from a 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
 
@@ -232,7 +253,8 @@ Link package source to be able to run its local version:
 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.
+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

package/bitbucket-pipelines.yml

@@ -0,0 +1,43 @@
+image: node:20.18
+
+definitions:
+  caches:
+    node:
+      key:
+        files:
+          - pnpm-lock.yaml
+          - package.json
+      path: node_modules
+    pnpm:
+      key:
+        files:
+          - pnpm-lock.yaml
+          - package.json
+      path: $BITBUCKET_CLONE_DIR/.pnpm-store
+  scripts:
+    initialize: &initialize |-
+      corepack enable pnpm
+      corepack prepare --activate
+  steps:
+    - step: &install
+        name: Install dependencies
+        caches:
+          - node
+          - pnpm
+        script:
+          - *initialize
+          - pnpm install --prefer-offline
+    - step: &check
+        name: Check
+        caches:
+          - node
+          - pnpm
+        script:
+          - *initialize
+          - pnpm lint
+          - pnpm tscheck
+
+pipelines:
+  default:
+    - step: *install
+    - step: *check

package/dist/cli.js

@@ -27,6 +27,37 @@ import {
 // src/cli.ts
 import { createCommand } from "commander";
 
+// src/commands/validate.ts
+import { glob } from "glob";
+
+// src/lib/validators/validateEmailTemplates.ts
+import fs from "node:fs/promises";
+import handlebars from "handlebars";
+var { compile } = handlebars;
+var validateEmailTemplates = async (templateFiles) => {
+  const errors = [];
+  for (const templateFile of templateFiles) {
+    try {
+      const compiled = compile(await fs.readFile(templateFile, "utf-8"));
+      compiled({});
+      console.log(`${templateFile} is a valid email template`);
+    } catch (e) {
+      errors.push(`${templateFile} is invalid`);
+      errors.push(e);
+    }
+  }
+  return errors;
+};
+
+// src/commands/validate.ts
+var validate = async () => {
+  const errors = await validateEmailTemplates(await glob("email-config/templates/**/*.hbs"));
+  if (errors.length) {
+    halt(errors.map((el) => el.toString()).join("\n"));
+  }
+  logTitle("Valid. Bye.");
+};
+
 // src/lib/aws.ts
 import { execaCommandSync } from "execa";
 import prompts from "prompts";
@@ -151,6 +182,7 @@ var build = async (options) => {
     options.profile = await promptProfile();
   }
   assertOptionsValid(options);
+  await validate();
   const flags = prepareFlags2(options);
   const { ifCore } = getIfCoreFns();
   const paths = getPaths(ifCore);
@@ -228,6 +260,7 @@ var deploy = async (options) => {
     options.profile = await promptProfile();
   }
   assertOptionsValid2(options);
+  await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
   const { tag } = options;
@@ -335,6 +368,7 @@ var deployEmailConfig = async (options) => {
     options.bucket = options.ci ? AWS_S3_BUCKET_TAMARO_EMAIL_CONFIG_PROD : await promptBucketTamaroEmailConfig();
   }
   assertOptionsValid3(options);
+  await validate();
   awsAuthenticate(options);
   const flags = prepareFlags(options);
   const configName = getWidgetUuid();
@@ -577,7 +611,7 @@ var prepareFlags4 = async (options) => {
 // package.json
 var package_default = {
   name: "@raisenow/tamaro-cli",
-  version: "1.1.8",
+  version: "1.1.9",
   author: {
     name: "RaiseNow",
     email: "development@raisenow.com"
@@ -650,6 +684,8 @@ var package_default = {
     "file-loader": "^6.2.0",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     glob: "^11.0.0",
+    handlebars: "^4.7.8",
+    "handlebars-helpers": "^0.10.0",
     "html-loader": "^5.1.0",
     "html-webpack-plugin": "^5.6.3",
     "json-loader": "^0.5.7",
@@ -756,6 +792,9 @@ cli.command("list-deployed").description(
 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) => {
   await deployEmailConfig(options);
 });
+cli.command("validate").description("Validate the current Tamaro configuration to avoid common errors").action(async () => {
+  await validate();
+});
 (async () => {
   try {
     logTitle(`${package_default.name} ${package_default.version}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raisenow/tamaro-cli",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "author": {
     "name": "RaiseNow",
     "email": "development@raisenow.com"
@@ -73,6 +73,8 @@
     "file-loader": "^6.2.0",
     "fork-ts-checker-webpack-plugin": "^9.0.2",
     "glob": "^11.0.0",
+    "handlebars": "^4.7.8",
+    "handlebars-helpers": "^0.10.0",
     "html-loader": "^5.1.0",
     "html-webpack-plugin": "^5.6.3",
     "json-loader": "^0.5.7",

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)
-    }
-  }
-})()