@bhandari88/express-auth 1.0.0 → 1.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.
- package/README.md +12 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @bhandari88/express-auth
|
|
2
2
|
|
|
3
3
|
A plug-and-play authentication handler for Express.js with TypeScript supporting multiple authentication methods including email, username, phone, and social login (Google, Facebook).
|
|
4
4
|
|
|
5
|
+
## 📦 Package
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @bhandari88/express-auth
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
**Package URL**: [https://www.npmjs.com/package/@bhandari88/express-auth](https://www.npmjs.com/package/@bhandari88/express-auth)
|
|
12
|
+
|
|
5
13
|
## Features
|
|
6
14
|
|
|
7
15
|
- ✅ **Multiple Authentication Methods**
|
|
@@ -31,12 +39,6 @@ A plug-and-play authentication handler for Express.js with TypeScript supporting
|
|
|
31
39
|
- Optional refresh tokens
|
|
32
40
|
- Customizable user fields
|
|
33
41
|
|
|
34
|
-
## Installation
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npm install @auth-boiler/express-auth
|
|
38
|
-
```
|
|
39
|
-
|
|
40
42
|
## Peer Dependencies
|
|
41
43
|
|
|
42
44
|
Make sure you have the following peer dependencies installed:
|
|
@@ -50,7 +52,7 @@ npm install express
|
|
|
50
52
|
### 1. Install Dependencies
|
|
51
53
|
|
|
52
54
|
```bash
|
|
53
|
-
npm install @
|
|
55
|
+
npm install @bhandari88/express-auth express
|
|
54
56
|
npm install --save-dev typescript @types/express @types/node
|
|
55
57
|
```
|
|
56
58
|
|
|
@@ -59,7 +61,7 @@ npm install --save-dev typescript @types/express @types/node
|
|
|
59
61
|
Implement the `UserRepository` interface for your database:
|
|
60
62
|
|
|
61
63
|
```typescript
|
|
62
|
-
import { UserRepository, UserDocument } from '@
|
|
64
|
+
import { UserRepository, UserDocument } from '@bhandari88/express-auth';
|
|
63
65
|
|
|
64
66
|
class MyUserRepository implements UserRepository {
|
|
65
67
|
async findById(id: string): Promise<UserDocument | null> {
|
|
@@ -100,7 +102,7 @@ class MyUserRepository implements UserRepository {
|
|
|
100
102
|
|
|
101
103
|
```typescript
|
|
102
104
|
import express from 'express';
|
|
103
|
-
import { Auth, AuthConfig } from '@
|
|
105
|
+
import { Auth, AuthConfig } from '@bhandari88/express-auth';
|
|
104
106
|
import MyUserRepository from './repositories/MyUserRepository';
|
|
105
107
|
|
|
106
108
|
const app = express();
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bhandari88/express-auth",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Plug-and-play authentication handler for Express.js with TypeScript supporting email, username, phone, and social login",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|