wooks 0.6.2 → 0.6.3

package/dist/index.cjs

@@ -32,9 +32,19 @@ function getDefaultLogger(topic) {
 		transports: [(0, __prostojs_logger.createConsoleTransort)({ format: __prostojs_logger.coloredConsole })]
 	}, topic);
 }
+/**
+* Core Wooks framework class that manages routing and logging.
+*
+* @example
+* ```ts
+* const wooks = new Wooks({ router: { ignoreTrailingSlash: true } })
+* wooks.on('GET', '/hello', () => 'Hello World')
+* ```
+*/
 var Wooks = class {
 	router;
 	logger;
+	/** @param opts - Optional configuration for router and logger. */
 	constructor(opts) {
 		this.router = new __prostojs_router.ProstoRouter({
 			silent: true,
@@ -42,17 +52,28 @@ var Wooks = class {
 		});
 		this.logger = opts?.logger || getDefaultLogger(`[wooks]`);
 	}
+	/** Returns the underlying ProstoRouter instance. */
 	getRouter() {
 		return this.router;
 	}
+	/**
+	* Creates a child logger with the given topic.
+	* @param topic - Label for the logger topic.
+	*/
 	getLogger(topic) {
 		if (this.logger instanceof __prostojs_logger.ProstoLogger) return this.logger.createTopic(topic);
 		return this.logger;
 	}
+	/** Returns the current logger configuration options. */
 	getLoggerOptions() {
 		if (this.logger instanceof __prostojs_logger.ProstoLogger) return this.logger.getOptions();
 		return {};
 	}
+	/**
+	* Looks up a route by method and path, setting route params in the current event context.
+	* @param method - HTTP method (e.g., "GET", "POST").
+	* @param path - URL path to match against registered routes.
+	*/
 	lookup(method, path) {
 		const found = this.getRouter().lookup(method, path || "");
 		(0, __wooksjs_event_core.useAsyncEventContext)().store("routeParams").value = found?.ctx?.params || {};
@@ -65,6 +86,12 @@ var Wooks = class {
 			path: found?.route?.path || 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`).
+	* @param handler - Handler function invoked when the route matches.
+	*/
 	on(method, path, handler) {
 		return this.router.on(method, path, handler);
 	}
@@ -79,10 +106,9 @@ function clearGlobalWooks() {
 	gWooks = void 0;
 }
 /**
-* Creates global wooks singleton instance to share across adapters
-* @param logger
-* @param routerOpts
-* @returns
+* Returns the global Wooks singleton, creating it on first call.
+* @param logger - Optional custom logger for the instance.
+* @param routerOpts - Optional router configuration.
 */
 function getGlobalWooks(logger, routerOpts) {
 	if (!gWooks) gWooks = new Wooks({
@@ -91,13 +117,31 @@ function getGlobalWooks(logger, routerOpts) {
 	});
 	return gWooks;
 }
+/**
+* Base class for Wooks adapters that bridges a specific runtime (e.g., HTTP, CLI) with Wooks routing.
+*
+* @example
+* ```ts
+* class MyAdapter extends WooksAdapterBase {
+*   constructor(wooks?: Wooks) {
+*     super(wooks)
+*   }
+* }
+* ```
+*/
 var WooksAdapterBase = class WooksAdapterBase {
 	wooks;
+	/**
+	* @param wooks - Existing Wooks or adapter instance to share; creates/uses global instance if omitted.
+	* @param logger - Custom logger for the global Wooks instance (ignored when `wooks` is provided).
+	* @param routerOpts - Router options for the global Wooks instance (ignored when `wooks` is provided).
+	*/
 	constructor(wooks, logger, routerOpts) {
 		if (wooks && wooks instanceof WooksAdapterBase) this.wooks = wooks.getWooks();
 		else if (wooks && wooks instanceof Wooks) this.wooks = wooks;
 		else this.wooks = getGlobalWooks(logger, routerOpts);
 	}
+	/** Returns the underlying Wooks instance. */
 	getWooks() {
 		return this.wooks;
 	}
@@ -117,6 +161,7 @@ var WooksAdapterBase = class WooksAdapterBase {
 	getLoggerOptions() {
 		return this.getWooks().getLoggerOptions();
 	}
+	/** Merges the given event options with the current logger configuration. */
 	mergeEventOptions(opts) {
 		return {
 			...opts,
@@ -126,6 +171,12 @@ var WooksAdapterBase = class WooksAdapterBase {
 			}
 		};
 	}
+	/**
+	* 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`).
+	* @param handler - Handler function invoked when the route matches.
+	*/
 	on(method, path, handler) {
 		return this.wooks.on(method, path, handler);
 	}

package/dist/index.d.ts

@@ -4,29 +4,63 @@ 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;
 
+/** Configuration options for the Wooks instance. */
 interface TWooksOptions {
+    /** Custom logger instance to use instead of the default. */
     logger?: TConsoleBase;
+    /** Router configuration options. */
     router?: {
+        /** When true, `/path` and `/path/` are treated as the same route. */
         ignoreTrailingSlash?: boolean;
+        /** When true, route matching is case-insensitive. */
         ignoreCase?: boolean;
+        /** Maximum number of parsed routes to cache. */
         cacheLimit?: number;
     };
 }
+/**
+ * Core Wooks framework class that manages routing and logging.
+ *
+ * @example
+ * ```ts
+ * const wooks = new Wooks({ router: { ignoreTrailingSlash: true } })
+ * wooks.on('GET', '/hello', () => 'Hello World')
+ * ```
+ */
 declare class Wooks {
     protected router: ProstoRouter<TWooksHandler>;
     protected logger: TConsoleBase;
+    /** @param opts - Optional configuration for router and logger. */
     constructor(opts?: TWooksOptions);
+    /** Returns the underlying ProstoRouter instance. */
     getRouter(): ProstoRouter<TWooksHandler>;
+    /**
+     * Creates a child logger with the given topic.
+     * @param topic - Label for the logger topic.
+     */
     getLogger(topic: string): TConsoleBase;
+    /** Returns the current logger configuration options. */
     getLoggerOptions(): TProstoLoggerOptions;
+    /**
+     * Looks up a route by method and path, setting route params in the current event context.
+     * @param method - HTTP method (e.g., "GET", "POST").
+     * @param path - URL path to match against registered routes.
+     */
     lookup(method: string, path: string): {
         handlers: TWooksHandler[] | null;
         segments: TParsedSegment[] | null;
         firstStatic: string | null;
         path: string | 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`).
+     * @param handler - Handler function invoked when the route matches.
+     */
     on<ResType = unknown, ParamsType = Record<string, string | string[]>>(method: string, path: string, handler: TWooksHandler<ResType>): TProstoRouterPathHandle<ParamsType>;
 }
 /**
@@ -36,15 +70,32 @@ declare class Wooks {
  */
 declare function clearGlobalWooks(): void;
 /**
- * Creates global wooks singleton instance to share across adapters
- * @param logger
- * @param routerOpts
- * @returns
+ * Returns the global Wooks singleton, creating it on first call.
+ * @param logger - Optional custom logger for the instance.
+ * @param routerOpts - Optional router configuration.
  */
 declare function getGlobalWooks(logger?: TConsoleBase, routerOpts?: TWooksOptions['router']): Wooks;
+/**
+ * Base class for Wooks adapters that bridges a specific runtime (e.g., HTTP, CLI) with Wooks routing.
+ *
+ * @example
+ * ```ts
+ * class MyAdapter extends WooksAdapterBase {
+ *   constructor(wooks?: Wooks) {
+ *     super(wooks)
+ *   }
+ * }
+ * ```
+ */
 declare class WooksAdapterBase {
     protected wooks: Wooks;
+    /**
+     * @param wooks - Existing Wooks or adapter instance to share; creates/uses global instance if omitted.
+     * @param logger - Custom logger for the global Wooks instance (ignored when `wooks` is provided).
+     * @param routerOpts - Router options for the global Wooks instance (ignored when `wooks` is provided).
+     */
     constructor(wooks?: Wooks | WooksAdapterBase, logger?: TConsoleBase, routerOpts?: TWooksOptions['router']);
+    /** Returns the underlying Wooks instance. */
     getWooks(): Wooks;
     /**
      * Get logger instance for application logs
@@ -58,8 +109,16 @@ declare class WooksAdapterBase {
      */
     getLogger(topic: string): TConsoleBase;
     protected getLoggerOptions(): TProstoLoggerOptions;
+    /** Merges the given event options with the current logger configuration. */
     protected mergeEventOptions(opts?: TEventOptions): TEventOptions;
+    /**
+     * 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`).
+     * @param handler - Handler function invoked when the route matches.
+     */
     on<ResType = unknown, ParamsType = Record<string, string | string[]>>(method: string, path: string, handler: TWooksHandler<ResType>): TProstoRouterPathHandle<ParamsType>;
 }
 
-export { type TWooksHandler, type TWooksOptions, Wooks, WooksAdapterBase, clearGlobalWooks, getGlobalWooks };
+export { Wooks, WooksAdapterBase, clearGlobalWooks, getGlobalWooks };
+export type { TWooksHandler, TWooksOptions };

package/dist/index.mjs

@@ -9,9 +9,19 @@ function getDefaultLogger(topic) {
 		transports: [createConsoleTransort({ format: coloredConsole })]
 	}, topic);
 }
+/**
+* Core Wooks framework class that manages routing and logging.
+*
+* @example
+* ```ts
+* const wooks = new Wooks({ router: { ignoreTrailingSlash: true } })
+* wooks.on('GET', '/hello', () => 'Hello World')
+* ```
+*/
 var Wooks = class {
 	router;
 	logger;
+	/** @param opts - Optional configuration for router and logger. */
 	constructor(opts) {
 		this.router = new ProstoRouter({
 			silent: true,
@@ -19,17 +29,28 @@ var Wooks = class {
 		});
 		this.logger = opts?.logger || getDefaultLogger(`[wooks]`);
 	}
+	/** Returns the underlying ProstoRouter instance. */
 	getRouter() {
 		return this.router;
 	}
+	/**
+	* Creates a child logger with the given topic.
+	* @param topic - Label for the logger topic.
+	*/
 	getLogger(topic) {
 		if (this.logger instanceof ProstoLogger) return this.logger.createTopic(topic);
 		return this.logger;
 	}
+	/** Returns the current logger configuration options. */
 	getLoggerOptions() {
 		if (this.logger instanceof ProstoLogger) return this.logger.getOptions();
 		return {};
 	}
+	/**
+	* Looks up a route by method and path, setting route params in the current event context.
+	* @param method - HTTP method (e.g., "GET", "POST").
+	* @param path - URL path to match against registered routes.
+	*/
 	lookup(method, path) {
 		const found = this.getRouter().lookup(method, path || "");
 		useAsyncEventContext().store("routeParams").value = found?.ctx?.params || {};
@@ -42,6 +63,12 @@ var Wooks = class {
 			path: found?.route?.path || 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`).
+	* @param handler - Handler function invoked when the route matches.
+	*/
 	on(method, path, handler) {
 		return this.router.on(method, path, handler);
 	}
@@ -56,10 +83,9 @@ function clearGlobalWooks() {
 	gWooks = void 0;
 }
 /**
-* Creates global wooks singleton instance to share across adapters
-* @param logger
-* @param routerOpts
-* @returns
+* Returns the global Wooks singleton, creating it on first call.
+* @param logger - Optional custom logger for the instance.
+* @param routerOpts - Optional router configuration.
 */
 function getGlobalWooks(logger, routerOpts) {
 	if (!gWooks) gWooks = new Wooks({
@@ -68,13 +94,31 @@ function getGlobalWooks(logger, routerOpts) {
 	});
 	return gWooks;
 }
+/**
+* Base class for Wooks adapters that bridges a specific runtime (e.g., HTTP, CLI) with Wooks routing.
+*
+* @example
+* ```ts
+* class MyAdapter extends WooksAdapterBase {
+*   constructor(wooks?: Wooks) {
+*     super(wooks)
+*   }
+* }
+* ```
+*/
 var WooksAdapterBase = class WooksAdapterBase {
 	wooks;
+	/**
+	* @param wooks - Existing Wooks or adapter instance to share; creates/uses global instance if omitted.
+	* @param logger - Custom logger for the global Wooks instance (ignored when `wooks` is provided).
+	* @param routerOpts - Router options for the global Wooks instance (ignored when `wooks` is provided).
+	*/
 	constructor(wooks, logger, routerOpts) {
 		if (wooks && wooks instanceof WooksAdapterBase) this.wooks = wooks.getWooks();
 		else if (wooks && wooks instanceof Wooks) this.wooks = wooks;
 		else this.wooks = getGlobalWooks(logger, routerOpts);
 	}
+	/** Returns the underlying Wooks instance. */
 	getWooks() {
 		return this.wooks;
 	}
@@ -94,6 +138,7 @@ var WooksAdapterBase = class WooksAdapterBase {
 	getLoggerOptions() {
 		return this.getWooks().getLoggerOptions();
 	}
+	/** Merges the given event options with the current logger configuration. */
 	mergeEventOptions(opts) {
 		return {
 			...opts,
@@ -103,6 +148,12 @@ var WooksAdapterBase = class WooksAdapterBase {
 			}
 		};
 	}
+	/**
+	* 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`).
+	* @param handler - Handler function invoked when the route matches.
+	*/
 	on(method, path, handler) {
 		return this.wooks.on(method, path, handler);
 	}

package/package.json

@@ -1,13 +1,36 @@
 {
   "name": "wooks",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "wooks",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "keywords": [
+    "api",
+    "app",
+    "composables",
+    "framework",
+    "http",
+    "prostojs",
+    "rest",
+    "restful",
+    "web",
+    "wooks"
+  ],
+  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/wooks#readme",
+  "bugs": {
+    "url": "https://github.com/wooksjs/wooksjs/issues"
+  },
+  "license": "MIT",
+  "author": "Artem Maltsev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wooksjs/wooksjs.git",
+    "directory": "packages/wooks"
+  },
   "files": [
     "dist"
   ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -16,39 +39,16 @@
       "import": "./dist/index.mjs"
     }
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/wooksjs/wooksjs.git",
-    "directory": "packages/wooks"
-  },
-  "keywords": [
-    "http",
-    "wooks",
-    "composables",
-    "web",
-    "framework",
-    "app",
-    "api",
-    "rest",
-    "restful",
-    "prostojs"
-  ],
-  "author": "Artem Maltsev",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/wooksjs/wooksjs/issues"
-  },
   "dependencies": {
     "@prostojs/logger": "^0.4.3",
     "@prostojs/router": "^0.2.1",
-    "@wooksjs/event-core": "^0.6.2"
+    "@wooksjs/event-core": "^0.6.3"
   },
-  "homepage": "https://github.com/wooksjs/wooksjs/tree/main/packages/wooks#readme",
   "devDependencies": {
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.3",
     "vitest": "^3.2.4",
-    "@wooksjs/event-http": "^0.6.2",
-    "@wooksjs/http-body": "^0.6.2"
+    "@wooksjs/event-http": "^0.6.3",
+    "@wooksjs/http-body": "^0.6.3"
   },
   "scripts": {
     "build": "rolldown -c ../../rolldown.config.mjs"