@twin.org/api-service 0.0.3-next.4 → 0.0.3-next.41

package/docs/reference/classes/UrlTransformerService.md

@@ -0,0 +1,379 @@
+# Class: UrlTransformerService
+
+The URL transformer service for encrypting and decrypting URL parameters.
+
+## Implements
+
+- `IUrlTransformerComponent`
+
+## Constructors
+
+### Constructor
+
+> **new UrlTransformerService**(`options?`): `UrlTransformerService`
+
+Create a new instance of UrlTransformerService.
+
+#### Parameters
+
+##### options?
+
+[`IUrlTransformerServiceConstructorOptions`](../interfaces/IUrlTransformerServiceConstructorOptions.md)
+
+The options to create the service.
+
+#### Returns
+
+`UrlTransformerService`
+
+## 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
+
+`IUrlTransformerComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IUrlTransformerComponent.start`
+
+***
+
+### addEncryptedQueryParamToUrl() {#addencryptedqueryparamtourl}
+
+> **addEncryptedQueryParamToUrl**(`url`, `id`, `value`): `Promise`\<`string`\>
+
+Encrypt a named token value and append it as a query parameter to the given URL.
+
+#### 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.
+
+#### Implementation of
+
+`IUrlTransformerComponent.addEncryptedQueryParamToUrl`
+
+***
+
+### getEncryptedQueryParam() {#getencryptedqueryparam}
+
+> **getEncryptedQueryParam**(`queryParams`, `id`): `Promise`\<`string` \| `undefined`\>
+
+Get a named token value from the query parameters.
+
+#### Parameters
+
+##### queryParams
+
+`IHttpRequestQuery` \| `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.
+
+#### Implementation of
+
+`IUrlTransformerComponent.getEncryptedQueryParam`
+
+***
+
+### addEncryptedToUrl() {#addencryptedtourl}
+
+> **addEncryptedToUrl**(`url`, `params`): `Promise`\<`string`\>
+
+Add encrypted key/value pairs to a URL's query string.
+
+#### 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
+
+`IUrlTransformerComponent.addEncryptedToUrl`
+
+***
+
+### getEncryptedFromUrl() {#getencryptedfromurl}
+
+> **getEncryptedFromUrl**(`url`, `id`): `Promise`\<`string` \| `undefined`\>
+
+Get an encrypted value from a URL's query string.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to extract the encrypted value from.
+
+##### id
+
+`string`
+
+The logical identifier for the value to retrieve (e.g. "tenant").
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The decrypted value if it exists.
+
+#### Implementation of
+
+`IUrlTransformerComponent.getEncryptedFromUrl`
+
+***
+
+### getDecryptedFromQueryParams() {#getdecryptedfromqueryparams}
+
+> **getDecryptedFromQueryParams**(`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
+
+`IUrlTransformerComponent.getDecryptedFromQueryParams`
+
+***
+
+### encryptQueryParams() {#encryptqueryparams}
+
+> **encryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Encrypt query parameters.
+
+#### 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
+
+`IUrlTransformerComponent.encryptQueryParams`
+
+***
+
+### decryptQueryParams() {#decryptqueryparams}
+
+> **decryptQueryParams**(`httpRequestQuery`, `keys`): `Promise`\<`void`\>
+
+Decrypt query parameters.
+
+#### 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
+
+`IUrlTransformerComponent.decryptQueryParams`
+
+***
+
+### 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.
+
+#### Implementation of
+
+`IUrlTransformerComponent.encryptParam`
+
+***
+
+### 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.
+
+#### Implementation of
+
+`IUrlTransformerComponent.decryptParam`
+
+***
+
+### getParamName() {#getparamname}
+
+> **getParamName**(`key`): `string` \| `undefined`
+
+Get the parameter name for a given key.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The key of the parameter.
+
+#### Returns
+
+`string` \| `undefined`
+
+The parameter name.
+
+#### Implementation of
+
+`IUrlTransformerComponent.getParamName`

package/docs/reference/functions/generateRestRoutesHealth.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesHealth()
+
+> **generateRestRoutesHealth**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes for server health.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The generated routes.

package/docs/reference/functions/serverLivez.md

