@arkstack/driver-express 0.2.4 → 0.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Toneflix Technologies Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { ErrorRequestHandler, Express, Handler } from "express";
-import { ArkstackKitDriver, PromiseOrValue } from "@arkstack/contract";
+import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from "@arkstack/contract";
 
 //#region src/index.d.ts
 interface ExpressDriverOptions {
@@ -13,7 +13,7 @@ declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
   createApp(): Express;
   mountPublicAssets(app: Express, publicPath: string): void;
   bindRouter(app: Express): PromiseOrValue<void>;
-  applyMiddleware(app: Express, middleware: Handler): void;
+  applyMiddleware(app: Express, middleware: Handler | ArkstackMiddlewareConfig<Handler>): void;
   registerErrorHandler(app: Express): void;
   start(app: Express, port: number): void;
 }

package/dist/index.js

@@ -1,5 +1,6 @@
 import express from "express";
 import { ArkstackKitDriver } from "@arkstack/contract";
+import { Logger } from "@arkstack/common";
 
 //#region src/index.ts
 /**
@@ -50,7 +51,17 @@ var ExpressDriver = class extends ArkstackKitDriver {
 	* @param middleware 
 	*/
 	applyMiddleware(app, middleware) {
-		app.use(middleware);
+		if (typeof middleware === "function") {
+			app.use(middleware);
+			return;
+		}
+		for (const [pos, entries] of Object.entries(middleware)) for (const entry of entries) if (pos === "after") app.use(async (req, res, next) => {
+			res.once("finish", async () => {
+				await entry(req, res, next);
+			});
+			next();
+		});
+		else app.use(entry);
 	}
 	/**
 	* Registers an error handler middleware to the Express 
@@ -69,7 +80,7 @@ var ExpressDriver = class extends ArkstackKitDriver {
 	*/
 	start(app, port) {
 		app.listen(port, () => {
-			console.log(`Server is running on http://localhost:${port}`);
+			Logger.log([["Server is running on", "white"], [`http://localhost:${port}`, "cyan"]], " ");
 		});
 	}
 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, PromiseOrValue } from '@arkstack/contract'\n\nexport interface ExpressDriverOptions {\n    bindRouter: (app: Express) => PromiseOrValue<void>;\n    errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n    readonly name = 'express'\n    private readonly options: ExpressDriverOptions\n\n    /**\n     * Creates an instance of ExpressDriver.\n     * \n     * @param options \n     */\n    constructor(options: ExpressDriverOptions) {\n        super()\n        this.options = options\n    }\n\n    /**\n     * Creates an Express application instance.\n     * \n     * @returns \n     */\n    createApp (): Express {\n        return express()\n    }\n\n    /**\n     * Mounts static assets from the specified public path to the Express application.\n     * \n     * @param app \n     * @param publicPath \n     */\n    mountPublicAssets (app: Express, publicPath: string): void {\n        app.use(express.static(publicPath))\n    }\n\n    /**\n     * Binds the router to the Express application using the provided bindRouter function.\n     * \n     * @param app \n     */\n    bindRouter (app: Express): PromiseOrValue<void> {\n        return this.options.bindRouter(app)\n    }\n\n    /**\n     * Applies middleware to the Express application.\n     * \n     * @param app \n     * @param middleware \n     */\n    applyMiddleware (app: Express, middleware: Handler): void {\n        app.use(middleware)\n    }\n\n    /**\n     * Registers an error handler middleware to the Express \n     * application if provided in the options.\n     * \n     * @param app \n     */\n    registerErrorHandler (app: Express): void {\n        if (this.options.errorHandler) {\n            app.use(this.options.errorHandler as ErrorRequestHandler)\n        }\n    }\n\n    /**\n     * Starts the Express server on the specified port.\n     * \n     * @param app \n     * @param port \n     */\n    start (app: Express, port: number): void {\n        app.listen(port, () => {\n            console.log(`Server is running on http://localhost:${port}`)\n        })\n    }\n}\n"],"mappings":";;;;;;;;AAaA,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0B;AACvD,MAAI,IAAI,QAAQ,OAAO,WAAW,CAAC;;;;;;;CAQvC,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBAAiB,KAAc,YAA2B;AACtD,MAAI,IAAI,WAAW;;;;;;;;CASvB,qBAAsB,KAAoB;AACtC,MAAI,KAAK,QAAQ,aACb,KAAI,IAAI,KAAK,QAAQ,aAAoC;;;;;;;;CAUjE,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,WAAQ,IAAI,yCAAyC,OAAO;IAC9D"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { Logger } from '@arkstack/common'\n\nexport interface ExpressDriverOptions {\n    bindRouter: (app: Express) => PromiseOrValue<void>;\n    errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n    readonly name = 'express'\n    private readonly options: ExpressDriverOptions\n\n    /**\n     * Creates an instance of ExpressDriver.\n     * \n     * @param options \n     */\n    constructor(options: ExpressDriverOptions) {\n        super()\n        this.options = options\n    }\n\n    /**\n     * Creates an Express application instance.\n     * \n     * @returns \n     */\n    createApp (): Express {\n        return express()\n    }\n\n    /**\n     * Mounts static assets from the specified public path to the Express application.\n     * \n     * @param app \n     * @param publicPath \n     */\n    mountPublicAssets (app: Express, publicPath: string): void {\n        app.use(express.static(publicPath))\n    }\n\n    /**\n     * Binds the router to the Express application using the provided bindRouter function.\n     * \n     * @param app \n     */\n    bindRouter (app: Express): PromiseOrValue<void> {\n        return this.options.bindRouter(app)\n    }\n\n    /**\n     * Applies middleware to the Express application.\n     * \n     * @param app \n     * @param middleware \n     */\n    applyMiddleware (\n        app: Express,\n        middleware: Handler | ArkstackMiddlewareConfig<Handler>,\n    ): void {\n        if (typeof middleware === 'function') {\n            app.use(middleware)\n\n            return\n        }\n\n        for (const [pos, entries] of Object.entries(middleware) as [string, Handler[]][]) {\n            for (const entry of entries) {\n                if (pos === 'after') {\n                    app.use(async (req, res, next) => {\n                        res.once('finish', async () => {\n                            await entry(req, res, next)\n                        })\n                        next()\n                    })\n                } else {\n                    app.use(entry)\n                }\n            }\n        }\n    }\n\n    /**\n     * Registers an error handler middleware to the Express \n     * application if provided in the options.\n     * \n     * @param app \n     */\n    registerErrorHandler (app: Express): void {\n        if (this.options.errorHandler) {\n            app.use(this.options.errorHandler as ErrorRequestHandler)\n        }\n    }\n\n    /**\n     * Starts the Express server on the specified port.\n     * \n     * @param app \n     * @param port \n     */\n    start (app: Express, port: number): void {\n        app.listen(port, () => {\n            Logger.log([\n                ['Server is running on', 'white'],\n                [`http://localhost:${port}`, 'cyan']\n            ], ' ')\n        })\n    }\n}\n"],"mappings":";;;;;;;;;AAcA,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0B;AACvD,MAAI,IAAI,QAAQ,OAAO,WAAW,CAAC;;;;;;;CAQvC,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;AACJ,MAAI,OAAO,eAAe,YAAY;AAClC,OAAI,IAAI,WAAW;AAEnB;;AAGJ,OAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,CACnD,MAAK,MAAM,SAAS,QAChB,KAAI,QAAQ,QACR,KAAI,IAAI,OAAO,KAAK,KAAK,SAAS;AAC9B,OAAI,KAAK,UAAU,YAAY;AAC3B,UAAM,MAAM,KAAK,KAAK,KAAK;KAC7B;AACF,SAAM;IACR;MAEF,KAAI,IAAI,MAAM;;;;;;;;CAY9B,qBAAsB,KAAoB;AACtC,MAAI,KAAK,QAAQ,aACb,KAAI,IAAI,KAAK,QAAQ,aAAoC;;;;;;;;CAUjE,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,UAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}

