cdk-nuxt 2.12.0 → 2.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +42 -12
  2. package/package.json +12 -10
package/README.md CHANGED
@@ -46,31 +46,61 @@ Notes:
46
46
 
47
47
  ## Installation
48
48
 
49
- Install the package and its required dependencies (choose your package manager):
49
+ This library ships compiled JS and small CLI helpers. To use it in your CDK app, install the following in your project.
50
+
51
+ Required peer dependencies (must be installed in your project):
52
+ - aws-cdk-lib ^2.214.0
53
+ - constructs ^10.4.2
54
+
55
+ Optional peer dependency (only if you use Access Logs Analysis features):
56
+ - @aws-cdk/aws-glue-alpha 2.214.0-alpha.0
57
+
58
+ The package itself:
59
+ - cdk-nuxt (usually as a devDependency in your infrastructure repo)
60
+
61
+ Dev-time tools for TypeScript CDK apps (not required at runtime of this package):
62
+ - typescript and ts-node
63
+ - AWS CDK CLI (aws-cdk) is optional; you can also use `npx cdk`.
64
+
65
+ Choose your package manager:
50
66
 
51
67
  Using pnpm:
52
68
  ```bash
53
- pnpm add -D cdk-nuxt # The package itself
54
- pnpm add -D ts-node typescript # To compile the CDK stacks via TypeScript
55
- pnpm add -D aws-cdk@^2.214.0 # Optional: CDK CLI for the deployment (recommended range)
69
+ pnpm add -D cdk-nuxt aws-cdk-lib@^2.214.0 constructs@^10.4.2
70
+ # Optional (only if you enable Access Logs Analysis):
71
+ pnpm add -D @aws-cdk/aws-glue-alpha@2.214.0-alpha.0
72
+ # If your CDK app is written in TypeScript:
73
+ pnpm add -D typescript ts-node
74
+ # Optional convenience:
75
+ pnpm add -D aws-cdk@^2.214.0
56
76
  ```
57
77
 
58
78
  Using npm:
59
79
  ```bash
60
- npm install --save-dev cdk-nuxt # The package itself
61
- npm install --save-dev ts-node typescript # To compile the CDK stacks via TypeScript
62
- npm install --save-dev aws-cdk@^2.214.0 # Optional: CDK CLI for the deployment (recommended range)
80
+ npm install --save-dev cdk-nuxt aws-cdk-lib@^2.214.0 constructs@^10.4.2
81
+ # Optional (only if you enable Access Logs Analysis):
82
+ npm install --save-dev @aws-cdk/aws-glue-alpha@2.214.0-alpha.0
83
+ # If your CDK app is written in TypeScript:
84
+ npm install --save-dev typescript ts-node
85
+ # Optional convenience:
86
+ npm install --save-dev aws-cdk@^2.214.0
63
87
  ```
64
88
 
65
89
  Using Yarn:
66
90
  ```bash
67
- yarn add -D cdk-nuxt # The package itself
68
- yarn add -D ts-node typescript # To compile the CDK stacks via TypeScript
69
- yarn add -D aws-cdk@^2.214.0 # Optional: CDK CLI for the deployment (recommended range)
91
+ yarn add -D cdk-nuxt aws-cdk-lib@^2.214.0 constructs@^10.4.2
92
+ # Optional (only if you enable Access Logs Analysis):
93
+ yarn add -D @aws-cdk/aws-glue-alpha@2.214.0-alpha.0
94
+ # If your CDK app is written in TypeScript:
95
+ yarn add -D typescript ts-node
96
+ # Optional convenience:
97
+ yarn add -D aws-cdk@^2.214.0
70
98
  ```
71
99
 
72
- Note: Installing the AWS CDK CLI (aws-cdk) as a devDependency is optional. You can also invoke the CLI via npx (e.g., `npx cdk ...`). Ensure you are using CDK v2.
73
- This package targets aws-cdk-lib 2.214.x; for best compatibility, keep your project's aws-cdk-lib within the 2.214.x range as well.
100
+ Notes:
101
+ - aws-cdk-lib and constructs are declared as peerDependencies to avoid duplicate installations and version skew with your application's CDK setup.
102
+ - If you don’t use Access Logs Analysis, you don’t need @aws-cdk/aws-glue-alpha.
103
+ - This package targets aws-cdk-lib 2.214.x; keep your project's aws-cdk-lib within the 2.214.x range for the best compatibility.
74
104
 
75
105
  ## Setup
76
106
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cdk-nuxt",
3
- "version": "2.12.0",
3
+ "version": "2.12.2",
4
4
  "license": "MIT",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,28 +17,30 @@
17
17
  "types": "index.d.ts",
18
18
  "bin": {
19
19
  "cdk-nuxt-init-server": "lib/cli/init-server.js",
20
- "cdk-nuxt-init-static": "lib/cli/init-static.js",
21
20
  "cdk-nuxt-deploy-server": "lib/cli/deploy-server.js",
22
- "cdk-nuxt-destroy-server": "lib/cli/destroy-server.js",
23
- "cdk-nuxt-deploy-static": "lib/cli/deploy-static.js"
21
+ "cdk-nuxt-destroy-server": "lib/cli/destroy-server.js"
24
22
  },
25
23
  "devDependencies": {
26
24
  "@types/node": "^20.10",
27
25
  "changelogen": "^0.6.2",
28
26
  "ts-node": "^10.9.2",
29
- "typescript": "^5.6.3"
27
+ "typescript": "^5.6.3",
28
+ "aws-cdk-lib": "^2.214.0",
29
+ "constructs": "^10.4.2",
30
+ "@aws-cdk/aws-glue-alpha": "2.214.0-alpha.0"
30
31
  },
31
32
  "dependencies": {
32
- "@aws-cdk/aws-glue-alpha": "2.214.0-alpha.0",
33
- "aws-cdk-lib": "2.214.0",
34
- "constructs": "^10.4.2",
35
33
  "shelljs": "^0.10.0"
36
34
  },
37
35
  "peerDependencies": {
38
36
  "aws-cdk-lib": "^2.214.0",
39
37
  "constructs": "^10.4.2",
40
- "ts-node": "^10.9.2",
41
- "typescript": "^5.6.3"
38
+ "@aws-cdk/aws-glue-alpha": "2.214.0-alpha.0"
39
+ },
40
+ "peerDependenciesMeta": {
41
+ "@aws-cdk/aws-glue-alpha": {
42
+ "optional": true
43
+ }
42
44
  },
43
45
  "scripts": {
44
46
  "build": "tsc",