@gradientedge/cdk-utils 9.2.0 → 9.4.0

package/app/api-destined-function/node_modules/.bin/uuid

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@9.0.1/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/bin/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/dist/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules/uuid/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/uuid@10.0.0/node_modules:/home/runner/work/cdk-utils/cdk-utils/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../uuid/dist/bin/uuid" "$@"

package/app/api-destined-function/package.json

@@ -16,11 +16,11 @@
     "test": "npx jest --ci --runInBand --passWithNoTests"
   },
   "dependencies": {
-    "@types/uuid": "^9.0.8",
-    "uuid": "^9.0.1"
+    "@types/uuid": "^10.0.0",
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "mkdirp": "^3.0.1",
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.7"
   }
 }

package/dist/src/lib/aws/utils/index.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.redirectSuccess = exports.redirectError = exports.determineCredentials = exports.createCfnOutput = void 0;
+exports.createCfnOutput = createCfnOutput;
+exports.determineCredentials = determineCredentials;
+exports.redirectError = redirectError;
+exports.redirectSuccess = redirectSuccess;
 const credential_providers_1 = require("@aws-sdk/credential-providers");
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const lodash_1 = __importDefault(require("lodash"));
@@ -28,7 +31,6 @@ function createCfnOutput(id, scope, value, description, overrideId = true) {
     }
     return output;
 }
-exports.createCfnOutput = createCfnOutput;
 /**
  *
  */
@@ -37,7 +39,6 @@ function determineCredentials() {
         return (0, credential_providers_1.fromIni)();
     return (0, credential_providers_1.fromEnv)();
 }
-exports.determineCredentials = determineCredentials;
 /**
  */
 const defaultResponseObject = {
@@ -58,7 +59,6 @@ function redirectError(error) {
         statusCode: 500,
     });
 }
-exports.redirectError = redirectError;
 /**
  * @param message
  */
@@ -68,4 +68,3 @@ function redirectSuccess(message) {
         statusCode: 200,
     });
 }
-exports.redirectSuccess = redirectSuccess;

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

@@ -1,7 +1,7 @@
 import { AwsProvider } from '@cdktf/provider-aws/lib/provider';
 import { S3Backend, TerraformStack } from 'cdktf';
 import { Construct } from 'constructs';
