@gradientedge/cdk-utils 10.8.0 → 11.0.0

package/dist/src/lib/azure/common/construct.js

@@ -1,128 +0,0 @@
-import { getWorkspaceOutput } from '@pulumi/azure-native/operationalinsights/index.js';
-import * as pulumi from '@pulumi/pulumi';
-import { ComponentResource } from '@pulumi/pulumi';
-import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common/index.js';
-import { AzureAuthorisationManager } from '../services/authorisation/main.js';
-import { AzureApiManagementManager, AzureAppConfigurationManager, AzureApplicationInsightsManager, AzureAppServiceManager, AzureCosmosDbManager, AzureDnsManager, AzureEventgridManager, AzureFunctionManager, AzureKeyVaultManager, AzureMonitorManager, AzureOperationalInsightsManager, AzurePortalManager, AzureRedisManager, AzureResourceGroupManager, AzureSecurityCentermanager, AzureServiceBusManager, AzureStorageManager, } from '../services/index.js';
-import { AzureResourceNameFormatter } from './resource-name-formatter.js';
-/**
- * @classdesc Common Azure construct to use as a base for all higher level constructs using Pulumi
- * - Provides manager instances for all Azure services
- * - Handles resource naming conventions
- * - Manages common properties and utilities
- * @example
- * ```typescript
- * import { CommonAzureConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonAzureConstruct {
- *   constructor(name: string, props: CommonAzureStackProps) {
- *     super(name, props)
- *     // provision resources using this.resourceGroupManager, etc.
- *   }
- * }
- * ```
- */
-export class CommonAzureConstruct extends ComponentResource {
-    id;
-    resourceGroup;
-    fullyQualifiedDomainName;
-    authorisationManager;
-    apiManagementManager;
-    appConfigurationManager;
-    appServiceManager;
-    applicationInsightsManager;
-    cosmosDbManager;
-    dnsManager;
-    eventgridManager;
-    functionManager;
-    keyVaultManager;
-    operationalInsightsManager;
-    portalManager;
-    monitorManager;
-    redisManager;
-    resourceGroupManager;
-    resourceNameFormatter;
-    securityCentermanager;
-    serviceBusManager;
-    storageManager;
-    commonLogAnalyticsWorkspace;
-    constructor(name, props, options) {
-        super(`azure:${name}`, name, props, options);
-        this.props = props;
-        this.options = options;
-        this.id = name;
-        this.authorisationManager = new AzureAuthorisationManager();
-        this.apiManagementManager = new AzureApiManagementManager();
-        this.appConfigurationManager = new AzureAppConfigurationManager();
-        this.appServiceManager = new AzureAppServiceManager();
-        this.applicationInsightsManager = new AzureApplicationInsightsManager();
-        this.cosmosDbManager = new AzureCosmosDbManager();
-        this.dnsManager = new AzureDnsManager();
-        this.eventgridManager = new AzureEventgridManager();
-        this.functionManager = new AzureFunctionManager();
-        this.keyVaultManager = new AzureKeyVaultManager();
-        this.operationalInsightsManager = new AzureOperationalInsightsManager();
-        this.portalManager = new AzurePortalManager();
-        this.monitorManager = new AzureMonitorManager();
-        this.redisManager = new AzureRedisManager();
-        this.resourceGroupManager = new AzureResourceGroupManager();
-        this.resourceNameFormatter = new AzureResourceNameFormatter(props);
-        this.securityCentermanager = new AzureSecurityCentermanager();
-        this.serviceBusManager = new AzureServiceBusManager();
-        this.storageManager = new AzureStorageManager();
-        this.determineFullyQualifiedDomain();
-    }
-    resolveStack(stackName) {
-        if (!stackName)
-            throw 'Stack name undefined';
-        return new pulumi.StackReference(stackName);
-    }
-    createResourceGroup() {
-        if (this.resourceGroup)
-            return;
-        this.resourceGroup = this.resourceGroupManager.createResourceGroup(`${this.id}`, this, {
-            resourceGroupName: this.props.stackName,
-            location: this.props.location,
-        });
-        this.registerOutputs({
-            resourceGroupId: this.resourceGroup.id,
-            resourceGroupName: this.resourceGroup.name,
-        });
-    }
-    resolveCommonLogAnalyticsWorkspace() {
-        if (!this.props.commonLogAnalyticsWorkspace || !this.props.commonLogAnalyticsWorkspace.workspaceName)
-            throw 'Props undefined for commonLogAnalyticsWorkspace';
-        this.commonLogAnalyticsWorkspace = getWorkspaceOutput({
-            workspaceName: this.props.commonLogAnalyticsWorkspace.workspaceName,
-            resourceGroupName: this.props.commonLogAnalyticsWorkspace.resourceGroupName,
-        });
-    }
-    /**
-     * @summary Determine the fully qualified domain name based on domainName & subDomain
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    isProductionStage = () => isPrdStage(this.props.stage);
-}

package/dist/src/lib/azure/common/index.d.ts

@@ -1,6 +0,0 @@
-export * from './constants.js';
-export * from './construct.js';
-export * from './resource-name-formatter.js';
-export * from './stack.js';
-export * from './tagging.js';
-export * from './types.js';

package/dist/src/lib/azure/common/index.js

@@ -1,6 +0,0 @@
-export * from './constants.js';
-export * from './construct.js';
-export * from './resource-name-formatter.js';
-export * from './stack.js';
-export * from './tagging.js';
-export * from './types.js';

package/dist/src/lib/azure/common/resource-name-formatter.d.ts

@@ -1,18 +0,0 @@
-import { AzureResourceNameFormatterProps, CommonAzureStackProps } from '../index.js';
-/**
- * @classdesc Formats Azure resource names according to naming conventions
- * - Applies global/resource prefixes and suffixes
- * - Automatically appends stage to resource names
- * - Supports per-resource customization via options
- */
-export declare class AzureResourceNameFormatter {
-    props: CommonAzureStackProps;
-    constructor(props: CommonAzureStackProps);
-    /**
-     * @summary Helper method to format azure resource name based on the provided options
-     * @param resourceName The azure resource name to format
-     * @param options Options to control the formatting of the resource name
-     * @returns The formatted Azure-compliant resource name
-     */
-    format(resourceName: string | undefined, options?: AzureResourceNameFormatterProps): string;
-}

package/dist/src/lib/azure/common/resource-name-formatter.js

@@ -1,34 +0,0 @@
-/**
- * @classdesc Formats Azure resource names according to naming conventions
- * - Applies global/resource prefixes and suffixes
- * - Automatically appends stage to resource names
- * - Supports per-resource customization via options
- */
-export class AzureResourceNameFormatter {
-    props;
-    constructor(props) {
-        this.props = props;
-    }
-    /**
-     * @summary Helper method to format azure resource name based on the provided options
-     * @param resourceName The azure resource name to format
-     * @param options Options to control the formatting of the resource name
-     * @returns The formatted Azure-compliant resource name
-     */
-    format(resourceName, options) {
-        const azureResourceNameElements = [];
-        if (!options?.exclude) {
-            azureResourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined);
-            azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix);
-        }
-        azureResourceNameElements.push(resourceName || '');
-        if (!options?.exclude) {
-            azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix);
-            azureResourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined);
-        }
-        azureResourceNameElements.push(this.props.stage);
-        return azureResourceNameElements
-            .filter(azureResourceNameElements => azureResourceNameElements != undefined)
-            .join('-');
-    }
-}

