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

@lfreneda/aws-secrets-manager

v1.0.0

Published

High level interface (with cache) for AWS Secrets Manager

Downloads

3,350

Readme

aws-secrets-manager

Maintainability

:key: High level interface (with cache) for AWS Secrets Manager

Install

npm install @lfreneda/aws-secrets-manager --save
yarn add @lfreneda/aws-secrets-manager

What's New in Version 1.0.0

This release represents a MAJOR version update from 0.0.3, indicating significant changes to the API. Users of version ^0.0.3 should be aware that this update is not backward-compatible. However, packages using version ^0.0.3 will not be automatically updated to 1.0.0.

Major Changes

  • Language Update: The codebase has been migrated from JavaScript to TypeScript with correct types and JSDOC documentation.
  • Package Updates: The AWS SDK has been updated to version 3. Node.js 14 and above is now supported (developed in Node.js version 18).
  • Development Tools: ESLint has been updated to the latest version with the "Neon" standard, and Prettier has been added to the project.
  • Testing: Unit tests have been added using Vitest for various functions, including SecretManager, toConnectionString, and InMemoryCacheSecretsManagerDecorator.
  • API Changes: Error handling has been improved with errors now mapped to their own classes. The SecretManager has been enhanced to accept an inlineCache parameter during instantiation, and the getSecretValue method now supports a bypassCache parameter.

Note on Cache

When using the secret manager with inlineCache, the secrets will be cached for 10 minutes, if you need to bypass the cache, you can use the bypassCache parameter.

If your needs require any changes to the cache, you can implement your own cache by disabling the inlineCache and using the InMemoryCacheSecretsManagerDecorator decorator, see the Node-Cache package for more information on configuration options.

Utils

If you are using secrets for RDS credentials, there is also a helper to convert database settings to a connection string: toConnectionString.

How to use

Inline cache implementation:

const { SecretsManager } = require('@lfreneda/aws-secrets-manager')
const secretsManager = new SecretsManager({ region: 'us-east-1' })
const secretValue = await secretsManager.getSecretValue('sample/key')

To use the in-memory cache implementation:

const { SecretsManager, InMemoryCacheSecretsManagerDecorator } = require('@lfreneda/aws-secrets-manager')
const secretsManager = new SecretsManager({ region: 'us-east-1' }, false)
const cachedSecretManager = new InMemoryCacheSecretsManagerDecorator(secretsManager)
const secretValue = await cachedSecretManager.getSecretValue('sample/key')

To use the bypassCache parameter:

const { SecretsManager } = require('@lfreneda/aws-secrets-manager')
const secretsManager = new SecretsManager({ region: 'us-east-1' })
const secretValue = await secretsManager.getSecretValue('sample/key', true)

Running tests

Tests were made using Vitest and Sinon

npm test

Need Help?

If you have questions or encounter issues while transitioning to version 1.0.0, please feel free to open an issue on GitHub for assistance.

Make sure to adjust the installation, usage, and testing instructions as needed for your project.