@twin.org/api-models 0.0.1-next.8 → 0.0.1

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 (48) hide show
  1. package/dist/cjs/index.cjs +42 -70
  2. package/dist/esm/index.mjs +42 -73
  3. package/dist/types/factories/mimeTypeProcessorFactory.d.ts +6 -0
  4. package/dist/types/factories/restRouteProcessorFactory.d.ts +6 -0
  5. package/dist/types/factories/socketRouteProcessorFactory.d.ts +6 -0
  6. package/dist/types/helpers/httpParameterHelper.d.ts +8 -27
  7. package/dist/types/index.d.ts +9 -1
  8. package/dist/types/models/config/IBaseSocketClientConfig.d.ts +4 -0
  9. package/dist/types/models/routes/IBaseRouteEntryPoint.d.ts +22 -0
  10. package/dist/types/models/routes/IRestRouteEntryPoint.d.ts +2 -19
  11. package/dist/types/models/routes/ISocketRoute.d.ts +6 -8
  12. package/dist/types/models/routes/ISocketRouteEntryPoint.d.ts +6 -0
  13. package/dist/types/models/server/IBaseRouteProcessor.d.ts +34 -0
  14. package/dist/types/models/server/IMimeTypeProcessor.d.ts +17 -0
  15. package/dist/types/models/server/IRestRouteProcessor.d.ts +22 -0
  16. package/dist/types/models/server/{IHttpRestRouteProcessor.d.ts → ISocketRouteProcessor.d.ts} +12 -15
  17. package/dist/types/models/server/IWebServer.d.ts +7 -3
  18. package/docs/changelog.md +43 -1
  19. package/docs/reference/classes/HttpErrorHelper.md +19 -9
  20. package/docs/reference/classes/HttpParameterHelper.md +39 -63
  21. package/docs/reference/index.md +10 -2
  22. package/docs/reference/interfaces/IBaseRouteEntryPoint.md +55 -0
  23. package/docs/reference/interfaces/IBaseRouteProcessor.md +106 -0
  24. package/docs/reference/interfaces/IBaseSocketClientConfig.md +8 -0
  25. package/docs/reference/interfaces/IHealthInfo.md +18 -0
  26. package/docs/reference/interfaces/IHttpRequest.md +3 -1
  27. package/docs/reference/interfaces/IHttpRequestContext.md +2 -2
  28. package/docs/reference/interfaces/IHttpRequestPathParams.md +1 -1
  29. package/docs/reference/interfaces/IHttpRequestQuery.md +1 -1
  30. package/docs/reference/interfaces/IHttpResponse.md +3 -1
  31. package/docs/reference/interfaces/IHttpServerRequest.md +3 -1
  32. package/docs/reference/interfaces/IInformationComponent.md +13 -5
  33. package/docs/reference/interfaces/IMimeTypeProcessor.md +43 -0
  34. package/docs/reference/interfaces/IRestRoute.md +30 -4
  35. package/docs/reference/interfaces/{IHttpRestRouteProcessor.md → IRestRouteProcessor.md} +55 -23
  36. package/docs/reference/interfaces/IRestRouteRequestExample.md +3 -1
  37. package/docs/reference/interfaces/IRestRouteResponseExample.md +3 -1
  38. package/docs/reference/interfaces/ISocketRoute.md +22 -10
  39. package/docs/reference/interfaces/ISocketRouteProcessor.md +217 -0
  40. package/docs/reference/interfaces/IWebServer.md +26 -6
  41. package/docs/reference/type-aliases/HealthStatus.md +1 -1
  42. package/docs/reference/type-aliases/IRestRouteEntryPoint.md +5 -0
  43. package/docs/reference/type-aliases/ISocketRouteEntryPoint.md +5 -0
  44. package/docs/reference/variables/MimeTypeProcessorFactory.md +5 -0
  45. package/docs/reference/variables/RestRouteProcessorFactory.md +5 -0
  46. package/docs/reference/variables/SocketRouteProcessorFactory.md +5 -0
  47. package/package.json +6 -7
  48. package/docs/reference/interfaces/IRestRouteEntryPoint.md +0 -45
package/docs/reference/interfaces/IRestRouteEntryPoint.md DELETED
@@ -1,45 +0,0 @@
1
- # Interface: IRestRouteEntryPoint
2
-
3
- Route entry points are used for exposing the REST routes from a package.
4
-
5
- ## Properties
6
-
7
- ### name
8
-
9
- > **name**: `string`
10
-
11
- The name of the REST routes.
12
-
13
- ***
14
-
15
- ### defaultBaseRoute
16
-
17
- > **defaultBaseRoute**: `string`
18
-
19
- The default base route name for the REST routes.
20
-
21
- ***
22
-
23
- ### tags
24
-
25
- > **tags**: [`ITag`](ITag.md)[]
26
-
27
- The tags for the REST routes.
28
-
29
- ***
30
-
31
- ### generateRoutes()
32
-
33
- > **generateRoutes**: (`baseRouteName`, `componentName`) => [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
34
-
35
- The method to generate the REST routes.
36
-
37
- #### Parameters
38
-
39
- • **baseRouteName**: `string`
40
-
41
- • **componentName**: `string`
42
-
43
- #### Returns
44
-
45
- [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]