Standardise output for missing or optional fields

README.md

@@ -151,7 +151,7 @@ $ ably-interactive
 * [`ably logs push subscribe`](#ably-logs-push-subscribe)
 * [`ably logs subscribe`](#ably-logs-subscribe)
 * [`ably push`](#ably-push)
-* [`ably push batch-publish [PAYLOAD]`](#ably-push-batch-publish)
+* [`ably push batch-publish [PAYLOAD]`](#ably-push-batch-publish-payload)
 * [`ably push channels`](#ably-push-channels)
 * [`ably push channels list`](#ably-push-channels-list)
 * [`ably push channels list-channels`](#ably-push-channels-list-channels)

src/commands/accounts/current.ts

@@ -122,9 +122,9 @@ export default class AccountsCurrent extends ControlBaseCommand {
           {
             account: {
               cached: true,
-              name: currentAccount.accountName || "Unknown",
-              id: currentAccount.accountId || "Unknown ID",
-              user: { email: currentAccount.userEmail || null },
+              name: currentAccount.accountName,
+              id: currentAccount.accountId,
+              user: { email: currentAccount.userEmail },
               warning:
                 "Unable to verify account information. Your access token may have expired.",
             },
@@ -142,11 +142,9 @@ export default class AccountsCurrent extends ControlBaseCommand {
         );
 
         // Show cached information
-        if (currentAccount.accountName || currentAccount.accountId) {
-          this.log(
-            `${formatLabel("Account (cached)")} ${chalk.cyan.bold(currentAccount.accountName || "Unknown")} ${chalk.gray(`(${currentAccount.accountId || "Unknown ID"})`)}`,
-          );
-        }
+        this.log(
+          `${formatLabel("Account (cached)")} ${chalk.cyan.bold(currentAccount.accountName)} ${chalk.gray(`(${currentAccount.accountId})`)}`,
+        );
 
         if (currentAccount.userEmail) {
           this.log(

src/commands/accounts/list.ts

@@ -47,10 +47,10 @@ export default class AccountsList extends ControlBaseCommand {
                       account.currentAppId,
                   }
                 : undefined,
-            id: account.accountId || "Unknown",
+            id: account.accountId,
             isCurrent: alias === currentAlias,
-            name: account.accountName || "Unknown",
-            user: account.userEmail || "Unknown",
+            name: account.accountName,
+            user: account.userEmail,
           })),
           currentAccount: currentAlias,
         },
@@ -72,9 +72,9 @@ export default class AccountsList extends ControlBaseCommand {
           (isCurrent ? chalk.green(" (current)") : ""),
       );
       this.log(
-        `  ${formatLabel("Name")} ${account.accountName || "Unknown"} (${account.accountId || "Unknown"})`,
+        `  ${formatLabel("Name")} ${account.accountName} (${account.accountId})`,
       );
-      this.log(`  ${formatLabel("User")} ${account.userEmail || "Unknown"}`);
+      this.log(`  ${formatLabel("User")} ${account.userEmail}`);
 
       // Count number of apps configured for this account
       const appCount = account.apps ? Object.keys(account.apps).length : 0;

src/commands/accounts/switch.ts

@@ -63,8 +63,8 @@ export default class AccountsSwitch extends ControlBaseCommand {
         {
           availableAccounts: accounts.map(({ account, alias }) => ({
             alias,
-            id: account.accountId || "Unknown",
-            name: account.accountName || "Unknown",
+            id: account.accountId,
+            name: account.accountName,
           })),
         },
       );
@@ -83,7 +83,7 @@ export default class AccountsSwitch extends ControlBaseCommand {
   private async switchToAccount(
     alias: string,
     accounts: Array<{
-      account: { accountId?: string; accountName?: string };
+      account: { accountId: string; accountName: string };
       alias: string;
     }>,
     flags: Record<string, unknown>,
@@ -99,8 +99,8 @@ export default class AccountsSwitch extends ControlBaseCommand {
         {
           availableAccounts: accounts.map(({ account, alias }) => ({
             alias,
-            id: account.accountId || "Unknown",
-            name: account.accountName || "Unknown",
+            id: account.accountId,
+            name: account.accountName,
           })),
         },
       );

src/commands/apps/current.ts

@@ -83,7 +83,7 @@ export default class AppsCurrent extends ControlBaseCommand {
         );
       } else {
         this.log(
-          `${formatLabel("Account")} ${chalk.cyan.bold(currentAccount.accountName || currentAccountAlias)} ${chalk.gray(`(${currentAccount.accountId || "Unknown ID"})`)}`,
+          `${formatLabel("Account")} ${chalk.cyan.bold(currentAccount.accountName)} ${chalk.gray(`(${currentAccount.accountId})`)}`,
         );
         this.log(
           `${formatLabel("App")} ${chalk.green.bold(appName)} ${chalk.gray(`(${currentAppId})`)}`,
@@ -161,7 +161,9 @@ export default class AppsCurrent extends ControlBaseCommand {
           flags,
         );
       } else {
-        // Get account info if possible
+        // Web CLI mode: account info comes from the Control API, not local config.
+        // The API call may fail (e.g. token lacks account-level scope), so we
+        // fall back to generic defaults — accountId stays empty, hiding the "(id)" suffix.
         let accountName = "Web CLI Account";
         let accountId = "";
 
@@ -170,7 +172,7 @@ export default class AppsCurrent extends ControlBaseCommand {
           accountName = account.name;
           accountId = account.id;
         } catch {
-          // If we can't get account details, just use default values
+          // Control API unavailable — use defaults above
         }
 
         this.log(

src/commands/apps/rules/list.ts

@@ -69,6 +69,7 @@ export default class RulesListCommand extends ControlBaseCommand {
               (rule: Namespace): ChannelRuleOutput => ({
                 authenticated: rule.authenticated || false,
                 batchingEnabled: rule.batchingEnabled || false,
+                // Control API may omit optional fields; emit null for consistent JSON schema
                 batchingInterval: rule.batchingInterval ?? null,
                 conflationEnabled: rule.conflationEnabled || false,
                 conflationInterval: rule.conflationInterval ?? null,

src/commands/auth/issue-ably-token.ts

@@ -4,6 +4,11 @@ import { randomUUID } from "node:crypto";
 
 import { AblyBaseCommand } from "../../base-command.js";
 import { productApiFlags } from "../../flags.js";
+import {
+  formatClientId,
+  formatLabel,
+  formatSuccess,
+} from "../../utils/output.js";
 
 export default class IssueAblyTokenCommand extends AblyBaseCommand {
   static description = "Create an Ably Token with capabilities";
@@ -118,22 +123,32 @@ export default class IssueAblyTokenCommand extends AblyBaseCommand {
               value: tokenDetails.token,
               issuedAt: new Date(tokenDetails.issued).toISOString(),
               expiresAt: new Date(tokenDetails.expires).toISOString(),
-              clientId: tokenDetails.clientId || null,
+              ...(tokenDetails.clientId
+                ? { clientId: tokenDetails.clientId }
+                : {}),
               capability: tokenDetails.capability,
             },
           },
           flags,
         );
       } else {
-        this.log("Generated Ably Token:");
-        this.log(`Token: ${tokenDetails.token}`);
-        this.log(`Type: Ably`);
-        this.log(`Issued: ${new Date(tokenDetails.issued).toISOString()}`);
-        this.log(`Expires: ${new Date(tokenDetails.expires).toISOString()}`);
-        this.log(`TTL: ${flags.ttl} seconds`);
-        this.log(`Client ID: ${tokenDetails.clientId || "None"}`);
+        this.log(formatSuccess("Ably token generated."));
+        this.log(`${formatLabel("Token")} ${tokenDetails.token}`);
+        this.log(`${formatLabel("Type")} Ably`);
         this.log(
-          `Capability: ${this.formatJsonOutput({ capability: tokenDetails.capability }, flags)}`,
+          `${formatLabel("Issued")} ${new Date(tokenDetails.issued).toISOString()}`,
+        );
+        this.log(
+          `${formatLabel("Expires")} ${new Date(tokenDetails.expires).toISOString()}`,
+        );
+        this.log(`${formatLabel("TTL")} ${flags.ttl} seconds`);
+        if (tokenDetails.clientId) {
+          this.log(
+            `${formatLabel("Client ID")} ${formatClientId(tokenDetails.clientId)}`,
+          );
+        }
+        this.log(
+          `${formatLabel("Capability")} ${this.formatJsonOutput({ capability: tokenDetails.capability }, flags)}`,
         );
       }
     } catch (error) {

src/commands/auth/issue-jwt-token.ts

@@ -4,6 +4,11 @@ import { randomUUID } from "node:crypto";
 
 import { AblyBaseCommand } from "../../base-command.js";
 import { productApiFlags } from "../../flags.js";
+import {
+  formatClientId,
+  formatLabel,
+  formatSuccess,
+} from "../../utils/output.js";
 
 interface JwtPayload {
   exp: number;
@@ -133,7 +138,7 @@ export default class IssueJwtTokenCommand extends AblyBaseCommand {
             token: {
               appId,
               capability: capabilities,
-              clientId,
+              ...(clientId ? { clientId } : {}),
               expires: new Date(jwtPayload.exp * 1000).toISOString(),
               issued: new Date(jwtPayload.iat * 1000).toISOString(),
               keyId,
@@ -145,16 +150,24 @@ export default class IssueJwtTokenCommand extends AblyBaseCommand {
           flags,
         );
       } else {
-        this.log("Generated Ably JWT Token:");
-        this.log(`Token: ${token}`);
-        this.log(`Type: JWT`);
-        this.log(`Issued: ${new Date(jwtPayload.iat * 1000).toISOString()}`);
-        this.log(`Expires: ${new Date(jwtPayload.exp * 1000).toISOString()}`);
-        this.log(`TTL: ${flags.ttl} seconds`);
-        this.log(`App ID: ${appId}`);
-        this.log(`Key ID: ${keyId}`);
-        this.log(`Client ID: ${clientId || "None"}`);
-        this.log(`Capability: ${this.formatJsonOutput(capabilities, flags)}`);
+        this.log(formatSuccess("Ably JWT token generated."));
+        this.log(`${formatLabel("Token")} ${token}`);
+        this.log(`${formatLabel("Type")} JWT`);
+        this.log(
+          `${formatLabel("Issued")} ${new Date(jwtPayload.iat * 1000).toISOString()}`,
+        );
+        this.log(
+          `${formatLabel("Expires")} ${new Date(jwtPayload.exp * 1000).toISOString()}`,
+        );
+        this.log(`${formatLabel("TTL")} ${flags.ttl} seconds`);
+        this.log(`${formatLabel("App ID")} ${appId}`);
+        this.log(`${formatLabel("Key ID")} ${keyId}`);
+        if (clientId) {
+          this.log(`${formatLabel("Client ID")} ${formatClientId(clientId)}`);
+        }
+        this.log(
+          `${formatLabel("Capability")} ${this.formatJsonOutput(capabilities, flags)}`,
+        );
       }
     } catch (error) {
       this.fail(error, flags, "issueJwtToken");

src/commands/auth/keys/current.ts

@@ -71,7 +71,7 @@ export default class KeysCurrentCommand extends ControlBaseCommand {
       const currentAccountAlias = this.configManager.getCurrentAccountAlias();
 
       this.log(
-        `${formatLabel("Account")} ${chalk.cyan.bold(currentAccount?.accountName || currentAccountAlias)} ${chalk.gray(`(${currentAccount?.accountId || "Unknown ID"})`)}`,
+        `${formatLabel("Account")} ${chalk.cyan.bold(currentAccount?.accountName || currentAccountAlias)}${currentAccount ? chalk.gray(` (${currentAccount.accountId})`) : ""}`,
       );
       this.log(
         `${formatLabel("App")} ${chalk.green.bold(appName)} ${chalk.gray(`(${appId})`)}`,
@@ -118,7 +118,9 @@ export default class KeysCurrentCommand extends ControlBaseCommand {
         flags,
       );
     } else {
-      // Get account info if possible
+      // Web CLI mode: account info comes from the Control API, not local config.
+      // The API call may fail (e.g. token lacks account-level scope), so we
+      // fall back to generic defaults — accountId stays empty, hiding the "(id)" suffix.
       let accountName = "Web CLI Account";
       let accountId = "";
 
@@ -128,7 +130,7 @@ export default class KeysCurrentCommand extends ControlBaseCommand {
         accountName = account.name;
         accountId = account.id;
       } catch {
-        // If we can't get account details, just use default values
+        // Control API unavailable — use defaults above
       }
 
       this.log(

src/commands/channels/presence/enter.ts

@@ -124,7 +124,7 @@ export default class ChannelsPresenceEnter extends AblyBaseCommand {
               ? `${formatIndex(this.sequenceCounter)}`
               : "";
             this.log(
-              `${formatTimestamp(timestamp)}${sequencePrefix} ${formatResource(`Channel: ${channelName}`)} | Action: ${formatEventType(String(presenceMessage.action))} | Client: ${formatClientId(presenceMessage.clientId || "N/A")}`,
+              `${formatTimestamp(timestamp)}${sequencePrefix} ${formatResource(`Channel: ${channelName}`)} | Action: ${formatEventType(String(presenceMessage.action))} | Client: ${formatClientId(presenceMessage.clientId)}`,
             );
 
             if (

src/commands/channels/presence/get.ts

@@ -102,6 +102,7 @@ export default class ChannelsPresenceGet extends AblyBaseCommand {
           clientId: member.clientId,
           connectionId: member.connectionId,
           action: member.action,
+          // SDK presence data may be undefined; emit null for consistent JSON schema
           data: (member.data as unknown) ?? null,
           timestamp: formatMessageTimestamp(member.timestamp),
           id: member.id,

src/commands/push/channels/list.ts

@@ -108,7 +108,7 @@ export default class PushChannelsList extends AblyBaseCommand {
 
       for (const sub of subscriptions) {
         const type = sub.deviceId ? "device" : "client";
-        const id = sub.deviceId || sub.clientId || "unknown";
+        const id = sub.deviceId || sub.clientId;
         this.log(formatHeading(`${type}: ${id}`));
         this.log(`  ${formatLabel("Channel")} ${formatResource(sub.channel)}`);
         if (sub.deviceId)

src/commands/rooms/messages/history.ts

@@ -188,7 +188,7 @@ export default class MessagesHistory extends ChatBaseCommand {
           const messagesInOrder = [...items];
           for (const [i, message] of messagesInOrder.entries()) {
             const timestamp = formatMessageTimestamp(message.timestamp);
-            const author = message.clientId || "Unknown";
+            const author = message.clientId;
 
             this.log(`${formatIndex(i + 1)} ${formatTimestamp(timestamp)}`);
             this.log(

src/commands/rooms/messages/reactions/subscribe.ts

@@ -152,7 +152,7 @@ export default class MessagesReactionsSubscribe extends ChatBaseCommand {
               this.logJsonEvent({ reaction: eventData }, flags);
             } else {
               this.log(
-                `${formatTimestamp(timestamp)} ${chalk.green("⚡")} ${formatClientId(event.reaction.clientId || "Unknown")} [${event.reaction.type}] ${event.type}: ${formatEventType(event.reaction.name || "unknown")} to message ${formatResource(event.reaction.messageSerial)}`,
+                `${formatTimestamp(timestamp)} ${chalk.green("⚡")} ${formatClientId(event.reaction.clientId)} [${event.reaction.type}] ${event.type}: ${formatEventType(event.reaction.name || "unknown")} to message ${formatResource(event.reaction.messageSerial)}`,
               );
             }
           },

src/commands/rooms/messages/subscribe.ts

@@ -127,7 +127,7 @@ export default class MessagesSubscribe extends ChatBaseCommand {
       } else {
         // Format message with timestamp, author and content
         const timestamp = formatMessageTimestamp(message.timestamp);
-        const author = message.clientId || "Unknown";
+        const author = message.clientId;
 
         // Prefix with room name when multiple rooms
         const roomPrefix =

src/commands/rooms/presence/enter.ts

@@ -131,7 +131,7 @@ export default class RoomsPresenceEnter extends ChatBaseCommand {
                 ? `${formatIndex(this.sequenceCounter)}`
                 : "";
               this.log(
-                `${formatTimestamp(timestamp)}${sequencePrefix} ${formatResource(`Room: ${this.roomName!}`)} | Action: ${formatEventType(event.type)} | Client: ${formatClientId(member.clientId || "N/A")}`,
+                `${formatTimestamp(timestamp)}${sequencePrefix} ${formatResource(`Room: ${this.roomName!}`)} | Action: ${formatEventType(event.type)} | Client: ${formatClientId(member.clientId)}`,
               );
 
               if (member.data !== null && member.data !== undefined) {

src/commands/rooms/reactions/subscribe.ts

@@ -136,7 +136,7 @@ export default class RoomsReactionsSubscribe extends ChatBaseCommand {
           );
         } else {
           this.log(
-            `${formatTimestamp(timestamp)} ${chalk.green("⚡")} ${formatClientId(reaction.clientId || "Unknown")} reacted with ${chalk.yellow(reaction.name || "unknown")}`,
+            `${formatTimestamp(timestamp)} ${chalk.green("⚡")} ${formatClientId(reaction.clientId)} reacted with ${chalk.yellow(reaction.name || "unknown")}`,
           );
 
           // Show any additional metadata in the reaction

src/commands/spaces/members/subscribe.ts

@@ -73,8 +73,8 @@ export default class SpacesMembersSubscribe extends SpacesBaseCommand {
 
         // Determine the action from the member's lastEvent
         const action = member.lastEvent.name;
-        const clientId = member.clientId || "Unknown";
-        const connectionId = member.connectionId || "Unknown";
+        const clientId = member.clientId;
+        const connectionId = member.connectionId;
 
         // Create a unique key for this client+connection combination
         const clientKey = `${clientId}:${connectionId}`;

src/commands/spaces/subscribe.ts

@@ -70,8 +70,8 @@ export default class SpacesSubscribe extends SpacesBaseCommand {
         const now = Date.now();
 
         const action = member.lastEvent.name;
-        const clientId = member.clientId || "Unknown";
-        const connectionId = member.connectionId || "Unknown";
+        const clientId = member.clientId;
+        const connectionId = member.connectionId;
 
         // Dedup within 500ms window
         const clientKey = `${clientId}:${connectionId}`;