koatty_router 2.0.9 → 2.1.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
 
-> koatty_router@2.0.9 build /Users/richen/Workspace/nodejs/koatty-monorepo/packages/koatty-router
+> koatty_router@2.1.0 build /Users/richen/Workspace/nodejs/koatty-monorepo/packages/koatty-router
 > npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp
 
 
-> koatty_router@2.0.9 build:js
+> koatty_router@2.1.0 build:js
 > npx rollup --bundleConfigAsCjs -c .rollup.config.js
 
-
+⠙
 ./src/index.ts → ./dist/index.js, ./dist/index.mjs...
-created ./dist/index.js, ./dist/index.mjs in 15.5s
+created ./dist/index.js, ./dist/index.mjs in 12.6s
 ⠙⠙
-> koatty_router@2.0.9 build:dts
+> koatty_router@2.1.0 build:dts
 > bash ../../scripts/build-dts.sh
 
 🔨 Building type declarations for koatty-router...
@@ -19,17 +19,15 @@
 
 🔍 Checking dependencies: koatty_container, koatty_core, koatty_exception, koatty_graphql, koatty_lib, koatty_logger, koatty_proto, koatty_validation
   ✓ koatty_container type declarations ready
+  ✓ koatty_core type declarations ready
   ✓ koatty_exception type declarations ready
   ✓ koatty_graphql type declarations ready
   ✓ koatty_lib type declarations ready
   ✓ koatty_logger type declarations ready
   ✓ koatty_proto type declarations ready
   ✓ koatty_validation type declarations ready
-  ⏳ Waiting for: koatty_core (0s)
-     ✗ koatty_core: missing .d.ts
-  ✓ koatty_core type declarations ready
 
-✅ All dependencies ready (waited 1004ms)
+✅ All dependencies ready (waited 2ms)
 📝 Running TypeScript compiler...
 ⠙⠙📦 Running API Extractor...
 
@@ -40,6 +38,7 @@ Analysis will use the bundled TypeScript version 5.8.2
 *** The target project appears to use TypeScript 5.9.3 which is newer than the bundled compiler engine; consider upgrading API Extractor.
 Writing: /Users/richen/Workspace/nodejs/koatty-monorepo/packages/koatty-router/temp/koatty_router.api.json
 Writing package typings: /Users/richen/Workspace/nodejs/koatty-monorepo/packages/koatty-router/dist/index.d.ts
