Directus raw body extension

Simple Directus extension that sets the serialized request body in the express request object.

Installation / Configuration guide

In your Directus project directory run:

1npm install @significa/directus-extension-raw-body

Create an environment variable RAW_BODY_ENDPOINT_PATTERN with a Regex Expression matching the endpoints/routes where rawBody will be added to the request object.

Examples:

1# Matches all endpoints for a specific extension
2RAW_BODY_ENDPOINT_PATTERN='^\/sample-extension\/.*$'
3
4# Matches all endpoints (avoid: you should only set rawBody for custom endpoints)
5RAW_BODY_ENDPOINT_PATTERN='^.*$'
6
7# Matches two routes /hello-world and /sample/path
8RAW_BODY_ENDPOINT_PATTERN='^(\/hello-world|\/sample\/path)$'
9
10# Matches routes with variable input in path. Ex:
11#  - /sample/cats/fifi
12#  - /sample/cats/bob1
13#  - /sample/aaaa/info
14#  - /sample/bbbb/info
15RAW_BODY_ENDPOINT_PATTERN='^(\/sample\/cats\/\D+|\/sample\/[a-z]+\/info)$'

Restart Directus for the changes to take effect.

Usage

Create a directus endpoint extension:

• JS

  1export default (router, _) => {
  2  router.post(
  3    '/sample',
  4    async (req, res, _next) => {
  5    console.log('Raw body:', req.rawBody)
  6
  7     return res.json({
  8       status: 'OK',
  9       rawBody: req.rawBody,
  10     })
  11  }
  12)

• TS

  1import { NextFunction, Request, Response, Router, } from 'express'
  2import { ApiExtensionContext } from '@directus/shared/types'
  3import { RequestWithRawBody } from "@significa/directus-extension-raw-body";
  4
  5export default (router, extensionContext: ApiExtensionContext) => {
  6  router.post(
  7    '/sample',
  8    async (req: RequestWithRawBody, res: Response, _next: NextFunction) => {
  9      console.log('Raw body:', req.rawBody)
  10
  11      return res.json({
  12        status: 'OK',
  13        rawBody: req.rawBody,
  14      })
  15    }
  16  )
  17})