@gradientedge/cdk-utils 10.7.0 → 11.0.0

package/dist/src/lib/index.js

@@ -1,4 +0,0 @@
-export * from './aws/index.js';
-export * from './azure/index.js';
-export * from './cloudflare/index.js';
-export * from './common/index.js';

package/dist/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../app/api-destined-function/src/lib/lambda.ts","../app/api-destined-function/src/test/lambda.test.ts"],"version":"5.9.3"}

package/eslint.config.mjs

@@ -1,63 +0,0 @@
-import tseslint from '@typescript-eslint/eslint-plugin';
-import tsparser from '@typescript-eslint/parser';
-import importPlugin from 'eslint-plugin-import';
-import jsdoc from 'eslint-plugin-jsdoc';
-
-export default [
-  {
-    ignores: ["*.js", "**/cdk.out/**", "**/build/**", "**/*.d.ts", "coverage", "api-docs/**", "dist/**"]
-  },
-  {
-    files: ["**/*.ts"],
-    languageOptions: {
-      parser: tsparser,
-      parserOptions: {
-        ecmaVersion: 2022,
-        sourceType: "module"
-      }
-    },
-    plugins: {
-      '@typescript-eslint': tseslint,
-      'import': importPlugin,
-      'jsdoc': jsdoc
-    },
-    rules: {
-      // TypeScript rules
-      '@typescript-eslint/no-unused-vars': 'error',
-      '@typescript-eslint/no-explicit-any': 'warn',
-      '@typescript-eslint/prefer-const': 'error',
-      '@typescript-eslint/no-non-null-assertion': 'warn',
-      
-      // Import rules
-      'import/order': ['error', {
-        'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-        'newlines-between': 'always'
-      }],
-      'import/no-duplicates': 'error',
-      'import/no-unresolved': 'off',
-      
-      // Code complexity
-      'complexity': ['warn', 10],
-      'max-depth': ['warn', 4],
-      'max-lines-per-function': ['warn', 50],
-      'max-params': ['warn', 4],
-      
-      // Code quality
-      'no-console': 'warn',
-      'no-debugger': 'error',
-      'no-duplicate-imports': 'error',
-      'prefer-const': 'error',
-      'no-var': 'error',
-      
-      // Security
-      'no-eval': 'error',
-      'no-implied-eval': 'error',
-      'no-new-func': 'error',
-      
-      // Best practices
-      'eqeqeq': ['error', 'always'],
-      'no-throw-literal': 'error',
-      'prefer-template': 'error'
-    }
-  }
-];

package/index.ts

@@ -1 +0,0 @@
-export * from './src/lib/index.js'

package/pnpm-workspace.yaml

@@ -1,3 +0,0 @@
-packages:
-  - 'app/**'
-  - 'src/**'

package/src/lib/aws/common/construct.ts

