@twin.org/engine-types 0.0.2-next.4 → 0.0.2-next.6

package/dist/esm/index.mjs

@@ -15,6 +15,7 @@ import { MongoDbEntityStorageConnector } from '@twin.org/entity-storage-connecto
 import { MySqlEntityStorageConnector } from '@twin.org/entity-storage-connector-mysql';
 import { PostgreSqlEntityStorageConnector } from '@twin.org/entity-storage-connector-postgresql';
 import { ScyllaDBTableConnector } from '@twin.org/entity-storage-connector-scylladb';
+import { SynchronisedEntityStorageConnector } from '@twin.org/entity-storage-connector-synchronised';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { EntityStorageClient } from '@twin.org/entity-storage-rest-client';
 import { EntityStorageService } from '@twin.org/entity-storage-service';
@@ -42,7 +43,7 @@ import { LocalEventBusConnector } from '@twin.org/event-bus-connector-local';
 import { EventBusConnectorFactory } from '@twin.org/event-bus-models';
 import { EventBusService } from '@twin.org/event-bus-service';
 import { EventBusSocketClient } from '@twin.org/event-bus-socket-client';
-import { EntityStorageFaucetConnector, EntityStorageWalletConnector, initSchema as initSchema$g } from '@twin.org/wallet-connector-entity-storage';
+import { EntityStorageFaucetConnector, EntityStorageWalletConnector, initSchema as initSchema$h } from '@twin.org/wallet-connector-entity-storage';
 import { IotaFaucetConnector, IotaWalletConnector } from '@twin.org/wallet-connector-iota';
 import { FaucetConnectorFactory, WalletConnectorFactory } from '@twin.org/wallet-models';
 import { FederatedCatalogueClient } from '@twin.org/federated-catalogue-rest-client';
@@ -72,15 +73,17 @@ import { NftService } from '@twin.org/nft-service';
 import { RightsManagementClient } from '@twin.org/rights-management-rest-client';
 import { RightsManagementService } from '@twin.org/rights-management-service';
 import { initSchema as initSchema$c, PolicyAdministrationPointService } from '@twin.org/rights-management-pap-service';
+import { SynchronisedStorageClient } from '@twin.org/synchronised-storage-rest-client';
+import { initSchema as initSchema$d, SynchronisedStorageService } from '@twin.org/synchronised-storage-service';
 import { TaskSchedulerService } from '@twin.org/background-task-scheduler';
-import { initSchema as initSchema$d, EntityStorageTelemetryConnector } from '@twin.org/telemetry-connector-entity-storage';
+import { initSchema as initSchema$e, EntityStorageTelemetryConnector } from '@twin.org/telemetry-connector-entity-storage';
 import { TelemetryConnectorFactory } from '@twin.org/telemetry-models';
 import { TelemetryClient } from '@twin.org/telemetry-rest-client';
 import { TelemetryService } from '@twin.org/telemetry-service';
-import { initSchema as initSchema$e, EntityStorageVaultConnector } from '@twin.org/vault-connector-entity-storage';
+import { initSchema as initSchema$f, EntityStorageVaultConnector } from '@twin.org/vault-connector-entity-storage';
 import { HashicorpVaultConnector } from '@twin.org/vault-connector-hashicorp';
 import { VaultConnectorFactory } from '@twin.org/vault-models';
-import { initSchema as initSchema$f, EntityStorageVerifiableStorageConnector } from '@twin.org/verifiable-storage-connector-entity-storage';
+import { initSchema as initSchema$g, EntityStorageVerifiableStorageConnector } from '@twin.org/verifiable-storage-connector-entity-storage';
 import { IotaVerifiableStorageConnector } from '@twin.org/verifiable-storage-connector-iota';
 import { VerifiableStorageConnectorFactory } from '@twin.org/verifiable-storage-models';
 import { VerifiableStorageClient } from '@twin.org/verifiable-storage-rest-client';
