@twin.org/engine-types 0.0.3-next.31 → 0.0.3-next.33

package/docs/reference/functions/initialiseAutomationAction.md

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

package/docs/reference/functions/initialiseAutomationComponent.md

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

package/docs/reference/index.md

@@ -14,6 +14,8 @@
 - [AttestationConnectorConfig](type-aliases/AttestationConnectorConfig.md)
 - [AuditableItemGraphComponentConfig](type-aliases/AuditableItemGraphComponentConfig.md)
 - [AuditableItemStreamComponentConfig](type-aliases/AuditableItemStreamComponentConfig.md)
+- [AutomationActionConfig](type-aliases/AutomationActionConfig.md)
+- [AutomationComponentConfig](type-aliases/AutomationComponentConfig.md)
 - [BackgroundTaskComponentConfig](type-aliases/BackgroundTaskComponentConfig.md)
 - [BlobStorageComponentConfig](type-aliases/BlobStorageComponentConfig.md)
 - [BlobStorageConnectorConfig](type-aliases/BlobStorageConnectorConfig.md)
@@ -81,6 +83,8 @@
 - [AttestationConnectorType](type-aliases/AttestationConnectorType.md)
 - [AuditableItemGraphComponentType](type-aliases/AuditableItemGraphComponentType.md)
 - [AuditableItemStreamComponentType](type-aliases/AuditableItemStreamComponentType.md)
+- [AutomationActionType](type-aliases/AutomationActionType.md)
+- [AutomationComponentType](type-aliases/AutomationComponentType.md)
 - [BackgroundTaskComponentType](type-aliases/BackgroundTaskComponentType.md)
 - [BlobStorageComponentType](type-aliases/BlobStorageComponentType.md)
 - [BlobStorageConnectorType](type-aliases/BlobStorageConnectorType.md)
@@ -151,6 +155,8 @@
 - [AttestationConnectorType](variables/AttestationConnectorType.md)
 - [AuditableItemGraphComponentType](variables/AuditableItemGraphComponentType.md)
 - [AuditableItemStreamComponentType](variables/AuditableItemStreamComponentType.md)
+- [AutomationActionType](variables/AutomationActionType.md)
+- [AutomationComponentType](variables/AutomationComponentType.md)
 - [BackgroundTaskComponentType](variables/BackgroundTaskComponentType.md)
 - [BlobStorageComponentType](variables/BlobStorageComponentType.md)
 - [BlobStorageConnectorType](variables/BlobStorageConnectorType.md)
@@ -221,6 +227,8 @@
 - [initialiseAttestationComponent](functions/initialiseAttestationComponent.md)
 - [initialiseAuditableItemGraphComponent](functions/initialiseAuditableItemGraphComponent.md)
 - [initialiseAuditableItemStreamComponent](functions/initialiseAuditableItemStreamComponent.md)
+- [initialiseAutomationComponent](functions/initialiseAutomationComponent.md)
+- [initialiseAutomationAction](functions/initialiseAutomationAction.md)
 - [initialiseBackgroundTaskComponent](functions/initialiseBackgroundTaskComponent.md)
 - [initialiseBlobStorageConnector](functions/initialiseBlobStorageConnector.md)
 - [initialiseBlobStorageComponent](functions/initialiseBlobStorageComponent.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -156,6 +156,18 @@ Event bus connector options which can be overridden by individual components by
 
 Event bus component options which can be overridden by individual components by specifying types other than default.
 
+#### automationComponent?
+
+> `optional` **automationComponent?**: `IEngineCoreTypeConfig`\<[`AutomationComponentConfig`](../type-aliases/AutomationComponentConfig.md)\>[]
+
+Automation component options which can be overridden by individual components by specifying types other than default.
+
+#### automationAction?
+
+> `optional` **automationAction?**: `IEngineCoreTypeConfig`\<[`AutomationActionConfig`](../type-aliases/AutomationActionConfig.md)\>[]
+
+Automation action 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/AutomationActionConfig.md

@@ -0,0 +1,17 @@
+# Type Alias: AutomationActionConfig
+
+> **AutomationActionConfig** = `object`
+
+Automation action configuration.
+
+## Properties
+
+### type {#type}
+
+> **type**: *typeof* [`Fetch`](../variables/AutomationActionType.md#fetch)
+
+***
+
+### options {#options}
+
+> **options**: `IFetchActionConstructorOptions`

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

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

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

@@ -0,0 +1,5 @@
+# Type Alias: AutomationComponentConfig
+
+> **AutomationComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/AutomationComponentType.md#service); `options?`: `IAutomationServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/AutomationComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+
+Automation component configuration.

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

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

package/docs/reference/variables/AutomationActionType.md

@@ -0,0 +1,13 @@
+# Variable: AutomationActionType
+
+> `const` **AutomationActionType**: `object`
+
+Automation action types.
+
+## Type Declaration
+
+### Fetch {#fetch}
+
+> `readonly` **Fetch**: `"fetch"` = `"fetch"`
+
+Fetch action.

package/docs/reference/variables/AutomationComponentType.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.3-next.31",
+	"version": "0.0.3-next.33",
 	"description": "Component and connector type definitions with configuration helpers for engine composition.",
 	"repository": {
 		"type": "git",
@@ -26,6 +26,10 @@
 		"@twin.org/auditable-item-stream-models": "next",
 		"@twin.org/auditable-item-stream-rest-client": "next",
 		"@twin.org/auditable-item-stream-service": "next",
+		"@twin.org/automation-actions": "next",
+		"@twin.org/automation-models": "next",
+		"@twin.org/automation-rest-client": "next",
+		"@twin.org/automation-service": "next",
 		"@twin.org/background-task-models": "next",
 		"@twin.org/background-task-scheduler": "next",
 		"@twin.org/background-task-service": "next",
@@ -56,8 +60,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.31",
-		"@twin.org/engine-models": "0.0.3-next.31",
+		"@twin.org/engine-core": "0.0.3-next.33",
+		"@twin.org/engine-models": "0.0.3-next.33",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",