chore: removed sam folder & merged samples

Author: dreamorosi

.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/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/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

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": "tsx 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', {});

examples/cdk/cdk.json renamed to examples/app/cdk.json

@@ -21,7 +21,7 @@ import { StringParameter } from 'aws-cdk-lib/aws-ssm';
 import { Construct } from 'constructs';
 import { FunctionWithLogGroup } from './function-with-logstream-construct.js';
 
-export class CdkAppStack extends Stack {
+export class PowertoolsExampleStack extends Stack {
   public constructor(scope: Construct, id: string, props?: StackProps) {
     super(scope, id, props);
 
@@ -49,7 +49,7 @@ export class CdkAppStack extends Stack {
 
     // Idempotency table
     const idempotencyTable = new Table(this, 'idempotencyTable', {
-      tableName: 'powertools-example-idempotency-table',
+      tableName: 'powertools-example-idempotency',
       partitionKey: {
         name: 'id',
         type: AttributeType.STRING,
@@ -58,10 +58,11 @@ export class CdkAppStack extends Stack {
       billingMode: BillingMode.PAY_PER_REQUEST,
       removalPolicy: RemovalPolicy.DESTROY, // for demo only, change to RETAIN in production
     });
+
     /**
      * We will store the idempotency table name in a SSM parameter to simulate a potential
-     * cross-stack reference. This is not necessary in this example, but it's a good way of showing
-     * how to use SSM parameters to store and retrieve it from the function.
+     * cross-stack reference. This is not strictly necessary in this example, but it's a good way of showing
+     * how to use SSM parameters and retrieve them using Powertools.
      */
     const idempotencyTableNameParam = new StringParameter(
       this,
@@ -146,7 +147,7 @@ export class CdkAppStack extends Stack {
 
     /**
      * In this examle, we emit a CommonJS (CJS) bundle and include all the
-     * dependencies in the bundle.
+     * dependencies in it.
      */
     const getByIdFn = new FunctionWithLogGroup(this, 'get-by-id-fn', {
       entry: './functions/get-by-id.ts',

examples/app/cdk/example-app.ts

@@ -8,9 +8,6 @@
   "private": true,
   "description": "This project contains source code and supporting files for a serverless application that you can deploy with CDK.",
   "license": "MIT-0",
-  "bin": {
-    "cdk-app": "bin/cdk-app.js"
-  },
   "scripts": {
     "build": "echo 'Not applicable, run `npx cdk synth` instead to build the stack'",
     "test": "npm run test:unit",
@@ -35,28 +32,25 @@
     "#errors": "./functions/commons/errors.js"
   },
   "devDependencies": {
-    "@aws-lambda-powertools/commons": "^2.0.3",
-    "@aws-lambda-powertools/logger": "^2.0.3",
-    "@aws-lambda-powertools/metrics": "^2.0.3",
-    "@aws-lambda-powertools/parameters": "^2.0.3",
-    "@aws-lambda-powertools/tracer": "^2.0.3",
-    "@aws-sdk/client-ssm": "^3.533.0",
-    "@aws-sdk/lib-dynamodb": "^3.533.0",
     "@types/aws-lambda": "^8.10.136",
     "@types/node": "20.11.28",
     "aws-cdk": "^2.133.0",
+    "aws-cdk-lib": "^2.133.0",
     "constructs": "^10.3.0",
-    "esbuild": "^0.20.2",
+    "source-map-support": "^0.5.21",
     "tsx": "^4.7.1",
     "typescript": "^5.4.2"
   },
   "dependencies": {
     "@aws-lambda-powertools/batch": "^2.0.2",
     "@aws-lambda-powertools/idempotency": "^2.0.2",
+    "@aws-lambda-powertools/logger": "^2.0.3",
+    "@aws-lambda-powertools/metrics": "^2.0.3",
+    "@aws-lambda-powertools/parameters": "^2.0.3",
+    "@aws-lambda-powertools/tracer": "^2.0.3",
+    "@aws-sdk/client-ssm": "^3.533.0",
+    "@aws-sdk/lib-dynamodb": "^3.533.0",
     "@middy/core": "^4.7.0",
-    "aws-cdk-lib": "^2.133.0",
-    "construct": "^1.0.0",
-    "phin": "^3.7.0",
-    "source-map-support": "^0.5.21"
+    "esbuild": "^0.20.2"
   }
 }