dbdocs 0.7.5 → 0.8.1

package/README.md

@@ -122,7 +122,7 @@ OPTIONS
 
 ## `dbdocs remove [PROJECT_NAME]`
 
-remove docs
+remove project
 
 ```
 USAGE

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.7.5","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"}]}}}
+{"version":"0.8.1","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},"public":{"name":"public","type":"boolean","description":"anyone with the URL can access","helpGroup":"sharing","allowNo":false,"exclusive":["private","password"]},"private":{"name":"private","type":"boolean","description":"only invited people can access","helpGroup":"sharing","allowNo":false,"exclusive":["public","password"]},"password":{"name":"password","type":"option","char":"p","description":"anyone with the URL + password can access","helpGroup":"sharing","multiple":false,"exclusive":["public","private"]}},"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 project","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,6 +1,6 @@
 {
   "name": "dbdocs",
-  "version": "0.7.5",
+  "version": "0.8.1",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -19,7 +19,7 @@
     "netrc-parser": "^3.1.6",
     "open": "^7.0.0",
     "ora": "^4.0.3",
-    "update-notifier": "^4.1.0"
+    "update-notifier": "^6.0.2"
   },
   "devDependencies": {
     "@oclif/test": "2.1.1",
@@ -44,8 +44,12 @@
   "license": "MIT",
   "main": "src/index.js",
   "oclif": {
-    "additionalHelpFlags": ["help"],
-    "additionalVersionFlags": ["version"],
+    "additionalHelpFlags": [
+      "help"
+    ],
+    "additionalVersionFlags": [
+      "version"
+    ],
     "commands": "./src/commands",
     "bin": "dbdocs",
     "plugins": [

package/src/commands/build.js

@@ -11,6 +11,8 @@ const { getOrg } = require('../utils/org');
 const { shouldAskForFeedback } = require('../utils/feedback');
 const { isValidName } = require('../validators/projectName');
 const parse = require('../utils/parse');
+const { PROJECT_GENERAL_ACCESS_TYPE, FLAG_HELP_GROUP } = require('../utils/constants');
+const { getIsPublicValueFromBuildFlag } = require('../utils/helper');
 
 async function build (project, authConfig) {
   const res = await axios.post(`${vars.apiUrl}/projects`, project, authConfig);
@@ -36,9 +38,9 @@ class BuildCommand extends Command {
 
     try {
       const authConfig = await verifyToken();
-
-      let { flags: { project, password } } = await this.parse(BuildCommand);
-      const { args } = await this.parse(BuildCommand);
+      const { flags, args } = await this.parse(BuildCommand);
+      const { public: publicFlag, private: privateFlag, password } = flags;
+      let { project } = flags;
 
       const { filepath } = args;
       let content = '';
@@ -70,6 +72,7 @@ class BuildCommand extends Command {
 
       while (!isValidName(project)) {
         spinner.warn('Invalid project name! Project name can only contain only alphabets, numbers, space, "-" or "_" and can not be blanked!');
+        // eslint-disable-next-line no-await-in-loop
         project = await enterProjectName();
       }
 
@@ -77,8 +80,10 @@ class BuildCommand extends Command {
       spinner.text = `Pushing new database to project ${project}`;
       spinner.start();
       try {
-        const { newProject, isCreated } = await build({
+        const isPublic = getIsPublicValueFromBuildFlag(publicFlag, privateFlag, password);
+        const { newProject } = await build({
           projectName: project,
+          isPublic,
           password,
           orgName: org,
           doc: {
@@ -86,12 +91,18 @@ class BuildCommand extends Command {
           },
           shallowSchema: model.schemas,
         }, authConfig);
-        if (!newProject.isPublic) {
-          if (isCreated || password) {
-            spinner.succeed(`Password is set for '${newProject.name}'`);
-          }
-        } else {
-          spinner.warn(`Password is not set for '${newProject.name}'`);
+        switch (newProject.generalAccessType) {
+          case PROJECT_GENERAL_ACCESS_TYPE.public:
+            spinner.warn(`Project '${newProject.name}' is public, consider setting password or restricting access to it`);
+            break;
+          case PROJECT_GENERAL_ACCESS_TYPE.protected:
+            spinner.succeed(`Project '${newProject.name}' is protected with password`);
+            break;
+          case PROJECT_GENERAL_ACCESS_TYPE.restricted:
+            spinner.succeed(`Project '${newProject.name}' is private`);
+            break;
+          default:
+            break;
         }
         spinner.succeed(`Done. Visit: ${chalk.cyan(`${vars.hostUrl}/${newProject.org.name}/${newProject.urlName}`)}\n`);
         if (shouldAskForFeedback()) {
@@ -136,9 +147,20 @@ class BuildCommand extends Command {
 
 BuildCommand.description = 'build docs';
 
+// `public`, `private` and `password` are mutually exclusive flags. For example:
+// dbdocs build ./abc.dbml --project abc --public # works
+// dbdocs build ./abc.dbml --project abc --private # works
+// dbdocs build ./abc.dbml --project abc --password 123456 # works
+// dbdocs build ./abc.dbml --project abc --password 123456 --private # error
+// dbdocs build ./abc.dbml --project abc --public --private # error
+// dbdocs build ./abc.dbml --project abc --public --password 123456 # error
 BuildCommand.flags = {
   project: Flags.string({ description: 'project name' }),
-  password: Flags.string({ char: 'p', description: 'password for project' }),
+  public: Flags.boolean({ description: 'anyone with the URL can access', helpGroup: FLAG_HELP_GROUP.sharing, exclusive: ['private', 'password'] }),
+  private: Flags.boolean({ description: 'only invited people can access', helpGroup: FLAG_HELP_GROUP.sharing, exclusive: ['public', 'password'] }),
+  password: Flags.string({
+    char: 'p', description: 'anyone with the URL + password can access', helpGroup: FLAG_HELP_GROUP.sharing, exclusive: ['public', 'private'],
+  }),
 };
 
 BuildCommand.args = [

package/src/commands/ls.js

@@ -4,6 +4,7 @@ const { vars } = require('../vars');
 const verifyToken = require('../utils/verifyToken');
 const { getProjectsByOrg } = require('../utils/org');
 const { getOrg } = require('../utils/org');
+const { PROJECT_SHARING_TEXT } = require('../utils/constants');
 
 class LsCommand extends Command {
   async run () {
@@ -26,11 +27,9 @@ class LsCommand extends Command {
         name: {
           minWidth: 20,
         },
-        isPublic: {
-          minWidth: 12,
-          header: 'Password',
-          // eslint-disable-next-line no-confusing-arrow
-          get: (project) => project.isPublic ? 'No' : 'Yes',
+        sharing: {
+          minWidth: 23,
+          get: (project) => PROJECT_SHARING_TEXT[project.generalAccessType],
         },
         url: {
           minWidth: maxUrlWidth + 2,

package/src/commands/remove.js

@@ -67,7 +67,7 @@ class RemoveCommand extends Command {
   }
 }
 
-RemoveCommand.description = 'remove docs';
+RemoveCommand.description = 'remove project';
 
 RemoveCommand.args = [
   { name: 'project_name', description: 'name of the project which you want to remove' },

package/src/hooks/init/checkUpdate.js

@@ -1,6 +1,12 @@
-const updateNotifier = require('update-notifier');
 const pkg = require('../../../package.json');
 
 module.exports = async function () {
-  updateNotifier({ pkg }).notify({ isGlobal: true });
+  // update-notifier v6.x is pure ESM, can not use require() to load it,
+  // see: https://github.com/yeoman/update-notifier/releases/tag/v6.0.0
+  const updateNotifier = (await import('update-notifier')).default;
+  const notifier = updateNotifier({ pkg });
+
+  notifier.notify({ isGlobal: true });
+  // uncomment to check the update information
+  // console.log(await notifier.fetchInfo());
 };

package/src/utils/constants.js

@@ -0,0 +1,21 @@
+const PROJECT_GENERAL_ACCESS_TYPE = {
+  public: 'public',
+  protected: 'protected',
+  restricted: 'restricted',
+};
+
+const PROJECT_SHARING_TEXT = {
+  public: 'Shared URL',
+  protected: 'Shared URL & password',
+  restricted: 'Only invited',
+};
+
+const FLAG_HELP_GROUP = {
+  sharing: 'sharing',
+};
+
+module.exports = {
+  PROJECT_GENERAL_ACCESS_TYPE,
+  PROJECT_SHARING_TEXT,
+  FLAG_HELP_GROUP,
+};

package/src/utils/helper.js

@@ -0,0 +1,9 @@
+const getIsPublicValueFromBuildFlag = (publicFlag, privateFlag, passwordFlag) => {
+  if (publicFlag || passwordFlag) return true;
+  if (privateFlag) return false;
+  return undefined; // 'undefined' means keep the old `isPublic` state
+};
+
+module.exports = {
+  getIsPublicValueFromBuildFlag,
+};