Merge branch 'main' into feat/jmespath_tests

Author: sthulb

.github/boring-cyborg.yml

@@ -71,22 +71,7 @@ labelPRBasedOnFilePath:
     - docs/**/*
     - mkdocs.yml
     - typedoc.js
-    - examples/cdk/bin/*
-    - examples/cdk/functions/*
-    - examples/cdk/functions/**/*
-    - examples/cdk/src/*
-    - examples/cdk/src/**/*
-    - examples/cdk/tests/*
-    - examples/cdk/tests/**/*
-    - examples/cdk/README.md
-    - examples/cdk/cdk.json
-    - examples/sam/events/*
-    - examples/sam/src/*
-    - examples/sam/src/**/*
-    - examples/sam/tests/*
-    - examples/sam/tests/**/*
-    - examples/sam/README.md
-    - examples/sam/template.yaml
+    - examples/app/*
 
   area/automation:
     - .github/scripts/*
@@ -137,8 +122,7 @@ labelPRBasedOnFilePath:
     - packages/parser/README.md
     - layers/tsconfig*.json
     - layers/README.md
-    - examples/sam/tsconfig*.json
-    - examples/cdk/tsconfig*.json
+    - examples/app/tsconfig*.json
 
   type/dependencies:
     - package.json
@@ -153,8 +137,7 @@ labelPRBasedOnFilePath:
     - packages/validator/package.json
     - packages/batch/package.json
     - layers/package.json
-    - examples/cdk/package.json
-    - examples/sam/package.json
+    - examples/app/package.json
 
 ##### Greetings ########################################################################################################
 firstPRWelcomeComment: >

.github/workflows/dependency-review.yml

@@ -19,4 +19,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@0fa40c3c10055986a88de3baa0d6ec17c5a894b3 # v4.2.3
+        uses: actions/dependency-review-action@5bbc3ba658137598168acb2ab73b21c432dd411b # v4.2.5

.github/workflows/reusable-run-linting-check-and-unit-tests.yml

@@ -37,7 +37,7 @@ jobs:
       NODE_ENV: dev
     strategy:
       matrix:
-        example: ["sam", "cdk"]
+        example: ["app"]
       fail-fast: false
     defaults:
       run:

.gitignore

@@ -41,10 +41,6 @@ site
 # Generated API documentation (from TypeDoc)
 /api
 
-# SAM Example copies files
-/examples/sam/src/handlers/*
-!/examples/sam/src/handlers/COPY_LAMBDA_FUNCTIONS_HERE
-
 # Layer temp files
 tmp
 

README.md

@@ -84,8 +84,7 @@ Or refer to the installation guide of each utility:
 
 ### Examples
 
-* [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
-* [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
+You can find examples of how to use Powertools for AWS Lambda (TypeScript) in the [examples](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/app) directory. The application is a simple REST API that can be deployed via either AWS CDK or AWS SAM.
 
 ### Demo applications
 

docs/Dockerfile

@@ -1,5 +1,5 @@
 # version 9.5.2
-FROM squidfunk/mkdocs-material@sha256:6c81a890d0b5a59cc36e53684ae696995aa1f526f1406106f9bfec49d5031581
+FROM squidfunk/mkdocs-material@sha256:33076657e536b6b8439168296a193098aef3c4c88cc2cecd0736cd391b90e7fd
 
 ADD requirements.txt /tmp/
 RUN pip install --require-hashes -r /tmp/requirements.txt

docs/contributing/conventions.md

@@ -31,7 +31,7 @@ Whenever possible, we use the same directory structure for all utilities. This m
 There are also a few other workspaces that are not utilities published to npm, but that still share dependencies and/or runtime code with the utilities. These workspaces are:
 
 * `docs/snippets`: contains the documentation code snippets
-* `examples/*`: contains the example projects deployed via AWS CDK or AWS SAM
+* `examples/app`: contains an example project that can be deployed via AWS CDK or AWS SAM
 * `layers`: contains the code used to build and publish the [Lambda layers](../index.md#lambda-layer)
 
 ## Testing definition

docs/index.md

@@ -272,12 +272,9 @@ The examples in this documentation will feature all the approaches described abo
 
 ## Examples
 
-The project's repository includes examples of how to instrument your functions both in AWS CDK and AWS SAM:
+You can find examples of how to use Powertools for AWS Lambda (TypeScript) in the [examples](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/app){target="_blank"} directory. The application is a simple REST API that can be deployed via either AWS CDK or AWS SAM.
 
-* [AWS CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk){target="_blank"}
-* [AWS SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam){target="_blank"}
-
-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) or the [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository. Both demos use Powertools for AWS Lambda (TypeScript) as well as demonstrating other common techniques for Lambda functions written in TypeScript.
+If instead you want to see Powertools for AWS Lambda (TypeScript) in slightly different use cases, check the [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) or the [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository. Both demos use Powertools for AWS Lambda (TypeScript) as well as demonstrating other common techniques for Lambda functions written in TypeScript.
 
 
 ## Features

docs/requirements.in

@@ -1,4 +1,4 @@
 mike==1.1.2
-mkdocs-material==9.5.14
+mkdocs-material==9.5.15
 mkdocs-git-revision-date-plugin==0.3.2
 mkdocs-exclude==1.0.2

docs/requirements.txt

@@ -229,9 +229,9 @@ mkdocs-exclude==1.0.2 \
 mkdocs-git-revision-date-plugin==0.3.2 \
     --hash=sha256:2e67956cb01823dd2418e2833f3623dee8604cdf223bddd005fe36226a56f6ef
     # via -r requirements.in
-mkdocs-material==9.5.14 \
-    --hash=sha256:2a1f8e67cda2587ab93ecea9ba42d0ca61d1d7b5fad8cf690eeaeb39dcd4b9af \
-    --hash=sha256:a45244ac221fda46ecf8337f00ec0e5cb5348ab9ffb203ca2a0c313b0d4dbc27
+mkdocs-material==9.5.15 \
+    --hash=sha256:39f03cca45e82bf54eb7456b5a18bd252eabfdd67f237a229471484a0a4d4635 \
+    --hash=sha256:e5c96dec3d19491de49ca643fc1dbb92b278e43cdb816c775bc47db77d9b62fb
     # via -r requirements.in
 mkdocs-material-extensions==1.3.1 \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \

examples/cdk/.gitignore renamed to examples/app/.gitignore

@@ -8,5 +8,13 @@ node_modules
 .cdk.staging
 cdk.out
 lib
+# npm lock file - this is managed by the npm workspace
+package-lock.json
+
+**/.aws-sam
+
+# SAM
+samconfig.toml
+
 # npm lock file - this is managed by the npm workspace
 package-lock.json

examples/cdk/CHANGELOG.md renamed to examples/app/CHANGELOG.md

@@ -1,5 +1,5 @@
 {
-  "app": "npx ts-node --prefer-ts-exts bin/cdk-app.ts",
+  "app": "tsx cdk/example-app.ts",
   "watch": {
     "include": [
       "**"

examples/cdk/README.md renamed to examples/app/README.md

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import 'source-map-support/register';
+import { App } from 'aws-cdk-lib';
+import { PowertoolsExampleStack } from './example-stack.js';
+
+const app = new App();
+new PowertoolsExampleStack(app, 'PowertoolsTypeScript-Example-CDK', {});