@twin.org/engine-types 0.0.1 → 0.0.2-next.10

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

@@ -1,17 +1,5 @@
 # Type Alias: LoggingComponentConfig
 
-> **LoggingComponentConfig** = `object`
+> **LoggingComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/LoggingComponentType.md#service); `options?`: `ILoggingServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/LoggingComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Logging component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/LoggingComponentType.md#service)
-
-***
-
-### options?
-
-> `optional` **options**: `ILoggingServiceConstructorOptions`

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

@@ -1,17 +1,5 @@
 # Type Alias: NftComponentConfig
 
-> **NftComponentConfig** = `object`
+> **NftComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/NftComponentType.md#service); `options?`: `INftServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/NftComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 NFT component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/NftComponentType.md#service)
-
-***
-
-### options?
-
-> `optional` **options**: `INftServiceConstructorOptions`

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

@@ -1,17 +1,5 @@
 # Type Alias: RightsManagementComponentConfig
 
-> **RightsManagementComponentConfig** = `object`
+> **RightsManagementComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementComponentType.md#service); `options?`: `IRightsManagementServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Rights management component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/RightsManagementComponentType.md#service)
-
-***
-
-### options?
-
-> `optional` **options**: `IRightsManagementServiceConstructorOptions`

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

@@ -0,0 +1,17 @@
+# Type Alias: RightsManagementPdpComponentConfig
+
+> **RightsManagementPdpComponentConfig** = `object`
+
+Rights management PDP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementPdpComponentType.md#service)
+
+***
+
+### options?
+
+> `optional` **options**: `IPolicyDecisionPointServiceOptions`

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

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

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

@@ -0,0 +1,17 @@
+# Type Alias: RightsManagementPepComponentConfig
+
+> **RightsManagementPepComponentConfig** = `object`
+
+Rights management PEP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementPepComponentType.md#service)
+
+***
+
+### options?
+
+> `optional` **options**: `IPolicyEnforcementPointServiceOptions`

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

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

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

@@ -0,0 +1,17 @@
+# Type Alias: RightsManagementPipComponentConfig
+
+> **RightsManagementPipComponentConfig** = `object`
+
+Rights management PIP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementPipComponentType.md#service)
+
+***
+
+### options?
+
+> `optional` **options**: `IPolicyInformationPointServiceOptions`

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

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

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

@@ -0,0 +1,17 @@
+# Type Alias: RightsManagementPmpComponentConfig
+
+> **RightsManagementPmpComponentConfig** = `object`
+
+Rights management PMP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementPmpComponentType.md#service)
+
+***
+
+### options?
+
+> `optional` **options**: `IPolicyManagementPointServiceOptions`

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

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

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

@@ -0,0 +1,17 @@
+# Type Alias: RightsManagementPxpComponentConfig
+
+> **RightsManagementPxpComponentConfig** = `object`
+
+Rights management PXP component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/RightsManagementPxpComponentType.md#service)
+
+***
+
+### options?
+
+> `optional` **options**: `IPolicyExecutionPointServiceOptions`

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

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

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

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageComponentConfig
+
+> **SynchronisedStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/SynchronisedStorageComponentType.md#service); `options`: `ISynchronisedStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/SynchronisedStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+
+Synchronised storage component config types.

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

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

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

@@ -8,7 +8,7 @@ Background task scheduled component config types.
 
 ### type
 
