dbdocs 0.6.3 → 0.6.4

package/README.md

@@ -35,6 +35,7 @@ USAGE
 * [`dbdocs ls`](#dbdocs-ls)
 * [`dbdocs password`](#dbdocs-password)
 * [`dbdocs remove [PROJECT_NAME]`](#dbdocs-remove-project_name)
+* [`dbdocs rename`](#dbdocs-rename)
 * [`dbdocs token`](#dbdocs-token)
 * [`dbdocs validate [FILEPATH]`](#dbdocs-validate-filepath)
 
@@ -130,6 +131,19 @@ USAGE
 ARGUMENTS
   PROJECT_NAME  name of the project which you want to remove
 ```
+
+## `dbdocs rename`
+
+change your username
+
+```
+USAGE
+  $ dbdocs rename
+
+DESCRIPTION
+  change your username and your default organization name
+```
+
 ## `dbdocs token`
 
 generate or revoke your authentication token

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.6.3","commands":{"build":{"id":"build","description":"build docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name"},"password":{"name":"password","type":"option","char":"p","description":"password for project"}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name"},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password"},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"token":{"id":"token","description":"generate or revoke your authentication token","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}
+{"version":"0.6.4","commands":{"build":{"id":"build","description":"build docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name"},"password":{"name":"password","type":"option","char":"p","description":"password for project"}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name"},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password"},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove docs","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"project_name","description":"name of the project which you want to remove"}]},"rename":{"id":"rename","description":"change your username","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{"generate":{"name":"generate","type":"boolean","char":"g","description":"generate authentication token","allowNo":false},"revoke":{"name":"revoke","type":"boolean","char":"r","description":"revoke authentication token","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate docs content","pluginName":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dbdocs",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"

package/src/commands/rename.js

@@ -0,0 +1,88 @@
+const { Command } = require('@oclif/command');
+const inquirer = require('inquirer');
+const axios = require('axios');
+const ora = require('ora');
+const { vars } = require('../vars');
+const { isValidUserName } = require('../validators/userName');
+const verifyToken = require('../utils/verifyToken');
+
+async function enterUserName () {
+  const answer = await inquirer.prompt([
+    {
+      message: 'Please input your new username: ',
+      name: 'newUserName',
+    },
+  ]);
+  return answer.newUserName;
+}
+
+async function validateAndUpdateUserName (spinner, authConfig, command) {
+  let newUserName = await enterUserName();
+
+  while (!isValidUserName(newUserName)) {
+    spinner.warn('Invalid username! Username can only contain alphabets, numbers, "-" or "_" and can not be blanked!');
+    newUserName = await enterUserName();
+  }
+
+  try {
+    const { data: { user, hasRevokedToken } } = await axios.put(`${vars.apiUrl}/account/rename`, { newUserName }, authConfig);
+    return { user, hasRevokedToken };
+  } catch (err) {
+    const { error } = err.response.data;
+    const warningNames = ['UserNameNotChange', 'UserNameExisted'];
+    if (warningNames.includes(error.name)) {
+      spinner.warn(error.message);
+    } else {
+      command.error(error.message);
+    }
+    return { user: null, hasRevokedToken: null };
+  }
+}
+
+class RenameCommand extends Command {
+  async run () {
+    const spinner = ora({});
+    try {
+      const authConfig = await verifyToken();
+
+      this.warn('After renaming, your authentication token (if exists) will be revoked. Please re-generate a new one!');
+      this.warn('You may need to re-login your account on the dbdocs web app for the best user experience.');
+
+      let { user, hasRevokedToken } = await validateAndUpdateUserName(spinner, authConfig, this);
+      while (!user) {
+        ({ user, hasRevokedToken } = await validateAndUpdateUserName(spinner, authConfig, this));
+      }
+      if (hasRevokedToken) {
+        spinner.succeed('Rename successfully and your access token has been revoked, please generate a new one!');
+      } else {
+        spinner.succeed('Rename successfully!');
+      }
+    } catch (err) {
+      if (spinner.isSpinning) {
+        spinner.fail();
+      }
+      let message = err.message || 'Something wrong :( Please try again.';
+      if (err.response) {
+        const { error } = err.response.data;
+        switch (error.name) {
+          case 'TokenExpiredError':
+            message = 'Your token has expired. Please login again.';
+            break;
+
+          case 'InvalidAuthToken':
+            message = 'Invalid token. Please login again.';
+            break;
+
+          default:
+            message = error.message;
+            break;
+        }
+      }
+      this.error(message);
+    }
+  }
+}
+
+RenameCommand.description = 'change your username';
+
+module.exports = RenameCommand;

package/src/user_data.json

@@ -1 +1 @@
-{"BUILD_COUNT":2}
+{"BUILD_COUNT":1}

package/src/validators/userName.js

@@ -0,0 +1,6 @@
+const pattern = /^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i;
+const isValidUserName = (userName) => pattern.test(userName);
+
+module.exports = {
+  isValidUserName,
+};