@aligent/nx-cdk 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/nx-cdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
@@ -10,7 +10,7 @@
     "directory": "packages/nx-cdk"
   },
   "dependencies": {
-    "@nx/devkit": "22.4.1",
+    "@nx/devkit": "22.4.2",
     "ts-morph": "^27.0.2"
   },
   "generators": "./generators.json",

package/src/generators/preset/files/application/bin/main.ts.template

@@ -1,14 +1,15 @@
 #!/usr/bin/env node
-import { MicroserviceChecks, VersionFunctionsAspect } from '@aligent/cdk-aspects';
+import {
+    LambdaAndStepFunctionVersioningAspect,
+    LogGroupDefaultsAspect,
+    MicroserviceChecks,
+    NodeJsFunctionDefaultsAspect,
+    StepFunctionsDefaultsAspect,
+} from '@aligent/cdk-aspects';
 import { App, Aspects, Tags } from 'aws-cdk-lib';
 import { Runtime } from 'aws-cdk-lib/aws-lambda';
 import { ApplicationStage } from '../lib/service-stacks.js';
 
-// TODO: [MI-277] Move these aspects to @aligent/cdk-aspects package for reuse across projects
-import { LogGroupDefaultsAspect } from '../_internal/log-group-defaults-aspect.js';
-import { NodeJsFunctionDefaultsAspect } from '../_internal/nodejs-function-defaults-aspect.js';
-import { StepFunctionDefaultsAspect } from '../_internal/step-function-defaults-aspect.js';
-
 const APPLICATION_CONTEXT = { NAME: '<%= name %>-int', OWNER: 'aligent' } as const;
 const STAGE_NAMES = { DEV: 'dev', STG: 'stg', PRD: 'prd' } as const;
 
@@ -20,7 +21,7 @@ Tags.of(app).add('OWNER', APPLICATION_CONTEXT.OWNER);
  * These aspects are applied to all resources across all stages
  */
 Aspects.of(app).add(new NodeJsFunctionDefaultsAspect({ runtime: Runtime.NODEJS_<%= nodeRuntime %> }));
-Aspects.of(app).add(new StepFunctionDefaultsAspect());
+Aspects.of(app).add(new StepFunctionsDefaultsAspect());
 Aspects.of(app).add(new MicroserviceChecks());
 
 /**
@@ -65,4 +66,4 @@ Aspects.of(stg).add(new LogGroupDefaultsAspect({ duration: 'MEDIUM' }));
  */
 const prd = new ApplicationStage(app, STAGE_NAMES.PRD);
 Aspects.of(prd).add(new LogGroupDefaultsAspect({ duration: 'LONG' }));
-Aspects.of(prd).add(new VersionFunctionsAspect());
+Aspects.of(prd).add(new LambdaAndStepFunctionVersioningAspect());

package/src/generators/preset/files/application/_internal/log-group-defaults-aspect.ts.template

