Audit pass: hoist scope enum, extend helpers to MRT, migrate confirms

clavery · clavery · commit 1c8e419ac900 · 2026-05-07T18:31:51.000-04:00
Acts on findings from a post-merge audit covering both this branch and recently-merged main work: SDK: - Export ACCESS_KEY_SCOPES + AccessKeyScope from operations/bm-users so the 4 access-key CLI commands no longer redeclare the same tuple. - Refresh stale doc comment on getBmUserAccessKey (referenced removed example values 'WEBDAV', 'OCAPI', 'SCAPI'). - printFieldsBlock now accepts null in addition to undefined and skips both, matching the common shape of optional OpenAPI fields. New DetailValue type alias exported. CLI — apply our helpers to MRT commands main introduced in PR #407: - mrt/org/cert/list and mrt/org/member/list now use TableRenderer + columnFlagsFor + selectColumns instead of inline createTable. - mrt/org/cert/get and mrt/org/member/get now use printFieldsBlock instead of inline cliui label/value rendering. CLI — finish the @inquirer/prompts -> SDK ux migration begun in main: - setup, setup/instance/remove, sandbox/reset, sandbox/alias/delete, and mrt/env/var/push now use confirm() from @salesforce/b2c-tooling-sdk/ux. The two remaining @inquirer/prompts importers (setup/skills, setup/instance/create) need more than just confirm so they stay as-is for now.
diff --git a/packages/b2c-cli/src/commands/bm/access-key/create.ts b/packages/b2c-cli/src/commands/bm/access-key/create.ts
@@ -5,13 +5,15 @@
  */
 import {Args, Flags} from '@oclif/core';
 import {printFieldsBlock} from '@salesforce/b2c-tooling-sdk/cli';
-import {createBmUserAccessKey, type BmAccessKeyDetails} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
+import {
+  ACCESS_KEY_SCOPES,
+  createBmUserAccessKey,
+  type BmAccessKeyDetails,
+} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
 import {BmUserAuthCommand} from '../../../utils/bm/user-auth-command.js';
 import {resolveLoginOrWhoami} from '../../../utils/bm/resolve-login.js';
 import {t} from '../../../i18n/index.js';
 