package/dist/src/lib/azure/common/stack.d.ts

@@ -1,46 +0,0 @@
-import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pulumi';
-import { CommonAzureConstruct } from './construct.js';
-import { CommonAzureStackProps } from './types.js';
-/**
- * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
- * @example
- * ```typescript
- * import { CommonAzureStack } from '@gradientedge/cdk-utils'
- *
- * class CustomStack extends CommonAzureStack {
- *   constructor(name: string, props: CommonAzureStackProps) {
- *     super(name, props)
- *     // provision resources
- *   }
- * }
- * ```
- */
-export declare class CommonAzureStack extends ComponentResource {
-    static NODEJS_RUNTIME: string;
-    construct: CommonAzureConstruct;
-    props: CommonAzureStackProps;
-    config: Config;
-    constructor(name: string, props: CommonAzureStackProps, options?: ComponentResourceOptions);
-    /**
-     * @summary Method to determine the core construct properties injected via context
-     * @param props The stack properties
-     * @returns The stack properties
-     */
-    protected determineConstructProps(props: CommonAzureStackProps): any;
-    /**
-     * @summary Method to determine extra contexts apart from the main context
-     * - Sets the properties from the extra contexts
-     * - Primary use is to have layered config in separate files to enable easier maintenance and readability
-     */
-    protected determineExtraContexts(): Record<string, any>;
-    /**
-     * @summary Method to determine extra stage contexts apart from the main context
-     * - Sets the properties from the extra stage contexts
-     * - Primary use is to have layered config for each environment which is injected into the context
-     */
-    protected determineStageContexts(): any;
-    /**
-     * @summary Determine the fully qualified domain name based on domainName & subDomain
-     */
-    protected fullyQualifiedDomain(): string;
-}

