@gradientedge/cdk-utils 8.143.0 → 8.145.0

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

@@ -1,6 +1,6 @@
 import { TerraformStack } from 'cdktf';
 import { Construct } from 'constructs';
-import { CloudflareAccessManager, CloudflareApiShieldManager, CloudflareArgoManager, CloudflareFilterManager, CloudflareFirewallManager, CloudflarePageManager, CloudflareWorkerManager, CloudflareZoneManager } from '../services';
+import { CloudflareAccessManager, CloudflareApiShieldManager, CloudflareArgoManager, CloudflareFilterManager, CloudflareFirewallManager, CloudflarePageManager, CloudflareRecordManager, CloudflareWorkerManager, CloudflareZoneManager } from '../services';
 import { CommonCloudflareStackProps } from './types';
 export declare class CommonCloudflareConstruct extends TerraformStack {
     props: CommonCloudflareStackProps;
@@ -12,6 +12,7 @@ export declare class CommonCloudflareConstruct extends TerraformStack {
     filterManager: CloudflareFilterManager;
     firewallManager: CloudflareFirewallManager;
     pageManager: CloudflarePageManager;
+    recordManager: CloudflareRecordManager;
     workerManager: CloudflareWorkerManager;
     zoneManager: CloudflareZoneManager;
     constructor(scope: Construct, id: string, props: CommonCloudflareStackProps);
@@ -19,6 +20,11 @@ export declare class CommonCloudflareConstruct extends TerraformStack {
      * @summary Determine the fully qualified domain name based on domainName & subDomain
      */
     protected determineFullyQualifiedDomain(): void;
+    /**
+     * @summary Determine the account id based on the cdktf.json context
+     */
+    protected determineAccountId(): void;
+    protected determineApiToken(): 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

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

@@ -14,6 +14,7 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
     filterManager;
     firewallManager;
     pageManager;
+    recordManager;
     workerManager;
     zoneManager;
     constructor(scope, id, props) {
@@ -26,9 +27,12 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
         this.filterManager = new services_1.CloudflareFilterManager();
         this.firewallManager = new services_1.CloudflareFirewallManager();
         this.pageManager = new services_1.CloudflarePageManager();
+        this.recordManager = new services_1.CloudflareRecordManager();
         this.workerManager = new services_1.CloudflareWorkerManager();
         this.zoneManager = new services_1.CloudflareZoneManager();
         this.determineFullyQualifiedDomain();
+        this.determineAccountId();
+        this.determineApiToken();
         new provider_1.CloudflareProvider(this, `${this.id}-provider`, this.props);
     }
     /**
@@ -39,6 +43,15 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
             ? `${this.props.subDomain}.${this.props.domainName}`
             : this.props.domainName;
     }
+    /**
+     * @summary Determine the account id based on the cdktf.json context
+     */
+    determineAccountId() {
+        this.props.accountId = new cdktf_1.TerraformVariable(this, `accountId`, {}).stringValue;
+    }
+    determineApiToken() {
+        this.props.apiToken = new cdktf_1.TerraformVariable(this, `apiToken`, {}).stringValue;
+    }
     /**
      * @summary Utility method to determine if the initialisation is in development (dev) stage
      * This is determined by the stage property injected via cdk context

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

@@ -25,6 +25,7 @@ export declare class CommonCloudflareStack extends TerraformStack {
      */
     protected determineConstructProps(props: CommonCloudflareStackProps): {
         accountId: any;
+        apiToken: any;
         domainName: any;
         extraContexts: any;
         features: any;

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

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonCloudflareStack = void 0;
 const fs_1 = __importDefault(require("fs"));
-const construct_1 = require("./construct");
 const app_root_path_1 = __importDefault(require("app-root-path"));
 const cdktf_1 = require("cdktf");
 const lodash_1 = __importDefault(require("lodash"));
@@ -32,8 +31,6 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
         /* determine extra cdk stage contexts */
         this.determineStageContexts();
         this.props = this.determineConstructProps(props);
-        /* initialise the construct */
-        this.construct = new construct_1.CommonCloudflareConstruct(this, 'cdk-utils', this.props);
     }
     /**
      * @summary Method to determine the core CDK construct properties injected via context cdktf.json
@@ -43,6 +40,7 @@ class CommonCloudflareStack extends cdktf_1.TerraformStack {
     determineConstructProps(props) {
         return {
             accountId: this.node.tryGetContext('accountId'),
+            apiToken: this.node.tryGetContext('apiToken'),
             domainName: this.node.tryGetContext('domainName'),
             extraContexts: this.node.tryGetContext('extraContexts'),
             features: this.node.tryGetContext('features'),

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

@@ -4,4 +4,6 @@ import { BaseProps } from '../../common';
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
     accountId: string;
+    apiToken: string;
+    useExistingZone?: boolean;
 }

package/dist/src/lib/cloudflare/construct/index.d.ts

@@ -0,0 +1 @@
+export * from './pages-static-site';

package/dist/src/lib/cloudflare/construct/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pages-static-site"), exports);

package/dist/src/lib/cloudflare/construct/pages-static-site/index.d.ts

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

package/dist/src/lib/cloudflare/construct/pages-static-site/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+__exportStar(require("./types"), exports);

package/dist/src/lib/cloudflare/construct/pages-static-site/main.d.ts

@@ -0,0 +1,55 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone';
+import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain';
+import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project';
+import { Record } from '@cdktf/provider-cloudflare/lib/record';
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone';
+import { Construct } from 'constructs';
+import { CommonCloudflareConstruct } from '../../common';
+import { CloudflarePagesStaticSiteProps } from './types';
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export declare class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
+    props: CloudflarePagesStaticSiteProps;
+    sitePagesCnameRecord: Record;
+    sitePagesDomain: PagesDomain;
+    sitePagesProject: PagesProject;
+    siteZone: DataCloudflareZone | Zone;
+    constructor(parent: Construct, id: string, props: CloudflarePagesStaticSiteProps);
+    /**
+     * @summary Initialise and provision resources
+     */
+    protected initResources(): void;
+    /**
+     * @summary Resolve the zone to use for the static site
+     */
+    protected resolveZone(): void;
+    /**
+     * @summary Create the pages project
+     */
+    protected createProject(): void;
+    /**
+     * @summary Create the pages domain
+     */
+    protected createDomain(): void;
+    /**
+     * @summary Create the pages cname record
+     */
+    protected createRecord(): void;
+    /**
+     * @summary Deploy the pages project
+     */
+    protected deploySite(): void;
+}

package/dist/src/lib/cloudflare/construct/pages-static-site/main.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflarePagesStaticSite = void 0;
+const common_1 = require("../../common");
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+class CloudflarePagesStaticSite extends common_1.CommonCloudflareConstruct {
+    /* static site resources */
+    sitePagesCnameRecord;
+    sitePagesDomain;
+    sitePagesProject;
+    siteZone;
+    constructor(parent, id, props) {
+        super(parent, id, props);
+        this.props = props;
+        this.id = id;
+    }
+    /**
+     * @summary Initialise and provision resources
+     */
+    initResources() {
+        this.resolveZone();
+        this.createProject();
+        this.createDomain();
+        this.createRecord();
+        this.deploySite();
+    }
+    /**
+     * @summary Resolve the zone to use for the static site
+     */
+    resolveZone() {
+        if (this.props.useExistingZone) {
+            this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this);
+        }
+        else {
+            this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone);
+        }
+    }
+    /**
+     * @summary Create the pages project
+     */
+    createProject() {
+        this.sitePagesProject = this.pageManager.createPagesProject(`${this.id}-site-project`, this, this.props.sitePagesProject);
+    }
+    /**
+     * @summary Create the pages domain
+     */
+    createDomain() {
+        this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
+            accountId: this.props.accountId,
+            domain: `${this.props.siteSubDomain}.${this.props.domainName}`,
+            projectName: this.sitePagesProject.name,
+        });
+    }
+    /**
+     * @summary Create the pages cname record
+     */
+    createRecord() {
+        this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
+            ...this.props.siteCnameRecord,
+            name: this.props.siteSubDomain,
+            value: `${this.sitePagesProject.name}.pages.dev`,
+        });
+    }
+    /**
+     * @summary Deploy the pages project
+     */
+    deploySite() {
+        this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
+            branch: this.props.siteBranch ?? 'main',
+            directory: this.props.siteAssetDir,
+            message: this.props.siteDeployMessage,
+            projectName: this.sitePagesProject.name,
+        });
+    }
+}
+exports.CloudflarePagesStaticSite = CloudflarePagesStaticSite;

