@raisenow/tamaro-cli 2.0.0 → 3.0.0-dev.1

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/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$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <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="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/.idea/workspace.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="03cc3f97-55ca-4737-9fe2-779ac8457ab2" name="Changes" comment="" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="3BwvHZOW2N4A0f0JXo7q8qDzYwY" />
+  <component name="ProjectViewState">
+    <option name="autoscrollFromSource" value="true" />
+    <option name="autoscrollToSource" value="true" />
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+    <option name="showMembers" value="true" />
+  </component>
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
+    &quot;node.js.detected.package.eslint&quot;: &quot;true&quot;,
+    &quot;node.js.selected.package.eslint&quot;: &quot;(autodetect)&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;pnpm&quot;,
+    &quot;prettierjs.PrettierConfiguration.Package&quot;: &quot;/Users/sigerello/dev/_raisenow/tools/tamaro-cli/node_modules/prettier&quot;,
+    &quot;ts.external.directory.path&quot;: &quot;/Users/sigerello/dev/_raisenow/tools/tamaro-cli/node_modules/typescript/lib&quot;,
+    &quot;vue.rearranger.settings.migration&quot;: &quot;true&quot;
+  }
+}</component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="03cc3f97-55ca-4737-9fe2-779ac8457ab2" name="Changes" comment="" />
+      <created>1775412859839</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1775412859839</updated>
+      <workItem from="1775412861312" duration="2060000" />
+      <workItem from="1776174639969" duration="1525000" />
+      <workItem from="1776736351878" duration="598000" />
+      <workItem from="1777934504965" duration="82000" />
+      <workItem from="1777936008103" duration="88000" />
+      <workItem from="1778477038620" duration="2530000" />
+      <workItem from="1780398242165" duration="1962000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

package/README.md

@@ -1,26 +1,24 @@
 # Getting started
 
-It’s a command-line interface for all operations with Tamaro customer configurations and _Tamaro Core_.
+Tamaro CLI is the command-line interface for working with Tamaro customer configurations.
 
-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.
+The package is intended to be run on demand. Use `pnpx` instead of installing it globally.
 
 # Usage
 
-To see an overview of all possible commands just run the following command without any arguments.
+Show the available commands:
 
 ```bash
-npx -y @raisenow/tamaro-cli
+pnpx @raisenow/tamaro-cli --help
 ```
 
-To see the information about some particular command (for example `dev` command), prepend `help` before the command
-name:
+Show help for a specific command:
 
 ```bash
-npx -y @raisenow/tamaro-cli help dev
+pnpx @raisenow/tamaro-cli build --help
 ```
 
-Substitute `dev` with the command you want to get information about.
+Most commands are meant to be run from a configuration directory such as `configs/epms-demo` in `@raisenow/tamaro-configurations`.
 
 # Commands
 
