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

@kylewebb/aws-sig-v4

v1.3.0

Published

NestJS http client library with automatic aws v4 request signing

Downloads

8

Readme

NestJS AWS v4

npm version

A NestJS http client library with automatic AWS v4 request signing. This is useful for, among other things, IAM authorization in AWS API Gateway.

Installation

npm install --save nestjs-aws-v4

Usage

Module

By default, requests are signed with IAM credentials and region from environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION). These variables are automatically provided in most AWS code execution environments, like Lambda.

Simply importing the module will use these default settings.

import { Module } from '@nestjs/common';
import { AwsV4HttpModule } from 'nestjs-aws-v4';

@Module({
  imports: [AwsV4HttpModule],
})
export class AppModule {}

Configuration

AwsV4HttpModule has the same configuration options as HttpModule, as well as additional parameters to override credentials and control the signing process.

Note: When using with an API Gateway url (i.e. https://{api_gw_id}.execute-api.us-east-1.amazonaws.com/{stage}), the service will automatically be inferred as execute-api. If you are using an API Gateway custom domain, you must specify { service: 'execute-api' }.

Register

import { Module } from '@nestjs/common';
import { AwsV4HttpModule } from 'nestjs-aws-v4';

@Module({
  imports: [
    AwsV4HttpModule.register({
      region: 'us-east-1',
      service: 'execute-api'
      credentials: {
        accessKeyId: '...',
        secretAccessKey: '...',
      },
    }),
  ],
})
export class AppModule {}

RegisterAsync

Sometimes, it may be necessary to use a factory to build your configuration. For instance, you may need to inject a configuration service. This can be done with the registerAsync method.

@Module({
  imports: [
    AwsV4HttpModule.registerAsync({
      imports: [ConfigModule.forRoot()],
      useFactory: async (config: ConfigService) => ({
        region: await config.get('REGION'),
        credentials: {
          accessKeyId: await config.get('ACCESS_KEY_ID'),
          secretAccessKey: await config.get('SECRET_ACCESS_KEY'),
        },
      }),
      inject: [ConfigService],
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

AwsV4HttpService

AwsV4HttpService works just like the build-in HttpService, except all requests will automatically be signed with AWS Signature Version 4.

import { Injectable } from '@nestjs/common';
import { AwsV4HttpService } from 'nestjs-aws-v4';

@Injectable()
export class AppService {
  constructor(private readonly http: AwsV4HttpService) {
  }
  getHello() {
    return this.http.get(...);
  }
}