package/dist/src/lib/cloudflare/construct/pages-static-site/types.d.ts

@@ -0,0 +1,11 @@
+import { CommonCloudflareStackProps } from '../../common';
+import { PagesProjectProps, RecordProps, ZoneProps } from '../../services';
+export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
+    siteAssetDir: string;
+    siteBranch?: string;
+    siteCnameRecord: RecordProps;
+    siteDeployMessage: string;
+    sitePagesProject: PagesProjectProps;
+    siteSubDomain: string;
+    siteZone: ZoneProps;
+}

package/dist/src/lib/cloudflare/construct/pages-static-site/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/lib/cloudflare/index.d.ts

@@ -1,4 +1,5 @@
 export * from './common';
+export * from './construct';
 export * from './services';
 export * from './types';
 export * from './utils';

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
+__exportStar(require("./construct"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);

package/dist/src/lib/cloudflare/services/index.d.ts

@@ -4,5 +4,6 @@ export * from './argo';
 export * from './filter';
 export * from './firewall';
 export * from './page';
+export * from './record';
 export * from './worker';
 export * from './zone';

package/dist/src/lib/cloudflare/services/index.js

@@ -20,5 +20,6 @@ __exportStar(require("./argo"), exports);
 __exportStar(require("./filter"), exports);
 __exportStar(require("./firewall"), exports);
 __exportStar(require("./page"), exports);
+__exportStar(require("./record"), exports);
 __exportStar(require("./worker"), exports);
 __exportStar(require("./zone"), exports);

package/dist/src/lib/cloudflare/services/page/main.d.ts

@@ -1,8 +1,9 @@
+import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule';
 import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain';
 import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project';
+import { LocalExec } from 'cdktf-local-exec';
 import { CommonCloudflareConstruct } from '../../common';
-import { PageRuleProps, PagesDomainProps, PagesProjectProps } from './types';
-import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule';
+import { PageRuleProps, PagesDomainProps, PagesProjectDeployProps, PagesProjectProps } from './types';
 /**
  * @classdesc Provides operations on Cloudflare Pages
  * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
@@ -45,4 +46,5 @@ export declare class CloudflarePageManager {
      * @see [CDKTF Page Rule Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/pageRule.typescript.md}
      */
     createPageRule(id: string, scope: CommonCloudflareConstruct, props: PageRuleProps): PageRule;
+    deployPagesProject(id: string, scope: CommonCloudflareConstruct, props: PagesProjectDeployProps): LocalExec;
 }