@@ -1,167 +0,0 @@
-import { CfnOutput } from 'aws-cdk-lib'
-import { Construct } from 'constructs'
-import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common/index.js'
-import {
-  AcmManager,
-  ApiManager,
-  AppConfigManager,
-  CloudFrontManager,
-  CloudTrailManager,
-  CloudWatchManager,
-  CodeBuildManager,
-  DynamodbManager,
-  EcrManager,
-  EcsManager,
-  EfsManager,
-  EksManager,
-  ElastiCacheManager,
-  EventManager,
-  EventTargetManager,
-  EvidentlyManager,
-  IamManager,
-  KmsManager,
-  LambdaManager,
-  LogManager,
-  Route53Manager,
-  S3Manager,
-  SecretsManager,
-  SfnManager,
-  SnsManager,
-  SqsManager,
-  SsmManager,
-  VpcManager,
-  WafManager,
-} from '../services/index.js'
-import { createCfnOutput } from '../utils/index.js'
-import { ResourceNameFormatter } from './resource-name-formatter.js'
-import { CommonStackProps } from './types.js'
-
-/**
- * @subcategory Construct
- * @classdesc Common construct to use as a base for all higher level constructs.
- * @example
- * import { CommonConstruct } from '@gradientedge/cdk-utils';
- *
- * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
- *     super(parent, id, props);
- *     this.props = props;
- *   };
- * };
- */
-export class CommonConstruct extends Construct {
-  props: CommonStackProps
-  resourceNameFormatter: ResourceNameFormatter
-  acmManager: AcmManager
-  apiManager: ApiManager
-  appConfigManager: AppConfigManager
-  codeBuildManager: CodeBuildManager
-  cloudFrontManager: CloudFrontManager
-  cloudTrailManager: CloudTrailManager
-  cloudWatchManager: CloudWatchManager
-  dynamodbManager: DynamodbManager
-  ecrManager: EcrManager
-  ecsManager: EcsManager
-  efsManager: EfsManager
-  eksManager: EksManager
-  elasticacheManager: ElastiCacheManager
-  eventManager: EventManager
-  eventTargetManager: EventTargetManager
-  evidentlyManager: EvidentlyManager
-  iamManager: IamManager
-  kmsManager: KmsManager
-  lambdaManager: LambdaManager
-  logManager: LogManager
-  route53Manager: Route53Manager
-  s3Manager: S3Manager
-  secretsManager: SecretsManager
-  sfnManager: SfnManager
-  snsManager: SnsManager
-  sqsManager: SqsManager
-  ssmManager: SsmManager
-  vpcManager: VpcManager
-  wafManager: WafManager
-
-  fullyQualifiedDomainName: string
-
-  constructor(parent: Construct, id: string, props: CommonStackProps) {
-    super(parent, id)
-    this.props = props
-    this.resourceNameFormatter = new ResourceNameFormatter(this, `${id}-rnf`, props)
-    this.acmManager = new AcmManager()
-    this.apiManager = new ApiManager()
-    this.appConfigManager = new AppConfigManager()
-    this.codeBuildManager = new CodeBuildManager()
-    this.cloudFrontManager = new CloudFrontManager()
-    this.cloudTrailManager = new CloudTrailManager()
-    this.cloudWatchManager = new CloudWatchManager()
-    this.dynamodbManager = new DynamodbManager()
-    this.ecrManager = new EcrManager()
-    this.ecsManager = new EcsManager()
-    this.efsManager = new EfsManager()
-    this.eksManager = new EksManager()
-    this.elasticacheManager = new ElastiCacheManager()
-    this.eventManager = new EventManager()
-    this.eventTargetManager = new EventTargetManager()
-    this.evidentlyManager = new EvidentlyManager()
-    this.iamManager = new IamManager()
-    this.kmsManager = new KmsManager()
-    this.lambdaManager = new LambdaManager()
-    this.logManager = new LogManager()
-    this.route53Manager = new Route53Manager()
-    this.s3Manager = new S3Manager()
-    this.secretsManager = new SecretsManager()
-    this.sfnManager = new SfnManager()
-    this.snsManager = new SnsManager()
-    this.sqsManager = new SqsManager()
-    this.ssmManager = new SsmManager()
-    this.vpcManager = new VpcManager()
-    this.wafManager = new WafManager()
-
-    this.determineFullyQualifiedDomain()
-  }
-
-  /**
-   * @summary Helper method to add CloudFormation outputs from the construct
-   * @param id scoped id of the resource
-   * @param value the value of the exported output
-   * @param description optional description for the output
-   * @param overrideId Flag which indicates whether to override the default logical id of the output
-   */
-  protected addCfnOutput(id: string, value: string, description?: string, overrideId = true): CfnOutput {
-    return createCfnOutput(id, this, value, description, overrideId)
-  }
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  protected determineFullyQualifiedDomain() {
-    this.fullyQualifiedDomainName = this.props.subDomain
-      ? `${this.props.subDomain}.${this.props.domainName}`
-      : this.props.domainName
-  }
-
-  /**
-   * @summary Utility method to determine if the initialisation is in development (dev) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isDevelopmentStage = () => isDevStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in test (tst) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isTestStage = () => isTestStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in uat (uat) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isUatStage = () => isUatStage(this.props.stage)
-
-  /**
-   * @summary Utility method to determine if the initialisation is in production (prd) stage
-   * This is determined by the stage property injected via cdk context
-   */
-  public isProductionStage = () => isPrdStage(this.props.stage)
-}

package/src/lib/aws/common/index.ts

@@ -1,4 +0,0 @@
-export * from './construct.js'
-export * from './resource-name-formatter.js'
-export * from './stack.js'
-export * from './types.js'

