@autofleet/super-express 4.0.0 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/super-express",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "AF Express with built in boilerplate",
   "main": "src/index.js",
   "author": "Autofleet",
@@ -12,8 +12,7 @@
     "morgan": "^1.10.0"
   },
   "scripts": {
-    "test": "node --test test/index.test.js",
-    "publish": "npm publish"
+    "test": "node --test test/index.test.js"
   },
   "repository": {
     "type": "git",

package/src/index.d.ts

@@ -1,82 +1,86 @@
 import * as express from 'express';
 
-declare namespace SuperExpress {
+/**
+ * Options to customize the behavior of the SuperExpress application.
+ */
+export interface DefaultOptions {
     /**
-     * Options to customize the behavior of the SuperExpress application.
+     * The name of the application.  
      */
-    interface 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
-    }
-
+    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;
     /**
-     * Type for the callback function used in the listen method.
+     * Enables or disables the stats endpoint middleware.
      */
-    type ListenCallback = () => void;
+    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;
+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 {
     /**
-     * Extends the express.Application interface to include nativeListen and the overridden listen method.
+     * Original express listen method.
      */
-    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;
-    }
+    nativeListen: Listen;
 
     /**
-     * Creates a new SuperExpress application with the given options.
-     * @param options - Optional settings to customize the application.
-     * @returns A SuperExpress application instance.
+     * 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.
      */
-    function createSuperExpressApp(
-        options?: Partial<DefaultOptions & express.ApplicationOptions>
-    ): SuperExpressApp;
+    listen(port: number, cb?: ListenCallback): Server;
 }
 
-export = SuperExpress;
+/**
+ * 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

@@ -7,16 +7,19 @@ 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 = {}) {
-    const app = express(options);
+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":
@@ -41,26 +44,27 @@ module.exports = function (options = {}) {
     }
     /** 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');
+        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 && mergedOptions.packageJsonPath) {
-        // const serverRunningSince = new Date();
-        // const packageJson = require(mergedOptions.packageJsonPath);
-        // app.get('/', (req, res) => {
-        //     res.json({
-        //         name: packageJson.name,
-        //         version: packageJson.version,
-        //         commit: packageJson.commit,
-        //         serverRunningSince,
-        //     });
-        // });
+    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) {
@@ -73,13 +77,16 @@ module.exports = function (options = {}) {
         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}`);
+        console.log(`[SuperExpress] production mode: ${isProd}`);
         return app.nativeListen(port, cb)
     }
 

package/test/index.test.js

@@ -1,17 +1,7 @@
-// index.test.js
 const assert = require('assert').strict;
 const { test } = require('node:test');
 const supertest = require('supertest');
 const createSuperExpressApp = require('../src/index.js');
-const fs = require('fs');
-const path = require('path');
-
-// Mock the package.json file content
-const mockPackageJson = {
-    name: 'test-package',
-    version: '1.0.0',
-    commit: 'abcdef123456'
-};
 
 // Mock the default-options.json file content
 const defaultOptions = {
@@ -20,15 +10,10 @@ const defaultOptions = {
     morgan: true,
     nitur: true,
     stats: true,
-    packageJsonPath: '../test/mock-package.json',
     tracing: true,
     eagerLoadUserPermissions: true,
-    aliveEndpointOptions: { customOption: 'value' }
 };
 
-// Write the mock package.json file to disk
-fs.writeFileSync(path.resolve(__dirname, './mock-package.json'), JSON.stringify(mockPackageJson));
-
 // Test for the existence of default middleware
 test('should create an app with default middleware', async () => {
     const app = createSuperExpressApp();
@@ -43,7 +28,7 @@ test('should create an app with default middleware', async () => {
     const originalConsoleLog = console.log;
     let logOutput = [];
     console.log = (...args) => logOutput.push(...args);
-    const server = app.listen(3000, () => {});
+    const server = app.listen(3000, () => { });
     assert(logOutput.includes('[SuperExpress] will listen on port 3000'));
 
     console.log = originalConsoleLog;
@@ -53,6 +38,7 @@ test('should create an app with default middleware', async () => {
 // 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)
@@ -60,14 +46,15 @@ test('should create an app with custom options', async () => {
         .expect(200);
 
     // Test for the stats endpoint
-    // await supertest(app)
-    //     .get('/')
-    //     .expect(200)
-    //     .expect((res) => {
-    //         assert(res.body.name);
-    //         assert(res.body.version);
-    //         assert(res.body.serverRunningSince);
-    //     });
+    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
@@ -77,13 +64,17 @@ test('should disable body parser when option is set to false', async () => {
     console.log = (...args) => logOutput.push(...args);
 
     const app = createSuperExpressApp({ bodyParser: false });
+    const server = app.listen(3000, () => { });
 
-    await supertest(app)
+    try {
+        assert(logOutput.includes('[SuperExpress] body-parser is disabled ❌'));
+        await supertest(app)
         .post('/')
         .send({ key: 'value' })
         .expect(404);
+    } finally {
+        console.log = originalConsoleLog;
+        server.close();
+    }
 
-    assert(logOutput.includes('[SuperExpress] Body parser is disabled'));
-
-    console.log = originalConsoleLog;
 });

package/test/mock-package.json

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