@get-dx/cli 0.1.0

package/dist/commands/catalog/entitiesRendering.js

@@ -0,0 +1,286 @@
+import dayjs from "dayjs";
+import { renderRichText } from "../../renderers.js";
+import * as ui from "../../ui.js";
+export function renderEntityList(entities, nextCursor) {
+    const blocks = [ui.h1("Entities")];
+    blocks.push(ui.p(`Displaying ${ui.bold(entities.length.toString())} entities.`));
+    if (nextCursor) {
+        blocks.push(ui.p(`Next cursor: ${ui.code(nextCursor)}`));
+    }
+    for (const entity of entities) {
+        if (entity.name && entity.identifier) {
+            blocks.push(ui.h2(`${entity.name} (${ui.code(entity.identifier)})`));
+        }
+        else if (entity.identifier) {
+            blocks.push(ui.h2(ui.code(entity.identifier)));
+        }
+        else {
+            blocks.push(ui.h2("Entity"));
+        }
+        if (entity.identifier) {
+            blocks.push(ui.h3("Core attributes"));
+            blocks.push(...coreContent(entity));
+        }
+        if (entity.owner_teams || entity.owner_users) {
+            blocks.push(ui.h3("Owners"));
+            blocks.push(...ownersContent(entity));
+        }
+        if (entity.properties) {
+            blocks.push(ui.h3("Properties"));
+            blocks.push(...propertiesContent(entity));
+        }
+        if (entity.aliases) {
+            blocks.push(ui.h3("Aliases"));
+            blocks.push(...aliasesContent(entity));
+        }
+    }
+    renderRichText(blocks);
+}
+export function renderEntity(entity, title = "Entity Information") {
+    renderRichText([
+        ui.h1(title),
+        entity.identifier
+            ? [ui.h2("Core attributes"), ...coreContent(entity)]
+            : null,
+        entity.owner_teams ? [ui.h2("Owners"), ...ownersContent(entity)] : null,
+        entity.properties
+            ? [ui.h2("Properties"), ...propertiesContent(entity)]
+            : null,
+        entity.aliases ? [ui.h2("Aliases"), ...aliasesContent(entity)] : null,
+    ]);
+}
+export function renderEntityDeleted(entity) {
+    renderRichText([
+        ui.h1(`${ui.success(ui.GLYPHS.CHECK)} Entity deleted`),
+        ui.p(`The entity ${ui.code(entity.identifier)} has been deleted.`),
+    ]);
+}
+export function renderEntityScorecardList(scorecards, nextCursor) {
+    const blocks = [ui.h1("Scorecards")];
+    blocks.push(ui.p(`Displaying ${ui.bold(scorecards.length.toString())} scorecards.`));
+    if (nextCursor) {
+        blocks.push(ui.p(`Next cursor: ${ui.code(nextCursor)}`));
+    }
+    for (const scorecard of scorecards) {
+        blocks.push(ui.h2(scorecard.name));
+        blocks.push(...scorecardReportContent(scorecard));
+    }
+    renderRichText(blocks);
+}
+export function renderEntityTaskList(tasks, nextCursor) {
+    const blocks = [ui.h1("Tasks")];
+    blocks.push(ui.p(`Displaying ${ui.bold(tasks.length.toString())} tasks.`));
+    if (nextCursor) {
+        blocks.push(ui.p(`Next cursor: ${ui.code(nextCursor)}`));
+    }
+    for (const task of tasks) {
+        blocks.push(ui.h2(task.check.name));
+        blocks.push(...taskContent(task));
+    }
+    renderRichText(blocks);
+}
+function scorecardReportContent(scorecard) {
+    const blocks = [];
+    if (scorecard.type === "POINTS") {
+        const total = scorecard.points_meta?.points_total ?? 0;
+        const achieved = scorecard.points_meta?.points_achieved ?? 0;
+        const pct = total === 0 ? 0 : Math.round((achieved / total) * 100);
+        blocks.push(ui.p(`Points: ${ui.bold(`${achieved}/${total}`)} ${ui.dim(`(${pct}%)`)}`));
+    }
+    else {
+        const levelName = scorecard.current_level?.name ??
+            scorecard.empty_level?.label ??
+            "No level";
+        blocks.push(ui.p(`Current level: ${ui.bold(levelName)}`));
+    }
+    if (scorecard.type === "LEVEL" && scorecard.levels) {
+        for (const level of scorecard.levels) {
+            const checksInLevel = scorecard.checks.filter((check) => check.level?.id === level.id);
+            if (checksInLevel.length === 0)
+                continue;
+            blocks.push(ui.h3(level.name));
+            blocks.push(ui.ul(checksInLevel.map(scorecardCheckListItem)));
+        }
+    }
+    else if (scorecard.type === "POINTS" && scorecard.check_groups) {
+        const sortedGroups = [...scorecard.check_groups].sort((a, b) => a.ordering - b.ordering);
+        for (const group of sortedGroups) {
+            const checksInGroup = scorecard.checks.filter((check) => check.check_group?.id === group.id);
+            if (checksInGroup.length === 0)
+                continue;
+            blocks.push(ui.h3(group.name));
+            blocks.push(ui.ul(checksInGroup.map(scorecardCheckListItem)));
+        }
+    }
+    else if (scorecard.checks.length > 0) {
+        blocks.push(ui.ul(scorecard.checks.map(scorecardCheckListItem)));
+    }
+    return blocks;
+}
+function scorecardCheckListItem(check) {
+    let statusBadge;
+    if (check.status === "PASS") {
+        statusBadge = ui.success(`${ui.GLYPHS.CHECK} Passed`);
+    }
+    else if (check.status === "WARN") {
+        statusBadge = ui.warning(`${ui.GLYPHS.WARNING} Warning`);
+    }
+    else {
+        statusBadge = ui.error(`${ui.GLYPHS.ERROR} Not passed`);
+    }
+    const evalTime = check.executed_at
+        ? ui.dim(`(${dayjs(check.executed_at).fromNow()})`)
+        : "";
+    const parts = [check.name, evalTime, statusBadge].filter(Boolean);
+    return ui.li([ui.p(parts.join("  "), false)]);
+}
+function taskContent(task) {
+    const { check, initiative, owner } = task;
+    return [
+        ui.h3("Check:"),
+        ui.dl([
+            ui.dli("Name", [ui.p(check.name, false)]),
+            ui.dli("ID", [ui.p(ui.code(check.id), false)]),
+            ui.dli("External URL", [
+                ui.p(check.external_url ? ui.link(check.external_url) : ui.dim("(none)"), false),
+            ]),
+            ui.dli("Description", [
+                ui.p(check.description || ui.dim("(none)"), false),
+            ]),
+        ], { termWidth: 14 }),
+        ui.h3("Initiative:"),
+        ui.dl([
+            ui.dli("Name", [ui.p(initiative.name, false)]),
+            ui.dli("Priority", [ui.p(`P${initiative.priority}`, false)]),
+            ui.dli("Owner", [
+                ui.p(`${owner.name} (${ui.code(owner.email)})`, false),
+            ]),
+            ui.dli("Due", [ui.p(dueDateText(initiative.complete_by), false)]),
+        ], { termWidth: 10 }),
+        ui.p(ui.bold("Description:")),
+        ui.p(initiative.description || ui.dim("(none)")),
+    ];
+}
+function dueDateText(completeBy) {
+    const now = dayjs();
+    const dueDate = dayjs(completeBy);
+    const formattedDate = new Date(completeBy).toLocaleDateString(undefined, {
+        month: "short",
+        day: "numeric",
+        timeZone: "UTC",
+    });
+    if (dueDate.isBefore(now)) {
+        return ui.error(formattedDate);
+    }
+    else if (dueDate.isBefore(now.add(2, "week"))) {
+        return ui.warning(formattedDate);
+    }
+    else {
+        return formattedDate;
+    }
+}
+function coreContent(entity) {
+    return [
+        ui.dl([
+            ui.dli("Name", [ui.p(entity.name ?? ui.dim("(None)"), false)]),
+            ui.dli("Identifier", [ui.p(ui.code(entity.identifier), false)]),
+            ui.dli("Type", [ui.p(ui.code(entity.type), false)]),
+            ui.dli("Created", [
+                ui.p(ui.timestampSummary(entity.created_at), false),
+            ]),
+            ui.dli("Last updated", [ui.p(ui.timestampSummary(entity.updated_at))]),
+            ui.dli("Description", [
+                ui.p(entity.description ?? ui.dim("(None)"), false),
+            ]),
+        ], { termWidth: 14 }),
+    ];
+}
+function ownersContent(entity) {
+    const results = [];
+    const teamCount = entity.owner_teams?.length ?? 0;
+    const userCount = entity.owner_users?.length ?? 0;
+    if (teamCount === 0 && userCount === 0) {
+        results.push(ui.p(ui.dim("(No owners assigned)")));
+    }
+    if (entity.owner_teams && teamCount > 0) {
+        results.push(ui.p(ui.bold("Teams:")));
+        results.push(ui.ul([
+            ...entity.owner_teams.map((team) => ui.li([ui.p(`${team.name} (${team.id})`, false)])),
+        ]));
+    }
+    if (entity.owner_users && userCount > 0) {
+        results.push(ui.p(ui.bold("Users:")));
+        results.push(ui.ul([
+            ...entity.owner_users.map((user) => ui.li([ui.p(`${user.email} (${user.id})`, false)])),
+        ]));
+    }
+    return results;
+}
+function propertiesContent(entity) {
+    const propertiesListItems = [];
+    for (const [identifier, value] of Object.entries(entity.properties)) {
+        const serialized = propertyValueContent(identifier, value);
+        if (typeof serialized === "string") {
+            propertiesListItems.push(ui.li([ui.p(`${ui.bold(identifier)}: ${serialized}`, false)]));
+        }
+        else {
+            propertiesListItems.push(ui.li([ui.p(`${ui.bold(identifier)}:`, false), serialized]));
+        }
+    }
+    return [ui.ul(propertiesListItems)];
+}
+function aliasesContent(entity) {
+    return [ui.json({ ...entity.aliases })];
+}
+function propertyValueContent(identifier, value) {
+    // Property-specific
+    if (isFileMatchingRule(value)) {
+        const matchText = value.match_count === 1 ? "match" : "matches";
+        return `File matching rule: ${ui.code(value.status)} (${value.match_count} ${matchText})`;
+    }
+    else if (isUrl(value)) {
+        return ui.link(value);
+    }
+    // Primitives
+    if (value === null) {
+        return ui.code("null");
+    }
+    else if (typeof value === "string") {
+        return value;
+    }
+    else if (typeof value === "number") {
+        return value.toString();
+    }
+    else if (typeof value === "boolean") {
+        return value.toString();
+    }
+    // General arrays
+    if (isStringArray(value)) {
+        return value.join(", ");
+    }
+    // Fallback to JSON
+    return ui.json(value);
+}
+function isStringArray(value) {
+    return (Array.isArray(value) && value.every((item) => typeof item === "string"));
+}
+function isUrl(value) {
+    if (typeof value !== "string" || !value.startsWith("http")) {
+        return false;
+    }
+    try {
+        new URL(value);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function isFileMatchingRule(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        typeof value === "object" &&
+        "status" in value &&
+        typeof value.status === "string" &&
+        ["FOUND_MATCHES", "NO_MATCHES", "FILE_NOT_FOUND"].includes(value.status));
+}

package/dist/commands/catalog/entity-type-blank-template.yaml

@@ -0,0 +1,51 @@
+# Entity type configuration
+#
+# Edit this file, then run:
+#
+# ```
+# dx catalog entityTypes create --from-file <path>
+# ```
+#
+# After the entity type is created, make updates by running:
+#
+# ```
+# dx catalog entityTypes update <identifier> --from-file <path>
+# ```
+
+identifier: ""
+name: ""
+description: ""
+icon: server
+
+# Properties for this entity type (optional)
+properties:
+  - identifier: tier
+    name: Tier
+    type: select
+    description: null
+    definition:
+      options:
+        - value: Tier-1
+          color: "#ef4444"
+        - value: Tier-2
+          color: "#fbbf24"
+        - value: Tier-3
+          color: "#38bdf8"
+    is_required: false
+    visibility: visible
+    ordering: 0
+  - identifier: incident-runbook
+    name: Incident runbook
+    type: url
+    description: null
+    definition:
+      call_to_action: globe
+      call_to_action_type: icon
+    is_required: false
+    visibility: visible
+    ordering: 1
+
+# Aliases available for this entity type (optional)
+# aliases:
+#   github_repo: true
+aliases: {}