@fy-stack/fullstack-construct 0.0.143 → 0.0.144

package/README.md

@@ -1,64 +1,75 @@
 # Fullstack Construct Documentation
 
-## `FullstackConstruct`
+## Overview
 
-### Example
-```typescript
-import {
-  AppGrant,
-  AppType,
-  FullStackConstruct,
-} from '@fy-stack/fullstack-construct';
+The Fullstack Construct is a high-level AWS CDK construct that enables deploying full-stack applications to AWS infrastructure. It provides an integrated solution for deploying various types of applications with their associated infrastructure.
+
+## Supported Application Types
+
+### 1. Static Applications
+- **Static Website** (`AppType.STATIC_WEBSITE`)
+    - Simple static websites with HTML, CSS, and JavaScript
+    - Deployed to S3 and served via CloudFront
+
+### 2. Next.js Applications
+- **Next.js Pages Export** (`AppType.NEXT_PAGE_EXPORT`)
+    - Static export mode of Next.js applications
+    - Optimized for static site generation
+- **Next.js App Router** (`AppType.NEXT_APP_ROUTER`)
+    - Support for the newer App Router architecture
+    - Includes handling for server components
+
+### 3. Node.js Applications
+- **Node App** (`AppType.NODE_APP`)
+    - General purpose Node.js applications
+    - Deployable as containers or Lambda functions
+- **Node API** (`AppType.NODE_API`)
+    - Specialized for NestJS API applications
+    - Includes API Gateway integration
+
+### 4. Container Applications
+- **Image App** (`AppType.IMAGE_APP`)
+    - Docker container-based applications
+    - Deployable to ECS with Fargate
+
+## Deployment Options
 
-new FullStackConstruct(this, 'FullstackApp', {
-  appId: `unique-app-id`,
-  apps: {
-    api: {
-      type: AppType.NODE_API,
-      output: process.cwd() + '/dist/apps/api',
-      buildParams: { command: 'node main.js' },
-      attachment: { secrets: true },
-      grant: [AppGrant.EVENT, AppGrant.SECRETS],
-    },
-    eventHandler: {
-      type: AppType.NODE_APP,
-      output: process.cwd() + '/dist/apps/event-handler',
-      buildParams: { handler: 'main.handler' },
-      attachment: { secrets: true, queue: { batchSize: 10 } },
-      grant: [AppGrant.SECRETS],
-    },
-    web: {
-      type: AppType.NEXT_PAGE_EXPORT,
-      output: process.cwd() + '/dist/apps/web',
-    },
-  },
-  secrets: {
-    SOME_OTHER_ENV: "envValue"
-  },
-  events: {
-    messages: [
-      { messages: [EventType.DAILY_SPOOL], $resource: 'eventHandler' },
-    ],
-    cron: [
-      {
-        messages: [EventType.DAILY_SPOOL],
-        cron: { hour: '0', minute: '0' },
-      },
-    ],
-  },
-  cdn: {
-    routes: {
-      '/*': { $resource: 'web' },
-    },
-    domains: [
-      { domain: 'example.com', records: ['*', 'www'] }, 
-      { domain: 'example.com.ng', records: ['*', 'www'] },
-    ],
-  },
-  api: {
-    routes: {
-      '/*': { $resource: 'api' },
+### 1. Lambda Deployment
+- Suitable for serverless applications
+- Configurable memory and timeout settings
+- Environment variable support
+- Example configuration:
+
+```typescript
+{ 
+  type: AppType.NODE_API,
+  buildParams: {
+    memorySize: 512,
+      timeout: 30,
+      environment: {
+      NODE_ENV: 'production'
     }
   }
-})
+}
+```
+
+
+### 2. ECS Deployment
+- Container-based deployment with Fargate
+- Supports both service and task patterns
+- Load balancer integration
+- Example configuration:
+
+```typescript
+{ 
+  server: { 
+    apps: {
+      api: { 
+        type: AppType.NODE_API,
+        // ECS-specific configuration 
+      }
+    }, 
+    loadBalancer: { 
+// Load balancer configuration
+    } }, tasks: { // Background task configurations } }
 ```

package/dist/lib/fullstack-construct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fullstack-construct.d.ts","sourceRoot":"","sources":["../../src/lib/fullstack-construct.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,eAAe,EACf,eAAe,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAa,MAAM,iBAAiB,CAAC;AAErE,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEjE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IACxC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,gBAAgB,CAAC;gBAEpB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,uBAAuB;IAoNxE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,aAAa;IAU1D,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE;IAW5C,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM;CAgB/B"}
+{"version":3,"file":"fullstack-construct.d.ts","sourceRoot":"","sources":["../../src/lib/fullstack-construct.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EACL,YAAY,EACZ,eAAe,EACf,eAAe,EAChB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAa,MAAM,iBAAiB,CAAC;AAErE,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEjE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IACxC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,MAAM,EAAE,gBAAgB,CAAC;gBAEpB,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,uBAAuB;IAwNxE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,aAAa;IAU1D,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE;IAW5C,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM;CAgB/B"}

package/dist/lib/fullstack-construct.js

@@ -51,25 +51,6 @@ class FullStackConstruct extends constructs_1.Construct {
                 vpcId: this.vpc.vpcId,
             });
         }
-        this.secret = new secret_construct_1.SecretsConstruct(this, 'SecretConstruct', {
-            resources: {
-                auth: this.auth,
-                database: this.database,
-                storage: this.storage,
-                event: this.event,
-            },
-            secrets: {
-                REGION: aws_cdk_lib_1.Stack.of(this).region,
-                ENVIRONMENT: props.environment,
-                ...props.secret,
-            },
-        });
-        if (props.outputs) {
-            new aws_cdk_lib_1.CfnOutput(this, 'SecretsName', {
-                key: 'appSecrets',
-                value: this.secret.secrets.secretName,
-            });
-        }
         if (props.ecs) {
             this.ecs = new app_construct_1.EcsConstruct(this, 'EcsConstruct', {
                 vpc: this.vpc,
@@ -77,36 +58,12 @@ class FullStackConstruct extends constructs_1.Construct {
                 environment: props.environment,
                 ...props.ecs,
             });
-            if (this.ecs.server) {
-                this.fromGrants(this.ecs.server, props.ecs.server?.grants);
-                for (const i in this.ecs.server.apps) {
-                    if (!props.ecs.server?.apps[i].attachment)
-                        continue;
-                    this.fromAttachments(this.ecs.server.apps[i], props.ecs.server.apps[i].attachment);
-                }
-            }
-            for (const i in this.ecs.tasks) {
-                if (props.ecs.tasks[i]?.grants) {
-                    this.fromGrants(this.ecs.tasks[i], props.ecs.tasks[i]?.grants);
-                }
-                if (props.ecs.tasks[i]?.attachment) {
-                    this.fromAttachments(this.ecs.tasks[i], props.ecs.tasks[i]?.attachment);
-                }
-            }
         }
         if (props.lambda) {
             this.lambda = new app_construct_1.LambdaConstruct(this, 'LambdaConstruct', {
                 vpc: this.vpc,
                 apps: props.lambda,
             });
-            for (const i in this.lambda.apps) {
-                if (props.lambda[i].attachment) {
-                    this.fromAttachments(this.lambda.apps[i], props.lambda[i].attachment);
-                }
-                if (props.lambda[i].grants) {
-                    this.fromGrants(this.lambda.apps[i], props.lambda[i].grants);
-                }
-            }
         }
         if (props.static) {
             this.static = new app_construct_1.StaticConstruct(this, 'StaticConstruct', {
@@ -155,14 +112,61 @@ class FullStackConstruct extends constructs_1.Construct {
                 });
             }
         }
+        this.secret = new secret_construct_1.SecretsConstruct(this, 'SecretConstruct', {
+            resources: {
+                auth: this.auth,
+                database: this.database,
+                storage: this.storage,
+                event: this.event,
+                cdn: this.cdn,
+                api: this.api,
+            },
+            secrets: {
+                REGION: aws_cdk_lib_1.Stack.of(this).region,
+                ENVIRONMENT: props.environment,
+                ...props.secret,
+            },
+        });
+        if (props.outputs) {
+            new aws_cdk_lib_1.CfnOutput(this, 'SecretsName', {
+                key: 'appSecrets',
+                value: this.secret.secrets.secretName,
+            });
+        }
+        if (this.ecs && props.ecs) {
+            if (this.ecs.server) {
+                this.fromGrants(this.ecs.server, props.ecs.server?.grants);
+                for (const i in this.ecs.server.apps) {
+                    if (!props.ecs.server?.apps[i].attachment)
+                        continue;
+                    this.fromAttachments(this.ecs.server.apps[i], props.ecs.server.apps[i].attachment);
+                }
+            }
+            for (const i in this.ecs.tasks) {
+                if (props.ecs.tasks[i]?.grants) {
+                    this.fromGrants(this.ecs.tasks[i], props.ecs.tasks[i]?.grants);
+                }
+                if (props.ecs.tasks[i]?.attachment) {
+                    this.fromAttachments(this.ecs.tasks[i], props.ecs.tasks[i]?.attachment);
+                }
+            }
+        }
+        if (this.lambda && props.lambda) {
+            for (const i in this.lambda.apps) {
+                if (props.lambda[i].attachment) {
+                    this.fromAttachments(this.lambda.apps[i], props.lambda[i].attachment);
+                }
+                if (props.lambda[i].grants) {
+                    this.fromGrants(this.lambda.apps[i], props.lambda[i].grants);
+                }
+            }
+        }
         if (this.storage && this.cdn) {
             this.storagePolicy = JSON.stringify(this.storage.cloudfrontPolicy(this.cdn.distribution.distributionId));
-            if (props.outputs) {
-                new aws_cdk_lib_1.CfnOutput(this, 'StorageBucketCDNPolicy', {
-                    key: 'storageBucketCDNPolicy',
-                    value: this.storagePolicy,
-                });
-            }
+            new aws_cdk_lib_1.CfnOutput(this, 'StorageBucketCDNPolicy', {
+                key: 'storageBucketCDNPolicy',
+                value: this.storagePolicy,
+            });
         }
         aws_cdk_lib_1.Tags.of(this).add('App', props.name);
         aws_cdk_lib_1.Tags.of(this).add('Environment', props.environment);

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@fy-stack/fullstack-construct",
-  "version": "0.0.143",
+  "version": "0.0.144",
   "repository": "https://github.com/festusyuma/fy-stack",
   "dependencies": {
-    "@fy-stack/apigateway-construct": "0.0.143",
-    "@fy-stack/app-construct": "0.0.143",
-    "@fy-stack/auth-construct": "0.0.143",
-    "@fy-stack/cdn-construct": "0.0.143",
-    "@fy-stack/database-construct": "0.0.143",
-    "@fy-stack/event-construct": "0.0.143",
-    "@fy-stack/secret-construct": "0.0.143",
-    "@fy-stack/storage-construct": "0.0.143",
+    "@fy-stack/apigateway-construct": "0.0.144",
+    "@fy-stack/app-construct": "0.0.144",
+    "@fy-stack/auth-construct": "0.0.144",
+    "@fy-stack/cdn-construct": "0.0.144",
+    "@fy-stack/database-construct": "0.0.144",
+    "@fy-stack/event-construct": "0.0.144",
+    "@fy-stack/secret-construct": "0.0.144",
+    "@fy-stack/storage-construct": "0.0.144",
     "tslib": "^2.3.0",
-    "@fy-stack/types": "0.0.143"
+    "@fy-stack/types": "0.0.144"
   },
   "peerDependencies": {
     "aws-cdk-lib": "^2.198.0",