bdy 1.25.2-stage → 1.25.4-dev

package/distTs/src/utils.js

@@ -36,9 +36,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TARGET_TCP_TLS_REGEX = exports.ApiErrorTunnelsDisabled = exports.ApiErrorWorkspaceFlagged = exports.ApiErrorTunnelLimitReached = exports.ApiErrorAgentLimitReached = exports.ApiErrorDomainRestricted = exports.ApiErrorTargetInvalid = exports.ApiErrorWrongToken = exports.ApiErrorFailedToConnect = exports.ApiErrorAgentNotFound = exports.ARTIFACT_AUTH_TYPE = exports.TARGET_EXEC_STATUS = exports.TARGET_SCOPE = exports.ARTIFACT_TYPE = exports.SANDBOX_SNAPSHOT_STATUS = exports.SANDBOX_APP_STATUS = exports.SANDBOX_SETUP_STATUS = exports.SANDBOX_EXEC_STATUS = exports.SANDBOX_EXEC_RUNTIME = exports.SANDBOX_STATUS = exports.REST_API_ENDPOINT = exports.REST_API_REGION = exports.DEFAULT_SANDBOX_CP_USER = exports.ARTIFACT_DEFAULT_VERSION = exports.SUGGESTED_BROWSER_VERSION = exports.AGENT_UPDATE_STATUS_TTL_MS = exports.AGENT_UPDATE_PROBATION_MS = exports.AGENT_UPDATE_MAX_ATTEMPTS = exports.AGENT_FETCH_RETRY_MAX = exports.AGENT_FETCH_RETRY_MIN = exports.SSH_HANDSHAKE_TIMEOUT = exports.DEFAULT_TIMEOUT = exports.getSshIdent = exports.TUNNEL_SSH_IDENT_SHARED_H1 = exports.TUNNEL_SSH_IDENT_SHARED_H2 = exports.TUNNEL_CLIENT_IP_HEADER = exports.TUNNEL_H2_WINDOW_SIZE = exports.TUNNEL_HTTP2_SHED_LOG_INTERVAL = exports.TUNNEL_HTTP2_MAX_SESSIONS = exports.TUNNEL_HTTP1_CHANNEL_KEEPALIVE = exports.TUNNEL_HTTP2_SESSION_IDLE_TIMEOUT = exports.TUNNEL_HTTP_RETRY_AFTER = exports.TUNNEL_HTTP_MAX_INFLIGHT = exports.TUNNEL_HTTP_CB_MIN_REQUESTS = exports.TUNNEL_HTTP_CB_WINDOW = exports.TUNNEL_MAX_REQUEST_SIZE_TO_SYNC = exports.TUNNEL_HTTP_LOG_MAX_REQUESTS = exports.TUNNEL_HTTP_LOG_MAX_BODY = exports.TUNNEL_HTTP_RATE_WINDOW = exports.TUNNEL_HTTP_RATE_LIMIT = void 0;
-exports.filterIgnoredEntries = exports.parseIgnorePatterns = exports.ARTIFACT_IGNORE_DEFAULT = exports.createZip = exports.getGitName = exports.getGitEmail = exports.MCP_TOOL_CATEGORIES = exports.getBasicCommandTls = exports.getBasicCommandHttp = exports.getBasicCommandSandboxEndpoint = exports.getBasicCommandTcp = exports.getCurrentUser = exports.getServiceUser = exports.getRealTargetHost = exports.isWindows = exports.isLinux = exports.isOsx = exports.isDocker = exports.truncate = exports.sleep = exports.getLatestVersion = exports.getVersionEnv = exports.getCurrentVersionWithoutEnv = exports.isVersionNewer = exports.getVersionWithoutEnv = exports.parseVersion = exports.getVersion = exports.isInstalledByChoco = exports.isInstalledByApt = exports.isInstalledByBrew = exports.isInstalledByNpm = exports.isNpmGlobalWritable = exports.isPathWritable = exports.tryGetEmail = exports.execLocally = exports.getHomeDirectory = exports.HOME_DIR_NAME = exports.chownToHomeOwner = exports.isDomainAvailable = exports.sandboxScopeOptions = exports.newCommand = exports.formatBytes = exports.formatHelp = exports.getPlatform = exports.getHostname = exports.isStringRegExp = exports.getWorkingDir = exports.getRootDir = exports.TARGET_ONLY_PORT_REGEX = exports.TARGET_HTTP_REGEX = void 0;
-exports.findArtifactReadme = exports.isPathInside = exports.getComposerReadmePath = exports.parseComposerJson = exports.ARTIFACT_README_NAMES = exports.ARTIFACT_README_SIZE_LIMIT = void 0;
+exports.ApiErrorTunnelsDisabled = exports.ApiErrorWorkspaceFlagged = exports.ApiErrorTunnelLimitReached = exports.ApiErrorAgentLimitReached = exports.ApiErrorDomainRestricted = exports.ApiErrorTargetInvalid = exports.ApiErrorWrongToken = exports.ApiErrorFailedToConnect = exports.ApiErrorAgentNotFound = exports.ARTIFACT_AUTH_TYPE = exports.TARGET_EXEC_STATUS = exports.TARGET_SCOPE = exports.ARTIFACT_TYPE = exports.SANDBOX_SNAPSHOT_STATUS = exports.SANDBOX_APP_STATUS = exports.SANDBOX_SETUP_STATUS = exports.SANDBOX_EXEC_STATUS = exports.SANDBOX_EXEC_RUNTIME = exports.SANDBOX_STATUS = exports.REST_API_ENDPOINT = exports.REST_API_REGION = exports.DEFAULT_SANDBOX_CP_USER = exports.ARTIFACT_DEFAULT_VERSION = exports.SUGGESTED_BROWSER_VERSION = exports.AGENT_UPDATE_STATUS_TTL_MS = exports.AGENT_UPDATE_PROBATION_MS = exports.AGENT_UPDATE_MAX_ATTEMPTS = exports.AGENT_FETCH_RETRY_MAX = exports.AGENT_FETCH_RETRY_MIN = exports.SSH_HANDSHAKE_TIMEOUT = exports.DEFAULT_TIMEOUT = exports.getSshIdent = exports.TUNNEL_SSH_IDENT_SHARED_H1 = exports.TUNNEL_SSH_IDENT_SHARED_H2 = exports.TUNNEL_CLIENT_IP_HEADER = exports.TUNNEL_H2_WINDOW_SIZE = exports.TUNNEL_HTTP2_SHED_LOG_INTERVAL = exports.TUNNEL_HTTP2_MAX_SESSIONS = exports.TUNNEL_HTTP1_CHANNEL_KEEPALIVE = exports.TUNNEL_HTTP2_SESSION_IDLE_TIMEOUT = exports.TUNNEL_HTTP_RETRY_AFTER = exports.TUNNEL_HTTP_MAX_INFLIGHT = exports.TUNNEL_HTTP_CB_MIN_REQUESTS = exports.TUNNEL_HTTP_CB_WINDOW = exports.TUNNEL_MAX_REQUEST_SIZE_TO_SYNC = exports.TUNNEL_HTTP_LOG_MAX_REQUESTS = exports.TUNNEL_HTTP_LOG_MAX_BODY = exports.TUNNEL_HTTP_RATE_WINDOW = exports.TUNNEL_HTTP_RATE_LIMIT = exports.REST_API_SCOPE = void 0;
+exports.parseIgnorePatterns = exports.ARTIFACT_IGNORE_DEFAULT = exports.createZip = exports.getGitName = exports.getGitEmail = exports.MCP_TOOL_CATEGORIES = exports.getBasicCommandTls = exports.getBasicCommandHttp = exports.getBasicCommandSandboxEndpoint = exports.getBasicCommandTcp = exports.getCurrentUser = exports.getServiceUser = exports.getRealTargetHost = exports.isWindows = exports.isLinux = exports.isOsx = exports.isDocker = exports.truncate = exports.sleep = exports.getLatestVersion = exports.getVersionEnv = exports.getCurrentVersionWithoutEnv = exports.isVersionNewer = exports.getVersionWithoutEnv = exports.parseVersion = exports.getVersion = exports.isInstalledByChoco = exports.isInstalledByApt = exports.isInstalledByBrew = exports.isInstalledByNpm = exports.isNpmGlobalWritable = exports.isPathWritable = exports.tryGetEmail = exports.execLocally = exports.getHomeDirectory = exports.HOME_DIR_NAME = exports.chownToHomeOwner = exports.isDomainAvailable = exports.sandboxScopeOptions = exports.newCommand = exports.formatBytes = exports.formatHelp = exports.getPlatform = exports.getHostname = exports.isStringRegExp = exports.getWorkingDir = exports.getRootDir = exports.TARGET_ONLY_PORT_REGEX = exports.TARGET_HTTP_REGEX = exports.TARGET_TCP_TLS_REGEX = void 0;
+exports.findArtifactReadme = exports.isPathInside = exports.getComposerReadmePath = exports.parseComposerJson = exports.ARTIFACT_README_NAMES = exports.ARTIFACT_README_SIZE_LIMIT = exports.filterIgnoredEntries = void 0;
 exports.apiErrorCodeToClass = apiErrorCodeToClass;
 exports.isFile = isFile;
 exports.getAppWorkspaceUrl = getAppWorkspaceUrl;