package/dist/middlewares/index.d.ts

@@ -0,0 +1,11 @@
+import { NextFunction, Request, Response } from "express";
+
+//#region src/middlewares/request-logger.d.ts
+declare const requestLogger: ({
+  allowInProduction
+}?: {
+  allowInProduction?: boolean;
+}) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+//#endregion
+export { requestLogger };
+//# sourceMappingURL=index.d.ts.map

package/dist/middlewares/index.js

@@ -0,0 +1,34 @@
+import { Logger, nodeEnv } from "@arkstack/common";
+
+//#region src/middlewares/request-logger.ts
+const colors = {
+	GET: "green",
+	POST: "blue",
+	PUT: "yellow",
+	DELETE: "red",
+	PATCH: "cyan"
+};
+/**
+* Middleware to log incoming requests and their response times.
+* 
+* @param config Configuration options for the request logger middleware.
+* @param config.allowInProduction If true, the logger will also log requests in production environment. Default is false. 
+* @returns 
+*/
+const requestLogger = ({ allowInProduction = false } = {}) => async (req, res, next) => {
+	if (nodeEnv() === "prod" && !allowInProduction) return next();
+	const start = Date.now();
+	const status = res.statusCode || 200;
+	const duration = Date.now() - start;
+	Logger.log([
+		[`[${req.method}]`, colors[req.method] || "white"],
+		[req.url, "cyan"],
+		[status.toString(), status >= 500 ? "red" : status >= 400 ? "yellow" : "green"],
+		[`- ${duration}ms`, "dim"]
+	], " ");
+	next();
+};
+
+//#endregion
+export { requestLogger };
+//# sourceMappingURL=index.js.map

