cdk-nuxt 0.5.0 → 0.6.1

package/README.md

@@ -6,14 +6,14 @@
     <a href="https://www.npmjs.com/package/cdk-nuxt"><img alt="License" src="https://img.shields.io/npm/l/cdk-nuxt.svg" /></a>
 </p>
 
-Easily deploy a dynamic universal Nuxt application via CDK on AWS including the following features:
+Easily deploy Nuxt applications via CDK on AWS including the following features:
 
-- Fast responses via [Lambda](https://aws.amazon.com/lambda/)
-- Publicly available by a custom domain (or subdomain) via [Route53](https://aws.amazon.com/route53/) and [API Gateway](https://aws.amazon.com/api-gateway/)
+- Fast responses via [Lambda](https://aws.amazon.com/lambda/) (`target=server`) or [S3](https://aws.amazon.com/s3/) (`target=static`)
+- Publicly available by a custom domain (or subdomain) via [Route53](https://aws.amazon.com/route53/) and [API Gateway](https://aws.amazon.com/api-gateway/) (`target=server`)
 - Automatic redirects from HTTP to HTTPS via [CloudFront](https://aws.amazon.com/cloudfront/)
-- Automatic upload of the `client` build files for CSR and static assets to [S3](https://aws.amazon.com/s3/) with optimized caching rules
-- Scheduled pings of the Nuxt app to keep the Lambda warm for fast responses via [EventBridge](https://aws.amazon.com/eventbridge/) rules
-- Automatic cleanup of outdated static assets and build files
+- Automatic upload of the build files for CSR and static assets to [S3](https://aws.amazon.com/s3/) with optimized caching rules
+- Scheduled pings of the Nuxt app to keep the Lambda warm for fast responses via [EventBridge](https://aws.amazon.com/eventbridge/) rules (`target=server`)
+- Automatic cleanup of outdated static assets and build files (`target=server`)
 
 > :warning: **This package might not support every Nuxt config yet.** But feel free to give it a try and open an issue or a PR if necessary.
 
@@ -24,6 +24,11 @@ Easily deploy a dynamic universal Nuxt application via CDK on AWS including the
 
 ## Installation
 
+Two CDK stacks can be used to deploy a Nuxt app to AWS using this package depending on the [app's target setting](https://nuxtjs.org/docs/configuration-glossary/configuration-target#the-target-property).
+Therefore, follow the installation steps for your corresponding target setting.
+
+### Target: 'server'
+
 1. Install the package and its required dependencies:
     ```bash
     yarn add cdk-nuxt --dev # The package itself
@@ -55,8 +60,20 @@ After the installation steps the `package.json` file should look something like
 }
 ```
 
+### Target: 'static'
+
+Install the package and its required dependencies:
+ ```bash
+ yarn add cdk-nuxt --dev # The package itself
+ yarn add ts-node typescript --dev # To compile the CDK stacks via typescript
+ yarn add aws-cdk@2.15.0 --dev # CDK cli with this exact version for the deployment
+ ```
+
 ## Setup
 
+Again, follow the steps according to the [app's target setting](https://nuxtjs.org/docs/configuration-glossary/configuration-target#the-target-property).
+
+### Target: 'server'
 1. Replace the `export default` part of your Nuxt configuration file (`nuxt.config.js`) with `module.exports =`, so it fits the following format:
    ```js
    // Change "export default" => "module.exports ="
@@ -72,7 +89,19 @@ After the installation steps the `package.json` file should look something like
 6. Run the following command to automatically create the required CDK stack entrypoint at `stack/index.ts`. This file defines the config how the Nuxt app will be deployed via CDK. You should adapt the file to the project's needs, especially the props `env.account` (setup step 2), `hostedZoneId` (setup step 3), `regionalTlsCertificateArn` (setup step 4) and `globalTlsCertificateArn` (setup step 5).
 
    ```bash
-   node_modules/.bin/cdk-nuxt-init
+   node_modules/.bin/cdk-nuxt-init-server
+   ```
+
+   > :warning: It's recommended using a `.env` file or another secrets file to import the sensitive secrets into the `stack/index.ts` file.
+
+### Target: 'static'
+1. [Create an AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/?nc1=h_ls), if you don't have one yet. Then login into the AWS console and note the `Account ID`. You will need it in step 4.
+2. [Create a hosted zone in Route53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html) for the desired domain, if you don't have one yet.<br/>This is required to create DNS records for the domain to make the Nuxt app publicly available on that domain.<br/>On the hosted zone details you should see the `Hosted zone ID` of the hosted zone. You will need it in step 4.
+3. [Request a public **global** certificate in the AWS Certificate Manager (ACM)](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) for the desired domain in `us-east-1` (**global**) and validate it, if you don't have one yet.<br/>This is required to provide the Nuxt app via HTTPS on the public internet.<br/>Take note of the displayed `ARN` for the certificate. You will need it in step 4.<br/>**Important: The certificate must be issued in us-east-1 (global) regardless of the region used for the Nuxt app itself as it will be attached to the Cloudfront distribution which works globally.**
+4. Run the following command to automatically create the required CDK stack entrypoint at `stack/index.ts`. This file defines the config how the Nuxt app will be deployed via CDK. You should adapt the file to the project's needs, especially the props `env.account` (setup step 1), `hostedZoneId` (setup step 2), and `globalTlsCertificateArn` (setup step 3).
+
+   ```bash
+   node_modules/.bin/cdk-nuxt-init-static
    ```
 
    > :warning: It's recommended using a `.env` file or another secrets file to import the sensitive secrets into the `stack/index.ts` file.
@@ -80,7 +109,9 @@ After the installation steps the `package.json` file should look something like
 ## Build and Deploy
 
 After the installation and the setup you are already good to go to build the Nuxt app and to deploy it to AWS with this package.
+Again, follow the steps according to the [app's target setting](https://nuxtjs.org/docs/configuration-glossary/configuration-target#the-target-property).
 
+### Target: 'server'
 1. Install the dependencies for the Nuxt app including the `devDependencies` as these are required to successfully build the app:
    ```bash
    yarn install --production=false
@@ -91,11 +122,11 @@ After the installation and the setup you are already good to go to build the Nux
    ```
 3. Run the CDK deployment:
    ```bash
-   node_modules/.bin/cdk-nuxt-deploy
+   node_modules/.bin/cdk-nuxt-deploy-server
    ```
    The deployment script will take care of installing only the dependencies that are required for the Nuxt app and deploying the Nuxt build files to AWS according to the stack settings in `stack/index.ts`.<br/>See the section Used AWS Resources for details on which resources will exactly be created on AWS.
 
-## Optional: Customize the Lambda handler
+#### Optional: Customize the Lambda handler
 
 The package takes advantage of the `nuxt-start` and `aws-lambda` modules to automatically provide a Lambda handler for the Nuxt app. 
 If you need more control over the entrypoint of the Lambda function, e.g., for adding additional logging or performance monitoring, feel free to specify your own handler within a file `server/index.js` within your root directory.
@@ -118,7 +149,7 @@ const app = nuxt.server.app;
 let serverlessExpressInstance = null;
 async function initNuxt(event, context) {
    await nuxt.ready();
-   serverlessExpressInstance = serverlessExpress({ app, eventSourceName: 'AWS_API_GATEWAY_V2' })
+   serverlessExpressInstance = serverlessExpress({ app })
 
    return serverlessExpressInstance(event, context)
 }
@@ -132,6 +163,22 @@ exports.handler = async (event, context) => {
 }
 ```
 
+### Target: 'static'
+1. Install the dependencies for the Nuxt app including the `devDependencies` as these are required to successfully build the app:
+   ```bash
+   yarn install --production=false
+   ```
+2. Build the Nuxt app with the build settings you need for the app:
+   ```bash
+   yarn generate
+   ```
+3. Run the CDK deployment:
+   ```bash
+   node_modules/.bin/cdk-nuxt-deploy-static
+   ```
+   The deployment script will take care of deploying the Nuxt build files to AWS according to the stack settings in `stack/index.ts`.<br/>See the section Used AWS Resources for details on which resources will exactly be created on AWS.
+
+
 ## Optional: Automatically deploy on every push (CD) via [GitHub Actions](https://github.com/features/actions)
 
 Feel free to copy the following GitHub Actions YAML file content into a YAML file at `.github/workflows/deploy.yml` to automatically build and deploy the Nuxt app to AWS on every push to a specific branch.<br/>This only works if you're using GitHub for the project's VCS repository.
@@ -177,10 +224,10 @@ jobs:
         run: yarn install --production=false # Important to install devDependencies for the build
 
       - name: Build project
-        run: yarn build # Should trigger 'nuxt build' according to the package.json
+        run: yarn build # (or yarn generate)
 
       - name: Deploy to AWS
-        run: node_modules/.bin/nuxt-deploy
+        run: node_modules/.bin/cdk-nuxt-deploy-server # (or node_modules/.bin/cdk-nuxt-deploy-static)
         env:
            # Create an IAM user on AWS for the deployment and create the appropriate secrets in the GitHub repository secrets
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -190,24 +237,29 @@ jobs:
 
 ## Advanced: Used AWS Resources
 
-Two CDK stacks will be deployed to AWS using this package:
+Two CDK stacks can be used to deploy a Nuxt app to AWS using this package depending on the [app's target setting](https://nuxtjs.org/docs/configuration-glossary/configuration-target#the-target-property).
 
-### NuxtAppStack
+### NuxtServerAppStack ([`target=server`](https://nuxtjs.org/docs/features/deployment-targets))
 
-This is the main stack that is responsible for uploading all assets of the Nuxt app to AWS and to make it publicly reachable.
+This stack is responsible for deploying dynamic Nuxt apps (`target=server`) to AWS.
 The following AWS resources will be created by this stack:
 
-- [Lambda](https://aws.amazon.com/lambda/): A Lambda function to render the Nuxt app including a separated Lambda layer to provide the `node_modules` of the Nuxt app required for server-side rendering.
+- [Lambda](https://aws.amazon.com/lambda/): 
+  - A Lambda function to render the Nuxt app including a separated Lambda layer to provide the `node_modules` of the Nuxt app required for server-side rendering.
+  - A Lambda function that deletes the outdated static assets of the Nuxt app from S3.
 - [S3](https://aws.amazon.com/s3/): A bucket to store the client files of the Nuxt build (`.nuxt/dist/client`) and the custom static files of the Nuxt app (`static`) with optimized cache settings.
 - [Route53](https://aws.amazon.com/route53/): Two DNS records (`A` for IPv4 and `AAAA` for IPv6) in the configured hosted zone to make the Nuxt app available on the internet via the configured custom domain.
 - [API Gateway](https://aws.amazon.com/api-gateway/): An HTTP API to make the Nuxt Lambda function publicly available.
 - [CloudFront](https://aws.amazon.com/cloudfront/): A distribution to route incoming requests to the Nuxt Lambda function (via the API Gateway) and the S3 bucket to serve the static assets for the Nuxt app.
-- [EventBridge](https://aws.amazon.com/eventbridge/): A scheduled rule to ping the Nuxt app's Lambda function every 5 minutes in order to keep it warm and to speed up initial SSR requests.
+- [EventBridge](https://aws.amazon.com/eventbridge/): 
+  - A scheduled rule to ping the Nuxt app's Lambda function every 5 minutes in order to keep it warm and to speed up initial SSR requests.
+  - A scheduled rule to trigger the cleanup Lambda function for deleting the outdated static assets of the Nuxt app from S3 every tuesday at 03:30 AM GMT.
 
-### NuxtAppAssetsCleanupStack
+### NuxtStaticAppStack ([`target=static`](https://nuxtjs.org/docs/features/deployment-targets))
 
-This stack is responsible for deleting outdated static assets from the S3 deployment bucket created by the NuxtAppStack.
+This stack is responsible for deploying static Nuxt apps (`target=static`) to AWS.
 The following AWS resources will be created by this stack:
 
-- [Lambda](https://aws.amazon.com/lambda/): A Lambda function that deletes the outdated static assets of the Nuxt app from S3.
-- [EventBridge](https://aws.amazon.com/eventbridge/): A scheduled rule to trigger the stack's Lambda function every tuesday at 03:30 AM GMT.
+- [S3](https://aws.amazon.com/s3/): A bucket configured as website host to provide the files of the Nuxt build (`dist`) including the custom static files of the Nuxt app (`static`) with optimized cache settings.
+- [Route53](https://aws.amazon.com/route53/): Two DNS records (`A` for IPv4 and `AAAA` for IPv6) in the configured hosted zone to make the Nuxt app available on the internet via the configured custom domain.
+- [CloudFront](https://aws.amazon.com/cloudfront/): A distribution to route incoming requests to the S3 bucket to serve the Nuxt app.

package/index.d.ts

@@ -1,3 +1,2 @@
-export { AppStackProps } from "./lib/stack/app-stack-props";
-export { NuxtAppStack, NuxtAppStackProps } from "./lib/stack/nuxt-app-stack";
-export { NuxtAppAssetsCleanupStack, NuxtAppAssetsCleanupProps } from "./lib/stack/nuxt-app-assets-cleanup-stack";
+export { NuxtServerAppStack, NuxtServerAppStackProps } from "./lib/stack/server/nuxt-server-app-stack";
+export { NuxtStaticAppStack, NuxtStaticAppStackProps } from "./lib/stack/static/nuxt-static-app-stack";

package/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NuxtAppAssetsCleanupStack = exports.NuxtAppStack = void 0;
-var nuxt_app_stack_1 = require("./lib/stack/nuxt-app-stack");
-Object.defineProperty(exports, "NuxtAppStack", { enumerable: true, get: function () { return nuxt_app_stack_1.NuxtAppStack; } });
-var nuxt_app_assets_cleanup_stack_1 = require("./lib/stack/nuxt-app-assets-cleanup-stack");
-Object.defineProperty(exports, "NuxtAppAssetsCleanupStack", { enumerable: true, get: function () { return nuxt_app_assets_cleanup_stack_1.NuxtAppAssetsCleanupStack; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSw2REFBMEU7QUFBbEUsOEdBQUEsWUFBWSxPQUFBO0FBQ3BCLDJGQUE4RztBQUF0RywwSUFBQSx5QkFBeUIsT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7QXBwU3RhY2tQcm9wc30gZnJvbSBcIi4vbGliL3N0YWNrL2FwcC1zdGFjay1wcm9wc1wiXG5leHBvcnQge051eHRBcHBTdGFjaywgTnV4dEFwcFN0YWNrUHJvcHN9IGZyb20gXCIuL2xpYi9zdGFjay9udXh0LWFwcC1zdGFja1wiXG5leHBvcnQge051eHRBcHBBc3NldHNDbGVhbnVwU3RhY2ssIE51eHRBcHBBc3NldHNDbGVhbnVwUHJvcHN9IGZyb20gXCIuL2xpYi9zdGFjay9udXh0LWFwcC1hc3NldHMtY2xlYW51cC1zdGFja1wiIl19
+exports.NuxtStaticAppStack = exports.NuxtServerAppStack = void 0;
+var nuxt_server_app_stack_1 = require("./lib/stack/server/nuxt-server-app-stack");
+Object.defineProperty(exports, "NuxtServerAppStack", { enumerable: true, get: function () { return nuxt_server_app_stack_1.NuxtServerAppStack; } });
+var nuxt_static_app_stack_1 = require("./lib/stack/static/nuxt-static-app-stack");
+Object.defineProperty(exports, "NuxtStaticAppStack", { enumerable: true, get: function () { return nuxt_static_app_stack_1.NuxtStaticAppStack; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxrRkFBb0c7QUFBNUYsMkhBQUEsa0JBQWtCLE9BQUE7QUFDMUIsa0ZBQW9HO0FBQTVGLDJIQUFBLGtCQUFrQixPQUFBIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IHtOdXh0U2VydmVyQXBwU3RhY2ssIE51eHRTZXJ2ZXJBcHBTdGFja1Byb3BzfSBmcm9tIFwiLi9saWIvc3RhY2svc2VydmVyL251eHQtc2VydmVyLWFwcC1zdGFja1wiXG5leHBvcnQge051eHRTdGF0aWNBcHBTdGFjaywgTnV4dFN0YXRpY0FwcFN0YWNrUHJvcHN9IGZyb20gXCIuL2xpYi9zdGFjay9zdGF0aWMvbnV4dC1zdGF0aWMtYXBwLXN0YWNrXCJcbiJdfQ==

package/lib/cli/{deploy.js → deploy-server.js}

@@ -4,7 +4,7 @@ const shell = require("shelljs");
 const path = require("path");
 
 const logPrefix = 'CDK Nuxt Deployment';
-shell.echo(`${logPrefix}: Starting deployment...`);
+shell.echo(`${logPrefix}: Starting deployment for dynamic Nuxt app...`);
 
 const deploymentFolder = '.nuxt/cdk-deployment';
 const deploymentSourceFolder = `${deploymentFolder}/src`;

package/lib/cli/deploy-static.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+const shell = require("shelljs");
+
+const logPrefix = 'CDK Nuxt Deployment';
+shell.echo(`${logPrefix}: Starting deployment for static Nuxt app...`);
+
+// Refresh the cdk output folder to have a clean state and prevent persisting outdated outputs
+shell.echo(`${logPrefix}: Deleting outdated CDK files...`);
+shell.rm('-rf', 'cdk.out');
+
+// Run the deployment
+shell.echo(`${logPrefix}: Running deployment to AWS via CDK...`);
+if (shell.exec('yarn cdk deploy --require-approval never --all --app="yarn ts-node stack/index.ts" ' + process.argv.slice(2)).code !== 0) {
+    shell.echo(`${logPrefix} Error: CDK deployment failed.`);
+    shell.exit(1);
+}
+
+shell.echo(`${logPrefix}: CDK deployment successful.`);

package/lib/cli/init-server.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const shell = require("shelljs");
+const path = require("path");
+const fs = require("fs");
+
+const logPrefix = 'CDK Nuxt Init';
+
+shell.echo(`${logPrefix}: Initializing CDK stack index file for a dynamic Nuxt app...`);
+
+if (!fs.existsSync('stack')) {
+    shell.mkdir('-p', 'stack');
+    shell.cp(path.join(__dirname, '../templates/stack-index-server.ts'), 'stack/index.ts');
+    shell.echo(`${logPrefix}: CDK stack index file created. Please adapt the file at 'stack/index.ts' to the project's needs.`);
+} else {
+    shell.echo(`${logPrefix}: CDK stack folder already exists.`);
+}

package/lib/cli/{init.js → init-static.js}

@@ -6,11 +6,11 @@ const fs = require("fs");
 
 const logPrefix = 'CDK Nuxt Init';
 
-shell.echo(`${logPrefix}: Initializing CDK stack index file...`);
+shell.echo(`${logPrefix}: Initializing CDK stack index file for a static Nuxt app...`);
 
 if (!fs.existsSync('stack')) {
     shell.mkdir('-p', 'stack');
-    shell.cp(path.join(__dirname, '../templates/stack-index.ts'), 'stack/index.ts');
+    shell.cp(path.join(__dirname, '../templates/stack-index-static.ts'), 'stack/index.ts');
     shell.echo(`${logPrefix}: CDK stack index file created. Please adapt the file at 'stack/index.ts' to the project's needs.`);
 } else {
     shell.echo(`${logPrefix}: CDK stack folder already exists.`);

package/lib/functions/app/index.js

@@ -12,7 +12,7 @@ const app = nuxt.server.app;
 let serverlessExpressInstance = null;
 async function initNuxt(event, context) {
     await nuxt.ready();
-    serverlessExpressInstance = serverlessExpress({ app, eventSourceName: 'AWS_API_GATEWAY_V2' })
+    serverlessExpressInstance = serverlessExpress({ app })
 
     return serverlessExpressInstance(event, context)
 }

package/lib/stack/nuxt-app-stack-props.d.ts

@@ -0,0 +1,43 @@
+import { StackProps } from "aws-cdk-lib";
+import { NuxtConfig } from "./nuxt-config";
+/**
+ * Defines the common props required to deploy Nuxt apps on AWS.
+ */
+export interface NuxtAppStackProps extends StackProps {
+    /**
+     * A string identifier for the project the Nuxt app is part of.
+     * A project might have multiple different services.
+     */
+    readonly project: string;
+    /**
+     * A string identifier for the project's service the Nuxt app is created for.
+     * This can be seen as the name of the Nuxt app.
+     */
+    readonly service: string;
+    /**
+     * A string to identify the environment of the Nuxt app. This enables us
+     * to deploy multiple different environments of the same Nuxt app, e.g., production and development.
+     */
+    readonly environment: string;
+    /**
+     * The domain (without the protocol) at which the Nuxt app shall be publicly available.
+     * A DNS record will be automatically created in Route53 for the domain.
+     * This also supports subdomains.
+     * Examples: "example.com", "sub.example.com"
+     */
+    readonly domain: string;
+    /**
+     * The id of the hosted zone to create a DNS record for the specified domain.
+     */
+    readonly hostedZoneId: string;
+    /**
+     * The ARN of the certificate to use on CloudFront for the Nuxt app to make it accessible via HTTPS.
+     * The certificate must be issued for the specified domain in us-east-1 (global) regardless of the
+     * region specified via 'env.region' as CloudFront only works globally.
+     */
+    readonly globalTlsCertificateArn: string;
+    /**
+     * The nuxt.config.js of the Nuxt app.
+     */
+    readonly nuxtConfig: NuxtConfig;
+}

package/lib/stack/nuxt-app-stack-props.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnV4dC1hcHAtc3RhY2stcHJvcHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJudXh0LWFwcC1zdGFjay1wcm9wcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtTdGFja1Byb3BzfSBmcm9tIFwiYXdzLWNkay1saWJcIjtcbmltcG9ydCB7TnV4dENvbmZpZ30gZnJvbSBcIi4vbnV4dC1jb25maWdcIjtcblxuLyoqXG4gKiBEZWZpbmVzIHRoZSBjb21tb24gcHJvcHMgcmVxdWlyZWQgdG8gZGVwbG95IE51eHQgYXBwcyBvbiBBV1MuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTnV4dEFwcFN0YWNrUHJvcHMgZXh0ZW5kcyBTdGFja1Byb3BzIHtcblxuICAgIC8qKlxuICAgICAqIEEgc3RyaW5nIGlkZW50aWZpZXIgZm9yIHRoZSBwcm9qZWN0IHRoZSBOdXh0IGFwcCBpcyBwYXJ0IG9mLlxuICAgICAqIEEgcHJvamVjdCBtaWdodCBoYXZlIG11bHRpcGxlIGRpZmZlcmVudCBzZXJ2aWNlcy5cbiAgICAgKi9cbiAgICByZWFkb25seSBwcm9qZWN0OiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBBIHN0cmluZyBpZGVudGlmaWVyIGZvciB0aGUgcHJvamVjdCdzIHNlcnZpY2UgdGhlIE51eHQgYXBwIGlzIGNyZWF0ZWQgZm9yLlxuICAgICAqIFRoaXMgY2FuIGJlIHNlZW4gYXMgdGhlIG5hbWUgb2YgdGhlIE51eHQgYXBwLlxuICAgICAqL1xuICAgIHJlYWRvbmx5IHNlcnZpY2U6IHN0cmluZztcblxuICAgIC8qKlxuICAgICAqIEEgc3RyaW5nIHRvIGlkZW50aWZ5IHRoZSBlbnZpcm9ubWVudCBvZiB0aGUgTnV4dCBhcHAuIFRoaXMgZW5hYmxlcyB1c1xuICAgICAqIHRvIGRlcGxveSBtdWx0aXBsZSBkaWZmZXJlbnQgZW52aXJvbm1lbnRzIG9mIHRoZSBzYW1lIE51eHQgYXBwLCBlLmcuLCBwcm9kdWN0aW9uIGFuZCBkZXZlbG9wbWVudC5cbiAgICAgKi9cbiAgICByZWFkb25seSBlbnZpcm9ubWVudDogc3RyaW5nO1xuXG4gICAgLyoqXG4gICAgICogVGhlIGRvbWFpbiAod2l0aG91dCB0aGUgcHJvdG9jb2wpIGF0IHdoaWNoIHRoZSBOdXh0IGFwcCBzaGFsbCBiZSBwdWJsaWNseSBhdmFpbGFibGUuXG4gICAgICogQSBETlMgcmVjb3JkIHdpbGwgYmUgYXV0b21hdGljYWxseSBjcmVhdGVkIGluIFJvdXRlNTMgZm9yIHRoZSBkb21haW4uXG4gICAgICogVGhpcyBhbHNvIHN1cHBvcnRzIHN1YmRvbWFpbnMuXG4gICAgICogRXhhbXBsZXM6IFwiZXhhbXBsZS5jb21cIiwgXCJzdWIuZXhhbXBsZS5jb21cIlxuICAgICAqL1xuICAgIHJlYWRvbmx5IGRvbWFpbjogc3RyaW5nO1xuXG4gICAgLyoqXG4gICAgICogVGhlIGlkIG9mIHRoZSBob3N0ZWQgem9uZSB0byBjcmVhdGUgYSBETlMgcmVjb3JkIGZvciB0aGUgc3BlY2lmaWVkIGRvbWFpbi5cbiAgICAgKi9cbiAgICByZWFkb25seSBob3N0ZWRab25lSWQ6IHN0cmluZztcblxuICAgIC8qKlxuICAgICAqIFRoZSBBUk4gb2YgdGhlIGNlcnRpZmljYXRlIHRvIHVzZSBvbiBDbG91ZEZyb250IGZvciB0aGUgTnV4dCBhcHAgdG8gbWFrZSBpdCBhY2Nlc3NpYmxlIHZpYSBIVFRQUy5cbiAgICAgKiBUaGUgY2VydGlmaWNhdGUgbXVzdCBiZSBpc3N1ZWQgZm9yIHRoZSBzcGVjaWZpZWQgZG9tYWluIGluIHVzLWVhc3QtMSAoZ2xvYmFsKSByZWdhcmRsZXNzIG9mIHRoZVxuICAgICAqIHJlZ2lvbiBzcGVjaWZpZWQgdmlhICdlbnYucmVnaW9uJyBhcyBDbG91ZEZyb250IG9ubHkgd29ya3MgZ2xvYmFsbHkuXG4gICAgICovXG4gICAgcmVhZG9ubHkgZ2xvYmFsVGxzQ2VydGlmaWNhdGVBcm46IHN0cmluZztcblxuICAgIC8qKlxuICAgICAqIFRoZSBudXh0LmNvbmZpZy5qcyBvZiB0aGUgTnV4dCBhcHAuXG4gICAgICovXG4gICAgcmVhZG9ubHkgbnV4dENvbmZpZzogTnV4dENvbmZpZztcbn0iXX0=

package/lib/stack/nuxt-app-stack-props.ts

@@ -0,0 +1,51 @@
+import {StackProps} from "aws-cdk-lib";
+import {NuxtConfig} from "./nuxt-config";
+
+/**
+ * Defines the common props required to deploy Nuxt apps on AWS.
+ */
+export interface NuxtAppStackProps extends StackProps {
+
+    /**
+     * A string identifier for the project the Nuxt app is part of.
+     * A project might have multiple different services.
+     */
+    readonly project: string;
+
+    /**
+     * A string identifier for the project's service the Nuxt app is created for.
+     * This can be seen as the name of the Nuxt app.
+     */
+    readonly service: string;
+
+    /**
+     * A string to identify the environment of the Nuxt app. This enables us
+     * to deploy multiple different environments of the same Nuxt app, e.g., production and development.
+     */
+    readonly environment: string;
+
+    /**
+     * The domain (without the protocol) at which the Nuxt app shall be publicly available.
+     * A DNS record will be automatically created in Route53 for the domain.
+     * This also supports subdomains.
+     * Examples: "example.com", "sub.example.com"
+     */
+    readonly domain: string;
+
+    /**
+     * The id of the hosted zone to create a DNS record for the specified domain.
+     */
+    readonly hostedZoneId: string;
+
+    /**
+     * The ARN of the certificate to use on CloudFront for the Nuxt app to make it accessible via HTTPS.
+     * The certificate must be issued for the specified domain in us-east-1 (global) regardless of the
+     * region specified via 'env.region' as CloudFront only works globally.
+     */
+    readonly globalTlsCertificateArn: string;
+
+    /**
+     * The nuxt.config.js of the Nuxt app.
+     */
+    readonly nuxtConfig: NuxtConfig;
+}

package/lib/stack/nuxt-app-static-assets.d.ts

@@ -22,9 +22,12 @@ export interface StaticAssetConfig {
      * The cache settings to use for the uploaded source files when accessing them on the target path with the specified pattern.
      */
     cacheControl?: CacheControl[];
+    /**
+     * Whether to invalidate the files matching the config's pattern in the distribution's edge caches after the files are uploaded to the destination bucket.
+     */
+    invalidateOnChange?: boolean;
 }
 /**
  * Retrieves the static assets of the Nuxt app that shall be publicly available.
- * These should match the files in '.nuxt/dist/client' and 'static'.
  */
 export declare const getNuxtAppStaticAssetConfigs: (nuxtConfig: NuxtConfig) => StaticAssetConfig[];