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

package/dist/types/models/types/loggingComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Logging component types.
+ */
+export declare const LoggingComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Logging component types.
+ */
+export type LoggingComponentType = (typeof LoggingComponentType)[keyof typeof LoggingComponentType];

package/dist/types/models/types/loggingConnectorType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Logging connector types.
+ */
+export declare const LoggingConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * Console.
+     */
+    readonly Console: "console";
+    /**
+     * Multi combines other loggers.
+     */
+    readonly Multi: "multi";
+};
+/**
+ * Logging connector types.
+ */
+export type LoggingConnectorType = (typeof LoggingConnectorType)[keyof typeof LoggingConnectorType];

package/dist/types/models/types/nftComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * NFT component types.
+ */
+export declare const NftComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * NFT component types.
+ */
+export type NftComponentType = (typeof NftComponentType)[keyof typeof NftComponentType];

package/dist/types/models/types/nftConnectorType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * NFT connector types.
+ */
+export declare const NftConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * NFT connector types.
+ */
+export type NftConnectorType = (typeof NftConnectorType)[keyof typeof NftConnectorType];

package/dist/types/models/types/telemetryComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Telemetry component types.
+ */
+export declare const TelemetryComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Telemetry component types.
+ */
+export type TelemetryComponentType = (typeof TelemetryComponentType)[keyof typeof TelemetryComponentType];

package/dist/types/models/types/telemetryConnectorType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Telemetry connector types.
+ */
+export declare const TelemetryConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+};
+/**
+ * Telemetry connector types.
+ */
+export type TelemetryConnectorType = (typeof TelemetryConnectorType)[keyof typeof TelemetryConnectorType];

package/dist/types/models/types/vaultConnectorType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Vault connector types.
+ */
+export declare const VaultConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * Hashicorp.
+     */
+    readonly Hashicorp: "hashicorp";
+};
+/**
+ * Vault connector types.
+ */
+export type VaultConnectorType = (typeof VaultConnectorType)[keyof typeof VaultConnectorType];

package/dist/types/models/types/walletConnectorType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Wallet connector types.
+ */
+export declare const WalletConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Wallet connector types.
+ */
+export type WalletConnectorType = (typeof WalletConnectorType)[keyof typeof WalletConnectorType];

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/engine-types - Changelog
+
+## v0.0.1-next.14
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/engine-types - Examples

package/docs/reference/functions/initialiseAttestationComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseAttestationComponent()
+
+> **initialiseAttestationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the attestation component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`AttestationComponentConfig`](../type-aliases/AttestationComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseAttestationConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseAttestationConnector()
+
+> **initialiseAttestationConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the attestation connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`AttestationConnectorConfig`](../type-aliases/AttestationConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseAuditableItemGraphComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseAuditableItemGraphComponent()
+
+> **initialiseAuditableItemGraphComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the auditable item graph component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`AuditableItemGraphComponentConfig`](../type-aliases/AuditableItemGraphComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseAuditableItemStreamComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseAuditableItemStreamComponent()
+
+> **initialiseAuditableItemStreamComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the auditable item stream component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`AuditableItemStreamComponentConfig`](../type-aliases/AuditableItemStreamComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseBackgroundTaskConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseBackgroundTaskConnector()
+
+> **initialiseBackgroundTaskConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise a background task connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`BackgroundTaskConnectorConfig`](../type-aliases/BackgroundTaskConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseBlobStorageComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseBlobStorageComponent()
+
+> **initialiseBlobStorageComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the blob storage component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`BlobStorageComponentConfig`](../type-aliases/BlobStorageComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseBlobStorageConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseBlobStorageConnector()
+
+> **initialiseBlobStorageConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the blob storage connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`BlobStorageConnectorConfig`](../type-aliases/BlobStorageConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseEntityStorageComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseEntityStorageComponent()
+
+> **initialiseEntityStorageComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the entity storage connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`EntityStorageComponentConfig`](../type-aliases/EntityStorageComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseEntityStorageConnector.md

@@ -0,0 +1,31 @@
+# Function: initialiseEntityStorageConnector()
+
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`): `void`
+
+Initialise the entity storage connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **typeCustom**: `undefined` \| `string`
+
+Override the type of connector to use instead of default configuration.
+
+• **schema**: `string`
+
+The schema for the entity storage.
+
+## Returns
+
+`void`
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseFaucetConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseFaucetConnector()
+
+> **initialiseFaucetConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise a faucet connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`FaucetConnectorConfig`](../type-aliases/FaucetConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseIdentityComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseIdentityComponent()
+
+> **initialiseIdentityComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the identity component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`IdentityComponentConfig`](../type-aliases/IdentityComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseIdentityConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseIdentityConnector()
+
+> **initialiseIdentityConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the identity connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`IdentityConnectorConfig`](../type-aliases/IdentityConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseIdentityProfileComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseIdentityProfileComponent()
+
+> **initialiseIdentityProfileComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the identity profile component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`IdentityProfileComponentConfig`](../type-aliases/IdentityProfileComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseIdentityProfileConnector.md

@@ -0,0 +1,33 @@
+# Function: initialiseIdentityProfileConnector()
+
+> **initialiseIdentityProfileConnector**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the identity profile connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`IdentityProfileConnectorConfig`](../type-aliases/IdentityProfileConnectorConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/functions/initialiseImmutableProofComponent.md

@@ -0,0 +1,33 @@
+# Function: initialiseImmutableProofComponent()
+
+> **initialiseImmutableProofComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `string` \| `undefined`
+
+Initialise the immutable proof component.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The engine core.
+
+• **context**: `IEngineCoreContext`\<[`IEngineCoreTypesConfig`](../interfaces/IEngineCoreTypesConfig.md), `IEngineState`\>
+
+The context for the engine.
+
+• **instanceConfig**: [`ImmutableProofComponentConfig`](../type-aliases/ImmutableProofComponentConfig.md)
+
+The instance config.
+
+• **overrideInstanceType?**: `string`
+
+The instance type to override the default.
+
+## Returns
+
+`string` \| `undefined`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.