@motherbase/cli 0.2.5 → 0.2.6

package/src/commands/db.js

@@ -1,103 +1,103 @@
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const api = require('../api');
-const prompt = require('../prompt');
-const rls = require('./rls');
-const { output, alias, parseKeyValues } = require('./_util');
-const { CliError } = require('../context');
-
-const subcommands = {
-  tables: {
-    summary: 'List database tables',
-    usage: 'motherbase db tables',
-    async run(ctx) {
-      const data = await api.adminRequest(ctx, 'GET', '/schema/tables');
-      const tables = (data && data.tables) || data || [];
-      output(ctx, data, (_d, ui) =>
-        ui.table(Array.isArray(tables) ? tables : [], [
-          { key: 'name', label: 'TABLE' },
-          { key: 'schema', label: 'SCHEMA' },
-        ]),
-      );
-    },
-  },
-  sql: {
-    summary: 'Run SQL from -e "..." or a file',
-    usage: 'motherbase db sql -e "select 1" | motherbase db sql <file.sql>',
-    async run(ctx, args, flags) {
-      let sql = flags.e || flags.execute;
-      if (!sql && args[0]) sql = fs.readFileSync(path.resolve(ctx.cwd, args[0]), 'utf8');
-      if (!sql) throw new CliError('Provide SQL via -e "..." or a file path.');
-      const data = await api.adminRequest(ctx, 'POST', '/sql', { body: { sql } });
-      output(ctx, data, (d, ui) => {
-        if (d && Array.isArray(d.rows)) ui.table(d.rows);
-        else if (Array.isArray(d)) ui.table(d);
-        else ui.json(d);
-      });
-    },
-  },
-  // `db dump` is Supabase's local dump (../migration/commands); this is the
-  // server-side backup it used to be.
-  backup: {
-    summary: 'Create a database backup on the server',
-    usage: 'motherbase db backup [file]',
-    async run(ctx, args) {
-      const body = args[0] ? { file: args[0] } : {};
-      const data = await api.adminRequest(ctx, 'POST', '/backups', { body });
-      output(ctx, data, (d, ui) => ui.success(`Backup created${d && d.file ? `: ${d.file}` : ''}`));
-    },
-  },
-  restore: {
-    summary: 'Restore the database from a server dump or offsite key',
-    usage: 'motherbase db restore <file> | --key <remoteKey>  --confirm',
-    async run(ctx, args, flags) {
-      const file = args[0];
-      const key = flags.key;
-      if (!file && !key) throw new CliError('Provide a <file> or --key <remoteKey>.');
-      if (!flags.confirm && !flags.yes) {
-        const ok = await prompt.confirm('This will overwrite the database. Continue?');
-        if (!ok) throw new CliError('Aborted.');
-      }
-      const body = key ? { key, confirm: 'RESTORE' } : { file, confirm: 'RESTORE' };
-      const data = await api.adminRequest(ctx, 'POST', '/backups/restore', { body });
-      output(ctx, data, (d, ui) => ui.success('Restore complete'));
-    },
-  },
-  backups: {
-    summary: 'List backups, or manage backup config (`db backups config`)',
-    usage: 'motherbase db backups [list] | motherbase db backups config [--set key=value ...]',
-    async run(ctx, args, flags) {
-      const sub = args[0];
-      if (sub === 'config') {
-        const sets = [].concat(flags.set || []).filter(Boolean);
-        if (sets.length) {
-          const body = parseKeyValues(sets);
-          const data = await api.adminRequest(ctx, 'PUT', '/backups/config', { body });
-          output(ctx, data, (d, ui) => ui.success('Backup config saved'));
-        } else {
-          const data = await api.adminRequest(ctx, 'GET', '/backups/config');
-          output(ctx, data, (d, ui) => ui.keyValue(d || {}));
-        }
-        return;
-      }
-      const data = await api.adminRequest(ctx, 'GET', '/backups/list');
-      output(ctx, data, (d, ui) => ui.json(d));
-    },
-  },
-};
-
-// Supabase's local-files workflow: push, pull, diff, reset, dump, seed.
-Object.assign(subcommands, require('../migration/commands').dbSubcommands);
-// Studio's Database section: indexes, enum types, roles, column privileges, publications.
-Object.assign(subcommands, require('./db-catalog'));
-
-// Supabase's `db lint`: the same advisor as `rls lint`.
-subcommands.lint = alias(rls.subcommands.lint, 'motherbase db lint [--level critical|warning|info]');
-
-module.exports = {
-  summary: 'Database: tables, SQL, dumps, restores, indexes, types, roles, publications',
-  usage: 'motherbase db <push|pull|diff|reset|dump|seed|tables|sql|backup|restore|backups|lint|indexes|types|roles|column-privileges|publications> ...',
-  subcommands,
-};
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const api = require('../api');
+const prompt = require('../prompt');
+const rls = require('./rls');
+const { output, alias, parseKeyValues } = require('./_util');
+const { CliError } = require('../context');
+
+const subcommands = {
+  tables: {
+    summary: 'List database tables',
+    usage: 'motherbase db tables',
+    async run(ctx) {
+      const data = await api.adminRequest(ctx, 'GET', '/schema/tables');
+      const tables = (data && data.tables) || data || [];
+      output(ctx, data, (_d, ui) =>
+        ui.table(Array.isArray(tables) ? tables : [], [
+          { key: 'name', label: 'TABLE' },
+          { key: 'schema', label: 'SCHEMA' },
+        ]),
+      );
+    },
+  },
+  sql: {
+    summary: 'Run SQL from -e "..." or a file',
+    usage: 'motherbase db sql -e "select 1" | motherbase db sql <file.sql>',
+    async run(ctx, args, flags) {
+      let sql = flags.e || flags.execute;
+      if (!sql && args[0]) sql = fs.readFileSync(path.resolve(ctx.cwd, args[0]), 'utf8');
+      if (!sql) throw new CliError('Provide SQL via -e "..." or a file path.');
+      const data = await api.adminRequest(ctx, 'POST', '/sql', { body: { sql } });
+      output(ctx, data, (d, ui) => {
+        if (d && Array.isArray(d.rows)) ui.table(d.rows);
+        else if (Array.isArray(d)) ui.table(d);
+        else ui.json(d);
+      });
+    },
+  },
+  // `db dump` is Supabase's local dump (../migration/commands); this is the
+  // server-side backup it used to be.
+  backup: {
+    summary: 'Create a database backup on the server',
+    usage: 'motherbase db backup [file]',
+    async run(ctx, args) {
+      const body = args[0] ? { file: args[0] } : {};
+      const data = await api.adminRequest(ctx, 'POST', '/backups', { body });
+      output(ctx, data, (d, ui) => ui.success(`Backup created${d && d.file ? `: ${d.file}` : ''}`));
+    },
+  },
+  restore: {
+    summary: 'Restore the database from a server dump or offsite key',
+    usage: 'motherbase db restore <file> | --key <remoteKey>  --confirm',
+    async run(ctx, args, flags) {
+      const file = args[0];
+      const key = flags.key;
+      if (!file && !key) throw new CliError('Provide a <file> or --key <remoteKey>.');
+      if (!flags.confirm && !flags.yes) {
+        const ok = await prompt.confirm('This will overwrite the database. Continue?');
+        if (!ok) throw new CliError('Aborted.');
+      }
+      const body = key ? { key, confirm: 'RESTORE' } : { file, confirm: 'RESTORE' };
+      const data = await api.adminRequest(ctx, 'POST', '/backups/restore', { body });
+      output(ctx, data, (d, ui) => ui.success('Restore complete'));
+    },
+  },
+  backups: {
+    summary: 'List backups, or manage backup config (`db backups config`)',
+    usage: 'motherbase db backups [list] | motherbase db backups config [--set key=value ...]',
+    async run(ctx, args, flags) {
+      const sub = args[0];
+      if (sub === 'config') {
+        const sets = [].concat(flags.set || []).filter(Boolean);
+        if (sets.length) {
+          const body = parseKeyValues(sets);
+          const data = await api.adminRequest(ctx, 'PUT', '/backups/config', { body });
+          output(ctx, data, (d, ui) => ui.success('Backup config saved'));
+        } else {
+          const data = await api.adminRequest(ctx, 'GET', '/backups/config');
+          output(ctx, data, (d, ui) => ui.keyValue(d || {}));
+        }
+        return;
+      }
+      const data = await api.adminRequest(ctx, 'GET', '/backups/list');
+      output(ctx, data, (d, ui) => ui.json(d));
+    },
+  },
+};
+
+// Supabase's local-files workflow: push, pull, diff, reset, dump, seed.
+Object.assign(subcommands, require('../migration/commands').dbSubcommands);
+// Studio's Database section: indexes, enum types, roles, column privileges, publications.
+Object.assign(subcommands, require('./db-catalog'));
+
+// Supabase's `db lint`: the same advisor as `rls lint`.
+subcommands.lint = alias(rls.subcommands.lint, 'motherbase db lint [--level critical|warning|info]');
+
+module.exports = {
+  summary: 'Database: tables, SQL, dumps, restores, indexes, types, roles, publications',
+  usage: 'motherbase db <push|pull|diff|reset|dump|seed|tables|sql|backup|restore|backups|lint|indexes|types|roles|column-privileges|publications> ...',
+  subcommands,
+};

