From 940dfa93e02904d692e3b739a95bc73faee121c0 Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 23 May 2023 09:36:47 +0000 Subject: [PATCH 01/15] chore: rename project to Powertools for AWS Lambda (TypeScript) --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 6 ++-- .github/ISSUE_TEMPLATE/maintenance.yml | 4 +-- .github/ISSUE_TEMPLATE/rfc.yml | 6 ++-- .github/ISSUE_TEMPLATE/share_your_work.yml | 8 ++--- .github/ISSUE_TEMPLATE/support_powertools.yml | 14 ++++---- .github/boring-cyborg.yml | 4 +-- CONTRIBUTING.md | 10 +++--- MAINTAINERS.md | 2 +- README.md | 28 +++++++-------- docs/index.md | 36 +++++++++---------- docs/roadmap.md | 2 +- docs/snippets/package.json | 2 +- docs/we_made_this.md | 20 +++++------ examples/cdk/README.md | 4 +-- examples/cdk/functions/get-all-items.ts | 2 +- examples/sam/README.md | 8 ++--- examples/sam/src/get-all-items.ts | 2 +- examples/sam/template.yaml | 2 +- layers/README.md | 6 ++-- layers/jest.config.js | 2 +- layers/package.json | 2 +- layers/src/layer-publisher-stack.ts | 2 +- layers/tests/unit/layer-publisher.test.ts | 2 +- mkdocs.yml | 4 +-- packages/commons/README.md | 24 ++++++------- packages/commons/jest.config.js | 2 +- packages/commons/package.json | 2 +- packages/commons/src/Utility.ts | 4 +-- packages/commons/src/types/middy.ts | 2 +- packages/idempotency/README.md | 26 +++++++------- packages/idempotency/jest.config.js | 2 +- packages/idempotency/package.json | 2 +- packages/logger/README.md | 24 ++++++------- packages/logger/jest.config.js | 2 +- packages/logger/package.json | 2 +- .../helpers/populateEnvironmentVariables.ts | 2 +- packages/metrics/README.md | 24 ++++++------- packages/metrics/jest.config.js | 2 +- packages/metrics/package.json | 2 +- .../helpers/populateEnvironmentVariables.ts | 2 +- packages/parameters/README.md | 24 ++++++------- packages/parameters/jest.config.js | 2 +- packages/parameters/package.json | 2 +- .../tests/e2e/secretsProvider.class.test.ts | 2 +- packages/tracer/README.md | 24 ++++++------- packages/tracer/jest.config.js | 2 +- packages/tracer/package.json | 2 +- .../tests/e2e/allFeatures.decorator.test.ts | 6 ++-- .../tests/e2e/allFeatures.manual.test.ts | 2 +- .../tests/e2e/allFeatures.middy.test.ts | 6 ++-- .../tests/e2e/asyncHandler.decorator.test.ts | 4 +-- .../helpers/populateEnvironmentVariables.ts | 2 +- 53 files changed, 191 insertions(+), 191 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ef199d42c0..746aa44b0e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -56,7 +56,7 @@ body: - type: input id: version attributes: - label: AWS Lambda Powertools for TypeScript version + label: Powertools for AWS Lambda (TypeScript) version placeholder: "latest, 1.3.0" value: latest validations: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index eb77d4d838..c9b5f5e488 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Thank you for taking the time to suggest an idea to the Lambda Powertools project. + Thank you for taking the time to suggest an idea to the Powertools for AWS Lambda (TypeScript) project. - type: textarea id: problem attributes: @@ -34,9 +34,9 @@ body: attributes: label: Acknowledgment options: - - label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) + - label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) required: true - - label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) + - label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) required: false - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE/maintenance.yml index 505a284360..b90899682f 100644 --- a/.github/ISSUE_TEMPLATE/maintenance.yml +++ b/.github/ISSUE_TEMPLATE/maintenance.yml @@ -48,9 +48,9 @@ body: attributes: label: Acknowledgment options: - - label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) + - label: This request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) required: true - - label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) + - label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) required: false - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml index ea9e5a2b98..a555f8f16b 100644 --- a/.github/ISSUE_TEMPLATE/rfc.yml +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -15,7 +15,7 @@ body: - type: dropdown id: area attributes: - label: Which AWS Lambda Powertools utility does this relate to? + label: Which Powertools for AWS Lambda (TypeScript) utility does this relate to? options: - Tracer - Logger @@ -81,9 +81,9 @@ body: attributes: label: Acknowledgment options: - - label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) + - label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#tenets) required: true - - label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) + - label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [.NET](https://github.com/awslabs/aws-lambda-powertools-dotnet/) required: false - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/share_your_work.yml b/.github/ISSUE_TEMPLATE/share_your_work.yml index 2ee619fccd..8477619b6b 100644 --- a/.github/ISSUE_TEMPLATE/share_your_work.yml +++ b/.github/ISSUE_TEMPLATE/share_your_work.yml @@ -1,5 +1,5 @@ name: I Made This (showcase your work) -description: Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps, etc. +description: Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps, etc. title: "[I Made This]: " labels: ["community-content"] body: @@ -13,7 +13,7 @@ body: description: | Please share the original link to your material. - *Note: Short links will be expanded when added to Powertools documentation* + *Note: Short links will be expanded when added to Powertools for AWS Lambda (TypeScript) documentation* validations: required: true - type: textarea @@ -44,7 +44,7 @@ body: description: | Any notes you might want to share with us related to this material. - *Note: These notes are explicitly to Powertools maintainers. It will not be added to the community resources page.* + *Note: These notes are explicitly to Powertools for AWS Lambda (TypeScript) maintainers. It will not be added to the community resources page.* validations: required: false - type: checkboxes @@ -52,5 +52,5 @@ body: attributes: label: Acknowledgment options: - - label: I understand this content may be removed from Powertools documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct) + - label: I understand this content may be removed from Powertools for AWS Lambda (TypeScript) documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct) required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/support_powertools.yml b/.github/ISSUE_TEMPLATE/support_powertools.yml index a667a13f5e..d1f7bdf8a9 100644 --- a/.github/ISSUE_TEMPLATE/support_powertools.yml +++ b/.github/ISSUE_TEMPLATE/support_powertools.yml @@ -1,12 +1,12 @@ -name: Support Lambda Powertools (become a reference) -description: Add your organization's name or logo to the Lambda Powertools documentation -title: "[Support Lambda Powertools]: <your organization name>" +name: Support Powertools for AWS Lambda (TypeScript) (become a reference) +description: Add your organization's name or logo to the Powertools for AWS Lambda (TypeScript) documentation +title: "[Support Powertools for AWS Lambda (TypeScript)]: <your organization name>" labels: ["customer-reference"] body: - type: markdown attributes: value: | - Thank you for becoming a reference customer. Your support means a lot to us. It also helps new customers to know who're using Lambda Powertools. + Thank you for becoming a reference customer. Your support means a lot to us. It also helps new customers to know who're using Powertools for AWS Lambda (TypeScript). If you would like us to also display your organization's logo, please share a link in the `Company logo` field. - type: input @@ -42,13 +42,13 @@ body: id: use_case attributes: label: (Optional) Use case - description: How are you using Lambda Powertools today? *features, etc.* + description: How are you using Powertools for AWS Lambda (TypeScript) today? *features, etc.* validations: required: false - type: checkboxes id: other_languages attributes: - label: Also using other Lambda Powertools languages? + label: Also using other Powertools for AWS Lambda languages? options: - label: Python required: false @@ -59,6 +59,6 @@ body: - type: markdown attributes: value: | - *By raising a Support Lambda Powertools issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.* + *By raising a Support Powertools for AWS Lambda (TypeScript) issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.* *You can opt-out at any time by commenting or reopening this issue.* \ No newline at end of file diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml index d19858b927..cd6de6d321 100644 --- a/.github/boring-cyborg.yml +++ b/.github/boring-cyborg.yml @@ -160,7 +160,7 @@ labelPRBasedOnFilePath: firstPRWelcomeComment: > Thanks a lot for your first contribution! Please check out our [contributing guidelines](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/chore/pr_automation/CONTRIBUTING.md) and don't hesitate to ask whatever you need. - In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET) + In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET) # Comment to be posted to congratulate user on their first merged PR firstPRMergeComment: > @@ -170,4 +170,4 @@ firstPRMergeComment: > firstIssueWelcomeComment: > Thanks for opening your first issue here! We'll come back to you as soon as we can. - In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET) + In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: [Invite link](https://discord.gg/B8zZKbbyET) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc227e7777..172d524d4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ reported the issue. Please try to include as much information as you can. Detail ## Getting Started -The following steps describe how to set up the AWS Lambda Powertools for TypeScript repository on your local machine. +The following steps describe how to set up the Powertools for AWS Lambda (TypeScript) repository on your local machine. The alternative is to use a Cloud IDE like [Gitpod](https://www.gitpod.io/) or [GitHub CodeSpaces](https://github.com/features/codespaces) for your development. To quickly get up and running you can click one of these button to open a cloned version of this repo with all of the prerequisites and dependencies installed: @@ -98,11 +98,11 @@ the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeu ### Repo Layout -The AWS Lambda Powertools is a npm project written in [TypeScript](https://www.typescriptlang.org/). +The Powertools for AWS Lambda (TypeScript) is a npm project written in [TypeScript](https://www.typescriptlang.org/). More specifically, it is a [monorepo managed using npm workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces). If you're unfamiliar with any of these technologies, it is useful to learn about them and will make understanding the codebase easier but strictly not necessary for simple contributions. -The repo contains `packages/` directory that contains the Powertools utilities modules. For instance, the source code for the Logger utility can be found at the location `packages/logger` and so on. +The repo contains `packages/` directory that contains the Powertools for AWS Lambda (TypeScript) utilities modules. For instance, the source code for the Logger utility can be found at the location `packages/logger` and so on. The repo also contains a `packages/commons` directory that holds code and logic shared between one or more utilities and that is published as a separate npm package. ### Tests @@ -205,7 +205,7 @@ You can run the end-to-end tests automatically on your forked project by followi ### Examples -As part of the repo you will find an examples folder at the root. This folder contains examples (written with CDK and SAM) of deployable AWS Lambda functions using Powertools. +As part of the repo you will find an examples folder at the root. This folder contains examples (written with CDK and SAM) of deployable AWS Lambda functions using Powertools for AWS Lambda (TypeScript). To test your updates with these examples, you just have to: @@ -314,7 +314,7 @@ Work your magic. Before starting, make sure to check the [Getting Started](#Gett * Create a commit with your changes and push them to a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo). - > Note: Core members can push directly to a branch on the AWS Lambda Powertools (TypeScript) repo (following the same conventions detailed below). + > Note: Core members can push directly to a branch on the Powertools for AWS Lambda (TypeScript) repo (following the same conventions detailed below). * Create a [pull request on GitHub](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). * Pull request title and message (and PR title and description) must adhere to diff --git a/MAINTAINERS.md b/MAINTAINERS.md index b320bdb9f9..28dae901c3 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -228,7 +228,7 @@ To run locally, you need [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/ ### Releasing a documentation hotfix -You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/workflows/publish-docs-on-release.yml). Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools version available i.e. `v1.4.1`. +You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/workflows/publish-docs-on-release.yml). Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools for AWS Lambda (TypeScript) version available i.e. `v1.4.1`. This workflow will update both user guide and API documentation. diff --git a/README.md b/README.md index ea1689ed12..518d0a2298 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> [![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET) -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -22,7 +22,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -48,13 +48,13 @@ You have 2 ways of consuming those utilities: #### Lambda layers -The AWS Lambda Powertools for TypeScript utilities is packaged as a single [AWS Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-concepts.html#gettingstarted-concepts-layer) +The Powertools for AWS Lambda (TypeScript) utilities is packaged as a single [AWS Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-concepts.html#gettingstarted-concepts-layer) -๐Ÿ‘‰ [Installation guide for the **AWS Lambda Powertools for TypeScript** layer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#lambda-layer) +๐Ÿ‘‰ [Installation guide for the **Powertools for AWS Lambda (TypeScript)** layer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#lambda-layer) #### NPM modules -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. Install all three core utilities at once with this single command: @@ -80,7 +80,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -89,19 +89,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -115,15 +115,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda (TypeScript) languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/docs/index.md b/docs/index.md index b5a0410992..34be5292e7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,14 @@ --- title: Homepage -description: AWS Lambda Powertools for TypeScript +description: Powertools for AWS Lambda (TypeScript) --- -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](#features). -You can use Powertools in both TypeScript and JavaScript code bases. +You can use Powertools for AWS Lambda (TypeScript) in both TypeScript and JavaScript code bases. ???+ tip - Powertools is also available for [Python](https://awslabs.github.io/aws-lambda-powertools-python/){target="_blank"}, [Java](https://awslabs.github.io/aws-lambda-powertools-java/){target="_blank"}, and [.NET](https://awslabs.github.io/aws-lambda-powertools-dotnet/){target="_blank"} + Powertools for AWS Lambda is also available for [Python](https://awslabs.github.io/aws-lambda-powertools-python/){target="_blank"}, [Java](https://awslabs.github.io/aws-lambda-powertools-java/){target="_blank"}, and [.NET](https://awslabs.github.io/aws-lambda-powertools-dotnet/){target="_blank"} ??? hint "Support this project by becoming a reference customer, sharing your work, or using Layers :heart:" @@ -18,13 +18,13 @@ You can use Powertools in both TypeScript and JavaScript code bases. 2) [**Share your work**](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=community-content&template=share_your_work.yml&title=%5BI+Made+This%5D%3A+%3CTITLE%3E). Blog posts, video, sample projects you used Powertools! - 3) Use [**Lambda Layers**](#lambda-layer), if possible. This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Lambda Powertools languages. + 3) Use [**Lambda Layers**](#lambda-layer), if possible. This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. - When using Layers, you can add Lambda Powertools as a `devDependency` to not impact the development process. + When using Layers, you can add Powertools for AWS Lambda (TypeScript) as a `devDependency` to not impact the development process. ## Install -You can install Powertools using one of the following options: +You can install Powertools for AWS Lambda (TypeScript) using one of the following options: * **Lambda Layer**: [**arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:11**](#){: .copyMe}:clipboard: * **npm**: [`npm install @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics @aws-lambda-powertools/logger`](#){: .copyMe}:clipboard: @@ -35,7 +35,7 @@ You can install Powertools using one of the following options: [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html){target="_blank"} is a .zip file archive that can contain additional code, pre-packaged dependencies, data, or configuration files. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic. -You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework. +You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework. ??? note "Click to expand and copy any regional Lambda Layer ARN" @@ -135,7 +135,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https: constructor(scope: Construct, id: string) { super(scope, id); - // Create a Layer with AWS Lambda Powertools for TypeScript + // Create a Layer with Powertools for AWS Lambda (TypeScript) const powertoolsLayer = lambda.LayerVersion.fromLayerVersionArn( this, 'PowertoolsLayer', @@ -247,7 +247,7 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https: ? Do you want to edit the local lambda function now? No ``` -!!! info "Using Powertools via Lambda Layer? Simply add the Powertools utilities you are using as a development dependency" +!!! info "Using Powertools for AWS Lambda (TypeScript) via Lambda Layer? Simply add the Powertools for AWS Lambda (TypeScript) utilities you are using as a development dependency" ??? question "Want to inspect the contents of the Layer?" Change {region} to your AWS region, e.g. `eu-west-1` @@ -260,9 +260,9 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https: ## Instrumentation -You can instrument your code with Powertools in three different ways: +You can instrument your code with Powertools for AWS Lambda (TypeScript) in three different ways: -* **Middy** middleware. It is the best choice if your existing code base relies on the [Middy](https://middy.js.org/docs/) middleware engine. Powertools offers compatible Middy middleware to make this integration seamless. +* **Middy** middleware. It is the best choice if your existing code base relies on the [Middy](https://middy.js.org/docs/) middleware engine. Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless. * **Method decorator**. Use [TypeScript method decorators](https://www.typescriptlang.org/docs/handbook/decorators.html#method-decorators) if you prefer writing your business logic using [TypeScript Classes](https://www.typescriptlang.org/docs/handbook/classes.html). If you arenโ€™t using Classes, this requires the most significant refactoring. * **Manually**. It provides the most granular control. Itโ€™s the most verbose approach, with the added benefit of no additional dependency and no refactoring to TypeScript Classes. @@ -275,11 +275,11 @@ The project's repository includes examples of how to instrument your functions b * [AWS CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk){target="_blank"} * [AWS SAM](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/sam){target="_blank"} -If instead you want to see Powertools for TypeScript in a slightly more complex use case, check the [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). +If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly more complex use case, check the [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Features -Core utilities such as Tracing, Logging, and Metrics will be available across all Lambda Powertools languages. Additional utilities are subjective to each language ecosystem and customer demand. +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 | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | @@ -310,11 +310,11 @@ Core utilities such as Tracing, Logging, and Metrics will be available across al Each Utility page provides information on example values and allowed values. -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -328,11 +328,11 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](./we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](./we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layer), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda (TypeScript) languages. When [using Layers](#lambda-layer), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Tenets diff --git a/docs/roadmap.md b/docs/roadmap.md index f449979f2e..44c7a235ab 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -83,7 +83,7 @@ Our end-to-end mechanism follows four major steps: ## Disclaimer -The AWS Lambda Powertools team values feedback and guidance from its community of users, although final decisions on inclusion into the project will be made by AWS. +The Powertools for AWS Lambda team values feedback and guidance from its community of users, although final decisions on inclusion into the project will be made by AWS. We determine the high-level direction for our open roadmap based on customer feedback and popularity (๐Ÿ‘๐Ÿฝ and comments), security and operational impacts, and business value. Where features donโ€™t meet our goals and longer-term strategy, we will communicate that clearly and openly as quickly as possible with an explanation of why the decision was made. diff --git a/docs/snippets/package.json b/docs/snippets/package.json index 15b880f94e..1ec4ee035a 100644 --- a/docs/snippets/package.json +++ b/docs/snippets/package.json @@ -1,7 +1,7 @@ { "name": "docs", "version": "0.0.1", - "description": "A collection code snippets for the AWS Lambda Powertools for TypeScript docs", + "description": "A collection code snippets for the Powertools for AWS Lambda (TypeScript) docs", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/docs/we_made_this.md b/docs/we_made_this.md index 0fabec73cd..12394ed0d2 100644 --- a/docs/we_made_this.md +++ b/docs/we_made_this.md @@ -1,6 +1,6 @@ --- title: We Made This (Community) -description: Blog posts, tutorials, and videos about AWS Lambda Powertools created by the Powertools Community. +description: Blog posts, tutorials, and videos about Powertools for AWS Lambda (TypeScript) created by the Powertools Community. --- This space is dedicated to highlight our awesome community content featuring Powertools ๐Ÿ™! @@ -15,15 +15,15 @@ Join us on [Discord](https://discord.gg/B8zZKbbyET){target="_blank"} to connect ## Blog posts -### Lambda Powertools - great defaults for batteries that aren't quite (but should be) included +### Powertools for AWS Lambda (TypeScript) - great defaults for batteries that aren't quite (but should be) included > **Author: [Mike Roberts](mailto:mike@symphonia.io) [:material-twitter:](https://twitter.com/mikebroberts){target="_blank"}** -This article discusses why you should consider using Powertools in your Lambda functions. +This article discusses why you should consider using Powertools for AWS Lambda (TypeScript) in your Lambda functions. * [https://blog.symphonia.io/posts/2022-10-24_lambda-powertools](https://blog.symphonia.io/posts/2022-10-24_lambda-powertools){target="_blank"} -### Test Drive AWS Lambda Powertools for Typescript +### Test Drive Powertools for AWS Lambda (TypeScript) > **Author: [Matt Lewis](https://twitter.com/m_lewis){target="_blank"} :material-twitter:** @@ -31,7 +31,7 @@ This article gives an overview Powertools' core utilities: Logger, Metrics, and * [https://dev.to/aws-heroes/test-drive-aws-lambda-powertools-for-typescript-h3p](https://dev.to/aws-heroes/test-drive-aws-lambda-powertools-for-typescript-h3p){target="_blank"} -### Power-up Lambda functions with AWS Lambda Powertools for TypeScript +### Power-up Lambda functions with Powertools for AWS Lambda (TypeScript) > **Author: [Ryan Toler](https://www.linkedin.com/in/ryantoler/){target="_blank"} :material-linkedin:** @@ -43,16 +43,16 @@ Discover how easy it is to quickly โ€œpower-upโ€ your Node.js Lambda functions > **Author: [Eoin Shanaghy](https://twitter.com/eoins){target="_blank"} :material-twitter:** -This post shows how to use AWS Lambda Powertools to quickly build Well-Architected serverless applications. +This post shows how to use Powertools for AWS Lambda (TypeScript) to quickly build Well-Architected serverless applications. * [https://fourtheorem.com/aws-lambda-powertools/](https://fourtheorem.com/aws-lambda-powertools/){target="_blank"} -### AWS Lambda Powertools TypeScript +### Powertools for AWS Lambda (TypeScript) > **Author: [Matt Morgan](https://twitter.com/NullishCoalesce){target="_blank"} :material-twitter:** -A two parts series that gives an overview of Powertools and its features starting from the beta phase to the General Availability release. +A two parts series that gives an overview of Powertools for AWS Lambda (TypeScript) and its features starting from the beta phase to the General Availability release. -* [First Look at Lambda Powertools TypeScript](https://dev.to/aws-builders/first-look-at-lambda-powertools-typescript-2k3p){target="_blank"} +* [First Look at Powertools for AWS Lambda (TypeScript)](https://dev.to/aws-builders/first-look-at-lambda-powertools-typescript-2k3p){target="_blank"} -* [Lambda Powertools TypeScript is Generally Available](https://dev.to/aws-builders/lambda-powertools-typescript-is-generally-available-1dm8){target="_blank"} +* [Powertools for AWS Lambda (TypeScript) is Generally Available](https://dev.to/aws-builders/lambda-powertools-typescript-is-generally-available-1dm8){target="_blank"} diff --git a/examples/cdk/README.md b/examples/cdk/README.md index f4a2fd6621..29861533b4 100644 --- a/examples/cdk/README.md +++ b/examples/cdk/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools for TypeScript examples in CDK +# Powertools for AWS Lambda (TypeScript) examples in CDK -This is a deployable CDK app that deploys AWS Lambda functions as part of a CloudFormation stack. These Lambda functions use the utilities made available as part of AWS Lambda Powertools for TypeScript to demonstrate their usage. +This is a deployable CDK app that deploys AWS Lambda functions as part of a CloudFormation stack. These Lambda functions use the utilities made available as part of Powertools for AWS Lambda (TypeScript) to demonstrate their usage. > **Note** > You will need to have a valid AWS Account in order to deploy these resources. These resources may incur costs to your AWS Account. The cost from **some services** are covered by the [AWS Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all) but not all of them. If you don't have an AWS Account follow [these instructions to create one](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/). diff --git a/examples/cdk/functions/get-all-items.ts b/examples/cdk/functions/get-all-items.ts index 28c7bdbebd..2ac1c4d79a 100644 --- a/examples/cdk/functions/get-all-items.ts +++ b/examples/cdk/functions/get-all-items.ts @@ -17,7 +17,7 @@ import { default as request } from 'phin'; * * This example uses the Middy middleware instrumentation. * It is the best choice if your existing code base relies on the Middy middleware engine. - * Powertools offers compatible Middy middleware to make this integration seamless. + * Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless. * Find more Information in the docs: https://awslabs.github.io/aws-lambda-powertools-typescript/ * * Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format diff --git a/examples/sam/README.md b/examples/sam/README.md index bf8c45af66..8ca4cc3c6c 100644 --- a/examples/sam/README.md +++ b/examples/sam/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools for TypeScript examples in SAM +# Powertools for AWS Lambda (TypeScript) examples in SAM This project contains source code and supporting files for a serverless application that you can deploy with the [SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html). The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API. @@ -143,9 +143,9 @@ You can find more information and examples about filtering Lambda function logs ## Switch to Lambda Layer -In this example we are including AWS Lambda Powertools as a dependency in our function's `package.json`. This is the recommended approach for development and testing. However, for production, you can also use the AWS Lambda Powertools as a Lambda Layer. +In this example we are including Powertools for AWS Lambda (TypeScript) as a dependency in our function's `package.json`. This is the recommended approach for development and testing. However, for production, you can also use the Powertools for AWS Lambda (TypeScript) as a Lambda Layer. -To start using the AWS Lambda Powertools as a Lambda Layer, you need to: +To start using the Powertools for AWS Lambda (TypeScript) as a Lambda Layer, you need to: 1. Specify the Layer's ARN in `Layers` section under each function's `Properties` section 2. Instruct `esbuild` to not bundle `@aws-lambda-powertools` under each function's `Metadata/BuildProperties` section @@ -184,7 +184,7 @@ Metadata: EntryPoints: ``` -Learn more about Lambda Layers [here](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) and about the Lambda Powertools for TypeScript layers [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#lambda-layer). +Learn more about Lambda Layers [here](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) and about the Powertools for AWS Lambda (TypeScript) layers [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#lambda-layer). ## Cleanup diff --git a/examples/sam/src/get-all-items.ts b/examples/sam/src/get-all-items.ts index 28c7bdbebd..2ac1c4d79a 100644 --- a/examples/sam/src/get-all-items.ts +++ b/examples/sam/src/get-all-items.ts @@ -17,7 +17,7 @@ import { default as request } from 'phin'; * * This example uses the Middy middleware instrumentation. * It is the best choice if your existing code base relies on the Middy middleware engine. - * Powertools offers compatible Middy middleware to make this integration seamless. + * Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless. * Find more Information in the docs: https://awslabs.github.io/aws-lambda-powertools-typescript/ * * Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format diff --git a/examples/sam/template.yaml b/examples/sam/template.yaml index b183170b85..0168722fd4 100644 --- a/examples/sam/template.yaml +++ b/examples/sam/template.yaml @@ -5,7 +5,7 @@ # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html AWSTemplateFormatVersion: 2010-09-09 Description: >- - An example application with PowerTools for TypeScript instrumented. Its purpose is to demonstrate how to use the PowerTools with AWS SAM. The application an API with contains 3 endpoints (get all items, get an item by ids, put an item). Each Lambda function utilises Logger, Metrics, and Tracers. + An example application with Powertools for AWS Lambda (TypeScript) instrumented. Its purpose is to demonstrate how to use the Powertools for AWS Lambda (TypeScript) with AWS SAM. The application an API with contains 3 endpoints (get all items, get an item by ids, put an item). Each Lambda function utilises Logger, Metrics, and Tracers. # Transform section specifies one or more macros that AWS CloudFormation uses to process your template # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html diff --git a/layers/README.md b/layers/README.md index 1a3f5602b9..19912bfa9d 100644 --- a/layers/README.md +++ b/layers/README.md @@ -1,6 +1,6 @@ -# Lambda Powertools for TypeScript Layer Publisher +# Powertools for AWS Lambda (TypeScript) Layer Publisher -This CDK app is meant to be used to publish Powertools for TypeScript Lambda Layer. It is composed of a single stack deploying the Layer into the target account. +This CDK app is meant to be used to publish Powertools for AWS Lambda (TypeScript) Lambda Layer. It is composed of a single stack deploying the Layer into the target account. # Usage @@ -32,7 +32,7 @@ npm run test:e2e PS: You can force * the lambda runtime to test with the RUNTIME env variable -* the Powertools version with VERSION env variable +* the Powertools for AWS Lambda (TypeScript) version with VERSION env variable ```sh RUNTIME=node12.x VERSION=0.9.0 npm run test:e2e ``` diff --git a/layers/jest.config.js b/layers/jest.config.js index 6476c09626..6199d00704 100644 --- a/layers/jest.config.js +++ b/layers/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: LAYERS', + name: 'Powertools for AWS Lambda (TypeScript) utility: LAYERS', color: 'black', }, runner: 'groups', diff --git a/layers/package.json b/layers/package.json index a7158461c4..0b3f6398ed 100644 --- a/layers/package.json +++ b/layers/package.json @@ -5,7 +5,7 @@ "layer": "bin/layers.js" }, "private": true, - "description": "This CDK app is meant to be used to publish Powertools for TypeScript Lambda Layer. It is composed of a single stack deploying the Layer into the target account.", + "description": "This CDK app is meant to be used to publish Powertools for AWS Lambda (TypeScript) Lambda Layer. It is composed of a single stack deploying the Layer into the target account.", "scripts": { "build": "tsc", "watch": "tsc -w", diff --git a/layers/src/layer-publisher-stack.ts b/layers/src/layer-publisher-stack.ts index e55eac4dca..d8c738010f 100644 --- a/layers/src/layer-publisher-stack.ts +++ b/layers/src/layer-publisher-stack.ts @@ -31,7 +31,7 @@ export class LayerPublisherStack extends Stack { this.lambdaLayerVersion = new LayerVersion(this, 'LambdaPowertoolsLayer', { layerVersionName: props?.layerName, - description: `AWS Lambda Powertools for TypeScript version ${powertoolsPackageVersion}`, + description: `Powertools for AWS Lambda (TypeScript) version ${powertoolsPackageVersion}`, compatibleRuntimes: [ Runtime.NODEJS_14_X, Runtime.NODEJS_16_X, diff --git a/layers/tests/unit/layer-publisher.test.ts b/layers/tests/unit/layer-publisher.test.ts index 6dba9993c6..151dc87b99 100644 --- a/layers/tests/unit/layer-publisher.test.ts +++ b/layers/tests/unit/layer-publisher.test.ts @@ -29,7 +29,7 @@ describe('Class: LayerPublisherStack', () => { /* CompatibleArchitectures: [ 'x86_64', ], */ - Description: 'AWS Lambda Powertools for TypeScript version 1.0.1', + Description: 'Powertools for AWS Lambda (TypeScript) version 1.0.1', LayerName: 'AWSLambdaPowertoolsTypeScript', }); diff --git a/mkdocs.yml b/mkdocs.yml index dd5cb6b5ca..9f19f264a7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ -site_name: AWS Lambda Powertools for TypeScript -site_description: AWS Lambda Powertools for TypeScript +site_name: Powertools for AWS Lambda (TypeScript) +site_description: Powertools for AWS Lambda (TypeScript) site_author: Amazon Web Services repo_url: https://github.com/awslabs/aws-lambda-powertools-typescript edit_uri: edit/main/docs diff --git a/packages/commons/README.md b/packages/commons/README.md index ce745f2dc8..0067f74f79 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -19,7 +19,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -39,7 +39,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone npm package. @@ -66,7 +66,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -75,19 +75,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -101,15 +101,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Lambda Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/commons/jest.config.js b/packages/commons/jest.config.js index 4e0793d3dc..512b4ab601 100644 --- a/packages/commons/jest.config.js +++ b/packages/commons/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: COMMONS', + name: 'Powertools for AWS Lambda (TypeScript) utility: COMMONS', color: 'red', }, preset: 'ts-jest', diff --git a/packages/commons/package.json b/packages/commons/package.json index 17b3b436e6..ac506b998d 100644 --- a/packages/commons/package.json +++ b/packages/commons/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/commons", "version": "1.8.0", - "description": "A shared utility package for AWS Lambda Powertools for TypeScript libraries", + "description": "A shared utility package for Powertools for AWS Lambda (TypeScript) libraries", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/commons/src/Utility.ts b/packages/commons/src/Utility.ts index 2bb5eff446..7006499830 100644 --- a/packages/commons/src/Utility.ts +++ b/packages/commons/src/Utility.ts @@ -1,6 +1,6 @@ /** * ## Intro - * Utility is a base class that other Powertools utilites can extend to inherit shared logic. + * Utility is a base class that other Powertools for AWS Lambda (TypeScript) utilites can extend to inherit shared logic. * * * ## Key features @@ -14,7 +14,7 @@ * * To learn more about the Lambda execution environment lifecycle, see the [Execution environment section](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) of the AWS Lambda documentation. * - * As a Powertools user you probably won't be using this class directly, in fact if you use other Powertools utilities the cold start heuristic found here is already used to: + * As a Powertools for AWS Lambda (TypeScript) user you probably won't be using this class directly, in fact if you use other Powertools for AWS Lambda (TypeScript) utilities the cold start heuristic found here is already used to: * * Add a `coldStart` key to the structured logs when injecting context information in `Logger` * * Emit a metric during a cold start function invocation in `Metrics` * * Annotate the invocation segment with a `coldStart` key in `Tracer` diff --git a/packages/commons/src/types/middy.ts b/packages/commons/src/types/middy.ts index fe060ece0a..ea8307ab85 100644 --- a/packages/commons/src/types/middy.ts +++ b/packages/commons/src/types/middy.ts @@ -3,7 +3,7 @@ import { Context } from 'aws-lambda'; /** * We need to define these types and interfaces here because we can't import them from @middy/core. * Importing them from @middy/core would introduce a dependency on @middy/core, which we don't want - * because we want to keep it as an optional dependency. Those users who don't use the Powertools middleware + * because we want to keep it as an optional dependency. Those users who don't use the Powertools for AWS Lambda (TypeScript) middleware * and use `tsc` to compile their code will get an error if we import from @middy/core, see #1068. * Given that we use a subset of the @middy/core types, we can define them here and avoid the dependency. */ diff --git a/packages/idempotency/README.md b/packages/idempotency/README.md index 9b4d427858..c70172fb92 100644 --- a/packages/idempotency/README.md +++ b/packages/idempotency/README.md @@ -1,10 +1,10 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. -AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available. +[Powertools for AWS Lambda (Python)](https://github.com/awslabs/aws-lambda-powertools-python) and [Powertools for AWS Lambda (Java)](https://github.com/awslabs/aws-lambda-powertools-java) are also available. **[๐Ÿ“œ Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples)** | **[Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo)** @@ -18,7 +18,7 @@ AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powerto - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -38,7 +38,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. Install all three core utilities at once with this single command: @@ -64,7 +64,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -73,19 +73,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -99,15 +99,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Lambda Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/idempotency/jest.config.js b/packages/idempotency/jest.config.js index 8896fe6dda..f0890d6314 100644 --- a/packages/idempotency/jest.config.js +++ b/packages/idempotency/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: IDEMPOTENCY', + name: 'Powertools for AWS Lambda (TypeScript) utility: IDEMPOTENCY', color: 'yellow', }, runner: 'groups', diff --git a/packages/idempotency/package.json b/packages/idempotency/package.json index a6246bd3fc..8613cdf583 100644 --- a/packages/idempotency/package.json +++ b/packages/idempotency/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/idempotency", "version": "0.0.11", - "description": "The idempotency package for the AWS Lambda Powertools for TypeScript library. It provides options to make your Lambda functions idempotent and safe to retry.", + "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", "url": "https://aws.amazon.com" diff --git a/packages/logger/README.md b/packages/logger/README.md index aa5fb65516..d5ae446272 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -18,7 +18,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -38,7 +38,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone npm package. @@ -65,7 +65,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -74,19 +74,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -100,15 +100,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/logger/jest.config.js b/packages/logger/jest.config.js index cde674c939..31c2a6a370 100644 --- a/packages/logger/jest.config.js +++ b/packages/logger/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: LOGGER', + name: 'Powertools for AWS Lambda (TypeScript) utility: LOGGER', color: 'cyan', }, runner: 'groups', diff --git a/packages/logger/package.json b/packages/logger/package.json index bb01a2631f..823130adc8 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/logger", "version": "1.8.0", - "description": "The logging package for the AWS Lambda Powertools for TypeScript library", + "description": "The logging package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/logger/tests/helpers/populateEnvironmentVariables.ts b/packages/logger/tests/helpers/populateEnvironmentVariables.ts index a08fd0e35f..b993a774ba 100644 --- a/packages/logger/tests/helpers/populateEnvironmentVariables.ts +++ b/packages/logger/tests/helpers/populateEnvironmentVariables.ts @@ -10,6 +10,6 @@ if ( process.env.AWS_REGION = 'eu-west-1'; } -// Powertools variables +// Powertools for AWS Lambda (TypeScript) variables process.env.LOG_LEVEL = 'DEBUG'; process.env.POWERTOOLS_SERVICE_NAME = 'hello-world'; diff --git a/packages/metrics/README.md b/packages/metrics/README.md index cf1a92db42..07b1593232 100644 --- a/packages/metrics/README.md +++ b/packages/metrics/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -18,7 +18,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -38,7 +38,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. Install all three core utilities at once with this single command: @@ -64,7 +64,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -73,19 +73,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -99,15 +99,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/metrics/jest.config.js b/packages/metrics/jest.config.js index a187c129ed..3c1879fc3b 100644 --- a/packages/metrics/jest.config.js +++ b/packages/metrics/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: METRICS', + name: 'Powertools for AWS Lambda (TypeScript) utility: METRICS', color: 'green', }, runner: 'groups', diff --git a/packages/metrics/package.json b/packages/metrics/package.json index 5801621181..b3b4c9d732 100644 --- a/packages/metrics/package.json +++ b/packages/metrics/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/metrics", "version": "1.8.0", - "description": "The metrics package for the AWS Lambda Powertools for TypeScript library", + "description": "The metrics package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/metrics/tests/helpers/populateEnvironmentVariables.ts b/packages/metrics/tests/helpers/populateEnvironmentVariables.ts index ce4d3e4bc4..f3508c0f8c 100644 --- a/packages/metrics/tests/helpers/populateEnvironmentVariables.ts +++ b/packages/metrics/tests/helpers/populateEnvironmentVariables.ts @@ -10,5 +10,5 @@ if ( process.env.AWS_REGION = 'eu-west-1'; } -// Powertools variables +// Powertools for AWS Lambda (TypeScript) variables process.env.POWERTOOLS_METRICS_NAMESPACE = 'hello-world'; diff --git a/packages/parameters/README.md b/packages/parameters/README.md index 8d4c38e1f9..8aa84b3531 100644 --- a/packages/parameters/README.md +++ b/packages/parameters/README.md @@ -1,10 +1,10 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> | โš ๏ธ **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/awslabs/aws-lambda-powertools-typescript/milestone/10) we might introduce significant breaking changes and improvements in response to customers feedback. | _ | -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -22,7 +22,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -42,7 +42,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. Install all three core utilities at once with this single command: @@ -68,7 +68,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -77,19 +77,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -103,15 +103,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/parameters/jest.config.js b/packages/parameters/jest.config.js index d157d50b4d..64f709a02d 100644 --- a/packages/parameters/jest.config.js +++ b/packages/parameters/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: PARAMETERS', + name: 'Powertools for AWS Lambda (TypeScript) utility: PARAMETERS', color: 'magenta', }, runner: 'groups', diff --git a/packages/parameters/package.json b/packages/parameters/package.json index 521168d991..03c52bac84 100644 --- a/packages/parameters/package.json +++ b/packages/parameters/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/parameters", "version": "1.8.0", - "description": "The parameters package for the AWS Lambda Powertools for TypeScript library", + "description": "The parameters package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/parameters/tests/e2e/secretsProvider.class.test.ts b/packages/parameters/tests/e2e/secretsProvider.class.test.ts index ea1fdd7494..3d42577cba 100644 --- a/packages/parameters/tests/e2e/secretsProvider.class.test.ts +++ b/packages/parameters/tests/e2e/secretsProvider.class.test.ts @@ -118,7 +118,7 @@ describe(`parameters E2E tests (SecretsProvider) for runtime: ${runtime}`, () => 'testSecretPlainForceFetch' ); - // creates the test fuction that uses powertools secret provider we want to test + // creates the test fuction that uses Powertools for AWS Lambda (TypeScript) secret provider we want to test // pass env vars with secret names we want to fetch stack = createStackWithLambdaFunction({ app: integTestApp, diff --git a/packages/tracer/README.md b/packages/tracer/README.md index cf1a92db42..07b1593232 100644 --- a/packages/tracer/README.md +++ b/packages/tracer/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools for TypeScript <!-- omit in toc --> +# Powertools for AWS Lambda (TypeScript) <!-- omit in toc --> -Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). +Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features). You can use the library in both TypeScript and JavaScript code bases. @@ -18,7 +18,7 @@ You can use the library in both TypeScript and JavaScript code bases. - [Contribute](#contribute) - [Roadmap](#roadmap) - [Connect](#connect) -- [How to support AWS Lambda Powertools for TypeScript?](#how-to-support-aws-lambda-powertools-for-typescript) +- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-aws-lambda-powertools-for-typescript) - [Becoming a reference customer](#becoming-a-reference-customer) - [Sharing your work](#sharing-your-work) - [Using Lambda Layer](#using-lambda-layer) @@ -38,7 +38,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. Install all three core utilities at once with this single command: @@ -64,7 +64,7 @@ Or refer to the installation guide of each utility: ### Serverless TypeScript Demo application -The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Lambda Powertools for TypeScript. +The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo). ## Contribute @@ -73,19 +73,19 @@ If you are interested in contributing to this project, please refer to our [Cont ## Roadmap -The roadmap of Powertools is driven by customersโ€™ demand. +The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customersโ€™ demand. Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/awslabs/aws-lambda-powertools-typescript/issues), or [creating new ones](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new/choose), in this GitHub repository. ## Connect -* **AWS Lambda Powertools on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** +* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)** * **Email**: aws-lambda-powertools-feedback@amazon.com -## How to support AWS Lambda Powertools for TypeScript? +## How to support Powertools for AWS Lambda (TypeScript)? ### Becoming a reference customer -Knowing which companies are using this library is important to help prioritize the project internally. If your company is using AWS Lambda Powertools for TypeScript, you can request to have your name and logo added to the README file by raising a [Support Lambda Powertools (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. +Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E){target="_blank"} issue. The following companies, among others, use Powertools: @@ -99,15 +99,15 @@ The following companies, among others, use Powertools: ### Sharing your work -Share what you did with Powertools ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). +Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/we_made_this). ### Using Lambda Layer -This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages. When [using Layers](#lambda-layers), you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits -Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). +Credits for the Powertools for AWS Lambda (TypeScript) idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). ## License diff --git a/packages/tracer/jest.config.js b/packages/tracer/jest.config.js index 87da06ecbb..f6b014a746 100644 --- a/packages/tracer/jest.config.js +++ b/packages/tracer/jest.config.js @@ -1,6 +1,6 @@ module.exports = { displayName: { - name: 'AWS Lambda Powertools utility: TRACER', + name: 'Powertools for AWS Lambda (TypeScript) utility: TRACER', color: 'white', }, runner: 'groups', diff --git a/packages/tracer/package.json b/packages/tracer/package.json index 9da5c77f2b..582e3f485f 100644 --- a/packages/tracer/package.json +++ b/packages/tracer/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/tracer", "version": "1.8.0", - "description": "The tracer package for the AWS Lambda Powertools for TypeScript library", + "description": "The tracer package for the Powertools for AWS Lambda (TypeScript) library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts index d9210ccced..0dcf5bf4f4 100644 --- a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts @@ -248,7 +248,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) @@ -356,7 +356,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) @@ -420,7 +420,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) diff --git a/packages/tracer/tests/e2e/allFeatures.manual.test.ts b/packages/tracer/tests/e2e/allFeatures.manual.test.ts index 7794788176..b3eb137cbd 100644 --- a/packages/tracer/tests/e2e/allFeatures.manual.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.manual.test.ts @@ -152,7 +152,7 @@ describe(`Tracer E2E tests, all features with manual instantiation for runtime: const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) diff --git a/packages/tracer/tests/e2e/allFeatures.middy.test.ts b/packages/tracer/tests/e2e/allFeatures.middy.test.ts index 609b48df73..204f1e851a 100644 --- a/packages/tracer/tests/e2e/allFeatures.middy.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.middy.test.ts @@ -252,7 +252,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) @@ -357,7 +357,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) @@ -421,7 +421,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handlerWithNoCaptureResponseViaMiddlewareOption' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handlerWithNoCaptureResponseViaMiddlewareOption' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handlerWithNoCaptureResponseViaMiddlewareOption' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) diff --git a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts index 3126414c3d..193f17ea17 100644 --- a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts +++ b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts @@ -185,7 +185,7 @@ describe(`Tracer E2E tests, asynchronous handler with decorator instantiation fo const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) @@ -293,7 +293,7 @@ describe(`Tracer E2E tests, asynchronous handler with decorator instantiation fo const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) diff --git a/packages/tracer/tests/helpers/populateEnvironmentVariables.ts b/packages/tracer/tests/helpers/populateEnvironmentVariables.ts index 2fe6ddd9e7..4d4166743d 100644 --- a/packages/tracer/tests/helpers/populateEnvironmentVariables.ts +++ b/packages/tracer/tests/helpers/populateEnvironmentVariables.ts @@ -11,6 +11,6 @@ if ( } process.env._HANDLER = 'index.handler'; -// Powertools variables +// Powertools for AWS Lambda (TypeScript) variables process.env.POWERTOOLS_SERVICE_NAME = 'hello-world'; process.env.AWS_XRAY_LOGGING_LEVEL = 'silent'; From 4901305b46db9c97156717321a8b3ee976fa1ed5 Mon Sep 17 00:00:00 2001 From: Simon Thulbourn <sthulb@users.noreply.github.com> Date: Tue, 23 May 2023 09:38:58 +0000 Subject: [PATCH 02/15] fix: last couple of changes --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 518d0a2298..bb08f4c9d2 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog po ### Using Lambda Layer -This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda (TypeScript) languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layers), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Credits diff --git a/docs/index.md b/docs/index.md index 34be5292e7..87a1a69096 100644 --- a/docs/index.md +++ b/docs/index.md @@ -332,7 +332,7 @@ Share what you did with Powertools for AWS Lambda (TypeScript) ๐Ÿ’ž๐Ÿ’ž. Blog po ### Using Lambda Layer -This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda (TypeScript) languages. When [using Layers](#lambda-layer), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. +This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](#lambda-layer), you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process. ## Tenets From 8b53ea98d38964f7c1917548e74a9002cb13e828 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:05 +0200 Subject: [PATCH 03/15] Update packages/tracer/tests/e2e/asyncHandler.decorator.test.ts --- packages/tracer/tests/e2e/asyncHandler.decorator.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts index 193f17ea17..a5828a6e86 100644 --- a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts +++ b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts @@ -293,7 +293,7 @@ describe(`Tracer E2E tests, asynchronous handler with decorator instantiation fo const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 3907ce6f8a695345d149896714fecaa288ca995d Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:12 +0200 Subject: [PATCH 04/15] Update packages/tracer/tests/e2e/asyncHandler.decorator.test.ts --- packages/tracer/tests/e2e/asyncHandler.decorator.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts index a5828a6e86..2506e8a514 100644 --- a/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts +++ b/packages/tracer/tests/e2e/asyncHandler.decorator.test.ts @@ -185,7 +185,7 @@ describe(`Tracer E2E tests, asynchronous handler with decorator instantiation fo const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 3bb21f40e7be35f4d4c5cfe481029a1959a25af9 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:20 +0200 Subject: [PATCH 05/15] Update packages/tracer/tests/e2e/allFeatures.middy.test.ts --- packages/tracer/tests/e2e/allFeatures.middy.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.middy.test.ts b/packages/tracer/tests/e2e/allFeatures.middy.test.ts index 204f1e851a..541635067c 100644 --- a/packages/tracer/tests/e2e/allFeatures.middy.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.middy.test.ts @@ -252,7 +252,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 048cd0223ea826e48d8ad142f0c75e1650a783b1 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:26 +0200 Subject: [PATCH 06/15] Update packages/tracer/tests/e2e/allFeatures.middy.test.ts --- packages/tracer/tests/e2e/allFeatures.middy.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.middy.test.ts b/packages/tracer/tests/e2e/allFeatures.middy.test.ts index 541635067c..3b4e42c30b 100644 --- a/packages/tracer/tests/e2e/allFeatures.middy.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.middy.test.ts @@ -357,7 +357,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 5768cedaa83624af90031dc285d7be6e50b93035 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:37 +0200 Subject: [PATCH 07/15] Update examples/sam/README.md --- examples/sam/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sam/README.md b/examples/sam/README.md index 8ca4cc3c6c..c2bbed97fb 100644 --- a/examples/sam/README.md +++ b/examples/sam/README.md @@ -145,7 +145,7 @@ You can find more information and examples about filtering Lambda function logs In this example we are including Powertools for AWS Lambda (TypeScript) as a dependency in our function's `package.json`. This is the recommended approach for development and testing. However, for production, you can also use the Powertools for AWS Lambda (TypeScript) as a Lambda Layer. -To start using the Powertools for AWS Lambda (TypeScript) as a Lambda Layer, you need to: +To start using the public Lambda Layer, you need to: 1. Specify the Layer's ARN in `Layers` section under each function's `Properties` section 2. Instruct `esbuild` to not bundle `@aws-lambda-powertools` under each function's `Metadata/BuildProperties` section From edbb3c8122422b776aba68cadc0b6c5fa82c59de Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:44 +0200 Subject: [PATCH 08/15] Update examples/sam/README.md --- examples/sam/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/sam/README.md b/examples/sam/README.md index c2bbed97fb..d17b806381 100644 --- a/examples/sam/README.md +++ b/examples/sam/README.md @@ -143,7 +143,7 @@ You can find more information and examples about filtering Lambda function logs ## Switch to Lambda Layer -In this example we are including Powertools for AWS Lambda (TypeScript) as a dependency in our function's `package.json`. This is the recommended approach for development and testing. However, for production, you can also use the Powertools for AWS Lambda (TypeScript) as a Lambda Layer. +In this example we are including Powertools for AWS Lambda (TypeScript) as a dependency in our function's `package.json`. This is the recommended approach for development and testing. However, for production, you can also use Powertools for AWS as a Lambda Layer. To start using the public Lambda Layer, you need to: 1. Specify the Layer's ARN in `Layers` section under each function's `Properties` section From afd36318f5550315a5d646d20526c0b4a1a46efb Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:52 +0200 Subject: [PATCH 09/15] Update packages/tracer/tests/e2e/allFeatures.manual.test.ts --- packages/tracer/tests/e2e/allFeatures.manual.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.manual.test.ts b/packages/tracer/tests/e2e/allFeatures.manual.test.ts index b3eb137cbd..15f331c127 100644 --- a/packages/tracer/tests/e2e/allFeatures.manual.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.manual.test.ts @@ -152,7 +152,7 @@ describe(`Tracer E2E tests, all features with manual instantiation for runtime: const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 111195b5cbc54d2d01da72b6e6322027336591ac Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:18:58 +0200 Subject: [PATCH 10/15] Update packages/tracer/tests/e2e/allFeatures.middy.test.ts --- packages/tracer/tests/e2e/allFeatures.middy.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.middy.test.ts b/packages/tracer/tests/e2e/allFeatures.middy.test.ts index 3b4e42c30b..6cf3e24f44 100644 --- a/packages/tracer/tests/e2e/allFeatures.middy.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.middy.test.ts @@ -421,7 +421,7 @@ describe(`Tracer E2E tests, all features with middy instantiation for runtime: $ const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handlerWithNoCaptureResponseViaMiddlewareOption' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handlerWithNoCaptureResponseViaMiddlewareOption' (default behavior for Tracer) * '## index.handlerWithNoCaptureResponseViaMiddlewareOption' subsegment should have 2 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From d97a7b9c4b2367a4ab20a35ba073dc09f5468d49 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:19:05 +0200 Subject: [PATCH 11/15] Update packages/tracer/tests/e2e/allFeatures.decorator.test.ts --- packages/tracer/tests/e2e/allFeatures.decorator.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts index 0dcf5bf4f4..e0192af898 100644 --- a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts @@ -248,7 +248,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From eecfe496961da7c83ffbe3269959cd80deff1836 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:19:11 +0200 Subject: [PATCH 12/15] Update packages/tracer/tests/e2e/allFeatures.decorator.test.ts --- packages/tracer/tests/e2e/allFeatures.decorator.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts index e0192af898..f46c0c343c 100644 --- a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts @@ -356,7 +356,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 7ca80b5d6bc443586ebfd222001b122db46638f2 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:19:17 +0200 Subject: [PATCH 13/15] Update packages/tracer/tests/e2e/allFeatures.decorator.test.ts --- packages/tracer/tests/e2e/allFeatures.decorator.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts index f46c0c343c..fb8ed7a972 100644 --- a/packages/tracer/tests/e2e/allFeatures.decorator.test.ts +++ b/packages/tracer/tests/e2e/allFeatures.decorator.test.ts @@ -420,7 +420,7 @@ describe(`Tracer E2E tests, all features with decorator instantiation for runtim const invocationSubsegment = getInvocationSubsegment(trace); /** - * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Powertools for AWS Lambda (TypeScript) Tracer) + * Invocation subsegment should have a subsegment '## index.handler' (default behavior for Tracer) * '## index.handler' subsegment should have 3 subsegments * 1. DynamoDB (PutItem on the table) * 2. awslabs.github.io (Remote call) From 2d0ab916667a42fe25326cff8e6eebec9b070b34 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi <dreamorosi@gmail.com> Date: Tue, 23 May 2023 13:19:24 +0200 Subject: [PATCH 14/15] Update packages/commons/src/Utility.ts --- packages/commons/src/Utility.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/commons/src/Utility.ts b/packages/commons/src/Utility.ts index 7006499830..23aacedad1 100644 --- a/packages/commons/src/Utility.ts +++ b/packages/commons/src/Utility.ts @@ -14,7 +14,7 @@ * * To learn more about the Lambda execution environment lifecycle, see the [Execution environment section](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) of the AWS Lambda documentation. * - * As a Powertools for AWS Lambda (TypeScript) user you probably won't be using this class directly, in fact if you use other Powertools for AWS Lambda (TypeScript) utilities the cold start heuristic found here is already used to: + * As a Powertools for AWS Lambda (TypeScript) user you probably won't be using this class directly, in fact if you use other Powertools for AWS utilities the cold start heuristic found here is already used to: * * Add a `coldStart` key to the structured logs when injecting context information in `Logger` * * Emit a metric during a cold start function invocation in `Metrics` * * Annotate the invocation segment with a `coldStart` key in `Tracer` From c98f98f39c367fb1fc461e030d9c70694b92bb2c Mon Sep 17 00:00:00 2001 From: Simon Thulbourn <sthulb@users.noreply.github.com> Date: Tue, 23 May 2023 15:47:50 +0200 Subject: [PATCH 15/15] Update we_made_this.md --- docs/we_made_this.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/we_made_this.md b/docs/we_made_this.md index 12394ed0d2..47dc18db5b 100644 --- a/docs/we_made_this.md +++ b/docs/we_made_this.md @@ -15,15 +15,15 @@ Join us on [Discord](https://discord.gg/B8zZKbbyET){target="_blank"} to connect ## Blog posts -### Powertools for AWS Lambda (TypeScript) - great defaults for batteries that aren't quite (but should be) included +### Lambda Powertools - great defaults for batteries that aren't quite (but should be) included > **Author: [Mike Roberts](mailto:mike@symphonia.io) [:material-twitter:](https://twitter.com/mikebroberts){target="_blank"}** -This article discusses why you should consider using Powertools for AWS Lambda (TypeScript) in your Lambda functions. +This article discusses why you should consider using Powertools in your Lambda functions. * [https://blog.symphonia.io/posts/2022-10-24_lambda-powertools](https://blog.symphonia.io/posts/2022-10-24_lambda-powertools){target="_blank"} -### Test Drive Powertools for AWS Lambda (TypeScript) +### Test Drive AWS Lambda Powertools for Typescript > **Author: [Matt Lewis](https://twitter.com/m_lewis){target="_blank"} :material-twitter:** @@ -31,7 +31,7 @@ This article gives an overview Powertools' core utilities: Logger, Metrics, and * [https://dev.to/aws-heroes/test-drive-aws-lambda-powertools-for-typescript-h3p](https://dev.to/aws-heroes/test-drive-aws-lambda-powertools-for-typescript-h3p){target="_blank"} -### Power-up Lambda functions with Powertools for AWS Lambda (TypeScript) +### Power-up Lambda functions with AWS Lambda Powertools for TypeScript > **Author: [Ryan Toler](https://www.linkedin.com/in/ryantoler/){target="_blank"} :material-linkedin:** @@ -43,16 +43,16 @@ Discover how easy it is to quickly โ€œpower-upโ€ your Node.js Lambda functions > **Author: [Eoin Shanaghy](https://twitter.com/eoins){target="_blank"} :material-twitter:** -This post shows how to use Powertools for AWS Lambda (TypeScript) to quickly build Well-Architected serverless applications. +This post shows how to use AWS Lambda Powertools to quickly build Well-Architected serverless applications. * [https://fourtheorem.com/aws-lambda-powertools/](https://fourtheorem.com/aws-lambda-powertools/){target="_blank"} -### Powertools for AWS Lambda (TypeScript) +### AWS Lambda Powertools TypeScript > **Author: [Matt Morgan](https://twitter.com/NullishCoalesce){target="_blank"} :material-twitter:** -A two parts series that gives an overview of Powertools for AWS Lambda (TypeScript) and its features starting from the beta phase to the General Availability release. +A two parts series that gives an overview of Powertools and its features starting from the beta phase to the General Availability release. -* [First Look at Powertools for AWS Lambda (TypeScript)](https://dev.to/aws-builders/first-look-at-lambda-powertools-typescript-2k3p){target="_blank"} +* [First Look at Lambda Powertools TypeScript](https://dev.to/aws-builders/first-look-at-lambda-powertools-typescript-2k3p){target="_blank"} -* [Powertools for AWS Lambda (TypeScript) is Generally Available](https://dev.to/aws-builders/lambda-powertools-typescript-is-generally-available-1dm8){target="_blank"} +* [Lambda Powertools TypeScript is Generally Available](https://dev.to/aws-builders/lambda-powertools-typescript-is-generally-available-1dm8){target="_blank"}