starlight-server 1.6.7 → 1.7.1

package/dist/http/body/form-data.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 /**
  * 解析后的 FormData（格式参考浏览器环境中的 FormData 对象）
  * Parsed FormData (formatted like the FormData object in a browser environment)

package/dist/http/body/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { type NodeRequest } from '../types.js';
 export interface BodyOptions {
     /**

package/dist/http/body/receive.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { type NodeRequest } from '../types.js';
 export declare function receiveBody(nodeRequest: NodeRequest, 
 /**

package/dist/http/request.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import type http from 'node:http';
 import { type Logger } from '../logging.js';
 import { RequestBody, type BodyOptions } from './body/index.js';

package/dist/http/response.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import { type Logger } from '../logging.js';
 import { type NodeResponse } from './types.js';
 /**

package/dist/http/types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 /**
  * 重新定义 HTTP 请求相关类型
  * Redefine HTTP request-related types.

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export * from './logging.js';
 export * from './http/index.js';
 export * from './router/index.js';
 export * from './swagger/index.js';
-export { validators } from '@anjianshi/utils/validators/index.js';
+export * from './utils.js';

package/dist/index.js

@@ -2,4 +2,4 @@ export * from './logging.js';
 export * from './http/index.js';
 export * from './router/index.js';
 export * from './swagger/index.js';
-export { validators } from '@anjianshi/utils/validators/index.js';
+export * from './utils.js';

package/dist/router/helpers.d.ts

@@ -1,11 +1,63 @@
-import { type Validator } from '@anjianshi/utils/validators/index.js';
+import { type Definition as ValidatorDefinition } from '@anjianshi/utils/validators/index.js';
 import { type BasicContext } from './index.js';
+import { ResponseUtils } from '../http/response.js';
 export declare class Helpers {
     readonly context: BasicContext;
     constructor(context: BasicContext);
-    validatePathParameters<T>(struct: Record<string, Validator>): T;
-    validateQuery<T>(struct: Record<string, Validator>): T;
-    validateBody<T>(struct: Record<string, Validator>): Promise<T>;
+    validatePathParameters<Definition extends Record<string, ValidatorDefinition>>(struct: Definition): import("@anjianshi/utils/validators/base.js").Validated<{
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T ? T extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? { [Key in keyof T["struct"]]: import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["struct"][Key]>, T["struct"][Key]>; } : T extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Record<string, import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["record"]>, T["record"]>> : never : never : never, {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T_1 ? T_1 extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T_1 extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? Omit<T_1, "struct"> & {
+        struct: { [Key_1 in keyof T_1["struct"]]: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["struct"][Key_1]>; };
+    } : T_1 extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Omit<T_1, "record"> & {
+        record: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["record"]>;
+    } : T_1 : never : never>;
+    validateQuery<Definition extends Record<string, ValidatorDefinition>>(struct: Definition): import("@anjianshi/utils/validators/base.js").Validated<{
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T ? T extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? { [Key in keyof T["struct"]]: import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["struct"][Key]>, T["struct"][Key]>; } : T extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Record<string, import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["record"]>, T["record"]>> : never : never : never, {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T_1 ? T_1 extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T_1 extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? Omit<T_1, "struct"> & {
+        struct: { [Key_1 in keyof T_1["struct"]]: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["struct"][Key_1]>; };
+    } : T_1 extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Omit<T_1, "record"> & {
+        record: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["record"]>;
+    } : T_1 : never : never>;
+    validateBody<Definition extends Record<string, ValidatorDefinition>>(struct: Definition): Promise<import("@anjianshi/utils/validators/base.js").Validated<{
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T ? T extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? { [Key in keyof T["struct"]]: import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["struct"][Key]>, T["struct"][Key]>; } : T extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Record<string, import("@anjianshi/utils/validators/base.js").Validated<import("@anjianshi/utils/validators/factory.js").ValueOfDefinition<T["record"]>, T["record"]>> : never : never : never, {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } extends infer T_1 ? T_1 extends {
+        readonly type: "struct";
+        readonly struct: Definition;
+    } ? T_1 extends import("@anjianshi/utils/validators/factory.js").StructDefinition ? Omit<T_1, "struct"> & {
+        struct: { [Key_1 in keyof T_1["struct"]]: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["struct"][Key_1]>; };
+    } : T_1 extends import("@anjianshi/utils/validators/factory.js").RecordDefinition ? Omit<T_1, "record"> & {
+        record: import("@anjianshi/utils/validators/factory.js").ValidatorForDefinition<T_1["record"]>;
+    } : T_1 : never : never>>;
+}
+export declare class ResponseUtilsWithHelpers extends ResponseUtils {
+    constructor(response: ResponseUtils);
     success(data?: unknown): void;
     failed(message: string, code?: string | number): void;
     failed<T>(message: string, code: string | number | undefined, data: T): void;

package/dist/router/helpers.js

@@ -1,19 +1,20 @@
 import { success, failed } from '@anjianshi/utils';
-import { validators } from '@anjianshi/utils/validators/index.js';
+import { getValidator, } from '@anjianshi/utils/validators/index.js';
 import { HTTPError } from '../index.js';
+import { ResponseUtils } from '../http/response.js';
 export class Helpers {
     context;
     constructor(context) {
         this.context = context;
     }
     validatePathParameters(struct) {
-        const result = validators.struct(struct).validate('path', this.context.pathParameters);
+        const result = getValidator({ type: 'struct', struct })('path', this.context.pathParameters);
         if (result.success)
             return result.data;
         throw new HTTPError(400, result.message);
     }
     validateQuery(struct) {
-        const result = validators.struct(struct).validate('query', this.context.request.query);
+        const result = getValidator({ type: 'struct', struct })('query', this.context.request.query);
         if (result.success)
             return result.data;
         throw new HTTPError(400, result.message);
@@ -22,15 +23,20 @@ export class Helpers {
         const body = await this.context.request.body.json();
         if (typeof body !== 'object' || body === null || Array.isArray(body))
             throw new HTTPError(400, 'Invalid JSON body, should be an object.');
-        const result = validators.struct(struct).validate('body', body);
+        const result = getValidator({ type: 'struct', struct })('body', body);
         if (result.success)
             return result.data;
         throw new HTTPError(400, result.message);
     }
+}
+export class ResponseUtilsWithHelpers extends ResponseUtils {
+    constructor(response) {
+        super(response.nodeResponse, response.logger, response.jsonReplacer);
+    }
     success(data) {
-        this.context.response.json(success(data));
+        this.json(success(data));
     }
     failed(message, code, data) {
-        this.context.response.json(failed(message, code, data));
+        this.json(failed(message, code, data));
     }
 }

package/dist/router/index.d.ts

@@ -1,20 +1,17 @@
-import { validators } from '@anjianshi/utils/validators/index.js';
+import { type OptionalFields } from '@anjianshi/utils';
 import { type CORSRule } from '../http/cors.js';
 import { type Request, type ResponseUtils } from '../http/index.js';
 import { Swagger, type Method } from '../swagger/index.js';
-import { Helpers } from './helpers.js';
+import { Helpers, ResponseUtilsWithHelpers } from './helpers.js';
 import { type PathParameters } from './match-path.js';
 type HelpersInst = InstanceType<typeof Helpers>;
 export interface BasicContext {
     request: Request;
-    response: ResponseUtils;
+    response: ResponseUtilsWithHelpers;
     pathParameters: PathParameters;
     validatePathParameters: HelpersInst['validatePathParameters'];
     validateQuery: HelpersInst['validateQuery'];
     validateBody: HelpersInst['validateBody'];
-    validators: typeof validators;
-    success: HelpersInst['success'];
-    failed: HelpersInst['failed'];
 }
 /** 使用者可自行补充 Context 定义  */
 export interface Context extends BasicContext {
@@ -35,7 +32,7 @@ export declare class Router {
      * ----------------------
      */
     readonly routes: Route[];
-    register(route: Route): void;
+    register(inputRoute: OptionalFields<Route, 'method'>): void;
     /**
      * ----------------------
      * 全局 CORS 配置
@@ -68,6 +65,6 @@ export declare class Router {
      * 请求处理
      * ----------------------
      */
-    readonly handle: (request: Request, response: ResponseUtils) => Promise<void>;
+    readonly handle: (request: Request, originResponse: ResponseUtils) => Promise<void>;
 }
 export {};

package/dist/router/index.js

@@ -1,9 +1,8 @@
 import { joinPath } from '@anjianshi/utils';
-import { validators } from '@anjianshi/utils/validators/index.js';
 import { getPreflightRequestMethod, handleCORS } from '../http/cors.js';
 import { HTTPError } from '../http/index.js';
 import { Swagger } from '../swagger/index.js';
-import { Helpers } from './helpers.js';
+import { Helpers, ResponseUtilsWithHelpers } from './helpers.js';
 import { matchPath } from './match-path.js';
 export class Router {
     /**
@@ -12,7 +11,8 @@ export class Router {
      * ----------------------
      */
     routes = [];
-    register(route) {
+    register(inputRoute) {
+        const route = { ...inputRoute, method: inputRoute.method ?? 'GET' };
         this.routes.push(route);
         this.registerRouteToSwagger(route);
     }
@@ -78,7 +78,8 @@ export class Router {
      * 请求处理
      * ----------------------
      */
-    handle = async (request, response) => {
+    handle = async (request, originResponse) => {
+        const response = new ResponseUtilsWithHelpers(originResponse);
         const pathMatchedRoutes = matchPath(this.routes.map(route => route.path), request.path).map(result => ({ route: this.routes[result.index], parameters: result.parameters }));
         if (!pathMatchedRoutes.length)
             throw new HTTPError(404); // 没有路径匹配的路由
@@ -108,10 +109,9 @@ export class Router {
             validatePathParameters: helpers.validatePathParameters.bind(helpers),
             validateQuery: helpers.validateQuery.bind(helpers),
             validateBody: helpers.validateBody.bind(helpers),
-            validators,
-            success: helpers.success.bind(helpers),
-            failed: helpers.failed.bind(helpers),
         });
-        await this.executor(basicContext, matched.route);
+        const result = await this.executor(basicContext, matched.route);
+        if (result !== undefined)
+            throw new Error('route handler 不应该有返回值');
     };
 }

package/dist/router/match-path.d.ts

@@ -3,10 +3,10 @@ export interface MatchResult {
     pattern: string;
     parameters: PathParameters;
 }
-export type PathParameters = {
+export interface PathParameters {
     [name: string]: string | undefined;
     '*'?: string;
-};
+}
 /**
  * 返回与路径匹配的 pattern 及匹配得到的参数值
  */

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 把 @anjianshi/utils 包中 App 用得到的内导出来，这样用到时就不用分别引用 starlight-server 和 @anjianshi/utils 了
+ */
+export { getValidator, type Definition as ValidatorDefinition } from '@anjianshi/utils/validators/index.js';
+export * from '@anjianshi/utils/lang/may-success.js';

package/dist/utils.js

@@ -0,0 +1,5 @@
+/**
+ * 把 @anjianshi/utils 包中 App 用得到的内导出来，这样用到时就不用分别引用 starlight-server 和 @anjianshi/utils 了
+ */
+export { getValidator } from '@anjianshi/utils/validators/index.js';
+export * from '@anjianshi/utils/lang/may-success.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-server",
-  "version": "1.6.7",
+  "version": "1.7.1",
   "description": "Simple But Powerful Node.js HTTP Server",
   "type": "module",
   "keywords": [
@@ -26,7 +26,7 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@anjianshi/utils": "^2.1.1",
+    "@anjianshi/utils": "^2.2.2",
     "chalk": "^5.3.0",
     "dayjs": "^1.11.10",
     "debug": "^4.3.4",
@@ -34,10 +34,9 @@
     "swagger-ui-dist": "^5.15.1"
   },
   "devDependencies": {
-    "@anjianshi/presets-eslint-node": "^4.0.3",
-    "@anjianshi/presets-eslint-typescript": "^4.0.3",
-    "@anjianshi/presets-prettier": "^3.0.0",
-    "@anjianshi/presets-typescript": "^3.1.3",
+    "@anjianshi/presets-eslint-node": "^4.0.6",
+    "@anjianshi/presets-prettier": "^3.0.1",
+    "@anjianshi/presets-typescript": "^3.2.0",
     "@types/debug": "^4.1.9",
     "@types/lodash": "^4.14.199",
     "@types/node": "^20.8.6",
@@ -46,7 +45,7 @@
     "nodemon": "^3.0.2",
     "rimraf": "^5.0.5",
     "tsc-alias": "^1.8.8",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.4"
   },
   "eslintIgnore": [],
   "prettier": "@anjianshi/presets-prettier/prettierrc",

package/src/index.ts

@@ -2,4 +2,4 @@ export * from '@/logging.js'
 export * from '@/http/index.js'
 export * from '@/router/index.js'
 export * from '@/swagger/index.js'
-export { validators } from '@anjianshi/utils/validators/index.js'
+export * from '@/utils.js'

package/src/router/helpers.ts

@@ -1,40 +1,55 @@
 import { success, failed } from '@anjianshi/utils'
-import { type Validator, validators } from '@anjianshi/utils/validators/index.js'
+import {
+  getValidator,
+  type Definition as ValidatorDefinition,
+} from '@anjianshi/utils/validators/index.js'
 import { HTTPError } from '@/index.js'
 import { type BasicContext } from './index.js'
+import { ResponseUtils } from '@/http/response.js'
 
 export class Helpers {
   constructor(readonly context: BasicContext) {}
 
-  validatePathParameters<T>(struct: Record<string, Validator>) {
-    const result = validators.struct(struct).validate('path', this.context.pathParameters)
-    if (result.success) return result.data as T
+  validatePathParameters<Definition extends Record<string, ValidatorDefinition>>(
+    struct: Definition,
+  ) {
+    const result = getValidator({ type: 'struct', struct })(
+      'path',
+      this.context.pathParameters as Record<string, string>,
+    )
+    if (result.success) return result.data
     throw new HTTPError(400, result.message)
   }
 
-  validateQuery<T>(struct: Record<string, Validator>) {
-    const result = validators.struct(struct).validate('query', this.context.request.query)
-    if (result.success) return result.data as T
+  validateQuery<Definition extends Record<string, ValidatorDefinition>>(struct: Definition) {
+    const result = getValidator({ type: 'struct', struct })('query', this.context.request.query)
+    if (result.success) return result.data
     throw new HTTPError(400, result.message)
   }
 
-  async validateBody<T>(struct: Record<string, Validator>) {
+  async validateBody<Definition extends Record<string, ValidatorDefinition>>(struct: Definition) {
     const body = await this.context.request.body.json()
     if (typeof body !== 'object' || body === null || Array.isArray(body))
       throw new HTTPError(400, 'Invalid JSON body, should be an object.')
 
-    const result = validators.struct(struct).validate('body', body)
-    if (result.success) return result.data as T
+    const result = getValidator({ type: 'struct', struct })('body', body as Record<string, string>)
+    if (result.success) return result.data
     throw new HTTPError(400, result.message)
   }
+}
+
+export class ResponseUtilsWithHelpers extends ResponseUtils {
+  constructor(response: ResponseUtils) {
+    super(response.nodeResponse, response.logger, response.jsonReplacer)
+  }
 
   success(data?: unknown) {
-    this.context.response.json(success(data))
+    this.json(success(data))
   }
 
   failed(message: string, code?: string | number): void
   failed<T>(message: string, code: string | number | undefined, data: T): void
   failed<T>(message: string, code?: string | number, data?: T) {
-    this.context.response.json(failed(message, code, data))
+    this.json(failed(message, code, data))
   }
 }

package/src/router/index.ts

@@ -1,26 +1,22 @@
-import { joinPath } from '@anjianshi/utils'
-import { validators } from '@anjianshi/utils/validators/index.js'
+import { type OptionalFields, joinPath } from '@anjianshi/utils'
 import { getPreflightRequestMethod, handleCORS, type CORSRule } from '@/http/cors.js'
 import { HTTPError, type Request, type ResponseUtils } from '@/http/index.js'
 import { Swagger, type Method } from '@/swagger/index.js'
-import { Helpers } from './helpers.js'
+import { Helpers, ResponseUtilsWithHelpers } from './helpers.js'
 import { matchPath, type PathParameters } from './match-path.js'
 
 type HelpersInst = InstanceType<typeof Helpers>
 export interface BasicContext {
   request: Request
-  response: ResponseUtils
+  response: ResponseUtilsWithHelpers
   pathParameters: PathParameters
   validatePathParameters: HelpersInst['validatePathParameters']
   validateQuery: HelpersInst['validateQuery']
   validateBody: HelpersInst['validateBody']
-  validators: typeof validators
-  success: HelpersInst['success']
-  failed: HelpersInst['failed']
 }
 
 /** 使用者可自行补充 Context 定义  */
-export interface Context extends BasicContext {}
+export interface Context extends BasicContext {} // eslint-disable-line @typescript-eslint/no-empty-object-type
 
 export interface Route {
   method: Method
@@ -40,7 +36,8 @@ export class Router {
    */
   readonly routes: Route[] = []
 
-  register(route: Route) {
+  register(inputRoute: OptionalFields<Route, 'method'>) {
+    const route = { ...inputRoute, method: inputRoute.method ?? 'GET' }
     this.routes.push(route)
     this.registerRouteToSwagger(route)
   }
@@ -110,7 +107,9 @@ export class Router {
    * 请求处理
    * ----------------------
    */
-  readonly handle = async (request: Request, response: ResponseUtils) => {
+  readonly handle = async (request: Request, originResponse: ResponseUtils) => {
+    const response = new ResponseUtilsWithHelpers(originResponse)
+
     const pathMatchedRoutes = matchPath(
       this.routes.map(route => route.path),
       request.path,
@@ -145,10 +144,9 @@ export class Router {
       validatePathParameters: helpers.validatePathParameters.bind(helpers),
       validateQuery: helpers.validateQuery.bind(helpers),
       validateBody: helpers.validateBody.bind(helpers),
-      validators,
-      success: helpers.success.bind(helpers),
-      failed: helpers.failed.bind(helpers),
     })
-    await this.executor(basicContext, matched.route)
+
+    const result = await (this.executor(basicContext, matched.route) as Promise<unknown>)
+    if (result !== undefined) throw new Error('route handler 不应该有返回值')
   }
 }

package/src/router/match-path.ts

@@ -35,7 +35,7 @@ export interface MatchResult {
 }
 
 // 匹配得到的参数值
-export type PathParameters = {
+export interface PathParameters {
   [name: string]: string | undefined
   '*'?: string
 }

package/src/utils.ts

@@ -0,0 +1,5 @@
+/**
+ * 把 @anjianshi/utils 包中 App 用得到的内导出来，这样用到时就不用分别引用 starlight-server 和 @anjianshi/utils 了
+ */
+export { getValidator, type Definition as ValidatorDefinition } from '@anjianshi/utils/validators/index.js'
+export * from '@anjianshi/utils/lang/may-success.js'