@twin.org/api-rest-client 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 (3) hide show
  1. package/docs/changelog.md +91 -1
  2. package/docs/reference/classes/InformationClient.md +19 -9
  3. package/package.json +8 -8
package/docs/changelog.md CHANGED
@@ -1,5 +1,95 @@
1
1
  # @twin.org/api-rest-client - Changelog
2
2
 
3
- ## v0.0.1-next.8
3
+ ## 0.0.1 (2025-07-03)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/api-core bumped from ^0.0.0 to ^0.0.1
16
+ * @twin.org/api-models bumped from ^0.0.0 to ^0.0.1
17
+
18
+ ## [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)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **api-rest-client:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/api-core bumped from 0.0.1-next.35 to 0.0.1-next.36
31
+ * @twin.org/api-models bumped from 0.0.1-next.35 to 0.0.1-next.36
32
+
33
+ ## [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)
34
+
35
+
36
+ ### Features
37
+
38
+ * update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/api-core bumped from 0.0.1-next.34 to 0.0.1-next.35
46
+ * @twin.org/api-models bumped from 0.0.1-next.34 to 0.0.1-next.35
47
+
48
+ ## [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)
49
+
50
+
51
+ ### Miscellaneous Chores
52
+
53
+ * **api-rest-client:** Synchronize repo versions
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/api-core bumped from 0.0.1-next.33 to 0.0.1-next.34
61
+ * @twin.org/api-models bumped from 0.0.1-next.33 to 0.0.1-next.34
62
+
63
+ ## [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)
64
+
65
+
66
+ ### Features
67
+
68
+ * use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/api-core bumped from 0.0.1-next.32 to 0.0.1-next.33
76
+ * @twin.org/api-models bumped from 0.0.1-next.32 to 0.0.1-next.33
77
+
78
+ ## [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)
79
+
80
+
81
+ ### Miscellaneous Chores
82
+
83
+ * **api-rest-client:** Synchronize repo versions
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/api-core bumped from 0.0.1-next.31 to 0.0.1-next.32
91
+ * @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
92
+
93
+ ## v0.0.1-next.31
4
94
 
5
95
  - Initial Release
package/docs/reference/classes/InformationClient.md CHANGED
@@ -12,21 +12,23 @@ The client to connect to the information service.
12
12
 
13
13
  ## Constructors
14
14
 
15
- ### new InformationClient()
15
+ ### Constructor
16
16
 
17
- > **new InformationClient**(`config`): [`InformationClient`](InformationClient.md)
17
+ > **new InformationClient**(`config`): `InformationClient`
18
18
 
19
19
  Create a new instance of InformationClient.
20
20
 
21
21
  #### Parameters
22
22
 
23
- • **config**: `IBaseRestClientConfig`
23
+ ##### config
24
+
25
+ `IBaseRestClientConfig`
24
26
 
25
27
  The configuration for the client.
26
28
 
27
29
  #### Returns
28
30
 
29
- [`InformationClient`](InformationClient.md)
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`?): `Promise`\<`void`\>
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
- • **name**: `string`
113
+ ##### name
114
+
115
+ `string`
112
116
 
113
117
  The component name.
114
118
 
115
- • **status**: `HealthStatus`
119
+ ##### status
120
+
121
+ `HealthStatus`
116
122
 
117
123
  The status of the component.
118
124
 
119
- • **details?**: `string`
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
- • **name**: `string`
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.1-next.8",
3
+ "version": "0.0.1",
4
4
  "description": "Information contract implementation which can connect to REST endpoints",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,20 +14,20 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-core": "0.0.1-next.8",
18
- "@twin.org/api-models": "0.0.1-next.8",
19
- "@twin.org/core": "next",
20
- "@twin.org/nameof": "next",
21
- "@twin.org/web": "next"
17
+ "@twin.org/api-core": "^0.0.1",
18
+ "@twin.org/api-models": "^0.0.1",
19
+ "@twin.org/core": "^0.0.1",
20
+ "@twin.org/nameof": "^0.0.1",
21
+ "@twin.org/web": "^0.0.1"
22
22
  },
23
23
  "main": "./dist/cjs/index.cjs",
24
24
  "module": "./dist/esm/index.mjs",
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": [