@autofleet/super-express 1.1.21-beta-4 → 2.1.0

package/index.d.ts

@@ -0,0 +1,43 @@
+import express from 'express';
+
+/**
+ * Options to customize the behavior of the SuperExpress application.
+ */
+export type DefaultOptions = {
+    /**
+     * Enables or disables body parser middleware.
+     */
+    bodyParser?: boolean;
+    // Add other options from default-options.json as needed
+};
+
+/**
+ * Type for the callback function used in the listen method.
+ */
+type ListenCallback = () => void;
+
+/**
+ * Extends the express.Application interface to include nativeListen and the overridden listen method.
+ */
+export interface SuperExpressApp extends express.Application {
+    /**
+     * 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?: ListenCallback): void;
+}
+
+/**
+ * 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 & express.ApplicationOptions>
+): SuperExpressApp;

package/index.js

@@ -1,53 +1,27 @@
-const express = require('express')
+import express from 'express';
+import helmet from 'helmet';
+import morgan from 'morgan';
 
-const chalk = require('chalk');
+import defaultOptions from './default-options.json';
 
-const helmet = require('helmet')
-const bodyParser = require('body-parser')
-const morgan = require('morgan')
+export default function(options = {}) {
+    const app = express(options);
+    const isProd = process.env.NODE_ENV === 'production';
+    const mergedOptions = Object.assign({}, defaultOptions, options);
 
-const defaultOptions = require('./default-options.json')
-
-module.exports = function(options = {}) {
-    const app = express(options)
-
-    const isProd = process.env.NODE_ENV === 'production'
-    const isStage = process.env.NODE_ENV === 'staging'
-    const mergedOptions = Object.assign({}, defaultOptions, options)
-
-    if (options.httpLogCb) {
-        app.use(morgan((tokens, req, res) => {
-            options.httpLogCb({
-                method: tokens.method(req, res),
-                url: tokens.url(req, res),
-                status: tokens.status(req, res),
-                'content-length': tokens.res(req, res, 'content-length'),
-                'response-time': tokens['response-time'](req, res),
-                'user-agent': tokens['user-agent'](req, res),
-            })
-        }))
-    } else {
-        app.use(morgan(':method :url :status :res[content-length] - :response-time ms'))
-    }
-
-    // Timeout
-    app.use((req, res, next) => {
-        req.socket.setKeepAlive(true);
-        next();
-    });
-      
-
-    // General
+    app.use(morgan(':method :url :status :res[content-length] - :response-time ms'));
     app.use(helmet());
-    if( mergedOptions.bodyParser ) {
-        app.use(bodyParser.json({ limit: '1000mb' }))
+    if (mergedOptions.bodyParser) {
+        app.use(express.json({ limit: '1000mb' }))
+    } else {
+        console.log('[SuperExpress] Body parser is disabled');
     }
 
     app.nativeListen = app.listen
     app.listen = function (port, cb) {
-        console.log(chalk.blue(`Super express will listen on port ${port}`))
-        console.log(chalk.blue(`Production mode: ${isProd}`))
-        return app.nativeListen(port, cb)
+        console.log(`[SuperExpress] will listen on port ${port}`);
+        console.log(`[SuperExpress] Production mode: ${isProd}`);
+        app.nativeListen(port, cb)
     }
 
     return app

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@autofleet/super-express",
-  "version": "1.1.21-beta-4",
+  "version": "2.1.0",
   "description": "AF Express with built in boilerplate",
   "main": "index.js",
-  "author": "",
+  "type": "module",
+  "author": "Autofleet",
   "license": "MIT",
   "dependencies": {
-    "body-parser": "^1.19.0",
-    "chalk": "^2.4.1",
-    "express": "^4.17.1",
-    "helmet": "^4.6.0",
-    "morgan": "^1.10.0"
+    "express": "^4.19.2",
+    "helmet": "^3.21.2",
+    "morgan": "^1.9.1"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -22,5 +21,9 @@
   "bugs": {
     "url": "https://github.com/Autofleet/super-express/issues"
   },
-  "homepage": "https://github.com/Autofleet/super-express#readme"
+  "homepage": "https://github.com/Autofleet/super-express#readme",
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/helmet": "^4.0.0"
+  }
 }