starlight-server 1.5.0 → 1.6.2

package/dist/router/index.d.ts

@@ -1,15 +1,18 @@
+import { type validators } from '@anjianshi/utils/validators/index.js';
 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 * as helpers from './helpers.js';
 import { type PathParameters } from './match-path.js';
+type WithoutThis<T extends (...args: any[]) => unknown> = (...args: Parameters<T>) => ReturnType<T>;
 export interface BasicContext {
     request: Request;
     response: ResponseUtils;
     pathParameters: PathParameters;
-    validatePathParameters: typeof helpers.validatePathParameters;
-    validateQuery: typeof helpers.validateQuery;
-    validateBody: typeof helpers.validateBody;
+    validatePathParameters: WithoutThis<typeof helpers.validatePathParameters>;
+    validateQuery: WithoutThis<typeof helpers.validateQuery>;
+    validateBody: WithoutThis<typeof helpers.validateBody>;
+    validators: typeof validators;
 }
 /** 使用者可自行补充 Context 定义  */
 export interface Context extends BasicContext {
@@ -65,3 +68,4 @@ export declare class Router {
      */
     readonly handle: (request: Request, response: ResponseUtils) => Promise<void>;
 }
+export {};

package/dist/router/index.js

@@ -99,6 +99,7 @@ export class Router {
             request,
             response,
             pathParameters: matched.parameters,
+            validatePathParameters: helpers.validatePathParameters.bind(basicContext),
             validateQuery: helpers.validateQuery.bind(basicContext),
             validateBody: helpers.validateBody.bind(basicContext),
         });

package/dist/swagger/factories.js