package/src/lib/aws/common/resource-name-formatter.ts

@@ -1,37 +0,0 @@
-import { Construct } from 'constructs'
-import { CommonStackProps, ResourceNameFormatterProps } from './types.js'
-
-export class ResourceNameFormatter extends Construct {
-  props: CommonStackProps
-
-  constructor(parent: Construct, id: string, props: CommonStackProps) {
-    super(parent, id)
-    this.props = props
-  }
-
-  /**
-   * @summary Helper method to format a resource name based on the provided options
-   * @param resourceName the resource name to format
-   * @param options options to control the formatting of the resource name
-   * @returns The formatted resource name
-   */
-  public format(resourceName: string, options?: ResourceNameFormatterProps) {
-    const elements = []
-
-    if (!options?.exclude) {
-      if (options?.globalPrefix) elements.push(this.props.globalPrefix)
-      elements.push(options?.prefix ?? this.props.resourcePrefix)
-    }
-
-    elements.push(resourceName)
-
-    if (!options?.exclude) {
-      elements.push(options?.suffix ?? this.props.resourceSuffix)
-      if (options?.globalSuffix) elements.push(this.props.globalSuffix)
-    }
-
-    elements.push(this.props.stage)
-
-    return elements.filter(Boolean).join('-')
-  }
-}

package/src/lib/aws/common/stack.ts

