auth-verify 1.4.0 → 1.5.0

package/package.json

@@ -8,12 +8,11 @@
     "nodemailer": "^7.0.6",
     "qrcode": "^1.5.4",
     "redis": "^5.8.3",
-    "twilio": "^5.10.3",
     "uuid": "^9.0.1"
   },
   "name": "auth-verify",
-  "version": "1.4.0",
-  "description": "A simple Node.js library for sending and verifying OTP via email, SMS and Telegram bot. And handling JWT with Cookies",
+  "version": "1.5.0",
+  "description": "A simple Node.js library for sending and verifying OTP via email, SMS and Telegram bot. And generating TOTP codes and QR codes. And handling JWT with Cookies",
   "main": "index.js",
   "scripts": {
     "test": "jest --runInBand"
@@ -42,7 +41,10 @@
     "redis",
     "cookie",
     "jwa",
-    "jsonwebtoken"
+    "jsonwebtoken",
+    "totp",
+    "google-authenticator",
+    "signin"
   ],
   "author": "Jahongir Sobirov",
   "license": "MIT",

package/readme.md

@@ -1,13 +1,16 @@
 # auth-verify
 
 **auth-verify** is a Node.js authentication utility that provides:
-- ✅ Secure OTP (one-time password) generation and verification
-- ✅ Sending OTPs via Email, SMS (pluggable helpers), and Telegram bot
-- ✅ TOTP (Time-based One Time Passwords) generation code and QR code and verification (Google Authenticator support)
-- ✅ JWT creation, verification and optional token revocation with memory/Redis storage
-- ✅ Session management (in-memory or Redis)
-- ✅ New: OAuth 2.0 integration for Google, Facebook, GitHub, X (Twitter) and Linkedin
-- ⚙️ Developer extensibility: custom senders and `auth.register.sender()` / `auth.use(name).send(...)`
+  - ✅ Secure OTP (one-time password) generation and verification.
+  - ✅ Sending OTPs via Email, SMS (pluggable helpers), and Telegram bot.
+  - ✅ TOTP (Time-based One Time Passwords) generation, QR code generation, and verification (Google Authenticator support).
+  - ✅ JWT creation, verification, optional token revocation with memory/Redis storage, and advanced middleware for protecting routes, custom cookie/header handling, role-based guards, and token extraction from custom sources.
+  - ✅ Session management (in-memory or Redis).
+  - ✅ OAuth 2.0 integration for Google, Facebook, GitHub, X (Twitter), Linkedin, and additional providers like Apple, Discord, Slack, Microsoft, Telegram,and WhatsApp.
+  - ⚙️ Developer extensibility: custom senders via auth.register.sender() and chainable sending via auth.use(name).send(...).
+  - ✅ Automatic JWT cookie handling for Express apps, supporting secure, HTTP-only cookies and optional auto-verification.
+  - ✅ Fully asynchronous/Promise-based API, with callback support where applicable.
+  - ✅ Chainable OTP workflow with cooldowns, max attempts, and resend functionality.
 ---
 
 ## 🧩 Installation
@@ -24,11 +27,12 @@ npm install auth-verify
 
 ## ⚙️ Quick overview
 
-- `AuthVerify` (entry): constructs and exposes `.jwt`, `.otp`, (optionally) `.session` and `.oauth` managers.
-- `JWTManager`: sign, verify, decode, revoke tokens. Supports `storeTokens: "memory" | "redis" | "none"`.
+- `AuthVerify` (entry): constructs and exposes `.jwt`, `.otp`, (optionally) `.session`, `.totp` and `.oauth` managers.
+- `JWTManager`: sign, verify, decode, revoke tokens. Supports `storeTokens: "memory" | "redis" | "none"` and middleware with custom cookie, header, and token extraction.
 - `OTPManager`: generate, store, send, verify, resend OTPs. Supports `storeTokens: "memory" | "redis" | "none"`. Supports email, SMS helper, Telegram bot, and custom dev senders.