@@ -67,10 +67,23 @@ const node_path_1 = __importDefault(require("node:path"));
 const node_fs_1 = __importStar(require("node:fs"));
 const texts_1 = require("./texts");
 const node_sea_1 = require("node:sea");
-const commander_1 = require("commander");
+const cliCommand_1 = __importDefault(require("./cliCommand"));
 const node_os_1 = __importStar(require("node:os"));
 const node_child_process_1 = require("node:child_process");
 const tunnel_1 = require("./types/tunnel");
+var REST_API_SCOPE;
+(function (REST_API_SCOPE) {
+    REST_API_SCOPE["ARTIFACT_MANAGE"] = "ARTIFACT_MANAGE";
+    REST_API_SCOPE["ARTIFACT_READ"] = "ARTIFACT_READ";
+    REST_API_SCOPE["ARTIFACT_WRITE"] = "ARTIFACT_WRITE";
+    REST_API_SCOPE["DISTRIBUTION_MANAGE"] = "DISTRIBUTION_MANAGE";
+    REST_API_SCOPE["DISTRIBUTION_READ"] = "DISTRIBUTION_READ";
+    REST_API_SCOPE["DISTRIBUTION_WRITE"] = "DISTRIBUTION_WRITE";
+    REST_API_SCOPE["PIPELINE_MANAGE"] = "PIPELINE_MANAGE";
+    REST_API_SCOPE["PIPELINE_READ"] = "PIPELINE_READ";
+    REST_API_SCOPE["PIPELINE_RUN"] = "PIPELINE_RUN";
+    REST_API_SCOPE["PIPELINE_WRITE"] = "PIPELINE_WRITE";
+})(REST_API_SCOPE || (exports.REST_API_SCOPE = REST_API_SCOPE = {}));
 exports.TUNNEL_HTTP_RATE_LIMIT = 2000;
 exports.TUNNEL_HTTP_RATE_WINDOW = 60000;
 exports.TUNNEL_HTTP_LOG_MAX_BODY = 5242880; // 5MB