@@ -1,157 +0,0 @@
-import { App, Stack, StackProps } from 'aws-cdk-lib'
-import { Runtime } from 'aws-cdk-lib/aws-lambda'
-import fs from 'fs'
-import path from 'path'
-
-import { CommonConstruct } from './construct.js'
-import { CommonStackProps } from './types.js'
-
-import appRoot from 'app-root-path'
-import _ from 'lodash'
-import { isDevStage } from '../../common/index.js'
-
-/**
- * @classdesc Common stack to use as a base for all higher level constructs.
- * @example
- * import { CommonStack } from '@gradientedge/cdk-utils'
- *
- * class CustomStack extends CommonStack {
- *   constructor(parent: App, name: string, props: StackProps) {
- *     super(parent, name, props)
- *     // provision resources
- *   }
- * }
- */
-export class CommonStack extends Stack {
-  public static NODEJS_RUNTIME = Runtime.NODEJS_24_X
-
-  construct: CommonConstruct
-  props: CommonStackProps
-
-  constructor(parent: App, name: string, props: StackProps) {
-    super(parent, name, props)
-
-    /* determine extra cdk contexts */
-    this.determineExtraContexts()
-
-    /* determine extra cdk stage contexts */
-    this.determineStageContexts()
-
-    this.props = this.determineConstructProps(props)
-
-    /* initialise the construct */
-    this.construct = new CommonConstruct(this, 'cdk-utils', this.props)
-  }
-
-  /**
-   * @summary Method to determine the core CDK construct properties injected via context cdk.json
-   * @param props The stack properties
-   * @returns The stack properties
-   */
-  protected determineConstructProps(props: StackProps) {
-    return {
-      domainName: this.node.tryGetContext('domainName'),
-      excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
-      excludeAccountNumberForBuckets: this.node.tryGetContext('excludeAccountNumberForBuckets'),
-      extraContexts: this.node.tryGetContext('extraContexts'),
-      logRetention: this.node.tryGetContext('logRetention'),
-      name: props.stackName || 'cdk-utils',
-      nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
-      region: this.node.tryGetContext('region'),
-      globalPrefix: this.node.tryGetContext('globalPrefix'),
-      globalSuffix: this.node.tryGetContext('globalSuffix'),
-      resourceNameOptions: this.node.tryGetContext('resourceNameOptions'),
-      resourcePrefix: this.node.tryGetContext('resourcePrefix'),
-      resourceSuffix: this.node.tryGetContext('resourceSuffix'),
-      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
-      stackName: props.stackName,
-      stage: this.node.tryGetContext('stage'),
-      subDomain: this.node.tryGetContext('subDomain'),
-    }
-  }
-
-  /**
-   * @summary Method to determine extra cdk contexts apart from the main cdk.json
-   * - Sets the properties from the extra contexts into cdk node context
-   * - Primary use is to have layered config in separate files to enable easier maintenance and readability
-   */
-  protected determineExtraContexts() {
-    const extraContexts = this.node.tryGetContext('extraContexts')
-    const debug = this.node.tryGetContext('debug')
-
-    if (!extraContexts) {
-      if (debug) console.debug(`No additional contexts provided. Using default context properties from cdk.json`)
-      return
-    }
-
-    _.forEach(extraContexts, (context: string) => {
-      const extraContextPath = path.join(appRoot.path, context)
-
-      /* scenario where extra context is configured in cdk.json but absent in file system */
-      if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
-
-      /* read the extra properties */
-      const extraContextPropsBuffer = fs.readFileSync(extraContextPath)
-      if (debug) console.debug(`Adding additional contexts provided in ${extraContextPath}`)
-
-      /* parse as JSON properties */
-      const extraContextProps = JSON.parse(extraContextPropsBuffer.toString('utf-8'))
-
-      /* set each of the property into the cdk node context */
-      _.keys(extraContextProps).forEach((propKey: any) => {
-        this.node.setContext(propKey, extraContextProps[propKey])
-      })
-    })
-  }
-
-  /**
-   * @summary Method to determine extra cdk stage contexts apart from the main cdk.json
-   * - Sets the properties from the extra stage contexts into cdk node context
-   * - Primary use is to have layered config for each environment which is injected into the context
-   */
-  protected determineStageContexts() {
-    const stage = this.node.tryGetContext('stage')
-    const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
-    const stageContextFilePath = path.join(appRoot.path, stageContextPath, `${stage}.json`)
-
-    const debug = this.node.tryGetContext('debug')
-
-    if (isDevStage(stage)) {
-      if (debug) console.debug(`Development stage. Using default stage context properties`)
-    }
-
-    /* alert default context usage when extra stage config is missing */
-    if (!fs.existsSync(stageContextFilePath)) {
-      if (debug) console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`)
-      if (debug) console.debug(`Using default stage context properties for ${stage} stage`)
-      return
-    }
-
-    /* read the extra properties */
-    const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath)
-    if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
-
-    /* parse as JSON properties */
-    const stageContextProps = JSON.parse(stageContextPropsBuffer.toString('utf-8'))
-
-    /* set each of the property into the cdk node context */
-    _.keys(stageContextProps).forEach((propKey: any) => {
-      /* handle object, array properties */
-      if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
-        this.node.setContext(propKey, _.merge(this.node.tryGetContext(propKey), stageContextProps[propKey]))
-      } else {
-        /* handle all other primitive properties */
-        this.node.setContext(propKey, stageContextProps[propKey])
-      }
-    })
-  }
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  protected fullyQualifiedDomain() {
-    const domainName = this.node.tryGetContext('domainName')
-    const subDomain = this.node.tryGetContext('subDomain')
-    return subDomain ? `${subDomain}.${domainName}` : domainName
-  }
-}

package/src/lib/aws/common/types.ts

@@ -1,30 +0,0 @@
-import { StackProps } from 'aws-cdk-lib'
-import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda'
-import { RetentionDays } from 'aws-cdk-lib/aws-logs'
-import { BaseProps } from '../../common/index.js'
-
-/**
- */
-export interface CommonStackProps extends BaseProps, StackProps {
-  region: string
-  resourceProjectIdentifier?: string
-  globalPrefix?: string
-  globalSuffix?: string
-  resourcePrefix?: string
-  resourceSuffix?: string
-  logRetention?: RetentionDays
-  defaultReservedLambdaConcurrentExecutions?: number
-  defaultTracing?: Tracing
-  excludeDomainNameForBuckets?: boolean
-  excludeAccountNumberForBuckets?: boolean
-  nodejsRuntime?: Runtime
-  resourceNameOptions?: { [key: string]: ResourceNameFormatterProps }
-}
-
-export interface ResourceNameFormatterProps {
-  exclude?: boolean
-  globalPrefix?: boolean
-  globalSuffix?: boolean
-  prefix?: string
-  suffix?: string
-}

package/src/lib/aws/construct/api-to-any-target/index.ts

@@ -1,3 +0,0 @@
-export * from './main.js'
-export * from './target.js'
-export * from './types.js'