wip -- revert to this if needed

Author: kaizencc

packages/@aws-cdk/toolkit-lib/lib/api/io/private/codes.ts

@@ -1,6 +1,7 @@
 import { IoMessageCode } from '../io-message';
 
 export interface CodeInfo {
+  code: IoMessageCode;
   description: string;
   level: string;
   interface?: any;
@@ -19,26 +20,31 @@ function codeInfo(info: CodeInfo): CodeInfo {
 export const CODES = {
   // 1: Synth
   CDK_TOOLKIT_I1000: codeInfo({
+    code: 'CDK_TOOLKIT_I1000',
     description: 'Provides synthesis times.',
     level: 'info',
   }),
   CDK_TOOLKIT_I1901: codeInfo({
+    code: 'CDK_TOOLKIT_I1901',
     description: 'Provides stack data',
     level: 'result',
   }),
   CDK_TOOLKIT_I1902: codeInfo({
+    code: 'CDK_TOOLKIT_I1902',
     description: 'Successfully deployed stacks',
     level: 'result',
   }),
 
   // 2: List
   CDK_TOOLKIT_I2901: codeInfo({
+    code: 'CDK_TOOLKIT_I2901',
     description: 'Provides details on the selected stacks and their dependencies',
     level: 'result',
   }),
 
   // 3: Import & Migrate
   CDK_TOOLKIT_E3900: codeInfo({
+    code: 'CDK_TOOLKIT_E3900',
     description: 'Resource import failed',
     level: 'error',
   }),
@@ -47,69 +53,84 @@ export const CODES = {
 
   // 5: Deploy & Watch
   CDK_TOOLKIT_I5000: codeInfo({
+    code: 'CDK_TOOLKIT_I5000',
     description: 'Provides deployment times',
     level: 'info',
   }),
   CDK_TOOLKIT_I5001: codeInfo({
+    code: 'CDK_TOOLKIT_I5001',
     description: 'Provides total time in deploy action, including synth and rollback',
     level: 'info',
   }),
   CDK_TOOLKIT_I5002: codeInfo({
+    code: 'CDK_TOOLKIT_I5002',
     description: 'Provides time for resource migration',
     level: 'info',
   }),
   CDK_TOOLKIT_I5031: codeInfo({
+    code: 'CDK_TOOLKIT_I5031',
     description: 'Informs about any log groups that are traced as part of the deployment',
     level: 'info',
   }),
   CDK_TOOLKIT_I5050: codeInfo({
+    code: 'CDK_TOOLKIT_I5050',
     description: 'Confirm rollback during deployment',
     level: 'response',
   }),
   CDK_TOOLKIT_I5060: codeInfo({
+    code: 'CDK_TOOLKIT_I5060',
     description: 'Confirm deploy security sensitive changes',
     level: 'response',
   }),
   CDK_TOOLKIT_I5900: codeInfo({
+    code: 'CDK_TOOLKIT_I5900',
     description: 'Deployment results on success',
     level: 'result',
   }),
 
   CDK_TOOLKIT_E5001: codeInfo({
+    code: 'CDK_TOOLKIT_E5001',
     description: 'No stacks found',
     level: 'error',
   }),
 
   // 6: Rollback
   CDK_TOOLKIT_I6000: codeInfo({
+    code: 'CDK_TOOLKIT_I6000',
     description: 'Provides rollback times',
     level: 'info',
   }),
 
   CDK_TOOLKIT_E6001: codeInfo({
+    code: 'CDK_TOOLKIT_E6001',
     description: 'No stacks found',
     level: 'error',
   }),
   CDK_TOOLKIT_E6900: codeInfo({
+    code: 'CDK_TOOLKIT_E6900',
     description: 'Rollback failed',
     level: 'error',
   }),
 
   // 7: Destroy
   CDK_TOOLKIT_I7000: codeInfo({
+    code: 'CDK_TOOLKIT_I7000',
     description: 'Provides destroy times',
     level: 'info',
   }),
   CDK_TOOLKIT_I7010: codeInfo({
+    code: 'CDK_TOOLKIT_I7010',
     description: 'Confirm destroy stacks',
     level: 'response',
   }),
 
   CDK_TOOLKIT_E7010: codeInfo({
+    code: 'CDK_TOOLKIT_E7010',
     description: 'Action was aborted due to negative confirmation of request',
     level: 'error',
   }),
   CDK_TOOLKIT_E7900: codeInfo({
+    code: 'CDK_TOOLKIT_E7900',
     description: 'Stack deletion failed',
     level: 'error',
   }),
@@ -118,30 +139,37 @@ export const CODES = {
 
   // Assembly codes
   CDK_ASSEMBLY_I0042: codeInfo({
+    code: 'CDK_ASSEMBLY_I0042',
     description: 'Writing updated context',
     level: 'debug',
   }),
   CDK_ASSEMBLY_I0241: codeInfo({
+    code: 'CDK_ASSEMBLY_I0241',
     description: 'Fetching missing context',
     level: 'debug',
   }),
   CDK_ASSEMBLY_I1000: codeInfo({
+    code: 'CDK_ASSEMBLY_I1000',
     description: 'Cloud assembly output starts',
     level: 'debug',
   }),
   CDK_ASSEMBLY_I1001: codeInfo({
+    code: 'CDK_ASSEMBLY_I1001',
     description: 'Output lines emitted by the cloud assembly to stdout',
     level: 'info',
   }),
   CDK_ASSEMBLY_E1002: codeInfo({
+    code: 'CDK_ASSEMBLY_E1002',
     description: 'Output lines emitted by the cloud assembly to stderr',
     level: 'error',
   }),
   CDK_ASSEMBLY_I1003: codeInfo({
+    code: 'CDK_ASSEMBLY_I1003',
     description: 'Cloud assembly output finished',
     level: 'info',
   }),
   CDK_ASSEMBLY_E1111: codeInfo({
+    code: 'CDK_ASSEMBLY_E1111',
     description: 'Incompatible CDK CLI version. Upgrade needed.',
     level: 'error',
   }),

packages/@aws-cdk/toolkit-lib/lib/api/io/private/messages.ts

@@ -1,6 +1,6 @@
 import * as chalk from 'chalk';
 import type { IoMessageCodeCategory, IoMessageLevel } from '../io-message';
-import { type VALID_CODE } from './codes';
+import { CodeInfo, type VALID_CODE } from './codes';
 import type { ActionLessMessage, ActionLessRequest, Optional, SimplifiedMessage } from './types';
 
 /**
@@ -83,10 +83,10 @@ export const error = <T>(message: string, code: VALID_CODE, payload?: T) => {
  * However actions that operate on Cloud Assemblies might include a result per Stack.
  * Unlike other messages, results must always have a code and a payload.
  */
-export const result = <T>(message: string, code: VALID_CODE, payload: T) => {
+export const result = <T>(message: string, code: CodeInfo, payload: T) => {
   return formatMessage({
     level: 'result',
-    code,
+    code: code.code,
     message,
     data: payload,
   });

packages/@aws-cdk/toolkit-lib/lib/toolkit/private/index.ts

@@ -10,4 +10,15 @@ export interface ToolkitServices {
   ioHost: ActionAwareIoHost;
 }
 
-// export inter
+export interface StackData {
+  assemblyDirectory: string;
+  stacksCount: number;
+  stackIds: string[];
+  stack: {
+    stackName: string;
+    hierarchicalId: string;
+    template: any;
+    stringifiedJson: string;
+    stringifiedYaml: string;
+  };
+}

packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts

@@ -3,7 +3,7 @@ import * as cxapi from '@aws-cdk/cx-api';
 import * as chalk from 'chalk';
 import * as chokidar from 'chokidar';
 import * as fs from 'fs-extra';
-import { ToolkitServices } from './private';
+import { StackData, ToolkitServices } from './private';
 import { AssetBuildTime, type DeployOptions, RequireApproval } from '../actions/deploy';
 import { type ExtendedDeployOptions, buildParameterMap, createHotswapPropertyOverrides, removePublishedAssets } from '../actions/deploy/private';
 import { type DestroyOptions } from '../actions/destroy';
@@ -19,7 +19,7 @@ import { CachedCloudAssemblySource, IdentityCloudAssemblySource, StackAssembly,
 import { ALL_STACKS, CloudAssemblySourceBuilder } from '../api/cloud-assembly/private';
 import { ToolkitError } from '../api/errors';
 import { IIoHost, IoMessageCode, IoMessageLevel } from '../api/io';
-import { asSdkLogger, withAction, Timer, confirm, error, info, success, warn, ActionAwareIoHost, debug, result, withoutEmojis, withoutColor, withTrimmedWhitespace } from '../api/io/private';
+import { asSdkLogger, withAction, Timer, confirm, error, info, success, warn, ActionAwareIoHost, debug, result, withoutEmojis, withoutColor, withTrimmedWhitespace, CODES } from '../api/io/private';
 
 /**
  * The current action being performed by the CLI. 'none' represents the absence of an action.
@@ -177,7 +177,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
       const firstStack = stacks.firstStack!;
       const template = firstStack.template;
       const obscuredTemplate = obscureTemplate(template);
-      await ioHost.notify(result(message, 'CDK_TOOLKIT_I1901', {
+      await ioHost.notify(result(message, CODES.CDK_TOOLKIT_I1901, {
         ...assemblyData,
         stack: {
           stackName: firstStack.stackName,
@@ -186,10 +186,10 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
           stringifiedJson: serializeStructure(obscuredTemplate, true),
           stringifiedYaml: serializeStructure(obscuredTemplate, false),
         },
-      }));
+      } as StackData));
     } else {
       // not outputting template to stdout, let's explain things to the user a little bit...
-      await ioHost.notify(result(chalk.green(message), 'CDK_TOOLKIT_I1902', assemblyData));
+      await ioHost.notify(result(chalk.green(message), CODES.CDK_TOOLKIT_I1902, assemblyData));
       await ioHost.notify(info(`Supply a stack id (${stacks.stackArtifacts.map((s) => chalk.green(s.hierarchicalId)).join(', ')}) to display its template.`));
     }
 
@@ -211,7 +211,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
     const stacks = stackCollection.withDependencies();
     const message = stacks.map(s => s.id).join('\n');
 
-    await ioHost.notify(result(message, 'CDK_TOOLKIT_I2901', { stacks }));
+    await ioHost.notify(result(message, CODES.CDK_TOOLKIT_I2901, { stacks }));
     return stacks;
   }
 
@@ -458,7 +458,7 @@ export class Toolkit extends CloudAssemblySourceBuilder implements AsyncDisposab
           ? ` ✅  ${stack.displayName} (no changes)`
           : ` ✅  ${stack.displayName}`;
 
-        await ioHost.notify(result(chalk.green('\n' + message), 'CDK_TOOLKIT_I5900', deployResult));
+        await ioHost.notify(result(chalk.green('\n' + message), CODES.CDK_TOOLKIT_I5900, deployResult));
         deployDuration = await deployTimer.endAs(ioHost, 'deploy');
 
         if (Object.keys(deployResult.outputs).length > 0) {

packages/@aws-cdk/toolkit-lib/scripts/gen-code-registry.ts

@@ -7,8 +7,8 @@ function codesToMarkdownTable(codes: Record<string, CodeInfo>, mdPrefix?: string
   let table = '| Code | Description | Level | Data Interface |\n';
   table += '|------|-------------|-------|----------------|\n';
 
-  Object.entries(codes).forEach(([id, code]) => {
-    table += `| ${id} | ${code.description} | ${code.level} | ${code.interface ?? 'n/a'} |\n`;
+  Object.values(codes).forEach((code) => {
+    table += `| ${code.code} | ${code.description} | ${code.level} | ${code.interface ?? 'n/a'} |\n`;
   });
 
   const prefix = mdPrefix ? `${mdPrefix}\n\n` : '';