bdy 1.25.13-stage → 1.25.14-dev

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.13-stage",
+  "version": "1.25.14-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",

package/distTs/src/agent/manager.js

@@ -55,7 +55,10 @@ class AgentManagerClass {
             this.system = new system_1.default();
         }
     }
-    start(id, host, token, port, onProcessExit = () => { }) {
+    // quiet keeps stdout for a result printed by onStarted once load() is
+    // through: the retry notices go to stderr instead
+    quiet = false;
+    start(id, host, token, port, onProcessExit = () => { }, onStarted = () => { }) {
         const onExit = () => {
             onProcessExit();
             this.shutdown();
@@ -66,7 +69,10 @@ class AgentManagerClass {
         // Anything load() throws would otherwise be an unhandled rejection: no entry in the
         // agent log, just a stack on stderr that a service swallows. Exit non-zero so the
         // supervisor still retries, but say why first.
-        this.load(id, host, token, port).catch((err) => {
+        this.load(id, host, token, port).then((started) => {
+            if (started)
+                onStarted();
+        }, (err) => {
             try {
                 logger_1.default.error(err);
             }
@@ -280,7 +286,11 @@ class AgentManagerClass {
                 const wait = Math.round(delay * (0.5 + Math.random() * 0.5));
                 this.status = tunnel_1.TUNNEL_AGENT_STATUS.FETCH_FAILED;
                 // One decimal, so the message never claims a delay it is not taking
-                output_1.default.normal((0, texts_1.AGENT_FETCH_RETRY)(Math.round(wait / 100) / 10));
+                const retry = (0, texts_1.AGENT_FETCH_RETRY)(Math.round(wait / 100) / 10);
+                if (this.quiet)
+                    output_1.default.note(retry);
+                else
+                    output_1.default.normal(retry);
                 await (0, utils_1.sleep)(wait);
                 delay = Math.min(delay * 2, utils_1.AGENT_FETCH_RETRY_MAX);
             }
@@ -817,6 +827,8 @@ class AgentManagerClass {
             return false;
         }
     }
+    // Resolves true once the agent is fetched and running, false when it is
+    // exiting instead (an update rollback, or a teardown that exits the process).
     async load(id, host, token, port) {
         this.status = tunnel_1.TUNNEL_AGENT_STATUS.INITIALIZING;
         this.id = id;
@@ -825,21 +837,22 @@ class AgentManagerClass {
         this.port = port;
         if (!this.id || !this.token || !this.host || !this.port) {
             await this.disableAgentAndExit(texts_1.ERR_AGENT_NOT_REGISTERED);
-            return;
+            return false;
         }
         const ok = this.resaveAgentConfig();
         if (!ok) {
             await this.disableAgentAndExit(texts_1.ERR_SAVING_AGENT_CONFIG);
-            return;
+            return false;
         }
         // A rolled back update leaves this process exiting: binding the port and opening
         // tunnels on the binary we just replaced would be pointless at best, and a fetch
         // that came back 'agent not found' in that window would unregister us for good.
         if (!this.checkUpdateProbation())
-            return;
+            return false;
         this.createServer();
         await this.tryFetch();
         logger_1.default.info(texts_1.LOG_AGENT_STARTED);
+        return true;
     }
 }
 exports.AgentManagerClass = AgentManagerClass;

package/distTs/src/agent/system.js

@@ -872,7 +872,9 @@ class AgentSystem {
             }, 100);
         });
     }
-    startStandaloneProc() {
+    // With quiet, stdout carries only what onStarted prints, and only once the
+    // agent is really running: a failure before that is the only output.
+    startStandaloneProc(quiet = false, onStarted = () => { }) {
         let json;
         try {
             json = this.loadSystemConfig();
@@ -901,12 +903,15 @@ class AgentSystem {
         }
         logger_1.default.changeRootPath(this.getNewAgentConfigDir());
         logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_STARTED);
-        output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_STARTED);
+        if (!quiet)
+            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_STARTED);
+        manager_1.default.quiet = quiet;
         manager_1.default.start(json.id, json.host, json.token, json.port, () => {
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_EXITING);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_EXITING);
+            if (!quiet)
+                output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_EXITING);
             this.clearStandaloneProcConfig();
-        });
+        }, onStarted);
     }
     clearStandaloneProcConfig() {
         try {

package/distTs/src/api/client.js

@@ -305,12 +305,23 @@ class ApiClient {
         });
     }
     async updatePipelineYml(workspace, project, pipelineId, body) {
-        return await this.request({
-            method: 'PATCH',
-            path: `/workspaces/${encodeURIComponent(workspace)}/projects/${encodeURIComponent(project)}/pipelines/${encodeURIComponent(pipelineId)}/yaml`,
-            body,
-            parseResponseBody: true,
-        });
+        try {
+            return await this.request({
+                method: 'PATCH',
+                path: `/workspaces/${encodeURIComponent(workspace)}/projects/${encodeURIComponent(project)}/pipelines/${encodeURIComponent(pipelineId)}/yaml`,
+                body,
+                parseResponseBody: true,
+            });
+        }
+        catch (err) {
+            // the API's YAML errors can be terse or leak server internals; the
+            // local validator explains the same problems
+            if (err instanceof cliError_1.default && err.code === 'usage_error' && !err.hint)
+                throw new cliError_1.default(err.code, err.message, texts_1.HINT_PIPELINE_YAML_VALIDATE, {
+                    cause: err,
+                });
+            throw err;
+        }
     }
     async createPipeline(workspace, project, body) {
         return await this.request({
@@ -928,6 +939,7 @@ class ApiClient {
                 on_owner_behalf: onOwnerBehalf,
                 auto_renew: autoRenew,
             },
+            parseResponseBody: true,
         });
     }
     async domainClaim(workspace, name, onOwnerBehalf = false) {
@@ -938,6 +950,7 @@ class ApiClient {
                 name,
                 on_owner_behalf: onOwnerBehalf,
             },
+            parseResponseBody: true,
         });
     }
     async domainSearch(workspace, domains) {
@@ -1297,7 +1310,7 @@ class ApiClient {
         // answering for a different scope than asked (TARGET_API_REQUIREMENTS.md
         // p6). project_identifier is present whenever the project exists.
         if (params.project && !resolved.project_identifier) {
-            throw new cliError_1.default('not_found', texts_1.ERR_PROJECT_NOT_FOUND);
+            throw new cliError_1.default('not_found', texts_1.ERR_PROJECT_NOT_FOUND, texts_1.HINT_PROJECT_LIST);
         }
         return resolved;
     }

package/distTs/src/cliCommand.js

@@ -40,6 +40,17 @@ const commander_1 = require("commander");
 const output_1 = __importDefault(require("./output"));
 const cliError_1 = __importStar(require("./cliError"));
 const texts_1 = require("./texts");
+// No command offers both json and jsonl, so the one it lacks is accepted as a
+// silent alias for the one it has.
+const normalizeFormat = (choices, value) => {
+    if (!choices || choices.includes(value))
+        return value;
+    if (value === 'json' && choices.includes('jsonl'))
+        return 'jsonl';
+    if (value === 'jsonl' && choices.includes('json'))
+        return 'json';
+    return value;
+};
 /** Command documentation shared by terminal help and machine discovery. */
 class CliCommand extends commander_1.Command {
     agentStatus;
@@ -71,6 +82,11 @@ class CliCommand extends commander_1.Command {
             if (choices?.every((value) => ['text', 'json', 'jsonl'].includes(value)))
                 option.choices(choices);
         }
+        const choices = option.argChoices;
+        if (option.long === '--format' && choices && option.parseArg) {
+            const parse = option.parseArg;
+            option.argParser((value, previous) => parse(normalizeFormat(choices, value), previous));
+        }
         return super.addOption(option);
     }
     parseOptions(args) {
@@ -132,7 +148,7 @@ class CliCommand extends commander_1.Command {
                 if (!(err instanceof commander_1.CommanderError))
                     throw err;
             }
-            const format = probe.opts().format;
+            const format = normalizeFormat(formatOption?.argChoices, probe.opts().format);
             if (formatOption?.argChoices?.includes(format) &&
                 (format === 'json' || format === 'jsonl'))
                 output_1.default.errorFormat = format;

package/distTs/src/cliIndex.js

@@ -81,10 +81,20 @@ function cliIndex() {
     // the action runs; let Commander report it as an unknown command instead,
     // with the did-you-mean suggestion and the JSON error format
     program.allowExcessArguments();
+    // the root has an action, so Commander would check options before commands
+    // and `bdy nope --format json` would fail on --format; defer the option
+    // check here so an unknown command is reported first
+    program.allowUnknownOption();
     program.action(() => {
-        if (program.args.length > 0) {
-            program.unknownCommand();
+        const root = program;
+        const [first] = program.args;
+        if (first?.startsWith('-')) {
+            // unknownOption is a no-op while unknown options are allowed
+            program.allowUnknownOption(false);
+            root.unknownOption(first);
         }
+        if (first)
+            root.unknownCommand();
         program.help();
     });
     return program;

package/distTs/src/command/agent/debug.js

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
-const commandAgentDebug = (0, utils_1.newCommand)('debug', texts_1.DESC_COMMAND_AGENT_DEBUG);
+const commandAgentDebug = (0, utils_1.newCommand)('debug', texts_1.DESC_COMMAND_AGENT_DEBUG, { requiredScopes: [] });
 commandAgentDebug.argument('<on/off>');
-commandAgentDebug.action(async (debug) => {
+commandAgentDebug.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentDebug.action(async (debug, options) => {
     const AgentManager = require('../../agent/manager').default;
     const ApiAgent = require('../../tunnel/api/agent').default;
     const hasRights = await AgentManager.system.hasRightsToManage();
@@ -27,7 +28,7 @@ commandAgentDebug.action(async (debug) => {
         const api = new ApiAgent(json.port);
         await api.debugChange(debugOn);
         AgentManager.system.saveSystemConfig(json.id, json.host, json.token, json.port, !!json.standalone, debugOn);
-        output_1.default.exitSuccess(debugOn ? texts_1.TXT_AGENT_DEBUG_ON : texts_1.TXT_AGENT_DEBUG_OFF);
+        output_1.default.exitResult(options.format === 'json', { debug: debugOn }, debugOn ? texts_1.TXT_AGENT_DEBUG_ON : texts_1.TXT_AGENT_DEBUG_OFF);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/disable.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
-const commandAgentDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_DISABLE);
-commandAgentDisable.action(async () => {
+const commandAgentDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_DISABLE, { requiredScopes: [] });
+commandAgentDisable.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentDisable.action(async (options) => {
     const ApiAgent = require('../../tunnel/api/agent').default;
     if (!commandAgentDisable.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,7 +19,7 @@ commandAgentDisable.action(async () => {
     try {
         const api = new ApiAgent(commandAgentDisable.agentPort || 0);
         await api.disableAgent();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_STOPPED);
+        output_1.default.exitResult(options.format === 'json', { enabled: false }, texts_1.TXT_AGENT_STOPPED);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/enable.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
-const commandAgentEnable = (0, utils_1.newCommand)('enable', texts_1.DESC_COMMAND_AGENT_ENABLE);
-commandAgentEnable.action(async () => {
+const commandAgentEnable = (0, utils_1.newCommand)('enable', texts_1.DESC_COMMAND_AGENT_ENABLE, { requiredScopes: [] });
+commandAgentEnable.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentEnable.action(async (options) => {
     const ApiAgent = require('../../tunnel/api/agent').default;
     if (!commandAgentEnable.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,7 +19,7 @@ commandAgentEnable.action(async () => {
     try {
         const api = new ApiAgent(commandAgentEnable.agentPort || 0);
         await api.enableAgent();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_STARTED);
+        output_1.default.exitResult(options.format === 'json', { enabled: true }, texts_1.TXT_AGENT_STARTED);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/install.js

@@ -52,6 +52,13 @@ const isPortFree = (port) => new Promise((resolve) => {
         srv.close(() => resolve(true));
     });
 });
+// --format json result: the installed agent's identity, never its token
+const installedResult = (options, id, port, standalone) => ({
+    id,
+    port,
+    standalone,
+    started: !!options.start,
+});
 const prepareTags = (tags) => {
     const validTags = [];
     if (tags) {
@@ -126,7 +133,8 @@ const installService = async (options) => {
     catch {
         // do nothing
     }
-    await output_1.default.spinner(texts_1.TXT_ENABLING_AGENT);
+    if (options.format !== 'json')
+        await output_1.default.spinner(texts_1.TXT_ENABLING_AGENT);
     try {
         await AgentManager.system.install(id, host, agentToken, port, !!options.start, options.user, options.pass);
     }
@@ -138,7 +146,7 @@ const installService = async (options) => {
         await waitUntilAgentEnabled(api, 15000, () => {
             removeAllAndExit(texts_1.ERR_SWW_AGENT_ENABLING, id, host, agentToken);
         }, () => {
-            output_1.default.exitSuccess(texts_1.TXT_AGENT_INSTALLED);
+            output_1.default.exitResult(options.format === 'json', installedResult(options, id, port, false), texts_1.TXT_AGENT_INSTALLED);
         });
     }
     else {
@@ -148,7 +156,7 @@ const installService = async (options) => {
         catch {
             // do nothing
         }
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_INSTALLED);
+        output_1.default.exitResult(options.format === 'json', installedResult(options, id, port, false), texts_1.TXT_AGENT_INSTALLED);
     }
 };
 const installApp = async (options) => {
@@ -167,12 +175,13 @@ const installApp = async (options) => {
         addToken = '';
     }
     const { token, host } = await input_1.default.tunnelToken(addToken);
+    const say = output_1.default.progress(options.format === 'json');
     if (!id) {
         const tags = prepareTags(options.tag);
         const note = options.note;
         const agentNote = options.agentNote;
         try {
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERING, false);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERING, false);
             const agent = await ApiBuddy.register(true, !!options.target, !!options.tunnels, !!options.proxy, host, token, tags, (0, utils_1.getCurrentUser)(), {
                 note,
                 agentNote,
@@ -180,14 +189,14 @@ const installApp = async (options) => {
                 cfg_1.default.setRegionIfNotSet(region);
             });
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERED);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERED);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTERED);
             id = agent.id;
             agentToken = agent.token;
             agent.destroy();
         }
         catch (err) {
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTER_ERROR);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTER_ERROR);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_REGISTER_ERROR);
             logger_1.default.error(err);
             output_1.default.exitError(err);
         }
@@ -195,15 +204,15 @@ const installApp = async (options) => {
     else {
         try {
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHING);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHING, false);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHING, false);
             const agent = await ApiBuddy.fetchAgent(id, host, agentToken);
             agent.destroy();
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHED);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHED);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCHED);
         }
         catch (err) {
             logger_1.default.info(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCH_ERROR);
-            output_1.default.normal(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCH_ERROR);
+            say(texts_1.TXT_AGENT_STANDALONE_AGENT_FETCH_ERROR);
             logger_1.default.error(err);
             output_1.default.exitError(err);
         }
@@ -213,7 +222,13 @@ const installApp = async (options) => {
         output_1.default.exitError(texts_1.ERR_SWW_AGENT_ENABLING);
     }
     if (options.start) {
-        AgentManager.system.startStandaloneProc();
+        // the standalone agent keeps running in this process: the result is
+        // printed once it is fetched and started, so a failure is the only output
+        const json = options.format === 'json';
+        AgentManager.system.startStandaloneProc(json, () => {
+            if (json)
+                output_1.default.json(installedResult(options, id, port, true));
+        });
     }
     else {
         try {
@@ -222,10 +237,10 @@ const installApp = async (options) => {
         catch {
             // do nothing
         }
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_INSTALLED);
+        output_1.default.exitResult(options.format === 'json', installedResult(options, id, port, true), texts_1.TXT_AGENT_INSTALLED);
     }
 };
-const commandAgentInstall = (0, utils_1.newCommand)('install', texts_1.DESC_COMMAND_AGENT_INSTALL);
+const commandAgentInstall = (0, utils_1.newCommand)('install', texts_1.DESC_COMMAND_AGENT_INSTALL, { requiredScopes: [] });
 commandAgentInstall.option('-s, --start [true|false]', texts_1.OPTION_AGENT_START, 'true');
 commandAgentInstall.option('-i, --id <id>', texts_1.OPTION_AGENT_ID);
 commandAgentInstall.option('-t, --token <token>', texts_1.OPTION_AGENT_TOKEN);
@@ -240,6 +255,7 @@ commandAgentInstall.option('--tag <tag...>', texts_1.OPTION_AGENT_TAG);
 commandAgentInstall.option('-d, --debug', texts_1.OPTION_AGENT_DEBUG);
 commandAgentInstall.option('--note <note>', texts_1.OPT_COMMAND_NOTE);
 commandAgentInstall.option('--agent-note <note>', texts_1.OPT_COMMAND_AGENT_NOTE);
+commandAgentInstall.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandAgentInstall.action(async (options) => {
     const AgentManager = require('../../agent/manager').default;
     options.start = options.start === 'true' || options.start === true;

package/distTs/src/command/agent/proxy/disable.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentProxyDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_PROXY_DISABLE);
-commandAgentProxyDisable.action(async () => {
+const commandAgentProxyDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_PROXY_DISABLE, { requiredScopes: [] });
+commandAgentProxyDisable.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentProxyDisable.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentProxyDisable.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,7 +19,7 @@ commandAgentProxyDisable.action(async () => {
     try {
         const api = new ApiAgent(commandAgentProxyDisable.agentPort || 0);
         await api.disableAgentProxy();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_PROXY_DISABLED);
+        output_1.default.exitResult(options.format === 'json', { proxy: false }, texts_1.TXT_AGENT_PROXY_DISABLED);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/proxy/enable.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentProxyEnable = (0, utils_1.newCommand)('enable', texts_1.DESC_COMMAND_AGENT_PROXY_ENABLE);
-commandAgentProxyEnable.action(async () => {
+const commandAgentProxyEnable = (0, utils_1.newCommand)('enable', texts_1.DESC_COMMAND_AGENT_PROXY_ENABLE, { requiredScopes: [] });
+commandAgentProxyEnable.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentProxyEnable.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentProxyEnable.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,7 +19,7 @@ commandAgentProxyEnable.action(async () => {
     try {
         const api = new ApiAgent(commandAgentProxyEnable.agentPort || 0);
         await api.enableAgentProxy();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_TARGET_ENABLED);
+        output_1.default.exitResult(options.format === 'json', { proxy: true }, texts_1.TXT_AGENT_PROXY_ENABLED);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/proxy/status.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentProxyStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_PROXY_STATUS, { examples: texts_1.EXAMPLE_AGENT_PROXY_STATUS });
+const commandAgentProxyStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_PROXY_STATUS, { requiredScopes: [], examples: texts_1.EXAMPLE_AGENT_PROXY_STATUS });
 commandAgentProxyStatus.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandAgentProxyStatus.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;

package/distTs/src/command/agent/restart.js

@@ -7,8 +7,10 @@ const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const logger_1 = __importDefault(require("../../logger"));
-const commandAgentRestart = (0, utils_1.newCommand)('restart', texts_1.DESC_COMMAND_AGENT_RESTART);
-commandAgentRestart.action(async () => {
+const commandAgentRestart = (0, utils_1.newCommand)('restart', texts_1.DESC_COMMAND_AGENT_RESTART, { requiredScopes: [] });
+commandAgentRestart.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentRestart.action(async (options) => {
+    const json = options.format === 'json';
     const AgentManager = require('../../agent/manager').default;
     const hasRights = await AgentManager.system.hasRightsToManage();
     if (!hasRights) {
@@ -19,14 +21,20 @@ commandAgentRestart.action(async () => {
     }
     if (commandAgentRestart.agentStandalone) {
         await AgentManager.system.killStandaloneProc();
-        AgentManager.system.startStandaloneProc();
+        // the standalone agent keeps running in this process: the result is
+        // printed once it is fetched and started, so a failure is the only output
+        AgentManager.system.startStandaloneProc(json, () => {
+            if (json)
+                output_1.default.json({ running: true });
+        });
     }
     else {
         try {
             await AgentManager.system.stop();
-            output_1.default.normal(texts_1.TXT_AGENT_STOPPED);
+            if (!json)
+                output_1.default.normal(texts_1.TXT_AGENT_STOPPED);
             await AgentManager.system.start();
-            output_1.default.exitSuccess(texts_1.TXT_AGENT_RESTARTED);
+            output_1.default.exitResult(json, { running: true }, texts_1.TXT_AGENT_RESTARTED);
         }
         catch (err) {
             logger_1.default.error(err);

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

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
-const commandAgentStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_AGENT_START);
-commandAgentStart.action(async () => {
+const commandAgentStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_AGENT_START, { requiredScopes: [] });
+commandAgentStart.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentStart.action(async (options) => {
     const AgentManager = require('../../agent/manager').default;
     const logger = require('../../logger').default;
     const hasRights = await AgentManager.system.hasRightsToManage();
@@ -19,12 +20,18 @@ commandAgentStart.action(async () => {
     }
     if (commandAgentStart.agentStandalone) {
         await AgentManager.system.killStandaloneProc();
-        AgentManager.system.startStandaloneProc();
+        // the standalone agent keeps running in this process: the result is
+        // printed once it is fetched and started, so a failure is the only output
+        const json = options.format === 'json';
+        AgentManager.system.startStandaloneProc(json, () => {
+            if (json)
+                output_1.default.json({ running: true });
+        });
     }
     else {
         try {
             await AgentManager.system.start();
-            output_1.default.exitSuccess(texts_1.TXT_AGENT_STARTED);
+            output_1.default.exitResult(options.format === 'json', { running: true }, texts_1.TXT_AGENT_STARTED);
         }
         catch (err) {
             logger.error(err);

package/distTs/src/command/agent/status.js

@@ -8,7 +8,7 @@ const node_fs_1 = require("node:fs");
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
 const tunnel_1 = require("../../types/tunnel");
-const commandAgentStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_STATUS, { examples: texts_1.EXAMPLE_AGENT_STATUS, helpText: texts_1.HELP_AGENT_STATUS_JSON });
+const commandAgentStatus = (0, utils_1.newCommand)('status', texts_1.DESC_COMMAND_AGENT_STATUS, { requiredScopes: [], examples: texts_1.EXAMPLE_AGENT_STATUS, helpText: texts_1.HELP_AGENT_STATUS_JSON });
 const outputStatus = (installed, standalone, version, id, running, enabled, target, tunneling, proxy, status, json) => {
     const AgentManager = require('../../agent/manager').default;
     if (!installed) {

package/distTs/src/command/agent/stop.js

@@ -7,8 +7,9 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const output_1 = __importDefault(require("../../output"));
 const logger_1 = __importDefault(require("../../logger"));
-const commandAgentStop = (0, utils_1.newCommand)('stop', texts_1.DESC_COMMAND_AGENT_STOP);
-commandAgentStop.action(async () => {
+const commandAgentStop = (0, utils_1.newCommand)('stop', texts_1.DESC_COMMAND_AGENT_STOP, { requiredScopes: [] });
+commandAgentStop.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentStop.action(async (options) => {
     const AgentManager = require('../../agent/manager').default;
     const ApiAgent = require('../../tunnel/api/agent').default;
     const hasRights = await AgentManager.system.hasRightsToManage();
@@ -27,12 +28,12 @@ commandAgentStop.action(async () => {
     }
     if (commandAgentStop.agentStandalone) {
         await AgentManager.system.killStandaloneProc();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_STOPPED);
+        output_1.default.exitResult(options.format === 'json', { running: false }, texts_1.TXT_AGENT_STOPPED);
     }
     else {
         try {
             await AgentManager.system.stop();
-            output_1.default.exitSuccess(texts_1.TXT_AGENT_STOPPED);
+            output_1.default.exitResult(options.format === 'json', { running: false }, texts_1.TXT_AGENT_STOPPED);
         }
         catch (err) {
             logger_1.default.error(err);

package/distTs/src/command/agent/tags/get.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentTagsGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_AGENT_TAGS_GET, { examples: texts_1.EXAMPLE_AGENT_TAGS_GET });
+const commandAgentTagsGet = (0, utils_1.newCommand)('get', texts_1.DESC_COMMAND_AGENT_TAGS_GET, { requiredScopes: [], examples: texts_1.EXAMPLE_AGENT_TAGS_GET });
 commandAgentTagsGet.option('--format <text|json>', texts_1.OPTION_FORMAT);
 commandAgentTagsGet.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;

package/distTs/src/command/agent/tags/set.js

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentTagsSet = (0, utils_1.newCommand)('set', texts_1.DESC_COMMAND_AGENT_TAGS_SET);
+const commandAgentTagsSet = (0, utils_1.newCommand)('set', texts_1.DESC_COMMAND_AGENT_TAGS_SET, { requiredScopes: [] });
 commandAgentTagsSet.argument('[tags...]', texts_1.OPT_COMMAND_AGENT_TAGS_SET);
-commandAgentTagsSet.action(async (tags) => {
+commandAgentTagsSet.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTagsSet.action(async (tags, options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentTagsSet.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -29,7 +30,7 @@ commandAgentTagsSet.action(async (tags) => {
     try {
         const api = new ApiAgent(commandAgentTagsSet.agentPort || 0);
         await api.setAgentTags(validTags);
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_TAGS_SET);
+        output_1.default.exitResult(options.format === 'json', { tags: validTags }, texts_1.TXT_AGENT_TAGS_SET);
     }
     catch (err) {
         output_1.default.exitError(err);

package/distTs/src/command/agent/target/disable.js

@@ -6,8 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../../utils");
 const texts_1 = require("../../../texts");
 const output_1 = __importDefault(require("../../../output"));
-const commandAgentTargetDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_TARGET_DISABLE);
-commandAgentTargetDisable.action(async () => {
+const commandAgentTargetDisable = (0, utils_1.newCommand)('disable', texts_1.DESC_COMMAND_AGENT_TARGET_DISABLE, { requiredScopes: [] });
+commandAgentTargetDisable.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandAgentTargetDisable.action(async (options) => {
     const ApiAgent = require('../../../tunnel/api/agent').default;
     if (!commandAgentTargetDisable.agentInstalled) {
         output_1.default.exitError(texts_1.ERR_AGENT_NOT_INSTALLED);
@@ -18,7 +19,7 @@ commandAgentTargetDisable.action(async () => {
     try {
         const api = new ApiAgent(commandAgentTargetDisable.agentPort || 0);
         await api.disableAgentTarget();
-        output_1.default.exitSuccess(texts_1.TXT_AGENT_TARGET_DISABLED);
+        output_1.default.exitResult(options.format === 'json', { target: false }, texts_1.TXT_AGENT_TARGET_DISABLED);
     }
     catch (err) {
         output_1.default.exitError(err);