-> **type**: *typeof* [`Default`](../variables/TaskSchedulerComponentType.md#default)
+> **type**: *typeof* [`Service`](../variables/TaskSchedulerComponentType.md#service)
 
 ***
 

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

@@ -1,17 +1,5 @@
 # Type Alias: TelemetryComponentConfig
 
-> **TelemetryComponentConfig** = `object`
+> **TelemetryComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/TelemetryComponentType.md#service); `options?`: `ITelemetryServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/TelemetryComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Telemetry component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/TelemetryComponentType.md#service)
-
-***
-
-### options?
-
-> `optional` **options**: `ITelemetryServiceConstructorOptions`

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

@@ -1,17 +1,5 @@
 # Type Alias: VerifiableStorageComponentConfig
 
-> **VerifiableStorageComponentConfig** = `object`
+> **VerifiableStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/VerifiableStorageComponentType.md#service); `options?`: `IVerifiableStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/VerifiableStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
 
 Verifiable storage component config types.
-
-## Properties
-
-### type
-
-> **type**: *typeof* [`Service`](../variables/VerifiableStorageComponentType.md#service)
-
-***
-
-### options?
-
-> `optional` **options**: `IVerifiableStorageServiceConstructorOptions`

package/docs/reference/variables/AttestationComponentType.md

@@ -11,3 +11,9 @@ Attestation component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/AuditableItemGraphComponentType.md

@@ -11,3 +11,9 @@ Auditable item graph component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/AuditableItemStreamComponentType.md

@@ -11,3 +11,9 @@ Auditable item stream component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/BlobStorageComponentType.md

@@ -11,3 +11,9 @@ Blob storage component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/DataProcessingComponentType.md

@@ -11,3 +11,9 @@ Data processing component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/DataSpaceConnectorComponentType.md

@@ -0,0 +1,25 @@
+# Variable: DataSpaceConnectorComponentType
+
+> `const` **DataSpaceConnectorComponentType**: `object`
+
+Data space connector component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.
+
+### SocketClient
+
+> `readonly` **SocketClient**: `"socket-client"` = `"socket-client"`
+
+Socket client.

package/docs/reference/variables/DocumentManagementComponentType.md

@@ -11,3 +11,9 @@ Document management component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/EntityStorageComponentType.md

@@ -11,3 +11,9 @@ Entity storage component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/EntityStorageConnectorType.md

@@ -59,3 +59,9 @@ MongoDb.
 > `readonly` **PostgreSql**: `"postgresql"` = `"postgresql"`
 
 Postgre SQL.
+
+### Synchronised
+
+> `readonly` **Synchronised**: `"synchronised"` = `"synchronised"`
+
+Synchronised.

package/docs/reference/variables/EventBusComponentType.md

@@ -11,3 +11,9 @@ Event bus component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### SocketClient
+
+> `readonly` **SocketClient**: `"socket-client"` = `"socket-client"`
+
+Socket client.

package/docs/reference/variables/FederatedCatalogueComponentType.md

@@ -11,3 +11,9 @@ Federated catalogue component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/IdentityComponentType.md

@@ -11,3 +11,9 @@ Identity component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/IdentityProfileComponentType.md

@@ -11,3 +11,9 @@ Identity profile component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/IdentityResolverComponentType.md

@@ -11,3 +11,9 @@ Identity resolver component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/ImmutableProofComponentType.md

@@ -11,3 +11,9 @@ Immutable proof component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/LoggingComponentType.md

@@ -11,3 +11,9 @@ Logging component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/NftComponentType.md

@@ -11,3 +11,9 @@ NFT component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/RightsManagementComponentType.md

@@ -11,3 +11,9 @@ Rights management component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/RightsManagementPdpComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementPdpComponentType
+
+> `const` **RightsManagementPdpComponentType**: `object`
+
+Rights management PDP component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/RightsManagementPepComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementPepComponentType
+
+> `const` **RightsManagementPepComponentType**: `object`
+
+Rights management PEP component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/RightsManagementPipComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementPipComponentType
+
+> `const` **RightsManagementPipComponentType**: `object`
+
+Rights management PIP component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/RightsManagementPmpComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementPmpComponentType
+
+> `const` **RightsManagementPmpComponentType**: `object`
+
+Rights management PMP component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/RightsManagementPxpComponentType.md

@@ -0,0 +1,13 @@
+# Variable: RightsManagementPxpComponentType
+
+> `const` **RightsManagementPxpComponentType**: `object`
+
+Rights management PXP component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/SynchronisedStorageComponentType.md

@@ -0,0 +1,19 @@
+# Variable: SynchronisedStorageComponentType
+
+> `const` **SynchronisedStorageComponentType**: `object`
+
+Synchronised storage component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/TaskSchedulerComponentType.md

@@ -6,8 +6,8 @@ Task scheduler component types.
 
 ## Type declaration
 
-### Default
+### Service
 
-> `readonly` **Default**: `"default"` = `"default"`
+> `readonly` **Service**: `"service"` = `"service"`
 
 Task scheduler.

package/docs/reference/variables/TelemetryComponentType.md

@@ -11,3 +11,9 @@ Telemetry component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/docs/reference/variables/VerifiableStorageComponentType.md

@@ -11,3 +11,9 @@ Verifiable storage component types.
 > `readonly` **Service**: `"service"` = `"service"`
 
 Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.