@twin.org/api-rest-client 0.0.1-next.9 → 0.0.2-next.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.
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,111 @@
|
|
|
1
1
|
# @twin.org/api-rest-client - Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.0...api-rest-client-v0.0.2-next.1) (2025-07-08)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
|
|
9
|
+
* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Dependencies
|
|
13
|
+
|
|
14
|
+
* The following workspace dependencies were updated
|
|
15
|
+
* dependencies
|
|
16
|
+
* @twin.org/api-core bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
17
|
+
* @twin.org/api-models bumped from 0.0.2-next.0 to 0.0.2-next.1
|
|
18
|
+
|
|
19
|
+
## 0.0.1 (2025-07-03)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/api-core bumped from ^0.0.0 to ^0.0.1
|
|
32
|
+
* @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
|
|
33
|
+
|
|
34
|
+
## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.1-next.35...api-rest-client-v0.0.1-next.36) (2025-06-17)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Miscellaneous Chores
|
|
38
|
+
|
|
39
|
+
* **api-rest-client:** Synchronize repo versions
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Dependencies
|
|
43
|
+
|
|
44
|
+
* The following workspace dependencies were updated
|
|
45
|
+
* dependencies
|
|
46
|
+
* @twin.org/api-core bumped from 0.0.1-next.35 to 0.0.1-next.36
|
|
47
|
+
* @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
|
|
48
|
+
|
|
49
|
+
## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.1-next.34...api-rest-client-v0.0.1-next.35) (2025-06-11)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### Features
|
|
53
|
+
|
|
54
|
+
* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Dependencies
|
|
58
|
+
|
|
59
|
+
* The following workspace dependencies were updated
|
|
60
|
+
* dependencies
|
|
61
|
+
* @twin.org/api-core bumped from 0.0.1-next.34 to 0.0.1-next.35
|
|
62
|
+
* @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
|
|
63
|
+
|
|
64
|
+
## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.1-next.33...api-rest-client-v0.0.1-next.34) (2025-05-27)
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### Miscellaneous Chores
|
|
68
|
+
|
|
69
|
+
* **api-rest-client:** Synchronize repo versions
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
### Dependencies
|
|
73
|
+
|
|
74
|
+
* The following workspace dependencies were updated
|
|
75
|
+
* dependencies
|
|
76
|
+
* @twin.org/api-core bumped from 0.0.1-next.33 to 0.0.1-next.34
|
|
77
|
+
* @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
|
|
78
|
+
|
|
79
|
+
## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.1-next.32...api-rest-client-v0.0.1-next.33) (2025-04-17)
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Features
|
|
83
|
+
|
|
84
|
+
* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Dependencies
|
|
88
|
+
|
|
89
|
+
* The following workspace dependencies were updated
|
|
90
|
+
* dependencies
|
|
91
|
+
* @twin.org/api-core bumped from 0.0.1-next.32 to 0.0.1-next.33
|
|
92
|
+
* @twin.org/api-models bumped from 0.0.1-next.32 to 0.0.1-next.33
|
|
93
|
+
|
|
94
|
+
## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.1-next.31...api-rest-client-v0.0.1-next.32) (2025-03-28)
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Miscellaneous Chores
|
|
98
|
+
|
|
99
|
+
* **api-rest-client:** Synchronize repo versions
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Dependencies
|
|
103
|
+
|
|
104
|
+
* The following workspace dependencies were updated
|
|
105
|
+
* dependencies
|
|
106
|
+
* @twin.org/api-core bumped from 0.0.1-next.31 to 0.0.1-next.32
|
|
107
|
+
* @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
|
|
108
|
+
|
|
109
|
+
## v0.0.1-next.31
|
|
4
110
|
|
|
5
111
|
- Initial Release
|
|
@@ -12,21 +12,23 @@ The client to connect to the information service.
|
|
|
12
12
|
|
|
13
13
|
## Constructors
|
|
14
14
|
|
|
15
|
-
###
|
|
15
|
+
### Constructor
|
|
16
16
|
|
|
17
|
-
> **new InformationClient**(`config`):
|
|
17
|
+
> **new InformationClient**(`config`): `InformationClient`
|
|
18
18
|
|
|
19
19
|
Create a new instance of InformationClient.
|
|
20
20
|
|
|
21
21
|
#### Parameters
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
##### config
|
|
24
|
+
|
|
25
|
+
`IBaseRestClientConfig`
|
|
24
26
|
|
|
25
27
|
The configuration for the client.
|
|
26
28
|
|
|
27
29
|
#### Returns
|
|
28
30
|
|
|
29
|
-
|
|
31
|
+
`InformationClient`
|
|
30
32
|
|
|
31
33
|
#### Overrides
|
|
32
34
|
|
|
@@ -102,21 +104,27 @@ The service health.
|
|
|
102
104
|
|
|
103
105
|
### setComponentHealth()
|
|
104
106
|
|
|
105
|
-
> **setComponentHealth**(`name`, `status`, `details
|
|
107
|
+
> **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
|
|
106
108
|
|
|
107
109
|
Set the status of a component.
|
|
108
110
|
|
|
109
111
|
#### Parameters
|
|
110
112
|
|
|
111
|
-
|
|
113
|
+
##### name
|
|
114
|
+
|
|
115
|
+
`string`
|
|
112
116
|
|
|
113
117
|
The component name.
|
|
114
118
|
|
|
115
|
-
|
|
119
|
+
##### status
|
|
120
|
+
|
|
121
|
+
`HealthStatus`
|
|
116
122
|
|
|
117
123
|
The status of the component.
|
|
118
124
|
|
|
119
|
-
|
|
125
|
+
##### details?
|
|
126
|
+
|
|
127
|
+
`string`
|
|
120
128
|
|
|
121
129
|
The details for the status.
|
|
122
130
|
|
|
@@ -140,7 +148,9 @@ Remove the status of a component.
|
|
|
140
148
|
|
|
141
149
|
#### Parameters
|
|
142
150
|
|
|
143
|
-
|
|
151
|
+
##### name
|
|
152
|
+
|
|
153
|
+
`string`
|
|
144
154
|
|
|
145
155
|
The component name.
|
|
146
156
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/api-rest-client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2-next.1",
|
|
4
4
|
"description": "Information contract implementation which can connect to REST endpoints",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,8 +14,8 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/api-core": "0.0.
|
|
18
|
-
"@twin.org/api-models": "0.0.
|
|
17
|
+
"@twin.org/api-core": "0.0.2-next.1",
|
|
18
|
+
"@twin.org/api-models": "0.0.2-next.1",
|
|
19
19
|
"@twin.org/core": "next",
|
|
20
20
|
"@twin.org/nameof": "next",
|
|
21
21
|
"@twin.org/web": "next"
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"types": "./dist/types/index.d.ts",
|
|
26
26
|
"exports": {
|
|
27
27
|
".": {
|
|
28
|
+
"types": "./dist/types/index.d.ts",
|
|
28
29
|
"require": "./dist/cjs/index.cjs",
|
|
29
|
-
"import": "./dist/esm/index.mjs"
|
|
30
|
-
"types": "./dist/types/index.d.ts"
|
|
30
|
+
"import": "./dist/esm/index.mjs"
|
|
31
31
|
}
|
|
32
32
|
},
|
|
33
33
|
"files": [
|