@autofleet/super-express 5.0.0 → 6.0.0

package/README.md

@@ -35,10 +35,9 @@ const options = {
     morgan: true,
     nitur: true,
     stats: true,
-    packageJsonPath: './package.json',
     tracing: true,
     eagerLoadUserPermissions: true,
-    aliveEndpointOptions: { customOption: 'value' }
+    aliveEndpointOptions: { sequelize },
 };
 
 const app = await createSuperExpressApp(options);
@@ -52,12 +51,11 @@ app.listen(3000, () => {
 
 You can customize the behavior of SuperExpress by passing an options object:
 
-- `bodyParser` (boolean): Enables or disables the body parser middleware.
+- `bodyParser` (boolean|string): Enables or disables the body parser middleware.
 - `helmet` (boolean): Enables or disables security headers.
 - `morgan` (boolean): Enables or disables HTTP request logging.
 - `nitur` (boolean): Enables or disables the alive endpoint.
 - `stats` (boolean): Enables or disables the stats endpoint.
-- `packageJsonPath` (string): Path to the `package.json` file for the stats endpoint.
 - `tracing` (boolean): Enables or disables request tracing.
 - `eagerLoadUserPermissions` (boolean): Enables or disables eager loading of user permissions for tracing middleware.
 - `aliveEndpointOptions` (object): Options to customize the alive endpoint.
@@ -72,7 +70,7 @@ You can customize the behavior of SuperExpress by passing an options object:
 
 ### Stats Endpoint
 
-- **Path**: `/`
+- **Path**: `/stats`
 - **Method**: `GET`
 - **Description**: Provides server and application statistics.
 
@@ -81,7 +79,7 @@ You can customize the behavior of SuperExpress by passing an options object:
 This project uses Node.js's built-in test runner for testing. To run the tests, execute:
 
 ```bash
-node --test index.test.js
+node --run test
 ```
 
 ## Example
@@ -97,10 +95,9 @@ const options = {
     morgan: true,
     nitur: true,
     stats: true,
-    packageJsonPath: './package.json',
     tracing: true,
     eagerLoadUserPermissions: true,
-    aliveEndpointOptions: { customOption: 'value' }
+    aliveEndpointOptions: { sequelize },
 };
 
 const app = await createSuperExpressApp(options);

package/dist/index.cjs

@@ -0,0 +1,2 @@
+'use strict';var l=require('node:fs'),f=require('node:path'),node_module=require('node:module'),c=require('express');var _documentCurrentScript=typeof document!=='undefined'?document.currentScript:null;function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var l__default=/*#__PURE__*/_interopDefault(l);var f__default=/*#__PURE__*/_interopDefault(f);var c__default=/*#__PURE__*/_interopDefault(c);var d={bodyParser:"1000mb",helmet:true,morgan:true,nitur:true,stats:true,tracing:true,eagerLoadUserPermissions:true};var p=node_module.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))),g=JSON.parse(l__default.default.readFileSync(f__default.default.resolve(undefined,"../package.json"),"utf8"));function S({logger:e,...m}){let o=c__default.default(),r={...d,...m};if(r.morgan){let t=p("morgan");e.debug("[SuperExpress] formatting is enabled \u2705"),o.use(t((n,s,i)=>{let a={method:n.method(s,i),url:n.url(s,i)??"unknown URL",status:n.status(s,i),contentLength:n.res(s,i,"content-length"),responseTime:n["response-time"](s,i)??"0",userAgent:n["user-agent"](s,i)};e.info(a.url,{httpRequest:{status:a.status,requestUrl:a.url,requestMethod:a.method,responseSize:a.contentLength,latency:{seconds:Number.parseInt(a.responseTime,10)/1e3,nanos:Number.parseInt(a.responseTime,10)*1e6},userAgent:a.userAgent}});}));}if(r.helmet){e.debug("[SuperExpress] security is enabled \u2705");let t={"Content-Security-Policy":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","Cross-Origin-Opener-Policy":"same-origin","Cross-Origin-Resource-Policy":"same-origin","Origin-Agent-Cluster":"?1","Referrer-Policy":"no-referrer","Strict-Transport-Security":"max-age=15552000; includeSubDomains","X-Content-Type-Options":"nosniff","X-DNS-Prefetch-Control":"off","X-Download-Options":"noopen","X-Frame-Options":"SAMEORIGIN","X-Permitted-Cross-Domain-Policies":"none","X-XSS-Protection":"0"};o.use((n,s,i)=>{s.set(t),i();}),o.disable("x-powered-by");}else e.warn("[SuperExpress] security headers are disabled \u{1F628}");if(r.bodyParser){e.debug("[SuperExpress] body-parser is enabled \u2705");let t=typeof r.bodyParser=="string"?r.bodyParser:"1000mb";o.use(c__default.default.json({limit:t}));}else e.debug("[SuperExpress] body-parser is disabled \u274C");if(r.nitur){let{aliveEndpoint:t}=p("@autofleet/nitur");o.get("/alive",t({logger:e,...r.aliveEndpointOptions})),e.debug("[SuperExpress] added /alive endpoint \u2705");}if(r.stats){let t=new Date;o.get("/stats",(n,s)=>{s.json({name:r.name||"default-name",version:r.version||"default-version",serverRunningSince:t});}),e.debug("[SuperExpress] added /stats endpoint \u2705");}if(r.tracing){let{enableTracing:t,middleware:n,outbreak:s}=p("@autofleet/zehut");t(),e.addContextMiddleware(()=>({traceId:s.getCurrentContext()?.context?.get("x-trace-id")})),o.use(n({eagerLoadUserPermissions:r.eagerLoadUserPermissions})),e.debug("[SuperExpress] tracing is enabled \u2705");}let u=o.listen.bind(o);return o.listen=function(t,n){let s=process.env.NODE_ENV==="production",i=g?.version||"unknown";return e.debug(`[SuperExpress] is started with version ${i}`),e.debug(`[SuperExpress] will listen on port ${t}`),e.debug(`[SuperExpress] production mode: ${s}`),u(t,n)},Object.assign(o,{nativeListen:u})}module.exports=S;//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../config/default-options.ts","../src/index.ts"],"names":["defaultOptions","safeRequire","createRequire","packageJson","fs","path","superExpress","logger","options","app","express","mergedOptions","morgan","tokens","req","res","values","HEADERS","_req","next","limit","aliveEndpoint","serverRunningSince","enableTracing","middleware","outbreak","nativeListen","port","callback","isProd","version"],"mappings":"wZA6BO,IAAMA,CAAiB,CAAA,CAC5B,UAAY,CAAA,QAAA,CACZ,MAAQ,CAAA,IAAA,CACR,OAAQ,IACR,CAAA,KAAA,CAAO,IACP,CAAA,KAAA,CAAO,IACP,CAAA,OAAA,CAAS,KACT,wBAA0B,CAAA,IAC5B,CC9BA,CAAA,IAAMC,CAAcC,CAAAA,yBAAAA,CAAc,2PAAe,CAAA,CAE3CC,CAAc,CAAA,IAAA,CAAK,KAAMC,CAAAA,kBAAAA,CAAG,aAAaC,kBAAK,CAAA,OAAA,CAAQ,SAAY,CAAS,iBAAiB,CAAA,CAAG,MAAM,CAAC,CAAA,CAqB7F,SAARC,CAAAA,CAA8B,CAAE,MAAA,CAAAC,EAAQ,GAAGC,CAAQ,CAA6B,CAAA,CACnF,IAAMC,CAAAA,CAAMC,oBACNC,CAAAA,CAAAA,CAAgB,CAAE,GAAGX,CAAgB,CAAA,GAAGQ,CAAQ,CAEtD,CAAA,GAAIG,CAAc,CAAA,MAAA,CAAQ,CACtB,IAAMC,EAASX,CAAY,CAAA,QAAQ,CACnCM,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACrDE,CAAI,CAAA,GAAA,CAAIG,CAAO,CAAA,CAACC,CAAQC,CAAAA,CAAAA,CAAKC,IAAQ,CACjC,IAAMC,CAAS,CAAA,CACX,MAAQH,CAAAA,CAAAA,CAAO,OAAOC,CAAKC,CAAAA,CAAG,CAC9B,CAAA,GAAA,CAAKF,CAAO,CAAA,GAAA,CAAIC,EAAKC,CAAG,CAAA,EAAK,aAC7B,CAAA,MAAA,CAAQF,CAAO,CAAA,MAAA,CAAOC,EAAKC,CAAG,CAAA,CAC9B,aAAeF,CAAAA,CAAAA,CAAO,GAAIC,CAAAA,CAAAA,CAAKC,EAAK,gBAAgB,CAAA,CACpD,YAAcF,CAAAA,CAAAA,CAAO,eAAe,CAAA,CAAEC,EAAKC,CAAG,CAAA,EAAK,GACnD,CAAA,SAAA,CAAWF,CAAO,CAAA,YAAY,EAAEC,CAAKC,CAAAA,CAAG,CAC5C,CAAA,CACAR,CAAO,CAAA,IAAA,CAAKS,EAAO,GAAK,CAAA,CACpB,WAAa,CAAA,CACX,MAAQA,CAAAA,CAAAA,CAAO,OACf,UAAYA,CAAAA,CAAAA,CAAO,GACnB,CAAA,aAAA,CAAeA,CAAO,CAAA,MAAA,CACtB,aAAcA,CAAO,CAAA,aAAA,CACrB,OAAS,CAAA,CACP,OAAS,CAAA,MAAA,CAAO,SAASA,CAAO,CAAA,YAAA,CAAc,EAAE,CAAA,CAAI,GACpD,CAAA,KAAA,CAAO,OAAO,QAASA,CAAAA,CAAAA,CAAO,YAAc,CAAA,EAAE,CAAI,CAAA,GACpD,EACA,SAAWA,CAAAA,CAAAA,CAAO,SACpB,CACJ,CAAC,EAEL,CAAC,CAAC,EACN,CAEA,GAAIL,CAAc,CAAA,MAAA,CAAQ,CACtBJ,CAAO,CAAA,KAAA,CAAM,2CAAsC,CAAA,CAEnD,IAAMU,CAAAA,CAAU,CACZ,yBACI,CAAA,6PAAA,CACJ,4BAA8B,CAAA,aAAA,CAC9B,8BAAgC,CAAA,aAAA,CAChC,uBAAwB,IACxB,CAAA,iBAAA,CAAmB,aACnB,CAAA,2BAAA,CAA6B,qCAC7B,CAAA,wBAAA,CAA0B,UAC1B,wBAA0B,CAAA,KAAA,CAC1B,oBAAsB,CAAA,QAAA,CACtB,iBAAmB,CAAA,YAAA,CACnB,oCAAqC,MACrC,CAAA,kBAAA,CAAoB,GACxB,CAAA,CACAR,CAAI,CAAA,GAAA,CAAI,CAACS,CAAMH,CAAAA,CAAAA,CAAKI,CAAS,GAAA,CACzBJ,CAAI,CAAA,GAAA,CAAIE,CAAO,CACfE,CAAAA,CAAAA,GACJ,CAAC,CACDV,CAAAA,CAAAA,CAAI,QAAQ,cAAc,EAC9B,CACIF,KAAAA,CAAAA,CAAO,IAAK,CAAA,wDAAiD,EAGjE,GAAII,CAAAA,CAAc,UAAY,CAAA,CAC1BJ,CAAO,CAAA,KAAA,CAAM,8CAAyC,CACtD,CAAA,IAAMa,CAAQ,CAAA,OAAOT,CAAc,CAAA,UAAA,EAAe,SAAWA,CAAc,CAAA,UAAA,CAAa,QACxFF,CAAAA,CAAAA,CAAI,GAAIC,CAAAA,kBAAAA,CAAQ,KAAK,CAAE,KAAA,CAAAU,CAAM,CAAC,CAAC,EACnC,MACIb,CAAO,CAAA,KAAA,CAAM,+CAA0C,CAAA,CAG3D,GAAII,CAAAA,CAAc,MAAO,CACrB,GAAM,CAAE,aAAA,CAAAU,CAAc,CAAA,CAAIpB,EAAY,kBAAkB,CAAA,CACxDQ,CAAI,CAAA,GAAA,CAAI,QAAUY,CAAAA,CAAAA,CAAc,CAAE,MAAAd,CAAAA,CAAAA,CAAQ,GAAGI,CAAAA,CAAc,oBAAqB,CAAC,CAAC,CAClFJ,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACzD,CAEA,GAAII,CAAc,CAAA,KAAA,CAAO,CACrB,IAAMW,CAAqB,CAAA,IAAI,KAC/Bb,CAAI,CAAA,GAAA,CAAI,QAAU,CAAA,CAACS,CAAMH,CAAAA,CAAAA,GAAQ,CAC7BA,CAAI,CAAA,IAAA,CAAK,CACL,IAAA,CAAMJ,CAAc,CAAA,IAAA,EAAQ,eAC5B,OAASA,CAAAA,CAAAA,CAAc,OAAW,EAAA,iBAAA,CAClC,kBAAAW,CAAAA,CACJ,CAAC,EACL,CAAC,CACDf,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACzD,CAEA,GAAII,CAAc,CAAA,OAAA,CAAS,CACvB,GAAM,CAAE,aAAAY,CAAAA,CAAAA,CAAe,UAAAC,CAAAA,CAAAA,CAAY,QAAAC,CAAAA,CAAS,EAAIxB,CAAY,CAAA,kBAAkB,CAC9EsB,CAAAA,CAAAA,EACAhB,CAAAA,CAAAA,CAAO,qBAAqB,KAAO,CAC/B,OAASkB,CAAAA,CAAAA,CAAS,iBAAkB,EAAA,EAAG,SAAS,GAAI,CAAA,YAAY,CACpE,CAAA,CAAE,CAEFhB,CAAAA,CAAAA,CAAI,IAAIe,CAAW,CAAA,CACf,wBAA0Bb,CAAAA,CAAAA,CAAc,wBAC5C,CAAC,CAAC,CACFJ,CAAAA,CAAAA,CAAO,KAAM,CAAA,0CAAqC,EACtD,CAEA,IAAMmB,CAAqCjB,CAAAA,CAAAA,CAAI,MAAO,CAAA,IAAA,CAAKA,CAAG,CAAA,CAC9D,OAAAA,CAAI,CAAA,MAAA,CAAS,SAAUkB,CAAAA,CAAcC,CAAuB,CAAA,CACxD,IAAMC,CAAS,CAAA,OAAA,CAAQ,GAAI,CAAA,QAAA,GAAa,YAClCC,CAAAA,CAAAA,CAAU3B,GAAa,OAAW,EAAA,SAAA,CACxC,OAAAI,CAAAA,CAAO,KAAM,CAAA,CAAA,uCAAA,EAA0CuB,CAAO,CAAE,CAAA,CAAA,CAChEvB,CAAO,CAAA,KAAA,CAAM,CAAsCoB,mCAAAA,EAAAA,CAAI,EAAE,CACzDpB,CAAAA,CAAAA,CAAO,KAAM,CAAA,CAAA,gCAAA,EAAmCsB,CAAM,CAAA,CAAE,EACjDH,CAAaC,CAAAA,CAAAA,CAAMC,CAAQ,CACtC,CAEO,CAAA,MAAA,CAAO,MAAOnB,CAAAA,CAAAA,CAAK,CAAE,YAAA,CAAAiB,CAAa,CAAC,CAC9C","file":"index.cjs","sourcesContent":["import { LoggerInstanceManager } from '@autofleet/logger';\nimport { aliveEndpoint } from '@autofleet/nitur';\n\n/** Options to customize the behavior of the SuperExpress application. */\nexport interface Options {\n    /** The name of the application. @default 'default-name' */\n    name?: string;\n    /** The version of the application. @default 'default-version' */\n    version?: string;\n    /** Enables or disables body parser middleware. if given a string, will be used as the limit for body size @default '1000mb' */\n    bodyParser?: boolean | string;\n    /** Enables or disables security headers middleware. @default true */\n    helmet?: boolean;\n    /** Enables or disables HTTP request logging middleware. @default true */\n    morgan?: boolean;\n    /** Enables or disables the alive endpoint middleware. @default true */\n    nitur?: boolean;\n    /** Enables or disables the stats endpoint middleware. @default true */\n    stats?: boolean;\n    /** Enables or disables request tracing middleware. @default true */\n    tracing?: boolean;\n    /** Enables or disables eager loading of user permissions for tracing middleware. @default true */\n    eagerLoadUserPermissions?: boolean;\n    /** Options to customize the alive endpoint middleware. */\n    aliveEndpointOptions?: Omit<Parameters<typeof aliveEndpoint>[0], 'logger'>;\n    /** The servers logger instance. */\n    logger: LoggerInstanceManager;\n}\n\nexport const defaultOptions = {\n  bodyParser: '1000mb',\n  helmet: true,\n  morgan: true,\n  nitur: true,\n  stats: true,\n  tracing: true,\n  eagerLoadUserPermissions: true,\n} satisfies Omit<Options, 'logger'>;","import fs from 'node:fs';\nimport path from 'node:path';\nimport type { Server } from 'node:http';\nimport { createRequire } from 'node:module';\nimport express from 'express';\nimport { defaultOptions, Options } from '../config/default-options.js';\n\nconst safeRequire = createRequire(import.meta.url);\n\nconst packageJson = JSON.parse(fs.readFileSync(path.resolve(import.meta.dirname, '../package.json'), 'utf8'));\n\n/** Extended express.Application interface which includes nativeListen and the overridden listen method. */\ninterface SuperExpressApp extends Omit<express.Application, 'listen'> {\n    /** Original express listen method. */\n    nativeListen: express.Application['listen'];\n\n    /**\n     * Overridden listen method to add custom behavior.\n     * @param port - The port number to listen on.\n     * @param cb - Optional callback function to execute after the server starts listening.\n     */\n    listen(port: number, cb?: () => void): Server;\n}\n\n/**\n * Creates a new SuperExpress application with the given options.\n * @param options - Optional settings to customize the application.\n * @param expressOptions - Optional settings to customize express.\n * @returns A SuperExpress application instance.\n */\nexport default function superExpress({ logger, ...options }: Options): SuperExpressApp {\n    const app = express();\n    const mergedOptions = { ...defaultOptions, ...options };\n    /** Formatting */\n    if (mergedOptions.morgan) {\n        const morgan = safeRequire('morgan') as typeof import('morgan');\n        logger.debug('[SuperExpress] formatting is enabled ✅');\n        app.use(morgan((tokens, req, res) => {\n            const values = {\n                method: tokens.method(req, res),\n                url: tokens.url(req, res) ?? 'unknown URL',\n                status: tokens.status(req, res),\n                contentLength: tokens.res(req, res, 'content-length'),\n                responseTime: tokens['response-time'](req, res) ?? '0',\n                userAgent: tokens['user-agent'](req, res),\n            };\n            logger.info(values.url, {\n                httpRequest: {\n                  status: values.status,\n                  requestUrl: values.url,\n                  requestMethod: values.method,\n                  responseSize: values.contentLength,\n                  latency: {\n                    seconds: Number.parseInt(values.responseTime, 10) / 1_000,\n                    nanos: Number.parseInt(values.responseTime, 10) * 1_000_000,\n                  },\n                  userAgent: values.userAgent,\n                },\n            });\n            return undefined;\n        }));\n    }\n    /** Security */\n    if (mergedOptions.helmet) {\n        logger.debug('[SuperExpress] security is enabled ✅');\n        // this is what helmet does by default. https://helmetjs.github.io/faq/you-might-not-need-helmet/\n        const HEADERS = {\n            \"Content-Security-Policy\":\n                \"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests\",\n            \"Cross-Origin-Opener-Policy\": \"same-origin\",\n            \"Cross-Origin-Resource-Policy\": \"same-origin\",\n            \"Origin-Agent-Cluster\": \"?1\",\n            \"Referrer-Policy\": \"no-referrer\",\n            \"Strict-Transport-Security\": \"max-age=15552000; includeSubDomains\",\n            \"X-Content-Type-Options\": \"nosniff\",\n            \"X-DNS-Prefetch-Control\": \"off\",\n            \"X-Download-Options\": \"noopen\",\n            \"X-Frame-Options\": \"SAMEORIGIN\",\n            \"X-Permitted-Cross-Domain-Policies\": \"none\",\n            \"X-XSS-Protection\": \"0\",\n        };\n        app.use((_req, res, next) => {\n            res.set(HEADERS);\n            next();\n        });\n        app.disable('x-powered-by');\n    } else {\n        logger.warn('[SuperExpress] security headers are disabled 😨');\n    }\n    /** Body Parser */\n    if (mergedOptions.bodyParser) {\n        logger.debug('[SuperExpress] body-parser is enabled ✅');\n        const limit = typeof mergedOptions.bodyParser === 'string' ? mergedOptions.bodyParser : '1000mb';\n        app.use(express.json({ limit }))\n    } else {\n        logger.debug('[SuperExpress] body-parser is disabled ❌');\n    }\n    /** Alive Endpoint */\n    if (mergedOptions.nitur) {\n        const { aliveEndpoint } = safeRequire('@autofleet/nitur') as typeof import('@autofleet/nitur');\n        app.get('/alive', aliveEndpoint({ logger, ...mergedOptions.aliveEndpointOptions }));\n        logger.debug('[SuperExpress] added /alive endpoint ✅');\n    }\n    /** Stats Endpoint */\n    if (mergedOptions.stats) {\n        const serverRunningSince = new Date();\n        app.get('/stats', (_req, res) => {\n            res.json({\n                name: mergedOptions.name || 'default-name',\n                version: mergedOptions.version || 'default-version',\n                serverRunningSince,\n            });\n        });\n        logger.debug('[SuperExpress] added /stats endpoint ✅');\n    }\n    /** Tracing */\n    if (mergedOptions.tracing) {\n        const { enableTracing, middleware, outbreak } = safeRequire('@autofleet/zehut') as typeof import('@autofleet/zehut');\n        enableTracing();\n        logger.addContextMiddleware(() => ({\n            traceId: outbreak.getCurrentContext()?.context?.get('x-trace-id'),\n        }));\n\n        app.use(middleware({\n            eagerLoadUserPermissions: mergedOptions.eagerLoadUserPermissions,\n        }));\n        logger.debug('[SuperExpress] tracing is enabled ✅');\n    }\n\n    const nativeListen: typeof app['listen'] = app.listen.bind(app);\n    app.listen = function (port: number, callback?: () => void) {\n        const isProd = process.env.NODE_ENV === 'production';\n        const version = packageJson?.version || 'unknown';\n        logger.debug(`[SuperExpress] is started with version ${version}`);\n        logger.debug(`[SuperExpress] will listen on port ${port}`);\n        logger.debug(`[SuperExpress] production mode: ${isProd}`);\n        return nativeListen(port, callback)\n    } as typeof app['listen'];\n\n    return Object.assign(app, { nativeListen }) as SuperExpressApp;\n};"]}

package/dist/index.d.cts

@@ -0,0 +1,51 @@
+import { Server } from 'node:http';
+import express from 'express';
+import { LoggerInstanceManager } from '@autofleet/logger';
+import { aliveEndpoint } from '@autofleet/nitur';
+
+/** Options to customize the behavior of the SuperExpress application. */
+interface Options {
+    /** The name of the application. @default 'default-name' */
+    name?: string;
+    /** The version of the application. @default 'default-version' */
+    version?: string;
+    /** Enables or disables body parser middleware. if given a string, will be used as the limit for body size @default '1000mb' */
+    bodyParser?: boolean | string;
+    /** Enables or disables security headers middleware. @default true */
+    helmet?: boolean;
+    /** Enables or disables HTTP request logging middleware. @default true */
+    morgan?: boolean;
+    /** Enables or disables the alive endpoint middleware. @default true */
+    nitur?: boolean;
+    /** Enables or disables the stats endpoint middleware. @default true */
+    stats?: boolean;
+    /** Enables or disables request tracing middleware. @default true */
+    tracing?: boolean;
+    /** Enables or disables eager loading of user permissions for tracing middleware. @default true */
+    eagerLoadUserPermissions?: boolean;
+    /** Options to customize the alive endpoint middleware. */
+    aliveEndpointOptions?: Omit<Parameters<typeof aliveEndpoint>[0], 'logger'>;
+    /** The servers logger instance. */
+    logger: LoggerInstanceManager;
+}
+
+/** Extended express.Application interface which includes nativeListen and the overridden listen method. */
+interface SuperExpressApp extends Omit<express.Application, 'listen'> {
+    /** Original express listen method. */
+    nativeListen: express.Application['listen'];
+    /**
+     * Overridden listen method to add custom behavior.
+     * @param port - The port number to listen on.
+     * @param cb - Optional callback function to execute after the server starts listening.
+     */
+    listen(port: number, cb?: () => void): Server;
+}
+/**
+ * Creates a new SuperExpress application with the given options.
+ * @param options - Optional settings to customize the application.
+ * @param expressOptions - Optional settings to customize express.
+ * @returns A SuperExpress application instance.
+ */
+declare function superExpress({ logger, ...options }: Options): SuperExpressApp;
+
+export { superExpress as default };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { Server } from 'node:http';
+import express from 'express';
+import { LoggerInstanceManager } from '@autofleet/logger';
+import { aliveEndpoint } from '@autofleet/nitur';
+
+/** Options to customize the behavior of the SuperExpress application. */
+interface Options {
+    /** The name of the application. @default 'default-name' */
+    name?: string;
+    /** The version of the application. @default 'default-version' */
+    version?: string;
+    /** Enables or disables body parser middleware. if given a string, will be used as the limit for body size @default '1000mb' */
+    bodyParser?: boolean | string;
+    /** Enables or disables security headers middleware. @default true */
+    helmet?: boolean;
+    /** Enables or disables HTTP request logging middleware. @default true */
+    morgan?: boolean;
+    /** Enables or disables the alive endpoint middleware. @default true */
+    nitur?: boolean;
+    /** Enables or disables the stats endpoint middleware. @default true */
+    stats?: boolean;
+    /** Enables or disables request tracing middleware. @default true */
+    tracing?: boolean;
+    /** Enables or disables eager loading of user permissions for tracing middleware. @default true */
+    eagerLoadUserPermissions?: boolean;
+    /** Options to customize the alive endpoint middleware. */
+    aliveEndpointOptions?: Omit<Parameters<typeof aliveEndpoint>[0], 'logger'>;
+    /** The servers logger instance. */
+    logger: LoggerInstanceManager;
+}
+
+/** Extended express.Application interface which includes nativeListen and the overridden listen method. */
+interface SuperExpressApp extends Omit<express.Application, 'listen'> {
+    /** Original express listen method. */
+    nativeListen: express.Application['listen'];
+    /**
+     * Overridden listen method to add custom behavior.
+     * @param port - The port number to listen on.
+     * @param cb - Optional callback function to execute after the server starts listening.
+     */
+    listen(port: number, cb?: () => void): Server;
+}
+/**
+ * Creates a new SuperExpress application with the given options.
+ * @param options - Optional settings to customize the application.
+ * @param expressOptions - Optional settings to customize express.
+ * @returns A SuperExpress application instance.
+ */
+declare function superExpress({ logger, ...options }: Options): SuperExpressApp;
+
+export { superExpress as default };

package/dist/index.js

@@ -0,0 +1,2 @@
+import l from'node:fs';import f from'node:path';import {createRequire}from'node:module';import c from'express';var d={bodyParser:"1000mb",helmet:true,morgan:true,nitur:true,stats:true,tracing:true,eagerLoadUserPermissions:true};var p=createRequire(import.meta.url),g=JSON.parse(l.readFileSync(f.resolve(import.meta.dirname,"../package.json"),"utf8"));function S({logger:e,...m}){let o=c(),r={...d,...m};if(r.morgan){let t=p("morgan");e.debug("[SuperExpress] formatting is enabled \u2705"),o.use(t((n,s,i)=>{let a={method:n.method(s,i),url:n.url(s,i)??"unknown URL",status:n.status(s,i),contentLength:n.res(s,i,"content-length"),responseTime:n["response-time"](s,i)??"0",userAgent:n["user-agent"](s,i)};e.info(a.url,{httpRequest:{status:a.status,requestUrl:a.url,requestMethod:a.method,responseSize:a.contentLength,latency:{seconds:Number.parseInt(a.responseTime,10)/1e3,nanos:Number.parseInt(a.responseTime,10)*1e6},userAgent:a.userAgent}});}));}if(r.helmet){e.debug("[SuperExpress] security is enabled \u2705");let t={"Content-Security-Policy":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","Cross-Origin-Opener-Policy":"same-origin","Cross-Origin-Resource-Policy":"same-origin","Origin-Agent-Cluster":"?1","Referrer-Policy":"no-referrer","Strict-Transport-Security":"max-age=15552000; includeSubDomains","X-Content-Type-Options":"nosniff","X-DNS-Prefetch-Control":"off","X-Download-Options":"noopen","X-Frame-Options":"SAMEORIGIN","X-Permitted-Cross-Domain-Policies":"none","X-XSS-Protection":"0"};o.use((n,s,i)=>{s.set(t),i();}),o.disable("x-powered-by");}else e.warn("[SuperExpress] security headers are disabled \u{1F628}");if(r.bodyParser){e.debug("[SuperExpress] body-parser is enabled \u2705");let t=typeof r.bodyParser=="string"?r.bodyParser:"1000mb";o.use(c.json({limit:t}));}else e.debug("[SuperExpress] body-parser is disabled \u274C");if(r.nitur){let{aliveEndpoint:t}=p("@autofleet/nitur");o.get("/alive",t({logger:e,...r.aliveEndpointOptions})),e.debug("[SuperExpress] added /alive endpoint \u2705");}if(r.stats){let t=new Date;o.get("/stats",(n,s)=>{s.json({name:r.name||"default-name",version:r.version||"default-version",serverRunningSince:t});}),e.debug("[SuperExpress] added /stats endpoint \u2705");}if(r.tracing){let{enableTracing:t,middleware:n,outbreak:s}=p("@autofleet/zehut");t(),e.addContextMiddleware(()=>({traceId:s.getCurrentContext()?.context?.get("x-trace-id")})),o.use(n({eagerLoadUserPermissions:r.eagerLoadUserPermissions})),e.debug("[SuperExpress] tracing is enabled \u2705");}let u=o.listen.bind(o);return o.listen=function(t,n){let s=process.env.NODE_ENV==="production",i=g?.version||"unknown";return e.debug(`[SuperExpress] is started with version ${i}`),e.debug(`[SuperExpress] will listen on port ${t}`),e.debug(`[SuperExpress] production mode: ${s}`),u(t,n)},Object.assign(o,{nativeListen:u})}export{S as default};//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../config/default-options.ts","../src/index.ts"],"names":["defaultOptions","safeRequire","createRequire","packageJson","fs","path","superExpress","logger","options","app","express","mergedOptions","morgan","tokens","req","res","values","HEADERS","_req","next","limit","aliveEndpoint","serverRunningSince","enableTracing","middleware","outbreak","nativeListen","port","callback","isProd","version"],"mappings":"+GA6BO,IAAMA,CAAiB,CAAA,CAC5B,UAAY,CAAA,QAAA,CACZ,MAAQ,CAAA,IAAA,CACR,OAAQ,IACR,CAAA,KAAA,CAAO,IACP,CAAA,KAAA,CAAO,IACP,CAAA,OAAA,CAAS,KACT,wBAA0B,CAAA,IAC5B,CC9BA,CAAA,IAAMC,CAAcC,CAAAA,aAAAA,CAAc,YAAY,GAAG,CAAA,CAE3CC,CAAc,CAAA,IAAA,CAAK,KAAMC,CAAAA,CAAAA,CAAG,aAAaC,CAAK,CAAA,OAAA,CAAQ,MAAY,CAAA,IAAA,CAAA,OAAA,CAAS,iBAAiB,CAAA,CAAG,MAAM,CAAC,CAAA,CAqB7F,SAARC,CAAAA,CAA8B,CAAE,MAAA,CAAAC,EAAQ,GAAGC,CAAQ,CAA6B,CAAA,CACnF,IAAMC,CAAAA,CAAMC,GACNC,CAAAA,CAAAA,CAAgB,CAAE,GAAGX,CAAgB,CAAA,GAAGQ,CAAQ,CAEtD,CAAA,GAAIG,CAAc,CAAA,MAAA,CAAQ,CACtB,IAAMC,EAASX,CAAY,CAAA,QAAQ,CACnCM,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACrDE,CAAI,CAAA,GAAA,CAAIG,CAAO,CAAA,CAACC,CAAQC,CAAAA,CAAAA,CAAKC,IAAQ,CACjC,IAAMC,CAAS,CAAA,CACX,MAAQH,CAAAA,CAAAA,CAAO,OAAOC,CAAKC,CAAAA,CAAG,CAC9B,CAAA,GAAA,CAAKF,CAAO,CAAA,GAAA,CAAIC,EAAKC,CAAG,CAAA,EAAK,aAC7B,CAAA,MAAA,CAAQF,CAAO,CAAA,MAAA,CAAOC,EAAKC,CAAG,CAAA,CAC9B,aAAeF,CAAAA,CAAAA,CAAO,GAAIC,CAAAA,CAAAA,CAAKC,EAAK,gBAAgB,CAAA,CACpD,YAAcF,CAAAA,CAAAA,CAAO,eAAe,CAAA,CAAEC,EAAKC,CAAG,CAAA,EAAK,GACnD,CAAA,SAAA,CAAWF,CAAO,CAAA,YAAY,EAAEC,CAAKC,CAAAA,CAAG,CAC5C,CAAA,CACAR,CAAO,CAAA,IAAA,CAAKS,EAAO,GAAK,CAAA,CACpB,WAAa,CAAA,CACX,MAAQA,CAAAA,CAAAA,CAAO,OACf,UAAYA,CAAAA,CAAAA,CAAO,GACnB,CAAA,aAAA,CAAeA,CAAO,CAAA,MAAA,CACtB,aAAcA,CAAO,CAAA,aAAA,CACrB,OAAS,CAAA,CACP,OAAS,CAAA,MAAA,CAAO,SAASA,CAAO,CAAA,YAAA,CAAc,EAAE,CAAA,CAAI,GACpD,CAAA,KAAA,CAAO,OAAO,QAASA,CAAAA,CAAAA,CAAO,YAAc,CAAA,EAAE,CAAI,CAAA,GACpD,EACA,SAAWA,CAAAA,CAAAA,CAAO,SACpB,CACJ,CAAC,EAEL,CAAC,CAAC,EACN,CAEA,GAAIL,CAAc,CAAA,MAAA,CAAQ,CACtBJ,CAAO,CAAA,KAAA,CAAM,2CAAsC,CAAA,CAEnD,IAAMU,CAAAA,CAAU,CACZ,yBACI,CAAA,6PAAA,CACJ,4BAA8B,CAAA,aAAA,CAC9B,8BAAgC,CAAA,aAAA,CAChC,uBAAwB,IACxB,CAAA,iBAAA,CAAmB,aACnB,CAAA,2BAAA,CAA6B,qCAC7B,CAAA,wBAAA,CAA0B,UAC1B,wBAA0B,CAAA,KAAA,CAC1B,oBAAsB,CAAA,QAAA,CACtB,iBAAmB,CAAA,YAAA,CACnB,oCAAqC,MACrC,CAAA,kBAAA,CAAoB,GACxB,CAAA,CACAR,CAAI,CAAA,GAAA,CAAI,CAACS,CAAMH,CAAAA,CAAAA,CAAKI,CAAS,GAAA,CACzBJ,CAAI,CAAA,GAAA,CAAIE,CAAO,CACfE,CAAAA,CAAAA,GACJ,CAAC,CACDV,CAAAA,CAAAA,CAAI,QAAQ,cAAc,EAC9B,CACIF,KAAAA,CAAAA,CAAO,IAAK,CAAA,wDAAiD,EAGjE,GAAII,CAAAA,CAAc,UAAY,CAAA,CAC1BJ,CAAO,CAAA,KAAA,CAAM,8CAAyC,CACtD,CAAA,IAAMa,CAAQ,CAAA,OAAOT,CAAc,CAAA,UAAA,EAAe,SAAWA,CAAc,CAAA,UAAA,CAAa,QACxFF,CAAAA,CAAAA,CAAI,GAAIC,CAAAA,CAAAA,CAAQ,KAAK,CAAE,KAAA,CAAAU,CAAM,CAAC,CAAC,EACnC,MACIb,CAAO,CAAA,KAAA,CAAM,+CAA0C,CAAA,CAG3D,GAAII,CAAAA,CAAc,MAAO,CACrB,GAAM,CAAE,aAAA,CAAAU,CAAc,CAAA,CAAIpB,EAAY,kBAAkB,CAAA,CACxDQ,CAAI,CAAA,GAAA,CAAI,QAAUY,CAAAA,CAAAA,CAAc,CAAE,MAAAd,CAAAA,CAAAA,CAAQ,GAAGI,CAAAA,CAAc,oBAAqB,CAAC,CAAC,CAClFJ,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACzD,CAEA,GAAII,CAAc,CAAA,KAAA,CAAO,CACrB,IAAMW,CAAqB,CAAA,IAAI,KAC/Bb,CAAI,CAAA,GAAA,CAAI,QAAU,CAAA,CAACS,CAAMH,CAAAA,CAAAA,GAAQ,CAC7BA,CAAI,CAAA,IAAA,CAAK,CACL,IAAA,CAAMJ,CAAc,CAAA,IAAA,EAAQ,eAC5B,OAASA,CAAAA,CAAAA,CAAc,OAAW,EAAA,iBAAA,CAClC,kBAAAW,CAAAA,CACJ,CAAC,EACL,CAAC,CACDf,CAAAA,CAAAA,CAAO,KAAM,CAAA,6CAAwC,EACzD,CAEA,GAAII,CAAc,CAAA,OAAA,CAAS,CACvB,GAAM,CAAE,aAAAY,CAAAA,CAAAA,CAAe,UAAAC,CAAAA,CAAAA,CAAY,QAAAC,CAAAA,CAAS,EAAIxB,CAAY,CAAA,kBAAkB,CAC9EsB,CAAAA,CAAAA,EACAhB,CAAAA,CAAAA,CAAO,qBAAqB,KAAO,CAC/B,OAASkB,CAAAA,CAAAA,CAAS,iBAAkB,EAAA,EAAG,SAAS,GAAI,CAAA,YAAY,CACpE,CAAA,CAAE,CAEFhB,CAAAA,CAAAA,CAAI,IAAIe,CAAW,CAAA,CACf,wBAA0Bb,CAAAA,CAAAA,CAAc,wBAC5C,CAAC,CAAC,CACFJ,CAAAA,CAAAA,CAAO,KAAM,CAAA,0CAAqC,EACtD,CAEA,IAAMmB,CAAqCjB,CAAAA,CAAAA,CAAI,MAAO,CAAA,IAAA,CAAKA,CAAG,CAAA,CAC9D,OAAAA,CAAI,CAAA,MAAA,CAAS,SAAUkB,CAAAA,CAAcC,CAAuB,CAAA,CACxD,IAAMC,CAAS,CAAA,OAAA,CAAQ,GAAI,CAAA,QAAA,GAAa,YAClCC,CAAAA,CAAAA,CAAU3B,GAAa,OAAW,EAAA,SAAA,CACxC,OAAAI,CAAAA,CAAO,KAAM,CAAA,CAAA,uCAAA,EAA0CuB,CAAO,CAAE,CAAA,CAAA,CAChEvB,CAAO,CAAA,KAAA,CAAM,CAAsCoB,mCAAAA,EAAAA,CAAI,EAAE,CACzDpB,CAAAA,CAAAA,CAAO,KAAM,CAAA,CAAA,gCAAA,EAAmCsB,CAAM,CAAA,CAAE,EACjDH,CAAaC,CAAAA,CAAAA,CAAMC,CAAQ,CACtC,CAEO,CAAA,MAAA,CAAO,MAAOnB,CAAAA,CAAAA,CAAK,CAAE,YAAA,CAAAiB,CAAa,CAAC,CAC9C","file":"index.js","sourcesContent":["import { LoggerInstanceManager } from '@autofleet/logger';\nimport { aliveEndpoint } from '@autofleet/nitur';\n\n/** Options to customize the behavior of the SuperExpress application. */\nexport interface Options {\n    /** The name of the application. @default 'default-name' */\n    name?: string;\n    /** The version of the application. @default 'default-version' */\n    version?: string;\n    /** Enables or disables body parser middleware. if given a string, will be used as the limit for body size @default '1000mb' */\n    bodyParser?: boolean | string;\n    /** Enables or disables security headers middleware. @default true */\n    helmet?: boolean;\n    /** Enables or disables HTTP request logging middleware. @default true */\n    morgan?: boolean;\n    /** Enables or disables the alive endpoint middleware. @default true */\n    nitur?: boolean;\n    /** Enables or disables the stats endpoint middleware. @default true */\n    stats?: boolean;\n    /** Enables or disables request tracing middleware. @default true */\n    tracing?: boolean;\n    /** Enables or disables eager loading of user permissions for tracing middleware. @default true */\n    eagerLoadUserPermissions?: boolean;\n    /** Options to customize the alive endpoint middleware. */\n    aliveEndpointOptions?: Omit<Parameters<typeof aliveEndpoint>[0], 'logger'>;\n    /** The servers logger instance. */\n    logger: LoggerInstanceManager;\n}\n\nexport const defaultOptions = {\n  bodyParser: '1000mb',\n  helmet: true,\n  morgan: true,\n  nitur: true,\n  stats: true,\n  tracing: true,\n  eagerLoadUserPermissions: true,\n} satisfies Omit<Options, 'logger'>;","import fs from 'node:fs';\nimport path from 'node:path';\nimport type { Server } from 'node:http';\nimport { createRequire } from 'node:module';\nimport express from 'express';\nimport { defaultOptions, Options } from '../config/default-options.js';\n\nconst safeRequire = createRequire(import.meta.url);\n\nconst packageJson = JSON.parse(fs.readFileSync(path.resolve(import.meta.dirname, '../package.json'), 'utf8'));\n\n/** Extended express.Application interface which includes nativeListen and the overridden listen method. */\ninterface SuperExpressApp extends Omit<express.Application, 'listen'> {\n    /** Original express listen method. */\n    nativeListen: express.Application['listen'];\n\n    /**\n     * Overridden listen method to add custom behavior.\n     * @param port - The port number to listen on.\n     * @param cb - Optional callback function to execute after the server starts listening.\n     */\n    listen(port: number, cb?: () => void): Server;\n}\n\n/**\n * Creates a new SuperExpress application with the given options.\n * @param options - Optional settings to customize the application.\n * @param expressOptions - Optional settings to customize express.\n * @returns A SuperExpress application instance.\n */\nexport default function superExpress({ logger, ...options }: Options): SuperExpressApp {\n    const app = express();\n    const mergedOptions = { ...defaultOptions, ...options };\n    /** Formatting */\n    if (mergedOptions.morgan) {\n        const morgan = safeRequire('morgan') as typeof import('morgan');\n        logger.debug('[SuperExpress] formatting is enabled ✅');\n        app.use(morgan((tokens, req, res) => {\n            const values = {\n                method: tokens.method(req, res),\n                url: tokens.url(req, res) ?? 'unknown URL',\n                status: tokens.status(req, res),\n                contentLength: tokens.res(req, res, 'content-length'),\n                responseTime: tokens['response-time'](req, res) ?? '0',\n                userAgent: tokens['user-agent'](req, res),\n            };\n            logger.info(values.url, {\n                httpRequest: {\n                  status: values.status,\n                  requestUrl: values.url,\n                  requestMethod: values.method,\n                  responseSize: values.contentLength,\n                  latency: {\n                    seconds: Number.parseInt(values.responseTime, 10) / 1_000,\n                    nanos: Number.parseInt(values.responseTime, 10) * 1_000_000,\n                  },\n                  userAgent: values.userAgent,\n                },\n            });\n            return undefined;\n        }));\n    }\n    /** Security */\n    if (mergedOptions.helmet) {\n        logger.debug('[SuperExpress] security is enabled ✅');\n        // this is what helmet does by default. https://helmetjs.github.io/faq/you-might-not-need-helmet/\n        const HEADERS = {\n            \"Content-Security-Policy\":\n                \"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests\",\n            \"Cross-Origin-Opener-Policy\": \"same-origin\",\n            \"Cross-Origin-Resource-Policy\": \"same-origin\",\n            \"Origin-Agent-Cluster\": \"?1\",\n            \"Referrer-Policy\": \"no-referrer\",\n            \"Strict-Transport-Security\": \"max-age=15552000; includeSubDomains\",\n            \"X-Content-Type-Options\": \"nosniff\",\n            \"X-DNS-Prefetch-Control\": \"off\",\n            \"X-Download-Options\": \"noopen\",\n            \"X-Frame-Options\": \"SAMEORIGIN\",\n            \"X-Permitted-Cross-Domain-Policies\": \"none\",\n            \"X-XSS-Protection\": \"0\",\n        };\n        app.use((_req, res, next) => {\n            res.set(HEADERS);\n            next();\n        });\n        app.disable('x-powered-by');\n    } else {\n        logger.warn('[SuperExpress] security headers are disabled 😨');\n    }\n    /** Body Parser */\n    if (mergedOptions.bodyParser) {\n        logger.debug('[SuperExpress] body-parser is enabled ✅');\n        const limit = typeof mergedOptions.bodyParser === 'string' ? mergedOptions.bodyParser : '1000mb';\n        app.use(express.json({ limit }))\n    } else {\n        logger.debug('[SuperExpress] body-parser is disabled ❌');\n    }\n    /** Alive Endpoint */\n    if (mergedOptions.nitur) {\n        const { aliveEndpoint } = safeRequire('@autofleet/nitur') as typeof import('@autofleet/nitur');\n        app.get('/alive', aliveEndpoint({ logger, ...mergedOptions.aliveEndpointOptions }));\n        logger.debug('[SuperExpress] added /alive endpoint ✅');\n    }\n    /** Stats Endpoint */\n    if (mergedOptions.stats) {\n        const serverRunningSince = new Date();\n        app.get('/stats', (_req, res) => {\n            res.json({\n                name: mergedOptions.name || 'default-name',\n                version: mergedOptions.version || 'default-version',\n                serverRunningSince,\n            });\n        });\n        logger.debug('[SuperExpress] added /stats endpoint ✅');\n    }\n    /** Tracing */\n    if (mergedOptions.tracing) {\n        const { enableTracing, middleware, outbreak } = safeRequire('@autofleet/zehut') as typeof import('@autofleet/zehut');\n        enableTracing();\n        logger.addContextMiddleware(() => ({\n            traceId: outbreak.getCurrentContext()?.context?.get('x-trace-id'),\n        }));\n\n        app.use(middleware({\n            eagerLoadUserPermissions: mergedOptions.eagerLoadUserPermissions,\n        }));\n        logger.debug('[SuperExpress] tracing is enabled ✅');\n    }\n\n    const nativeListen: typeof app['listen'] = app.listen.bind(app);\n    app.listen = function (port: number, callback?: () => void) {\n        const isProd = process.env.NODE_ENV === 'production';\n        const version = packageJson?.version || 'unknown';\n        logger.debug(`[SuperExpress] is started with version ${version}`);\n        logger.debug(`[SuperExpress] will listen on port ${port}`);\n        logger.debug(`[SuperExpress] production mode: ${isProd}`);\n        return nativeListen(port, callback)\n    } as typeof app['listen'];\n\n    return Object.assign(app, { nativeListen }) as SuperExpressApp;\n};"]}

package/package.json

@@ -1,18 +1,53 @@
 {
   "name": "@autofleet/super-express",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "AF Express with built in boilerplate",
-  "main": "src/index.js",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "author": "Autofleet",
   "license": "MIT",
+  "files": [
+    "dist/"
+  ],
   "dependencies": {
-    "@autofleet/nitur": "^1.3.4",
-    "@autofleet/zehut": "^3.0.10",
-    "express": "^4.19.2",
+    "@autofleet/nitur": "^2.1.0",
+    "@autofleet/zehut": "^3.2.0",
+    "express": "^4.21.2",
     "morgan": "^1.10.0"
   },
+  "peerDependencies": {
+    "@autofleet/logger": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@autofleet/logger": "^4.2.1",
+    "@types/express": "^4.17.21",
+    "@types/morgan": "^1.9.9",
+    "@types/supertest": "^6.0.2",
+    "supertest": "^7.0.0",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2"
+  },
   "scripts": {
-    "test": "node --test test/index.test.js"
+    "test": "tsx --test",
+    "build": "tsup"
   },
   "repository": {
     "type": "git",
@@ -21,9 +56,5 @@
   "bugs": {
     "url": "https://github.com/Autofleet/super-express/issues"
   },
-  "homepage": "https://github.com/Autofleet/super-express#readme",
-  "devDependencies": {
-    "@types/express": "^4.17.21",
-    "supertest": "^7.0.0"
-  }
+  "homepage": "https://github.com/Autofleet/super-express#readme"
 }

package/.nvmrc

@@ -1 +0,0 @@
-20.15.0

package/config/default-options.json

@@ -1,10 +0,0 @@
-{
-    "bodyParser": true,
-    "compression": true,
-    "helmet": true,
-    "morgan": true,
-    "nitur": true,
-    "stats": true,
-    "tracing": true,
-    "eagerLoadUserPermissions": true
-}

package/src/index.d.ts

@@ -1,86 +0,0 @@
-import * as express from 'express';
-
-/**
- * Options to customize the behavior of the SuperExpress application.
- */
-export interface DefaultOptions {
-    /**
-     * The name of the application.  
-     */
-    name?: string;
-    /**
-     * The version of the application.  
-     */
-    version?: string;
-    /**
-     * Enables or disables body parser middleware.
-     */
-    bodyParser?: boolean;
-    /**
-     * Enables or disables security headers middleware.
-     */
-    helmet?: boolean;
-    /**
-     * Enables or disables HTTP request logging middleware.
-     */
-    morgan?: boolean;
-    /**
-     * Enables or disables the alive endpoint middleware.
-     */
-    nitur?: boolean;
-    /**
-     * Enables or disables the stats endpoint middleware.
-     */
-    stats?: boolean;
-    /**
-     * Enables or disables request tracing middleware.
-     */
-    tracing?: boolean;
-    /**
-     * Enables or disables eager loading of user permissions for tracing middleware.
-     */
-    eagerLoadUserPermissions?: boolean;
-    /**
-     * Options to customize the alive endpoint middleware.
-     */
-    aliveEndpointOptions?: Record<string, unknown>;
-    // Add other options from config/default-options.json as needed
-}
-
-/**
- * Type for the callback function used in the listen method.
- */
-export type ListenCallback = () => void;
-
-type Listen = express.Application['listen'];
-type Server = Listen extends (port: any, cb: any) => infer R ? R : never;
-
-/**
- * Extends the express.Application interface to include nativeListen and the overridden listen method.
- */
-export interface SuperExpressApp extends express.Application {
-    /**
-     * Original express listen method.
-     */
-    nativeListen: Listen;
-
-    /**
-     * Overridden listen method to add custom behavior.
-     * @param port - The port number to listen on.
-     * @param cb - Optional callback function to execute after the server starts listening.
-     */
-    listen(port: number, cb?: ListenCallback): Server;
-}
-
-/**
- * Creates a new SuperExpress application with the given options.
- * @param options - Optional settings to customize the application.
- * @param expressOptions - Optional settings to customize express.
- * @returns A SuperExpress application instance.
- */
-declare function createSuperExpressApp(
-    options?: Partial<DefaultOptions>,
-    expressOptions?: express.ApplicationOptions,
-): SuperExpressApp;
-
-export = createSuperExpressApp;

package/src/index.js

@@ -1,94 +0,0 @@
-const express = require('express');
-const morgan = require('morgan');
-const { aliveEndpoint } = require('@autofleet/nitur');
-const zehut = require('@autofleet/zehut');
-const { enableTracing } = zehut;
-const fs = require('fs');
-const path = require('path');
-
-const defaultOptions = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../config/default-options.json'), 'utf8'));
-const packageJson = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8'));
-
-module.exports = function (options = {}, expressOptions = {}) {
-    const app = express(expressOptions);
-    const mergedOptions = Object.assign({}, defaultOptions, options);
-    /** Formatting */
-    if (mergedOptions.morgan) {
-        console.log('[SuperExpress] formatting is enabled ✅');
-        app.use(morgan(':method :url :status :res[content-length] - :response-time ms'));
-    }
-    /** Security */
-    if (mergedOptions.helmet) {
-        console.log('[SuperExpress] security is enabled ✅');
-        // this is what helmet does by default. https://helmetjs.github.io/faq/you-might-not-need-helmet/
-        const HEADERS = {
-            "Content-Security-Policy":
-                "default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests",
-            "Cross-Origin-Opener-Policy": "same-origin",
-            "Cross-Origin-Resource-Policy": "same-origin",
-            "Origin-Agent-Cluster": "?1",
-            "Referrer-Policy": "no-referrer",
-            "Strict-Transport-Security": "max-age=15552000; includeSubDomains",
-            "X-Content-Type-Options": "nosniff",
-            "X-DNS-Prefetch-Control": "off",
-            "X-Download-Options": "noopen",
-            "X-Frame-Options": "SAMEORIGIN",
-            "X-Permitted-Cross-Domain-Policies": "none",
-            "X-XSS-Protection": "0",
-        };
-        app.use((req, res, next) => {
-            res.set(HEADERS);
-            next();
-        });
-        app.disable('x-powered-by');
-    }
-    /** Body Parser */
-    if (mergedOptions.bodyParser) {
-        console.log('[SuperExpress] body-parser is enabled ✅');
-        app.use(express.json({ limit: '1000mb' }))
-    } else {
-        console.log('[SuperExpress] body-parser is disabled ❌');
-    }
-    /** Alive Endpoint */
-    if (mergedOptions.nitur) {
-        app.get('/alive', aliveEndpoint(mergedOptions.aliveEndpointOptions || {}));
-        console.log('[SuperExpress] added /alive endpoint ✅');
-    }
-    /** Stats Endpoint */
-    if (mergedOptions.stats) {
-        const serverRunningSince = new Date();
-        app.get('/stats', (req, res) => {
-            res.json({
-                name: mergedOptions.name || 'default-name',
-                version: mergedOptions.version || 'default-version',
-                serverRunningSince,
-            });
-        });
-        console.log('[SuperExpress] added /stats endpoint ✅');
-    }
-    /** Tracing */
-    if (mergedOptions.tracing) {
-        enableTracing({
-            outbreakOptions: {
-                headersPrefix: 'x-af',
-            },
-        });
-
-        app.use(zehut.middleware({
-            eagerLoadUserPermissions: mergedOptions.eagerLoadUserPermissions,
-        }));
-        console.log('[SuperExpress] tracing is enabled ✅');
-    }
-
-    app.nativeListen = app.listen
-    app.listen = function (port, cb) {
-        const isProd = process.env.NODE_ENV === 'production';
-        const version = packageJson?.version || 'unknown';
-        console.log(`[SuperExpress] is started with version ${version}`);
-        console.log(`[SuperExpress] will listen on port ${port}`);
-        console.log(`[SuperExpress] production mode: ${isProd}`);
-        return app.nativeListen(port, cb)
-    }
-
-    return app
-};

package/test/index.test.js

@@ -1,80 +0,0 @@
-const assert = require('assert').strict;
-const { test } = require('node:test');
-const supertest = require('supertest');
-const createSuperExpressApp = require('../src/index.js');
-
-// Mock the default-options.json file content
-const defaultOptions = {
-    bodyParser: true,
-    helmet: true,
-    morgan: true,
-    nitur: true,
-    stats: true,
-    tracing: true,
-    eagerLoadUserPermissions: true,
-};
-
-// Test for the existence of default middleware
-test('should create an app with default middleware', async () => {
-    const app = createSuperExpressApp();
-
-    // Test for the existence of bodyParser middleware
-    await supertest(app)
-        .post('/')
-        .send({ key: 'value' })
-        .expect(404); // Expect 404 because no routes are defined
-
-    // Test for the overridden listen method
-    const originalConsoleLog = console.log;
-    let logOutput = [];
-    console.log = (...args) => logOutput.push(...args);
-    const server = app.listen(3000, () => { });
-    assert(logOutput.includes('[SuperExpress] will listen on port 3000'));
-
-    console.log = originalConsoleLog;
-    server.close();
-});
-
-// Test for custom options
-test('should create an app with custom options', async () => {
-    const app = createSuperExpressApp(defaultOptions);
-    const server = app.listen(3000, () => { });
-
-    // Test for the alive endpoint
-    await supertest(app)
-        .get('/alive')
-        .expect(200);
-
-    // Test for the stats endpoint
-    await supertest(app)
-        .get('/stats')
-        .expect(200)
-        .expect((res) => {
-            assert(res.body.name);
-            assert(res.body.version);
-            assert(res.body.serverRunningSince);
-        });
-    server.close();
-});
-
-// Test for disabled body parser
-test('should disable body parser when option is set to false', async () => {
-    const originalConsoleLog = console.log;
-    let logOutput = [];
-    console.log = (...args) => logOutput.push(...args);
-
-    const app = createSuperExpressApp({ bodyParser: false });
-    const server = app.listen(3000, () => { });
-
-    try {
-        assert(logOutput.includes('[SuperExpress] body-parser is disabled ❌'));
-        await supertest(app)
-        .post('/')
-        .send({ key: 'value' })
-        .expect(404);
-    } finally {
-        console.log = originalConsoleLog;
-        server.close();
-    }
-
-});

package/test/mock-package.json

@@ -1 +0,0 @@
-{"name":"test-package","version":"1.0.0"}