+Warning: src/RouterComponent.ts:160:38 - (tsdoc-characters-after-block-tag) The token "@OnEvent" looks like a TSDoc tag but contains an invalid character "("; if it is not a tag, use a backslash to escape the "@"
 Warning: src/params/mapping.ts:33:4 - (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration
 Warning: src/params/mapping.ts:34:4 - (tsdoc-undefined-tag) The TSDoc tag "@interface" is not defined in this configuration
 Warning: src/params/mapping.ts:47:4 - (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration
@@ -114,18 +113,20 @@ Analysis will use the bundled TypeScript version 5.8.2
 Warning: src/router/router.ts:54:14 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
 Warning: src/router/router.ts:55:62 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
 Warning: src/router/router.ts:55:17 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
-Warning: src/router/router.ts:87:4 - (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration
-Warning: src/router/router.ts:88:11 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
-Warning: src/router/router.ts:89:11 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
-Warning: src/router/router.ts:90:15 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-Warning: src/router/router.ts:90:31 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-Warning: src/router/router.ts:90:13 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
-Warning: src/router/router.ts:90:18 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
+Warning: src/router/router.ts:89:4 - (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration
+Warning: src/router/router.ts:90:11 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
+Warning: src/router/router.ts:91:11 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
+Warning: src/router/router.ts:92:15 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
+Warning: src/router/router.ts:92:66 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
+Warning: src/router/router.ts:92:67 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
+Warning: src/router/router.ts:92:13 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
+Warning: src/router/router.ts:92:18 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
+Warning: src/router/router.ts:92:19 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
 
 API Extractor completed successfully
 ⠙✅ Type declarations built successfully
 ⠙
-> koatty_router@2.0.9 build:doc
+> koatty_router@2.1.0 build:doc
 > npx api-documenter markdown --input temp --output docs/api
 
 
@@ -168,10 +169,18 @@ Unsupported block tag: @interface
 Unsupported block tag: @RequestBody
 Unsupported block tag: @RequestParam
 ⠙⠙
-> koatty_router@2.0.9 build:cp
+> koatty_router@2.1.0 build:cp
 > copyfiles package.json LICENSE README.md dist/ && node scripts/postBuild
 
-✓ Fixed main: ./dist/... → ./index.js
+✓ Fixed dependencies.koatty_container: workspace:* → ^2.0.0
+✓ Fixed dependencies.koatty_core: workspace:* → ^2.1.0
+✓ Fixed dependencies.koatty_exception: workspace:* → ^2.1.0
+✓ Fixed dependencies.koatty_graphql: workspace:* → ^1.1.4
+✓ Fixed dependencies.koatty_lib: workspace:* → ^1.4.5
+✓ Fixed dependencies.koatty_logger: workspace:* → ^2.4.0
+✓ Fixed dependencies.koatty_proto: workspace:* → ^1.3.5
+✓ Fixed dependencies.koatty_validation: workspace:* → ^2.0.0
+✓ Fixed main: ./dist/... → ./index.js
 ✓ Fixed types: ./dist/... → ./index.d.ts
 ✓ Fixed exports.require: ./dist/index.js → ./index.js
 ✓ Fixed exports.import: ./dist/index.mjs → ./index.mjs

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 2.1.0
+
+### Minor Changes
+
+- build
+
+### Patch Changes
+
+- Updated dependencies
+  - koatty_container@2.0.0
+  - koatty_core@2.1.0
+  - koatty_exception@2.1.0
+  - koatty_logger@2.4.0
+  - koatty_validation@2.0.0
+
 ## 2.0.9
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,13 +1,12 @@
 /*!
 * @Author: richen
-* @Date: 2026-01-28 17:21:09
+* @Date: 2026-01-31 09:50:30
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
 import { Application } from 'koatty_container';
-import { IPlugin } from 'koatty_core';
-import { IPluginCapability } from 'koatty_core';
+import { IComponent } from 'koatty_core';
 import { KoattyApplication } from 'koatty_core';
 import { KoattyContext } from 'koatty_core';
 import { KoattyNext } from 'koatty_core';
@@ -214,9 +213,12 @@ export declare type MiddlewareFunction = <T = unknown>(ctx: KoattyContext, next:
  * @export
  * @param {KoattyApplication} app
  * @param {RouterOptions} options
- * @returns {*}  {KoattyRouter}
+ * @returns {*}  {{ router: KoattyRouter, factory: RouterFactory }}
  */
-export declare function NewRouter(app: KoattyApplication, opt?: RouterOptions): KoattyRouter;
+export declare function NewRouter(app: KoattyApplication, opt?: RouterOptions): {
+    router: KoattyRouter;
+    factory: RouterFactory;
+};
 
 /**
  * Routes HTTP OPTIONS requests to the specified path.
@@ -359,6 +361,42 @@ export declare enum RequestMethod {
  */
 export declare function RequestParam(): ParameterDecorator;
 
+/**
+ * Router Component
+ * Responsible for initializing and managing routing
+ *
+ * Implements IComponent interface (base interface)
+ *
+ * Event bindings:
+ * - loadRouter: Initialize router
+ * - appStop: Cleanup router resources
+ */
+export declare class RouterComponent implements IComponent {
+    events: Record<string, any>;
+    /**
+     * Initialize router and load routes
+     *
+     * This method handles the complete router initialization:
+     * 1. Create router instance(s) for configured protocol(s)
+     * 2. Bind router to app.router
+     * 3. Load controller routes into router
+     */
+    initRouter(app: KoattyApplication): Promise<void>;
+    /**
+     * Load controller routes into router
+     *
+     * @param app - Koatty application instance
+     */
+    run(app: KoattyApplication): Promise<void>;
+    /**
+     * Cleanup router resources on app stop
+     *
+     * NOTE: Original app.once("appStop", ...) listener in router.ts
+     * is now unified to be handled by @OnEvent(AppEvent.appStop) decorator
+     */
+    cleanup(_app: KoattyApplication): Promise<void>;
+}
+
 /**
  * Router constructor type
  */
@@ -614,38 +652,32 @@ export declare interface RouterOptions {
      *
      * @example
      * ```typescript
-     * // WebSocket 配置
-     * ext: {
-     *   maxFrameSize: 1024 * 1024,
-     *   heartbeatInterval: 15000,
-     *   maxConnections: 1000
-     * }
-     *
-     * // gRPC 配置
      * ext: {
-     *   protoFile: "./proto/service.proto",
-     *   poolSize: 10,
-     *   streamConfig: { maxConcurrentStreams: 50 }
-     * }
-     *
-     * // GraphQL 配置
-     * ext: {
-     *   schemaFile: "./schema/schema.graphql",
-     *   playground: true
+     *   http: {},
+     *   grpc: {
+     *     protoFile: "./proto/service.proto",
+     *     poolSize: 10,
+     *     streamConfig: { maxConcurrentStreams: 50 }
+     *   },
+     *   graphql: {
+     *     schemaFile: "./resource/graphql/schema.graphql",
+     *     // Optional: Enable HTTP/2 with SSL for GraphQL
+     *     // keyFile: "./ssl/server.key",
+     *     // crtFile: "./ssl/server.crt",
+     *     // ssl: { mode: 'auto', allowHTTP1: true },
+     *     // http2: { maxConcurrentStreams: 100 }
+     *   },
+     *   ws: {
+     *     maxFrameSize: 1024 * 1024,
+     *     heartbeatInterval: 15000,
+     *     maxConnections: 1000
+     *   }
      * }
      * ```
      */
     ext?: Record<string, any>;
 }
 
-export declare class RouterPlugin implements IPlugin {
-    readonly provides: IPluginCapability[];
-    readonly events: {
-        beforeRouterLoad: (app: KoattyApplication) => Promise<void>;
-    };
-    uninstall(_app: KoattyApplication): Promise<void>;
-}
-
 /**
  * gRPC 流配置
  */