@divine-lab/request 1.1.1 → 1.2.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/dist/fastify-helpers/index.js +3 -1
- package/package.json +1 -1
- package/readme.md +5 -2
|
@@ -13,6 +13,8 @@ const APIError_1 = require("../errors/APIError");
|
|
|
13
13
|
const logger_1 = __importDefault(require("@divine-lab/logger"));
|
|
14
14
|
const API_LOG = process.env.DIVINE_LAB_REQUEST_API_LOG === "true";
|
|
15
15
|
logger_1.default.raw(`${(0, colors_1.colorize)("blue", "[API]")} - API logging is ${API_LOG ? (0, colors_1.colorize)("green", "enabled") : (0, colors_1.colorize)("red", "disabled")} - ${API_LOG ? "API requests and responses will be logged." : `to enable, set ${(0, colors_1.colorize)("yellow", "DIVINE_LAB_REQUEST_API_LOG")}=true in environment variables`}`);
|
|
16
|
+
const INSTANCE_BASE = process.env.DIVINE_LAB_REQUEST_INSTANCE_BASE || "";
|
|
17
|
+
logger_1.default.raw(`${(0, colors_1.colorize)("blue", "[API]")} - API instance base path is set to ${(0, colors_1.colorize)("yellow", INSTANCE_BASE)}. Configure this with the ${(0, colors_1.colorize)("yellow", "DIVINE_LAB_REQUEST_INSTANCE_BASE")} environment variable.`);
|
|
16
18
|
/** Sends a standardized error response.
|
|
17
19
|
* Uses the RFC 9457 Format.
|
|
18
20
|
* @param res - Fastify reply object
|
|
@@ -30,7 +32,7 @@ function errorResponse(res, error, { title, detail, type, data, status } = {}) {
|
|
|
30
32
|
logger_1.default.raw(`${new Date().toISOString()} ${(0, colors_1.colorize)("red", "[API]")} - ${(0, colors_1.colorize)("gray", res.request.ip)} - ${(0, colors_1.colorize)("red", (status || errorDef.status))} - ${res.request.url} : ${(0, colors_1.colorize)("gray", `${title || errorDef.title} - ${detail || errorDef.detail}`)}`);
|
|
31
33
|
res.code(status || errorDef.status).send({
|
|
32
34
|
status: status || errorDef.status,
|
|
33
|
-
instance: res.request.url
|
|
35
|
+
instance: `${INSTANCE_BASE}${res.request.url}`,
|
|
34
36
|
title: title || errorDef.title,
|
|
35
37
|
detail: detail || errorDef.detail,
|
|
36
38
|
type: type || errorDef.type,
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -110,13 +110,16 @@ Additionally if a `400 Bad request` is made, then this handler should handle it
|
|
|
110
110
|
|
|
111
111
|
### Environment Variables
|
|
112
112
|
|
|
113
|
-
Supports API response logging via <a>`@divine-lab/logger`</a>.
|
|
114
|
-
Enable by setting ENV Variable `DIVINE_LAB_REQUEST_API_LOG` to `true`.
|
|
113
|
+
- Supports API response logging via <a>`@divine-lab/logger`</a>.
|
|
114
|
+
Enable by setting ENV Variable `DIVINE_LAB_REQUEST_API_LOG` to `true`.
|
|
115
|
+
- Supports base path for `instance` property of error responses via `DIVINE_LAB_REQUEST_INSTANCE_BASE`,
|
|
116
|
+
Defaults to empty string.
|
|
115
117
|
|
|
116
118
|
#### Updates:
|
|
117
119
|
|
|
118
120
|
- 1.1.0: added rate limit error response in backend errors and handling it in global error handler (when using `@fastify/rate-limit`)
|
|
119
121
|
- 1.1.1: fixed data response for the rate-limit in global error handler for fastify.
|
|
122
|
+
- 1.2.0: added support for instance base path in error responses via environment variable.
|
|
120
123
|
|
|
121
124
|
#### Contact:
|
|
122
125
|
|