dbdocs 0.12.2 → 0.13.0

package/README.md

@@ -36,6 +36,7 @@ USAGE
 * [`dbdocs password`](#dbdocs-password)
 * [`dbdocs remove [PROJECT_NAME]`](#dbdocs-remove-project_name)
 * [`dbdocs rename`](#dbdocs-rename)
+* [`dbdocs set`](#dbdocs-set)
 * [`dbdocs token`](#dbdocs-token)
 * [`dbdocs validate [FILEPATH]`](#dbdocs-validate-filepath)
 
@@ -184,6 +185,25 @@ DESCRIPTION
   change your username and your default organization name
 ```
 
+## `dbdocs set`
+
+Set the Web URL and API URL of dbdocs self-hosted server
+
+```bash
+USAGE
+  $ dbdocs set --webUrl <value> --apiUrl <value>
+
+FLAGS
+  --apiUrl=<value>  (required) Self-hosted api url
+  --webUrl=<value>  (required) Self-hosted web url
+
+DESCRIPTION
+  Set the Web URL and API URL of dbdocs self-hosted server
+
+EXAMPLES
+  $ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev
+```
+
 ## `dbdocs token`
 
 generate or revoke your authentication token

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.12.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"}]},"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":[]},"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.13.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},"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.12.2",
+  "version": "0.13.0",
   "author": "@holistics",
   "bin": {
     "dbdocs": "./bin/run"
@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@dbml/connector": "3.8.1",
-    "@dbml/core": "3.8.1",
+    "@dbml/core": "3.9.0",
     "@oclif/core": "1.12.1",
     "@oclif/plugin-help": "5.1.12",
     "axios": "^1.7.4",

package/src/commands/build.js

@@ -120,6 +120,7 @@ class BuildCommand extends Command {
         if (err.response) {
           const { error } = err.response.data;
           if (error.name === 'SyntaxError') {
+            // eslint-disable-next-line max-len
             message = `You have syntax error(s) in ${path.basename(filepath)} line ${error.location.start.line} column ${error.location.start.column}. ${error.message}`;
           } else if (error.name === 'AccessDenied') {
             message = error.message;

package/src/commands/set.js

@@ -0,0 +1,80 @@
+const { Command, Flags } = require('@oclif/core');
+const ora = require('ora');
+const netrc = require('netrc-parser').default;
+const { HOST_CONFIG_STATUS } = require('../utils/constants');
+const { tryParseHttpUrl } = require('../validators/url');
+
+class SetCommand extends Command {
+  async run () {
+    const spinner = ora({});
+    try {
+      const { flags } = await this.parse(SetCommand);
+
+      const { webUrl, apiUrl } = flags;
+
+      const parseAPIUrlResult = tryParseHttpUrl(apiUrl);
+      if (!parseAPIUrlResult.isSuccess) {
+        spinner.fail(`API URL parse error: ${parseAPIUrlResult.data}`);
+        return;
+      }
+
+      const parseWebUrlResult = tryParseHttpUrl(webUrl);
+      if (!parseWebUrlResult.isSuccess) {
+        spinner.fail(`Web URL parse error: ${parseWebUrlResult.data}`);
+        return;
+      }
+
+      // load netrc config
+      await netrc.load();
+
+      spinner.text = 'Saving your configurations';
+      spinner.start();
+
+      // make all hosts are inactive
+      Object.keys(netrc.machines).forEach((host) => {
+        if (netrc.machines[host].webUrl) {
+          netrc.machines[host].status = HOST_CONFIG_STATUS.inactive;
+        }
+      });
+
+      const parsedAPIUrl = parseAPIUrlResult.data;
+      const parsedWebUrl = parseWebUrlResult.data;
+
+      if (!netrc.machines[parsedAPIUrl]) {
+        netrc.machines[parsedAPIUrl] = {};
+      }
+
+      netrc.machines[parsedAPIUrl].webUrl = parsedWebUrl;
+      netrc.machines[parsedAPIUrl].status = HOST_CONFIG_STATUS.active;
+
+      await netrc.save();
+
+      spinner.succeed('Your configuration has been saved.');
+    } catch (error) {
+      if (spinner.isSpinning) {
+        spinner.fail();
+      }
+
+      this.error(error.message);
+    }
+  }
+}
+
+SetCommand.description = 'Set the Web URL and API URL of dbdocs self-hosted server';
+
+SetCommand.flags = {
+  webUrl: Flags.string({
+    description: 'Self-hosted web url',
+    required: true,
+  }),
+  apiUrl: Flags.string({
+    description: 'Self-hosted api url',
+    required: true,
+  }),
+};
+
+SetCommand.examples = [
+  '$ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev',
+].join('\n');
+
+module.exports = SetCommand;

package/src/hooks/init/loadEnv.js

@@ -1,3 +1,23 @@
+/* eslint-disable no-restricted-syntax */
+/* eslint-disable guard-for-in */
+const netrc = require('netrc-parser').default;
+const { HOST_CONFIG_STATUS } = require('../../utils/constants');
+
+// eslint-disable-next-line func-names
 module.exports = async function () {
+  // eslint-disable-next-line global-require
   require('dotenv').config();
-}
+
+  // Check netrc config
+  await netrc.load();
+
+  const machines = Object.keys(netrc.machines).map((key) => ({ apiUrl: key, ...netrc.machines[key] }));
+
+  const matchedMachine = machines.find((machine) => machine.apiUrl && machine.webUrl && machine.status === HOST_CONFIG_STATUS.active);
+
+  if (!matchedMachine) return;
+
+  // Override env
+  process.env.DBDOCS_HOST = matchedMachine.webUrl;
+  process.env.DBDOCS_API_HOST = matchedMachine.apiUrl;
+};

package/src/utils/constants.js

@@ -38,6 +38,11 @@ const WINDOW_FILE_PATH_REGEX = /^[a-zA-Z]:[\\/](?:[^<>:"/\\|?*\n\r]+[\\/])*[^<>:
  */
 const UNIX_FILE_PATH_REGEX = /^(\/|\.\/|~\/|\.\.\/)([^<>:"|?*\n\r]*\/?)*[^<>:"|?*\n\r]*$/;
 
+const HOST_CONFIG_STATUS = {
+  active: 'active',
+  inactive: 'inactive',
+};
+
 module.exports = {
   PROJECT_GENERAL_ACCESS_TYPE,
   PROJECT_SHARING_TEXT,
@@ -46,4 +51,5 @@ module.exports = {
   SUPPORTED_DATABASE_CONNECTORS,
   WINDOW_FILE_PATH_REGEX,
   UNIX_FILE_PATH_REGEX,
+  HOST_CONFIG_STATUS,
 };

package/src/validators/url.js

@@ -0,0 +1,22 @@
+const { URL } = require('url');
+
+function tryParseHttpUrl (url) {
+  try {
+    const parsedUrl = new URL(url);
+
+    if (parsedUrl.protocol !== 'http:' && parsedUrl.protocol !== 'https:') {
+      return { isSuccess: false, data: 'URL protocol must be HTTP or HTTPS' };
+    }
+
+    // Remove trailing slash from the origin.
+    const sanitizedOrigin = parsedUrl.origin.replace(/\/$/, '');
+
+    return { isSuccess: true, data: sanitizedOrigin };
+  } catch (error) {
+    return { isSuccess: false, data: 'Invalid URL format' };
+  }
+}
+
+module.exports = {
+  tryParseHttpUrl,
+};