@rexeus/typeweaver-aws-cdk 0.0.2 โ 0.0.4
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 +56 -234
- package/dist/LICENSE +202 -0
- package/dist/NOTICE +4 -0
- package/dist/index.js +10 -182
- package/dist/lib/AwsHttpApiGatewayRoutes.ts +17 -0
- package/dist/lib/index.ts +8 -1
- package/dist/templates/HttpApiRouter.ejs +10 -2
- package/package.json +15 -9
- package/dist/lib/AwsHttpApiGatewayRouter.ts +0 -10
package/README.md
CHANGED
|
@@ -1,264 +1,86 @@
|
|
|
1
|
-
# @rexeus/typeweaver-aws-cdk
|
|
1
|
+
# ๐งตโจ @rexeus/typeweaver-aws-cdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@rexeus/typeweaver-aws-cdk)
|
|
4
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
|
+
[](https://www.typescriptlang.org/)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Typeweaver is a type-safe HTTP API framework built for API-first development with a focus on
|
|
8
|
+
developer experience. Use typeweaver to specify your HTTP APIs in TypeScript and Zod, and generate
|
|
9
|
+
clients, validators, routers, and more โจ
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
definitions, making it easy to deploy type-safe APIs to AWS.
|
|
11
|
+
## ๐ AWS CDK Plugin
|
|
9
12
|
|
|
10
|
-
|
|
13
|
+
This plugin generates utils for the AWS CDK from your typeweaver API definitions, making it easy to
|
|
14
|
+
deploy type-safe APIs to AWS. Currently only the AWS API Gateway HTTP API (V2) is supported.
|
|
11
15
|
|
|
12
|
-
|
|
13
|
-
npm install @rexeus/typeweaver-aws-cdk
|
|
14
|
-
```
|
|
16
|
+
---
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
## ๐ฅ Installation
|
|
17
19
|
|
|
18
20
|
```bash
|
|
19
|
-
|
|
20
|
-
|
|
21
|
+
# Install the CLI and the plugin as a dev dependency
|
|
22
|
+
npm install -D @rexeus/typeweaver @rexeus/typeweaver-aws-cdk
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
# Install the runtime as a dependency
|
|
25
|
+
npm install @rexeus/typeweaver-core
|
|
26
|
+
```
|
|
23
27
|
|
|
24
|
-
|
|
28
|
+
## ๐ก How to use
|
|
25
29
|
|
|
26
30
|
```bash
|
|
27
31
|
npx typeweaver generate --input ./api/definitions --output ./api/generated --plugins aws-cdk
|
|
28
32
|
```
|
|
29
33
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
```javascript
|
|
33
|
-
// typeweaver.config.js
|
|
34
|
-
export default {
|
|
35
|
-
input: "./api/definitions",
|
|
36
|
-
output: "./api/generated",
|
|
37
|
-
plugins: ["aws-cdk"],
|
|
38
|
-
};
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Generated Output
|
|
42
|
-
|
|
43
|
-
This plugin generates HTTP API Gateway routers for each entity in your API definitions.
|
|
44
|
-
|
|
45
|
-
### Example Generated Router
|
|
46
|
-
|
|
47
|
-
For an API definition with a `users` entity, the plugin generates:
|
|
48
|
-
|
|
49
|
-
```typescript
|
|
50
|
-
// UsersHttpApiRouter.ts
|
|
51
|
-
import { HttpMethod } from "@rexeus/typeweaver-core";
|
|
52
|
-
|
|
53
|
-
export const UsersHttpApiRouter = {
|
|
54
|
-
"/users": [HttpMethod.POST],
|
|
55
|
-
"/users/{userId}": [HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE],
|
|
56
|
-
};
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Router Structure
|
|
60
|
-
|
|
61
|
-
The generated routers provide:
|
|
62
|
-
|
|
63
|
-
- **Route Definitions** - Express-style paths converted to API Gateway format
|
|
64
|
-
- **HTTP Methods** - Supported methods for each route
|
|
65
|
-
- **Parameter Mapping** - Path parameters (`:param` โ `{param}`)
|
|
66
|
-
|
|
67
|
-
### Path Conversion
|
|
68
|
-
|
|
69
|
-
The plugin automatically converts Express-style paths to API Gateway format:
|
|
70
|
-
|
|
71
|
-
- `/users/:userId` โ `/users/{userId}`
|
|
72
|
-
- `/users/:userId/posts/:postId` โ `/users/{userId}/posts/{postId}`
|
|
73
|
-
|
|
74
|
-
## AWS CDK Integration
|
|
75
|
-
|
|
76
|
-
Use the generated routers in your CDK stacks:
|
|
77
|
-
|
|
78
|
-
```typescript
|
|
79
|
-
import { HttpApi, HttpMethod } from "@aws-cdk/aws-apigatewayv2-alpha";
|
|
80
|
-
import { UsersHttpApiRouter, PostsHttpApiRouter } from "./api/generated";
|
|
81
|
-
|
|
82
|
-
export class ApiStack extends Stack {
|
|
83
|
-
constructor(scope: Construct, id: string, props?: StackProps) {
|
|
84
|
-
super(scope, id, props);
|
|
85
|
-
|
|
86
|
-
const api = new HttpApi(this, "TypeWeaverApi");
|
|
87
|
-
|
|
88
|
-
// Add routes from generated routers
|
|
89
|
-
Object.entries(UsersHttpApiRouter).forEach(([path, methods]) => {
|
|
90
|
-
methods.forEach(method => {
|
|
91
|
-
api.addRoutes({
|
|
92
|
-
path,
|
|
93
|
-
methods: [method],
|
|
94
|
-
integration: new HttpLambdaIntegration("UsersIntegration", usersHandler),
|
|
95
|
-
});
|
|
96
|
-
});
|
|
97
|
-
});
|
|
98
|
-
|
|
99
|
-
Object.entries(PostsHttpApiRouter).forEach(([path, methods]) => {
|
|
100
|
-
methods.forEach(method => {
|
|
101
|
-
api.addRoutes({
|
|
102
|
-
path,
|
|
103
|
-
methods: [method],
|
|
104
|
-
integration: new HttpLambdaIntegration("PostsIntegration", postsHandler),
|
|
105
|
-
});
|
|
106
|
-
});
|
|
107
|
-
});
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
## Complete AWS Deployment Example
|
|
113
|
-
|
|
114
|
-
### 1. Define Your API
|
|
34
|
+
More details on how to use the [CLI](https://github.com/rexeus/typeweaver/tree/main/packages/cli/README.md#๏ธ-cli).
|
|
115
35
|
|
|
116
|
-
|
|
117
|
-
// api/definitions/users/GetUserDefinition.ts
|
|
118
|
-
import { HttpOperationDefinition, HttpMethod, HttpStatusCode } from "@rexeus/typeweaver-core";
|
|
119
|
-
import { z } from "zod/v4";
|
|
120
|
-
|
|
121
|
-
export default new HttpOperationDefinition({
|
|
122
|
-
operationId: "GetUser",
|
|
123
|
-
method: HttpMethod.GET,
|
|
124
|
-
path: "/users/:userId",
|
|
125
|
-
request: {
|
|
126
|
-
param: z.object({
|
|
127
|
-
userId: z.string(),
|
|
128
|
-
}),
|
|
129
|
-
},
|
|
130
|
-
responses: [
|
|
131
|
-
{
|
|
132
|
-
statusCode: HttpStatusCode.OK,
|
|
133
|
-
body: z.object({
|
|
134
|
-
id: z.string(),
|
|
135
|
-
name: z.string(),
|
|
136
|
-
email: z.email(),
|
|
137
|
-
}),
|
|
138
|
-
},
|
|
139
|
-
],
|
|
140
|
-
});
|
|
141
|
-
```
|
|
36
|
+
## ๐ Generated Output
|
|
142
37
|
|
|
143
|
-
|
|
38
|
+
For each resource, one file is generated: `<ResourceName>HttpApiRoutes.ts`.
|
|
144
39
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
```
|
|
40
|
+
This file contains a generated class `<ResourceName>HttpApiRoutes` that includes all routes for its
|
|
41
|
+
defined operations, e.g. `TodoHttpApiRoutes`.
|
|
148
42
|
|
|
149
|
-
|
|
43
|
+
**Using the generated routes**
|
|
150
44
|
|
|
151
45
|
```typescript
|
|
152
|
-
// lib/api-stack.ts
|
|
153
|
-
import { Stack, StackProps } from "aws-cdk-lib";
|
|
154
46
|
import { Construct } from "constructs";
|
|
155
|
-
import { HttpApi } from "
|
|
156
|
-
import { HttpLambdaIntegration } from "
|
|
157
|
-
import {
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
47
|
+
import { HttpApi } from "aws-cdk-lib/aws-apigatewayv2";
|
|
48
|
+
import { HttpLambdaIntegration } from "aws-cdk-lib/aws-apigatewayv2-integrations";
|
|
49
|
+
import { NodejsFunction } from "aws-cdk-lib/aws-lambda-nodejs";
|
|
50
|
+
import { TodoHttpApiRoutes } from "path/to/generated/output";
|
|
51
|
+
|
|
52
|
+
type TodoApiProps = {
|
|
53
|
+
// Provide an HttpApi instance, where the routes for the resource should be added
|
|
54
|
+
readonly httpApi: HttpApi;
|
|
55
|
+
// ...
|
|
56
|
+
};
|
|
164
57
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
58
|
+
export class TodoApi extends Construct {
|
|
59
|
+
public constructor(
|
|
60
|
+
scope: Construct,
|
|
61
|
+
id: string,
|
|
62
|
+
private readonly props: TodoApiProps
|
|
63
|
+
) {
|
|
64
|
+
// A Lambda handler for the resource API
|
|
65
|
+
const apiHandler = new NodejsFunction(this, "Handler", {
|
|
66
|
+
// ...
|
|
168
67
|
});
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
68
|
+
const integration = new HttpLambdaIntegration("Integration", apiHandler);
|
|
69
|
+
|
|
70
|
+
// Get all routes
|
|
71
|
+
const routes = new TodoHttpApiRoutes().getRoutes();
|
|
72
|
+
for (const endpoint of routes) {
|
|
73
|
+
// Register the routes with the HTTP API
|
|
74
|
+
this.props.httpApi.addRoutes({
|
|
75
|
+
integration,
|
|
76
|
+
path: endpoint.path,
|
|
77
|
+
methods: endpoint.methods,
|
|
178
78
|
});
|
|
179
|
-
}
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### 4. Deploy
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
cdk deploy
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
## Features
|
|
191
|
-
|
|
192
|
-
### Route Organization
|
|
193
|
-
|
|
194
|
-
- **Entity-based routing** - Each entity gets its own router file
|
|
195
|
-
- **Method grouping** - Routes grouped by HTTP method support
|
|
196
|
-
- **Parameter extraction** - Path parameters automatically identified
|
|
197
|
-
|
|
198
|
-
### Type Safety
|
|
199
|
-
|
|
200
|
-
- **Generated types** - Work seamlessly with other TypeWeaver plugins
|
|
201
|
-
- **CDK integration** - Type-safe AWS CDK constructs
|
|
202
|
-
- **Validation** - Runtime validation via TypeWeaver Core
|
|
203
|
-
|
|
204
|
-
### Development Workflow
|
|
205
|
-
|
|
206
|
-
- **Hot reload** - Regenerate routes when API definitions change
|
|
207
|
-
- **Version control** - Generated files can be committed for review
|
|
208
|
-
- **Testing** - Generated routes can be unit tested
|
|
209
|
-
|
|
210
|
-
## Plugin Architecture
|
|
211
|
-
|
|
212
|
-
This plugin extends the TypeWeaver plugin system:
|
|
213
|
-
|
|
214
|
-
```typescript
|
|
215
|
-
import { BasePlugin, type GeneratorContext } from "@rexeus/typeweaver-gen";
|
|
216
|
-
|
|
217
|
-
export default class AwsCdkPlugin extends BasePlugin {
|
|
218
|
-
public name = "aws-cdk";
|
|
219
|
-
|
|
220
|
-
public override generate(context: GeneratorContext): void {
|
|
221
|
-
// Generates HTTP API routers for each entity
|
|
79
|
+
}
|
|
222
80
|
}
|
|
223
81
|
}
|
|
224
82
|
```
|
|
225
83
|
|
|
226
|
-
##
|
|
227
|
-
|
|
228
|
-
### CDK Integration
|
|
229
|
-
|
|
230
|
-
- Use the generated routers as single source of truth for API routes
|
|
231
|
-
- Combine with other TypeWeaver plugins for complete type safety
|
|
232
|
-
- Version generated files in source control
|
|
233
|
-
|
|
234
|
-
### Deployment
|
|
235
|
-
|
|
236
|
-
- Generate code before CDK synthesis
|
|
237
|
-
- Use CDK context for environment-specific configuration
|
|
238
|
-
- Implement proper error handling in Lambda functions
|
|
239
|
-
|
|
240
|
-
### Monitoring
|
|
241
|
-
|
|
242
|
-
- Add CloudWatch metrics for generated routes
|
|
243
|
-
- Implement distributed tracing
|
|
244
|
-
- Monitor API Gateway throttling and errors
|
|
245
|
-
|
|
246
|
-
## Troubleshooting
|
|
247
|
-
|
|
248
|
-
### Common Issues
|
|
249
|
-
|
|
250
|
-
**Route conflicts**: Ensure API definitions don't have conflicting paths **Method mismatches**:
|
|
251
|
-
Verify HTTP methods in definitions match usage **Parameter mapping**: Check path parameter names are
|
|
252
|
-
consistent
|
|
253
|
-
|
|
254
|
-
### Debug Mode
|
|
255
|
-
|
|
256
|
-
Enable verbose logging during generation:
|
|
257
|
-
|
|
258
|
-
```bash
|
|
259
|
-
DEBUG=typeweaver:* npx typeweaver generate --plugins aws-cdk
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
## License
|
|
84
|
+
## ๐ License
|
|
263
85
|
|
|
264
|
-
|
|
86
|
+
Apache 2.0 ยฉ Dennis Wentzien 2025
|
package/dist/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2025 Dennis Wentzien
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/dist/NOTICE
ADDED
package/dist/index.js
CHANGED
|
@@ -1,193 +1,21 @@
|
|
|
1
|
-
import { BasePlugin } from '@rexeus/typeweaver-gen';
|
|
2
1
|
import path from 'path';
|
|
3
2
|
import { fileURLToPath } from 'url';
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
var Case$2 = {exports: {}};
|
|
10
|
-
|
|
11
|
-
var Case$1 = Case$2.exports;
|
|
12
|
-
|
|
13
|
-
var hasRequiredCase;
|
|
14
|
-
|
|
15
|
-
function requireCase () {
|
|
16
|
-
if (hasRequiredCase) return Case$2.exports;
|
|
17
|
-
hasRequiredCase = 1;
|
|
18
|
-
(function (module) {
|
|
19
|
-
/*! Case - v1.6.2 - 2020-03-24
|
|
20
|
-
* Copyright (c) 2020 Nathan Bubna; Licensed MIT, GPL */
|
|
21
|
-
(function() {
|
|
22
|
-
var unicodes = function(s, prefix) {
|
|
23
|
-
prefix = prefix || "";
|
|
24
|
-
return s.replace(/(^|-)/g, "$1\\u" + prefix).replace(/,/g, "\\u" + prefix);
|
|
25
|
-
}, basicSymbols = unicodes("20-26,28-2F,3A-40,5B-60,7B-7E,A0-BF,D7,F7", "00"), baseLowerCase = "a-z" + unicodes("DF-F6,F8-FF", "00"), baseUpperCase = "A-Z" + unicodes("C0-D6,D8-DE", "00"), improperInTitle = "A|An|And|As|At|But|By|En|For|If|In|Of|On|Or|The|To|Vs?\\.?|Via", regexps = function(symbols, lowers, uppers, impropers) {
|
|
26
|
-
symbols = symbols || basicSymbols;
|
|
27
|
-
lowers = lowers || baseLowerCase;
|
|
28
|
-
uppers = uppers || baseUpperCase;
|
|
29
|
-
impropers = impropers || improperInTitle;
|
|
30
|
-
return {
|
|
31
|
-
capitalize: new RegExp("(^|[" + symbols + "])([" + lowers + "])", "g"),
|
|
32
|
-
pascal: new RegExp("(^|[" + symbols + "])+([" + lowers + uppers + "])", "g"),
|
|
33
|
-
fill: new RegExp("[" + symbols + "]+(.|$)", "g"),
|
|
34
|
-
sentence: new RegExp('(^\\s*|[\\?\\!\\.]+"?\\s+"?|,\\s+")([' + lowers + "])", "g"),
|
|
35
|
-
improper: new RegExp("\\b(" + impropers + ")\\b", "g"),
|
|
36
|
-
relax: new RegExp("([^" + uppers + "])([" + uppers + "]*)([" + uppers + "])(?=[^" + uppers + "]|$)", "g"),
|
|
37
|
-
upper: new RegExp("^[^" + lowers + "]+$"),
|
|
38
|
-
hole: /[^\s]\s[^\s]/,
|
|
39
|
-
apostrophe: /'/g,
|
|
40
|
-
room: new RegExp("[" + symbols + "]")
|
|
41
|
-
};
|
|
42
|
-
}, re = regexps(), _ = {
|
|
43
|
-
re,
|
|
44
|
-
unicodes,
|
|
45
|
-
regexps,
|
|
46
|
-
types: [],
|
|
47
|
-
up: String.prototype.toUpperCase,
|
|
48
|
-
low: String.prototype.toLowerCase,
|
|
49
|
-
cap: function(s) {
|
|
50
|
-
return _.up.call(s.charAt(0)) + s.slice(1);
|
|
51
|
-
},
|
|
52
|
-
decap: function(s) {
|
|
53
|
-
return _.low.call(s.charAt(0)) + s.slice(1);
|
|
54
|
-
},
|
|
55
|
-
deapostrophe: function(s) {
|
|
56
|
-
return s.replace(re.apostrophe, "");
|
|
57
|
-
},
|
|
58
|
-
fill: function(s, fill, deapostrophe) {
|
|
59
|
-
if (fill != null) {
|
|
60
|
-
s = s.replace(re.fill, function(m, next) {
|
|
61
|
-
return next ? fill + next : "";
|
|
62
|
-
});
|
|
63
|
-
}
|
|
64
|
-
if (deapostrophe) {
|
|
65
|
-
s = _.deapostrophe(s);
|
|
66
|
-
}
|
|
67
|
-
return s;
|
|
68
|
-
},
|
|
69
|
-
prep: function(s, fill, pascal, upper) {
|
|
70
|
-
s = s == null ? "" : s + "";
|
|
71
|
-
if (!upper && re.upper.test(s)) {
|
|
72
|
-
s = _.low.call(s);
|
|
73
|
-
}
|
|
74
|
-
if (!fill && !re.hole.test(s)) {
|
|
75
|
-
var holey = _.fill(s, " ");
|
|
76
|
-
if (re.hole.test(holey)) {
|
|
77
|
-
s = holey;
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
if (!pascal && !re.room.test(s)) {
|
|
81
|
-
s = s.replace(re.relax, _.relax);
|
|
82
|
-
}
|
|
83
|
-
return s;
|
|
84
|
-
},
|
|
85
|
-
relax: function(m, before, acronym, caps) {
|
|
86
|
-
return before + " " + (acronym ? acronym + " " : "") + caps;
|
|
87
|
-
}
|
|
88
|
-
}, Case = {
|
|
89
|
-
_,
|
|
90
|
-
of: function(s) {
|
|
91
|
-
for (var i = 0, m = _.types.length; i < m; i++) {
|
|
92
|
-
if (Case[_.types[i]].apply(Case, arguments) === s) {
|
|
93
|
-
return _.types[i];
|
|
94
|
-
}
|
|
95
|
-
}
|
|
96
|
-
},
|
|
97
|
-
flip: function(s) {
|
|
98
|
-
return s.replace(/\w/g, function(l) {
|
|
99
|
-
return (l == _.up.call(l) ? _.low : _.up).call(l);
|
|
100
|
-
});
|
|
101
|
-
},
|
|
102
|
-
random: function(s) {
|
|
103
|
-
return s.replace(/\w/g, function(l) {
|
|
104
|
-
return (Math.round(Math.random()) ? _.up : _.low).call(l);
|
|
105
|
-
});
|
|
106
|
-
},
|
|
107
|
-
type: function(type2, fn) {
|
|
108
|
-
Case[type2] = fn;
|
|
109
|
-
_.types.push(type2);
|
|
110
|
-
}
|
|
111
|
-
}, types = {
|
|
112
|
-
lower: function(s, fill, deapostrophe) {
|
|
113
|
-
return _.fill(_.low.call(_.prep(s, fill)), fill, deapostrophe);
|
|
114
|
-
},
|
|
115
|
-
snake: function(s) {
|
|
116
|
-
return Case.lower(s, "_", true);
|
|
117
|
-
},
|
|
118
|
-
constant: function(s) {
|
|
119
|
-
return Case.upper(s, "_", true);
|
|
120
|
-
},
|
|
121
|
-
camel: function(s) {
|
|
122
|
-
return _.decap(Case.pascal(s));
|
|
123
|
-
},
|
|
124
|
-
kebab: function(s) {
|
|
125
|
-
return Case.lower(s, "-", true);
|
|
126
|
-
},
|
|
127
|
-
upper: function(s, fill, deapostrophe) {
|
|
128
|
-
return _.fill(_.up.call(_.prep(s, fill, false, true)), fill, deapostrophe);
|
|
129
|
-
},
|
|
130
|
-
capital: function(s, fill, deapostrophe) {
|
|
131
|
-
return _.fill(_.prep(s).replace(re.capitalize, function(m, border, letter) {
|
|
132
|
-
return border + _.up.call(letter);
|
|
133
|
-
}), fill, deapostrophe);
|
|
134
|
-
},
|
|
135
|
-
header: function(s) {
|
|
136
|
-
return Case.capital(s, "-", true);
|
|
137
|
-
},
|
|
138
|
-
pascal: function(s) {
|
|
139
|
-
return _.fill(_.prep(s, false, true).replace(re.pascal, function(m, border, letter) {
|
|
140
|
-
return _.up.call(letter);
|
|
141
|
-
}), "", true);
|
|
142
|
-
},
|
|
143
|
-
title: function(s) {
|
|
144
|
-
return Case.capital(s).replace(re.improper, function(small, p, i, s2) {
|
|
145
|
-
return i > 0 && i < s2.lastIndexOf(" ") ? _.low.call(small) : small;
|
|
146
|
-
});
|
|
147
|
-
},
|
|
148
|
-
sentence: function(s, names, abbreviations) {
|
|
149
|
-
s = Case.lower(s).replace(re.sentence, function(m, prelude, letter) {
|
|
150
|
-
return prelude + _.up.call(letter);
|
|
151
|
-
});
|
|
152
|
-
if (names) {
|
|
153
|
-
names.forEach(function(name) {
|
|
154
|
-
s = s.replace(new RegExp("\\b" + Case.lower(name) + "\\b", "g"), _.cap);
|
|
155
|
-
});
|
|
156
|
-
}
|
|
157
|
-
if (abbreviations) {
|
|
158
|
-
abbreviations.forEach(function(abbr) {
|
|
159
|
-
s = s.replace(new RegExp("(\\b" + Case.lower(abbr) + "\\. +)(\\w)"), function(m, abbrAndSpace, letter) {
|
|
160
|
-
return abbrAndSpace + _.low.call(letter);
|
|
161
|
-
});
|
|
162
|
-
});
|
|
163
|
-
}
|
|
164
|
-
return s;
|
|
165
|
-
}
|
|
166
|
-
};
|
|
167
|
-
types.squish = types.pascal;
|
|
168
|
-
Case.default = Case;
|
|
169
|
-
for (var type in types) {
|
|
170
|
-
Case.type(type, types[type]);
|
|
171
|
-
}
|
|
172
|
-
var define = typeof define === "function" ? define : function() {
|
|
173
|
-
};
|
|
174
|
-
define(module.exports ? module.exports = Case : this.Case = Case);
|
|
175
|
-
}).call(Case$1);
|
|
176
|
-
} (Case$2));
|
|
177
|
-
return Case$2.exports;
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
var CaseExports = requireCase();
|
|
181
|
-
var Case = /*@__PURE__*/getDefaultExportFromCjs(CaseExports);
|
|
3
|
+
import { BasePlugin } from '@rexeus/typeweaver-gen';
|
|
4
|
+
import Case from 'case';
|
|
182
5
|
|
|
183
6
|
const __dirname$1 = path.dirname(fileURLToPath(import.meta.url));
|
|
184
7
|
class HttpApiRouterGenerator {
|
|
185
8
|
static generate(context) {
|
|
186
9
|
const templateFile = path.join(__dirname$1, "templates", "HttpApiRouter.ejs");
|
|
187
|
-
for (const [entityName,
|
|
10
|
+
for (const [entityName, entityResource] of Object.entries(
|
|
188
11
|
context.resources.entityResources
|
|
189
12
|
)) {
|
|
190
|
-
this.writeHttpApiRoutes(
|
|
13
|
+
this.writeHttpApiRoutes(
|
|
14
|
+
entityName,
|
|
15
|
+
templateFile,
|
|
16
|
+
entityResource.operations,
|
|
17
|
+
context
|
|
18
|
+
);
|
|
191
19
|
}
|
|
192
20
|
}
|
|
193
21
|
static writeHttpApiRoutes(entityName, templateFile, operationResources, context) {
|
|
@@ -196,7 +24,7 @@ class HttpApiRouterGenerator {
|
|
|
196
24
|
const outputDir = operationResources[0].outputDir;
|
|
197
25
|
const outputFile = path.join(
|
|
198
26
|
outputDir,
|
|
199
|
-
`${pascalCaseEntityName}
|
|
27
|
+
`${pascalCaseEntityName}HttpApiRoutes.ts`
|
|
200
28
|
);
|
|
201
29
|
for (const operation of operationResources) {
|
|
202
30
|
const path2 = this.createRoutePath(operation.definition.path);
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was automatically generated by typeweaver.
|
|
3
|
+
* DO NOT EDIT. Instead, modify the source definition file and generate again.
|
|
4
|
+
*
|
|
5
|
+
* @generated by @rexeus/typeweaver
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { HttpMethod } from "@rexeus/typeweaver-core";
|
|
9
|
+
|
|
10
|
+
export type AwsHttpApiGatewayRoute = {
|
|
11
|
+
path: string;
|
|
12
|
+
methods: HttpMethod[];
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
export abstract class AwsHttpApiGatewayRoutes {
|
|
16
|
+
public abstract getRoutes(): AwsHttpApiGatewayRoute[];
|
|
17
|
+
}
|
package/dist/lib/index.ts
CHANGED
|
@@ -1 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* This file was automatically generated by typeweaver.
|
|
3
|
+
* DO NOT EDIT. Instead, modify the source definition file and generate again.
|
|
4
|
+
*
|
|
5
|
+
* @generated by @rexeus/typeweaver
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
export * from "./AwsHttpApiGatewayRoutes";
|
|
@@ -1,10 +1,18 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* This file was automatically generated by typeweaver.
|
|
4
|
+
* DO NOT EDIT. Instead, modify the source definition file and generate again.
|
|
5
|
+
*
|
|
6
|
+
* @generated by @rexeus/typeweaver
|
|
7
|
+
*/
|
|
8
|
+
|
|
1
9
|
import { HttpMethod } from "<%= coreDir %>";
|
|
2
10
|
import {
|
|
3
11
|
type AwsHttpApiGatewayRoute,
|
|
4
|
-
|
|
12
|
+
AwsHttpApiGatewayRoutes,
|
|
5
13
|
} from "../lib/aws-cdk";
|
|
6
14
|
|
|
7
|
-
export class <%= pascalCaseEntityName %>
|
|
15
|
+
export class <%= pascalCaseEntityName %>HttpApiRoutes extends AwsHttpApiGatewayRoutes {
|
|
8
16
|
private routes: AwsHttpApiGatewayRoute[] = [
|
|
9
17
|
<% for(const [path, methods] of Object.entries(routes)) { %>
|
|
10
18
|
{
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rexeus/typeweaver-aws-cdk",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "AWS CDK constructs and deployment utilities for
|
|
3
|
+
"version": "0.0.4",
|
|
4
|
+
"description": "AWS CDK constructs and deployment utilities for typeweaver APIs",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
7
8
|
"exports": {
|
|
8
9
|
".": {
|
|
9
10
|
"import": "./dist/index.js",
|
|
@@ -13,7 +14,9 @@
|
|
|
13
14
|
"files": [
|
|
14
15
|
"dist",
|
|
15
16
|
"package.json",
|
|
16
|
-
"README.md"
|
|
17
|
+
"README.md",
|
|
18
|
+
"LICENSE",
|
|
19
|
+
"NOTICE"
|
|
17
20
|
],
|
|
18
21
|
"keywords": [
|
|
19
22
|
"api",
|
|
@@ -25,7 +28,7 @@
|
|
|
25
28
|
"typeweaver"
|
|
26
29
|
],
|
|
27
30
|
"author": "Dennis Wentzien <dw@rexeus.com>",
|
|
28
|
-
"license": "
|
|
31
|
+
"license": "Apache-2.0",
|
|
29
32
|
"repository": {
|
|
30
33
|
"type": "git",
|
|
31
34
|
"url": "git+https://github.com/rexeus/typeweaver.git",
|
|
@@ -36,17 +39,20 @@
|
|
|
36
39
|
},
|
|
37
40
|
"homepage": "https://github.com/rexeus/typeweaver#readme",
|
|
38
41
|
"peerDependencies": {
|
|
39
|
-
"@rexeus/typeweaver-core": "^0.0.
|
|
40
|
-
"@rexeus/typeweaver-gen": "^0.0.
|
|
42
|
+
"@rexeus/typeweaver-core": "^0.0.4",
|
|
43
|
+
"@rexeus/typeweaver-gen": "^0.0.4"
|
|
41
44
|
},
|
|
42
45
|
"devDependencies": {
|
|
43
|
-
"@rexeus/typeweaver-core": "^0.0.
|
|
44
|
-
"@rexeus/typeweaver-gen": "^0.0.
|
|
46
|
+
"@rexeus/typeweaver-core": "^0.0.4",
|
|
47
|
+
"@rexeus/typeweaver-gen": "^0.0.4"
|
|
48
|
+
},
|
|
49
|
+
"dependencies": {
|
|
50
|
+
"case": "^1.6.3"
|
|
45
51
|
},
|
|
46
52
|
"scripts": {
|
|
47
53
|
"typecheck": "tsc --noEmit",
|
|
48
54
|
"format": "prettier --write .",
|
|
49
|
-
"build": "pkgroll --clean-dist && cp -r ./src/templates ./dist/templates && cp -r ./src/lib ./dist/lib",
|
|
55
|
+
"build": "pkgroll --clean-dist && cp -r ./src/templates ./dist/templates && cp -r ./src/lib ./dist/lib && cp ../../LICENSE ../../NOTICE ./dist/",
|
|
50
56
|
"preversion": "npm run build"
|
|
51
57
|
}
|
|
52
58
|
}
|