@gradientedge/cdk-utils 10.7.0 → 11.0.0

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,45 +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 {
-    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(props: CommonAzureStackProps): 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(props: CommonAzureStackProps): any;
-    /**
-     * @summary Determine the fully qualified domain name based on domainName & subDomain
-     */
-    protected fullyQualifiedDomain(): string;
-}

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

@@ -1,137 +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 {
-    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) {
-        let projectProps = props;
-        if (!projectProps) {
-            const projectPropsPath = path.join(appRoot.path, 'pulumi.json');
-            if (!fs.existsSync(projectPropsPath))
-                throw `Context properties unavailable in path:${projectPropsPath}`;
-            const projectPropsBuffer = fs.readFileSync(projectPropsPath);
-            projectProps = JSON.parse(projectPropsBuffer.toString('utf-8'));
-        }
-        return {
-            domainName: projectProps.domainName,
-            extraContexts: projectProps.extraContexts,
-            location: projectProps.location,
-            name: projectProps.resourceGroupName ?? projectProps.name,
-            resourceGroupName: projectProps.resourceGroupName,
-            globalPrefix: projectProps.globalPrefix,
-            globalSuffix: projectProps.globalSuffix,
-            resourceNameOptions: projectProps.resourceNameOptions,
-            resourcePrefix: projectProps.resourcePrefix,
-            resourceSuffix: projectProps.resourceSuffix,
-            skipStageForARecords: projectProps.skipStageForARecords,
-            stage: projectProps.stage,
-            stageContextPath: projectProps.stageContextPath,
-            subDomain: projectProps.subDomain,
-            subscriptionId: projectProps.subscriptionId,
-            tenantId: projectProps.tenantId,
-            clientId: projectProps.clientId,
-            clientSecret: projectProps.clientSecret,
-            defaultTags: projectProps.defaultTags,
-            ...this.determineExtraContexts(props),
-            ...this.determineStageContexts(props),
-        };
-    }
-    /**
-     * @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(props) {
-        if (!props.extraContexts) {
-            if (props.debug)
-                console.debug(`No additional contexts provided. Using default context properties`);
-            return {};
-        }
-        let extraContextProps = {};
-        _.forEach(props.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 (props.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(props) {
-        const stageContextFilePath = path.join(appRoot.path, props.stageContextPath ?? 'env', `${props.stage}.json`);
-        if (isDevStage(props.stage)) {
-            if (props.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 (props.debug)
-                console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`);
-            if (props.debug)
-                console.debug(`Using default stage context properties for ${props.stage} stage`);
-            return {};
-        }
-        /* read the extra properties */
-        const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath);
-        if (props.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,46 +0,0 @@
-import { BaseProps } from '../../common/index.js';
-import { AzureRemoteBackend } from './constants.js';
-/**
- * @interface CommonAzureStackProps
- * @description Common properties for Azure stack configuration using Pulumi
- */
-export interface CommonAzureStackProps extends BaseProps {
-    resourceGroupName?: string;
-    remoteBackend?: AzureRemoteBackendProps;
-    globalPrefix?: string;
-    globalSuffix?: string;
-    resourcePrefix?: string;
-    resourceSuffix?: string;
-    resourceNameOptions?: {
-        [key: string]: AzureResourceNameFormatterProps;
-    };
-    location?: string;
-    defaultTags?: {
-        [key: string]: string;
-    };
-    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/index.d.ts

@@ -1,3 +0,0 @@
-export * from './common/index.js';
-export * from './services/index.js';
-export * from './types/index.js';

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

@@ -1,3 +0,0 @@
-export * from './common/index.js';
-export * from './services/index.js';
-export * from './types/index.js';

package/dist/src/lib/azure/services/api-management/index.d.ts

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

package/dist/src/lib/azure/services/api-management/index.js

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

package/dist/src/lib/azure/services/api-management/main.d.ts

@@ -1,65 +0,0 @@
-import * as redis from '@pulumi/azure-native/redis/index.js';
-import { CommonAzureConstruct } from '../../common/index.js';
-import { ApiManagementApiProps, ApiManagementBackendProps, ApiManagementCustomDomainProps, ApiManagementProps, ResolveApiManagementProps } from './types.js';
-/**
- * @classdesc Provides operations on Azure API Management using Pulumi
- * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
- * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
- * @example
- * ```typescript
- * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonAzureConstruct {
- *   constructor(name: string, props: CommonAzureStackProps) {
- *     super(name, props)
- *     this.props = props
- *     this.apiManagementManager.createApiManagement('MyApiManagement', this, props)
- *   }
- * }
- * ```
- */
-export declare class AzureApiManagementManager {
-    /**
-     * @summary Method to create a new API Management service
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props API Management properties
-     * @param applicationInsightsKey Optional Application Insights instrumentation key for logging
-     * @param externalRedisCache Optional external Redis cache for API Management caching
-     * @see [Pulumi Azure Native API Management]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apimanagementservice/}
-     */
-    createApiManagementService(id: string, scope: CommonAzureConstruct, props: ApiManagementProps, applicationInsightsKey?: string, externalRedisCache?: redis.Redis): import("@pulumi/azure-native/apimanagement/apiManagementService.js").ApiManagementService;
-    /**
-     * @summary Method to resolve an existing API Management service
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props API Management lookup properties
-     * @see [Pulumi Azure Native API Management Lookup]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/apimanagementservice/}
-     */
-    resolveApiManagementService(id: string, scope: CommonAzureConstruct, props: ResolveApiManagementProps): import("@pulumi/pulumi").Output<import("@pulumi/azure-native/apimanagement/getApiManagementService.js").GetApiManagementServiceResult>;
-    /**
-     * @summary Method to create a new API Management backend
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props API Management backend properties
-     * @see [Pulumi Azure Native API Management Backend]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/backend/}
-     */
-    createBackend(id: string, scope: CommonAzureConstruct, props: ApiManagementBackendProps): import("@pulumi/azure-native/apimanagement/backend.js").Backend;
-    /**
-     * @summary Method to create a new API Management API with operations and policies
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props API Management API properties
-     * @see [Pulumi Azure Native API Management API]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/api/}
-     */
-    createApi(id: string, scope: CommonAzureConstruct, props: ApiManagementApiProps): import("@pulumi/azure-native/apimanagement/api.js").Api;
-    /**
-     * @summary Method to create a new API Management custom domain
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props API Management custom domain properties
-     * @note In Pulumi Azure Native, custom domains are configured as part of the API Management service resource,
-     * not as a separate resource. Use the hostnameConfigurations property when creating the service.
-     */
-    createApiManagementCustomDomain(id: string, scope: CommonAzureConstruct, props: ApiManagementCustomDomainProps): void;
-}