Release notes from powertools-lambda-typescript

v2.13.0

2025-01-14T15:02:05Z

Summary

In this release we fixed a bug in Tracer that prevented Fetch API requests from propagating the parent trace. We also improved the Parser experience by adding a helper to easily write Zod schemas for DynamoDB data structures.

⭐️ Thanks to @arnabrahman for their contributions to this release!

Full traces when working with Fetch API

Requests made with the global fetch module now adds X-Ray trace info to requests in the X-Amzn-Trace-Id header. This allows X-Ray to construct a full trace that includes upstream and downstream nodes.

Zod schemas with Amazon DynamoDB Attributes

You can now easily extend DynamoDB Stream schemas with your own payloads using the new DynamoDBMarshalled helper. This helper lets you focus on your schemas while we handle unmarshalling data from DynamoDB Attribute format to the native format before Zod parses the payload.

Changes

test(parser): refactor appsync schema tests (#3388) by @svozza
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.17 to 3.0.18 (#3430) by @dependabot
chore(deps): bump actions/upload-artifact from 4.4.3 to 4.5.0 (#3437) by @dependabot

🌟New features and non-breaking changes

feat(parser): DynamoDBMarshalled helper to parse DynamoDB data structure (#3442) by @arnabrahman

🌟 Minor Changes

refactor(metrics): swap isDate for instanceof Date (#3462) by @dreamorosi

📜 Documentation updates

chore(ci): update layer ARN on documentation (#3474) by @dreamorosi
chore(deps): bump the aws-cdk group (#3472) by @dreamorosi
feat(parser): DynamoDBMarshalled helper to parse DynamoDB data structure (#3442) by @arnabrahman
chore(deps): bump the typescript group across 1 directory with 4 updates (#3446) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 11 updates (#3459) by @dependabot
chore(deps): bump @types/node from 22.10.2 to 22.10.5 (#3456) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3455) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.146 to 8.10.147 (#3457) by @dependabot
chore(deps): bump esbuild from 0.24.0 to 0.24.2 (#3443) by @dependabot
chore(deps): bump jinja2 from 3.1.4 to 3.1.5 in /docs (#3453) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3452) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 10 updates (#3451) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3435) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from d485eb6 to ba73db5 in /docs (#3429) by @dependabot
chore(deps): bump mkdocs-material from 9.5.48 to 9.5.49 in /docs (#3427) by @dependabot

🐛 Bug and hot fixes

fix(tracer): forward X-Amzn-Trace-Id header when instrumenting fetch (#3470) by @dreamorosi

🔧 Maintenance

chore(deps): bump the aws-cdk group (#3472) by @dreamorosi
feat(parser): DynamoDBMarshalled helper to parse DynamoDB data structure (#3442) by @arnabrahman
chore(deps-dev): bump lint-staged from 15.2.11 to 15.3.0 (#3460) by @dependabot
chore(deps): bump the typescript group across 1 directory with 4 updates (#3446) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 11 updates (#3459) by @dependabot
chore(deps): bump @types/node from 22.10.2 to 22.10.5 (#3456) by @dependabot
chore(deps): bump @aws-cdk/cli-lib-alpha to 2.174.1-alpha.0 (#3458) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3455) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.146 to 8.10.147 (#3457) by @dependabot
chore(deps): bump esbuild from 0.24.0 to 0.24.2 (#3443) by @dependabot
chore(deps-dev): bump markdownlint-cli2 from 0.16.0 to 0.17.1 (#3450) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3452) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 10 updates (#3451) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3435) by @dependabot

This release was made possible by the following contributors:

@arnabrahman, @dependabot, @dependabot[bot], @dreamorosi, @github-actions, @github-actions[bot] and @svozza

v2.12.0

2024-12-17T16:19:59Z

Summary

In this release we have made the Logger class more extensible, added POWERTOOLS_METRICS_DISABLED to control metrics output in non production environment, and added AppSyncResolverSchema and KinesisDynamoDBStreamSchema to the parser utility.

⭐️ Thanks to @zirkelc and @svozza for their contributions to this release!

Logger class is now more extensible

You can now overwrite the Logger methods createAndPopulateLogItem, printLog, processLogItem, which were private before. This allows you to extend the Logger and add new functionality, i.e. implement your own message buffer.

Metrics utility improvements

You can now set POWERTOOLS_METRICS_DISABLED to control the metrics output. This is useful when you don't want to emit metrics in a non-production environment. When POWERTOOLS_DEV is enabled, the metrics are also suppressed, but you can always explicitly enable it with POWERTOOLS_METRICS_DISABLED .

We have also added a warning message when you overwrite a dimension with the same key, which will help you to troubleshoot unintentional changes:

import { Metrics } from '@aws-lambda-powertools/metrics';

const metrics = new Metrics({ singleMetric: true });

metrics.addDimension('test', 'foo');
metrics.addDimension('test', 'bar'); // "bar" replaces "foo"

// warning: Dimension "test" has already been added. The previous value will be overwritten.

New schema for AppSync and DynamoDB events

You can now use AppSyncResolverSchema and AppSyncResolverBatchSchema to parse AppSync Lambda resolver event.

We have also added KinesisDynamoDBStreamSchema to validate the event from the invocation chain of DynamoDB, Kinesis and Lambda, which are slightly different compared to direct DynamoDB Streams invocations, see more details in #3193.

Changes

chore(deps): bump github/codeql-action from 3.27.7 to 3.27.9 (#3422) by @dependabot
chore(deps): bump github/codeql-action from 3.27.5 to 3.27.7 (#3411) by @dependabot
chore(deps): bump actions/setup-node from 4.0.4 to 4.1.0 (#3380) by @dependabot
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.16 to 3.0.17 (#3362) by @dependabot
chore: replace close-issue-message action (#3364) by @dreamorosi
chore(deps): bump github/codeql-action from 3.27.3 to 3.27.5 (#3336) by @dependabot
chore(parser): return correct type for safeParse in envelopes (#3339) by @jharlow
chore(deps): bump actions/dependency-review-action from 4.4.0 to 4.5.0 (#3344) by @dependabot
chore(deps): bump aws-actions/closed-issue-message from 80edfc24bdf1283400eb04d20a8a605ae8bf7d48 to 37548691e7cc75ba58f85c9f873f9eee43590449 (#3345) by @dependabot

🌟New features and non-breaking changes

feat(logger): change visibility to protected (#3377) by @zirkelc
feat(metrics): disable metrics with POWERTOOLS_METRICS_DISABLED (#3351) by @zirkelc
feat(metrics): warn when overwriting dimension (#3352) by @dreamorosi
feat(parser): Add appsync resolver event Zod schemas (#3301) by @svozza
feat(parser): add schema for DynamoDB - Kinesis Stream event (#3328) by @am29d

📜 Documentation updates

chore(deps): bump @types/node from 22.10.1 to 22.10.2 (#3420) by @dependabot
docs: add videos section in community (#3416) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3413) by @dependabot
chore(deps): bump mkdocs-material from 9.5.46 to 9.5.48 in /docs (#3404) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from d063d84 to d485eb6 in /docs (#3407) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3412) by @dependabot
docs: fix link to parser sub page in the README (#3403) by @having-fun-serverless
chore(deps): bump the aws-sdk-v3 group across 1 directory with 2 updates (#3395) by @dependabot
docs: multiple minor improvements (#3387) by @dreamorosi
chore(deps): bump @types/aws-lambda from 8.10.145 to 8.10.146 (#3370) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3381) by @dependabot
chore(deps): bump @types/node from 22.10.0 to 22.10.1 (#3384) by @dependabot
chore: remove jest from codebase (#3379) by @dreamorosi
chore: move RFCs to discussions (#3373) by @dreamorosi
chore(deps): bump mkdocs-material from 9.5.45 to 9.5.46 in /docs (#3356) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3357) by @dependabot
chore(deps): bump @types/node from 22.9.0 to 22.10.0 (#3365) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from ce587cb to d063d84 in /docs (#3366) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 4 updates (#3349) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3348) by @dependabot
feat(parser): add schema for DynamoDB - Kinesis Stream event (#3328) by @am29d
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3343) by @dependabot

🐛 Bug and hot fixes

fix(parser): make SNS subject field nullish (#3415) by @dreamorosi

🔧 Maintenance

chore(deps-dev): bump markdownlint-cli2 from 0.15.0 to 0.16.0 (#3418) by @dependabot
chore(deps-dev): bump zod from 3.23.8 to 3.24.1 (#3419) by @dependabot
chore(deps): bump @types/node from 22.10.1 to 22.10.2 (#3420) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from d493ef0 to 896bfba in /.devcontainer (#3421) by @dependabot
chore(deps-dev): bump lint-staged from 15.2.10 to 15.2.11 (#3417) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3413) by @dependabot
chore(deps-dev): bump the vitest group across 1 directory with 2 updates (#3394) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3412) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 2 updates (#3395) by @dependabot
chore: add @middy/core v6 as peer dependency (#3368) by @anthony-nhs
chore(deps): bump @types/aws-lambda from 8.10.145 to 8.10.146 (#3370) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3381) by @dependabot
chore(deps): bump @types/node from 22.10.0 to 22.10.1 (#3384) by @dependabot
chore(deps-dev): bump the vitest group across 1 directory with 2 updates (#3383) by @dependabot
chore: remove jest from codebase (#3379) by @dreamorosi
chore: move RFCs to discussions (#3373) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3357) by @dependabot
chore(deps): bump @types/node from 22.9.0 to 22.10.0 (#3365) by @dependabot
chore(deps-dev): bump husky from 9.1.6 to 9.1.7 (#3360) by @dependabot
test(metrics): migrate tests to vitest & refactor (#3355) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 4 updates (#3349) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3348) by @dependabot
chore(deps-dev): bump typedoc-plugin-missing-exports from 3.0.0 to 3.0.2 in the typedoc group across 1 directory (#3342) by @dependabot
feat(parser): Add appsync resolver event Zod schemas (#3301) by @svozza
chore(deps-dev): bump markdownlint-cli2 from 0.14.0 to 0.15.0 (#3307) by @dependabot
chore(maintenance): remove Gitpod-specific configs (#3347) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3343) by @dependabot

This release was made possible by the following contributors:

@am29d, @anthony-nhs, @dependabot, @dependabot[bot], @dreamorosi, @github-actions, @github-actions[bot], @having-fun-serverless, @jharlow, @svozza and @zirkelc

v2.11.0

2024-11-20T18:26:00Z

Summary

In this release we’ve added support for the new Node.js 22 managed runtime in AWS Lambda 🚀.

We have also added two new features to Metrics to let you: 1/ set a custom logger, and 2/ emit metrics with a custom timestamp; and improved Batch Processing by adding async processing of SQS FIFO queues.

⭐️ Thanks to @arnabrahman and @psperber for their contributions to this release!

Node.js 22 support

You can now use Powertools for AWS Lambda (TypeScript) with the new Node.js 22 runtime in AWS Lambda.

We’ve partnered with the AWS Lambda team for this launch and have been testing our toolkit for the past few weeks to ensure compatibility with no changes from your side.

To start using Powertools for AWS with the new runtime, you can upgrade to this version via npm or use the latest version of our Lambda layer.

Custom timestamps in metrics

You can now configure the timestamp of all the metrics you create, using the setTimestamp() method. This allows you to specify a Datetime object or an integer representing an epoch timestamp in milliseconds. This is useful when emitting metrics related to an event in the past or in the future.

Bring your own logger to Metrics

Additionally, you can now also set a custom logger that the Metrics utility will use to emit warnings and debug logs. This is helpful for when you want to silence certain warnings or see diagnostic messages from the utility. To avoid compatibility issues and potential data loss, we will continue to emit the EMF blobs for your metrics directly to stdout.

FIFO queues async processing

You can now use an asynchronous function as record handler when processing a batch of items coming from an Amazon SQS FIFO queue. This is helpful when you need to perform side effects that involve http requests or other AWS services.

Changes

chore(deps): bump github/codeql-action from 3.27.0 to 3.27.3 (#3314) by @dependabot
chore(parser): fix type inference for result types (#3293) by @am29d
chore: fix relative import regression (#3287) by @dreamorosi
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.15 to 3.0.16 (#3282) by @dependabot
chore(deps): bump actions/setup-node from 4.0.4 to 4.1.0 (#3258) by @dependabot
chore(deps): bump actions/dependency-review-action from 4.3.5 to 4.4.0 (#3268) by @dependabot
chore(deps): bump github/codeql-action from 3.26.13 to 3.27.0 (#3245) by @dependabot
chore(deps): bump actions/checkout from 4.2.1 to 4.2.2 (#3253) by @dependabot
chore(deps): bump actions/setup-python from 5.2.0 to 5.3.0 (#3259) by @dependabot
chore(deps): bump actions/dependency-review-action from 4.3.4 to 4.3.5 (#3235) by @dependabot
chore(maintenance): add force-publish to bump all packages (#3238) by @am29d

🌟New features and non-breaking changes

feat(batch): Async Processing of Records for for SQS Fifo (#3160) by @arnabrahman
feat(metrics): add ability to pass custom logger (#3057) by @dreamorosi

🌟 Minor Changes

improv(parser): export API Gateway v2 request schemas (#3271) by @dreamorosi

📜 Documentation updates

chore: migrate dev environment to nodejs22 (#3327) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3335) by @dependabot
chore(deps): bump mkdocs-material from 9.5.44 to 9.5.45 in /docs (#3334) by @dependabot
feat(metrics): ability to set custom timestamp with setTimestamp for metrics (#3310) by @arnabrahman
chore(deps): bump the aws-sdk-v3 group across 1 directory with 3 updates (#3312) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3297) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3300) by @dependabot
feat(batch): Async Processing of Records for for SQS Fifo (#3160) by @arnabrahman
chore(deps): bump @types/node from 22.8.4 to 22.9.0 (#3290) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 2c2802b to ce587cb in /docs (#3294) by @dependabot
chore(deps): bump mkdocs-material from 9.5.43 to 9.5.44 in /docs (#3295) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3280) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3277) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 31eb7f7 to 2c2802b in /docs (#3276) by @dependabot
chore(deps): bump mkdocs-material from 9.5.41 to 9.5.43 in /docs (#3274) by @dependabot
chore(deps-dev): bump tsx from 4.19.1 to 4.19.2 (#3275) by @dependabot
chore(deps): bump @types/node from 22.7.7 to 22.8.4 (#3272) by @dependabot
chore(docs): fix typo in captureHTTPsRequests (#3143) by @psperber

🐛 Bug and hot fixes

fix(metrics): skip empty string dimension values (#3319) by @arnabrahman
fix(parser): event type literal for selfManagedKafka (#3325) by @am29d
fix(parser): add aws region to kinesis event (#3260) by @am29d
fix(parser): fix cause errors nested structure (#3250) by @am29d

🔧 Maintenance

chore: migrate dev environment to nodejs22 (#3327) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3335) by @dependabot
chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 (#3331) by @dependabot
chore(deps-dev): bump @vitest/coverage-v8 from 2.1.4 to 2.1.5 (#3318) by @dependabot
fix(parser): event type literal for selfManagedKafka (#3325) by @am29d
chore(deps): bump aws-xray-sdk-core from 3.10.1 to 3.10.2 (#3313) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 3 updates (#3312) by @dependabot
test(parameters): migrate tests to vitest (#3304) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1691.0 to 2.1692.0 (#3298) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3297) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3300) by @dependabot
test(parser): migrate to vitest (#3299) by @dreamorosi
chore(deps-dev): bump @vitest/coverage-v8 from 2.1.3 to 2.1.4 (#3289) by @dependabot
chore(deps): bump @types/node from 22.8.4 to 22.9.0 (#3290) by @dependabot
test(maintenance): switch layers to vitest (#3292) by @dreamorosi
chore(deps-dev): bump typedoc from 0.26.10 to 0.26.11 in the typedoc group across 1 directory (#3281) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3280) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3277) by @dependabot
test(maintenance): switch tracer to vitest (#3285) by @dreamorosi
chore(deps-dev): bump @types/jest from 29.5.13 to 29.5.14 (#3244) by @dependabot
chore(deps-dev): bump tsx from 4.19.1 to 4.19.2 (#3275) by @dependabot
chore(deps): bump @types/node from 22.7.7 to 22.8.4 (#3272) by @dependabot
chore(maintenance): exclude e2e tests from pre-push hook (#3240) by @dreamorosi

This release was made possible by the following contributors:

@am29d, @arnabrahman, @dependabot, @dependabot[bot], @dreamorosi, @github-actions, @github-actions[bot] and @psperber

v2.10.0

2024-10-23T10:17:12Z

Summary

This release improves the Logger utility by extending the formatting of errors to include custom properties.

⭐️ Thanks to @kevinpeno, and @ralbertazzi for their contributions to this release!

Log error properties

you more context over the nature of errors.

For example, consider these two custom error classes:

When calling logger.error('An error occurred', new SuperCustomError('foo', 42)); the log now looks like this:

Changes

chore(maintenance): add force-publish to bump all packages (#3238) by @am29d
chore(ci): add input type to the publish package workflow (#3236) by @am29d
chore(ci): add workflow to publish a single package (#3234) by @am29d
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.14 to 3.0.15 (#3223) by @dependabot
chore(deps): bump github/codeql-action from 3.26.12 to 3.26.13 (#3202) by @dependabot
chore(deps): bump actions/upload-artifact from 4.4.2 to 4.4.3 (#3187) by @dependabot
chore(deps): bump actions/upload-artifact from 4.4.0 to 4.4.2 (#3176) by @dependabot
chore(deps): bump github/codeql-action from 3.26.11 to 3.26.12 (#3174) by @dependabot
chore(deps): bump actions/checkout from 4.2.0 to 4.2.1 (#3175) by @dependabot
chore(layers): remove schema parsing from layer canary (#3171) by @dreamorosi

🌟New features and non-breaking changes

feat: add resetKeys to LoggerInterface type (#3213) by @ralbertazzi
feat(logger): include enumerable properties in formatted errors (#3195) by @dreamorosi

📜 Documentation updates

chore(deps): bump squidfunk/mkdocs-material from 0d4e687 to 31eb7f7 in /docs (#3224) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3220) by @dependabot
chore(deps): bump @types/node from 22.7.6 to 22.7.7 (#3221) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 5 updates (#3218) by @dependabot
chore(deps): bump constructs from 10.3.0 to 10.4.2 (#3205) by @dependabot
chore(deps): bump @types/node from 22.7.5 to 22.7.6 (#3216) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from f9cb76d to 0d4e687 in /docs (#3211) by @dependabot
chore(deps): bump mkdocs-material from 9.5.40 to 9.5.41 in /docs (#3210) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3203) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3198) by @dependabot
chore(deps): bump mkdocs-material from 9.5.38 to 9.5.40 in /docs (#3186) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 7aea359 to f9cb76d in /docs (#3185) by @dependabot
chore(deps): bump typescript from 5.6.2 to 5.6.3 (#3181) by @dependabot
chore(deps): bump @types/node from 22.7.4 to 22.7.5 (#3180) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3192) by @dependabot
docs(maintenance): add community content (#3190) by @dreamorosi
docs(metrics): clarify single metrics metadata & publish (#3189) by @dreamorosi
docs: fix env variable name in logEventIfEnabled() docstring (#3197) by @kevinpeno
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3167) by @dependabot

🔧 Maintenance

chore(maintenance): exclude e2e tests from pre-push hook (#3240) by @dreamorosi
chore(parser): bump parser to 2.10.0 (#3230) by @am29d
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3220) by @dependabot
chore(deps): bump @types/node from 22.7.6 to 22.7.7 (#3221) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from 61c3428 to d493ef0 in /.devcontainer (#3214) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 5 updates (#3218) by @dependabot
chore(deps-dev): bump @biomejs/biome from 1.9.3 to 1.9.4 (#3219) by @dependabot
chore(deps-dev): bump @vitest/coverage-v8 from 2.1.2 to 2.1.3 (#3206) by @dependabot
chore(deps): bump constructs from 10.3.0 to 10.4.2 (#3205) by @dependabot
chore(deps-dev): bump aws-sdk-client-mock-vitest from 4.0.0 to 4.0.1 (#3215) by @dependabot
chore(deps): bump @types/node from 22.7.5 to 22.7.6 (#3216) by @dependabot
chore(deps-dev): bump the aws-sdk-v3 group across 1 directory with 2 updates (#3207) by @dependabot
chore(deps-dev): bump typedoc from 0.26.8 to 0.26.10 in the typedoc group across 1 directory (#3209) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3203) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3198) by @dependabot
chore(deps): bump typescript from 5.6.2 to 5.6.3 (#3181) by @dependabot
chore(deps): bump @types/node from 22.7.4 to 22.7.5 (#3180) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3192) by @dependabot
chore(deps-dev): bump @biomejs/biome from 1.9.0 to 1.9.3 (#3177) by @dependabot
chore(deps-dev): bump typedoc from 0.26.7 to 0.26.8 in the typedoc group across 1 directory (#3166) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from 426f06d to 61c3428 in /.devcontainer (#3141) by @dependabot
chore(deps-dev): bump @vitest/coverage-v8 from 2.1.1 to 2.1.2 (#3152) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3167) by @dependabot
chore(deps-dev): bump aws-cdk from 1.155.0 to 1.161.0 in layers (#3169) by @dreamorosi

This release was made possible by the following contributors:

@am29d, @dreamorosi, @kevinpeno, and @ralbertazzi

v2.9.0

2024-10-08T13:31:46Z

Summary

This release introduces 1/ the ability to process records sequentially when working with async functions in Batch Processing, 2/ a new option for Idempotency to manipulate the payload stored for idempotent operations, and 3/ the option to specify custom JMESPath functions when selecting an idempotency key.

Finally, you can now use the Parser utility when using our public AWS Lambda layers.

⭐️ Thanks to @arnabrahman, @garysassano and, @scratchclaggy for their big contributions to this release!

Sequential async processing

You can now process records sequentially when working with async functions in Batch Processing by setting the processInParallel option to false. This is useful for when you want to opt-out of the default behavior and preserve the order of the records.

Manipulating idempotent responses

Now you can set up a responseHook function when configuring the Idempotency utility to manipulate the returned data when an operation is idempotent.

Custom JMESPath functions with Idempotency

You can now use custom JMESPath functions with the Idempotency utility by configuring the jmesPathOptions in your idempotency configuration. This is useful when you’re making idempotent operations that accept complex payloads or encoding formats that are not supported by default.

Changes

chore(layers): remove schema parsing from layer canary (#3171) by @dreamorosi
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.12 to 3.0.14 (#3162) by @dependabot
chore(deps): bump github/codeql-action from 3.26.9 to 3.26.11 (#3157) by @dependabot
chore(deps): bump actions/checkout from 4.1.7 to 4.2.0 (#3122) by @dependabot
chore(deps): bump github/codeql-action from 3.26.8 to 3.26.9 (#3114) by @dependabot
chore(deps): bump actions/setup-node from 4.0.3 to 4.0.4 (#3097) by @dependabot
chore(layers): add Parser to layer (#3101) by @scratchclaggy
chore(deps): bump github/codeql-action from 3.26.7 to 3.26.8 (#3087) by @dependabot

🌟New features and non-breaking changes

feat(idempotency): ability to specify JMESPath custom functions (#3150) by @arnabrahman
feat(batch): sequential async processing of records for BatchProcessor (#3109) by @arnabrahman
feat(idempotency): manipulate idempotent response via response hook (#3071) by @arnabrahman

🌟 Minor Changes

refactor(logger): use LogLevelThreshold constant inside Logger class (#3133) by @arnabrahman

📜 Documentation updates

chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3163) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3156) by @dependabot
chore(maintenance): add Flyweight customer reference (#3161) by @dreamorosi
docs(parser): highlight JSONStringify helper (#3158) by @dreamorosi
feat(idempotency): ability to specify JMESPath custom functions (#3150) by @arnabrahman
chore(deps): bump @types/node from 22.7.2 to 22.7.4 (#3139) by @dependabot
feat(batch): sequential async processing of records for BatchProcessor (#3109) by @arnabrahman
chore(deps): bump mkdocs-material from 9.5.36 to 9.5.38 in /docs (#3121) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 22a429f to 7aea359 in /docs (#3120) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3116) by @dependabot
chore(docs): recreate requirements.txt file for mkdocs container (#3119) by @leandrodamascena
chore(deps): bump squidfunk/mkdocs-material from 2a70399 to 22a429f in /docs (#3104) by @dependabot
chore(deps): bump mkdocs-material from 9.5.35 to 9.5.36 in /docs (#3105) by @dependabot
chore(deps): bump @types/node from 22.5.5 to 22.7.2 (#3115) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3110) by @dependabot
chore(deps): bump esbuild from 0.23.1 to 0.24.0 (#3102) by @dependabot
docs(idempotency): fix descriptions in Advanced table (#3092) by @garysassano
chore(deps): bump the aws-sdk-v3 group across 1 directory with 6 updates (#3107) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3088) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3090) by @dependabot
feat(idempotency): manipulate idempotent response via response hook (#3071) by @arnabrahman
chore(deps): bump squidfunk/mkdocs-material from a2e3a31 to 2a70399 in /docs (#3082) by @dependabot
chore(deps): bump mkdocs-material from 9.5.34 to 9.5.35 in /docs (#3084) by @dependabot
chore(deps): bump @types/node from 22.5.4 to 22.5.5 (#3067) by @dependabot

🔧 Maintenance

chore(deps-dev): bump aws-cdk from 1.155.0 to 1.161.0 in layers (#3169) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3163) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3156) by @dependabot
chore(maintenance): add Flyweight customer reference (#3161) by @dreamorosi
chore(metrics): expose MetricsInterface as return type of single metric and further improve API docs (#3145) by @dreamorosi
test(idempotency): switch e2e tests to vitest (#3149) by @dreamorosi
test(logger): switch e2e tests to vitest (#3148) by @dreamorosi
chore(deps): bump @types/node from 22.7.2 to 22.7.4 (#3139) by @dependabot
chore(deps): bump @aws-sdk/client-lambda from 3.658.1 to 3.659.0 in the aws-sdk-v3 group across 1 directory (#3127) by @dependabot
test(logger): migrate to vitest & custom matchers (#3131) by @dreamorosi
test(event-handler): migrate to vitest (#3126) by @dreamorosi
test(idempotency): migrate to vitest (#3124) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3116) by @dependabot
chore(deps): bump @types/node from 22.5.5 to 22.7.2 (#3115) by @dependabot
chore(deps): bump aws-xray-sdk-core from 3.10.0 to 3.10.1 (#3095) by @dependabot
chore(deps): bump @aws-cdk/cli-lib-alpha to 2.160.0-alpha.0 (#3118) by @dreamorosi
chore(deps-dev): bump @faker-js/faker from 9.0.1 to 9.0.2 (#3113) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3110) by @dependabot
chore(deps): bump esbuild from 0.23.1 to 0.24.0 (#3102) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from b303046 to 426f06d in /.devcontainer (#3108) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 6 updates (#3107) by @dependabot
chore(deps): bump rollup from 4.21.3 to 4.22.4 (#3106) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3088) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3090) by @dependabot
chore(deps-dev): bump @faker-js/faker from 9.0.0 to 9.0.1 (#3075) by @dependabot
chore(deps): bump vite from 5.4.5 to 5.4.6 (#3081) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from f1e8fdc to b303046 in /.devcontainer (#3080) by @dependabot
test(jmespath): switch tests to vitest (#3079) by @dreamorosi
test(commons): migrate to vitest (#3060) by @dreamorosi
chore(deps-dev): bump @vitest/coverage-v8 from 2.1.0 to 2.1.1 (#3068) by @dependabot
chore(deps): bump @types/node from 22.5.4 to 22.5.5 (#3067) by @dependabot

This release was made possible by the following contributors:

@arnabrahman, @dependabot, @dependabot[bot], @dreamorosi, @garysassano, @github-actions, @github-actions[bot], @leandrodamascena and @scratchclaggy

v2.8.0

2024-09-16T12:37:13Z

Summary

This release introduces 1/ the ability store parameters on AWS System Manager Parameter Store using the Parameters utility, and 2/ a new option for Logger that you can use to specify the order of how keys appear in your JSON-structured logs.

We are also adding a new TRACE log level to align with AWS Lambda Advanced Logging Controls (ALC), and improved made improvements to errors in the Idempotency utility, which now include more details on the cause of the error.

Finally, you can now use our public AWS Lambda Layers in two new AWS Regions: ap-south-2 and me-central-1.

⭐️ Thanks to @daschaa, @arnabrahman, and @timo92 for their contributions to this release!

Store parameters using SSM

In response to customer requests, you can now store parameters using AWS System Manager Parameter Store with the setParameter function. This new helper function fits right in with the other Parameters features you know and love, and provides a seamless experience without having to deal with the AWS SDK.

A big thank you to @daschaa for working on this feature!

Specify log keys order

You can now change the order of the keys in your logs via the logRecordOrder constructor parameter when using Logger. This is useful when you want to customize how the logs are structured without having to create and maintain your own custom log formatter.

When you specify one or more keys in the logRecordOrder we’ll place these keys first, followed by all the other keys in the log.

Thank you to @arnabrahman for adding this feature!

v1.x Reached End-of-Life (EOL)

Starting from September 1st 2024, v1.x of Powertools for AWS Lambda (TypeScript) has reached EOL and will not receive any further updates in accordance with our Versioning Policy.

We recommend you to upgrade to v2.x as soon as possible to continue receiving new feature and bug fixes. If you are having issues migrating and need support, please reach out via one of our channels or open a discussion on our repo.

Changes

chore(deps): bump github/codeql-action from 3.26.6 to 3.26.7 (#3064) by @dependabot
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.11 to 3.0.12 (#3034) by @dependabot
chore(maintenance): switch to unmanaged log group for functions (#3014) by @dreamorosi
chore(maintenance): remove obsolete workflow (#3016) by @dreamorosi
chore(deps): bump actions/upload-artifact from 4.3.6 to 4.4.0 (#3006) by @dependabot
chore(deps): bump actions/setup-python from 5.1.1 to 5.2.0 (#3001) by @dependabot
chore(deps): bump github/codeql-action from 3.26.5 to 3.26.6 (#2996) by @dependabot
docs(parameters): review API docs & README for Parameters (#2994) by @am29d
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.10 to 3.0.11 (#2979) by @dependabot
chore(deps): bump github/codeql-action from 3.26.4 to 3.26.5 (#2978) by @dependabot
chore(deps): bump github/codeql-action from 3.26.2 to 3.26.4 (#2968) by @dependabot
chore(deps): bump github/codeql-action from 3.26.1 to 3.26.2 (#2932) by @dependabot
test(logger): simplify unit tests structure (#2942) by @dreamorosi
chore(deps): bump github/codeql-action from 3.26.0 to 3.26.1 (#2925) by @dependabot
test(idempotency): simplify wrapper & middleware tests (#2919) by @dreamorosi
chore(deps): bump actions/upload-artifact from 4.3.4 to 4.3.6 (#2895) by @dependabot
chore(deps): bump github/codeql-action from 3.25.15 to 3.26.0 (#2894) by @dependabot

🌟New features and non-breaking changes

feat(parameters): adds setParameter function to store SSM parameters (#3020) by @daschaa
feat(logger): introduce log key reordering functionality (#2736) by @arnabrahman
feat(logger): introduce loglevel trace #1589 (#2902) by @timo92

🌟 Minor Changes

improv(logger): streamline Logger types (#3054) by @dreamorosi
improv(tracer): set AWS_XRAY_CONTEXT_MISSING to IGNORE_ERROR when no value is set (#3058) by @dreamorosi
improv(metrics): avoid emitting empty EMF metric (#3044) by @dreamorosi
improv(parameters): include cause in set parameter error (#3047) by @dreamorosi
improv(parser): correctly infer helper return type (#2946) by @dreamorosi

📜 Documentation updates

chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3066) by @dependabot
chore(deps-dev): bump tsx from 4.19.0 to 4.19.1 (#3062) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3049) by @dependabot
docs(tracer): clarify escape hatch mechanism (#3056) by @dreamorosi
docs(idempotency): add callout about undefined early return (#3055) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3048) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3045) by @dependabot
feat(parameters): adds setParameter function to store SSM parameters (#3020) by @daschaa
chore(docs): fix spelling issues (#3039) by @dreamorosi
chore(deps): bump typescript from 5.5.4 to 5.6.2 (#3041) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3038) by @dependabot
chore(deps): bump @types/node from 22.5.2 to 22.5.4 (#3026) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3036) by @dependabot
feat(logger): introduce log key reordering functionality (#2736) by @arnabrahman
docs(maintenance): fix install instructions & switch test runner (#3030) by @dreamorosi
docs(maintenance): mark 1.x as EoL on docs (#3019) by @dreamorosi
chore(deps): bump mkdocs-material from 9.5.33 to 9.5.34 in /docs (#3005) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 7132ca3 to a2e3a31 in /docs (#3004) by @dependabot
chore(deps): bump @types/node from 22.5.1 to 22.5.2 (#3008) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.155.0 in the aws-cdk group across 1 directory (#3007) by @dependabot
chore(deps): bump @types/node from 22.5.0 to 22.5.1 (#2998) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.148.1 (#3003) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2999) by @dependabot
docs: removed unnecessary exports previously added to api docs (#3000) by @am29d
chore(deps): bump ts-jest from 29.2.4 to 29.2.5 (#2981) by @dependabot
chore(deps-dev): bump tsx from 4.17.0 to 4.19.0 (#2986) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.143 to 8.10.145 (#2991) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.148.1 (#2988) by @dependabot
chore(docs): load self hosted mermaid.js (#2977) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2973) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2972) by @dependabot
chore(deps): bump @types/node from 22.4.1 to 22.5.0 (#2966) by @dependabot
chore(deps): bump mkdocs-material from 9.5.32 to 9.5.33 in /docs (#2971) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from a73e4bb to 7132ca3 in /docs (#2974) by @dependabot
chore(deps): bump esbuild from 0.23.0 to 0.23.1 (#2950) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2962) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2958) by @dependabot
chore(deps): bump mkdocs-material from 9.5.31 to 9.5.32 in /docs (#2953) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 9919d6e to a73e4bb in /docs (#2952) by @dependabot
chore(deps): bump @types/node from 22.3.0 to 22.4.1 (#2951) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2931) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2941) by @dependabot
chore(deps): bump @types/node from 22.2.0 to 22.3.0 (#2926) by @dependabot
docs(logger): add logEventIfEnabled() docs (#2924) by @dreamorosi
chore(layers): deploy Lambda layers in ap-south-2 and me-central-1 (#2933) by @dreamorosi
feat(logger): introduce loglevel trace #1589 (#2902) by @timo92
chore(deps): bump @types/node from 22.1.0 to 22.2.0 (#2914) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2922) by @dependabot
docs(idempotency): review API docs & README (#2917) by @am29d
chore(maintenance): replace copy command in docs dockerfile (#2911) by @dreamorosi
chore(deps): bump @types/aws-lambda from 8.10.142 to 8.10.143 (#2896) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2888) by @dependabot
chore(deps-dev): bump tsx from 4.16.5 to 4.17.0 (#2907) by @dependabot

🐛 Bug and hot fixes

fix(tracer): include request pathname in trace data (#2955) by @dreamorosi
fix(idempotency): include cause in idempotency persistence layer error (#2916) by @dreamorosi

🔧 Maintenance

chore(deps-dev): bump path-to-regexp to 6.3.0 (#3070) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3066) by @dependabot
chore(deps-dev): bump @types/jest from 29.5.12 to 29.5.13 (#3063) by @dependabot
chore(deps-dev): bump tsx from 4.19.0 to 4.19.1 (#3062) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from aedf26c to f1e8fdc in /.devcontainer (#3061) by @dependabot
chore(deps-dev): bump @biomejs/biome from 1.8.3 to 1.9.0 (#3052) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3049) by @dependabot
chore(deps-dev): bump @vitest/coverage-v8 from 2.0.5 to 2.1.0 (#3051) by @dependabot
chore(deps-dev): bump husky from 9.1.5 to 9.1.6 (#3050) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3048) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3045) by @dependabot
chore(docs): fix spelling issues (#3039) by @dreamorosi
chore(deps): bump aws-xray-sdk-core from 3.9.0 to 3.10.0 (#3042) by @dependabot
chore(deps): bump typescript from 5.5.4 to 5.6.2 (#3041) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1687.0 to 2.1691.0 (#3035) by @dependabot
chore(deps-dev): bump typedoc from 0.26.6 to 0.26.7 in the typedoc group across 1 directory (#3040) by @dependabot
chore(deps-dev): bump markdownlint-cli2 from 0.13.0 to 0.14.0 (#3043) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#3038) by @dependabot
chore(deps-dev): bump @faker-js/faker from 8.4.1 to 9.0.0 (#3027) by @dependabot
chore(deps): bump @types/node from 22.5.2 to 22.5.4 (#3026) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#3036) by @dependabot
test(tracer): streamline e2e test structure (#3031) by @dreamorosi
docs(maintenance): fix install instructions & switch test runner (#3030) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1686.0 to 2.1688.0 (#3022) by @dependabot
test(maintenance): improve assertions on traces & logs (#3012) by @dreamorosi
chore(deps-dev): bump lint-staged from 15.2.9 to 15.2.10 (#3010) by @dependabot
chore(deps): bump @types/node from 22.5.1 to 22.5.2 (#3008) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.155.0 in the aws-cdk group across 1 directory (#3007) by @dependabot
chore(deps): bump @types/node from 22.5.0 to 22.5.1 (#2998) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1685.0 to 2.1686.0 (#3002) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.148.1 (#3003) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2999) by @dependabot
chore(docs): remove markdownlint exclusions (#2995) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1684.0 to 2.1685.0 (#2997) by @dependabot
docs(tracer): review API docs & README for Tracer (#2992) by @am29d
chore(deps): bump ts-jest from 29.2.4 to 29.2.5 (#2981) by @dependabot
chore(deps-dev): bump tsx from 4.17.0 to 4.19.0 (#2986) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1680.0 to 2.1684.0 (#2989) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.143 to 8.10.145 (#2991) by @dependabot
chore(deps): bump aws-cdk from 2.145.0 to 2.148.1 (#2988) by @dependabot
docs(logger): review API docs & README for Logger (#2984) by @am29d
docs(metrics): review API docs & README (#2983) by @am29d
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2973) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2972) by @dependabot
chore(deps): bump @types/node from 22.4.1 to 22.5.0 (#2966) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from e2228df to aedf26c in /.devcontainer (#2963) by @dependabot
chore(deps): bump esbuild from 0.23.0 to 0.23.1 (#2950) by @dependabot
chore(deps-dev): bump husky from 9.1.4 to 9.1.5 (#2959) by @dependabot
chore(deps): bump @aws-sdk/client-lambda from 3.635.0 to 3.636.0 in the aws-sdk-v3 group across 1 directory (#2969) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1677.0 to 2.1680.0 (#2967) by @dependabot
chore(deps-dev): bump hashi-vault-js from 0.4.15 to 0.4.16 (#2964) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2962) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2958) by @dependabot
test(maintenance): migrate testing utils to vitest (#2940) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1673.0 to 2.1677.0 (#2947) by @dependabot
chore(deps): bump @types/node from 22.3.0 to 22.4.1 (#2951) by @dependabot
chore(deps-dev): bump the typedoc group across 1 directory with 2 updates (#2949) by @dependabot
test(batch): migrate unit tests to Vitest (#2938) by @dreamorosi
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2931) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2941) by @dependabot
chore(deps): bump @types/node from 22.2.0 to 22.3.0 (#2926) by @dependabot
chore(ci): add vitest to workspace (#2935) by @dreamorosi
feat(logger): introduce loglevel trace #1589 (#2902) by @timo92
chore(deps-dev): bump axios from 1.7.2 to 1.7.4 (#2928) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from 2ac7b2c to e2228df in /.devcontainer (#2909) by @dependabot
chore(deps): bump @types/node from 22.1.0 to 22.2.0 (#2914) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1671.0 to 2.1673.0 (#2921) by @dependabot
chore(deps-dev): bump lint-staged from 15.2.8 to 15.2.9 (#2920) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2922) by @dependabot
docs(idempotency): review API docs & README (#2917) by @am29d
chore(deps-dev): bump aws-sdk from 2.1668.0 to 2.1671.0 (#2908) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.142 to 8.10.143 (#2896) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2888) by @dependabot
chore(deps-dev): bump tsx from 4.16.5 to 4.17.0 (#2907) by @dependabot

This release was made possible by the following contributors:

@am29d, @arnabrahman, @daschaa, @dreamorosi, and @timo92

v2.7.0

2024-08-08T13:44:29Z

Summary

This release 1/ brings a new helper function to parse JSON stringified fields when using Parser, 2/ and improved Metrics, which now can emit metrics using the None unit.

⭐️ Thanks to @daschaa for fixing Logger and making it default to :UTC when encountering an invalid time zone value.

Quickly parse JSON stringified fields

You can now parse and validate JSON stringified fields using Zod schemas without having to transform them first. This is useful when working with payloads coming from sources that stringify payloads like Amazon API Gateway, Amazon SQS, Amazon Application Load Balancer (ALB), etc.

Use the JSONStringified helper to extend your schemas or any of the built-in schemas in Parser:

Metrics without unit

You can now create metrics without a unit of measure, this is helpful when your business metrics are tied to an abstract concept or when none of the units supported by the Embedded metric format specification fit.

Changes

chore(ci): extract cached-node-modules action (#2876) by @dreamorosi
chore(deps): bump github/codeql-action from 3.25.14 to 3.25.15 (#2855) by @dependabot
chore(deps): bump ossf/scorecard-action from 2.3.3 to 2.4.0 (#2856) by @dependabot
chore(deps): bump github/codeql-action from 3.25.13 to 3.25.14 (#2845) by @dependabot

🌟New features and non-breaking changes

feat(metrics): add unit None for CloudWatch EMF Metrics (#2904) by @am29d
feat(parser): add helper functions to transform JSON stringified payloads (#2901) by @am29d

📜 Documentation updates

feat(parser): add helper functions to transform JSON stringified payloads (#2901) by @am29d
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2884) by @dependabot
chore(deps): bump typescript from 5.4.5 to 5.5.4 (#2820) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2882) by @dependabot
chore(deps): bump mkdocs-material from 9.5.30 to 9.5.31 in /docs (#2877) by @dependabot
chore(deps): bump @types/node from 22.0.2 to 22.1.0 (#2879) by @dependabot
chore(deps): bump squidfunk/mkdocs-material from 257eca8 to 9919d6e in /docs (#2881) by @dependabot
chore(deps): bump @types/node from 22.0.0 to 22.0.2 (#2872) by @dependabot
chore(deps-dev): bump tsx from 4.16.3 to 4.16.5 (#2873) by @dependabot
chore(deps): bump ts-jest from 29.1.5 to 29.2.4 (#2874) by @dependabot
chore(maintenance): add LocalStack customer reference (#2870) by @dreamorosi
chore(deps-dev): bump tsx from 4.16.2 to 4.16.3 (#2867) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2866) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2861) by @dependabot
chore(deps): bump @types/node from 20.14.10 to 22.0.0 (#2852) by @dependabot
chore: create event-handler utility workspace (#2858) by @dreamorosi
chore(maintenance): add Banxware & WeSchool customer references (#2859) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2848) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.141 to 8.10.142 (#2849) by @dependabot
chore(maintenance): remove eslint & prettier (#2841) by @dreamorosi
chore(maintenance): add caylent as customer reference (#2843) by @dreamorosi

🐛 Bug and hot fixes

fix(logger): invalid time zone environment variables leads to error (#2865) by @daschaa

🔧 Maintenance

feat(parser): add helper functions to transform JSON stringified payloads (#2901) by @am29d
chore(commons): extract lru-cache into commons (#2899) by @dreamorosi
chore(deps-dev): bump lint-staged from 15.2.7 to 15.2.8 (#2885) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1667.0 to 2.1668.0 (#2890) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2884) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1666.0 to 2.1667.0 (#2886) by @dependabot
chore(deps): bump typescript from 5.4.5 to 5.5.4 (#2820) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2882) by @dependabot
chore(deps): bump @types/node from 22.0.2 to 22.1.0 (#2879) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1665.0 to 2.1666.0 (#2880) by @dependabot
chore(deps): bump @types/node from 22.0.0 to 22.0.2 (#2872) by @dependabot
chore(deps-dev): bump tsx from 4.16.3 to 4.16.5 (#2873) by @dependabot
chore(deps): bump ts-jest from 29.1.5 to 29.2.4 (#2874) by @dependabot
chore(maintenance): add LocalStack customer reference (#2870) by @dreamorosi
chore(deps-dev): bump tsx from 4.16.2 to 4.16.3 (#2867) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1664.0 to 2.1665.0 (#2868) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2866) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2861) by @dependabot
chore(deps-dev): bump husky from 9.0.11 to 9.1.4 (#2860) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1663.0 to 2.1664.0 (#2854) by @dependabot
chore(deps): bump @types/node from 20.14.10 to 22.0.0 (#2852) by @dependabot
chore: create event-handler utility workspace (#2858) by @dreamorosi
chore(maintenance): add Banxware & WeSchool customer references (#2859) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2848) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.141 to 8.10.142 (#2849) by @dependabot
chore(maintenance): remove eslint & prettier (#2841) by @dreamorosi
chore(parser): adds scoped exports for schemas and envelopes (#2847) by @daschaa
chore(maintenance): add caylent as customer reference (#2843) by @dreamorosi
chore(parser): adds exports for Record schemas (#2846) by @daschaa
chore(deps-dev): bump aws-sdk from 2.1659.0 to 2.1663.0 (#2835) by @dependabot

This release was made possible by the following contributors:

@am29d, @daschaa, and @dreamorosi

v2.6.0

2024-07-25T14:05:05Z

Summary

This release 1/ promotes Parser to Generally Available and ready for production, and 2/ adds support for unsupported types serialization in Logger.

⭐ Big thanks to @daschaa for helping improve our code quality automation
🏅 Congrats to @marlapativ & @sandrokeil on their first contribution

Parser is Generally Available

We want to thank the community who engaged with us, tested Parser during beta, and provided valuable feedback and contributions to improve everyone' experience.

New to Parser?

Parser provides data validation and parsing using Zod, a TypeScript-first schema declaration and validation library, and comes with built-in schemas and envelopes for common AWS event types for AWS Lambda.

To get started with Parser, you also need to install Zod:

npm install @aws-lambda-powertools/parser zod@~3

Next, you can extend one of the schemas using your own schema, and parse the event both with class method decorators (or Middy.js):

Support unserializable types

You can now extend the default logic used to emit JSON-structured logs by passing a custom serializer function to the Logger constructor, using the jsonReplacerFn option. This is useful when you want to customize the serialization of specific values.

Changes

chore(parser): review imports (#2838) by @dreamorosi
chore(deps): bump github/codeql-action from 3.25.12 to 3.25.13 (#2789) by @dependabot
chore(maintenance): migrate jmespath utility to biome (#2807) by @dreamorosi
chore(maintenance): migrate testing utility to biome (#2808) by @dreamorosi
chore(maintenance): migrate idempotency utility to biome (#2810) by @dreamorosi
chore(deps): bump aws-actions/closed-issue-message from 36b7048ea77bb834d16e7a7c5b5471ac767a4ca1 to 80edfc24bdf1283400eb04d20a8a605ae8bf7d48 (#2784) by @dependabot
chore(deps): bump actions/setup-python from 5.1.0 to 5.1.1 (#2765) by @dependabot
chore(deps): bump github/codeql-action from 3.25.11 to 3.25.12 (#2771) by @dependabot

🌟New features and non-breaking changes

feat(parser): allow parser set event type of handler with middy (#2786) by @am29d
feat(logger): introduce loglevel constant (#2787) by @marlapativ

🌟 Minor Changes

improv(logger): export LoggerInterface (#2832) by @sandrokeil

📜 Documentation updates

chore(ci): revert bump version to 2.6.0 (#2836) by @dreamorosi
chore(docs): Add lambda layer policy to versioning docs (#2824) by @hjgraca
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2818) by @dependabot
chore(deps): bump mkdocs-material from 9.5.29 to 9.5.30 in /docs (#2815) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2817) by @dependabot
chore(maintenance): migrate snippets to biome (#2814) by @daschaa
chore(maintenance): add biome to the project (#2791) by @dreamorosi
chore(deps): bump mkdocs-material from 9.5.28 to 9.5.29 in /docs (#2778) by @dependabot

🔧 Maintenance

chore(ci): revert bump version to 2.6.0 (#2836) by @dreamorosi
chore(parser): mark parser as GA (#2831) by @dreamorosi
chore(maintenance): migrate parser utility to biome (#2822) by @daschaa
chore(deps-dev): bump typedoc from 0.26.4 to 0.26.5 in the typedoc group across 1 directory (#2819) by @dependabot
chore(deps): bump the aws-cdk group across 1 directory with 2 updates (#2818) by @dependabot
chore(maintenance): migrate metrics utility to biome (#2816) by @daschaa
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2817) by @dependabot
chore(maintenance): migrate parameters utility to biome (#2812) by @dreamorosi
chore(maintenance): migrate tracer utility to biome (#2809) by @dreamorosi
chore(maintenance): migrate logger utility to biome (#2813) by @daschaa
chore(maintenance): migrate batch utility to biome (#2804) by @dreamorosi
chore(maintenance): migrate commons utility to biome (#2805) by @dreamorosi
chore(maintenance): migrate layers package to biome (#2806) by @dreamorosi
chore(maintenance): add biome to the project (#2791) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1657.0 to 2.1659.0 (#2776) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from cf26683 to 2ac7b2c in /.devcontainer (#2770) by @dependabot

This release was made possible by the following contributors:

@am29d, @daschaa, @dreamorosi, @hjgraca, @marlapativ and @sandrokeil

v2.5.0

2024-07-15T10:24:25Z

Summary

The regression on the Parser utility introduced in the last release is resolved in this release. You can now access again the errors that made the validation fail using the cause property of the ParseError.

We continue improving our test coverage for the utility during the beta period and before the utility is considered generally available.

Changes

chore(deps): bump actions/dependency-review-action from 4.3.3 to 4.3.4 (#2772) by @dependabot
chore(deps): bump actions/setup-node from 4.0.2 to 4.0.3 (#2757) by @dependabot

🌟New features and non-breaking changes

feat(logger): custom function for unserializable values (JSON replacer) (#2739) by @arnabrahman

📜 Documentation updates

chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2766) by @dependabot
feat(logger): custom function for unserializable values (JSON replacer) (#2739) by @arnabrahman
chore(deps): bump @types/node from 20.14.9 to 20.14.10 (#2760) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.140 to 8.10.141 (#2761) by @dependabot
docs(parser): add section on how to test parser using decorator (#2755) by @am29d

🐛 Bug and hot fixes

fix(parser): links the error cause with ParseError (#2774) by @tusharf5

🔧 Maintenance

chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2766) by @dependabot
chore(deps-dev): bump typedoc from 0.26.3 to 0.26.4 in the typedoc group across 1 directory (#2759) by @dependabot
chore(deps): bump @types/node from 20.14.9 to 20.14.10 (#2760) by @dependabot
chore(deps): bump vscode/devcontainers/javascript-node from cad3951 to cf26683 in /.devcontainer (#2756) by @dependabot
chore(deps): bump @types/aws-lambda from 8.10.140 to 8.10.141 (#2761) by @dependabot

This release was made possible by the following contributors:

@am29d, @arnabrahman, @dependabot, @dependabot[bot], @github-actions, @github-actions[bot] and @tusharf5

v2.4.0

2024-07-11T10:28:43Z

Summary

This release improves: 1/ Logger by making it time zone aware, and 2/ Batch Processing which you can now customize to not throw an error when the entire batch of items fails to process.

We also dropped support for Node.js 16, and introduced support for Middy.js 5.x for functions using ES Modules.

🌟 ⭐ Thank you to @arnabrahman for the work on both the new features!

Change timezone in log timestamps

You can now change the timezone used for timestamps in your logs using the TZ environment variable, which is now taken in account when instantiating a new Logger instance. This is useful for when you want your logs to use a different timezone than the default UTC one.

Working with full batch failures

You can now configure the Batch Processing utility to not throw a FullBatchFailureError when all the records in the batch fail to process, by setting the throwOnFullBatchFailure option to false. This is useful when working with functions that handle batches with a small number of records, or when you use errors as a flow control mechanism.

End of support for Node.js 16

Three months ago we announced that we would stop supporting Node.js 16, and today we are removing support.
End of support does not impact existing functions and functions using versions of Powertools for AWS Lambda (TypeScript) up to version 2.3.0, however starting from this release we no longer guarantee compatibility with Node.js 16.

We recommend that you upgrade your existing Node.js 16 functions to Node.js 18 or later if you want to use Powertools for AWS Lambda (TypeScript) version 2.4.0 and above.

Changes

chore(ci): revert enable CodeQl (#2731) (#2740) by @dreamorosi
chore(deps): bump github/codeql-action from 3.23.0 to 3.25.11 (#2745) by @dependabot
chore(deps): bump actions/download-artifact from 4.1.7 to 4.1.8 (#2746) by @dependabot
chore(deps): bump actions/upload-artifact from 4.3.3 to 4.3.4 (#2744) by @dependabot
chore(ci): enable CodeQl (#2731) by @dreamorosi
chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.9 to 3.0.10 (#2729) by @dependabot
chore(deps): bump github/codeql-action from 3.25.10 to 3.25.11 (#2719) by @dependabot
chore(ci): update Dependabot groups for typedoc (#2716) by @dreamorosi

🌟New features and non-breaking changes

feat(internal): support Middy.js 5.x (#2748) by @dreamorosi
feat(batch): add option to not throw FullBatchFailureError when the entire batch fails (#2711) by @arnabrahman
feat(logger): time zone aware timestamp in Logger (#2710) by @arnabrahman
feat(maintenance): drop support for Node.js 16.x (#2717) by @dreamorosi
chore(layers): deploy Lambda layers in ap-south-2 and me-central-1 (#2675) by @dreamorosi

📜 Documentation updates

chore(layers): revert deploy Lambda layers in ap-south-2 and me-central-1 (#2762) by @dreamorosi
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2754) by @dependabot
feat(internal): support Middy.js 5.x (#2748) by @dreamorosi
feat(batch): add option to not throw FullBatchFailureError when the entire batch fails (#2711) by @arnabrahman
chore(deps): bump certifi from 2023.11.17 to 2024.7.4 in /docs (#2738) by @dependabot
chore(deps-dev): bump tsx from 4.16.0 to 4.16.2 (#2732) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2733) by @dependabot
chore(deps): bump mkdocs-material from 9.5.27 to 9.5.28 in /docs (#2728) by @dependabot
feat(logger): time zone aware timestamp in Logger (#2710) by @arnabrahman
feat(maintenance): drop support for Node.js 16.x (#2717) by @dreamorosi
chore(deps): bump esbuild from 0.21.5 to 0.23.0 (#2722) by @dependabot
chore(deps-dev): bump tsx from 4.15.7 to 4.16.0 (#2718) by @dependabot
chore(layers): deploy Lambda layers in ap-south-2 and me-central-1 (#2675) by @dreamorosi
chore(deps): bump the aws-sdk group across 1 directory with 9 updates (#2712) by @dependabot
chore(layers): downgrade aws cdk to 2.145.0 (#2700) by @dreamorosi

🐛 Bug and hot fixes

fix(idempotency): check error identity via names (#2747) by @dreamorosi

🔧 Maintenance

chore(deps-dev): bump aws-sdk from 2.1652.0 to 2.1657.0 (#2753) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2754) by @dependabot
feat(internal): support Middy.js 5.x (#2748) by @dreamorosi
chore(deps-dev): bump aws-sdk from 2.1651.0 to 2.1652.0 (#2726) by @dependabot
chore(deps-dev): bump tsx from 4.16.0 to 4.16.2 (#2732) by @dependabot
chore(deps): bump the aws-sdk-v3 group across 1 directory with 9 updates (#2733) by @dependabot
feat(maintenance): drop support for Node.js 16.x (#2717) by @dreamorosi
chore(deps): bump esbuild from 0.21.5 to 0.23.0 (#2722) by @dependabot
chore(deps-dev): bump tsx from 4.15.7 to 4.16.0 (#2718) by @dependabot
chore(deps-dev): bump the typedoc group across 1 directory with 3 updates (#2720) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1649.0 to 2.1651.0 (#2714) by @dependabot
chore(deps): bump the aws-sdk group across 1 directory with 9 updates (#2712) by @dependabot
chore(deps-dev): bump aws-sdk from 2.1648.0 to 2.1649.0 (#2706) by @dependabot
chore(layers): downgrade AWS CDK to 2.145.0 part 2 (#2702) by @dreamorosi
chore(layers): downgrade aws cdk to 2.145.0 (#2700) by @dreamorosi

This release was made possible by the following contributors:

@arnabrahman, and @dreamorosi