@@ -0,0 +1,31 @@
+# Function: serverLivez()
+
+> **serverLivez**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerLivezResponse`\>
+
+Get the livez for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerLivezResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/serverReadyz.md

@@ -0,0 +1,31 @@
+# Function: serverReadyz()
+
+> **serverReadyz**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IServerReadyzResponse`\>
+
+Get the readyz for the server.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`INoContentRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IServerReadyzResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -2,23 +2,36 @@
 
 ## Classes
 
+- [HealthService](classes/HealthService.md)
+- [HostingService](classes/HostingService.md)
 - [InformationService](classes/InformationService.md)
+- [UrlTransformerService](classes/UrlTransformerService.md)
 
 ## Interfaces
 
+- [IHealthServiceConfig](interfaces/IHealthServiceConfig.md)
+- [IHealthServiceConstructorOptions](interfaces/IHealthServiceConstructorOptions.md)
+- [IHostingServiceConfig](interfaces/IHostingServiceConfig.md)
+- [IHostingServiceConstructorOptions](interfaces/IHostingServiceConstructorOptions.md)
 - [IInformationServiceConfig](interfaces/IInformationServiceConfig.md)
 - [IInformationServiceConstructorOptions](interfaces/IInformationServiceConstructorOptions.md)
+- [IUrlTransformerServiceConfig](interfaces/IUrlTransformerServiceConfig.md)
+- [IUrlTransformerServiceConstructorOptions](interfaces/IUrlTransformerServiceConstructorOptions.md)
 
 ## Variables
 
+- [tagsHealth](variables/tagsHealth.md)
 - [tagsInformation](variables/tagsInformation.md)
 - [restEntryPoints](variables/restEntryPoints.md)
 
 ## Functions
 
+- [generateRestRoutesHealth](functions/generateRestRoutesHealth.md)
+- [serverHealth](functions/serverHealth.md)
 - [generateRestRoutesInformation](functions/generateRestRoutesInformation.md)
 - [serverRoot](functions/serverRoot.md)
 - [serverInfo](functions/serverInfo.md)
-- [serverHealth](functions/serverHealth.md)
+- [serverLivez](functions/serverLivez.md)
+- [serverReadyz](functions/serverReadyz.md)
 - [serverFavIcon](functions/serverFavIcon.md)
 - [serverSpec](functions/serverSpec.md)

package/docs/reference/interfaces/IHealthServiceConfig.md

@@ -0,0 +1,32 @@
+# Interface: IHealthServiceConfig
+
+Configuration for the health service.
+
+## Properties
+
+### healthCheckInterval? {#healthcheckinterval}
+
+> `optional` **healthCheckInterval?**: `number`
+
+The interval for checking the health of the components and setting it in the health service.
+
+#### Default
+
+```ts
+60000
+```
+
+***
+
+### initialInterval? {#initialinterval}
+
+> `optional` **initialInterval?**: `number`
+
+The initial interval for checking the health of the components and setting it in the health service.
+This is used to check the health of the components immediately after the service is started.
+
+#### Default
+
+```ts
+2000
+```

package/docs/reference/interfaces/IHealthServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IHealthServiceConstructorOptions
+
+Options for the HealthService constructor.
+
+## Properties
+
+### config? {#config}
+
+> `optional` **config?**: [`IHealthServiceConfig`](IHealthServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/interfaces/IHostingServiceConfig.md

@@ -0,0 +1,19 @@
+# Interface: IHostingServiceConfig
+
+Configuration for the hosting service.
+
+## Properties
+
+### localOrigin {#localorigin}
+
+> **localOrigin**: `string`
+
+The local origin, must be provided as a fallback e.g. http://localhost:1234.
+
+***
+
+### publicOrigin? {#publicorigin}
+
+> `optional` **publicOrigin?**: `string`
+
+The APIs public base URL e.g. "https://api.example.com:1234".

package/docs/reference/interfaces/IHostingServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IHostingServiceConstructorOptions
+
+Options for the HostingService constructor.
+
+## Properties
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The tenant admin component type.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### config {#config}
+
+> **config**: [`IHostingServiceConfig`](IHostingServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/interfaces/IInformationServiceConfig.md

@@ -4,7 +4,7 @@ Configuration for the information service.
 
 ## Properties
 
-### serverInfo
+### serverInfo {#serverinfo}
 
 > **serverInfo**: `IServerInfo`
 
@@ -12,16 +12,16 @@ The server information.
 
 ***
 
-### openApiSpecPath?
+### openApiSpecPath? {#openapispecpath}
 
-> `optional` **openApiSpecPath**: `string`
+> `optional` **openApiSpecPath?**: `string`
 
 The path to the OpenAPI Spec.
 
 ***
 
-### favIconPath?
+### favIconPath? {#faviconpath}
 
-> `optional` **favIconPath**: `string`
+> `optional` **favIconPath?**: `string`
 
 The path to the favicon.

package/docs/reference/interfaces/IInformationServiceConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the InformationService constructor.
 
 ## Properties
 
-### config
+### config {#config}
 
 > **config**: [`IInformationServiceConfig`](IInformationServiceConfig.md)
 

package/docs/reference/interfaces/IUrlTransformerServiceConfig.md

@@ -0,0 +1,32 @@
+# Interface: IUrlTransformerServiceConfig
+
+Configuration for the URL transformer service.
+
+## Properties
+
+### paramEncryptionKeyName? {#paramencryptionkeyname}
+
+> `optional` **paramEncryptionKeyName?**: `string`
+
+The name of the key to retrieve from the vault for encryption/decryption of parameters.
+
+#### Default
+
+```ts
+param-encryption
+```
+
+***
+
+### queryParamNames? {#queryparamnames}
+
+> `optional` **queryParamNames?**: `object`
+
+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.
+
+#### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/interfaces/IUrlTransformerServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IUrlTransformerServiceConstructorOptions
+
+Options for the UrlTransformerService constructor.
+
+## Properties
+
+### vaultConnectorType? {#vaultconnectortype}
+
+> `optional` **vaultConnectorType?**: `string`
+
+The vault connector type.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IUrlTransformerServiceConfig`](IUrlTransformerServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/tagsHealth.md

@@ -0,0 +1,5 @@
+# Variable: tagsHealth
+
+> `const` **tagsHealth**: `ITag`[]
+
+The tag to associate with the routes.