@quadnix/octo-build 0.0.4 → 0.0.6

package/dist/commands/create/generator-octo-app-template/generators/app/templates/gitignore.ejs

@@ -0,0 +1,82 @@
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Build outputs
+dist/
+build/
+*.tsbuildinfo
+
+# Environment variables
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+logs
+*.log
+
+# Coverage
+coverage/
+.nyc_output/
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Storybook build outputs
+.out
+.storybook-out
+
+# Temporary folders
+tmp/
+temp/

package/dist/commands/create/generator-octo-app-template/generators/app/templates/package.json.ejs

@@ -0,0 +1,54 @@
+{
+  "dependencies": {},
+  "description": "<%= description %>",
+  "devDependencies": {},
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "jest": {
+    "coverageDirectory": "./coverage",
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "moduleNameMapper": {
+      "(.+)\\.js": "$1"
+    },
+    "preset": "ts-jest/presets/default-esm",
+    "rootDir": ".",
+    "testEnvironment": "node",
+    "testRegex": ".*spec\\.ts$",
+    "transform": {
+      "^.+\\.ts$": [
+        "ts-jest",
+        {
+          "useESM": true
+        }
+      ]
+    }
+  },
+  "keywords": [
+    "cdk",
+    "infrastructure",
+    "octo",
+    "typescript"
+  ],
+  "main": "dist/main.js",
+  "name": "<%= name %>",
+  "private": true,
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint .",
+    "start": "node dist/main.js",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --testRegex=\"\\.spec.ts$\"",
+    "test:e2e": "NODE_OPTIONS=--experimental-vm-modules jest --testRegex=\"\\.e2e-spec.ts$\""
+  },
+  "type": "module",
+  "types": "dist/main.d.ts",
+  "version": "<%= version %>"
+}

package/dist/commands/create/generator-octo-app-template/generators/app/templates/prettierrc.ejs

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-ecs-server/app.config.ts.ejs

@@ -0,0 +1,23 @@
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import env from 'env-smart';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+env.load({
+  directory: __dirname,
+  envDefaultsFilename: '.env.defaults',
+  envFilename: '.env',
+  inlineTypes: false,
+  process: true,
+});
+
+type Configuration = {
+  AWS_ACCOUNT_ID: string;
+};
+
+export const config = env.config<Configuration>((env) => {
+  return {
+    AWS_ACCOUNT_ID: env.AWS_ACCOUNT_ID,
+  };
+});

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-ecs-server/env.ejs

@@ -0,0 +1,2 @@
+# Fix me: AWS account ID.
+AWS_ACCOUNT_ID=123456789123

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-ecs-server/main.ts.ejs

@@ -0,0 +1,22 @@
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { type App, LocalStateProvider, Octo } from '@quadnix/octo';
+import { EventLoggerListener } from '@quadnix/octo-event-listeners';
+import { ModuleDefinitions } from './module-definitions.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const octoStatePath = join(__dirname, '.octo');
+
+const octo = new Octo();
+const stateProvider = new LocalStateProvider(octoStatePath);
+await octo.initialize(stateProvider, [{ type: EventLoggerListener }]);
+
+const moduleDefinitions = new ModuleDefinitions();
+for (const moduleDefinition of moduleDefinitions.getAll()) {
+  octo.loadModule(moduleDefinition.module, moduleDefinition.moduleId, moduleDefinition.moduleInputs);
+}
+octo.orderModules(moduleDefinitions.getAll().map((m) => m.module));
+
+const { 'app-module.model.app': app } = (await octo.compose()) as { 'app-module.model.app': App };
+const transaction = octo.beginTransaction(app);
+await transaction.next();

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-ecs-server/module-definitions.ts.ejs

