@testmonitor/testmonitor-cli 0.0.1 → 0.0.4

package/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

package/.prettierignore

@@ -0,0 +1,10 @@
+# Build artifacts
+build
+coverage
+dist
+
+# Markdown files
+**/*.md
+
+# Lock files
+package-lock.json

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2025-08-15
+### Added
+- Initial version.

package/README.md

@@ -1,95 +1,128 @@
 # TestMonitor CLI
 
-TestMonitor CLI (`testmonitor-cli`) is a command-line tool to submit JUnit XML test results to a JSON API.
+The TestMonitor CLI (`testmonitor-cli`) lets you interact with the TestMonitor platform directly from your terminal or CI pipelines. You can use it to submit automated test results through a simple, scriptable interface.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+- [Command Reference](#command-reference)
+- [Documentation](#documention)
+- [License](#license)
 
 ## Installation
 
-Simply install the package by using NPM or Yarn:
+Install the CLI globally using NPM:
+
+```sh
+npm install -g @testmonitor/testmonitor-cli
+```
+
+To upgrade to the latest version later on, run:
 
 ```sh
-npm install -g testmonitor-cli
+npm update -g @testmonitor/testmonitor-cli
 ```
 
-or
+After installation, you can verify the installed version with:
 
 ```sh
-yarn global add testmonitor-cli
+testmonitor-cli --version
 ```
 
-This installs the TestMonitor CLI tool globally on your system.
+## Getting Started
 
-## Authentication
+To begin using the CLI, follow these steps:
 
-TestMonitor CLI requires authentication via an API token. Set the token as an environment variable:
+### Authenticate
 
+Set your API token using the TESTMONITOR_TOKEN environment variable.
+
+**macOS/Linux:**
 ```sh
 export TESTMONITOR_TOKEN=<your_api_token>
 ```
 
-On Windows (PowerShell):
-
+**Windows (PowerShell):**
 ```sh
 $env:TESTMONITOR_TOKEN="<your_api_token>"
 ```
 
-## Usage
+> You can find or regenerate your API token in your TestMonitor user profile settings under API Tokens.
+
+### Check your connection
 
-Once you've setup your TestMonitor token, you can start submitting JUnit reports:
+Verify that your domain and token are set up correctly:
 
 ```sh
-testmonitor-cli submit -d <TESTMONITOR_DOMAIN> -i <INTEGRATION_ID> -f <FILE_PATH>
+testmonitor-cli check auth -d domain.testmonitor.com
 ```
 
-For example:
+If the connection is successful, you’ll see:
 
 ```sh
-testmonitor-cli submit -d domain.testmonitor.com -i 12345-abcdef-67890-ghijkl -f results.xml
+Connection successful.
 ```
 
-## Commands
+If the check fails, try the following:
 
-### `submit`
+- **Invalid token**: Regenerate it from your user profile in TestMonitor and update the TESTMONITOR_TOKEN variable.
+- **Wrong domain**: Double-check that the --domain flag matches the full domain assigned to your TestMonitor workspace (e.g., mycompany.testmonitor.com).
+- **Deleted or inactive account**: Log into TestMonitor to ensure your user account is still active.
 
-Submit a JUnit XML test report.
+If problems persist, contact support@testmonitor.com.
 
-**Options:**
-```sh
--d, --domain <domain>       TestMonitor domain (required)
--i, --integration-id <id>   Integration ID (required)
--f, --file <path>           Path to JUnit XML file (required)
-```
+## Command Reference
 
-## Development
+This section lists all available commands grouped by functionality.
 
-Clone the repository and install dependencies:
+### Check
 
-```sh
-git clone https://github.com/testmonitor/testmonitor-cli.git
-cd testmonitor-cli
-npm install
-```
+Tools for verifying your CLI setup and connection to the TestMonitor API.
+
+#### Auth
+
+Verify API token and domain connectivity.
 
-Run locally:
 ```sh
-node index.js submit -d api.testmonitor.com -i 12345-abcdef-67890-ghijkl -f test-results.xml
+testmonitor-cli check auth [options]
 ```
 
-Run tests:
+|   Option                 |   Description                    |
+|--------------------------|----------------------------------|
+|   -d, --domain <domain>  |   TestMonitor domain (required)  |
+
+### JUnit
+
+Commands for managing JUnit-style test reports.
+
+#### Submit
+
+Submit a JUnit XML report and create a new test run in your TestMonitor project.
+
 ```sh
-npm test
+testmonitor-cli junit submit [options]
 ```
 
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/testmonitor/testmonitor/tags)
-and the [releases](https://github.com/testmonitor/testmonitor/releases) on this repository.
+|   Option                          |   Description                                    |
+|-----------------------------------|--------------------------------------------------|
+|   -d, --domain <domain>           |   TestMonitor domain (required)                  |
+|   -i, --integration-id <id>       |   JUnit integration ID (required)                |
+|   -f, --file <path>               |   Path to JUnit XML file (required)              |
+|   -n, --name <name>               |   Custom test run name                           |
+|   -m, --milestone-id <id>         |   Target milestone ID                            |
+|   -o, --milestone-name <name>     |   Milestone name to find or create               |
+|   -e, --test-environment-id <id>  |   Target test environment ID                     |
+|   -t, --type <type>               |   Test type (e.g. cypress, playwright, phpunit)  |
+|   -p, --preserve-names            |   Preserve original test case names              |
+|   -s, --skip-root-suite           |   Skip root test suite nesting                   |
+|   -v, --verbose                   |   Output debug information                       |
 
-## Authors
+## Documentation
 
-* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
-* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
-* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)
+Please refer to our [knowledge base](https://help.testmonitor.com/) for more information.
 
 ## License
 
-TestMonitor is a commercial product, provided as a SaaS application to the customers of TestManagement BV.
+Copyright (c) TestMonitor | we are Cerios B.V.
+All rights reserved.

package/dist/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+var N=Object.defineProperty;var D=(n,e)=>()=>(n&&(e=n(n=0)),e);var S=(n,e)=>{for(var t in e)N(n,t,{get:e[t],enumerable:!0})};var b={};S(b,{default:()=>L});var L,T=D(()=>{L={name:"@testmonitor/testmonitor-cli",type:"module",version:"0.0.2",description:"The TestMonitor CLI lets you interact with the TestMonitor platform directly from your terminal or CI pipelines.",keywords:["testmonitor","cli"],homepage:"https://www.testmonitor.com/",bugs:{url:"https://github.com/testmonitor/testmonitor-cli/issues"},repository:{type:"git",url:"git+https://github.com/testmonitor/testmonitor-cli.git"},author:"TestMonitor | we are Cerios B.V.",main:"src/index.js",bin:{"testmonitor-cli":"dist/index.js"},scripts:{start:"node src/index.js",build:"node esbuild.config.js",lint:"eslint .","lint:fix":"eslint . --fix",test:"NODE_OPTIONS='--experimental-vm-modules' jest","test:watch":"NODE_OPTIONS='--experimental-vm-modules' jest --watch","test:coverage":"NODE_OPTIONS='--experimental-vm-modules' jest --coverage"},dependencies:{axios:"^1.7.9",chalk:"^5.4.1",commander:"^14.0.0",dotenv:"^17.2.0",ora:"^8.2.0","strip-ansi":"^7.1.0",table:"^6.9.0"},devDependencies:{chai:"^5.2.0",esbuild:"^0.25.6",eslint:"^9.31.0","eslint-config-prettier":"^10.1.5","eslint-formatter-junit":"^8.40.0","eslint-plugin-import":"^2.32.0","eslint-plugin-jest":"^28.14.0","eslint-plugin-jsdoc":"^51.4.1",jest:"^29.7.0","jest-junit":"^16.0.0",prettier:"^3.6.2"},engines:{node:">=16.0.0"}}});import"dotenv/config";import{Command as W}from"commander";async function y(){return"0.0.2"}import{Command as B}from"commander";import{Command as X}from"commander";import C from"os";import R from"fs";import P from"axios";import O from"form-data";var V=await y(),q=`NodeJS/${process.nodeVersion}`,J=`${C.platform()} ${C.release()}`,A=`TestMonitorCLI/${V} (${q}; ${J}; +https://www.testmonitor.com/)`,u=class{constructor({domain:e,apiKey:t,httpClient:o}){this.baseURL=`https://${e}/api/v1`,this.apiKey=t,this.httpClient=o||P.create({baseURL:this.baseURL,headers:{Authorization:`Bearer ${this.apiKey}`,"User-Agent":A}})}async get(e,t={}){return this._request("get",e,null,t)}async post(e,t={},o={}){return this._request("post",e,t,o)}async put(e,t={},o={}){return this._request("put",e,t,o)}async delete(e,t={}){return this._request("delete",e,null,t)}async _request(e,t,o,i){let s={...o instanceof O?o.getHeaders():{"Content-Type":"application/json"},...i.headers||{}};try{return(await this.httpClient.request({method:e,url:t,data:o,headers:s,...i})).data}catch(a){let f=a.response?.data?.message||a.message;throw new Error(f)}}async checkConnection(){return this.get("/my-account")}async submitJUnitReport({integrationId:e,filePath:t,name:o,type:i,milestoneId:r,milestoneName:s,preserveNames:a,skipRootSuite:f,testEnvironmentId:w}){let c=new O;c.append("integration_id",e),c.append("report",R.createReadStream(t));let v={name:o,type:i,milestone:s,milestone_id:r,preserve_names:a?1:null,skip_root_suite:f?1:null,test_environment_id:w};for(let[m,l]of Object.entries(v))l!=null&&c.append(m,l);return this.post("/reporters/junit/submit",c)}};import d from"chalk";import K from"ora";import{table as F}from"table";var h=class{#e="TestMonitor";info(e){console.log(`${this.#e}: ${e}`)}success(e){console.log(`${this.#e}: ${d.green(e)}`)}warn(e){console.warn(`${this.#e}: ${d.yellow(e)}`)}error(e,t){let o=`${this.#e}: ${d.red(e)}`;console.error(o),process.env.DEBUG&&t instanceof Error&&console.error(d.gray(t.stack||t.message))}debug(e){process.env.DEBUG&&console.log(`${this.#e}: ${e}`)}line(e=""){console.log(e)}async spin(e,t,o={}){let i=K({text:`${this.#e}: ${e}`,color:"green"}).start();try{let r=await t();return i.succeed(`${this.#e}: ${d.green(o.successMessage||e)}`),r}catch(r){throw i.fail(`${this.#e}: ${d.red(o.errorMessage||e)}`),r}}table(e,t){let o=F(e,{singleLine:!0,...t});console.log(o)}};async function G(n,{client:e}={}){let{domain:t}=n,o=new h,i=process.env.TESTMONITOR_TOKEN;i||(o.error("TESTMONITOR_TOKEN environment variable is not set."),process.exit(1));let r=e||new u({domain:t,apiKey:i});try{let{data:s}=await o.spin("Connecting...",()=>r.checkConnection(),{successMessage:"Connection successful.",errorMessage:"Failed to connect."});o.line(),o.table([["User ID",s.id],["Name",s.name],["Email",s.email]])}catch(s){let a=s.response?.data?.message||s.message;o.line(),o.error(a,s),process.exit(1)}}var _=new X("auth").description("Verify connectivity with your TestMonitor instance.").requiredOption("-d, --domain <domain>","Your TestMonitor domain name (e.g., mydomain.testmonitor.com)").action(async n=>{await G(n)});var x=new B("check").name("check").description("Commands for verifying the connection state.").helpOption("-h, --help","Display help for command.");x.addCommand(_);var M=x;import{Command as Q}from"commander";import"dotenv/config";import Y from"fs";import{Command as z}from"commander";async function H(n,{client:e}={}){let{domain:t,integrationId:o,file:i,name:r,milestoneId:s,milestoneName:a,preserveNames:f,skipRootSuite:w,testEnvironmentId:c,type:v}=n,m=new h,l=process.env.TESTMONITOR_TOKEN;l||(m.error("TESTMONITOR_TOKEN environment variable is not set."),process.exit(1)),Y.existsSync(i)||(m.error(`File not found at path ${i}`),process.exit(1));let j=e||new u({domain:t,apiKey:l});try{let{data:p}=await m.spin("Submitting...",()=>j.submitJUnitReport({integrationId:o,filePath:i,name:r,type:v,milestoneId:s,milestoneName:a,preserveNames:f,skipRootSuite:w,testEnvironmentId:c}),{successMessage:"Report submitted.",errorMessage:"Failed to submit."});m.line(),m.table([["JUnit file",p.name],["Test run code",p.test_run.code],["Test run URL",p.test_run.links.show]])}catch(p){let k=p.response?.data?.message||p.message;m.line(),m.error(k,p),process.exit(1)}}var $=new z("submit").name("submit").description("Submit a JUnit XML file to your TestMonitor instance.").helpOption("-h, --help","Display help for command.").requiredOption("-d, --domain <domain>","Your TestMonitor domain name (e.g., mydomain.testmonitor.com)").requiredOption("-i, --integration-id <id>","The JUnit integration ID").requiredOption("-f, --file <path>","Path to your JUnit XML file").option("-m, --milestone-id <id>","Milestone ID for the new test run (required if not set in configuration))").option("-o, --milestone-name <name>","Find or create a milestone by name for the test run.").option("-n, --name <name>","Custom name for the test run (auto-generated if omitted).").option("-p, --preserve-names","Preserve test case names exactly as in the XML file.").option("-s, --skip-root-suite","Skip the root suite and start from nested suites.").option("-e, --test-environment-id <id>","Test environment ID for the new test run.").option("-t, --type <type>","The automation test type (cypress, playwright, phpunit, selenium).").option("-v, --verbose","Enable verbose debug output.").action(n=>H(n));var I=new Q("junit").name("junit").description("Commands for JUnit XML report submission.").helpOption("-h, --help","Display help for command.");I.addCommand($);var E=I;var g=new W;g.name("testmonitor-cli").version(await y(),"-v, --version","Display the current CLI version.").description("CLI tool for interacting with the TestMonitor API.").helpCommand(!1).helpOption("-h, --help","Display help for command.");g.on("option:verbose",function(){process.env.VERBOSE=this.opts().verbose});g.addCommand(M);g.addCommand(E);g.parse(process.argv);

package/package.json

@@ -1,43 +1,57 @@
 {
-  "name": "@testmonitor/testmonitor-cli",
-  "version": "0.0.1",
-  "description": "TestMonitor CLI tool",
-  "keywords": [
-    "testmonitor",
-    "cli"
-  ],
-  "homepage": "https://www.testmonitor.com/",
-  "bugs": {
-    "url": "https://github.com/testmonitor/testmonitor-cli/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/testmonitor/testmonitor-cli.git"
-  },
-  "author": "TestMonitor | we are Cerios B.V.",
-  "main": "index.js",
-  "bin": {
-    "testmonitor-cli": "index.js"
-  },
-  "scripts": {
-    "start": "node index.js",
-    "lint": "eslint .",
-    "test": "mocha"
-  },
-  "dependencies": {
-    "axios": "^1.7.9",
-    "chalk": "^5.4.1",
-    "commander": "^13.1.0",
-    "dotenv": "^16.4.7",
-    "table": "^6.9.0"
-  },
-  "devDependencies": {
-    "chai": "^5.2.0",
-    "eslint": "^9.21.0",
-    "mocha": "^11.1.0",
-    "sinon": "^19.0.2"
-  },
-  "engines": {
-    "node": ">=16.0.0"
-  }
+    "name": "@testmonitor/testmonitor-cli",
+    "type": "module",
+    "version": "0.0.4",
+    "description": "The TestMonitor CLI lets you interact with the TestMonitor platform directly from your terminal or CI pipelines.",
+    "keywords": [
+        "testmonitor",
+        "cli"
+    ],
+    "homepage": "https://www.testmonitor.com/",
+    "bugs": {
+        "url": "https://github.com/testmonitor/testmonitor-cli/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/testmonitor/testmonitor-cli.git"
+    },
+    "author": "TestMonitor | we are Cerios B.V.",
+    "main": "src/index.js",
+    "bin": {
+        "testmonitor-cli": "dist/index.js"
+    },
+    "scripts": {
+        "start": "node src/index.js",
+        "build": "node esbuild.config.js",
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+        "test:watch": "NODE_OPTIONS='--experimental-vm-modules' jest --watch",
+        "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage"
+    },
+    "dependencies": {
+        "axios": "^1.7.9",
+        "chalk": "^5.4.1",
+        "commander": "^14.0.0",
+        "dotenv": "^17.2.0",
+        "ora": "^8.2.0",
+        "strip-ansi": "^7.1.0",
+        "table": "^6.9.0"
+    },
+    "devDependencies": {
+        "chai": "^5.2.0",
+        "esbuild": "^0.25.6",
+        "eslint": "^9.31.0",
+        "eslint-config-prettier": "^10.1.5",
+        "eslint-formatter-junit": "^8.40.0",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-jest": "^28.14.0",
+        "eslint-plugin-jsdoc": "^51.4.1",
+        "jest": "^29.7.0",
+        "jest-junit": "^16.0.0",
+        "prettier": "^3.6.2"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    }
 }

package/src/commands/check/check-auth-command.js

@@ -0,0 +1,45 @@
+import { Command } from 'commander';
+
+import { APIClient } from '../../lib/api-client.js';
+import { Logger } from '../../lib/logger.js';
+
+export async function handleCheckConnection(options, { client } = {}) {
+    const { domain } = options;
+
+    const log = new Logger();
+    const apiKey = process.env.TESTMONITOR_TOKEN;
+
+    if (!apiKey) {
+        log.error('TESTMONITOR_TOKEN environment variable is not set.');
+        process.exit(1);
+    }
+
+    const apiClient = client || new APIClient({ domain, apiKey });
+
+    try {
+        const { data } = await log.spin('Connecting...', () => apiClient.checkConnection(), {
+            successMessage: 'Connection successful.',
+            errorMessage: 'Failed to connect.',
+        });
+
+        log.line();
+        log.table([
+            ['User ID', data.id],
+            ['Name', data.name],
+            ['Email', data.email],
+        ]);
+    } catch (error) {
+        const message = error.response?.data?.message || error.message;
+
+        log.line();
+        log.error(message, error);
+        process.exit(1);
+    }
+}
+
+export const checkAuthCommand = new Command('auth')
+    .description('Verify connectivity with your TestMonitor instance.')
+    .requiredOption('-d, --domain <domain>', 'Your TestMonitor domain name (e.g., mydomain.testmonitor.com)')
+    .action(async (options) => {
+        await handleCheckConnection(options);
+    });

package/src/commands/check/index.js

@@ -0,0 +1,12 @@
+import { Command } from 'commander';
+
+import { checkAuthCommand } from './check-auth-command.js';
+
+const checkGroup = new Command('check')
+    .name('check')
+    .description('Commands for verifying the connection state.')
+    .helpOption('-h, --help', 'Display help for command.');
+
+checkGroup.addCommand(checkAuthCommand);
+
+export default checkGroup;

package/src/commands/junit/index.js

@@ -0,0 +1,12 @@
+import { Command } from 'commander';
+
+import { submitJUnitXMLCommand } from './submit-junit-xml-command.js';
+
+const junitGroup = new Command('junit')
+    .name('junit')
+    .description('Commands for JUnit XML report submission.')
+    .helpOption('-h, --help', 'Display help for command.');
+
+junitGroup.addCommand(submitJUnitXMLCommand);
+
+export default junitGroup;

package/src/commands/junit/submit-junit-xml-command.js

@@ -0,0 +1,90 @@
+import 'dotenv/config';
+import fs from 'fs';
+
+import { Command } from 'commander';
+
+import { APIClient } from '../../lib/api-client.js';
+import { Logger } from '../../lib/logger.js';
+
+export async function handleSubmitJUnitXML(options, { client } = {}) {
+    const {
+        domain,
+        integrationId,
+        file,
+        name,
+        milestoneId,
+        milestoneName,
+        preserveNames,
+        skipRootSuite,
+        testEnvironmentId,
+        type,
+    } = options;
+
+    const log = new Logger();
+    const apiKey = process.env.TESTMONITOR_TOKEN;
+
+    if (!apiKey) {
+        log.error('TESTMONITOR_TOKEN environment variable is not set.');
+        process.exit(1);
+    }
+
+    if (!fs.existsSync(file)) {
+        log.error(`File not found at path ${file}`);
+        process.exit(1);
+    }
+
+    const apiClient = client || new APIClient({ domain, apiKey });
+
+    try {
+        const { data } = await log.spin(
+            'Submitting...',
+            () =>
+                apiClient.submitJUnitReport({
+                    integrationId,
+                    filePath: file,
+                    name,
+                    type,
+                    milestoneId,
+                    milestoneName,
+                    preserveNames,
+                    skipRootSuite,
+                    testEnvironmentId,
+                }),
+            {
+                successMessage: 'Report submitted.',
+                errorMessage: 'Failed to submit.',
+            }
+        );
+
+        log.line();
+        log.table([
+            ['JUnit file', data.name],
+            ['Test run code', data.test_run.code],
+            ['Test run URL', data.test_run.links.show],
+        ]);
+    } catch (error) {
+        const message = error.response?.data?.message || error.message;
+
+        log.line();
+        log.error(message, error);
+        process.exit(1);
+    }
+}
+
+// Command to submit a JUnit XML file
+export const submitJUnitXMLCommand = new Command('submit')
+    .name('submit')
+    .description('Submit a JUnit XML file to your TestMonitor instance.')
+    .helpOption('-h, --help', 'Display help for command.')
+    .requiredOption('-d, --domain <domain>', 'Your TestMonitor domain name (e.g., mydomain.testmonitor.com)')
+    .requiredOption('-i, --integration-id <id>', 'The JUnit integration ID')
+    .requiredOption('-f, --file <path>', 'Path to your JUnit XML file')
+    .option('-m, --milestone-id <id>', 'Milestone ID for the new test run (required if not set in configuration))')
+    .option('-o, --milestone-name <name>', 'Find or create a milestone by name for the test run.')
+    .option('-n, --name <name>', 'Custom name for the test run (auto-generated if omitted).')
+    .option('-p, --preserve-names', 'Preserve test case names exactly as in the XML file.')
+    .option('-s, --skip-root-suite', 'Skip the root suite and start from nested suites.')
+    .option('-e, --test-environment-id <id>', 'Test environment ID for the new test run.')
+    .option('-t, --type <type>', 'The automation test type (cypress, playwright, phpunit, selenium).')
+    .option('-v, --verbose', 'Enable verbose debug output.')
+    .action((options) => handleSubmitJUnitXML(options));

package/src/index.js

@@ -0,0 +1,25 @@
+import 'dotenv/config';
+
+import { Command } from 'commander';
+
+import { appVersion } from './lib/app-version.js';
+import checkGroup from './commands/check/index.js';
+import junitGroup from './commands/junit/index.js';
+
+const program = new Command();
+
+program
+    .name('testmonitor-cli')
+    .version(await appVersion(), '-v, --version', 'Display the current CLI version.')
+    .description('CLI tool for interacting with the TestMonitor API.')
+    .helpCommand(false)
+    .helpOption('-h, --help', 'Display help for command.');
+
+program.on('option:verbose', function () {
+    process.env.VERBOSE = this.opts().verbose;
+});
+
+program.addCommand(checkGroup);
+program.addCommand(junitGroup);
+
+program.parse(process.argv);

package/src/lib/api-client.js

@@ -0,0 +1,113 @@
+import os from 'os';
+import fs from 'fs';
+
+import axios from 'axios';
+import FormData from 'form-data';
+
+import { appVersion } from './app-version.js';
+
+const cliVersion = await appVersion();
+const nodeVersion = `NodeJS/${process.nodeVersion}`;
+const osVersion = `${os.platform()} ${os.release()}`;
+const userAgent = `TestMonitorCLI/${cliVersion} (${nodeVersion}; ${osVersion}; +https://www.testmonitor.com/)`;
+
+export class APIClient {
+    constructor({ domain, apiKey, httpClient }) {
+        this.baseURL = `https://${domain}/api/v1`;
+        this.apiKey = apiKey;
+
+        this.httpClient =
+            httpClient ||
+            axios.create({
+                baseURL: this.baseURL,
+                headers: {
+                    Authorization: `Bearer ${this.apiKey}`,
+                    'User-Agent': userAgent,
+                },
+            });
+    }
+
+    async get(path, config = {}) {
+        return this._request('get', path, null, config);
+    }
+
+    async post(path, data = {}, config = {}) {
+        return this._request('post', path, data, config);
+    }
+
+    async put(path, data = {}, config = {}) {
+        return this._request('put', path, data, config);
+    }
+
+    async delete(path, config = {}) {
+        return this._request('delete', path, null, config);
+    }
+
+    async _request(method, path, data, config) {
+        const isFormData = data instanceof FormData;
+        const headers = {
+            ...(isFormData ? data.getHeaders() : { 'Content-Type': 'application/json' }),
+            ...(config.headers || {}),
+        };
+
+        try {
+            const response = await this.httpClient.request({
+                method,
+                url: path,
+                data,
+                headers,
+                ...config,
+            });
+
+            return response.data;
+        } catch (err) {
+            const message = err.response?.data?.message || err.message;
+            throw new Error(message);
+        }
+    }
+
+    /**
+     * Check connection to the API by fetching account info
+     */
+    async checkConnection() {
+        return this.get('/my-account');
+    }
+
+    /**
+     * Submit a JUnit report using plain data and file path
+     */
+    async submitJUnitReport({
+        integrationId,
+        filePath,
+        name,
+        type,
+        milestoneId,
+        milestoneName,
+        preserveNames,
+        skipRootSuite,
+        testEnvironmentId,
+    }) {
+        const form = new FormData();
+
+        form.append('integration_id', integrationId);
+        form.append('report', fs.createReadStream(filePath));
+
+        const optional = {
+            name,
+            type,
+            milestone: milestoneName,
+            milestone_id: milestoneId,
+            preserve_names: preserveNames ? 1 : null,
+            skip_root_suite: skipRootSuite ? 1 : null,
+            test_environment_id: testEnvironmentId,
+        };
+
+        for (const [key, value] of Object.entries(optional)) {
+            if (value !== undefined && value !== null) {
+                form.append(key, value);
+            }
+        }
+
+        return this.post('/reporters/junit/submit', form);
+    }
+}

