@mytmpvpn/mytmpvpn-cli 1.5.0 → 1.7.0

package/dist/#mytmpvpn.js#

@@ -0,0 +1,335 @@
+
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Use NODE_NO_WARNINGS=1 to get rid of the fetch node deprecated API
+//  https://github.com/netlify/cli/issues/4608 -- but it hangs the process: https://github.com/nodejs/node/issues/21960
+const fs = require("fs");
+const path = require("path");
+const commander_1 = require("commander");
+const log = require("loglevel");
+log.setDefaultLevel("info");
+const vpnlib = require("@mytmpvpn/mytmpvpn-common/models/vpn");
+const peanuts = require("@mytmpvpn/mytmpvpn-common/models/peanuts");
+const appconfig_1 = require("@mytmpvpn/mytmpvpn-client/appconfig");
+const userconfig_1 = require("@mytmpvpn/mytmpvpn-client/userconfig");
+const auth = require("@mytmpvpn/mytmpvpn-client/auth");
+const client_1 = require("@mytmpvpn/mytmpvpn-client/client");
+const program = new commander_1.Command();
+function handleError(error, verbose = false) {
+    if (error.response) {
+        // The request was made and the server responded with a status code
+        // that falls out of the range of 2xx
+        try {
+            log.error(`[${error.response.status}] - ${JSON.stringify(error.response.data)}`);
+        }
+        catch (Error) {
+            log.error(`[${error.response.status}] - ${JSON.stringify(error.message)}`);
+        }
+        log.debug(error.response.headers);
+    }
+    else if (error.request) {
+        // The request was made but no response was received
+        // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
+        // http.ClientRequest in node.js
+        log.error(`No reponse received. Check your profile and your appConfig`);
+    }
+    else {
+        // Something happened in setting up the request that triggered an Error
+        log.error(`Error while setting up the request ${JSON.stringify(error)}`);
+    }
+    log.trace(`Stack trace: ${error}`);
+}
+program
+    .name('mytmpvpn-cli')
+    .description('MyTmpVpn CLI')
+    .version('0.0.1')
+    .option('--verbose', 'Produce more logs')
+    .option('--appConfig <file>', 'Path to the application config file', (0, appconfig_1.getDefaultAppConfigFile)())
+    .option('--userConfig <file>', 'Path to the user config file', (0, userconfig_1.getDefaultUserConfigFile)())
+    .option('--profile <name>', 'Name of the profile in the user config file to use', (0, userconfig_1.getDefaultUserProfile)());
+program.on('option:verbose', function () {
+    log.setDefaultLevel("trace");
+});
+program.command('list-peanuts-packs')
+    .description(`Returns the list of peanuts packs you can purchase. A peanuts pack contains a given number of peanuts. You need a minimum of ${peanuts.PEANUTS_CONFIG.min} peanuts to create a vpn`)
+    .action((_, command) => {
+    const options = command.optsWithGlobals();
+    const appConfig = (0, appconfig_1.loadAppConfig)(options.appConfig);
+    // We don't need authenticated user to call this API
+    const client = new client_1.MyTmpVpnClient(appConfig.apiUrl);
+    client.listPeanutsPacks()
+        .then(((packs) => {
+        log.info(JSON.stringify(packs, null, 2));
+    }))
+        .catch((err) => handleError(err));
+});
+program.command('get-peanuts-balance')
+    .description('Get the current peanuts balance')
+    .action((_, command) => {
+    const options = command.optsWithGlobals();
+    log.debug(`Get peanuts balance`);
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err, options.verbose);
+            return;
+        }
+        client.getPeanutsBalance().then(balance => {
+            log.info(balance);
+        }).catch(err => {
+            handleError(err);
+        });
+    });
+});
+program.command('list-regions')
+    .description('Returns the list of all regions where vpn can be created')
+    .action((_, command) => {
+    const options = command.optsWithGlobals();
+    const appConfig = (0, appconfig_1.loadAppConfig)(options.appConfig);
+    // We don't need authenticated user to call this API
+    const client = new client_1.MyTmpVpnClient(appConfig.apiUrl);
+    client.listRegions()
+        .then(((regions) => {
+        log.info(JSON.stringify(regions, null, 2));
+    }))
+        .catch((err) => handleError(err));
+});
+program.command('create')
+    .description('Create a new vpn')
+    .argument('<region>', 'region where the vpn should be created, as returned by list-regions')
+    .option('--sync', 'wait for vpn creation completion')
+    .addOption(new commander_1.Option('--type <type>', 'Type of VPN')
+    .choices(vpnlib.getVpnConfigTypes())
+    .default(vpnlib.VpnType.WireGuard))
+    .option('--peanuts <nb>', 'Max number of peanuts to use (specify -1 for maximum)', '-1')
+    .action((region, _, command) => {
+    const options = command.optsWithGlobals();
+    const syncStr = options.sync ? "synchronously" : "asynchronously";
+    log.debug(`Creating new ${options.type} vpn into ${region} ${syncStr}`);
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err, options.verbose);
+            return;
+        }
+        client.createVpn(region, { type: options.type, maxPeanuts: options.peanuts }).then(vpn => {
+            if (!options.sync) {
+                log.info(vpn);
+                return;
+            }
+            client.waitUntilVpnStateIs(vpn.vpnId, vpnlib.VpnState.Running).then(updatedVpn => {
+                log.info(updatedVpn);
+            }).catch(err => {
+                handleError(err);
+            });
+        }).catch(err => {
+            handleError(err);
+        });
+    });
+});
+program.command('delete')
+    .description('Delete a vpn')
+    .argument('<vpnId>', 'vpnId to delete')
+    .option('--sync', 'wait for vpn deletion completion')
+    .action((vpnId, _, command) => {
+    const options = command.optsWithGlobals();
+    const syncStr = options.sync ? "synchronously" : "asynchronously";
+    log.debug(`Deleting vpn ${vpnId} ${syncStr}`);
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err.message || JSON.stringify(err));
+            return;
+        }
+        client.deleteVpn(vpnId).then(vpn => {
+            if (!options.sync) {
+                log.info(JSON.stringify(vpn));
+                return;
+            }
+            client.waitUntilVpnStateIs(vpnId, vpnlib.VpnState.Deleted).then(updatedVpn => {
+                log.info(updatedVpn);
+                return;
+            }).catch(err => {
+                handleError(err.response?.data || JSON.stringify(err));
+            });
+        }).catch(err => {
+            handleError(err.response?.data || JSON.stringify(err));
+        });
+    });
+});
+program.command('get')
+    .description('Get information on a vpn')
+    .argument('<vpnId>', 'vpnId to get information from')
+    .action((vpnId, _, command) => {
+    const options = command.optsWithGlobals();
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        client.getVpn(vpnId)
+            .then(result => log.info(result))
+            .catch(err => handleError(err));
+    });
+});
+program.command('download-config')
+    .description('Download configuration of the given vpn to the given file')
+    .argument('<vpnId>', 'vpnId to get config file from')
+    .option('--file <file>', 'file where the config should be downloaded to. Default is <vpnId>.tar.gz')
+    .option('--path <path>', 'path where the config file should be written to', (0, userconfig_1.getDefaultUserConfigDir)())
+    .action((vpnId, _, command) => {
+    const options = command.optsWithGlobals();
+    const file = options.file ? options.file : `${vpnId}.tar.gz`;
+    const fullpath = path.join(options.path, file);
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        client.writeVpnConfigTo(vpnId, fs.createWriteStream(fullpath))
+            .then(() => log.info(fullpath))
+            .catch(err => handleError(err));
+    });
+});
+program.command('list')
+    .description('List all vpns')
+    .option('--region <region>', 'region to list vpns from')
+    .option('--exclude-state <state>', 'state to exclude from the list', 'DELETED')
+    .action((_, command) => {
+    const options = command.optsWithGlobals();
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        client.listVpns(options.state)
+            .then(vpns => {
+            log.info(JSON.stringify(vpns, null, 2));
+        })
+            .catch(err => handleError(err));
+    });
+});
+program.command('wait')
+    .description('Wait for vpn operation completion')
+    .argument('<vpnId>', 'the vpnId to wait a status change for')
+    .argument('<state>', 'the state to wait for')
+    .action((vpnId, state, _, command) => {
+    const options = command.optsWithGlobals();
+    const actualState = vpnlib.VpnState[state];
+    if (!actualState) {
+        handleError(`Unknown state: ${state}. Valid states: ${Object.values(vpnlib.VpnState)}`);
+        return;
+    }
+    log.debug(`Waiting for ${vpnId} state to be (at least) ${state}`);
+    auth.getLoggedInClientFromFiles({ appConfigFile: options.appConfig, userConfigFile: options.userConfig, profileName: options.profile }, (err, client) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        client.waitUntilVpnStateIs(vpnId, actualState)
+            .then(vpn => {
+            log.info(vpn);
+        })
+            .catch(err => handleError(err));
+    });
+});
+program.command('register')
+    .description('Register a new user to the MyTmpVpn application')
+    .argument('<username>', 'the email/phone that will identify your account')
+    .argument('<password>', 'a password')
+    .action((username, password, _, command) => {
+    const options = command.optsWithGlobals();
+    var userConfig;
+    if (fs.existsSync(options.userConfig)) {
+        userConfig = (0, userconfig_1.loadUserConfig)(options.userConfig);
+        if (userConfig.profiles[options.profile]) {
+            handleError(`Profile ${options.profile}  already exists in ${options.userConfig}, specify another profile name using --profile`);
+            return;
+        }
+        userConfig.profiles[options.profile] = {
+            username: username,
+            password: password
+        };
+    }
+    else {
+        userConfig = {
+            version: 1,
+            profiles: {
+                default: {
+                    username: username,
+                    password: password
+                }
+            }
+        };
+    }
+    auth.registerUserFromFiles(options.appConfig, username, password, (err, result) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        log.info(`Please confirm your identity with the code sent to ${username}`);
+        fs.mkdir(path.dirname(options.userConfig), { recursive: true }, (err, path) => {
+            if (err) {
+                handleError(err);
+                return;
+            }
+            log.debug(`Directory: ${path} created`);
+            fs.writeFile(options.userConfig, JSON.stringify(userConfig, null, 2), (err) => {
+                if (err) {
+                    handleError(err);
+                    return;
+                }
+            });
+            log.info(`A new profile has been created for ${options.profile} in ${options.userConfig}`);
+        });
+    });
+});
+program.command('confirm-registration')
+    .description('Confirm registration to the MyTmpVpn application using the code that was sent to email/phone')
+    .argument('<username>', 'the email/phone that identify your account')
+    .argument('<code>', 'the code received')
+    .action((username, code, _, command) => {
+    const options = command.optsWithGlobals();
+    auth.confirmUserFromFiles(options.appConfig, username, code, (err, result) => {
+        if (err) {
+            handleError(err);
+            return;
+        }
+        log.debug(result);
+        log.info(`User ${username} confirmed!`);
+    });
+});
+program.addHelpText('after', `
+
+Examples:
+
+  # Before doing anything, you need to register to the MyTmpVpn service:
+
+  $ mytmpvpn register 'your@email.com' 'StrongPassword'  # Min: 8 characters with digit, lower, upper and symbols
+  $ mytmpvpn confirm-registration 'your@email.com' 'code'  # The code you've received by email
+
+  # You then need to buy some peanuts, the list of peanuts packs can be fetched using:
+
+  $ mytmpvpn list-peanuts-packs
+
+  # Visit one of those URLs returned, and complete the purchase.
+  # There is no CLI for purchasing peanuts-packs.
+  # Once you have purchased some peanuts, your peanuts balance should show it:
+
+  $ mytmpvpn get-peanuts-balance
+
+  # Then you can use the following command at will:
+  
+  # List available regions:
+  $ mytmpvpn list-regions                 
+
+  # Create a new vpn in Paris:
+  $ mytmpvpn create 'paris' --sync         # This takes several minutes, please be patient or remove --sync
+
+  # List all my vpns:
+  $ mytmpvpn list
+
+  # Fetch the configuration of a given vpn
+  $ mytmpvpn download-config 'vpn-id'      # The vpn-id is provided by the list command
+
+  # Delete a given vpn 
+  $ mytmpvpn delete 'vpn-id'   # The vpn-id is provided by the list command
+`);
+program.parse();