@@ -0,0 +1,202 @@
+import {
+  type AModule,
+  type Account,
+  type App,
+  type Constructable,
+  type Deployment,
+  type Environment,
+  Execution,
+  type ModuleSchemaInputs,
+  type Region,
+  type Server,
+  type Subnet,
+  SubnetType,
+  stub,
+} from '@quadnix/octo';
+import { AwsIniAccountModule } from '@quadnix/octo-aws-cdk/modules/account/aws-ini-account';
+import { SimpleAppModule } from '@quadnix/octo-aws-cdk/modules/app/simple-app';
+import { AwsEcsDeploymentModule } from '@quadnix/octo-aws-cdk/modules/deployment/aws-ecs-deployment';
+import { AwsEcsEnvironmentModule } from '@quadnix/octo-aws-cdk/modules/environment/aws-ecs-environment';
+import { AwsEcsExecutionModule } from '@quadnix/octo-aws-cdk/modules/execution/aws-ecs-execution';
+import { AwsMultiAzRegionModule } from '@quadnix/octo-aws-cdk/modules/region/aws-multi-az-region';
+import { AwsMultiAzRegionId } from '@quadnix/octo-aws-cdk/modules/region/aws-multi-az-region/schema';
+import { AwsEcsServerModule } from '@quadnix/octo-aws-cdk/modules/server/aws-ecs-server';
+import { AwsEcsAlbServiceModule } from '@quadnix/octo-aws-cdk/modules/service/aws-ecs-alb-service';
+import { AwsSimpleSubnetModule } from '@quadnix/octo-aws-cdk/modules/subnet/aws-simple-subnet';
+import { config } from './app.config.js';
+
+type ModuleDefinition<T extends AModule<unknown, any>> = {
+  module: Constructable<T>;
+  moduleId: string;
+  moduleInputs: ModuleSchemaInputs<T>;
+};
+
+export class ModuleDefinitions {
+  private readonly moduleDefinitions: ModuleDefinition<AModule<unknown, any>>[] = [];
+
+  constructor() {
+    this.init();
+  }
+
+  add<T extends AModule<unknown, any>>(
+    module: Constructable<T>,
+    moduleId: string,
+    moduleInputs: ModuleSchemaInputs<T>,
+  ): void {
+    this.moduleDefinitions.push({ module, moduleId, moduleInputs });
+  }
+
+  getAll(): ModuleDefinitions['moduleDefinitions'] {
+    return this.moduleDefinitions;
+  }
+
+  private init(): void {
+    this.add(SimpleAppModule, 'app-module', { name: 'aws-ecs-server' });
+
+    this.add(AwsIniAccountModule, 'account-module', {
+      accountId: config.AWS_ACCOUNT_ID,
+      app: stub<App>('${{app-module.model.app}}'),
+    });
+
+    this.add(AwsMultiAzRegionModule, 'region-module', {
+      account: stub<Account>('${{account-module.model.account}}'),
+      name: 'app-region-east',
+      regionIds: [AwsMultiAzRegionId.AWS_US_EAST_1A, AwsMultiAzRegionId.AWS_US_EAST_1B],
+      vpcCidrBlock: '10.0.0.0/16',
+    });
+
+    this.add(AwsEcsServerModule, 'backend-server-module', {
+      account: stub<Account>('${{account-module.model.account}}'),
+      serverKey: 'backend',
+    });
+
+    this.add(AwsEcsDeploymentModule, 'backend-deployment-v1-module', {
+      deploymentContainerProperties: {
+        cpu: 256,
+        image: {
+          command: 'node webserver',
+          ports: [{ containerPort: 80, protocol: 'tcp' }],
+          // eslint-disable-next-line spellcheck/spell-checker
+          uri: 'docker.io/ealen/echo-server:0.9.2',
+        },
+        memory: 512,
+      },
+      deploymentTag: 'v1',
+      server: stub<Server>('${{backend-server-module.model.server}}'),
+    });
+
+    this.add(AwsEcsEnvironmentModule, 'qa-environment-module', {
+      environmentName: 'qa',
+      environmentVariables: { NODE_ENV: 'qa' },
+      region: stub<Region>('${{region-module.model.region}}'),
+    });
+
+    this.add(AwsSimpleSubnetModule, 'public-subnet-module', {
+      region: stub<Region>('${{region-module.model.region}}'),
+      subnetAvailabilityZone: 'us-east-1a',
+      subnetCidrBlock: '10.0.0.0/24',
+      subnetName: 'public-subnet',
+      subnetOptions: {
+        createNatGateway: true,
+        disableSubnetIntraNetwork: false,
+        subnetType: SubnetType.PUBLIC,
+      },
+    });
+    this.add(AwsSimpleSubnetModule, 'public-backup-subnet-module', {
+      region: stub<Region>('${{region-module.model.region}}'),
+      subnetAvailabilityZone: 'us-east-1b',
+      subnetCidrBlock: '10.0.1.0/24',
+      subnetName: 'public-backup-subnet',
+      subnetOptions: {
+        createNatGateway: false,
+        disableSubnetIntraNetwork: false,
+        subnetType: SubnetType.PUBLIC,
+      },
+    });
+    this.add(AwsSimpleSubnetModule, 'private-subnet-module', {
+      region: stub<Region>('${{region-module.model.region}}'),
+      subnetAvailabilityZone: 'us-east-1a',
+      subnetCidrBlock: '10.0.2.0/24',
+      subnetName: 'private-subnet',
+      subnetOptions: {
+        createNatGateway: false,
+        disableSubnetIntraNetwork: true,
+        subnetType: SubnetType.PRIVATE,
+      },
+      subnetSiblings: [
+        {
+          attachToNatGateway: true,
+          subnet: stub<Subnet>('${{public-subnet-module.model.subnet}}'),
+        },
+        {
+          attachToNatGateway: false,
+          subnet: stub<Subnet>('${{public-backup-subnet-module.model.subnet}}'),
+        },
+      ],
+    });
+
+    this.add(AwsEcsExecutionModule, 'backend-v1-qa-execution-module', {
+      deployments: {
+        main: {
+          containerProperties: {
+            image: {
+              essential: true,
+              name: 'backend-v1',
+            },
+          },
+          deployment: stub<Deployment>('${{backend-deployment-v1-module.model.deployment}}'),
+        },
+        sidecars: [],
+      },
+      desiredCount: 1,
+      environment: stub<Environment>('${{qa-environment-module.model.environment}}'),
+      executionId: 'backend-v1-qa-execution',
+      securityGroupRules: [
+        {
+          CidrBlock: '0.0.0.0/0',
+          Egress: false,
+          FromPort: 80,
+          IpProtocol: 'tcp',
+          ToPort: 80,
+        },
+      ],
+      subnet: stub<Subnet>('${{private-subnet-module.model.subnet}}'),
+    });
+
+    this.add(AwsEcsAlbServiceModule, 'qa-api-alb-module', {
+      albName: 'qa-api-alb',
+      listeners: [
+        {
+          DefaultActions: [
+            { action: { TargetGroups: [{ targetGroupName: 'backend-v1-80', Weight: 100 }] }, actionType: 'forward' },
+          ],
+          Port: 80,
+          rules: [],
+        },
+      ],
+      region: stub<Region>('${{region-module.model.region}}'),
+      subnets: [
+        stub<Subnet>('${{public-subnet-module.model.subnet}}'),
+        stub<Subnet>('${{public-backup-subnet-module.model.subnet}}'),
+      ],
+      targets: [
+        {
+          containerName: 'backend-v1',
+          containerPort: 80,
+          execution: stub<Execution>('${{backend-v1-qa-execution-module.model.execution}}'),
+          healthCheck: {
+            HealthCheckIntervalSeconds: 30,
+            HealthCheckPath: '/',
+            HealthCheckPort: 80,
+            HealthCheckProtocol: 'HTTP',
+            HealthCheckTimeoutSeconds: 5,
+            HealthyThresholdCount: 2,
+            Matcher: { HttpCode: 200 },
+            UnhealthyThresholdCount: 2,
+          },
+          Name: 'backend-v1-80',
+        },
+      ],
+    });
+  }
+}

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/app.config.ts.ejs