-import { CloudflareAccessManager, CloudflareApiShieldManager, CloudflareArgoManager, CloudflareFilterManager, CloudflareFirewallManager, CloudflarePageManager, CloudflareRecordManager, CloudflareWorkerManager, CloudflareZoneManager } from '../services';
+import { CloudflareAccessManager, CloudflareApiShieldManager, CloudflareArgoManager, CloudflareFilterManager, CloudflareFirewallManager, CloudflarePageManager, CloudflareRecordManager, CloudflareRuleSetManager, CloudflareWorkerManager, CloudflareZoneManager } from '../services';
 import { CommonCloudflareStackProps } from './types';
 export declare class CommonCloudflareConstruct extends TerraformStack {
     props: CommonCloudflareStackProps;
@@ -14,6 +14,7 @@ export declare class CommonCloudflareConstruct extends TerraformStack {
     firewallManager: CloudflareFirewallManager;
     pageManager: CloudflarePageManager;
     recordManager: CloudflareRecordManager;
+    ruleSetManager: CloudflareRuleSetManager;
     workerManager: CloudflareWorkerManager;
     zoneManager: CloudflareZoneManager;
     awsProvider: AwsProvider;

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

@@ -17,6 +17,7 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
     firewallManager;
     pageManager;
     recordManager;
+    ruleSetManager;
     workerManager;
     zoneManager;
     awsProvider;
@@ -32,6 +33,7 @@ class CommonCloudflareConstruct extends cdktf_1.TerraformStack {
         this.firewallManager = new services_1.CloudflareFirewallManager();
         this.pageManager = new services_1.CloudflarePageManager();
         this.recordManager = new services_1.CloudflareRecordManager();
+        this.ruleSetManager = new services_1.CloudflareRuleSetManager();
         this.workerManager = new services_1.CloudflareWorkerManager();
         this.zoneManager = new services_1.CloudflareZoneManager();
         this.determineFullyQualifiedDomain();

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

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

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

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

package/dist/src/lib/cloudflare/services/rule-set/index.d.ts

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

package/dist/src/lib/cloudflare/services/rule-set/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/rule-set/main.d.ts

@@ -0,0 +1,30 @@
+import { CommonCloudflareConstruct } from '../../common';
+import { RulesetProps } from './types';
+import { Ruleset } from '@cdktf/provider-cloudflare/lib/ruleset';
+/**
+ * @classdesc Provides operations on Cloudflare Rule Sets
+ * - 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.ruleSetManager.createRuleSet('MyRule', this, props)
+ *   }
+ * }
+ * ```
+ */
+export declare class CloudflareRuleSetManager {
+    /**
+     * @summary Method to create a new Cloudflare Rule Set
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props rule set properties
+     * @see [CDKTF Ruleset Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/ruleset.typescript.md}
+     */
+    createRuleSet(id: string, scope: CommonCloudflareConstruct, props: RulesetProps): Ruleset;
+}

package/dist/src/lib/cloudflare/services/rule-set/main.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareRuleSetManager = void 0;
+const utils_1 = require("../../utils");
+const ruleset_1 = require("@cdktf/provider-cloudflare/lib/ruleset");
+/**
+ * @classdesc Provides operations on Cloudflare Rule Sets
+ * - 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.ruleSetManager.createRuleSet('MyRule', this, props)
+ *   }
+ * }
+ * ```
+ */
+class CloudflareRuleSetManager {
+    /**
+     * @summary Method to create a new Cloudflare Rule Set
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props rule set properties
+     * @see [CDKTF Ruleset Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/ruleset.typescript.md}
+     */
+    createRuleSet(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 ruleSet = new ruleset_1.Ruleset(scope, `${id}`, {
+            ...props,
+            zoneId,
+        });
+        (0, utils_1.createCloudflareTfOutput)(`${id}-ruleSetFriendlyUniqueId`, scope, ruleSet.friendlyUniqueId);
+        (0, utils_1.createCloudflareTfOutput)(`${id}-ruleSetId`, scope, ruleSet.id);
+        return ruleSet;
+    }
+}
+exports.CloudflareRuleSetManager = CloudflareRuleSetManager;

package/dist/src/lib/cloudflare/services/rule-set/types.d.ts

@@ -0,0 +1,3 @@
+import { RulesetConfig } from '@cdktf/provider-cloudflare/lib/ruleset';
+export interface RulesetProps extends RulesetConfig {
+}

package/dist/src/lib/cloudflare/services/rule-set/types.js

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

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

@@ -11,16 +11,16 @@ export declare enum LogLevel {
 /**
  * @param stage
  */
-export declare const isDevStage: (stage: string) => boolean;
+export declare const isDevStage: (stage: string) => stage is "dev";
 /**
  * @param stage
  */
-export declare const isTestStage: (stage: string) => boolean;
+export declare const isTestStage: (stage: string) => stage is "tst";
 /**
  * @param stage
  */
-export declare const isUatStage: (stage: string) => boolean;
+export declare const isUatStage: (stage: string) => stage is "uat";
 /**
  * @param stage
  */
-export declare const isPrdStage: (stage: string) => boolean;
+export declare const isPrdStage: (stage: string) => stage is "prd";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.2.0",
+  "version": "9.4.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {
@@ -50,62 +50,62 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/client-secrets-manager": "^3.554.0",
-    "@aws-sdk/credential-providers": "^3.554.0",
-    "@aws-sdk/types": "^3.535.0",
-    "@cdktf/provider-aws": "^19.14.0",
-    "@cdktf/provider-azurerm": "^12.12.0",
-    "@cdktf/provider-cloudflare": "^11.7.0",
-    "@types/lodash": "^4.17.0",
-    "@types/node": "^20.12.7",
-    "@types/uuid": "^9.0.8",
+    "@aws-sdk/client-secrets-manager": "^3.600.0",
+    "@aws-sdk/credential-providers": "^3.600.0",
+    "@aws-sdk/types": "^3.598.0",
+    "@cdktf/provider-aws": "^19.23.0",
+    "@cdktf/provider-azurerm": "^12.21.0",
+    "@cdktf/provider-cloudflare": "^11.13.0",
+    "@types/lodash": "^4.17.5",
+    "@types/node": "^20.14.8",
+    "@types/uuid": "^10.0.0",
     "app-root-path": "^3.1.0",
-    "aws-cdk-lib": "^2.141.0",
+    "aws-cdk-lib": "^2.147.1",
     "cdktf": "^0.20.7",
-    "cdktf-local-exec": "^0.5.13",
+    "cdktf-local-exec": "^0.5.23",
     "constructs": "^10.3.0",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
     "nconf": "^0.12.1",
     "pluralize": "^8.0.0",
     "ts-node": "^10.9.2",
-    "uuid": "^9.0.1"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/eslint-parser": "^7.24.1",
+    "@babel/core": "^7.24.7",
+    "@babel/eslint-parser": "^7.24.7",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
-    "aws-cdk": "^2.137.0",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "aws-cdk": "^2.147.1",
     "better-docs": "^2.7.3",
     "codecov": "^3.8.3",
     "commitizen": "^4.3.0",
     "docdash": "^2.0.2",
     "dotenv": "^16.4.5",
-    "eslint": "^9.0.0",
+    "eslint": "^9.5.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-jsdoc": "^48.4.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "jest-junit": "^16.0.0",
-    "jsdoc": "^4.0.2",
+    "jsdoc": "^4.0.3",
     "jsdoc-babel": "^0.5.0",
     "jsdoc-mermaid": "^1.0.0",
     "jsdoc-plugin-typescript": "^2.2.1",
     "jsdoc-to-markdown": "^8.0.1",
-    "prettier": "^3.2.5",
+    "prettier": "^3.3.2",
     "prettier-plugin-organize-imports": "^3.2.4",
-    "rimraf": "^5.0.5",
-    "semantic-release": "^23.0.8",
+    "rimraf": "^5.0.7",
+    "semantic-release": "^24.0.0",
     "taffydb": "^2.7.3",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.1.5",
     "ts-node": "^10.9.2",
-    "typescript": "5.4.5",
-    "yaml": "^2.4.2"
+    "typescript": "5.5.2",
+    "yaml": "^2.4.5"
   },
   "optionalDependencies": {
     "prop-types": "^15.8.1",

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

@@ -11,6 +11,7 @@ import {
   CloudflareFirewallManager,
   CloudflarePageManager,
   CloudflareRecordManager,
+  CloudflareRuleSetManager,
   CloudflareWorkerManager,
   CloudflareZoneManager,
 } from '../services'
@@ -28,6 +29,7 @@ export class CommonCloudflareConstruct extends TerraformStack {
   firewallManager: CloudflareFirewallManager
   pageManager: CloudflarePageManager
   recordManager: CloudflareRecordManager
+  ruleSetManager: CloudflareRuleSetManager
   workerManager: CloudflareWorkerManager
   zoneManager: CloudflareZoneManager
   awsProvider: AwsProvider
@@ -45,6 +47,7 @@ export class CommonCloudflareConstruct extends TerraformStack {
     this.firewallManager = new CloudflareFirewallManager()
     this.pageManager = new CloudflarePageManager()
     this.recordManager = new CloudflareRecordManager()
+    this.ruleSetManager = new CloudflareRuleSetManager()
     this.workerManager = new CloudflareWorkerManager()
     this.zoneManager = new CloudflareZoneManager()
 

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

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

package/src/lib/cloudflare/services/rule-set/index.ts

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

package/src/lib/cloudflare/services/rule-set/main.ts

@@ -0,0 +1,49 @@
+import { Filter } from '@cdktf/provider-cloudflare/lib/filter'
+import { CommonCloudflareConstruct } from '../../common'
+import { createCloudflareTfOutput } from '../../utils'
+import { RulesetProps } from './types'
+import { Ruleset } from '@cdktf/provider-cloudflare/lib/ruleset'
+
+/**
+ * @classdesc Provides operations on Cloudflare Rule Sets
+ * - 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.ruleSetManager.createRuleSet('MyRule', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class CloudflareRuleSetManager {
+  /**
+   * @summary Method to create a new Cloudflare Rule Set
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props rule set properties
+   * @see [CDKTF Ruleset Module]{@link https://github.com/cdktf/cdktf-provider-cloudflare/blob/main/docs/ruleset.typescript.md}
+   */
+  public createRuleSet(id: string, scope: CommonCloudflareConstruct, props: RulesetProps) {
+    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 ruleSet = new Ruleset(scope, `${id}`, {
+      ...props,
+      zoneId,
+    })
+
+    createCloudflareTfOutput(`${id}-ruleSetFriendlyUniqueId`, scope, ruleSet.friendlyUniqueId)
+    createCloudflareTfOutput(`${id}-ruleSetId`, scope, ruleSet.id)
+
+    return ruleSet
+  }
+}

package/src/lib/cloudflare/services/rule-set/types.ts

@@ -0,0 +1,3 @@
+import { RulesetConfig } from '@cdktf/provider-cloudflare/lib/ruleset'
+
+export interface RulesetProps extends RulesetConfig {}