remult 3.0.6-next.0 → 3.0.6-next.1

package/esm/remult-express.js

@@ -13,7 +13,10 @@ export function remultApi(options) {
         app.use(express.urlencoded({ extended: true, limit: options.bodySizeLimit }));
     }
     const server = createRemultServer(options, {
-        buildGenericRequestInfo: (req) => req,
+        buildGenericRequestInfo: (req) => ({
+            internal: { ...req, on: req.on },
+            public: { headers: new Headers(req.headers) },
+        }),
         getRequestBody: async (req) => req.body,
     });
     server.registerRouter(app);

package/esm/remult-fastify.js

@@ -33,7 +33,15 @@ export function remultApi(options) {
         return response;
     }
     const api = createRemultServer(options, {
-        buildGenericRequestInfo: (req) => req,
+        buildGenericRequestInfo: (req) => ({
+            internal: {
+                ...req,
+                url: req.originalUrl,
+                // @ts-ignore
+                on: req.on,
+            },
+            public: { headers: new Headers(req.headers) },
+        }),
         getRequestBody: async (req) => req.body,
     });
     const pluginFunction = async (instance, op) => {

package/esm/remult-fresh.js

@@ -1,7 +1,11 @@
 import { createRemultServerCore } from './server/remult-api-server.js';
 export function remultApi(options, response) {
     const server = createRemultServerCore(options, {
-        buildGenericRequestInfo: (r) => r,
+        buildGenericRequestInfo: (r) => ({
+            // @ts-ignore
+            internal: { ...r, on: r.on },
+            public: { headers: r.headers },
+        }),
         getRequestBody: (req) => req.json(),
     });
     return {

package/esm/remult-hapi.js

@@ -3,13 +3,14 @@ import { PassThrough } from 'stream';
 export function remultApi(options) {
     const api = createRemultServer(options, {
         buildGenericRequestInfo: (req) => ({
-            method: req.method,
-            params: req.params,
-            query: req.query,
-            url: req.url.pathname,
-            on: (e, do1) => {
-                req.raw.req.on('close', do1);
+            internal: {
+                ...req,
+                url: req.url.pathname,
+                on: (e, do1) => {
+                    req.raw.req.on('close', do1);
+                },
             },
+            public: { headers: new Headers(req.headers) },
         }),
         getRequestBody: async (req) => req.payload,
     });

package/esm/remult-hono.js

@@ -6,22 +6,24 @@ export function remultApi(options) {
     const api = createRemultServer(options, {
         buildGenericRequestInfo: (c) => {
             return {
-                method: c.req.method,
-                params: c.req.param(),
-                query: new Proxy(c.req, {
-                    get: (target, prop) => {
-                        const r = c.req.queries(prop);
-                        if (r?.length == 1)
-                            return r[0];
-                        return r;
+                internal: {
+                    method: c.req.method,
+                    params: c.req.param(),
+                    query: new Proxy(c.req, {
+                        get: (target, prop) => {
+                            const r = c.req.queries(prop);
+                            if (r?.length == 1)
+                                return r[0];
+                            return r;
+                        },
+                    }),
+                    url: c.req.url,
+                    on: (e, do1) => {
+                        ;
+                        c['_tempOnClose'](() => do1());
                     },
-                }),
-                url: c.req.url,
-                on: (e, do1) => {
-                    ;
-                    c['_tempOnClose'](() => do1());
-                    //   c.req.on('close', do1)
                 },
+                public: { headers: new Headers(c.req.header()) },
             };
         },
         getRequestBody: async (c) => {

package/esm/remult-next.js

@@ -1,7 +1,10 @@
 import { createRemultServer } from './server/index.js';
 export function remultNext(options) {
     let result = createRemultServer(options, {
-        buildGenericRequestInfo: (req) => req,
+        buildGenericRequestInfo: (req) => ({
+            internal: { ...req, on: req.on },
+            public: { headers: new Headers(req.headers) },
+        }),
         getRequestBody: async (req) => req.body,
     });
     return Object.assign((req, res) => result.handle(req, res).then(() => { }), result, {
@@ -41,14 +44,17 @@ export function remultApi(options) {
     let result = createRemultServer(options, {
         getRequestBody: (req) => req.json(),
         buildGenericRequestInfo: (req) => ({
-            url: req?.url,
-            method: req?.method,
-            on: (e, do1) => {
-                if (e === 'close') {
-                    ;
-                    req['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: req?.url,
+                method: req?.method,
+                on: (e, do1) => {
+                    if (e === 'close') {
+                        ;
+                        req['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: req.headers },
         }),
     });
     const handler = async (req) => {

package/esm/remult-nuxt.js

@@ -2,15 +2,18 @@ import { readBody, setResponseStatus } from 'h3';
 import { createRemultServer } from './server/index.js';
 export function remultApi(options) {
     const result = createRemultServer(options, {
-        buildGenericRequestInfo: (event) => {
-            return {
+        buildGenericRequestInfo: (event) => ({
+            internal: {
                 method: event.node.req.method,
                 url: event.node.req.url,
                 on: (a, b) => event.node.req.on('close', () => {
                     b();
                 }),
-            };
-        },
+            },
+            public: {
+                headers: new Headers(event.node.req.headers),
+            },
+        }),
         getRequestBody: async (event) => await readBody(event),
     });
     const handler = async (event) => {

package/esm/remult-solid-start.js

@@ -3,13 +3,16 @@ import { createRemultServer } from './server/index.js';
 export function remultApi(options) {
     let result = createRemultServer(options, {
         buildGenericRequestInfo: (event) => ({
-            url: event.request.url,
-            method: event.request.method,
-            on: (e, do1) => {
-                if (e === 'close') {
-                    event.locals['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: event.request.url,
+                method: event.request.method,
+                on: (e, do1) => {
+                    if (e === 'close') {
+                        event.locals['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: new Headers(event.request.headers) },
         }),
         getRequestBody: (event) => event.request.json(),
     });

package/esm/remult-sveltekit.js

@@ -2,14 +2,17 @@ import { createRemultServer } from './server/index.js';
 export function remultApi(options) {
     let result = createRemultServer(options, {
         buildGenericRequestInfo: (event) => ({
-            url: event.request.url,
-            method: event.request.method,
-            on: (e, do1) => {
-                if (e === 'close') {
-                    ;
-                    event.locals['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: event.request.url,
+                method: event.request.method,
+                on: (e, do1) => {
+                    if (e === 'close') {
+                        ;
+                        event.locals['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: event.request.headers },
         }),
         getRequestBody: (event) => event.request.json(),
     });
@@ -65,7 +68,7 @@ export function remultApi(options) {
                 status: responseFromRemultHandler.statusCode,
                 headers: {
                     'Content-Type': 'application/json',
-                }
+                },
             });
             return res;
         }

package/esm/server/index.js

@@ -9,7 +9,10 @@ export { Module } from './module.js';
 export function createRemultServer(options, serverCoreOptions) {
     initAsyncHooks();
     return createRemultServerCore(options, serverCoreOptions || {
-        buildGenericRequestInfo: (req) => cast(req, 'method'),
+        buildGenericRequestInfo: (req) => ({
+            internal: cast(req, 'method'),
+            public: { headers: new Headers(req.headers) },
+        }),
         getRequestBody: async (req) => req.body,
     });
 }

package/esm/server/module.js

@@ -11,8 +11,8 @@ export class Module {
         this.priority = options.priority ?? 0;
         this.entities = options.entities;
         this.controllers = options.controllers;
-        this.initRequest = options.initRequest;
         this.initApi = options.initApi;
+        this.initRequest = options.initRequest;
         this.modules = options.modules;
     }
 }

package/esm/server/remult-api-server.js

@@ -339,7 +339,9 @@ export class RemultServerImplementation {
     }
     process(what, doNotReuseInitRequest) {
         return async (req, origRes) => {
-            const genReq = req ? this.coreOptions.buildGenericRequestInfo(req) : {};
+            const { internal: genReq, public: genReqPublic, } = req
+                ? this.coreOptions.buildGenericRequestInfo(req)
+                : { internal: {}, public: { headers: new Headers() } };
             if (req) {
                 if (!genReq.query) {
                     genReq.query = req['_tempQuery'];
@@ -358,6 +360,16 @@ export class RemultServerImplementation {
                         if (req) {
                             ;
                             remult.context.request = req;
+                            remult.context.headers = {
+                                get: (key) => genReqPublic.headers.get(key) ?? undefined,
+                                getAll: () => {
+                                    const result = {};
+                                    genReqPublic.headers.forEach((value, key) => {
+                                        result[key] = value;
+                                    });
+                                    return result;
+                                },
+                            };
                             remultStatic.asyncContext.setInInitRequest(true);
                             try {
                                 let user;
@@ -1109,7 +1121,7 @@ export class RouteImplementation {
         });
     }
     middleware(origReq, res, next) {
-        const req = this.coreOptions.buildGenericRequestInfo(origReq);
+        const { internal: req } = this.coreOptions.buildGenericRequestInfo(origReq);
         let theUrl = req.url?.toString() || '';
         if (theUrl.startsWith('/'))
             //next sends a partial url '/api/tasks' and not the full url

package/esm/server/test-api-data-provider.js

@@ -11,7 +11,10 @@ export function TestApiDataProvider(options) {
     });
     const server = createRemultServerCore({ ...options, dataProvider: dp }, {
         getRequestBody: async (req) => req.body,
-        buildGenericRequestInfo: (req) => req,
+        buildGenericRequestInfo: (req) => ({
+            internal: req,
+            public: { headers: new Headers() },
+        }),
         ignoreAsyncStorage: true,
     });
     const lock = new AsyncLock();

package/esm/src/context.js

@@ -231,7 +231,15 @@ export class Remult {
     }
     /** A helper callback that is called whenever an entity is created. */
     static entityRefInit;
-    /** context information that can be used to store custom information that will be disposed as part of the `remult` object */
+    /**
+     * context that can be used to store custom information that will be disposed as part of the `remult` object.
+     *
+     * `remult.context` is pre-filled in a framework-agnostic way with:
+     *   - `headers.get(key: string)` _of request_
+     *   - `headers.getAll()` _of request_
+     *
+     * Check out the [extensibility section](/docs/custom-options#enhancing-field-and-entity-definitions-with-custom-options) for more custom options.
+     */
     context = {};
     /** The api client that will be used by `remult` to perform calls to the `api` */
     apiClient = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.0.6-next.0",
+    "version": "3.0.6-next.1",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/remult-express.js

@@ -19,7 +19,10 @@ function remultApi(options) {
         app.use(express.urlencoded({ extended: true, limit: options.bodySizeLimit }));
     }
     var server = (0, index_js_1.createRemultServer)(options, {
-        buildGenericRequestInfo: function (req) { return req; },
+        buildGenericRequestInfo: function (req) { return ({
+            internal: tslib_1.__assign(tslib_1.__assign({}, req), { on: req.on }),
+            public: { headers: new Headers(req.headers) },
+        }); },
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.body];
         }); }); },

package/remult-fastify.js

@@ -39,7 +39,12 @@ function remultApi(options) {
         return response;
     }
     var api = (0, index_js_1.createRemultServer)(options, {
-        buildGenericRequestInfo: function (req) { return req; },
+        buildGenericRequestInfo: function (req) { return ({
+            internal: tslib_1.__assign(tslib_1.__assign({}, req), { url: req.originalUrl, 
+                // @ts-ignore
+                on: req.on }),
+            public: { headers: new Headers(req.headers) },
+        }); },
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.body];
         }); }); },

package/remult-fresh.js

@@ -7,7 +7,11 @@ var remult_api_server_js_1 = require("./server/remult-api-server.js");
 function remultApi(options, response) {
     var _this = this;
     var server = (0, remult_api_server_js_1.createRemultServerCore)(options, {
-        buildGenericRequestInfo: function (r) { return r; },
+        buildGenericRequestInfo: function (r) { return ({
+            // @ts-ignore
+            internal: tslib_1.__assign(tslib_1.__assign({}, r), { on: r.on }),
+            public: { headers: r.headers },
+        }); },
         getRequestBody: function (req) { return req.json(); },
     });
     return {

package/remult-hapi.js

@@ -9,13 +9,10 @@ function remultApi(options) {
     var _this = this;
     var api = (0, index_js_1.createRemultServer)(options, {
         buildGenericRequestInfo: function (req) { return ({
-            method: req.method,
-            params: req.params,
-            query: req.query,
-            url: req.url.pathname,
-            on: function (e, do1) {
-                req.raw.req.on('close', do1);
-            },
+            internal: tslib_1.__assign(tslib_1.__assign({}, req), { url: req.url.pathname, on: function (e, do1) {
+                    req.raw.req.on('close', do1);
+                } }),
+            public: { headers: new Headers(req.headers) },
         }); },
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.payload];

package/remult-hono.js

@@ -12,22 +12,24 @@ function remultApi(options) {
     var api = (0, index_js_1.createRemultServer)(options, {
         buildGenericRequestInfo: function (c) {
             return {
-                method: c.req.method,
-                params: c.req.param(),
-                query: new Proxy(c.req, {
-                    get: function (target, prop) {
-                        var r = c.req.queries(prop);
-                        if ((r === null || r === void 0 ? void 0 : r.length) == 1)
-                            return r[0];
-                        return r;
+                internal: {
+                    method: c.req.method,
+                    params: c.req.param(),
+                    query: new Proxy(c.req, {
+                        get: function (target, prop) {
+                            var r = c.req.queries(prop);
+                            if ((r === null || r === void 0 ? void 0 : r.length) == 1)
+                                return r[0];
+                            return r;
+                        },
+                    }),
+                    url: c.req.url,
+                    on: function (e, do1) {
+                        ;
+                        c['_tempOnClose'](function () { return do1(); });
                     },
-                }),
-                url: c.req.url,
-                on: function (e, do1) {
-                    ;
-                    c['_tempOnClose'](function () { return do1(); });
-                    //   c.req.on('close', do1)
                 },
+                public: { headers: new Headers(c.req.header()) },
             };
         },
         getRequestBody: function (c) { return tslib_1.__awaiter(_this, void 0, void 0, function () {

package/remult-next.js

@@ -8,7 +8,10 @@ var index_js_1 = require("./server/index.js");
 function remultNext(options) {
     var _this = this;
     var result = (0, index_js_1.createRemultServer)(options, {
-        buildGenericRequestInfo: function (req) { return req; },
+        buildGenericRequestInfo: function (req) { return ({
+            internal: tslib_1.__assign(tslib_1.__assign({}, req), { on: req.on }),
+            public: { headers: new Headers(req.headers) },
+        }); },
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.body];
         }); }); },
@@ -84,14 +87,17 @@ function remultApi(options) {
     var result = (0, index_js_1.createRemultServer)(options, {
         getRequestBody: function (req) { return req.json(); },
         buildGenericRequestInfo: function (req) { return ({
-            url: req === null || req === void 0 ? void 0 : req.url,
-            method: req === null || req === void 0 ? void 0 : req.method,
-            on: function (e, do1) {
-                if (e === 'close') {
-                    ;
-                    req['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: req === null || req === void 0 ? void 0 : req.url,
+                method: req === null || req === void 0 ? void 0 : req.method,
+                on: function (e, do1) {
+                    if (e === 'close') {
+                        ;
+                        req['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: req.headers },
         }); },
     });
     var handler = function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () {

package/remult-nuxt.js

@@ -8,8 +8,8 @@ var index_js_1 = require("./server/index.js");
 function remultApi(options) {
     var _this = this;
     var result = (0, index_js_1.createRemultServer)(options, {
-        buildGenericRequestInfo: function (event) {
-            return {
+        buildGenericRequestInfo: function (event) { return ({
+            internal: {
                 method: event.node.req.method,
                 url: event.node.req.url,
                 on: function (a, b) {
@@ -17,8 +17,11 @@ function remultApi(options) {
                         b();
                     });
                 },
-            };
-        },
+            },
+            public: {
+                headers: new Headers(event.node.req.headers),
+            },
+        }); },
         getRequestBody: function (event) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, (0, h3_1.readBody)(event)];

package/remult-solid-start.js

@@ -9,13 +9,16 @@ function remultApi(options) {
     var _this = this;
     var result = (0, index_js_1.createRemultServer)(options, {
         buildGenericRequestInfo: function (event) { return ({
-            url: event.request.url,
-            method: event.request.method,
-            on: function (e, do1) {
-                if (e === 'close') {
-                    event.locals['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: event.request.url,
+                method: event.request.method,
+                on: function (e, do1) {
+                    if (e === 'close') {
+                        event.locals['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: new Headers(event.request.headers) },
         }); },
         getRequestBody: function (event) { return event.request.json(); },
     });

package/remult-sveltekit.js

@@ -8,14 +8,17 @@ function remultApi(options) {
     var _this = this;
     var result = (0, index_js_1.createRemultServer)(options, {
         buildGenericRequestInfo: function (event) { return ({
-            url: event.request.url,
-            method: event.request.method,
-            on: function (e, do1) {
-                if (e === 'close') {
-                    ;
-                    event.locals['_tempOnClose'] = do1;
-                }
+            internal: {
+                url: event.request.url,
+                method: event.request.method,
+                on: function (e, do1) {
+                    if (e === 'close') {
+                        ;
+                        event.locals['_tempOnClose'] = do1;
+                    }
+                },
             },
+            public: { headers: event.request.headers },
         }); },
         getRequestBody: function (event) { return event.request.json(); },
     });
@@ -88,7 +91,7 @@ function remultApi(options) {
                             status: responseFromRemultHandler.statusCode,
                             headers: {
                                 'Content-Type': 'application/json',
-                            }
+                            },
                         });
                         return [2 /*return*/, res];
                     }

package/server/core.d.ts

@@ -1,4 +1,4 @@
-export { queuedJobInfo, QueueStorage, GenericRequestInfo, GenericRequestHandler, GenericResponse, GenericRouter, createRemultServerCore, RemultServerOptions, SpecificRoute, RemultServer, } from './remult-api-server.js';
+export { type queuedJobInfo, type QueueStorage, type GenericRequestInfo, type GenericRequestHandler, type GenericResponse, type GenericRouter, createRemultServerCore, type RemultServerOptions, type SpecificRoute, type RemultServer, } from './remult-api-server.js';
 export { JsonEntityFileStorage, JsonFileDataProvider, } from './JsonEntityFileStorage.js';
 export { SseSubscriptionServer } from '../SseSubscriptionServer.js';
 export { DataProviderLiveQueryStorage } from '../live-query/data-provider-live-query-storage.js';

package/server/index.js

@@ -21,7 +21,10 @@ function createRemultServer(options, serverCoreOptions) {
     var _this = this;
     (0, initAsyncHooks_js_1.initAsyncHooks)();
     return (0, remult_api_server_js_1.createRemultServerCore)(options, serverCoreOptions || {
-        buildGenericRequestInfo: function (req) { return (0, isOfType_js_1.cast)(req, 'method'); },
+        buildGenericRequestInfo: function (req) { return ({
+            internal: (0, isOfType_js_1.cast)(req, 'method'),
+            public: { headers: new Headers(req.headers) },
+        }); },
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.body];
         }); }); },

package/server/module.js

@@ -9,8 +9,8 @@ var Module = /** @class */ (function () {
         this.priority = (_a = options.priority) !== null && _a !== void 0 ? _a : 0;
         this.entities = options.entities;
         this.controllers = options.controllers;
-        this.initRequest = options.initRequest;
         this.initApi = options.initApi;
+        this.initRequest = options.initRequest;
         this.modules = options.modules;
     }
     return Module;

package/server/remult-api-server.d.ts

@@ -99,16 +99,23 @@ export interface RemultServerOptions<RequestType> {
      * @example
      * import { Module } from 'remult/server'
      *
-     * modules: [
-     *   new Module({
-     *     key: 'analytics',
-     *     entities: [AnalyticsEvent],
-     *     controllers: [AnalyticsController],
-     *     initApi: () => {
-     *       console.log('analytics module initialized')
-     *     },
-     *   }),
-     * ]
+     * // create an analytics module
+     * const analytics = () => new Module({
+     *   key: 'analytics',
+     *   priority: 11, // Default: 0, Prioritized by ascending order.
+     *   entities: [AnalyticsEvent],
+     *   controllers: [AnalyticsController],
+     *   initApi: () => console.log('analytics module initialized'),
+     *   initRequest: () => {},
+     *   modules: [] // You can nest modules
+     * })
+     *
+     * // use the module in the remultApi
+     * remultApi({
+     *   modules: [
+     *     analytics(),
+     *   ]
+     * })
      */
     modules?: Module<RequestType>[];
 }
@@ -145,6 +152,9 @@ export type SpecificRoute<RequestType> = {
     post(handler: GenericRequestHandler<RequestType>): SpecificRoute<RequestType>;
     delete(handler: GenericRequestHandler<RequestType>): SpecificRoute<RequestType>;
 };
+export interface GenericRequest {
+    headers: Headers;
+}
 export interface GenericRequestInfo {
     url?: string;
     method?: any;
@@ -199,7 +209,10 @@ export declare class JobsInQueueEntity extends IdEntity {
     progress: number;
 }
 export interface ServerCoreOptions<RequestType> {
-    buildGenericRequestInfo(req: RequestType): GenericRequestInfo;
+    buildGenericRequestInfo(req: RequestType): {
+        internal: GenericRequestInfo;
+        public: GenericRequest;
+    };
     getRequestBody(req: RequestType): Promise<any>;
     ignoreAsyncStorage?: boolean;
 }

package/server/remult-api-server.js

@@ -629,12 +629,14 @@ var RemultServerImplementation = /** @class */ (function () {
     RemultServerImplementation.prototype.process = function (what, doNotReuseInitRequest) {
         var _this = this;
         return function (req, origRes) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-            var genReq, myReq, myRes, err_2;
+            var _a, genReq, genReqPublic, myReq, myRes, err_2;
             var _this = this;
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        genReq = req ? this.coreOptions.buildGenericRequestInfo(req) : {};
+                        _a = req
+                            ? this.coreOptions.buildGenericRequestInfo(req)
+                            : { internal: {}, public: { headers: new Headers() } }, genReq = _a.internal, genReqPublic = _a.public;
                         if (req) {
                             if (!genReq.query) {
                                 genReq.query = req['_tempQuery'];
@@ -644,13 +646,13 @@ var RemultServerImplementation = /** @class */ (function () {
                         }
                         myReq = new RequestBridgeToDataApiRequest(genReq);
                         myRes = new ResponseBridgeToDataApiResponse(origRes, req, genReq, this.options.error);
-                        _a.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _a.trys.push([1, 6, , 7]);
+                        _b.trys.push([1, 6, , 7]);
                         if (!(remult_static_js_1.remultStatic.asyncContext.isInInitRequest() &&
                             !doNotReuseInitRequest)) return [3 /*break*/, 3];
                         return [4 /*yield*/, what(remult_static_js_1.remultStatic.asyncContext.getStore().remult, myReq, myRes, genReq, origRes, req)];
-                    case 2: return [2 /*return*/, _a.sent()];
+                    case 2: return [2 /*return*/, _b.sent()];
                     case 3: return [4 /*yield*/, this.runWithRemult(function (remult) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
                             var user, i, _initRequest;
                             return tslib_1.__generator(this, function (_a) {
@@ -659,6 +661,16 @@ var RemultServerImplementation = /** @class */ (function () {
                                         if (!req) return [3 /*break*/, 11];
                                         ;
                                         remult.context.request = req;
+                                        remult.context.headers = {
+                                            get: function (key) { var _a; return (_a = genReqPublic.headers.get(key)) !== null && _a !== void 0 ? _a : undefined; },
+                                            getAll: function () {
+                                                var result = {};
+                                                genReqPublic.headers.forEach(function (value, key) {
+                                                    result[key] = value;
+                                                });
+                                                return result;
+                                            },
+                                        };
                                         remult_static_js_1.remultStatic.asyncContext.setInInitRequest(true);
                                         _a.label = 1;
                                     case 1:
@@ -712,11 +724,11 @@ var RemultServerImplementation = /** @class */ (function () {
                             });
                         }); })];
                     case 4:
-                        _a.sent();
-                        _a.label = 5;
+                        _b.sent();
+                        _b.label = 5;
                     case 5: return [3 /*break*/, 7];
                     case 6:
-                        err_2 = _a.sent();
+                        err_2 = _b.sent();
                         if (origRes)
                             myRes.error(err_2, undefined);
                         else
@@ -1581,7 +1593,7 @@ var RouteImplementation = /** @class */ (function () {
     RouteImplementation.prototype.middleware = function (origReq, res, next) {
         var e_8, _a;
         var _b;
-        var req = this.coreOptions.buildGenericRequestInfo(origReq);
+        var req = this.coreOptions.buildGenericRequestInfo(origReq).internal;
         var theUrl = ((_b = req.url) === null || _b === void 0 ? void 0 : _b.toString()) || '';
         if (theUrl.startsWith('/'))
             //next sends a partial url '/api/tasks' and not the full url

package/server/test-api-data-provider.js

@@ -21,7 +21,10 @@ function TestApiDataProvider(options) {
         getRequestBody: function (req) { return tslib_1.__awaiter(_this, void 0, void 0, function () { return tslib_1.__generator(this, function (_a) {
             return [2 /*return*/, req.body];
         }); }); },
-        buildGenericRequestInfo: function (req) { return req; },
+        buildGenericRequestInfo: function (req) { return ({
+            internal: req,
+            public: { headers: new Headers() },
+        }); },
         ignoreAsyncStorage: true,
     });
     var lock = new AsyncLock();

package/src/context.d.ts

@@ -90,7 +90,15 @@ export declare class Remult {
     clearAllCache(): any;
     /** A helper callback that is called whenever an entity is created. */
     static entityRefInit?: (ref: EntityRef<any>, row: any) => void;
-    /** context information that can be used to store custom information that will be disposed as part of the `remult` object */
+    /**
+     * context that can be used to store custom information that will be disposed as part of the `remult` object.
+     *
+     * `remult.context` is pre-filled in a framework-agnostic way with:
+     *   - `headers.get(key: string)` _of request_
+     *   - `headers.getAll()` _of request_
+     *
+     * Check out the [extensibility section](/docs/custom-options#enhancing-field-and-entity-definitions-with-custom-options) for more custom options.
+     */
     readonly context: RemultContext;
     /** The api client that will be used by `remult` to perform calls to the `api` */
     apiClient: ApiClient;
@@ -102,13 +110,18 @@ export type GetArguments<T> = T extends (...args: infer FirstArgument) => any ?
  * To type it correctly, you can extend it with your own properties.
  * @example
  * import type express from 'express'
+ *
  * declare module 'remult' {
  *   export interface RemultContext {
  *     request?: express.Request
  *   }
  * }
- *  */
+ */
 export interface RemultContext {
+    headers?: {
+        get: (key: string) => string | undefined;
+        getAll: () => Record<string, string>;
+    };
 }
 /**
  * Interface for configuring the API client used by Remult to perform HTTP calls to the backend.

package/src/context.js

@@ -121,7 +121,15 @@ var Remult = /** @class */ (function () {
         };
         /* @internal*/
         this.liveQuerySubscriber = new LiveQueryClient_js_1.LiveQueryClient(function () { return _this.apiClient; }, function () { var _a; return (_a = _this.user) === null || _a === void 0 ? void 0 : _a.id; });
-        /** context information that can be used to store custom information that will be disposed as part of the `remult` object */
+        /**
+         * context that can be used to store custom information that will be disposed as part of the `remult` object.
+         *
+         * `remult.context` is pre-filled in a framework-agnostic way with:
+         *   - `headers.get(key: string)` _of request_
+         *   - `headers.getAll()` _of request_
+         *
+         * Check out the [extensibility section](/docs/custom-options#enhancing-field-and-entity-definitions-with-custom-options) for more custom options.
+         */
         this.context = {};
         /** The api client that will be used by `remult` to perform calls to the `api` */
         this.apiClient = {