npmpackage.info

Gathering detailed insights and metrics for @aws-lambda-powertools/jmespath

@aws-lambda-powertools/jmespath - 2.23.0 | npmpackage.info

@aws-lambda-powertools/jmespath

Powertools for AWS is a developer toolkit to implement Serverless best practices and increase developer velocity.

2.23.0

1,681

MIT-0

TypeScript

332.36 kB

8.9

Installations

npm install @aws-lambda-powertools/jmespath

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

22.16.0

NPM Version

lerna/8.1.2/node@v22.16.0+x64 (linux)

Pull Requests

Open

5

Total

3,093

Closed

676

Merged

2,412

Issues

Open

42

Total

1,009

Closed

967

Releases

v2.23.0

Updated on Jul 03, 2025

v2.22.0

Updated on Jun 20, 2025

v2.21.0

Updated on Jun 03, 2025

v2.20.0

Updated on May 20, 2025

v2.19.1

Updated on May 06, 2025

v2.19.0

Updated on Apr 24, 2025

View All 80 releases

Languages

TypeScript

JavaScript

Dockerfile

TypeScript (97.91%)

JavaScript (2.06%)

Dockerfile (0.03%)

Developer

aws-powertools

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT-0 License

1,681 Stars

2,540 Commits

160 Forks

27 Watchers

9 Branches

83 Contributors

Updated on Jul 11, 2025

Maintainers

View All 83 Contributors

Package Meta Information

Latest Version

2.23.0

Package Id

@aws-lambda-powertools/jmespath@2.23.0

Unpacked Size

332.36 kB

Size

43.41 kB

File Count

NPM Version

lerna/8.1.2/node@v22.16.0+x64 (linux)

Node Version

22.16.0

Published on

Jul 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@aws-lambda-powertools/commons

Powertools for AWS Lambda (TypeScript) - JMESPath Utility

Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless best practices and increase developer velocity.

You can use the package in both TypeScript and JavaScript code bases.

Intro
Usage
Contribute
Roadmap
Connect
How to support Powertools for AWS Lambda (TypeScript)?
License

Intro

The JMESPath utility is a high-level function to parse and extract data from JSON objects using JMESPath expressions.

Usage

To get started, install the library by running:

1npm i @aws-lambda-powertools/jmespath

Basic usage

At its core, the library provides a utility function to extract data from a JSON object using a JMESPath expression.

1import { search } from '@aws-lambda-powertools/jmespath';
2import { Logger } from '@aws-lambda-powertools/logger';
3
4const logger = new Logger();
5
6type MyEvent = {
7  foo: {
8    bar: string;
9  };
10}
11
12export const handler = async (event: MyEvent): Promise<void> => {
13  const result = search(event, 'foo.bar');
14  logger.info(result); // "baz"
15};

Extract data from envelopes

In some cases, you may want to extract data from an envelope. The library provides a utility function to help you work with envelopes and extract data from them.

1import { extractDataFromEnvelope } from '@aws-lambda-powertools/jmespath/envelopes';
2
3type MyEvent = {
4  body: string; // "{\"customerId\":\"dd4649e6-2484-4993-acb8-0f9123103394\"}"
5  deeplyNested: Array<{ someData: number[] }>;
6};
7
8type MessageBody = {
9  customerId: string;
10};
11
12export const handler = async (event: MyEvent): Promise<unknown> => {
13  const payload = extractDataFromEnvelope<MessageBody>(
14    event,
15    'powertools_json(body)'
16  );
17  const { customerId } = payload; // now deserialized
18
19  // also works for fetching and flattening deeply nested data
20  const someData = extractDataFromEnvelope<number[]>(
21    event,
22    'deeplyNested[*].someData[]'
23  );
24
25  return {
26    customerId,
27    message: 'success',
28    context: someData,
29    statusCode: 200,
30  };
31};

The library provides a set of built-in envelopes to help you extract data from common event sources, such as S3, SQS, and SNS, and more.

1import {
2  extractDataFromEnvelope,
3  SQS,
4} from '@aws-lambda-powertools/jmespath/envelopes';
5import { Logger } from '@aws-lambda-powertools/logger';
6import type { SQSEvent } from 'aws-lambda';
7
8const logger = new Logger();
9
10type MessageBody = {
11  customerId: string;
12};
13
14export const handler = async (event: SQSEvent): Promise<void> => {
15  const records = extractDataFromEnvelope<Array<MessageBody>>(event, SQS);
16  for (const record of records) {
17    // records is now a list containing the deserialized body of each message
18    const { customerId } = record;
19    logger.appendKeys({ customerId });
20  }
21};

