diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 78ea680699..9eaace6133 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -94,6 +94,11 @@ jobs: - name: Copy API Docs run: | cp -r api site/ + - name: Create Artifact (Site) + uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 + with: + name: site + path: site - name: Deploy Docs (Version) env: VERSION: ${{ inputs.version }} @@ -121,7 +126,7 @@ jobs: # 1. Download the versions.json file from S3 # 2. Find any reference to the alias and delete it from the versions file # 3. This is voodoo (don't use JQ): - # - we assign the input as $o and the new version/alias as $n, + # - we assign the input as $o and the new version/alias as $n, # - we check if the version number exists in the file already (for republishing docs) # - if it's an alias (stage/latest/*) or old version, we do nothing and output $o (original input) # - if it's a new version number, we add it at position 0 in the array. diff --git a/CHANGELOG.md b/CHANGELOG.md index 78a04beeaa..0119115ca0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) ### Bug Fixes diff --git a/README.md b/README.md index 0363e5c104..6eff246381 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ You can use the library in both TypeScript and JavaScript code bases. * **[Logger](https://docs.powertools.aws.dev/lambda-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://docs.powertools.aws.dev/lambda-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) * **[Parameters](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB -* **[Idempotency (beta)](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content -* **[Batch Processing (beta)](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. +* **[Idempotency](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content +* **[Batch Processing](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. ## Getting started diff --git a/docs/core/tracer.md b/docs/core/tracer.md index c9c0b79cf0..c8dab4003c 100644 --- a/docs/core/tracer.md +++ b/docs/core/tracer.md @@ -129,16 +129,22 @@ When using the `captureLambdaHandler` decorator or middleware, Tracer performs t === "Annotations" You can add annotations using `putAnnotation` method. - ```typescript hl_lines="9" + ```typescript hl_lines="12" --8<-- "docs/snippets/tracer/putAnnotation.ts" ``` + + 1. When Lambda starts an invocation [the X-Ray SDk creates a segment called `facade`](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-subsegments.html#xray-sdk-nodejs-subsegments-lambda). This segment cannot be annotated or modified by your code, so you need to create a new subsegment. This is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler) + 2. To correctly trace the current and subsequent invocations you need to restore the original segment, this is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler). === "Metadata" You can add metadata using `putMetadata` method. - ```typescript hl_lines="9-11" + ```typescript hl_lines="12-14" --8<-- "docs/snippets/tracer/putMetadata.ts" ``` + 1. When Lambda starts an invocation [the X-Ray SDk creates a segment called `facade`](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-subsegments.html#xray-sdk-nodejs-subsegments-lambda). This segment cannot be modified by your code, so you need to create a new subsegment. This is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler) + 2. To correctly trace the current and subsequent invocations you need to restore the original segment, this is done automatically by Tracer when using the [decorator or middleware patterns](./tracer.md/#lambda-handler). +
Screenshot of the Amazon CloudWatch Console showing an example of segments and subsegments generated and with metadata set for the handler
Tracer showcase - Handler Metadata
diff --git a/docs/index.md b/docs/index.md index dc80473c9d..55c581ee7d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,7 +26,7 @@ You can use Powertools for AWS Lambda (TypeScript) in both TypeScript and JavaSc You can install Powertools for AWS Lambda (TypeScript) using one of the following options: -* **Lambda Layer**: [**arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18**](#){: .copyMe}:clipboard: +* **Lambda Layer**: [**arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19**](#){: .copyMe}:clipboard: * **npm**: [`npm install @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics @aws-lambda-powertools/logger`](#){: .copyMe}:clipboard: ### Lambda Layer @@ -41,32 +41,32 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L | Region | Layer ARN | | ---------------- | ------------------------------------------------------------------------------------------------------------ | - | `us-east-1` | [arn:aws:lambda:us-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `us-east-2` | [arn:aws:lambda:us-east-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `us-west-1` | [arn:aws:lambda:us-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `us-west-2` | [arn:aws:lambda:us-west-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-south-1` | [arn:aws:lambda:ap-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-east-1` | [arn:aws:lambda:ap-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-northeast-1` | [arn:aws:lambda:ap-northeast-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-northeast-2` | [arn:aws:lambda:ap-northeast-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-northeast-3` | [arn:aws:lambda:ap-northeast-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-southeast-1` | [arn:aws:lambda:ap-southeast-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-southeast-2` | [arn:aws:lambda:ap-southeast-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-southeast-3` | [arn:aws:lambda:ap-southeast-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ap-southeast-4` | [arn:aws:lambda:ap-southeast-4:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-central-1` | [arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-central-2` | [arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-west-1` | [arn:aws:lambda:eu-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-west-2` | [arn:aws:lambda:eu-west-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-west-3` | [arn:aws:lambda:eu-west-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-north-1` | [arn:aws:lambda:eu-north-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-south-1` | [arn:aws:lambda:eu-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `eu-south-2` | [arn:aws:lambda:eu-south-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `ca-central-1` | [arn:aws:lambda:ca-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `sa-east-1` | [arn:aws:lambda:sa-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `af-south-1` | [arn:aws:lambda:af-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `me-south-1` | [arn:aws:lambda:me-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | - | `il-central-1` | [arn:aws:lambda:il-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:18](#){: .copyMe}:clipboard: | + | `us-east-1` | [arn:aws:lambda:us-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `us-east-2` | [arn:aws:lambda:us-east-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `us-west-1` | [arn:aws:lambda:us-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `us-west-2` | [arn:aws:lambda:us-west-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-south-1` | [arn:aws:lambda:ap-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-east-1` | [arn:aws:lambda:ap-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-northeast-1` | [arn:aws:lambda:ap-northeast-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-northeast-2` | [arn:aws:lambda:ap-northeast-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-northeast-3` | [arn:aws:lambda:ap-northeast-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-southeast-1` | [arn:aws:lambda:ap-southeast-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-southeast-2` | [arn:aws:lambda:ap-southeast-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-southeast-3` | [arn:aws:lambda:ap-southeast-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ap-southeast-4` | [arn:aws:lambda:ap-southeast-4:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-central-1` | [arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-central-2` | [arn:aws:lambda:eu-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-west-1` | [arn:aws:lambda:eu-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-west-2` | [arn:aws:lambda:eu-west-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-west-3` | [arn:aws:lambda:eu-west-3:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-north-1` | [arn:aws:lambda:eu-north-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-south-1` | [arn:aws:lambda:eu-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `eu-south-2` | [arn:aws:lambda:eu-south-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `ca-central-1` | [arn:aws:lambda:ca-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `sa-east-1` | [arn:aws:lambda:sa-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `af-south-1` | [arn:aws:lambda:af-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `me-south-1` | [arn:aws:lambda:me-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | + | `il-central-1` | [arn:aws:lambda:il-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:19](#){: .copyMe}:clipboard: | ??? note "Click to expand and copy code snippets for popular frameworks" @@ -77,7 +77,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L Type: AWS::Serverless::Function Properties: Layers: - - !Sub arn:aws:lambda:${AWS::Region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18 + - !Sub arn:aws:lambda:${AWS::Region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19 ``` If you use `esbuild` to bundle your code, make sure to exclude `@aws-lambda-powertools` from being bundled since the packages will be already present the Layer: @@ -108,7 +108,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L hello: handler: lambda_function.lambda_handler layers: - - arn:aws:lambda:${aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18 + - arn:aws:lambda:${aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19 ``` If you use `esbuild` to bundle your code, make sure to exclude `@aws-lambda-powertools` from being bundled since the packages will be already present the Layer: @@ -140,7 +140,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L const powertoolsLayer = lambda.LayerVersion.fromLayerVersionArn( this, 'PowertoolsLayer', - `arn:aws:lambda:${cdk.Stack.of(this).region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18` + `arn:aws:lambda:${cdk.Stack.of(this).region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19` ); new lambda.Function(this, 'Function', { @@ -192,7 +192,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L role = ... handler = "index.handler" runtime = "nodejs16.x" - layers = ["arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18"] + layers = ["arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19"] source_code_hash = filebase64sha256("lambda_function_payload.zip") } ``` @@ -210,7 +210,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L const lambdaFunction = new aws.lambda.Function('function', { layers: [ - pulumi.interpolate`arn:aws:lambda:${aws.getRegionOutput().name}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18` + pulumi.interpolate`arn:aws:lambda:${aws.getRegionOutput().name}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19` ], code: new pulumi.asset.FileArchive('lambda_function_payload.zip'), tracingConfig: { @@ -234,7 +234,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L ? Do you want to configure advanced settings? Yes ... ? Do you want to enable Lambda layers for this function? Yes - ? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18 + ? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19 ❯ amplify push -y # Updating an existing function and add the layer @@ -244,7 +244,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L - Name: ? Which setting do you want to update? Lambda layers configuration ? Do you want to enable Lambda layers for this function? Yes - ? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18 + ? Enter up to 5 existing Lambda layer ARNs (comma-separated): arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19 ? Do you want to edit the local lambda function now? No ``` @@ -254,7 +254,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L Change {region} to your AWS region, e.g. `eu-west-1` ```bash title="AWS CLI" - aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18 --region {region} + aws lambda get-layer-version-by-arn --arn arn:aws:lambda:{aws::region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:19 --region {region} ``` The pre-signed URL to download this Lambda Layer will be within `Location` key. @@ -282,12 +282,14 @@ If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly Core utilities such as Tracing, Logging, and Metrics will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand. -| Utility | Description | -| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | -| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | -| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | -| [Parameters (beta)](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | +| Utility | Description | +|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | +| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | +| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | +| [Parameters](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | +| [Idempotency](./utilities/idempotency.md) | Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content. | +| [Batch Processing](./utilities/batch.md) | Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. | ## Environment variables diff --git a/docs/requirements.txt b/docs/requirements.txt index 9332acafa3..28ee101cfe 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ mike==1.1.2 -mkdocs-material==9.0.2 +mkdocs-material==9.3.2 mkdocs-git-revision-date-plugin==0.3.2 mkdocs-exclude==1.0.2 \ No newline at end of file diff --git a/docs/snippets/tracer/putAnnotation.ts b/docs/snippets/tracer/putAnnotation.ts index c83363417f..fdff8108e5 100644 --- a/docs/snippets/tracer/putAnnotation.ts +++ b/docs/snippets/tracer/putAnnotation.ts @@ -6,5 +6,11 @@ export const handler = async ( _event: unknown, _context: unknown ): Promise => { + const handlerSegment = tracer.getSegment()?.addNewSubsegment('### handler'); + handlerSegment && tracer.setSegment(handlerSegment); // (1)! + tracer.putAnnotation('successfulBooking', true); + + handlerSegment?.close(); + handlerSegment && tracer.setSegment(handlerSegment?.parent); // (2)! }; diff --git a/docs/snippets/tracer/putMetadata.ts b/docs/snippets/tracer/putMetadata.ts index 4458907925..5b900a138c 100644 --- a/docs/snippets/tracer/putMetadata.ts +++ b/docs/snippets/tracer/putMetadata.ts @@ -6,7 +6,13 @@ export const handler = async ( _event: unknown, _context: unknown ): Promise => { + const handlerSegment = tracer.getSegment()?.addNewSubsegment('### handler'); + handlerSegment && tracer.setSegment(handlerSegment); // (1)! + tracer.putMetadata('paymentResponse', { foo: 'bar', }); + + handlerSegment?.close(); + handlerSegment && tracer.setSegment(handlerSegment?.parent); // (2)! }; diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index d04907563a..6c871ed307 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -3,10 +3,8 @@ } .highlight .hll { - background-color: lavender; - - [data-md-color-scheme="slate"] { - background-color: rgb(69, 48, 164) + [data-md-color-scheme="default"] { + background-color: lavender; } } diff --git a/docs/utilities/batch.md b/docs/utilities/batch.md index 47c14cad56..5c2b5631f1 100644 --- a/docs/utilities/batch.md +++ b/docs/utilities/batch.md @@ -3,9 +3,6 @@ title: Batch Processing description: Utility --- -???+ warning - **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/14) we might introduce significant breaking changes and improvements in response to customers feedback. - The batch processing utility handles partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. ```mermaid diff --git a/docs/utilities/idempotency.md b/docs/utilities/idempotency.md index 0bb45ac7b9..3100fffa23 100644 --- a/docs/utilities/idempotency.md +++ b/docs/utilities/idempotency.md @@ -3,9 +3,6 @@ title: Idempotency description: Utility --- -???+ warning - **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/7) we might introduce significant breaking changes and improvements in response to customers feedback. - The idempotency utility provides a simple solution to convert your Lambda functions into idempotent operations which are safe to retry. ## Key features diff --git a/examples/cdk/CHANGELOG.md b/examples/cdk/CHANGELOG.md index b661e66ead..45f9e641e7 100644 --- a/examples/cdk/CHANGELOG.md +++ b/examples/cdk/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package cdk-sample + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package cdk-sample diff --git a/examples/cdk/package.json b/examples/cdk/package.json index 3ec5802d2c..b3d1748195 100644 --- a/examples/cdk/package.json +++ b/examples/cdk/package.json @@ -1,6 +1,6 @@ { "name": "cdk-sample", - "version": "1.13.0", + "version": "1.13.1", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" @@ -25,11 +25,11 @@ "*.js": "npm run lint-fix" }, "devDependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", - "@aws-lambda-powertools/logger": "^1.13.0", - "@aws-lambda-powertools/metrics": "^1.13.0", - "@aws-lambda-powertools/parameters": "^1.13.0", - "@aws-lambda-powertools/tracer": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", + "@aws-lambda-powertools/logger": "^1.13.1", + "@aws-lambda-powertools/metrics": "^1.13.1", + "@aws-lambda-powertools/parameters": "^1.13.1", + "@aws-lambda-powertools/tracer": "^1.13.1", "@aws-sdk/client-ssm": "^3.413.0", "@aws-sdk/lib-dynamodb": "^3.413.0", "@types/aws-lambda": "^8.10.121", diff --git a/examples/sam/CHANGELOG.md b/examples/sam/CHANGELOG.md index ff350d2658..1675f5c7d4 100644 --- a/examples/sam/CHANGELOG.md +++ b/examples/sam/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package sam-example + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package sam-example diff --git a/examples/sam/package.json b/examples/sam/package.json index 1d3adc03f0..bf0f00c1bf 100644 --- a/examples/sam/package.json +++ b/examples/sam/package.json @@ -1,6 +1,6 @@ { "name": "sam-example", - "version": "1.13.0", + "version": "1.13.1", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" @@ -30,10 +30,10 @@ "typescript": "^5.2.2" }, "dependencies": { - "@aws-lambda-powertools/logger": "^1.13.0", - "@aws-lambda-powertools/metrics": "^1.13.0", - "@aws-lambda-powertools/parameters": "^1.13.0", - "@aws-lambda-powertools/tracer": "^1.13.0", + "@aws-lambda-powertools/logger": "^1.13.1", + "@aws-lambda-powertools/metrics": "^1.13.1", + "@aws-lambda-powertools/parameters": "^1.13.1", + "@aws-lambda-powertools/tracer": "^1.13.1", "@aws-sdk/client-dynamodb": "^3.413.0", "@aws-sdk/client-ssm": "^3.413.0", "@aws-sdk/lib-dynamodb": "^3.413.0", diff --git a/layers/CHANGELOG.md b/layers/CHANGELOG.md index c45ccb00e5..7014c66a0d 100644 --- a/layers/CHANGELOG.md +++ b/layers/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package layers + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package layers diff --git a/layers/package.json b/layers/package.json index fc43ed2665..03d0fbcff9 100644 --- a/layers/package.json +++ b/layers/package.json @@ -1,6 +1,6 @@ { "name": "layers", - "version": "1.13.0", + "version": "1.13.1", "bin": { "layer": "bin/layers.js" }, diff --git a/lerna.json b/lerna.json index 3b62c8e546..90247a576c 100644 --- a/lerna.json +++ b/lerna.json @@ -12,7 +12,7 @@ "examples/sam", "layers" ], - "version": "1.13.0", + "version": "1.13.1", "npmClient": "npm", "message": "chore(release): %s [skip ci]" } diff --git a/package-lock.json b/package-lock.json index 1967e3ad40..85f846f737 100644 --- a/package-lock.json +++ b/package-lock.json @@ -72,7 +72,7 @@ }, "examples/cdk": { "name": "cdk-sample", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { "@middy/core": "^3.6.2", @@ -85,11 +85,11 @@ "cdk-app": "bin/cdk-app.js" }, "devDependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", - "@aws-lambda-powertools/logger": "^1.13.0", - "@aws-lambda-powertools/metrics": "^1.13.0", - "@aws-lambda-powertools/parameters": "^1.13.0", - "@aws-lambda-powertools/tracer": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", + "@aws-lambda-powertools/logger": "^1.13.1", + "@aws-lambda-powertools/metrics": "^1.13.1", + "@aws-lambda-powertools/parameters": "^1.13.1", + "@aws-lambda-powertools/tracer": "^1.13.1", "@aws-sdk/client-ssm": "^3.413.0", "@aws-sdk/lib-dynamodb": "^3.413.0", "@types/aws-lambda": "^8.10.121", @@ -111,13 +111,13 @@ }, "examples/sam": { "name": "sam-example", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/logger": "^1.13.0", - "@aws-lambda-powertools/metrics": "^1.13.0", - "@aws-lambda-powertools/parameters": "^1.13.0", - "@aws-lambda-powertools/tracer": "^1.13.0", + "@aws-lambda-powertools/logger": "^1.13.1", + "@aws-lambda-powertools/metrics": "^1.13.1", + "@aws-lambda-powertools/parameters": "^1.13.1", + "@aws-lambda-powertools/tracer": "^1.13.1", "@aws-sdk/client-dynamodb": "^3.413.0", "@aws-sdk/client-ssm": "^3.413.0", "@aws-sdk/lib-dynamodb": "^3.413.0", @@ -142,7 +142,7 @@ "dev": true }, "layers": { - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { "aws-cdk": "^2.96.1", @@ -17736,12 +17736,12 @@ }, "packages/batch": { "name": "@aws-lambda-powertools/batch", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0" }, "packages/commons": { "name": "@aws-lambda-powertools/commons", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "devDependencies": { "@aws-sdk/client-appconfigdata": "^3.413.0", @@ -17754,10 +17754,10 @@ }, "packages/idempotency": { "name": "@aws-lambda-powertools/idempotency", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "@aws-sdk/util-base64-node": "^3.209.0", "jmespath": "^0.16.0" }, @@ -17772,7 +17772,7 @@ "peerDependencies": { "@aws-sdk/client-dynamodb": ">=3.x", "@aws-sdk/lib-dynamodb": ">=3.x", - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@aws-sdk/client-dynamodb": { @@ -17788,10 +17788,10 @@ }, "packages/logger": { "name": "@aws-lambda-powertools/logger", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "lodash.merge": "^4.6.2" }, "devDependencies": { @@ -17799,7 +17799,7 @@ "@types/lodash.merge": "^4.6.7" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { @@ -17809,10 +17809,10 @@ }, "packages/metrics": { "name": "@aws-lambda-powertools/metrics", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0" + "@aws-lambda-powertools/commons": "^1.13.1" }, "devDependencies": { "@aws-lambda-powertools/testing-utils": "file:../testing", @@ -17821,7 +17821,7 @@ "promise-retry": "^2.0.1" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { @@ -17831,10 +17831,10 @@ }, "packages/parameters": { "name": "@aws-lambda-powertools/parameters", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "@aws-sdk/util-base64-node": "^3.209.0" }, "devDependencies": { @@ -17852,7 +17852,7 @@ "@aws-sdk/client-secrets-manager": ">=3.x", "@aws-sdk/client-ssm": ">=3.x", "@aws-sdk/util-dynamodb": ">=3.x", - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@aws-sdk/client-appconfigdata": { @@ -17877,7 +17877,7 @@ }, "packages/testing": { "name": "@aws-lambda-powertools/testing-utils", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { "@aws-cdk/cli-lib-alpha": "^2.96.1-alpha.0", @@ -17887,10 +17887,10 @@ }, "packages/tracer": { "name": "@aws-lambda-powertools/tracer", - "version": "1.13.0", + "version": "1.13.1", "license": "MIT-0", "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "aws-xray-sdk-core": "^3.5.1" }, "devDependencies": { @@ -17903,7 +17903,7 @@ "promise-retry": "^2.0.1" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { diff --git a/packages/batch/CHANGELOG.md b/packages/batch/CHANGELOG.md index 8bf25d9d7b..fa660af861 100644 --- a/packages/batch/CHANGELOG.md +++ b/packages/batch/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package @aws-lambda-powertools/batch + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) ### Bug Fixes diff --git a/packages/batch/README.md b/packages/batch/README.md index ff26800107..622297d37c 100644 --- a/packages/batch/README.md +++ b/packages/batch/README.md @@ -1,11 +1,5 @@ # Powertools for AWS Lambda (TypeScript) - Batch Processing Utility - -| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/14) we might introduce significant breaking changes and improvements in response to customers feedback. | _ | - - Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda-typescript/latest/#features). You can use the package in both TypeScript and JavaScript code bases. diff --git a/packages/batch/package.json b/packages/batch/package.json index 3e9f7482f1..ed8b1daf12 100644 --- a/packages/batch/package.json +++ b/packages/batch/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/batch", - "version": "1.13.0", + "version": "1.13.1", "description": "The batch processing package for the Powertools for AWS Lambda (TypeScript) library.", "author": { "name": "Amazon Web Services", diff --git a/packages/commons/CHANGELOG.md b/packages/commons/CHANGELOG.md index f017cc6fdd..b9bac66556 100644 --- a/packages/commons/CHANGELOG.md +++ b/packages/commons/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package @aws-lambda-powertools/commons + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/commons diff --git a/packages/commons/README.md b/packages/commons/README.md index cfef383eb4..29241216a8 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -32,6 +32,8 @@ You can use the library in both TypeScript and JavaScript code bases. * **[Logger](https://docs.powertools.aws.dev/lambda-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://docs.powertools.aws.dev/lambda-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) * **[Parameters](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM, Secrets Manager, AppConfig, and DynamoDB +* **[Idempotency](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content +* **[Batch processing](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. ## Getting started diff --git a/packages/commons/package.json b/packages/commons/package.json index 4f3bc52dfd..119d11f620 100644 --- a/packages/commons/package.json +++ b/packages/commons/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/commons", - "version": "1.13.0", + "version": "1.13.1", "description": "A shared utility package for Powertools for AWS Lambda (TypeScript) libraries", "author": { "name": "Amazon Web Services", diff --git a/packages/commons/src/version.ts b/packages/commons/src/version.ts index f9f331fd56..c42c660c40 100644 --- a/packages/commons/src/version.ts +++ b/packages/commons/src/version.ts @@ -1,2 +1,2 @@ // this file is auto generated, do not modify -export const PT_VERSION = '1.12.2'; +export const PT_VERSION = '1.13.1'; diff --git a/packages/idempotency/CHANGELOG.md b/packages/idempotency/CHANGELOG.md index 6027a60597..2010310696 100644 --- a/packages/idempotency/CHANGELOG.md +++ b/packages/idempotency/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/idempotency diff --git a/packages/idempotency/README.md b/packages/idempotency/README.md index 27abb05d24..99e8f812e8 100644 --- a/packages/idempotency/README.md +++ b/packages/idempotency/README.md @@ -1,11 +1,6 @@ # Powertools for AWS Lambda (TypeScript) - Idempotency Utility -| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/10) we might introduce significant breaking changes and improvements in response to customers feedback. | _ | - - Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda-typescript/latest/#features). You can use the package in both TypeScript and JavaScript code bases. diff --git a/packages/idempotency/package.json b/packages/idempotency/package.json index 3d189e9d54..d40fb0e5b5 100644 --- a/packages/idempotency/package.json +++ b/packages/idempotency/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/idempotency", - "version": "1.13.0", + "version": "1.13.1", "description": "The idempotency package for the Powertools for AWS Lambda (TypeScript) library. It provides options to make your Lambda functions idempotent and safe to retry.", "author": { "name": "Amazon Web Services", @@ -79,14 +79,14 @@ "url": "https://github.com/aws-powertools/powertools-lambda-typescript/issues" }, "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "@aws-sdk/util-base64-node": "^3.209.0", "jmespath": "^0.16.0" }, "peerDependencies": { "@aws-sdk/client-dynamodb": ">=3.x", "@aws-sdk/lib-dynamodb": ">=3.x", - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@aws-sdk/client-dynamodb": { diff --git a/packages/logger/CHANGELOG.md b/packages/logger/CHANGELOG.md index 2f2fea0a1d..439c9c581d 100644 --- a/packages/logger/CHANGELOG.md +++ b/packages/logger/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/logger diff --git a/packages/logger/package.json b/packages/logger/package.json index 49c7e93012..d9b03c56c3 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/logger", - "version": "1.13.0", + "version": "1.13.1", "description": "The logging package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", @@ -35,7 +35,7 @@ "@types/lodash.merge": "^4.6.7" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { @@ -53,7 +53,7 @@ "url": "https://github.com/aws-powertools/powertools-lambda-typescript/issues" }, "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "lodash.merge": "^4.6.2" }, "keywords": [ diff --git a/packages/metrics/CHANGELOG.md b/packages/metrics/CHANGELOG.md index fac1d8d871..5ea5585bce 100644 --- a/packages/metrics/CHANGELOG.md +++ b/packages/metrics/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/metrics diff --git a/packages/metrics/package.json b/packages/metrics/package.json index 4e8d2640cd..43df8c7a1f 100644 --- a/packages/metrics/package.json +++ b/packages/metrics/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/metrics", - "version": "1.13.0", + "version": "1.13.1", "description": "The metrics package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", @@ -37,7 +37,7 @@ "promise-retry": "^2.0.1" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { @@ -55,7 +55,7 @@ "url": "https://github.com/aws-powertools/powertools-lambda-typescript/issues" }, "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0" + "@aws-lambda-powertools/commons": "^1.13.1" }, "keywords": [ "aws", diff --git a/packages/parameters/CHANGELOG.md b/packages/parameters/CHANGELOG.md index f9e0cd6b79..28c89edcb5 100644 --- a/packages/parameters/CHANGELOG.md +++ b/packages/parameters/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) ### Bug Fixes diff --git a/packages/parameters/package.json b/packages/parameters/package.json index fc20717084..bbfcd7098d 100644 --- a/packages/parameters/package.json +++ b/packages/parameters/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/parameters", - "version": "1.13.0", + "version": "1.13.1", "description": "The parameters package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", @@ -146,7 +146,7 @@ "aws-sdk-client-mock-jest": "^3.0.0" }, "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "@aws-sdk/util-base64-node": "^3.209.0" }, "peerDependencies": { @@ -155,7 +155,7 @@ "@aws-sdk/client-secrets-manager": ">=3.x", "@aws-sdk/client-ssm": ">=3.x", "@aws-sdk/util-dynamodb": ">=3.x", - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { diff --git a/packages/testing/CHANGELOG.md b/packages/testing/CHANGELOG.md index 21a5ab58e5..cccbf59027 100644 --- a/packages/testing/CHANGELOG.md +++ b/packages/testing/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +**Note:** Version bump only for package @aws-lambda-powertools/testing-utils + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/testing-utils diff --git a/packages/testing/package.json b/packages/testing/package.json index da264a79c3..e4834088b4 100644 --- a/packages/testing/package.json +++ b/packages/testing/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/testing-utils", - "version": "1.13.0", + "version": "1.13.1", "description": "A package containing utilities to test your serverless workloads", "author": { "name": "Amazon Web Services", diff --git a/packages/tracer/CHANGELOG.md b/packages/tracer/CHANGELOG.md index 407d7e739c..fbaefc4da9 100644 --- a/packages/tracer/CHANGELOG.md +++ b/packages/tracer/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.13.1](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.13.0...v1.13.1) (2023-09-21) + +### Bug Fixes + +- **maintenance:** remove upper peer dependency Middy ([#1705](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1705)) ([df21ec8](https://github.com/aws-powertools/powertools-lambda-typescript/commit/df21ec8761b1be511c13c28fedd41bf0e2851061)) + # [1.13.0](https://github.com/aws-powertools/powertools-lambda-typescript/compare/v1.12.1...v1.13.0) (2023-09-18) **Note:** Version bump only for package @aws-lambda-powertools/tracer diff --git a/packages/tracer/package.json b/packages/tracer/package.json index 0bce9f1ebf..aa026c0527 100644 --- a/packages/tracer/package.json +++ b/packages/tracer/package.json @@ -1,6 +1,6 @@ { "name": "@aws-lambda-powertools/tracer", - "version": "1.13.0", + "version": "1.13.1", "description": "The tracer package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", @@ -40,7 +40,7 @@ "promise-retry": "^2.0.1" }, "peerDependencies": { - "@middy/core": ">=3.x <4.x" + "@middy/core": ">=3.x" }, "peerDependenciesMeta": { "@middy/core": { @@ -58,7 +58,7 @@ "url": "https://github.com/aws-powertools/powertools-lambda-typescript/issues" }, "dependencies": { - "@aws-lambda-powertools/commons": "^1.13.0", + "@aws-lambda-powertools/commons": "^1.13.1", "aws-xray-sdk-core": "^3.5.1" }, "keywords": [ diff --git a/packages/tracer/src/helpers.ts b/packages/tracer/src/helpers.ts index 485475c07c..48fc9eda68 100644 --- a/packages/tracer/src/helpers.ts +++ b/packages/tracer/src/helpers.ts @@ -1,6 +1,11 @@ import { Tracer } from '.'; import type { TracerOptions } from './types'; +/** + * Create a new tracer instance with the given options. + * + * @deprecated - This function will be removed in the next major release. Use the Tracer class directly instead. + */ const createTracer = (options: TracerOptions = {}): Tracer => new Tracer(options);