package/dist/src/lib/cloudflare/services/page/main.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CloudflarePageManager = void 0;
+const page_rule_1 = require("@cdktf/provider-cloudflare/lib/page-rule");
 const pages_domain_1 = require("@cdktf/provider-cloudflare/lib/pages-domain");
 const pages_project_1 = require("@cdktf/provider-cloudflare/lib/pages-project");
+const cdktf_local_exec_1 = require("cdktf-local-exec");
 const utils_1 = require("../../utils");
-const page_rule_1 = require("@cdktf/provider-cloudflare/lib/page-rule");
 /**
  * @classdesc Provides operations on Cloudflare Pages
  * - A new instance of this class is injected into {@link CommonCloudflareConstruct} constructor.
@@ -82,5 +83,17 @@ class CloudflarePageManager {
         (0, utils_1.createCloudflareTfOutput)(`${id}-pageRuleId`, scope, pageRule.id);
         return pageRule;
     }
+    deployPagesProject(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const localExecProvider = new cdktf_local_exec_1.Provider(scope, `${id}`);
+        const branch = scope.isProductionStage() ? 'main' : props.branch;
+        const message = process.env.BUILD_NUMBER ?? props.message;
+        const deployment = new cdktf_local_exec_1.LocalExec(scope, `${id}-deploy-${new Date().toISOString()}`, {
+            command: `CLOUDFLARE_ACCOUNT_ID=${scope.props.accountId} CLOUDFLARE_API_TOKEN=${scope.props.apiToken} npx wrangler pages deploy ${props.directory} --project-name=${props.projectName} --branch=${props.branch} --commit-message=${message}`,
+            cwd: '',
+        });
+        return deployment;
+    }
 }
 exports.CloudflarePageManager = CloudflarePageManager;

package/dist/src/lib/cloudflare/services/page/types.d.ts

@@ -7,3 +7,9 @@ export interface PagesDomainProps extends PagesDomainConfig {
 }
 export interface PageRuleProps extends PageRuleConfig {
 }
+export interface PagesProjectDeployProps {
+    branch: string;
+    directory: string;
+    message: string;
+    projectName: string;
+}

package/dist/src/lib/cloudflare/services/record/index.d.ts

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

package/dist/src/lib/cloudflare/services/record/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+__exportStar(require("./types"), exports);

package/dist/src/lib/cloudflare/services/record/main.d.ts

@@ -0,0 +1,30 @@
+import { Record } from '@cdktf/provider-cloudflare/lib/record';
+import { CommonCloudflareConstruct } from '../../common';
+import { RecordProps } from './types';
+/**
+ * @classdesc Provides operations on Cloudflare Records
+ * - 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, CommonCloudflareConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonCloudflareConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonCloudflareStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.recordManager.createRecord('MyRecord', this, props)
+ *   }
+ * }
+ * ```
+ */
+export declare class CloudflareRecordManager {
+    /**
+     * @summary Method to create a new Cloudflare Record
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props record properties
+     * @see [CDKTF Record Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/record.typescript.md}
+     */
+    createRecord(id: string, scope: CommonCloudflareConstruct, props: RecordProps): Record;
+}