package/src/commands/domains.js

@@ -1,124 +1,124 @@
-'use strict';
-
-// Custom domains and vanity subdomains (Supabase's `supabase domains` and
-// `supabase vanity-subdomains`). Both are Console routes on the linked project.
-
-const api = require('../api');
-const { output, requireArg, consoleProjectPath } = require('./_util');
-
-function renderHostname(d, ui) {
-  const custom = d.customHostname;
-  if (!custom) {
-    ui.info(`No custom domain. The API answers on ${d.projectDomain}.`);
-    return;
-  }
-  ui.keyValue({ hostname: custom.hostname, status: custom.status, projectDomain: d.projectDomain });
-  if (custom.status !== 'active') {
-    ui.print('');
-    ui.print('Publish these DNS records, then run `motherbase domains reverify`:');
-    ui.table(custom.requiredRecords, [
-      { key: 'type', label: 'TYPE' },
-      { key: 'name', label: 'NAME' },
-      { key: 'value', label: 'VALUE' },
-    ]);
-  }
-  for (const check of custom.checks || []) {
-    ui[check.ok ? 'success' : 'warn'](`${check.record} ${check.name}: ${check.ok ? 'ok' : `found ${check.found.join(', ') || 'nothing'}`}`);
-  }
-}
-
-const hostnamePath = (ctx, suffix = '') => consoleProjectPath(ctx, `/custom-hostname${suffix}`);
-
-const domains = {
-  summary: 'Custom domain for the linked project\'s API',
-  usage: 'motherbase domains <create|get|reverify|activate|delete> ...',
-  subcommands: {
-    create: {
-      summary: 'Start using a custom hostname (prints the DNS records to publish)',
-      usage: 'motherbase domains create --custom-hostname <api.example.com>',
-      async run(ctx, _args, flags) {
-        const hostname = requireArg(flags['custom-hostname'], 'custom-hostname');
-        const data = await api.consoleRequest(ctx, 'POST', hostnamePath(ctx), { body: { hostname } });
-        output(ctx, data, renderHostname);
-      },
-    },
-    get: {
-      summary: 'Show the custom hostname and its verification state',
-      usage: 'motherbase domains get',
-      async run(ctx) {
-        output(ctx, await api.consoleRequest(ctx, 'GET', hostnamePath(ctx)), renderHostname);
-      },
-    },
-    reverify: {
-      summary: 'Check the DNS records again',
-      usage: 'motherbase domains reverify',
-      async run(ctx) {
-        output(ctx, await api.consoleRequest(ctx, 'POST', hostnamePath(ctx, '/reverify')), renderHostname);
-      },
-    },
-    activate: {
-      summary: 'Serve the API on the verified hostname (TLS is issued on first request)',
-      usage: 'motherbase domains activate',
-      async run(ctx) {
-        output(ctx, await api.consoleRequest(ctx, 'POST', hostnamePath(ctx, '/activate')), renderHostname);
-      },
-    },
-    delete: {
-      summary: 'Stop using the custom hostname',
-      usage: 'motherbase domains delete',
-      async run(ctx) {
-        const data = await api.consoleRequest(ctx, 'DELETE', hostnamePath(ctx));
-        output(ctx, data, (_d, ui) => ui.success('Custom hostname removed'));
-      },
-    },
-  },
-};
-
-function renderVanity(d, ui) {
-  if (d.vanitySubdomain) ui.keyValue(d.vanitySubdomain);
-  else ui.info(`No vanity subdomain${d.vanitySuffix ? ` (they live under ${d.vanitySuffix})` : ''}.`);
-}
-
-const vanityPath = (ctx, suffix = '') => consoleProjectPath(ctx, `/vanity-subdomain${suffix}`);
-
-const vanitySubdomains = {
-  summary: 'Vanity subdomain under the platform domain',
-  usage: 'motherbase vanity-subdomains <get|check-availability|activate|delete> ...',
-  subcommands: {
-    get: {
-      summary: 'Show the active vanity subdomain',
-      usage: 'motherbase vanity-subdomains get',
-      async run(ctx) {
-        output(ctx, await api.consoleRequest(ctx, 'GET', vanityPath(ctx)), renderVanity);
-      },
-    },
-    'check-availability': {
-      summary: 'Is a subdomain free?',
-      usage: 'motherbase vanity-subdomains check-availability --desired-subdomain <name>',
-      async run(ctx, _args, flags) {
-        const subdomain = requireArg(flags['desired-subdomain'], 'desired-subdomain');
-        const data = await api.consoleRequest(ctx, 'POST', vanityPath(ctx, '/check-availability'), { body: { subdomain } });
-        output(ctx, data, (d, ui) => (d.available ? ui.success(`${d.hostname} is available`) : ui.warn(`${d.hostname} is taken`)));
-      },
-    },
-    activate: {
-      summary: 'Serve the API on <name>.<platform domain> as well',
-      usage: 'motherbase vanity-subdomains activate --desired-subdomain <name>',
-      async run(ctx, _args, flags) {
-        const subdomain = requireArg(flags['desired-subdomain'], 'desired-subdomain');
-        const data = await api.consoleRequest(ctx, 'POST', vanityPath(ctx), { body: { subdomain } });
-        output(ctx, data, renderVanity);
-      },
-    },
-    delete: {
-      summary: 'Remove the vanity subdomain',
-      usage: 'motherbase vanity-subdomains delete',
-      async run(ctx) {
-        const data = await api.consoleRequest(ctx, 'DELETE', vanityPath(ctx));
-        output(ctx, data, (_d, ui) => ui.success('Vanity subdomain removed'));
-      },
-    },
-  },
-};
-
-module.exports = { domains, vanitySubdomains };
+'use strict';
+
+// Custom domains and vanity subdomains (Supabase's `supabase domains` and
+// `supabase vanity-subdomains`). Both are Console routes on the linked project.
+
+const api = require('../api');
+const { output, requireArg, consoleProjectPath } = require('./_util');
+
+function renderHostname(d, ui) {
+  const custom = d.customHostname;
+  if (!custom) {
+    ui.info(`No custom domain. The API answers on ${d.projectDomain}.`);
+    return;
+  }
+  ui.keyValue({ hostname: custom.hostname, status: custom.status, projectDomain: d.projectDomain });
+  if (custom.status !== 'active') {
+    ui.print('');
+    ui.print('Publish these DNS records, then run `motherbase domains reverify`:');
+    ui.table(custom.requiredRecords, [
+      { key: 'type', label: 'TYPE' },
+      { key: 'name', label: 'NAME' },
+      { key: 'value', label: 'VALUE' },
+    ]);
+  }
+  for (const check of custom.checks || []) {
+    ui[check.ok ? 'success' : 'warn'](`${check.record} ${check.name}: ${check.ok ? 'ok' : `found ${check.found.join(', ') || 'nothing'}`}`);
+  }
+}
+
+const hostnamePath = (ctx, suffix = '') => consoleProjectPath(ctx, `/custom-hostname${suffix}`);
+
+const domains = {
+  summary: 'Custom domain for the linked project\'s API',
+  usage: 'motherbase domains <create|get|reverify|activate|delete> ...',
+  subcommands: {
+    create: {
+      summary: 'Start using a custom hostname (prints the DNS records to publish)',
+      usage: 'motherbase domains create --custom-hostname <api.example.com>',
+      async run(ctx, _args, flags) {
+        const hostname = requireArg(flags['custom-hostname'], 'custom-hostname');
+        const data = await api.consoleRequest(ctx, 'POST', hostnamePath(ctx), { body: { hostname } });
+        output(ctx, data, renderHostname);
+      },
+    },
+    get: {
+      summary: 'Show the custom hostname and its verification state',
+      usage: 'motherbase domains get',
+      async run(ctx) {
+        output(ctx, await api.consoleRequest(ctx, 'GET', hostnamePath(ctx)), renderHostname);
+      },
+    },
+    reverify: {
+      summary: 'Check the DNS records again',
+      usage: 'motherbase domains reverify',
+      async run(ctx) {
+        output(ctx, await api.consoleRequest(ctx, 'POST', hostnamePath(ctx, '/reverify')), renderHostname);
+      },
+    },
+    activate: {
+      summary: 'Serve the API on the verified hostname (TLS is issued on first request)',
+      usage: 'motherbase domains activate',
+      async run(ctx) {
+        output(ctx, await api.consoleRequest(ctx, 'POST', hostnamePath(ctx, '/activate')), renderHostname);
+      },
+    },
+    delete: {
+      summary: 'Stop using the custom hostname',
+      usage: 'motherbase domains delete',
+      async run(ctx) {
+        const data = await api.consoleRequest(ctx, 'DELETE', hostnamePath(ctx));
+        output(ctx, data, (_d, ui) => ui.success('Custom hostname removed'));
+      },
+    },
+  },
+};
+
+function renderVanity(d, ui) {
+  if (d.vanitySubdomain) ui.keyValue(d.vanitySubdomain);
+  else ui.info(`No vanity subdomain${d.vanitySuffix ? ` (they live under ${d.vanitySuffix})` : ''}.`);
+}
+
+const vanityPath = (ctx, suffix = '') => consoleProjectPath(ctx, `/vanity-subdomain${suffix}`);
+
+const vanitySubdomains = {
+  summary: 'Vanity subdomain under the platform domain',
+  usage: 'motherbase vanity-subdomains <get|check-availability|activate|delete> ...',
+  subcommands: {
+    get: {
+      summary: 'Show the active vanity subdomain',
+      usage: 'motherbase vanity-subdomains get',
+      async run(ctx) {
+        output(ctx, await api.consoleRequest(ctx, 'GET', vanityPath(ctx)), renderVanity);
+      },
+    },
+    'check-availability': {
+      summary: 'Is a subdomain free?',
+      usage: 'motherbase vanity-subdomains check-availability --desired-subdomain <name>',
+      async run(ctx, _args, flags) {
+        const subdomain = requireArg(flags['desired-subdomain'], 'desired-subdomain');
+        const data = await api.consoleRequest(ctx, 'POST', vanityPath(ctx, '/check-availability'), { body: { subdomain } });
+        output(ctx, data, (d, ui) => (d.available ? ui.success(`${d.hostname} is available`) : ui.warn(`${d.hostname} is taken`)));
+      },
+    },
+    activate: {
+      summary: 'Serve the API on <name>.<platform domain> as well',
+      usage: 'motherbase vanity-subdomains activate --desired-subdomain <name>',
+      async run(ctx, _args, flags) {
+        const subdomain = requireArg(flags['desired-subdomain'], 'desired-subdomain');
+        const data = await api.consoleRequest(ctx, 'POST', vanityPath(ctx), { body: { subdomain } });
+        output(ctx, data, renderVanity);
+      },
+    },
+    delete: {
+      summary: 'Remove the vanity subdomain',
+      usage: 'motherbase vanity-subdomains delete',
+      async run(ctx) {
+        const data = await api.consoleRequest(ctx, 'DELETE', vanityPath(ctx));
+        output(ctx, data, (_d, ui) => ui.success('Vanity subdomain removed'));
+      },
+    },
+  },
+};
+
+module.exports = { domains, vanitySubdomains };