@gradientedge/cdk-utils 10.8.0 → 11.0.0

package/src/lib/azure/services/portal/main.ts

@@ -1,81 +0,0 @@
-import { Dashboard } from '@pulumi/azure-native/portal/index.js'
-import { ResourceOptions } from '@pulumi/pulumi'
-import fs from 'fs'
-import { CommonAzureConstruct } from '../../index.js'
-import { AzureDashboardRenderer } from './renderer.js'
-import { PortalDashboardProps } from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Portal Dashboards 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.azurePortalManager.createDashBoard('MyDashboard', this, props)
- *   }
- * }
- * ```
- */
-export class AzurePortalManager {
-  /**
-   * @summary Method to create a new portal dashboard
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props  the dashboard properties
-   * @param renderer An optional renderer to use
-   * @param resourceOptions Optional settings to control resource behaviour
-   * @see [Pulumi Azure Native Portal Dashboard]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/portal/dashboard/}
-   */
-  public createDashBoard(
-    id: string,
-    scope: CommonAzureConstruct,
-    props: PortalDashboardProps,
-    renderer?: AzureDashboardRenderer,
-    resourceOptions?: ResourceOptions
-  ) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const resourceGroup = scope.resourceGroupManager.resolveResourceGroup(
-      scope,
-      props.resourceGroupName.toString() ?? scope.props.resourceGroupName,
-      resourceOptions
-    )
-
-    const dashboardName = scope.resourceNameFormatter.format(
-      props.dashboardName?.toString(),
-      scope.props.resourceNameOptions?.portalDashboard
-    )
-
-    const dashboardRenderer = renderer ?? new AzureDashboardRenderer()
-    const templateFile = dashboardRenderer.renderToFile(dashboardName, props)
-    const template = fs.readFileSync(templateFile, 'utf-8')
-    const content = Object.entries(props.variables).reduce(
-      (result, [key, value]) => result.replaceAll(`\${${key}}`, String(value)),
-      template
-    )
-
-    return new Dashboard(
-      `${id}-dashboard`,
-      {
-        ...props,
-        dashboardName: scope.resourceNameFormatter.format(
-          props.dashboardName?.toString(),
-          scope.props.resourceNameOptions?.portalDashboard
-        ),
-        resourceGroupName: resourceGroup.name,
-        location: props.location ?? resourceGroup.location,
-        properties: JSON.parse(content),
-        tags: {
-          'hidden-title': `${props.location} - ${props.displayName}`,
-        },
-      },
-      { ...resourceOptions, ignoreChanges: ['location'] }
-    )
-  }
-}

package/src/lib/azure/services/portal/renderer.ts

@@ -1,182 +0,0 @@
-import appRoot from 'app-root-path'
-import fs from 'fs'
-import _ from 'lodash'
-import path from 'path'
-import { parse } from 'yaml'
-import { TemplateError } from './error.js'
-import { DashboardRenderer, MissingKeys, PaneTemplate, RenderParams } from './types.js'
-
-export class AzureDashboardRenderer implements DashboardRenderer {
-  private readonly paneTemplatePath: string
-  private readonly outputDir: string
-
-  constructor(basePath?: string, outputDir?: string) {
-    this.paneTemplatePath = basePath ?? path.join(appRoot.path, 'template', 'dashboard')
-    this.outputDir = outputDir ?? path.join(appRoot.path, '.artifacts')
-  }
-
-  private getPaneId(id: string): PaneTemplate {
-    const panePath = `${this.paneTemplatePath}/${id}.yaml`
-    const paneFileContent = fs.readFileSync(panePath, 'utf-8')
-    const paneTemplate = parse(paneFileContent)
-    return paneTemplate
-  }
-
-  public getMissingProperties(template: PaneTemplate, properties: RenderParams['properties'] = []): MissingKeys {
-    const keys = Object.keys(template.properties).filter(key => !(key in properties))
-    return {
-      keys,
-      hasMissingKeys: keys.length !== 0,
-    }
-  }
-
-  public getMissingVariables(template: PaneTemplate, variables: RenderParams['variables']): MissingKeys {
-    const keys = Object.keys(template.variables).filter(key => !(key in variables))
-    return {
-      keys,
-      hasMissingKeys: keys.length !== 0,
-    }
-  }
-
-  public render(params: RenderParams): string {
-    _.templateSettings.interpolate = /{{([\s\S]+?)}}/g
-
-    // if client is used instead of hosts
-    let partsIndex = 0
-    let yIndex = 0
-    const parts: Record<string, any> = {}
-    for (const pane of params.panes) {
-      try {
-        const paneTemplate = this.getPaneId(pane.id)
-        const compiled = _.template(paneTemplate.template)
-
-        function getValue(value: string | number): string | number {
-          try {
-            if (typeof value === 'number') {
-              return value
-            }
-
-            if (value.includes(':')) {
-              const [property, formatter] = value.split(':')
-              const unformattedValue = _.get(params.properties, property)
-              if (formatter === 'host') {
-                const host = new URL(unformattedValue)
-                const port = host.protocol.startsWith('https') ? '443' : '80'
-                return `${host.host}:${port}`
-              }
-
-              return unformattedValue
-            }
-
-            return value
-          } catch (e) {
-            console.error('failed to process', value, 'with error', e)
-
-            return ''
-          }
-        }
-
-        const missingVariables = this.getMissingVariables(paneTemplate, params.variables)
-        if (missingVariables.hasMissingKeys) {
-          throw new TemplateError(
-            `Failed to render pane ${pane.id}: Missing required variables [${missingVariables.keys.join(', ')}] for template substitution.`
-          )
-        }
-
-        const paneProperties: Record<string, string | number | Array<string | number>> = {}
-        for (const [key, value] of Object.entries(pane.properties ?? {})) {
-          if (value === undefined || value === null) {
-            continue
-          }
-
-          let resolvedValue: string | number | Array<string | number> = ''
-          if (typeof value === 'string') {
-            resolvedValue = getValue(value)
-          }
-
-          if (Array.isArray(value)) {
-            resolvedValue = value.map(v => getValue(v))
-          }
-
-          paneProperties[key] = resolvedValue
-        }
-
-        const properties = { ...params.properties, yIndex, ...paneProperties }
-        const missingProperties = this.getMissingProperties(paneTemplate, properties)
-        if (missingProperties.hasMissingKeys) {
-          throw new TemplateError(
-            `Failed to render pane ${pane.id}: Missing required properties [${missingProperties.keys.join(', ')}] for template substitution.`
-          )
-        }
-        const paneContent = compiled(properties)
-        const paneJSON = JSON.parse(paneContent)
-        const templateParts = paneJSON.parts
-
-        for (const part of templateParts) {
-          parts[`${partsIndex}`] = part
-          partsIndex++
-        }
-        yIndex += paneTemplate.dimensions.height
-      } catch (e) {
-        if (TemplateError.isInstance(e)) {
-          throw e
-        }
-        console.error('failed to render pane', pane.id, 'with error', e)
-      }
-    }
-
-    const dashboard = {
-      lenses: {
-        '0': {
-          order: 0,
-          parts,
-        },
-      },
-      metadata: {
-        model: {
-          timeRange: {
-            value: {
-              relative: {
-                duration: 24,
-                timeUnit: 1,
-              },
-            },
-            type: 'MsPortalFx.Composition.Configuration.ValueTypes.TimeRange',
-          },
-          filterLocale: {
-            value: params.filter?.locale ?? 'en-us',
-          },
-          filters: {
-            value: {
-              MsPortalFx_TimeRange: {
-                model: {
-                  format: params.filter?.timeFormat ?? 'utc',
-                  granularity: params.filter?.timeGranularity ?? 'auto',
-                  relative: params.filter?.timeRelative ?? '4h',
-                },
-                displayCache: {
-                  name: 'UTC Time',
-                  value: 'Past 4 hours',
-                },
-                filteredPartIds: [],
-              },
-            },
-          },
-        },
-      },
-    }
-
-    return JSON.stringify(dashboard, null, 2)
-  }
-
-  renderToFile(filename: string, params: RenderParams): string {
-    const templateOutput = this.render(params)
-    if (!fs.existsSync(this.outputDir)) {
-      fs.mkdirSync(this.outputDir, { recursive: true })
-    }
-    const filePath = path.join(this.outputDir, `${filename}.tftpl`)
-    fs.writeFileSync(filePath, templateOutput)
-
-    return filePath
-  }
-}

package/src/lib/azure/services/portal/types.ts

@@ -1,45 +0,0 @@
-import { DashboardArgs } from '@pulumi/azure-native/portal/index.js'
-
-export type PaneTemplate = {
-  dimensions: { height: number }
-  properties: Record<string, string>
-  variables: Record<string, string>
-  template: string
-}
-
-export type MissingKeys = {
-  keys: Array<string>
-  hasMissingKeys: boolean
-}
-
-export type Pane = {
-  id: string
-  properties?: Record<string, string | number | Array<string | number>>
-}
-
-export type Filter = {
-  locale?: string
-  timeFormat?: string
-  timeGranularity?: string
-  timeRelative?: string
-}
-
-export type RenderParams = {
-  panes: Array<Pane>
-  variables: Record<string, any>
-  properties?: Record<string, any>
-  filter?: Filter
-}
-
-export interface DashboardRenderer {
-  render(params: RenderParams): string
-  renderToFile(filename: string, params: RenderParams): string
-}
-
-export interface PortalDashboardProps extends DashboardArgs {
-  displayName: string
-  panes: Array<Pane>
-  variables: Record<string, string>
-  filter?: Filter
-  enabled?: boolean
-}

package/src/lib/azure/services/redis/index.ts

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

package/src/lib/azure/services/redis/main.ts

@@ -1,66 +0,0 @@
-import { Redis, SkuFamily, SkuName } from '@pulumi/azure-native/redis/index.js'
-import { ResourceOptions } from '@pulumi/pulumi'
-import { CommonAzureConstruct } from '../../common/index.js'
-import { RedisProps } from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Redis 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.redisManager.createManagedRedis('MyManagedRedis', this, props)
- *   }
- * }
- * ```
- */
-export class AzureRedisManager {
-  /**
-   * @summary Method to create a new managed redis cache
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props redis cache properties
-   * @param resourceOptions Optional settings to control resource behaviour
-   * @see [Pulumi Azure Native Redis]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/cache/redis/}
-   */
-  public createManagedRedis(
-    id: string,
-    scope: CommonAzureConstruct,
-    props: RedisProps,
-    resourceOptions?: ResourceOptions
-  ) {
-    if (!props) throw `Props undefined for ${id}`
-
-    // Get resource group name
-    const resourceGroupName = scope.props.resourceGroupName
-      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
-      : props.resourceGroupName
-
-    if (!resourceGroupName) throw `Resource group name undefined for ${id}`
-
-    return new Redis(
-      `${id}-rc`,
-      {
-        ...props,
-        name: scope.resourceNameFormatter.format(props.name?.toString(), scope.props.resourceNameOptions?.managedRedis),
-        location: props.location ?? scope.props.location,
-        resourceGroupName: resourceGroupName,
-        sku: props.sku ?? {
-          name: SkuName.Basic,
-          family: SkuFamily.C,
-          capacity: 0,
-        },
-        tags: props.tags ?? {
-          environment: scope.props.stage,
-        },
-      },
-      { parent: scope, ...resourceOptions }
-    )
-  }
-}

