snap-on-openapi 1.0.16 → 1.0.17

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.
@@ -45,18 +45,19 @@ export class ConfigBuilder {
45
45
  if (conf) {
46
46
  return this.construct(conf);
47
47
  }
48
- const routeMap = this.routeMap ?? undefined;
49
48
  const contextMap = this.routeContextMap ?? undefined;
50
- if (this.routeContextMap && this.routeMap) {
51
- for (const key of Object.keys(routeMap)) {
52
- routeMap[key].contextFactory = contextMap[key];
49
+ if (this.routeMap) {
50
+ const keys = Object.keys(this.routeMap);
51
+ for (const key of keys) {
52
+ const factory = contextMap?.[key] ? contextMap[key] : async () => undefined;
53
+ this.routeMap[key].contextFactory = factory;
53
54
  }
54
55
  }
55
56
  const def = new DefaultConfig();
56
57
  const builtConf = {
57
58
  ...def,
58
59
  ...this.conf,
59
- ...(routeMap ? { routes: routeMap } : {}),
60
+ ...(this.routeMap ? { routes: this.routeMap } : {}),
60
61
  ...(this.errorMap ? { errors: this.errorMap } : {}),
61
62
  ...(this.defaultError ? { defaultError: this.defaultError } : {}),
62
63
  };
@@ -21,9 +21,9 @@ export declare class DefaultConfig implements Config<SampleRouteType, ErrorCode,
21
21
  };
22
22
  };
23
23
  onRequest?: () => Promise<void>;
24
- onRoute?: (e: OnRouteEvent) => Promise<void>;
24
+ onRoute?: (e: OnRouteEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<void>;
25
25
  onHandler?: () => Promise<void>;
26
- onResponse?: (e: OnResponseEvent) => Promise<void>;
27
- onError?: (e: OnErrorEvent) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
26
+ onResponse?: (e: OnResponseEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<void>;
27
+ onError?: (e: OnErrorEvent<SampleRouteType, DefaultRouteParamsMap>) => Promise<ErrorResponse<ErrorCode, DefaultErrorMap>>;
28
28
  skipDescriptionsCheck?: boolean;
29
29
  }
@@ -3,4 +3,5 @@ import { RouteContextMap } from '../../../types/config/RouteContextMap.js';
3
3
  import { DefaultRouteParamsMap } from './DefaultRouteParamsMap.js';
4
4
  export declare class DefaultRouteContextMap implements RouteContextMap<SampleRouteType, DefaultRouteParamsMap> {
5
5
  Public: () => Promise<{}>;
6
+ User: () => Promise<{}>;
6
7
  }
@@ -1,3 +1,4 @@
1
1
  export class DefaultRouteContextMap {
2
2
  Public = async () => ({});
3
+ User = async () => ({});
3
4
  }
@@ -33,8 +33,8 @@ export type Config<TRouteTypes extends string, TErrorCodes extends string, TErro
33
33
  servers?: Server[];
34
34
  logLevel?: LogLevel;
35
35
  onRequest?: (e: OnRequestEvent) => Promise<void>;
36
- onRoute?: (e: OnRouteEvent) => Promise<void>;
37
- onHandler?: (e: OnHandlerEvent) => Promise<void>;
38
- onResponse?: (e: OnResponseEvent) => Promise<void>;
39
- onError?: (e: OnErrorEvent) => Promise<ErrorResponse<TErrorCodes, TErrorConfigMap>>;
36
+ onRoute?: (e: OnRouteEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
37
+ onHandler?: (e: OnHandlerEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
38
+ onResponse?: (e: OnResponseEvent<TRouteTypes, TRouteParamMap>) => Promise<void>;
39
+ onError?: (e: OnErrorEvent<TRouteTypes, TRouteParamMap>) => Promise<ErrorResponse<TErrorCodes, TErrorConfigMap>>;
40
40
  };
@@ -1,6 +1,7 @@
1
1
  import { Logger } from '../../services/Logger/Logger.js';
2
+ import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
2
3
  import { OnResponseEvent } from './OnResponseEvent.js';
3
- export interface OnErrorEvent extends Partial<OnResponseEvent> {
4
+ export interface OnErrorEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends Partial<OnResponseEvent<TRouteType, TContextMap>> {
4
5
  request: Request;
5
6
  logger: Logger;
6
7
  error: unknown;
@@ -1,5 +1,6 @@
1
+ import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
1
2
  import { OnRouteEvent } from './OnRouteEvent.js';
2
- export interface OnHandlerEvent extends OnRouteEvent {
3
+ export interface OnHandlerEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnRouteEvent<TRouteType, TContextMap> {
3
4
  validated: {
4
5
  query: Record<string, unknown>;
5
6
  path: Record<string, unknown>;
@@ -1,5 +1,6 @@
1
+ import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
1
2
  import { RouteResponse } from '../RouteResponse.js';
2
3
  import { OnHandlerEvent } from './OnHandlerEvent.js';
3
- export interface OnResponseEvent extends OnHandlerEvent {
4
+ export interface OnResponseEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnHandlerEvent<TRouteType, TContextMap> {
4
5
  response: RouteResponse;
5
6
  }
@@ -1,10 +1,12 @@
1
1
  import { AnyRoute } from '../AnyRoute.js';
2
+ import { RouteExtraProps } from '../config/RouteExtraProps.js';
3
+ import { RouteExtraPropsMap } from '../config/RouteExtraPropsMap.js';
2
4
  import { OnRequestEvent } from './OnRequestEvent.js';
3
- export interface OnRouteEvent extends OnRequestEvent {
5
+ export interface OnRouteEvent<TRouteType extends string, TContextMap extends RouteExtraPropsMap<TRouteType>> extends OnRequestEvent {
4
6
  path: string;
5
7
  method: string;
6
8
  params: Record<string, string>;
7
9
  query: Record<string, string | string[]>;
8
10
  body: unknown;
9
- route: AnyRoute<string>;
11
+ route: AnyRoute<TRouteType> & RouteExtraProps<TContextMap[TRouteType]>;
10
12
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "snap-on-openapi",
3
3
  "author": "Alex Sarychev",
4
- "version": "1.0.16",
4
+ "version": "1.0.17",
5
5
  "description": "Swiftly build type-checked OpenAPI applications with Zod and TypeScript",
6
6
  "type": "module",
7
7
  "license": "ISC",