package/src/lib/app-version.js

@@ -0,0 +1,8 @@
+export async function appVersion() {
+    if (typeof __APP_VERSION__ !== 'undefined') {
+        return __APP_VERSION__;
+    }
+
+    const pkg = await import('../../package.json', { with: { type: 'json' } });
+    return pkg.default.version;
+}

package/src/lib/logger.js

@@ -0,0 +1,59 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import { table } from 'table';
+
+export class Logger {
+    #prefix = 'TestMonitor';
+
+    info(message) {
+        console.log(`${this.#prefix}: ${message}`);
+    }
+
+    success(message) {
+        console.log(`${this.#prefix}: ${chalk.green(message)}`);
+    }
+
+    warn(message) {
+        console.warn(`${this.#prefix}: ${chalk.yellow(message)}`);
+    }
+
+    error(message, err) {
+        const output = `${this.#prefix}: ${chalk.red(message)}`;
+        console.error(output);
+
+        if (process.env.DEBUG && err instanceof Error) {
+            console.error(chalk.gray(err.stack || err.message));
+        }
+    }
+
+    debug(message) {
+        if (process.env.DEBUG) {
+            console.log(`${this.#prefix}: ${message}`);
+        }
+    }
+
+    line(message = '') {
+        console.log(message);
+    }
+
+    async spin(message, callback, options = {}) {
+        const spinner = ora({
+            text: `${this.#prefix}: ${message}`,
+            color: 'green',
+        }).start();
+
+        try {
+            const result = await callback();
+            spinner.succeed(`${this.#prefix}: ${chalk.green(options.successMessage || message)}`);
+            return result;
+        } catch (error) {
+            spinner.fail(`${this.#prefix}: ${chalk.red(options.errorMessage || message)}`);
+            throw error;
+        }
+    }
+
+    table(rows, config) {
+        const output = table(rows, { ...{ singleLine: true }, ...config });
+        console.log(output);
+    }
+}