+- `TOTPManager`: generate, verify uri, codes and QR codes
 - `SessionManager`: simple session creation/verification/destroy with memory or Redis backend.
-- `OAuthManager`: Handle OAuth 2.0 logins for Google, Facebook, GitHub, X and Linkedin
+- `OAuthManager`: Handle OAuth 2.0 logins for Google, Facebook, GitHub, X, Linkedin, Apple, Discord, Slack, Microsoft, Telegram and WhatsApp
 ---
 
 ## 🚀 Example: Initialize library (CommonJS)
@@ -49,6 +53,108 @@ const auth = new AuthVerify({
 
 ## 🔐 JWT Usage
 
+### JWT Middleware (`protect`) (New in v1.5.0) 
+
+auth-verify comes with a fully customizable JWT middleware, making it easy to **protect routes**, **attach decoded data to the request**, and **check user roles**.
+
+#### ⚙️ `protect` Method Overview
+
+Function signature:
+```js
+protect(options = {})
+```
+**Description**:
+ - Returns an Express-style middleware.
+ - Automatically reads JWT from cookie, header, or custom extractor.
+ - Verifies the token and optionally checks for roles.
+ - Attaches the decoded payload to req (default property: req.user).
+
+| Option           | Type     | Default           | Description                                                                            |
+| ---------------- | -------- | ----------------- | -------------------------------------------------------------------------------------- |
+| `onError`        | Function | `null`            | Custom error handler. `(err, req, res)`                                                |
+| `attachProperty` | String   | `"user"`          | Where to attach decoded token payload on `req`                                         |
+| `requiredRole`   | String   | `null`            | Optional role check. Throws error if decoded role does not match                       |
+| `cookieName`     | String   | `this.cookieName` | Name of the cookie to read JWT from                                                    |
+| `headerName`     | String   | `"authorization"` | Header name to read JWT from. `"authorization"` splits `Bearer TOKEN` automatically    |
+| `extractor`      | Function | `null`            | Custom function to extract token. Receives `req` as argument and must return the token |
+
+#### Middleware Behavior
+
+1. **Token extraction order:**
+  - First: `extractor(req)` if provided
+  - Second: `req.headers[headerName]` (for `authorization`, splits `Bearer TOKEN`)
+  - Third: `cookieName` from request cookies
+2. **Verification**:
+  - Calls `this.verify(token)`
+  - Throws `NO_TOKEN` if no token is found
+  - Throws `ROLE_NOT_ALLOWED` if `requiredRole`is provided but decoded role does not match
+3. **Attachment**:
+  - Decoded token is attached to `req[attachProperty]`
+4. **Error handling**:
+  - Default: responds with `401` and JSON `{ success: false, error: err.message }`
+  - Custom: if `onError` is provided, it is called instead of default behavior
+
+#### Example Usage
+##### Basic Usage
+```js
+const express = require("express");
+const AuthVerify = require("auth-verify");
+const app = express();
+
+const auth = new AuthVerify({ jwtSecret: "supersecret" });
+
+// Protect route
+app.get("/dashboard", auth.jwt.protect(), (req, res) => {
+  // req.user contains decoded JWT payload
+  res.json({ message: `Welcome, ${req.user.userId}` });
+});
+
+app.listen(3000, () => console.log("Server running on port 3000"));
+```
+
+##### Custom Cookie & Header
+```js
+app.get("/profile", auth.jwt.protect({
+  cookieName: "myToken",
+  headerName: "x-access-token"
+}), (req, res) => {
+  res.json({ user: req.user });
+});
+```
+  - JWT will be read from the cookie named `"myToken"` or from the header `"x-access-token"`.
+
+#### Role-based Guard
+```js
+app.get("/admin", auth.jwt.protect({
+  requiredRole: "admin"
+}), (req, res) => {
+  res.json({ message: "Welcome Admin" });
+});
+``` 
+  - Throws error if decoded token does not have role: `"admin"`.
+
+#### Custom Token Extractor
+```js
+app.get("/custom", auth.jwt.protect({
+  extractor: (req) => req.query.token
+}), (req, res) => {
+  res.json({ user: req.user });
+});
+```
+  - Allows you to read token from any custom location (e.g., query params).
+
+#### Custom Error Handler
+```js
+app.get("/custom-error", auth.jwt.protect({
+  onError: (err, req, res) => {
+    res.status(403).json({ error: "Access denied", details: err.message });
+  }
+}), (req, res) => {
+  res.json({ user: req.user });
+});
+```
+  - Overrides default `401` response with custom logic.
+
 ### JWA Handling (v1.3.0+) 
 
 You can choose json web algorithm for signing jwt
@@ -144,8 +250,26 @@ auth.otp.setSender({
 auth.otp.setSender({
   via: 'sms',
   provider: 'infobip',
-  apiKey: 'xxx',
-  apiSecret: 'yyy',
+  apiKey: 'API_KEY',
+  apiSecret: 'API_SECRET',
+  sender: 'SENDER_NAME',
+  mock: true // in dev prints message instead of sending
+});
+
+auth.otp.setSender({
+  via: 'sms',
+  provider: 'twilio',
+  apiKey: 'ACCOUNT_SID',
+  apiSecret: 'AUTH_TOKEN',
+  sender: 'SENDER_NAME',
+  mock: true // in dev prints message instead of sending
+});
+
+auth.otp.setSender({
+  via: 'sms',
+  provider: 'vonage',
+  apiKey: 'API_KEY',
+  apiSecret: 'API_SECRET',
   sender: 'SENDER_NAME',
   mock: true // in dev prints message instead of sending
 });
@@ -175,7 +299,20 @@ auth.otp.generate(6).set('user@example.com', (err) => {
     else console.log('sent', info && info.messageId);
   });
 });
+
+// Sending OTP with SMS
+auth.otp.generate(6).set('+1234567890', (err) => {
+  if (err) throw err;
+  auth.otp.message({
+    to: '+1234567890',
+    text: `Your code: <b>${auth.otp.code}</b>`
+  }, (err, info) => {
+    if (err) console.error('send error', err);
+    else console.log('sent', info && info.messageId);
+  });
+});
 ```
+`+1234567890` is reciever number
 
 Async/await style:
 
@@ -218,7 +355,7 @@ auth.otp.verify({ check: 'user@example.com', code: '123456' }, (err, isValid)=>{
 
 ---
 
-## ✅ TOTP (Time-based One Time Passwords) — Google Authenticator support (New in v1.4.0)
+## ✅ TOTP (Time-based One Time Passwords) — Google Authenticator support (v1.4.0+)
 ```js
 const AuthVerify = require("auth-verify");
 const auth = new AuthVerify();
@@ -521,11 +658,12 @@ auth-verify/
 │  ├─ /session/index.js
 |  ├─ /oauth/index.js
 │  └─ helpers/helper.js
-├─ test/
+├─ tests/
 │  ├─ jwa.test.js
 │  ├─ jwtmanager.multitab.test.js
 │  ├─ jwtmanager.test.js
 │  ├─ otpmanager.test.js
+│  ├─ oauth.test.js
 │  ├─ totpmanager.test.js
 ├─ babel.config.js
 ```

package/src/jwt/index.js

@@ -391,6 +391,76 @@ class JWTManager {
             await this.redis.set(token, JSON.stringify(data));
         }
     }
+
+    // JWT middleware part
+    readCookie(req, name) {
+        const cookieHeader = req.headers.cookie;
+        if (!cookieHeader) return null;
+
+        const cookies = cookieHeader.split(';').map(v => v.trim());
+        for (const c of cookies) {
+            const [key, val] = c.split('=');
+            if (key === name) return val;
+        }
+        return null;
+    }
+
+    protect(options = {}) {
+        // customizable messages / behavior
+        const {
+            onError,
+            attachProperty = "user",   // where to put decoded data on req
+            requiredRole = null,        // optional: role check
+            cookieName = this.cookieName,
+            headerName = "authorization",
+            extractor = null
+        } = options;
+
+        return async (req, res, next) => {
+            try {
+                // read token (cookie → header)
+                let token = null;
+
+                if (extractor && typeof extractor === "function") {
+                    token = extractor(req);
+                }
+
+                if(!token && req.headers[headerName]){
+                    if(headerName == "authorization"){
+                        token = req.headers.authorization.split(" ")[1];
+                    }else{
+                        token = req.headers[headerName]; // custom header — return raw
+                    }
+                }
+
+                if (!token) {
+                    token = this.readCookie(req, cookieName);
+                }
+
+                if (!token) throw new Error("NO_TOKEN");
+
+                const decoded = await this.verify(token);
+
+                // role guard?
+                if (requiredRole && decoded.role !== requiredRole) {
+                    throw new Error("ROLE_NOT_ALLOWED");
+                }
+
+                // attach user
+                req[attachProperty] = decoded;
+
+                next();
+            } catch (err) {
+                if (onError) return onError(err, req, res);
+
+                return res.status(401).json({
+                    success: false,
+                    error: err.message
+                });
+            }
+        };
+    }
+
 }
 
 module.exports = JWTManager;

package/src/oauth/index.js

@@ -235,6 +235,184 @@ class OAuthManager {
         };
     }
 
+      // --- APPLE LOGIN ---
+    apple({ clientId, clientSecret, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://appleid.apple.com/auth/authorize?" +
+                    new URLSearchParams({
+                        response_type: "code",
+                        client_id: clientId,
+                        redirect_uri: redirectUri,
+                        scope: "name email",
+                        response_mode: "form_post",
+                    });
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                const tokenRes = await fetch("https://appleid.apple.com/auth/token", {
+                    method: "POST",
+                    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+                    body: new URLSearchParams({
+                        grant_type: "authorization_code",
+                        code,
+                        client_id: clientId,
+                        client_secret: clientSecret,
+                        redirect_uri: redirectUri,
+                    }),
+                });
+                const tokenData = await tokenRes.json();
+                if (tokenData.error) throw new Error("OAuth Error: " + tokenData.error);
+                return tokenData;
+            },
+        };
+    }
+
+    // --- DISCORD LOGIN ---
+    discord({ clientId, clientSecret, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://discord.com/api/oauth2/authorize?" +
+                    new URLSearchParams({
+                        client_id: clientId,
+                        redirect_uri: redirectUri,
+                        response_type: "code",
+                        scope: "identify email",
+                    });
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                const tokenRes = await fetch("https://discord.com/api/oauth2/token", {
+                    method: "POST",
+                    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+                    body: new URLSearchParams({
+                        client_id: clientId,
+                        client_secret: clientSecret,
+                        code,
+                        grant_type: "authorization_code",
+                        redirect_uri: redirectUri,
+                    }),
+                });
+                const tokenData = await tokenRes.json();
+                if (tokenData.error) throw new Error("OAuth Error: " + tokenData.error);
+                const userRes = await fetch("https://discord.com/api/users/@me", {
+                    headers: { Authorization: `Bearer ${tokenData.access_token}` },
+                });
+                const user = await userRes.json();
+                return { ...user, access_token: tokenData.access_token };
+            },
+        };
+    }
+
+    // --- SLACK LOGIN ---
+    slack({ clientId, clientSecret, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://slack.com/oauth/v2/authorize?" +
+                    new URLSearchParams({
+                        client_id: clientId,
+                        redirect_uri: redirectUri,
+                        scope: "identity.basic identity.email",
+                    });
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                const tokenRes = await fetch("https://slack.com/api/oauth.v2.access?" +
+                    new URLSearchParams({
+                        client_id: clientId,
+                        client_secret: clientSecret,
+                        code,
+                        redirect_uri: redirectUri,
+                    }));
+                const tokenData = await tokenRes.json();
+                if (!tokenData.ok) throw new Error("OAuth Error: " + tokenData.error);
+                return { ...tokenData, access_token: tokenData.access_token };
+            },
+        };
+    }
+
+    // --- MICROSOFT LOGIN ---
+    microsoft({ clientId, clientSecret, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?" +
+                    new URLSearchParams({
+                        client_id: clientId,
+                        redirect_uri: redirectUri,
+                        response_type: "code",
+                        scope: "User.Read",
+                    });
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                const tokenRes = await fetch("https://login.microsoftonline.com/common/oauth2/v2.0/token", {
+                    method: "POST",
+                    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+                    body: new URLSearchParams({
+                        client_id: clientId,
+                        client_secret: clientSecret,
+                        code,
+                        redirect_uri: redirectUri,
+                        grant_type: "authorization_code",
+                    }),
+                });
+                const tokenData = await tokenRes.json();
+                if (tokenData.error) throw new Error("OAuth Error: " + tokenData.error);
+                return tokenData;
+            },
+        };
+    }
+
+    // --- TELEGRAM LOGIN ---
+    telegram({ botId, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://t.me/" + botId + "?start=auth&redirect_uri=" + encodeURIComponent(redirectUri);
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                // Telegram uses bot login; typically handled via deep links
+                return { code, message: "Telegram login uses deep link auth" };
+            },
+        };
+    }
+
+    // --- WHATSAPP LOGIN ---
+    whatsapp({ phoneNumberId, redirectUri }) {
+        return {
+            redirect: (res) => {
+                const url =
+                    "https://api.whatsapp.com/send?" +
+                    new URLSearchParams({
+                        phone: phoneNumberId,
+                        text: "Please authorize: " + redirectUri,
+                    });
+                res.redirect(url);
+            },
+            callback: async (code) => {
+                // WhatsApp login usually handled via QR / deep link
+                return { code, message: "WhatsApp login uses QR/deep link auth" };
+            },
+        };
+    }
+
+    // --- CUSTOM PROVIDER ---
+    register(name, fn) {
+        if (!name || typeof fn !== "function") throw new Error("Provider registration requires a name and function");
+        this.providers[name] = fn;
+    }
+
+    use(name, options) {
+        const provider = this.providers[name];
+        if (!provider) throw new Error(`Provider "${name}" not found`);
+        return provider(options);
+    }
+
 }
 
 module.exports = OAuthManager;

package/tests/jwt.middleware.test.js

@@ -0,0 +1,89 @@
+const request = require("supertest");
+const express = require("express");
+const AuthVerify = require("../index"); // path to your AuthVerify file
+
+describe("AuthVerify protect() with custom options", () => {
+  let app;
+  let auth;
+
+  beforeEach(() => {
+    auth = new AuthVerify({ jwtSecret: "test_secret" });
+
+    app = express();
+
+    // route that signs a token + sets cookie
+    app.get("/login", async (req, res) => {
+      const token = await auth.jwt.sign({ id: 123 }, "30m", { res });
+      res.json({ token });
+    });
+
+    // standard protected route
+    app.get("/profile", auth.jwt.protect(), (req, res) => {
+      res.json({ ok: true, user: req.user });
+    });
+
+    // route with custom cookie
+    app.get(
+      "/cookie",
+      auth.jwt.protect({ cookieName: "my_cookie" }),
+      (req, res) => {
+        res.json({ ok: true, user: req.user });
+      }
+    );
+
+    // route with custom header
+    app.get(
+      "/header",
+      auth.jwt.protect({ headerName: "x-access-token" }),
+      (req, res) => {
+        res.json({ ok: true, user: req.user });
+      }
+    );
+
+    // route with custom extractor
+    app.get(
+      "/query",
+      auth.jwt.protect({
+        extractor: (req) => req.query.token
+      }),
+      (req, res) => {
+        res.json({ ok: true, user: req.user });
+      }
+    );
+  });
+
+  test("custom cookie name works", async () => {
+    const token = await auth.jwt.sign({ id: 555 });
+    const res = await request(app)
+      .get("/cookie")
+      .set("Cookie", `my_cookie=${token}`);
+    expect(res.status).toBe(200);
+    expect(res.body.user.id).toBe(555);
+  });
+
+  test("custom header name works", async () => {
+    const token = await auth.jwt.sign({ id: 777 });
+    const res = await request(app)
+      .get("/header")
+      .set("x-access-token", token);
+    expect(res.status).toBe(200);
+    expect(res.body.user.id).toBe(777);
+  });
+
+  test("custom extractor works (query param)", async () => {
+    const token = await auth.jwt.sign({ id: 999 });
+    const res = await request(app)
+      .get(`/query?token=${token}`);
+    expect(res.status).toBe(200);
+    expect(res.body.user.id).toBe(999);
+  });
+
+  test("default fallback still works", async () => {
+    const token = await auth.jwt.sign({ id: 123 });
+    const res = await request(app)
+      .get("/profile")
+      .set("Authorization", `Bearer ${token}`);
+    expect(res.status).toBe(200);
+    expect(res.body.user.id).toBe(123);
+  });
+});

package/tests/oauth.test.js

@@ -0,0 +1,77 @@
+// __tests__/authVerify.oauth.direct.test.js
+const AuthVerify = require("../index"); // your wrapper
+
+describe("AuthVerify OAuth - Direct Provider Tests", () => {
+    let auth;
+    let res;
+
+    beforeEach(() => {
+        auth = new AuthVerify();
+        res = { redirect: jest.fn() }; // mock Express response
+    });
+
+    beforeAll(() => {
+        global.fetch = jest.fn(); // mock fetch
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    test("Apple redirect and callback", async () => {
+        const apple = auth.oauth.apple({
+            clientId: "apple_id",
+            clientSecret: "apple_secret",
+            redirectUri: "http://localhost/callback",
+        });
+
+        apple.redirect(res);
+        expect(res.redirect).toHaveBeenCalled();
+        expect(res.redirect.mock.calls[0][0]).toContain("https://appleid.apple.com/auth/authorize");
+
+        global.fetch.mockResolvedValueOnce({ json: async () => ({ access_token: "apple_token" }) });
+        const tokenData = await apple.callback("code123");
+        expect(tokenData.access_token).toBe("apple_token");
+    });
+
+    test("Discord redirect and callback", async () => {
+        const discord = auth.oauth.discord({
+            clientId: "discord_id",
+            clientSecret: "discord_secret",
+            redirectUri: "http://localhost/callback",
+        });
+
+        discord.redirect(res);
+        expect(res.redirect).toHaveBeenCalled();
+
+        global.fetch
+            .mockResolvedValueOnce({ json: async () => ({ access_token: "discord_token" }) })
+            .mockResolvedValueOnce({ json: async () => ({ id: "discord_123", username: "user" }) });
+
+        const userData = await discord.callback("code123");
+        expect(userData.access_token).toBe("discord_token");
+        expect(userData.id).toBe("discord_123");
+    });
+
+    test("Telegram callback returns message", async () => {
+        const telegram = auth.oauth.telegram({ botId: "bot123", redirectUri: "http://localhost/callback" });
+        const tResult = await telegram.callback("code123");
+        expect(tResult.message).toContain("Telegram login");
+    });
+
+    test("WhatsApp callback returns message", async () => {
+        const whatsapp = auth.oauth.whatsapp({ phoneNumberId: "12345", redirectUri: "http://localhost/callback" });
+        const wResult = await whatsapp.callback("code456");
+        expect(wResult.message).toContain("WhatsApp login");
+    });
+
+    test("Slack and Microsoft redirect URLs", () => {
+        const slack = auth.oauth.slack({ clientId: "slack_id", redirectUri: "http://localhost/callback" });
+        slack.redirect(res);
+        expect(res.redirect).toHaveBeenCalled();
+
+        const ms = auth.oauth.microsoft({ clientId: "ms_id", redirectUri: "http://localhost/callback" });
+        ms.redirect(res);
+        expect(res.redirect).toHaveBeenCalledTimes(2);
+    });
+});