@@ -1,83 +0,0 @@
-import { RemovalPolicy, type IAspect } from 'aws-cdk-lib';
-import { CfnLogGroup, LogGroup, RetentionDays, type LogGroupProps } from 'aws-cdk-lib/aws-logs';
-import { IConstruct } from 'constructs';
-
-interface Config {
-    duration: 'SHORT' | 'MEDIUM' | 'LONG';
-}
-
-/**
- * Aspect that automatically applies configuration-aware defaults to CloudWatch Log Groups
- *
- * Visits all constructs in the scope and automatically applies configuration-specific to log groups.
- * Different configurations balance between cost optimization and data retention needs.
- *
- * @example
- * ```typescript
- * // Apply configuration-specific defaults to all log groups
- * Aspects.of(app).add(new LogGroupDefaultsAspect({ duration: 'SHORT' }));
- *
- * // Log groups automatically inherit configuration defaults
- * new LogGroup(stack, 'MyLogGroup', {
- *   // retention and removal policy applied automatically
- * });
- * ```
- *
- * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html
- */
-export class LogGroupDefaultsAspect implements IAspect {
-    private readonly defaultProps: LogGroupProps;
-
-    /**
-     * Creates a new LogGroupDefaultsAspect
-     *
-     * @param config - Configuration identifier used to select appropriate defaults.
-     */
-    constructor(config: Config) {
-        const props = this.retentionProperties(config.duration);
-        this.defaultProps = { ...props };
-    }
-
-    /**
-     * Get duration-specific log group properties
-     *
-     * @param duration - The duration to get the log group properties for
-     * @returns The log group properties for the duration
-     */
-    private retentionProperties(duration: 'SHORT' | 'MEDIUM' | 'LONG') {
-        switch (duration) {
-            case 'SHORT':
-                return { retention: RetentionDays.ONE_WEEK, removalPolicy: RemovalPolicy.DESTROY };
-            case 'MEDIUM':
-                return {
-                    retention: RetentionDays.SIX_MONTHS,
-                    removalPolicy: RemovalPolicy.DESTROY,
-                };
-            default:
-                return { retention: RetentionDays.TWO_YEARS, removalPolicy: RemovalPolicy.RETAIN };
-        }
-    }
-
-    /**
-     * Visits a construct and applies configuration-appropriate defaults
-     *
-     * Applies configuration-specific retention and removal policies to log groups
-     * that don't already have these properties explicitly set.
-     *
-     * @param node - The construct to potentially modify
-     */
-    visit(node: IConstruct): void {
-        if (node instanceof LogGroup) {
-            if (this.defaultProps.removalPolicy) {
-                node.applyRemovalPolicy(this.defaultProps.removalPolicy);
-            }
-
-            if (this.defaultProps.retention) {
-                const cfnLogGroup = node.node.defaultChild as CfnLogGroup;
-                if (cfnLogGroup && cfnLogGroup.retentionInDays === undefined) {
-                    cfnLogGroup.retentionInDays = this.defaultProps.retention;
-                }
-            }
-        }
-    }
-}

package/src/generators/preset/files/application/_internal/nodejs-function-defaults-aspect.ts.template