package/actions/SubmitReport.js

@@ -1,83 +0,0 @@
-import fs from 'fs';
-import axios from 'axios';
-import FormData from 'form-data';
-import chalk from 'chalk';
-import { table, getBorderCharacters } from 'table';
-
-export class SubmitReport {
-  constructor({ domain, apiKey, integrationId, file, name, type, milestoneId, milestoneName, preserveNames, skipRootSuite, testEnvironmentId }) {
-    this.domain = domain;
-    this.apiKey = apiKey;
-    this.integrationId = integrationId;
-    this.file = file;
-    this.name = name;
-    this.type = type;
-    this.milestoneId = milestoneId;
-    this.milestoneName = milestoneName;
-    this.preserveNames = preserveNames;
-    this.skipRootSuite = skipRootSuite;
-    this.testEnvironmentId = testEnvironmentId;
-  }
-
-  async run() {
-    const formData = new FormData();
-
-    // Required
-    formData.append('integration_id', this.integrationId);
-    formData.append('report', fs.createReadStream(this.file));
-
-    // Optional
-    const optional = {
-      name: this.name,
-      type: this.type,
-      milestone: this.milestoneName,
-      milestone_id: this.milestoneId,
-      preserve_names: this.preserveNames ? 1: null,
-      skip_root_suite: this.skipRootSuite ? 1 : null,
-      test_environment_id: this.testEnvironmentId,
-    };
-
-    for (const [key, value] of Object.entries(optional)) {
-      if (value !== undefined && value !== null) {
-        formData.append(key, value);
-      }
-    }
-
-    try {
-      const response = await axios.post(
-        `https://${this.domain}/api/v1/reporters/junit/submit`,
-        formData,
-        {
-          headers: {
-            ...formData.getHeaders(),
-            Authorization: `Bearer ${this.apiKey}`,
-          },
-        }
-      );
-
-      const { data } = response.data;
-
-      const config = {
-        border: getBorderCharacters('ramac'),
-        singleLine: true,
-      };
-
-      const rows = [
-        [chalk.bold('File'), data.name],
-        [chalk.bold('Date'), data.created_at],
-        [chalk.bold('ID'), data.test_run.id],
-        [chalk.bold('Code'), data.test_run.code],
-        [chalk.bold('Name'), data.test_run.name],
-        [chalk.bold('URL'), data.test_run.links.show],
-      ];
-
-      console.log(table(rows, config));
-
-      console.log('Report submitted ' + chalk.green('successfully') + '.');
-    } catch (error) {
-      const message = error.response?.data?.message || error.message;
-      console.error(chalk.red('Error') + ': ' + message);
-      process.exit(1);
-    }
-  }
-}

