Merge pull request #73 from bouwe77/headers-in-requestInterceptor

Add headers to `requestInterceptor` callbacks

README.md

@@ -265,19 +265,19 @@ It allows you to implement your own validation, or even change the request body.
 ```js
 const config = {
   requestInterceptor: {
-    get: ({ resource, id }) => {
+    get: ({ headers, resource, id }) => {
       //...
     },
-    post: ({ resource, body }) => {
+    post: ({ headers, resource, body }) => {
       // Validate, or even change the request body
     },
-    put: ({ resource, id, body }) => {
+    put: ({ headers, resource, id, body }) => {
       // Validate, or even change the request body
     },
-    patch: ({ resource, id, body }) => {
+    patch: ({ headers, resource, id, body }) => {
       // Validate, or even change the request body
     },
-    delete: ({ resource, id }) => {
+    delete: ({ headers, resource, id }) => {
       //...
     },
   },
@@ -288,7 +288,9 @@ const server = create(config)
 
 The `requestInterceptor` is an object with fields for each of the HTTP methods you might want to intercept, and the callback function you want Temba to call, before processing the request, i.e. going to the database.
 
-Each callback function receives an object containing the `resource` (e.g. `"movies"`). Depending on the HTTP method, also the `id` from the URL, and the request `body` are provided. `body` is a JSON object of the request body.
+Each callback function receives an object containing the request headers and the `resource` (e.g. `"movies"`). Depending on the HTTP method, also the `id` from the URL, and the request `body` are provided. `body` is a JSON object of the request body.
+
+> Request headers are not used by Temba internally when processing requests, so they are only passed into the `requestInterceptor` callback so you can do your own custom header validation.
 
 Your callback function can return the following things:
 
@@ -301,7 +303,7 @@ Example:
 ```js
 const config = {
   requestInterceptor: {
-    post: ({ resource, body }) => {      
+    post: ({ headers, resource, body }) => {      
       // Add a genre to Star Trek films:
       if (resource === 'movies' && body.title.startsWith('Star Trek'))
         return { ...body, genre: 'Science Fiction' }
@@ -457,19 +459,19 @@ const config = {
   etags: true,
   port: 4321,
   requestInterceptor: {
-    get: ({ resource, id }) => {
+    get: ({ headers, resource, id }) => {
       //...
     },
-    post: ({ resource, body }) => {
+    post: ({ headers, resource, body }) => {
       // Validate, or even change the request body
     },
-    put: ({ resource, id, body }) => {
+    put: ({ headers, resource, id, body }) => {
       // Validate, or even change the request body
     },
-    patch: ({ resource, id, body }) => {
+    patch: ({ headers, resource, id, body }) => {
       // Validate, or even change the request body
     },
-    delete: ({ resource, id }) => {
+    delete: ({ headers, resource, id }) => {
       //...
     },
   },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "temba",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Get a simple REST API with zero coding in less than 30 seconds (seriously).",
   "type": "module",
   "main": "dist/src/index.js",

src/requestHandlers/delete.ts

@@ -13,11 +13,11 @@ export const createDeleteRoutes = (
 ) => {
   const handleDelete = async (req: DeleteRequest) => {
     try {
-      const { resource, id } = req
+      const { headers, resource, id } = req
 
       if (requestInterceptor?.delete) {
         try {
-          interceptDeleteRequest(requestInterceptor.delete, resource, id)
+          interceptDeleteRequest(requestInterceptor.delete, headers, resource, id)
         } catch (error: unknown) {
           return {
             status: error instanceof TembaError ? error.statusCode : 500,

src/requestHandlers/get.ts

@@ -17,11 +17,11 @@ export const createGetRoutes = (
 
   const handleGet = async (req: GetRequest) => {
     try {
-      const { resource, id } = req
+      const { headers, resource, id } = req
 
       if (!req.isHeadRequest && requestInterceptor?.get) {
         try {
-          interceptGetRequest(requestInterceptor.get, resource, id)
+          interceptGetRequest(requestInterceptor.get, headers, resource, id)
         } catch (error: unknown) {
           return {
             status: error instanceof TembaError ? error.statusCode : 500,

src/requestHandlers/patch.ts

@@ -17,7 +17,7 @@ export const createPatchRoutes = (
 ) => {
   const handlePatch = async (req: PatchRequest) => {
     try {
-      const { body, resource, id } = req
+      const { headers, body, resource, id } = req
 
       const validationResult = validate(body, schemas?.[resource])
       if (validationResult.isValid === false) {
@@ -27,7 +27,7 @@ export const createPatchRoutes = (
       let body2 = body
       if (requestInterceptor?.patch) {
         try {
-          body2 = interceptPatchRequest(requestInterceptor.patch, resource, id, body)
+          body2 = interceptPatchRequest(requestInterceptor.patch, headers, resource, id, body)
         } catch (error: unknown) {
           return {
             status: error instanceof TembaError ? error.statusCode : 500,

src/requestHandlers/post.ts

@@ -16,7 +16,7 @@ export const createPostRoutes = (
 ) => {
   const handlePost = async (req: PostRequest) => {
     try {
-      const { body, protocol, host, resource } = req
+      const { headers, body, protocol, host, resource } = req
 
       const validationResult = validate(body, schemas[resource])
       if (validationResult.isValid === false) {
@@ -26,7 +26,7 @@ export const createPostRoutes = (
       let body2 = body
       if (requestInterceptor?.post) {
         try {
-          body2 = interceptPostRequest(requestInterceptor.post, resource, body)
+          body2 = interceptPostRequest(requestInterceptor.post, headers, resource, body)
         } catch (error: unknown) {
           return {
             status: error instanceof TembaError ? error.statusCode : 500,

src/requestHandlers/put.ts

@@ -17,7 +17,7 @@ export const createPutRoutes = (
 ) => {
   const handlePut = async (req: PutRequest) => {
     try {
-      const { body, resource, id } = req
+      const { headers, body, resource, id } = req
 
       const validationResult = validate(body, schemas?.[resource])
       if (validationResult.isValid === false) {
@@ -27,7 +27,7 @@ export const createPutRoutes = (
       let body2 = body
       if (requestInterceptor?.put) {
         try {
-          body2 = interceptPutRequest(requestInterceptor.put, resource, id, body)
+          body2 = interceptPutRequest(requestInterceptor.put, headers, resource, id, body)
         } catch (error: unknown) {
           return {
             status: error instanceof TembaError ? error.statusCode : 500,

src/requestHandlers/types.ts

@@ -1,3 +1,5 @@
+import type { IncomingHttpHeaders } from 'http'
+
 export type UrlInfo = {
   resource: string | null
   id: string | null
@@ -10,6 +12,7 @@ export type RequestInfo = {
   host: string | null
   protocol: string | null
   method: string
+  headers: IncomingHttpHeaders
   etag: string | null
 }
 
@@ -19,6 +22,7 @@ export type ErrorResponse = {
 }
 
 export type TembaRequest = {
+  headers: IncomingHttpHeaders
   resource: string
 }
 

src/requestInterceptor/interceptRequest.ts

@@ -1,3 +1,5 @@
+import type { IncomingHttpHeaders } from 'http'
+
 import type {
   InterceptedDeleteRequest,
   InterceptedGetRequest,
@@ -8,39 +10,43 @@ import type {
 
 export const interceptGetRequest = (
   intercept: InterceptedGetRequest,
+  headers: IncomingHttpHeaders,
   resource: string,
   id: string | null,
 ) => {
-  intercept({ resource, id })
+  intercept({ headers, resource, id })
 }
 
 export const interceptPostRequest = (
   intercept: InterceptedPostRequest,
+  headers: IncomingHttpHeaders,
   resource: string,
   body: unknown,
 ) => {
-  const intercepted = intercept({ resource, body })
+  const intercepted = intercept({ headers, resource, body })
   return interceptRequest(intercepted, body)
 }
 
 export const interceptPutRequest = (
   intercept: InterceptedPutRequest,
+  headers: IncomingHttpHeaders,
   resource: string,
   id: string,
   body: unknown,
 ) => {
-  const intercepted = intercept({ resource, id, body })
+  const intercepted = intercept({ headers, resource, id, body })
   return interceptRequest(intercepted, body)
 }
 
 export const interceptPatchRequest = interceptPutRequest
 
 export const interceptDeleteRequest = (
   intercept: InterceptedDeleteRequest,
+  headers: IncomingHttpHeaders,
   resource: string,
   id: string | null,
 ) => {
-  intercept({ resource, id })
+  intercept({ headers, resource, id })
 }
 
 const interceptRequest = (intercepted: InterceptedReturnValue, body: unknown) => {

src/requestInterceptor/types.ts

@@ -1,4 +1,7 @@
+import type { IncomingHttpHeaders } from 'http'
+
 type InterceptedResource = {
+  headers: IncomingHttpHeaders
   resource: string
 }
 

src/resourceRouter.ts

@@ -46,6 +46,7 @@ const validateIdInRequestBodyNotAllowed = (requestInfo: RequestInfo) => {
 
 const convertToGetRequest = (requestInfo: RequestInfo) => {
   return {
+    headers: requestInfo.headers,
     id: requestInfo.id,
     resource: requestInfo.resource,
     isHeadRequest: requestInfo.method.toUpperCase() === 'HEAD',
@@ -54,6 +55,7 @@ const convertToGetRequest = (requestInfo: RequestInfo) => {
 
 const convertToPostRequest = (requestInfo: RequestInfo) => {
   return {
+    headers: requestInfo.headers,
     resource: requestInfo.resource,
     body: requestInfo.body ?? {},
     protocol: requestInfo.protocol,
@@ -63,6 +65,7 @@ const convertToPostRequest = (requestInfo: RequestInfo) => {
 
 const convertToPutRequest = (requestInfo: RequestInfo) => {
   return {
+    headers: requestInfo.headers,
     id: requestInfo.id!,
     resource: requestInfo.resource,
     body: requestInfo.body ?? {},
@@ -74,6 +77,7 @@ const convertToPatchRequest = convertToPutRequest
 
 const convertToDeleteRequest = (requestInfo: RequestInfo) => {
   return {
+    headers: requestInfo.headers,
     id: requestInfo.id,
     resource: requestInfo.resource,
     etag: requestInfo.etag ?? null,
@@ -108,6 +112,7 @@ export const createResourceRouter = (
       host,
       protocol,
       method: req.method,
+      headers: req.headers,
       etag,
     } satisfies RequestInfo
   }