imean-service-engine 2.0.0 → 2.0.2

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import { Hono, MiddlewareHandler } from 'hono';
 export { Context, MiddlewareHandler } from 'hono';
-import { ContentfulStatusCode } from 'hono/utils/http-status';
 import * as hono_utils_html from 'hono/utils/html';
+import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
+import { ContentfulStatusCode } from 'hono/utils/http-status';
 import { z } from 'zod';
 export { z } from 'zod';
 
@@ -51,10 +52,6 @@ declare class Microservice<ModuleOptions = Record<string, any>> {
      * 在所有插件执行完 onHandlerLoad 后调用
      */
     private applyWrapperChains;
-    /**
-     * 检查端口是否可用
-     */
-    private isPortAvailable;
     /**
      * 寻找一个随机的可用端口
      */
@@ -313,6 +310,37 @@ interface PreStartChecker {
 }
 declare function startCheck(checkers: PreStartChecker[], pass?: () => void | Promise<void>): Promise<void>;
 
+declare const BaseLayout: (props?: {
+    children?: any;
+    title?: string;
+    heads?: any;
+}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+declare const HtmxLayout: (props?: {
+    children?: any;
+    title: string;
+    favicon?: any;
+}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+
+/**
+ * 服务状态信息接口
+ * 基于 MicroserviceOptions，并添加运行时信息
+ */
+interface ServiceStatusInfo {
+    name: string;
+    version: string;
+    prefix?: string;
+    hostname?: string;
+    port?: number;
+    env?: string;
+    status?: string;
+}
+declare const ServiceInfoCards: ({ serviceInfo, }: {
+    serviceInfo: ServiceStatusInfo;
+}) => hono_jsx_jsx_dev_runtime.JSX.Element;
+declare const ServiceStatusPage: ({ serviceInfo, }: {
+    serviceInfo: ServiceStatusInfo;
+}) => hono_jsx_jsx_dev_runtime.JSX.Element;
+
 type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
 /**
  * Route装饰器配置选项
@@ -365,6 +393,12 @@ interface RouteModuleOptions {
  * RoutePlugin 配置选项
  */
 interface RoutePluginOptions {
+    /**
+     * 全局路径前缀（应用于所有路由）
+     * 路径拼接顺序：全局前缀 + 模块前缀 + 路由路径
+     * 例如：prefix="/api", routePrefix="/v1", path="/users" => "/api/v1/users"
+     */
+    prefix?: string;
     /**
      * 全局中间件（应用于所有路由）
      * 执行顺序：全局中间件 -> 模块级中间件 -> 路由级中间件
@@ -373,19 +407,54 @@ interface RoutePluginOptions {
     globalMiddlewares?: MiddlewareHandler[];
 }
 
+/**
+ * Route装饰器（Handler的语法糖封装）
+ * 固定type="route"，简化HTTP路由标注
+ * 使用最新的 Stage 3 装饰器标准
+ *
+ * @example
+ * ```typescript
+ * @Route({ method: "GET", path: "/users" })
+ * async getUsers(ctx: Context) {
+ *   return ctx.json({ users: [] });
+ * }
+ *
+ * // 支持多个路径
+ * @Route({ path: ["/", "/home", "/dashboard"] })
+ * async homePage(ctx: Context) {
+ *   return <HomePage />;
+ * }
+ * ```
+ */
+declare function Route(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
+/**
+ * Page装饰器（Route的别名，用于向后兼容）
+ * 专门用于页面路由，默认使用 GET 方法
+ *
+ * @example
+ * ```typescript
+ * @Page({ path: ["/", "/home"] })
+ * async adminPage(ctx: Context) {
+ *   return HtmxLayout({ title: "Admin", children: <AdminLayout /> });
+ * }
+ * ```
+ */
+declare function Page(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
+
 /**
  * RoutePlugin - 核心路由插件
  * 负责解析type="route"的Handler元数据，注册HTTP路由到Hono实例
  *
  * @example
  * ```typescript
- * // 使用全局中间件（如鉴权）
+ * // 使用全局前缀和中间件
  * const authMiddleware = async (ctx, next) => {
  *   // 验证 token
  *   await next();
  * };
  *
  * const routePlugin = new RoutePlugin({
+ *   prefix: "/api", // 全局路径前缀，所有路由都会加上这个前缀
  *   globalMiddlewares: [authMiddleware],
  * });
  * ```
@@ -394,6 +463,7 @@ declare class RoutePlugin implements Plugin<RouteModuleOptions> {
     readonly name = "route-plugin";
     readonly priority = PluginPriority.ROUTE;
     private engine;
+    private globalPrefix;
     private globalMiddlewares;
     /**
      * 构造函数
@@ -414,51 +484,6 @@ declare class RoutePlugin implements Plugin<RouteModuleOptions> {
     onHandlerLoad(handlers: HandlerMetadata[]): void;
 }
 
-/**
- * Route装饰器（Handler的语法糖封装）
- * 固定type="route"，简化HTTP路由标注
- * 使用最新的 Stage 3 装饰器标准
- *
- * @example
- * ```typescript
- * @Route({ method: "GET", path: "/users" })
- * async getUsers(ctx: Context) {
- *   return ctx.json({ users: [] });
- * }
- *
- * // 支持多个路径
- * @Route({ path: ["/", "/home", "/dashboard"] })
- * async homePage(ctx: Context) {
- *   return <HomePage />;
- * }
- * ```
- */
-declare function Route(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
-/**
- * Page装饰器（Route的别名，用于向后兼容）
- * 专门用于页面路由，默认使用 GET 方法
- *
- * @example
- * ```typescript
- * @Page({ path: ["/", "/home"] })
- * async adminPage(ctx: Context) {
- *   return HtmxLayout({ title: "Admin", children: <AdminLayout /> });
- * }
- * ```
- */
-declare function Page(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
-
-declare const BaseLayout: (props?: {
-    children?: any;
-    title?: string;
-    heads?: any;
-}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
-declare const HtmxLayout: (props?: {
-    children?: any;
-    title: string;
-    favicon?: any;
-}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
-
 /**
  * Action装饰器配置选项
  */
@@ -1306,4 +1331,4 @@ declare const Testing: {
     readonly wait: typeof wait;
 };
 
-export { Action, type ActionInfo, type ActionModuleOptions, type ActionOptions, ActionPlugin, BaseLayout, Cache, type CacheAdapter, type CacheItem, type CacheModuleOptions, type CacheOptions, CachePlugin, type Campaign, type Class, type ClassDecoratorContext, type ClassMethodDecoratorContext$1 as ClassMethodDecoratorContext, ClientCodePlugin, type ClientCodePluginOptions, DEFAULT_TEST_OPTIONS, DuplicateModuleError, type Election, type Etcd3, Factory, GracefulShutdownPlugin, type GracefulShutdownPluginOptions, type HTTPMethod, Handler, type HandlerMetadata, type HandlerWrapper, HtmxLayout, MemoryCacheAdapter, Microservice, type MicroserviceOptions, MockEtcd3, ModuleConfigValidationError, type ModuleDecorator, type ModuleInfo, type ModuleMetadata, type Observer, Page, type Plugin, type PluginModuleOptionsSchema, PluginNameRequiredError, PluginPriority, type PreStartChecker, RedisCacheAdapter, type RedisCacheAdapterOptions, Route, type RouteModuleOptions, type RouteOptions, RoutePlugin, type RoutePluginOptions, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, SchedulePlugin, type SchedulePluginOptions, Scheduler, Testing, convertHandlersToModuleInfo, convertHandlersToModuleInfoWithMetadata, generateClientCode, getZodTypeString, startCheck };
+export { Action, type ActionInfo, type ActionModuleOptions, type ActionOptions, ActionPlugin, BaseLayout, Cache, type CacheAdapter, type CacheItem, type CacheModuleOptions, type CacheOptions, CachePlugin, type Campaign, type Class, type ClassDecoratorContext, type ClassMethodDecoratorContext$1 as ClassMethodDecoratorContext, ClientCodePlugin, type ClientCodePluginOptions, DEFAULT_TEST_OPTIONS, DuplicateModuleError, type Election, type Etcd3, Factory, GracefulShutdownPlugin, type GracefulShutdownPluginOptions, type HTTPMethod, Handler, type HandlerMetadata, type HandlerWrapper, HtmxLayout, MemoryCacheAdapter, Microservice, type MicroserviceOptions, MockEtcd3, ModuleConfigValidationError, type ModuleDecorator, type ModuleInfo, type ModuleMetadata, type Observer, Page, type Plugin, type PluginModuleOptionsSchema, PluginNameRequiredError, PluginPriority, type PreStartChecker, RedisCacheAdapter, type RedisCacheAdapterOptions, Route, type RouteModuleOptions, type RouteOptions, RoutePlugin, type RoutePluginOptions, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, SchedulePlugin, type SchedulePluginOptions, Scheduler, ServiceInfoCards, type ServiceStatusInfo, ServiceStatusPage, Testing, convertHandlersToModuleInfo, convertHandlersToModuleInfoWithMetadata, generateClientCode, getZodTypeString, startCheck };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import { Hono, MiddlewareHandler } from 'hono';
 export { Context, MiddlewareHandler } from 'hono';
-import { ContentfulStatusCode } from 'hono/utils/http-status';
 import * as hono_utils_html from 'hono/utils/html';
+import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
+import { ContentfulStatusCode } from 'hono/utils/http-status';
 import { z } from 'zod';
 export { z } from 'zod';
 
@@ -51,10 +52,6 @@ declare class Microservice<ModuleOptions = Record<string, any>> {
      * 在所有插件执行完 onHandlerLoad 后调用
      */
     private applyWrapperChains;
-    /**
-     * 检查端口是否可用
-     */
-    private isPortAvailable;
     /**
      * 寻找一个随机的可用端口
      */
@@ -313,6 +310,37 @@ interface PreStartChecker {
 }
 declare function startCheck(checkers: PreStartChecker[], pass?: () => void | Promise<void>): Promise<void>;
 
+declare const BaseLayout: (props?: {
+    children?: any;
+    title?: string;
+    heads?: any;
+}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+declare const HtmxLayout: (props?: {
+    children?: any;
+    title: string;
+    favicon?: any;
+}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+
+/**
+ * 服务状态信息接口
+ * 基于 MicroserviceOptions，并添加运行时信息
+ */
+interface ServiceStatusInfo {
+    name: string;
+    version: string;
+    prefix?: string;
+    hostname?: string;
+    port?: number;
+    env?: string;
+    status?: string;
+}
+declare const ServiceInfoCards: ({ serviceInfo, }: {
+    serviceInfo: ServiceStatusInfo;
+}) => hono_jsx_jsx_dev_runtime.JSX.Element;
+declare const ServiceStatusPage: ({ serviceInfo, }: {
+    serviceInfo: ServiceStatusInfo;
+}) => hono_jsx_jsx_dev_runtime.JSX.Element;
+
 type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
 /**
  * Route装饰器配置选项
@@ -365,6 +393,12 @@ interface RouteModuleOptions {
  * RoutePlugin 配置选项
  */
 interface RoutePluginOptions {
+    /**
+     * 全局路径前缀（应用于所有路由）
+     * 路径拼接顺序：全局前缀 + 模块前缀 + 路由路径
+     * 例如：prefix="/api", routePrefix="/v1", path="/users" => "/api/v1/users"
+     */
+    prefix?: string;
     /**
      * 全局中间件（应用于所有路由）
      * 执行顺序：全局中间件 -> 模块级中间件 -> 路由级中间件
@@ -373,19 +407,54 @@ interface RoutePluginOptions {
     globalMiddlewares?: MiddlewareHandler[];
 }
 
+/**
+ * Route装饰器（Handler的语法糖封装）
+ * 固定type="route"，简化HTTP路由标注
+ * 使用最新的 Stage 3 装饰器标准
+ *
+ * @example
+ * ```typescript
+ * @Route({ method: "GET", path: "/users" })
+ * async getUsers(ctx: Context) {
+ *   return ctx.json({ users: [] });
+ * }
+ *
+ * // 支持多个路径
+ * @Route({ path: ["/", "/home", "/dashboard"] })
+ * async homePage(ctx: Context) {
+ *   return <HomePage />;
+ * }
+ * ```
+ */
+declare function Route(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
+/**
+ * Page装饰器（Route的别名，用于向后兼容）
+ * 专门用于页面路由，默认使用 GET 方法
+ *
+ * @example
+ * ```typescript
+ * @Page({ path: ["/", "/home"] })
+ * async adminPage(ctx: Context) {
+ *   return HtmxLayout({ title: "Admin", children: <AdminLayout /> });
+ * }
+ * ```
+ */
+declare function Page(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
+
 /**
  * RoutePlugin - 核心路由插件
  * 负责解析type="route"的Handler元数据，注册HTTP路由到Hono实例
  *
  * @example
  * ```typescript
- * // 使用全局中间件（如鉴权）
+ * // 使用全局前缀和中间件
  * const authMiddleware = async (ctx, next) => {
  *   // 验证 token
  *   await next();
  * };
  *
  * const routePlugin = new RoutePlugin({
+ *   prefix: "/api", // 全局路径前缀，所有路由都会加上这个前缀
  *   globalMiddlewares: [authMiddleware],
  * });
  * ```
@@ -394,6 +463,7 @@ declare class RoutePlugin implements Plugin<RouteModuleOptions> {
     readonly name = "route-plugin";
     readonly priority = PluginPriority.ROUTE;
     private engine;
+    private globalPrefix;
     private globalMiddlewares;
     /**
      * 构造函数
@@ -414,51 +484,6 @@ declare class RoutePlugin implements Plugin<RouteModuleOptions> {
     onHandlerLoad(handlers: HandlerMetadata[]): void;
 }
 
-/**
- * Route装饰器（Handler的语法糖封装）
- * 固定type="route"，简化HTTP路由标注
- * 使用最新的 Stage 3 装饰器标准
- *
- * @example
- * ```typescript
- * @Route({ method: "GET", path: "/users" })
- * async getUsers(ctx: Context) {
- *   return ctx.json({ users: [] });
- * }
- *
- * // 支持多个路径
- * @Route({ path: ["/", "/home", "/dashboard"] })
- * async homePage(ctx: Context) {
- *   return <HomePage />;
- * }
- * ```
- */
-declare function Route(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
-/**
- * Page装饰器（Route的别名，用于向后兼容）
- * 专门用于页面路由，默认使用 GET 方法
- *
- * @example
- * ```typescript
- * @Page({ path: ["/", "/home"] })
- * async adminPage(ctx: Context) {
- *   return HtmxLayout({ title: "Admin", children: <AdminLayout /> });
- * }
- * ```
- */
-declare function Page(options: RouteOptions): (target: Function, context: ClassMethodDecoratorContext) => void;
-
-declare const BaseLayout: (props?: {
-    children?: any;
-    title?: string;
-    heads?: any;
-}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
-declare const HtmxLayout: (props?: {
-    children?: any;
-    title: string;
-    favicon?: any;
-}) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
-
 /**
  * Action装饰器配置选项
  */
@@ -1306,4 +1331,4 @@ declare const Testing: {
     readonly wait: typeof wait;
 };
 
-export { Action, type ActionInfo, type ActionModuleOptions, type ActionOptions, ActionPlugin, BaseLayout, Cache, type CacheAdapter, type CacheItem, type CacheModuleOptions, type CacheOptions, CachePlugin, type Campaign, type Class, type ClassDecoratorContext, type ClassMethodDecoratorContext$1 as ClassMethodDecoratorContext, ClientCodePlugin, type ClientCodePluginOptions, DEFAULT_TEST_OPTIONS, DuplicateModuleError, type Election, type Etcd3, Factory, GracefulShutdownPlugin, type GracefulShutdownPluginOptions, type HTTPMethod, Handler, type HandlerMetadata, type HandlerWrapper, HtmxLayout, MemoryCacheAdapter, Microservice, type MicroserviceOptions, MockEtcd3, ModuleConfigValidationError, type ModuleDecorator, type ModuleInfo, type ModuleMetadata, type Observer, Page, type Plugin, type PluginModuleOptionsSchema, PluginNameRequiredError, PluginPriority, type PreStartChecker, RedisCacheAdapter, type RedisCacheAdapterOptions, Route, type RouteModuleOptions, type RouteOptions, RoutePlugin, type RoutePluginOptions, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, SchedulePlugin, type SchedulePluginOptions, Scheduler, Testing, convertHandlersToModuleInfo, convertHandlersToModuleInfoWithMetadata, generateClientCode, getZodTypeString, startCheck };
+export { Action, type ActionInfo, type ActionModuleOptions, type ActionOptions, ActionPlugin, BaseLayout, Cache, type CacheAdapter, type CacheItem, type CacheModuleOptions, type CacheOptions, CachePlugin, type Campaign, type Class, type ClassDecoratorContext, type ClassMethodDecoratorContext$1 as ClassMethodDecoratorContext, ClientCodePlugin, type ClientCodePluginOptions, DEFAULT_TEST_OPTIONS, DuplicateModuleError, type Election, type Etcd3, Factory, GracefulShutdownPlugin, type GracefulShutdownPluginOptions, type HTTPMethod, Handler, type HandlerMetadata, type HandlerWrapper, HtmxLayout, MemoryCacheAdapter, Microservice, type MicroserviceOptions, MockEtcd3, ModuleConfigValidationError, type ModuleDecorator, type ModuleInfo, type ModuleMetadata, type Observer, Page, type Plugin, type PluginModuleOptionsSchema, PluginNameRequiredError, PluginPriority, type PreStartChecker, RedisCacheAdapter, type RedisCacheAdapterOptions, Route, type RouteModuleOptions, type RouteOptions, RoutePlugin, type RoutePluginOptions, Schedule, type ScheduleMetadata, ScheduleMode, type ScheduleOptions, SchedulePlugin, type SchedulePluginOptions, Scheduler, ServiceInfoCards, type ServiceStatusInfo, ServiceStatusPage, Testing, convertHandlersToModuleInfo, convertHandlersToModuleInfoWithMetadata, generateClientCode, getZodTypeString, startCheck };