@twin.org/api-rest-client 0.0.3-next.20 → 0.0.3-next.22

package/README.md

@@ -1,6 +1,6 @@
 # TWIN API REST Client
 
-Information contract implementation which can connect to REST endpoints.
+This package provides a REST client implementation for consuming information and hosting endpoints.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,34 @@
-# @twin.org/api-rest-client - Changelog
+# Changelog
+
+## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.3-next.21...api-rest-client-v0.0.3-next.22) (2026-03-27)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.3-next.20...api-rest-client-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.3-next.20 to 0.0.3-next.21
+    * @twin.org/api-models bumped from 0.0.3-next.20 to 0.0.3-next.21
 
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-rest-client-v0.0.3-next.19...api-rest-client-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,64 @@
-# @twin.org/api-rest-client - Examples
+# Rest Client Examples
+
+Use these snippets to call health, metadata, and specification endpoints from operational tools and integration tests.
+
+## InformationRestClient
+
+```typescript
+import { InformationRestClient } from '@twin.org/api-rest-client';
+
+const client = new InformationRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1'
+});
+
+console.log(client.className()); // InformationRestClient
+
+const root = await client.root();
+const info = await client.info();
+const icon = await client.favicon();
+
+console.log(root); // twin-api - 1.2.0
+console.log(info.version); // 1.2.0
+console.log((icon?.byteLength ?? 0) > 0); // true
+```
+
+```typescript
+import { InformationRestClient } from '@twin.org/api-rest-client';
+
+const client = new InformationRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1'
+});
+
+const openApi = await client.spec();
+const live = await client.livez();
+const health = await client.health();
+
+console.log(typeof openApi); // object
+console.log(live); // true
+console.log(health.status); // ok
+```
+
+```typescript
+import { InformationRestClient } from '@twin.org/api-rest-client';
+
+const client = new InformationRestClient({
+  endpoint: 'https://api.example.org',
+  pathPrefix: 'v1'
+});
+
+try {
+  await client.setComponentHealth('database', 'ok');
+} catch (err) {
+  const errorName = err instanceof Error ? err.name : 'Error';
+  console.log(errorName); // NotSupportedError
+}
+
+try {
+  await client.removeComponentHealth('database');
+} catch (err) {
+  const errorName = err instanceof Error ? err.name : 'Error';
+  console.log(errorName); // NotSupportedError
+}
+```

package/docs/reference/classes/InformationRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,73 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### getEndpointWithPrefix() {#getendpointwithprefix}
+
+> **getEndpointWithPrefix**(): `string`
+
+Get the endpoint with the prefix for the namespace.
+
+#### Returns
+
+`string`
+
+The endpoint with namespace prefix attached.
+
+#### Inherited from
+
+`BaseRestClient.getEndpointWithPrefix`
+
+***
+
+### fetch() {#fetch}
+
+> **fetch**\<`T`, `U`\>(`route`, `method`, `request?`): `Promise`\<`U`\>
+
+Perform a request in json format.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `IHttpRequest`\<`any`\>
+
+##### U
+
+`U` *extends* `IHttpResponse`\<`any`\>
+
+#### Parameters
+
+##### route
+
+`string`
+
+The route of the request.
+
+##### method
+
+`HttpMethod`
+
+The http method.
+
+##### request?
+
+`T`
+
+Request to send to the endpoint.
+
+#### Returns
+
+`Promise`\<`U`\>
+
+The response.
+
+#### Inherited from
+
+`BaseRestClient.fetch`
+
+***
+
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +128,7 @@ The class name of the component.
 
 ***
 
-### root()
+### root() {#root}
 
 > **root**(): `Promise`\<`string`\>
 
@@ -80,7 +146,7 @@ The root root.
 
 ***
 
-### info()
+### info() {#info}
 
 > **info**(): `Promise`\<`IServerInfo`\>
 
@@ -98,7 +164,7 @@ The service information.
 
 ***
 
-### favicon()
+### favicon() {#favicon}
 
 > **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
@@ -116,7 +182,7 @@ The favicon.
 
 ***
 
-### spec()
+### spec() {#spec}
 
 > **spec**(): `Promise`\<`unknown`\>
 
@@ -134,7 +200,7 @@ The OpenAPI spec.
 
 ***
 
-### livez()
+### livez() {#livez}
 
 > **livez**(): `Promise`\<`boolean`\>
 
@@ -152,7 +218,7 @@ True if the server is live.
 
 ***
 
-### health()
+### health() {#health}
 
 > **health**(): `Promise`\<`IHealthInfo`\>
 
@@ -170,7 +236,7 @@ The service health.
 
 ***
 
-### setComponentHealth()
+### setComponentHealth() {#setcomponenthealth}
 
 > **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
 
@@ -208,7 +274,7 @@ Nothing.
 
 ***
 
-### removeComponentHealth()
+### removeComponentHealth() {#removecomponenthealth}
 
 > **removeComponentHealth**(`name`): `Promise`\<`void`\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-rest-client",
-	"version": "0.0.3-next.20",
-	"description": "Information contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.22",
+	"description": "REST client implementation for consuming information and hosting endpoints.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-core": "0.0.3-next.20",
-		"@twin.org/api-models": "0.0.3-next.20",
+		"@twin.org/api-core": "0.0.3-next.22",
+		"@twin.org/api-models": "0.0.3-next.22",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"