@get-dx/cli 0.3.6 → 0.3.8

package/dist/commands/catalog/entities.js

@@ -19,6 +19,7 @@ export function entitiesCommand() {
         .option("--name <name>", "Display name of the entity")
         .option("--description <desc>", "Description of the entity")
         .option("--owner-team-ids <ids>", "Comma-separated owner team IDs")
+        .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties.", (val, prev) => [...prev, val], [])
         .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases.", (val, prev) => [...prev, val], [])
@@ -57,12 +58,9 @@ export function entitiesCommand() {
             type: options.type,
             name: options.name,
             description: options.description,
-            owner_team_ids: options.ownerTeamIds
-                ?.split(",")
-                .map((s) => s.trim()),
-            owner_user_ids: options.ownerUserIds
-                ?.split(",")
-                .map((s) => s.trim()),
+            owner_team_ids: parseCommaSeparatedValues(options.ownerTeamIds),
+            owner_user_emails: parseCommaSeparatedValues(options.ownerUserEmails),
+            owner_user_ids: parseCommaSeparatedValues(options.ownerUserIds),
             ...resolvedValues,
         });
         if (runtime.context.json) {
@@ -103,6 +101,7 @@ export function entitiesCommand() {
         .option("--name <name>", "Display name of the entity")
         .option("--description <desc>", "Description of the entity")
         .option("--owner-team-ids <ids>", "Comma-separated owner team IDs")
+        .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties. Use value null to remove a property.", (val, prev) => [...prev, val], [])
         .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
@@ -146,6 +145,7 @@ export function entitiesCommand() {
         .option("--name <name>", "Display name of the entity")
         .option("--description <desc>", "Description of the entity")
         .option("--owner-team-ids <ids>", "Comma-separated owner team IDs")
+        .option("--owner-user-emails <emails>", "Comma-separated owner user emails")
         .option("--owner-user-ids <ids>", "Comma-separated owner user IDs")
         .option("--property <kv>", "Set a property value as key=value. Repeat for multiple properties. Use value null to remove a property.", (val, prev) => [...prev, val], [])
         .option("--alias <kv>", "Set an alias value as key=value. Repeat for multiple aliases. Use value null to remove an alias.", (val, prev) => [...prev, val], [])
@@ -300,8 +300,10 @@ export function entitiesCommand() {
         .command("scorecards")
         .description("Get the current scorecard report for an entity")
         .argument("<identifier>", "Entity identifier")
+        .option("--check-ids <ids>", "Comma-separated check IDs to filter the report to")
         .option("--cursor <cursor>", "Cursor for the next page of results")
         .option("--limit <n>", "Max scorecards per page (default is 50)", (value) => parsePositiveIntOption(value, "--limit"))
+        .option("--only-failing", "Return only checks that are not passing (exempted failing checks are still included)")
         .addHelpText("afterAll", createExampleText([
         {
             label: "Get scorecards for the `login-frontend` entity",
@@ -315,12 +317,22 @@ export function entitiesCommand() {
             label: "Fetch the next page of scorecards",
             command: "dx catalog entities scorecards login-frontend --cursor xuvkgfq9t0ty",
         },
+        {
+            label: "Show only checks that are not passing",
+            command: "dx catalog entities scorecards login-frontend --only-failing",
+        },
+        {
+            label: "Filter the report to specific checks",
+            command: "dx catalog entities scorecards login-frontend --check-ids NDQ,NTU",
+        },
     ]))
         .action(wrapAction(async (identifier, options, command) => {
         const runtime = await buildRuntime(getContext(command));
         const response = await getEntityScorecards(runtime, identifier, {
+            check_ids: parseCommaSeparatedValues(options.checkIds),
             cursor: options.cursor,
             limit: options.limit,
+            only_failing: options.onlyFailing,
         });
         if (runtime.context.json) {
             renderJson(response);
@@ -383,11 +395,18 @@ async function upsertEntity(runtime, identifier, params) {
     return response.body;
 }
 async function getEntityScorecards(runtime, identifier, params) {
-    const query = { identifier };
+    const query = {
+        identifier,
+    };
     if (params.cursor !== undefined)
         query.cursor = params.cursor;
     if (params.limit !== undefined)
         query.limit = params.limit;
+    if (params.only_failing)
+        query.only_failing = true;
+    if (params.check_ids !== undefined && params.check_ids.length > 0) {
+        query.check_ids = params.check_ids.join(",");
+    }
     const response = await request(runtime, "/catalog.entities.scorecards", {
         method: "GET",
         query,
@@ -585,11 +604,12 @@ function getEntityMutationOptionValues(options) {
     return {
         name: options.name,
         description: options.description,
-        owner_team_ids: parseCommaSeparatedIds(options.ownerTeamIds),
-        owner_user_ids: parseCommaSeparatedIds(options.ownerUserIds),
+        owner_team_ids: parseCommaSeparatedValues(options.ownerTeamIds),
+        owner_user_emails: parseCommaSeparatedValues(options.ownerUserEmails),
+        owner_user_ids: parseCommaSeparatedValues(options.ownerUserIds),
     };
 }
-function parseCommaSeparatedIds(value) {
+function parseCommaSeparatedValues(value) {
     if (value === undefined) {
         return undefined;
     }
@@ -610,6 +630,8 @@ function buildEntityMutationBody(identifier, params) {
         body.description = params.description;
     if (params.owner_team_ids?.length)
         body.owner_team_ids = params.owner_team_ids;
+    if (params.owner_user_emails?.length)
+        body.owner_user_emails = params.owner_user_emails;
     if (params.owner_user_ids?.length)
         body.owner_user_ids = params.owner_user_ids;
     if (params.properties !== undefined)

package/package.json

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