dbdocs 0.13.1 → 0.14.0

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.13.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"}]},"db2dbml":{"id":"db2dbml","description":"Generate DBML directly from a database","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"examples":"Postgres:\n  $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'\nMySQL:\n  $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'\nMSSQL:\n  $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'\nSnowflake:\n  $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\nBigQuery:\n  $ db2dbml bigquery /path_to_json_credential.json\n \n  Note: Your JSON credential file must contain:\n  {\n    \"project_id\": \"your-project-id\",\n    \"client_email\": \"your-client-email\",\n    \"private_key\": \"your-private-key\",\n    \"datasets\": [\"dataset_1\", \"dataset_2\", ...]\n  }\n  If \"datasets\" key is not provided or is empty, it will fetch all datasets.","flags":{"outFile":{"name":"outFile","type":"option","char":"o","description":"output file path","helpValue":"/path-to-your-file","multiple":false}},"args":[{"name":"database-type","description":"your database type (postgres, mysql, mssql, snowflake, bigquery)","required":true},{"name":"connection-string","description":"your database connection string (See below examples for more details)","required":true}]},"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":[]},"set":{"id":"set","description":"Set the Web URL and API URL of dbdocs self-hosted server","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"examples":"$ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev","flags":{"webUrl":{"name":"webUrl","type":"option","description":"Self-hosted web url","required":true,"multiple":false},"apiUrl":{"name":"apiUrl","type":"option","description":"Self-hosted api url","required":true,"multiple":false}},"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.14.0","commands":{"build":{"id":"build","description":"build docs","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"flags":{"project":{"name":"project","type":"option","description":"<username>/<project_name> or <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"}]},"db2dbml":{"id":"db2dbml","description":"Generate DBML directly from a database","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"examples":"Postgres:\n  $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'\nMySQL:\n  $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'\nMSSQL:\n  $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'\nSnowflake:\n  $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'\nBigQuery:\n  $ db2dbml bigquery /path_to_json_credential.json\n \n  Note: Your JSON credential file must contain:\n  {\n    \"project_id\": \"your-project-id\",\n    \"client_email\": \"your-client-email\",\n    \"private_key\": \"your-private-key\",\n    \"datasets\": [\"dataset_1\", \"dataset_2\", ...]\n  }\n  If \"datasets\" key is not provided or is empty, it will fetch all datasets.","flags":{"outFile":{"name":"outFile","type":"option","char":"o","description":"output file path","helpValue":"/path-to-your-file","multiple":false}},"args":[{"name":"database-type","description":"your database type (postgres, mysql, mssql, snowflake, bigquery)","required":true},{"name":"connection-string","description":"your database connection string (See below examples for more details)","required":true}]},"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":[]},"set":{"id":"set","description":"Set the Web URL and API URL of dbdocs self-hosted server","strict":true,"pluginName":"dbdocs","pluginAlias":"dbdocs","pluginType":"core","aliases":[],"examples":"$ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev","flags":{"webUrl":{"name":"webUrl","type":"option","description":"Self-hosted web url","required":true,"multiple":false},"apiUrl":{"name":"apiUrl","type":"option","description":"Self-hosted api url","required":true,"multiple":false}},"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.13.1",
+  "version": "0.14.0",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"

package/src/commands/build.js

@@ -14,7 +14,7 @@ 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 { getProjectUrl } = require('../utils/helper');
+const { getProjectUrl, parseProjectName } = require('../utils/helper');
 const { getIsPublicValueFromBuildFlag } = require('../utils/helper');
 const { formatParserV2ErrorMessage } = require('../utils/error-formatter');
 
@@ -26,6 +26,16 @@ async function build (project, authConfig) {
   return { newProject: res.data.project, isCreated: res.status === 201 };
 }
 
+async function enterOrgName (defaultOrgName) {
+  const answer = await inquirer.prompt([
+    {
+      message: `Username: (${defaultOrgName})`,
+      name: 'orgName',
+    },
+  ]);
+  return answer.orgName || defaultOrgName;
+}
+
 async function enterProjectName () {
   const answer = await inquirer.prompt([
     {
@@ -43,15 +53,26 @@ class BuildCommand extends Command {
     try {
       const authConfig = await verifyToken();
       const { flags, args } = await this.parse(BuildCommand);
-      const { public: publicFlag, private: privateFlag, password } = flags;
-      let { project } = flags;
+      const {
+        public: publicFlag, private: privateFlag, password, project,
+      } = flags;
 
       const { filepath } = args;
       let content = '';
       content = fs.readFileSync(path.resolve(process.cwd(), filepath), 'utf-8');
 
-      const userOrg = await getOrg(authConfig);
-      const org = userOrg.name;
+      const defaultOrgName = (await getOrg(authConfig)).name;
+      let orgName = '';
+      let projectNameFromDbml = null;
+      let projectNameFromInput = null;
+
+      // Re-parse the project name from argument to get the username
+      if (project) {
+        const parseRes = parseProjectName(project);
+
+        if (!parseRes) spinner.warn('Invalid username or project name!');
+        else [orgName, projectNameFromInput] = parseRes;
+      }
 
       // validate dbml syntax, get project name if it's already defined in the file
       spinner.text = 'Parsing file content';
@@ -60,7 +81,7 @@ class BuildCommand extends Command {
       try {
         model = await parse(content);
         if (!project) {
-          project = model.name;
+          projectNameFromDbml = model.name;
         }
         spinner.succeed('Parsing file content');
       } catch (error) {
@@ -69,34 +90,47 @@ class BuildCommand extends Command {
         throw new Error(message);
       }
 
+      if (!orgName) orgName = defaultOrgName;
+
+      let projectName = projectNameFromInput || projectNameFromDbml;
+
       // if project name is not defined yet, ask user to input the project name
-      if (!project) {
-        project = await enterProjectName();
+      if (!projectName) {
+        // ask the username to publish to
+        orgName = await enterOrgName(defaultOrgName);
+        while (!isValidName(orgName)) {
+          // eslint-disable-next-line max-len
+          spinner.warn('Invalid username! Username can only contain alphabets, numbers, space, "-" or "_", or leave it blank to publish to your personal account!');
+          // eslint-disable-next-line no-await-in-loop
+          orgName = await enterOrgName(defaultOrgName);
+        }
+        projectName = await enterProjectName();
       }
 
-      while (!isValidName(project)) {
-        spinner.warn('Invalid project name! Project name can only contain only alphabets, numbers, space, "-" or "_" and can not be blanked!');
+      while (!isValidName(projectName)) {
+        spinner.warn('Invalid project name! Project name can only contain alphabets, numbers, space, "-" or "_" and can not be blanked!');
         // eslint-disable-next-line no-await-in-loop
-        project = await enterProjectName();
+        projectName = await enterProjectName();
       }
 
       // pushing project
-      spinner.text = `Pushing new database to project ${project}`;
+      spinner.text = `Pushing new database to project ${projectName}`;
       spinner.start();
       try {
         const isPublic = getIsPublicValueFromBuildFlag(publicFlag, privateFlag, password);
         const { newProject } = await build({
-          projectName: project,
+          projectName,
           description: removeMd(model.description),
           isPublic,
           password,
-          orgName: org,
+          orgName,
           doc: {
             content,
           },
           shallowSchema: model.schemas,
           normalizedDatabase: model.normalizedDatabase,
           dbmlVersion: VERSION,
+          clientType: 'cli',
         }, authConfig);
         switch (newProject.generalAccessType) {
           case PROJECT_GENERAL_ACCESS_TYPE.public:
@@ -165,7 +199,7 @@ BuildCommand.description = 'build docs';
 // 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' }),
+  project: Flags.string({ description: '<username>/<project_name> or <project_name>' }),
   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({

package/src/commands/ls.js

@@ -2,48 +2,114 @@ const { Command, CliUx } = require('@oclif/core');
 const chalk = require('chalk');
 const { vars } = require('../vars');
 const verifyToken = require('../utils/verifyToken');
-const { getProjectsByOrg } = require('../utils/org');
+const { getProjectsByOrg, getProjectUserRolesByOrg } = require('../utils/org');
 const { getOrg } = require('../utils/org');
 const { PROJECT_SHARING_TEXT } = require('../utils/constants');
 const { getProjectUrl } = require('../utils/helper');
 
+const ROLE_DESCRIPTIONS = {
+  viewer: 'View only',
+  editor: 'View and edit',
+  admin: 'Administrator',
+  noAccess: 'No access',
+};
+
 class LsCommand extends Command {
+  showProjects (projects, orgName) {
+    const [maxUrlWidth, maxUpdatedAtWidth] = projects.reduce((accumulator, project) => {
+      const url = getProjectUrl(vars.hostUrl, orgName, project.urlName);
+      const updatedAt = (new Date(project.updatedAt)).toLocaleString();
+      return [
+        accumulator[0] > url.length ? accumulator[0] : url.length,
+        accumulator[1] > updatedAt.length ? accumulator[1] : updatedAt.length,
+      ];
+    }, [3, 12]);
+
+    this.log(chalk.bold(orgName));
+
+    CliUx.ux.table(projects, {
+      name: {
+        minWidth: 20,
+      },
+      generalAccess: {
+        header: 'Access Control',
+        minWidth: 20,
+        get: (project) => PROJECT_SHARING_TEXT[project.generalAccessType],
+      },
+      url: {
+        minWidth: maxUrlWidth + 2,
+        get: (project) => chalk.cyan(getProjectUrl(vars.hostUrl, orgName, project.urlName)),
+      },
+      updatedAt: {
+        minWidth: maxUpdatedAtWidth + 2,
+        header: 'Last updated',
+        get: (project) => (new Date(project.updatedAt)).toLocaleString(),
+      },
+    }, {
+      printLine: this.log.bind(this),
+    });
+
+    if (!projects.length) CliUx.ux.log('', '(empty)');
+  }
+
+  showSharedProjects (sharedProjectsData) {
+    const [maxOrgWidth, maxUrlWidth, maxUpdatedAtWidth, projects] = sharedProjectsData.reduce((accumulator, sharedData) => {
+      const { Project: project, Role: role } = sharedData;
+
+      const url = getProjectUrl(vars.hostUrl, project.Org.name, project.urlName);
+      const updatedAt = (new Date(project.updatedAt)).toLocaleString();
+
+      accumulator[3].push({ ...project, org: project.Org.name, role });
+      return [
+        accumulator[0] > project.Org.name.length ? accumulator[0] : project.Org.name.length,
+        accumulator[1] > url.length ? accumulator[1] : url.length,
+        accumulator[2] > updatedAt.length ? accumulator[2] : updatedAt.length,
+        accumulator[3],
+      ];
+    }, [3, 3, 12, []]);
+
+    this.log(chalk.bold('Shared with me'));
+
+    CliUx.ux.table(projects, {
+      name: {
+        minWidth: 20,
+      },
+      org: {
+        header: 'Owner',
+        minWidth: maxOrgWidth + 2,
+      },
+      permission: {
+        minWidth: 15,
+        get: (project) => ROLE_DESCRIPTIONS[project.role.name],
+      },
+      url: {
+        minWidth: maxUrlWidth + 2,
+        get: (project) => chalk.cyan(getProjectUrl(vars.hostUrl, project.org, project.urlName)),
+      },
+      updatedAt: {
+        minWidth: maxUpdatedAtWidth + 2,
+        header: 'Last updated',
+        get: (project) => (new Date(project.updatedAt)).toLocaleString(),
+      },
+    }, {
+      printLine: this.log.bind(this),
+    });
+
+    if (!projects.length) CliUx.ux.log('', '(empty)');
+  }
+
   async run () {
     try {
       const authConfig = await verifyToken();
       const org = await getOrg(authConfig);
-      const projects = await getProjectsByOrg(org.name, authConfig);
-      this.log(chalk.bold(org.name));
-
-      const [maxUrlWidth, maxUpdatedAtWidth] = projects.reduce((accumulator, project) => {
-        const url = getProjectUrl(vars.hostUrl, org.name, project.urlName);
-        const updatedAt = (new Date(project.updatedAt)).toLocaleString();
-        return [
-          accumulator[0] > url.length ? accumulator[0] : url.length,
-          accumulator[1] > updatedAt.length ? accumulator[1] : updatedAt.length,
-        ];
-      }, [3, 12]);
-
-      CliUx.ux.table(projects, {
-        name: {
-          minWidth: 20,
-        },
-        sharing: {
-          minWidth: 23,
-          get: (project) => PROJECT_SHARING_TEXT[project.generalAccessType],
-        },
-        url: {
-          minWidth: maxUrlWidth + 2,
-          get: (project) => chalk.cyan(getProjectUrl(vars.hostUrl, org.name, project.urlName)),
-        },
-        updatedAt: {
-          minWidth: maxUpdatedAtWidth + 2,
-          header: 'Last updated',
-          get: (project) => (new Date(project.updatedAt)).toLocaleString(),
-        },
-      }, {
-        printLine: this.log.bind(this),
-      });
+      const [projects, sharedProjectsData] = await Promise.all([
+        getProjectsByOrg(org.name, authConfig),
+        getProjectUserRolesByOrg(org.name, authConfig),
+      ]);
+
+      this.showProjects(projects, org.name);
+      this.log('\n');
+      this.showSharedProjects(sharedProjectsData);
     } catch (err) {
       this.error(err);
     }

package/src/utils/constants.js

@@ -5,9 +5,9 @@ const PROJECT_GENERAL_ACCESS_TYPE = {
 };
 
 const PROJECT_SHARING_TEXT = {
-  public: 'Shared URL',
-  protected: 'Shared URL & password',
-  restricted: 'Only invited',
+  public: 'Public',
+  protected: 'Password-protected',
+  restricted: 'Private',
 };
 
 const FLAG_HELP_GROUP = {

package/src/utils/helper.js

@@ -1,11 +1,22 @@
+const { isValidName } = require('../validators/projectName');
+
 const getIsPublicValueFromBuildFlag = (publicFlag, privateFlag, passwordFlag) => {
   if (publicFlag || passwordFlag) return true;
   if (privateFlag) return false;
   return undefined; // 'undefined' means keep the old `isPublic` state
 };
+
+const parseProjectName = (projectName) => {
+  if (!isValidName(projectName, true)) return null;
+  const middleIdx = projectName.indexOf('/');
+  if (middleIdx === -1) return ['', projectName];
+  return [projectName.slice(0, middleIdx), projectName.slice(middleIdx + 1)];
+};
+
 const getProjectUrl = (hostUrl, orgName, projectUrl) => `${hostUrl}/${encodeURIComponent(orgName)}/${projectUrl}`;
 
 module.exports = {
   getIsPublicValueFromBuildFlag,
   getProjectUrl,
+  parseProjectName,
 };

package/src/utils/org.js

@@ -9,8 +9,13 @@ async function getProjectsByOrg (orgName, authConfig) {
   const { data: { org: { projects } } } = await axios.get(`${vars.apiUrl}/orgs/${orgName}/projects`, authConfig);
   return projects;
 }
+async function getProjectUserRolesByOrg (orgName, authConfig) {
+  const { data } = await axios.get(`${vars.apiUrl}/orgs/${orgName}/project_user_roles`, authConfig);
+  return data;
+}
 
 module.exports = {
   getOrg,
   getProjectsByOrg,
+  getProjectUserRolesByOrg,
 };

package/src/validators/projectName.js

@@ -1,6 +1,9 @@
-const pattern = /^([A-Za-z0-9_\-@.\s]+)$/;
-const isValidName = (name) => pattern.test(name);
+const isValidName = (name, allowOrgPattern = false) => {
+  const pattern = '([A-Za-z0-9_\\-@.\\s]+)';
+  const testPattern = allowOrgPattern ? `^(${pattern}/)?${pattern}$` : `^${pattern}$`;
+  return (new RegExp(testPattern)).test(name);
+};
 
 module.exports = {
-  isValidName
-}
+  isValidName,
+};