@@ -0,0 +1,25 @@
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import env from 'env-smart';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+env.load({
+  directory: __dirname,
+  envDefaultsFilename: '.env.defaults',
+  envFilename: '.env',
+  inlineTypes: false,
+  process: true,
+});
+
+type Configuration = {
+  AWS_ACCOUNT_ID: string;
+  AWS_S3_WEBSITE_BUCKET_NAME: string;
+};
+
+export const config = env.config<Configuration>((env) => {
+  return {
+    AWS_ACCOUNT_ID: env.AWS_ACCOUNT_ID,
+    AWS_S3_WEBSITE_BUCKET_NAME: env.AWS_S3_WEBSITE_BUCKET_NAME,
+  };
+});

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/env.ejs

@@ -0,0 +1,5 @@
+# Fix me: AWS account ID.
+AWS_ACCOUNT_ID=123456789123
+
+# Fix me: S3 bucket name.
+AWS_S3_WEBSITE_BUCKET_NAME=my-website-unique-bucket

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/main.ts.ejs

@@ -0,0 +1,22 @@
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { type App, LocalStateProvider, Octo } from '@quadnix/octo';
+import { EventLoggerListener } from '@quadnix/octo-event-listeners';
+import { ModuleDefinitions } from './module-definitions.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const octoStatePath = join(__dirname, '.octo');
+
+const octo = new Octo();
+const stateProvider = new LocalStateProvider(octoStatePath);
+await octo.initialize(stateProvider, [{ type: EventLoggerListener }]);
+
+const moduleDefinitions = new ModuleDefinitions();
+for (const moduleDefinition of moduleDefinitions.getAll()) {
+  octo.loadModule(moduleDefinition.module, moduleDefinition.moduleId, moduleDefinition.moduleInputs);
+}
+octo.orderModules(moduleDefinitions.getAll().map((m) => m.module));
+
+const { 'app-module.model.app': app } = (await octo.compose()) as { 'app-module.model.app': App };
+const transaction = octo.beginTransaction(app);
+await transaction.next();

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/module-definitions.ts.ejs

