@codedazur/cdk-next-app 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @codedazur/cdk-next-app
 
+## 0.2.3
+
+### Patch Changes
+
+- [`17034ee`](https://github.com/codedazur/toolkit/commit/17034ee5fcbc026fc779a12130572d515d2b8298) Thanks [@thijsdaniels](https://github.com/thijsdaniels)! - Dependency versions were made explicit.
+
+- Updated dependencies [[`d1f3d51`](https://github.com/codedazur/toolkit/commit/d1f3d512d31d659ffdc115147d9631057fe8d073), [`17034ee`](https://github.com/codedazur/toolkit/commit/17034ee5fcbc026fc779a12130572d515d2b8298), [`737fe0d`](https://github.com/codedazur/toolkit/commit/737fe0ddd4d353db1e005d2dab886a4a60bc02d8)]:
+  - @codedazur/cdk-docker-cluster@0.5.0
+
+## 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

package/README.md

@@ -2,15 +2,37 @@
 
 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 configured 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-mnonorepo build, simply provide the path to the directory that contains your Dockerfile.
+For a non-monorepo build, simply provide the path to the directory that contains your Dockerfile.
 
 ```ts
 new NextApp(this, "NextApp", {
-  path: "../next",
+  source: "../next",
 });
 ```
 
@@ -20,24 +42,54 @@ For monorepo builds, set the build context to the root of your monorepo, and pro
 
 ```ts
 new NextApp(this, "NextApp", {
-  path: "../../",
-  file: "apps/next/Dockerfile",
+  source: {
+    directory: "../../",
+    file: "apps/next/Dockerfile",
+  },
+});
+```
+
+### Arguments and Secrets
+
+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 related to Docker's build arguments and secrets.
+
+These arguments and secrets need to be handled appropriately by your Dockerfile in order for them to have any effect.
+
+```ts
+import { DockerBuildSecret } from "aws-cdk-lib";
+
+new NextApp(this, "NextApp", {
+  source: {
+    // ...
+    arguments: {
+      MY_BUILD_ARGUMENT: process.env.MY_BUILD_ARGUMENT,
+    },
+    secrets: {
+      myBuildSecret: new DockerBuildSecret.fromEnvironment("MY_BUILD_SECRET"),
+    },
+  },
 });
 ```
 
 ### 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.
+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 vertical scaling and horizontal (auto-)scaling.
 
 ```ts
 new NextApp(this, "NextApp", {
-  ...
+  // ...
   cpu: 1024,
   memory: 4096,
-  tasks: { min: 1, max: 10 },
+  tasks: 3,
 });
 ```
 
-## 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.
+```ts
+new NextApp(this, "NextApp", {
+  // ...
+  tasks: {
+    minimum: 1,
+    maximum: 5,
+  },
+});
+```

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { DockerClusterProps, DockerCluster } from '@codedazur/cdk-docker-cluster';
+import { ContainerImage } from 'aws-cdk-lib/aws-ecs';
 import { Construct } from 'constructs';
 
 interface NextAppProps extends DockerClusterProps {
@@ -8,7 +9,16 @@ interface NextAppProps extends DockerClusterProps {
  * for private NPM packages using a build-time secret.
  */
 declare class NextApp extends DockerCluster {
-    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextAppProps);
+    constructor(scope: Construct, id: string, { port, source, ...props }: NextAppProps);
+    protected static withNpmSecret(source: NextAppProps["source"]): ContainerImage | {
+        secrets: {
+            npmrc: string;
+        };
+        directory: string;
+        exclude?: string[];
+        file?: string;
+        arguments?: Record<string, string>;
+    };
 }
 
-export { NextApp, NextAppProps };
+export { NextApp, type NextAppProps };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { DockerClusterProps, DockerCluster } from '@codedazur/cdk-docker-cluster';
+import { ContainerImage } from 'aws-cdk-lib/aws-ecs';
 import { Construct } from 'constructs';
 
 interface NextAppProps extends DockerClusterProps {
@@ -8,7 +9,16 @@ interface NextAppProps extends DockerClusterProps {
  * for private NPM packages using a build-time secret.
  */
 declare class NextApp extends DockerCluster {
-    constructor(scope: Construct, id: string, { port, secrets, ...props }: NextAppProps);
+    constructor(scope: Construct, id: string, { port, source, ...props }: NextAppProps);
+    protected static withNpmSecret(source: NextAppProps["source"]): ContainerImage | {
+        secrets: {
+            npmrc: string;
+        };
+        directory: string;
+        exclude?: string[];
+        file?: string;
+        arguments?: Record<string, string>;
+    };
 }
 
-export { NextApp, NextAppProps };
+export { NextApp, type NextAppProps };

package/dist/index.js

@@ -39,17 +39,35 @@ 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 NextApp = class extends import_cdk_docker_cluster.DockerCluster {
-  constructor(scope, id, { port = 3e3, secrets, ...props }) {
+var import_aws_ecs = require("aws-cdk-lib/aws-ecs");
+var NextApp = class _NextApp extends import_cdk_docker_cluster.DockerCluster {
+  constructor(scope, id, { port = 3e3, source, ...props }) {
     super(scope, id, {
       port,
-      secrets: {
-        npmrc: import_aws_cdk_lib.DockerBuildSecret.fromSrc(import_path.default.join(import_os.default.homedir(), "/.npmrc")),
-        ...secrets
-      },
+      source: _NextApp.withNpmSecret(source),
       ...props
     });
   }
+  static withNpmSecret(source) {
+    if (source instanceof import_aws_ecs.ContainerImage) {
+      return source;
+    }
+    if (typeof source === "string") {
+      return {
+        directory: source,
+        secrets: {
+          npmrc: import_aws_cdk_lib.DockerBuildSecret.fromSrc(import_path.default.join(import_os.default.homedir(), "/.npmrc"))
+        }
+      };
+    }
+    return {
+      ...source,
+      secrets: {
+        npmrc: import_aws_cdk_lib.DockerBuildSecret.fromSrc(import_path.default.join(import_os.default.homedir(), "/.npmrc")),
+        ...source.secrets
+      }
+    };
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -5,17 +5,35 @@ import {
   DockerCluster
 } from "@codedazur/cdk-docker-cluster";
 import { DockerBuildSecret } from "aws-cdk-lib";
-var NextApp = class extends DockerCluster {
-  constructor(scope, id, { port = 3e3, secrets, ...props }) {
+import { ContainerImage } from "aws-cdk-lib/aws-ecs";
+var NextApp = class _NextApp extends DockerCluster {
+  constructor(scope, id, { port = 3e3, source, ...props }) {
     super(scope, id, {
       port,
-      secrets: {
-        npmrc: DockerBuildSecret.fromSrc(path.join(os.homedir(), "/.npmrc")),
-        ...secrets
-      },
+      source: _NextApp.withNpmSecret(source),
       ...props
     });
   }
+  static withNpmSecret(source) {
+    if (source instanceof ContainerImage) {
+      return source;
+    }
+    if (typeof source === "string") {
+      return {
+        directory: source,
+        secrets: {
+          npmrc: DockerBuildSecret.fromSrc(path.join(os.homedir(), "/.npmrc"))
+        }
+      };
+    }
+    return {
+      ...source,
+      secrets: {
+        npmrc: DockerBuildSecret.fromSrc(path.join(os.homedir(), "/.npmrc")),
+        ...source.secrets
+      }
+    };
+  }
 };
 export {
   NextApp

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codedazur/cdk-next-app",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "main": ".dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -22,21 +22,17 @@
     "types": "tsc --noEmit",
     "test": "vitest run --passWithNoTests"
   },
-  "dependencies": {
-    "@codedazur/cdk-docker-cluster": "*"
-  },
   "peerDependencies": {
     "aws-cdk-lib": ">=2",
     "constructs": ">=10"
   },
+  "dependencies": {
+    "@codedazur/cdk-docker-cluster": "^0.5.0"
+  },
   "devDependencies": {
-    "@codedazur/eslint-config": "*",
-    "@codedazur/tsconfig": "*",
-    "@types/node": "^20.14.2",
-    "aws-cdk-lib": "^2.145.0",
+    "@types/node": "^20.14.9",
+    "aws-cdk-lib": "^2.147.2",
     "constructs": "^10.3.0",
-    "esbuild": "^0.20.2",
-    "eslint": "^8.30.0",
-    "typescript": "^5.4.5"
+    "esbuild": "^0.21.5"
   }
 }

package/tsconfig.json

@@ -1,5 +1,3 @@
 {
-  "extends": "@codedazur/tsconfig/cdk.json",
-  "include": ["."],
-  "exclude": ["dist", "build", "node_modules"]
+  "extends": "@codedazur/tsconfig/cdk.json"
 }