@gtsc/api-models - npm Package Compare versions

Comparing version 0.0.3-next.1 to 0.0.3-next.2

dist/types/index.d.ts

 export * from "./clients/baseRestClient";
 export * from "./clients/baseSocketClient";
+export * from "./models/responses/errors/IBadRequestErrorResponse";
+export * from "./models/responses/errors/IConflictResponse";
+export * from "./models/responses/errors/IForbiddenResponse";
+export * from "./models/responses/errors/IInternalServerErrorResponse";
+export * from "./models/responses/errors/INotFoundResponse";
+export * from "./models/responses/errors/IServiceUnavailableResponse";
+export * from "./models/responses/errors/IUnauthorizedResponse";
+export * from "./models/responses/errors/IUnprocessableEntityResponse";
+export * from "./models/responses/IAcceptedResponse";
+export * from "./models/responses/ICreatedResponse";
+export * from "./models/responses/IErrorResponse";
+export * from "./models/responses/INoContentResponse";
+export * from "./models/responses/ISuccessResponse";
 export * from "./models/config/IBaseRestClientConfig";
@@ -4,0 +17,0 @@ export * from "./models/config/IBaseSocketClientConfig";

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

 import type { IRequestContext } from "@gtsc/services";
-import type { HttpMethods } from "@gtsc/web";
+import type { HttpMethods, HttpStatusCodes } from "@gtsc/web";
 import type { IBaseRoute } from "./IBaseRoute";
@@ -31,7 +31,7 @@ /**
      */
-    request: any, 
+    request: unknown, 
     /**
      * Body as standalone if it's a data request.
      */
-    body?: unknown) => Promise<any>;
+    body?: unknown) => Promise<unknown>;
     /**
@@ -45,3 +45,3 @@ * The type of the request object.
     responseType?: string | {
-        statusCode: number;
+        statusCode: HttpStatusCodes;
         type: string;
@@ -48,0 +48,0 @@ }[];

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

@@ -22,3 +22,3 @@ import type { IRequestContext } from "@gtsc/services";
      */
-    request: any, 
+    request: unknown, 
     /**
@@ -25,0 +25,0 @@ * Method to emit data on the socket.

docs/reference/interfaces/IRestRoute.md

@@ -15,3 +15,3 @@ # Interface: IRestRoute
 
-• **handler**: (`requestContext`: `IRequestContext`, `request`: `any`, `body?`: `unknown`) => `Promise`\<`any`\>
+• **handler**: (`requestContext`: `IRequestContext`, `request`: `unknown`, `body?`: `unknown`) => `Promise`\<`unknown`\>
 
@@ -22,3 +22,3 @@ The handler module.
 
-▸ (`requestContext`, `request`, `body?`): `Promise`\<`any`\>
+▸ (`requestContext`, `request`, `body?`): `Promise`\<`unknown`\>
 
@@ -30,3 +30,3 @@ ##### Parameters
 | `requestContext` | `IRequestContext` | The request context. |
-| `request` | `any` | The request object, combined query param, path params and body. |
+| `request` | `unknown` | The request object, combined query param, path params and body. |
 | `body?` | `unknown` | Body as standalone if it's a data request. |
@@ -36,3 +36,3 @@
 
-`Promise`\<`any`\>
+`Promise`\<`unknown`\>
 
@@ -99,3 +99,3 @@ ___
 
-• `Optional` **responseType**: `string` \| \{ `statusCode`: `number` ; `type`: `string`  }[]
+• `Optional` **responseType**: `string` \| \{ `statusCode`: `HttpStatusCodes` ; `type`: `string`  }[]
 
@@ -102,0 +102,0 @@ The type of the response object.

docs/reference/interfaces/ISocketRoute.md

@@ -15,3 +15,3 @@ # Interface: ISocketRoute
 
-• **handler**: (`requestContext`: `IRequestContext`, `socketId`: `string`, `request`: `any`, `emitter`: (`topic`: `string`, `response?`: `unknown`) => `Promise`\<`void`\>) => `Promise`\<`void`\>
+• **handler**: (`requestContext`: `IRequestContext`, `socketId`: `string`, `request`: `unknown`, `emitter`: (`topic`: `string`, `response?`: `unknown`) => `Promise`\<`void`\>) => `Promise`\<`void`\>
 
@@ -30,3 +30,3 @@ The handler module.
 | `socketId` | `string` | The id of the socket the request is arriving on. |
-| `request` | `any` | The request object. |
+| `request` | `unknown` | The request object. |
 | `emitter` | (`topic`: `string`, `response?`: `unknown`) => `Promise`\<`void`\> | Method to emit data on the socket. |
@@ -33,0 +33,0 @@

docs/reference/modules.md

@@ -10,11 +10,24 @@ # @gtsc/api-models
 
+- [IAcceptedResponse](interfaces/IAcceptedResponse.md)
 - [IAuthConnector](interfaces/IAuthConnector.md)
+- [IBadRequestResponse](interfaces/IBadRequestResponse.md)
 - [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
 - [IBaseRoute](interfaces/IBaseRoute.md)
 - [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
+- [IConflictResponse](interfaces/IConflictResponse.md)
+- [ICreatedResponse](interfaces/ICreatedResponse.md)
+- [IErrorResponse](interfaces/IErrorResponse.md)
+- [IForbiddenResponse](interfaces/IForbiddenResponse.md)
 - [IHttpRequest](interfaces/IHttpRequest.md)
 - [IHttpRequestQuery](interfaces/IHttpRequestQuery.md)
 - [IHttpResponse](interfaces/IHttpResponse.md)
+- [IInternalServerErrorResponse](interfaces/IInternalServerErrorResponse.md)
+- [INoContentResponse](interfaces/INoContentResponse.md)
+- [INotFoundResponse](interfaces/INotFoundResponse.md)
 - [IRestRoute](interfaces/IRestRoute.md)
+- [IServiceUnavailableResponse](interfaces/IServiceUnavailableResponse.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
+- [ISuccessResponse](interfaces/ISuccessResponse.md)
 - [ITag](interfaces/ITag.md)
+- [IUnauthorizedResponse](interfaces/IUnauthorizedResponse.md)
+- [IUnprocessableEntityResponse](interfaces/IUnprocessableEntityResponse.md)

package.json

 {
 	"name": "@gtsc/api-models",
-	"version": "0.0.3-next.1",
+	"version": "0.0.3-next.2",
 	"description": "Contains models and classes for use with APIs",
@@ -5,0 +5,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

65310

increased by17.73%

Number of package files

61

increased by74.29%

Lines of code

985

increased by14.94%

No dependency changes