@get-dx/cli 0.2.0 → 0.3.0

package/dist/config.js

@@ -1,14 +1,10 @@
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
-const DEFAULT_BASE_URL = "https://api.getdx.com";
-export function getConfigDir() {
-    const xdg = process.env.XDG_CONFIG_HOME;
-    if (xdg) {
-        return path.join(xdg, "dx");
-    }
-    return path.join(os.homedir(), ".config", "dx");
-}
+import { CliError, EXIT_CODES } from "./errors.js";
+const DEFAULT_API_BASE_URL = "https://api.getdx.com";
+const DEFAULT_WEB_BASE_URL = "https://app.getdx.com";
+// --- Config file I/O ---------------------------------------------------------
 export function getConfigPath() {
     return path.join(getConfigDir(), "config.json");
 }
@@ -18,38 +14,184 @@ export function readConfig() {
         return {};
     }
     const content = fs.readFileSync(configPath, "utf8");
-    return JSON.parse(content);
+    const raw = JSON.parse(content);
+    const api = raw.apiBaseUrl;
+    const web = raw.webBaseUrl;
+    const stored = {};
+    if (web) {
+        stored.webBaseUrl = web;
+    }
+    if (api) {
+        stored.apiBaseUrl = api;
+    }
+    return stored;
+}
+/**
+ * Responsible for handling the migration from `baseUrl` to `apiBaseUrl` and `webBaseUrl`,
+ * so the upgrade to 0.3.x will be non-breaking for `cloud` and `dedicated` deployments.
+ *
+ * `managed` deployments will encounter an error and will have to reauthenticate.
+ *
+ * TODO: delete after 2026-07-01.
+ */
+export function handleTemporaryBaseUrlMigration(argv) {
+    if (!process.env.VITEST) {
+        // Running tests - we don't want our permanent tests to exercise this logic
+        return;
+    }
+    const COMMANDS_TO_SKIP_MIGRATION = ["login", "logout", "init"];
+    if (COMMANDS_TO_SKIP_MIGRATION.some((command) => argv.includes(command))) {
+        // Logging in or logging out: we need to ignore the current config file's contents
+        return;
+    }
+    const configPath = getConfigPath();
+    if (!fs.existsSync(configPath)) {
+        // No config file, no need to migrate
+        return;
+    }
+    const content = fs.readFileSync(configPath, "utf8");
+    const raw = JSON.parse(content);
+    const api = raw.apiBaseUrl;
+    const web = raw.webBaseUrl;
+    if (api !== undefined && web !== undefined) {
+        // Already migrated, no need to do anything
+        return;
+    }
+    if (raw.baseUrl) {
+        // Legacy baseUrl is present, migrate to apiBaseUrl and webBaseUrl
+        const apiBaseUrl = raw.baseUrl;
+        let webBaseUrl;
+        if (apiBaseUrl.endsWith(".getdx.com")) {
+            // Migrate `cloud`
+            webBaseUrl = "https://app.getdx.com";
+            writeConfig({
+                apiBaseUrl: normalizeUrl(apiBaseUrl),
+                webBaseUrl: normalizeUrl(webBaseUrl),
+            });
+            return;
+        }
+        const dedicatedMatch = apiBaseUrl.match(/^api\.(.+)\.getdx\.io$/);
+        if (dedicatedMatch) {
+            // Migrate `dedicated`
+            webBaseUrl = `https://${dedicatedMatch[1]}.getdx.io`;
+            writeConfig({
+                apiBaseUrl: normalizeUrl(apiBaseUrl),
+                webBaseUrl: normalizeUrl(webBaseUrl),
+            });
+            return;
+        }
+        // Unable to automatically migrate `managed`
+        throw new CliError("Your on-disk DX CLI config is missing apiBaseUrl and webBaseUrl. Run `dx auth logout`, then login again via `dx init` or `dx auth login`.");
+    }
 }
 export function writeConfig(config) {
     fs.mkdirSync(getConfigDir(), { recursive: true });
     fs.writeFileSync(getConfigPath(), JSON.stringify(config, null, 2) + "\n", "utf8");
 }