@@ -28,7 +26,7 @@ Available commands:
 
 - [`dev`](#dev)
 - [`build`](#build)
-- [`serve`](#serve)
+- [`preview`](#preview)
 - [`deploy`](#deploy)
 - [`list-deployed`](#list-deployed)
 - [`deploy-email-config`](#deploy-email-config)
@@ -36,328 +34,290 @@ Available commands:
 - [`undeploy-email-config`](#undeploy-email-config)
 - [`archive`](#archive)
 - [`unarchive`](#unarchive)
+- [`update-epms`](#update-epms)
+- [`validate`](#validate)
 
 ## `dev`
 
-Runs the local development server for _Tamaro Core_ or a particular customer configuration.
+Run the local Vite dev server for the current customer configuration.
 
 ### Options
 
-- `--local-core` – Load _Tamaro Core_ from localhost:1234 instead of the CDN
-- `--https` – Let local web server serve Tamaro with SSL encryption
-- `--port <port>` – Web server port (default: 1234)
-- `--env <env>` – Environment (dev, stage, prod)
+- `--local-core` - Load Tamaro Core from `https://localhost:1234/src/index.ts` rather than from CDN
 
-### 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).
+### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli dev
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @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
-    ```
-
-### 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):
-
-Install `mkcert`:
-
-```bash
-brew install mkcert
-```
+### Use a locally running Tamaro Core
 
-Generate certificate:
+1. Start Tamaro Core locally.
+2. Run the configuration with `--local-core`.
 
 ```bash
-mkcert -install -cert-file localhost.crt -key-file localhost.key localhost 127.0.0.1 0.0.0.0 ::1
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli dev --local-core
 ```
 
-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.
-
 ## `build`
 
-Build an optimised (minified) bundle of _Tamaro Core_ or a customer configuration.
+Build an optimised bundle for the current customer configuration. The command always runs `validate` before building.
 
 ### 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
-- `--https` – Let local web server serve Tamaro with SSL encryption
-- `--port <port>` – Web server port (default: 1234)
-- `--env <env>` – Environment (dev, stage, prod)
-- `--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")
-- `--dryrun` – Displays the operations that would be performed using the specified command without actually running them.
-
-### Build and deploy a customer configuration
+- `--preview` - Run a local web server for the built bundle after the build finishes
+- `--babel` - Use Babel for transpilation
+- `--no-babel` - Do not use Babel for transpilation
+- `--minify` - Minify the bundle
+- `--no-minify` - Do not minify the bundle
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--deploy` - Deploy the bundle to AWS S3 after building
+- `--force-skip-epms-sync` - Skip the EPMS sync entirely. Only use this in emergencies.
+- `--tag <tag>` - Tag to use for deployment, default: `latest`
 
-Build and deploy an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration.
+### Build locally
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --deploy
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli build
 ```
 
-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_.
+### Build and preview
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --deploy --tag WEB-123
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli build --preview
 ```
 
-As a result, the bundle should be deployed to: <https://tamaro.raisenow.com/example-02-typical-customisations/WEB-123/>
+### Build and deploy
 
-### Build and serve a customer configuration
+```bash
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli build --deploy --tag WEB-123
+```
 
-Build and serve an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration.
+## `preview`
 
-After running this command, a local web server should be running on <http://localhost:1234> (port may differ, see
-console output).
+Serve a pre-built bundle locally over HTTPS.
 
-### Build and test locally with a Tamaro configuration
+This command expects a successful build in `dist/<config-name>` and local TLS files named `localhost.crt` and `localhost.key` in the configurations package root.
 
-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`
+### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli build --serve
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli preview
 ```
 
-## `serve`
+### Create local certificates
 
-Run a local web server for pre-built bundle.
-
-### Example
-
-1. Build an optimised (minified) bundle of the _example-02-typical-customisations_ customer configuration
+Install `mkcert`:
 
-    ```bash
-    cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-    npx -y @raisenow/tamaro-cli build
-    ```
+```bash
+brew install mkcert
+```
 
-2. Serve it. After running this command, web-server should be running on <http://localhost:1234> (port may differ, see
-   console output).
+Generate the certificate and key in the configurations repository root:
 
-    ```bash
-    npx -y @raisenow/tamaro-cli serve
-    ```
+```bash
+mkcert -install -cert-file localhost.crt -key-file localhost.key localhost 127.0.0.1 0.0.0.0 ::1
+```
 
 ## `deploy`
 
-Deploy a pre-built _Tamaro Core_ or customer configuration bundle to AWS S3.
+Deploy a pre-built customer configuration bundle to AWS S3. The command always runs `validate` before deploying.
 
 ### Options
 
-- `--dryrun` – Displays the operations that would be performed without actually running them
-- `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: "latest")
-- `--force-skip-epms-sync` – Skip the EPMS sync entirely. Only use this in emergencies.
-
-Make sure you have built the bundle before deploying it with this command, otherwise you may mistakenly deploy the
-bundle from a previous build.
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--tag <tag>` - Tag to deploy, default: `latest`
+- `--dryrun` - Show the operations without executing them
+- `--force-skip-epms-sync` - Skip the EPMS sync entirely. Only use this in emergencies.
 
 ### 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
-    ```
+```bash
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli deploy --tag WEB-123
+```
 
 ## `list-deployed`
 
-List deployments of _Tamaro Core_ or a particular customer configuration.
+List the deployed tags for the current customer configuration.
 
 ### Options
 
-- `--config <config>` – Configuration name (default: current customer configuration)
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
 
 ### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli list-deployed
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli list-deployed
 ```
 
 ## `deploy-email-config`
 
-Deploy a widget’s email configuration to AWS S3.
+Deploy the current configuration's `email-config` folder to AWS S3. The command always runs `validate` before deploying.
+
+### Options
+
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--bucket <bucket>` - AWS bucket for email configs
+- `--dryrun` - Show the operations without executing them
+
+If `--bucket` is omitted outside CI, the CLI prompts for the target environment.
 
 ### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli deploy-email-config
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli deploy-email-config
 ```
 
 ## `undeploy`
 
-Undeploy a _Tamaro Core_ or customer configuration bundle from AWS S3. Removes the specified tag from S3 and invalidates
-the CloudFront cache. Always asks for confirmation unless `-y` is passed.
-
-**NOTE**: _Tamaro Core_ cannot be undeployed with the `latest` or no tag.
+Remove a previously deployed bundle from AWS S3 and invalidate the CloudFront cache.
 
 ### Options
 
-- `--tag <tag>` – Tag which should be undeployed (default: "latest")
-- `--all` – Undeploy all tags
-- `--dryrun` – Displays the operations that would be performed without actually running them
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--tag <tag>` - Tag to undeploy, default: `latest`
+- `--all` - Undeploy all tags for the current configuration
+- `--dryrun` - Show the operations without executing them
+
+`--all` and `--tag` cannot be used together.
 
-### Undeploy the "latest" tag
+### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli undeploy
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli undeploy --tag WEB-123
 ```
 
-### Undeploy a specific tag
+## `undeploy-email-config`
 
-```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli undeploy --tag WEB-123
-```
+Remove the current configuration's email configuration from AWS S3.
+
+### Options
 
-### Undeploy all tags
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--bucket <bucket>` - AWS bucket for email configs
+- `--stage` - Use the stage email-config bucket
+- `--prod` - Use the prod email-config bucket
+- `--dryrun` - Show the operations without executing them
+
+### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli undeploy --all
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli undeploy-email-config --stage
 ```
 
-## `undeploy-email-config`
+## `archive`
 
-Undeploy a widget's email configuration from AWS S3.
+Archive the current configuration by moving it into the `_archived` directory. Unless disabled, the command also archives the related EPMS entries.
 
 ### Options
 
-- `--bucket <bucket>` – AWS bucket for email configs
-- `--dryrun` – Displays the operations that would be performed without actually running them
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--dryrun` - Show the operations without executing them
+- `--force-skip-epms-sync` - Skip EPMS archive sync. Emergency use only.
 
 ### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli undeploy-email-config
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli archive
 ```
 
-## `update-epms`
+## `unarchive`
 
-Sync the Tamaro configuration with EPMS (without deploying it). 
+Restore an archived configuration from `_archived` back into the main `configs` directory. Unless disabled, the command also unarchives the related EPMS entries.
 
-## Options
+### Options
 
-- `--dryrun` – Displays the operations that would be performed without actually running them
-- `--tag <tag>` – Tag which should be used for the deployment of the bundle (default: "latest")
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--dryrun` - Show the operations without executing them
+- `--force-skip-epms-sync` - Skip EPMS unarchive sync. Emergency use only.
 
-## `archive`
+### Example
 
-Archive a customer configuration. This moves the configuration folder into the `_archived` folder.
+```bash
+cd /path/to/tamaro-configurations/configs/_archived/epms-demo
+pnpx @raisenow/tamaro-cli unarchive
+```
+
+## `update-epms`
+
+Update EPMS with the currently deployed widget tag for the current configuration without uploading a new build.
 
 ### Options
 
-- `--dryrun` – Displays the operations that would be performed without actually running them
+- `--profile <profile>` - AWS profile
+- `--ci` - Run in CI mode
+- `--dryrun` - Show the operations without executing them
+- `--tag <tag>` - Tag to set in EPMS, default: `latest`
 
 ### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli archive
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli update-epms --tag WEB-123
 ```
 
-## `unarchive`
-
-Unarchive a previously archived customer configuration. This moves the configuration out of the `_archived` folder.
-
-### Options
+## `validate`
 
-- `--dryrun` – Displays the operations that would be performed without actually running them
+Validate the current configuration and fail on known issues such as invalid email templates.
 
 ### Example
 
 ```bash
-cd /path/to/tamaro-configurations/configs/_archived/example-02-typical-customisations
-npx -y @raisenow/tamaro-cli unarchive
+cd /path/to/tamaro-configurations/configs/epms-demo
+pnpx @raisenow/tamaro-cli validate
 ```
 
 # Development
 
-Make sure you have installed and activated the proper `node` and `npm` versions.
+Use the versions declared in `package.json`:
 
-- `node: ">= 16"`
-- `npm: ">= 8"`
+- `node >= 24.16.0`
+- `pnpm >= 11.7.0`
 
-Clone the repository and install its dependencies:
+Clone the repository and install dependencies:
 
 ```bash
 git clone git@bitbucket.org:raisenow/tamaro-cli.git
 cd tamaro-cli
-npm ci
+pnpm install
 ```
 
-Link package source to be able to run its local version:
+Build the CLI:
 
 ```bash
-npm link .
+pnpm build
 ```
 
-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 watch build during CLI development:
 
 ```bash
-npm run build:watch
+pnpm dev
 ```
 
-To use the locally linked version of _Tamaro CLI_, use it without `@raisenow/` scope, `-y` flag is also not needed:
+Use the local build directly from a configuration directory:
 
 ```bash
-npx tamaro-cli dev
+cd /path/to/tamaro-configurations/configs/epms-demo
+node ../../tools/tamaro-cli/dist/cli.js dev
 ```