# sidelab-key-vault

> A package to manage secrets using key vault

Latest version **1.0.1** (published 2021-09-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install sidelab-key-vault
pnpm add sidelab-key-vault
yarn add sidelab-key-vault
bun add sidelab-key-vault
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-09-01 |
| First published | 2021-08-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | sidelab |
| Maintainers | development_sidelab |

## Links

- npm: https://www.npmjs.com/package/sidelab-key-vault
- npm.io page: https://npm.io/package/sidelab-key-vault

## Dependencies (2)

- [@azure/identity](https://npm.io/package/@azure/identity.md) ^1.5.1
- [@azure/keyvault-secrets](https://npm.io/package/@azure/keyvault-secrets.md) ^4.3.0

## Recent versions

- 1.0.1 (latest) — 2021-09-01
- 1.0.0 — 2021-08-23

## README

# Description
A package to manage secrets using key vault.

# Install

```bash
$ yarn add sidelab-key-vault
```

# Set up

```bash
# local and on CI/CD tool
export AZURE_CLIENT_ID="<CLIENT_ID>"
export AZURE_CLIENT_SECRET="<CLIENT_SECRET>"
export AZURE_TENANT_ID="<TENANT_ID>"
```

# Usage

```typescript
import { KeyVault } from 'sidelab-key-vault';

const keyVault = new KeyVault({
	keyVaultName,
	environment
});

const secret = keyVault.getSecret(secretName);
```

# Contribute

- Clone this repository

- Make your changes

- [Update lib version](https://docs.npmjs.com/updating-your-published-package-version-number)

- Open a Pull Request

# Add method to get new secrets

- Create a constant for the new secret on [constants.ts file](./src/constants.ts).

- Add a new method on [key-vault.ts file](./src/key-vault.ts).

---
_Source: https://npm.io/package/sidelab-key-vault · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._