@twin.org/engine-types 0.0.3-next.32 → 0.0.3-next.34

package/docs/reference/functions/initialiseHealthComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseHealthComponent()
+
+> **initialiseHealthComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`HealthComponentConfig`](../type-aliases/HealthComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the health component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`HealthComponentConfig`](../type-aliases/HealthComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`HealthComponentConfig`](../type-aliases/HealthComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/functions/initialiseUrlTransformerComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseUrlTransformerComponent()
+
+> **initialiseUrlTransformerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+Initialise the URL transformer component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md), `Factory`\<`IComponent`\>\>
+
+The instance created and the factory for it.

package/docs/reference/index.md

@@ -34,6 +34,7 @@
 - [FaucetConnectorConfig](type-aliases/FaucetConnectorConfig.md)
 - [FederatedCatalogueComponentConfig](type-aliases/FederatedCatalogueComponentConfig.md)
 - [FederatedCatalogueFilterComponentConfig](type-aliases/FederatedCatalogueFilterComponentConfig.md)
+- [HealthComponentConfig](type-aliases/HealthComponentConfig.md)
 - [IdentityComponentConfig](type-aliases/IdentityComponentConfig.md)
 - [IdentityConnectorConfig](type-aliases/IdentityConnectorConfig.md)
 - [IdentityProfileComponentConfig](type-aliases/IdentityProfileComponentConfig.md)
@@ -75,6 +76,7 @@
 - [TrustComponentConfig](type-aliases/TrustComponentConfig.md)
 - [TrustGeneratorComponentConfig](type-aliases/TrustGeneratorComponentConfig.md)
 - [TrustVerifierComponentConfig](type-aliases/TrustVerifierComponentConfig.md)
+- [UrlTransformerComponentConfig](type-aliases/UrlTransformerComponentConfig.md)
 - [VaultConnectorConfig](type-aliases/VaultConnectorConfig.md)
 - [VerifiableStorageComponentConfig](type-aliases/VerifiableStorageComponentConfig.md)
 - [VerifiableStorageConnectorConfig](type-aliases/VerifiableStorageConnectorConfig.md)
@@ -103,6 +105,7 @@
 - [FaucetConnectorType](type-aliases/FaucetConnectorType.md)
 - [FederatedCatalogueComponentType](type-aliases/FederatedCatalogueComponentType.md)
 - [FederatedCatalogueFilterComponentType](type-aliases/FederatedCatalogueFilterComponentType.md)
+- [HealthComponentType](type-aliases/HealthComponentType.md)
 - [IdentityComponentType](type-aliases/IdentityComponentType.md)
 - [IdentityConnectorType](type-aliases/IdentityConnectorType.md)
 - [IdentityProfileComponentType](type-aliases/IdentityProfileComponentType.md)
@@ -144,6 +147,7 @@
 - [TrustComponentType](type-aliases/TrustComponentType.md)
 - [TrustGeneratorComponentType](type-aliases/TrustGeneratorComponentType.md)
 - [TrustVerifierComponentType](type-aliases/TrustVerifierComponentType.md)
+- [UrlTransformerComponentType](type-aliases/UrlTransformerComponentType.md)
 - [VaultConnectorType](type-aliases/VaultConnectorType.md)
 - [IVerifiableStorageComponentType](type-aliases/IVerifiableStorageComponentType.md)
 - [VerifiableStorageConnectorType](type-aliases/VerifiableStorageConnectorType.md)
@@ -175,6 +179,7 @@
 - [FaucetConnectorType](variables/FaucetConnectorType.md)
 - [FederatedCatalogueComponentType](variables/FederatedCatalogueComponentType.md)
 - [FederatedCatalogueFilterComponentType](variables/FederatedCatalogueFilterComponentType.md)
+- [HealthComponentType](variables/HealthComponentType.md)
 - [IdentityComponentType](variables/IdentityComponentType.md)
 - [IdentityConnectorType](variables/IdentityConnectorType.md)
 - [IdentityProfileComponentType](variables/IdentityProfileComponentType.md)
@@ -216,6 +221,7 @@
 - [TrustComponentType](variables/TrustComponentType.md)
 - [TrustGeneratorComponentType](variables/TrustGeneratorComponentType.md)
 - [TrustVerifierComponentType](variables/TrustVerifierComponentType.md)
+- [UrlTransformerComponentType](variables/UrlTransformerComponentType.md)
 - [VaultConnectorType](variables/VaultConnectorType.md)
 - [VerifiableStorageComponentType](variables/VerifiableStorageComponentType.md)
 - [VerifiableStorageConnectorType](variables/VerifiableStorageConnectorType.md)
@@ -246,6 +252,7 @@
 - [initialiseFaucetConnector](functions/initialiseFaucetConnector.md)
 - [initialiseFederatedCatalogueComponent](functions/initialiseFederatedCatalogueComponent.md)
 - [initialiseFederatedCatalogueFilterComponent](functions/initialiseFederatedCatalogueFilterComponent.md)
