@ttoss/cloud-vpc 0.1.0

package/README.md

@@ -0,0 +1,34 @@
+# @ttoss/cloud-vpc
+
+This module provides a set of resources to create a VPC on AWS.
+
+## Installation
+
+```bash
+pnpm install @ttoss/cloud-vpc
+```
+
+## Usage
+
+```typescript
+import { createVpcTemplate } from '@ttoss/cloud-vpc';
+
+const cidrBlock = '10.0.0.0/16';
+
+const template = createVpcTemplate({
+  cidrBlock,
+});
+
+export default template;
+```
+
+## API
+
+### `createVpcTemplate`
+
+Creates a VPC template.
+
+#### Parameters
+
+- `cidrBlock: string` - The CIDR block of the VPC.
+- `createPublicSubnets: boolean` - Whether to create public subnets. Default is `true`.

package/dist/esm/index.js

@@ -0,0 +1,227 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+
+// src/index.ts
+var NUMBER_OF_AVAILABILITY_ZONES = 3;
+var PUBLIC_ROUTER_TABLE_LOGICAL_ID = "PublicRouteTable";
+var PRIVATE_ROUTER_TABLE_LOGICAL_ID = "PrivateRouteTable";
+var createVpcTemplate = ({
+  cidrBlock,
+  createPublicSubnets = true
+}) => {
+  const totalOfSubnetsOnEachType = 2;
+  const getSubnetResource = ({
+    number,
+    isPublic
+  }) => {
+    const subnetType = isPublic ? "Public" : "Private";
+    const key = `${subnetType}Subnet${number}`;
+    const routerTableAssociationKey = `${subnetType}Subnet${number}RouteTableAssociation`;
+    const index = (isPublic ? 0 : 1) * totalOfSubnetsOnEachType + number - 1;
+    const azIndex = index % NUMBER_OF_AVAILABILITY_ZONES;
+    const cidrSubBlockCount = 2 * totalOfSubnetsOnEachType;
+    const cidrPrefixLength = parseInt(cidrBlock.split("/")[1], 10);
+    const cidrSubBlockBits = 32 - cidrPrefixLength - Math.ceil(Math.log2(cidrSubBlockCount));
+    let resources = {
+      [key]: {
+        Type: "AWS::EC2::Subnet",
+        Properties: {
+          AvailabilityZone: {
+            "Fn::Select": [azIndex, {
+              "Fn::GetAZs": ""
+            }]
+          },
+          CidrBlock: {
+            "Fn::Select": [index, {
+              "Fn::Cidr": [cidrBlock, cidrSubBlockCount, cidrSubBlockBits]
+            }]
+          },
+          MapPublicIpOnLaunch: isPublic,
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": `\${Project}-${subnetType.toLowerCase()}-subnet-${number}-\${AWS::Region}`
+            }
+          }]
+        }
+      },
+      [routerTableAssociationKey]: {
+        Type: "AWS::EC2::SubnetRouteTableAssociation",
+        Properties: {
+          RouteTableId: {
+            Ref: isPublic ? PUBLIC_ROUTER_TABLE_LOGICAL_ID : PRIVATE_ROUTER_TABLE_LOGICAL_ID
+          },
+          SubnetId: {
+            Ref: key
+          }
+        }
+      }
+    };
+    if (isPublic) {
+      resources = {
+        ...resources
+      };
+    }
+    if (!isPublic) {
+      resources = {
+        ...resources
+      };
+    }
+    return resources;
+  };
+  const template = {
+    AWSTemplateFormatVersion: "2010-09-09",
+    Description: "VPC, Subnets, and Route Tables for the project.",
+    Parameters: {
+      Project: {
+        Type: "String",
+        Description: "The name of the project"
+      }
+    },
+    Resources: {
+      Vpc: {
+        Type: "AWS::EC2::VPC",
+        Properties: {
+          CidrBlock: cidrBlock,
+          EnableDnsHostnames: true,
+          EnableDnsSupport: true,
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-vpc"
+            }
+          }]
+        }
+      },
+      ...getSubnetResource({
+        number: 1,
+        isPublic: false
+      }),
+      ...getSubnetResource({
+        number: 2,
+        isPublic: false
+      }),
+      [PRIVATE_ROUTER_TABLE_LOGICAL_ID]: {
+        Type: "AWS::EC2::RouteTable",
+        Properties: {
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-private-rtb"
+            }
+          }]
+        }
+      }
+    },
+    Outputs: {
+      DefaultSecurityGroup: {
+        Description: "The default security group ID",
+        Value: {
+          "Fn::GetAtt": ["Vpc", "DefaultSecurityGroup"]
+        }
+      },
+      VpcId: {
+        Description: "The VPC ID",
+        Value: {
+          Ref: "Vpc"
+        }
+      },
+      PrivateSubnet1: {
+        Description: "The private subnet 1 ID",
+        Value: {
+          Ref: "PrivateSubnet1"
+        }
+      },
+      PrivateSubnet2: {
+        Description: "The private subnet 2 ID",
+        Value: {
+          Ref: "PrivateSubnet2"
+        }
+      }
+    }
+  };
+  if (createPublicSubnets) {
+    template.Resources = {
+      ...template.Resources,
+      ...getSubnetResource({
+        number: 1,
+        isPublic: true
+      }),
+      ...getSubnetResource({
+        number: 2,
+        isPublic: true
+      }),
+      InternetGateway: {
+        Type: "AWS::EC2::InternetGateway",
+        Properties: {
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-igw"
+            }
+          }]
+        }
+      },
+      [PUBLIC_ROUTER_TABLE_LOGICAL_ID]: {
+        Type: "AWS::EC2::RouteTable",
+        Properties: {
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-public-rtb"
+            }
+          }]
+        }
+      },
+      InternetGatewayAttachment: {
+        Type: "AWS::EC2::VPCGatewayAttachment",
+        Properties: {
+          InternetGatewayId: {
+            Ref: "InternetGateway"
+          },
+          VpcId: {
+            Ref: "Vpc"
+          }
+        }
+      },
+      PublicRoute: {
+        Type: "AWS::EC2::Route",
+        DependsOn: "InternetGatewayAttachment",
+        Properties: {
+          DestinationCidrBlock: "0.0.0.0/0",
+          GatewayId: {
+            Ref: "InternetGateway"
+          },
+          RouteTableId: {
+            Ref: PUBLIC_ROUTER_TABLE_LOGICAL_ID
+          }
+        }
+      }
+    };
+    template.Outputs = {
+      ...template.Outputs,
+      PublicSubnet1: {
+        Description: "The public subnet 1 ID",
+        Value: {
+          Ref: "PublicSubnet1"
+        }
+      },
+      PublicSubnet2: {
+        Description: "The public subnet 2 ID",
+        Value: {
+          Ref: "PublicSubnet2"
+        }
+      }
+    };
+  }
+  return template;
+};
+export { createVpcTemplate };

