@gradientedge/cdk-utils 10.7.0 → 11.0.0

package/src/lib/cloudflare/services/zone/main.ts

@@ -1,221 +0,0 @@
-import {
-  Zone,
-  ZoneCacheReserve,
-  ZoneCacheVariants,
-  ZoneDnssec,
-  ZoneHold,
-  ZoneLockdown,
-  ZoneSetting,
-} from '@pulumi/cloudflare'
-import * as pulumi from '@pulumi/pulumi'
-import { CommonCloudflareConstruct } from '../../common/index.js'
-import {
-  GetZoneProps,
-  ZoneCacheReserveProps,
-  ZoneCacheVariantsProps,
-  ZoneDnssecProps,
-  ZoneHoldProps,
-  ZoneLockdownProps,
-  ZoneProps,
-  ZoneSettingProps,
-} from './types.js'
-
-/**
- * @classdesc Provides operations on Cloudflare Zone using Pulumi
- * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
- * - If a custom construct extends {@link CommonCloudflareConstruct}, an instance is available within the context.
- * @example
- * ```
- * import { CommonCloudflareConstruct } from '@gradientedge/cdk-utils'
- *
- * class CustomConstruct extends CommonCloudflareConstruct {
- *   constructor(parent: pulumi.ComponentResource, id: string, props: CommonCloudflareStackProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.zoneManager.createZone('MyZone', this, props)
- *   }
- * }
- * ```
- */
-export class CloudflareZoneManager {
-  /**
-   * @summary Method to create a new zone
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone properties
-   */
-  public createZone(id: string, scope: CommonCloudflareConstruct, props: ZoneProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    return new Zone(
-      id,
-      {
-        ...props,
-        account: props.account ?? scope.props.accountId,
-        name: scope.props.domainName,
-      },
-      { parent: scope }
-    )
-  }
-
-  public resolveZone(id: string, scope: CommonCloudflareConstruct, options?: GetZoneProps) {
-    const name = options?.filter?.name ?? scope.props.domainName
-    return Zone.get(name, id)
-  }
-
-  /**
-   * @summary Method to create a new zone cache reserve
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone cache reserve properties
-   */
-  public createZoneCacheReserve(id: string, scope: CommonCloudflareConstruct, props: ZoneCacheReserveProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneCacheReserve(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new zone cache variants
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone cache variants properties
-   */
-  public createZoneCacheVariants(id: string, scope: CommonCloudflareConstruct, props: ZoneCacheVariantsProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneCacheVariants(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new zone dnssec
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone dnssec properties
-   */
-  public createZoneDnssec(id: string, scope: CommonCloudflareConstruct, props: ZoneDnssecProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneDnssec(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new zone hold
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone hold properties
-   */
-  public createZoneHold(id: string, scope: CommonCloudflareConstruct, props: ZoneHoldProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneHold(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create a new zone lockdown
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone lockdown properties
-   */
-  public createZoneLockdown(id: string, scope: CommonCloudflareConstruct, props: ZoneLockdownProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneLockdown(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-
-  /**
-   * @summary Method to create new zone dns settings
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone dns settings properties
-   */
-  public createZoneDnsSettings(id: string, scope: CommonCloudflareConstruct, props: ZoneSettingProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    const zoneDnsSettings = new ZoneSetting(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-
-    return zoneDnsSettings
-  }
-
-  /**
-   * @summary Method to create a new zone setting
-   * @param id scoped id of the resource
-   * @param scope scope in which this resource is defined
-   * @param props zone setting properties
-   */
-  public createZoneSetting(id: string, scope: CommonCloudflareConstruct, props: ZoneSettingProps) {
-    if (!props) throw `Props undefined for ${id}`
-
-    const zoneId =
-      props.zoneId ??
-      pulumi.output(this.resolveZone(`${id}-data-zone`, scope, { filter: { name: scope.props.domainName } })).id
-    return new ZoneSetting(
-      id,
-      {
-        ...props,
-        zoneId,
-      },
-      { parent: scope }
-    )
-  }
-}

package/src/lib/cloudflare/services/zone/types.ts

@@ -1,21 +0,0 @@
-import {
-  GetZoneArgs,
-  ZoneArgs,
-  ZoneCacheReserveArgs,
-  ZoneCacheVariantsArgs,
-  ZoneDnssecArgs,
-  ZoneDnsSettingsArgs,
-  ZoneHoldArgs,
-  ZoneLockdownArgs,
-  ZoneSettingArgs,
-} from '@pulumi/cloudflare'
-
-export interface ZoneProps extends ZoneArgs {}
-export interface GetZoneProps extends GetZoneArgs {}
-export interface ZoneCacheReserveProps extends ZoneCacheReserveArgs {}
-export interface ZoneCacheVariantsProps extends ZoneCacheVariantsArgs {}
-export interface ZoneDnssecProps extends ZoneDnssecArgs {}
-export interface ZoneHoldProps extends ZoneHoldArgs {}
-export interface ZoneLockdownProps extends ZoneLockdownArgs {}
-export interface ZoneSettingProps extends ZoneSettingArgs {}
-export interface ZoneDnsSettingsProps extends ZoneDnsSettingsArgs {}

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

@@ -1,3 +0,0 @@
-export interface BaseCloudflareProps {
-  accountId: string
-}

package/src/lib/common/construct.ts

@@ -1,35 +0,0 @@
-import { Construct } from 'constructs'
-import { BaseProps } from './types.js'
-
-export abstract class BaseConstruct extends Construct {
-  props: BaseProps
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  public abstract determineFullyQualifiedDomain(): void
-
-  /**
-   * @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 abstract isDevelopmentStage(): void
-
-  /**
-   * @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 abstract isTestStage(): void
-
-  /**
-   * @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 abstract isUatStage(): void
-
-  /**
-   * @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 abstract isProductionStage(): void
-}

package/src/lib/common/index.ts

@@ -1,18 +0,0 @@
-import _ from 'lodash'
-
-export * from './construct.js'
-export * from './stack.js'
-export * from './types.js'
-export * from './utils.js'
-
-export const applyMixins = (derivedCtor: any, constructors: any[]) => {
-  _.forEach(constructors, baseConstructor => {
-    Object.getOwnPropertyNames(baseConstructor.prototype).forEach(name => {
-      Object.defineProperty(
-        derivedCtor.prototype,
-        name,
-        Object.getOwnPropertyDescriptor(baseConstructor.prototype, name) || Object.create(null)
-      )
-    })
-  })
-}

package/src/lib/common/stack.ts

@@ -1,26 +0,0 @@
-import { Construct } from 'constructs'
-import { BaseProps } from './types.js'
-
-export abstract class BaseStack extends Construct {
-  props: BaseProps
-
-  /**
-   * @summary Method to determine the core CDK construct properties injected via context json
-   */
-  protected abstract determineConstructProps(props: BaseProps): void
-
-  /**
-   * @summary Method to determine extra cdk contexts apart from the main json
-   */
-  public abstract determineExtraContexts(): void
-
-  /**
-   * @summary Method to determine extra cdk stage contexts apart from the main json
-   */
-  public abstract determineStageContexts(): void
-
-  /**
-   * @summary Determine the fully qualified domain name based on domainName & subDomain
-   */
-  public abstract fullyQualifiedDomain(): void
-}

package/src/lib/common/types.ts

@@ -1,14 +0,0 @@
-import { ComponentResourceOptions } from '@pulumi/pulumi'
-
-export interface BaseProps {
-  debug?: boolean
-  domainName: string
-  extraContexts?: string[]
-  name: string
-  skipStageForARecords?: boolean
-  stage: string
-  stageContextPath?: string
-  subDomain?: string
-}
-
-export interface BaseOptions extends ComponentResourceOptions {}

package/src/lib/common/utils.ts

@@ -1,40 +0,0 @@
-/**
- */
-export enum LogLevel {
-  DEBUG = 'DEBUG',
-  INFO = 'INFO',
-  WARNING = 'WARNING',
-  TRACE = 'TRACE',
-  ERROR = 'ERROR',
-  CRITICAL = 'CRITICAL',
-}
-
-export enum Stage {
-  DEV = 'dev',
-  TEST = 'tst',
-  UAT = 'uat',
-  PROD = 'prd',
-}
-
-/**
- * @param stage - The stage to check
- * @param targetStage - The target stage to compare against
- */
-export const isStage = (stage: string, targetStage: Stage) => stage === targetStage
-
-/**
- * @param stage
- */
-export const isDevStage = (stage: string) => isStage(stage, Stage.DEV)
-/**
- * @param stage
- */
-export const isTestStage = (stage: string) => isStage(stage, Stage.TEST)
-/**
- * @param stage
- */
-export const isUatStage = (stage: string) => isStage(stage, Stage.UAT)
-/**
- * @param stage
- */
-export const isPrdStage = (stage: string) => isStage(stage, Stage.PROD)

package/src/lib/index.ts

@@ -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/tsconfig.prd.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declarationMap": false,
-    "sourceMap": false
-  },
-  "exclude": ["**/*.test.ts", "**/test/**"]
-}

package/vitest.config.ts

@@ -1,37 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    include: ['**/?(*.)+(spec|test).[t]s?(x)'],
-    coverage: {
-      provider: 'v8',
-      reporter: ['text', 'text-summary', 'json', 'html', 'lcov', 'clover'],
-      reportOnFailure: true,
-      thresholds: {
-        global: {
-          branches: 70,
-          functions: 90,
-          lines: 90,
-          statements: 80,
-        },
-      },
-      exclude: [
-        '**/*.d.ts',
-        '**/*.js',
-        '**/*.mjs',
-        '**/cdk.out/**',
-        '**/index.ts',
-        'vitest.config.ts',
-        '**/types.ts',
-        '**/.gen/**',
-        '**/theme/**',
-        '**/test/tools/**',
-        'coverage/**',
-        'dist/**',
-        'node_modules/**',
-      ],
-    },
-  },
-})