@twin.org/api-rest-client 0.0.3-next.4 → 0.0.3-next.40

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/HealthRestClient.md

@@ -0,0 +1,145 @@
+# Class: HealthRestClient
+
+The client to connect to the health service.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IHealthComponent`
+
+## Constructors
+
+### Constructor
+
+> **new HealthRestClient**(`config`): `HealthRestClient`
+
+Create a new instance of HealthRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`HealthRestClient`
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### 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`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IHealthComponent.className`
+
+***
+
+### healthStatus() {#healthstatus}
+
+> **healthStatus**(): `Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+Get the server health.
+
+#### Returns
+
+`Promise`\<\{ `status`: `HealthStatus`; `components`: `IHealth`[]; \}\>
+
+The service health.
+
+#### Implementation of
+
+`IHealthComponent.healthStatus`

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,82 +200,36 @@ The OpenAPI spec.
 
 ***
 
-### health()
+### livez() {#livez}
 
-> **health**(): `Promise`\<`IHealthInfo`\>
+> **livez**(): `Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
-Get the server health.
+Is the server live.
 
 #### Returns
 
-`Promise`\<`IHealthInfo`\>
+`Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
-The service health.
+True if the server is live.
 
 #### Implementation of
 
-`IInformationComponent.health`
+`IInformationComponent.livez`
 
 ***
 
-### setComponentHealth()
-
-> **setComponentHealth**(`name`, `status`, `details?`): `Promise`\<`void`\>
-
-Set the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### status
-
-`HealthStatus`
-
-The status of the component.
-
-##### details?
-
-`string`
+### readyz() {#readyz}
 
-The details for the status.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IInformationComponent.setComponentHealth`
-
-***
-
-### removeComponentHealth()
-
-> **removeComponentHealth**(`name`): `Promise`\<`void`\>
-
-Remove the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-The component name.
+Is the server ready.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-Nothing.
+True if the server is ready.
 
 #### Implementation of
 
-`IInformationComponent.removeComponentHealth`
+`IInformationComponent.readyz`

package/docs/reference/index.md

@@ -2,4 +2,5 @@
 
 ## Classes
 
+- [HealthRestClient](classes/HealthRestClient.md)
 - [InformationRestClient](classes/InformationRestClient.md)

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-rest-client",
-	"version": "0.0.3-next.4",
-	"description": "Information contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.40",
+	"description": "REST client implementation for consuming information and hosting endpoints.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-rest-client"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-core": "0.0.3-next.4",
-		"@twin.org/api-models": "0.0.3-next.4",
+		"@twin.org/api-core": "0.0.3-next.40",
+		"@twin.org/api-models": "0.0.3-next.40",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
@@ -44,7 +44,7 @@
 		"api"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }