starlight-server 1.1.0 → 1.3.0

package/dist/demo/index.js

@@ -25,6 +25,10 @@ router.register({
     description: 'hello world',
     method: 'GET',
     path: '/hello',
+    query: [
+        { name: 'q1', type: 'number', required: true },
+        { name: 'q2', type: 'string', description: '这是q2' },
+    ],
     body: [
         { name: 'abc', type: 'number' },
         { name: 'def', type: { array: { type: 'string' } } },

package/dist/router/cors.d.ts

@@ -15,7 +15,7 @@ export type CORSOptions = boolean | {
     exposeHeaders?: string;
 };
 /**
- * 若当前请求是 CORS Preflight 请求，返回实际请求的 method，否则返回 null
+ * 若当前请求是 CORS Preflight 请求，返回实际请求的 method；若不是 Preflight 请求，返回 null
  */
 export declare function getMethodFromCORSPreflight(request: Request): string | null;
 /**

package/dist/router/cors.js

@@ -1,5 +1,5 @@
 /**
- * 若当前请求是 CORS Preflight 请求，返回实际请求的 method，否则返回 null
+ * 若当前请求是 CORS Preflight 请求，返回实际请求的 method；若不是 Preflight 请求，返回 null
  */
 export function getMethodFromCORSPreflight(request) {
     if (request.method === 'OPTIONS' &&

package/dist/router/match.d.ts

@@ -1,9 +1,9 @@
 /**
  * 标准化路径
- * 标准化后，相同的两个路径一定也是相同的字符串（例如 /Abc/Def 和 abc/def/ 都会变成 abc/def）。
+ * 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
  *
- * - 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
- * - 统一改为小写
+ * 注意：此操作不会统一大小写，因此不保证标准化后两个字符串在代码层面 ===
  */
 export declare function normalizePath(path: string): string;
 /**

package/dist/router/match.js

@@ -12,10 +12,10 @@
 import escapeRegExp from 'lodash/escapeRegExp.js';
 /**
  * 标准化路径
- * 标准化后，相同的两个路径一定也是相同的字符串（例如 /Abc/Def 和 abc/def/ 都会变成 abc/def）。
+ * 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
  *
- * - 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
- * - 统一改为小写
+ * 注意：此操作不会统一大小写，因此不保证标准化后两个字符串在代码层面 ===
  */
 export function normalizePath(path) {
     if (path.startsWith('/'))
@@ -23,7 +23,7 @@ export function normalizePath(path) {
     if (path.endsWith('/'))
         path = path.slice(0, -1);
     path = path.replace(/\/+/g, '/');
-    return path.toLowerCase();
+    return path;
 }
 /**
  * 解析路由路径定义

package/dist/router/router.d.ts

@@ -105,12 +105,12 @@ export declare abstract class Router<Ctx extends BaseContext = BaseContext> {
     /**
      * 为未指定 CORS 配置的 route 提供默认配置
      */
-    getCORSOptions(request: Request, routeMatch: RouteMatch<Route<Ctx>>): boolean;
+    getCORSOptions(request: Request, routeMatch: RouteMatch<Route<Ctx>>): CORSOptions;
     /**
      * 完善 context 对象并执行 route
      * 注意：handler 在很多时候都是异步的，要用 await 等待执行完成
      */
-    protected abstract executeWithContext(baseContext: BaseContext, route: Route<Ctx>, pathParameters: PathParameters): void | Promise<void>;
+    protected abstract executeWithContext(baseContext: BaseContext, route: Route<Ctx>, pathParameters: PathParameters): unknown;
     /**
      * response 定义中可引用的数据类型
      */

package/dist/swagger/factory.d.ts

@@ -62,6 +62,13 @@ export declare function operation(route: RouteDefinition): {
     tags: string[];
     summary: string;
     operationId: string;
+    parameters: {
+        name: string;
+        in: "query";
+        description: string | undefined;
+        required: boolean | undefined;
+        schema: Schema;
+    }[] | undefined;
     requestBody: {
         content: {
             'application/json': {
@@ -85,7 +92,17 @@ export declare function operation(route: RouteDefinition): {
  */
 export declare function operationId(route: RouteDefinition): string;
 /**
- * 路由请求参数转为 swagger 定义
+ * 路由 query 参数转为 swagger 定义
+ */
+export declare function queryParameters(route: RouteDefinition): {
+    name: string;
+    in: "query";
+    description: string | undefined;
+    required: boolean | undefined;
+    schema: Schema;
+}[] | undefined;
+/**
+ * 路由 body 参数转为 swagger 定义
  */
 export declare function requestBody(route: RouteDefinition): {
     content: {

package/dist/swagger/factory.js

@@ -113,6 +113,7 @@ export function operation(route) {
         tags: route.category ? [route.category] : [],
         summary: route.description,
         operationId: operationId(route),
+        parameters: queryParameters(route),
         requestBody: requestBody(route),
         responses: {
             default: {
@@ -129,7 +130,21 @@ export function operationId(route) {
     return `${route.method}-${route.path}`;
 }
 /**
- * 路由请求参数转为 swagger 定义
+ * 路由 query 参数转为 swagger 定义
+ */
+export function queryParameters(route) {
+    if (!route.query)
+        return;
+    return route.query.map(parameter => ({
+        name: parameter.name,
+        in: 'query',
+        description: parameter.description,
+        required: parameter.required,
+        schema: parameterSchema(parameter),
+    }));
+}
+/**
+ * 路由 body 参数转为 swagger 定义
  */
 export function requestBody(route) {
     if (!route.body)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "starlight-server",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Simple But Powerful Node.js HTTP Server",
   "type": "module",
   "scripts": {
-    "dev": "npm run build && (concurrently \"tsc -w\" \"tsc-alias -w\" \"nodemon dist/demo/index.js\")",
+    "dev": "rimraf dist && (concurrently --raw \"tsc -w\" \"sleep 5 && tsc-alias -w\" \"sleep 6 && nodemon dist/demo/index.js\")",
     "build": "rimraf dist && tsc && tsc-alias",
     "prepublishOnly": "npm run build"
   },

package/src/demo/index.ts

@@ -43,6 +43,10 @@ router.register({
   description: 'hello world',
   method: 'GET',
   path: '/hello',
+  query: [
+    { name: 'q1', type: 'number', required: true },
+    { name: 'q2', type: 'string', description: '这是q2' },
+  ],
   body: [
     { name: 'abc', type: 'number' },
     { name: 'def', type: { array: { type: 'string' } } },

package/src/router/cors.ts

@@ -15,7 +15,7 @@ export type CORSOptions =
   | { allowOrigin?: string; allowHeaders?: string; exposeHeaders?: string }
 
 /**
- * 若当前请求是 CORS Preflight 请求，返回实际请求的 method，否则返回 null
+ * 若当前请求是 CORS Preflight 请求，返回实际请求的 method；若不是 Preflight 请求，返回 null
  */
 export function getMethodFromCORSPreflight(request: Request) {
   if (

package/src/router/match.ts

@@ -13,16 +13,16 @@ import escapeRegExp from 'lodash/escapeRegExp.js'
 
 /**
  * 标准化路径
- * 标准化后，相同的两个路径一定也是相同的字符串（例如 /Abc/Def 和 abc/def/ 都会变成 abc/def）。
+ * 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
+ * 例如 /abc/def 和 abc/def/ 都会变成 abc/def
  *
- * - 移除首尾和重复的 '/'，完成后有 path 有这几种可能的格式： ''、'abc'、'abc/def'
- * - 统一改为小写
+ * 注意：此操作不会统一大小写，因此不保证标准化后两个字符串在代码层面 ===
  */
 export function normalizePath(path: string) {
   if (path.startsWith('/')) path = path.slice(1)
   if (path.endsWith('/')) path = path.slice(0, -1)
   path = path.replace(/\/+/g, '/')
-  return path.toLowerCase()
+  return path
 }
 
 /**

package/src/router/router.ts

@@ -179,7 +179,7 @@ export abstract class Router<Ctx extends BaseContext = BaseContext> {
    * 为未指定 CORS 配置的 route 提供默认配置
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  getCORSOptions(request: Request, routeMatch: RouteMatch<Route<Ctx>>) {
+  getCORSOptions(request: Request, routeMatch: RouteMatch<Route<Ctx>>): CORSOptions {
     return false
   }
 
@@ -191,7 +191,7 @@ export abstract class Router<Ctx extends BaseContext = BaseContext> {
     baseContext: BaseContext,
     route: Route<Ctx>,
     pathParameters: PathParameters,
-  ): void | Promise<void>
+  ): unknown
 
   /**
    * response 定义中可引用的数据类型

package/src/swagger/factory.ts

@@ -134,6 +134,7 @@ export function operation(route: RouteDefinition) {
     tags: route.category ? [route.category] : [],
     summary: route.description,
     operationId: operationId(route),
+    parameters: queryParameters(route),
     requestBody: requestBody(route),
     responses: {
       default: {
@@ -152,7 +153,21 @@ export function operationId(route: RouteDefinition) {
 }
 
 /**
- * 路由请求参数转为 swagger 定义
+ * 路由 query 参数转为 swagger 定义
+ */
+export function queryParameters(route: RouteDefinition) {
+  if (!route.query) return
+  return route.query.map(parameter => ({
+    name: parameter.name,
+    in: 'query' as const,
+    description: parameter.description,
+    required: parameter.required,
+    schema: parameterSchema(parameter),
+  }))
+}
+
+/**
+ * 路由 body 参数转为 swagger 定义
  */
 export function requestBody(route: RouteDefinition) {
   if (!route.body) return