|
1 | | -## Overview |
| 1 | +# Overview |
2 | 2 |
|
3 | | -Our public roadmap outlines the high level direction we are working towards, namely [Themes](#themes). We update this document when our priorities change: security and stability is our top priority. |
| 3 | +Our public roadmap outlines the high level direction we are working towards. We update this document when our priorities change: security and stability are our top priority. |
4 | 4 |
|
5 | 5 | !!! info "For most up-to-date information, see our [board of activities](https://github.com/orgs/aws-powertools/projects/7/views/3?query=is%3Aopen+sort%3Aupdated-desc){target="_blank"}." |
6 | 6 |
|
7 | | -## Themes |
| 7 | +## Key areas |
8 | 8 |
|
9 | | -Operational Excellence is priority number 1. This means bug fixing, stability, security, customer's support, and governance will take precedence above all else. |
| 9 | +Security and operational excellence take precedence above all else. This means bug fixing, stability, customer's support, and internal compliance may delay one or more key areas below. |
10 | 10 |
|
11 | | -**What are themes?** |
| 11 | +**Missing something or want us to prioritize an existing area?** |
12 | 12 |
|
13 | | -They are key activities maintainers are focusing on. These are updated periodically and you can find the latest [under Themes in our GitHub Milestones](https://github.com/aws-powertools/powertools-lambda-typescript/milestones){target="_blank"}. |
| 13 | +You can help us prioritize by [upvoting existing feature requests](https://github.com/aws-powertools/powertools-lambda-typescript/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc++label%3Atype%2Ffeature-request+), leaving a comment on what use cases it could unblock for you, and by joining our discussions on Discord. |
14 | 14 |
|
15 | | -### Feature Parity |
| 15 | +[](https://discord.gg/B8zZKbbyET){target="_blank"} |
16 | 16 |
|
17 | | -We want to close the gap between this version of Powertools for AWS Lambda and the [Python version](https://github.com/aws-powertools/powertools-lambda-python). This means that in the fullness of time, we want to have the same or equivalent features in both versions. |
| 17 | +### Event Handler REST |
18 | 18 |
|
19 | | -In 2023 we have released three the utilities, first as public betas and then as generally available: |
20 | | - |
21 | | -- [x] [Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/) |
22 | | -- [x] [Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/) |
23 | | -- [x] [Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/) |
24 | | - |
25 | | -Over the next quarter, we are considering implementing one or more of the following utilities (in no particular order): |
26 | | - |
27 | | -- [ ] Parser (Status: [RFC Finalized](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1334) - Implementation: [In Progress](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/15)) |
28 | | -- [ ] Validation (Status: [RFC In Progress](https://github.com/aws-powertools/powertools-lambda-typescript/issues/508)) |
29 | | -- [ ] Event Handler (Status: [RFC In Progress](https://github.com/aws-powertools/powertools-lambda-typescript/issues/413)) |
30 | | - |
31 | | -If any of these utilities are important to you, please let us know by upvoting the issue, leaving a comment under the RFCs, or by joining the discussion in our [Discord community](https://discord.gg/B8zZKbbyET){target="_blank"}. |
32 | | - |
33 | | -### Version 2 release |
34 | | - |
35 | | -Over the past year, we have gathered a number of feature requests and improvements that we want to implement but that are not backwards compatible with the current API surface. We are going to release our next major version (v2) by the end of 2023, which will include some of these changes: |
36 | | - |
37 | | -- [x] **ES Modules support ([#521](https://github.com/aws-powertools/powertools-lambda-typescript/issues/521))** - Thanks to the work of the community we have been able to validate the feasibility of dual support for CommonJS and ES Modules. We are currently working on a plan to implement this. |
38 | | -- [x] **TypeScript 5.x support ([#1375](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1375))** - This new version of TypeScript brings breaking changes to the experimental decorators API, which we use in our core utilities. We need to investigate the impact of this change and how to best support it. |
39 | | -- [x] **Support for 3rd party observability providers ([#1500](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1500))** - Many of our customers would like to use Powertools for AWS to send logs, traces, and metrics to providers other than Amazon CloudWatch. At the moment we are investigating the feasibility of this for the Logger utility, while the Python version of Powertools for AWS Lambda is considering this also for Tracer and Metrics. |
40 | | - |
41 | | -You can find the full list of changes in the [v2 RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1714) and follow the progress in the [v2 milestone](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/12). |
42 | | - |
43 | | -Just like for the feature parity, if you have any feedback or would like to contribute to the discussion, please leave a comment in the RFC or join the discussion in our [Discord community](https://discord.gg/B8zZKbbyET){target="_blank"}. |
| 19 | +- [ ] [RFC to discuss initial thoughts and feasibility for TS/JS ecosystem](https://github.com/aws-powertools/powertools-lambda-typescript/issues/413) |
| 20 | +- [ ] Explore pros & cons of whether to build atop lean frameworks (e.g., Hono) or from scratch |
| 21 | +- [ ] Support for API Gateway REST API resolver |
| 22 | +- [ ] Support for API Gateway HTTP API resolver |
| 23 | +- [ ] Support for Lambda Function URL resolver |
| 24 | +- [ ] Support for Application Load Balancer resolver |
| 25 | +- [ ] Support for VPC Lattice resolver |
| 26 | +- [ ] Support for Data Validation _(e.g., `Zod`)_ |
| 27 | +- [ ] Support for OpenAPI generation |
| 28 | +- [ ] Support for Middlewares |
| 29 | +- [ ] Support for Compression |
| 30 | +- [ ] Support for Binary responses |
| 31 | +- [ ] Support for custom serializer |
| 32 | +- [ ] Support for injecting request details _(consider not doing globals like Python legacy)_ |
| 33 | +- [ ] Support for Router _(multi-file routes)_ |
44 | 34 |
|
45 | 35 | ### Improve operational excellence |
46 | 36 |
|
@@ -113,4 +103,44 @@ A: Because job zero is security and operational stability, we can't provide spec |
113 | 103 |
|
114 | 104 | **Q: How can I provide feedback or ask for more information?** |
115 | 105 |
|
116 | | -A: For existing features, you can directly comment on issues. For anything else, please open an issue. |
| 106 | +A: For existing features, you can directly comment on issues. For anything else, please open an issue. |
| 107 | + |
| 108 | +## Launched |
| 109 | + |
| 110 | +### JMESPath Functions |
| 111 | + |
| 112 | +> [Docs](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/jmespath/) |
| 113 | +
|
| 114 | +Feature parity on JMESPath Powertools Functions feature |
| 115 | + |
| 116 | +- [x] Support for extracting data |
| 117 | +- [x] Support for envelopes (unwrap before data extraction) |
| 118 | +- [x] Support for built-in `powertools_json` JMESPath function |
| 119 | +- [x] Support for built-in `powertools_base64` JMESPath function |
| 120 | +- [x] Support for built-in `powertools_base64_gzip` JMESPath function |
| 121 | +- [x] Support for Bring Your Own JMESPath function |
| 122 | + |
| 123 | +### Parser (Zod) |
| 124 | + |
| 125 | +> [Docs](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parser/) |
| 126 | +
|
| 127 | +Feature parity on Parser feature |
| 128 | + |
| 129 | +- [x] Support for defining your own Zod schema |
| 130 | +- [x] Support for popular Lambda Event Sources as built-in schemas |
| 131 | +- [x] Support for envelope (wrapping before schema validation) |
| 132 | +- [x] Support for user-defined envelopes |
| 133 | + |
| 134 | +### Version 2 release |
| 135 | + |
| 136 | +> [Docs](https://docs.powertools.aws.dev/lambda/typescript/latest/upgrade/) |
| 137 | +
|
| 138 | +Over the past year, we have gathered a number of feature requests and improvements that we want to implement but that are not backwards compatible with the current API surface. We are going to release our next major version (v2) by the end of 2023, which will include some of these changes: |
| 139 | + |
| 140 | +- [x] **ES Modules support ([#521](https://github.com/aws-powertools/powertools-lambda-typescript/issues/521))** - Thanks to the work of the community we have been able to validate the feasibility of dual support for CommonJS and ES Modules. We are currently working on a plan to implement this. |
| 141 | +- [x] **TypeScript 5.x support ([#1375](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1375))** - This new version of TypeScript brings breaking changes to the experimental decorators API, which we use in our core utilities. We need to investigate the impact of this change and how to best support it. |
| 142 | +- [x] **Support for 3rd party observability providers ([#1500](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1500))** - Many of our customers would like to use Powertools for AWS to send logs, traces, and metrics to providers other than Amazon CloudWatch. At the moment we are investigating the feasibility of this for the Logger utility, while the Python version of Powertools for AWS Lambda is considering this also for Tracer and Metrics. |
| 143 | + |
| 144 | +You can find the full list of changes in the [v2 RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1714) and follow the progress in the [v2 milestone](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/12). |
| 145 | + |
| 146 | +Just like for the feature parity, if you have any feedback or would like to contribute to the discussion, please leave a comment in the RFC or join the discussion in our [Discord community](https://discord.gg/B8zZKbbyET){target="_blank"}. |
0 commit comments