remult 3.0.5 → 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

@@ -5,10 +5,14 @@ export { SseSubscriptionServer } from '../SseSubscriptionServer.js';
 export { DataProviderLiveQueryStorage } from '../live-query/data-provider-live-query-storage.js';
 export { JsonEntityFileStorage, JsonFileDataProvider, } from './JsonEntityFileStorage.js';
 export { TestApiDataProvider } from './test-api-data-provider.js';
+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

@@ -0,0 +1,38 @@
+export class Module {
+    key;
+    priority;
+    entities;
+    controllers;
+    initApi;
+    initRequest;
+    modules;
+    constructor(options) {
+        this.key = options.key;
+        this.priority = options.priority ?? 0;
+        this.entities = options.entities;
+        this.controllers = options.controllers;
+        this.initApi = options.initApi;
+        this.initRequest = options.initRequest;
+        this.modules = options.modules;
+    }
+}
+/**
+ * Full flat and ordered list by index and concatenaining the modules name
+ */
+export const modulesFlatAndOrdered = (modules) => {
+    const flattenModules = (modules, parentName = '') => {
+        return modules.reduce((acc, module) => {
+            const fullKey = parentName ? `${parentName}-${module.key}` : module.key;
+            // Create a new module object without the 'modules' property
+            const { modules: _, ...flatModule } = module;
+            const newModule = { ...flatModule, key: fullKey };
+            const subModules = module.modules
+                ? flattenModules(module.modules, fullKey)
+                : [];
+            return [...acc, newModule, ...subModules];
+        }, []);
+    };
+    const flatModules = flattenModules(modules);
+    flatModules.sort((a, b) => a.priority - b.priority);
+    return flatModules;
+};

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

@@ -14,6 +14,7 @@ import { remultStatic } from '../src/remult-static.js';
 import remultAdminHtml, { buildEntityInfo } from './remult-admin.js';
 import { isOfType } from '../src/isOfType.js';
 import { initDataProviderOrJson } from './initDataProviderOrJson.js';
+import { modulesFlatAndOrdered } from './module.js';
 export function createRemultServerCore(options, serverCoreOptions) {
     const safeOptions = options ?? {};
     if (!safeOptions.entities)
@@ -57,6 +58,9 @@ export class RemultServerImplementation {
     dataProvider;
     coreOptions;
     liveQueryStorage = new InMemoryLiveQueryStorage();
+    modulesSorted = [];
+    entities = [];
+    controllers = [];
     constructor(queue, options, dataProvider, coreOptions) {
         this.queue = queue;
         this.options = options;
@@ -67,6 +71,19 @@ export class RemultServerImplementation {
         if (options.subscriptionServer)
             this.subscriptionServer = options.subscriptionServer;
         const entitiesMetaData = [];
+        const modules = options.modules ?? [];
+        modules.push({
+            key: 'default',
+            priority: 0,
+            entities: options.entities ?? [],
+            controllers: options.controllers ?? [],
+            initApi: options.initApi,
+            initRequest: options.initRequest,
+            modules: [],
+        });
+        this.modulesSorted = modulesFlatAndOrdered(modules);
+        this.entities = this.modulesSorted.flatMap((m) => m.entities ?? []);
+        this.controllers = this.modulesSorted.flatMap((m) => m.controllers ?? []);
         this.dataProvider = dataProvider.then(async (dp) => {
             await this.runWithRemult(async (remult) => {
                 remult.dataProvider = dp;
@@ -78,8 +95,8 @@ export class RemultServerImplementation {
                         started = true;
                         console.time('Schema ensured');
                     };
-                    if (options.entities)
-                        entitiesMetaData.push(...options.entities.map((e) => remult.repo(e).metadata));
+                    if (this.entities)
+                        entitiesMetaData.push(...this.entities.map((e) => remult.repo(e).metadata));
                     if (dp.ensureSchema) {
                         startConsoleLog();
                         await dp.ensureSchema(entitiesMetaData);
@@ -96,8 +113,12 @@ export class RemultServerImplementation {
                     if (started)
                         console.timeEnd('Schema ensured');
                 }
-                if (options.initApi)
-                    await options.initApi(remult);
+                for (let i = 0; i < this.modulesSorted.length; i++) {
+                    const _initApi = this.modulesSorted[i].initApi;
+                    if (_initApi) {
+                        await _initApi(remult);
+                    }
+                }
             }, { skipDataProvider: true });
             return dp;
         });
@@ -124,10 +145,10 @@ export class RemultServerImplementation {
     getEntities() {
         //TODO V2 - consider using entitiesMetaData - but it may require making it all awaitable
         var r = new Remult();
-        return this.options.entities.map((x) => r.repo(x).metadata);
+        return this.entities.map((x) => r.repo(x).metadata);
     }
     runWithSerializedJsonContextData = async (jsonContextData, entityKey, what) => {
-        for (const e of this.options.entities) {
+        for (const e of this.entities) {
             let key = getEntityKey(e);
             if (key === entityKey) {
                 await this.runWithRemult(async (remult) => {
@@ -173,7 +194,7 @@ export class RemultServerImplementation {
             throw 'Router already registered';
         this.registeredRouter = true;
         {
-            for (const c of this.options.controllers) {
+            for (const c of this.controllers) {
                 let z = c[classBackendMethodsArray];
                 if (z)
                     for (const a of z) {
@@ -211,7 +232,7 @@ export class RemultServerImplementation {
                         if (orig?.params?.id === '__entities-metadata') {
                             res.success(buildEntityInfo({
                                 remult,
-                                entities: this.options.entities ?? [],
+                                entities: this.entities,
                             }));
                         }
                         else {
@@ -259,7 +280,7 @@ export class RemultServerImplementation {
                 res.success(await remult.liveQueryStorage.keepAliveAndReturnUnknownQueryIds(await this.coreOptions.getRequestBody(origReq)));
             }));
         }
-        this.options.entities?.forEach((e) => {
+        this.entities.forEach((e) => {
             this.addEntity(e, getEntityKey(e), r);
         });
     }
@@ -318,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'];
@@ -337,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;
@@ -351,16 +384,19 @@ export class RemultServerImplementation {
                                 }
                                 if (user)
                                     remult.user = user;
-                                if (this.options.initRequest) {
-                                    await this.options.initRequest(req, {
-                                        remult,
-                                        get liveQueryStorage() {
-                                            return remult.liveQueryStorage;
-                                        },
-                                        set liveQueryStorage(value) {
-                                            remult.liveQueryStorage = value;
-                                        },
-                                    });
+                                for (let i = 0; i < this.modulesSorted.length; i++) {
+                                    const _initRequest = this.modulesSorted[i].initRequest;
+                                    if (_initRequest) {
+                                        await _initRequest(req, {
+                                            remult,
+                                            get liveQueryStorage() {
+                                                return remult.liveQueryStorage;
+                                            },
+                                            set liveQueryStorage(value) {
+                                                remult.liveQueryStorage = value;
+                                            },
+                                        });
+                                    }
                                 }
                                 await what(remult, myReq, myRes, genReq, origRes, req);
                             }
@@ -1085,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.5",
+    "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 () {