@mytmpvpn/mytmpvpn-cli 1.1.0 → 1.5.0

package/.eslintignore

@@ -0,0 +1,4 @@
+# .estlintignore file
+dist
+build
+node_modules/

package/README.md

@@ -1,9 +1,9 @@
 # mytmpvpn-cli
 
-Command Line Interface for the [`MyTmpVpn`](https://gitlab.com/mytmpvpn) project. 
+Command Line Interface for the [`MyTmpVpn`](https://gitlab.com/mytmpvpn) project.
 
 ## Getting started
-            
+
 ### Pre-requisite && how to build?
 
 1. Install npm: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
@@ -17,36 +17,46 @@ Command Line Interface for the [`MyTmpVpn`](https://gitlab.com/mytmpvpn) project
 1. Go to the `mytmpvpn-cli` project and build everything: `cd mytmpvpn-cli; npm run build-all`
 
 From there you should be able to:
-1. execute the mytmpvpn CLI: `npx mytmpvpn` 
-1. Develop inside each project. 
+
+1. execute the mytmpvpn CLI: `npx mytmpvpn`
+1. Develop inside each project.
 
 ## TODO: write down remaining sections
 
 ## Name
+
 Choose a self-explaining name for your project.
 
 ## Description
+
 Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
 
 ## Badges
+
 On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
 
 ## Visuals
+
 Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
 
 ## Installation
+
 Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
 
 ## Usage
+
 Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
 
 ## Support
+
 Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
 
 ## Roadmap
+
 If you have ideas for releases in the future, it is a good idea to list them in the README.
 
 ## Contributing
+
 State if you are open to contributions and what your requirements are for accepting them.
 
 For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
@@ -54,10 +64,13 @@ For people who want to make changes to your project, it's helpful to have some d
 You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
 
 ## Authors and acknowledgment
+
 Show your appreciation to those who have contributed to the project.
 
 ## License
+
 For open source projects, say how it is licensed.
 
 ## Project status
+
 If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/mytmpvpn.js

@@ -13,7 +13,7 @@ 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 mytmpvpn_client_1 = require("@mytmpvpn/mytmpvpn-client/mytmpvpn-client");
+const client_1 = require("@mytmpvpn/mytmpvpn-client/client");
 const program = new commander_1.Command();
 function handleError(error, verbose = false) {
     if (error.response) {
@@ -56,7 +56,7 @@ program.command('list-peanuts-packs')
     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 mytmpvpn_client_1.MyTmpVpnClient(appConfig.apiUrl);
+    const client = new client_1.MyTmpVpnClient(appConfig.apiUrl);
     client.listPeanutsPacks()
         .then(((packs) => {
         log.info(JSON.stringify(packs, null, 2));
@@ -86,13 +86,26 @@ program.command('list-regions')
     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 mytmpvpn_client_1.MyTmpVpnClient(appConfig.apiUrl);
+    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('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')
@@ -183,7 +196,7 @@ program.command('download-config')
             handleError(err);
             return;
         }
-        client.getVpnConfig(vpnId, fs.createWriteStream(fullpath))
+        client.writeVpnConfigTo(vpnId, fs.createWriteStream(fullpath))
             .then(() => log.info(fullpath))
             .catch(err => handleError(err));
     });
@@ -303,7 +316,7 @@ 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 'code'  # The code you've received by email
+  $ 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:
 
@@ -321,7 +334,7 @@ Examples:
   $ mytmpvpn list-regions                 
 
   # Create a new vpn in Paris:
-  $ mytmpvpn --sync create 'paris'         # This takes several minutes, please be patient or remove --sync
+  $ mytmpvpn create 'paris' --sync         # This takes several minutes, please be patient or remove --sync
 
   # List all my vpns:
   $ mytmpvpn list

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mytmpvpn/mytmpvpn-cli",
-  "version": "1.1.0",
+  "version": "1.5.0",
   "description": "MyTmpVpn CLI",
   "main": "./dist/mytmpvpn.js",
   "bin": {
@@ -23,12 +23,12 @@
     "email": "pierre.vigneras@gmail.com",
     "url": "https://www.linkedin.com/in/pierrevigneras/"
   },
-  "license": "GNU AGPL",
+  "license": "GNU GPL",
   "dependencies": {
     "commander": "^9.4.1",
     "loglevel": "^1.8.1",
-    "@mytmpvpn/mytmpvpn-client": "^1.0.0",
-    "@mytmpvpn/mytmpvpn-common": "^1.1.0"
+    "@mytmpvpn/mytmpvpn-client": "^1.6.2",
+    "@mytmpvpn/mytmpvpn-common": "^1.4.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.2",

package/src/mytmpvpn.ts

@@ -3,7 +3,7 @@
 //  https://github.com/netlify/cli/issues/4608 -- but it hangs the process: https://github.com/nodejs/node/issues/21960
 import * as fs from 'fs'
 import * as path from 'path'
-import { Argument, Command, Option } from 'commander'
+import { Command, Option } from 'commander'
 import * as log from 'loglevel'
 log.setDefaultLevel("info")
 
@@ -12,7 +12,7 @@ import * as peanuts from '@mytmpvpn/mytmpvpn-common/models/peanuts'
 import { getDefaultAppConfigFile, loadAppConfig } from '@mytmpvpn/mytmpvpn-client/appconfig'
 import { getDefaultUserConfigFile, getDefaultUserProfile, getDefaultUserConfigDir, loadUserConfig, UserConfig } from '@mytmpvpn/mytmpvpn-client/userconfig'
 import * as auth from '@mytmpvpn/mytmpvpn-client/auth'
-import { MyTmpVpnClient } from '@mytmpvpn/mytmpvpn-client/mytmpvpn-client'
+import { MyTmpVpnClient } from '@mytmpvpn/mytmpvpn-client/client'
 
 const program = new Command()
 
@@ -83,7 +83,7 @@ program.command('get-peanuts-balance')
     })
   })
 
-  program.command('list-regions')
+program.command('list-regions')
   .description('Returns the list of all regions where vpn can be created')
   .action((_, command) => {
     const options = command.optsWithGlobals()
@@ -97,6 +97,19 @@ program.command('get-peanuts-balance')
       .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 = loadAppConfig(options.appConfig)
+    // We don't need authenticated user to call this API
+    const client = new MyTmpVpnClient(appConfig.apiUrl)
+    client.listRegionsDetailed()
+      .then(((regions: any) => {
+        log.info(JSON.stringify(regions, null, 2))
+      }))
+      .catch((err) => handleError(err))
+  })
 
 program.command('create')
   .description('Create a new vpn')
@@ -192,7 +205,7 @@ program.command('download-config')
         handleError(err)
         return
       }
-      client.getVpnConfig(vpnId, fs.createWriteStream(fullpath))
+      client.writeVpnConfigTo(vpnId, fs.createWriteStream(fullpath))
         .then(() => log.info(fullpath))
         .catch(err => handleError(err))
     })
@@ -316,7 +329,7 @@ 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 'code'  # The code you've received by email
+  $ 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:
 
@@ -334,7 +347,7 @@ Examples:
   $ mytmpvpn list-regions                 
 
   # Create a new vpn in Paris:
-  $ mytmpvpn --sync create 'paris'         # This takes several minutes, please be patient or remove --sync
+  $ mytmpvpn create 'paris' --sync         # This takes several minutes, please be patient or remove --sync
 
   # List all my vpns:
   $ mytmpvpn list