package/dist/src/lib/cloudflare/services/record/main.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareRecordManager = void 0;
+const record_1 = require("@cdktf/provider-cloudflare/lib/record");
+const utils_1 = require("../../utils");
+/**
+ * @classdesc Provides operations on Cloudflare Records
+ * - 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, CommonCloudflareConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonCloudflareConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonCloudflareStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.recordManager.createRecord('MyRecord', this, props)
+ *   }
+ * }
+ * ```
+ */
+class CloudflareRecordManager {
+    /**
+     * @summary Method to create a new Cloudflare Record
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props record properties
+     * @see [CDKTF Record Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/record.typescript.md}
+     */
+    createRecord(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const zoneId = props.zoneId
+            ? props.zoneId
+            : scope.zoneManager.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id;
+        const record = new record_1.Record(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-recordFriendlyUniqueId`, scope, record.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-recordId`, scope, record.id);
+        return record;
+    }
+}
+exports.CloudflareRecordManager = CloudflareRecordManager;

package/dist/src/lib/cloudflare/services/record/types.d.ts

@@ -0,0 +1,3 @@
+import { RecordConfig } from '@cdktf/provider-cloudflare/lib/record';
+export interface RecordProps extends RecordConfig {
+}

package/dist/src/lib/cloudflare/services/record/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -34,7 +34,7 @@ export declare class CloudflareZoneManager {
      * @see [CDKTF Zone Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/zone.typescript.md}
      */
     createZone(id: string, scope: CommonCloudflareConstruct, props: ZoneProps): Zone;
-    resolveZone(id: string, scope: CommonCloudflareConstruct, options: ZoneOptions): DataCloudflareZone;
+    resolveZone(id: string, scope: CommonCloudflareConstruct, options?: ZoneOptions): DataCloudflareZone;
     /**
      * @summary Method to create a new zone cache reserve
      * @param id scoped id of the resource

package/dist/src/lib/cloudflare/services/zone/main.js

@@ -49,12 +49,10 @@ class CloudflareZoneManager {
         return zone;
     }
     resolveZone(id, scope, options) {
-        if (!options)
-            throw `Options undefined for ${id}`;
         const zone = new data_cloudflare_zone_1.DataCloudflareZone(scope, `${id}-data-zone`, {
             accountId: scope.props.accountId,
-            name: options.name ?? scope.props.domainName,
-            zoneId: options.id,
+            name: options?.name ?? scope.props.domainName,
+            zoneId: options?.id,
         });
         return zone;
     }

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

@@ -2,7 +2,7 @@ export interface BaseProps {
     domainName: string;
     extraContexts?: string[];
     name: string;
-    skipStageForARecords: boolean;
+    skipStageForARecords?: boolean;
     stage: string;
     stageContextPath?: string;
     subDomain?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "8.143.0",
+  "version": "8.145.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -47,17 +47,18 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.454.0",
-    "@aws-sdk/credential-providers": "^3.454.0",
+    "@aws-sdk/client-secrets-manager": "^3.458.0",
+    "@aws-sdk/credential-providers": "^3.458.0",
     "@aws-sdk/types": "^3.451.0",
-    "@cdktf/provider-azurerm": "^11.0.5",
+    "@cdktf/provider-azurerm": "^11.0.6",
     "@cdktf/provider-cloudflare": "^10.0.3",
-    "@types/lodash": "^4.14.201",
-    "@types/node": "^20.9.2",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^20.10.0",
     "@types/uuid": "^9.0.7",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.110.0",
+    "aws-cdk-lib": "^2.110.1",
     "cdktf": "^0.19.1",
+    "cdktf-local-exec": "^0.4.8",
     "constructs": "^10.3.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
@@ -70,10 +71,10 @@
     "@babel/core": "^7.23.3",
     "@babel/eslint-parser": "^7.23.3",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@types/jest": "^29.5.8",
-    "@typescript-eslint/eslint-plugin": "^6.11.0",
-    "@typescript-eslint/parser": "^6.11.0",
-    "aws-cdk": "^2.110.0",
+    "@types/jest": "^29.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "aws-cdk": "^2.110.1",
     "better-docs": "^2.7.2",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
@@ -99,7 +100,7 @@
     "taffydb": "^2.7.3",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "5.2.2"
+    "typescript": "5.3.2"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

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

@@ -1,5 +1,5 @@
 import { CloudflareProvider } from '@cdktf/provider-cloudflare/lib/provider'
-import { TerraformStack } from 'cdktf'
+import { TerraformStack, TerraformVariable } from 'cdktf'
 import { Construct } from 'constructs'
 import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
 import {
@@ -9,6 +9,7 @@ import {
   CloudflareFilterManager,
   CloudflareFirewallManager,
   CloudflarePageManager,
+  CloudflareRecordManager,
   CloudflareWorkerManager,
   CloudflareZoneManager,
 } from '../services'
@@ -24,6 +25,7 @@ export class CommonCloudflareConstruct extends TerraformStack {
   filterManager: CloudflareFilterManager
   firewallManager: CloudflareFirewallManager
   pageManager: CloudflarePageManager
+  recordManager: CloudflareRecordManager
   workerManager: CloudflareWorkerManager
   zoneManager: CloudflareZoneManager
 
@@ -38,10 +40,13 @@ export class CommonCloudflareConstruct extends TerraformStack {
     this.filterManager = new CloudflareFilterManager()
     this.firewallManager = new CloudflareFirewallManager()
     this.pageManager = new CloudflarePageManager()
+    this.recordManager = new CloudflareRecordManager()
     this.workerManager = new CloudflareWorkerManager()
     this.zoneManager = new CloudflareZoneManager()
 
     this.determineFullyQualifiedDomain()
+    this.determineAccountId()
+    this.determineApiToken()
     new CloudflareProvider(this, `${this.id}-provider`, this.props)
   }
 
@@ -54,6 +59,17 @@ export class CommonCloudflareConstruct extends TerraformStack {
       : this.props.domainName
   }
 
+  /**
+   * @summary Determine the account id based on the cdktf.json context
+   */
+  protected determineAccountId(): void {
+    this.props.accountId = new TerraformVariable(this, `accountId`, {}).stringValue
+  }
+
+  protected determineApiToken(): void {
+    this.props.apiToken = new TerraformVariable(this, `apiToken`, {}).stringValue
+  }
+
   /**
    * @summary Utility method to determine if the initialisation is in development (dev) stage
    * This is determined by the stage property injected via cdk context

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

@@ -34,9 +34,6 @@ export class CommonCloudflareStack extends TerraformStack {
     this.determineStageContexts()
 
     this.props = this.determineConstructProps(props)
-
-    /* initialise the construct */
-    this.construct = new CommonCloudflareConstruct(this, 'cdk-utils', this.props)
   }
 
   /**
@@ -47,6 +44,7 @@ export class CommonCloudflareStack extends TerraformStack {
   protected determineConstructProps(props: CommonCloudflareStackProps) {
     return {
       accountId: this.node.tryGetContext('accountId'),
+      apiToken: this.node.tryGetContext('apiToken'),
       domainName: this.node.tryGetContext('domainName'),
       extraContexts: this.node.tryGetContext('extraContexts'),
       features: this.node.tryGetContext('features'),

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

@@ -5,4 +5,6 @@ import { BaseProps } from '../../common'
  */
 export interface CommonCloudflareStackProps extends BaseProps, CloudflareProviderConfig {
   accountId: string
+  apiToken: string
+  useExistingZone?: boolean
 }

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

