wooks 0.6.5 → 0.7.0

package/README.md

@@ -1,6 +1,4 @@
-# Wooks
-
-**!!! This is work-in-progress library, breaking changes are expected !!!**
+# wooks
 
 <p align="center">
 <img src="../../wooks-logo.png" width="450px"><br>
@@ -9,46 +7,18 @@
 </a>
 </p>
 
-Wooks is a Event Processing Framework based on composable (hooks) functions.
-
-`wooks` + `@wooksjs/event-http` = Web Application Framework with hooks.
-
-As an alternative for `express` and `fastify`, `wooks` brings the whole different approach for processing http requests.
-It utilizes such a technique as you can see in React Hooks or Vue Composables. It has only a dependency on [@prostojs/router](https://github.com/prostojs/router) (an alternative to `find-my-way` used by `fastify`) which is a very fast (see benchmarks [here](https://github.com/prostojs/router-benchmark)) and robust URI router.
-
-### HTTP Composables packs:
-
-- [@wooksjs/event-http](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http) - HTTP event package with core functionality
-- [@wooksjs/http-body](https://github.com/wooksjs/wooksjs/tree/main/packages/http-body) - to parse body
-- [@wooksjs/http-static](https://github.com/wooksjs/wooksjs/tree/main/packages/http-static) - to serve static files
-- [@wooksjs/http-proxy](https://github.com/wooksjs/wooksjs/tree/main/packages/http-proxy) - to proxy requests
+Wooks is an event processing framework based on composable functions. It provides a typed, per-event context with lazy caching and a fast URI router, serving as the foundation for HTTP, CLI, and workflow applications.
 
 ## Installation
 
-`npm install wooks`
-
-## Quick Start with a Web App
-
-`npm install wooks @wooksjs/event-http`
-
-```js
-import { useRouteParams } from 'wooks'
-import { createHttpApp } from '@wooksjs/event-http'
-
-const app = createHttpApp()
-
-app.on('GET', 'hello/:name', () => `Hello ${useRouteParams().get('name')}!`)
-
-// shortcuts for some methods are supported:
-// app.get('hello/:name', () => `Hello ${ useRouteParams().get('name') }!`)
-
-app.listen(3000, () => {
-  console.log('Wooks Server is up on port 3000')
-})
+```sh
+npm install wooks
 ```
 
-See full documentation for http event [here](https://github.com/wooksjs/wooksjs/tree/main/packages/event-http)
-
 ## Documentation
 
-To check out docs, visit [wooks.moost.org](https://wooks.moost.org/).
+For full documentation, visit [wooks.moost.org](https://wooks.moost.org/).
+
+## License
+
+MIT

package/dist/index.cjs

@@ -74,9 +74,9 @@ var Wooks = class {
 	* @param method - HTTP method (e.g., "GET", "POST").
 	* @param path - URL path to match against registered routes.
 	*/
-	lookup(method, path) {
+	lookup(method, path, ctx = (0, __wooksjs_event_core.current)()) {
 		const found = this.getRouter().lookup(method, path || "");
-		(0, __wooksjs_event_core.useAsyncEventContext)().store("routeParams").value = found?.ctx?.params || {};
+		ctx.set(__wooksjs_event_core.routeParamsKey, found?.ctx?.params || {});
 		if (found?.route?.handlers.length) (0, __wooksjs_event_core.getContextInjector)().hook(method, "Handler:routed", found.route.path);
 		else (0, __wooksjs_event_core.getContextInjector)().hook(method, "Handler:not_found");
 		return {
@@ -87,6 +87,20 @@ var Wooks = class {
 		};
 	}
 	/**
+	* Fast lookup that returns only the handlers array (or null).
+	* Avoids allocating a result object on each request.
+	*/
+	lookupHandlers(method, path, ctx = (0, __wooksjs_event_core.current)()) {
+		const found = this.getRouter().lookup(method, path || "");
+		ctx.set(__wooksjs_event_core.routeParamsKey, found?.ctx?.params || {});
+		if (found?.route?.handlers.length) {
+			(0, __wooksjs_event_core.getContextInjector)().hook(method, "Handler:routed", found.route.path);
+			return found.route.handlers;
+		}
+		(0, __wooksjs_event_core.getContextInjector)().hook(method, "Handler:not_found");
+		return null;
+	}
+	/**
 	* Registers a route handler for the given method and path.
 	* @param method - HTTP method (e.g., "GET", "POST").
 	* @param path - URL path pattern (supports parameters like `/users/:id`).
@@ -158,18 +172,9 @@ var WooksAdapterBase = class WooksAdapterBase {
 	getLogger(topic) {
 		return this.getWooks().getLogger(topic);
 	}
-	getLoggerOptions() {
-		return this.getWooks().getLoggerOptions();
-	}
-	/** Merges the given event options with the current logger configuration. */
-	mergeEventOptions(opts) {
-		return {
-			...opts,
-			eventLogger: {
-				...this.getLoggerOptions(),
-				...opts?.eventLogger
-			}
-		};
+	/** Returns event context options with a logger derived from the Wooks instance. */
+	getEventContextOptions() {
+		return { logger: this.getWooks().getLogger("event") };
 	}
 	/**
 	* Registers a route handler for the given method and path.
@@ -193,10 +198,10 @@ Object.defineProperty(exports, 'useEventId', {
     return __wooksjs_event_core.useEventId;
   }
 });
-Object.defineProperty(exports, 'useEventLogger', {
+Object.defineProperty(exports, 'useLogger', {
   enumerable: true,
   get: function () {
-    return __wooksjs_event_core.useEventLogger;
+    return __wooksjs_event_core.useLogger;
   }
 });
 Object.defineProperty(exports, 'useRouteParams', {

package/dist/index.d.ts

@@ -1,11 +1,30 @@
+import { Key, EventContext, EventContextOptions } from '@wooksjs/event-core';
+export { EventContextOptions, Logger, useEventId, useLogger, useRouteParams } from '@wooksjs/event-core';
+import { IncomingMessage } from 'http';
+import { Duplex } from 'stream';
 import { TConsoleBase, TProstoLoggerOptions } from '@prostojs/logger';
 import { ProstoRouter, TParsedSegment, TProstoRouterPathHandle } from '@prostojs/router';
 export { TProstoRouterPathHandle } from '@prostojs/router';
-import { TEventOptions } from '@wooksjs/event-core';
-export { useEventId, useEventLogger, useRouteParams } from '@wooksjs/event-core';
 
 /** A route handler function that returns a response synchronously or asynchronously. */
 type TWooksHandler<ResType = unknown> = () => Promise<ResType> | ResType;
+/**
+ * Contract interface for integrating a WebSocket adapter with the HTTP adapter.
+ *
+ * The WS adapter implements this interface and provides context keys.
+ * The HTTP adapter accepts it via `httpApp.ws(handler)`, sets the keys
+ * on the HTTP context during upgrade events, and routes as method 'UPGRADE'.
+ */
+interface WooksUpgradeHandler {
+    /** Key for the upgrade request (HTTP sets this alongside its own httpKind.keys.req). */
+    readonly reqKey: Key<IncomingMessage>;
+    /** Key for the raw TCP socket from the upgrade event. */
+    readonly socketKey: Key<Duplex>;
+    /** Key for the initial data chunk from the upgrade event. */
+    readonly headKey: Key<Buffer>;
+    /** Fallback handler called by HTTP when no UPGRADE route matches. */
+    handleUpgrade(req: IncomingMessage, socket: Duplex, head: Buffer): void;
+}
 
 /** Configuration options for the Wooks instance. */
 interface TWooksOptions {
@@ -49,12 +68,17 @@ declare class Wooks {
      * @param method - HTTP method (e.g., "GET", "POST").
      * @param path - URL path to match against registered routes.
      */
-    lookup(method: string, path: string): {
+    lookup(method: string, path: string, ctx?: EventContext): {
         handlers: TWooksHandler[] | null;
         segments: TParsedSegment[] | null;
         firstStatic: string | null;
         path: string | null;
     };
+    /**
+     * Fast lookup that returns only the handlers array (or null).
+     * Avoids allocating a result object on each request.
+     */
+    lookupHandlers(method: string, path: string, ctx?: EventContext): TWooksHandler[] | null;
     /**
      * Registers a route handler for the given method and path.
      * @param method - HTTP method (e.g., "GET", "POST").
@@ -108,9 +132,8 @@ declare class WooksAdapterBase {
      * @returns logger instance
      */
     getLogger(topic: string): TConsoleBase;
-    protected getLoggerOptions(): TProstoLoggerOptions;
-    /** Merges the given event options with the current logger configuration. */
-    protected mergeEventOptions(opts?: TEventOptions): TEventOptions;
+    /** Returns event context options with a logger derived from the Wooks instance. */
+    protected getEventContextOptions(): EventContextOptions;
     /**
      * Registers a route handler for the given method and path.
      * @param method - HTTP method (e.g., "GET", "POST").
@@ -121,4 +144,4 @@ declare class WooksAdapterBase {
 }
 
 export { Wooks, WooksAdapterBase, clearGlobalWooks, getGlobalWooks };
-export type { TWooksHandler, TWooksOptions };
+export type { TWooksHandler, TWooksOptions, WooksUpgradeHandler };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { ProstoLogger, coloredConsole, createConsoleTransort } from "@prostojs/logger";
 import { ProstoRouter } from "@prostojs/router";
-import { getContextInjector, useAsyncEventContext, useEventId, useEventLogger, useRouteParams } from "@wooksjs/event-core";
+import { current, getContextInjector, routeParamsKey, useEventId, useLogger, useRouteParams } from "@wooksjs/event-core";
 
 //#region packages/wooks/src/wooks.ts
 function getDefaultLogger(topic) {
@@ -51,9 +51,9 @@ var Wooks = class {
 	* @param method - HTTP method (e.g., "GET", "POST").
 	* @param path - URL path to match against registered routes.
 	*/
-	lookup(method, path) {
+	lookup(method, path, ctx = current()) {
 		const found = this.getRouter().lookup(method, path || "");
-		useAsyncEventContext().store("routeParams").value = found?.ctx?.params || {};
+		ctx.set(routeParamsKey, found?.ctx?.params || {});
 		if (found?.route?.handlers.length) getContextInjector().hook(method, "Handler:routed", found.route.path);
 		else getContextInjector().hook(method, "Handler:not_found");
 		return {
@@ -64,6 +64,20 @@ var Wooks = class {
 		};
 	}
 	/**
+	* Fast lookup that returns only the handlers array (or null).
+	* Avoids allocating a result object on each request.
+	*/
+	lookupHandlers(method, path, ctx = current()) {
+		const found = this.getRouter().lookup(method, path || "");
+		ctx.set(routeParamsKey, found?.ctx?.params || {});
+		if (found?.route?.handlers.length) {
+			getContextInjector().hook(method, "Handler:routed", found.route.path);
+			return found.route.handlers;
+		}
+		getContextInjector().hook(method, "Handler:not_found");
+		return null;
+	}
+	/**
 	* Registers a route handler for the given method and path.
 	* @param method - HTTP method (e.g., "GET", "POST").
 	* @param path - URL path pattern (supports parameters like `/users/:id`).
@@ -135,18 +149,9 @@ var WooksAdapterBase = class WooksAdapterBase {
 	getLogger(topic) {
 		return this.getWooks().getLogger(topic);
 	}
-	getLoggerOptions() {
-		return this.getWooks().getLoggerOptions();
-	}
-	/** Merges the given event options with the current logger configuration. */
-	mergeEventOptions(opts) {
-		return {
-			...opts,
-			eventLogger: {
-				...this.getLoggerOptions(),
-				...opts?.eventLogger
-			}
-		};
+	/** Returns event context options with a logger derived from the Wooks instance. */
+	getEventContextOptions() {
+		return { logger: this.getWooks().getLogger("event") };
 	}
 	/**
 	* Registers a route handler for the given method and path.
@@ -160,4 +165,4 @@ var WooksAdapterBase = class WooksAdapterBase {
 };
 
 //#endregion
-export { Wooks, WooksAdapterBase, clearGlobalWooks, getGlobalWooks, useEventId, useEventLogger, useRouteParams };
+export { Wooks, WooksAdapterBase, clearGlobalWooks, getGlobalWooks, useEventId, useLogger, useRouteParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wooks",
-  "version": "0.6.5",
+  "version": "0.7.0",
   "description": "wooks",
   "keywords": [
     "api",
@@ -41,14 +41,14 @@
   },
   "dependencies": {
     "@prostojs/logger": "^0.4.3",
-    "@prostojs/router": "^0.3.0",
-    "@wooksjs/event-core": "^0.6.5"
+    "@prostojs/router": "^0.3.2",
+    "@wooksjs/event-core": "^0.7.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "@wooksjs/event-http": "^0.6.5",
-    "@wooksjs/http-body": "^0.6.5"
+    "@wooksjs/http-body": "^0.7.0",
+    "@wooksjs/event-http": "^0.7.0"
   },
   "scripts": {
     "build": "rolldown -c ../../rolldown.config.mjs"