package/dist/src/lib/azure/common/stack.js

@@ -1,120 +0,0 @@
-import { ComponentResource, Config } from '@pulumi/pulumi';
-import appRoot from 'app-root-path';
-import fs from 'fs';
-import _ from 'lodash';
-import path from 'path';
-import { isDevStage } from '../../common/index.js';
-import { registerTagTransformation } from './tagging.js';
-/**
- * @classdesc Common stack to use as a base for all higher level constructs using Pulumi
- * @example
- * ```typescript
- * import { CommonAzureStack } from '@gradientedge/cdk-utils'
- *
- * class CustomStack extends CommonAzureStack {
- *   constructor(name: string, props: CommonAzureStackProps) {
- *     super(name, props)
- *     // provision resources
- *   }
- * }
- * ```
- */
-export class CommonAzureStack extends ComponentResource {
-    static NODEJS_RUNTIME = '22';
-    construct;
-    props;
-    config;
-    constructor(name, props, options) {
-        super(`custom:azure:Stack:${name}`, name, props, options);
-        /* initialise config */
-        this.config = new Config();
-        this.props = this.determineConstructProps(props);
-        /* register tag transformation for automatic tag application */
-        if (this.props.defaultTags) {
-            registerTagTransformation(this.props.defaultTags);
-        }
-    }
-    /**
-     * @summary Method to determine the core construct properties injected via context
-     * @param props The stack properties
-     * @returns The stack properties
-     */
-    determineConstructProps(props) {
-        return {
-            ...props,
-            extraContexts: this.config.getObject('extraContexts'),
-            stage: this.config.require('stage'),
-            stageContextPath: this.config.require('stageContextPath'),
-            ...this.determineExtraContexts(),
-            ...this.determineStageContexts(),
-        };
-    }
-    /**
-     * @summary Method to determine extra contexts apart from the main context
-     * - Sets the properties from the extra contexts
-     * - Primary use is to have layered config in separate files to enable easier maintenance and readability
-     */
-    determineExtraContexts() {
-        const extraContexts = this.config.getObject('extraContexts');
-        const debug = this.config.getBoolean('debug');
-        if (!extraContexts) {
-            if (debug)
-                console.debug(`No additional contexts provided. Using default context properties`);
-            return {};
-        }
-        let extraContextProps = {};
-        _.forEach(extraContexts, (context) => {
-            const extraContextPath = path.join(appRoot.path, context);
-            /* scenario where extra context is configured 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 */
-            extraContextProps = {
-                ...extraContextProps,
-                ...JSON.parse(extraContextPropsBuffer.toString('utf-8')),
-            };
-        });
-        return extraContextProps;
-    }
-    /**
-     * @summary Method to determine extra stage contexts apart from the main context
-     * - Sets the properties from the extra stage contexts
-     * - Primary use is to have layered config for each environment which is injected into the context
-     */
-    determineStageContexts() {
-        const debug = this.config.getBoolean('debug');
-        const stage = this.config.require('stage');
-        const stageContextPath = this.config.get('stageContextPath');
-        const stageContextFilePath = path.join(appRoot.path, stageContextPath ?? 'env', `${stage}.json`);
-        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 */
-        return JSON.parse(stageContextPropsBuffer.toString('utf-8'));
-    }
-    /**
-     * @summary Determine the fully qualified domain name based on domainName & subDomain
-     */
-    fullyQualifiedDomain() {
-        const domainName = this.props.domainName;
-        const subDomain = this.props.subDomain;
-        return subDomain ? `${subDomain}.${domainName}` : domainName;
-    }
-}

