@arkstack/driver-express 0.12.5 → 0.12.7

package/dist/index.d.ts

@@ -20,15 +20,58 @@ 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 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>;
+  /**
+   * Applies middleware to the Express application.
+   *
+   * @param app
+   * @param middleware
+   */
   applyMiddleware(app: Express, middleware: Handler | ArkstackMiddlewareConfig<Handler>): void;
+  /**
+   * Registers an error handler middleware to the Express
+   * application if provided in the options.
+   *
+   * @param app
+   */
   registerErrorHandler(app: Express): void;
+  /**
+   * Starts the Express server on the specified port.
+   *
+   * @param app
+   * @param port
+   */
   start(app: Express, port: number): void;
 }
 //#endregion

package/dist/middlewares/index.d.ts

@@ -10,9 +10,24 @@ declare const auth: Handler;
 declare const formdata: multer.Multer;
 //#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
 }?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.12.5",
+  "version": "0.12.7",
   "type": "module",
   "description": "Express driver for Arkstack, providing Express-based runtime integration for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -42,13 +42,13 @@
     "express-rate-limit": "^8.4.1",
     "@resora/plugin-clear-router": "^1.0.34",
     "resora": "^1.3.6",
-    "@arkstack/contract": "^0.12.5"
+    "@arkstack/contract": "^0.12.7"
   },
   "peerDependencies": {
     "express": "^5.2.1",
-    "@arkstack/auth": "^0.12.5",
-    "@arkstack/common": "^0.12.5",
-    "@arkstack/foundry": "^0.12.5"
+    "@arkstack/auth": "^0.12.7",
+    "@arkstack/foundry": "^0.12.7",
+    "@arkstack/common": "^0.12.7"
   },
   "peerDependenciesMeta": {
     "@arkstack/auth": {