package/dist/index.d.mts

@@ -0,0 +1,8 @@
+import { CloudFormationTemplate } from '@ttoss/cloudformation';
+
+declare const createVpcTemplate: ({ cidrBlock, createPublicSubnets, }: {
+    cidrBlock: string;
+    createPublicSubnets?: boolean;
+}) => CloudFormationTemplate;
+
+export { createVpcTemplate };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { CloudFormationTemplate } from '@ttoss/cloudformation';
+
+declare const createVpcTemplate: ({ cidrBlock, createPublicSubnets, }: {
+    cidrBlock: string;
+    createPublicSubnets?: boolean;
+}) => CloudFormationTemplate;
+
+export { createVpcTemplate };

package/dist/index.js

@@ -0,0 +1,259 @@
+/** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
+"use strict";
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createVpcTemplate: () => createVpcTemplate
+});
+module.exports = __toCommonJS(src_exports);
+var NUMBER_OF_AVAILABILITY_ZONES = 3;
+var PUBLIC_ROUTER_TABLE_LOGICAL_ID = "PublicRouteTable";
+var PRIVATE_ROUTER_TABLE_LOGICAL_ID = "PrivateRouteTable";
+var createVpcTemplate = ({
+  cidrBlock,
+  createPublicSubnets = true
+}) => {
+  const totalOfSubnetsOnEachType = 2;
+  const getSubnetResource = ({
+    number,
+    isPublic
+  }) => {
+    const subnetType = isPublic ? "Public" : "Private";
+    const key = `${subnetType}Subnet${number}`;
+    const routerTableAssociationKey = `${subnetType}Subnet${number}RouteTableAssociation`;
+    const index = (isPublic ? 0 : 1) * totalOfSubnetsOnEachType + number - 1;
+    const azIndex = index % NUMBER_OF_AVAILABILITY_ZONES;
+    const cidrSubBlockCount = 2 * totalOfSubnetsOnEachType;
+    const cidrPrefixLength = parseInt(cidrBlock.split("/")[1], 10);
+    const cidrSubBlockBits = 32 - cidrPrefixLength - Math.ceil(Math.log2(cidrSubBlockCount));
+    let resources = {
+      [key]: {
+        Type: "AWS::EC2::Subnet",
+        Properties: {
+          AvailabilityZone: {
+            "Fn::Select": [azIndex, {
+              "Fn::GetAZs": ""
+            }]
+          },
+          CidrBlock: {
+            "Fn::Select": [index, {
+              "Fn::Cidr": [cidrBlock, cidrSubBlockCount, cidrSubBlockBits]
+            }]
+          },
+          MapPublicIpOnLaunch: isPublic,
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": `\${Project}-${subnetType.toLowerCase()}-subnet-${number}-\${AWS::Region}`
+            }
+          }]
+        }
+      },
+      [routerTableAssociationKey]: {
+        Type: "AWS::EC2::SubnetRouteTableAssociation",
+        Properties: {
+          RouteTableId: {
+            Ref: isPublic ? PUBLIC_ROUTER_TABLE_LOGICAL_ID : PRIVATE_ROUTER_TABLE_LOGICAL_ID
+          },
+          SubnetId: {
+            Ref: key
+          }
+        }
+      }
+    };
+    if (isPublic) {
+      resources = {
+        ...resources
+      };
+    }
+    if (!isPublic) {
+      resources = {
+        ...resources
+      };
+    }
+    return resources;
+  };
+  const template = {
+    AWSTemplateFormatVersion: "2010-09-09",
+    Description: "VPC, Subnets, and Route Tables for the project.",
+    Parameters: {
+      Project: {
+        Type: "String",
+        Description: "The name of the project"
+      }
+    },
+    Resources: {
+      Vpc: {
+        Type: "AWS::EC2::VPC",
+        Properties: {
+          CidrBlock: cidrBlock,
+          EnableDnsHostnames: true,
+          EnableDnsSupport: true,
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-vpc"
+            }
+          }]
+        }
+      },
+      ...getSubnetResource({
+        number: 1,
+        isPublic: false
+      }),
+      ...getSubnetResource({
+        number: 2,
+        isPublic: false
+      }),
+      [PRIVATE_ROUTER_TABLE_LOGICAL_ID]: {
+        Type: "AWS::EC2::RouteTable",
+        Properties: {
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-private-rtb"
+            }
+          }]
+        }
+      }
+    },
+    Outputs: {
+      DefaultSecurityGroup: {
+        Description: "The default security group ID",
+        Value: {
+          "Fn::GetAtt": ["Vpc", "DefaultSecurityGroup"]
+        }
+      },
+      VpcId: {
+        Description: "The VPC ID",
+        Value: {
+          Ref: "Vpc"
+        }
+      },
+      PrivateSubnet1: {
+        Description: "The private subnet 1 ID",
+        Value: {
+          Ref: "PrivateSubnet1"
+        }
+      },
+      PrivateSubnet2: {
+        Description: "The private subnet 2 ID",
+        Value: {
+          Ref: "PrivateSubnet2"
+        }
+      }
+    }
+  };
+  if (createPublicSubnets) {
+    template.Resources = {
+      ...template.Resources,
+      ...getSubnetResource({
+        number: 1,
+        isPublic: true
+      }),
+      ...getSubnetResource({
+        number: 2,
+        isPublic: true
+      }),
+      InternetGateway: {
+        Type: "AWS::EC2::InternetGateway",
+        Properties: {
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-igw"
+            }
+          }]
+        }
+      },
+      [PUBLIC_ROUTER_TABLE_LOGICAL_ID]: {
+        Type: "AWS::EC2::RouteTable",
+        Properties: {
+          VpcId: {
+            Ref: "Vpc"
+          },
+          Tags: [{
+            Key: "Name",
+            Value: {
+              "Fn::Sub": "${Project}-public-rtb"
+            }
+          }]
+        }
+      },
+      InternetGatewayAttachment: {
+        Type: "AWS::EC2::VPCGatewayAttachment",
+        Properties: {
+          InternetGatewayId: {
+            Ref: "InternetGateway"
+          },
+          VpcId: {
+            Ref: "Vpc"
+          }
+        }
+      },
+      PublicRoute: {
+        Type: "AWS::EC2::Route",
+        DependsOn: "InternetGatewayAttachment",
+        Properties: {
+          DestinationCidrBlock: "0.0.0.0/0",
+          GatewayId: {
+            Ref: "InternetGateway"
+          },
+          RouteTableId: {
+            Ref: PUBLIC_ROUTER_TABLE_LOGICAL_ID
+          }
+        }
+      }
+    };
+    template.Outputs = {
+      ...template.Outputs,
+      PublicSubnet1: {
+        Description: "The public subnet 1 ID",
+        Value: {
+          Ref: "PublicSubnet1"
+        }
+      },
+      PublicSubnet2: {
+        Description: "The public subnet 2 ID",
+        Value: {
+          Ref: "PublicSubnet2"
+        }
+      }
+    };
+  }
+  return template;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createVpcTemplate
+});

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@ttoss/cloud-vpc",
+  "version": "0.1.0",
+  "description": "Deploy a VPC with public and private subnets",
+  "author": "ttoss",
+  "contributors": [
+    "Pedro Arantes <pedro@arantespp.com> (https://arantespp.com)"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ttoss/ttoss.git",
+    "directory": "packages/cloud-vpc"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@ttoss/cloudformation": "^0.10.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "tsup": "^8.1.0",
+    "@ttoss/config": "^1.32.6",
+    "@ttoss/test-utils": "^2.1.10"
+  },
+  "keywords": [
+    "aws",
+    "cloudformation",
+    "vpc"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "jest --projects tests/unit"
+  }
+}