package/dist/middlewares/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/request-logger.ts"],"sourcesContent":["import { Logger, nodeEnv } from '@arkstack/common'\nimport { NextFunction, Request, Response } from 'express'\n\nconst colors: Record<string, 'green' | 'blue' | 'yellow' | 'red' | 'cyan'> = {\n    GET: 'green',\n    POST: 'blue',\n    PUT: 'yellow',\n    DELETE: 'red',\n    PATCH: 'cyan',\n}\n\n/**\n * Middleware to log incoming requests and their response times.\n * \n * @param config Configuration options for the request logger middleware.\n * @param config.allowInProduction If true, the logger will also log requests in production environment. Default is false. \n * @returns \n */\nexport const requestLogger = ({\n    allowInProduction = false,\n}: {\n    allowInProduction?: boolean\n} = {}) => async (req: Request, res: Response, next: NextFunction) => {\n    if (nodeEnv() === 'prod' && !allowInProduction) return next()\n\n    const start = Date.now()\n\n    const status = res.statusCode || 200\n    const duration = Date.now() - start\n    Logger.log([\n        [`[${req.method}]`, colors[req.method] || 'white'],\n        [req.url, 'cyan'],\n        [status.toString(), status >= 500 ? 'red' : status >= 400 ? 'yellow' : 'green'],\n        [`- ${duration}ms`, 'dim']\n    ], ' ')\n\n    next()\n}"],"mappings":";;;AAGA,MAAM,SAAuE;CACzE,KAAK;CACL,MAAM;CACN,KAAK;CACL,QAAQ;CACR,OAAO;CACV;;;;;;;;AASD,MAAa,iBAAiB,EAC1B,oBAAoB,UAGpB,EAAE,KAAK,OAAO,KAAc,KAAe,SAAuB;AAClE,KAAI,SAAS,KAAK,UAAU,CAAC,kBAAmB,QAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,QAAO,IAAI;EACP,CAAC,IAAI,IAAI,OAAO,IAAI,OAAO,IAAI,WAAW,QAAQ;EAClD,CAAC,IAAI,KAAK,OAAO;EACjB,CAAC,OAAO,UAAU,EAAE,UAAU,MAAM,QAAQ,UAAU,MAAM,WAAW,QAAQ;EAC/E,CAAC,KAAK,SAAS,KAAK,MAAM;EAC7B,EAAE,IAAI;AAEP,OAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "type": "module",
   "description": "Express driver package for Arkstack providing Express-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
   "homepage": "https://arkstack.toneflix.net",
@@ -32,13 +32,15 @@
   },
   "exports": {
     ".": "./dist/index.js",
+    "./middlewares": "./dist/middlewares/index.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/contract": "^0.2.4"
+    "@arkstack/contract": "^0.3.1"
   },
   "peerDependencies": {
-    "express": "^5.2.1"
+    "express": "^5.2.1",
+    "@arkstack/common": "^0.3.1"
   },
   "devDependencies": {
     "@types/express": "^5.0.6"