@codedazur/cdk-next-app 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @codedazur/cdk-next-app
 
+## 0.2.2
+
+### Patch Changes
+
+- [`17d19aea004254b214364caef8fa02f9a6019f8f`](https://github.com/codedazur/toolkit/commit/17d19aea004254b214364caef8fa02f9a6019f8f) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - The version of the DockerCluster dependency is now explicit.
+
+- Updated dependencies [[`17d19aea004254b214364caef8fa02f9a6019f8f`](https://github.com/codedazur/toolkit/commit/17d19aea004254b214364caef8fa02f9a6019f8f)]:
+  - @codedazur/cdk-docker-cluster@0.4.0
+
+## 0.2.1
+
+### Patch Changes
+
+- [`4aad27259400d8c8c4fd6825ee20ef970b6ad718`](https://github.com/codedazur/toolkit/commit/4aad27259400d8c8c4fd6825ee20ef970b6ad718) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - The construct name was corrected.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -2,14 +2,60 @@
 
 The NextApp CDK construct deploys a standalone Next.js build to a load balanced Fargate service on AWS.
 
+It automatically mounts the `~/.npmrc` file as a build secret for installation of private NPM packages.
+
+## Prerequisites
+
+### Next.js Configuration
+
+Your `next.config.js` file needs to be configured for standalone output.
+
+```js
+// next.config.js
+// ...
+const nextConfig = {
+  // ...
+  output: "standalone",
+}
+// ...
+```
+
+### Docker
+
+In order to use this construct, your Next.js application needs to be configure for Docker deployments. See the [official documentation](https://nextjs.org/docs/pages/building-your-application/deploying#docker-image) for more information.
+
 ## Example
 
+### Standard Repository
+
+For a non-monorepo build, simply provide the path to the directory that contains your Dockerfile.
+
 ```ts
-new NextApp(this, "Next", {
-  path: "../next", // Must contain a Dockerfile.
+new NextApp(this, "NextApp", {
+  path: "../next",
 });
 ```
 
-## Docker
+### Monorepo
 
-In order to use this construct, your Next.js application needs to be configure for Docker deployments. See the [official documentation](https://nextjs.org/docs/pages/building-your-application/deploying#docker-image) for more information.
+For monorepo builds, set the build context to the root of your monorepo, and provide the path to your Next.js module's Dockerfile.
+
+```ts
+new NextApp(this, "NextApp", {
+  path: "../../",
+  file: "apps/next/Dockerfile",
+});
+```
+
+### Scaling
+
+The NextApp is based on the [DockerCluster](https://github.com/codedazur/toolkit/tree/main/packages/cdk-docker-cluster) construct and supports all of its features for horizontal and vertical scaling.
+
+```ts
+new NextApp(this, "NextApp", {
+  // ...
+  cpu: 1024,
+  memory: 4096,
+  tasks: { min: 1, max: 10 },
+});
+```

package/dist/index.d.mts

@@ -1,14 +1,14 @@
 import { DockerClusterProps, DockerCluster } from '@codedazur/cdk-docker-cluster';
 import { Construct } from 'constructs';
 
-interface NextDockerClusterProps extends DockerClusterProps {
+interface NextAppProps extends DockerClusterProps {
 }
 /**
  * A docker cluster preconfigured for running a Next.js application with support
  * for private NPM packages using a build-time secret.
  */
-declare class NextDockerCluster extends DockerCluster {
-    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextDockerClusterProps);
+declare class NextApp extends DockerCluster {
+    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextAppProps);
 }
 
-export { NextDockerCluster, NextDockerClusterProps };
+export { NextApp, NextAppProps };

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import { DockerClusterProps, DockerCluster } from '@codedazur/cdk-docker-cluster';
 import { Construct } from 'constructs';
 
-interface NextDockerClusterProps extends DockerClusterProps {
+interface NextAppProps extends DockerClusterProps {
 }
 /**
  * A docker cluster preconfigured for running a Next.js application with support
  * for private NPM packages using a build-time secret.
  */
-declare class NextDockerCluster extends DockerCluster {
-    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextDockerClusterProps);
+declare class NextApp extends DockerCluster {
+    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextAppProps);
 }
 
-export { NextDockerCluster, NextDockerClusterProps };
+export { NextApp, NextAppProps };

package/dist/index.js

@@ -30,7 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  NextDockerCluster: () => NextDockerCluster
+  NextApp: () => NextApp
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -39,7 +39,7 @@ var import_os = __toESM(require("os"));
 var import_path = __toESM(require("path"));
 var import_cdk_docker_cluster = require("@codedazur/cdk-docker-cluster");
 var import_aws_cdk_lib = require("aws-cdk-lib");
-var NextDockerCluster = class extends import_cdk_docker_cluster.DockerCluster {
+var NextApp = class extends import_cdk_docker_cluster.DockerCluster {
   constructor(scope, id, { port = 3e3, secrets, ...props }) {
     super(scope, id, {
       port,
@@ -53,5 +53,5 @@ var NextDockerCluster = class extends import_cdk_docker_cluster.DockerCluster {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  NextDockerCluster
+  NextApp
 });

package/dist/index.mjs

@@ -5,7 +5,7 @@ import {
   DockerCluster
 } from "@codedazur/cdk-docker-cluster";
 import { DockerBuildSecret } from "aws-cdk-lib";
-var NextDockerCluster = class extends DockerCluster {
+var NextApp = class extends DockerCluster {
   constructor(scope, id, { port = 3e3, secrets, ...props }) {
     super(scope, id, {
       port,
@@ -18,5 +18,5 @@ var NextDockerCluster = class extends DockerCluster {
   }
 };
 export {
-  NextDockerCluster
+  NextApp
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codedazur/cdk-next-app",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "main": ".dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -23,7 +23,7 @@
     "test": "vitest run --passWithNoTests"
   },
   "dependencies": {
-    "@codedazur/cdk-docker-cluster": "*"
+    "@codedazur/cdk-docker-cluster": "^0.4.0"
   },
   "peerDependencies": {
     "aws-cdk-lib": ">=2",
@@ -32,8 +32,8 @@
   "devDependencies": {
     "@codedazur/eslint-config": "*",
     "@codedazur/tsconfig": "*",
-    "@types/node": "^20.12.8",
-    "aws-cdk-lib": "^2.139.1",
+    "@types/node": "^20.14.2",
+    "aws-cdk-lib": "^2.145.0",
     "constructs": "^10.3.0",
     "esbuild": "^0.20.2",
     "eslint": "^8.30.0",