@lambda-kata/cdk 0.1.0
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/LICENSE +201 -0
- package/README.md +169 -0
- package/lib/account-resolver.d.ts +103 -0
- package/lib/config-layer.d.ts +168 -0
- package/lib/index.d.ts +25 -0
- package/lib/kata-wrapper.d.ts +219 -0
- package/lib/licensing.d.ts +113 -0
- package/lib/mock-licensing.d.ts +200 -0
- package/lib/types.d.ts +113 -0
- package/out/dist/index.js +60 -0
- package/package.json +75 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# @lambda-kata/cdk
|
|
2
|
+
|
|
3
|
+
AWS CDK integration for Lambda Kata - Transform Node.js Lambda functions to run via the Lambda Kata runtime.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @lambda-kata/cdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { kata } from '@lambda-kata/cdk';
|
|
15
|
+
import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
|
|
16
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
17
|
+
import { Construct } from 'constructs';
|
|
18
|
+
|
|
19
|
+
export class MyStack extends Stack {
|
|
20
|
+
constructor(scope: Construct, id: string, props?: StackProps) {
|
|
21
|
+
super(scope, id, props);
|
|
22
|
+
|
|
23
|
+
const myFunction = new NodejsFunction(this, 'MyFunction', {
|
|
24
|
+
entry: 'src/handler.ts',
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
// Transform to use Lambda Kata runtime
|
|
28
|
+
kata(myFunction);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## How It Works
|
|
34
|
+
|
|
35
|
+
The `kata()` wrapper transforms your Node.js Lambda function to run via the Lambda Kata runtime:
|
|
36
|
+
|
|
37
|
+
1. **Runtime Change**: Switches from Node.js to Python 3.12
|
|
38
|
+
2. **Handler Update**: Sets handler to `lambdakata.optimized_handler.lambda_handler`
|
|
39
|
+
3. **Layer Attachment**: Attaches the customer-specific Lambda Kata Layer
|
|
40
|
+
4. **Config Layer**: Creates a config layer with handler path at `/opt/.kata/original_handler.json`
|
|
41
|
+
|
|
42
|
+
Your original JavaScript/TypeScript code remains unchanged - the Lambda Kata runtime executes it through an embedded Node.js engine.
|
|
43
|
+
|
|
44
|
+
## Custom Handler Resolution
|
|
45
|
+
|
|
46
|
+
Lambda Kata supports two ways to customize how handlers are resolved:
|
|
47
|
+
|
|
48
|
+
### Option 1: Inline Handler Resolver (Recommended)
|
|
49
|
+
|
|
50
|
+
Write the resolver function directly in your CDK code:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
kata(myFunction, {
|
|
54
|
+
handlerResolver: (bundle, ctx) => {
|
|
55
|
+
const handlerName = ctx.originalHandler.split('.').pop() as string;
|
|
56
|
+
return (bundle as Record<string, Function>)[handlerName];
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The function is:
|
|
62
|
+
1. Serialized to a temporary TypeScript file
|
|
63
|
+
2. Compiled with esbuild
|
|
64
|
+
3. Included in the config layer as `/opt/.kata/middleware.js`
|
|
65
|
+
|
|
66
|
+
**Use cases:**
|
|
67
|
+
- Handler wrapping with logging/metrics
|
|
68
|
+
- Environment-based handler selection
|
|
69
|
+
- Multi-handler routing
|
|
70
|
+
|
|
71
|
+
**Example with logging wrapper:**
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
kata(myFunction, {
|
|
75
|
+
handlerResolver: (bundle, ctx) => {
|
|
76
|
+
const handlerName = ctx.originalHandler.split('.').pop() as string;
|
|
77
|
+
const originalHandler = (bundle as Record<string, Function>)[handlerName];
|
|
78
|
+
|
|
79
|
+
// Wrap with logging
|
|
80
|
+
return async (event: unknown, lambdaCtx: unknown) => {
|
|
81
|
+
console.log('Invocation started', { handler: handlerName });
|
|
82
|
+
const start = Date.now();
|
|
83
|
+
try {
|
|
84
|
+
const result = await originalHandler(event, lambdaCtx);
|
|
85
|
+
console.log('Invocation completed', { durationMs: Date.now() - start });
|
|
86
|
+
return result;
|
|
87
|
+
} catch (error) {
|
|
88
|
+
console.error('Invocation failed', { error });
|
|
89
|
+
throw error;
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
},
|
|
93
|
+
});
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Option 2: Middleware File
|
|
97
|
+
|
|
98
|
+
For complex middleware logic, use a separate TypeScript file:
|
|
99
|
+
|
|
100
|
+
```typescript
|
|
101
|
+
kata(myFunction, {
|
|
102
|
+
middlewarePath: path.join(__dirname, 'middleware.ts'),
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
See [Middleware Example](./examples/middleware-example/README.md) for details.
|
|
107
|
+
|
|
108
|
+
## Handler Resolver Function Signature
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
type HandlerResolver = (
|
|
112
|
+
bundle: unknown,
|
|
113
|
+
context: { originalHandler: string }
|
|
114
|
+
) => Function;
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
| Parameter | Description |
|
|
118
|
+
|-----------|-------------|
|
|
119
|
+
| `bundle` | The loaded JavaScript bundle (result of `require()`) |
|
|
120
|
+
| `context.originalHandler` | The original handler path (e.g., `"index.handler"`) |
|
|
121
|
+
| **Returns** | The handler function to invoke |
|
|
122
|
+
|
|
123
|
+
**Important:** The function must be pure (no closures over external CDK variables) because it's serialized via `.toString()`.
|
|
124
|
+
|
|
125
|
+
## API Reference
|
|
126
|
+
|
|
127
|
+
### `kata(lambda, options?)`
|
|
128
|
+
|
|
129
|
+
Transforms a Node.js Lambda function to use Lambda Kata runtime.
|
|
130
|
+
|
|
131
|
+
**Parameters:**
|
|
132
|
+
|
|
133
|
+
| Parameter | Type | Description |
|
|
134
|
+
|-----------|------|-------------|
|
|
135
|
+
| `lambda` | `NodejsFunction \| Function` | The Lambda function to transform |
|
|
136
|
+
| `options` | `KataWrapperOptions` | Optional configuration |
|
|
137
|
+
|
|
138
|
+
**Options:**
|
|
139
|
+
|
|
140
|
+
| Option | Type | Description |
|
|
141
|
+
|--------|------|-------------|
|
|
142
|
+
| `unlicensedBehavior` | `'warn' \| 'fail'` | Behavior when account is not licensed. Default: `'warn'` |
|
|
143
|
+
| `bundlePath` | `string` | Custom path to JavaScript bundle |
|
|
144
|
+
| `middlewarePath` | `string` | Path to middleware TypeScript/JavaScript file |
|
|
145
|
+
| `handlerResolver` | `Function` | Inline handler resolver function |
|
|
146
|
+
|
|
147
|
+
**Note:** `middlewarePath` and `handlerResolver` are mutually exclusive.
|
|
148
|
+
|
|
149
|
+
## Requirements
|
|
150
|
+
|
|
151
|
+
- AWS CDK v2
|
|
152
|
+
- Node.js 18+
|
|
153
|
+
- Valid AWS Marketplace subscription for Lambda Kata
|
|
154
|
+
|
|
155
|
+
## Examples
|
|
156
|
+
|
|
157
|
+
See the [examples](./examples) directory:
|
|
158
|
+
|
|
159
|
+
- [Basic Usage](./examples/example-stack.ts) - Simple kata() transformation
|
|
160
|
+
- [Middleware Example](./examples/middleware-example) - Custom handler resolution with middleware file
|
|
161
|
+
- [Config Layer Example](./examples/config-layer-example) - Handler path configuration
|
|
162
|
+
|
|
163
|
+
## Contributing
|
|
164
|
+
|
|
165
|
+
**Security:** Report vulnerabilities privately to [raman@worktif.com](mailto:raman@worktif.com)
|
|
166
|
+
|
|
167
|
+
## License
|
|
168
|
+
|
|
169
|
+
Apache-2.0
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Account ID Resolution for Lambda Kata CDK Integration
|
|
3
|
+
*
|
|
4
|
+
* This module provides functionality to determine the target AWS account ID
|
|
5
|
+
* during CDK synthesis/deploy time. The account ID is required for validating
|
|
6
|
+
* AWS Marketplace entitlements.
|
|
7
|
+
*
|
|
8
|
+
* Resolution strategies (in order of precedence):
|
|
9
|
+
* 1. CDK context value (explicit configuration)
|
|
10
|
+
* 2. Stack account (if not a token/unresolved)
|
|
11
|
+
* 3. STS GetCallerIdentity (fallback for runtime resolution)
|
|
12
|
+
*
|
|
13
|
+
* @module account-resolver
|
|
14
|
+
*/
|
|
15
|
+
import { Construct } from 'constructs';
|
|
16
|
+
import { STSClient } from '@aws-sdk/client-sts';
|
|
17
|
+
/**
|
|
18
|
+
* Error thrown when account ID cannot be resolved through any strategy.
|
|
19
|
+
*/
|
|
20
|
+
export declare class AccountResolutionError extends Error {
|
|
21
|
+
constructor(message: string);
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Result of account ID resolution, including the source of the resolution.
|
|
25
|
+
*/
|
|
26
|
+
export interface AccountResolutionResult {
|
|
27
|
+
/**
|
|
28
|
+
* The resolved AWS account ID (12-digit string)
|
|
29
|
+
*/
|
|
30
|
+
accountId: string;
|
|
31
|
+
/**
|
|
32
|
+
* The source/strategy that successfully resolved the account ID
|
|
33
|
+
*/
|
|
34
|
+
source: 'context' | 'stack' | 'sts';
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Options for account ID resolution.
|
|
38
|
+
*/
|
|
39
|
+
export interface AccountResolverOptions {
|
|
40
|
+
/**
|
|
41
|
+
* Custom STS client for testing or custom configuration.
|
|
42
|
+
* If not provided, a default client will be created.
|
|
43
|
+
*/
|
|
44
|
+
stsClient?: STSClient;
|
|
45
|
+
/**
|
|
46
|
+
* Whether to skip the STS fallback (useful for testing).
|
|
47
|
+
* Default: false
|
|
48
|
+
*/
|
|
49
|
+
skipStsFallback?: boolean;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Resolves the target AWS account ID for entitlement checking.
|
|
53
|
+
*
|
|
54
|
+
* This function attempts to determine the AWS account ID using multiple
|
|
55
|
+
* strategies in order of precedence:
|
|
56
|
+
*
|
|
57
|
+
* 1. **CDK Context**: Checks for `aws:cdk:account` context value
|
|
58
|
+
* 2. **Stack Account**: Uses the Stack's account if it's not a token
|
|
59
|
+
* 3. **STS Fallback**: Calls STS GetCallerIdentity as a last resort
|
|
60
|
+
*
|
|
61
|
+
* @param scope - The CDK construct scope to resolve the account for
|
|
62
|
+
* @param options - Optional configuration for resolution behavior
|
|
63
|
+
* @returns Promise resolving to the AWS account ID (12-digit string)
|
|
64
|
+
* @throws AccountResolutionError if account cannot be resolved through any strategy
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```typescript
|
|
68
|
+
* const accountId = await resolveAccountId(this);
|
|
69
|
+
* console.log(`Deploying to account: ${accountId}`);
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
* Validates: Requirements 3.1
|
|
74
|
+
* - WHEN `cdk deploy` is executed, THE kata_Wrapper SHALL determine the target AWS account ID
|
|
75
|
+
*/
|
|
76
|
+
export declare function resolveAccountId(scope: Construct, options?: AccountResolverOptions): Promise<string>;
|
|
77
|
+
/**
|
|
78
|
+
* Resolves the target AWS account ID with information about the resolution source.
|
|
79
|
+
*
|
|
80
|
+
* This is an extended version of `resolveAccountId` that also returns
|
|
81
|
+
* information about which strategy was used to resolve the account ID.
|
|
82
|
+
*
|
|
83
|
+
* @param scope - The CDK construct scope to resolve the account for
|
|
84
|
+
* @param options - Optional configuration for resolution behavior
|
|
85
|
+
* @returns Promise resolving to the account ID and resolution source
|
|
86
|
+
* @throws AccountResolutionError if account cannot be resolved through any strategy
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* const { accountId, source } = await resolveAccountIdWithSource(this);
|
|
91
|
+
* console.log(`Account ${accountId} resolved via ${source}`);
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
export declare function resolveAccountIdWithSource(scope: Construct, options?: AccountResolverOptions): Promise<AccountResolutionResult>;
|
|
95
|
+
/**
|
|
96
|
+
* Validates that a string is a valid AWS account ID format.
|
|
97
|
+
*
|
|
98
|
+
* AWS account IDs are exactly 12 digits.
|
|
99
|
+
*
|
|
100
|
+
* @param accountId - The string to validate
|
|
101
|
+
* @returns true if the string is a valid 12-digit account ID
|
|
102
|
+
*/
|
|
103
|
+
export declare function isValidAccountIdFormat(accountId: string): boolean;
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config Layer Generator for Lambda Kata CDK Integration
|
|
3
|
+
*
|
|
4
|
+
* This module provides functionality to create a Lambda Layer containing
|
|
5
|
+
* the kata configuration. The configuration includes the original Node.js
|
|
6
|
+
* handler path, which the Lambda Kata runtime reads during initialization.
|
|
7
|
+
*
|
|
8
|
+
* The config layer replaces the JS_HANDLER_PATH environment variable approach,
|
|
9
|
+
* providing cleaner separation between runtime configuration and environment variables.
|
|
10
|
+
*
|
|
11
|
+
* @module config-layer
|
|
12
|
+
*/
|
|
13
|
+
import { Construct } from 'constructs';
|
|
14
|
+
import { LayerVersion } from 'aws-cdk-lib/aws-lambda';
|
|
15
|
+
/**
|
|
16
|
+
* Configuration for the kata config layer.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```typescript
|
|
20
|
+
* const props: KataConfigLayerProps = {
|
|
21
|
+
* originalHandler: 'bundle.handler'
|
|
22
|
+
* };
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```typescript
|
|
27
|
+
* // With custom bundle path and middleware
|
|
28
|
+
* const props: KataConfigLayerProps = {
|
|
29
|
+
* originalHandler: 'index.handler',
|
|
30
|
+
* bundlePath: '/var/task/index.js',
|
|
31
|
+
* middlewarePath: './middleware.ts'
|
|
32
|
+
* };
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
export interface KataConfigLayerProps {
|
|
36
|
+
/**
|
|
37
|
+
* The original Node.js handler path (e.g., "bundle.handler").
|
|
38
|
+
*
|
|
39
|
+
* This value will be stored in the config layer and read by the
|
|
40
|
+
* Lambda Kata runtime during initialization.
|
|
41
|
+
*
|
|
42
|
+
* Format: "<module>.<function>" or "<path/module>.<function>"
|
|
43
|
+
* Examples: "bundle.handler", "src/index.handler", "dist/main.handler"
|
|
44
|
+
*/
|
|
45
|
+
originalHandler: string;
|
|
46
|
+
/**
|
|
47
|
+
* Path to the JavaScript bundle.
|
|
48
|
+
*
|
|
49
|
+
* When specified, the Lambda Kata runtime will load the bundle from this path
|
|
50
|
+
* instead of the default location. This allows using custom project layouts
|
|
51
|
+
* where the bundle is located in a different directory.
|
|
52
|
+
*
|
|
53
|
+
* If not specified, defaults to /opt/js_runtime/bundle.js
|
|
54
|
+
*
|
|
55
|
+
* @example "/var/task/index.js"
|
|
56
|
+
* @example "/var/task/dist/bundle.js"
|
|
57
|
+
*
|
|
58
|
+
* @remarks
|
|
59
|
+
* Validates: Requirement 4.1
|
|
60
|
+
*/
|
|
61
|
+
bundlePath?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Path to the middleware TypeScript/JavaScript source file.
|
|
64
|
+
*
|
|
65
|
+
* When specified, the middleware file will be compiled with esbuild and
|
|
66
|
+
* included in the config layer at /opt/.kata/middleware.js. The middleware
|
|
67
|
+
* module must export a function with signature: (bundle, context) => handler
|
|
68
|
+
*
|
|
69
|
+
* The context parameter includes:
|
|
70
|
+
* - originalHandler: The handler path (e.g., "index.handler")
|
|
71
|
+
*
|
|
72
|
+
* @example "./middleware.ts"
|
|
73
|
+
* @example "./src/custom-resolver.js"
|
|
74
|
+
*
|
|
75
|
+
* @remarks
|
|
76
|
+
* Validates: Requirement 5.1
|
|
77
|
+
*/
|
|
78
|
+
middlewarePath?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Inline handler resolver function.
|
|
81
|
+
*
|
|
82
|
+
* When specified, this function will be serialized to a temporary TypeScript file,
|
|
83
|
+
* compiled with esbuild, and included in the config layer at /opt/.kata/middleware.js.
|
|
84
|
+
*
|
|
85
|
+
* The function receives the loaded bundle and context with originalHandler,
|
|
86
|
+
* and must return the handler function.
|
|
87
|
+
*
|
|
88
|
+
* Note: The function must be pure (no closures over external variables)
|
|
89
|
+
* because it will be serialized via .toString()
|
|
90
|
+
*
|
|
91
|
+
* Cannot be used together with middlewarePath.
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```typescript
|
|
95
|
+
* handlerResolver: (bundle, ctx) => {
|
|
96
|
+
* const handlerName = ctx.originalHandler.split('.').pop();
|
|
97
|
+
* return bundle[handlerName];
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
handlerResolver?: (bundle: unknown, context: {
|
|
102
|
+
originalHandler: string;
|
|
103
|
+
}) => Function;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* The path where the config file will be located in the Lambda Layer.
|
|
107
|
+
* When the layer is attached to a Lambda, this file will be at /opt/.kata/original_handler.json
|
|
108
|
+
*/
|
|
109
|
+
export declare const CONFIG_DIR_NAME = ".kata";
|
|
110
|
+
/**
|
|
111
|
+
* The name of the config file within the .kata directory.
|
|
112
|
+
*/
|
|
113
|
+
export declare const CONFIG_FILE_NAME = "original_handler.json";
|
|
114
|
+
/**
|
|
115
|
+
* The key used in the JSON config file to store the handler path.
|
|
116
|
+
*/
|
|
117
|
+
export declare const HANDLER_CONFIG_KEY = "original_js_handler";
|
|
118
|
+
/**
|
|
119
|
+
* The name of the compiled middleware file within the .kata directory.
|
|
120
|
+
*/
|
|
121
|
+
export declare const MIDDLEWARE_FILE_NAME = "middleware.js";
|
|
122
|
+
/**
|
|
123
|
+
* Creates a Lambda Layer containing the kata configuration.
|
|
124
|
+
*
|
|
125
|
+
* The layer contains a single JSON file at /opt/.kata/original_handler.json
|
|
126
|
+
* with the original handler path. This file is read by the Lambda Kata
|
|
127
|
+
* runtime during initialization to determine which JavaScript handler to invoke.
|
|
128
|
+
*
|
|
129
|
+
* @param scope - The CDK construct scope
|
|
130
|
+
* @param id - The unique identifier for this layer within the scope
|
|
131
|
+
* @param props - Configuration properties including the original handler path
|
|
132
|
+
* @returns A LayerVersion construct containing the configuration
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* ```typescript
|
|
136
|
+
* import { createKataConfigLayer } from './config-layer';
|
|
137
|
+
*
|
|
138
|
+
* const configLayer = createKataConfigLayer(this, 'KataConfigLayer', {
|
|
139
|
+
* originalHandler: 'bundle.handler'
|
|
140
|
+
* });
|
|
141
|
+
*
|
|
142
|
+
* myFunction.addLayers(configLayer);
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
145
|
+
* @remarks
|
|
146
|
+
* Validates: Requirements 1.1, 1.2, 1.3, 3.1, 3.2, 3.5
|
|
147
|
+
*/
|
|
148
|
+
export declare function createKataConfigLayer(scope: Construct, id: string, props: KataConfigLayerProps): LayerVersion;
|
|
149
|
+
/**
|
|
150
|
+
* Generates the JSON configuration content for the config layer.
|
|
151
|
+
*
|
|
152
|
+
* This function creates a properly formatted JSON string containing
|
|
153
|
+
* the original handler path. The output is formatted with 2-space
|
|
154
|
+
* indentation for readability.
|
|
155
|
+
*
|
|
156
|
+
* @param originalHandler - The original Node.js handler path
|
|
157
|
+
* @returns The JSON configuration content as a string
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* ```typescript
|
|
161
|
+
* const content = generateConfigContent('bundle.handler');
|
|
162
|
+
* // Returns: '{\n "original_js_handler": "bundle.handler"\n}'
|
|
163
|
+
* ```
|
|
164
|
+
*
|
|
165
|
+
* @remarks
|
|
166
|
+
* Validates: Requirements 1.2, 3.2
|
|
167
|
+
*/
|
|
168
|
+
export declare function generateConfigContent(originalHandler: string): string;
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @lambda-kata/cdk - AWS CDK integration for Lambda Kata
|
|
3
|
+
*
|
|
4
|
+
* This package provides CDK constructs to transform Node.js Lambda functions
|
|
5
|
+
* to run via the Lambda Kata runtime.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* import { kata } from '@lambda-kata/cdk';
|
|
10
|
+
* import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs';
|
|
11
|
+
*
|
|
12
|
+
* const myFunction = new NodejsFunction(this, 'MyFunction', {
|
|
13
|
+
* entry: 'src/handler.ts',
|
|
14
|
+
* });
|
|
15
|
+
*
|
|
16
|
+
* // Transform to use Lambda Kata runtime
|
|
17
|
+
* kata(myFunction);
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
export { KataProps, LicensingResponse, TransformationConfig } from './types';
|
|
21
|
+
export { LicensingService, HttpLicensingService, createLicensingService, isValidAccountId, } from './licensing';
|
|
22
|
+
export { MockLicensingService, createMockLicensingService, } from './mock-licensing';
|
|
23
|
+
export { resolveAccountId, resolveAccountIdWithSource, isValidAccountIdFormat, AccountResolutionError, AccountResolutionResult, AccountResolverOptions, } from './account-resolver';
|
|
24
|
+
export { kata, kataWithAccountId, applyTransformation, handleUnlicensed, isKataTransformed, getKataPromise, KataWrapperOptions, KataResult, } from './kata-wrapper';
|
|
25
|
+
export { createKataConfigLayer, generateConfigContent, KataConfigLayerProps, CONFIG_DIR_NAME, CONFIG_FILE_NAME, HANDLER_CONFIG_KEY, } from './config-layer';
|