@@ -136,8 +139,8 @@ function initialiseAttestationConnector(engineCore, context, instanceConfig, ove
     let instanceType;
     if (type === AttestationConnectorType.Nft) {
         connector = new NftAttestationConnector({
-            identityConnectorType: context.defaultTypes.identityConnector,
-            nftConnectorType: context.defaultTypes.nftConnector,
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            nftConnectorType: engineCore.getRegisteredInstanceType("nftConnector"),
             ...instanceConfig.options
         });
         instanceType = NftAttestationConnector.NAMESPACE;
@@ -256,7 +259,11 @@ const EntityStorageConnectorType = {
     /**
      * Postgre SQL.
      */
-    PostgreSql: "postgresql"
+    PostgreSql: "postgresql",
+    /**
+     * Synchronised.
+     */
+    Synchronised: "synchronised"
 };
 
 // Copyright 2024 IOTA Stiftung.
@@ -267,6 +274,7 @@ const EntityStorageConnectorType = {
  * @param context The context for the engine.
  * @param typeCustom Override the type of connector to use instead of default configuration.
  * @param schema The schema for the entity storage.
+ * @returns The name of the instance type that was created.
  * @throws GeneralError if the connector type is unknown.
  */
 function initialiseEntityStorageConnector(engineCore, context, typeCustom, schema) {
@@ -387,6 +395,23 @@ function initialiseEntityStorageConnector(engineCore, context, typeCustom, schem
                 }
             });
         }
+        else if (type === EntityStorageConnectorType.Synchronised) {
+            // Create the entity storage that is wrapped by the synchronised connector
+            // by removing the custom type it will default to the standard storage
+            // mechanism for entity storage
+            const wrappedInstanceName = initialiseEntityStorageConnector(engineCore, context, undefined, schema);
+            // Use the wrapped instance name as the entity storage connector type
+            // for the synchronised connector
+            entityStorageConnector = new SynchronisedEntityStorageConnector({
+                entitySchema: schema,
+                ...entityStorageConfig.options,
+                entityStorageConnectorType: wrappedInstanceName,
+                eventBusComponentType: engineCore.getRegisteredInstanceType("eventBusComponent"),
+                config: {
+                    ...entityStorageConfig.options.config
+                }
+            });
+        }
         else {
             throw new GeneralError("engineCore", "connectorUnknownType", {
                 type,
@@ -399,6 +424,7 @@ function initialiseEntityStorageConnector(engineCore, context, typeCustom, schem
         });
         EntityStorageConnectorFactory.register(instanceName, () => entityStorageConnector);
     }
+    return instanceName;
 }
 /**
  * Initialise the entity storage connector.
@@ -490,8 +516,8 @@ function initialiseAuditableItemGraphComponent(engineCore, context, instanceConf
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.vertexEntityStorageType, "AuditableItemGraphVertex");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.changesetEntityStorageType, "AuditableItemGraphChangeset");
         component = new AuditableItemGraphService({
-            immutableProofComponentType: context.defaultTypes.immutableProofComponent,
-            eventBusComponentType: context.defaultTypes.eventBusComponent,
+            immutableProofComponentType: engineCore.getRegisteredInstanceType("immutableProofComponent"),
+            eventBusComponentType: engineCore.getRegisteredInstanceTypeOptional("eventBusComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("AuditableItemGraphService");
@@ -553,8 +579,8 @@ function initialiseAuditableItemStreamComponent(engineCore, context, instanceCon
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.streamEntityStorageType, "AuditableItemStream");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.streamEntryEntityStorageType, "AuditableItemStreamEntry");
         component = new AuditableItemStreamService({
-            immutableProofComponentType: context.defaultTypes.immutableProofComponent,
-            eventBusComponentType: context.defaultTypes.eventBusComponent,
+            immutableProofComponentType: engineCore.getRegisteredInstanceType("immutableProofComponent"),
+            eventBusComponentType: engineCore.getRegisteredInstanceTypeOptional("eventBusComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("AuditableItemStreamService");
@@ -613,7 +639,7 @@ function initialiseBackgroundTaskConnector(engineCore, context, instanceConfig,
         initSchema$2();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.backgroundTaskEntityStorageType, "BackgroundTask");
         connector = new EntityStorageBackgroundTaskConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageBackgroundTaskConnector.NAMESPACE;
@@ -782,7 +808,7 @@ function initialiseBlobStorageComponent(engineCore, context, instanceConfig, ove
         initSchema$3();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.entryEntityStorageType, "BlobStorageEntry");
         component = new BlobStorageService({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("BlobStorageService");
@@ -1007,10 +1033,10 @@ function initialiseDocumentManagementComponent(engineCore, context, instanceConf
     let instanceType;
     if (type === DocumentManagementComponentType.Service) {
         component = new DocumentManagementService({
-            auditableItemGraphComponentType: context.defaultTypes.auditableItemGraphComponent,
-            blobStorageComponentType: context.defaultTypes.blobStorageComponent,
-            attestationComponentType: context.defaultTypes.attestationComponent,
-            dataProcessingComponentType: context.defaultTypes.dataProcessingComponent,
+            auditableItemGraphComponentType: engineCore.getRegisteredInstanceType("auditableItemGraphComponent"),
+            blobStorageComponentType: engineCore.getRegisteredInstanceType("blobStorageComponent"),
+            attestationComponentType: engineCore.getRegisteredInstanceType("attestationComponent"),
+            dataProcessingComponentType: engineCore.getRegisteredInstanceType("dataProcessingComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("DocumentManagementService");
@@ -1084,7 +1110,7 @@ function initialiseEventBusConnector(engineCore, context, instanceConfig, overri
     let instanceType;
     if (type === EventBusConnectorType.Local) {
         connector = new LocalEventBusConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = LocalEventBusConnector.NAMESPACE;
@@ -1118,14 +1144,14 @@ function initialiseEventBusComponent(engineCore, context, instanceConfig, overri
     let instanceType;
     if (type === EventBusComponentType.Service) {
         component = new EventBusService({
-            eventBusConnectorType: context.defaultTypes.eventBusConnector,
+            eventBusConnectorType: engineCore.getRegisteredInstanceType("eventBusConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("EventBusService");
     }
     else if (type === EventBusComponentType.SocketClient) {
         component = new EventBusSocketClient({
-            loggingComponentType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("EventBusSocketClient");
@@ -1178,7 +1204,8 @@ function initialiseFaucetConnector(engineCore, context, instanceConfig, override
     let connector;
     let instanceType;
     if (type === FaucetConnectorType.Iota) {
-        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === context.defaultTypes.dltConfig);
+        const defaultConfigType = engineCore.getRegisteredInstanceType("dltConfig");
+        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === defaultConfigType);
         connector = new IotaFaucetConnector({
             ...instanceConfig.options,
             config: {
@@ -1249,8 +1276,8 @@ function initialiseFederatedCatalogueComponent(engineCore, context, instanceConf
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.serviceOfferingEntityStorageType, "ServiceOfferingEntry");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.dataSpaceConnectorStorageType, "DataSpaceConnectorEntry");
         component = new FederatedCatalogueService({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
-            identityResolverComponentType: context.defaultTypes.identityResolverComponent,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            identityResolverComponentType: engineCore.getRegisteredInstanceType("identityResolverComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("FederatedCatalogueService");
@@ -1327,9 +1354,10 @@ function initialiseIdentityConnector(engineCore, context, instanceConfig, overri
     let connector;
     let instanceType;
     if (type === IdentityConnectorType.Iota) {
-        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === context.defaultTypes.dltConfig);
+        const defaultConfigType = engineCore.getRegisteredInstanceType("dltConfig");
+        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === defaultConfigType);
         connector = new IotaIdentityConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             ...instanceConfig.options,
             config: {
                 ...dltConfig?.options?.config,
@@ -1342,7 +1370,7 @@ function initialiseIdentityConnector(engineCore, context, instanceConfig, overri
         initSchema$6({ includeProfile: false });
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.didDocumentEntityStorageType, "IdentityDocument");
         connector = new EntityStorageIdentityConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageIdentityConnector.NAMESPACE;
@@ -1480,7 +1508,7 @@ function initialiseIdentityProfileComponent(engineCore, context, instanceConfig,
     let instanceType;
     if (type === IdentityProfileComponentType.Service) {
         component = new IdentityProfileService({
-            profileEntityConnectorType: context.defaultTypes.identityProfileConnector,
+            profileEntityConnectorType: engineCore.getRegisteredInstanceType("identityProfileConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("IdentityProfileService");
@@ -1561,7 +1589,8 @@ function initialiseIdentityResolverConnector(engineCore, context, instanceConfig
     let connector;
     let instanceType;
     if (type === IdentityResolverConnectorType.Iota) {
-        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === context.defaultTypes.dltConfig);
+        const defaultConfigType = engineCore.getRegisteredInstanceType("dltConfig");
+        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === defaultConfigType);
         connector = new IotaIdentityResolverConnector({
             ...instanceConfig.options,
             config: {
@@ -1575,7 +1604,7 @@ function initialiseIdentityResolverConnector(engineCore, context, instanceConfig
         initSchema$6({ includeProfile: false });
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.didDocumentEntityStorageType, "IdentityDocument");
         connector = new EntityStorageIdentityResolverConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageIdentityResolverConnector.NAMESPACE;
@@ -1614,8 +1643,9 @@ function initialiseIdentityResolverComponent(engineCore, context, instanceConfig
     let component;
     let instanceType;
     if (type === IdentityResolverComponentType.Service) {
+        const defaultIdentityResolverType = engineCore.getRegisteredInstanceType("identityResolverConnector");
         component = new IdentityResolverService({
-            fallbackResolverConnectorType: context.defaultTypes.identityResolverConnector !== IdentityResolverConnectorType.Universal
+            fallbackResolverConnectorType: defaultIdentityResolverType !== IdentityResolverConnectorType.Universal
                 ? IdentityResolverConnectorType.Universal
                 : undefined,
             ...instanceConfig.options
@@ -1677,10 +1707,10 @@ function initialiseImmutableProofComponent(engineCore, context, instanceConfig,
         initSchema$7();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.immutableProofEntityStorageType, "ImmutableProof");
         component = new ImmutableProofService({
-            verifiableStorageType: context.defaultTypes.verifiableStorageConnector,
-            identityConnectorType: context.defaultTypes.identityConnector,
-            backgroundTaskConnectorType: context.defaultTypes.backgroundTaskConnector,
-            eventBusComponentType: context.defaultTypes.eventBusComponent,
+            verifiableStorageType: engineCore.getRegisteredInstanceType("verifiableStorageConnector"),
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            backgroundTaskConnectorType: engineCore.getRegisteredInstanceType("backgroundTaskConnector"),
+            eventBusComponentType: engineCore.getRegisteredInstanceTypeOptional("eventBusComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("ImmutableProofService");
@@ -1803,7 +1833,7 @@ function initialiseLoggingComponent(engineCore, context, instanceConfig, overrid
     let instanceType;
     if (type === LoggingComponentType.Service) {
         component = new LoggingService({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingConnectorType: engineCore.getRegisteredInstanceType("loggingConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("LoggingService");
@@ -1910,14 +1940,14 @@ function initialiseMessagingEmailConnector(engineCore, context, instanceConfig,
         initSchema$9({ email: true, sms: false, pushNotification: false });
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingEmailEntryStorageConnectorType, "EmailEntry");
         connector = new EntityStorageMessagingEmailConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageMessagingEmailConnector.NAMESPACE;
     }
     else if (type === MessagingEmailConnectorType.Aws) {
         connector = new AwsMessagingEmailConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = AwsMessagingEmailConnector.NAMESPACE;
@@ -1953,14 +1983,14 @@ function initialiseMessagingSmsConnector(engineCore, context, instanceConfig, ov
         initSchema$9({ email: false, sms: true, pushNotification: false });
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingSmsEntryStorageConnectorType, "SmsEntry");
         connector = new EntityStorageMessagingSmsConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageMessagingSmsConnector.NAMESPACE;
     }
     else if (type === MessagingSmsConnectorType.Aws) {
         connector = new AwsMessagingSmsConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = AwsMessagingSmsConnector.NAMESPACE;
@@ -1997,14 +2027,14 @@ function initialiseMessagingPushNotificationConnector(engineCore, context, insta
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingDeviceEntryStorageConnectorType, "PushNotificationDeviceEntry");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingMessageEntryStorageConnectorType, "PushNotificationMessageEntry");
         connector = new EntityStorageMessagingPushNotificationConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageMessagingPushNotificationConnector.NAMESPACE;
     }
     else if (type === MessagingPushNotificationConnectorType.Aws) {
         connector = new AwsMessagingPushNotificationConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = AwsMessagingPushNotificationConnector.NAMESPACE;
@@ -2040,9 +2070,9 @@ function initialiseMessagingComponent(engineCore, context, instanceConfig, overr
         initSchema$a();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.templateEntryStorageConnectorType, "TemplateEntry");
         component = new MessagingService({
-            messagingEmailConnectorType: context.defaultTypes.messagingEmailConnector,
-            messagingSmsConnectorType: context.defaultTypes.messagingSmsConnector,
-            messagingPushNotificationConnectorType: context.defaultTypes.messagingNotificationConnector,
+            messagingEmailConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingEmailConnector"),
+            messagingSmsConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingSmsConnector"),
+            messagingPushNotificationConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingNotificationConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("MessagingService");
@@ -2119,8 +2149,8 @@ function initialiseNftConnector(engineCore, context, instanceConfig, overrideIns
     }
     else if (type === NftConnectorType.Iota) {
         connector = new IotaNftConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            walletConnectorType: context.defaultTypes.walletConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            walletConnectorType: engineCore.getRegisteredInstanceType("walletConnector"),
             ...instanceConfig.options
         });
         instanceType = IotaNftConnector.NAMESPACE;
@@ -2215,7 +2245,7 @@ function initialiseRightsManagementComponent(engineCore, context, instanceConfig
     let instanceType;
     if (type === RightsManagementComponentType.Service) {
         component = new RightsManagementService({
-            papComponentType: context.defaultTypes.rightsManagementPapComponent,
+            papComponentType: engineCore.getRegisteredInstanceType("rightsManagementPapComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("RightsManagementService");
@@ -2291,6 +2321,78 @@ function initialiseRightsManagementPapComponent(engineCore, context, instanceCon
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Synchronised storage component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service",
+    /**
+     * REST client.
+     */
+    RestClient: "rest-client"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Initialise the synchronised storage component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+function initialiseSynchronisedStorageComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
+        element: `Synchronised Storage Component: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === SynchronisedStorageComponentType.Service) {
+        initSchema$d();
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.syncSnapshotStorageConnectorType, "SyncSnapshotEntry");
+        component = new SynchronisedStorageService({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            eventBusComponentType: engineCore.getRegisteredInstanceType("eventBusComponent"),
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            verifiableStorageConnectorType: engineCore.getRegisteredInstanceType("verifiableStorageConnector"),
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            taskSchedulerComponentType: engineCore.getRegisteredInstanceType("taskSchedulerComponent"),
+            trustedSynchronisedStorageComponentType: engineCore.getRegisteredInstanceTypeOptional("synchronisedStorageComponent", ["trusted"]),
+            blobStorageConnectorType: engineCore.getRegisteredInstanceType("blobStorageConnector", [
+                "public"
+            ]),
+            ...instanceConfig.options
+        });
+        instanceType = StringHelper.kebabCase("SynchronisedStorageService");
+    }
+    else if (type === SynchronisedStorageComponentType.RestClient) {
+        component = new SynchronisedStorageClient(instanceConfig.options);
+        instanceType = StringHelper.kebabCase("SynchronisedStorageClient");
+    }
+    else {
+        throw new GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "SynchronisedStorageComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -2322,7 +2424,7 @@ function initialiseTaskSchedulerComponent(engineCore, context, instanceConfig, o
     let instanceType;
     if (type === TaskSchedulerComponentType.Service) {
         component = new TaskSchedulerService({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("TaskSchedulerService");
@@ -2391,11 +2493,11 @@ function initialiseTelemetryConnector(engineCore, context, instanceConfig, overr
     let connector;
     let instanceType;
     if (type === TelemetryConnectorType.EntityStorage) {
-        initSchema$d();
+        initSchema$e();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.telemetryMetricStorageConnectorType, "TelemetryMetric");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.telemetryMetricValueStorageConnectorType, "TelemetryMetricValue");
         connector = new EntityStorageTelemetryConnector({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageTelemetryConnector.NAMESPACE;
@@ -2429,7 +2531,7 @@ function initialiseTelemetryComponent(engineCore, context, instanceConfig, overr
     let instanceType;
     if (type === TelemetryComponentType.Service) {
         component = new TelemetryService({
-            telemetryConnectorType: context.defaultTypes.telemetryConnector,
+            telemetryConnectorType: engineCore.getRegisteredInstanceType("telemetryConnector"),
             ...instanceConfig.options
         });
         instanceType = StringHelper.kebabCase("TelemetryService");
@@ -2486,7 +2588,7 @@ function initialiseVaultConnector(engineCore, context, instanceConfig, overrideI
     let connector;
     let instanceType;
     if (type === VaultConnectorType.EntityStorage) {
-        initSchema$e();
+        initSchema$f();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.vaultKeyEntityStorageType, "VaultKey");
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.vaultSecretEntityStorageType, "VaultSecret");
         connector = new EntityStorageVaultConnector(instanceConfig.options);
@@ -2561,9 +2663,10 @@ function initialiseVerifiableStorageConnector(engineCore, context, instanceConfi
     let connector;
     let instanceType;
     if (type === VerifiableStorageConnectorType.Iota) {
-        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === context.defaultTypes.dltConfig);
+        const defaultConfigType = engineCore.getRegisteredInstanceType("dltConfig");
+        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === defaultConfigType);
         connector = new IotaVerifiableStorageConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             ...instanceConfig.options,
             config: {
                 ...dltConfig?.options?.config,
@@ -2573,7 +2676,7 @@ function initialiseVerifiableStorageConnector(engineCore, context, instanceConfi
         instanceType = IotaVerifiableStorageConnector.NAMESPACE;
     }
     else if (type === VerifiableStorageConnectorType.EntityStorage) {
-        initSchema$f();
+        initSchema$g();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.verifiableStorageEntityStorageType, "VerifiableItem");
         connector = new EntityStorageVerifiableStorageConnector(instanceConfig.options);
         instanceType = EntityStorageVerifiableStorageConnector.NAMESPACE;
@@ -2669,10 +2772,11 @@ function initialiseWalletConnector(engineCore, context, instanceConfig, override
     let connector;
     let instanceType;
     if (type === WalletConnectorType.Iota) {
-        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === context.defaultTypes.dltConfig);
+        const defaultConfigType = engineCore.getRegisteredInstanceType("dltConfig");
+        const dltConfig = context.config.types.dltConfig?.find(dlt => dlt.type === defaultConfigType);
         connector = new IotaWalletConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            faucetConnectorType: context.defaultTypes.faucetConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            faucetConnectorType: engineCore.getRegisteredInstanceType("faucetConnector"),
             ...instanceConfig.options,
             config: {
                 ...dltConfig?.options?.config,
@@ -2683,8 +2787,8 @@ function initialiseWalletConnector(engineCore, context, instanceConfig, override
     }
     else if (type === WalletConnectorType.EntityStorage) {
         connector = new EntityStorageWalletConnector({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            faucetConnectorType: context.defaultTypes.faucetConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            faucetConnectorType: engineCore.getRegisteredInstanceType("faucetConnector"),
             ...instanceConfig.options
         });
         instanceType = EntityStorageWalletConnector.NAMESPACE;
@@ -2716,7 +2820,7 @@ function initialiseWalletStorage(engineCore, context, instanceConfig, overrideIn
     const type = instanceConfig.type;
     if (type === WalletConnectorType.Iota) ;
     else if (type === WalletConnectorType.EntityStorage) {
-        initSchema$g();
+        initSchema$h();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.walletAddressEntityStorageType, "WalletAddress");
     }
     else {
@@ -2741,4 +2845,4 @@ const DltConfigType = {
     Iota: "iota"
 };
 
-export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, DocumentManagementComponentType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementComponentType, RightsManagementPapComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseDocumentManagementComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseFederatedCatalogueComponent, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseRightsManagementComponent, initialiseRightsManagementPapComponent, initialiseTaskSchedulerComponent, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseVerifiableStorageComponent, initialiseVerifiableStorageConnector, initialiseWalletConnector, initialiseWalletStorage };
+export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, DocumentManagementComponentType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementComponentType, RightsManagementPapComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseDocumentManagementComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseFederatedCatalogueComponent, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseRightsManagementComponent, initialiseRightsManagementPapComponent, initialiseSynchronisedStorageComponent, initialiseTaskSchedulerComponent, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseVerifiableStorageComponent, initialiseVerifiableStorageConnector, initialiseWalletConnector, initialiseWalletStorage };

package/dist/types/components/entityStorage.d.ts

@@ -7,9 +7,10 @@ import type { IEngineConfig } from "../models/IEngineConfig";
  * @param context The context for the engine.
  * @param typeCustom Override the type of connector to use instead of default configuration.
  * @param schema The schema for the entity storage.
+ * @returns The name of the instance type that was created.
  * @throws GeneralError if the connector type is unknown.
  */
-export declare function initialiseEntityStorageConnector(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, typeCustom: string | undefined, schema: string): void;
+export declare function initialiseEntityStorageConnector(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, typeCustom: string | undefined, schema: string): string;
 /**
  * Initialise the entity storage connector.
  * @param engineCore The engine core.

package/dist/types/components/synchronisedStorage.d.ts

@@ -0,0 +1,13 @@
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { SynchronisedStorageComponentConfig } from "../models/config/synchronisedStorageComponentConfig";
+import type { IEngineConfig } from "../models/IEngineConfig";
+/**
+ * Initialise the synchronised storage component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseSynchronisedStorageComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: SynchronisedStorageComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/index.d.ts

@@ -18,6 +18,7 @@ export * from "./components/messaging";
 export * from "./components/nft";
 export * from "./components/rightsManagement";
 export * from "./components/rightsManagementPap";
+export * from "./components/synchronisedStorage";
 export * from "./components/taskScheduler";
 export * from "./components/telemetry";
 export * from "./components/vault";
@@ -58,6 +59,7 @@ export * from "./models/config/nftComponentConfig";
 export * from "./models/config/nftConnectorConfig";
 export * from "./models/config/rightsManagementComponentConfig";
 export * from "./models/config/rightsManagementPapComponentConfig";
+export * from "./models/config/synchronisedStorageComponentConfig";
 export * from "./models/config/taskSchedulerComponentConfig";
 export * from "./models/config/telemetryComponentConfig";
 export * from "./models/config/telemetryConnectorConfig";
@@ -101,6 +103,7 @@ export * from "./models/types/nftComponentType";
 export * from "./models/types/nftConnectorType";
 export * from "./models/types/rightsManagementComponentType";
 export * from "./models/types/rightsManagementPapComponentType";
+export * from "./models/types/synchronisedStorageComponentType";
 export * from "./models/types/taskSchedulerComponentType";
 export * from "./models/types/telemetryComponentType";
 export * from "./models/types/telemetryConnectorType";

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

@@ -34,6 +34,7 @@ import type { NftComponentConfig } from "./config/nftComponentConfig";
 import type { NftConnectorConfig } from "./config/nftConnectorConfig";
 import type { RightsManagementComponentConfig } from "./config/rightsManagementComponentConfig";
 import type { RightsManagementPapComponentConfig } from "./config/rightsManagementPapComponentConfig";
+import type { SynchronisedStorageComponentConfig } from "./config/synchronisedStorageComponentConfig";
 import type { TaskSchedulerComponentConfig } from "./config/taskSchedulerComponentConfig";
 import type { TelemetryComponentConfig } from "./config/telemetryComponentConfig";
 import type { TelemetryConnectorConfig } from "./config/telemetryConnectorConfig";
@@ -206,10 +207,6 @@ export interface IEngineConfig extends IEngineCoreConfig {
          * Document management options which can be overridden by individual components by specifying types other than default.
          */
         documentManagementComponent?: IEngineCoreTypeConfig<DocumentManagementComponentConfig>[];
-        /**
-         * Federated catalogue options which can be overridden by individual components by specifying types other than default.
-         */
-        federatedCatalogueComponent?: IEngineCoreTypeConfig<FederatedCatalogueComponentConfig>[];
         /**
          * Rights management options which can be overridden by individual components by specifying types other than default.
          */
@@ -218,5 +215,13 @@ export interface IEngineConfig extends IEngineCoreConfig {
          * Rights management PAP options which can be overridden by individual components by specifying types other than default.
          */
         rightsManagementPapComponent?: IEngineCoreTypeConfig<RightsManagementPapComponentConfig>[];
+        /**
+         * Synchronised storage options which can be overridden by individual components by specifying types other than default.
+         */
+        synchronisedStorageComponent?: IEngineCoreTypeConfig<SynchronisedStorageComponentConfig>[];
+        /**
+         * Federated catalogue options which can be overridden by individual components by specifying types other than default.
+         */
+        federatedCatalogueComponent?: IEngineCoreTypeConfig<FederatedCatalogueComponentConfig>[];
     };
 }