-export function resolveBaseUrl() {
-    if (process.env.DX_BASE_URL) {
-        return normalizeBaseUrl(process.env.DX_BASE_URL);
+export function persistBaseUrls(apiBaseUrl, webBaseUrl) {
+    writeConfig({
+        ...readConfig(),
+        apiBaseUrl: normalizeUrl(apiBaseUrl),
+        webBaseUrl: normalizeUrl(webBaseUrl),
+    });
+}
+/** Strips trailing slashes from an HTTP(S) base URL string. */
+export function normalizeUrl(url) {
+    return url.replace(/\/+$/, "");
+}
+function getConfigDir() {
+    const xdg = process.env.XDG_CONFIG_HOME;
+    if (xdg) {
+        return path.join(xdg, "dx");
     }
-    return normalizeBaseUrl(readConfig().baseUrl || DEFAULT_BASE_URL);
+    return path.join(os.homedir(), ".config", "dx");
 }
+// --- Resolving URLs at command runtime ------------------------------------------------------
 /**
- * Web UI origin for browser OAuth (`/cli/auth`), inferred from the API base URL.
- * Dedicated and cloud hostnames map to their app origins; otherwise the API URL origin is used.
+ * Resolved API base URL for HTTP requests.
+ * Precedence: `DX_API_BASE_URL`, then persisted `apiBaseUrl`, then DX Cloud default.
  */
-export function resolveUiUrl(apiBaseUrl) {
-    const normalized = normalizeBaseUrl(apiBaseUrl);
-    const url = new URL(normalized);
-    const host = url.hostname;
-    if (host === "api.getdx.com") {
-        return "https://app.getdx.com";
+export function resolveApiBaseUrl() {
+    if (process.env.DX_API_BASE_URL) {
+        return normalizeUrl(process.env.DX_API_BASE_URL);
     }
-    const dedicated = host.match(/^api\.(.+)\.getdx\.io$/);
-    if (dedicated) {
-        return `https://${dedicated[1]}.getdx.io`;
+    return normalizeUrl(readConfig().apiBaseUrl || DEFAULT_API_BASE_URL);
+}
+/**
+ * Resolved web-app base URL for CLI deep links and browser OAuth.
+ * Precedence: `DX_WEB_BASE_URL`, persisted `webBaseUrl`, then DX Cloud default.
+ */
+export function resolveWebBaseUrl() {
+    if (process.env.DX_WEB_BASE_URL) {
+        return normalizeUrl(process.env.DX_WEB_BASE_URL);
     }
-    return url.origin;
+    return normalizeUrl(readConfig().webBaseUrl || DEFAULT_WEB_BASE_URL);
 }
-export function persistBaseUrl(baseUrl) {
-    writeConfig({ ...readConfig(), baseUrl: normalizeBaseUrl(baseUrl) });
+// --- Deriving base URLs at login time -------------------------------------
+/**
+ * Derive the appropriate `apiBaseUrl` and `webBaseUrl` to persist into config,
+ * considering the `DX_API_BASE_URL` and `DX_WEB_BASE_URL` env vars if they are present.
+ *
+ * If the env vars are not set, we assume the user is configuring for a `cloud` deployment.
+ *
+ * If they are set, we parse them to determine whether the deployment is `cloud`, `dedicated`, or `managed`.
+ *
+ * If we fail to derive the base URLs, a `CliError` is thrown.
+ */
+export function deriveBaseUrlsFromEnv() {
+    const apiBaseUrlFromEnv = process.env.DX_API_BASE_URL;
+    const webBaseUrlFromEnv = process.env.DX_WEB_BASE_URL;
+    if (apiBaseUrlFromEnv && !webBaseUrlFromEnv) {
+        throw new CliError("DX_WEB_BASE_URL must be set when DX_API_BASE_URL is set", EXIT_CODES.ARGUMENT_ERROR);
+    }
+    const parsed = webBaseUrlFromEnv
+        ? parseWebBaseUrl(webBaseUrlFromEnv)
+        : { type: "cloud" };
+    switch (parsed.type) {
+        case "cloud":
+            return {
+                apiBaseUrl: "https://api.getdx.com",
+                webBaseUrl: "https://app.getdx.com",
+            };
+        case "dedicated": {
+            const { accountName } = parsed;
+            return {
+                apiBaseUrl: `https://api.${accountName}.getdx.io`,
+                webBaseUrl: `https://${accountName}.getdx.io`,
+            };
+        }
+        case "managed": {
+            const apiBaseUrl = process.env.DX_API_BASE_URL;
+            if (!apiBaseUrl) {
+                throw new CliError("DX_API_BASE_URL must be specified when authenticating with a managed deployment");
+            }
+            return {
+                apiBaseUrl,
+                webBaseUrl: parsed.webAppUrl,
+            };
+        }
+        case "invalid":
+            throw new CliError(`Could not recognize web base URL "${parsed.input}". Expected https://app.getdx.com, https://<account>.getdx.io, or a custom domain.`);
+    }
 }
-function normalizeBaseUrl(baseUrl) {
-    return baseUrl.replace(/\/+$/, "");
+function parseWebBaseUrl(raw) {
+    const normalized = raw.trim().replace(/\/$/, "");
+    if (!normalized || normalized === "app.getdx.com") {
+        return { type: "cloud" };
+    }
+    try {
+        const url = new URL(normalized.startsWith("http") ? normalized : `https://${normalized}`);
+        const host = url.hostname;
+        const dedicatedMatch = host.match(/^(.+)\.getdx\.io$/);
+        if (dedicatedMatch) {
+            return { type: "dedicated", accountName: dedicatedMatch[1] };
+        }
+        if (host) {
+            return { type: "managed", webAppUrl: url.origin };
+        }
+    }
+    catch {
+        // fall through to invalid
+    }
+    return { type: "invalid", input: raw };
 }

package/dist/http.js

@@ -23,7 +23,7 @@ export async function request(runtime, route, options = {}) {
             query.set(key, String(value));
         }
     });
-    const url = `${runtime.baseUrl}${route}${query.size > 0 ? `?${query.toString()}` : ""}`;
+    const url = `${runtime.apiBaseUrl}${route}${query.size > 0 ? `?${query.toString()}` : ""}`;
     const requestBody = options.body !== undefined ? JSON.stringify(options.body) : undefined;
     runtime.logger.debug("Sending HTTP request", {
         body: options.body ?? null,

package/dist/loginViaBrowser.js

@@ -4,7 +4,7 @@ import { AuthCodeCallbackServer, } from "./authCodeCallbackServer.js";
 import { CliError } from "./errors.js";
 import { renderRichText } from "./renderers.js";
 import * as ui from "./ui.js";
-export async function loginViaBrowser(uiBaseUrl) {
+export async function loginViaBrowser(webBaseUrl) {
     const server = new AuthCodeCallbackServer();
     await server.start();
     const callbackUri = server.getAddress();
@@ -17,7 +17,7 @@ export async function loginViaBrowser(uiBaseUrl) {
         code_challenge: codeChallenge,
         code_challenge_method: "S256",
     });
-    const authUrl = `${uiBaseUrl}/cli/auth?${params.toString()}`;
+    const authUrl = `${webBaseUrl}/cli/auth?${params.toString()}`;
     renderRichText([
         ui.p(`Opening your browser to complete authentication...`),
         ui.blankLine(),
@@ -42,7 +42,7 @@ export async function loginViaBrowser(uiBaseUrl) {
                 error: new CliError("Authentication failed: state mismatch"),
             };
         }
-        const tokenExchangeResponse = await exchangeCodeForToken(uiBaseUrl, code, codeVerifier);
+        const tokenExchangeResponse = await exchangeCodeForToken(webBaseUrl, code, codeVerifier);
         if (!tokenExchangeResponse.ok) {
             return {
                 type: "ERROR",
@@ -64,8 +64,8 @@ export async function loginViaBrowser(uiBaseUrl) {
 function validateState(stateFromResponse, originalState) {
     return stateFromResponse === originalState;
 }
-async function exchangeCodeForToken(baseUrl, code, codeVerifier) {
-    return fetch(`${baseUrl}/cli/token`, {
+async function exchangeCodeForToken(webBaseUrl, code, codeVerifier) {
+    return fetch(`${webBaseUrl}/cli/token`, {
         method: "POST",
         headers: { "Content-Type": "application/x-www-form-urlencoded" },
         body: new URLSearchParams({ code, code_verifier: codeVerifier }),

package/dist/runtime.js

@@ -1,4 +1,4 @@
-import { resolveBaseUrl } from "./config.js";
+import { resolveApiBaseUrl, resolveWebBaseUrl } from "./config.js";
 import { CliError } from "./errors.js";
 import { getToken } from "./secrets.js";
 import { createLogger } from "./logger.js";
@@ -7,13 +7,15 @@ export function buildLogger(context) {
     return createLogger({ json: context.json || !process.stderr.isTTY });
 }
 export function buildRuntime(context, overrides) {
-    const baseUrl = overrides?.baseUrl ?? resolveBaseUrl();
-    const token = overrides?.token ?? getToken(baseUrl);
+    const apiBaseUrl = overrides?.apiBaseUrl ?? resolveApiBaseUrl();
+    const webBaseUrl = overrides?.webBaseUrl ?? resolveWebBaseUrl();
+    const token = overrides?.token ?? getToken(apiBaseUrl);
     if (!token) {
         throw new CliError("No API token configured. Run `dx auth login --token <token>` or set DX_API_TOKEN.");
     }
     return {
-        baseUrl,
+        apiBaseUrl,
+        webBaseUrl,
         token,
         context,
         version: cliPackage.version,
@@ -21,13 +23,15 @@ export function buildRuntime(context, overrides) {
     };
 }
 export function buildRuntimeSafe(context, overrides) {
-    const baseUrl = overrides?.baseUrl ?? resolveBaseUrl();
-    const token = overrides?.token ?? getToken(baseUrl);
+    const apiBaseUrl = overrides?.apiBaseUrl ?? resolveApiBaseUrl();
+    const webBaseUrl = overrides?.webBaseUrl ?? resolveWebBaseUrl();
+    const token = overrides?.token ?? getToken(apiBaseUrl);
     if (!token) {
         return null;
     }
     return {
-        baseUrl,
+        apiBaseUrl,
+        webBaseUrl,
         token,
         context,
         version: cliPackage.version,

package/dist/ui.js

@@ -58,6 +58,14 @@ export function json(value) {
 export function blankLine() {
     return new ParagraphBlock("", false);
 }
+export function truncatedSqlBlock(sql) {
+    const lines = sql.split("\n");
+    const firstLine = lines[0];
+    const isLong = firstLine.length > 80 || lines.length > 1;
+    const truncated = firstLine.length > 80 ? firstLine.slice(0, 80) : firstLine;
+    const display = isLong ? truncated + dim(" …") : truncated;
+    return p(code(display));
+}
 // Inline elements
 export function bold(text) {
     return pc.bold(text);
@@ -113,3 +121,6 @@ export function maskToken(token) {
     }
     return `${token.slice(0, 4)}${"*".repeat(token.length - 8)}${token.slice(-4)}`;
 }
+export function webLink(path, runtime) {
+    return `${runtime.webBaseUrl}${path}`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@get-dx/cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "DX CLI",
   "author": "DX <developers@getdx.com>",
   "bugs": {