starlight-server 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import path from 'node:path';
2
2
  import { getFileDir } from '@anjianshi/utils/env-node/index.js';
3
- import { getLogger, startHTTPServer, DefaultRouter } from '../index.js';
3
+ import { getLogger, startHTTPServer, Router, } from '../index.js';
4
4
  import { registerSwaggerRoute } from '../swagger/index.js';
5
5
  const logger = getLogger({
6
6
  level: 'debug',
@@ -9,7 +9,16 @@ const logger = getLogger({
9
9
  dir: path.resolve(getFileDir(import.meta), '../../logs'),
10
10
  },
11
11
  });
12
- const router = new DefaultRouter();
12
+ class DemoRouter extends Router {
13
+ async executeWithContext(baseContext, route, pathParameters) {
14
+ const context = {
15
+ ...baseContext,
16
+ now: () => Date.now(),
17
+ };
18
+ await route.handler(context, pathParameters);
19
+ }
20
+ }
21
+ const router = new DemoRouter();
13
22
  router.registerResponseReference('hello', { object: [{ name: 'hello', type: 'string' }] });
14
23
  router.register({
15
24
  category: 'demo',
@@ -1,6 +1,6 @@
1
- import type { Router } from '../router/index.js';
1
+ import type { Router, BaseContext } from '../router/index.js';
2
2
  import type { OpenAPI } from './openapi-spec.js';
3
- export declare function registerSwaggerRoute(router: Router, endpoint?: string, customFields?: OpenAPICustomFields, swaggerOptions?: Record<string, unknown>): void;
3
+ export declare function registerSwaggerRoute<Ctx extends BaseContext>(router: Router<Ctx>, endpoint?: string, customFields?: OpenAPICustomFields, swaggerOptions?: Record<string, unknown>): void;
4
4
  /**
5
5
  * swagger API 路由
6
6
  */
@@ -15,7 +15,7 @@ export function registerSwaggerRoute(router, endpoint = '/swagger', customFields
15
15
  category: 'swagger',
16
16
  method: 'GET',
17
17
  path: normalizePath(endpoint) + '/api-swagger.json',
18
- handler: apiRoute.bind(null, router, customFields),
18
+ handler: (context) => apiRoute(router, customFields, context),
19
19
  });
20
20
  }
21
21
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "starlight-server",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Simple But Powerful Node.js HTTP Server",
5
5
  "type": "module",
6
6
  "scripts": {
package/src/demo/index.ts CHANGED
@@ -1,6 +1,13 @@
1
1
  import path from 'node:path'
2
2
  import { getFileDir } from '@anjianshi/utils/env-node/index.js'
3
- import { getLogger, startHTTPServer, DefaultRouter } from '@/index.js'
3
+ import {
4
+ getLogger,
5
+ startHTTPServer,
6
+ type BaseContext,
7
+ type Route,
8
+ type PathParameters,
9
+ Router,
10
+ } from '@/index.js'
4
11
  import { registerSwaggerRoute } from '@/swagger/index.js'
5
12
 
6
13
  const logger = getLogger({
@@ -11,7 +18,23 @@ const logger = getLogger({
11
18
  },
12
19
  })
13
20
 
14
- const router = new DefaultRouter()
21
+ type DemoContext = BaseContext & {
22
+ now: () => number
23
+ }
24
+ class DemoRouter extends Router<DemoContext> {
25
+ async executeWithContext(
26
+ baseContext: BaseContext,
27
+ route: Route<DemoContext>,
28
+ pathParameters: PathParameters,
29
+ ) {
30
+ const context: DemoContext = {
31
+ ...baseContext,
32
+ now: () => Date.now(),
33
+ }
34
+ await route.handler(context, pathParameters)
35
+ }
36
+ }
37
+ const router = new DemoRouter()
15
38
 
16
39
  router.registerResponseReference('hello', { object: [{ name: 'hello', type: 'string' }] })
17
40
 
@@ -7,8 +7,8 @@ import { normalizePath } from '@/router/match.js'
7
7
  import * as factory from './factory.js'
8
8
  import type { OpenAPI } from './openapi-spec.js'
9
9
 
10
- export function registerSwaggerRoute(
11
- router: Router,
10
+ export function registerSwaggerRoute<Ctx extends BaseContext>(
11
+ router: Router<Ctx>,
12
12
  endpoint: string = '/swagger',
13
13
  customFields: OpenAPICustomFields = { info: { title: 'API Document', version: '0.0.1' } },
14
14
  swaggerOptions?: Record<string, unknown>,
@@ -23,7 +23,7 @@ export function registerSwaggerRoute(
23
23
  category: 'swagger',
24
24
  method: 'GET',
25
25
  path: normalizePath(endpoint) + '/api-swagger.json',
26
- handler: apiRoute.bind(null, router, customFields),
26
+ handler: (context: Ctx) => apiRoute(router, customFields, context),
27
27
  })
28
28
  }
29
29
 
@@ -76,7 +76,11 @@ function replacement(abspath: string, content: Buffer, swaggerOptions?: Record<s
76
76
  */
77
77
  type OpenAPICustomFields = Omit<OpenAPI, 'openapi' | 'paths' | 'components'>
78
78
 
79
- function apiRoute(router: Router, customFields: OpenAPICustomFields, { response }: BaseContext) {
79
+ function apiRoute<Ctx extends BaseContext>(
80
+ router: Router<Ctx>,
81
+ customFields: OpenAPICustomFields,
82
+ { response }: BaseContext,
83
+ ) {
80
84
  const swaggerJSON: OpenAPI = {
81
85
  ...customFields,
82
86
  openapi: '3.1.0',