@get-dx/cli 0.10.0 → 0.11.0

package/dist/commands/catalog/relationsRendering.js

@@ -24,6 +24,7 @@ export function renderRelationDeleted(relation) {
 function relationContent(relation) {
     return [
         ui.dl([
+            ui.dli("Public ID", ui.code(relation.public_id)),
             ui.dli("Identifier", ui.code(relation.identifier)),
             ui.dli("Relation", `${ui.code(relation.source_entity_type_identifier)} ${relation.type} ${ui.code(relation.target_entity_type_identifier)}`),
             ui.dli("Type", relation.type),

package/dist/commands/scorecard-blank-template.yaml

@@ -28,6 +28,11 @@ entity_filter_type_identifiers:
 # SQL filter expression (when entity_filter_type is "sql")
 entity_filter_sql: ""
 
+# Optional: default view when looking at the scorecard's results. Set to null to clear.
+# default_display_entity_type_identifier: service
+# default_display_grouping: owner_team  # entity, owner_team, owner_leaf, or relation:<relation_id>
+#   (relation groupings require default_display_entity_type_identifier)
+
 # User IDs of editors
 editors: []
 

package/dist/commands/scorecards.js

@@ -439,6 +439,8 @@ const SCORECARD_SECTION_KEYS = {
         "entity_filter_type",
         "entity_filter_sql",
         "entity_filter_type_ids",
+        "default_display_entity_type_identifier",
+        "default_display_grouping",
         "tags",
         "sql_errors",
         "levels",

package/dist/commands/users/update.js

@@ -0,0 +1,207 @@
+import { Command, Option } from "commander";
+import { createExampleText, getContext, parseCommaSeparatedValues, wrapAction, } from "../../commandHelpers.js";
+import { CliError, EXIT_CODES } from "../../errors.js";
+import { requestWithMessages } from "../../http.js";
+import { renderJson, renderRichText } from "../../renderers.js";
+import { buildRuntime } from "../../runtime.js";
+import * as ui from "../../ui.js";
+const PROPERTIES = [
+    {
+        key: "start_date",
+        label: "Start date",
+        valueName: "date",
+        description: "Start date as YYYY-MM-DD, or null to clear it",
+        parse: parseDate,
+    },
+    {
+        key: "github_username",
+        label: "GitHub username",
+        valueName: "username",
+        description: "GitHub username, or null to clear it",
+        parse: parseText,
+    },
+    {
+        key: "additional_github_username",
+        label: "Additional GitHub username",
+        valueName: "username",
+        description: "Additional GitHub username, or null to clear it",
+        parse: parseText,
+    },
+    {
+        key: "gitlab_username",
+        label: "GitLab username",
+        valueName: "username",
+        description: "GitLab username, or null to clear it",
+        parse: parseText,
+    },
+    {
+        key: "ai_light_adoption_date",
+        label: "AI light adoption date",
+        valueName: "date",
+        description: "Date the user became a light AI adopter as YYYY-MM-DD, or null to clear it",
+        parse: parseDate,
+    },
+    {
+        key: "ai_moderate_adoption_date",
+        label: "AI moderate adoption date",
+        valueName: "date",
+        description: "Date the user became a moderate AI adopter as YYYY-MM-DD, or null to clear it",
+        parse: parseDate,
+    },
+    {
+        key: "ai_heavy_adoption_date",
+        label: "AI heavy adoption date",
+        valueName: "date",
+        description: "Date the user became a heavy AI adopter as YYYY-MM-DD, or null to clear it",
+        parse: parseDate,
+    },
+    {
+        key: "sso_email",
+        label: "SSO email",
+        valueName: "email",
+        description: "Alternate email used to authenticate through SAML SSO, or null to clear it",
+        parse: parseText,
+    },
+    {
+        key: "additional_emails",
+        label: "Additional emails",
+        valueName: "emails",
+        description: "Comma-separated additional email addresses. Replaces the existing list; null clears it",
+        parse: parseEmails,
+    },
+    {
+        key: "protected",
+        label: "Protected",
+        valueName: "true|false",
+        description: "Whether the user's IC metrics are de-identified",
+        parse: (value, flag) => parseBoolean(value, flag, false),
+    },
+    {
+        key: "exclude_from_snapshots",
+        label: "Exclude from snapshots",
+        valueName: "true|false",
+        description: "Whether the user is left out of snapshots",
+        parse: (value, flag) => parseBoolean(value, flag, false),
+    },
+    {
+        key: "developer",
+        label: "Developer",
+        valueName: "true|false|null",
+        description: "Whether the user is a developer: true, false, or null to clear it. Clearing only works for accounts that manage developer classification manually",
+        parse: (value, flag) => parseBoolean(value, flag, true),
+    },
+];
+const ERROR_MESSAGES = {
+    "User not found": "No active DX user has that email address. Check the spelling.",
+    "Developer must be true or false": "Only accounts that manage developer classification manually can clear the developer flag. Pass true or false instead.",
+};
+export function updateCommand() {
+    const update = new Command()
+        .name("update")
+        .description("Update the properties of a DX user")
+        .argument("<email>", "Email address of the user to update");
+    for (const property of PROPERTIES) {
+        update.addOption(new Option(`${flagFor(property)} <${property.valueName}>`, property.description));
+    }
+    return update
+        .addHelpText("afterAll", createExampleText([
+        {
+            label: "Set a user's start date and GitHub username",
+            command: "dx users update ada@example.com --start-date 2024-10-07 --github-username ada-lovelace",
+        },
+        {
+            label: "Clear a user's GitLab username",
+            command: "dx users update ada@example.com --gitlab-username null",
+        },
+        {
+            label: "Mark a user as not a developer and return JSON",
+            command: "dx users update ada@example.com --developer false --json",
+        },
+    ]))
+        .action(wrapAction(async (email, options, command) => {
+        const params = { email };
+        for (const property of PROPERTIES) {
+            const value = options[attributeNameFor(property)];
+            if (value !== undefined) {
+                params[property.key] = property.parse(value, flagFor(property));
+            }
+        }
+        if (Object.keys(params).length === 1) {
+            throw new CliError("Nothing to update. Pass at least one property option, such as --start-date or --developer. See --help for the full list.", EXIT_CODES.ARGUMENT_ERROR);
+        }
+        const runtime = await buildRuntime(getContext(command));
+        const response = await updateUser(runtime, params);
+        if (runtime.context.json) {
+            renderJson(response);
+        }
+        else {
+            renderRichText([
+                ui.p(`${ui.success(ui.GLYPHS.CHECK)} Updated user ${ui.code(response.user.email)}.`),
+                ui.dl(
+                // The API only returns protected when the account has protected_user_ic_metrics_disabled on.
+                PROPERTIES.filter(({ key }) => key !== "protected" ||
+                    response.user.protected !== undefined).map(({ key, label }) => ui.dli(label, formatValue(response.user[key]))), {
+                    termWidth: Math.max(...PROPERTIES.map(({ label }) => label.length)) +
+                        2,
+                }),
+            ]);
+        }
+    }));
+}
+function flagFor(property) {
+    return `--${property.key.replace(/_/g, "-")}`;
+}
+function attributeNameFor(property) {
+    return new Option(flagFor(property)).attributeName();
+}
+function formatValue(value) {
+    if (Array.isArray(value)) {
+        return value.length > 0 ? value.join(", ") : "unset";
+    }
+    return String(value ?? "unset");
+}
+function parseText(value) {
+    return value === "null" ? null : value;
+}
+function parseDate(value, flag) {
+    if (value === "null") {
+        return null;
+    }
+    // JS rolls 2024-02-30 over to March 1, so compare the round trip.
+    const date = new Date(`${value}T00:00:00Z`);
+    if (!/^\d{4}-\d{2}-\d{2}$/.test(value) ||
+        Number.isNaN(date.getTime()) ||
+        !date.toISOString().startsWith(value)) {
+        throw new CliError(`${flag} must be a date formatted as YYYY-MM-DD, or null`, EXIT_CODES.ARGUMENT_ERROR);
+    }
+    return value;
+}
+function parseEmails(value, flag) {
+    if (value === "null") {
+        return null;
+    }
+    const emails = parseCommaSeparatedValues(value);
+    if (emails === undefined) {
+        throw new CliError(`${flag} needs at least one email address, or null to clear the list`, EXIT_CODES.ARGUMENT_ERROR);
+    }
+    return emails;
+}
+function parseBoolean(value, flag, allowNull) {
+    const normalized = value.trim().toLowerCase();
+    if (normalized === "true") {
+        return true;
+    }
+    if (normalized === "false") {
+        return false;
+    }
+    if (allowNull && normalized === "null") {
+        return null;
+    }
+    throw new CliError(`${flag} must be ${allowNull ? "true, false, or null" : "true or false"}`, EXIT_CODES.ARGUMENT_ERROR);
+}
+async function updateUser(runtime, params) {
+    return requestWithMessages(runtime, "/users.update", {
+        method: "POST",
+        body: params,
+    }, ERROR_MESSAGES);
+}

package/dist/commands/users.js

@@ -1,9 +1,11 @@
 import { Command } from "commander";
 import { linkableAccountsCommand } from "./users/linkableAccounts.js";
 import { linksCommand } from "./users/links.js";
+import { updateCommand } from "./users/update.js";
 export function usersCommand() {
     const users = new Command().name("users").description("Manage DX users");
     users.addCommand(linkableAccountsCommand());
     users.addCommand(linksCommand());
+    users.addCommand(updateCommand());
     return users;
 }

package/package.json

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