@gradientedge/cdk-utils 10.7.0 → 11.0.0

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,49 +0,0 @@
-import { ResourceGroup } from '@pulumi/azure-native/resources/index.js'
-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
-   * @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) {
-    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 }
-    )
-  }
-}

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/servicebus/index.ts

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

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

@@ -1,178 +0,0 @@
-import {
-  getQueueOutput,
-  ManagedServiceIdentityType,
-  Namespace,
-  Queue,
-  SkuName,
-  Subscription,
-  Topic,
-} from '@pulumi/azure-native/servicebus/index.js'
-import { CommonAzureConstruct } from '../../common/index.js'
-import {
-  ResolveServicebusQueueProps,
-  ServicebusNamespaceProps,
-  ServicebusQueueProps,
-  ServicebusSubscriptionProps,
-  ServicebusTopicProps,
-} from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Servicebus 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.ServicebusManager.createServicebusTopic('MyServicebusTopic', this, props)
- *   }
- * }
- * ```
- */
-export class AzureServicebusManager {
-  /**
-   * @summary Method to create a new servicebus namespace
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props servicebus namespace properties
-   * @see [Pulumi Azure Native Service Bus Namespace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/namespace/}
-   */
-  public createServicebusNamespace(id: string, scope: CommonAzureConstruct, props: ServicebusNamespaceProps) {
-    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 Namespace(
-      `${id}-sn`,
-      {
-        ...props,
-        namespaceName: scope.resourceNameFormatter.format(
-          props.namespaceName?.toString(),
-          scope.props.resourceNameOptions?.serviceBusNamespace
-        ),
-        resourceGroupName: resourceGroupName,
-        location: props.location ?? scope.props.location,
-        identity: props.identity ?? {
-          type: ManagedServiceIdentityType.SystemAssigned,
-        },
-        sku: props.sku ?? {
-          name: SkuName.Standard,
-        },
-        tags: props.tags ?? {
-          environment: scope.props.stage,
-        },
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new servicebus topic
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props servicebus topic properties
-   * @see [Pulumi Azure Native Service Bus Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/topic/}
-   */
-  public createServicebusTopic(id: string, scope: CommonAzureConstruct, props: ServicebusTopicProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new Topic(
-      `${id}-st`,
-      {
-        ...props,
-        topicName: scope.resourceNameFormatter.format(
-          props.topicName?.toString(),
-          scope.props.resourceNameOptions?.serviceBusTopic
-        ),
-        namespaceName: props.namespaceName,
-        resourceGroupName: props.resourceGroupName,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new servicebus queue
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props servicebus queue properties
-   * @see [Pulumi Azure Native Service Bus Queue]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
-   */
-  public createServicebusQueue(id: string, scope: CommonAzureConstruct, props: ServicebusQueueProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new Queue(
-      `${id}-sq`,
-      {
-        ...props,
-        queueName: scope.resourceNameFormatter.format(
-          props.queueName?.toString(),
-          scope.props.resourceNameOptions?.serviceBusQueue
-        ),
-        namespaceName: props.namespaceName,
-        resourceGroupName: props.resourceGroupName,
-        duplicateDetectionHistoryTimeWindow: props.duplicateDetectionHistoryTimeWindow ?? 'PT1M',
-        requiresDuplicateDetection: props.requiresDuplicateDetection ?? true,
-        deadLetteringOnMessageExpiration: props.deadLetteringOnMessageExpiration ?? true,
-        defaultMessageTimeToLive: (props as any).defaultMessageTtl ?? 'P2D',
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new servicebus subscription
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props servicebus subscription properties
-   * @see [Pulumi Azure Native Service Bus Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/subscription/}
-   */
-  public createServicebusSubscription(id: string, scope: CommonAzureConstruct, props: ServicebusSubscriptionProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new Subscription(
-      `${id}-ss`,
-      {
-        ...props,
-        subscriptionName: scope.resourceNameFormatter.format(
-          props.subscriptionName?.toString(),
-          scope.props.resourceNameOptions?.serviceBusSubscription
-        ),
-        maxDeliveryCount: props.maxDeliveryCount ?? 1,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to resolve an existing servicebus queue
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props servicebus queue properties for lookup
-   * @see [Pulumi Azure Native Service Bus Queue Lookup]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
-   */
-  public resolveServicebusQueue(id: string, scope: CommonAzureConstruct, props: ResolveServicebusQueueProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return getQueueOutput(
-      {
-        queueName: scope.resourceNameFormatter.format(
-          props.queueName?.toString(),
-          scope.props.resourceNameOptions?.serviceBusQueue
-        ),
-        namespaceName: props.namespaceName,
-        resourceGroupName: props.resourceGroupName,
-      },
-      { parent: scope }
-    )
-  }
-}

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

@@ -1,17 +0,0 @@
-import {
-  GetQueueOutputArgs,
-  NamespaceArgs,
-  QueueArgs,
-  SubscriptionArgs,
-  TopicArgs,
-} from '@pulumi/azure-native/servicebus/index.js'
-
-export interface ServicebusNamespaceProps extends NamespaceArgs {}
-
-export interface ServicebusTopicProps extends TopicArgs {}
-
-export interface ServicebusQueueProps extends QueueArgs {}
-
-export interface ServicebusSubscriptionProps extends SubscriptionArgs {}
-
-export interface ResolveServicebusQueueProps extends GetQueueOutputArgs {}

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

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

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

@@ -1,176 +0,0 @@
-import {
-  Blob,
-  BlobContainer,
-  HttpProtocol,
-  Kind,
-  listStorageAccountSAS,
-  Permissions,
-  Services,
-  SignedResourceTypes,
-  SkuName,
-  StorageAccount,
-} from '@pulumi/azure-native/storage/index.js'
-import * as pulumi from '@pulumi/pulumi'
-import { CommonAzureConstruct } from '../../common/index.js'
-import { ContainerSasTokenProps, StorageAccountProps, StorageBlobProps, StorageContainerProps } from './types.js'
-
-/**
- * @classdesc Provides operations on Azure Storage 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.storageManager.createStorageAccount('MyAccount', this, props)
- *   }
- * }
- * ```
- */
-export class AzureStorageManager {
-  /**
-   * @summary Method to create a new storage account
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props storage account properties
-   * @see [Pulumi Azure Native Storage Account]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/storageaccount/}
-   */
-  public createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const resourceGroupName = scope.props.resourceGroupName
-      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
-      : `${props.resourceGroupName}`
-
-    return new StorageAccount(
-      `${id}-sa`,
-      {
-        ...props,
-        accountName: scope.resourceNameFormatter
-          .format(props.accountName?.toString(), scope.props.resourceNameOptions?.storageAccount)
-          .replace(/\W/g, '')
-          .toLowerCase(),
-        resourceGroupName,
-        sku: props.sku ?? {
-          name: SkuName.Standard_LRS,
-        },
-        kind: props.kind ?? Kind.StorageV2,
-        location: props.location ?? scope.props.location,
-        tags: props.tags ?? {
-          environment: scope.props.stage,
-        },
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new storage container (blob container)
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props storage container properties
-   * @see [Pulumi Azure Native Blob Container]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/blobcontainer/}
-   */
-  public createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const resourceGroupName = scope.props.resourceGroupName
-      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
-      : `${props.resourceGroupName}`
-
-    return new BlobContainer(
-      `${id}-sc`,
-      {
-        ...props,
-        containerName: scope.resourceNameFormatter.format(
-          props.containerName?.toString(),
-          scope.props.resourceNameOptions?.storageContainer
-        ),
-        accountName: props.accountName,
-        resourceGroupName,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new storage blob
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props storage blob properties
-   * @see [Pulumi Azure Native Blob]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/blob/}
-   */
-  public createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const resourceGroupName = scope.props.resourceGroupName
-      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
-      : `${props.resourceGroupName}`
-
-    return new Blob(
-      `${id}-sb`,
-      {
-        ...props,
-        blobName: scope.resourceNameFormatter.format(
-          props.blobName?.toString(),
-          scope.props.resourceNameOptions?.storageBlob
-        ),
-        accountName: props.accountName,
-        containerName: `${props.containerName}-${scope.props.stage}`,
-        resourceGroupName,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Generates a container-level SAS token for an existing Azure Storage container.
-   *
-   * @description
-   * This method generates a Shared Access Signature (SAS) token for secure container access.
-   * The token is generated using Pulumi's listStorageAccountSAS function.
-   *
-   * @param id - Unique scoped identifier for the SAS token resource
-   * @param scope - Pulumi construct scope
-   * @param props - SAS options:
-   *   - start: Optional start date in the format 'YYYY-MM-DD'. Defaults to today's date.
-   *   - expiry: Optional expiry date in the format 'YYYY-MM-DD'. Defaults to 7 days from current date.
-   * @param storageAccount - The storage account resource
-   * @param storageContainer - Optional blob container resource
-   *
-   * @returns A Pulumi Output containing the SAS token
-   *
-   * @see https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/liststorageaccountsas/
-   */
-  public generateContainerSasToken(
-    id: string,
-    scope: CommonAzureConstruct,
-    props: ContainerSasTokenProps,
-    storageAccount: StorageAccount
-  ) {
-    const resourceGroupName = scope.props.resourceGroupName
-      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
-      : `${props.resourceGroupName}`
-
-    return pulumi
-      .all([storageAccount.name])
-      .apply(([accountName]) => {
-        return listStorageAccountSAS({
-          accountName,
-          resourceGroupName,
-          protocols: props.httpsOnly === false ? HttpProtocol.Https_http : HttpProtocol.Https,
-          sharedAccessStartTime: props.start ?? new Date().toISOString().split('T')[0],
-          sharedAccessExpiryTime:
-            props.expiry ?? new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString().split('T')[0],
-          permissions: props.permissions ?? Permissions.R,
-          services: Services.B,
-          resourceTypes: SignedResourceTypes.C,
-        })
-      })
-      .apply(result => result.accountSasToken)
-  }
-}

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

@@ -1,21 +0,0 @@
-import {
-  BlobArgs,
-  BlobContainerArgs,
-  ListStorageAccountSASArgs,
-  StorageAccountArgs,
-} from '@pulumi/azure-native/storage/index.js'
-import { BaseAzureConfigProps } from '../../types/index.js'
-
-export interface StorageAccountProps extends StorageAccountArgs {}
-
-export interface StorageContainerProps extends BaseAzureConfigProps, BlobContainerArgs {}
-
-export interface StorageBlobProps extends BaseAzureConfigProps, BlobArgs {}
-
-export interface ContainerSasTokenProps extends ListStorageAccountSASArgs {
-  resourceGroupName: string
-  containerName?: string
-  httpsOnly?: boolean
-  start?: string
-  expiry?: string
-}

package/src/lib/azure/types/index.ts

@@ -1,4 +0,0 @@
-import * as pulumi from '@pulumi/pulumi'
-export interface BaseAzureConfigProps {
-  resourceGroupName: pulumi.Input<string>
-}

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

@@ -1,91 +0,0 @@
-import { Provider as CloudflareProvider } from '@pulumi/cloudflare'
-import { ComponentResource, ComponentResourceOptions, Config } from '@pulumi/pulumi'
-import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common/index.js'
-import {
-  CloudflareAccessManager,
-  CloudflareApiShieldManager,
-  CloudflareArgoManager,
-  CloudflareFilterManager,
-  CloudflareFirewallManager,
-  CloudflarePageManager,
-  CloudflareRecordManager,
-  CloudflareRuleSetManager,
-  CloudflareWorkerManager,
-  CloudflareZoneManager,
-} from '../services/index.js'
-import { CommonCloudflareStackProps } from './types.js'
-
-export class CommonCloudflareConstruct extends ComponentResource {
-  declare props: CommonCloudflareStackProps
-  declare options?: ComponentResourceOptions
-  id: string
-  config: Config
-  fullyQualifiedDomainName: string
-  accessManager: CloudflareAccessManager
-  apiShieldManager: CloudflareApiShieldManager
-  argoManager: CloudflareArgoManager
-  filterManager: CloudflareFilterManager
-  firewallManager: CloudflareFirewallManager
-  pageManager: CloudflarePageManager
-  recordManager: CloudflareRecordManager
-  ruleSetManager: CloudflareRuleSetManager
-  workerManager: CloudflareWorkerManager
-  zoneManager: CloudflareZoneManager
-  provider: CloudflareProvider
-
-  constructor(name: string, props: CommonCloudflareStackProps, options?: ComponentResourceOptions) {
-    super(`cloudflare:${name}`, name, props, options)
-    this.props = props
-    this.options = options
-    this.id = name
-
-    this.accessManager = new CloudflareAccessManager()
-    this.apiShieldManager = new CloudflareApiShieldManager()
-    this.argoManager = new CloudflareArgoManager()
-    this.filterManager = new CloudflareFilterManager()
-    this.firewallManager = new CloudflareFirewallManager()
-    this.pageManager = new CloudflarePageManager()
-    this.recordManager = new CloudflareRecordManager()
-    this.ruleSetManager = new CloudflareRuleSetManager()
-    this.workerManager = new CloudflareWorkerManager()
-    this.zoneManager = new CloudflareZoneManager()
-
-    /* initialise config */
-    this.config = new Config()
-    this.determineFullyQualifiedDomain()
-    this.provider = new CloudflareProvider(`${this.id}-provider`, this.props, options)
-  }
-
-  /**
-   * @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/cloudflare/common/index.ts

@@ -1,3 +0,0 @@
-export * from './construct.js'
-export * from './stack.js'
-export * from './types.js'