@twin.org/engine-models 0.0.1-next.1

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

@@ -0,0 +1,5 @@
+# Type Alias: IdentityProfileConnectorType
+
+> **IdentityProfileConnectorType**: *typeof* [`IdentityProfileConnectorType`](../variables/IdentityProfileConnectorType.md)\[keyof *typeof* [`IdentityProfileConnectorType`](../variables/IdentityProfileConnectorType.md)\]
+
+Identity profile connector types.

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

@@ -0,0 +1,39 @@
+# Type Alias: ImmutableProofComponentConfig
+
+> **ImmutableProofComponentConfig**: `object`
+
+Immutable proof component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `ImmutableProofComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+### options.immutableProofEntityStorageType?
+
+> `optional` **immutableProofEntityStorageType**: `string`
+
+### options.immutableStorageType?
+
+> `optional` **immutableStorageType**: `string`
+
+### options.identityConnectorType?
+
+> `optional` **identityConnectorType**: `string`
+
+### options.backgroundTaskConnectorType?
+
+> `optional` **backgroundTaskConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IImmutableProofServiceConfig`

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

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableStorageConnectorConfig
+
+> **ImmutableStorageConnectorConfig**: `object` \| `object`
+
+Immutable storage connector config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableStorageConnectorType
+
+> **ImmutableStorageConnectorType**: *typeof* [`ImmutableStorageConnectorType`](../variables/ImmutableStorageConnectorType.md)\[keyof *typeof* [`ImmutableStorageConnectorType`](../variables/ImmutableStorageConnectorType.md)\]
+
+Immutable storage connector types.

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

@@ -0,0 +1,19 @@
+# Type Alias: InformationComponentConfig
+
+> **InformationComponentConfig**: `object`
+
+Information component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `InformationComponentType.Service`
+
+### options
+
+> **options**: `object`
+
+### options.config
+
+> **config**: `IInformationServiceConfig`

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

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

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

@@ -0,0 +1,19 @@
+# Type Alias: LoggingComponentConfig
+
+> **LoggingComponentConfig**: `object`
+
+Logging component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `LoggingComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`

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

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

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

@@ -0,0 +1,5 @@
+# Type Alias: LoggingConnectorConfig
+
+> **LoggingConnectorConfig**: `object` \| `object` \| `object`
+
+Logging config connector types.

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

@@ -0,0 +1,5 @@
+# Type Alias: LoggingConnectorType
+
+> **LoggingConnectorType**: *typeof* [`LoggingConnectorType`](../variables/LoggingConnectorType.md)\[keyof *typeof* [`LoggingConnectorType`](../variables/LoggingConnectorType.md)\]
+
+Logging connector types.

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

@@ -0,0 +1,15 @@
+# Type Alias: MimeTypeProcessorConfig
+
+> **MimeTypeProcessorConfig**: `object`
+
+Mime type processor config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `MimeTypeProcessorType.Jwt`
+
+### options?
+
+> `optional` **options**: `never`

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

@@ -0,0 +1,5 @@
+# Type Alias: MimeTypeProcessorType
+
+> **MimeTypeProcessorType**: *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\[keyof *typeof* [`MimeTypeProcessorType`](../variables/MimeTypeProcessorType.md)\]
+
+Mime type processor types.

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

