@twin.org/node-core 0.0.2-next.26 → 0.0.2-next.27

package/docs/reference/functions/start.md

@@ -1,6 +1,6 @@
 # Function: start()
 
-> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
+> **start**(`nodeOptions`, `nodeEngineConfig`, `envVars`, `contextIdKeys?`): `Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
 
 Start the engine server.
 
@@ -24,8 +24,14 @@ The configuration for the engine server.
 
 The environment variables.
 
+### contextIdKeys?
+
+`string`[]
+
+The context ID keys.
+
 ## Returns
 
-`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, `IEngineState`\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
+`Promise`\<`undefined` \| \{ `engine`: `Engine`\<`IEngineServerConfig`, [`INodeEngineState`](../interfaces/INodeEngineState.md)\>; `server`: `EngineServer`; `shutdown`: () => `Promise`\<`void`\>; \}\>
 
 The engine server.

package/docs/reference/index.md

@@ -7,6 +7,7 @@
 - [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
 - [IModuleProtocol](interfaces/IModuleProtocol.md)
 - [INodeEngineConfig](interfaces/INodeEngineConfig.md)
+- [INodeEngineState](interfaces/INodeEngineState.md)
 - [INodeEnvironmentVariables](interfaces/INodeEnvironmentVariables.md)
 - [INodeOptions](interfaces/INodeOptions.md)
 - [IProtocolHandlerResult](interfaces/IProtocolHandlerResult.md)
@@ -34,8 +35,10 @@
 ## Functions
 
 - [bootstrap](functions/bootstrap.md)
-- [bootstrapNodeIdentity](functions/bootstrapNodeIdentity.md)
-- [bootstrapNodeUser](functions/bootstrapNodeUser.md)
+- [bootstrapContextIdHandlers](functions/bootstrapContextIdHandlers.md)
+- [bootstrapNodeId](functions/bootstrapNodeId.md)
+- [bootstrapTenantId](functions/bootstrapTenantId.md)
+- [bootstrapNodeAdminUser](functions/bootstrapNodeAdminUser.md)
 - [bootstrapImmutableProofMethod](functions/bootstrapImmutableProofMethod.md)
 - [bootstrapBlobEncryption](functions/bootstrapBlobEncryption.md)
 - [bootstrapAuth](functions/bootstrapAuth.md)

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -32,6 +32,30 @@ The name of the state file.
 
 ***
 
+### tenantEnabled?
+
+> `optional` **tenantEnabled**: `string`
+
+Is multi-tenant support enabled, defaults to false.
+
+***
+
+### tenantId?
+
+> `optional` **tenantId**: `string`
+
+A tenant id to use as a default for the node.
+
+***
+
+### tenantApiKey?
+
+> `optional` **tenantApiKey**: `string`
+
+A tenant api key to use as a default for the node.
+
+***
+
 ### entityStorageConnectorType?
 
 > `optional` **entityStorageConnectorType**: `string`
@@ -571,15 +595,6 @@ Are the messaging components enabled, defaults to false.
 
 ***
 
-### messagingTemplates?
-
-> `optional` **messagingTemplates**: `string`
-
-An initial set of templates for the messages.
-Use the @json: prefix to specify the path to the JSON file.
-
-***
-
 ### awsSesRegion?
 
 > `optional` **awsSesRegion**: `string`

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -48,6 +48,42 @@ The name of the state file.
 
 ***
 
+### tenantEnabled?
+
+> `optional` **tenantEnabled**: `string`
+
+Is multi-tenant support enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
+
+***
+
+### tenantId?
+
+> `optional` **tenantId**: `string`
+
+A tenant id to use as a default for the node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantId`](IEngineEnvironmentVariables.md#tenantid)
+
+***
+
+### tenantApiKey?
+
+> `optional` **tenantApiKey**: `string`
+
+A tenant api key to use as a default for the node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantApiKey`](IEngineEnvironmentVariables.md#tenantapikey)
+
+***
+
 ### entityStorageConnectorType?
 
 > `optional` **entityStorageConnectorType**: `string`
@@ -855,19 +891,6 @@ Are the messaging components enabled, defaults to false.
 
 ***
 
-### messagingTemplates?
-
-> `optional` **messagingTemplates**: `string`
-
-An initial set of templates for the messages.
-Use the @json: prefix to specify the path to the JSON file.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingTemplates`](IEngineEnvironmentVariables.md#messagingtemplates)
-
-***
-
 ### awsSesRegion?
 
 > `optional` **awsSesRegion**: `string`

package/docs/reference/interfaces/INodeEngineConfig.md

@@ -5,3 +5,433 @@ The config for the node.
 ## Extends
 
 - `IEngineServerConfig`
+
+## Properties
+
+### debug?
+
+> `optional` **debug**: `boolean`
+
+Start the engine in debug mode.
+
+#### Default
+
+```ts
+false
+```
+
+#### Inherited from
+
+`IEngineServerConfig.debug`
+
+***
+
+### silent?
+
+> `optional` **silent**: `boolean`
+
+Disable output to the console.
+
+#### Default
+
+```ts
+false
+```
+
+#### Inherited from
+
+`IEngineServerConfig.silent`
+
+***
+
+### web?
+
+> `optional` **web**: `IWebServerOptions`
+
+Configuration for the web server.
+
+#### Inherited from
+
+`IEngineServerConfig.web`
+
+***
+
+### types
+
+> **types**: `object` & `object`
+
+The types to initialise in the engine.
+
+#### Type Declaration
+
+##### loggingConnector?
+
+> `optional` **loggingConnector**: `IEngineCoreTypeConfig`\<`LoggingConnectorConfig`\>[]
+
+Logging connector options which can be overridden by individual components by specifying types other than default.
+
+##### loggingComponent?
+
+> `optional` **loggingComponent**: `IEngineCoreTypeConfig`\<`LoggingComponentConfig`\>[]
+
+Logging component options which can be overridden by individual components by specifying types other than default.
+
+##### entityStorageConnector?
+
+> `optional` **entityStorageConnector**: `IEngineCoreTypeConfig`\<`EntityStorageConnectorConfig`\>[]
+
+Entity storage connector options which can be overridden by individual components by specifying types other than default.
+
+##### entityStorageComponent?
+
+> `optional` **entityStorageComponent**: `IEngineCoreTypeConfig`\<`EntityStorageComponentConfig`\>[]
+
+Entity storage component options which can be overridden by individual components by specifying types other than default.
+
+##### blobStorageConnector?
+
+> `optional` **blobStorageConnector**: `IEngineCoreTypeConfig`\<`BlobStorageConnectorConfig`\>[]
+
+Blob storage connector options which can be overridden by individual components by specifying types other than default.
+
+##### blobStorageComponent?
+
+> `optional` **blobStorageComponent**: `IEngineCoreTypeConfig`\<`BlobStorageComponentConfig`\>[]
+
+Blob storage component options which can be overridden by individual components by specifying types other than default.
+
+##### telemetryConnector?
+
+> `optional` **telemetryConnector**: `IEngineCoreTypeConfig`\<`TelemetryConnectorConfig`\>[]
+
+Telemetry connector options which can be overridden by individual components by specifying types other than default.
+
+##### telemetryComponent?
+
+> `optional` **telemetryComponent**: `IEngineCoreTypeConfig`\<`TelemetryComponentConfig`\>[]
+
+Telemetry component options which can be overridden by individual components by specifying types other than default.
+
+##### messagingEmailConnector?
+
+> `optional` **messagingEmailConnector**: `IEngineCoreTypeConfig`\<`MessagingEmailConnectorConfig`\>[]
+
+Messaging email connector options which can be overridden by individual components by specifying types other than default.
+
+##### messagingSmsConnector?
+
+> `optional` **messagingSmsConnector**: `IEngineCoreTypeConfig`\<`MessagingSmsConnectorConfig`\>[]
+
+Messaging SMS connector options which can be overridden by individual components by specifying types other than default.
+
+##### messagingPushNotificationConnector?
+
+> `optional` **messagingPushNotificationConnector**: `IEngineCoreTypeConfig`\<`MessagingPushNotificationConnectorConfig`\>[]
+
+Messaging push notification connector options which can be overridden by individual components by specifying types other than default.
+
+##### messagingAdminComponent?
+
+> `optional` **messagingAdminComponent**: `IEngineCoreTypeConfig`\<`MessagingAdminComponentConfig`\>[]
+
+Messaging admin component options which can be overridden by individual components by specifying types other than default.
+
+##### messagingComponent?
+
+> `optional` **messagingComponent**: `IEngineCoreTypeConfig`\<`MessagingComponentConfig`\>[]
+
+Messaging component options which can be overridden by individual components by specifying types other than default.
+
+##### backgroundTaskConnector?
+
+> `optional` **backgroundTaskConnector**: `IEngineCoreTypeConfig`\<`BackgroundTaskConnectorConfig`\>[]
+
+Background task connector options which can be overridden by individual components by specifying types other than default.
+
+##### taskSchedulerComponent?
+
+> `optional` **taskSchedulerComponent**: `IEngineCoreTypeConfig`\<`TaskSchedulerComponentConfig`\>[]
+
+Task scheduler component options which can be overridden by individual components by specifying types other than default.
+
+##### eventBusConnector?
+
+> `optional` **eventBusConnector**: `IEngineCoreTypeConfig`\<`EventBusConnectorConfig`\>[]
+
+Event bus connector options which can be overridden by individual components by specifying types other than default.
+
+##### eventBusComponent?
+
+> `optional` **eventBusComponent**: `IEngineCoreTypeConfig`\<`EventBusComponentConfig`\>[]
+
+Event bus component options which can be overridden by individual components by specifying types other than default.
+
+##### vaultConnector?
+
+> `optional` **vaultConnector**: `IEngineCoreTypeConfig`\<`VaultConnectorConfig`\>[]
+
+Vault connector options which can be overridden by individual components by specifying types other than default.
+
+##### dltConfig?
+
+> `optional` **dltConfig**: `IEngineCoreTypeConfig`\<`DltConfig`\>[]
+
+DLT options which can be overridden by individual components by specifying types other than default.
+
+##### walletConnector?
+
+> `optional` **walletConnector**: `IEngineCoreTypeConfig`\<`WalletConnectorConfig`\>[]
+
+Wallet connector options which can be overridden by individual components by specifying types other than default.
+
+##### verifiableStorageConnector?
+
+> `optional` **verifiableStorageConnector**: `IEngineCoreTypeConfig`\<`VerifiableStorageConnectorConfig`\>[]
+
+Verifiable storage connector options which can be overridden by individual components by specifying types other than default.
+
+##### verifiableStorageComponent?
+
+> `optional` **verifiableStorageComponent**: `IEngineCoreTypeConfig`\<`VerifiableStorageComponentConfig`\>[]
+
+Verifiable storage component options which can be overridden by individual components by specifying types other than default.
+
+##### immutableProofComponent?
+
+> `optional` **immutableProofComponent**: `IEngineCoreTypeConfig`\<`ImmutableProofComponentConfig`\>[]
+
+Immutable proof component options which can be overridden by individual components by specifying types other than default.
+
+##### faucetConnector?
+
+> `optional` **faucetConnector**: `IEngineCoreTypeConfig`\<`FaucetConnectorConfig`\>[]
+
+Faucet connector options which can be overridden by individual components by specifying types other than default.
+
+##### identityConnector?
+
+> `optional` **identityConnector**: `IEngineCoreTypeConfig`\<`IdentityConnectorConfig`\>[]
+
+Identity connector options which can be overridden by individual components by specifying types other than default.
+
+##### identityComponent?
+
+> `optional` **identityComponent**: `IEngineCoreTypeConfig`\<`IdentityComponentConfig`\>[]
+
+Identity component options which can be overridden by individual components by specifying types other than default.
+
+##### identityResolverConnector?
+
+> `optional` **identityResolverConnector**: `IEngineCoreTypeConfig`\<`IdentityResolverConnectorConfig`\>[]
+
+Identity resolver connector options which can be overridden by individual components by specifying types other than default.
+
+##### identityResolverComponent?
+
+> `optional` **identityResolverComponent**: `IEngineCoreTypeConfig`\<`IdentityResolverComponentConfig`\>[]
+
+Identity resolver component options which can be overridden by individual components by specifying types other than default.
+
+##### identityProfileConnector?
+
+> `optional` **identityProfileConnector**: `IEngineCoreTypeConfig`\<`IdentityProfileConnectorConfig`\>[]
+
+Identity profile connector options which can be overridden by individual components by specifying types other than default.
+
+##### identityProfileComponent?
+
+> `optional` **identityProfileComponent**: `IEngineCoreTypeConfig`\<`IdentityProfileComponentConfig`\>[]
+
+Identity profile component options which can be overridden by individual components by specifying types other than default.
+
+##### nftConnector?
+
+> `optional` **nftConnector**: `IEngineCoreTypeConfig`\<`NftConnectorConfig`\>[]
+
+NFT connector options which can be overridden by individual components by specifying types other than default.
+
+##### nftComponent?
+
+> `optional` **nftComponent**: `IEngineCoreTypeConfig`\<`NftComponentConfig`\>[]
+
+NFT component options which can be overridden by individual components by specifying types other than default.
+
+##### attestationConnector?
+
+> `optional` **attestationConnector**: `IEngineCoreTypeConfig`\<`AttestationConnectorConfig`\>[]
+
+Attestation connector options which can be overridden by individual components by specifying types other than default.
+
+##### attestationComponent?
+
+> `optional` **attestationComponent**: `IEngineCoreTypeConfig`\<`AttestationComponentConfig`\>[]
+
+Attestation component options which can be overridden by individual components by specifying types other than default.
+
+##### auditableItemGraphComponent?
+
+> `optional` **auditableItemGraphComponent**: `IEngineCoreTypeConfig`\<`AuditableItemGraphComponentConfig`\>[]
+
+Auditable item graph component options which can be overridden by individual components by specifying types other than default.
+
+##### auditableItemStreamComponent?
+
+> `optional` **auditableItemStreamComponent**: `IEngineCoreTypeConfig`\<`AuditableItemStreamComponentConfig`\>[]
+
+Auditable item stream component  options which can be overridden by individual components by specifying types other than default.
+
+##### dataConverterConnector?
+
+> `optional` **dataConverterConnector**: `IEngineCoreTypeConfig`\<`DataConverterConnectorConfig`\>[]
+
+Data converter connector options which can be overridden by individual components by specifying types other than default.
+
+##### dataExtractorConnector?
+
+> `optional` **dataExtractorConnector**: `IEngineCoreTypeConfig`\<`DataExtractorConnectorConfig`\>[]
+
+Data extractor connector options which can be overridden by individual components by specifying types other than default.
+
+##### dataProcessingComponent?
+
+> `optional` **dataProcessingComponent**: `IEngineCoreTypeConfig`\<`DataProcessingComponentConfig`\>[]
+
+Date processing options which can be overridden by individual components by specifying types other than default.
+
+##### documentManagementComponent?
+
+> `optional` **documentManagementComponent**: `IEngineCoreTypeConfig`\<`DocumentManagementComponentConfig`\>[]
+
+Document management options which can be overridden by individual components by specifying types other than default.
+
+##### authenticationGeneratorComponent?
+
+> `optional` **authenticationGeneratorComponent**: `IEngineCoreTypeConfig`\<`AuthenticationGeneratorComponentConfig`\>[]
+
+Authentication generator options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPapComponent?
+
+> `optional` **rightsManagementPapComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPapComponentConfig`\>[]
+
+Rights management PAP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPdpComponent?
+
+> `optional` **rightsManagementPdpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPdpComponentConfig`\>[]
+
+Rights management PDP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPepComponent?
+
+> `optional` **rightsManagementPepComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPepComponentConfig`\>[]
+
+Rights management PEP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPipComponent?
+
+> `optional` **rightsManagementPipComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPipComponentConfig`\>[]
+
+Rights management PIP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPmpComponent?
+
+> `optional` **rightsManagementPmpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPmpComponentConfig`\>[]
+
+Rights management PMP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPxpComponent?
+
+> `optional` **rightsManagementPxpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPxpComponentConfig`\>[]
+
+Rights management PXP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPnpComponent?
+
+> `optional` **rightsManagementPnpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPnpComponentConfig`\>[]
+
+Rights management PNP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementPnapComponent?
+
+> `optional` **rightsManagementPnapComponent**: `IEngineCoreTypeConfig`\<`RightsManagementPnapComponentConfig`\>[]
+
+Rights management PNAP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementDapComponent?
+
+> `optional` **rightsManagementDapComponent**: `IEngineCoreTypeConfig`\<`RightsManagementDapComponentConfig`\>[]
+
+Rights management DAP options which can be overridden by individual components by specifying types other than default.
+
+##### rightsManagementDarpComponent?
+
+> `optional` **rightsManagementDarpComponent**: `IEngineCoreTypeConfig`\<`RightsManagementDarpComponentConfig`\>[]
+
+Rights management DARP options which can be overridden by individual components by specifying types other than default.
+
+##### synchronisedStorageComponent?
+
+> `optional` **synchronisedStorageComponent**: `IEngineCoreTypeConfig`\<`SynchronisedStorageComponentConfig`\>[]
+
+Synchronised storage options which can be overridden by individual components by specifying types other than default.
+
+##### federatedCatalogueComponent?
+
+> `optional` **federatedCatalogueComponent**: `IEngineCoreTypeConfig`\<`FederatedCatalogueComponentConfig`\>[]
+
+Federated catalogue options which can be overridden by individual components by specifying types other than default.
+
+##### dataSpaceConnectorComponent?
+
+> `optional` **dataSpaceConnectorComponent**: `IEngineCoreTypeConfig`\<`DataSpaceConnectorComponentConfig`\>[]
+
+Data space connector options which can be overridden by individual components by specifying types other than default.
+
+##### tenantAdminComponent?
+
+> `optional` **tenantAdminComponent**: `IEngineCoreTypeConfig`\<`TenantAdminComponentConfig`\>[]
+
+Tenant admin component options which can be overridden by individual components by specifying types other than default.
+
+#### Type Declaration
+
+##### informationComponent?
+
+> `optional` **informationComponent**: `IEngineCoreTypeConfig`\<`InformationComponentConfig`\>[]
+
+Information component options which can be overridden by individual components by specifying types other than default..
+
+##### restRouteProcessor?
+
+> `optional` **restRouteProcessor**: `IEngineCoreTypeConfig`\<`RestRouteProcessorConfig`\>[]
+
+REST route processors options which can be overridden by individual components by specifying types other than default..
+
+##### socketRouteProcessor?
+
+> `optional` **socketRouteProcessor**: `IEngineCoreTypeConfig`\<`SocketRouteProcessorConfig`\>[]
+
+Socket route processors options which can be overridden by individual components by specifying types other than default..
+
+##### mimeTypeProcessor?
+
+> `optional` **mimeTypeProcessor**: `IEngineCoreTypeConfig`\<`MimeTypeProcessorConfig`\>[]
+
+Mime type processors options which can be overridden by individual components by specifying types other than default..
+
+##### authenticationComponent?
+
+> `optional` **authenticationComponent**: `IEngineCoreTypeConfig`\<`AuthenticationComponentConfig`\>[]
+
+Authentication component options which can be overridden by individual components by specifying types other than default..
+
+##### authenticationAdminComponent?
+
+> `optional` **authenticationAdminComponent**: `IEngineCoreTypeConfig`\<`AuthenticationAdminComponentConfig`\>[]
+
+Authentication admin component options which can be overridden by individual components by specifying types other than default..
+
+#### Inherited from
+
+`IEngineServerConfig.types`

package/docs/reference/interfaces/INodeEngineState.md

@@ -0,0 +1,39 @@
+# Interface: INodeEngineState
+
+The engine state for the node.
+
+## Extends
+
+- `IEngineState`
+
+## Properties
+
+### nodeId?
+
+> `optional` **nodeId**: `string`
+
+The identity for the node.
+
+***
+
+### nodeTenantId?
+
+> `optional` **nodeTenantId**: `string`
+
+The tenant id for the node.
+
+***
+
+### nodeOrganizationId?
+
+> `optional` **nodeOrganizationId**: `string`
+
+The identity for the organization.
+
+***
+
+### nodeAdminUserId?
+
+> `optional` **nodeAdminUserId**: `string`
+
+The identity for the admin user.