dbdocs 0.6.3 → 0.7.0

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/bin/run

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-require('@oclif/command').run()
-.then(require('@oclif/command/flush'))
-.catch(require('@oclif/errors/handle'))
+require('@oclif/core').run()
+.then(require('@oclif/core/flush'))
+.catch(require('@oclif/core/handle'))

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.7.0","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"project name","multiple":false},"password":{"name":"password","type":"option","char":"p","description":"password for project","multiple":false}},"args":[{"name":"filepath","description":"dbml file path"}]},"login":{"id":"login","description":"login to dbdocs\nlogin with your dbdocs credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"logout":{"id":"logout","description":"logout\nclears local login credentials\n","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"ls":{"id":"ls","description":"list projects","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"password":{"id":"password","description":"set password for your project or remove password","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","char":"p","description":"project name","helpValue":"project name","multiple":false},"set":{"name":"set","type":"option","char":"s","description":"password for your project","helpValue":"password","multiple":false},"remove":{"name":"remove","type":"boolean","char":"r","description":"remove password from your project","allowNo":false}},"args":[]},"remove":{"id":"remove","description":"remove docs","strict":true,"pluginName":"dbdocs","pluginAlias":"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","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[]},"token":{"id":"token","description":"generate or revoke your authentication token","strict":true,"pluginName":"dbdocs","pluginAlias":"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","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"filepath","description":"dbml file path"}]}}}

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "dbdocs",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
   },
   "dependencies": {
     "@dbml/core": "^2.4.2",
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
-    "@oclif/plugin-help": "^2",
-    "axios": "^0.19.0",
+    "@oclif/core": "1.12.1",
+    "@oclif/plugin-help": "5.1.12",
+    "axios": "0.27.2",
     "chalk": "^3.0.0",
-    "cli-ux": "^5.6.3",
     "dotenv": "^8.2.0",
     "inquirer": "^7.0.1",
     "netrc-parser": "^3.1.6",
@@ -21,15 +19,15 @@
     "update-notifier": "^4.1.0"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1",
-    "@oclif/test": "^1",
+    "@oclif/test": "2.1.1",
     "chai": "^4",
     "globby": "^10",
     "mocha": "^5",
-    "nyc": "^14"
+    "nyc": "^14",
+    "oclif": "^3.2.0"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/bin",
@@ -43,6 +41,8 @@
   "license": "MIT",
   "main": "src/index.js",
   "oclif": {
+    "additionalHelpFlags": ["help"],
+    "additionalVersionFlags": ["version"],
     "commands": "./src/commands",
     "bin": "dbdocs",
     "plugins": [
@@ -53,7 +53,7 @@
         "./src/hooks/init/checkUpdate",
         "./src/hooks/init/loadEnv"
       ],
-      "prerun":[
+      "prerun": [
         "./src/hooks/prerun/checkVersion"
       ]
     }
@@ -61,8 +61,8 @@
   "repository": "holistics/dbdocs",
   "scripts": {
     "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif-dev manifest",
+    "prepack": "oclif manifest",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif readme && git add README.md"
   }
 }

package/src/commands/build.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require('@oclif/command');
+const { Command, Flags } = require('@oclif/core');
 const axios = require('axios');
 const inquirer = require('inquirer');
 const fs = require('fs');
@@ -37,8 +37,8 @@ class BuildCommand extends Command {
     try {
       const authConfig = await verifyToken();
 
-      let { flags: { project, password } } = this.parse(BuildCommand);
-      const { args } = this.parse(BuildCommand);
+      let { flags: { project, password } } = await this.parse(BuildCommand);
+      const { args } = await this.parse(BuildCommand);
 
       const { filepath } = args;
       let content = '';
@@ -137,8 +137,8 @@ class BuildCommand extends Command {
 BuildCommand.description = 'build docs';
 
 BuildCommand.flags = {
-  project: flags.string({ description: 'project name' }),
-  password: flags.string({ char: 'p', description: 'password for project' }),
+  project: Flags.string({ description: 'project name' }),
+  password: Flags.string({ char: 'p', description: 'password for project' }),
 };
 
 BuildCommand.args = [

package/src/commands/login.js

@@ -1,4 +1,4 @@
-const { Command } = require('@oclif/command');
+const { Command } = require('@oclif/core');
 const open = require('open');
 const inquirer = require('inquirer');
 const axios = require('axios');

package/src/commands/logout.js

@@ -1,4 +1,4 @@
-const { Command } = require('@oclif/command');
+const { Command } = require('@oclif/core');
 const netrc = require('netrc-parser').default;
 const { vars } = require('../vars');
 

package/src/commands/ls.js

@@ -1,5 +1,4 @@
-const { Command } = require('@oclif/command');
-const { cli } = require('cli-ux');
+const { Command, CliUx } = require('@oclif/core');
 const chalk = require('chalk');
 const { vars } = require('../vars');
 const verifyToken = require('../utils/verifyToken');
@@ -23,7 +22,7 @@ class LsCommand extends Command {
         ];
       }, [3, 12]);
 
-      cli.table(projects, {
+      CliUx.ux.table(projects, {
         name: {
           minWidth: 20,
         },
@@ -43,7 +42,7 @@ class LsCommand extends Command {
           get: (project) => (new Date(project.updatedAt)).toLocaleString(),
         },
       }, {
-        printLine: this.log,
+        printLine: this.log.bind(this),
       });
     } catch (err) {
       this.error(err);

package/src/commands/password.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require('@oclif/command');
+const { Command, Flags } = require('@oclif/core');
 const axios = require('axios');
 const inquirer = require('inquirer');
 const ora = require('ora');
@@ -24,7 +24,7 @@ class PasswordCommand extends Command {
   async run () {
     const spinner = ora({});
     try {
-      let { flags: { project, set, remove } } = this.parse(PasswordCommand);
+      let { flags: { project, set, remove } } = await this.parse(PasswordCommand);
 
       if (set && remove) {
         throw new Error('You must choose one, set password or remove.');
@@ -102,9 +102,9 @@ class PasswordCommand extends Command {
 PasswordCommand.description = 'set password for your project or remove password';
 
 PasswordCommand.flags = {
-  project: flags.string({ char: 'p', description: 'project name', helpValue: 'project name' }),
-  set: flags.string({ char: 's', description: 'password for your project', helpValue: 'password' }),
-  remove: flags.boolean({ char: 'r', description: 'remove password from your project' }),
+  project: Flags.string({ char: 'p', description: 'project name', helpValue: 'project name' }),
+  set: Flags.string({ char: 's', description: 'password for your project', helpValue: 'password' }),
+  remove: Flags.boolean({ char: 'r', description: 'remove password from your project' }),
 };
 
 module.exports = PasswordCommand;

package/src/commands/remove.js

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-const { Command } = require('@oclif/command');
+const { Command } = require('@oclif/core');
 const axios = require('axios');
 const inquirer = require('inquirer');
 const ora = require('ora');
@@ -21,7 +21,7 @@ class RemoveCommand extends Command {
       const authConfig = await verifyToken();
       const org = await getOrg(authConfig);
 
-      const { args } = this.parse(RemoveCommand);
+      const { args } = await this.parse(RemoveCommand);
       let { project_name } = args;
       if (!project_name) {
         const answer = await inquirer.prompt([

package/src/commands/rename.js

@@ -0,0 +1,88 @@
+const { Command } = require('@oclif/core');
+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/commands/token.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require('@oclif/command');
+const { Command, Flags } = require('@oclif/core');
 const ora = require('ora');
 const axios = require('axios');
 const { vars } = require('../vars');
@@ -7,7 +7,7 @@ const verifyToken = require('../utils/verifyToken');
 class TokenCommand extends Command {
   async run () {
     const spinner = ora({});
-    const { flags: { generate, revoke } } = this.parse(TokenCommand);
+    const { flags: { generate, revoke } } = await this.parse(TokenCommand);
     if (!generate && !revoke) {
       this.error('Please specify an action, type "dbdocs token --help" to see processable actitons.');
     }
@@ -56,12 +56,12 @@ class TokenCommand extends Command {
 
 TokenCommand.description = 'generate or revoke your authentication token';
 TokenCommand.flags = {
-  generate: flags.boolean({
+  generate: Flags.boolean({
     char: 'g',
     description: 'generate authentication token',
     default: false,
   }),
-  revoke: flags.boolean({
+  revoke: Flags.boolean({
     char: 'r',
     description: 'revoke authentication token',
     default: false,

package/src/commands/validate.js

@@ -1,4 +1,4 @@
-const { Command, flags } = require('@oclif/command');
+const { Command } = require('@oclif/core');
 const fs = require('fs');
 const path = require('path');
 const ora = require('ora');
@@ -9,7 +9,7 @@ class ValidateCommand extends Command {
     const spinner = ora({});
     let filepath = null;
     try {
-      const { args } = this.parse(ValidateCommand);
+      const { args } = await this.parse(ValidateCommand);
       filepath = args.filepath;
       let content = '';
       content = fs.readFileSync(path.resolve(process.cwd(), filepath), 'utf-8');

package/src/index.js

@@ -1 +1 @@
-module.exports = require('@oclif/command');
+module.exports = require('@oclif/core');

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,
+};