@@ -0,0 +1 @@
+export * from './pages-static-site'

package/src/lib/cloudflare/construct/pages-static-site/index.ts

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

package/src/lib/cloudflare/construct/pages-static-site/main.ts

@@ -0,0 +1,106 @@
+import { DataCloudflareZone } from '@cdktf/provider-cloudflare/lib/data-cloudflare-zone'
+import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain'
+import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project'
+import { Record } from '@cdktf/provider-cloudflare/lib/record'
+import { Zone } from '@cdktf/provider-cloudflare/lib/zone'
+import { Construct } from 'constructs'
+import { CommonCloudflareConstruct } from '../../common'
+import { CloudflarePagesStaticSiteProps } from './types'
+
+/**
+ * @classdesc Provides a construct to create and deploy a cloudflare pages static site
+ * @example
+ * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends CloudflarePagesStaticSite {
+ *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ */
+export class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
+  declare props: CloudflarePagesStaticSiteProps
+
+  /* static site resources */
+  sitePagesCnameRecord: Record
+  sitePagesDomain: PagesDomain
+  sitePagesProject: PagesProject
+  siteZone: DataCloudflareZone | Zone
+
+  constructor(parent: Construct, id: string, props: CloudflarePagesStaticSiteProps) {
+    super(parent, id, props)
+    this.props = props
+    this.id = id
+  }
+
+  /**
+   * @summary Initialise and provision resources
+   */
+  protected initResources() {
+    this.resolveZone()
+    this.createProject()
+    this.createDomain()
+    this.createRecord()
+    this.deploySite()
+  }
+
+  /**
+   * @summary Resolve the zone to use for the static site
+   */
+  protected resolveZone() {
+    if (this.props.useExistingZone) {
+      this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this)
+    } else {
+      this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone)
+    }
+  }
+
+  /**
+   * @summary Create the pages project
+   */
+  protected createProject() {
+    this.sitePagesProject = this.pageManager.createPagesProject(
+      `${this.id}-site-project`,
+      this,
+      this.props.sitePagesProject
+    )
+  }
+
+  /**
+   * @summary Create the pages domain
+   */
+  protected createDomain() {
+    this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
+      accountId: this.props.accountId,
+      domain: `${this.props.siteSubDomain}.${this.props.domainName}`,
+      projectName: this.sitePagesProject.name,
+    })
+  }
+
+  /**
+   * @summary Create the pages cname record
+   */
+  protected createRecord() {
+    this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
+      ...this.props.siteCnameRecord,
+      name: this.props.siteSubDomain,
+      value: `${this.sitePagesProject.name}.pages.dev`,
+    })
+  }
+
+  /**
+   * @summary Deploy the pages project
+   */
+  protected deploySite() {
+    this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
+      branch: this.props.siteBranch ?? 'main',
+      directory: this.props.siteAssetDir,
+      message: this.props.siteDeployMessage,
+      projectName: this.sitePagesProject.name,
+    })
+  }
+}

