@twin.org/api-models 0.0.3-next.21 → 0.0.3-next.23

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.
Files changed (86) hide show
  1. package/dist/es/errors/forbiddenError.js +23 -0
  2. package/dist/es/errors/forbiddenError.js.map +1 -0
  3. package/dist/es/errors/tooManyRequestsError.js +25 -0
  4. package/dist/es/errors/tooManyRequestsError.js.map +1 -0
  5. package/dist/es/helpers/httpErrorHelper.js +6 -2
  6. package/dist/es/helpers/httpErrorHelper.js.map +1 -1
  7. package/dist/es/index.js +5 -0
  8. package/dist/es/index.js.map +1 -1
  9. package/dist/es/models/httpContextIdKeys.js +21 -0
  10. package/dist/es/models/httpContextIdKeys.js.map +1 -0
  11. package/dist/es/models/responses/errors/IConflictResponse.js.map +1 -1
  12. package/dist/es/models/responses/errors/INotImplementedResponse.js +2 -0
  13. package/dist/es/models/responses/errors/INotImplementedResponse.js.map +1 -0
  14. package/dist/es/models/responses/errors/ITooManyRequestsResponse.js +2 -0
  15. package/dist/es/models/responses/errors/ITooManyRequestsResponse.js.map +1 -0
  16. package/dist/types/errors/forbiddenError.d.ts +20 -0
  17. package/dist/types/errors/tooManyRequestsError.d.ts +22 -0
  18. package/dist/types/index.d.ts +5 -0
  19. package/dist/types/models/httpContextIdKeys.d.ts +21 -0
  20. package/dist/types/models/responses/errors/IConflictResponse.d.ts +1 -6
  21. package/dist/types/models/responses/errors/INotImplementedResponse.d.ts +15 -0
  22. package/dist/types/models/responses/errors/ITooManyRequestsResponse.d.ts +15 -0
  23. package/docs/changelog.md +14 -0
  24. package/docs/reference/classes/ForbiddenError.md +55 -0
  25. package/docs/reference/classes/HttpErrorHelper.md +3 -3
  26. package/docs/reference/classes/HttpParameterHelper.md +4 -4
  27. package/docs/reference/classes/HttpUrlHelper.md +6 -6
  28. package/docs/reference/classes/TooManyRequestsError.md +67 -0
  29. package/docs/reference/index.md +6 -0
  30. package/docs/reference/interfaces/IAcceptedResponse.md +2 -2
  31. package/docs/reference/interfaces/IBadRequestResponse.md +2 -2
  32. package/docs/reference/interfaces/IBaseRestClientConfig.md +9 -9
  33. package/docs/reference/interfaces/IBaseRoute.md +12 -12
  34. package/docs/reference/interfaces/IBaseRouteEntryPoint.md +4 -4
  35. package/docs/reference/interfaces/IBaseRouteProcessor.md +7 -7
  36. package/docs/reference/interfaces/IBaseSocketClientConfig.md +7 -7
  37. package/docs/reference/interfaces/IConflictResponse.md +3 -11
  38. package/docs/reference/interfaces/ICreatedResponse.md +2 -2
  39. package/docs/reference/interfaces/IForbiddenResponse.md +2 -2
  40. package/docs/reference/interfaces/IHealthComponentInfo.md +4 -4
  41. package/docs/reference/interfaces/IHealthInfo.md +3 -3
  42. package/docs/reference/interfaces/IHostingComponent.md +3 -3
  43. package/docs/reference/interfaces/IHttpRequest.md +8 -8
  44. package/docs/reference/interfaces/IHttpRequestContext.md +6 -6
  45. package/docs/reference/interfaces/IHttpRequestPathParams.md +1 -1
  46. package/docs/reference/interfaces/IHttpRequestQuery.md +1 -1
  47. package/docs/reference/interfaces/IHttpResponse.md +6 -6
  48. package/docs/reference/interfaces/IHttpServerRequest.md +11 -11
  49. package/docs/reference/interfaces/IInformationComponent.md +8 -8
  50. package/docs/reference/interfaces/IInternalServerErrorResponse.md +2 -2
  51. package/docs/reference/interfaces/IMimeTypeProcessor.md +2 -2
  52. package/docs/reference/interfaces/INoContentRequest.md +8 -8
  53. package/docs/reference/interfaces/INoContentResponse.md +1 -1
  54. package/docs/reference/interfaces/INotFoundResponse.md +3 -3
  55. package/docs/reference/interfaces/INotImplementedResponse.md +19 -0
  56. package/docs/reference/interfaces/IOkResponse.md +1 -1
  57. package/docs/reference/interfaces/IRestRoute.md +26 -26
  58. package/docs/reference/interfaces/IRestRouteExample.md +3 -3
  59. package/docs/reference/interfaces/IRestRouteProcessor.md +10 -10
  60. package/docs/reference/interfaces/IRestRouteRequestExample.md +4 -4
  61. package/docs/reference/interfaces/IRestRouteResponseAttachmentOptions.md +6 -6
  62. package/docs/reference/interfaces/IRestRouteResponseExample.md +4 -4
  63. package/docs/reference/interfaces/IRestRouteResponseOptions.md +2 -2
  64. package/docs/reference/interfaces/IServerFavIconResponse.md +7 -7
  65. package/docs/reference/interfaces/IServerHealthResponse.md +1 -1
  66. package/docs/reference/interfaces/IServerInfo.md +2 -2
  67. package/docs/reference/interfaces/IServerInfoResponse.md +1 -1
  68. package/docs/reference/interfaces/IServerLivezResponse.md +2 -2
  69. package/docs/reference/interfaces/IServerRootResponse.md +2 -2
  70. package/docs/reference/interfaces/IServerSpecResponse.md +4 -4
  71. package/docs/reference/interfaces/ISocketRequestContext.md +7 -7
  72. package/docs/reference/interfaces/ISocketRoute.md +17 -17
  73. package/docs/reference/interfaces/ISocketRouteProcessor.md +16 -16
  74. package/docs/reference/interfaces/ISocketServerRequest.md +12 -12
  75. package/docs/reference/interfaces/ITag.md +2 -2
  76. package/docs/reference/interfaces/ITenant.md +8 -8
  77. package/docs/reference/interfaces/ITenantAdminComponent.md +7 -7
  78. package/docs/reference/interfaces/ITooManyRequestsResponse.md +19 -0
  79. package/docs/reference/interfaces/IUnauthorizedResponse.md +2 -2
  80. package/docs/reference/interfaces/IUnprocessableEntityResponse.md +2 -2
  81. package/docs/reference/interfaces/IWebServer.md +4 -4
  82. package/docs/reference/interfaces/IWebServerOptions.md +36 -12
  83. package/docs/reference/type-aliases/HttpContextIdKeys.md +5 -0
  84. package/docs/reference/variables/HealthStatus.md +3 -3
  85. package/docs/reference/variables/HttpContextIdKeys.md +25 -0
  86. package/package.json +1 -1