JMESPath custom functions

In addition to all the built-in JMESPath functions, the library provides custom functions to help you work with complex data structures. For example, you can use the powertools_json function to parse a JSON string, or the powertools_base64 function to decode a base64-encoded string:

1import { extractDataFromEnvelope } from '@aws-lambda-powertools/jmespath/envelopes';
2import { Logger } from '@aws-lambda-powertools/logger';
3
4const logger = new Logger();
5
6export const handler = async (event: { payload: string }): Promise<void> => {
7  const data = extractDataFromEnvelope<string>(
8    event,
9    'powertools_json(powertools_base64(payload))'
10  );
11
12  logger.info('Decoded payload', { data });
13};

Finally, you can also extend the library with your own custom functions. Below an example of how to create a custom function to decode a Brotli-compressed string.

1import { fromBase64 } from '@aws-lambda-powertools/commons/utils/base64';
2import { extractDataFromEnvelope } from '@aws-lambda-powertools/jmespath/envelopes';
3import { PowertoolsFunctions } from '@aws-lambda-powertools/jmespath/functions';
4import { Logger } from '@aws-lambda-powertools/logger';
5import { brotliDecompressSync } from 'node:zlib';
6
7const logger = new Logger();
8
9class CustomFunctions extends PowertoolsFunctions {
10  @PowertoolsFunctions.signature({
11    argumentsSpecs: [['string']],
12    variadic: false,
13  })
14  public funcDecodeBrotliCompression(value: string): string {
15    const encoded = fromBase64(value, 'base64');
16    const uncompressed = brotliDecompressSync(encoded);
17
18    return uncompressed.toString();
19  }
20}
21
22export const handler = async (event: { payload: string }): Promise<void> => {
23  const message = extractDataFromEnvelope<string>(
24    event,
25    'Records[*].decode_brotli_compression(notification) | [*].powertools_json(@).message',
26    { customFunctions: new CustomFunctions() }
27  );
28
29  logger.info('Decoded message', { message });
30};

Contribute

If you are interested in contributing to this project, please refer to our Contributing Guidelines.

Roadmap

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, or creating new ones, in this GitHub repository.

Connect

Powertools for AWS Lambda on Discord: #typescript - Invite link
Email: aws-lambda-powertools-feedback@amazon.com

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 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) issue.

The following companies, among others, use Powertools:

Sharing your work

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

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 languages. When using Layers, you can add Powertools as a dev dependency to not impact the development process.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

No vulnerabilities found.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

Reason

GitHub workflow tokens follow principle of least privilege

Details

