dbdocs 0.8.0 → 0.8.2

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.8.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},"restricted":{"name":"restricted","type":"boolean","char":"r","description":"restrict access to project","allowNo":false},"password":{"name":"password","type":"option","char":"p","description":"password for project","multiple":false,"exclusive":["restricted"]}},"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.2","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.8.0",
+  "version": "0.8.2",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -9,7 +9,7 @@
     "oclif/**/ansi-regex": "^3.0.1"
   },
   "dependencies": {
-    "@dbml/core": "^2.5.3",
+    "@dbml/core": "^2.6.0",
     "@oclif/core": "1.12.1",
     "@oclif/plugin-help": "5.1.12",
     "axios": "0.27.2",

package/src/commands/build.js

@@ -11,7 +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 } = require('../utils/constants');
+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);
@@ -38,7 +39,7 @@ class BuildCommand extends Command {
     try {
       const authConfig = await verifyToken();
       const { flags, args } = await this.parse(BuildCommand);
-      const { restricted, password } = flags;
+      const { public: publicFlag, private: privateFlag, password } = flags;
       let { project } = flags;
 
       const { filepath } = args;
@@ -79,10 +80,10 @@ class BuildCommand extends Command {
       spinner.text = `Pushing new database to project ${project}`;
       spinner.start();
       try {
+        const isPublic = getIsPublicValueFromBuildFlag(publicFlag, privateFlag, password);
         const { newProject } = await build({
           projectName: project,
-          // 'undefined' means not update isPublic value
-          isPublic: restricted ? false : undefined,
+          isPublic,
           password,
           orgName: org,
           doc: {
@@ -98,7 +99,7 @@ class BuildCommand extends Command {
             spinner.succeed(`Project '${newProject.name}' is protected with password`);
             break;
           case PROJECT_GENERAL_ACCESS_TYPE.restricted:
-            spinner.succeed(`Restricted access to project '${newProject.name}'`);
+            spinner.succeed(`Project '${newProject.name}' is private`);
             break;
           default:
             break;
@@ -146,14 +147,20 @@ class BuildCommand extends Command {
 
 BuildCommand.description = 'build docs';
 
-// Not allow using both --password and --restricted flags at the same time. For example:
+// `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 --restricted # works
-// dbdocs build ./abc.dbml --project abc --password 123456 --restricted # error
+// 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' }),
-  restricted: Flags.boolean({ char: 'r', description: 'restrict access to project' }),
-  password: Flags.string({ char: 'p', description: 'password for project', exclusive: ['restricted'] }),
+  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/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/utils/constants.js

@@ -10,7 +10,12 @@ const PROJECT_SHARING_TEXT = {
   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,
+};