npm - @twin.org/engine-types - Versions diffs - 0.0.3-next.5 → 0.0.3-next.50 - Mend

@twin.org/engine-types 0.0.3-next.5 → 0.0.3-next.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (629) hide show

package/docs/reference/functions/initialiseVerifiableStorageComponent.md DELETED Viewed

@@ -1,31 +0,0 @@
-# Function: initialiseVerifiableStorageComponent()
-> **initialiseVerifiableStorageComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
-Initialise the verifiable storage component.
-## Parameters
-### engineCore
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The engine core.
-### context
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The context for the engine.
-### instanceConfig
-[`VerifiableStorageComponentConfig`](../type-aliases/VerifiableStorageComponentConfig.md)
-The instance config.
-## Returns
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
-The instance created and the factory for it.

package/docs/reference/functions/initialiseVerifiableStorageConnector.md DELETED Viewed

@@ -1,31 +0,0 @@
-# Function: initialiseVerifiableStorageConnector()
-> **initialiseVerifiableStorageConnector**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IVerifiableStorageConnector`\>; `component?`: `IComponent`; \}\>
-Initialise the verifiable storage connector.
-## Parameters
-### engineCore
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The engine core.
-### context
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The context for the engine.
-### instanceConfig
-[`VerifiableStorageConnectorConfig`](../type-aliases/VerifiableStorageConnectorConfig.md)
-The instance config.
-## Returns
-`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IVerifiableStorageConnector`\>; `component?`: `IComponent`; \}\>
-The instance created and the factory for it.

package/docs/reference/type-aliases/AuthenticationGeneratorComponentConfig.md DELETED Viewed

@@ -1,17 +0,0 @@
-# Type Alias: AuthenticationGeneratorComponentConfig
-> **AuthenticationGeneratorComponentConfig** = `object`
-Authentication generator component config types.
-## Properties
-### type
-> **type**: *typeof* [`VerifiableCredential`](../variables/AuthenticationGeneratorComponentType.md#verifiablecredential)
-***
-### options
-> **options**: `IVerifiableCredentialAuthenticationGeneratorConstructorOptions`

package/docs/reference/type-aliases/AuthenticationGeneratorComponentType.md DELETED Viewed

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

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

@@ -1,17 +0,0 @@
-# Type Alias: BackgroundTaskConnectorConfig
-> **BackgroundTaskConnectorConfig** = `object`
-Background task connector config types.
-## Properties
-### type
-> **type**: *typeof* [`EntityStorage`](../variables/BackgroundTaskConnectorType.md#entitystorage)
-***
-### options?
-> `optional` **options**: `IEntityStorageBackgroundTaskConnectorConstructorOptions`

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

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

package/docs/reference/type-aliases/DataSpaceConnectorComponentConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: DataSpaceConnectorComponentConfig
-> **DataSpaceConnectorComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/DataSpaceConnectorComponentType.md#service); `options?`: `IDataSpaceConnectorServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/DataSpaceConnectorComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \} \| \{ `type`: *typeof* [`SocketClient`](../variables/DataSpaceConnectorComponentType.md#socketclient); `options`: `IDataSpaceConnectorSocketClientConstructorOptions`; \}
-Data space connector component config types.

package/docs/reference/type-aliases/DataSpaceConnectorComponentType.md DELETED Viewed

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

package/docs/reference/type-aliases/IVerifiableStorageComponentType.md DELETED Viewed

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

package/docs/reference/type-aliases/RightsManagementDapComponentConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: RightsManagementDapComponentConfig
-> **RightsManagementDapComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/RightsManagementDapComponentType.md#service); `options?`: `IDataAccessPointServiceConstructorOptions` & `object`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/RightsManagementDapComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
-Rights management DAP component config types.

package/docs/reference/type-aliases/RightsManagementDapComponentType.md DELETED Viewed

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

package/docs/reference/type-aliases/RightsManagementDarpComponentConfig.md DELETED Viewed

@@ -1,23 +0,0 @@
-# Type Alias: RightsManagementDarpComponentConfig
-> **RightsManagementDarpComponentConfig** = `object`
-Rights management DARP component config types.
-## Properties
-### type
-> **type**: *typeof* [`Service`](../variables/RightsManagementDarpComponentType.md#service)
-***
-### options
-> **options**: `IDataAccessRequestPointServiceConstructorOptions` & `object`
-#### Type Declaration
-##### negotiatorModulesConfig?
-> `optional` **negotiatorModulesConfig**: `IEngineModuleConfig`[]

package/docs/reference/type-aliases/RightsManagementDarpComponentType.md DELETED Viewed

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

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

@@ -1,5 +0,0 @@
-# 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 DELETED Viewed

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

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

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

package/docs/reference/type-aliases/VerifiableStorageConnectorConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: VerifiableStorageConnectorConfig
-> **VerifiableStorageConnectorConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/VerifiableStorageConnectorType.md#entitystorage); `options?`: `IEntityStorageVerifiableStorageConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Iota`](../variables/VerifiableStorageConnectorType.md#iota); `options`: `IIotaVerifiableStorageConnectorConstructorOptions`; \}
-Verifiable storage connector config types.

package/docs/reference/type-aliases/VerifiableStorageConnectorType.md DELETED Viewed

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

package/docs/reference/variables/AuthenticationGeneratorComponentType.md DELETED Viewed

@@ -1,13 +0,0 @@
-# Variable: AuthenticationGeneratorComponentType
-> `const` **AuthenticationGeneratorComponentType**: `object`
-Authentication generator component types.
-## Type Declaration
-### VerifiableCredential
-> `readonly` **VerifiableCredential**: `"verifiable-credential"` = `"verifiable-credential"`
-Verifiable Credential.

package/docs/reference/variables/BackgroundTaskConnectorType.md DELETED Viewed

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

package/docs/reference/variables/RightsManagementDapComponentType.md DELETED Viewed

@@ -1,19 +0,0 @@
-# Variable: RightsManagementDapComponentType
-> `const` **RightsManagementDapComponentType**: `object`
-Rights management DAP component types.
-## Type Declaration
-### Service
-> `readonly` **Service**: `"service"` = `"service"`
-Service.
-### RestClient
-> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
-REST client.

package/docs/reference/variables/RightsManagementDarpComponentType.md DELETED Viewed

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

package/docs/reference/variables/SynchronisedStorageComponentType.md DELETED Viewed

@@ -1,19 +0,0 @@
-# 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/VerifiableStorageConnectorType.md DELETED Viewed

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