bdy 1.25.13-dev → 1.25.14-dev

package/distTs/src/command/target/scope.js

@@ -31,7 +31,7 @@ const resolveTargetId = async (client, workspace, identifier, options, strictLin
         resolved = await client.getTargetByIdentifier(workspace, identifier);
     }
     if (!resolved.target_id) {
-        throw new cliError_1.default('not_found', texts_1.ERR_TARGET_NOT_FOUND);
+        throw new cliError_1.default('not_found', texts_1.ERR_TARGET_NOT_FOUND, texts_1.HINT_TARGET_LIST);
     }
     if (strictLine) {
         const requested = options.pipeline
@@ -50,7 +50,7 @@ const resolveTargetId = async (client, workspace, identifier, options, strictLin
                     : (0, exports.targetScopeOf)(target) === utils_1.TARGET_SCOPE.PROJECT &&
                         target.project?.name === resolved.project_identifier;
             if (!matches) {
-                throw new cliError_1.default('not_found', texts_1.ERR_TARGET_NOT_FOUND);
+                throw new cliError_1.default('not_found', texts_1.ERR_TARGET_NOT_FOUND, texts_1.HINT_TARGET_LIST);
             }
         }
     }
@@ -123,7 +123,7 @@ const resolveTargetScope = async (client, workspace, project, scope, options) =>
     if (scope === utils_1.TARGET_SCOPE.PIPELINE) {
         const { pipeline_id } = await client.getPipelineByIdentifier(workspace, project, options.pipeline);
         if (!pipeline_id)
-            output_1.default.exitError(texts_1.ERR_PIPELINE_NOT_FOUND);
+            output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_PIPELINE_NOT_FOUND, texts_1.HINT_PIPELINE_LIST));
         params.pipelineId = pipeline_id;
     }
     else if (scope === utils_1.TARGET_SCOPE.ENVIRONMENT) {
@@ -135,7 +135,7 @@ const resolveTargetScope = async (client, workspace, project, scope, options) =>
         const resolved = await client.getResourceByIdentifier(workspace, query);
         // a nonexistent project is rejected by getResourceByIdentifier itself
         if (!resolved.environment_id) {
-            output_1.default.exitError(texts_1.ERR_TARGET_ENVIRONMENT_NOT_FOUND);
+            output_1.default.exitError(new cliError_1.default('not_found', texts_1.ERR_TARGET_ENVIRONMENT_NOT_FOUND, texts_1.HINT_ENVIRONMENT_LIST));
         }
         params.environmentId = resolved.environment_id;
     }

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

@@ -9,6 +9,7 @@ const output_1 = __importDefault(require("../../output"));
 const input_1 = __importDefault(require("../../input"));
 const scope_1 = require("./scope");
 const commandTargetUpdate = (0, utils_1.newCommand)('update', texts_1.DESC_COMMAND_TARGET_UPDATE, {
+    requiredScopes: [utils_1.REST_API_SCOPE.TARGET_WRITE],
     examples: texts_1.EXAMPLE_TARGET_UPDATE,
 });
 commandTargetUpdate.alias('edit');

package/distTs/src/command/tests/capture.js

@@ -22,7 +22,10 @@ commandCapture.option('--cookie <cookies...>', texts_1.OPTION_COMPARE_COOKIE);
 commandCapture.option('--header <headers...>', texts_1.OPTION_COMPARE_HEADER);
 commandCapture.option('--delay <delays...>', texts_1.OPTION_COMPARE_DELAY);
 commandCapture.option('--waitFor <waitFors...>', texts_1.OPTION_COMPARE_WAIT_FOR);