Info: jobLevel 'contents' permission set to 'read': .github/workflows/bootstrap_region.yml:78
Info: jobLevel 'contents' permission set to 'read': .github/workflows/bootstrap_region.yml:41
Info: jobLevel 'checks' permission set to 'read': .github/workflows/dispatch_analytics.yml:32
Info: jobLevel 'deployments' permission set to 'read': .github/workflows/dispatch_analytics.yml:34
Info: jobLevel 'issues' permission set to 'read': .github/workflows/dispatch_analytics.yml:35
Info: jobLevel 'packages' permission set to 'read': .github/workflows/dispatch_analytics.yml:37
Info: jobLevel 'pages' permission set to 'read': .github/workflows/dispatch_analytics.yml:38
Info: jobLevel 'pull-requests' permission set to 'read': .github/workflows/dispatch_analytics.yml:39
Info: jobLevel 'statuses' permission set to 'read': .github/workflows/dispatch_analytics.yml:42
Info: jobLevel 'actions' permission set to 'read': .github/workflows/dispatch_analytics.yml:31
Info: jobLevel 'contents' permission set to 'read': .github/workflows/dispatch_analytics.yml:33
Info: jobLevel 'discussions' permission set to 'read': .github/workflows/dispatch_analytics.yml:36
Info: jobLevel 'repository-projects' permission set to 'read': .github/workflows/dispatch_analytics.yml:40
Info: jobLevel 'security-events' permission set to 'read': .github/workflows/dispatch_analytics.yml:41
Info: jobLevel 'contents' permission set to 'read': .github/workflows/layer_balance.yml:40
Info: jobLevel 'contents' permission set to 'read': .github/workflows/layers_partition_verify.yml:75
Info: jobLevel 'contents' permission set to 'read': .github/workflows/layers_partition_verify.yml:104
Info: jobLevel 'contents' permission set to 'read': .github/workflows/layers_partitions.yml:72
Info: jobLevel 'contents' permission set to 'read': .github/workflows/layers_partitions.yml:108
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/make-release.yml:79
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/make-release.yml:103
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/make-version.yml:14
Info: jobLevel 'contents' permission set to 'read': .github/workflows/on_doc_merge.yml:18
Info: jobLevel 'actions' permission set to 'read': .github/workflows/on_merged_pr.yml:36
Info: jobLevel 'contents' permission set to 'read': .github/workflows/on_merged_pr.yml:37
Info: jobLevel 'contents' permission set to 'read': .github/workflows/post-release.yml:21
Info: found token with 'none' permissions: .github/workflows/publish_layer.yml:100
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/publish_layer.yml:98
Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_layer.yml:67
Info: jobLevel 'contents' permission set to 'read': .github/workflows/publish_layer.yml:82
Info: jobLevel 'contents' permission set to 'read': .github/workflows/rebuild_latest_docs.yml:32
Info: jobLevel 'contents' permission set to 'read': .github/workflows/record_pr.yml:47
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-drafter.yml:28
Info: jobLevel 'actions' permission set to 'read': .github/workflows/reusable_export_pr_details.yml:61
Info: jobLevel 'contents' permission set to 'read': .github/workflows/run-e2e-tests.yml:23
Info: jobLevel 'contents' permission set to 'read': .github/workflows/secure-workflows.yml:30
Warn: jobLevel 'contents' permission set to 'write': .github/workflows/update_ssm.yml:89
Info: topLevel 'contents' permission set to 'read': .github/workflows/bootstrap_region.yml:34
Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:13
Info: topLevel 'contents' permission set to 'read': .github/workflows/dispatch_analytics.yml:20
Info: topLevel 'contents' permission set to 'read': .github/workflows/layer_balance.yml:33
Info: found token with 'none' permissions: .github/workflows/layers_partition_verify.yml:1
Info: topLevel 'contents' permission set to 'read': .github/workflows/layers_partitions.yml:44
Info: topLevel 'contents' permission set to 'read': .github/workflows/make-release.yml:29
Info: topLevel 'contents' permission set to 'read': .github/workflows/make-version.yml:7
Info: topLevel 'contents' permission set to 'read': .github/workflows/on_doc_merge.yml:12
Info: topLevel 'contents' permission set to 'read': .github/workflows/on_merged_pr.yml:30
Info: found token with 'none' permissions: .github/workflows/on_pr_updates.yml:1
Info: topLevel permissions set to 'read-all': .github/workflows/ossf_scorecard.yml:12
Info: topLevel 'contents' permission set to 'read': .github/workflows/post-release.yml:16
Info: topLevel 'contents' permission set to 'read': .github/workflows/pr-run-linting-check-and-unit-tests.yml:8
Info: topLevel 'contents' permission set to 'read': .github/workflows/publish-package.yml:24
Info: topLevel 'contents' permission set to 'read': .github/workflows/publish_layer.yml:4
Info: topLevel 'contents' permission set to 'read': .github/workflows/quality_check.yml:13
Info: topLevel 'contents' permission set to 'read': .github/workflows/rebuild_latest_docs.yml:26
Info: topLevel 'contents' permission set to 'read': .github/workflows/record_pr.yml:41
Info: topLevel 'contents' permission set to 'read': .github/workflows/release-drafter.yml:22
Info: topLevel 'contents' permission set to 'read': .github/workflows/reusable-run-linting-check-and-unit-tests.yml:33
Info: topLevel 'contents' permission set to 'read': .github/workflows/reusable_deploy_layer_stack.yml:23
Info: topLevel 'contents' permission set to 'read': .github/workflows/reusable_export_pr_details.yml:56
Info: topLevel 'contents' permission set to 'read': .github/workflows/reusable_publish_docs.yml:38
Info: topLevel 'contents' permission set to 'read': .github/workflows/run-e2e-tests.yml:12
Info: topLevel 'contents' permission set to 'read': .github/workflows/secure-workflows.yml:23
Info: topLevel 'contents' permission set to 'read': .github/workflows/stale-issues.yml:8
Info: topLevel 'contents' permission set to 'read': .github/workflows/update_ssm.yml:45

10

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

10

License

Determines if the project has defined a license.

10

CI-Tests

Determines if the project runs tests before pull requests are merged.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

9

SAST

Determines if the project uses static code analysis.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

8.9

/10

Last Scanned on 2025-07-12T09:00:58Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More