package/docs/reference/type-aliases/HttpContextIdKeys.md ADDED
@@ -0,0 +1,5 @@
1
+ # Type Alias: HttpContextIdKeys
2
+
3
+ > **HttpContextIdKeys** = *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\[keyof *typeof* [`HttpContextIdKeys`](../variables/HttpContextIdKeys.md)\]
4
+
5
+ HTTP definition of some context keys.
package/docs/reference/variables/HealthStatus.md CHANGED
@@ -6,19 +6,19 @@ The health status of the component.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Ok
9
+ ### Ok {#ok}
10
10
 
11
11
  > `readonly` **Ok**: `"ok"` = `"ok"`
12
12
 
13
13
  OK.
14
14
 
15
- ### Warning
15
+ ### Warning {#warning}
16
16
 
17
17
  > `readonly` **Warning**: `"warning"` = `"warning"`
18
18
 
19
19
  Warning.
20
20
 
21
- ### Error
21
+ ### Error {#error}
22
22
 
23
23
  > `readonly` **Error**: `"error"` = `"error"`
24
24
 
package/docs/reference/variables/HttpContextIdKeys.md ADDED
@@ -0,0 +1,25 @@
1
+ # Variable: HttpContextIdKeys
2
+
3
+ > `const` **HttpContextIdKeys**: `object`
4
+
5
+ HTTP definition of some context keys.
6
+
7
+ ## Type Declaration
8
+
9
+ ### IpAddress {#ipaddress}
10
+
11
+ > `readonly` **IpAddress**: `"ipAddress"` = `"ipAddress"`
12
+
13
+ IP address of the client.
14
+
15
+ ### UserAgent {#useragent}
16
+
17
+ > `readonly` **UserAgent**: `"userAgent"` = `"userAgent"`
18
+
19
+ User agent of the client.
20
+
21
+ ### CorrelationId {#correlationid}
22
+
23
+ > `readonly` **CorrelationId**: `"correlationId"` = `"correlationId"`
24
+
25
+ Correlation ID of the request.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-models",
3
- "version": "0.0.3-next.21",
3
+ "version": "0.0.3-next.23",
4
4
  "description": "Shared API contracts, route types, and response models used across services and clients.",
5
5
  "repository": {
6
6
  "type": "git",