@arkstack/driver-express 0.14.2 → 0.14.14

package/dist/app.d.ts

@@ -18,4 +18,8 @@ declare module '@arkstack/foundry' {
             error: (error: unknown, ctx: { req: Request, res: Response }) => Promise<void>
         }
     }
+}
+
+declare global {
+    var tunnelUrl: () => string
 }

package/dist/index.d.ts

@@ -27,6 +27,7 @@ interface ExpressDriverOptions {
  */
 declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
   readonly name = "express";
+  private tunnel_url?;
   private readonly options;
   /**
    * Creates an instance of ExpressDriver.
@@ -67,6 +68,12 @@ declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
    * @param app
    */
   registerErrorHandler(app: Express): 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.
    *
@@ -78,7 +85,7 @@ declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
    * @param app
    * @param port
    */
-  start(app: Express, port: number): void;
+  start(app: Express, port: number): Promise<void>;
 }
 //#endregion
 export { ExpressDriver, ExpressDriverOptions, Router, defaultErrorHandler };

package/dist/index.js

@@ -2,6 +2,7 @@ import express from "express";
 import { Arkstack, ArkstackKitDriver } from "@arkstack/contract";
 import { ErrorHandler, Logger, RequestException, env, renderError } from "@arkstack/common";
 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";
@@ -93,6 +94,7 @@ var Router = class extends Router$2 {
 */
 var ExpressDriver = class extends ArkstackKitDriver {
 	name = "express";
+	tunnel_url;
 	options;
 	/**
 	* Creates an instance of ExpressDriver.
@@ -170,6 +172,14 @@ var ExpressDriver = class extends ArkstackKitDriver {
 		app.use(this.options.errorHandler ?? defaultErrorHandler);
 	}
 	/**
+	* If trafic has been proxied via ngrok, this will return the tunnel URL.
+	* 
+	* @returns 
+	*/
+	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
@@ -180,10 +190,25 @@ var ExpressDriver = class extends ArkstackKitDriver {
 	* @param app
 	* @param port
 	*/
-	start(app, port) {
+	async start(app, port) {
 		const host = env("APP_HOST", env("HOST", "0.0.0.0"));
-		app.listen(port, host, () => {
-			Logger.log([["Server is running on", "white"], [`http://${host}:${port}`, "cyan"]], " ");
+		const tunneled = env("TUNNEL", false);
+		app.listen(port, host, async () => {
+			let log = [Logger.log([["Server is running on", "white"], [`http://${host}:${port}`, "cyan"]], " ", false)];
+			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"));
 		});
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.14.2",
+  "version": "0.14.14",
   "type": "module",
   "description": "Express driver for Arkstack, providing Express-based runtime integration for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -37,18 +37,19 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "multer": "^2.1.1",
+    "@ngrok/ngrok": "^1.7.0",
+    "@resora/plugin-clear-router": "^1.0.63",
     "clear-router": "^2.8.8",
     "express-rate-limit": "^8.4.1",
-    "@resora/plugin-clear-router": "^1.0.63",
+    "multer": "^2.1.1",
     "resora": "^1.3.26",
-    "@arkstack/contract": "^0.14.2"
+    "@arkstack/contract": "^0.14.14"
   },
   "peerDependencies": {
     "express": "^5.2.1",
-    "@arkstack/auth": "^0.14.2",
-    "@arkstack/common": "^0.14.2",
-    "@arkstack/foundry": "^0.14.2"
+    "@arkstack/foundry": "^0.14.14",
+    "@arkstack/auth": "^0.14.14",
+    "@arkstack/common": "^0.14.14"
   },
   "peerDependenciesMeta": {
     "@arkstack/auth": {
@@ -56,8 +57,8 @@
     }
   },
   "devDependencies": {
-    "@types/multer": "^2.1.0",
-    "@types/express": "^5.0.6"
+    "@types/express": "^5.0.6",
+    "@types/multer": "^2.1.0"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",