mysa2mqtt/src/options.ts

/*
mysa2mqtt
Copyright (C) 2025 Pascal Bourque

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

import { Command, InvalidArgumentError, Option } from 'commander';
import { configDotenv } from 'dotenv';
import { readFileSync } from 'fs';
import { dirname, join } from 'path';
import { fileURLToPath } from 'url';

configDotenv({
  path: ['.env', '.env.local'],
  override: true
});

/**
 * Gets the package version at runtime.
 *
 * @returns The package version or 'unknown' if it cannot be read.
 */
function getPackageVersion(): string {
  try {
    const __filename = fileURLToPath(import.meta.url);
    const __dirname = dirname(__filename);
    const packageJsonPath = join(__dirname, '..', 'package.json');
    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
    return packageJson.version || 'unknown';
  } catch {
    return 'unknown';
  }
}

/**
 * Parses a required integer value.
 *
 * @param value - The value to parse.
 * @returns The parsed integer value.
 * @throws InvalidArgumentError if the value is not a valid integer.
 */
function parseRequiredInt(value: string) {
  const parsedValue = parseInt(value, 10);
  if (isNaN(parsedValue)) {
    throw new InvalidArgumentError('Must be a number.');
  }
  return parsedValue;
}

export const version = getPackageVersion();

const extraHelpText = `
Copyright (c) 2025 Pascal Bourque
Licensed under the MIT License

Source code and documentation available at: https://github.com/bourquep/mysa2mqtt
`;

export const options = new Command('mysa2mqtt')
  .version(version)
  .description('Expose Mysa smart thermostats to home automation platforms via MQTT.')
  .addHelpText('afterAll', extraHelpText)
  .addOption(
    new Option('-l, --log-level <logLevel>', 'log level')
      .choices(['silent', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'])
      .env('M2M_LOG_LEVEL')
      .default('info')
      .helpGroup('Configuration')
  )
  .addOption(
    new Option('-f, --log-format <logFormat>', 'log format')
      .choices(['pretty', 'json'])
      .env('M2M_LOG_FORMAT')
      .default('pretty')
      .helpGroup('Configuration')
  )
  .addOption(
    new Option('-H, --mqtt-host <mqttHost>', 'hostname of the MQTT broker')
      .env('M2M_MQTT_HOST')
      .makeOptionMandatory()
      .helpGroup('MQTT')
  )
  .addOption(
    new Option('-P, --mqtt-port <mqttPort>', 'port of the MQTT broker')
      .env('M2M_MQTT_PORT')
      .argParser(parseRequiredInt)
      .default(1883)
      .helpGroup('MQTT')
  )
  .addOption(
    new Option('-U, --mqtt-username <mqttUsername>', 'username of the MQTT broker')
      .env('M2M_MQTT_USERNAME')
      .helpGroup('MQTT')
  )
  .addOption(
    new Option('-B, --mqtt-password <mqttPassword>', 'password of the MQTT broker')
      .env('M2M_MQTT_PASSWORD')
      .helpGroup('MQTT')
  )
  .addOption(
    new Option('-u, --mysa-username <mysaUsername>', 'Mysa account username')
      .env('M2M_MYSA_USERNAME')
      .makeOptionMandatory()
      .helpGroup('Mysa')
  )
  .addOption(
    new Option('-p, --mysa-password <mysaPassword>', 'Mysa account password')
      .env('M2M_MYSA_PASSWORD')
      .makeOptionMandatory()
      .helpGroup('Mysa')
  )
  .addOption(
    new Option('-s, --mysa-session-file <mysaSessionFile>', 'Mysa session file')
      .env('M2M_MYSA_SESSION_FILE')
      .default('session.json')
      .helpGroup('Configuration')
  )
  .addOption(
    new Option('-N, --mqtt-client-name <mqttClientName>', 'name of the MQTT client')
      .env('M2M_MQTT_CLIENT_NAME')
      .default('mysa2mqtt')
      .helpGroup('MQTT')
  )
  .addOption(
    new Option('-T, --mqtt-topic-prefix <mqttTopicPrefix>', 'prefix of the MQTT topic')
      .env('M2M_MQTT_TOPIC_PREFIX')
      .default('mysa2mqtt')
      .helpGroup('MQTT')
  )
  .parse()
  .opts();