@twin.org/api-models 0.0.3-next.29 → 0.0.3-next.30

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 (46) hide show
  1. package/dist/es/index.js +3 -3
  2. package/dist/es/index.js.map +1 -1
  3. package/dist/es/models/api/IServerHealthResponse.js.map +1 -1
  4. package/dist/es/models/api/IServerLivezResponse.js.map +1 -1
  5. package/dist/es/models/api/IServerReadyzResponse.js +2 -0
  6. package/dist/es/models/api/IServerReadyzResponse.js.map +1 -0
  7. package/dist/es/models/server/IWebServer.js.map +1 -1
  8. package/dist/es/models/services/IHealthComponent.js +2 -0
  9. package/dist/es/models/services/IHealthComponent.js.map +1 -0
  10. package/dist/es/models/services/IHostingComponent.js.map +1 -1
  11. package/dist/es/models/services/IInformationComponent.js.map +1 -1
  12. package/dist/es/models/services/IUrlTransformerComponent.js +2 -0
  13. package/dist/es/models/services/IUrlTransformerComponent.js.map +1 -0
  14. package/dist/types/index.d.ts +3 -3
  15. package/dist/types/models/api/IServerHealthResponse.d.ts +6 -3
  16. package/dist/types/models/api/IServerLivezResponse.d.ts +1 -1
  17. package/dist/types/models/api/IServerReadyzResponse.d.ts +16 -0
  18. package/dist/types/models/server/IWebServer.d.ts +7 -1
  19. package/dist/types/models/services/IHealthComponent.d.ts +14 -0
  20. package/dist/types/models/services/IHostingComponent.d.ts +0 -56
  21. package/dist/types/models/services/IInformationComponent.d.ts +9 -23
  22. package/dist/types/models/services/IUrlTransformerComponent.d.ts +66 -0
  23. package/docs/changelog.md +7 -0
  24. package/docs/reference/index.md +3 -4
  25. package/docs/reference/interfaces/IHealthComponent.md +21 -0
  26. package/docs/reference/interfaces/IHostingComponent.md +0 -208
  27. package/docs/reference/interfaces/IInformationComponent.md +8 -76
  28. package/docs/reference/interfaces/IServerHealthResponse.md +10 -2
  29. package/docs/reference/interfaces/IServerLivezResponse.md +1 -1
  30. package/docs/reference/interfaces/IServerReadyzResponse.md +23 -0
  31. package/docs/reference/interfaces/IUrlTransformerComponent.md +229 -0
  32. package/docs/reference/interfaces/IWebServer.md +30 -0
  33. package/package.json +1 -1
  34. package/dist/es/models/services/IHealthComponentInfo.js +0 -2
  35. package/dist/es/models/services/IHealthComponentInfo.js.map +0 -1
  36. package/dist/es/models/services/IHealthInfo.js +0 -2
  37. package/dist/es/models/services/IHealthInfo.js.map +0 -1
  38. package/dist/es/models/services/healthStatus.js +0 -21
  39. package/dist/es/models/services/healthStatus.js.map +0 -1
  40. package/dist/types/models/services/IHealthComponentInfo.d.ts +0 -18
  41. package/dist/types/models/services/IHealthInfo.d.ts +0 -15
  42. package/dist/types/models/services/healthStatus.d.ts +0 -21
  43. package/docs/reference/interfaces/IHealthComponentInfo.md +0 -27
  44. package/docs/reference/interfaces/IHealthInfo.md +0 -19
  45. package/docs/reference/type-aliases/HealthStatus.md +0 -5
  46. package/docs/reference/variables/HealthStatus.md +0 -25
package/dist/types/models/services/IHealthInfo.d.ts DELETED
@@ -1,15 +0,0 @@
1
- import type { HealthStatus } from "./healthStatus.js";
2
- import type { IHealthComponentInfo } from "./IHealthComponentInfo.js";
3
- /**
4
- * The status of the server.
5
- */
6
- export interface IHealthInfo {
7
- /**
8
- * The status.
9
- */
10
- status: HealthStatus;
11
- /**
12
- * The status of the components.
13
- */
14
- components?: IHealthComponentInfo[];
15
- }
package/dist/types/models/services/healthStatus.d.ts DELETED
@@ -1,21 +0,0 @@
1
- /**
2
- * The health status of the component.
3
- */
4
- export declare const HealthStatus: {
5
- /**
6
- * OK.
7
- */
8
- readonly Ok: "ok";
9
- /**
10
- * Warning.
11
- */
12
- readonly Warning: "warning";
13
- /**
14
- * Error.
15
- */
16
- readonly Error: "error";
17
- };
18
- /**
19
- * The health status of the component.
20
- */
21
- export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];
package/docs/reference/interfaces/IHealthComponentInfo.md DELETED
@@ -1,27 +0,0 @@
1
- # Interface: IHealthComponentInfo
2
-
3
- The health component information.
4
-
5
- ## Properties
6
-
7
- ### name {#name}
8
-
9
- > **name**: `string`
10
-
11
- The name of the component.
12
-
13
- ***
14
-
15
- ### status {#status}
16
-
17
- > **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
18
-
19
- The status of the component.
20
-
21
- ***
22
-
23
- ### details? {#details}
24
-
25
- > `optional` **details?**: `string`
26
-
27
- The details for the status.
package/docs/reference/interfaces/IHealthInfo.md DELETED
@@ -1,19 +0,0 @@
1
- # Interface: IHealthInfo
2
-
3
- The status of the server.
4
-
5
- ## Properties
6
-
7
- ### status {#status}
8
-
9
- > **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
10
-
11
- The status.
12
-
13
- ***
14
-
15
- ### components? {#components}
16
-
17
- > `optional` **components?**: [`IHealthComponentInfo`](IHealthComponentInfo.md)[]
18
-
19
- The status of the components.
package/docs/reference/type-aliases/HealthStatus.md DELETED
@@ -1,5 +0,0 @@
1
- # Type Alias: HealthStatus
2
-
3
- > **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
4
-
5
- The health status of the component.
package/docs/reference/variables/HealthStatus.md DELETED
@@ -1,25 +0,0 @@
1
- # Variable: HealthStatus
2
-
3
- > `const` **HealthStatus**: `object`
4
-
5
- The health status of the component.
6
-
7
- ## Type Declaration
8
-
9
- ### Ok {#ok}
10
-
11
- > `readonly` **Ok**: `"ok"` = `"ok"`
12
-
13
- OK.
14
-
15
- ### Warning {#warning}
16
-
17
- > `readonly` **Warning**: `"warning"` = `"warning"`
18
-
19
- Warning.
20
-
21
- ### Error {#error}
22
-
23
- > `readonly` **Error**: `"error"` = `"error"`
24
-
25
- Error.