package/src/lib/cloudflare/construct/pages-static-site/types.ts

@@ -0,0 +1,12 @@
+import { CommonCloudflareStackProps } from '../../common'
+import { PagesProjectProps, RecordProps, ZoneProps } from '../../services'
+
+export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
+  siteAssetDir: string
+  siteBranch?: string
+  siteCnameRecord: RecordProps
+  siteDeployMessage: string
+  sitePagesProject: PagesProjectProps
+  siteSubDomain: string
+  siteZone: ZoneProps
+}

package/src/lib/cloudflare/index.ts

@@ -1,4 +1,5 @@
 export * from './common'
+export * from './construct'
 export * from './services'
 export * from './types'
 export * from './utils'

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

@@ -4,5 +4,6 @@ export * from './argo'
 export * from './filter'
 export * from './firewall'
 export * from './page'
+export * from './record'
 export * from './worker'
 export * from './zone'

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

@@ -1,9 +1,10 @@
+import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule'
 import { PagesDomain } from '@cdktf/provider-cloudflare/lib/pages-domain'
 import { PagesProject } from '@cdktf/provider-cloudflare/lib/pages-project'
+import { LocalExec, Provider } from 'cdktf-local-exec'
 import { CommonCloudflareConstruct } from '../../common'
 import { createCloudflareTfOutput } from '../../utils'
