@naturalcycles/backend-lib 9.42.4 → 9.43.0

package/dist/express/createDefaultApp.js

@@ -33,6 +33,10 @@ export async function createDefaultApp(cfg) {
     // accepts application/json
     app.use(express.json({
         limit: '1mb',
+        verify(req, _res, buf) {
+            // Store the raw Buffer body
+            req.rawBody = buf;
+        },
         ...cfg.bodyParserJsonOptions,
     }));
     app.use(express.urlencoded({
@@ -44,6 +48,10 @@ export async function createDefaultApp(cfg) {
     app.use(express.raw({
         // inflate: true, // default is `true`
         limit: '1mb',
+        verify(req, _res, buf) {
+            // Store the raw Buffer body
+            req.rawBody = buf;
+        },
         ...cfg.bodyParserRawOptions,
     }));
     app.use(cookieParser());

package/dist/server/server.model.d.ts

@@ -18,6 +18,15 @@ export interface BackendRequest extends Request {
      * Only used for request logging purposes.
      */
     userId?: string;
+    /**
+     * Raw Buffer of the `req.body`, before it's stringified and json-parsed.
+     * Useful for when something mutates `req.body` json (e.g j validation), and you
+     * want access to the original input.
+     *
+     * For `req.rawBody` to exist - you need to use `createDefaultApp`, or use the
+     * `verify` option of the json parser (copy-paste it from `createDefaultApp`).
+     */
+    rawBody?: Buffer;
     /**
      * Set by requestTimeoutMiddleware.
      * Can be used to cancel/override the timeout.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.42.4",
+  "version": "9.43.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },

package/src/express/createDefaultApp.ts

@@ -10,7 +10,11 @@ import { logMiddleware } from '../server/logMiddleware.js'
 import { methodOverrideMiddleware } from '../server/methodOverrideMiddleware.js'
 import { notFoundMiddleware } from '../server/notFoundMiddleware.js'
 import { requestTimeoutMiddleware } from '../server/requestTimeoutMiddleware.js'
-import type { BackendApplication, BackendRequestHandler } from '../server/server.model.js'
+import type {
+  BackendApplication,
+  BackendRequest,
+  BackendRequestHandler,
+} from '../server/server.model.js'
 import { simpleRequestLoggerMiddleware } from '../server/simpleRequestLoggerMiddleware.js'
 
 const isTest = process.env['APP_ENV'] === 'test'
@@ -53,6 +57,10 @@ export async function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendAppli
   app.use(
     express.json({
       limit: '1mb',
+      verify(req: BackendRequest, _res, buf) {
+        // Store the raw Buffer body
+        req.rawBody = buf
+      },
       ...cfg.bodyParserJsonOptions,
     }),
   )
@@ -70,6 +78,10 @@ export async function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendAppli
     express.raw({
       // inflate: true, // default is `true`
       limit: '1mb',
+      verify(req: BackendRequest, _res, buf) {
+        // Store the raw Buffer body
+        req.rawBody = buf
+      },
       ...cfg.bodyParserRawOptions,
     }),
   )

package/src/server/server.model.ts

@@ -20,6 +20,15 @@ export interface BackendRequest extends Request {
    * Only used for request logging purposes.
    */
   userId?: string
+  /**
+   * Raw Buffer of the `req.body`, before it's stringified and json-parsed.
+   * Useful for when something mutates `req.body` json (e.g j validation), and you
+   * want access to the original input.
+   *
+   * For `req.rawBody` to exist - you need to use `createDefaultApp`, or use the
+   * `verify` option of the json parser (copy-paste it from `createDefaultApp`).
+   */
+  rawBody?: Buffer
 
   /**
    * Set by requestTimeoutMiddleware.