starlight-server 1.0.0 → 1.0.2

package/dist/demo/index.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import { getFileDir } from '@anjianshi/utils/env-node/index.js';
-import { getLogger, startHTTPServer, DefaultRouter } from '../index.js';
+import { getLogger, startHTTPServer, Router, } from '../index.js';
 import { registerSwaggerRoute } from '../swagger/index.js';
 const logger = getLogger({
     level: 'debug',
@@ -9,7 +9,16 @@ const logger = getLogger({
         dir: path.resolve(getFileDir(import.meta), '../../logs'),
     },
 });
-const router = new DefaultRouter();
+class DemoRouter extends Router {
+    async executeWithContext(baseContext, route, pathParameters) {
+        const context = {
+            ...baseContext,
+            now: () => Date.now(),
+        };
+        await route.handler(context, pathParameters);
+    }
+}
+const router = new DemoRouter();
 router.registerResponseReference('hello', { object: [{ name: 'hello', type: 'string' }] });
 router.register({
     category: 'demo',

package/dist/router/router.d.ts

@@ -29,6 +29,7 @@ export type RouteHandler<Ctx extends BaseContext = BaseContext, PathP extends Pa
  * - method 一定为全大写
  */
 export type Route<Ctx extends BaseContext = BaseContext, PathP extends PathParameters = PathParameters> = RequiredFields<RawRoute<Ctx, PathP>, 'description' | 'category' | 'method'>;
+export type RouteDefinition = Omit<Route, 'handler'>;
 export interface RawRoute<Ctx extends BaseContext = BaseContext, PathP extends PathParameters = PathParameters> {
     /** 接口路径。支持变量（/abc/:xxx/def），详见 src/router/match.ts */
     path: string;

package/dist/swagger/factory.d.ts

@@ -1,7 +1,7 @@
 /**
  * 把路由定义转换成 swagger API 定义的工具函数
  */
-import type { Route, ResponseDataType, BasicParameter } from '../router/index.js';
+import type { RouteDefinition, ResponseDataType, BasicParameter } from '../router/index.js';
 import type { Schema, Reference, PathItem } from './openapi-spec.js';
 type AnyObject = {
     [k: string]: unknown;
@@ -54,11 +54,11 @@ export declare function jsonMedia(schema: string | Schema): {
 /**
  * 把一系列路由转换成 swagger API 定义
  */
-export declare function paths(routes: Route[]): Record<string, PathItem>;
+export declare function paths(routes: RouteDefinition[]): Record<string, PathItem>;
 /**
  * 单个路由定义
  */
-export declare function operation(route: Route): {
+export declare function operation(route: RouteDefinition): {
     tags: string[];
     summary: string;
     operationId: string;
@@ -83,11 +83,11 @@ export declare function operation(route: Route): {
 /**
  * 生成路由的唯一 ID
  */
-export declare function operationId(route: Route): string;
+export declare function operationId(route: RouteDefinition): string;
 /**
  * 路由请求参数转为 swagger 定义
  */
-export declare function requestBody(route: Route): {
+export declare function requestBody(route: RouteDefinition): {
     content: {
         'application/json': {
             schema: Schema | Reference;

package/dist/swagger/index.d.ts

@@ -1,6 +1,6 @@
-import type { Router } from '../router/index.js';
+import type { Router, BaseContext } from '../router/index.js';
 import type { OpenAPI } from './openapi-spec.js';
-export declare function registerSwaggerRoute(router: Router, endpoint?: string, customFields?: OpenAPICustomFields, swaggerOptions?: Record<string, unknown>): void;
+export declare function registerSwaggerRoute<Ctx extends BaseContext>(router: Router<Ctx>, endpoint?: string, customFields?: OpenAPICustomFields, swaggerOptions?: Record<string, unknown>): void;
 /**
  * swagger API 路由
  */

package/dist/swagger/index.js

@@ -15,7 +15,7 @@ export function registerSwaggerRoute(router, endpoint = '/swagger', customFields
         category: 'swagger',
         method: 'GET',
         path: normalizePath(endpoint) + '/api-swagger.json',
-        handler: apiRoute.bind(null, router, customFields),
+        handler: (context) => apiRoute(router, customFields, context),
     });
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-server",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Simple But Powerful Node.js HTTP Server",
   "type": "module",
   "scripts": {

package/src/demo/index.ts

@@ -1,6 +1,13 @@
 import path from 'node:path'
 import { getFileDir } from '@anjianshi/utils/env-node/index.js'
-import { getLogger, startHTTPServer, DefaultRouter } from '@/index.js'
+import {
+  getLogger,
+  startHTTPServer,
+  type BaseContext,
+  type Route,
+  type PathParameters,
+  Router,
+} from '@/index.js'
 import { registerSwaggerRoute } from '@/swagger/index.js'
 
 const logger = getLogger({
@@ -11,7 +18,23 @@ const logger = getLogger({
   },
 })
 
-const router = new DefaultRouter()
+type DemoContext = BaseContext & {
+  now: () => number
+}
+class DemoRouter extends Router<DemoContext> {
+  async executeWithContext(
+    baseContext: BaseContext,
+    route: Route<DemoContext>,
+    pathParameters: PathParameters,
+  ) {
+    const context: DemoContext = {
+      ...baseContext,
+      now: () => Date.now(),
+    }
+    await route.handler(context, pathParameters)
+  }
+}
+const router = new DemoRouter()
 
 router.registerResponseReference('hello', { object: [{ name: 'hello', type: 'string' }] })
 

package/src/router/router.ts

@@ -39,6 +39,7 @@ export type Route<
   Ctx extends BaseContext = BaseContext,
   PathP extends PathParameters = PathParameters,
 > = RequiredFields<RawRoute<Ctx, PathP>, 'description' | 'category' | 'method'>
+export type RouteDefinition = Omit<Route, 'handler'> // 仅含定义，不含实现
 
 export interface RawRoute<
   Ctx extends BaseContext = BaseContext,

package/src/swagger/factory.ts

@@ -1,7 +1,7 @@
 /**
  * 把路由定义转换成 swagger API 定义的工具函数
  */
-import type { Route, ResponseDataType, BasicParameter } from '@/router/index.js'
+import type { RouteDefinition, ResponseDataType, BasicParameter } from '@/router/index.js'
 import type { Schema, Reference, PathItem } from './openapi-spec.js'
 
 type AnyObject = { [k: string]: unknown }
@@ -111,7 +111,7 @@ export function jsonMedia(schema: string | Schema) {
 /**
  * 把一系列路由转换成 swagger API 定义
  */
-export function paths(routes: Route[]) {
+export function paths(routes: RouteDefinition[]) {
   const paths: Record<string, PathItem> = {}
 
   for (const route of routes) {
@@ -129,7 +129,7 @@ export function paths(routes: Route[]) {
 /**
  * 单个路由定义
  */
-export function operation(route: Route) {
+export function operation(route: RouteDefinition) {
   return {
     tags: route.category ? [route.category] : [],
     summary: route.description,
@@ -147,14 +147,14 @@ export function operation(route: Route) {
 /**
  * 生成路由的唯一 ID
  */
-export function operationId(route: Route) {
+export function operationId(route: RouteDefinition) {
   return `${route.method}-${route.path}`
 }
 
 /**
  * 路由请求参数转为 swagger 定义
  */
-export function requestBody(route: Route) {
+export function requestBody(route: RouteDefinition) {
   if (!route.body) return
   return jsonMedia({
     type: 'object',

package/src/swagger/index.ts

@@ -7,8 +7,8 @@ import { normalizePath } from '@/router/match.js'
 import * as factory from './factory.js'
 import type { OpenAPI } from './openapi-spec.js'
 
-export function registerSwaggerRoute(
-  router: Router,
+export function registerSwaggerRoute<Ctx extends BaseContext>(
+  router: Router<Ctx>,
   endpoint: string = '/swagger',
   customFields: OpenAPICustomFields = { info: { title: 'API Document', version: '0.0.1' } },
   swaggerOptions?: Record<string, unknown>,
@@ -23,7 +23,7 @@ export function registerSwaggerRoute(
     category: 'swagger',
     method: 'GET',
     path: normalizePath(endpoint) + '/api-swagger.json',
-    handler: apiRoute.bind(null, router, customFields),
+    handler: (context: Ctx) => apiRoute(router, customFields, context),
   })
 }
 
@@ -76,7 +76,11 @@ function replacement(abspath: string, content: Buffer, swaggerOptions?: Record<s
  */
 type OpenAPICustomFields = Omit<OpenAPI, 'openapi' | 'paths' | 'components'>
 
-function apiRoute(router: Router, customFields: OpenAPICustomFields, { response }: BaseContext) {
+function apiRoute<Ctx extends BaseContext>(
+  router: Router<Ctx>,
+  customFields: OpenAPICustomFields,
+  { response }: BaseContext,
+) {
   const swaggerJSON: OpenAPI = {
     ...customFields,
     openapi: '3.1.0',