@arkstack/driver-express 0.5.2 → 0.5.3

package/README.md

@@ -1,5 +1,7 @@
 # @arkstack/driver-express
 
+[![@arkstack/driver-express](https://img.shields.io/npm/dt/@arkstack/driver-express?style=flat-square&label=@arkstack/driver-express&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/driver-express)](https://www.npmjs.com/package/@arkstack/driver-express)
+
 Express driver for Arkstack, providing Express-based runtime integration for the framework.
 
 ## Auth Middleware

package/dist/app.d.ts

@@ -0,0 +1,25 @@
+import type { Request, Response } from 'express'
+
+declare module '@arkstack/common' {
+    interface HookRegistry {
+        'middleware:auth': {
+            before: (ctx: { req: Request, res: Response }) => Promise<void>
+            after: (ctx: { req: Request, res: Response }) => Promise<void>
+            error: (error: unknown, ctx: { req: Request, res: Response }) => Promise<void>
+        }
+    }
+}
+
+declare module '@arkstack/foundry' {
+    interface HookRegistry {
+        'middleware:auth': {
+            before: (ctx: { req: Request, res: Response }) => Promise<void>
+            after: (ctx: { req: Request, res: Response }) => Promise<void>
+            error: (error: unknown, ctx: { req: Request, res: Response }) => Promise<void>
+        }
+    }
+}
+
+declare global {
+    var tunnelUrl: () => string
+}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
+/// <reference path="./app.d.ts" />
+import { Middleware as Middleware$1, MiddlewareConfig } from "./types.js";
 import { ErrorRequestHandler, Express, Handler, Router as Router$1 } from "express";
-import { ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, PromiseOrValue } from "@arkstack/contract";
+import { ArkstackKitDriver, ArkstackRouteListOptions, PromiseOrValue } from "@arkstack/contract";
 import { Router as Router$2 } from "clear-router/express";
 import { Route } from "clear-router";
 import { Handler as Handler$1, HttpContext, Middleware } from "clear-router/types/express";
@@ -19,17 +21,71 @@ interface ExpressDriverOptions {
   mountPublicAssets?: (app: Express, publicPath: string) => PromiseOrValue<void>;
   errorHandler?: ErrorRequestHandler | Handler;
 }
+/**
+ * The ExpressDriver class implements the ArkstackKitDriver
+ * contract for the Express framework.
+ */
 declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
   readonly name = "express";
+  private tunnel_url?;
   private readonly options;
+  /**
+   * Creates an instance of ExpressDriver.
+   *
+   * @param options
+   */
   constructor(options: ExpressDriverOptions);
+  /**
+   * Creates an Express application instance.
+   *
+   * @returns
+   */
   createApp(): Express;
+  /**
+   * Mounts static assets from the specified public path to the Express application.
+   *
+   * @param app
+   * @param publicPath
+   */
   mountPublicAssets(app: Express, publicPath: string): PromiseOrValue<void>;
+  /**
+   * Binds the router to the Express application using the provided bindRouter function.
+   *
+   * @param app
+   */
   bindRouter(app: Express): PromiseOrValue<void>;
-  applyMiddleware(app: Express, middleware: Handler | ArkstackMiddlewareConfig<Handler>): void;
+  /**
+   * Applies middleware to the Express application.
+   *
+   * @param app
+   * @param middleware
+   */
+  applyMiddleware(app: Express, middleware: Middleware$1 | MiddlewareConfig): void;
+  /**
+   * Registers an error handler middleware to the Express
+   * application if provided in the options.
+   *
+   * @param app
+   */
   registerErrorHandler(app: Express): void;
-  start(app: Express, port: number): void;
+  /**
+   * If trafic has been proxied via ngrok, this will return the tunnel URL.
+   *
+   * @returns
+   */
+  geTunnelUrl(): string | undefined;
+  /**
+   * Starts the Express server on the specified port.
+   *
+   * The bind host can be overridden with the `APP_HOST` (or `HOST`) env
+   * variable. It defaults to `0.0.0.0` so the server is reachable on all
+   * network interfaces, which platforms like Railway require for their
+   * healthcheck proxy to reach the app.
+   *
+   * @param app
+   * @param port
+   */
+  start(app: Express, port: number): Promise<void>;
 }
 //#endregion
-export { ExpressDriver, ExpressDriverOptions, Router, defaultErrorHandler };
-//# sourceMappingURL=index.d.ts.map
+export { ExpressDriver, ExpressDriverOptions, Router, defaultErrorHandler };

package/dist/index.js

@@ -1,12 +1,34 @@
 import express from "express";
 import { ArkstackKitDriver } from "@arkstack/contract";
-import { ErrorHandler, Logger, RequestException, importFile, renderError } from "@arkstack/common";
+import { ErrorHandler, Logger, RequestException, devTlsCredentials, env, localNetworkAddress, renderError, resolveRuntimeModule } from "@arkstack/common";
+import https from "node:https";
+import { resolveMiddleware } from "@arkstack/http";
+import ngrok from "@ngrok/ngrok";
 import { Router as Router$2 } from "clear-router/express";
 import { clearRouterExpressPlugin } from "@resora/plugin-clear-router";
-import { join } from "node:path";
 import { registerPlugin } from "resora";
 //#region src/error-handler.ts
-const defaultErrorHandler = (err, req, res, next) => {
+const webMiddlewareKey = Symbol.for("arkstack:http:web");
+const isRecord = (value) => {
+	return typeof value === "object" && value !== null;
+};
+const isWebRequest = (value) => {
+	if (!isRecord(value)) return false;
+	return value[webMiddlewareKey] === true || value.arkstackWeb === true || isWebRequest(value.context) || isWebRequest(value.req);
+};
+const redirectBackTarget = (req) => {
+	const referer = req.headers?.referer ?? req.headers?.referrer;
+	const value = Array.isArray(referer) ? referer[0] : referer;
+	return typeof value === "string" && value ? value : "/";
+};
+const flashValidationState = async (err, req, errors) => {
+	const session = req.httpSession ?? (isRecord(req.session) && typeof req.session.addValidationErrors === "function" ? req.session : void 0);
+	if (!session) return;
+	if (errors) session.addErrors?.(errors);
+	else session.addValidationErrors?.(err);
+	await session.save?.();
+};
+const defaultErrorHandler = async (err, req, res, next) => {
 	const responseBody = ErrorHandler.createErrorPayload(err);
 	if (ErrorHandler.shouldLogError(err)) ErrorHandler.logUnhandledError(err, {
 		headers: req.headers,
@@ -20,6 +42,11 @@ const defaultErrorHandler = (err, req, res, next) => {
 	}
 	const expectsJson = (Array.isArray(req.headers.accept) ? req.headers.accept.join(",") : req.headers.accept ?? "").includes("application/json") || req.originalUrl.startsWith("/api/");
 	const code = ErrorHandler.normalizeStatusCode(responseBody.code);
+	if (code === 422 && !expectsJson && isWebRequest(req)) {
+		await flashValidationState(err, req, responseBody.errors);
+		res.redirect(302, redirectBackTarget(req));
+		return;
+	}
 	if (expectsJson) {
 		res.status(code).json(responseBody);
 		return;
@@ -37,12 +64,16 @@ Router$2.configure({ inferParamName: true });
 var Router = class extends Router$2 {
 	static async bind() {
 		const router = express.Router();
-		await Router$2.group("/api", async () => {
-			await importFile(join(process.cwd(), "src/routes/api.ts"));
-		});
-		await Router$2.group("/", async () => {
-			await importFile(join(process.cwd(), "src/routes/web.ts"));
-		});
+		try {
+			await Router$2.group("/api", resolveRuntimeModule("src/routes/api.ts"));
+		} catch (e) {
+			Logger.error("ERROR: Unable to load \"api.ts\" routes: " + e.message, false);
+		}
+		try {
+			await Router$2.group("/", resolveRuntimeModule("src/routes/web.ts"));
+		} catch (e) {
+			Logger.error("ERROR: Unable to load \"web.ts\" routes: " + e.message, false);
+		}
 		Router$2.apply(router);
 		router.all("/*splat", (req, _res, next) => {
 			const url = req.originalUrl || req.url;
@@ -63,6 +94,7 @@ var Router = class extends Router$2 {
 */
 var ExpressDriver = class extends ArkstackKitDriver {
 	name = "express";
+	tunnel_url;
 	options;
 	/**
 	* Creates an instance of ExpressDriver.
@@ -114,17 +146,21 @@ var ExpressDriver = class extends ArkstackKitDriver {
 	* @param middleware 
 	*/
 	applyMiddleware(app, middleware) {
+		if (!middleware) return;
 		if (typeof middleware === "function") {
-			app.use(middleware);
+			app.use(resolveMiddleware(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);
+		for (const [pos, entries] of Object.entries(middleware)) for (const instance of entries) {
+			const entry = resolveMiddleware(instance);
+			if (pos === "after") app.use(async (req, res, next) => {
+				res.once("finish", async () => {
+					await entry(req, res, next);
+				});
+				next();
 			});
-			next();
-		});
-		else app.use(entry);
+			else app.use(entry);
+		}
 	}
 	/**
 	* Registers an error handler middleware to the Express 
@@ -136,18 +172,71 @@ var ExpressDriver = class extends ArkstackKitDriver {
 		app.use(this.options.errorHandler ?? defaultErrorHandler);
 	}
 	/**
-	* Starts the Express server on the specified port.
+	* If trafic has been proxied via ngrok, this will return the tunnel URL.
 	* 
-	* @param app 
-	* @param port 
+	* @returns 
 	*/
-	start(app, port) {
-		app.listen(port, () => {
-			Logger.log([["Server is running on", "white"], [`http://localhost:${port}`, "cyan"]], " ");
-		});
+	geTunnelUrl() {
+		return this.tunnel_url;
+	}
+	/**
+	* Starts the Express server on the specified port.
+	*
+	* The bind host can be overridden with the `APP_HOST` (or `HOST`) env
+	* variable. It defaults to `0.0.0.0` so the server is reachable on all
+	* network interfaces, which platforms like Railway require for their
+	* healthcheck proxy to reach the app.
+	*
+	* @param app
+	* @param port
+	*/
+	async start(app, port) {
+		const host = env("APP_HOST", env("HOST", "0.0.0.0"));
+		const secure = env("APP_SECURE", false) === true;
+		const tunneled = env("TUNNEL", false);
+		const scheme = secure ? "https" : "http";
+		const onListen = async () => {
+			let log = startupLogLines(scheme, host, port);
+			if (tunneled === true) {
+				const url = (await ngrok.forward({
+					addr: port,
+					authtoken: env("NGROK_AUTHTOKEN"),
+					domain: env("NGROK_DOMAIN")
+				})).url();
+				if (url) {
+					log = log.concat(Logger.log([["Trafic has been tunnelled to", "white"], [url, "green"]], " ", false));
+					process.env.TUNNEL_URL = url;
+					this.tunnel_url = url;
+					globalThis.tunnelUrl = () => url;
+				}
+			}
+			console.log(log.join("\n"));
+		};
+		if (secure) {
+			const credentials = await devTlsCredentials();
+			https.createServer({
+				key: credentials.key,
+				cert: credentials.cert
+			}, app).listen(port, host, onListen);
+			return;
+		}
+		app.listen(port, host, onListen);
+	}
+};
+/**
+* Build the "Server is running" startup lines, adding a local-network URL when
+* the server is bound to all interfaces (`0.0.0.0`/`::`) so it is reachable from
+* other devices.
+*/
+const startupLogLines = (scheme, host, port) => {
+	const bindsAll = host === "0.0.0.0" || host === "::";
+	const localHost = bindsAll ? "localhost" : host;
+	const lines = [Logger.log([["Server is running on", "white"], [`${scheme}://${localHost}:${port}`, "cyan"]], " ", false)];
+	if (bindsAll) {
+		const address = localNetworkAddress();
+		if (address) lines.push(Logger.log([["Network access via", "white"], [`${scheme}://${address}:${port}`, "cyan"]], " ", false));
 	}
+	return lines;
 };
 //#endregion
 export { ExpressDriver, Router, defaultErrorHandler };
-
-//# sourceMappingURL=index.js.map

package/dist/middlewares/index.d.ts

@@ -1,18 +1,88 @@
 import { Handler, NextFunction, Request, Response } from "express";
 import multer from "multer";
+import * as _$express_rate_limit0 from "express-rate-limit";
+import { ValueDeterminingMiddleware } from "express-rate-limit";
 
 //#region src/middlewares/auth.d.ts
 declare const auth: Handler;
+declare class AuthMiddleware {
+  handler(req: Request, res: Response, next: NextFunction): unknown;
+}
 //#endregion
 //#region src/middlewares/formdata.d.ts
 declare const formdata: multer.Multer;
+declare class FormDataMiddleware {
+  private type;
+  private name?;
+  private count?;
+  private options?;
+  constructor(type: 'array', fieldName: string, maxCount?: number | undefined, options?: multer.Options);
+  constructor(type: 'fields', fields: multer.Field[], options?: multer.Options);
+  constructor(type: 'single', fieldName: string, options?: multer.Options);
+  handler(req: Request, res: Response, next: NextFunction): unknown;
+}
+//#endregion
+//#region src/middlewares/inertia.d.ts
+/**
+ * Bind the Inertia request context for Express.
+ *
+ * Normalizes the Express request into the adapter's driver-agnostic shape and
+ * runs the downstream handler inside Inertia's async-local context (mirroring the
+ * `resora` middleware), so `inertia()` / `Inertia.*` resolve the active request.
+ *
+ * It also upgrades `302` redirects to `303 See Other` for `PUT`/`PATCH`/`DELETE`
+ * Inertia visits, which the Inertia client requires to follow the redirect with
+ * a `GET`.
+ *
+ * `@arkstack/inertia` is imported dynamically so the package stays optional.
+ */
+declare const inertia: () => Handler;
+declare class InertiaMiddleware {
+  handler(req: Request, res: Response, next: NextFunction): unknown;
+}
+//#endregion
+//#region src/middlewares/limiter.d.ts
+/**
+ *  create a rate limiter middleware
+ *
+ * @param requests   number of requests allowed per windowMs
+ * @param perMin     number of minutes for the window
+ * @param message    custom message to be returned when rate limit is exceeded
+ * @returns
+ */
+declare const limiter: (requests?: number | ValueDeterminingMiddleware<number>, perSec?: number, message?: string | ValueDeterminingMiddleware<string>) => _$express_rate_limit0.RateLimitRequestHandler;
 //#endregion
 //#region src/middlewares/request-logger.d.ts
+/**
+ * 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
+ */
 declare const requestLogger: ({
   allowInProduction
 }?: {
   allowInProduction?: boolean;
 }) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+declare class RequestLoggerMiddleware {
+  private options;
+  constructor(options?: {
+    allowInProduction?: boolean;
+  });
+  handler(req: Request, res: Response, next: NextFunction): Promise<void>;
+}
+//#endregion
+//#region src/middlewares/resora.d.ts
+/**
+ * Apply the application's resora configuration (`src/config/resources.ts`) and
+ * bind the per-request `{ req, res }` context so Resources can build URLs and
+ * pagination links.
+ *
+ * Replaces the manual `Resource.setCtx(...)` wiring: resora's runtime config is
+ * applied from `config('resources')`, and the request is run within resora's
+ * async context so downstream handlers resolve the correct context.
+ */
+declare const resora: () => Handler;
 //#endregion
-export { auth, formdata, requestLogger };
-//# sourceMappingURL=index.d.ts.map
+export { AuthMiddleware, FormDataMiddleware, InertiaMiddleware, RequestLoggerMiddleware, auth, formdata, inertia, limiter, requestLogger, resora };

package/dist/middlewares/index.js

@@ -1,8 +1,10 @@
-import { Hook, Logger, nodeEnv } from "@arkstack/common";
-import { Auth, AuthenticationException } from "@arkstack/auth";
+import { Exception, Hook, Logger, config, env, nodeEnv, resolveRuntimeDir } from "@arkstack/common";
+import { applyRuntimeConfig, getDefaultConfig, runWithCtx, setCtx } from "resora";
 import multer from "multer";
+import { rateLimit } from "express-rate-limit";
 //#region src/middlewares/auth.ts
 const auth = async (req, res, next) => {
+	const { Auth, AuthenticationException } = await import("@arkstack/auth");
 	try {
 		if (Hook.has("middleware:auth", "before")) await Promise.resolve(Hook.get("middleware:auth", "before")?.({
 			req,
@@ -14,10 +16,11 @@ const auth = async (req, res, next) => {
 			status: 401
 		});
 		const auth = Auth.make().setRequest(req);
-		const user = await Auth.make().setRequest(req).authorizeToken(token);
+		const user = await auth.authorizeToken(token);
 		req.user = user;
 		req.auth = auth;
 		req.authUser = user;
+		req.session = auth.session();
 		req.authToken = token;
 		if (Hook.has("middleware:auth", "after")) await Promise.resolve(Hook.get("middleware:auth", "after")?.({
 			req,
@@ -32,6 +35,11 @@ const auth = async (req, res, next) => {
 		next(error);
 	}
 };
+var AuthMiddleware = class {
+	handler(req, res, next) {
+		return auth(req, res, next);
+	}
+};
 const readBearerToken = (authorization) => {
 	const value = Array.isArray(authorization) ? authorization[0] : authorization;
 	if (!value?.startsWith("Bearer ")) return null;
@@ -40,6 +48,110 @@ const readBearerToken = (authorization) => {
 //#endregion
 //#region src/middlewares/formdata.ts
 const formdata = multer({ storage: multer.memoryStorage() });
+var FormDataMiddleware = class {
+	type;
+	name;
+	count;
+	options;
+	constructor(type, name, count, options) {
+		this.type = type;
+		this.name = name;
+		this.count = count;
+		this.options = options;
+	}
+	handler(req, res, next) {
+		let inst;
+		const options = this.options ?? (typeof this.count === "object" && "storage" in this.count ? this.count : {});
+		const formdata = multer({
+			storage: multer.memoryStorage(),
+			...options
+		});
+		if (this.type === "any" || this.type === "none") inst = formdata.any();
+		else if (this.type === "array") inst = formdata.array(this.name, this.count);
+		else if (this.type === "fields") inst = formdata.fields(this.name);
+		else inst = formdata.single(this.name);
+		return inst.call(inst, req, res, next);
+	}
+};
+//#endregion
+//#region src/middlewares/inertia.ts
+/**
+* Bind the Inertia request context for Express.
+*
+* Normalizes the Express request into the adapter's driver-agnostic shape and
+* runs the downstream handler inside Inertia's async-local context (mirroring the
+* `resora` middleware), so `inertia()` / `Inertia.*` resolve the active request.
+*
+* It also upgrades `302` redirects to `303 See Other` for `PUT`/`PATCH`/`DELETE`
+* Inertia visits, which the Inertia client requires to follow the redirect with
+* a `GET`.
+*
+* `@arkstack/inertia` is imported dynamically so the package stays optional.
+*/
+const inertia = () => {
+	return async (req, res, next) => {
+		try {
+			const { runInertia, shouldUpgradeRedirect } = await import("@arkstack/inertia");
+			const request = {
+				method: String(req.method ?? "GET").toUpperCase(),
+				url: req.originalUrl || req.url || "/",
+				header: (name) => {
+					const value = req.headers[name.toLowerCase()];
+					return Array.isArray(value) ? value[0] : value;
+				}
+			};
+			if (request.header("x-inertia") === "true") {
+				const original = res.redirect.bind(res);
+				res.redirect = ((...args) => {
+					let status = typeof args[0] === "number" ? args[0] : 302;
+					const url = typeof args[0] === "number" ? args[1] : args[0];
+					if (shouldUpgradeRedirect(request.method, status)) status = 303;
+					return original(status, url);
+				});
+			}
+			runInertia(request, () => next());
+		} catch (error) {
+			next(error);
+		}
+	};
+};
+var InertiaMiddleware = class {
+	handler(req, res, next) {
+		return inertia()(req, res, next);
+	}
+};
+//#endregion
+//#region src/Exceptions/RateLimitExceededException.ts
+var RateLimitExceededException = class extends Exception {
+	statusCode = 429;
+	name;
+	constructor(options) {
+		super(options.message);
+		this.name = "RateLimitExceededException";
+		this.statusCode = options.statusCode ?? 429;
+	}
+};
+//#endregion
+//#region src/middlewares/limiter.ts
+/**
+*  create a rate limiter middleware
+* 
+* @param requests   number of requests allowed per windowMs
+* @param perMin     number of minutes for the window
+* @param message    custom message to be returned when rate limit is exceeded
+* @returns 
+*/
+const limiter = (requests = 100, perSec = 900, message) => rateLimit({
+	message,
+	limit: requests,
+	windowMs: (env("NODE_ENV") === "production" ? perSec : 30) * 1e3,
+	standardHeaders: true,
+	legacyHeaders: false,
+	ipv6Subnet: 56,
+	handler: (_, __, ___, options) => {
+		throw new RateLimitExceededException(options);
+	}
+});
 //#endregion
 //#region src/middlewares/request-logger.ts
 const colors = {
@@ -57,7 +169,8 @@ const colors = {
 * @returns 
 */
 const requestLogger = ({ allowInProduction = false } = {}) => async (req, res, next) => {
-	if (nodeEnv() === "prod" && !allowInProduction) return next();
+	const VERBOSE = process.env.VERBOSITY != "0";
+	if (nodeEnv() === "prod" && !allowInProduction || !VERBOSE) return next();
 	const start = Date.now();
 	const status = res.statusCode || 200;
 	const duration = Date.now() - start;
@@ -69,7 +182,49 @@ const requestLogger = ({ allowInProduction = false } = {}) => async (req, res, n
 	], " ");
 	next();
 };
+var RequestLoggerMiddleware = class {
+	options;
+	constructor(options = {}) {
+		this.options = options;
+	}
+	handler(req, res, next) {
+		const inst = requestLogger(this.options);
+		return inst.call(inst, req, res, next);
+	}
+};
+//#endregion
+//#region src/middlewares/resora.ts
+/**
+* Apply the application's resora configuration (`src/config/resources.ts`) and
+* bind the per-request `{ req, res }` context so Resources can build URLs and
+* pagination links.
+*
+* Replaces the manual `Resource.setCtx(...)` wiring: resora's runtime config is
+* applied from `config('resources')`, and the request is run within resora's
+* async context so downstream handlers resolve the correct context.
+*/
+const resora = () => {
+	let resources;
+	return (req, res, next) => {
+		try {
+			if (!resources) {
+				resources = {
+					...getDefaultConfig(),
+					...config("resources", {})
+				};
+				if (typeof resources.resourcesDir === "string") resources.resourcesDir = resolveRuntimeDir(resources.resourcesDir);
+			}
+			applyRuntimeConfig(resources);
+		} catch {}
+		setCtx({
+			req,
+			res
+		});
+		return runWithCtx({
+			req,
+			res
+		}, () => next());
+	};
+};
 //#endregion
-export { auth, formdata, requestLogger };
-
-//# sourceMappingURL=index.js.map
+export { AuthMiddleware, FormDataMiddleware, InertiaMiddleware, RequestLoggerMiddleware, auth, formdata, inertia, limiter, requestLogger, resora };

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+import { Handler } from "express";
+import { ArkstackMiddlewareConfig } from "@arkstack/contract";
+import { ClassMiddleware } from "clear-router/types/basic";
+
+//#region src/types.d.ts
+type Middleware = Handler | ClassMiddleware<Handler>;
+type MiddlewareConfig = ArkstackMiddlewareConfig<Middleware>;
+//#endregion
+export { Middleware, MiddlewareConfig };

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "type": "module",
   "description": "Express driver for Arkstack, providing Express-based runtime integration for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -33,32 +33,39 @@
   "exports": {
     ".": "./dist/index.js",
     "./middlewares": "./dist/middlewares/index.js",
+    "./types": "./dist/types.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "multer": "^2.1.1",
-    "clear-router": "^2.6.4",
+    "@ngrok/ngrok": "^1.7.0",
+    "@resora/plugin-clear-router": "^1.0.66",
+    "clear-router": "^2.9.0",
     "express-rate-limit": "^8.4.1",
-    "@resora/plugin-clear-router": "^1.0.14",
-    "resora": "^1.2.4",
-    "@arkstack/contract": "^0.5.2"
+    "multer": "^2.1.1",
+    "resora": "^1.3.27",
+    "@arkstack/contract": "^0.5.3"
   },
   "peerDependencies": {
     "express": "^5.2.1",
-    "@arkstack/auth": "^0.5.2",
-    "@arkstack/common": "^0.5.2"
+    "@arkstack/auth": "^0.5.3",
+    "@arkstack/foundry": "^0.5.3",
+    "@arkstack/inertia": "^0.5.3",
+    "@arkstack/common": "^0.5.3"
   },
   "peerDependenciesMeta": {
     "@arkstack/auth": {
       "optional": true
+    },
+    "@arkstack/inertia": {
+      "optional": true
     }
   },
   "devDependencies": {
-    "@types/multer": "^2.1.0",
-    "@types/express": "^5.0.6"
+    "@types/express": "^5.0.6",
+    "@types/multer": "^2.1.0"
   },
   "scripts": {
-    "build": "tsdown",
+    "build": "tsdown --config-loader unrun",
     "version:patch": "pnpm version patch"
   }
 }

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":["ClearRouter"],"sources":["../src/error-handler.ts","../src/Router.ts","../src/index.ts"],"sourcesContent":["import {\n    ErrorHandler,\n    renderError,\n} from '@arkstack/common'\n\nimport type { ErrorRequestHandler } from 'express'\n\nexport const defaultErrorHandler: ErrorRequestHandler = (err, req, res, next) => {\n    const responseBody = ErrorHandler.createErrorPayload(err)\n\n    if (ErrorHandler.shouldLogError(err)) {\n        ErrorHandler.logUnhandledError(err, {\n            headers: req.headers,\n            method: req.method,\n            url: req.originalUrl || req.url,\n        }, 'Unhandled Express request error')\n    }\n\n    if (process.env.NODE_ENV === 'development') console.error(responseBody)\n\n    if (res.headersSent) {\n        next(err)\n\n        return\n    }\n\n    const acceptsHeader = Array.isArray(req.headers.accept) ? req.headers.accept.join(',') : req.headers.accept ?? ''\n    const expectsJson = acceptsHeader.includes('application/json') || req.originalUrl.startsWith('/api/')\n    const code = ErrorHandler.normalizeStatusCode(responseBody.code)\n\n    if (expectsJson) {\n        res.status(code).json(responseBody)\n\n        return\n    }\n\n    res.status(code).setHeader('Content-Type', 'text/html').send(renderError({\n        message: String(responseBody.message),\n        stack: typeof responseBody.stack === 'string' ? responseBody.stack : undefined,\n        code,\n    }))\n}\n\nexport default defaultErrorHandler\n","import { RequestException, importFile } from '@arkstack/common'\nimport express, { Router as ExpressRouter } from 'express'\n\nimport { ArkstackRouteListOptions } from '@arkstack/contract'\nimport { Router as ClearRouter } from 'clear-router/express'\nimport { type Route } from 'clear-router'\nimport { clearRouterExpressPlugin } from '@resora/plugin-clear-router'\nimport { join } from 'node:path'\nimport { registerPlugin } from 'resora'\nimport type { Handler, HttpContext, Middleware } from 'clear-router/types/express'\n\nregisterPlugin(clearRouterExpressPlugin)\nClearRouter.configure({\n  inferParamName: true\n})\n\nexport class Router extends ClearRouter {\n  static async bind (): Promise<ExpressRouter> {\n    const router = express.Router()\n\n    // Register API routes\n    await ClearRouter.group('/api', async () => {\n      await importFile(join(process.cwd(), 'src/routes/api.ts'))\n    })\n\n    // Register web routes\n    await ClearRouter.group('/', async () => {\n      await importFile(join(process.cwd(), 'src/routes/web.ts'))\n    })\n\n    // Apply the registered routes to the Express application\n    ClearRouter.apply(router)\n\n    // Handle unmatched routes\n    router.all('/*splat', (req, _res, next) => {\n      const url = req.originalUrl || req.url\n      next(new RequestException(`Cannot find any route matching [${req.method}] ${url}`, 404))\n    })\n\n    return router\n  }\n\n  static async list (\n    _options: ArkstackRouteListOptions = {}\n  ): Promise<Array<Route<HttpContext, Middleware, Handler>>> {\n    await this.bind()\n\n    return this.allRoutes() as never\n  }\n}\n","import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { Logger } from '@arkstack/common'\nimport { defaultErrorHandler } from './error-handler'\n\nexport interface ExpressDriverOptions {\n    bindRouter: (app: Express) => PromiseOrValue<void>;\n    mountPublicAssets?: (app: Express, publicPath: string) => 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): PromiseOrValue<void> {\n        if (this.options.mountPublicAssets) {\n            return this.options.mountPublicAssets(app, publicPath)\n        }\n\n        app.use(express.static(publicPath, {\n            maxAge: '1y',\n            immutable: true,\n            setHeaders: (res) => {\n                res.setHeader('Access-Control-Allow-Origin', '*')\n                res.setHeader('Access-Control-Allow-Methods', 'GET, HEAD, OPTIONS')\n                res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')\n            },\n        }))\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        app.use((this.options.errorHandler ?? defaultErrorHandler) as ErrorRequestHandler)\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\nexport * from './error-handler'\nexport * from './Router'\n"],"mappings":";;;;;;;;AAOA,MAAa,uBAA4C,KAAK,KAAK,KAAK,SAAS;CAC7E,MAAM,eAAe,aAAa,mBAAmB,IAAI;CAEzD,IAAI,aAAa,eAAe,IAAI,EAChC,aAAa,kBAAkB,KAAK;EAChC,SAAS,IAAI;EACb,QAAQ,IAAI;EACZ,KAAK,IAAI,eAAe,IAAI;EAC/B,EAAE,kCAAkC;CAGzC,IAAI,QAAQ,IAAI,aAAa,eAAe,QAAQ,MAAM,aAAa;CAEvE,IAAI,IAAI,aAAa;EACjB,KAAK,IAAI;EAET;;CAIJ,MAAM,eADgB,MAAM,QAAQ,IAAI,QAAQ,OAAO,GAAG,IAAI,QAAQ,OAAO,KAAK,IAAI,GAAG,IAAI,QAAQ,UAAU,IAC7E,SAAS,mBAAmB,IAAI,IAAI,YAAY,WAAW,QAAQ;CACrG,MAAM,OAAO,aAAa,oBAAoB,aAAa,KAAK;CAEhE,IAAI,aAAa;EACb,IAAI,OAAO,KAAK,CAAC,KAAK,aAAa;EAEnC;;CAGJ,IAAI,OAAO,KAAK,CAAC,UAAU,gBAAgB,YAAY,CAAC,KAAK,YAAY;EACrE,SAAS,OAAO,aAAa,QAAQ;EACrC,OAAO,OAAO,aAAa,UAAU,WAAW,aAAa,QAAQ,KAAA;EACrE;EACH,CAAC,CAAC;;;;AC7BP,eAAe,yBAAyB;AACxCA,SAAY,UAAU,EACpB,gBAAgB,MACjB,CAAC;AAEF,IAAa,SAAb,cAA4BA,SAAY;CACtC,aAAa,OAAgC;EAC3C,MAAM,SAAS,QAAQ,QAAQ;EAG/B,MAAMA,SAAY,MAAM,QAAQ,YAAY;GAC1C,MAAM,WAAW,KAAK,QAAQ,KAAK,EAAE,oBAAoB,CAAC;IAC1D;EAGF,MAAMA,SAAY,MAAM,KAAK,YAAY;GACvC,MAAM,WAAW,KAAK,QAAQ,KAAK,EAAE,oBAAoB,CAAC;IAC1D;EAGF,SAAY,MAAM,OAAO;EAGzB,OAAO,IAAI,YAAY,KAAK,MAAM,SAAS;GACzC,MAAM,MAAM,IAAI,eAAe,IAAI;GACnC,KAAK,IAAI,iBAAiB,mCAAmC,IAAI,OAAO,IAAI,OAAO,IAAI,CAAC;IACxF;EAEF,OAAO;;CAGT,aAAa,KACX,WAAqC,EAAE,EACkB;EACzD,MAAM,KAAK,MAAM;EAEjB,OAAO,KAAK,WAAW;;;;;;;;;AC/B3B,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,OAAgB;CAChB;;;;;;CAOA,YAAY,SAA+B;EACvC,OAAO;EACP,KAAK,UAAU;;;;;;;CAQnB,YAAsB;EAClB,OAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0C;EACvE,IAAI,KAAK,QAAQ,mBACb,OAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;EAG1D,IAAI,IAAI,QAAQ,OAAO,YAAY;GAC/B,QAAQ;GACR,WAAW;GACX,aAAa,QAAQ;IACjB,IAAI,UAAU,+BAA+B,IAAI;IACjD,IAAI,UAAU,gCAAgC,qBAAqB;IACnE,IAAI,UAAU,gCAAgC,8BAA8B;;GAEnF,CAAC,CAAC;;;;;;;CAQP,WAAY,KAAoC;EAC5C,OAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;EACJ,IAAI,OAAO,eAAe,YAAY;GAClC,IAAI,IAAI,WAAW;GAEnB;;EAGJ,KAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,EACnD,KAAK,MAAM,SAAS,SAChB,IAAI,QAAQ,SACR,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS;GAC9B,IAAI,KAAK,UAAU,YAAY;IAC3B,MAAM,MAAM,KAAK,KAAK,KAAK;KAC7B;GACF,MAAM;IACR;OAEF,IAAI,IAAI,MAAM;;;;;;;;CAY9B,qBAAsB,KAAoB;EACtC,IAAI,IAAK,KAAK,QAAQ,gBAAgB,oBAA4C;;;;;;;;CAStF,MAAO,KAAc,MAAoB;EACrC,IAAI,OAAO,YAAY;GACnB,OAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}

package/dist/middlewares/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/auth.ts","../../src/middlewares/formdata.ts","../../src/middlewares/request-logger.ts"],"sourcesContent":["import { Auth, AuthenticationException } from '@arkstack/auth'\n\nimport type { Handler } from 'express'\nimport { Hook } from '@arkstack/common'\n\nexport const auth: Handler = async (req, res, next) => {\n    try {\n        if (Hook.has('middleware:auth', 'before'))\n            await Promise.resolve(Hook.get('middleware:auth', 'before')?.({ req, res }))\n\n        const token = readBearerToken(req.headers.authorization)\n\n        if (!token) {\n            throw new AuthenticationException('Unauthenticated', { req, status: 401 })\n        }\n\n        const auth = Auth.make().setRequest(req)\n        const user = await Auth.make().setRequest(req).authorizeToken(token)\n\n        req.user = user\n        req.auth = auth\n        req.authUser = user\n        req.authToken = token\n\n        if (Hook.has('middleware:auth', 'after'))\n            await Promise.resolve(Hook.get('middleware:auth', 'after')?.({ req, res }))\n\n        next()\n    } catch (error) {\n        if (Hook.has('middleware:auth', 'error'))\n            await Promise.resolve(Hook.get('middleware:auth', 'error')?.(error, {\n                req,\n                res\n            }))\n\n        next(error)\n    }\n}\n\nconst readBearerToken = (authorization: string | string[] | undefined) => {\n    const value = Array.isArray(authorization) ? authorization[0] : authorization\n\n    if (!value?.startsWith('Bearer ')) {\n        return null\n    }\n\n    return value.substring(7)\n}\n","import multer from 'multer'\n\nexport const formdata = multer({ storage: multer.memoryStorage() })","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":";;;;AAKA,MAAa,OAAgB,OAAO,KAAK,KAAK,SAAS;CACnD,IAAI;EACA,IAAI,KAAK,IAAI,mBAAmB,SAAS,EACrC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,SAAS,GAAG;GAAE;GAAK;GAAK,CAAC,CAAC;EAEhF,MAAM,QAAQ,gBAAgB,IAAI,QAAQ,cAAc;EAExD,IAAI,CAAC,OACD,MAAM,IAAI,wBAAwB,mBAAmB;GAAE;GAAK,QAAQ;GAAK,CAAC;EAG9E,MAAM,OAAO,KAAK,MAAM,CAAC,WAAW,IAAI;EACxC,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,CAAC,eAAe,MAAM;EAEpE,IAAI,OAAO;EACX,IAAI,OAAO;EACX,IAAI,WAAW;EACf,IAAI,YAAY;EAEhB,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,QAAQ,GAAG;GAAE;GAAK;GAAK,CAAC,CAAC;EAE/E,MAAM;UACD,OAAO;EACZ,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,QAAQ,GAAG,OAAO;GAChE;GACA;GACH,CAAC,CAAC;EAEP,KAAK,MAAM;;;AAInB,MAAM,mBAAmB,kBAAiD;CACtE,MAAM,QAAQ,MAAM,QAAQ,cAAc,GAAG,cAAc,KAAK;CAEhE,IAAI,CAAC,OAAO,WAAW,UAAU,EAC7B,OAAO;CAGX,OAAO,MAAM,UAAU,EAAE;;;;AC5C7B,MAAa,WAAW,OAAO,EAAE,SAAS,OAAO,eAAe,EAAE,CAAA;;;ACClE,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;CAClE,IAAI,SAAS,KAAK,UAAU,CAAC,mBAAmB,OAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;CAC9B,OAAO,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;CAEP,MAAM"}