-const ACCESS_KEY_SCOPES = ['WEBDAV_AND_STUDIO', 'AGENT_USER_AND_OCAPI', 'STOREFRONT'] as const;
-
 export default class BmAccessKeyCreate extends BmUserAuthCommand<typeof BmAccessKeyCreate> {
   static args = {
     login: Args.string({
diff --git a/packages/b2c-cli/src/commands/bm/access-key/delete.ts b/packages/b2c-cli/src/commands/bm/access-key/delete.ts
@@ -4,14 +4,12 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import {Args, Flags} from '@oclif/core';
-import {deleteBmUserAccessKey} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
+import {ACCESS_KEY_SCOPES, deleteBmUserAccessKey} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
 import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 import {BmUserAuthCommand} from '../../../utils/bm/user-auth-command.js';
 import {resolveLoginOrWhoami} from '../../../utils/bm/resolve-login.js';
 import {t} from '../../../i18n/index.js';
 
-const ACCESS_KEY_SCOPES = ['WEBDAV_AND_STUDIO', 'AGENT_USER_AND_OCAPI', 'STOREFRONT'] as const;
-
 interface DeleteResult {
   success: boolean;
   login: string;
diff --git a/packages/b2c-cli/src/commands/bm/access-key/get.ts b/packages/b2c-cli/src/commands/bm/access-key/get.ts
@@ -5,13 +5,15 @@
  */
 import {Args, Flags} from '@oclif/core';
 import {printFieldsBlock} from '@salesforce/b2c-tooling-sdk/cli';
-import {getBmUserAccessKey, type BmAccessKeyDetails} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
+import {
+  ACCESS_KEY_SCOPES,
+  getBmUserAccessKey,
+  type BmAccessKeyDetails,
+} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
 import {BmUserAuthCommand} from '../../../utils/bm/user-auth-command.js';
 import {resolveLoginOrWhoami} from '../../../utils/bm/resolve-login.js';
 import {t} from '../../../i18n/index.js';
 
-const ACCESS_KEY_SCOPES = ['WEBDAV_AND_STUDIO', 'AGENT_USER_AND_OCAPI', 'STOREFRONT'] as const;
-
 export default class BmAccessKeyGet extends BmUserAuthCommand<typeof BmAccessKeyGet> {
   static args = {
     login: Args.string({
diff --git a/packages/b2c-cli/src/commands/bm/access-key/set.ts b/packages/b2c-cli/src/commands/bm/access-key/set.ts
@@ -4,13 +4,15 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import {Args, Flags} from '@oclif/core';
-import {setBmUserAccessKeyEnabled, type BmAccessKeyDetails} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
+import {
+  ACCESS_KEY_SCOPES,
+  setBmUserAccessKeyEnabled,
+  type BmAccessKeyDetails,
+} from '@salesforce/b2c-tooling-sdk/operations/bm-users';
 import {BmUserAuthCommand} from '../../../utils/bm/user-auth-command.js';
 import {resolveLoginOrWhoami} from '../../../utils/bm/resolve-login.js';
 import {t} from '../../../i18n/index.js';
 
-const ACCESS_KEY_SCOPES = ['WEBDAV_AND_STUDIO', 'AGENT_USER_AND_OCAPI', 'STOREFRONT'] as const;
-
 export default class BmAccessKeySet extends BmUserAuthCommand<typeof BmAccessKeySet> {
   static args = {
     login: Args.string({
diff --git a/packages/b2c-cli/src/commands/mrt/env/var/push.ts b/packages/b2c-cli/src/commands/mrt/env/var/push.ts
@@ -7,7 +7,7 @@ import {readFileSync} from 'node:fs';
 import {resolve} from 'node:path';
 import {parseEnv} from 'node:util';
 import {Flags, ux} from '@oclif/core';
-import {confirm} from '@inquirer/prompts';
+import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 import {MrtCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {listEnvVars, setEnvVar, setEnvVars} from '@salesforce/b2c-tooling-sdk/operations/mrt';
 import {t, withDocs} from '../../../../i18n/index.js';
@@ -149,7 +149,7 @@ export default class MrtEnvVarPush extends MrtCommand<typeof MrtEnvVarPush> {
           environment,
         },
       );
-      const confirmed = await confirm({message, default: false});
+      const confirmed = await confirm(message);
       if (!confirmed) {
         ux.stdout(t('commands.mrt.env.var.push.aborted', 'Aborted.'));
         return {pushed: 0, failed: 0, skipped: diff.remoteOnly.length};
diff --git a/packages/b2c-cli/src/commands/mrt/org/cert/get.ts b/packages/b2c-cli/src/commands/mrt/org/cert/get.ts
@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
-import {Args, Flags, ux} from '@oclif/core';
-import cliui from 'cliui';
-import {MrtCommand} from '@salesforce/b2c-tooling-sdk/cli';
+import {Args, Flags} from '@oclif/core';
+import {MrtCommand, printFieldsBlock} from '@salesforce/b2c-tooling-sdk/cli';
 import {getCertificate, type MrtCertificate} from '@salesforce/b2c-tooling-sdk/operations/mrt';
 import {t, withDocs} from '../../../../i18n/index.js';
 
@@ -40,18 +39,16 @@ export default class MrtOrgCertGet extends MrtCommand<typeof MrtOrgCertGet> {
     );
 
     if (!this.jsonEnabled()) {
-      const ui = cliui({width: process.stdout.columns || 80});
-      const w = 24;
-      ui.div('');
-      ui.div({text: 'ID:', width: w}, {text: cert.id?.toString() ?? '-'});
-      ui.div({text: 'Domain:', width: w}, {text: cert.domain_name ?? '-'});
-      ui.div({text: 'Validation Status:', width: w}, {text: cert.validation_status ?? '-'});
-      ui.div({text: 'Validation Record:', width: w}, {text: cert.validation_record ?? '-'});
-      ui.div({text: 'Validation Requested:', width: w}, {text: cert.validation_requested_at ?? '-'});
-      ui.div({text: 'Expires:', width: w}, {text: cert.expires_at ?? '-'});
-      ui.div({text: 'Renewal Status:', width: w}, {text: (cert.renewal_status as null | string) ?? '-'});
-      ui.div({text: 'Renewal Eligibility:', width: w}, {text: (cert.renewal_eligibility as null | string) ?? '-'});
-      ux.stdout(ui.toString());
+      printFieldsBlock('Certificate', [
+        ['ID', cert.id?.toString()],
+        ['Domain', cert.domain_name],
+        ['Validation Status', cert.validation_status],
+        ['Validation Record', cert.validation_record],
+        ['Validation Requested', cert.validation_requested_at],
+        ['Expires', cert.expires_at],
+        ['Renewal Status', cert.renewal_status as null | string | undefined],
+        ['Renewal Eligibility', cert.renewal_eligibility as null | string | undefined],
+      ]);
     }
 
     return cert;
diff --git a/packages/b2c-cli/src/commands/mrt/org/cert/list.ts b/packages/b2c-cli/src/commands/mrt/org/cert/list.ts
@@ -4,7 +4,13 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import {Flags} from '@oclif/core';
-import {MrtCommand, createTable, type ColumnDef} from '@salesforce/b2c-tooling-sdk/cli';
+import {
+  MrtCommand,
+  TableRenderer,
+  columnFlagsFor,
+  selectColumns,
+  type ColumnDef,
+} from '@salesforce/b2c-tooling-sdk/cli';
 import {
   listCertificates,
   type ListCertificatesResult,
@@ -25,6 +31,8 @@ const COLUMNS: Record<string, ColumnDef<MrtCertificateListCreate>> = {
 
 const DEFAULT_COLUMNS = ['id', 'domain', 'validation', 'expires', 'renewal'];
 
+const tableRenderer = new TableRenderer(COLUMNS);
+
 export default class MrtOrgCertList extends MrtCommand<typeof MrtOrgCertList> {
   static description = withDocs(
     t('commands.mrt.org.cert.list.description', 'List custom domain certificates for an organization'),
@@ -45,6 +53,7 @@ export default class MrtOrgCertList extends MrtCommand<typeof MrtOrgCertList> {
     offset: Flags.integer({description: 'Offset for pagination'}),
     search: Flags.string({description: 'Search term for filtering'}),
     'custom-only': Flags.boolean({description: 'Show only customer-managed certificates'}),
+    ...columnFlagsFor(COLUMNS),
   };
 
   async run(): Promise<ListCertificatesResult> {
@@ -69,7 +78,10 @@ export default class MrtOrgCertList extends MrtCommand<typeof MrtOrgCertList> {
         this.log(t('commands.mrt.org.cert.list.empty', 'No certificates found.'));
       } else {
         this.log(t('commands.mrt.org.cert.list.count', 'Found {{count}} certificate(s):', {count: result.count}));
-        createTable(COLUMNS).render(result.certificates, DEFAULT_COLUMNS);
+        tableRenderer.render(
+          result.certificates,
+          selectColumns(this.flags, tableRenderer, DEFAULT_COLUMNS, this.warn.bind(this)),
+        );
       }
     }
 
diff --git a/packages/b2c-cli/src/commands/mrt/org/member/get.ts b/packages/b2c-cli/src/commands/mrt/org/member/get.ts
@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
-import {Args, Flags, ux} from '@oclif/core';
-import cliui from 'cliui';
-import {MrtCommand} from '@salesforce/b2c-tooling-sdk/cli';
+import {Args, Flags} from '@oclif/core';
+import {MrtCommand, printFieldsBlock} from '@salesforce/b2c-tooling-sdk/cli';
 import {
   getOrgMember,
   ORG_ROLES,
@@ -45,18 +44,13 @@ export default class MrtOrgMemberGet extends MrtCommand<typeof MrtOrgMemberGet>
     );
 
     if (!this.jsonEnabled()) {
-      const ui = cliui({width: process.stdout.columns || 80});
-      const w = 22;
-      ui.div('');
-      ui.div({text: 'Email:', width: w}, {text: member.email ?? member.user ?? '-'});
-      ui.div({text: 'Name:', width: w}, {text: [member.first_name, member.last_name].filter(Boolean).join(' ') || '-'});
-      ui.div({text: 'Role:', width: w}, {text: ORG_ROLES[member.role as OrgRoleValue] ?? String(member.role)});
-      ui.div({text: 'View All Projects:', width: w}, {text: member.can_view_all_projects ? 'Yes' : 'No'});
-      ui.div(
-        {text: 'Cert Permission:', width: w},
-        {text: member.custom_domain_cert_permission === 2 ? 'Enabled' : 'Disabled'},
-      );
-      ux.stdout(ui.toString());
+      printFieldsBlock('Member', [
+        ['Email', member.email ?? member.user ?? undefined],
+        ['Name', [member.first_name, member.last_name].filter(Boolean).join(' ') || undefined],
+        ['Role', ORG_ROLES[member.role as OrgRoleValue] ?? String(member.role)],
+        ['View All Projects', member.can_view_all_projects ? 'Yes' : 'No'],
+        ['Cert Permission', member.custom_domain_cert_permission === 2 ? 'Enabled' : 'Disabled'],
+      ]);
     }
 
     return member;
diff --git a/packages/b2c-cli/src/commands/mrt/org/member/list.ts b/packages/b2c-cli/src/commands/mrt/org/member/list.ts
@@ -4,7 +4,13 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import {Flags} from '@oclif/core';
-import {MrtCommand, createTable, type ColumnDef} from '@salesforce/b2c-tooling-sdk/cli';
+import {
+  MrtCommand,
+  TableRenderer,
+  columnFlagsFor,
+  selectColumns,
+  type ColumnDef,
+} from '@salesforce/b2c-tooling-sdk/cli';
 import {
   listOrgMembers,
   ORG_ROLES,
@@ -39,6 +45,8 @@ const COLUMNS: Record<string, ColumnDef<MrtOrgMember>> = {
 
 const DEFAULT_COLUMNS = ['email', 'name', 'role', 'allProjects', 'certPerm'];
 
+const tableRenderer = new TableRenderer(COLUMNS);
+
 export default class MrtOrgMemberList extends MrtCommand<typeof MrtOrgMemberList> {
   static description = withDocs(
     t('commands.mrt.org.member.list.description', 'List members of a Managed Runtime organization'),
@@ -61,6 +69,7 @@ export default class MrtOrgMemberList extends MrtCommand<typeof MrtOrgMemberList
     limit: Flags.integer({description: 'Maximum number of results to return'}),
     offset: Flags.integer({description: 'Offset for pagination'}),
     search: Flags.string({description: 'Search term for filtering'}),
+    ...columnFlagsFor(COLUMNS),
   };
 
   async run(): Promise<ListOrgMembersResult> {
@@ -84,7 +93,10 @@ export default class MrtOrgMemberList extends MrtCommand<typeof MrtOrgMemberList
         this.log(t('commands.mrt.org.member.list.empty', 'No members found.'));
       } else {
         this.log(t('commands.mrt.org.member.list.count', 'Found {{count}} member(s):', {count: result.count}));
-        createTable(COLUMNS).render(result.members, DEFAULT_COLUMNS);
+        tableRenderer.render(
+          result.members,
+          selectColumns(this.flags, tableRenderer, DEFAULT_COLUMNS, this.warn.bind(this)),
+        );
       }
     }
 
diff --git a/packages/b2c-cli/src/commands/sandbox/alias/delete.ts b/packages/b2c-cli/src/commands/sandbox/alias/delete.ts
@@ -7,7 +7,7 @@ import {Args, Flags} from '@oclif/core';
 import {OdsCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {getApiErrorMessage} from '@salesforce/b2c-tooling-sdk';
 import {t, withDocs} from '../../../i18n/index.js';
-import {confirm} from '@inquirer/prompts';
+import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 
 /**
  * Command to delete a sandbox alias.
@@ -58,10 +58,9 @@ export default class SandboxAliasDelete extends OdsCommand<typeof SandboxAliasDe
 
     // Confirmation prompt (skip if --force or --json)
     if (!force && !this.jsonEnabled()) {
-      const confirmed = await confirm({
-        message: t('commands.sandbox.alias.delete.confirm', 'Delete alias {{aliasId}}?', {aliasId}),
-        default: false,
-      });
+      const confirmed = await confirm(
+        t('commands.sandbox.alias.delete.confirm', 'Delete alias {{aliasId}}?', {aliasId}),
+      );
 
       if (!confirmed) {
         this.log(t('commands.sandbox.alias.delete.cancelled', 'Delete cancelled'));
diff --git a/packages/b2c-cli/src/commands/sandbox/reset.ts b/packages/b2c-cli/src/commands/sandbox/reset.ts
@@ -7,7 +7,7 @@ import {Args, Flags} from '@oclif/core';
 import {OdsCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {getApiErrorMessage, waitForSandbox, type OdsComponents} from '@salesforce/b2c-tooling-sdk';
 import {t, withDocs} from '../../i18n/index.js';
-import {confirm} from '@inquirer/prompts';
+import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 
 type SandboxOperationModel = OdsComponents['schemas']['SandboxOperationModel'];
 
@@ -73,10 +73,9 @@ export default class SandboxReset extends OdsCommand<typeof SandboxReset> {
 
     // Confirmation prompt (skip if --force or --json)
     if (!force && !this.jsonEnabled()) {
-      const confirmed = await confirm({
-        message: `⚠️  Reset will permanently delete all data and code in sandbox ${this.args.sandboxId}. Continue?`,
-        default: false,
-      });
+      const confirmed = await confirm(
+        `⚠️  Reset will permanently delete all data and code in sandbox ${this.args.sandboxId}. Continue?`,
+      );
 
       if (!confirmed) {
         this.log(t('commands.sandbox.reset.cancelled', 'Reset cancelled'));
diff --git a/packages/b2c-cli/src/commands/setup/index.ts b/packages/b2c-cli/src/commands/setup/index.ts
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
-import {confirm} from '@inquirer/prompts';
+import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 import {BaseCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {withDocs} from '../../i18n/index.js';
 
@@ -30,10 +30,7 @@ export default class SetupIndex extends BaseCommand<typeof SetupIndex> {
     const isTTY = Boolean(process.stdin.isTTY && process.stdout.isTTY);
 
     if (!hasInstance && isTTY) {
-      const shouldCreate = await confirm({
-        message: 'No instance configured. Would you like to set one up?',
-        default: true,
-      });
+      const shouldCreate = await confirm('No instance configured. Would you like to set one up?', {defaultYes: true});
 
       if (shouldCreate) {
         await this.config.runCommand('setup:instance:create');
diff --git a/packages/b2c-cli/src/commands/setup/instance/remove.ts b/packages/b2c-cli/src/commands/setup/instance/remove.ts
@@ -4,7 +4,7 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import {Args, Flags, ux} from '@oclif/core';
-import {confirm} from '@inquirer/prompts';
+import {confirm} from '@salesforce/b2c-tooling-sdk/ux';
 import {BaseCommand} from '@salesforce/b2c-tooling-sdk/cli';
 import {DwJsonSource} from '@salesforce/b2c-tooling-sdk/config';
 import {withDocs} from '../../../i18n/index.js';
@@ -67,10 +67,7 @@ export default class SetupInstanceRemove extends BaseCommand<typeof SetupInstanc
 
     // Confirm removal
     if (!this.flags.force) {
-      const proceed = await confirm({
-        message: `Remove instance "${name}"? This cannot be undone.`,
-        default: false,
-      });
+      const proceed = await confirm(`Remove instance "${name}"? This cannot be undone.`);
 
       if (!proceed) {
         ux.stdout('Instance removal cancelled.');
diff --git a/packages/b2c-tooling-sdk/src/cli/details.ts b/packages/b2c-tooling-sdk/src/cli/details.ts
@@ -19,18 +19,23 @@ import cliui from 'cliui';
  * A single label / value pair. Tuple form is supported as a shorthand —
  * `['Login', 'user@example.com']` is equivalent to `{label: 'Login', value: 'user@example.com'}`.
  *
- * Values that are `undefined` are skipped entirely (the row is not rendered).
- * `null` is rendered as the literal string "null" — coerce to `undefined` if
- * you want it suppressed instead.
+ * Values that are `null` or `undefined` are skipped entirely (the row is not
+ * rendered). This matches the common shape of optional fields in OpenAPI
+ * responses where missing data is `null`.
  */
-export type DetailField = [label: string, value: string | number | boolean | undefined] | DetailFieldObject;
+export type DetailField = [label: string, value: DetailValue] | DetailFieldObject;
+
+/**
+ * Allowed scalar values for a detail field.
+ */
+export type DetailValue = string | number | boolean | null | undefined;
 
 /**
  * Object form of a {@link DetailField} entry.
  */
 export interface DetailFieldObject {
   label: string;
-  value: string | number | boolean | undefined;
+  value: DetailValue;
 }
 
 /**
@@ -67,7 +72,7 @@ function normalizeField(field: DetailField): DetailFieldObject {
 function renderFields(ui: ReturnType<typeof cliui>, fields: DetailField[], labelWidth: number): void {
   for (const raw of fields) {
     const {label, value} = normalizeField(raw);
-    if (value === undefined) continue;
+    if (value === undefined || value === null) continue;
     ui.div({text: `${label}:`, width: labelWidth, padding: [0, 2, 0, 0]}, {text: String(value), padding: [0, 0, 0, 0]});
   }
 }
diff --git a/packages/b2c-tooling-sdk/src/cli/index.ts b/packages/b2c-tooling-sdk/src/cli/index.ts
@@ -143,4 +143,4 @@ export type {ColumnDef, TableRenderOptions} from './table.js';
 export {columnFlagsFor, selectColumns} from './columns.js';
 export type {ColumnFlags, ColumnFlagsOptions, WarnFn} from './columns.js';
 export {printFieldsBlock} from './details.js';
-export type {DetailField, DetailFieldObject, DetailSection, PrintFieldsBlockOptions} from './details.js';
+export type {DetailField, DetailFieldObject, DetailSection, DetailValue, PrintFieldsBlockOptions} from './details.js';
diff --git a/packages/b2c-tooling-sdk/src/operations/bm-users/index.ts b/packages/b2c-tooling-sdk/src/operations/bm-users/index.ts
diff --git a/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts b/packages/b2c-tooling-sdk/src/operations/bm-users/users.ts
