@gtsc/api-models - npm Package Compare versions

Comparing version 0.0.3-next.20 to 0.0.3-next.21

dist/types/index.d.ts

@@ -21,8 +21,7 @@ export * from "./models/config/IBaseRestClientConfig";
 export * from "./models/routes/IRestRoute";
-export * from "./models/routes/IRestRouteRequest";
-export * from "./models/routes/IRestRouteResponse";
+export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
 export * from "./models/routes/ITag";
+export * from "./models/server/httpRestRouteProcessor";
 export * from "./models/server/IWebServer";
 export * from "./models/server/IWebServerOptions";
-export * from "./models/server/httpRestRouteProcessor";

dist/types/models/protocol/IHttpRequest.d.ts

@@ -7,3 +7,3 @@ import type { HttpMethods, IHttpRequestHeaders } from "@gtsc/web";
  */
-export interface IHttpRequest<T = unknown> {
+export interface IHttpRequest<T = any> {
     /**
@@ -10,0 +10,0 @@ * The request method.

dist/types/models/protocol/IHttpRequestContext.d.ts

@@ -8,5 +8,5 @@ import type { IRequestContext } from "@gtsc/services";
     /**
-     * The full HTTP request.
+     * The raw HTTP request.
      */
-    request: IHttpRequest;
+    rawRequest: IHttpRequest;
 }

dist/types/models/protocol/IHttpResponse.d.ts

@@ -5,3 +5,3 @@ import type { HttpStatusCodes, IHttpRequestHeaders } from "@gtsc/web";
  */
-export interface IHttpResponse<T = unknown> {
+export interface IHttpResponse<T = any> {
     /**
@@ -8,0 +8,0 @@ * Response status code.

dist/types/models/routes/IRestRoute.d.ts

 import type { HttpMethods } from "@gtsc/web";
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IRestRouteResponseOptions } from "./IRestRouteResponseOptions";
+import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
+import type { IHttpResponse } from "../protocol/IHttpResponse";
 /**
  * Interface which defines a REST route.
  */
-export interface IRestRoute<T = any, U = any> extends IBaseRoute {
+export interface IRestRoute<T extends IHttpRequest = IHttpRequest, U extends IHttpResponse & IRestRouteResponseOptions = IHttpResponse & IRestRouteResponseOptions> extends IBaseRoute {
     /**
@@ -9,0 +12,0 @@ * Summary of what task the operation performs.

docs/reference/globals.md

@@ -21,4 +21,3 @@ # @gtsc/api-models
 - [IRestRoute](interfaces/IRestRoute.md)
-- [IRestRouteRequest](interfaces/IRestRouteRequest.md)
-- [IRestRouteResponse](interfaces/IRestRouteResponse.md)
+- [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
@@ -25,0 +24,0 @@ - [ITag](interfaces/ITag.md)

docs/reference/interfaces/IHttpRequest.md

@@ -11,3 +11,3 @@ [**@gtsc/api-models**](../overview.md) • **Docs**
 
-• **T** = `unknown`
+• **T** = `any`
 
@@ -14,0 +14,0 @@ ## Properties

docs/reference/interfaces/IHttpRequestContext.md

@@ -51,6 +51,6 @@ [**@gtsc/api-models**](../overview.md) • **Docs**
 
-### request
+### rawRequest
 
-> **request**: [`IHttpRequest`](IHttpRequest.md)\<`unknown`\>
+> **rawRequest**: [`IHttpRequest`](IHttpRequest.md)\<`any`\>
 
-The full HTTP request.
+The raw HTTP request.

docs/reference/interfaces/IHttpResponse.md

@@ -11,3 +11,3 @@ [**@gtsc/api-models**](../overview.md) • **Docs**
 
-• **T** = `unknown`
+• **T** = `any`
 
@@ -14,0 +14,0 @@ ## Properties

docs/reference/interfaces/IRestRoute.md

@@ -15,5 +15,5 @@ [**@gtsc/api-models**](../overview.md) • **Docs**
 
-• **T** = `any`
+• **T** *extends* [`IHttpRequest`](IHttpRequest.md) = [`IHttpRequest`](IHttpRequest.md)
 
-• **U** = `any`
+• **U** *extends* [`IHttpResponse`](IHttpResponse.md) & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.md) = [`IHttpResponse`](IHttpResponse.md) & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.md)
 
@@ -20,0 +20,0 @@ ## Properties

docs/reference/interfaces/IWebServer.md

@@ -23,3 +23,3 @@ [**@gtsc/api-models**](../overview.md) • **Docs**
 
-• **restRoutes**: [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
+• **restRoutes**: [`IRestRoute`](IRestRoute.md)\<[`IHttpRequest`](IHttpRequest.md)\<`any`\>, [`IHttpResponse`](IHttpResponse.md)\<`any`\> & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.md)\>[]
 
@@ -26,0 +26,0 @@ The REST routes.

package.json

 {
 	"name": "@gtsc/api-models",
-	"version": "0.0.3-next.20",
+	"version": "0.0.3-next.21",
 	"description": "Contains models and classes for use with APIs",
@@ -19,3 +19,3 @@ "repository": {
 		"@gtsc/logging-models": "next",
-		"@gtsc/nameof": "^0.0.4",
+		"@gtsc/nameof": "0.0.4",
 		"@gtsc/services": "next",
@@ -22,0 +22,0 @@ "@gtsc/web": "next"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

44651

decreased by-2.07%

Number of package files

63

decreased by-3.08%

Lines of code

493

decreased by-5.92%

Dependency changes

• Updated@gtsc/nameof@0.0.4