@twin.org/api-service 0.0.3-next.29 → 0.0.3-next.31

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.0.3-next.31](https://github.com/twinfoundation/twin-api/compare/api-service-v0.0.3-next.30...api-service-v0.0.3-next.31) (2026-05-06)
+
+
+### Features
+
+* update health format ([cfbfbbb](https://github.com/twinfoundation/twin-api/commit/cfbfbbb2e9afbd2574ffd2446ad51e4217437951))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.30 to 0.0.3-next.31
+
+## [0.0.3-next.30](https://github.com/twinfoundation/twin-api/compare/api-service-v0.0.3-next.29...api-service-v0.0.3-next.30) (2026-05-05)
+
+
+### Features
+
+* separate service responsibilities ([#116](https://github.com/twinfoundation/twin-api/issues/116)) ([2234648](https://github.com/twinfoundation/twin-api/commit/2234648de4a2de5b7356aadde328f40470bc12e3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.29 to 0.0.3-next.30
+
 ## [0.0.3-next.29](https://github.com/twinfoundation/twin-api/compare/api-service-v0.0.3-next.28...api-service-v0.0.3-next.29) (2026-05-01)
 
 

package/docs/reference/classes/HealthService.md

@@ -0,0 +1,123 @@
+# Class: HealthService
+
+The health service for the server.
+
+## Implements
+
+- `IHealthComponent`
+
+## Constructors
+
+### Constructor
+
+> **new HealthService**(`options?`): `HealthService`
+
+Create a new instance of HealthService.
+
+#### Parameters
+
+##### options?
+
+[`IHealthServiceConstructorOptions`](../interfaces/IHealthServiceConstructorOptions.md)
+
+The constructor options.
+
+#### Returns
+
+`HealthService`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IHealthComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IHealthComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IHealthComponent.stop`
+
+***
+
+### 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/HostingService.md

@@ -54,32 +54,6 @@ The class name of the component.
 
 ***
 
-### start() {#start}
-
-> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
-
-The component needs to be started when the node is initialized.
-
-#### Parameters
-
-##### nodeLoggingComponentType?
-
-`string`
-
-The node logging component type.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IHostingComponent.start`
-
-***
-
 ### getPublicOrigin() {#getpublicorigin}
 
 > **getPublicOrigin**(`serverRequestUrl?`): `Promise`\<`string`\>
@@ -155,243 +129,3 @@ The full url based on the public origin.
 #### Implementation of
 
 `IHostingComponent.buildPublicUrl`
-
-***
-
-### addEncryptedParamsToUrl() {#addencryptedparamstourl}
-
-> **addEncryptedParamsToUrl**(`url`, `params`): `Promise`\<`string`\>
-
-Add encrypted key/value pairs to a URL's query string.
-Existing query parameters on the URL are preserved; the provided params are
-merged in and then encrypted before being written back to the URL.
-
-#### Parameters
-
-##### url
-
-`string`
-
-The base URL to add parameters to.
-
-##### params
-
-`IHttpRequestQuery`
-
-The key/value pairs to encrypt and append.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The URL with the encrypted parameters added.
-
-#### Implementation of
-
-`IHostingComponent.addEncryptedParamsToUrl`
-
-***
-
-### getDecryptedParamsFromQueryParams() {#getdecryptedparamsfromqueryparams}
-
-> **getDecryptedParamsFromQueryParams**(`queryParams`, `keys`): `Promise`\<`IHttpRequestQuery`\>
-
-Decrypt specified keys from a query parameter object and return their plain-text values.
-
-#### Parameters
-
-##### queryParams
-
-`IHttpRequestQuery` \| `undefined`
-
-The HTTP request query containing the encrypted parameters.
-
-##### keys
-
-`string`[]
-
-The keys to decrypt.
-
-#### Returns
-
-`Promise`\<`IHttpRequestQuery`\>
-
-A map of the decrypted key/value pairs that were present.
-
-#### Implementation of
-
-`IHostingComponent.getDecryptedParamsFromQueryParams`
-
-***
-
-### addTenantTokenToUrl() {#addtenanttokentourl}
-
-> **addTenantTokenToUrl**(`url`, `tenantId`): `Promise`\<`string`\>
-
-Encrypt the tenant id and append it as a query parameter to the given URL.
-
-#### Parameters
-
-##### url
-
-`string`
-
-The URL to append the encrypted tenant token to.
-
-##### tenantId
-
-`string`
-
-The tenant identifier to encrypt and add.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The URL with the encrypted tenant token added as a query parameter.
-
-#### Implementation of
-
-`IHostingComponent.addTenantTokenToUrl`
-
-***
-
-### getTenantTokenFromQueryParams() {#gettenanttokenfromqueryparams}
-
-> **getTenantTokenFromQueryParams**(`queryParams`): `Promise`\<`string` \| `undefined`\>
-
-Get the tenant token from the query parameters.
-
-#### Parameters
-
-##### queryParams
-
-`IHttpRequestQuery` \| `undefined`
-
-The HTTP request query containing the parameters.
-
-#### Returns
-
-`Promise`\<`string` \| `undefined`\>
-
-The tenant token if it exists.
-
-#### Implementation of
-
-`IHostingComponent.getTenantTokenFromQueryParams`
-
-***
-
-### encryptQueryParams() {#encryptqueryparams}
-
-> **encryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
-
-Encrypt query parameters using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### httpRequestQuery
-
-`IHttpRequestQuery` \| `undefined`
-
-The HTTP request query containing the parameters to encrypt.
-
-##### keys
-
-`string`[]
-
-The keys of the parameters to encrypt.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the query parameters have been encrypted.
-
-#### Implementation of
-
-`IHostingComponent.encryptQueryParams`
-
-***
-
-### decryptQueryParams() {#decryptqueryparams}
-
-> **decryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
-
-Decrypt query parameters using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### httpRequestQuery
-
-`IHttpRequestQuery` \| `undefined`
-
-The HTTP request query containing the encrypted values.
-
-##### keys
-
-`string`[]
-
-The keys of the parameters to decrypt.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-A promise that resolves when the query parameters have been decrypted.
-
-#### Implementation of
-
-`IHostingComponent.decryptQueryParams`
-
-***
-
-### encryptParam() {#encryptparam}
-
-> **encryptParam**(`paramValue`): `Promise`\<`string`\>
-
-Encrypt a parameter value using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### paramValue
-
-`string`
-
-The value of the parameter to encrypt.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-A promise that resolves to the encrypted value of the parameter.
-
-#### Implementation of
-
-`IHostingComponent.encryptParam`
-
-***
-
-### decryptParam() {#decryptparam}
-
-> **decryptParam**(`encryptedValue`): `Promise`\<`string`\>
-
-Decrypt a parameter value using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### encryptedValue
-
-`string`
-
-The encrypted value of the parameter.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-A promise that resolves to the decrypted value of the parameter.
-
-#### Implementation of
-
-`IHostingComponent.decryptParam`

package/docs/reference/classes/InformationService.md

@@ -146,13 +146,13 @@ The OpenAPI spec.
 
 ### livez() {#livez}
 
-> **livez**(): `Promise`\<`boolean`\>
+> **livez**(): `Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
 Is the server live.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
 True if the server is live.
 
@@ -162,94 +162,18 @@ True if the server is live.
 
 ***
 
-### health() {#health}
+### readyz() {#readyz}
 
-> **health**(): `Promise`\<`IHealthInfo`\>
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-Get the server health.
+Is the server ready.
 
 #### Returns
 
-`Promise`\<`IHealthInfo`\>
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-The service health.
+The readyz status of the server.
 
 #### Implementation of
 
-`IInformationComponent.health`
-
-***
-
-### setComponentHealth() {#setcomponenthealth}
-
-> **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
-
-Set the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### status
-
-`HealthStatus`
-
-The status of the component.
-
-##### details?
-
-`string`
-
-The details for the status.
-
-##### tenantId?
-
-`string`
-
-The tenant id, optional if the health status is not tenant specific.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IInformationComponent.setComponentHealth`
-
-***
-
-### removeComponentHealth() {#removecomponenthealth}
-
-> **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
-
-Remove the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### tenantId?
-
-`string`
-
-The tenant id, optional if the health status is not tenant specific.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-#### Implementation of
-
-`IInformationComponent.removeComponentHealth`
+`IInformationComponent.readyz`