@@ -1,72 +0,0 @@
-import { type IAspect } from 'aws-cdk-lib';
-import { CfnFunction, Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
-import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
-import { IConstruct } from 'constructs';
-
-interface Config {
-    runtime: Runtime;
-    sourceMap?: boolean;
-}
-
-/**
- * Aspect that automatically applies configuration-aware defaults to Node.js Lambda functions
- *
- * Visits all constructs in the scope and automatically applies configuration-specific runtime, tracing, and environment settings to Node.js Lambda functions.
- * Different configurations can optimize for different priorities such as build speed, bundle size, or debugging capabilities.
- *
- * @example
- * ```typescript
- * // Apply configuration-specific defaults to all Node.js functions
- * Aspects.of(app).add(new NodeJsFunctionDefaultsAspect({
- *   runtime: Runtime.NODEJS_24_X,
- *   sourceMap: true,
- * }));
- *
- * // Functions automatically inherit configuration defaults
- * new NodejsFunction(stack, 'MyFunction', {
- *   code: Code.fromAsset('src/lambda'),
- *   handler: 'index.handler',
- *   // runtime, tracing, and source map support applied automatically
- * });
- * ```
- *
- * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_nodejs.NodejsFunction.html
- */
-export class NodeJsFunctionDefaultsAspect implements IAspect {
-    private readonly config: Required<Config>;
-
-    /**
-     * Creates a new NodeJsFunctionDefaultsAspect
-     *
-     * @param config - Configuration identifier used to select appropriate defaults.
-     */
-    constructor(config: Config) {
-        this.config = { ...config, sourceMap: config.sourceMap ?? true };
-    }
-
-    /**
-     * Visits a construct and applies runtime and tracing settings if it's a NodejsFunction
-     *
-     * Applies configuration-specific runtime, tracing, and environment settings to Node.js
-     * Lambda functions that don't already have these properties explicitly set.
-     *
-     * @param node - The construct to potentially modify
-     */
-    visit(node: IConstruct): void {
-        if (node instanceof NodejsFunction) {
-            const cfnFunction = node.node.defaultChild as CfnFunction;
-
-            if (cfnFunction) {
-                cfnFunction.runtime = this.config.runtime.name;
-            }
-
-            if (cfnFunction && cfnFunction.tracingConfig === undefined) {
-                cfnFunction.tracingConfig = { mode: Tracing.ACTIVE };
-            }
-
-            if (this.config.sourceMap) {
-                node.addEnvironment('NODE_OPTIONS', '--enable-source-maps');
-            }
-        }
-    }
-}

package/src/generators/preset/files/application/_internal/step-function-defaults-aspect.ts.template

@@ -1,83 +0,0 @@
-import { type IAspect } from 'aws-cdk-lib';
-import { CfnLogGroup, LogGroup } from 'aws-cdk-lib/aws-logs';
-import {
-    CfnStateMachine,
-    LogLevel,
-    StateMachine,
-    StateMachineType,
-} from 'aws-cdk-lib/aws-stepfunctions';
-import { IConstruct } from 'constructs';
-
-/**
- * Aspect that automatically applies tracing and logging settings to Step Functions
- *
- * Visits all constructs in the scope and automatically applies X-Ray tracing to all
- * state machines. For EXPRESS state machines, automatically creates log groups and
- * configures comprehensive logging for enhanced observability.
- *
- * @example
- * ```typescript
- * // Apply configuration-specific defaults to all Step Functions
- * Aspects.of(app).add(new StepFunctionDefaultsAspect());
- *
- * // Step Functions automatically inherit defaults
- * new StateMachine(stack, 'MyWorkflow', {
- *   stateMachineType: StateMachineType.EXPRESS,
- *   definitionBody: DefinitionBody.fromFile('workflow.asl.yaml'),
- *   // tracing enabled and logging configured automatically for EXPRESS
- * });
- * ```
- *
- * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html
- */
-export class StepFunctionDefaultsAspect implements IAspect {
-    /**
-     * Visits a construct and applies tracing and logging settings if it's a StateMachine
-     *
-     * Enables X-Ray tracing for all state machines. For EXPRESS state machines that don't
-     * already have logging configured, automatically creates log groups and configures
-     * comprehensive logging with full execution data capture.
-     *
-     * @param node - The construct to potentially modify
-     */
-    visit(node: IConstruct): void {
-        if (node instanceof StateMachine) {
-            const cfnStateMachine = node.node.defaultChild as CfnStateMachine;
-
-            if (cfnStateMachine) {
-                // Apply tracing if not already set
-                if (cfnStateMachine.tracingConfiguration === undefined) {
-                    cfnStateMachine.tracingConfiguration = {
-                        enabled: true,
-                    };
-                }
-
-                // For EXPRESS state machines, configure logging if not already set
-                if (
-                    cfnStateMachine.stateMachineType === StateMachineType.EXPRESS &&
-                    cfnStateMachine.loggingConfiguration === undefined
-                ) {
-                    // Create a log group for the state machine
-                    const logGroup = new LogGroup(node, 'LogGroup', {
-                        logGroupName: `/aws/vendedlogs/states/${node.node.id}`,
-                    });
-
-                    // Get the underlying CFN log group to access its ARN
-                    const cfnLogGroup = logGroup.node.defaultChild as CfnLogGroup;
-
-                    cfnStateMachine.loggingConfiguration = {
-                        destinations: [
-                            {
-                                cloudWatchLogsLogGroup: {
-                                    logGroupArn: cfnLogGroup.attrArn,
-                                },
-                            },
-                        ],
-                        level: LogLevel.ALL,
-                        includeExecutionData: true,
-                    };
-                }
-            }
-        }
-    }
-}