@nauth-toolkit/sms-aws-sns 0.2.0 → 0.2.2
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.
- package/README.md +39 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,4 +4,42 @@ AWS SNS SMS provider for [nauth-toolkit](https://nauth.dev).
|
|
|
4
4
|
|
|
5
5
|
Sends SMS verification codes and MFA one-time passwords through Amazon SNS. Plug in your AWS credentials and nauth-toolkit handles message formatting and delivery.
|
|
6
6
|
|
|
7
|
-
**
|
|
7
|
+
**[Documentation](https://nauth.dev)** · **[GitHub](https://github.com/noorixorg/nauth)**
|
|
8
|
+
|
|
9
|
+
> Part of [nauth-toolkit](https://www.npmjs.com/package/@nauth-toolkit/core). Requires `@nauth-toolkit/core`.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @nauth-toolkit/sms-aws-sns
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Configure in your auth config:
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { AWSSNSProvider } from '@nauth-toolkit/sms-aws-sns';
|
|
23
|
+
|
|
24
|
+
const authConfig = {
|
|
25
|
+
smsProvider: new AWSSNSProvider({
|
|
26
|
+
region: process.env.AWS_REGION,
|
|
27
|
+
accessKeyId: process.env.AWS_ACCESS_KEY_ID,
|
|
28
|
+
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
|
|
29
|
+
}),
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Also available
|
|
36
|
+
|
|
37
|
+
| Package | Purpose |
|
|
38
|
+
| --- | --- |
|
|
39
|
+
| [`@nauth-toolkit/sms-console`](https://www.npmjs.com/package/@nauth-toolkit/sms-console) | Log SMS to console — development use |
|
|
40
|
+
|
|
41
|
+
See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
Free to use. See [license](https://nauth.dev/docs/license).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nauth-toolkit/sms-aws-sns",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "AWS SNS SMS provider for nauth-toolkit",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"@aws-sdk/client-sns": "^3.0.0"
|
|
19
19
|
},
|
|
20
20
|
"peerDependencies": {
|
|
21
|
-
"@nauth-toolkit/core": "^0.2.
|
|
21
|
+
"@nauth-toolkit/core": "^0.2.2"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@types/jest": "^29.5.0",
|