-import { PageRuleProps, PagesDomainProps, PagesProjectProps } from './types'
-import { PageRule } from '@cdktf/provider-cloudflare/lib/page-rule'
+import { PageRuleProps, PagesDomainProps, PagesProjectDeployProps, PagesProjectProps } from './types'
 
 /**
  * @classdesc Provides operations on Cloudflare Pages
@@ -91,4 +92,18 @@ export class CloudflarePageManager {
 
     return pageRule
   }
+
+  public deployPagesProject(id: string, scope: CommonCloudflareConstruct, props: PagesProjectDeployProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const localExecProvider = new Provider(scope, `${id}`)
+    const branch = scope.isProductionStage() ? 'main' : props.branch
+    const message = process.env.BUILD_NUMBER ?? props.message
+    const deployment = new LocalExec(scope, `${id}-deploy-${new Date().toISOString()}`, {
+      command: `CLOUDFLARE_ACCOUNT_ID=${scope.props.accountId} CLOUDFLARE_API_TOKEN=${scope.props.apiToken} npx wrangler pages deploy ${props.directory} --project-name=${props.projectName} --branch=${props.branch} --commit-message=${message}`,
+      cwd: '',
+    })
+
+    return deployment
+  }
 }

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

@@ -5,3 +5,9 @@ import { PagesProjectConfig } from '@cdktf/provider-cloudflare/lib/pages-project
 export interface PagesProjectProps extends PagesProjectConfig {}
 export interface PagesDomainProps extends PagesDomainConfig {}
 export interface PageRuleProps extends PageRuleConfig {}
+export interface PagesProjectDeployProps {
+  branch: string
+  directory: string
+  message: string
+  projectName: string
+}

package/src/lib/cloudflare/services/record/index.ts

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

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

@@ -0,0 +1,48 @@
+import { Record } from '@cdktf/provider-cloudflare/lib/record'
+import { CommonCloudflareConstruct } from '../../common'
+import { createCloudflareTfOutput } from '../../utils'
+import { RecordProps } from './types'
+
+/**
+ * @classdesc Provides operations on Cloudflare Records
+ * - 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, CommonCloudflareConstruct } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonCloudflareConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonCloudflareStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.recordManager.createRecord('MyRecord', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class CloudflareRecordManager {
+  /**
+   * @summary Method to create a new Cloudflare Record
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props record properties
+   * @see [CDKTF Record Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/record.typescript.md}
+   */
+  public createRecord(id: string, scope: CommonCloudflareConstruct, props: RecordProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const zoneId = props.zoneId
+      ? props.zoneId
+      : scope.zoneManager.resolveZone(`${id}-data-zone`, scope, { name: scope.props.domainName })?.id
+
+    const record = new Record(scope, `${id}`, {
+      ...props,
+      zoneId,
+    })
+
+    createCloudflareTfOutput(`${id}-recordFriendlyUniqueId`, scope, record.friendlyUniqueId)
+    createCloudflareTfOutput(`${id}-recordId`, scope, record.id)
+
+    return record
+  }
+}

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

@@ -0,0 +1,3 @@
+import { RecordConfig } from '@cdktf/provider-cloudflare/lib/record'
+
+export interface RecordProps extends RecordConfig {}

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

@@ -60,13 +60,11 @@ export class CloudflareZoneManager {
     return zone
   }
 
-  public resolveZone(id: string, scope: CommonCloudflareConstruct, options: ZoneOptions) {
-    if (!options) throw `Options undefined for ${id}`
-
+  public resolveZone(id: string, scope: CommonCloudflareConstruct, options?: ZoneOptions) {
     const zone = new DataCloudflareZone(scope, `${id}-data-zone`, {
       accountId: scope.props.accountId,
-      name: options.name ?? scope.props.domainName,
-      zoneId: options.id,
+      name: options?.name ?? scope.props.domainName,
+      zoneId: options?.id,
     })
 
     return zone

package/src/lib/common/types.ts

@@ -2,7 +2,7 @@ export interface BaseProps {
   domainName: string
   extraContexts?: string[]
   name: string
-  skipStageForARecords: boolean
+  skipStageForARecords?: boolean
   stage: string
   stageContextPath?: string
   subDomain?: string