package/dist/mytmpvpn.js

@@ -93,19 +93,6 @@ program.command('list-regions')
     }))
         .catch((err) => handleError(err));
 });
-program.command('list-regions-detailed')
-    .description('Returns the detailed list of all regions where vpn can be created')
-    .action((_, command) => {
-    const options = command.optsWithGlobals();
-    const appConfig = (0, appconfig_1.loadAppConfig)(options.appConfig);
-    // We don't need authenticated user to call this API
-    const client = new client_1.MyTmpVpnClient(appConfig.apiUrl);
-    client.listRegionsDetailed()
-        .then(((regions) => {
-        log.info(JSON.stringify(regions, null, 2));
-    }))
-        .catch((err) => handleError(err));
-});
 program.command('create')
     .description('Create a new vpn')
     .argument('<region>', 'region where the vpn should be created, as returned by list-regions')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-cli",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "MyTmpVpn CLI",
   "main": "./dist/mytmpvpn.js",
   "bin": {
@@ -27,8 +27,8 @@
   "dependencies": {
     "commander": "^9.4.1",
     "loglevel": "^1.8.1",
-    "@mytmpvpn/mytmpvpn-client": "^1.6.2",
-    "@mytmpvpn/mytmpvpn-common": "^1.4.0"
+    "@mytmpvpn/mytmpvpn-client": "^2.2.0",
+    "@mytmpvpn/mytmpvpn-common": "^2.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.2",