@itgorillaz/configify 3.0.0-alpha.3 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -1
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -172,9 +172,20 @@ export class DatabaseConfiguration {
172
172
 
173
173
  ### Dealing with Secrets
174
174
 
175
- Out of the box, this module can resolve AWS Secrets Manager and Parameter Store secrets. For that, just need to choose which strategies you would like to use to resolve AWS secrets:
175
+ Out of the box, this module can resolve AWS Secrets Manager and Parameter Store secrets.
176
+
177
+ For that, first is you need to install the required aws-sdk modules:
178
+
179
+ ```
180
+ npm install @aws-sdk/client-ssm @aws-sdk/client-secrets-manager
181
+ ```
182
+
183
+ then you can choose which strategies you would like to use to resolve AWS secrets:
176
184
 
177
185
  ```js
186
+ import { ConfigifyModule } from '@itgorillaz/configify';
187
+ import { AwsSecretsResolverFactory } from '@itgorillaz/configify/configuration/resolvers/aws';
188
+
178
189
  // use default aws client instances
179
190
  ConfigifyModule.forRootAsync({
180
191
  secretsResolverStrategies: [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itgorillaz/configify",
3
- "version": "3.0.0-alpha.3",
3
+ "version": "3.0.1",
4
4
  "description": "NestJS Config on Steroids",
5
5
  "author": "tommelo",
6
6
  "private": false,
@@ -30,8 +30,6 @@
30
30
  "js-yaml": "^4.1.0"
31
31
  },
32
32
  "peerDependencies": {
33
- "@aws-sdk/client-secrets-manager": "^3.454.0",
34
- "@aws-sdk/client-ssm": "^3.461.0",
35
33
  "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
36
34
  "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0",
37
35
  "class-validator": "^0.14.0",
@@ -39,6 +37,8 @@
39
37
  "rxjs": "^7.2.0"
40
38
  },
41
39
  "devDependencies": {
40
+ "@aws-sdk/client-secrets-manager": "^3.454.0",
41
+ "@aws-sdk/client-ssm": "^3.461.0",
42
42
  "@nestjs/cli": "^11.0.2",
43
43
  "@nestjs/schematics": "^11.0.0",
44
44
  "@nestjs/testing": "^11.0.5",