@get-dx/cli 0.3.0 → 0.3.1

package/dist/cli.js

@@ -3,6 +3,7 @@ import { authCommand } from "./commands/auth.js";
 import { catalogCommand } from "./commands/catalog.js";
 import { initCommand } from "./commands/init.js";
 import { scorecardsCommand } from "./commands/scorecards.js";
+import { snapshotsCommand } from "./commands/snapshots.js";
 import { studioCommand } from "./commands/studio.js";
 import { teamsCommand } from "./commands/teams.js";
 import { workflowsCommand } from "./commands/workflows.js";
@@ -36,6 +37,7 @@ function createProgram() {
     program.addCommand(catalogCommand());
     program.addCommand(initCommand());
     program.addCommand(scorecardsCommand());
+    program.addCommand(snapshotsCommand());
     program.addCommand(studioCommand());
     program.addCommand(teamsCommand());
     program.addCommand(workflowsCommand());

package/dist/commands/snapshots.js

@@ -0,0 +1,379 @@
+import { Command } from "commander";
+import { createExampleText, getContext, parsePositiveIntOption, wrapAction, } from "../commandHelpers.js";
+import { CliError, EXIT_CODES } from "../errors.js";
+import { request } from "../http.js";
+import { renderJson, renderRichText } from "../renderers.js";
+import { buildRuntime } from "../runtime.js";
+import * as ui from "../ui.js";
+export function snapshotsCommand() {
+    const snapshots = new Command()
+        .name("snapshots")
+        .description("Work with DX snapshots");
+    const csatComments = new Command()
+        .name("csatComments")
+        .description("Work with snapshot CSAT comments");
+    csatComments
+        .command("list")
+        .description("List CSAT comments for a snapshot")
+        .option("--id <id>", "The unique ID of the snapshot")
+        .option("--cursor <cursor>", "Cursor for the next page of results")
+        .option("--limit <n>", "Max comments per page (default is 50, max is 100)", (value) => parseLimitOption(value, "--limit"))
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "List CSAT comments for a snapshot",
+            command: "dx snapshots csatComments list --id MjUyNbaY",
+        },
+        {
+            label: "List CSAT comments as JSON",
+            command: "dx --json snapshots csatComments list --id MjUyNbaY",
+        },
+        {
+            label: "Fetch the next page using a cursor from the prior response",
+            command: "dx snapshots csatComments list --id MjUyNbaY --cursor xuvkgfq9t0ty --limit 100",
+        },
+    ]))
+        .action(wrapAction(async (options, command) => {
+        const id = parseRequiredTextOption(options.id, "--id");
+        const runtime = buildRuntime(getContext(command));
+        const response = await listSnapshotCsatComments(runtime, {
+            id,
+            cursor: options.cursor,
+            limit: options.limit,
+        });
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderSnapshotCsatComments(extractCsatComments(response), response.response_metadata?.next_cursor ?? null, id, runtime);
+        }
+    }));
+    snapshots.addCommand(csatComments);
+    const driverComments = new Command()
+        .name("driverComments")
+        .description("Work with snapshot driver comments");
+    driverComments
+        .command("list")
+        .description("List driver comments for a snapshot")
+        .option("--id <id>", "The unique ID of the snapshot")
+        .option("--cursor <cursor>", "Cursor for the next page of results")
+        .option("--limit <n>", "Max comments per page (default is 50, max is 100)", (value) => parseLimitOption(value, "--limit"))
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "List driver comments for a snapshot",
+            command: "dx snapshots driverComments list --id MjUyNbaY",
+        },
+        {
+            label: "List driver comments as JSON",
+            command: "dx --json snapshots driverComments list --id MjUyNbaY",
+        },
+        {
+            label: "Fetch the next page using a cursor from the prior response",
+            command: "dx snapshots driverComments list --id MjUyNbaY --cursor xuvkgfq9t0ty --limit 100",
+        },
+    ]))
+        .action(wrapAction(async (options, command) => {
+        const id = parseRequiredTextOption(options.id, "--id");
+        const runtime = buildRuntime(getContext(command));
+        const response = await listSnapshotDriverComments(runtime, {
+            id,
+            cursor: options.cursor,
+            limit: options.limit,
+        });
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderSnapshotDriverComments(extractDriverComments(response), response.response_metadata?.next_cursor ?? null, id, runtime);
+        }
+    }));
+    snapshots.addCommand(driverComments);
+    snapshots
+        .command("info")
+        .description("Retrieve results for a single snapshot")
+        .option("--id <snapshot_id>", "The unique ID of the snapshot")
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "Fetch info for a snapshot",
+            command: "dx snapshots info --id MjUyNbaY",
+        },
+        {
+            label: "Fetch snapshot info as JSON",
+            command: "dx --json snapshots info --id MjUyNbaY",
+        },
+    ]))
+        .action(wrapAction(async (options, command) => {
+        const snapshotId = parseRequiredTextOption(options.id, "--id");
+        const runtime = buildRuntime(getContext(command));
+        const response = await getSnapshotInfo(runtime, snapshotId);
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderSnapshotInfo(response.snapshot, snapshotId, runtime);
+        }
+    }));
+    snapshots
+        .command("list")
+        .description("List DX snapshots")
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "List snapshots",
+            command: "dx snapshots list",
+        },
+        {
+            label: "List snapshots as JSON",
+            command: "dx --json snapshots list",
+        },
+    ]))
+        .action(wrapAction(async (_options, command) => {
+        const runtime = buildRuntime(getContext(command));
+        const response = await listSnapshots(runtime);
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderSnapshots(response.snapshots, runtime);
+        }
+    }));
+    return snapshots;
+}
+async function listSnapshotDriverComments(runtime, options) {
+    const response = await request(runtime, "/snapshots.driverComments.list", {
+        method: "GET",
+        query: {
+            id: options.id,
+            cursor: options.cursor,
+            limit: options.limit,
+        },
+    });
+    return response.body;
+}
+async function listSnapshotCsatComments(runtime, options) {
+    const response = await request(runtime, "/snapshots.csatComments.list", {
+        method: "GET",
+        query: {
+            id: options.id,
+            cursor: options.cursor,
+            limit: options.limit,
+        },
+    });
+    return response.body;
+}
+async function getSnapshotInfo(runtime, snapshotId) {
+    const response = await request(runtime, "/snapshots.info", {
+        method: "GET",
+        query: { snapshot_id: snapshotId },
+    });
+    return response.body;
+}
+async function listSnapshots(runtime) {
+    const response = await request(runtime, "/snapshots.list", {
+        method: "GET",
+        query: {
+            ordering: "completed_at",
+        },
+    });
+    return response.body;
+}
+function renderSnapshotDriverComments(comments, nextCursor, snapshotId, runtime) {
+    const blocks = [ui.h1("Snapshot Driver Comments")];
+    blocks.push(ui.p(`Displaying ${ui.bold(comments.length.toString())} comments.`));
+    blocks.push(ui.p(ui.link(snapshotWebLink(snapshotId, "drivers/comments", runtime))));
+    if (nextCursor) {
+        blocks.push(ui.p(`Next cursor: ${ui.code(nextCursor)}`));
+    }
+    if (comments.length === 0) {
+        blocks.push(ui.p(ui.dim("(None)")));
+        renderRichText(blocks);
+        return;
+    }
+    for (const comment of comments) {
+        blocks.push(ui.h2(formatCommentHeading(comment)));
+        const details = [
+            optionalDetail("Email", formatText(comment.email), comment.email),
+            optionalDetail("Driver", formatText(comment.driver_name ?? comment.driver), comment.driver_name ?? comment.driver),
+            optionalDetail("Driver ID", formatText(comment.driver_id), comment.driver_id),
+            optionalDetail("Team", formatText(comment.team_name), comment.team_name),
+            optionalDetail("Team ID", formatText(comment.team_id), comment.team_id),
+            optionalDetail("Item", formatText(comment.item_name), comment.item_name),
+            optionalDetail("Item ID", formatText(comment.item_id), comment.item_id),
+            optionalDetail("Snapshot ID", formatText(comment.snapshot_id), comment.snapshot_id),
+            optionalDetail("Timestamp", formatTimestamp(comment.timestamp), comment.timestamp),
+        ].filter((detail) => detail !== null);
+        if (details.length > 0) {
+            blocks.push(ui.dl(details, { termWidth: 11 }));
+        }
+        blocks.push(ui.p(formatText(comment.text ?? comment.comment)));
+    }
+    renderRichText(blocks);
+}
+function renderSnapshotCsatComments(comments, nextCursor, snapshotId, runtime) {
+    const blocks = [ui.h1("Snapshot CSAT Comments")];
+    blocks.push(ui.p(`Displaying ${ui.bold(comments.length.toString())} comments.`));
+    blocks.push(ui.p(ui.link(snapshotWebLink(snapshotId, "csat/comments", runtime))));
+    if (nextCursor) {
+        blocks.push(ui.p(`Next cursor: ${ui.code(nextCursor)}`));
+    }
+    if (comments.length === 0) {
+        blocks.push(ui.p(ui.dim("(None)")));
+        renderRichText(blocks);
+        return;
+    }
+    for (const comment of comments) {
+        blocks.push(ui.h2(formatCommentHeading(comment)));
+        const details = [
+            optionalDetail("Email", formatText(comment.email), comment.email),
+            optionalDetail("Team", formatText(comment.team_name), comment.team_name),
+            optionalDetail("Team ID", formatText(comment.team_id), comment.team_id),
+            optionalDetail("Item", formatText(comment.item_name), comment.item_name),
+            optionalDetail("Item ID", formatText(comment.item_id), comment.item_id),
+            optionalDetail("Snapshot ID", formatText(comment.snapshot_id), comment.snapshot_id),
+            optionalDetail("Timestamp", formatTimestamp(comment.timestamp), comment.timestamp),
+        ].filter((detail) => detail !== null);
+        if (details.length > 0) {
+            blocks.push(ui.dl(details, { termWidth: 11 }));
+        }
+        blocks.push(ui.p(formatText(comment.text ?? comment.comment)));
+    }
+    renderRichText(blocks);
+}
+function renderSnapshotInfo(snapshot, snapshotId, runtime) {
+    const teamScores = snapshot.team_scores ?? [];
+    const blocks = [ui.h1("Snapshot Information")];
+    blocks.push(ui.p(`Displaying ${ui.bold(teamScores.length.toString())} team scores.`));
+    blocks.push(ui.p(ui.link(snapshotWebLink(snapshotId, "drivers", runtime))));
+    if (teamScores.length === 0) {
+        blocks.push(ui.p(ui.dim("(None)")));
+        renderRichText(blocks);
+        return;
+    }
+    for (const teamScore of teamScores) {
+        blocks.push(ui.h2("Team Score"));
+        blocks.push(ui.dl([
+            optionalDetail("Team name", formatText(teamScore.snapshot_team?.name), teamScore.snapshot_team?.name),
+            optionalDetail("Team ID", formatText(teamScore.snapshot_team?.team_id), teamScore.snapshot_team?.team_id),
+            optionalDetail("item_name", formatText(teamScore.item_name), teamScore.item_name),
+            optionalDetail("Response count", formatNumber(teamScore.response_count), teamScore.response_count),
+            optionalDetail("Score", formatNumber(teamScore.score), teamScore.score),
+        ].filter((detail) => detail !== null), { termWidth: 16 }));
+        blocks.push(ui.h3("Benchmarks"));
+        blocks.push(ui.p(formatBenchmarkTable(teamScore)));
+    }
+    renderRichText(blocks);
+}
+function renderSnapshots(snapshots, runtime) {
+    const blocks = [ui.h1("Snapshots")];
+    blocks.push(ui.p(`Displaying ${ui.bold(snapshots.length.toString())} snapshots.`));
+    if (snapshots.length === 0) {
+        blocks.push(ui.p(ui.dim("(None)")));
+        renderRichText(blocks);
+        return;
+    }
+    for (const snapshot of snapshots) {
+        blocks.push(ui.h2(ui.code(snapshot.id)));
+        blocks.push(ui.dl([
+            optionalDetail("Account ID", formatText(snapshot.account_id), snapshot.account_id),
+            optionalDetail("Scheduled for", formatText(snapshot.scheduled_for), snapshot.scheduled_for),
+            optionalDetail("Completed", formatTimestamp(snapshot.completed_at), snapshot.completed_at),
+            optionalDetail("Completed count", formatNumber(snapshot.completed_count), snapshot.completed_count),
+            optionalDetail("Total count", formatNumber(snapshot.total_count), snapshot.total_count),
+            optionalDetail("Last result change", formatTimestamp(snapshot.last_result_change_at), snapshot.last_result_change_at),
+            optionalDetail("Deleted", formatTimestamp(snapshot.deleted_at), snapshot.deleted_at),
+            ui.dli("Web link", ui.link(snapshotWebLink(snapshot.id, "drivers", runtime))),
+        ].filter((detail) => detail !== null), { termWidth: 18 }));
+    }
+    renderRichText(blocks);
+}
+function extractDriverComments(response) {
+    return (response.driver_comments ??
+        response.driverComments ??
+        response.drivercomments ??
+        response.comments ??
+        []);
+}
+function extractCsatComments(response) {
+    return (response.csat_comments ??
+        response.csatComments ??
+        response.csatcomments ??
+        response.comments ??
+        []);
+}
+function formatCommentHeading(comment) {
+    const heading = comment.item_name ??
+        comment.driver_name ??
+        comment.driver ??
+        comment.email ??
+        comment.item_id ??
+        comment.driver_id;
+    return typeof heading === "string" && heading.trim().length > 0
+        ? heading
+        : "Comment";
+}
+function formatText(value) {
+    return typeof value === "string" && value.trim().length > 0
+        ? value
+        : ui.dim("(None)");
+}
+function formatNumber(value) {
+    return typeof value === "number" && Number.isFinite(value)
+        ? value.toString()
+        : ui.dim("(None)");
+}
+function formatTimestamp(value) {
+    if (typeof value !== "string" || value.trim().length === 0) {
+        return "";
+    }
+    const trimmed = value.trim();
+    const seconds = Number(trimmed);
+    if (Number.isFinite(seconds) && seconds > 0) {
+        return ui.timestampSummary(new Date(seconds * 1000).toISOString());
+    }
+    return Number.isNaN(Date.parse(trimmed))
+        ? trimmed
+        : ui.timestampSummary(trimmed);
+}
+function optionalDetail(term, value, rawValue) {
+    if (rawValue === undefined || rawValue === null) {
+        return null;
+    }
+    if (typeof rawValue === "string" && rawValue.trim().length === 0) {
+        return null;
+    }
+    return ui.dli(term, value);
+}
+function formatBenchmarkTable(teamScore) {
+    const rows = [
+        ["vs_prev", formatBenchmarkNumber(teamScore.vs_prev)],
+        ["vs_org", formatBenchmarkNumber(teamScore.vs_org)],
+        ["vs_50th", formatBenchmarkNumber(teamScore.vs_50th)],
+        ["vs_75th", formatBenchmarkNumber(teamScore.vs_75th)],
+        ["vs_90th", formatBenchmarkNumber(teamScore.vs_90th)],
+    ];
+    const columns = ["Benchmark", "Value"];
+    const widths = columns.map((column, index) => Math.max(column.length, ...rows.map((row) => row[index].length)));
+    const border = `+${widths.map((width) => "-".repeat(width + 2)).join("+")}+`;
+    const header = `| ${columns.map((column, index) => column.padEnd(widths[index])).join(" | ")} |`;
+    const body = rows.map((row) => `| ${row.map((cell, index) => cell.padEnd(widths[index])).join(" | ")} |`);
+    return [border, header, border, ...body, border].join("\n");
+}
+function formatBenchmarkNumber(value) {
+    return typeof value === "number" && Number.isFinite(value)
+        ? value.toString()
+        : "(None)";
+}
+function snapshotWebLink(snapshotId, section, runtime) {
+    return ui.webLink(`/snapshots/${snapshotId}/${section}`, runtime);
+}
+function parseRequiredTextOption(value, flag) {
+    if (typeof value !== "string" || value.trim().length === 0) {
+        throw new CliError(`${flag} is required`, EXIT_CODES.ARGUMENT_ERROR);
+    }
+    return value.trim();
+}
+function parseLimitOption(value, flag) {
+    const limit = parsePositiveIntOption(value, flag);
+    if (limit > 100) {
+        throw new CliError(`${flag} must be at most 100`, EXIT_CODES.ARGUMENT_ERROR);
+    }
+    return limit;
+}

package/package.json

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