Merge branch 'chore/esm_e2e_test' of github.com:aws-powertools/powertools-lambda-typescript into chore/esm_e2e_test

Author: dreamorosi

.github/actions/cached-node-modules/action.yml

@@ -34,17 +34,18 @@ runs:
     - name: Build packages
       # Regardless of whether the cache was hit or not, we need to build the packages, unless the caller says otherwise
       if: inputs.build == 'true'
-      # We build the shared package first, then the others in parallel to speed up the process
+      # We build the commons and jmspath packages first, then the others in parallel to speed up the process
       # even though we could just run `npm run build` in the root folder and build them in
       # sequence, but still in the correct order.
       run: |
-        npm run build -w packages/commons
+        npm run build -w packages/commons 
         npm run build -w packages/jmespath
         npm run build -w packages/logger & \
         npm run build -w packages/tracer & \
         npm run build -w packages/metrics & \
         npm run build -w packages/parameters & \
         npm run build -w packages/idempotency & \
         npm run build -w packages/batch & \
-        npm run build -w packages/testing 
+        npm run build -w packages/testing & \
+        npm run build -w packages/parser
       shell: bash

.github/scripts/release_patch_package_json.js

@@ -18,7 +18,7 @@ if (process.argv.length < 3) {
 const basePath = resolve(process.argv[2]);
 const packageJsonPath = join(basePath, 'package.json');
 const alphaPackages = [];
-const betaPackages = [];
+const betaPackages = ['@aws-lambda-powertools/parser'];
 
 (() => {
   try {

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

@@ -28,9 +28,9 @@ jobs:
         with:
           nodeVersion: ${{ matrix.version }}
       - name: Run linting
-        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w packages/batch -w packages/jmespath
+        run: npm run lint -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w packages/batch -w packages/jmespath -w packages/parser
       - name: Run unit tests
-        run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w packages/batch -w packages/jmespath
+        run: npm t -w packages/commons -w packages/logger -w packages/tracer -w packages/metrics -w packages/parameters -w packages/idempotency -w packages/batch -w packages/jmespath -w packages/parser
   check-examples:
     runs-on: ubuntu-latest
     env:

docs/Dockerfile

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

docs/requirements.in

@@ -1,4 +1,4 @@
 mike==1.1.2
-mkdocs-material==9.5.17
+mkdocs-material==9.5.18
 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.17 \
-    --hash=sha256:06ae1275a72db1989cf6209de9e9ecdfbcfdbc24c58353877b2bb927dbe413e4 \
-    --hash=sha256:14a2a60119a785e70e765dd033e6211367aca9fc70230e577c1cf6a326949571
+mkdocs-material==9.5.18 \
+    --hash=sha256:1e0e27fc9fe239f9064318acf548771a4629d5fd5dfd45444fd80a953fe21eb4 \
+    --hash=sha256:a43f470947053fa2405c33995f282d24992c752a50114f23f30da9d8d0c57e62
     # via -r requirements.in
 mkdocs-material-extensions==1.3.1 \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \

lerna.json

@@ -9,6 +9,7 @@
     "packages/batch",
     "packages/testing",
     "packages/jmespath",
+    "packages/parser",
     "examples/app",
     "layers",
     "docs/snippets"

packages/jmespath/src/Functions.ts

@@ -48,7 +48,11 @@ import { arityCheck, typeCheck } from './utils.js';
  * ```
  */
 class Functions {
+  /**
+   * A set of all the custom functions available in this and all child classes.
+   */
   public methods: Set<string> = new Set();
+
   /**
    * Get the absolute value of the provided number.
    *
@@ -528,14 +532,32 @@ class Functions {
     return Object.values(arg);
   }
 
+  /**
+   * Lazily introspects the methods of the class instance and all child classes
+   * to get the names of the methods that correspond to JMESPath functions.
+   *
+   * This method is used to get the names of the custom functions that are available
+   * in the class instance and all child classes. The names of the functions are used
+   * to create the custom function map that is passed to the JMESPath search function.
+   *
+   * The method traverses the inheritance chain going from the leaf class to the root class
+   * and stops when it reaches the `Functions` class, which is the root class.
+   *
+   * In doing so, it collects the names of the methods that start with `func` and adds them
+   * to the `methods` set. Finally, when the recursion collects back to the current instance,
+   * it adds the collected methods to the `this.methods` set so that they can be accessed later.
+   *
+   * @param scope The scope of the class instance to introspect
+   */
   public introspectMethods(scope?: Functions): Set<string> {
     const prototype = Object.getPrototypeOf(this);
-    const ownName = prototype.constructor.name;
     const methods = new Set<string>();
-    if (ownName !== 'Functions') {
+    if (this instanceof Functions) {
       for (const method of prototype.introspectMethods(scope)) {
         methods.add(method);
       }
+    } else {
+      return methods;
     }
 
     // This block is executed for every class in the inheritance chain

packages/jmespath/tests/unit/index.test.ts

@@ -351,9 +351,6 @@ describe('Coverage tests', () => {
     it('uses the custom function extending the powertools custom functions', () => {
       // Prepare
       class CustomFunctions extends PowertoolsFunctions {
-        public constructor() {
-          super();
-        }
         @PowertoolsFunctions.signature({
           argumentsSpecs: [['string']],
         })
@@ -384,5 +381,26 @@ describe('Coverage tests', () => {
       // Assess
       expect(messages).toStrictEqual(['hello world']);
     });
+
+    it('correctly registers all the custom functions', () => {
+      // Prepare
+      class CustomFunctions extends PowertoolsFunctions {
+        @PowertoolsFunctions.signature({
+          argumentsSpecs: [['string']],
+        })
+        public funcPassThrough(value: string): string {
+          return value;
+        }
+      }
+
+      // Act
+      const customFunctions = new CustomFunctions();
+      search('pass_through(foo)', { foo: 'bar' }, { customFunctions });
+
+      // Assess
+      expect(customFunctions.methods.size).toBeGreaterThan(
+        new PowertoolsFunctions().methods.size
+      );
+    });
   });
 });

packages/parser/README.md

@@ -1,5 +1,12 @@
 # Powertools for AWS Lambda (TypeScript) - Parser Utility <!-- omit in toc -->
 
+
+| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️                                                                                                                                                                                                                                                                                                  |
+| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| This AWS Lambda Powertools for TypeScript utility is currently released as beta developer preview and is intended strictly for feedback and testing purposes only.  <br/>This version is not stable, and significant breaking changes might incur before going [before the GA release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/16). | _ |
+
+
+
 Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features).
 
 You can use the package in both TypeScript and JavaScript code bases.

packages/parser/package.json

@@ -7,7 +7,7 @@
     "url": "https://aws.amazon.com"
   },
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   },
   "scripts": {
     "test": "npm run test:unit",
@@ -91,9 +91,16 @@
     "aws",
     "lambda",
     "powertools",
-    "batch",
-    "batch-processing",
+    "parser",
+    "zod",
+    "parse",
+    "events",
+    "payloads",
+    "inputs",
+    "validate",
+    "validation",
     "serverless",
+    "typescript",
     "nodejs"
   ],
   "peerDependencies": {