@autofleet/super-express 3.0.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/super-express",
-  "version": "3.0.0",
+  "version": "4.1.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,80 @@
 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.
+     * Enables or disables body parser middleware.
      */
-    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
-    }
-
+    bodyParser?: boolean;
+    /**
+     * Enables or disables security headers middleware.
+     */
+    helmet?: boolean;
+    /**
+     * Enables or disables HTTP request logging middleware.
+     */
+    morgan?: boolean;
     /**
-     * Type for the callback function used in the listen method.
+     * Enables or disables the alive endpoint middleware.
      */
-    type ListenCallback = () => void;
+    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.
+ */
+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.
+ * @returns A SuperExpress application instance.
+ */
+declare function createSuperExpressApp(
+    options?: Partial<DefaultOptions & express.ApplicationOptions>
+): SuperExpressApp;
+
+export = createSuperExpressApp;