package/src/lib/azure/services/redis/types.ts

@@ -1,3 +0,0 @@
-import { RedisArgs } from '@pulumi/azure-native/redis/index.js'
-
-export interface RedisProps extends RedisArgs {}

package/src/lib/azure/services/resource-group/index.ts

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

package/src/lib/azure/services/resource-group/main.ts

@@ -1,80 +0,0 @@
-import { getResourceGroupOutput, ResourceGroup } from '@pulumi/azure-native/resources/index.js'
-import { ResourceOptions } from '@pulumi/pulumi'
-import { CommonAzureConstruct } from '../../common/index.js'
-import { ResourceGroupProps } from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Resource Group 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.resourceGroupManager.createResourceGroup('MyResourceGroup', this, props)
- *   }
- * }
- * ```
- */
-export class AzureResourceGroupManager {
-  /**
-   * @summary Method to create a new resource group
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props resource group properties
-   * @param resourceOptions Optional settings to control resource behaviour
-   * @see [Pulumi Azure Native Resource Group]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/resources/resourcegroup/}
-   */
-  public createResourceGroup(
-    id: string,
-    scope: CommonAzureConstruct,
-    props: ResourceGroupProps,
-    resourceOptions?: ResourceOptions
-  ) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new ResourceGroup(
-      `${id}-rg`,
-      {
-        ...props,
-        resourceGroupName: scope.resourceNameFormatter.format(
-          props.resourceGroupName?.toString(),
-          scope.props.resourceNameOptions?.resourceGroup
-        ),
-        location: props.location,
-        tags: props.tags ?? {
-          environment: scope.props.stage,
-        },
-      },
-      { parent: scope, ...resourceOptions }
-    )
-  }
-
-  /**
-   * @summary Method to resolve an existing resource group
-   * @param scope scope in which this resource is defined
-   * @param resourceGroupName the resource group name
-   * @param resourceOptions Optional settings to control resource behaviour
-   */
-  public resolveResourceGroup(
-    scope: CommonAzureConstruct,
-    resourceGroupName: string,
-    resourceOptions?: ResourceOptions
-  ) {
-    if (!resourceGroupName) throw `Resource Group Name undefined`
-
-    return getResourceGroupOutput(
-      {
-        resourceGroupName: scope.resourceNameFormatter.format(
-          resourceGroupName?.toString(),
-          scope.props.resourceNameOptions?.resourceGroup
-        ),
-      },
-      { parent: scope, ...resourceOptions }
-    )
-  }
-}

package/src/lib/azure/services/resource-group/types.ts

@@ -1,3 +0,0 @@
-import { ResourceGroupArgs } from '@pulumi/azure-native/resources/index.js'
-
-export interface ResourceGroupProps extends ResourceGroupArgs {}

package/src/lib/azure/services/security-center/index.ts

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

package/src/lib/azure/services/security-center/main.ts

@@ -1,42 +0,0 @@
-import { DefenderForStorage } from '@pulumi/azure-native/security/index.js'
-import { ResourceOptions } from '@pulumi/pulumi'
-import { CommonAzureConstruct } from '../../common/index.js'
-import { DefenderForStorageProps } from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Security Center 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.securityCenterManager.createDefenderForStorage('MyDefender', this, props)
- *   }
- * }
- * ```
- */
-export class AzureSecurityCentermanager {
-  /**
-   * @summary Method to create a new defender for storage account
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props defender for storage account properties
-   * @param resourceOptions Optional settings to control resource behaviour
-   * @see [Pulumi Azure Native Defender For Storage]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/security/defenderforstorage/}
-   */
-  public createDefenderForStorage(
-    id: string,
-    scope: CommonAzureConstruct,
-    props: DefenderForStorageProps,
-    resourceOptions?: ResourceOptions
-  ) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new DefenderForStorage(`${id}`, props, { parent: scope, ...resourceOptions })
-  }
-}

package/src/lib/azure/services/security-center/types.ts

@@ -1,3 +0,0 @@
-import { DefenderForStorageArgs } from '@pulumi/azure-native/security/index.js'
-
-export interface DefenderForStorageProps extends DefenderForStorageArgs {}

package/src/lib/azure/services/servicebus/index.ts

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