@@ -0,0 +1,19 @@
+# Type Alias: NftComponentConfig
+
+> **NftComponentConfig**: `object`
+
+NFT component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `NftComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.config?
+
+> `optional` **config**: `INftServiceConfig`

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

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

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

@@ -0,0 +1,5 @@
+# Type Alias: NftConnectorConfig
+
+> **NftConnectorConfig**: `object` \| `object`
+
+NFT connector config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: NftConnectorType
+
+> **NftConnectorType**: *typeof* [`NftConnectorType`](../variables/NftConnectorType.md)\[keyof *typeof* [`NftConnectorType`](../variables/NftConnectorType.md)\]
+
+NFT connector types.

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

@@ -0,0 +1,15 @@
+# Type Alias: RestRouteGenerator()
+
+> **RestRouteGenerator**: (`baseRouteName`, `componentName`) => `IRestRoute`[]
+
+Method definition for the REST route creation.
+
+## Parameters
+
+• **baseRouteName**: `string`
+
+• **componentName**: `string`
+
+## Returns
+
+`IRestRoute`[]

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

@@ -0,0 +1,5 @@
+# Type Alias: RestRouteProcessorConfig
+
+> **RestRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
+
+REST route processor config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: RestRouteProcessorType
+
+> **RestRouteProcessorType**: *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\[keyof *typeof* [`RestRouteProcessorType`](../variables/RestRouteProcessorType.md)\]
+
+REST route processor types.

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

@@ -0,0 +1,15 @@
+# Type Alias: SocketRouteGenerator()
+
+> **SocketRouteGenerator**: (`baseRouteName`, `componentName`) => `ISocketRoute`[]
+
+Method definition for the socket route creation.
+
+## Parameters
+
+• **baseRouteName**: `string`
+
+• **componentName**: `string`
+
+## Returns
+
+`ISocketRoute`[]

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

@@ -0,0 +1,5 @@
+# Type Alias: SocketRouteProcessorConfig
+
+> **SocketRouteProcessorConfig**: `object` \| `object` \| `object` \| `object` \| `object`
+
+Socket route processor config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: SocketRouteProcessorType
+
+> **SocketRouteProcessorType**: *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\[keyof *typeof* [`SocketRouteProcessorType`](../variables/SocketRouteProcessorType.md)\]
+
+Socket route processor types.

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

@@ -0,0 +1,19 @@
+# Type Alias: TelemetryComponentConfig
+
+> **TelemetryComponentConfig**: `object`
+
+Telemetry component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `TelemetryComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.telemetryConnectorType?
+
+> `optional` **telemetryConnectorType**: `string`

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

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

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

@@ -0,0 +1,27 @@
+# Type Alias: TelemetryConnectorConfig
+
+> **TelemetryConnectorConfig**: `object`
+
+Telemetry connector config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `TelemetryConnectorType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.telemetryMetricStorageConnectorType?
+
+> `optional` **telemetryMetricStorageConnectorType**: `string`
+
+### options.telemetryMetricValueStorageConnectorType?
+
+> `optional` **telemetryMetricValueStorageConnectorType**: `string`
+
+### options.loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`

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

@@ -0,0 +1,5 @@
+# Type Alias: TelemetryConnectorType
+
+> **TelemetryConnectorType**: *typeof* [`TelemetryConnectorType`](../variables/TelemetryConnectorType.md)\[keyof *typeof* [`TelemetryConnectorType`](../variables/TelemetryConnectorType.md)\]
+
+Telemetry connector types.

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

@@ -0,0 +1,5 @@
+# Type Alias: VaultConnectorConfig
+
+> **VaultConnectorConfig**: `object` \| `object`
+
+Vault connector config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: VaultConnectorType
+
+> **VaultConnectorType**: *typeof* [`VaultConnectorType`](../variables/VaultConnectorType.md)\[keyof *typeof* [`VaultConnectorType`](../variables/VaultConnectorType.md)\]
+
+Vault connector types.

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

@@ -0,0 +1,5 @@
+# Type Alias: WalletConnectorConfig
+
+> **WalletConnectorConfig**: `object` \| `object`
+
+Wallet connector config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: WalletConnectorType
+
+> **WalletConnectorType**: *typeof* [`WalletConnectorType`](../variables/WalletConnectorType.md)\[keyof *typeof* [`WalletConnectorType`](../variables/WalletConnectorType.md)\]
+
+Wallet connector types.

package/docs/reference/variables/AttestationComponentType.md

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

package/docs/reference/variables/AttestationConnectorType.md

@@ -0,0 +1,19 @@
+# Variable: AttestationConnectorType
+
+> `const` **AttestationConnectorType**: `object`
+
+Attestation connector types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.

package/docs/reference/variables/AuditableItemGraphComponentType.md

@@ -0,0 +1,13 @@
+# Variable: AuditableItemGraphComponentType
+
+> `const` **AuditableItemGraphComponentType**: `object`
+
+Auditable item graph component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/AuditableItemStreamComponentType.md

@@ -0,0 +1,13 @@
+# Variable: AuditableItemStreamComponentType
+
+> `const` **AuditableItemStreamComponentType**: `object`
+
+Auditable item stream component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/AuthenticationComponentType.md

@@ -0,0 +1,13 @@
+# Variable: AuthenticationComponentType
+
+> `const` **AuthenticationComponentType**: `object`
+
+Authentication component types.
+
+## Type declaration
+
+### AuthEntityStorage
+
+> `readonly` **AuthEntityStorage**: `"auth-entity-storage"` = `"auth-entity-storage"`
+
+Authentication entity storage.

package/docs/reference/variables/BackgroundTaskConnectorType.md

@@ -0,0 +1,13 @@
+# Variable: BackgroundTaskConnectorType
+
+> `const` **BackgroundTaskConnectorType**: `object`
+
+Background task connector types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.