@@ -22,7 +22,10 @@ export function makeOperation(options = {}) {
         ? query
         : query
             ? Object.entries(query).reduce((result, [name, options]) => {
-                const query = makeQuery({ name, ...('schema' in options ? options : { schema: options }) });
+                const query = makeQuery({
+                    name,
+                    ...('schema' in options ? options : { schema: options }),
+                });
                 return [...result, query];
             }, [])
             : undefined;

package/package.json

@@ -1,13 +1,8 @@
 {
   "name": "starlight-server",
-  "version": "1.5.0",
+  "version": "1.6.2",
   "description": "Simple But Powerful Node.js HTTP Server",
   "type": "module",
-  "scripts": {
-    "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"
-  },
   "keywords": [
     "web",
     "app",
@@ -29,26 +24,35 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "main": "dist/index.js",
   "dependencies": {
-    "@anjianshi/utils": "^1.3.1",
+    "@anjianshi/utils": "^2.0.7",
     "chalk": "^5.3.0",
+    "dayjs": "^1.11.10",
     "debug": "^4.3.4",
-    "swagger-ui-dist": "^5.11.10"
+    "lodash": "^4.17.21",
+    "swagger-ui-dist": "^5.15.1"
   },
   "devDependencies": {
-    "@anjianshi/presets-eslint-node": "^1.0.3",
-    "@anjianshi/presets-eslint-typescript": "^1.0.3",
-    "@anjianshi/presets-prettier": "^1.0.0",
-    "@anjianshi/presets-typescript": "^1.0.1",
+    "@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",
     "@types/debug": "^4.1.9",
     "@types/lodash": "^4.14.199",
     "@types/node": "^20.8.6",
     "@types/swagger-ui-dist": "^3.30.4",
     "concurrently": "^8.2.1",
     "nodemon": "^3.0.2",
-    "rimraf": "^4.3.0",
-    "tsc-alias": "^1.8.8"
+    "rimraf": "^5.0.5",
+    "tsc-alias": "^1.8.8",
+    "typescript": "^5.4.5"
   },
   "eslintIgnore": [],
-  "prettier": "@anjianshi/presets-prettier/prettierrc"
-}
+  "prettier": "@anjianshi/presets-prettier/prettierrc",
+  "scripts": {
+    "dev": "rimraf dist && (concurrently --raw \"tsc-with-alias --watch\" \"nodemon dist/demo/index.js\")",
+    "build": "rimraf dist && tsc-with-alias",
+    "lint": "tsc --noEmit && eslint './src/**/*'"
+  }
+}

package/src/demo/index.ts

@@ -31,7 +31,7 @@ swagger.registerResponse(
   'hello',
   swagger.response({
     hello: swagger.string(),
-  })
+  }),
 )
 
 router.register({

package/src/router/index.ts

@@ -1,17 +1,20 @@
 import { joinPath } from '@anjianshi/utils'
+import { type validators } from '@anjianshi/utils/validators/index.js'
 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 * as helpers from './helpers.js'
 import { matchPath, type PathParameters } from './match-path.js'
 
+type WithoutThis<T extends (...args: any[]) => unknown> = (...args: Parameters<T>) => ReturnType<T>
 export interface BasicContext {
   request: Request
   response: ResponseUtils
   pathParameters: PathParameters
-  validatePathParameters: typeof helpers.validatePathParameters
-  validateQuery: typeof helpers.validateQuery
-  validateBody: typeof helpers.validateBody
+  validatePathParameters: WithoutThis<typeof helpers.validatePathParameters>
+  validateQuery: WithoutThis<typeof helpers.validateQuery>
+  validateBody: WithoutThis<typeof helpers.validateBody>
+  validators: typeof validators
 }
 
 /** 使用者可自行补充 Context 定义  */
@@ -108,7 +111,7 @@ export class Router {
   readonly handle = async (request: Request, response: ResponseUtils) => {
     const pathMatchedRoutes = matchPath(
       this.routes.map(route => route.path),
-      request.path
+      request.path,
     ).map(result => ({ route: this.routes[result.index]!, parameters: result.parameters }))
     if (!pathMatchedRoutes.length) throw new HTTPError(404) // 没有路径匹配的路由
 
@@ -117,7 +120,7 @@ export class Router {
     if (!matched) {
       const preflightTargetMethod = getPreflightRequestMethod(request) // 对于 CORS Preflight 请求，此为客户端原本希望请求的 method
       const preflightMatched = pathMatchedRoutes.find(
-        match => match.route.method === preflightTargetMethod
+        match => match.route.method === preflightTargetMethod,
       )
       if (preflightMatched) {
         const corsRule = preflightMatched.route.cors ?? this.cors
@@ -133,6 +136,7 @@ export class Router {
       request,
       response,
       pathParameters: matched.parameters,
+      validatePathParameters: helpers.validatePathParameters.bind(basicContext),
       validateQuery: helpers.validateQuery.bind(basicContext),
       validateBody: helpers.validateBody.bind(basicContext),
     })

package/src/swagger/factories.ts

@@ -13,7 +13,6 @@ import type {
   Reference,
   Parameter,
   RequestBody,
-  Components,
 } from './specification.js'
 
 type SchemaOrRef = Schema | Reference
@@ -45,11 +44,14 @@ export function makeOperation(options: OperationOptions = {}): Operation {
   const parameters = Array.isArray(query)
     ? query
     : query
-    ? Object.entries(query).reduce<Parameter[]>((result, [name, options]) => {
-        const query = makeQuery({ name, ...('schema' in options ? options : { schema: options }) })
-        return [...result, query]
-      }, [])
-    : undefined
+      ? Object.entries(query).reduce<Parameter[]>((result, [name, options]) => {
+          const query = makeQuery({
+            name,
+            ...('schema' in options ? options : { schema: options }),
+          })
+          return [...result, query]
+        }, [])
+      : undefined
   const requestBody = body ? ('$ref' in body ? (body as Reference) : makeBody(body)) : undefined
   const responses = response
     ? '$ref' in response
@@ -79,7 +81,7 @@ export function isOperationOptions(value: unknown): value is OperationOptions {
   if (typeof value !== 'object' || value === null) return false
   return (
     ['category', 'query', 'body', 'response'].find(key =>
-      truthy((value as Record<string, unknown>)[key])
+      truthy((value as Record<string, unknown>)[key]),
     ) !== undefined
   )
 }
@@ -116,7 +118,7 @@ export function makeHeader(options: ParameterOptions): Parameter {
  */
 export function makeBody(
   input: Record<string, SchemaOrRef> | ObjectOptions | Schema,
-  description?: string
+  description?: string,
 ): RequestBody {
   return {
     description,
@@ -152,7 +154,7 @@ export function makeResponsesBy(response: Response | Reference): Responses {
 /** 生成 Response 定义 */
 export function makeResponse(
   schema: Schema | Record<string, SchemaOrRef>,
-  description?: string
+  description?: string,
 ): Response {
   return {
     description,
@@ -175,7 +177,7 @@ export function isSchema(value: unknown): value is Schema {
   if (typeof value !== 'object' || value === null) return false
   return (
     ['type', 'allOf', 'anyOf', 'oneOf', 'not'].find(key =>
-      truthy((value as Record<string, unknown>)[key])
+      truthy((value as Record<string, unknown>)[key]),
     ) !== undefined
   )
 }