openapi-backend - npm Package Compare versions

Comparing version 5.8.1 to 5.9.0

backend.d.ts

 import type { Options as AjvOpts } from 'ajv';
 import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import { OpenAPIRouter, Request, ParsedRequest, Operation } from './router';
+import { OpenAPIRouter, Request, ParsedRequest, Operation, UnknownParams } from './router';
 import { OpenAPIValidator, ValidationResult, AjvCustomizer } from './validation';
@@ -19,9 +19,6 @@ export type Document = OpenAPIV3_1.Document | OpenAPIV3.Document;
  * Passed context built for request. Passed as first argument for all handlers.
- *
- * @export
- * @interface Context
  */
-export interface Context<D extends Document = Document> {
+export interface Context<RequestBody = any, Params = UnknownParams, Query = UnknownParams, Headers = UnknownParams, Cookies = UnknownParams, D extends Document = Document> {
     api: OpenAPIBackend<D>;
-    request: ParsedRequest;
+    request: ParsedRequest<RequestBody, Params, Query, Headers, Cookies>;
     operation: Operation<D>;
@@ -32,3 +29,6 @@ validation: ValidationResult;
 }
-export type Handler = (context: Context, ...args: any[]) => any | Promise<any>;
+/**
+ * A handler for an operation with request Context and passed arguments from handleRequest
+ */
+export type Handler<RequestBody = any, Params = UnknownParams, Query = UnknownParams, Headers = UnknownParams, Cookies = UnknownParams, D extends Document = Document> = (context: Context<RequestBody, Params, Query, Headers, Cookies, D>, ...args: any[]) => any | Promise<any>;
 export type BoolPredicate = (context: Context, ...args: any[]) => boolean;
@@ -35,0 +35,0 @@ /**

package.json

 {
   "name": "openapi-backend",
   "description": "Build, Validate, Route, Authenticate and Mock using OpenAPI definitions. Framework-agnostic",
-  "version": "5.8.1",
+  "version": "5.9.0",
   "author": "Viljami Kuosmanen <[e-mail]>",
@@ -45,3 +45,3 @@ "funding": "https://github.com/sponsors/anttiviljami",
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^9.0.7",
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
     "ajv": "^8.6.2",
@@ -48,0 +48,0 @@ "bath-es5": "^3.0.3",

README.md

@@ -30,3 +30,3 @@ <h1 align="center"><img alt="openapi-backend" src="./header.png" style="max-width:50rem"></h1>
 
-**New!** OpenAPI-backend documentation is now found on [openapistack.co](https://openapistack.co)
+**New!** OpenAPI Backend documentation is now found on [openapistack.co](https://openapistack.co)
 
@@ -33,0 +33,0 @@ https://openapistack.co/docs/openapi-backend/intro

router.d.ts

@@ -30,13 +30,14 @@ import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 }
-export interface ParsedRequest extends Request {
-    params: {
-        [key: string]: string | string[];
-    };
-    cookies: {
-        [key: string]: string | string[];
-    };
-    query: {
-        [key: string]: string | string[];
-    };
-    requestBody: any;
+export type UnknownParams = {
+    [key: string]: string | string[];
+};
+export interface ParsedRequest<RequestBody = any, Params = UnknownParams, Query = UnknownParams, Headers = UnknownParams, Cookies = UnknownParams> {
+    method: string;
+    path: string;
+    requestBody: RequestBody;
+    params: Params;
+    query: Query;
+    headers: Headers;
+    cookies: Cookies;
+    body?: any;
 }
@@ -43,0 +44,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

152390

0.37%

Lines of code

2432

0.04%

Dependency changes

• + Added

  @apidevtools/json-schema-ref-parser@10.1.0
  (transitive)

• + Added

  @types/lodash@4.17.17
  (transitive)

• + Added

  @types/lodash.clonedeep@4.5.9
  (transitive)

• + Added

  lodash.clonedeep@4.5.0
  (transitive)

• - Removed

  @apidevtools/json-schema-ref-parser@9.1.2
  (transitive)

• - Removed

  call-me-maybe@1.0.2
  (transitive)

• Updated

  @apidevtools/json-schema-ref-parser@^10.1.0