@twin.org/engine-types 0.0.1-next.14

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

@@ -0,0 +1,31 @@
+# Type Alias: AuditableItemGraphComponentConfig
+
+> **AuditableItemGraphComponentConfig**: `object`
+
+Auditable item graph component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuditableItemGraphComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.immutableProofComponentType?
+
+> `optional` **immutableProofComponentType**: `string`
+
+### options.vertexEntityStorageType?
+
+> `optional` **vertexEntityStorageType**: `string`
+
+### options.changesetEntityStorageType?
+
+> `optional` **changesetEntityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IAuditableItemGraphServiceConfig`

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

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

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

@@ -0,0 +1,31 @@
+# Type Alias: AuditableItemStreamComponentConfig
+
+> **AuditableItemStreamComponentConfig**: `object`
+
+Auditable item stream component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `AuditableItemStreamComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.immutableProofComponentType?
+
+> `optional` **immutableProofComponentType**: `string`
+
+### options.streamEntityStorageType?
+
+> `optional` **streamEntityStorageType**: `string`
+
+### options.streamEntryEntityStorageType?
+
+> `optional` **streamEntryEntityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IAuditableItemStreamServiceConfig`

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

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

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

@@ -0,0 +1,27 @@
+# Type Alias: BackgroundTaskConnectorConfig
+
+> **BackgroundTaskConnectorConfig**: `object`
+
+Background task connector config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `BackgroundTaskConnectorType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.backgroundTaskEntityStorageType?
+
+> `optional` **backgroundTaskEntityStorageType**: `string`
+
+### options.loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageBackgroundTaskConnectorConfig`

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

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

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

@@ -0,0 +1,27 @@
+# Type Alias: BlobStorageComponentConfig
+
+> **BlobStorageComponentConfig**: `object`
+
+Blob storage component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `BlobStorageComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.entryEntityStorageType?
+
+> `optional` **entryEntityStorageType**: `string`
+
+### options.vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IBlobStorageServiceConfig`

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+# Type Alias: DltConfig
+
+> **DltConfig**: `object`
+
+DLT config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `DltConfigType.Iota`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.config?
+
+> `optional` **config**: `IIotaConfig`

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

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

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

@@ -0,0 +1,23 @@
+# Type Alias: EntityStorageComponentConfig
+
+> **EntityStorageComponentConfig**: `object`
+
+Entity storage component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `EntityStorageComponentType.Service`
+
+### options
+
+> **options**: `object`
+
+### options.entityStorageType
+
+> **entityStorageType**: `string`
+
+### options.config?
+
+> `optional` **config**: `IEntityStorageConfig`

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+# Type Alias: IdentityComponentConfig
+
+> **IdentityComponentConfig**: `object`
+
+Identity component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.config?
+
+> `optional` **config**: `IIdentityServiceConfig`

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+# Type Alias: IdentityProfileComponentConfig
+
+> **IdentityProfileComponentConfig**: `object`
+
+Identity profile component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityComponentType.Service`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.profileEntityConnectorType?
+
+> `optional` **profileEntityConnectorType**: `string`

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

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

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

@@ -0,0 +1,19 @@
+# Type Alias: IdentityProfileConnectorConfig
+
+> **IdentityProfileConnectorConfig**: `object`
+
+Identity profile connector config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* `IdentityProfileConnectorType.EntityStorage`
+
+### options?
+
+> `optional` **options**: `object`
+
+### options.profileEntityStorageType?
+
+> `optional` **profileEntityStorageType**: `string`

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/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/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/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.