@twin.org/api-service 0.0.3-next.28 → 0.0.3-next.30

package/dist/types/models/IHealthServiceConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Configuration for the health service.
+ */
+export interface IHealthServiceConfig {
+    /**
+     * The interval for checking the health of the components and setting it in the health service.
+     * @default 30000
+     */
+    healthCheckInterval?: number;
+}

package/dist/types/models/IHealthServiceConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IHealthServiceConfig } from "./IHealthServiceConfig.js";
+/**
+ * Options for the HealthService constructor.
+ */
+export interface IHealthServiceConstructorOptions {
+    /**
+     * The configuration for the service.
+     */
+    config?: IHealthServiceConfig;
+}

package/dist/types/models/IHostingServiceConstructorOptions.d.ts

@@ -1,6 +1,6 @@
 import type { IHostingServiceConfig } from "./IHostingServiceConfig.js";
 /**
- * Options for the IHostingService constructor.
+ * Options for the HostingService constructor.
  */
 export interface IHostingServiceConstructorOptions {
     /**

package/dist/types/models/IUrlTransformerServiceConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Configuration for the URL transformer service.
+ */
+export interface IUrlTransformerServiceConfig {
+    /**
+     * The name of the key to retrieve from the vault for encryption/decryption of parameters.
+     * @default param-encryption
+     */
+    paramEncryptionKeyName?: string;
+    /**
+     * A dictionary mapping logical token identifiers to their URL query parameter names.
+     * For example: { "tenant": "tenant-token" } maps the logical id "tenant" to the
+     * query param "tenant-token". When an id is not present the id itself is used as
+     * the param name.
+     */
+    queryParamNames?: {
+        [id: string]: string;
+    };
+}

package/dist/types/models/IUrlTransformerServiceConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+import type { IUrlTransformerServiceConfig } from "./IUrlTransformerServiceConfig.js";
+/**
+ * Options for the UrlTransformerService constructor.
+ */
+export interface IUrlTransformerServiceConstructorOptions {
+    /**
+     * The vault connector type.
+     * @default vault
+     */
+    vaultConnectorType?: string;
+    /**
+     * The configuration for the service.
+     */
+    config?: IUrlTransformerServiceConfig;
+}

package/dist/types/urlTransformerService.d.ts

@@ -0,0 +1,81 @@
+import type { IHttpRequestQuery, IUrlTransformerComponent } from "@twin.org/api-models";
+import type { IUrlTransformerServiceConstructorOptions } from "./models/IUrlTransformerServiceConstructorOptions.js";
+/**
+ * The URL transformer service for encrypting and decrypting URL parameters.
+ */
+export declare class UrlTransformerService implements IUrlTransformerComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of UrlTransformerService.
+     * @param options The options to create the service.
+     */
+    constructor(options?: IUrlTransformerServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * The component needs to be started when the node is initialized.
+     * @returns Nothing.
+     */
+    start(): Promise<void>;
+    /**
+     * Encrypt a named token value and append it as a query parameter to the given URL.
+     * @param url The URL to append the encrypted token to.
+     * @param id The logical token identifier (e.g. "tenant").
+     * @param value The value to encrypt and add.
+     * @returns The URL with the encrypted token added as a query parameter.
+     */
+    addEncryptedQueryParamToUrl(url: string, id: string, value: string): Promise<string>;
+    /**
+     * Get a named token value from the query parameters.
+     * @param queryParams The HTTP request query containing the parameters.
+     * @param id The logical token identifier (e.g. "tenant").
+     * @returns The decrypted token value if it exists.
+     */
+    getEncryptedQueryParam(queryParams: IHttpRequestQuery | undefined, id: string): Promise<string | undefined>;
+    /**
+     * Add encrypted key/value pairs to a URL's query string.
+     * @param url The base URL to add parameters to.
+     * @param params The key/value pairs to encrypt and append.
+     * @returns The URL with the encrypted parameters added.
+     */
+    addEncryptedParamsToUrl(url: string, params: IHttpRequestQuery): Promise<string>;
+    /**
+     * Decrypt specified keys from a query parameter object and return their plain-text values.
+     * @param queryParams The HTTP request query containing the encrypted parameters.
+     * @param keys The keys to decrypt.
+     * @returns A map of the decrypted key/value pairs that were present.
+     */
+    getDecryptedParamsFromQueryParams(queryParams: IHttpRequestQuery | undefined, keys: string[]): Promise<IHttpRequestQuery>;
+    /**
+     * Encrypt query parameters.
+     * @param httpRequestQuery The HTTP request query containing the parameters to encrypt.
+     * @param keys The keys of the parameters to encrypt.
+     * @returns A promise that resolves when the query parameters have been encrypted.
+     */
+    encryptQueryParams(httpRequestQuery: IHttpRequestQuery | undefined, keys: string[]): Promise<void>;
+    /**
+     * Decrypt query parameters.
+     * @param httpRequestQuery The HTTP request query containing the encrypted values.
+     * @param keys The keys of the parameters to decrypt.
+     * @returns A promise that resolves when the query parameters have been decrypted.
+     */
+    decryptQueryParams(httpRequestQuery: IHttpRequestQuery | undefined, keys: string[]): Promise<void>;
+    /**
+     * Encrypt a parameter value.
+     * @param paramValue The value of the parameter to encrypt.
+     * @returns A promise that resolves to the encrypted value of the parameter.
+     */
+    encryptParam(paramValue: string): Promise<string>;
+    /**
+     * Decrypt a parameter value.
+     * @param encryptedValue The encrypted value of the parameter.
+     * @returns A promise that resolves to the decrypted value of the parameter.
+     */
+    decryptParam(encryptedValue: string): Promise<string>;
+}

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* hosting service ([#109](https://github.com/twinfoundation/twin-api/issues/109)) ([985bf1f](https://github.com/twinfoundation/twin-api/commit/985bf1f5c07b09ecb800df7120bc2422ac7a6d25))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-models bumped from 0.0.3-next.28 to 0.0.3-next.29
+
 ## [0.0.3-next.28](https://github.com/twinfoundation/twin-api/compare/api-service-v0.0.3-next.27...api-service-v0.0.3-next.28) (2026-04-30)
 
 

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/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`