bdy 1.25.13-stage → 1.25.15-dev

package/distTs/src/command/config/set/whitelist.js

@@ -8,10 +8,11 @@ const output_1 = __importDefault(require("../../../output"));
 const input_1 = __importDefault(require("../../../input"));
 const texts_1 = require("../../../texts");
 const utils_1 = require("../../../utils");
-const commandConfigSetWhitelist = (0, utils_1.newCommand)('whitelist', texts_1.DESC_COMMAND_CONFIG_SET_WHITELIST);
+const commandConfigSetWhitelist = (0, utils_1.newCommand)('whitelist', texts_1.DESC_COMMAND_CONFIG_SET_WHITELIST, { requiredScopes: [] });
 commandConfigSetWhitelist.argument('[cidrs...]', texts_1.OPTION_WHITELIST, []);
-commandConfigSetWhitelist.action((whitelist) => {
+commandConfigSetWhitelist.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandConfigSetWhitelist.action((whitelist, options) => {
     cfg_1.default.setWhitelist(input_1.default.whitelist(whitelist));
-    output_1.default.exitSuccess(texts_1.TXT_WHITELIST_SAVED);
+    output_1.default.exitResult(options.format === 'json', { whitelist: cfg_1.default.getWhitelist().length ? cfg_1.default.getWhitelist() : null }, texts_1.TXT_WHITELIST_SAVED);
 });
 exports.default = commandConfigSetWhitelist;

package/distTs/src/command/crawl/link.js

@@ -7,15 +7,18 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const commandCrawlLink = (0, utils_1.newCommand)('link', texts_1.DESC_COMMAND_CRAWL_LINK, {
+    requiredScopes: [utils_1.REST_API_SCOPE.CRAWL_WRITE],
     examples: texts_1.EXAMPLE_CRAWL_LINK,
 });
 commandCrawlLink.option('-w, --workspace <workspace>', texts_1.OPTION_REST_API_WORKSPACE);
 commandCrawlLink.option('-p, --project <project>', texts_1.OPTION_REST_API_PROJECT);
 commandCrawlLink.option('-s, --suite <suite>', texts_1.OPTION_SUITE_IDENTIFIER);
+commandCrawlLink.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandCrawlLink.action(async (options) => {
     const Input = require('../../input').default;
     const ProjectCfg = require('../../project/cfg').default;
     output_1.default.handleSignals();
+    const json = options.format === 'json';
     const workspace = Input.restApiWorkspace(options.workspace);
     const project = Input.restApiProject(options.project);
     const client = Input.restApiTokenClient(false, options.api, options.region);
@@ -36,8 +39,10 @@ commandCrawlLink.action(async (options) => {
         if (opt === 'new') {
             const name = await output_1.default.inputString(texts_1.TXT_COMMAND_SUITE_NAME);
             const response = await client.createCrawlSuite(workspace, project, { name, identifier: name });
-            output_1.default.okSign();
-            output_1.default.normal(texts_1.TXT_COMMAND_SUITE_CREATED);
+            if (!json) {
+                output_1.default.okSign();
+                output_1.default.normal(texts_1.TXT_COMMAND_SUITE_CREATED);
+            }
             suiteIdentifier = response.identifier;
         }
         else {
@@ -57,7 +62,8 @@ commandCrawlLink.action(async (options) => {
         }
     }
     ProjectCfg.setSuite((0, utils_1.getWorkingDir)(), 'crawl', suiteIdentifier);
-    output_1.default.okSign();
-    output_1.default.exitSuccess(texts_1.TXT_COMMAND_CRAWL_LINK_SUCCESS);
+    if (!json)
+        output_1.default.okSign();
+    output_1.default.exitResult(json, { suite: suiteIdentifier }, texts_1.TXT_COMMAND_CRAWL_LINK_SUCCESS);
 });
 exports.default = commandCrawlLink;

package/distTs/src/command/crawl/run.js

@@ -42,7 +42,10 @@ commandCrawlRun.option('--header <headers...>', texts_1.OPTION_COMPARE_HEADER);
 commandCrawlRun.option('--localStorage <items...>', texts_1.OPTION_CRAWL_LOCAL_STORAGE);
 commandCrawlRun.option('--delay <delays...>', texts_1.OPTION_CRAWL_DELAY);
 commandCrawlRun.option('--outputDir <dir>', texts_1.OPTION_CRAWL_OUTPUT_DIR, '.');
+commandCrawlRun.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandCrawlRun.action(async (inputUrl, options) => {
+    const json = options.format === 'json';
+    const say = output_1.default.progress(json);
     const { downloadCrawlPackage, sendCrawl } = require('../../crawl/requests');
     const { createCrawlContext, applyToken, applyCiAndCommitInfo } = require('../../visualTest/context');
     const { validateInputAndOptions } = require('./validation');
@@ -60,25 +63,26 @@ commandCrawlRun.action(async (inputUrl, options) => {
         const ciAndGitInfo = await getCiAndGitInfo({});
         applyCiAndCommitInfo(ctx, ciAndGitInfo);
         const { buildId } = await sendCrawl(ctx, url, follow, respectRobots, outputTypes, colorScheme, browsers, devices, cookies, requestHeaders, delays, waitForSelectors, localStorage);
-        const status = await watchSessionStatus(ctx, buildId);
+        const status = await watchSessionStatus(ctx, buildId, json);
         if (!status.ok) {
             output_1.default.exitError(`Crawl session failed: ${status.error}`);
         }
-        output_1.default.normal('Downloading crawl package');
+        say('Downloading crawl package');
         const crawlPackageStream = await downloadCrawlPackage(ctx, buildId);
         const brotliDecompressor = (0, node_zlib_1.createBrotliDecompress)();
         const unpack = tar.extract();
+        const preparedOutputDir = outputDir.startsWith('.')
+            ? node_path_1.default.join(process.cwd(), outputDir)
+            : outputDir;
+        let files = 0;
         unpack.on('entry', async (header, stream, next) => {
-            const currentDir = process.cwd();
-            const preparedOutputDir = outputDir.startsWith('.')
-                ? node_path_1.default.join(currentDir, outputDir)
-                : outputDir;
             const newFilePath = node_path_1.default.join(preparedOutputDir, header.name);
             try {
                 if (header.type === 'file') {
                     await (0, promises_2.mkdir)(node_path_1.default.dirname(newFilePath), { recursive: true });
                     const fileWriteStream = (0, node_fs_1.createWriteStream)(newFilePath);
                     await (0, promises_1.pipeline)(stream, fileWriteStream);
+                    files += 1;
                     next();
                 }
                 else {
@@ -87,43 +91,51 @@ commandCrawlRun.action(async (inputUrl, options) => {
                 }
             }
             catch (entryError) {
-                output_1.default.error(`Error processing entry ${header.name}: ${entryError}`);
+                sayError(json, `Error processing entry ${header.name}: ${entryError}`);
                 next(entryError);
             }
         });
         await (0, promises_1.pipeline)(crawlPackageStream, brotliDecompressor, unpack);
-        output_1.default.exitSuccess('Downloading crawl package finished');
+        output_1.default.exitResult(json, { build_id: buildId, output_dir: preparedOutputDir, files }, 'Downloading crawl package finished');
     }
     catch (error) {
         output_1.default.exitError(`${error}`);
     }
 });
-async function watchSessionStatus(ctx, buildId) {
+// with --format json session failures go to stderr, keeping stdout for the result
+const sayError = (json, txt) => {
+    if (json)
+        output_1.default.noteWarning(txt);
+    else
+        output_1.default.error(txt);
+};
+async function watchSessionStatus(ctx, buildId, json) {
     const { connectToCrawlSession } = require('../../crawl/requests');
+    const say = output_1.default.progress(json);
     return new Promise((resolve) => {
         const eventSource = connectToCrawlSession(ctx, buildId);
         eventSource.addEventListener('SESSION_STATUS', (event) => {
             const data = JSON.parse(event.data);
             if (data.status === 'STARTED') {
-                output_1.default.normal('Crawl session started');
+                say('Crawl session started');
             }
             else if (data.status === 'GATHER_URLS_COMPLETED') {
-                output_1.default.normal(`Gathering URLs completed, found ${data.text} URLs`);
+                say(`Gathering URLs completed, found ${data.text} URLs`);
             }
             else if (data.status === 'GATHER_URLS_FAILED') {
-                output_1.default.error('Gathering URLs failed');
+                sayError(json, 'Gathering URLs failed');
             }
             else if (data.status === 'CRAWL_URL_COMPLETED') {
-                output_1.default.normal(`Crawling ${data.text} completed`);
+                say(`Crawling ${data.text} completed`);
             }
             else if (data.status === 'CRAWL_URL_FAILED') {
-                output_1.default.error(`Crawling ${data.text} failed`);
+                sayError(json, `Crawling ${data.text} failed`);
             }
             else if (data.status === 'CREATE_PACKAGE_COMPLETED') {
-                output_1.default.normal('Package created');
+                say('Package created');
             }
             else if (data.status === 'CREATE_PACKAGE_FAILED') {
-                output_1.default.error('Package creation failed');
+                sayError(json, 'Package creation failed');
             }
             else if (data.status === 'ERROR') {
                 eventSource.close();
@@ -131,7 +143,7 @@ async function watchSessionStatus(ctx, buildId) {
             }
             else if (data.status === 'FINISHED') {
                 eventSource.close();
-                output_1.default.normal('Crawl session finished');
+                say('Crawl session finished');
                 resolve({ ok: true });
             }
         });
@@ -139,7 +151,7 @@ async function watchSessionStatus(ctx, buildId) {
             if (event.code) {
                 eventSource.close();
                 if (event.code === 410) {
-                    output_1.default.normal('Crawl session finished');
+                    say('Crawl session finished');
                 }
                 resolve({ ok: event.code === 410, error: event.code });
             }

package/distTs/src/command/distro/delete.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../cliError"));
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
@@ -17,6 +18,7 @@ commandDistroDelete.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_W
 commandDistroDelete.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
 commandDistroDelete.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandDistroDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
+commandDistroDelete.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDistroDelete.argument('<identifier>', texts_1.OPT_COMMAND_DISTRO_IDENTIFIER);
 commandDistroDelete.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -25,18 +27,19 @@ commandDistroDelete.action(async (identifier, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data || !data.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data || !data.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
-    const confirmed = await output_1.default.confirmDestructive(options.force, (0, texts_1.TXT_COMMAND_DISTRO_DELETE_CONFIRM)(identifier));
+    const json = options.format === 'json';
+    const confirmed = await output_1.default.confirmDestructive(options.force, (0, texts_1.TXT_COMMAND_DISTRO_DELETE_CONFIRM)(identifier), json);
     if (confirmed) {
         await client.deleteDistribution(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id);
-        output_1.default.exitSuccess(texts_1.TXT_COMMAND_DISTRO_DELETED);
+        output_1.default.exitResult(json, { deleted: identifier }, texts_1.TXT_COMMAND_DISTRO_DELETED);
     }
     else {
-        output_1.default.exitNormal();
+        output_1.default.exitResult(json, { deleted: null });
     }
 });
 exports.default = commandDistroDelete;

package/distTs/src/command/distro/get.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../cliError"));
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
@@ -24,10 +25,10 @@ commandDistroGet.action(async (identifier, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data || !data.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data || !data.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     const distro = await client.getDistribution(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id);
     if (options.format === 'json') {

package/distTs/src/command/distro/open.js

@@ -16,6 +16,7 @@ const commandDistroOpen = (0, utils_1.newCommand)('open', texts_1.DESC_COMMAND_R
 commandDistroOpen.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDistroOpen.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandDistroOpen.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
+commandDistroOpen.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDistroOpen.argument('<identifier>', texts_1.OPT_COMMAND_DISTRO_IDENTIFIER);
 commandDistroOpen.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -25,8 +26,8 @@ commandDistroOpen.action(async (identifier, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scopedProject, identifier);
     if (!data?.distribution_id)
-        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST);
     const distro = await client.getDistribution(workspace, scopedProject, data.distribution_id);
-    await output_1.default.openUrl(distro.html_url);
+    await output_1.default.openUrl(distro.html_url, options.format === 'json');
 });
 exports.default = commandDistroOpen;

package/distTs/src/command/distro/route/create.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
@@ -47,10 +48,10 @@ commandDistroRouteCreate.action(async (identifier, options) => {
         body.agent_note = options.agentNote;
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data?.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data?.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     body.targets = await input_1.default.routeTarget(client, workspace, scope === distro_1.SCOPE.PROJECT ? project : null, options.target);
     const result = await client.createRoute(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, body);

package/distTs/src/command/distro/route/delete.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
@@ -17,6 +18,7 @@ commandDistroRouteDelete.option('-w, --workspace <domain>', texts_1.OPTION_REST_
 commandDistroRouteDelete.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandDistroRouteDelete.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
 commandDistroRouteDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
+commandDistroRouteDelete.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDistroRouteDelete.argument('<identifier>', texts_1.OPT_COMMAND_DISTRO_IDENTIFIER);
 commandDistroRouteDelete.argument('<route-id>', texts_1.OPT_COMMAND_ROUTE_ID);
 commandDistroRouteDelete.action(async (identifier, routeId, options) => {
@@ -26,18 +28,19 @@ commandDistroRouteDelete.action(async (identifier, routeId, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data?.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data?.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
-    const confirmed = await output_1.default.confirmDestructive(options.force, (0, texts_1.TXT_COMMAND_ROUTE_DELETE_CONFIRM)(identifier, routeId));
+    const json = options.format === 'json';
+    const confirmed = await output_1.default.confirmDestructive(options.force, (0, texts_1.TXT_COMMAND_ROUTE_DELETE_CONFIRM)(identifier, routeId), json);
     if (confirmed) {
         await client.deleteRoute(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, routeId);
-        output_1.default.exitSuccess(texts_1.TXT_COMMAND_ROUTE_DELETED);
+        output_1.default.exitResult(json, { deleted: routeId }, texts_1.TXT_COMMAND_ROUTE_DELETED);
     }
     else {
-        output_1.default.exitNormal();
+        output_1.default.exitResult(json, { deleted: null });
     }
 });
 exports.default = commandDistroRouteDelete;

package/distTs/src/command/distro/route/get.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
@@ -34,10 +35,10 @@ commandDistroRouteGet.action(async (identifier, routeId, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data?.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data?.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     const route = await client.getRoute(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, routeId);
     if (options.format === 'json') {

package/distTs/src/command/distro/route/list.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
@@ -25,10 +26,10 @@ commandDistroRouteList.action(async (identifier, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data?.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data?.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     const r = await client.listRoutes(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id);
     const routes = r.routes || [];

package/distTs/src/command/distro/route/open.js

@@ -16,6 +16,7 @@ const commandDistroRouteOpen = (0, utils_1.newCommand)('open', texts_1.DESC_COMM
 commandDistroRouteOpen.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDistroRouteOpen.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandDistroRouteOpen.option('--scope <scope>', texts_1.OPT_COMMAND_SCOPE);
+commandDistroRouteOpen.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDistroRouteOpen.argument('<identifier>', texts_1.OPT_COMMAND_DISTRO_IDENTIFIER);
 commandDistroRouteOpen.argument('<route-id>', texts_1.OPT_COMMAND_ROUTE_ID);
 commandDistroRouteOpen.action(async (identifier, routeId, options) => {
@@ -26,8 +27,8 @@ commandDistroRouteOpen.action(async (identifier, routeId, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scopedProject, identifier);
     if (!data?.distribution_id)
-        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST);
     const route = await client.getRoute(workspace, scopedProject, data.distribution_id, routeId);
-    await output_1.default.openUrl(route.html_url);
+    await output_1.default.openUrl(route.html_url, options.format === 'json');
 });
 exports.default = commandDistroRouteOpen;

package/distTs/src/command/distro/route/update.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../../cliError"));
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const input_1 = __importDefault(require("../../../input"));
@@ -33,10 +34,10 @@ commandDistroRouteUpdate.action(async (identifier, routeId, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data?.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data?.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     const route = await client.getRoute(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, routeId);
     let changed = false;

package/distTs/src/command/distro/update.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../cliError"));
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
@@ -54,10 +55,10 @@ commandDistroUpdate.action(async (identifier, options) => {
     const client = input_1.default.restApiTokenClient();
     const data = await client.getDistributionByIdentifier(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, identifier);
     if (!data || !data.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_WORKSPACE_NOT_FOUND, texts_1.HINT_WORKSPACE_LIST));
     }
     if (!data || !data.distribution_id) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DISTRO_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DISTRO_NOT_FOUND, texts_1.HINT_DISTRO_LIST));
     }
     const result = await client.updateDistribution(workspace, scope === distro_1.SCOPE.PROJECT ? project : null, data.distribution_id, body);
     if (options.format === 'json') {

package/distTs/src/command/domain/buy.js

@@ -7,6 +7,7 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const input_1 = __importDefault(require("../../input"));
+const cliError_1 = __importDefault(require("../../cliError"));
 const sortDomains = (arr, sort) => {
     return arr.sort((a, b) => {
         if (sort === 'name') {
@@ -20,13 +21,14 @@ const sortDomains = (arr, sort) => {
         return 0;
     });
 };
-const commandDomainBuy = (0, utils_1.newCommand)('buy', texts_1.DESC_COMMAND_DOMAIN_BUY);
+const commandDomainBuy = (0, utils_1.newCommand)('buy', texts_1.DESC_COMMAND_DOMAIN_BUY, { requiredScopes: [utils_1.REST_API_SCOPE.DOMAIN_MANAGE] });
 commandDomainBuy.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDomainBuy.option('-d, --tld <tld...>', texts_1.OPT_COMMAND_DOMAIN_BUY_TLD);
 commandDomainBuy.option('-o, --owner-behalf', texts_1.OPT_COMMAND_DOMAIN_BUY_OWNER);
 commandDomainBuy.option('-s, --sort <name|price>', texts_1.OPT_COMMAND_DOMAIN_SORT);
 commandDomainBuy.option('-f, --force', texts_1.OPTION_CONFIRM_DOMAIN_BUY);
 commandDomainBuy.option('-a, --only-available', texts_1.OPT_COMMAND_DOMAIN_ONLY_AVAILABLE);
+commandDomainBuy.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDomainBuy.argument('[domain|prompt]', texts_1.OPT_COMMAND_DOMAIN_PHRASE);
 commandDomainBuy.action(async (text, options) => {
     const onlyAvailable = options.onlyAvailable;
@@ -36,11 +38,16 @@ commandDomainBuy.action(async (text, options) => {
     const tlds = input_1.default.allowedTlds(options.tld);
     const prompt = (text || '').trim().toLowerCase();
     const onOwnerBehalf = !!options.ownerBehalf;
-    if (output_1.default.isTTY() && !options.force) {
+    const json = options.format === 'json';
+    if (options.force) {
+        await nonInteractive(client, workspace, prompt, tlds, onOwnerBehalf, json);
+    }
+    else if (output_1.default.isTTY() && !json) {
         await interactive(client, workspace, prompt, tlds, onOwnerBehalf, onlyAvailable, sort);
     }
     else {
-        await nonInteractive(client, workspace, prompt, tlds, onOwnerBehalf);
+        // buying spends money, so only the menu or --force may pick the domain
+        throw new cliError_1.default('usage_error', texts_1.ERR_CONFIRM_REQUIRED, texts_1.TXT_CONFIRM_FORCE_HINT);
     }
     output_1.default.exitNormal();
 });
@@ -67,19 +74,28 @@ const outputBought = (domain) => {
     output_1.default.normal(' bought');
     outputRouteExample(domain);
 };
-const claimNonInteractive = async (client, workspace, domain, onOwnerBehalf) => {
+const claimNonInteractive = async (client, workspace, domain, onOwnerBehalf, json) => {
+    if (json) {
+        output_1.default.json(await client.domainClaim(workspace, domain, onOwnerBehalf));
+        return;
+    }
     output_1.default.arrowSign();
     output_1.default.normal(`Matched: ${output_1.default.formatDomainClaim(domain, true)}`);
     await client.domainClaim(workspace, domain, onOwnerBehalf);
     outputClaimed(domain);
 };
-const buyNonInteractive = async (client, workspace, domain, onOwnerBehalf) => {
+const buyNonInteractive = async (client, workspace, domain, onOwnerBehalf, json) => {
+    if (!domain?.available) {
+        throw new cliError_1.default('usage_error', texts_1.ERR_COMMAND_DOMAIN_UNAVAILABLE);
+    }
+    if (json) {
+        output_1.default.json(await client.domainBuy(workspace, domain.name, onOwnerBehalf, true));
+        return;
+    }
     output_1.default.arrowSign();
     output_1.default.normal(`Matched: ${output_1.default.formatDomain(domain)}`);
-    if (domain.available) {
-        await client.domainBuy(workspace, domain.name, onOwnerBehalf, true);
-        outputBought(domain.name);
-    }
+    await client.domainBuy(workspace, domain.name, onOwnerBehalf, true);
+    outputBought(domain.name);
 };
 const interactive = async (client, workspace, prompt, tlds, onOwnerBehalf, onlyAvailable, sort) => {
     if (!prompt) {
@@ -264,7 +280,7 @@ const interactive = async (client, workspace, prompt, tlds, onOwnerBehalf, onlyA
         outputBought(name);
     }
 };
-const nonInteractive = async (client, workspace, prompt, tlds, onOwnerBehalf) => {
+const nonInteractive = async (client, workspace, prompt, tlds, onOwnerBehalf, json) => {
     if (!prompt) {
         output_1.default.exitError(texts_1.TXT_COMMAND_DOMAIN_PROMPT_REQUIRED);
     }
@@ -273,19 +289,22 @@ const nonInteractive = async (client, workspace, prompt, tlds, onOwnerBehalf) =>
         const claims = await client.domainClaimable(workspace, subdomain);
         const claimable = claims.domains.find((c) => c.available && `${subdomain}.${c.domain}` === prompt);
         if (claimable) {
-            await claimNonInteractive(client, workspace, prompt, onOwnerBehalf);
+            await claimNonInteractive(client, workspace, prompt, onOwnerBehalf, json);
             return;
         }
         const { domains } = await client.domainSearch(workspace, [prompt]);
-        await buyNonInteractive(client, workspace, domains[0], onOwnerBehalf);
+        await buyNonInteractive(client, workspace, domains[0], onOwnerBehalf, json);
         return;
     }
-    output_1.default.arrowSign();
-    output_1.default.normal(`Searching...`);
+    if (!json) {
+        output_1.default.arrowSign();
+        output_1.default.normal(`Searching...`);
+    }
     const suggestions = await client.domainSuggest(workspace, prompt, tlds, 5);
-    output_1.default.clearPreviousLine();
+    if (!json)
+        output_1.default.clearPreviousLine();
     if (suggestions.claims.length > 0) {
-        await claimNonInteractive(client, workspace, suggestions.claims[0], onOwnerBehalf);
+        await claimNonInteractive(client, workspace, suggestions.claims[0], onOwnerBehalf, json);
         return;
     }
     const domains = suggestions.domains.sort((a, b) => {
@@ -296,7 +315,7 @@ const nonInteractive = async (client, workspace, prompt, tlds, onOwnerBehalf) =>
         return a.prices.create.price < b.prices.create.price ? -1 : 1;
     });
     if (domains.length > 0) {
-        await buyNonInteractive(client, workspace, domains[0], onOwnerBehalf);
+        await buyNonInteractive(client, workspace, domains[0], onOwnerBehalf, json);
         return;
     }
     output_1.default.exitError(texts_1.ERR_COMMAND_DOMAIN_NOT_FOUND);

package/distTs/src/command/domain/get.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const cliError_1 = __importDefault(require("../../cliError"));
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandDomainGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_DOMAIN_GET);
+const commandDomainGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_DOMAIN_GET, { requiredScopes: [utils_1.REST_API_SCOPE.DOMAIN_READ] });
 commandDomainGet.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDomainGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDomainGet.argument('<id|name>', texts_1.OPTION_COMMAND_DOMAIN_IDENTIFIER);
@@ -26,7 +27,7 @@ commandDomainGet.action(async (name, options) => {
         }
     }
     if (!domain) {
-        output_1.default.exitError(texts_1.ERR_COMMAND_DOMAIN_NOT_FOUND);
+        output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_COMMAND_DOMAIN_NOT_FOUND, texts_1.HINT_DOMAIN_LIST));
     }
     if (options.format === 'json') {
         output_1.default.json(domain);

package/distTs/src/command/domain/list.js

@@ -7,7 +7,7 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
-const commandDomainList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_DOMAIN_LIST);
+const commandDomainList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_DOMAIN_LIST, { requiredScopes: [utils_1.REST_API_SCOPE.DOMAIN_READ] });
 commandDomainList.alias('ls');
 commandDomainList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandDomainList.option('--format <text|json>', texts_1.OPTION_FORMAT);

package/distTs/src/command/domain/open.js

@@ -9,9 +9,11 @@ const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 const cliError_1 = __importDefault(require("../../cliError"));
 const commandDomainOpen = (0, utils_1.newCommand)('open', texts_1.DESC_COMMAND_RESOURCE_OPEN, {
+    requiredScopes: [utils_1.REST_API_SCOPE.DOMAIN_READ],
     examples: [{ description: 'Open a domain in Buddy', command: 'bdy domain open example.com' }],
 });
 commandDomainOpen.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
+commandDomainOpen.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandDomainOpen.argument('<id|name>', texts_1.OPTION_COMMAND_DOMAIN_IDENTIFIER);
 commandDomainOpen.action(async (name, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -27,7 +29,7 @@ commandDomainOpen.action(async (name, options) => {
             domain = await client.getDomain(workspace, found.id);
     }
     if (!domain)
-        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DOMAIN_NOT_FOUND);
-    await output_1.default.openUrl(domain.html_url);
+        throw new cliError_1.default('not_found', texts_1.ERR_COMMAND_DOMAIN_NOT_FOUND, texts_1.HINT_DOMAIN_LIST);
+    await output_1.default.openUrl(domain.html_url, options.format === 'json');
 });
 exports.default = commandDomainOpen;

package/distTs/src/command/domain/search.js

@@ -21,6 +21,7 @@ const sort = (arr, sort) => {
     });
 };
 const commandDomainSearch = (0, utils_1.newCommand)('search', texts_1.DESC_COMMAND_DOMAIN_SEARCH, {
+    requiredScopes: [utils_1.REST_API_SCOPE.DOMAIN_READ],
     helpText: texts_1.HELP_DOMAIN_SEARCH_JSON,
     examples: texts_1.EXAMPLE_DOMAIN_SEARCH,
 });