@twin.org/engine-types 0.0.3-next.4 → 0.0.3-next.40

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

@@ -1,17 +0,0 @@
-/**
- * Rights management DAP component types.
- */
-export declare const RightsManagementDapComponentType: {
-    /**
-     * Service.
-     */
-    readonly Service: "service";
-    /**
-     * REST client.
-     */
-    readonly RestClient: "rest-client";
-};
-/**
- * Rights management DAP component types.
- */
-export type RightsManagementDapComponentType = (typeof RightsManagementDapComponentType)[keyof typeof RightsManagementDapComponentType];

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

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

package/docs/reference/functions/initialiseAuthenticationGeneratorComponent.md

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

package/docs/reference/functions/initialiseBackgroundTaskConnector.md

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

package/docs/reference/functions/initialiseDataSpaceConnectorComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseDataSpaceConnectorComponent()
-
-> **initialiseDataSpaceConnectorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
-
-Initialise the data space connector component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`DataSpaceConnectorComponentConfig`](../type-aliases/DataSpaceConnectorComponentConfig.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/initialiseRightsManagementDapComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseRightsManagementDapComponent()
-
-> **initialiseRightsManagementDapComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
-
-Initialise the rights management DAP component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`RightsManagementDapComponentConfig`](../type-aliases/RightsManagementDapComponentConfig.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/initialiseRightsManagementDarpComponent.md

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

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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/RightsManagementDapComponentConfig.md

@@ -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

@@ -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

@@ -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

@@ -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/variables/AuthenticationGeneratorComponentType.md

@@ -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

@@ -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

@@ -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

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