@autofleet/super-express 2.2.1-beta-6c740761.0 → 3.0.0

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@autofleet/super-express",
-  "version": "2.2.1-beta-6c740761.0",
+  "version": "3.0.0",
   "description": "AF Express with built in boilerplate",
-  "main": "src/index.mjs",
-  "module": "src/index.mjs",
-  "types": "src/index.d.ts",
-  "type": "module",
+  "main": "src/index.js",
   "author": "Autofleet",
   "license": "MIT",
   "dependencies": {
@@ -29,17 +26,5 @@
   "devDependencies": {
     "@types/express": "^4.17.21",
     "supertest": "^7.0.0"
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "default": "./src/index.mjs",
-        "types": "./src/index.d.ts"
-      },
-      "require": {
-        "default": "./src/index.cjs",
-        "types": "./src/index.d.cts"
-      }
-    }
   }
 }

package/src/index.d.ts

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

package/src/{index.cjs → index.js}

@@ -1,10 +1,14 @@
 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');
+const zehut = require('@autofleet/zehut');
+const { enableTracing } = zehut;
+const fs = require('fs');
+const path = require('path');
 
-module.exports = function superExpress(options = {}) {
+const defaultOptions = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../config/default-options.json'), 'utf8'));
+
+module.exports = function (options = {}) {
     const app = express(options);
     const mergedOptions = Object.assign({}, defaultOptions, options);
     /** Formatting */
@@ -47,19 +51,16 @@ module.exports = function superExpress(options = {}) {
     }
     /** 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,
-                    });
-                });
-            });
+        // 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,
+        //     });
+        // });
     }
     /** Tracing */
     if (mergedOptions.tracing) {
@@ -83,4 +84,4 @@ module.exports = function superExpress(options = {}) {
     }
 
     return app
-};
+};

package/test/index.test.js

@@ -1,14 +1,10 @@
 // index.test.js
-import { strict as assert } from 'assert';
-import { test } from 'node:test';
-import supertest from 'supertest';
-import createSuperExpressApp from '../src/index.js';
-import fs from 'fs';
-import path, { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+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 = {
@@ -64,14 +60,14 @@ 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('/')
+    //     .expect(200)
+    //     .expect((res) => {
+    //         assert(res.body.name);
+    //         assert(res.body.version);
+    //         assert(res.body.serverRunningSince);
+    //     });
 });
 
 // Test for disabled body parser
@@ -82,7 +78,6 @@ test('should disable body parser when option is set to false', async () => {
 
     const app = createSuperExpressApp({ bodyParser: false });
 
-
     await supertest(app)
         .post('/')
         .send({ key: 'value' })
@@ -91,4 +86,4 @@ test('should disable body parser when option is set to false', async () => {
     assert(logOutput.includes('[SuperExpress] Body parser is disabled'));
 
     console.log = originalConsoleLog;
-});
+});

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;