@twin.org/api-rest-client 0.0.2-next.10 → 0.0.2-next.12
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/dist/cjs/index.cjs +6 -6
- package/dist/esm/index.mjs +6 -6
- package/dist/types/index.d.ts +1 -1
- package/dist/types/{informationClient.d.ts → informationRestClient.d.ts} +2 -2
- package/docs/changelog.md +30 -0
- package/docs/reference/classes/{InformationClient.md → InformationRestClient.md} +4 -8
- package/docs/reference/index.md +1 -1
- package/package.json +16 -4
package/dist/cjs/index.cjs
CHANGED
|
@@ -8,17 +8,17 @@ var core = require('@twin.org/core');
|
|
|
8
8
|
/**
|
|
9
9
|
* The client to connect to the information service.
|
|
10
10
|
*/
|
|
11
|
-
class
|
|
11
|
+
class InformationRestClient extends apiCore.BaseRestClient {
|
|
12
12
|
/**
|
|
13
13
|
* Runtime name for the class.
|
|
14
14
|
*/
|
|
15
|
-
CLASS_NAME = "
|
|
15
|
+
static CLASS_NAME = "InformationRestClient";
|
|
16
16
|
/**
|
|
17
17
|
* Create a new instance of InformationClient.
|
|
18
18
|
* @param config The configuration for the client.
|
|
19
19
|
*/
|
|
20
20
|
constructor(config) {
|
|
21
|
-
super("
|
|
21
|
+
super("InformationRestClient", config, "");
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
24
|
* Get the server root.
|
|
@@ -68,7 +68,7 @@ class InformationClient extends apiCore.BaseRestClient {
|
|
|
68
68
|
* @returns Nothing.
|
|
69
69
|
*/
|
|
70
70
|
async setComponentHealth(name, status, details) {
|
|
71
|
-
throw new core.NotSupportedError(
|
|
71
|
+
throw new core.NotSupportedError(InformationRestClient.CLASS_NAME, "\"setComponentHealth\"");
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* Remove the status of a component.
|
|
@@ -76,8 +76,8 @@ class InformationClient extends apiCore.BaseRestClient {
|
|
|
76
76
|
* @returns Nothing.
|
|
77
77
|
*/
|
|
78
78
|
async removeComponentHealth(name) {
|
|
79
|
-
throw new core.NotSupportedError(
|
|
79
|
+
throw new core.NotSupportedError(InformationRestClient.CLASS_NAME, "\"removeComponentHealth\"");
|
|
80
80
|
}
|
|
81
81
|
}
|
|
82
82
|
|
|
83
|
-
exports.
|
|
83
|
+
exports.InformationRestClient = InformationRestClient;
|
package/dist/esm/index.mjs
CHANGED
|
@@ -6,17 +6,17 @@ import { NotSupportedError } from '@twin.org/core';
|
|
|
6
6
|
/**
|
|
7
7
|
* The client to connect to the information service.
|
|
8
8
|
*/
|
|
9
|
-
class
|
|
9
|
+
class InformationRestClient extends BaseRestClient {
|
|
10
10
|
/**
|
|
11
11
|
* Runtime name for the class.
|
|
12
12
|
*/
|
|
13
|
-
CLASS_NAME = "
|
|
13
|
+
static CLASS_NAME = "InformationRestClient";
|
|
14
14
|
/**
|
|
15
15
|
* Create a new instance of InformationClient.
|
|
16
16
|
* @param config The configuration for the client.
|
|
17
17
|
*/
|
|
18
18
|
constructor(config) {
|
|
19
|
-
super("
|
|
19
|
+
super("InformationRestClient", config, "");
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
22
|
* Get the server root.
|
|
@@ -66,7 +66,7 @@ class InformationClient extends BaseRestClient {
|
|
|
66
66
|
* @returns Nothing.
|
|
67
67
|
*/
|
|
68
68
|
async setComponentHealth(name, status, details) {
|
|
69
|
-
throw new NotSupportedError(
|
|
69
|
+
throw new NotSupportedError(InformationRestClient.CLASS_NAME, "\"setComponentHealth\"");
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
72
|
* Remove the status of a component.
|
|
@@ -74,8 +74,8 @@ class InformationClient extends BaseRestClient {
|
|
|
74
74
|
* @returns Nothing.
|
|
75
75
|
*/
|
|
76
76
|
async removeComponentHealth(name) {
|
|
77
|
-
throw new NotSupportedError(
|
|
77
|
+
throw new NotSupportedError(InformationRestClient.CLASS_NAME, "\"removeComponentHealth\"");
|
|
78
78
|
}
|
|
79
79
|
}
|
|
80
80
|
|
|
81
|
-
export {
|
|
81
|
+
export { InformationRestClient };
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from "./
|
|
1
|
+
export * from "./informationRestClient";
|
|
@@ -3,11 +3,11 @@ import type { HealthStatus, IBaseRestClientConfig, IHealthInfo, IInformationComp
|
|
|
3
3
|
/**
|
|
4
4
|
* The client to connect to the information service.
|
|
5
5
|
*/
|
|
6
|
-
export declare class
|
|
6
|
+
export declare class InformationRestClient extends BaseRestClient implements IInformationComponent {
|
|
7
7
|
/**
|
|
8
8
|
* Runtime name for the class.
|
|
9
9
|
*/
|
|
10
|
-
readonly CLASS_NAME: string;
|
|
10
|
+
static readonly CLASS_NAME: string;
|
|
11
11
|
/**
|
|
12
12
|
* Create a new instance of InformationClient.
|
|
13
13
|
* @param config The configuration for the client.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @twin.org/api-rest-client - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.11...api-rest-client-v0.0.2-next.12) (2025-10-09)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/api-core bumped from 0.0.2-next.11 to 0.0.2-next.12
|
|
16
|
+
* @twin.org/api-models bumped from 0.0.2-next.11 to 0.0.2-next.12
|
|
17
|
+
|
|
18
|
+
## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.10...api-rest-client-v0.0.2-next.11) (2025-09-29)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/api-core bumped from 0.0.2-next.10 to 0.0.2-next.11
|
|
31
|
+
* @twin.org/api-models bumped from 0.0.2-next.10 to 0.0.2-next.11
|
|
32
|
+
|
|
3
33
|
## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.2-next.9...api-rest-client-v0.0.2-next.10) (2025-09-23)
|
|
4
34
|
|
|
5
35
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Class:
|
|
1
|
+
# Class: InformationRestClient
|
|
2
2
|
|
|
3
3
|
The client to connect to the information service.
|
|
4
4
|
|
|
@@ -14,7 +14,7 @@ The client to connect to the information service.
|
|
|
14
14
|
|
|
15
15
|
### Constructor
|
|
16
16
|
|
|
17
|
-
> **new
|
|
17
|
+
> **new InformationRestClient**(`config`): `InformationRestClient`
|
|
18
18
|
|
|
19
19
|
Create a new instance of InformationClient.
|
|
20
20
|
|
|
@@ -28,7 +28,7 @@ The configuration for the client.
|
|
|
28
28
|
|
|
29
29
|
#### Returns
|
|
30
30
|
|
|
31
|
-
`
|
|
31
|
+
`InformationRestClient`
|
|
32
32
|
|
|
33
33
|
#### Overrides
|
|
34
34
|
|
|
@@ -38,14 +38,10 @@ The configuration for the client.
|
|
|
38
38
|
|
|
39
39
|
### CLASS\_NAME
|
|
40
40
|
|
|
41
|
-
> `readonly` **CLASS\_NAME**: `string`
|
|
41
|
+
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
42
42
|
|
|
43
43
|
Runtime name for the class.
|
|
44
44
|
|
|
45
|
-
#### Implementation of
|
|
46
|
-
|
|
47
|
-
`IInformationComponent.CLASS_NAME`
|
|
48
|
-
|
|
49
45
|
## Methods
|
|
50
46
|
|
|
51
47
|
### root()
|
package/docs/reference/index.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/api-rest-client",
|
|
3
|
-
"version": "0.0.2-next.
|
|
3
|
+
"version": "0.0.2-next.12",
|
|
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.2-next.
|
|
18
|
-
"@twin.org/api-models": "0.0.2-next.
|
|
17
|
+
"@twin.org/api-core": "0.0.2-next.12",
|
|
18
|
+
"@twin.org/api-models": "0.0.2-next.12",
|
|
19
19
|
"@twin.org/core": "next",
|
|
20
20
|
"@twin.org/nameof": "next",
|
|
21
21
|
"@twin.org/web": "next"
|
|
@@ -36,5 +36,17 @@
|
|
|
36
36
|
"dist/types",
|
|
37
37
|
"locales",
|
|
38
38
|
"docs"
|
|
39
|
-
]
|
|
39
|
+
],
|
|
40
|
+
"keywords": [
|
|
41
|
+
"twin",
|
|
42
|
+
"trade",
|
|
43
|
+
"iota",
|
|
44
|
+
"framework",
|
|
45
|
+
"blockchain",
|
|
46
|
+
"api"
|
|
47
|
+
],
|
|
48
|
+
"bugs": {
|
|
49
|
+
"url": "git+https://github.com/twinfoundation/api/issues"
|
|
50
|
+
},
|
|
51
|
+
"homepage": "https://twindev.org"
|
|
40
52
|
}
|