package/docs/reference/variables/BlobStorageComponentType.md

@@ -0,0 +1,13 @@
+# Variable: BlobStorageComponentType
+
+> `const` **BlobStorageComponentType**: `object`
+
+Blob storage component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/BlobStorageConnectorType.md

@@ -0,0 +1,43 @@
+# Variable: BlobStorageConnectorType
+
+> `const` **BlobStorageConnectorType**: `object`
+
+Blob storage connector types.
+
+## Type declaration
+
+### File
+
+> `readonly` **File**: `"file"` = `"file"`
+
+File storage.
+
+### Memory
+
+> `readonly` **Memory**: `"memory"` = `"memory"`
+
+Memory.
+
+### Ipfs
+
+> `readonly` **Ipfs**: `"ipfs"` = `"ipfs"`
+
+IPFS.
+
+### AwsS3
+
+> `readonly` **AwsS3**: `"aws-s3"` = `"aws-s3"`
+
+AWS S3.
+
+### AzureStorage
+
+> `readonly` **AzureStorage**: `"azure-storage"` = `"azure-storage"`
+
+Azure Storage.
+
+### GcpStorage
+
+> `readonly` **GcpStorage**: `"gcp-storage"` = `"gcp-storage"`
+
+GCP Storage.

package/docs/reference/variables/DltConfigType.md

@@ -0,0 +1,13 @@
+# Variable: DltConfigType
+
+> `const` **DltConfigType**: `object`
+
+DLT config types.
+
+## Type declaration
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.

package/docs/reference/variables/EngineCoreFactory.md

@@ -0,0 +1,5 @@
+# Variable: EngineCoreFactory
+
+> `const` **EngineCoreFactory**: `Factory`\<[`IEngineCore`](../interfaces/IEngineCore.md)\>
+
+Factory for creating engine cores.

package/docs/reference/variables/EngineServerFactory.md

@@ -0,0 +1,5 @@
+# Variable: EngineServerFactory
+
+> `const` **EngineServerFactory**: `Factory`\<[`IEngineServer`](../interfaces/IEngineServer.md)\>
+
+Factory for creating engine servers.

package/docs/reference/variables/EntityStorageComponentType.md

@@ -0,0 +1,13 @@
+# Variable: EntityStorageComponentType
+
+> `const` **EntityStorageComponentType**: `object`
+
+Entity storage component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/EntityStorageConnectorType.md

@@ -0,0 +1,43 @@
+# Variable: EntityStorageConnectorType
+
+> `const` **EntityStorageConnectorType**: `object`
+
+Entity storage connector types.
+
+## Type declaration
+
+### File
+
+> `readonly` **File**: `"file"` = `"file"`
+
+Use storage.
+
+### Memory
+
+> `readonly` **Memory**: `"memory"` = `"memory"`
+
+Memory.
+
+### ScyllaDb
+
+> `readonly` **ScyllaDb**: `"scylladb"` = `"scylladb"`
+
+ScyllaDb.
+
+### AwsDynamoDb
+
+> `readonly` **AwsDynamoDb**: `"aws-dynamodb"` = `"aws-dynamodb"`
+
+AWS DynamoDB.
+
+### AzureCosmosDb
+
+> `readonly` **AzureCosmosDb**: `"azure-cosmosdb"` = `"azure-cosmosdb"`
+
+Azure CosmosDB.
+
+### GcpFirestoreDb
+
+> `readonly` **GcpFirestoreDb**: `"gcp-firestoredb"` = `"gcp-firestoredb"`
+
+GCP Firestore.

package/docs/reference/variables/FaucetConnectorType.md

@@ -0,0 +1,19 @@
+# Variable: FaucetConnectorType
+
+> `const` **FaucetConnectorType**: `object`
+
+Faucet connector types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.

package/docs/reference/variables/IdentityComponentType.md

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

package/docs/reference/variables/IdentityConnectorType.md

@@ -0,0 +1,19 @@
+# Variable: IdentityConnectorType
+
+> `const` **IdentityConnectorType**: `object`
+
+Identity connector types.
+
+## Type declaration
+
+### EntityStorage
+
+> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
+
+Entity storage.
+
+### Iota
+
+> `readonly` **Iota**: `"iota"` = `"iota"`
+
+IOTA.

package/docs/reference/variables/IdentityProfileComponentType.md

@@ -0,0 +1,13 @@
+# Variable: IdentityProfileComponentType
+
+> `const` **IdentityProfileComponentType**: `object`
+
+Identity profile component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.