@autofleet/super-express 2.2.1-beta-6c740761.2 → 2.2.1-beta-30e2192b.0

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var y=Object.create;var a=Object.defineProperty;var O=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,E=Object.prototype.hasOwnProperty;var h=(r,e)=>{for(var s in e)a(r,s,{get:e[s],enumerable:!0})},m=(r,e,s,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of x(e))!E.call(r,t)&&t!==s&&a(r,t,{get:()=>e[t],enumerable:!(o=O(e,t))||o.enumerable});return r};var l=(r,e,s)=>(s=r!=null?y(S(r)):{},m(e||!r||!r.__esModule?a(s,"default",{value:r,enumerable:!0}):s,r)),v=r=>m(a({},"__esModule",{value:!0}),r);var k={};h(k,{default:()=>b});module.exports=v(k);var c=l(require("express"),1),d=l(require("morgan"),1),g=require("@autofleet/nitur"),p=l(require("@autofleet/zehut"),1);var f={bodyParser:!0,compression:!0,helmet:!0,morgan:!0,nitur:!0,stats:!0,tracing:!0,eagerLoadUserPermissions:!0};function b(r={}){let e=(0,c.default)(r),s=Object.assign({},f,r);if(s.morgan&&e.use((0,d.default)(":method :url :status :res[content-length] - :response-time ms")),s.helmet){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"};e.use((i,n,u)=>{n.set(t),u()}),e.disable("x-powered-by")}if(s.bodyParser?e.use(c.default.json({limit:"1000mb"})):console.log("[SuperExpress] Body parser is disabled"),s.nitur&&e.get("/alive",(0,g.aliveEndpoint)(s.aliveEndpointOptions||{})),s.stats&&s.packageJsonPath){let t=new Date;import(s.packageJsonPath,{assert:{type:"json"}}).then(i=>{let n=i.default;e.get("/",(u,P)=>{P.json({name:n.name,version:n.version,commit:n.commit,serverRunningSince:t})})})}s.tracing&&((0,p.enableTracing)({outbreakOptions:{headersPrefix:"x-af"}}),e.use(p.default.middleware({eagerLoadUserPermissions:s.eagerLoadUserPermissions})));let o=e.listen;return Object.assign(e,{nativeListen:o,listen(t,i){let n=process.env.NODE_ENV==="production";return console.log(`[SuperExpress] will listen on port ${t}`),console.log(`[SuperExpress] Production mode: ${n}`),o(t,i)}}),e}

package/dist/index.d.cts

@@ -0,0 +1,67 @@
+import express from 'express';
+
+/**
+ * Options to customize the behavior of the SuperExpress application.
+ */
+type DefaultOptions = {
+    /**
+     * 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;
+    /**
+     * Path to the package.json file for the stats endpoint.
+     */
+    packageJsonPath?: string;
+    /**
+     * 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>;
+};
+/**
+ * Type for the callback function used in the listen method.
+ */
+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.
+ */
+interface SuperExpressApp extends Omit<express.Application, 'listen'> {
+    /**
+     * 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;
+}
+declare function superExpress(options?: Partial<DefaultOptions>): SuperExpressApp;
+
+export { type DefaultOptions, type SuperExpressApp, superExpress as default };

package/{src → dist}/index.d.ts

@@ -3,7 +3,7 @@ import express from 'express';
 /**
  * Options to customize the behavior of the SuperExpress application.
  */
-export type DefaultOptions = {
+type DefaultOptions = {
     /**
      * Enables or disables body parser middleware.
      */
@@ -40,25 +40,21 @@ export type DefaultOptions = {
      * 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.
  */
 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 Omit<express.Application, 'listen'> {
+interface SuperExpressApp extends Omit<express.Application, 'listen'> {
     /**
      * Original express listen method.
      */
     nativeListen: Listen;
-
     /**
      * Overridden listen method to add custom behavior.
      * @param port - The port number to listen on.
@@ -66,12 +62,6 @@ export interface SuperExpressApp extends Omit<express.Application, 'listen'> {
      */
     listen(port: number, cb?: ListenCallback): Server;
 }
+declare function superExpress(options?: Partial<DefaultOptions>): SuperExpressApp;
 
-/**
- * Creates a new SuperExpress application with the given options.
- * @param options - Optional settings to customize the application.
- * @returns A SuperExpress application instance.
- */
-export default function createSuperExpressApp(
-    options?: Partial<DefaultOptions>
-): SuperExpressApp;
+export { type DefaultOptions, type SuperExpressApp, superExpress as default };

package/dist/index.js

@@ -0,0 +1 @@
+import l from"express";import m from"morgan";import{aliveEndpoint as f}from"@autofleet/nitur";import d,{enableTracing as g}from"@autofleet/zehut";var p={bodyParser:!0,compression:!0,helmet:!0,morgan:!0,nitur:!0,stats:!0,tracing:!0,eagerLoadUserPermissions:!0};function b(o={}){let e=l(o),s=Object.assign({},p,o);if(s.morgan&&e.use(m(":method :url :status :res[content-length] - :response-time ms")),s.helmet){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"};e.use((n,r,a)=>{r.set(t),a()}),e.disable("x-powered-by")}if(s.bodyParser?e.use(l.json({limit:"1000mb"})):console.log("[SuperExpress] Body parser is disabled"),s.nitur&&e.get("/alive",f(s.aliveEndpointOptions||{})),s.stats&&s.packageJsonPath){let t=new Date;import(s.packageJsonPath,{assert:{type:"json"}}).then(n=>{let r=n.default;e.get("/",(a,c)=>{c.json({name:r.name,version:r.version,commit:r.commit,serverRunningSince:t})})})}s.tracing&&(g({outbreakOptions:{headersPrefix:"x-af"}}),e.use(d.middleware({eagerLoadUserPermissions:s.eagerLoadUserPermissions})));let i=e.listen;return Object.assign(e,{nativeListen:i,listen(t,n){let r=process.env.NODE_ENV==="production";return console.log(`[SuperExpress] will listen on port ${t}`),console.log(`[SuperExpress] Production mode: ${r}`),i(t,n)}}),e}export{b as default};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@autofleet/super-express",
-  "version": "2.2.1-beta-6c740761.2",
+  "version": "2.2.1-beta-30e2192b.0",
   "description": "AF Express with built in boilerplate",
-  "main": "src/index.mjs",
-  "module": "src/index.mjs",
-  "types": "src/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
   "author": "Autofleet",
   "license": "MIT",
@@ -15,9 +15,9 @@
     "morgan": "^1.10.0"
   },
   "scripts": {
-    "test": "node --test test/index.test.js",
-    "build": "",
-    "publish": "npm publish"
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "node --test test/index.test.js"
   },
   "repository": {
     "type": "git",
@@ -29,17 +29,21 @@
   "homepage": "https://github.com/Autofleet/super-express#readme",
   "devDependencies": {
     "@types/express": "^4.17.21",
-    "supertest": "^7.0.0"
+    "@types/morgan": "^1.9.9",
+    "supertest": "^7.0.0",
+    "tsup": "^8.2.2",
+    "typescript": "^5.5.3"
   },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": {
-        "default": "./src/index.mjs",
-        "types": "./src/index.d.ts"
+        "default": "./dist/index.js",
+        "types": "./dist/index.d.ts"
       },
       "require": {
-        "default": "./src/index.cjs",
-        "types": "./src/index.d.cts"
+        "default": "./dist/index.cjs",
+        "types": "./dist/index.d.cts"
       }
     }
   }

package/src/index.ts

@@ -0,0 +1,157 @@
+import express from 'express';
+import morgan from 'morgan';
+import { aliveEndpoint } from '@autofleet/nitur';
+import zehut, { enableTracing } from '@autofleet/zehut';
+
+import defaultOptions from '../config/default-options.json' assert { type: "json" };
+
+/**
+ * Options to customize the behavior of the SuperExpress application.
+ */
+export type DefaultOptions = {
+    /**
+     * 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;
+    /**
+     * Path to the package.json file for the stats endpoint.
+     */
+    packageJsonPath?: string;
+    /**
+     * 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.
+ */
+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 Omit<express.Application, 'listen'> {
+    /**
+     * 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;
+}
+
+export default function superExpress(options: Partial<DefaultOptions> = {}): SuperExpressApp {
+    // @ts-expect-error we pass options which express doesn't handle
+    const app = express(options);
+    const mergedOptions: DefaultOptions = Object.assign({}, defaultOptions, options);
+    /** Formatting */
+    if (mergedOptions.morgan) {
+        app.use(morgan(':method :url :status :res[content-length] - :response-time ms'));
+    }
+    /** Security */
+    if (mergedOptions.helmet) {
+        // 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) {
+        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 || {}));
+    }
+    /** Stats Endpoint */
+    if (mergedOptions.stats && mergedOptions.packageJsonPath) {
+        const serverRunningSince = new Date();
+        import(mergedOptions.packageJsonPath, { assert: { type: 'json' } })
+            .then(module => {
+                const packageJson = module.default;
+                app.get('/', (req, res) => {
+                    res.json({
+                        name: packageJson.name,
+                        version: packageJson.version,
+                        commit: packageJson.commit,
+                        serverRunningSince,
+                    });
+                });
+            });
+    }
+    /** Tracing */
+    if (mergedOptions.tracing) {
+        enableTracing({
+            outbreakOptions: {
+                headersPrefix: 'x-af',
+            },
+        });
+
+        app.use(zehut.middleware({
+            eagerLoadUserPermissions: mergedOptions.eagerLoadUserPermissions,
+        }));
+    }
+
+    const nativeListen = app.listen;
+    Object.assign(app, {
+        nativeListen,
+        listen(port: number, cb?: ListenCallback) {
+            const isProd = process.env.NODE_ENV === 'production';
+            console.log(`[SuperExpress] will listen on port ${port}`);
+            console.log(`[SuperExpress] Production mode: ${isProd}`);
+            return nativeListen(port, cb)
+        }
+    });
+
+    return app as unknown as SuperExpressApp;
+};

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": false,
+    "moduleResolution": "NodeNext",
+    "resolveJsonModule": true,
+    "skipLibCheck": true
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig((options) => ({
+  entry: ['src/index.ts'],
+  target: 'node20.0',
+  format: ['esm', 'cjs'],
+  clean: !options.watch,
+  minify: !options.watch,
+  dts: true,
+}));

package/src/index.cjs

@@ -1,86 +0,0 @@
-const express = require('express');
-const morgan = require('morgan');
-const { aliveEndpoint } = require('@autofleet/nitur');
-const { default: zehut, enableTracing } = require('@autofleet/zehut');
-const defaultOptions = require('../config/default-options.json');
-
-module.exports = function superExpress(options = {}) {
-    const app = express(options);
-    const mergedOptions = Object.assign({}, defaultOptions, options);
-    /** Formatting */
-    if (mergedOptions.morgan) {
-        app.use(morgan(':method :url :status :res[content-length] - :response-time ms'));
-    }
-    /** Security */
-    if (mergedOptions.helmet) {
-        // 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) {
-        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 || {}));
-    }
-    /** Stats Endpoint */
-    if (mergedOptions.stats && mergedOptions.packageJsonPath) {
-        const serverRunningSince = new Date();
-        import(mergedOptions.packageJsonPath, { assert: { type: 'json' } })
-            .then(module => {
-                const packageJson = module.default;
-                app.get('/', (req, res) => {
-                    res.json({
-                        name: packageJson.name,
-                        version: packageJson.version,
-                        commit: packageJson.commit,
-                        serverRunningSince,
-                    });
-                });
-            });
-    }
-    /** Tracing */
-    if (mergedOptions.tracing) {
-        enableTracing({
-            outbreakOptions: {
-                headersPrefix: 'x-af',
-            },
-        });
-
-        app.use(zehut.middleware({
-            eagerLoadUserPermissions: mergedOptions.eagerLoadUserPermissions,
-        }));
-    }
-
-    app.nativeListen = app.listen
-    app.listen = function (port, cb) {
-        const isProd = process.env.NODE_ENV === 'production';
-        console.log(`[SuperExpress] will listen on port ${port}`);
-        console.log(`[SuperExpress] Production mode: ${isProd}`);
-        return app.nativeListen(port, cb)
-    }
-
-    return app
-};

package/src/index.d.cts

@@ -1,10 +0,0 @@
-import type createSuperExpressApp from './index.d.ts';
-import type { DefaultOptions as Options, SuperExpressApp as _SuperExpressApp } from './index.d.ts';
-
-declare namespace createSuperExpressApp {
-    export type DefaultOptions = Options;
-    export type SuperExpressApp = _SuperExpressApp;
-
-}
-
-export = createSuperExpressApp;

package/src/index.mjs

@@ -1,7 +0,0 @@
-import { createRequire } from 'node:module';
-
-const require = createRequire(import.meta.url);
-const superExpress = require('./index.cjs');
-
-
-export default superExpress;