@@ -376,7 +389,15 @@ const formatHelp = (cmd, helper) => {
     // Usage
     let output = ['USAGE:', `  ${helper.commandUsage(cmd)}`, ''];
     // Description
-    const commandDescription = helper.commandDescription(cmd);
+    const describe = (command, description) => {
+        if (!(command instanceof cliCommand_1.default))
+            return description;
+        const scopes = command.requiredScopes;
+        return scopes?.length
+            ? `${description} ${texts_1.TXT_API_ENDPOINT_REQUIRED_SCOPES}: ${scopes.join(', ')}`.trim()
+            : description;
+    };
+    const commandDescription = describe(cmd, helper.commandDescription(cmd));
     if (commandDescription.length > 0) {
         output = output.concat([
             'DESCRIPTION:',
@@ -402,12 +423,20 @@ const formatHelp = (cmd, helper) => {
     }
     // Commands
     const commandList = helper.visibleCommands(cmd).map((cmd) => {
-        return formatItem(helper.subcommandTerm(cmd), helper.subcommandDescription(cmd));
+        return formatItem(helper.subcommandTerm(cmd), describe(cmd, helper.subcommandDescription(cmd)));
     });
     if (commandList.length > 0) {
         output = output.concat(['COMMANDS:', formatList(commandList), '']);
     }
-    return output.join('\n');
+    let help = output.join('\n');
+    if (cmd instanceof cliCommand_1.default) {
+        if (cmd.examples.length) {
+            help += `\n${texts_1.TXT_COMMAND_EXAMPLES}\n${cmd.examples.map((example) => `  ### ${example.description}\n  ${example.command}`).join('\n')}\n`;
+        }
+        if (cmd.metadata.helpText)
+            help += `${cmd.metadata.helpText}\n`;
+    }
+    return help;
 };
 exports.formatHelp = formatHelp;
 const formatBytes = (bytes) => {
@@ -423,8 +452,8 @@ const formatBytes = (bytes) => {
     return `${bytes}GB`;
 };
 exports.formatBytes = formatBytes;
-const newCommand = (name, desc) => {
-    const cmd = new commander_1.Command(name);
+const newCommand = (name, desc, metadata) => {
+    const cmd = new cliCommand_1.default(name, metadata);
     if (desc)
         cmd.description(desc);
     cmd.configureHelp({
@@ -782,8 +811,8 @@ const getCurrentUser = () => {
     return node_os_1.default.userInfo().username;
 };
 exports.getCurrentUser = getCurrentUser;
-const getBasicCommandTcp = () => {
-    const commandTcp = (0, exports.newCommand)('tcp');
+const getBasicCommandTcp = (metadata) => {
+    const commandTcp = (0, exports.newCommand)('tcp', undefined, metadata);
     commandTcp.alias('TCP');
     commandTcp.option('-r, --region <region>', texts_1.OPTION_REGION);
     commandTcp.option('-w, --whitelist <cidrs...>', texts_1.OPTION_WHITELIST);
@@ -794,8 +823,8 @@ const getBasicCommandTcp = () => {
     return commandTcp;
 };
 exports.getBasicCommandTcp = getBasicCommandTcp;
-const getBasicCommandSandboxEndpoint = (name, desc) => {
-    const command = (0, exports.newCommand)(name, desc);
+const getBasicCommandSandboxEndpoint = (name, desc, metadata) => {
+    const command = (0, exports.newCommand)(name, desc, metadata);
     // No short `-e` here: this command already uses it for `--endpoint`.
     (0, exports.sandboxScopeOptions)(command, false);
     command.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
@@ -824,8 +853,8 @@ const getBasicCommandSandboxEndpoint = (name, desc) => {
     return command;
 };
 exports.getBasicCommandSandboxEndpoint = getBasicCommandSandboxEndpoint;
-const getBasicCommandHttp = () => {
-    const commandHttp = (0, exports.newCommand)('http');
+const getBasicCommandHttp = (metadata) => {
+    const commandHttp = (0, exports.newCommand)('http', undefined, metadata);
     commandHttp.alias('HTTP');
     commandHttp.option('-r, --region <region>', texts_1.OPTION_REGION);
     commandHttp.option('-w, --whitelist <cidrs...>', texts_1.OPTION_WHITELIST);
@@ -848,8 +877,8 @@ const getBasicCommandHttp = () => {
     return commandHttp;
 };
 exports.getBasicCommandHttp = getBasicCommandHttp;
-const getBasicCommandTls = () => {
-    const commandTls = (0, exports.newCommand)('tls');
+const getBasicCommandTls = (metadata) => {
+    const commandTls = (0, exports.newCommand)('tls', undefined, metadata);
     commandTls.alias('TLS');
     commandTls.option('-r, --region <region>', texts_1.OPTION_REGION);
     commandTls.option('-w, --whitelist <cidrs...>', texts_1.OPTION_WHITELIST);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.25.2-stage",
+  "version": "1.25.4-dev",
   "type": "commonjs",
   "license": "MIT",
   "homepage": "https://buddy.works/docs/cli",
@@ -13,24 +13,25 @@
     "lint:types": "tsc --skipLibCheck --noEmit --project tsconfig.json && tsc --skipLibCheck --project test/tsconfig.json && tsc --skipLibCheck --project e2e/tsconfig.json",
     "watch": "tsc --watch --project tsconfig.json & tsc --watch --project src/visualTest/utils/tsconfig.json",
     "buildTs": "(tsc --project tsconfig.json & tsc --project src/visualTest/utils/tsconfig.json & wait) && cp package.json distTs/package.json && cp detect-rules.json distTs/detect-rules.json && curl -fsSL https://raw.githubusercontent.com/buddy/cli/main/README.md -o README.md",
-    "e2e": "npm run buildTs && vitest run --config e2e/vitest.config.ts",
-    "e2e:version": "vitest run --config e2e/vitest.config.ts e2e/modules/version/",
-    "e2e:tunnel-config": "vitest run --config e2e/vitest.config.ts e2e/modules/tunnel-config/",
-    "e2e:auth": "vitest run --config e2e/vitest.config.ts e2e/modules/auth/",
-    "e2e:workspace": "vitest run --config e2e/vitest.config.ts e2e/modules/workspace/",
-    "e2e:project": "vitest run --config e2e/vitest.config.ts e2e/modules/project/",
-    "e2e:artifact": "vitest run --config e2e/vitest.config.ts e2e/modules/artifact/",
-    "e2e:sandbox": "vitest run --config e2e/vitest.config.ts e2e/modules/sandbox/",
-    "e2e:api": "vitest run --config e2e/vitest.config.ts e2e/modules/api/",
-    "e2e:mcp": "vitest run --config e2e/vitest.config.ts e2e/modules/mcp/",
-    "e2e:pipeline": "vitest run --config e2e/vitest.config.ts e2e/modules/pipeline/",
-    "e2e:tunnel": "vitest run --config e2e/vitest.config.ts e2e/modules/tunnel/",
-    "e2e:agent": "vitest run --config e2e/vitest.config.ts e2e/modules/agent/",
-    "e2e:distro": "vitest run --config e2e/vitest.config.ts e2e/modules/distro/",
-    "e2e:target": "vitest run --config e2e/vitest.config.ts e2e/modules/target/",
-    "e2e:environment": "vitest run --config e2e/vitest.config.ts e2e/modules/environment/",
-    "e2e:yaml": "vitest run --config e2e/vitest.config.ts e2e/modules/yaml/",
-    "unit": "vitest run --config vitest.config.ts"
+    "e2e": "npm run buildTs && vitest run --config e2e/vitest.config.mts",
+    "e2e:version": "vitest run --config e2e/vitest.config.mts e2e/modules/version/",
+    "e2e:discover": "vitest run --config e2e/vitest.discover.config.mts",
+    "e2e:tunnel-config": "vitest run --config e2e/vitest.config.mts e2e/modules/tunnel-config/",
+    "e2e:auth": "vitest run --config e2e/vitest.config.mts e2e/modules/auth/",
+    "e2e:workspace": "vitest run --config e2e/vitest.config.mts e2e/modules/workspace/",
+    "e2e:project": "vitest run --config e2e/vitest.config.mts e2e/modules/project/",
+    "e2e:artifact": "vitest run --config e2e/vitest.config.mts e2e/modules/artifact/",
+    "e2e:sandbox": "vitest run --config e2e/vitest.config.mts e2e/modules/sandbox/",
+    "e2e:api": "vitest run --config e2e/vitest.config.mts e2e/modules/api/",
+    "e2e:mcp": "vitest run --config e2e/vitest.config.mts e2e/modules/mcp/",
+    "e2e:pipeline": "vitest run --config e2e/vitest.config.mts e2e/modules/pipeline/",
+    "e2e:tunnel": "vitest run --config e2e/vitest.config.mts e2e/modules/tunnel/",
+    "e2e:agent": "vitest run --config e2e/vitest.config.mts e2e/modules/agent/",
+    "e2e:distro": "vitest run --config e2e/vitest.config.mts e2e/modules/distro/",
+    "e2e:target": "vitest run --config e2e/vitest.config.mts e2e/modules/target/",
+    "e2e:environment": "vitest run --config e2e/vitest.config.mts e2e/modules/environment/",
+    "e2e:yaml": "vitest run --config e2e/vitest.config.mts e2e/modules/yaml/",
+    "unit": "vitest run --config vitest.config.mts"
   },
   "files": [
     "distTs"