+commandCapture.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandCapture.action(async (options) => {
+    const json = options.format === 'json';
+    const say = output_1.default.progress(json);
     const { getCiAndGitInfo, formattedCiInfo } = require('@buddy-works/ci-info');
     const { addProtocolIfMissing } = require('../../visualTest/linkUtils');
     const { sendCompareLinks } = require('../../visualTest/requests');
@@ -54,21 +57,21 @@ commandCapture.action(async (options) => {
     }
     const { filteredUrls, duplicates } = filterDuplicates(urls);
     if (duplicates.length > 0) {
-        output_1.default.normal(`Detected ${duplicates.length} duplicated urls:`);
-        output_1.default.normal(duplicates.join('\n'));
+        say(`Detected ${duplicates.length} duplicated urls:`);
+        say(duplicates.join('\n'));
     }
     if (validatedOptions.dryRun) {
-        output_1.default.exitSuccess(`List of urls:\n${filteredUrls.join('\n')}`);
+        output_1.default.exitResult(json, { urls: filteredUrls, duplicates }, `List of urls:\n${filteredUrls.join('\n')}`);
     }
     else if (filteredUrls.length > 1) {
-        output_1.default.normal(`List of urls:\n${filteredUrls.join('\n')}`);
+        say(`List of urls:\n${filteredUrls.join('\n')}`);
     }
     const ciAndGitInfo = await getCiAndGitInfo({});
-    output_1.default.normal(formattedCiInfo(ciAndGitInfo));
+    say(formattedCiInfo(ciAndGitInfo));
     applyCiAndCommitInfo(ctx, ciAndGitInfo);
     try {
-        const { message } = await sendCompareLinks(ctx, filteredUrls, validatedOptions, sitemapSource);
-        output_1.default.exitSuccess(message);
+        const response = await sendCompareLinks(ctx, filteredUrls, validatedOptions, sitemapSource);
+        output_1.default.exitResult(json, response, response.message);
     }
     catch (error) {
         output_1.default.exitError(`${error}`);

package/distTs/src/command/tests/unit/link.js

@@ -7,15 +7,18 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
 const commandUtLink = (0, utils_1.newCommand)('link', texts_1.DESC_COMMAND_UT_LINK, {
+    requiredScopes: [utils_1.REST_API_SCOPE.UNIT_TEST_WRITE],
     examples: texts_1.EXAMPLE_TESTS_UNIT_LINK,
 });
 commandUtLink.option('-w, --workspace <workspace>', texts_1.OPTION_REST_API_WORKSPACE);
 commandUtLink.option('-p, --project <project>', texts_1.OPTION_REST_API_PROJECT);
 commandUtLink.option('-s, --suite <suite>', texts_1.OPTION_SUITE_IDENTIFIER);
+commandUtLink.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandUtLink.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 @@ commandUtLink.action(async (options) => {
         if (opt === 'new') {
             const name = await output_1.default.inputString(texts_1.TXT_COMMAND_SUITE_NAME);
             const response = await client.createUtSuite(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 @@ commandUtLink.action(async (options) => {
         }
     }
     ProjectCfg.setSuite((0, utils_1.getWorkingDir)(), 'ut', suiteIdentifier);
-    output_1.default.okSign();
-    output_1.default.exitSuccess(texts_1.TXT_COMMAND_UT_LINK_SUCCESS);
+    if (!json)
+        output_1.default.okSign();
+    output_1.default.exitResult(json, { suite: suiteIdentifier }, texts_1.TXT_COMMAND_UT_LINK_SUCCESS);
 });
 exports.default = commandUtLink;

package/distTs/src/command/tests/visual/link.js

@@ -7,15 +7,18 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
 const commandVisualLink = (0, utils_1.newCommand)('link', texts_1.DESC_COMMAND_VT_LINK, {
+    requiredScopes: [utils_1.REST_API_SCOPE.VISUAL_TEST_WRITE],
     examples: texts_1.EXAMPLE_TESTS_VISUAL_LINK,
 });
 commandVisualLink.option('-w, --workspace <workspace>', texts_1.OPTION_REST_API_WORKSPACE);
 commandVisualLink.option('-p, --project <project>', texts_1.OPTION_REST_API_PROJECT);
 commandVisualLink.option('-s, --suite <suite>', texts_1.OPTION_SUITE_IDENTIFIER);
+commandVisualLink.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandVisualLink.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 @@ commandVisualLink.action(async (options) => {
         if (opt === 'new') {
             const name = await output_1.default.inputString(texts_1.TXT_COMMAND_SUITE_NAME);
             const response = await client.createVtSuite(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 @@ commandVisualLink.action(async (options) => {
         }
     }
     ProjectCfg.setSuite((0, utils_1.getWorkingDir)(), 'vt', suiteIdentifier);
-    output_1.default.okSign();
-    output_1.default.exitSuccess(texts_1.TXT_COMMAND_VT_LINK_SUCCESS);
+    if (!json)
+        output_1.default.okSign();
+    output_1.default.exitResult(json, { suite: suiteIdentifier }, texts_1.TXT_COMMAND_VT_LINK_SUCCESS);
 });
 exports.default = commandVisualLink;

package/distTs/src/command/tests/visual/session/close.js

@@ -9,7 +9,8 @@ const output_1 = __importDefault(require("../../../../output"));
 const commandSessionClose = (0, utils_1.newCommand)('close', texts_1.DESC_COMMAND_SESSION_CLOSE, {
     examples: texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE,
 });
-commandSessionClose.action(async () => {
+commandSessionClose.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandSessionClose.action(async (options) => {
     const { checkBuildId } = require('../../../../visualTest/validation');
     const { closeSession } = require('../../../../visualTest/requests');
     const { createVtContext, applyToken } = require('../../../../visualTest/context');
@@ -24,8 +25,12 @@ commandSessionClose.action(async () => {
     const ctx = createVtContext();
     applyToken(ctx, token);
     try {
-        const { message } = await closeSession(ctx);
-        output_1.default.exitNormal(message);
+        const response = await closeSession(ctx);
+        if (options.format === 'json') {
+            output_1.default.json(response);
+            output_1.default.exitNormal();
+        }
+        output_1.default.exitNormal(response.message);
     }
     catch (error) {
         output_1.default.exitError(`${error}`);

package/distTs/src/command/tests/visual/setup.js

@@ -7,13 +7,16 @@ const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
 const commandVisualSetup = (0, utils_1.newCommand)('setup', texts_1.DESC_COMMAND_VISUAL_SETUP, {
+    requiredScopes: [],
     examples: texts_1.EXAMPLE_TESTS_VISUAL_SETUP,
 });
-commandVisualSetup.action(async () => {
+commandVisualSetup.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandVisualSetup.action(async (options) => {
+    const json = options.format === 'json';
     try {
         const { installBrowser } = require('../../../visualTest/browser');
-        await installBrowser();
-        output_1.default.exitNormal('');
+        const path = await installBrowser(json);
+        output_1.default.exitResult(json, { installed: true, path }, '');
     }
     catch (error) {
         output_1.default.exitError(`${error}`);

package/distTs/src/command/tests/visual/upload.js

@@ -13,7 +13,10 @@ const commandVisualUpload = (0, utils_1.newCommand)('upload', texts_1.DESC_COMMA
     examples: texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD,
 });
 commandVisualUpload.argument('[directory]', texts_1.OPTION_STORYBOOK_DIRECTORY);
-commandVisualUpload.action(async (directory) => {
+commandVisualUpload.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandVisualUpload.action(async (directory, options) => {
+    const json = options.format === 'json';
+    const say = output_1.default.progress(json);
     const { getCiAndGitInfo, formattedCiInfo } = require('@buddy-works/ci-info');
     const { getDefaultSettings, sendStorybook } = require('../../../visualTest/requests');
     const { setDefaultSettings } = require('../../../visualTest/snapshots');
@@ -36,19 +39,19 @@ commandVisualUpload.action(async (directory) => {
     }
     const storybookStoriesIndex = getStorybookStoriesIndex(storybookFiles);
     const storiesList = getStoriesList(node_path_1.default.join(storybookDirectory, storybookStoriesIndex));
-    const storybookSnapshots = getStorybookSnapshots(storiesList);
+    const storybookSnapshots = getStorybookSnapshots(storiesList, say);
     const defaultSettings = await getDefaultSettings(ctx);
     setDefaultSettings(defaultSettings);
     const ciAndGitInfo = await getCiAndGitInfo({
         baseBranch: defaultSettings.baseBranch,
-        logger: output_1.default.warning,
+        logger: json ? output_1.default.noteWarning.bind(output_1.default) : output_1.default.warning,
     });
     applyCiAndCommitInfo(ctx, ciAndGitInfo);
-    output_1.default.normal(formattedCiInfo(ciAndGitInfo));
+    say(formattedCiInfo(ciAndGitInfo));
     try {
         const compressedStorybookDirectory = await createCompressedStorybookDirectory(storybookFiles, storybookDirectory);
-        const { message } = await sendStorybook(ctx, storybookSnapshots, compressedStorybookDirectory);
-        output_1.default.exitSuccess(message);
+        const response = await sendStorybook(ctx, storybookSnapshots, compressedStorybookDirectory);
+        output_1.default.exitResult(json, response, response.message);
     }
     catch (error) {
         output_1.default.exitError(`${error}`);
@@ -134,14 +137,14 @@ function getStoriesList(storybookStoriesIndex) {
         output_1.default.exitError(texts_1.ERR_PARSING_STORIES);
     }
 }
-function getStorybookSnapshots(storiesList) {
+function getStorybookSnapshots(storiesList, say) {
     const stories = Object.entries(storiesList.entries)
         .filter(([, value]) => value.type === 'story')
         .map(([key, value]) => ({
         id: key,
         name: `${value.title}/${value.name}`,
     }));
-    output_1.default.normal((0, texts_1.TXT_STORIES_AMOUNT)(stories.length));
+    say((0, texts_1.TXT_STORIES_AMOUNT)(stories.length));
     return stories;
 }
 exports.default = commandVisualUpload;

package/distTs/src/command/tunnel/http.js

@@ -8,11 +8,13 @@ const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
 const commandHttp = (0, utils_1.getBasicCommandHttp)({
+    requiredScopes: [],
     examples: (0, texts_1.EXAMPLE_TUNNEL_HTTP)(false),
 });
 commandHttp.description(texts_1.DESC_COMMAND_HTTP);
 commandHttp.option('-s, --serve <directory>', texts_1.OPTION_SERVE);
 commandHttp.option('--token <token>', texts_1.OPTION_TOKEN);
+commandHttp.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandHttp.argument('[protocol://host:port]', texts_1.OPTION_TARGET);
 commandHttp.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
@@ -20,7 +22,9 @@ commandHttp.action(async (target, options) => {
     const Cfg = require('../../tunnel/cfg').default;
     const { host, token } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.HTTP, target, options, true);
-    await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
+    const jsonl = options.format === 'jsonl';
+    if (!jsonl)
+        await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
     const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
@@ -28,6 +32,6 @@ commandHttp.action(async (target, options) => {
     agent.startRefreshingConfiguration();
     const tunnel = await ApiBuddy.addTunnel(agent.id, agent.host, agent.token, prepared);
     agent.addTunnel(tunnel);
-    output_1.default.tunnel(tunnel);
+    output_1.default.tunnel(tunnel, jsonl);
 });
 exports.default = commandHttp;

package/distTs/src/command/tunnel/start.js

@@ -3,24 +3,29 @@ 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 output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const commandStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_START, {
+    requiredScopes: [],
     examples: texts_1.EXAMPLE_TUNNEL_START,
 });
 commandStart.option('--token <token>', texts_1.OPTION_TOKEN);
+commandStart.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandStart.argument('<name>', texts_1.OPTION_NAME);
 commandStart.action(async (name, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
     const Input = require('../../input').default;
     const Cfg = require('../../tunnel/cfg').default;
     if (!Cfg.hasTunnel(name)) {
-        output_1.default.exitError((0, texts_1.ERR_TUNNEL_NOT_FOUND)(name));
+        output_1.default.exitError(new cliError_1.default('not_found', (0, texts_1.ERR_TUNNEL_NOT_FOUND)(name), texts_1.HINT_TUNNEL_CONFIG_LIST));
     }
     const { token, host } = await Input.tunnelToken(options.token);
     const prepared = Cfg.getTunnel(name);
-    await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
+    const jsonl = options.format === 'jsonl';
+    if (!jsonl)
+        await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
     const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
@@ -28,6 +33,6 @@ commandStart.action(async (name, options) => {
     agent.startRefreshingConfiguration();
     const tunnel = await ApiBuddy.addTunnel(agent.id, agent.host, agent.token, prepared);
     agent.addTunnel(tunnel);
-    output_1.default.tunnel(tunnel);
+    output_1.default.tunnel(tunnel, jsonl);
 });
 exports.default = commandStart;

package/distTs/src/command/tunnel/tcp.js

@@ -7,9 +7,10 @@ const utils_1 = require("../../utils");
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
-const commandTcp = (0, utils_1.getBasicCommandTcp)({ examples: (0, texts_1.EXAMPLE_TUNNEL_TCP)(false) });
+const commandTcp = (0, utils_1.getBasicCommandTcp)({ requiredScopes: [], examples: (0, texts_1.EXAMPLE_TUNNEL_TCP)(false) });
 commandTcp.description(texts_1.DESC_COMMAND_TCP);
 commandTcp.option('--token <token>', texts_1.OPTION_TOKEN);
+commandTcp.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandTcp.argument('[host:port]', texts_1.OPTION_TARGET);
 commandTcp.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
@@ -17,7 +18,9 @@ commandTcp.action(async (target, options) => {
     const Cfg = require('../../tunnel/cfg').default;
     const { host, token } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.TCP, target, options, true);
-    await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
+    const jsonl = options.format === 'jsonl';
+    if (!jsonl)
+        await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
     const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
@@ -25,6 +28,6 @@ commandTcp.action(async (target, options) => {
     agent.startRefreshingConfiguration();
     const tunnel = await ApiBuddy.addTunnel(agent.id, agent.host, agent.token, prepared);
     agent.addTunnel(tunnel);
-    output_1.default.tunnel(tunnel);
+    output_1.default.tunnel(tunnel, jsonl);
 });
 exports.default = commandTcp;

package/distTs/src/command/tunnel/tls.js

@@ -7,9 +7,10 @@ const utils_1 = require("../../utils");
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
-const commandTls = (0, utils_1.getBasicCommandTls)({ examples: (0, texts_1.EXAMPLE_TUNNEL_TLS)(false) });
+const commandTls = (0, utils_1.getBasicCommandTls)({ requiredScopes: [], examples: (0, texts_1.EXAMPLE_TUNNEL_TLS)(false) });
 commandTls.description(texts_1.DESC_COMMAND_TLS);
 commandTls.option('--token <token>', texts_1.OPTION_TOKEN);
+commandTls.option('--format <text|jsonl>', texts_1.OPTION_FORMAT_JSONL);
 commandTls.argument('[host:port]', texts_1.OPTION_TARGET);
 commandTls.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
@@ -17,7 +18,9 @@ commandTls.action(async (target, options) => {
     const Cfg = require('../../tunnel/cfg').default;
     const { token, host } = await Input.tunnelToken(options.token);
     const prepared = await Cfg.prepareTunnel(tunnel_1.TUNNEL_TYPE.TLS, target, options, true);
-    await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
+    const jsonl = options.format === 'jsonl';
+    if (!jsonl)
+        await output_1.default.spinner(texts_1.TXT_OPENING_TUNNEL);
     const agent = await ApiBuddy.register(false, false, true, false, host, token, [], (0, utils_1.getCurrentUser)(), {}, (region) => {
         Cfg.setRegionIfNotSet(region);
     });
@@ -25,6 +28,6 @@ commandTls.action(async (target, options) => {
     agent.startRefreshingConfiguration();
     const tunnel = await ApiBuddy.addTunnel(agent.id, agent.host, agent.token, prepared);
     agent.addTunnel(tunnel);
-    output_1.default.tunnel(tunnel);
+    output_1.default.tunnel(tunnel, jsonl);
 });
 exports.default = commandTls;

package/distTs/src/command/version.js

@@ -7,7 +7,18 @@ const utils_1 = require("../utils");
 const output_1 = __importDefault(require("../output"));
 const utils_2 = require("../utils");
 const texts_1 = require("../texts");
+// set by the action; every install path below ends in updateMessage
+let json = false;
 const updateMessage = (currentVersion, latestVersion, instructions) => {
+    if (json) {
+        output_1.default.json({
+            current_version: currentVersion,
+            latest_version: latestVersion,
+            update_available: true,
+            instructions,
+        });
+        output_1.default.exitNormal();
+    }
     output_1.default.normal('Current version: ', false);
     output_1.default.gray(currentVersion);
     output_1.default.normal('Latest version: ', false);
@@ -72,10 +83,12 @@ const updateByDownload = (platform, currentVersion, latestVersion, env) => {
     }
     updateMessage(currentVersion, latestVersion, instructions);
 };
-const commandVersion = (0, utils_2.newCommand)('update', texts_1.DESC_COMMAND_UPDATE);
+const commandVersion = (0, utils_2.newCommand)('update', texts_1.DESC_COMMAND_UPDATE, { requiredScopes: [] });
 commandVersion.alias('version');
 commandVersion.hideVersionUpdate = true;
-commandVersion.action(async () => {
+commandVersion.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandVersion.action(async (options) => {
+    json = options.format === 'json';
     const currVersion = commandVersion.currentVersion || '';
     const lastVersion = commandVersion.latestVersion || '';
     const env = commandVersion.env || '';
@@ -114,6 +127,15 @@ commandVersion.action(async () => {
             return;
         }
     }
+    if (json) {
+        output_1.default.json({
+            current_version: currVersion,
+            latest_version: lastVersion || null,
+            update_available: false,
+            instructions: null,
+        });
+        output_1.default.exitNormal();
+    }
     output_1.default.exitNormal(currVersion);
 });
 exports.default = commandVersion;

package/distTs/src/command/whoami.js

@@ -8,7 +8,7 @@ const texts_1 = require("../texts");
 const output_1 = __importDefault(require("../output"));
 const input_1 = __importDefault(require("../input"));
 const cfg_1 = __importDefault(require("../project/cfg"));
-const commandWhoami = (0, utils_1.newCommand)('whoami', texts_1.DESC_COMMAND_WHOAMI);
+const commandWhoami = (0, utils_1.newCommand)('whoami', texts_1.DESC_COMMAND_WHOAMI, { requiredScopes: [utils_1.REST_API_SCOPE.USER_READ] });
 commandWhoami.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandWhoami.action(async (options) => {
     const { workspace, project, localWorkspace } = input_1.default.accountScope();

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

@@ -7,12 +7,17 @@ const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
-const commandWorkspaceGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_WORKSPACE_GET);
-commandWorkspaceGet.action(async () => {
+const commandWorkspaceGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_WORKSPACE_GET, { requiredScopes: [] });
+commandWorkspaceGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandWorkspaceGet.action(async (options) => {
     const { workspace } = input_1.default.accountScope();
     if (!workspace) {
         output_1.default.exitError(texts_1.TXT_WORKSPACE_NONE);
     }
+    if (options.format === 'json') {
+        output_1.default.json({ workspace });
+        output_1.default.exitNormal();
+    }
     output_1.default.exitNormal(workspace);
 });
 exports.default = commandWorkspaceGet;

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

@@ -7,7 +7,7 @@ const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const input_1 = __importDefault(require("../../input"));
-const commandWorkspaceList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_WORKSPACE_LIST);
+const commandWorkspaceList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_WORKSPACE_LIST, { requiredScopes: [utils_1.REST_API_SCOPE.WORKSPACE_READ] });
 commandWorkspaceList.alias('ls');
 commandWorkspaceList.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandWorkspaceList.action(async (options) => {

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

@@ -9,16 +9,18 @@ const input_1 = __importDefault(require("../../input"));
 const output_1 = __importDefault(require("../../output"));
 const cliError_1 = __importDefault(require("../../cliError"));
 const commandWorkspaceOpen = (0, utils_1.newCommand)('open', texts_1.DESC_COMMAND_RESOURCE_OPEN, {
+    requiredScopes: [utils_1.REST_API_SCOPE.WORKSPACE_READ],
     examples: [{ description: 'Open the current workspace in Buddy', command: 'bdy workspace open' }],
 });
+commandWorkspaceOpen.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandWorkspaceOpen.argument('[domain]', texts_1.OPTION_REST_API_WORKSPACE);
-commandWorkspaceOpen.action(async (domain) => {
+commandWorkspaceOpen.action(async (domain, options) => {
     const workspace = input_1.default.restApiWorkspace(domain);
     const client = input_1.default.restApiTokenClient();
     const response = await client.getWorkspaces();
     const found = response.workspaces.find((item) => item.domain === workspace);
     if (!found)
         throw new cliError_1.default('not_found', (0, texts_1.ERR_WORKSPACE_OPEN_NOT_FOUND)(workspace));
-    await output_1.default.openUrl(found.html_url);
+    await output_1.default.openUrl(found.html_url, options.format === 'json');
 });
 exports.default = commandWorkspaceOpen;

package/distTs/src/command/workspace/set.js

@@ -8,10 +8,11 @@ const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const input_1 = __importDefault(require("../../input"));
-const commandWorkspaceSet = (0, utils_1.newCommand)('set', texts_1.DESC_COMMAND_WORKSPACE_SET);
+const commandWorkspaceSet = (0, utils_1.newCommand)('set', texts_1.DESC_COMMAND_WORKSPACE_SET, { requiredScopes: [utils_1.REST_API_SCOPE.WORKSPACE_READ] });
 commandWorkspaceSet.usesDefaultContext = true;
 commandWorkspaceSet.argument('[workspace]', texts_1.ARG_COMMAND_WORKSPACE);
-commandWorkspaceSet.action(async (workspaceDomain) => {
+commandWorkspaceSet.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandWorkspaceSet.action(async (workspaceDomain, options) => {
     output_1.default.handleSignals();
     const client = input_1.default.restApiTokenClient();
     const response = await client.getWorkspaces();
@@ -30,6 +31,6 @@ commandWorkspaceSet.action(async (workspaceDomain) => {
         workspace = await output_1.default.selectWorkspace(response.workspaces);
     }
     cfg_1.default.setWorkspace(workspace);
-    output_1.default.exitSuccess((0, texts_1.TXT_WORKSPACE_SET_SUCCESS)(workspace));
+    output_1.default.exitResult(options.format === 'json', { workspace }, (0, texts_1.TXT_WORKSPACE_SET_SUCCESS)(workspace));
 });
 exports.default = commandWorkspaceSet;

package/distTs/src/command/yaml/actions/info.js

@@ -13,7 +13,7 @@ const render_1 = require("../render");
 async function suggestionLine(query) {
     return (await (0, schema_1.searchActions)(query, 5)).map((hit) => `${hit.type} (${hit.name})`);
 }
-const commandYamlActionsInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_YAML_ACTIONS_INFO, { examples: texts_1.EXAMPLE_YAML_ACTIONS_INFO });
+const commandYamlActionsInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_YAML_ACTIONS_INFO, { requiredScopes: [], examples: texts_1.EXAMPLE_YAML_ACTIONS_INFO });
 commandYamlActionsInfo.argument('<type>', texts_1.OPTION_ACTION_TYPE);
 commandYamlActionsInfo.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandYamlActionsInfo.action(async (type, options) => {

package/distTs/src/command/yaml/actions/list.js

@@ -26,7 +26,7 @@ function actionJson(actions, detectedTypes) {
         suggested: detectedTypes.has(action.type),
     }));
 }
-const commandYamlActionsList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_YAML_ACTIONS_LIST, { examples: texts_1.EXAMPLE_YAML_ACTIONS_LIST });
+const commandYamlActionsList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_YAML_ACTIONS_LIST, { requiredScopes: [], examples: texts_1.EXAMPLE_YAML_ACTIONS_LIST });
 commandYamlActionsList.alias('ls');
 commandYamlActionsList.option('-s, --search <query>', texts_1.OPTION_ACTION_SEARCH);
 commandYamlActionsList.option('--format <text|json>', texts_1.OPTION_FORMAT);

package/distTs/src/command/yaml/pipeline.js

@@ -9,6 +9,7 @@ const texts_1 = require("../../texts");
 const schemaUtils_1 = require("./schemaUtils");
 const render_1 = require("./render");
 const commandYamlPipeline = (0, utils_1.newCommand)('pipeline', texts_1.DESC_COMMAND_YAML_PIPELINE, {
+    requiredScopes: [],
     examples: texts_1.EXAMPLE_YAML_PIPELINE,
 });
 commandYamlPipeline.option('--format <text|json>', texts_1.OPTION_FORMAT);

package/distTs/src/command/yaml/validate.js

@@ -353,6 +353,7 @@ function validatePipelineFile(file, unions, json) {
     }
 }
 const commandYamlValidate = (0, utils_1.newCommand)('validate', texts_1.DESC_COMMAND_YAML_VALIDATE, {
+    requiredScopes: [],
     helpText: texts_1.HELP_YAML_VALIDATE_JSON,
     examples: texts_1.EXAMPLE_YAML_VALIDATE,
 });