package/dist/src/lib/azure/common/tagging.d.ts

@@ -1,29 +0,0 @@
-/**
- * @summary Check if a resource type is taggable
- * @param resourceType The Pulumi resource type (e.g., 'azure-native:resources:ResourceGroup')
- * @returns True if the resource supports tags, false otherwise
- */
-export declare function isTaggableResource(resourceType: string): boolean;
-/**
- * @summary Register a stack transformation to automatically apply tags to Azure resources
- * @param defaultTags The default tags to apply to all resources
- * @param tagsToIgnore Optional list of tag keys to ignore in lifecycle management
- * @example
- * ```typescript
- * registerTagTransformation({ environment: 'production', team: 'platform' })
- * ```
- */
-export declare function registerTagTransformation(defaultTags: Record<string, string>, tagsToIgnore?: string[]): void;
-/**
- * @summary Helper function to apply tags to a specific resource's properties
- * @param props The resource properties
- * @param defaultTags The default tags to merge with existing tags
- * @returns The properties with merged tags
- * @example
- * ```typescript
- * const resourceGroupProps = applyTags(props, { environment: 'dev' })
- * ```
- */
-export declare function applyTags<T extends {
-    tags?: Record<string, string>;
-}>(props: T, defaultTags: Record<string, string>): T;

package/dist/src/lib/azure/common/tagging.js

@@ -1,78 +0,0 @@
-import * as pulumi from '@pulumi/pulumi';
-import { RESOURCES_TO_EXCLUDE_TAGS } from './constants.js';
-/**
- * @summary Check if a resource type is taggable
- * @param resourceType The Pulumi resource type (e.g., 'azure-native:resources:ResourceGroup')
- * @returns True if the resource supports tags, false otherwise
- */
-export function isTaggableResource(resourceType) {
-    // Extract the resource name from the type (e.g., 'ResourceGroup' from 'azure-native:resources:ResourceGroup')
-    const resourceName = resourceType.split(':').pop() || '';
-    // Check if this resource is in the exclusion list
-    if (RESOURCES_TO_EXCLUDE_TAGS.has(resourceName)) {
-        return false;
-    }
-    // Most Azure resources support tags, but we can add more specific checks here if needed
-    return true;
-}
-/**
- * @summary Register a stack transformation to automatically apply tags to Azure resources
- * @param defaultTags The default tags to apply to all resources
- * @param tagsToIgnore Optional list of tag keys to ignore in lifecycle management
- * @example
- * ```typescript
- * registerTagTransformation({ environment: 'production', team: 'platform' })
- * ```
- */
-export function registerTagTransformation(defaultTags, tagsToIgnore = []) {
-    pulumi.runtime.registerStackTransformation((args) => {
-        // Only process taggable resources
-        if (!isTaggableResource(args.type)) {
-            return undefined;
-        }
-        // Check if the resource has a tags property
-        if (!args.props || typeof args.props !== 'object') {
-            return undefined;
-        }
-        // Merge default tags with resource-specific tags (resource tags take precedence)
-        const currentTags = args.props.tags || {};
-        const mergedTags = { ...defaultTags, ...currentTags };
-        // Apply the merged tags
-        const newProps = {
-            ...args.props,
-            tags: mergedTags,
-        };
-        // Handle tag ignores via Pulumi's ignoreChanges option
-        let newOpts = args.opts;
-        if (tagsToIgnore.length > 0) {
-            const ignoreChanges = tagsToIgnore.map(tag => `tags.${tag}`);
-            newOpts = {
-                ...args.opts,
-                ignoreChanges: [...(args.opts?.ignoreChanges || []), ...ignoreChanges],
-            };
-        }
-        return {
-            props: newProps,
-            opts: newOpts,
-        };
-    });
-}
-/**
- * @summary Helper function to apply tags to a specific resource's properties
- * @param props The resource properties
- * @param defaultTags The default tags to merge with existing tags
- * @returns The properties with merged tags
- * @example
- * ```typescript
- * const resourceGroupProps = applyTags(props, { environment: 'dev' })
- * ```
- */
-export function applyTags(props, defaultTags) {
-    return {
-        ...props,
-        tags: {
-            ...defaultTags,
-            ...(props.tags || {}),
-        },
-    };
-}