+- [initialiseHealthComponent](functions/initialiseHealthComponent.md)
 - [initialiseIdentityConnector](functions/initialiseIdentityConnector.md)
 - [initialiseIdentityComponent](functions/initialiseIdentityComponent.md)
 - [initialiseIdentityProfileConnector](functions/initialiseIdentityProfileConnector.md)
@@ -287,6 +294,7 @@
 - [initialiseTrustComponent](functions/initialiseTrustComponent.md)
 - [initialiseTrustGeneratorComponent](functions/initialiseTrustGeneratorComponent.md)
 - [initialiseTrustVerifierComponent](functions/initialiseTrustVerifierComponent.md)
+- [initialiseUrlTransformerComponent](functions/initialiseUrlTransformerComponent.md)
 - [initialiseVaultConnector](functions/initialiseVaultConnector.md)
 - [initialiseVerifiableStorageConnector](functions/initialiseVerifiableStorageConnector.md)
 - [initialiseVerifiableStorageComponent](functions/initialiseVerifiableStorageComponent.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -168,6 +168,18 @@ Automation component options which can be overridden by individual components by
 
 Automation action options which can be overridden by individual components by specifying types other than default.
 
+#### healthComponent?
+
+> `optional` **healthComponent?**: `IEngineCoreTypeConfig`\<[`HealthComponentConfig`](../type-aliases/HealthComponentConfig.md)\>[]
+
+Health component options which can be overridden by individual components by specifying types other than default.
+
+#### urlTransformerComponent?
+
+> `optional` **urlTransformerComponent?**: `IEngineCoreTypeConfig`\<[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md)\>[]
+
+URL transformer component options which can be overridden by individual components by specifying types other than default.
+
 #### vaultConnector?
 
 > `optional` **vaultConnector?**: `IEngineCoreTypeConfig`\<[`VaultConnectorConfig`](../type-aliases/VaultConnectorConfig.md)\>[]

package/docs/reference/type-aliases/HealthComponentConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: HealthComponentConfig
+
+> **HealthComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/HealthComponentType.md#service); `options?`: `IHealthServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/HealthComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+
+Health component config types.

package/docs/reference/type-aliases/HealthComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: HealthComponentType
+
+> **HealthComponentType** = *typeof* [`HealthComponentType`](../variables/HealthComponentType.md)\[keyof *typeof* [`HealthComponentType`](../variables/HealthComponentType.md)\]
+
+Health component types.

package/docs/reference/type-aliases/UrlTransformerComponentConfig.md

@@ -0,0 +1,17 @@
+# Type Alias: UrlTransformerComponentConfig
+
+> **UrlTransformerComponentConfig** = `object`
+
+URL transformer component config types.
+
+## Properties
+
+### type {#type}
+
+> **type**: *typeof* [`Service`](../variables/UrlTransformerComponentType.md#service)
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `IUrlTransformerServiceConstructorOptions`

package/docs/reference/type-aliases/UrlTransformerComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: UrlTransformerComponentType
+
+> **UrlTransformerComponentType** = *typeof* [`UrlTransformerComponentType`](../variables/UrlTransformerComponentType.md)\[keyof *typeof* [`UrlTransformerComponentType`](../variables/UrlTransformerComponentType.md)\]
+
+URL transformer component types.

package/docs/reference/variables/HealthComponentType.md

@@ -0,0 +1,19 @@
+# Variable: HealthComponentType
+
+> `const` **HealthComponentType**: `object`
+
+Health component types.
+
+## Type Declaration
+
+### Service {#service}
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.
+
+### RestClient {#restclient}
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/UrlTransformerComponentType.md

@@ -0,0 +1,13 @@
+# Variable: UrlTransformerComponentType
+
+> `const` **UrlTransformerComponentType**: `object`
+
+URL transformer component types.
+
+## Type Declaration
+
+### Service {#service}
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.3-next.32",
+	"version": "0.0.3-next.34",
 	"description": "Component and connector type definitions with configuration helpers for engine composition.",
 	"repository": {
 		"type": "git",
@@ -15,6 +15,8 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
+		"@twin.org/api-rest-client": "next",
+		"@twin.org/api-service": "next",
 		"@twin.org/api-tenant-processor": "next",
 		"@twin.org/attestation-connector-nft": "next",
 		"@twin.org/attestation-models": "next",
@@ -60,8 +62,8 @@
 		"@twin.org/document-management-models": "next",
 		"@twin.org/document-management-rest-client": "next",
 		"@twin.org/document-management-service": "next",
-		"@twin.org/engine-core": "0.0.3-next.32",
-		"@twin.org/engine-models": "0.0.3-next.32",
+		"@twin.org/engine-core": "0.0.3-next.34",
+		"@twin.org/engine-models": "0.0.3-next.34",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",