@@ -0,0 +1,52 @@
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { type AModule, type Account, type App, type Constructable, type ModuleSchemaInputs, stub } from '@quadnix/octo';
+import { AwsIniAccountModule } from '@quadnix/octo-aws-cdk/modules/account/aws-ini-account';
+import { SimpleAppModule } from '@quadnix/octo-aws-cdk/modules/app/simple-app';
+import { AwsS3StaticWebsiteServiceModule } from '@quadnix/octo-aws-cdk/modules/service/aws-s3-static-website-service';
+import { config } from './app.config.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const websiteSourcePath = join(__dirname, 'website');
+
+type ModuleDefinition<T extends AModule<unknown, any>> = {
+  module: Constructable<T>;
+  moduleId: string;
+  moduleInputs: ModuleSchemaInputs<T>;
+};
+
+export class ModuleDefinitions {
+  private readonly moduleDefinitions: ModuleDefinition<AModule<unknown, any>>[] = [];
+
+  constructor() {
+    this.init();
+  }
+
+  add<T extends AModule<unknown, any>>(
+    module: Constructable<T>,
+    moduleId: string,
+    moduleInputs: ModuleSchemaInputs<T>,
+  ): void {
+    this.moduleDefinitions.push({ module, moduleId, moduleInputs });
+  }
+
+  getAll(): ModuleDefinitions['moduleDefinitions'] {
+    return this.moduleDefinitions;
+  }
+
+  private init(): void {
+    this.add(SimpleAppModule, 'app-module', { name: 'aws-s3-website' });
+
+    this.add(AwsIniAccountModule, 'account-module', {
+      accountId: config.AWS_ACCOUNT_ID,
+      app: stub<App>('${{app-module.model.app}}'),
+    });
+
+    this.add(AwsS3StaticWebsiteServiceModule, 's3-website-service-module', {
+      account: stub<Account>('${{account-module.model.account}}'),
+      awsRegionId: 'us-east-1',
+      bucketName: config.AWS_S3_WEBSITE_BUCKET_NAME,
+      directoryPath: websiteSourcePath,
+    });
+  }
+}

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/website/error.html.ejs

@@ -0,0 +1,8 @@
+<html lang='en'>
+<head>
+  <title>Oh No!</title>
+</head>
+<body>
+<h1>This is an error page from <%= name %>!</h1>
+</body>
+</html>

package/dist/commands/create/generator-octo-app-template/generators/app/templates/src/aws-s3-website/website/index.html.ejs

@@ -0,0 +1,8 @@
+<html lang='en'>
+<head>
+  <title>Hello World</title>
+</head>
+<body>
+<h1>Hello from <%= name %></h1>
+</body>
+</html>

package/dist/commands/create/generator-octo-app-template/generators/app/templates/tsconfig.build.json.ejs

@@ -0,0 +1,11 @@
+{
+  "exclude": [
+    "**/*spec.ts",
+    "eslint.config.js",
+    "coverage",
+    "dist",
+    "node_modules",
+    "test"
+  ],
+  "extends": "./tsconfig.json"
+}

package/dist/commands/create/generator-octo-app-template/generators/app/templates/tsconfig.json.ejs

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": "./",
+    "declaration": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "incremental": true,
+    "isolatedModules": true,
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": false,
+    "noImplicitOverride": true,
+    "outDir": "./dist",
+    "removeComments": false,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strictBindCallApply": true,
+    "strictNullChecks": true,
+    "target": "ES2022",
+    "typeRoots": [
+      "node_modules/@types"
+    ],
+    "useDefineForClassFields": false,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "coverage",
+    "dist",
+    "node_modules"
+  ],
+  "include": [
+    "eslint.config.js",
+    "**/*.json",
+    "**/*.ts"
+  ]
+}

package/dist/commands/create/index.d.ts

@@ -0,0 +1 @@
+export { createCommand } from './create.command.js';

package/dist/commands/create/index.js

@@ -0,0 +1,2 @@
+export { createCommand } from './create.command.js';
+//# sourceMappingURL=index.js.map

package/dist/commands/create/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/create/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}