reqforge 0.4.0 → 0.6.0
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 +24 -6
- package/package.json +1 -1
- package/src/auth.js +66 -0
- package/src/index.js +5 -1
- package/src/logger.js +51 -0
- package/src/request.js +4 -0
package/README.md
CHANGED
|
@@ -11,23 +11,32 @@ npm install reqforge
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
13
|
```javascript
|
|
14
|
-
const { config, utils, request } = require('reqforge');
|
|
14
|
+
const { config, utils, request, Logger, auth } = require('reqforge');
|
|
15
15
|
|
|
16
16
|
// Get the base URL for API requests
|
|
17
17
|
const baseURL = config.getBaseURL();
|
|
18
18
|
console.log(baseURL); // https://api.example.com/v1
|
|
19
19
|
|
|
20
|
+
// Login
|
|
21
|
+
auth.login('username', 'password')
|
|
22
|
+
.then(data => console.log('Logged in:', data.token));
|
|
23
|
+
|
|
20
24
|
// Make a GET request
|
|
21
25
|
request.get('/users')
|
|
22
26
|
.then(res => res.json())
|
|
23
27
|
.then(data => console.log(data));
|
|
24
|
-
|
|
25
|
-
// Make a POST request
|
|
26
|
-
request.post('/users', { name: 'John', email: 'john@example.com' })
|
|
27
|
-
.then(res => res.json())
|
|
28
|
-
.then(data => console.log(data));
|
|
29
28
|
```
|
|
30
29
|
|
|
30
|
+
## Authentication
|
|
31
|
+
|
|
32
|
+
The `auth` module provides:
|
|
33
|
+
|
|
34
|
+
- `login(username, password)` - Login and store token
|
|
35
|
+
- `logout()` - Logout and clear token
|
|
36
|
+
- `getToken()` - Get current auth token
|
|
37
|
+
- `setToken(token)` - Set auth token manually
|
|
38
|
+
- `isAuthenticated()` - Check if authenticated
|
|
39
|
+
|
|
31
40
|
## Request Methods
|
|
32
41
|
|
|
33
42
|
The `request` module provides:
|
|
@@ -38,6 +47,15 @@ The `request` module provides:
|
|
|
38
47
|
- `put(endpoint, data, options)` - PUT request
|
|
39
48
|
- `del(endpoint, options)` - DELETE request
|
|
40
49
|
|
|
50
|
+
## Logger
|
|
51
|
+
|
|
52
|
+
The `Logger` class provides:
|
|
53
|
+
|
|
54
|
+
- `log(message)` - Log a message
|
|
55
|
+
- `info(message)` - Log an info message
|
|
56
|
+
- `warn(message)` - Log a warning message
|
|
57
|
+
- `error(message)` - Log an error message
|
|
58
|
+
|
|
41
59
|
## Configuration
|
|
42
60
|
|
|
43
61
|
The `config` module provides:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "reqforge",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "A lightweight, flexible HTTP client library with request interception, automatic retry, and logging capabilities, designed for modern web applications.",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"scripts": {
|
package/src/auth.js
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Authentication module for ReqForge
|
|
3
|
+
* @module auth
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
const { sendRequest } = require('./request');
|
|
7
|
+
|
|
8
|
+
let authToken = null;
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Login with username and password
|
|
12
|
+
* @param {string} username - Username
|
|
13
|
+
* @param {string} password - Password
|
|
14
|
+
* @returns {Promise<Object>} Login response with token
|
|
15
|
+
*/
|
|
16
|
+
function login(username, password) {
|
|
17
|
+
return sendRequest('/login', { username, password }, { method: 'POST' })
|
|
18
|
+
.then(response => response.json())
|
|
19
|
+
.then(data => {
|
|
20
|
+
authToken = data.token;
|
|
21
|
+
return data;
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Logout and clear auth token
|
|
27
|
+
* @returns {Promise<void>}
|
|
28
|
+
*/
|
|
29
|
+
function logout() {
|
|
30
|
+
return sendRequest('/logout', {}, { method: 'POST' })
|
|
31
|
+
.then(() => {
|
|
32
|
+
authToken = null;
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Get current auth token
|
|
38
|
+
* @returns {string|null} Current auth token
|
|
39
|
+
*/
|
|
40
|
+
function getToken() {
|
|
41
|
+
return authToken;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Set auth token
|
|
46
|
+
* @param {string} token - Auth token to set
|
|
47
|
+
*/
|
|
48
|
+
function setToken(token) {
|
|
49
|
+
authToken = token;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Check if user is authenticated
|
|
54
|
+
* @returns {boolean} True if authenticated
|
|
55
|
+
*/
|
|
56
|
+
function isAuthenticated() {
|
|
57
|
+
return authToken !== null;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
module.exports = {
|
|
61
|
+
login,
|
|
62
|
+
logout,
|
|
63
|
+
getToken,
|
|
64
|
+
setToken,
|
|
65
|
+
isAuthenticated
|
|
66
|
+
};
|
package/src/index.js
CHANGED
|
@@ -6,9 +6,13 @@
|
|
|
6
6
|
const config = require('./config');
|
|
7
7
|
const utils = require('./utils');
|
|
8
8
|
const request = require('./request');
|
|
9
|
+
const Logger = require('./logger');
|
|
10
|
+
const auth = require('./auth');
|
|
9
11
|
|
|
10
12
|
module.exports = {
|
|
11
13
|
config,
|
|
12
14
|
utils,
|
|
13
|
-
request
|
|
15
|
+
request,
|
|
16
|
+
Logger,
|
|
17
|
+
auth
|
|
14
18
|
};
|
package/src/logger.js
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Logging module for ReqForge
|
|
3
|
+
* @module logger
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Logger class for logging messages with different levels
|
|
8
|
+
*/
|
|
9
|
+
class Logger {
|
|
10
|
+
/**
|
|
11
|
+
* Create a Logger instance
|
|
12
|
+
* @param {string} prefix - Prefix for log messages
|
|
13
|
+
*/
|
|
14
|
+
constructor(prefix = '[ReqForge]') {
|
|
15
|
+
this.prefix = prefix;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Log a message
|
|
20
|
+
* @param {string} message - Message to log
|
|
21
|
+
*/
|
|
22
|
+
log(message) {
|
|
23
|
+
console.log(`${this.prefix} ${message}`);
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Log an info message
|
|
28
|
+
* @param {string} message - Message to log
|
|
29
|
+
*/
|
|
30
|
+
info(message) {
|
|
31
|
+
console.info(`${this.prefix} INFO: ${message}`);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Log a warning message
|
|
36
|
+
* @param {string} message - Message to log
|
|
37
|
+
*/
|
|
38
|
+
warn(message) {
|
|
39
|
+
console.warn(`${this.prefix} WARN: ${message}`);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Log an error message
|
|
44
|
+
* @param {string} message - Message to log
|
|
45
|
+
*/
|
|
46
|
+
error(message) {
|
|
47
|
+
console.error(`${this.prefix} ERROR: ${message}`);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
module.exports = Logger;
|
package/src/request.js
CHANGED
|
@@ -4,6 +4,9 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
const { getBaseURL } = require('./config');
|
|
7
|
+
const Logger = require('./logger');
|
|
8
|
+
|
|
9
|
+
const logger = new Logger();
|
|
7
10
|
|
|
8
11
|
/**
|
|
9
12
|
* Send HTTP request
|
|
@@ -14,6 +17,7 @@ const { getBaseURL } = require('./config');
|
|
|
14
17
|
*/
|
|
15
18
|
function sendRequest(endpoint, data, options = {}) {
|
|
16
19
|
const url = getBaseURL() + endpoint;
|
|
20
|
+
logger.log(`Request: ${options.method || 'GET'} ${url}`);
|
|
17
21
|
|
|
18
22
|
const fetchOptions = {
|
|
19
23
|
method: options.method || 'GET',
|