@twin.org/api-models 0.0.3-next.29 → 0.0.3-next.30

package/docs/reference/interfaces/IHostingComponent.md

@@ -71,211 +71,3 @@ The url to build upon the public origin.
 `Promise`\<`string`\>
 
 The full url based on the public origin.
-
-***
-
-### 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`](IHttpRequestQuery.md)
-
-The key/value pairs to encrypt and append.
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The URL with the encrypted parameters added.
-
-***
-
-### getDecryptedParamsFromQueryParams() {#getdecryptedparamsfromqueryparams}
-
-> **getDecryptedParamsFromQueryParams**(`queryParams`, `keys`): `Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
-
-Decrypt specified keys from a query parameter object and return their plain-text values.
-
-#### Parameters
-
-##### queryParams
-
-[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
-
-The HTTP request query containing the encrypted parameters.
-
-##### keys
-
-`string`[]
-
-The keys to decrypt.
-
-#### Returns
-
-`Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
-
-A map of the decrypted key/value pairs that were present.
-
-***
-
-### 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.
-
-***
-
-### getTenantTokenFromQueryParams() {#gettenanttokenfromqueryparams}
-
-> **getTenantTokenFromQueryParams**(`queryParams`): `Promise`\<`string` \| `undefined`\>
-
-Get the tenant token from the query parameters.
-
-#### Parameters
-
-##### queryParams
-
-[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
-
-The HTTP request query containing the parameters.
-
-#### Returns
-
-`Promise`\<`string` \| `undefined`\>
-
-The tenant token if it exists.
-
-***
-
-### encryptQueryParams() {#encryptqueryparams}
-
-> **encryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
-
-Encrypt query parameters using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### httpRequestQuery
-
-[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `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.
-
-***
-
-### decryptQueryParams() {#decryptqueryparams}
-
-> **decryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
-
-Decrypt query parameters using the hosting component's encryption mechanism.
-
-#### Parameters
-
-##### httpRequestQuery
-
-[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `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.
-
-***
-
-### 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.
-
-***
-
-### 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.

package/docs/reference/interfaces/IInformationComponent.md

@@ -66,94 +66,26 @@ 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.
+The livez status of the server.
 
 ***
 
-### health() {#health}
+### readyz() {#readyz}
 
-> **health**(): `Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-Get the server health.
+Is the server ready.
 
 #### Returns
 
-`Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-The service health.
-
-***
-
-### setComponentHealth() {#setcomponenthealth}
-
-> **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
-
-Set the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### status
-
-[`HealthStatus`](../type-aliases/HealthStatus.md)
-
-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.
-
-***
-
-### 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.
+The readyz status of the server.

package/docs/reference/interfaces/IServerHealthResponse.md

@@ -6,6 +6,14 @@ The health of the server.
 
 ### body {#body}
 
-> **body**: [`IHealthInfo`](IHealthInfo.md)
+> **body**: `object`
 
-The information for the server.
+The health for the server.
+
+#### status
+
+> **status**: `HealthStatus`
+
+#### components
+
+> **components**: `IHealth`[]

package/docs/reference/interfaces/IServerLivezResponse.md

@@ -18,6 +18,6 @@ The headers for the response.
 
 ### body {#body}
 
-> **body**: `"ok"` \| `"failed"`
+> **body**: `"alive"` \| `"dead"`
 
 The livez information for the server.

package/docs/reference/interfaces/IServerReadyzResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerReadyzResponse
+
+The readyz of the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `"ready"` \| `"not ready"`
+
+The readyz information for the server.

package/docs/reference/interfaces/IUrlTransformerComponent.md

@@ -0,0 +1,229 @@
+# Interface: IUrlTransformerComponent
+
+The URL transformer component for encrypting and decrypting URL parameters.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### addEncryptedQueryParamToUrl() {#addencryptedqueryparamtourl}
+
+> **addEncryptedQueryParamToUrl**(`url`, `id`, `value`): `Promise`\<`string`\>
+
+Encrypt a named token value and append it as a query parameter to the given URL.
+The URL param name is resolved from the configured token name dictionary using the id.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to append the encrypted token to.
+
+##### id
+
+`string`
+
+The logical token identifier (e.g. "tenant").
+
+##### value
+
+`string`
+
+The value to encrypt and add.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The URL with the encrypted token added as a query parameter.
+
+***
+
+### getEncryptedQueryParam() {#getencryptedqueryparam}
+
+> **getEncryptedQueryParam**(`queryParams`, `id`): `Promise`\<`string` \| `undefined`\>
+
+Get a named token value from the query parameters.
+The URL param name is resolved from the configured token name dictionary using the id.
+
+#### Parameters
+
+##### queryParams
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the parameters.
+
+##### id
+
+`string`
+
+The logical token identifier (e.g. "tenant").
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The decrypted token value if it exists.
+
+***
+
+### 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`](IHttpRequestQuery.md)
+
+The key/value pairs to encrypt and append.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The URL with the encrypted parameters added.
+
+***
+
+### getDecryptedParamsFromQueryParams() {#getdecryptedparamsfromqueryparams}
+
+> **getDecryptedParamsFromQueryParams**(`queryParams`, `keys`): `Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
+
+Decrypt specified keys from a query parameter object and return their plain-text values.
+
+#### Parameters
+
+##### queryParams
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `undefined`
+
+The HTTP request query containing the encrypted parameters.
+
+##### keys
+
+`string`[]
+
+The keys to decrypt.
+
+#### Returns
+
+`Promise`\<[`IHttpRequestQuery`](IHttpRequestQuery.md)\>
+
+A map of the decrypted key/value pairs that were present.
+
+***
+
+### encryptQueryParams() {#encryptqueryparams}
+
+> **encryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Encrypt query parameters using the URL transformer's encryption mechanism.
+
+#### Parameters
+
+##### httpRequestQuery
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `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.
+
+***
+
+### decryptQueryParams() {#decryptqueryparams}
+
+> **decryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Decrypt query parameters using the URL transformer's encryption mechanism.
+
+#### Parameters
+
+##### httpRequestQuery
+
+[`IHttpRequestQuery`](IHttpRequestQuery.md) \| `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.
+
+***
+
+### encryptParam() {#encryptparam}
+
+> **encryptParam**(`paramValue`): `Promise`\<`string`\>
+
+Encrypt a parameter value.
+
+#### Parameters
+
+##### paramValue
+
+`string`
+
+The value of the parameter to encrypt.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the encrypted value of the parameter.
+
+***
+
+### decryptParam() {#decryptparam}
+
+> **decryptParam**(`encryptedValue`): `Promise`\<`string`\>
+
+Decrypt a parameter value.
+
+#### Parameters
+
+##### encryptedValue
+
+`string`
+
+The encrypted value of the parameter.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the decrypted value of the parameter.

package/docs/reference/interfaces/IWebServer.md

@@ -2,6 +2,10 @@
 
 Interface describing a web server.
 
+## Extends
+
+- `IComponent`
+
 ## Type Parameters
 
 ### T
@@ -82,6 +86,10 @@ Start the server.
 
 Nothing.
 
+#### Overrides
+
+`IComponent.start`
+
 ***
 
 ### stop() {#stop}
@@ -95,3 +103,25 @@ Stop the server.
 `Promise`\<`void`\>
 
 Nothing.
+
+#### Overrides
+
+`IComponent.stop`
+
+***
+
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Returns the health status of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health status of the component, can return multiple entries for elements within the component.
+
+#### Overrides
+
+`IComponent.health`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.3-next.29",
+	"version": "0.0.3-next.30",
 	"description": "Shared API contracts, route types, and response models used across services and clients.",
 	"repository": {
 		"type": "git",

package/dist/es/models/services/IHealthComponentInfo.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IHealthComponentInfo.js.map

package/dist/es/models/services/IHealthComponentInfo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHealthComponentInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IHealthComponentInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * The health component information.\n */\nexport interface IHealthComponentInfo {\n\t/**\n\t * The name of the component.\n\t */\n\tname: string;\n\n\t/**\n\t * The status of the component.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The details for the status.\n\t */\n\tdetails?: string;\n}\n"]}

package/dist/es/models/services/IHealthInfo.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IHealthInfo.js.map

package/dist/es/models/services/IHealthInfo.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHealthInfo.js","sourceRoot":"","sources":["../../../../src/models/services/IHealthInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\nimport type { IHealthComponentInfo } from \"./IHealthComponentInfo.js\";\n\n/**\n * The status of the server.\n */\nexport interface IHealthInfo {\n\t/**\n\t * The status.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The status of the components.\n\t */\n\tcomponents?: IHealthComponentInfo[];\n}\n"]}

package/dist/es/models/services/healthStatus.js

@@ -1,21 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The health status of the component.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const HealthStatus = {
-    /**
-     * OK.
-     */
-    Ok: "ok",
-    /**
-     * Warning.
-     */
-    Warning: "warning",
-    /**
-     * Error.
-     */
-    Error: "error"
-};
-//# sourceMappingURL=healthStatus.js.map

package/dist/es/models/services/healthStatus.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"healthStatus.js","sourceRoot":"","sources":["../../../../src/models/services/healthStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The health status of the component.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthStatus = {\n\t/**\n\t * OK.\n\t */\n\tOk: \"ok\",\n\n\t/**\n\t * Warning.\n\t */\n\tWarning: \"warning\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\"\n} as const;\n\n/**\n * The health status of the component.\n */\nexport type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];\n"]}

package/dist/types/models/services/IHealthComponentInfo.d.ts

@@ -1,18 +0,0 @@
-import type { HealthStatus } from "./healthStatus.js";
-/**
- * The health component information.
- */
-export interface IHealthComponentInfo {
-    /**
-     * The name of the component.
-     */
-    name: string;
-    /**
-     * The status of the component.
-     */
-    status: HealthStatus;
-    /**
-     * The details for the status.
-     */
-    details?: string;
-}