npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@santriseus/zod-lambda-mapper

v0.0.3

Published

Use zod schema as mapper definition to extract data from aws lambda events

Downloads

5

Readme

@santriseus/zod-lambda-mapper

Extends a Zod schema with additional functions allowing to declare mapping and extract required fields from AWS API Gateway Lambda Events APIGatewayProxyEventV2and APIGatewayProxyEventV2WithJWTAuthorizer


Installation

Zod is a peer dependency.

npm install zod @santriseus/zod-lambda-mapper

Usage

Extend a Zod schema with additional methods

  • fromBody(path?: string) (path is lodash get path, if not specified whole parsed body object is assigned)
  • fromQuery(name?: string) (name is query parameter name, if not specified whole query object is assigned)
  • fromParams(name?: string) (name is url parameter name, if not specified whole params object is assigned)
  • fromJwtClaims(name?: string) (name is jwt claim name, if not specified whole claims object is assigned)
import { extendZodWithLambdaEventMapper, extract } from '@santriseus/zod-lambda-mapper';
import {z} from 'zod';

extendZodWithLambdaEventMapper(z);

const schema = z.object({
  order: z.object({
    customerId: z.string().fromJwtClaims('uid'),
    orderId: z.string().fromParams('orderId'),
    products: z.array(z.object({
      name: z.string(),
      quantity: z.number(),
    })).fromBody('products'),
    pagination: z.object({
      skip: z.number(),
      take: z.number()
    }).fromQuery()
  }),
  comment: z.string().fromBody('additionalInfo.comment'),
});
const event: APIGatewayProxyEventV2WithJWTAuthorizer = {
//   ...  
  requestContext: {
//   ...
    authorizer: {
//   ...    
      jwt: {
        claims: {
          uid: '12345',
        },
      },
    },
  },
//   ...
  body: JSON.stringify({
    products: [
      {
        name: 'cucumbers',
        quantity: 3,
      },
      {
        name: 'tomatoes',
        quantity: 2,
      }
    ],
    additionalInfo: {
      comment: 'some comment',
      note: 'some note'
    }
  }),
//   ...
  pathParameters: {
    orderId: '54321',
  },
//   ...  
  queryStringParameters:  {
    take: '2',
    skip: '5',
  },
//  ...  
};

const extracted = extract(event, schema)
// ...

This will extract following object:

const extracted = {
  order: {
    customerId: "12345",
    orderId: "54321",
    products: [
      {
        name: "cucumbers",
        quantity: 3,
      },
      {
        name: "tomatoes",
        quantity: 2,
      },
    ],
    pagination: {
      take: "2",
      skip: "5",
    },
  },
  comment: "some comment"
}