package/dist/src/lib/azure/common/types.d.ts

@@ -1,57 +0,0 @@
-import { GetComponentOutputArgs } from '@pulumi/azure-native/applicationinsights/index.js';
-import { GetWorkspaceOutputArgs } from '@pulumi/azure-native/operationalinsights/index.js';
-import { BaseProps } from '../../common/index.js';
-import { AzureLocation, AzureRemoteBackend } from './constants.js';
-export interface AzureLocationConfig {
-    id: string;
-    name: string;
-}
-/**
- * @interface CommonAzureStackProps
- * @description Common properties for Azure stack configuration using Pulumi
- */
-export interface CommonAzureStackProps extends BaseProps {
-    stackName?: string;
-    resourceGroupName?: string;
-    remoteBackend?: AzureRemoteBackendProps;
-    globalPrefix?: string;
-    globalSuffix?: string;
-    resourcePrefix?: string;
-    resourceSuffix?: string;
-    resourceNameOptions?: {
-        [key: string]: AzureResourceNameFormatterProps;
-    };
-    location: AzureLocation;
-    locationConfig?: Record<AzureLocation, AzureLocationConfig>;
-    locales?: string[];
-    defaultTags?: {
-        [key: string]: string;
-    };
-    commonLogAnalyticsWorkspace?: GetWorkspaceOutputArgs;
-    commonApplicationInsights?: GetComponentOutputArgs;
-    subscriptionId?: string;
-    tenantId?: string;
-    clientId?: string;
-    clientSecret?: string;
-    environment?: string;
-    useOidc?: boolean;
-    oidcRequestToken?: string;
-    oidcRequestUrl?: string;
-    useMsi?: boolean;
-    msiEndpoint?: string;
-}
-export interface AzureRemoteBackendProps {
-    type: AzureRemoteBackend;
-    storageAccountName?: string;
-    containerName?: string;
-    resourceGroupName?: string;
-    subscriptionId?: string;
-    key?: string;
-}
-export interface AzureResourceNameFormatterProps {
-    exclude?: boolean;
-    globalPrefix?: boolean;
-    globalSuffix?: boolean;
-    prefix?: string;
-    suffix?: string;
-}

package/dist/src/lib/azure/common/types.js

@@ -1 +0,0 @@
-export {};

package/dist/src/lib/azure/construct/event-handler/index.d.ts

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/azure/construct/event-handler/index.js

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/azure/construct/event-handler/main.d.ts

@@ -1,20 +0,0 @@
-import { GetTopicResult, Topic } from '@pulumi/azure-native/eventgrid/index.js';
-import { Output } from '@pulumi/pulumi';
-import { AzureFunctionApp } from '../function-app/index.js';
-import { AzureEventHandlerProps, EventHandlerEventGridSubscription, EventHandlerServiceBus } from './types.js';
-export declare class AzureEventHandler extends AzureFunctionApp {
-    props: AzureEventHandlerProps;
-    eventGridEventSubscription: EventHandlerEventGridSubscription;
-    eventGridTopic: Topic | Output<GetTopicResult>;
-    serviceBus: EventHandlerServiceBus;
-    constructor(id: string, props: AzureEventHandlerProps);
-    initResources(): void;
-    protected createEventGridSubscriptionDlqStorageAccount(): void;
-    protected createEventGridSubscriptionDlqStorageContainer(): void;
-    protected createServiceBusNamespace(): void;
-    protected createServiceBusQueue(): void;
-    protected createEventGrid(): void;
-    protected createEventGridEventSubscription(): void;
-    protected createServiceBusDiagnosticLog(): void;
-    protected enableMalwareScanningOnDataStorageAccount(): void;
-}