@arkstack/contract 0.19.6 → 0.20.0

package/dist/global.d.ts

@@ -1,4 +1,4 @@
-import { Arkstack } from '.'
+import { Arkstack, ServerStartInfo, TunneledServerStartInfo } from '.'
 
 declare global {
   function app(): Arkstack<never, never>
@@ -8,18 +8,23 @@ declare global {
   }
 }
 
-declare module '@arkstack/common' {
-  interface HookRegistry {
-    'set:root-dir': {
-      after: (dir: string) => void
-    }
-  }
-}
-
+// `Hook` and its registry live in @arkstack/foundry (@arkstack/common only
+// re-exports them), so typed hook names are declared there.
 declare module '@arkstack/foundry' {
   interface HookRegistry {
     'set:root-dir': {
       after: (dir: string) => void
     }
+    /**
+     * Fired by every driver once its server is listening (dev and production),
+     * after the startup banner and once any tunnel is open.
+     */
+    'server:start': {
+      after: (info: ServerStartInfo) => void | Promise<void>
+      /**
+       * Only when the server is reachable through a tunnel; runs after `after`.
+       */
+      tunneled: (info: TunneledServerStartInfo) => void | Promise<void>
+    }
   }
 }

package/dist/index.d.ts

@@ -7,6 +7,25 @@ interface ArkstackMiddlewareConfig<TMiddleware> {
 }
 //#endregion
 //#region src/kits.d.ts
+/**
+ * What a driver passes to the `server:start` hook (`after` position) once its
+ * server is listening, and any tunnel is open.
+ */
+interface ServerStartInfo {
+  /** The address the server is bound to, e.g. `0.0.0.0`. */
+  host: string;
+  port: number;
+  scheme: 'http' | 'https';
+  secure: boolean;
+  /** A browsable local URL (`localhost` when bound to every interface). */
+  url: string;
+  /** The public tunnel URL (`TUNNEL_URL`, or the one `ark dev -t` opened), if any. */
+  tunnelUrl?: string;
+}
+/** What the `server:start` hook's `tunneled` position receives: a tunnel is always open. */
+type TunneledServerStartInfo = ServerStartInfo & {
+  tunnelUrl: string;
+};
 /**
  * The ArkstackKitDriver class defines the contract for a driver
  * that can be used with the ArkstackKitContract.
@@ -125,4 +144,4 @@ declare abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {
   static setRootDir(dir: string): void;
 }
 //#endregion
-export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue, RootDirChangeListener };
+export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue, RootDirChangeListener, ServerStartInfo, TunneledServerStartInfo };

package/dist/index.js

@@ -92,7 +92,7 @@ var Arkstack = class Arkstack {
 		const previousDir = Arkstack.appRootDir;
 		Arkstack.appRootDir = dir;
 		if (previousDir === dir) return;
-		if (Hook.has("set:root-dir", "after")) Hook.get("set:root-dir", "after", dir);
+		Hook.emit("set:root-dir", "after", dir);
 	}
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/contract",
-  "version": "0.19.6",
+  "version": "0.20.0",
   "type": "module",
   "description": "Contract module for Arkstack, providing shared interfaces and type contracts used across the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -29,7 +29,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/foundry": "^0.19.6"
+    "@arkstack/foundry": "^0.20.0"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",