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

package/docs/reference/classes/HostingService.md

@@ -54,6 +54,32 @@ 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`\>
@@ -129,3 +155,243 @@ 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/interfaces/IHostingServiceConfig.md

@@ -17,3 +17,31 @@ The local origin, must be provided as a fallback e.g. http://localhost:1234.
 > `optional` **publicOrigin?**: `string`
 
 The APIs public base URL e.g. "https://api.example.com:1234".
+
+***
+
+### paramEncryptionKeyName? {#paramencryptionkeyname}
+
+> `optional` **paramEncryptionKeyName?**: `string`
+
+The name of the key to retrieve from the vault for encryption/decryption of parameters.
+
+#### Default
+
+```ts
+param-encryption
+```
+
+***
+
+### tenantTokenName? {#tenanttokenname}
+
+> `optional` **tenantTokenName?**: `string`
+
+The query param name to look for the encrypted tenant token.
+
+#### Default
+
+```ts
+tenant-token
+```

package/docs/reference/interfaces/IHostingServiceConstructorOptions.md

@@ -18,6 +18,20 @@ tenant-admin
 
 ***
 
+### vaultConnectorType? {#vaultconnectortype}
+
+> `optional` **vaultConnectorType?**: `string`
+
+The vault connector type.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
 ### config {#config}
 
 > **config**: [`IHostingServiceConfig`](IHostingServiceConfig.md)

package/locales/en.json

@@ -1 +1,10 @@
-{}
+{
+	"error": {
+		"hostingService": {
+			"encryptionUnavailable": "Encryption is unavailable because no vault connector is configured",
+			"decryptionUnavailable": "Decryption is unavailable because no vault connector is configured",
+			"encryptionFailed": "An error occurred during encryption",
+			"decryptionFailed": "An error occurred during decryption"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-service",
-	"version": "0.0.3-next.27",
+	"version": "0.0.3-next.29",
 	"description": "Information and hosting service implementations with generated REST route handlers.",
 	"repository": {
 		"type": "git",
@@ -14,10 +14,11 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "0.0.3-next.27",
+		"@twin.org/api-models": "0.0.3-next.29",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
+		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",