@nauth-toolkit/sms-console 0.2.1 → 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 +35 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,4 +4,38 @@ Console SMS provider for [nauth-toolkit](https://nauth.dev).
|
|
|
4
4
|
|
|
5
5
|
Logs SMS content to the console instead of sending it. Use during development and testing to see verification codes and MFA one-time passwords without configuring a real SMS gateway.
|
|
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-console
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Configure in your auth config:
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { ConsoleSMSProvider } from '@nauth-toolkit/sms-console';
|
|
23
|
+
|
|
24
|
+
const authConfig = {
|
|
25
|
+
smsProvider: new ConsoleSMSProvider(),
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## For production
|
|
32
|
+
|
|
33
|
+
| Package | Purpose |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| [`@nauth-toolkit/sms-aws-sns`](https://www.npmjs.com/package/@nauth-toolkit/sms-aws-sns) | AWS SNS |
|
|
36
|
+
|
|
37
|
+
See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
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-console",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Console SMS provider for nauth-toolkit — development and testing",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"format:check": "prettier --check \"src/**/*.ts\""
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
|
-
"@nauth-toolkit/core": "^0.2.
|
|
17
|
+
"@nauth-toolkit/core": "^0.2.2"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@types/jest": "^29.5.0",
|