@incloodsolutions/devkit 0.0.3 → 0.0.5
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.
- package/README.md +180 -41
- package/dist/{aws/cdk/constructs/api-gateway-v2-construct.cjs → aws-cdk/constructs/api-gateway-v2.cjs} +2 -2
- package/dist/aws-cdk/constructs/api-gateway-v2.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/api-gateway-v2-construct.d.ts → aws-cdk/constructs/api-gateway-v2.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-v2-construct.d.cts → aws-cdk/constructs/api-gateway-v2.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-v2-construct.js → aws-cdk/constructs/api-gateway-v2.js} +2 -2
- package/dist/aws-cdk/constructs/api-gateway-v2.js.map +1 -0
- package/dist/{aws/cdk/constructs/api-gateway-websocket-construct.cjs → aws-cdk/constructs/api-gateway-websocket.cjs} +18 -6
- package/dist/aws-cdk/constructs/api-gateway-websocket.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/api-gateway-websocket-construct.d.ts → aws-cdk/constructs/api-gateway-websocket.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-websocket-construct.d.cts → aws-cdk/constructs/api-gateway-websocket.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-websocket-construct.js → aws-cdk/constructs/api-gateway-websocket.js} +18 -6
- package/dist/aws-cdk/constructs/api-gateway-websocket.js.map +1 -0
- package/dist/{aws/cdk/constructs/api-gateway-construct.cjs → aws-cdk/constructs/api-gateway.cjs} +6 -3
- package/dist/aws-cdk/constructs/api-gateway.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/api-gateway-construct.d.ts → aws-cdk/constructs/api-gateway.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-construct.d.cts → aws-cdk/constructs/api-gateway.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/api-gateway-construct.js → aws-cdk/constructs/api-gateway.js} +6 -3
- package/dist/aws-cdk/constructs/api-gateway.js.map +1 -0
- package/dist/{aws/cdk/constructs/cloudfront-construct.cjs → aws-cdk/constructs/cloudfront.cjs} +2 -2
- package/dist/aws-cdk/constructs/cloudfront.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/cloudfront-construct.d.ts → aws-cdk/constructs/cloudfront.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/cloudfront-construct.d.cts → aws-cdk/constructs/cloudfront.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/cloudfront-construct.js → aws-cdk/constructs/cloudfront.js} +2 -2
- package/dist/aws-cdk/constructs/cloudfront.js.map +1 -0
- package/dist/{aws/cdk/constructs/cloudwatch-construct.cjs → aws-cdk/constructs/cloudwatch.cjs} +2 -2
- package/dist/aws-cdk/constructs/cloudwatch.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/cloudwatch-construct.d.ts → aws-cdk/constructs/cloudwatch.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/cloudwatch-construct.d.cts → aws-cdk/constructs/cloudwatch.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/cloudwatch-construct.js → aws-cdk/constructs/cloudwatch.js} +2 -2
- package/dist/aws-cdk/constructs/cloudwatch.js.map +1 -0
- package/dist/{aws/cdk/constructs/dynamo-db-construct.cjs → aws-cdk/constructs/dynamo-db.cjs} +2 -2
- package/dist/aws-cdk/constructs/dynamo-db.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/dynamo-db-construct.d.ts → aws-cdk/constructs/dynamo-db.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/dynamo-db-construct.d.cts → aws-cdk/constructs/dynamo-db.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/dynamo-db-construct.js → aws-cdk/constructs/dynamo-db.js} +2 -2
- package/dist/aws-cdk/constructs/dynamo-db.js.map +1 -0
- package/dist/{aws/cdk/constructs/event-bridge-construct.cjs → aws-cdk/constructs/event-bridge.cjs} +2 -2
- package/dist/aws-cdk/constructs/event-bridge.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/event-bridge-construct.d.ts → aws-cdk/constructs/event-bridge.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/event-bridge-construct.d.cts → aws-cdk/constructs/event-bridge.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/event-bridge-construct.js → aws-cdk/constructs/event-bridge.js} +2 -2
- package/dist/aws-cdk/constructs/event-bridge.js.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-authorizer-v2-construct.cjs → aws-cdk/constructs/lambda-authorizer-v2.cjs} +6 -3
- package/dist/aws-cdk/constructs/lambda-authorizer-v2.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-authorizer-v2-construct.d.ts → aws-cdk/constructs/lambda-authorizer-v2.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-authorizer-v2-construct.d.cts → aws-cdk/constructs/lambda-authorizer-v2.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-authorizer-v2-construct.js → aws-cdk/constructs/lambda-authorizer-v2.js} +6 -3
- package/dist/aws-cdk/constructs/lambda-authorizer-v2.js.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-authorizer-construct.cjs → aws-cdk/constructs/lambda-authorizer.cjs} +2 -2
- package/dist/aws-cdk/constructs/lambda-authorizer.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-authorizer-construct.d.cts → aws-cdk/constructs/lambda-authorizer.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-authorizer-construct.d.ts → aws-cdk/constructs/lambda-authorizer.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-authorizer-construct.js → aws-cdk/constructs/lambda-authorizer.js} +2 -2
- package/dist/aws-cdk/constructs/lambda-authorizer.js.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-layer-construct.cjs → aws-cdk/constructs/lambda-layer.cjs} +3 -6
- package/dist/aws-cdk/constructs/lambda-layer.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-layer-construct.d.ts → aws-cdk/constructs/lambda-layer.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-layer-construct.d.cts → aws-cdk/constructs/lambda-layer.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-layer-construct.js → aws-cdk/constructs/lambda-layer.js} +3 -6
- package/dist/aws-cdk/constructs/lambda-layer.js.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-construct.cjs → aws-cdk/constructs/lambda.cjs} +4 -4
- package/dist/aws-cdk/constructs/lambda.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/lambda-construct.d.ts → aws-cdk/constructs/lambda.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-construct.d.cts → aws-cdk/constructs/lambda.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/lambda-construct.js → aws-cdk/constructs/lambda.js} +4 -4
- package/dist/aws-cdk/constructs/lambda.js.map +1 -0
- package/dist/{aws/cdk/constructs/role-policy-construct.cjs → aws-cdk/constructs/role-policy.cjs} +2 -2
- package/dist/aws-cdk/constructs/role-policy.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/role-policy-construct.d.ts → aws-cdk/constructs/role-policy.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/role-policy-construct.d.cts → aws-cdk/constructs/role-policy.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/role-policy-construct.js → aws-cdk/constructs/role-policy.js} +2 -2
- package/dist/aws-cdk/constructs/role-policy.js.map +1 -0
- package/dist/aws-cdk/constructs/route53.cjs +79 -0
- package/dist/aws-cdk/constructs/route53.cjs.map +1 -0
- package/dist/aws-cdk/constructs/route53.d.cts +95 -0
- package/dist/aws-cdk/constructs/route53.d.ts +95 -0
- package/dist/aws-cdk/constructs/route53.js +77 -0
- package/dist/aws-cdk/constructs/route53.js.map +1 -0
- package/dist/{aws/cdk/constructs/s3-deployment-construct.cjs → aws-cdk/constructs/s3-deployment.cjs} +20 -11
- package/dist/aws-cdk/constructs/s3-deployment.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/s3-deployment-construct.d.ts → aws-cdk/constructs/s3-deployment.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/s3-deployment-construct.d.cts → aws-cdk/constructs/s3-deployment.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/s3-deployment-construct.js → aws-cdk/constructs/s3-deployment.js} +20 -11
- package/dist/aws-cdk/constructs/s3-deployment.js.map +1 -0
- package/dist/{aws/cdk/constructs/s3-construct.cjs → aws-cdk/constructs/s3.cjs} +2 -2
- package/dist/aws-cdk/constructs/s3.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/s3-construct.d.ts → aws-cdk/constructs/s3.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/s3-construct.d.cts → aws-cdk/constructs/s3.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/s3-construct.js → aws-cdk/constructs/s3.js} +2 -2
- package/dist/aws-cdk/constructs/s3.js.map +1 -0
- package/dist/{aws/cdk/constructs/sns-construct.cjs → aws-cdk/constructs/sns.cjs} +2 -2
- package/dist/aws-cdk/constructs/sns.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/sns-construct.d.ts → aws-cdk/constructs/sns.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/sns-construct.d.cts → aws-cdk/constructs/sns.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/sns-construct.js → aws-cdk/constructs/sns.js} +2 -2
- package/dist/aws-cdk/constructs/sns.js.map +1 -0
- package/dist/{aws/cdk/constructs/sqs-construct.cjs → aws-cdk/constructs/sqs.cjs} +2 -2
- package/dist/aws-cdk/constructs/sqs.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/sqs-construct.d.ts → aws-cdk/constructs/sqs.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/sqs-construct.d.cts → aws-cdk/constructs/sqs.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/sqs-construct.js → aws-cdk/constructs/sqs.js} +2 -2
- package/dist/aws-cdk/constructs/sqs.js.map +1 -0
- package/dist/{aws/cdk/constructs/vpc-construct.cjs → aws-cdk/constructs/vpc.cjs} +2 -2
- package/dist/aws-cdk/constructs/vpc.cjs.map +1 -0
- package/dist/{aws/cdk/constructs/vpc-construct.d.ts → aws-cdk/constructs/vpc.d.cts} +2 -1
- package/dist/{aws/cdk/constructs/vpc-construct.d.cts → aws-cdk/constructs/vpc.d.ts} +2 -1
- package/dist/{aws/cdk/constructs/vpc-construct.js → aws-cdk/constructs/vpc.js} +2 -2
- package/dist/aws-cdk/constructs/vpc.js.map +1 -0
- package/dist/aws-cdk/stacks/lambda-api.cjs +252 -0
- package/dist/aws-cdk/stacks/lambda-api.cjs.map +1 -0
- package/dist/aws-cdk/stacks/lambda-api.d.cts +16 -0
- package/dist/aws-cdk/stacks/lambda-api.d.ts +16 -0
- package/dist/aws-cdk/stacks/lambda-api.js +250 -0
- package/dist/aws-cdk/stacks/lambda-api.js.map +1 -0
- package/dist/aws-cdk/stacks/lambda-sns.cjs +211 -0
- package/dist/aws-cdk/stacks/lambda-sns.cjs.map +1 -0
- package/dist/aws-cdk/stacks/lambda-sns.d.cts +17 -0
- package/dist/aws-cdk/stacks/lambda-sns.d.ts +17 -0
- package/dist/aws-cdk/stacks/lambda-sns.js +209 -0
- package/dist/aws-cdk/stacks/lambda-sns.js.map +1 -0
- package/dist/aws-cdk/stacks/lambda-sqs.cjs +220 -0
- package/dist/aws-cdk/stacks/lambda-sqs.cjs.map +1 -0
- package/dist/aws-cdk/stacks/lambda-sqs.d.cts +18 -0
- package/dist/aws-cdk/stacks/lambda-sqs.d.ts +18 -0
- package/dist/aws-cdk/stacks/lambda-sqs.js +218 -0
- package/dist/aws-cdk/stacks/lambda-sqs.js.map +1 -0
- package/dist/aws-types.cjs +4 -0
- package/dist/aws-types.cjs.map +1 -0
- package/dist/aws-types.d.cts +55 -0
- package/dist/aws-types.d.ts +55 -0
- package/dist/aws-types.js +3 -0
- package/dist/aws-types.js.map +1 -0
- package/dist/{aws/cdk/constructs/index.cjs → aws.cjs} +244 -23
- package/dist/aws.cjs.map +1 -0
- package/dist/aws.d.cts +40 -0
- package/dist/aws.d.ts +40 -0
- package/dist/{aws/index.js → aws.js} +243 -26
- package/dist/aws.js.map +1 -0
- package/dist/index.cjs +242 -21
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +24 -18
- package/dist/index.d.ts +24 -18
- package/dist/index.js +241 -24
- package/dist/index.js.map +1 -1
- package/package.json +160 -25
- package/dist/aws/cdk/constructs/api-gateway-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/api-gateway-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/api-gateway-v2-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/api-gateway-v2-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/api-gateway-websocket-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/api-gateway-websocket-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/cloudfront-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/cloudfront-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/cloudwatch-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/cloudwatch-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/dynamo-db-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/dynamo-db-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/event-bridge-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/event-bridge-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/index.cjs.map +0 -1
- package/dist/aws/cdk/constructs/index.d.cts +0 -34
- package/dist/aws/cdk/constructs/index.d.ts +0 -34
- package/dist/aws/cdk/constructs/index.js +0 -863
- package/dist/aws/cdk/constructs/index.js.map +0 -1
- package/dist/aws/cdk/constructs/lambda-authorizer-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/lambda-authorizer-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/lambda-authorizer-v2-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/lambda-authorizer-v2-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/lambda-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/lambda-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/lambda-layer-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/lambda-layer-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/role-policy-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/role-policy-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/s3-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/s3-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/s3-deployment-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/s3-deployment-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/sns-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/sns-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/sqs-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/sqs-construct.js.map +0 -1
- package/dist/aws/cdk/constructs/vpc-construct.cjs.map +0 -1
- package/dist/aws/cdk/constructs/vpc-construct.js.map +0 -1
- package/dist/aws/cdk/index.cjs +0 -881
- package/dist/aws/cdk/index.cjs.map +0 -1
- package/dist/aws/cdk/index.d.cts +0 -34
- package/dist/aws/cdk/index.d.ts +0 -34
- package/dist/aws/cdk/index.js +0 -863
- package/dist/aws/cdk/index.js.map +0 -1
- package/dist/aws/cli/index.cjs +0 -4
- package/dist/aws/cli/index.cjs.map +0 -1
- package/dist/aws/cli/index.d.cts +0 -2
- package/dist/aws/cli/index.d.ts +0 -2
- package/dist/aws/cli/index.js +0 -3
- package/dist/aws/cli/index.js.map +0 -1
- package/dist/aws/index.cjs +0 -881
- package/dist/aws/index.cjs.map +0 -1
- package/dist/aws/index.d.cts +0 -34
- package/dist/aws/index.d.ts +0 -34
- package/dist/aws/index.js.map +0 -1
- package/dist/aws/types/index.cjs +0 -4
- package/dist/aws/types/index.cjs.map +0 -1
- package/dist/aws/types/index.d.cts +0 -18
- package/dist/aws/types/index.d.ts +0 -18
- package/dist/aws/types/index.js +0 -3
- package/dist/aws/types/index.js.map +0 -1
- package/dist/lint/index.cjs +0 -4
- package/dist/lint/index.cjs.map +0 -1
- package/dist/lint/index.d.cts +0 -2
- package/dist/lint/index.d.ts +0 -2
- package/dist/lint/index.js +0 -3
- package/dist/lint/index.js.map +0 -1
- package/dist/prettier/index.cjs +0 -4
- package/dist/prettier/index.cjs.map +0 -1
- package/dist/prettier/index.d.cts +0 -2
- package/dist/prettier/index.d.ts +0 -2
- package/dist/prettier/index.js +0 -3
- package/dist/prettier/index.js.map +0 -1
- package/dist/utility/index.cjs +0 -4
- package/dist/utility/index.cjs.map +0 -1
- package/dist/utility/index.d.cts +0 -2
- package/dist/utility/index.d.ts +0 -2
- package/dist/utility/index.js +0 -3
- package/dist/utility/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,58 +1,197 @@
|
|
|
1
1
|
# @incloodsolutions/devkit
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
4
|
-
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
4
|
+
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
6
5
|
[](https://www.npmjs.com/package/@incloodsolutions/devkit)
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
Opinionated **AWS CDK v2 constructs** with sensible defaults for building serverless
|
|
8
|
+
applications. Each construct wraps one or more `aws-cdk-lib` resources, applies defaults
|
|
9
|
+
(ARM64, current Node.js runtime, source maps, stage-based timeouts, CloudFormation
|
|
10
|
+
outputs), and exposes the underlying resource for further customisation.
|
|
11
|
+
|
|
12
|
+
> For a one-line index of every construct and type in this package (and the other
|
|
13
|
+
> toolkits), see [`../docs/AI-INDEX.md`](../docs/AI-INDEX.md). Every construct, its props
|
|
14
|
+
> interface, and the created resource fields carry inline TSDoc comments describing the
|
|
15
|
+
> applied defaults.
|
|
9
16
|
|
|
10
17
|
---
|
|
11
18
|
|
|
12
|
-
##
|
|
19
|
+
## Installation
|
|
13
20
|
|
|
14
21
|
```bash
|
|
15
|
-
npm install @incloodsolutions/devkit
|
|
16
|
-
|
|
17
|
-
|
|
22
|
+
npm install @incloodsolutions/devkit aws-cdk-lib constructs
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Depends on `aws-cdk-lib`, `constructs`, `esbuild`, and
|
|
26
|
+
[`@incloodsolutions/toolkit`](../toolkit).
|
|
27
|
+
|
|
28
|
+
> **Scope note.** Only the AWS CDK constructs and their types are currently exported. The
|
|
29
|
+
> `src/utility`, `src/lint`, `src/prettier`, and `src/aws/cli` folders are placeholders and
|
|
30
|
+
> export nothing yet, despite what older documentation suggested.
|
|
31
|
+
|
|
32
|
+
## Common props
|
|
33
|
+
|
|
34
|
+
Every construct constructor is `new XxxConstruct(scope, id, props)`. `props` is based on
|
|
35
|
+
`IBaseCdkConstructProps`:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
interface IBaseCdkConstructProps<TOptions = any> {
|
|
39
|
+
readonly stage?: AppEnvironmentType; // 'production' | 'staging' | 'qa' | ...
|
|
40
|
+
readonly options?: TOptions; // the service-specific options (see each construct)
|
|
41
|
+
readonly stackName?: string;
|
|
42
|
+
readonly appName?: string;
|
|
43
|
+
readonly enableDebug?: boolean;
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The created resource is exposed as a public readonly field (`.function`, `.api`, `.table`,
|
|
48
|
+
`.topic`, `.queue`, `.layer`, `.distribution`, ...).
|
|
49
|
+
|
|
50
|
+
## Modular imports (tree-shaking)
|
|
51
|
+
|
|
52
|
+
**There is no package-root import.** `import ... from '@incloodsolutions/devkit'` does not
|
|
53
|
+
resolve — you must import a specific subpath. Every construct and every stack is published
|
|
54
|
+
as its own subpath, so using one does not bundle the other seventeen constructs or the
|
|
55
|
+
other two stacks. **There is also no "all constructs" or "all stacks" barrel** —
|
|
56
|
+
`.../aws-cdk`, `.../aws-cdk/constructs`, and `.../aws-cdk/stacks` do not resolve, on
|
|
57
|
+
purpose: each would silently re-bundle every construct or every stack the moment anyone
|
|
58
|
+
imported it. `.../aws` is the one deliberate exception — the "just give me everything"
|
|
59
|
+
escape hatch, documented as non-treeshaking.
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
import { BaseLambdaConstruct } from '@incloodsolutions/devkit/aws-cdk/constructs/lambda';
|
|
63
|
+
import { BaseDynamoDBConstruct } from '@incloodsolutions/devkit/aws-cdk/constructs/dynamo-db';
|
|
64
|
+
import type { IBaseCdkConstructProps } from '@incloodsolutions/devkit/aws-types';
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
| Subpath | Contents |
|
|
68
|
+
| ------- | -------- |
|
|
69
|
+
| `.../aws` | everything: all `Base*` constructs and stacks + shared types (does not tree-shake) |
|
|
70
|
+
| `.../aws-cdk/constructs/<name>` | one construct — `api-gateway`, `api-gateway-v2`, `api-gateway-websocket`, `cloudfront`, `cloudwatch`, `dynamo-db`, `event-bridge`, `lambda`, `lambda-authorizer`, `lambda-authorizer-v2`, `lambda-layer`, `role-policy`, `route53`, `s3`, `s3-deployment`, `sns`, `sqs`, `vpc` |
|
|
71
|
+
| `.../aws-cdk/stacks/<name>` | one stack — `lambda-api`, `lambda-sns`, `lambda-sqs` |
|
|
72
|
+
| `.../aws-types` | `IBaseConstruct`, `IBaseCdkConstructProps`, `IBaseStackProps` |
|
|
73
|
+
|
|
74
|
+
Every subpath resolves ESM (`import`), CommonJS (`require`), and its own `.d.ts`.
|
|
75
|
+
`aws-cdk-lib` and `constructs` stay external in every bundle.
|
|
76
|
+
|
|
77
|
+
## Constructs
|
|
78
|
+
|
|
79
|
+
| Construct | Wraps | Notable defaults |
|
|
80
|
+
| --------- | ----- | ---------------- |
|
|
81
|
+
| `BaseLambdaConstruct` | `aws-lambda.Function` | Node.js 24, ARM64, 1024 MB, `Code.fromAsset('dist')`, handler `lambda.handler`, timeout 30 s (prod) / 15 s, `--enable-source-maps`, injects `NODE_ENV` from `stage`, validates env vars for duplicates. Exposes `.function`. |
|
|
82
|
+
| `BaseLambdaLayerConstruct` | `aws-lambda.LayerVersion` | Create new or import via `fromExistingLayerArn` / `fromExistingLayerAttribute`. Exposes `.layer` / `.existingLayer`. |
|
|
83
|
+
| `BaseApiGatewayConstruct` | `aws-apigateway.RestApi` | REST API with Lambda proxy integration and permissive CORS. |
|
|
84
|
+
| `BaseApiGatewayV2Construct` | `aws-apigatewayv2.HttpApi` | HTTP API; takes `handlerFunctions` and `routeOptions`. Exposes `.api`. |
|
|
85
|
+
| `BaseApiGatewayWebSocketConstruct` | `aws-apigatewayv2.WebSocketApi` + `WebSocketStage` | Lambda route integrations for `$connect` / `$disconnect` / custom routes. |
|
|
86
|
+
| `BaseLambdaAuthoriserConstruct` | `aws-apigateway.TokenAuthorizer` | REST API token authorizer backed by a Lambda. |
|
|
87
|
+
| `BaseLambdaAuthoriserV2Construct` | `aws-apigatewayv2-authorizers.HttpLambdaAuthorizer` | HTTP API Lambda authorizer. |
|
|
88
|
+
| `BaseDynamoDBConstruct` | `aws-dynamodb.Table` | Create new or import (`fromExistingTableArn` / `Name` / `Attributes`); `globalSecondaryIndexes` / `localSecondaryIndexes`. Exposes `.table` / `.existingTable`. |
|
|
89
|
+
| `BaseS3Construct` | `aws-s3.Bucket` | Bucket with defaults. |
|
|
90
|
+
| `BaseS3DeploymentConstruct` | S3 `Bucket` + CloudFront `Distribution` + `BucketDeployment` | Static-site deploy; toggles `withS3Bucket` / `withCloudfront`; `bucketDeploymentOptions.sources` required. |
|
|
91
|
+
| `BaseCloudfrontConstruct` | `aws-cloudfront.Distribution` | Distribution with `ViewerProtocolPolicy` default. |
|
|
92
|
+
| `BaseCloudwatchLogGroupConstruct` | `aws-logs.LogGroup` | Log group with retention. |
|
|
93
|
+
| `BaseSnsConstruct` | `aws-sns.Topic` | Optional `targetFunctions` as `LambdaSubscription`. Exposes `.topic`. |
|
|
94
|
+
| `BaseSqsConstruct` | `aws-sqs.Queue` | Optional Lambda `EventSourceMapping`. Exposes `.queue`. |
|
|
95
|
+
| `BaseEventBridgeConstruct` | `aws-events.Rule` | Rule with a Lambda target. |
|
|
96
|
+
| `BaseVpcConstruct` | `aws-ec2.Vpc` | VPC with defaults. |
|
|
97
|
+
| `BaseRolePolicyConstruct` | `aws-iam.Role` + `PolicyStatement` / `ManagedPolicy` | IAM role and policy helper. |
|
|
98
|
+
| `BaseRoute53Construct` | `aws-route53.HostedZone` + `ARecord` / `AaaaRecord` / `CnameRecord` / `TxtRecord` | Create, import (`fromExistingHostedZoneAttributes`), or look up (`fromLookupOptions`) a hosted zone — exactly one required. Optional `aRecords` / `aaaaRecords` / `cnameRecords` / `txtRecords` arrays attach records to it. Exposes `.hostedZone`. |
|
|
99
|
+
|
|
100
|
+
## Stacks
|
|
101
|
+
|
|
102
|
+
Ready-made `Stack` subclasses that wire a few constructs together. Props are based on
|
|
103
|
+
`IBaseStackProps<TStackOptions>` — a regular CDK `StackProps` plus a required
|
|
104
|
+
`stackOptions` bag (`stage`, `enableDebug`, and the stack's own options).
|
|
105
|
+
|
|
106
|
+
| Stack | Source file | Wires together |
|
|
107
|
+
| ----- | ----------- | --------------- |
|
|
108
|
+
| `BaseLambdaApiStack` | `lambda-api-stack.ts` | `BaseLambdaConstruct` (+ optional imported layer) behind `BaseApiGatewayV2Construct` (`/{proxy+}`, any method). |
|
|
109
|
+
| `BaseLambdaSnsStack` | `lambda-sns-stack.ts` | `BaseLambdaConstruct` subscribed to a `BaseSnsConstruct` topic. |
|
|
110
|
+
| `BaseLambdaSqsStack` | `lambda-sqs-stack.ts` | `BaseLambdaConstruct` as the target of a `BaseSqsConstruct` queue. |
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
import { App } from 'aws-cdk-lib';
|
|
114
|
+
import { BaseLambdaApiStack } from '@incloodsolutions/devkit/aws-cdk/stacks/lambda-api';
|
|
115
|
+
|
|
116
|
+
const app = new App();
|
|
117
|
+
new BaseLambdaApiStack(app, 'OrdersApi', {
|
|
118
|
+
stackOptions: { stage: 'production' },
|
|
119
|
+
});
|
|
18
120
|
```
|
|
19
121
|
|
|
20
|
-
##
|
|
122
|
+
## Types
|
|
123
|
+
|
|
124
|
+
| Symbol | Summary |
|
|
125
|
+
| ------ | ------- |
|
|
126
|
+
| `IBaseConstruct` | extends `IBaseEnableDebug`. |
|
|
127
|
+
| `IBaseCdkConstructProps<TOptions>` | shared construct props (see above). |
|
|
128
|
+
| `IBaseStackProps<TStackOptions>` | shared stack props: CDK `StackProps` + a required `stackOptions: { stage?; enableDebug? } & TStackOptions`. |
|
|
129
|
+
|
|
130
|
+
## Usage
|
|
21
131
|
|
|
22
132
|
```typescript
|
|
23
|
-
import {
|
|
133
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
134
|
+
import { Construct } from 'constructs';
|
|
135
|
+
import { BaseLambdaConstruct } from '@incloodsolutions/devkit/aws-cdk/constructs/lambda';
|
|
136
|
+
import { BaseApiGatewayV2Construct } from '@incloodsolutions/devkit/aws-cdk/constructs/api-gateway-v2';
|
|
137
|
+
import { BaseDynamoDBConstruct } from '@incloodsolutions/devkit/aws-cdk/constructs/dynamo-db';
|
|
138
|
+
|
|
139
|
+
export class ApiStack extends Stack {
|
|
140
|
+
constructor(scope: Construct, id: string, props?: StackProps) {
|
|
141
|
+
super(scope, id, props);
|
|
142
|
+
|
|
143
|
+
const table = new BaseDynamoDBConstruct(this, 'Table', {
|
|
144
|
+
stage: 'production',
|
|
145
|
+
stackName: this.stackName,
|
|
146
|
+
options: { tableOptions: { partitionKey: { name: 'id', type: AttributeType.STRING } } },
|
|
147
|
+
});
|
|
24
148
|
|
|
25
|
-
|
|
26
|
-
|
|
149
|
+
const handler = new BaseLambdaConstruct(this, 'Handler', {
|
|
150
|
+
stage: 'production',
|
|
151
|
+
stackName: this.stackName,
|
|
152
|
+
options: { lambdaOptions: { environment: { TABLE_NAME: table.table.tableName } } },
|
|
153
|
+
});
|
|
154
|
+
|
|
155
|
+
table.table.grantReadWriteData(handler.function);
|
|
156
|
+
|
|
157
|
+
new BaseApiGatewayV2Construct(this, 'Api', {
|
|
158
|
+
stage: 'production',
|
|
159
|
+
stackName: this.stackName,
|
|
160
|
+
options: {
|
|
161
|
+
handlerFunctions: [handler.function],
|
|
162
|
+
routeOptions: [{ path: '/{proxy+}' }],
|
|
163
|
+
},
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
}
|
|
27
167
|
```
|
|
28
168
|
|
|
29
|
-
##
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
- **@incloodsolutions/devkit** — Development tooling, configuration, AWS CDK constructs, stacks, and infrastructure utilities
|
|
169
|
+
## Development
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
npm install
|
|
173
|
+
npm run build # tsup: bundles ESM + CJS and a single dist/index.d.ts
|
|
174
|
+
npm run format # prettier --write (tabs, single quotes, trailing commas)
|
|
175
|
+
npm run lint # eslint --fix
|
|
176
|
+
npm test # vitest run — synthesises every construct and asserts its CloudFormation
|
|
177
|
+
npm run test:watch # vitest in watch mode
|
|
178
|
+
npm run package # build, then npm pack a tarball
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
[`test/constructs.spec.ts`](./test/constructs.spec.ts) instantiates each `Base*` construct
|
|
182
|
+
in a throwaway `Stack` and checks the output with `aws-cdk-lib/assertions` (`Template`).
|
|
183
|
+
Nothing is deployed and no AWS credentials are used. Its header comment records the
|
|
184
|
+
constructs that need extra props or currently throw.
|
|
185
|
+
[`test/esm-bundle.spec.ts`](./test/esm-bundle.spec.ts) guards that every subpath entry is
|
|
186
|
+
built, loads as ESM, and keeps `aws-cdk-lib` / `constructs` external.
|
|
187
|
+
|
|
188
|
+
> The whole build is `tsup` (`dts: true`), pinned to `typescript@^6`. There is **no root
|
|
189
|
+
> export** and no `main`/`module`/`types` fields — every module and every construct is a
|
|
190
|
+
> `./*` subpath in `exports` (see [Modular imports](#modular-imports-tree-shaking)),
|
|
191
|
+
> configured by the `entry` map in `tsup.config.ts` and `exports` + `typesVersions` in
|
|
192
|
+
> `package.json`. The `index` bundle is still built as the test aggregation point but is
|
|
193
|
+
> not reachable by the package name.
|
|
194
|
+
|
|
195
|
+
## License
|
|
196
|
+
|
|
197
|
+
MIT © Inclood Solutions
|
|
@@ -73,5 +73,5 @@ var BaseApiGatewayV2Construct = class extends constructs.Construct {
|
|
|
73
73
|
};
|
|
74
74
|
|
|
75
75
|
exports.BaseApiGatewayV2Construct = BaseApiGatewayV2Construct;
|
|
76
|
-
//# sourceMappingURL=api-gateway-v2
|
|
77
|
-
//# sourceMappingURL=api-gateway-v2
|
|
76
|
+
//# sourceMappingURL=api-gateway-v2.cjs.map
|
|
77
|
+
//# sourceMappingURL=api-gateway-v2.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-v2-construct.ts"],"names":["Construct","HttpApi","CorsHttpMethod","CustomException","HttpLambdaIntegration","RemovalPolicy","CfnOutput"],"mappings":";;;;;;;;;;AAsDO,IAAM,yBAAA,GAAN,cACEA,oBAAA,CAET;AAAA,EAzDA;AAyDA,IAAA,MAAA,CAAA,IAAA,EAAA,2BAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CACC,KAAA,EACA,EAAA,EACA,KAAA,EACC;AACD,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAIC,uBAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,aAAA,EAAe;AAAA,QACd,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,aAAA;AAAA;AAAA,QAGlC,YAAA,EACC,MAAM,OAAA,EAAS,cAAA,EAAgB,eAAe,YAAA,IAC9C,MAAA,CAAO,OAAOC,8BAAc,CAAA;AAAA;AAAA,QAG7B,YAAA,EAAc;AAAA,UACb,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA,kBAAA;AAAA,UACA,GAAI,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,aAAA,EAAe,gBAAgB;AAAC;AACpE;AACD,KACA,CAAA;AAKD,IAAA,IAAI,CAAC,KAAA,EAAO,gBAAA,EAAkB,MAAA,EAAQ;AACrC,MAAA,MAAM,IAAIC,wBAAgB,yCAAyC,CAAA;AAAA,IACpE;AAKA,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,EAAQ;AACzC,MAAA,KAAA,CAAM,gBAAA,CAAiB,OAAA,CAAQ,CAAC,WAAA,KAAgB;AAC/C,QAAA,KAAA,EAAO,OAAA,EAAS,YAAA,CAAa,OAAA,CAAQ,CAAC,KAAA,KAAU;AAC/C,UAAA,IAAA,CAAK,IAAI,SAAA,CAAU;AAAA,YAClB,GAAG,KAAA;AAAA;AAAA;AAAA;AAAA,YAKH,WAAA,EAAa,IAAIC,iDAAA,CAAsB,QAAA,EAAU,WAAW;AAAA,WACxC,CAAA;AAAA,QACtB,CAAC,CAAA;AAAA,MACF,CAAC,CAAA;AAAA,IACF;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmBC,uBAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAIC,mBAAA,CAAU,MAAM,cAAA,EAAgB;AAAA,MACnC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AACD","file":"api-gateway-v2.cjs","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { CfnOutput, RemovalPolicy } from 'aws-cdk-lib';\nimport { HttpLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';\nimport {\n\tAddRoutesOptions,\n\tCorsHttpMethod,\n\tHttpApi,\n\tHttpApiProps,\n} from 'aws-cdk-lib/aws-apigatewayv2';\n\nimport { CustomException } from '@incloodsolutions/toolkit';\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Properties for configuring the API Gateway v2 construct\n *\n * Extends base CDK construct props and provides configuration for:\n * - HTTP API (Api Gateway v2)\n * - Route definitions\n * - Lambda handlers\n */\ninterface IApiGatewayV2ConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** HTTP API configuration options */\n\t\treadonly gatewayOptions: HttpApiProps;\n\n\t\t/** Route definitions passed directly to `addRoutes` */\n\t\treadonly routeOptions: Partial<AddRoutesOptions>[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda functions used as route handlers\n\t *\n\t * Note:\n\t * Each handler is paired with each route during route creation\n\t */\n\treadonly handlerFunctions: Function[];\n}\n\n/**\n * CDK construct for creating an API Gateway v2 (HTTP API)\n *\n * Responsibilities:\n * - Creates an HTTP API with optional custom configuration\n * - Applies default CORS configuration when not provided\n * - Attaches routes with Lambda integrations\n * - Exposes API URL as a CloudFormation output\n *\n * Behaviour:\n * - Each route is registered for every provided handler function\n * - Throws if no handler functions are supplied\n */\nexport class BaseApiGatewayV2Construct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created HTTP API instance */\n\treadonly api: HttpApi;\n\n\t/** Enables debug logging (if used externally) */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and handlers\n\t */\n\tconstructor(\n\t\tscope: Construct,\n\t\tid: string,\n\t\tprops: IApiGatewayV2ConstructProps,\n\t) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new HttpApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is an Http API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all methods and standard headers if not explicitly defined\n\t\t\t */\n\t\t\tcorsPreflight: {\n\t\t\t\t...props.options?.gatewayOptions?.corsPreflight,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops.options?.gatewayOptions?.corsPreflight?.allowMethods ||\n\t\t\t\t\tObject.values(CorsHttpMethod),\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t\t...(props.options?.gatewayOptions?.corsPreflight?.allowHeaders || []),\n\t\t\t\t],\n\t\t\t},\n\t\t});\n\n\t\t/**\n\t\t * Ensure at least one handler function is provided\n\t\t */\n\t\tif (!props?.handlerFunctions?.length) {\n\t\t\tthrow new CustomException('Construct requires atleast one function');\n\t\t}\n\n\t\t/**\n\t\t * Register routes with Lambda integrations\n\t\t */\n\t\tif (props?.options?.routeOptions?.length) {\n\t\t\tprops.handlerFunctions.forEach((handlerFunc) => {\n\t\t\t\tprops?.options?.routeOptions.forEach((route) => {\n\t\t\t\t\tthis.api.addRoutes({\n\t\t\t\t\t\t...route,\n\n\t\t\t\t\t\t/**\n\t\t\t\t\t\t * Lambda integration for each route\n\t\t\t\t\t\t */\n\t\t\t\t\t\tintegration: new HttpLambdaIntegration('routes', handlerFunc),\n\t\t\t\t\t} as AddRoutesOptions);\n\t\t\t\t});\n\t\t\t});\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing the API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGatewayV2', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n}\n"]}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Construct } from 'constructs';
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { HttpApi, HttpApiProps, AddRoutesOptions } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
|
-
import { IBaseConstruct, IBaseCdkConstructProps } from '../../types
|
|
4
|
+
import { IBaseConstruct, IBaseCdkConstructProps } from '../../aws-types.cjs';
|
|
5
5
|
import '@incloodsolutions/toolkit';
|
|
6
|
+
import 'aws-cdk-lib';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* Properties for configuring the API Gateway v2 construct
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Construct } from 'constructs';
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { HttpApi, HttpApiProps, AddRoutesOptions } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
|
-
import { IBaseConstruct, IBaseCdkConstructProps } from '../../types
|
|
4
|
+
import { IBaseConstruct, IBaseCdkConstructProps } from '../../aws-types.js';
|
|
5
5
|
import '@incloodsolutions/toolkit';
|
|
6
|
+
import 'aws-cdk-lib';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* Properties for configuring the API Gateway v2 construct
|
package/dist/{aws/cdk/constructs/api-gateway-v2-construct.js → aws-cdk/constructs/api-gateway-v2.js}
RENAMED
|
@@ -71,5 +71,5 @@ var BaseApiGatewayV2Construct = class extends Construct {
|
|
|
71
71
|
};
|
|
72
72
|
|
|
73
73
|
export { BaseApiGatewayV2Construct };
|
|
74
|
-
//# sourceMappingURL=api-gateway-v2
|
|
75
|
-
//# sourceMappingURL=api-gateway-v2
|
|
74
|
+
//# sourceMappingURL=api-gateway-v2.js.map
|
|
75
|
+
//# sourceMappingURL=api-gateway-v2.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-v2-construct.ts"],"names":[],"mappings":";;;;;;;;AAsDO,IAAM,yBAAA,GAAN,cACE,SAAA,CAET;AAAA,EAzDA;AAyDA,IAAA,MAAA,CAAA,IAAA,EAAA,2BAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CACC,KAAA,EACA,EAAA,EACA,KAAA,EACC;AACD,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAI,OAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,+BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,aAAA,EAAe;AAAA,QACd,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,aAAA;AAAA;AAAA,QAGlC,YAAA,EACC,MAAM,OAAA,EAAS,cAAA,EAAgB,eAAe,YAAA,IAC9C,MAAA,CAAO,OAAO,cAAc,CAAA;AAAA;AAAA,QAG7B,YAAA,EAAc;AAAA,UACb,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA,kBAAA;AAAA,UACA,GAAI,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,aAAA,EAAe,gBAAgB;AAAC;AACpE;AACD,KACA,CAAA;AAKD,IAAA,IAAI,CAAC,KAAA,EAAO,gBAAA,EAAkB,MAAA,EAAQ;AACrC,MAAA,MAAM,IAAI,gBAAgB,yCAAyC,CAAA;AAAA,IACpE;AAKA,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,EAAQ;AACzC,MAAA,KAAA,CAAM,gBAAA,CAAiB,OAAA,CAAQ,CAAC,WAAA,KAAgB;AAC/C,QAAA,KAAA,EAAO,OAAA,EAAS,YAAA,CAAa,OAAA,CAAQ,CAAC,KAAA,KAAU;AAC/C,UAAA,IAAA,CAAK,IAAI,SAAA,CAAU;AAAA,YAClB,GAAG,KAAA;AAAA;AAAA;AAAA;AAAA,YAKH,WAAA,EAAa,IAAI,qBAAA,CAAsB,QAAA,EAAU,WAAW;AAAA,WACxC,CAAA;AAAA,QACtB,CAAC,CAAA;AAAA,MACF,CAAC,CAAA;AAAA,IACF;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmB,aAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAI,SAAA,CAAU,MAAM,cAAA,EAAgB;AAAA,MACnC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AACD","file":"api-gateway-v2.js","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { CfnOutput, RemovalPolicy } from 'aws-cdk-lib';\nimport { HttpLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';\nimport {\n\tAddRoutesOptions,\n\tCorsHttpMethod,\n\tHttpApi,\n\tHttpApiProps,\n} from 'aws-cdk-lib/aws-apigatewayv2';\n\nimport { CustomException } from '@incloodsolutions/toolkit';\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Properties for configuring the API Gateway v2 construct\n *\n * Extends base CDK construct props and provides configuration for:\n * - HTTP API (Api Gateway v2)\n * - Route definitions\n * - Lambda handlers\n */\ninterface IApiGatewayV2ConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** HTTP API configuration options */\n\t\treadonly gatewayOptions: HttpApiProps;\n\n\t\t/** Route definitions passed directly to `addRoutes` */\n\t\treadonly routeOptions: Partial<AddRoutesOptions>[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda functions used as route handlers\n\t *\n\t * Note:\n\t * Each handler is paired with each route during route creation\n\t */\n\treadonly handlerFunctions: Function[];\n}\n\n/**\n * CDK construct for creating an API Gateway v2 (HTTP API)\n *\n * Responsibilities:\n * - Creates an HTTP API with optional custom configuration\n * - Applies default CORS configuration when not provided\n * - Attaches routes with Lambda integrations\n * - Exposes API URL as a CloudFormation output\n *\n * Behaviour:\n * - Each route is registered for every provided handler function\n * - Throws if no handler functions are supplied\n */\nexport class BaseApiGatewayV2Construct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created HTTP API instance */\n\treadonly api: HttpApi;\n\n\t/** Enables debug logging (if used externally) */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and handlers\n\t */\n\tconstructor(\n\t\tscope: Construct,\n\t\tid: string,\n\t\tprops: IApiGatewayV2ConstructProps,\n\t) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new HttpApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is an Http API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all methods and standard headers if not explicitly defined\n\t\t\t */\n\t\t\tcorsPreflight: {\n\t\t\t\t...props.options?.gatewayOptions?.corsPreflight,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops.options?.gatewayOptions?.corsPreflight?.allowMethods ||\n\t\t\t\t\tObject.values(CorsHttpMethod),\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t\t...(props.options?.gatewayOptions?.corsPreflight?.allowHeaders || []),\n\t\t\t\t],\n\t\t\t},\n\t\t});\n\n\t\t/**\n\t\t * Ensure at least one handler function is provided\n\t\t */\n\t\tif (!props?.handlerFunctions?.length) {\n\t\t\tthrow new CustomException('Construct requires atleast one function');\n\t\t}\n\n\t\t/**\n\t\t * Register routes with Lambda integrations\n\t\t */\n\t\tif (props?.options?.routeOptions?.length) {\n\t\t\tprops.handlerFunctions.forEach((handlerFunc) => {\n\t\t\t\tprops?.options?.routeOptions.forEach((route) => {\n\t\t\t\t\tthis.api.addRoutes({\n\t\t\t\t\t\t...route,\n\n\t\t\t\t\t\t/**\n\t\t\t\t\t\t * Lambda integration for each route\n\t\t\t\t\t\t */\n\t\t\t\t\t\tintegration: new HttpLambdaIntegration('routes', handlerFunc),\n\t\t\t\t\t} as AddRoutesOptions);\n\t\t\t\t});\n\t\t\t});\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing the API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGatewayV2', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n}\n"]}
|
|
@@ -27,27 +27,39 @@ var BaseApiGatewayWebSocketConstruct = class extends constructs.Construct {
|
|
|
27
27
|
*/
|
|
28
28
|
connectRouteOptions: {
|
|
29
29
|
...props.handlers.connect?.option,
|
|
30
|
-
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
30
|
+
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
31
|
+
"connectIntegration",
|
|
32
|
+
props.handlers.connect.function
|
|
33
|
+
)
|
|
31
34
|
},
|
|
32
35
|
/**
|
|
33
36
|
* Route for disconnection events ($disconnect)
|
|
34
37
|
*/
|
|
35
38
|
disconnectRouteOptions: {
|
|
36
39
|
...props.handlers.disconnect?.option,
|
|
37
|
-
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
40
|
+
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
41
|
+
"disconnectIntegration",
|
|
42
|
+
props.handlers.disconnect.function
|
|
43
|
+
)
|
|
38
44
|
},
|
|
39
45
|
/**
|
|
40
46
|
* Default route for unmatched messages ($default)
|
|
41
47
|
*/
|
|
42
48
|
defaultRouteOptions: {
|
|
43
49
|
...props.handlers.default?.option,
|
|
44
|
-
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
50
|
+
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
51
|
+
"defaultIntegration",
|
|
52
|
+
props.handlers.default.function
|
|
53
|
+
)
|
|
45
54
|
}
|
|
46
55
|
});
|
|
47
56
|
this.socketApi.addRoute("notifications", {
|
|
48
57
|
...props.handlers.message?.option,
|
|
49
58
|
/** Lambda integration for message handling */
|
|
50
|
-
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
59
|
+
integration: new awsApigatewayv2Integrations.WebSocketLambdaIntegration(
|
|
60
|
+
"routes",
|
|
61
|
+
props.handlers.message.function
|
|
62
|
+
)
|
|
51
63
|
});
|
|
52
64
|
const webSocketStage = new awsApigatewayv2.WebSocketStage(this, `${id}_stage`, {
|
|
53
65
|
...props.options?.webSocketStageOptions,
|
|
@@ -61,5 +73,5 @@ var BaseApiGatewayWebSocketConstruct = class extends constructs.Construct {
|
|
|
61
73
|
};
|
|
62
74
|
|
|
63
75
|
exports.BaseApiGatewayWebSocketConstruct = BaseApiGatewayWebSocketConstruct;
|
|
64
|
-
//# sourceMappingURL=api-gateway-websocket
|
|
65
|
-
//# sourceMappingURL=api-gateway-websocket
|
|
76
|
+
//# sourceMappingURL=api-gateway-websocket.cjs.map
|
|
77
|
+
//# sourceMappingURL=api-gateway-websocket.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-websocket-construct.ts"],"names":["Construct","WebSocketApi","WebSocketLambdaIntegration","WebSocketStage","CfnOutput"],"mappings":";;;;;;;;;AA6EO,IAAM,gCAAA,GAAN,cAA+CA,oBAAA,CAAU;AAAA,EA7EhE;AA6EgE,IAAA,MAAA,CAAA,IAAA,EAAA,kCAAA,CAAA;AAAA;AAAA;AAAA,EAEtD,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAA,CACC,KAAA,EACA,EAAA,EACA,KAAA,EACC;AACD,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,SAAA,GAAY,IAAIC,4BAAA,CAAa,IAAA,EAAM,EAAA,EAAI;AAAA,MAC3C,GAAG,MAAM,OAAA,CAAQ,mBAAA;AAAA;AAAA;AAAA;AAAA,MAKjB,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAIC,sDAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,sBAAA,EAAwB;AAAA,QACvB,GAAG,KAAA,CAAM,QAAA,CAAS,UAAA,EAAY,MAAA;AAAA,QAC9B,aAAa,IAAIA,sDAAA;AAAA,UAChB,uBAAA;AAAA,UACA,KAAA,CAAM,SAAS,UAAA,CAAW;AAAA;AAC3B,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAIA,sDAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB;AACD,KACA,CAAA;AAKD,IAAA,IAAA,CAAK,SAAA,CAAU,SAAS,eAAA,EAAiB;AAAA,MACxC,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA;AAAA,MAG3B,aAAa,IAAIA,sDAAA;AAAA,QAChB,QAAA;AAAA,QACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,KACA,CAAA;AAMD,IAAA,MAAM,iBAAiB,IAAIC,8BAAA,CAAe,IAAA,EAAM,CAAA,EAAG,EAAE,CAAA,MAAA,CAAA,EAAU;AAAA,MAC9D,GAAG,MAAM,OAAA,EAAS,qBAAA;AAAA,MAClB,cAAc,IAAA,CAAK,SAAA;AAAA,MACnB,UAAA,EAAY;AAAA,KACZ,CAAA;AAKD,IAAA,IAAIC,mBAAA,CAAU,MAAM,cAAA,EAAgB;AAAA,MACnC,OAAO,cAAA,CAAe;AAAA,KACtB,CAAA;AAAA,EACF;AACD","file":"api-gateway-websocket.cjs","sourcesContent":["import { Construct } from 'constructs';\nimport { CfnOutput } from 'aws-cdk-lib';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { WebSocketLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';\nimport {\n\tWebSocketApi,\n\tWebSocketApiProps,\n\tWebSocketRouteOptions,\n\tWebSocketStage,\n\tWebSocketStageProps,\n} from 'aws-cdk-lib/aws-apigatewayv2';\n\nimport { IBaseCdkConstructProps } from '../../types';\n\n/**\n * Props for BaseApiGatewayWebSocketConstruct\n *\n * Provides configuration for:\n * - WebSocket API (API Gateway v2)\n * - WebSocket stage\n * - Route handlers for lifecycle events\n */\ninterface IApiGatewayWebsocketConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** WebSocket API configuration options */\n\t\treadonly webSocketApiOptions: WebSocketApiProps;\n\n\t\t/** WebSocket stage configuration options */\n\t\treadonly webSocketStageOptions: WebSocketStageProps;\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda handlers mapped to WebSocket lifecycle routes\n\t *\n\t * Includes:\n\t * - $connect\n\t * - $disconnect\n\t * - $default\n\t * - custom message route\n\t */\n\treadonly handlers: {\n\t\t/** Handler for connection establishment ($connect) */\n\t\treadonly connect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for unmatched routes ($default) */\n\t\treadonly default: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for custom message route (e.g. 'notifications') */\n\t\treadonly message: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for disconnection events ($disconnect) */\n\t\treadonly disconnect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\t};\n}\n\n/**\n * CDK construct for WebSocket API Gateway\n *\n * Responsibilities:\n * - Creates a WebSocket API with lifecycle route integrations\n * - Registers a custom message route\n * - Deploys a stage with auto-deploy enabled\n * - Exposes WebSocket endpoint URL as a CloudFormation output\n */\nexport class BaseApiGatewayWebSocketConstruct extends Construct {\n\t/** The created WebSocket API instance */\n\treadonly socketApi: WebSocketApi;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, stage, and route handlers\n\t */\n\tconstructor(\n\t\tscope: Construct,\n\t\tid: string,\n\t\tprops: IApiGatewayWebsocketConstructProps,\n\t) {\n\t\tsuper(scope, id);\n\n\t\tthis.socketApi = new WebSocketApi(this, id, {\n\t\t\t...props.options.webSocketApiOptions,\n\n\t\t\t/**\n\t\t\t * Route for connection establishment ($connect)\n\t\t\t */\n\t\t\tconnectRouteOptions: {\n\t\t\t\t...props.handlers.connect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'connectIntegration',\n\t\t\t\t\tprops.handlers.connect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Route for disconnection events ($disconnect)\n\t\t\t */\n\t\t\tdisconnectRouteOptions: {\n\t\t\t\t...props.handlers.disconnect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'disconnectIntegration',\n\t\t\t\t\tprops.handlers.disconnect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Default route for unmatched messages ($default)\n\t\t\t */\n\t\t\tdefaultRouteOptions: {\n\t\t\t\t...props.handlers.default?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'defaultIntegration',\n\t\t\t\t\tprops.handlers.default.function,\n\t\t\t\t),\n\t\t\t},\n\t\t});\n\n\t\t/**\n\t\t * Custom message route (e.g. \"notifications\")\n\t\t */\n\t\tthis.socketApi.addRoute('notifications', {\n\t\t\t...props.handlers.message?.option,\n\n\t\t\t/** Lambda integration for message handling */\n\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t'routes',\n\t\t\t\tprops.handlers.message.function,\n\t\t\t),\n\t\t});\n\n\t\t/**\n\t\t * WebSocket stage deployment\n\t\t * Auto-deploy ensures changes are immediately available\n\t\t */\n\t\tconst webSocketStage = new WebSocketStage(this, `${id}_stage`, {\n\t\t\t...props.options?.webSocketStageOptions,\n\t\t\twebSocketApi: this.socketApi,\n\t\t\tautoDeploy: true,\n\t\t});\n\n\t\t/**\n\t\t * CloudFormation output exposing WebSocket endpoint URL\n\t\t */\n\t\tnew CfnOutput(this, 'WebSocketURL', {\n\t\t\tvalue: webSocketStage.url,\n\t\t});\n\t}\n}\n"]}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Construct } from 'constructs';
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { WebSocketApi, WebSocketApiProps, WebSocketStageProps, WebSocketRouteOptions } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
|
-
import { IBaseCdkConstructProps } from '../../types
|
|
4
|
+
import { IBaseCdkConstructProps } from '../../aws-types.cjs';
|
|
5
5
|
import '@incloodsolutions/toolkit';
|
|
6
|
+
import 'aws-cdk-lib';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* Props for BaseApiGatewayWebSocketConstruct
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Construct } from 'constructs';
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { WebSocketApi, WebSocketApiProps, WebSocketStageProps, WebSocketRouteOptions } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
|
-
import { IBaseCdkConstructProps } from '../../types
|
|
4
|
+
import { IBaseCdkConstructProps } from '../../aws-types.js';
|
|
5
5
|
import '@incloodsolutions/toolkit';
|
|
6
|
+
import 'aws-cdk-lib';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* Props for BaseApiGatewayWebSocketConstruct
|
|
@@ -25,27 +25,39 @@ var BaseApiGatewayWebSocketConstruct = class extends Construct {
|
|
|
25
25
|
*/
|
|
26
26
|
connectRouteOptions: {
|
|
27
27
|
...props.handlers.connect?.option,
|
|
28
|
-
integration: new WebSocketLambdaIntegration(
|
|
28
|
+
integration: new WebSocketLambdaIntegration(
|
|
29
|
+
"connectIntegration",
|
|
30
|
+
props.handlers.connect.function
|
|
31
|
+
)
|
|
29
32
|
},
|
|
30
33
|
/**
|
|
31
34
|
* Route for disconnection events ($disconnect)
|
|
32
35
|
*/
|
|
33
36
|
disconnectRouteOptions: {
|
|
34
37
|
...props.handlers.disconnect?.option,
|
|
35
|
-
integration: new WebSocketLambdaIntegration(
|
|
38
|
+
integration: new WebSocketLambdaIntegration(
|
|
39
|
+
"disconnectIntegration",
|
|
40
|
+
props.handlers.disconnect.function
|
|
41
|
+
)
|
|
36
42
|
},
|
|
37
43
|
/**
|
|
38
44
|
* Default route for unmatched messages ($default)
|
|
39
45
|
*/
|
|
40
46
|
defaultRouteOptions: {
|
|
41
47
|
...props.handlers.default?.option,
|
|
42
|
-
integration: new WebSocketLambdaIntegration(
|
|
48
|
+
integration: new WebSocketLambdaIntegration(
|
|
49
|
+
"defaultIntegration",
|
|
50
|
+
props.handlers.default.function
|
|
51
|
+
)
|
|
43
52
|
}
|
|
44
53
|
});
|
|
45
54
|
this.socketApi.addRoute("notifications", {
|
|
46
55
|
...props.handlers.message?.option,
|
|
47
56
|
/** Lambda integration for message handling */
|
|
48
|
-
integration: new WebSocketLambdaIntegration(
|
|
57
|
+
integration: new WebSocketLambdaIntegration(
|
|
58
|
+
"routes",
|
|
59
|
+
props.handlers.message.function
|
|
60
|
+
)
|
|
49
61
|
});
|
|
50
62
|
const webSocketStage = new WebSocketStage(this, `${id}_stage`, {
|
|
51
63
|
...props.options?.webSocketStageOptions,
|
|
@@ -59,5 +71,5 @@ var BaseApiGatewayWebSocketConstruct = class extends Construct {
|
|
|
59
71
|
};
|
|
60
72
|
|
|
61
73
|
export { BaseApiGatewayWebSocketConstruct };
|
|
62
|
-
//# sourceMappingURL=api-gateway-websocket
|
|
63
|
-
//# sourceMappingURL=api-gateway-websocket
|
|
74
|
+
//# sourceMappingURL=api-gateway-websocket.js.map
|
|
75
|
+
//# sourceMappingURL=api-gateway-websocket.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-websocket-construct.ts"],"names":[],"mappings":";;;;;;;AA6EO,IAAM,gCAAA,GAAN,cAA+C,SAAA,CAAU;AAAA,EA7EhE;AA6EgE,IAAA,MAAA,CAAA,IAAA,EAAA,kCAAA,CAAA;AAAA;AAAA;AAAA,EAEtD,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAA,CACC,KAAA,EACA,EAAA,EACA,KAAA,EACC;AACD,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,SAAA,GAAY,IAAI,YAAA,CAAa,IAAA,EAAM,EAAA,EAAI;AAAA,MAC3C,GAAG,MAAM,OAAA,CAAQ,mBAAA;AAAA;AAAA;AAAA;AAAA,MAKjB,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAI,0BAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,sBAAA,EAAwB;AAAA,QACvB,GAAG,KAAA,CAAM,QAAA,CAAS,UAAA,EAAY,MAAA;AAAA,QAC9B,aAAa,IAAI,0BAAA;AAAA,UAChB,uBAAA;AAAA,UACA,KAAA,CAAM,SAAS,UAAA,CAAW;AAAA;AAC3B,OACD;AAAA;AAAA;AAAA;AAAA,MAKA,mBAAA,EAAqB;AAAA,QACpB,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA,QAC3B,aAAa,IAAI,0BAAA;AAAA,UAChB,oBAAA;AAAA,UACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB;AACD,KACA,CAAA;AAKD,IAAA,IAAA,CAAK,SAAA,CAAU,SAAS,eAAA,EAAiB;AAAA,MACxC,GAAG,KAAA,CAAM,QAAA,CAAS,OAAA,EAAS,MAAA;AAAA;AAAA,MAG3B,aAAa,IAAI,0BAAA;AAAA,QAChB,QAAA;AAAA,QACA,KAAA,CAAM,SAAS,OAAA,CAAQ;AAAA;AACxB,KACA,CAAA;AAMD,IAAA,MAAM,iBAAiB,IAAI,cAAA,CAAe,IAAA,EAAM,CAAA,EAAG,EAAE,CAAA,MAAA,CAAA,EAAU;AAAA,MAC9D,GAAG,MAAM,OAAA,EAAS,qBAAA;AAAA,MAClB,cAAc,IAAA,CAAK,SAAA;AAAA,MACnB,UAAA,EAAY;AAAA,KACZ,CAAA;AAKD,IAAA,IAAI,SAAA,CAAU,MAAM,cAAA,EAAgB;AAAA,MACnC,OAAO,cAAA,CAAe;AAAA,KACtB,CAAA;AAAA,EACF;AACD","file":"api-gateway-websocket.js","sourcesContent":["import { Construct } from 'constructs';\nimport { CfnOutput } from 'aws-cdk-lib';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { WebSocketLambdaIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';\nimport {\n\tWebSocketApi,\n\tWebSocketApiProps,\n\tWebSocketRouteOptions,\n\tWebSocketStage,\n\tWebSocketStageProps,\n} from 'aws-cdk-lib/aws-apigatewayv2';\n\nimport { IBaseCdkConstructProps } from '../../types';\n\n/**\n * Props for BaseApiGatewayWebSocketConstruct\n *\n * Provides configuration for:\n * - WebSocket API (API Gateway v2)\n * - WebSocket stage\n * - Route handlers for lifecycle events\n */\ninterface IApiGatewayWebsocketConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** WebSocket API configuration options */\n\t\treadonly webSocketApiOptions: WebSocketApiProps;\n\n\t\t/** WebSocket stage configuration options */\n\t\treadonly webSocketStageOptions: WebSocketStageProps;\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda handlers mapped to WebSocket lifecycle routes\n\t *\n\t * Includes:\n\t * - $connect\n\t * - $disconnect\n\t * - $default\n\t * - custom message route\n\t */\n\treadonly handlers: {\n\t\t/** Handler for connection establishment ($connect) */\n\t\treadonly connect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for unmatched routes ($default) */\n\t\treadonly default: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for custom message route (e.g. 'notifications') */\n\t\treadonly message: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\n\t\t/** Handler for disconnection events ($disconnect) */\n\t\treadonly disconnect: {\n\t\t\toption: WebSocketRouteOptions;\n\t\t\tfunction: Function;\n\t\t};\n\t};\n}\n\n/**\n * CDK construct for WebSocket API Gateway\n *\n * Responsibilities:\n * - Creates a WebSocket API with lifecycle route integrations\n * - Registers a custom message route\n * - Deploys a stage with auto-deploy enabled\n * - Exposes WebSocket endpoint URL as a CloudFormation output\n */\nexport class BaseApiGatewayWebSocketConstruct extends Construct {\n\t/** The created WebSocket API instance */\n\treadonly socketApi: WebSocketApi;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, stage, and route handlers\n\t */\n\tconstructor(\n\t\tscope: Construct,\n\t\tid: string,\n\t\tprops: IApiGatewayWebsocketConstructProps,\n\t) {\n\t\tsuper(scope, id);\n\n\t\tthis.socketApi = new WebSocketApi(this, id, {\n\t\t\t...props.options.webSocketApiOptions,\n\n\t\t\t/**\n\t\t\t * Route for connection establishment ($connect)\n\t\t\t */\n\t\t\tconnectRouteOptions: {\n\t\t\t\t...props.handlers.connect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'connectIntegration',\n\t\t\t\t\tprops.handlers.connect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Route for disconnection events ($disconnect)\n\t\t\t */\n\t\t\tdisconnectRouteOptions: {\n\t\t\t\t...props.handlers.disconnect?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'disconnectIntegration',\n\t\t\t\t\tprops.handlers.disconnect.function,\n\t\t\t\t),\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Default route for unmatched messages ($default)\n\t\t\t */\n\t\t\tdefaultRouteOptions: {\n\t\t\t\t...props.handlers.default?.option,\n\t\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t\t'defaultIntegration',\n\t\t\t\t\tprops.handlers.default.function,\n\t\t\t\t),\n\t\t\t},\n\t\t});\n\n\t\t/**\n\t\t * Custom message route (e.g. \"notifications\")\n\t\t */\n\t\tthis.socketApi.addRoute('notifications', {\n\t\t\t...props.handlers.message?.option,\n\n\t\t\t/** Lambda integration for message handling */\n\t\t\tintegration: new WebSocketLambdaIntegration(\n\t\t\t\t'routes',\n\t\t\t\tprops.handlers.message.function,\n\t\t\t),\n\t\t});\n\n\t\t/**\n\t\t * WebSocket stage deployment\n\t\t * Auto-deploy ensures changes are immediately available\n\t\t */\n\t\tconst webSocketStage = new WebSocketStage(this, `${id}_stage`, {\n\t\t\t...props.options?.webSocketStageOptions,\n\t\t\twebSocketApi: this.socketApi,\n\t\t\tautoDeploy: true,\n\t\t});\n\n\t\t/**\n\t\t * CloudFormation output exposing WebSocket endpoint URL\n\t\t */\n\t\tnew CfnOutput(this, 'WebSocketURL', {\n\t\t\tvalue: webSocketStage.url,\n\t\t});\n\t}\n}\n"]}
|
package/dist/{aws/cdk/constructs/api-gateway-construct.cjs → aws-cdk/constructs/api-gateway.cjs}
RENAMED
|
@@ -84,12 +84,15 @@ var BaseApiGatewayConstruct = class _BaseApiGatewayConstruct extends constructs.
|
|
|
84
84
|
this.addRoutes(resource, route.children, integration, currentPath);
|
|
85
85
|
}
|
|
86
86
|
if (this.enableDebug) {
|
|
87
|
-
toolkit.printLog(
|
|
87
|
+
toolkit.printLog(
|
|
88
|
+
_BaseApiGatewayConstruct.name,
|
|
89
|
+
`Route created: ${route.method} ${currentPath}`
|
|
90
|
+
);
|
|
88
91
|
}
|
|
89
92
|
});
|
|
90
93
|
}
|
|
91
94
|
};
|
|
92
95
|
|
|
93
96
|
exports.BaseApiGatewayConstruct = BaseApiGatewayConstruct;
|
|
94
|
-
//# sourceMappingURL=api-gateway
|
|
95
|
-
//# sourceMappingURL=api-gateway
|
|
97
|
+
//# sourceMappingURL=api-gateway.cjs.map
|
|
98
|
+
//# sourceMappingURL=api-gateway.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-construct.ts"],"names":["Construct","RestApi","Cors","Size","LambdaIntegration","RemovalPolicy","CfnOutput","printLog"],"mappings":";;;;;;;;;AAoEO,IAAM,uBAAA,GAAN,MAAM,wBAAA,SACJA,oBAAA,CAET;AAAA,EAvEA;AAuEA,IAAA,MAAA,CAAA,IAAA,EAAA,yBAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CAAY,KAAA,EAAkB,EAAA,EAAY,KAAA,EAAkC;AAC3E,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAIC,qBAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,8BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,2BAAA,EAA6B;AAAA,QAC5B,GAAG,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA;AAAA;AAAA,QAGnC,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgBC,kBAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgBA,kBAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,YAAA,EAAc;AAAA,UACb,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC/B,YAAA;AAAA,UACH,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACD,OACD;AAAA;AAAA,MAGA,oBACC,KAAA,EAAO,OAAA,EAAS,gBAAgB,kBAAA,IAAsBC,cAAA,CAAK,MAAM,CAAC;AAAA,KACnE,CAAA;AAKD,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,IAAU,OAAO,eAAA,EAAiB;AACnE,MAAA,MAAM,WAAA,GAAc,IAAIC,+BAAA,CAAkB,KAAA,CAAM,eAAe,CAAA;AAK/D,MAAA,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,CAAI,MAAM,KAAA,CAAM,OAAA,CAAQ,cAAc,WAAW,CAAA;AAAA,IACtE;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmBC,uBAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAIC,mBAAA,CAAU,MAAM,YAAA,EAAc;AAAA,MACjC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBQ,SAAA,CACP,MAAA,EACA,MAAA,EACA,WAAA,EACA,YAAA,EACC;AACD,IAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACzB,MAAA,MAAM,cAAc,CAAA,EAAG,YAAA,IAAgB,EAAE,CAAA,CAAA,EAAI,MAAM,IAAI,CAAA,CAAA;AAEvD,MAAA,MAAM,QAAA,GAAW,MAAA,CAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AAG9C,MAAA,QAAA,CAAS,SAAA,CAAU,KAAA,CAAM,MAAA,EAAQ,WAAW,CAAA;AAG5C,MAAA,IAAI,KAAA,EAAO,SAAS,MAAA,EAAQ;AAC3B,QAAA,IAAA,CAAK,SAAA,CAAU,QAAA,EAAU,KAAA,CAAM,QAAA,EAAU,aAAa,WAAW,CAAA;AAAA,MAClE;AAGA,MAAA,IAAI,KAAK,WAAA,EAAa;AACrB,QAAAC,gBAAA;AAAA,UACC,wBAAA,CAAwB,IAAA;AAAA,UACxB,CAAA,eAAA,EAAkB,KAAA,CAAM,MAAM,CAAA,CAAA,EAAI,WAAW,CAAA;AAAA,SAC9C;AAAA,MACD;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AACD","file":"api-gateway.cjs","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';\nimport { CfnOutput, RemovalPolicy, Size } from 'aws-cdk-lib';\nimport {\n\tCors,\n\tIResource,\n\tLambdaIntegration,\n\tRestApi,\n\tRestApiProps,\n} from 'aws-cdk-lib/aws-apigateway';\n\nimport { printLog } from '@incloodsolutions/toolkit';\n\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Route definition for API Gateway resources\n *\n * Supports hierarchical route structures using `children`\n */\ninterface IRouteOption {\n\t/** Path segment (e.g. 'users', 'orders') */\n\tname: string;\n\n\t/** HTTP method for the route */\n\tmethod: `${HttpMethod}`;\n\n\t/** Nested routes under this path */\n\tchildren?: IRouteOption[];\n}\n\n/**\n * Props for BaseApiGatewayConstruct\n *\n * Provides configuration for:\n * - REST API (API Gateway v1)\n * - Route definitions\n * - Lambda handler\n */\ninterface IApiGatewayConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** REST API configuration options */\n\t\treadonly gatewayOptions: RestApiProps;\n\n\t\t/** Route definitions used to build API resources */\n\t\treadonly routeOptions: IRouteOption[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda function handling all API routes\n\t *\n\t * Note:\n\t * A single Lambda integration is reused across all routes\n\t */\n\treadonly handlerFunction: Function;\n}\n\n/**\n * CDK construct for REST API Gateway with Lambda integration\n *\n * Responsibilities:\n * - Creates a REST API with configurable options\n * - Applies default CORS and compression settings when not provided\n * - Recursively builds API resources from route definitions\n * - Exposes API base URL as a CloudFormation output\n */\nexport class BaseApiGatewayConstruct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created REST API instance */\n\treadonly api: RestApi;\n\n\t/** Enables debug logging for route creation */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and Lambda handler\n\t */\n\tconstructor(scope: Construct, id: string, props: IApiGatewayConstructProps) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new RestApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is a REST API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all origins, methods, and standard headers\n\t\t\t */\n\t\t\tdefaultCorsPreflightOptions: {\n\t\t\t\t...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,\n\n\t\t\t\t/** Allow all origins by default */\n\t\t\t\tallowOrigins:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowOrigins || Cors.ALL_ORIGINS,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowMethods || Cors.ALL_METHODS,\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t...props.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowHeaders,\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t],\n\t\t\t},\n\n\t\t\t/** Minimum payload size (in bytes) before compression is applied */\n\t\t\tminCompressionSize:\n\t\t\t\tprops?.options?.gatewayOptions?.minCompressionSize || Size.bytes(1),\n\t\t});\n\n\t\t/**\n\t\t * Register routes if provided\n\t\t */\n\t\tif (props?.options?.routeOptions?.length && props?.handlerFunction) {\n\t\t\tconst integration = new LambdaIntegration(props.handlerFunction);\n\n\t\t\t/**\n\t\t\t * Attach routes recursively starting from API root\n\t\t\t */\n\t\t\tthis.addRoutes(this.api.root, props.options.routeOptions, integration);\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGateway', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n\n\t/**\n\t * Recursively attaches routes to the API Gateway\n\t *\n\t * Behaviour:\n\t * - Creates a resource for each route segment\n\t * - Attaches method + Lambda integration\n\t * - Traverses child routes for nested paths\n\t *\n\t * @param parent Parent API resource\n\t * @param routes Route definitions\n\t * @param integration Lambda integration applied to each route\n\t * @param previousPath Accumulated path (used for debug logging)\n\t * @private\n\t */\n\tprivate addRoutes(\n\t\tparent: IResource,\n\t\troutes: IRouteOption[],\n\t\tintegration: LambdaIntegration,\n\t\tpreviousPath?: string,\n\t) {\n\t\troutes.forEach((route) => {\n\t\t\tconst currentPath = `${previousPath || ''}/${route.name}`;\n\n\t\t\tconst resource = parent.addResource(route.name);\n\n\t\t\t/** Attach HTTP method with Lambda integration */\n\t\t\tresource.addMethod(route.method, integration);\n\n\t\t\t/** Recursively process child routes */\n\t\t\tif (route?.children.length) {\n\t\t\t\tthis.addRoutes(resource, route.children, integration, currentPath);\n\t\t\t}\n\n\t\t\t/** Optional debug logging */\n\t\t\tif (this.enableDebug) {\n\t\t\t\tprintLog(\n\t\t\t\t\tBaseApiGatewayConstruct.name,\n\t\t\t\t\t`Route created: ${route.method} ${currentPath}`,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n}\n"]}
|
package/dist/{aws/cdk/constructs/api-gateway-construct.d.ts → aws-cdk/constructs/api-gateway.d.cts}
RENAMED
|
@@ -2,8 +2,9 @@ import { Construct } from 'constructs';
|
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
4
|
import { RestApi, RestApiProps } from 'aws-cdk-lib/aws-apigateway';
|
|
5
|
-
import { IBaseConstruct, IBaseCdkConstructProps } from '../../types
|
|
5
|
+
import { IBaseConstruct, IBaseCdkConstructProps } from '../../aws-types.cjs';
|
|
6
6
|
import '@incloodsolutions/toolkit';
|
|
7
|
+
import 'aws-cdk-lib';
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
10
|
* Route definition for API Gateway resources
|
package/dist/{aws/cdk/constructs/api-gateway-construct.d.cts → aws-cdk/constructs/api-gateway.d.ts}
RENAMED
|
@@ -2,8 +2,9 @@ import { Construct } from 'constructs';
|
|
|
2
2
|
import { Function } from 'aws-cdk-lib/aws-lambda';
|
|
3
3
|
import { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';
|
|
4
4
|
import { RestApi, RestApiProps } from 'aws-cdk-lib/aws-apigateway';
|
|
5
|
-
import { IBaseConstruct, IBaseCdkConstructProps } from '../../types
|
|
5
|
+
import { IBaseConstruct, IBaseCdkConstructProps } from '../../aws-types.js';
|
|
6
6
|
import '@incloodsolutions/toolkit';
|
|
7
|
+
import 'aws-cdk-lib';
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
10
|
* Route definition for API Gateway resources
|
package/dist/{aws/cdk/constructs/api-gateway-construct.js → aws-cdk/constructs/api-gateway.js}
RENAMED
|
@@ -82,12 +82,15 @@ var BaseApiGatewayConstruct = class _BaseApiGatewayConstruct extends Construct {
|
|
|
82
82
|
this.addRoutes(resource, route.children, integration, currentPath);
|
|
83
83
|
}
|
|
84
84
|
if (this.enableDebug) {
|
|
85
|
-
printLog(
|
|
85
|
+
printLog(
|
|
86
|
+
_BaseApiGatewayConstruct.name,
|
|
87
|
+
`Route created: ${route.method} ${currentPath}`
|
|
88
|
+
);
|
|
86
89
|
}
|
|
87
90
|
});
|
|
88
91
|
}
|
|
89
92
|
};
|
|
90
93
|
|
|
91
94
|
export { BaseApiGatewayConstruct };
|
|
92
|
-
//# sourceMappingURL=api-gateway
|
|
93
|
-
//# sourceMappingURL=api-gateway
|
|
95
|
+
//# sourceMappingURL=api-gateway.js.map
|
|
96
|
+
//# sourceMappingURL=api-gateway.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/api-gateway-construct.ts"],"names":[],"mappings":";;;;;;;AAoEO,IAAM,uBAAA,GAAN,MAAM,wBAAA,SACJ,SAAA,CAET;AAAA,EAvEA;AAuEA,IAAA,MAAA,CAAA,IAAA,EAAA,yBAAA,CAAA;AAAA;AAAA;AAAA,EAEU,GAAA;AAAA;AAAA,EAGT,WAAA,GAAc,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,WAAA,CAAY,KAAA,EAAkB,EAAA,EAAY,KAAA,EAAkC;AAC3E,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,cAAc,KAAA,CAAM,WAAA;AAEzB,IAAA,IAAA,CAAK,GAAA,GAAM,IAAI,OAAA,CAAQ,IAAA,EAAM,EAAA,EAAI;AAAA,MAChC,GAAG,OAAO,OAAA,EAAS,cAAA;AAAA;AAAA,MAGnB,WAAA,EACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,WAAA,IAChC,8BAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMD,2BAAA,EAA6B;AAAA,QAC5B,GAAG,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA;AAAA;AAAA,QAGnC,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgB,IAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,cACC,KAAA,EAAO,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC7B,gBAAgB,IAAA,CAAK,WAAA;AAAA;AAAA,QAGzB,YAAA,EAAc;AAAA,UACb,GAAG,KAAA,CAAM,OAAA,EAAS,cAAA,EAAgB,2BAAA,EAC/B,YAAA;AAAA,UACH,cAAA;AAAA,UACA,QAAA;AAAA,UACA,YAAA;AAAA,UACA,eAAA;AAAA,UACA,WAAA;AAAA,UACA,sBAAA;AAAA,UACA;AAAA;AACD,OACD;AAAA;AAAA,MAGA,oBACC,KAAA,EAAO,OAAA,EAAS,gBAAgB,kBAAA,IAAsB,IAAA,CAAK,MAAM,CAAC;AAAA,KACnE,CAAA;AAKD,IAAA,IAAI,KAAA,EAAO,OAAA,EAAS,YAAA,EAAc,MAAA,IAAU,OAAO,eAAA,EAAiB;AACnE,MAAA,MAAM,WAAA,GAAc,IAAI,iBAAA,CAAkB,KAAA,CAAM,eAAe,CAAA;AAK/D,MAAA,IAAA,CAAK,UAAU,IAAA,CAAK,GAAA,CAAI,MAAM,KAAA,CAAM,OAAA,CAAQ,cAAc,WAAW,CAAA;AAAA,IACtE;AAKA,IAAA,IAAA,CAAK,GAAA,CAAI,kBAAA,CAAmB,aAAA,CAAc,OAAO,CAAA;AAKjD,IAAA,IAAI,SAAA,CAAU,MAAM,YAAA,EAAc;AAAA,MACjC,KAAA,EAAO,KAAK,GAAA,CAAI;AAAA,KAChB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBQ,SAAA,CACP,MAAA,EACA,MAAA,EACA,WAAA,EACA,YAAA,EACC;AACD,IAAA,MAAA,CAAO,OAAA,CAAQ,CAAC,KAAA,KAAU;AACzB,MAAA,MAAM,cAAc,CAAA,EAAG,YAAA,IAAgB,EAAE,CAAA,CAAA,EAAI,MAAM,IAAI,CAAA,CAAA;AAEvD,MAAA,MAAM,QAAA,GAAW,MAAA,CAAO,WAAA,CAAY,KAAA,CAAM,IAAI,CAAA;AAG9C,MAAA,QAAA,CAAS,SAAA,CAAU,KAAA,CAAM,MAAA,EAAQ,WAAW,CAAA;AAG5C,MAAA,IAAI,KAAA,EAAO,SAAS,MAAA,EAAQ;AAC3B,QAAA,IAAA,CAAK,SAAA,CAAU,QAAA,EAAU,KAAA,CAAM,QAAA,EAAU,aAAa,WAAW,CAAA;AAAA,MAClE;AAGA,MAAA,IAAI,KAAK,WAAA,EAAa;AACrB,QAAA,QAAA;AAAA,UACC,wBAAA,CAAwB,IAAA;AAAA,UACxB,CAAA,eAAA,EAAkB,KAAA,CAAM,MAAM,CAAA,CAAA,EAAI,WAAW,CAAA;AAAA,SAC9C;AAAA,MACD;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AACD","file":"api-gateway.js","sourcesContent":["import { Construct } from 'constructs';\nimport { Function } from 'aws-cdk-lib/aws-lambda';\nimport { HttpMethod } from 'aws-cdk-lib/aws-apigatewayv2';\nimport { CfnOutput, RemovalPolicy, Size } from 'aws-cdk-lib';\nimport {\n\tCors,\n\tIResource,\n\tLambdaIntegration,\n\tRestApi,\n\tRestApiProps,\n} from 'aws-cdk-lib/aws-apigateway';\n\nimport { printLog } from '@incloodsolutions/toolkit';\n\nimport { IBaseCdkConstructProps, IBaseConstruct } from '../../types';\n\n/**\n * Route definition for API Gateway resources\n *\n * Supports hierarchical route structures using `children`\n */\ninterface IRouteOption {\n\t/** Path segment (e.g. 'users', 'orders') */\n\tname: string;\n\n\t/** HTTP method for the route */\n\tmethod: `${HttpMethod}`;\n\n\t/** Nested routes under this path */\n\tchildren?: IRouteOption[];\n}\n\n/**\n * Props for BaseApiGatewayConstruct\n *\n * Provides configuration for:\n * - REST API (API Gateway v1)\n * - Route definitions\n * - Lambda handler\n */\ninterface IApiGatewayConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** REST API configuration options */\n\t\treadonly gatewayOptions: RestApiProps;\n\n\t\t/** Route definitions used to build API resources */\n\t\treadonly routeOptions: IRouteOption[];\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {\n\t/**\n\t * Lambda function handling all API routes\n\t *\n\t * Note:\n\t * A single Lambda integration is reused across all routes\n\t */\n\treadonly handlerFunction: Function;\n}\n\n/**\n * CDK construct for REST API Gateway with Lambda integration\n *\n * Responsibilities:\n * - Creates a REST API with configurable options\n * - Applies default CORS and compression settings when not provided\n * - Recursively builds API resources from route definitions\n * - Exposes API base URL as a CloudFormation output\n */\nexport class BaseApiGatewayConstruct\n\textends Construct\n\timplements IBaseConstruct\n{\n\t/** The created REST API instance */\n\treadonly api: RestApi;\n\n\t/** Enables debug logging for route creation */\n\tenableDebug = false;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for API, routes, and Lambda handler\n\t */\n\tconstructor(scope: Construct, id: string, props: IApiGatewayConstructProps) {\n\t\tsuper(scope, id);\n\n\t\tthis.enableDebug = props.enableDebug;\n\n\t\tthis.api = new RestApi(this, id, {\n\t\t\t...props?.options?.gatewayOptions,\n\n\t\t\t/** Default API description if not provided */\n\t\t\tdescription:\n\t\t\t\tprops?.options?.gatewayOptions?.description ||\n\t\t\t\t'This is a REST API using CDK',\n\n\t\t\t/**\n\t\t\t * CORS configuration\n\t\t\t * Falls back to allowing all origins, methods, and standard headers\n\t\t\t */\n\t\t\tdefaultCorsPreflightOptions: {\n\t\t\t\t...props?.options?.gatewayOptions?.defaultCorsPreflightOptions,\n\n\t\t\t\t/** Allow all origins by default */\n\t\t\t\tallowOrigins:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowOrigins || Cors.ALL_ORIGINS,\n\n\t\t\t\t/** Allow all HTTP methods by default */\n\t\t\t\tallowMethods:\n\t\t\t\t\tprops?.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowMethods || Cors.ALL_METHODS,\n\n\t\t\t\t/** Merge default headers with user-defined headers */\n\t\t\t\tallowHeaders: [\n\t\t\t\t\t...props.options?.gatewayOptions?.defaultCorsPreflightOptions\n\t\t\t\t\t\t?.allowHeaders,\n\t\t\t\t\t'Content-Type',\n\t\t\t\t\t'Accept',\n\t\t\t\t\t'X-Amz-Date',\n\t\t\t\t\t'Authorization',\n\t\t\t\t\t'X-Api-Key',\n\t\t\t\t\t'X-Amz-Security-Token',\n\t\t\t\t\t'X-Amz-User-Agent',\n\t\t\t\t],\n\t\t\t},\n\n\t\t\t/** Minimum payload size (in bytes) before compression is applied */\n\t\t\tminCompressionSize:\n\t\t\t\tprops?.options?.gatewayOptions?.minCompressionSize || Size.bytes(1),\n\t\t});\n\n\t\t/**\n\t\t * Register routes if provided\n\t\t */\n\t\tif (props?.options?.routeOptions?.length && props?.handlerFunction) {\n\t\t\tconst integration = new LambdaIntegration(props.handlerFunction);\n\n\t\t\t/**\n\t\t\t * Attach routes recursively starting from API root\n\t\t\t */\n\t\t\tthis.addRoutes(this.api.root, props.options.routeOptions, integration);\n\t\t}\n\n\t\t/**\n\t\t * Apply removal policy (useful for non-production environments)\n\t\t */\n\t\tthis.api.applyRemovalPolicy(RemovalPolicy.DESTROY);\n\n\t\t/**\n\t\t * CloudFormation output exposing API base URL\n\t\t */\n\t\tnew CfnOutput(this, 'ApiGateway', {\n\t\t\tvalue: this.api.url,\n\t\t});\n\t}\n\n\t/**\n\t * Recursively attaches routes to the API Gateway\n\t *\n\t * Behaviour:\n\t * - Creates a resource for each route segment\n\t * - Attaches method + Lambda integration\n\t * - Traverses child routes for nested paths\n\t *\n\t * @param parent Parent API resource\n\t * @param routes Route definitions\n\t * @param integration Lambda integration applied to each route\n\t * @param previousPath Accumulated path (used for debug logging)\n\t * @private\n\t */\n\tprivate addRoutes(\n\t\tparent: IResource,\n\t\troutes: IRouteOption[],\n\t\tintegration: LambdaIntegration,\n\t\tpreviousPath?: string,\n\t) {\n\t\troutes.forEach((route) => {\n\t\t\tconst currentPath = `${previousPath || ''}/${route.name}`;\n\n\t\t\tconst resource = parent.addResource(route.name);\n\n\t\t\t/** Attach HTTP method with Lambda integration */\n\t\t\tresource.addMethod(route.method, integration);\n\n\t\t\t/** Recursively process child routes */\n\t\t\tif (route?.children.length) {\n\t\t\t\tthis.addRoutes(resource, route.children, integration, currentPath);\n\t\t\t}\n\n\t\t\t/** Optional debug logging */\n\t\t\tif (this.enableDebug) {\n\t\t\t\tprintLog(\n\t\t\t\t\tBaseApiGatewayConstruct.name,\n\t\t\t\t\t`Route created: ${route.method} ${currentPath}`,\n\t\t\t\t);\n\t\t\t}\n\t\t});\n\t}\n}\n"]}
|
package/dist/{aws/cdk/constructs/cloudfront-construct.cjs → aws-cdk/constructs/cloudfront.cjs}
RENAMED
|
@@ -64,5 +64,5 @@ var BaseCloudfrontConstruct = class extends constructs.Construct {
|
|
|
64
64
|
};
|
|
65
65
|
|
|
66
66
|
exports.BaseCloudfrontConstruct = BaseCloudfrontConstruct;
|
|
67
|
-
//# sourceMappingURL=cloudfront
|
|
68
|
-
//# sourceMappingURL=cloudfront
|
|
67
|
+
//# sourceMappingURL=cloudfront.cjs.map
|
|
68
|
+
//# sourceMappingURL=cloudfront.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/aws/cdk/constructs/cloudfront-construct.ts"],"names":["Construct","Distribution","ViewerProtocolPolicy","Duration"],"mappings":";;;;;;;;AAgCO,IAAM,uBAAA,GAAN,cAAsCA,oBAAA,CAAU;AAAA,EAhCvD;AAgCuD,IAAA,MAAA,CAAA,IAAA,EAAA,yBAAA,CAAA;AAAA;AAAA;AAAA,EAE7C,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAA,CAAY,KAAA,EAAkB,EAAA,EAAY,KAAA,EAAkC;AAC3E,IAAA,KAAA,CAAM,OAAO,EAAE,CAAA;AAEf,IAAA,IAAA,CAAK,YAAA,GAAe,IAAIC,0BAAA,CAAa,IAAA,EAAM,EAAA,EAAI;AAAA,MAC9C,GAAG,MAAM,OAAA,EAAS,iBAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMlB,eAAA,EAAiB;AAAA,QAChB,GAAG,KAAA,CAAM,OAAA,EAAS,iBAAA,EAAmB,eAAA;AAAA,QACrC,sBACC,KAAA,CAAM,OAAA,EAAS,iBAAA,EAAmB,eAAA,EAC/B,wBAAwBC,kCAAA,CAAqB;AAAA,OAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQA,cAAA,EAAgB;AAAA,QACf,GAAI,KAAA,CAAM,OAAA,EAAS,iBAAA,EAAmB,kBAAkB,EAAC;AAAA;AAAA,QAGzD;AAAA,UACC,UAAA,EAAY,GAAA;AAAA,UACZ,kBAAA,EAAoB,GAAA;AAAA,UACpB,gBAAA,EAAkB,aAAA;AAAA,UAClB,GAAA,EAAKC,kBAAA,CAAS,IAAA,CAAK,CAAC;AAAA,SACrB;AAAA;AAAA,QAGA;AAAA,UACC,UAAA,EAAY,GAAA;AAAA,UACZ,kBAAA,EAAoB,GAAA;AAAA,UACpB,gBAAA,EAAkB,aAAA;AAAA,UAClB,GAAA,EAAKA,kBAAA,CAAS,IAAA,CAAK,CAAC;AAAA,SACrB;AAAA;AAAA,QAGA;AAAA,UACC,UAAA,EAAY,GAAA;AAAA,UACZ,kBAAA,EAAoB,GAAA;AAAA,UACpB,gBAAA,EAAkB,aAAA;AAAA,UAClB,GAAA,EAAKA,kBAAA,CAAS,IAAA,CAAK,CAAC;AAAA;AACrB;AACD,KACA,CAAA;AAAA,EACF;AACD","file":"cloudfront.cjs","sourcesContent":["import { Construct } from 'constructs';\nimport { Duration } from 'aws-cdk-lib';\nimport {\n\tDistribution,\n\tDistributionProps,\n\tViewerProtocolPolicy,\n} from 'aws-cdk-lib/aws-cloudfront';\n\nimport { IBaseCdkConstructProps } from '../../types';\n\n/**\n * Props for BaseCloudfrontConstruct\n *\n * Provides configuration for creating a CloudFront distribution\n * with optional overrides for default behaviour and error handling.\n */\ninterface ICloudfrontConstructProps extends Omit<\n\tIBaseCdkConstructProps<{\n\t\t/** Partial configuration for the CloudFront distribution */\n\t\treadonly cloudfrontOptions: Partial<DistributionProps>;\n\t}>,\n\t'appName' | 'stage' | 'stackName'\n> {}\n\n/**\n * CDK construct for CloudFront distribution\n *\n * Responsibilities:\n * - Creates a CloudFront distribution with configurable options\n * - Enforces HTTPS redirection by default\n * - Adds fallback error responses for SPA routing (400, 403, 404 → index.html)\n */\nexport class BaseCloudfrontConstruct extends Construct {\n\t/** The created CloudFront distribution instance */\n\treadonly distribution: Distribution;\n\n\t/**\n\t * @param scope Parent construct\n\t * @param id Unique construct identifier\n\t * @param props Configuration for CloudFront distribution\n\t */\n\tconstructor(scope: Construct, id: string, props: ICloudfrontConstructProps) {\n\t\tsuper(scope, id);\n\n\t\tthis.distribution = new Distribution(this, id, {\n\t\t\t...props.options?.cloudfrontOptions,\n\n\t\t\t/**\n\t\t\t * Default behaviour configuration\n\t\t\t * Enforces HTTPS if not explicitly defined\n\t\t\t */\n\t\t\tdefaultBehavior: {\n\t\t\t\t...props.options?.cloudfrontOptions?.defaultBehavior,\n\t\t\t\tviewerProtocolPolicy:\n\t\t\t\t\tprops.options?.cloudfrontOptions?.defaultBehavior\n\t\t\t\t\t\t?.viewerProtocolPolicy || ViewerProtocolPolicy.REDIRECT_TO_HTTPS,\n\t\t\t},\n\n\t\t\t/**\n\t\t\t * Error response configuration\n\t\t\t *\n\t\t\t * Adds SPA-friendly fallbacks:\n\t\t\t * - 400, 403, 404 responses are redirected to index.html\n\t\t\t */\n\t\t\terrorResponses: [\n\t\t\t\t...(props.options?.cloudfrontOptions?.errorResponses || []),\n\n\t\t\t\t/** Handle 400 errors */\n\t\t\t\t{\n\t\t\t\t\thttpStatus: 400,\n\t\t\t\t\tresponseHttpStatus: 200,\n\t\t\t\t\tresponsePagePath: '/index.html',\n\t\t\t\t\tttl: Duration.days(1),\n\t\t\t\t},\n\n\t\t\t\t/** Handle 403 errors */\n\t\t\t\t{\n\t\t\t\t\thttpStatus: 403,\n\t\t\t\t\tresponseHttpStatus: 200,\n\t\t\t\t\tresponsePagePath: '/index.html',\n\t\t\t\t\tttl: Duration.days(1),\n\t\t\t\t},\n\n\t\t\t\t/** Handle 404 errors */\n\t\t\t\t{\n\t\t\t\t\thttpStatus: 404,\n\t\t\t\t\tresponseHttpStatus: 200,\n\t\t\t\t\tresponsePagePath: '/index.html',\n\t\t\t\t\tttl: Duration.days(1),\n\t\t\t\t},\n\t\t\t],\n\t\t});\n\t}\n}\n"]}
|