package/commands/submit.js

@@ -1,64 +0,0 @@
-import { Command } from 'commander';
-import { SubmitReport } from '../actions/SubmitReport.js';
-import fs from 'fs';
-import chalk from 'chalk';
-import 'dotenv/config';
-
-const submitCommand = new Command('submit')
-  .description('Submit a JUnit XML file to your TestMonitor instance.')
-  .helpOption('-h, --help', 'Display help for command')
-  .requiredOption('-d, --domain <domain>', 'Your TestMonitor domain name (e.g., mydomain.testmonitor.com)')
-  .requiredOption('-i, --integration-id <id>', 'The JUnit integration ID')
-  .requiredOption('-f, --file <path>', 'Path to your JUnit XML file')
-  .option('-m, --milestone-id <id>', 'The milestone ID for the new test run (required if not configured in your JUnit configuration)')
-  .option('-o, --milestone-name <name>', 'Finds or creates a milestone matching the name for the new test run')
-  .option('-n, --name <name>', 'The name for the new test run (will be auto-generated if not provided)')
-  .option('-p, --preserve-names', 'Preserve test case names exactly as they appear in the XML file.')
-  .option('-s, --skip-root-suite', 'Skip the root test suite and start from its nested suites.')
-  .option('-e, --test-environment-id <id>', 'The test environment ID for the new test run')
-  .option('-t, --type <type>', 'The automation test type (cypress, playwright, phpunit, selenium)')
-  .option('-v, --verbose', 'Output additional debug information')
-  .action(async (options) => {
-    const {
-      domain,
-      integrationId,
-      file,
-      name,
-      milestoneId,
-      milestoneName,
-      preserveNames,
-      skipRootSuite,
-      testEnvironmentId,
-      type,
-      verbose
-    } = options;
-
-    const apiKey = process.env.TESTMONITOR_TOKEN;
-
-    if (!apiKey) {
-      console.error(chalk.red('Error') + ': TESTMONITOR_TOKEN environment variable is not set.');
-      process.exit(1);
-    }
-
-    if (!fs.existsSync(file)) {
-      console.error(chalk.red('Error') + `: File not found at path ${file}`);
-      process.exit(1);
-    }
-
-    const action = new SubmitReport({
-      domain,
-      apiKey,
-      integrationId,
-      file,
-      name,
-      type,
-      milestoneId,
-      milestoneName,
-      preserveNames,
-      skipRootSuite,
-      testEnvironmentId
-    });
-    await action.run();
-  });
-
-export default submitCommand;

package/index.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import submitCommand from './commands/submit.js';
-import 'dotenv/config';
-
-const program = new Command();
-
-program
-    .name('testmonitor-cli')
-    .version('0.0.1')
-    .description('CLI tool for interacting with the TestMonitor API.');
-
-program.addCommand(submitCommand);
-
-program.on('option:verbose', function () {
-  process.env.VERBOSE = this.opts().verbose;
-});
-
-program.parse(process.argv);