@twin.org/engine 0.0.1-next.52 → 0.0.1-next.53

package/dist/cjs/index.cjs

@@ -1,9 +1,10 @@
 'use strict';
 
 var engineCore = require('@twin.org/engine-core');
-var path = require('node:path');
 var core = require('@twin.org/core');
 var engineTypes = require('@twin.org/engine-types');
+var entity = require('@twin.org/entity');
+var path = require('node:path');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -64,6 +65,49 @@ class Engine extends engineCore.EngineCore {
         this.addTypeInitialiser("dataConverterConnector", this._context.config.types.dataConverterConnector, "@twin.org/engine-types", "initialiseDataConverterConnector");
         this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
         this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
+        this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for engine config.
+ */
+class EngineConfigHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EngineConfigHelper";
+    /**
+     * Add a custom entity storage to the engine configuration.
+     * @param engineConfig The engine configuration.
+     * @param entityTypeName The entity type name.
+     * @param entitySchema The entity schema.
+     * @param restPath The rest path to serve the entity storage from.
+     * @param options Additional options.
+     * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
+     * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
+     */
+    static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
+        core.Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
+        core.Guards.stringValue(EngineConfigHelper.CLASS_NAME, "entityTypeName", entityTypeName);
+        core.Guards.object(EngineConfigHelper.CLASS_NAME, "entitySchema", entitySchema);
+        core.Guards.stringValue(EngineConfigHelper.CLASS_NAME, "restPath", restPath);
+        engineConfig.types.entityStorageComponent ??= [];
+        entity.EntitySchemaFactory.register(entityTypeName, () => entitySchema);
+        engineConfig.types.entityStorageComponent.push({
+            type: engineTypes.EntityStorageComponentType.Service,
+            options: {
+                entityStorageType: entityTypeName,
+                config: {
+                    includeNodeIdentity: options?.includeNodeIdentity ?? true,
+                    includeUserIdentity: options?.includeUserIdentity ?? true
+                }
+            },
+            overrideInstanceType: core.StringHelper.kebabCase(entityTypeName),
+            restPath
+        });
     }
 }
 
@@ -89,31 +133,34 @@ function buildEngineConfiguration(envVars) {
         debug: core.Coerce.boolean(envVars.debug) ?? false,
         types: {}
     };
-    configureEntityStorageConnectors(coreConfig, envVars);
-    configureBlobStorageConnectors(coreConfig, envVars);
-    configureVaultConnectors(coreConfig, envVars);
-    configureLoggingConnectors(coreConfig, envVars);
-    configureBackgroundTaskConnectors(coreConfig, envVars);
-    configureEventBusConnectors(coreConfig, envVars);
-    configureTelemetryConnectors(coreConfig, envVars);
-    configureMessagingConnectors(coreConfig, envVars);
-    configureFaucetConnectors(coreConfig, envVars);
-    configureWalletConnectors(coreConfig, envVars);
-    configureNftConnectors(coreConfig, envVars);
-    configureImmutableStorageConnectors(coreConfig, envVars);
-    configureIdentityConnectors(coreConfig, envVars);
-    configureIdentityResolverConnectors(coreConfig, envVars);
-    configureIdentityProfileConnectors(coreConfig, envVars);
-    configureAttestationConnectors(coreConfig, envVars);
-    configureDataProcessingConnectors(coreConfig, envVars);
+    configureEntityStorage(coreConfig, envVars);
+    configureBlobStorage(coreConfig, envVars);
+    configureVault(coreConfig, envVars);
+    configureLogging(coreConfig, envVars);
+    configureBackgroundTask(coreConfig, envVars);
+    configureEventBus(coreConfig, envVars);
+    configureTelemetry(coreConfig, envVars);
+    configureMessaging(coreConfig, envVars);
+    configureFaucet(coreConfig, envVars);
+    configureWallet(coreConfig, envVars);
+    configureNft(coreConfig, envVars);
+    configureImmutableStorage(coreConfig, envVars);
+    configureIdentity(coreConfig, envVars);
+    configureIdentityResolver(coreConfig, envVars);
+    configureIdentityProfile(coreConfig, envVars);
+    configureAttestation(coreConfig, envVars);
+    configureDataProcessing(coreConfig, envVars);
+    configureAuditableItemGraph(coreConfig);
+    configureAuditableItemStream(coreConfig);
+    configureDocumentManagement(coreConfig);
     return coreConfig;
 }
 /**
- * Configures the entity storage connectors for the core.
+ * Configures the entity storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureEntityStorageConnectors(coreConfig, envVars) {
+function configureEntityStorage(coreConfig, envVars) {
     coreConfig.types ??= {};
     coreConfig.types.entityStorageConnector ??= [];
     if ((core.Coerce.boolean(envVars.entityMemoryEnable) ?? false) ||
@@ -258,11 +305,11 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the blob storage connectors for the core.
+ * Configures the blob storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureBlobStorageConnectors(coreConfig, envVars) {
+function configureBlobStorage(coreConfig, envVars) {
     coreConfig.types.blobStorageConnector ??= [];
     if ((core.Coerce.boolean(envVars.blobMemoryEnable) ?? false) ||
         envVars.blobStorageConnectorType === engineTypes.BlobStorageConnectorType.Memory) {
@@ -359,11 +406,11 @@ function configureBlobStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the logging connectors for the core.
+ * Configures the logging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureLoggingConnectors(coreConfig, envVars) {
+function configureLogging(coreConfig, envVars) {
     coreConfig.types.loggingConnector ??= [];
     const loggingConnectors = (envVars.loggingConnector ?? "").split(",");
     for (const loggingConnector of loggingConnectors) {
@@ -401,11 +448,11 @@ function configureLoggingConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the vault connectors for the core.
+ * Configures the vault.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureVaultConnectors(coreConfig, envVars) {
+function configureVault(coreConfig, envVars) {
     coreConfig.types.vaultConnector ??= [];
     if (envVars.vaultConnector === engineTypes.VaultConnectorType.EntityStorage) {
         coreConfig.types.vaultConnector.push({
@@ -425,11 +472,11 @@ function configureVaultConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the background task connectors for the core.
+ * Configures the background task.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureBackgroundTaskConnectors(coreConfig, envVars) {
+function configureBackgroundTask(coreConfig, envVars) {
     coreConfig.types.backgroundTaskConnector ??= [];
     if (envVars.backgroundTaskConnector === engineTypes.BackgroundTaskConnectorType.EntityStorage) {
         coreConfig.types.backgroundTaskConnector.push({
@@ -438,11 +485,11 @@ function configureBackgroundTaskConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the event bud connectors for the core.
+ * Configures the event bud.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureEventBusConnectors(coreConfig, envVars) {
+function configureEventBus(coreConfig, envVars) {
     coreConfig.types.eventBusConnector ??= [];
     if (envVars.eventBusConnector === engineTypes.EventBusConnectorType.Local) {
         coreConfig.types.eventBusConnector.push({
@@ -455,11 +502,11 @@ function configureEventBusConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the telemetry connectors for the core.
+ * Configures the telemetry.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureTelemetryConnectors(coreConfig, envVars) {
+function configureTelemetry(coreConfig, envVars) {
     coreConfig.types.telemetryConnector ??= [];
     if (envVars.telemetryConnector === engineTypes.TelemetryConnectorType.EntityStorage) {
         coreConfig.types.telemetryConnector.push({
@@ -472,11 +519,11 @@ function configureTelemetryConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the messaging connectors for the core.
+ * Configures the messaging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureMessagingConnectors(coreConfig, envVars) {
+function configureMessaging(coreConfig, envVars) {
     coreConfig.types.messagingEmailConnector ??= [];
     coreConfig.types.messagingSmsConnector ??= [];
     coreConfig.types.messagingPushNotificationConnector ??= [];
@@ -546,11 +593,11 @@ function configureMessagingConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the faucet connectors for the core.
+ * Configures the faucet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureFaucetConnectors(coreConfig, envVars) {
+function configureFaucet(coreConfig, envVars) {
     coreConfig.types.faucetConnector ??= [];
     if (envVars.faucetConnector === engineTypes.FaucetConnectorType.EntityStorage) {
         coreConfig.types.faucetConnector.push({
@@ -589,11 +636,11 @@ function configureFaucetConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the wallet connectors for the core.
+ * Configures the wallet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureWalletConnectors(coreConfig, envVars) {
+function configureWallet(coreConfig, envVars) {
     coreConfig.types.walletConnector ??= [];
     if (envVars.walletConnector === engineTypes.WalletConnectorType.EntityStorage) {
         coreConfig.types.walletConnector.push({
@@ -630,11 +677,11 @@ function configureWalletConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the NFT connectors for the core.
+ * Configures the NFT.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureNftConnectors(coreConfig, envVars) {
+function configureNft(coreConfig, envVars) {
     coreConfig.types.nftConnector ??= [];
     if (envVars.nftConnector === engineTypes.NftConnectorType.EntityStorage) {
         coreConfig.types.nftConnector.push({
@@ -675,11 +722,11 @@ function configureNftConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the immutable storage connectors for the core.
+ * Configures the immutable storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureImmutableStorageConnectors(coreConfig, envVars) {
+function configureImmutableStorage(coreConfig, envVars) {
     coreConfig.types.immutableStorageConnector ??= [];
     if (envVars.immutableStorageConnector === engineTypes.ImmutableStorageConnectorType.EntityStorage) {
         coreConfig.types.immutableStorageConnector.push({
@@ -740,11 +787,11 @@ function configureImmutableStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity connectors for the core.
+ * Configures the identity.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityConnectors(coreConfig, envVars) {
+function configureIdentity(coreConfig, envVars) {
     coreConfig.types.identityConnector ??= [];
     if (envVars.identityConnector === engineTypes.IdentityConnectorType.EntityStorage) {
         coreConfig.types.identityConnector.push({
@@ -785,11 +832,11 @@ function configureIdentityConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity resolver connectors for the core.
+ * Configures the identity resolver.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityResolverConnectors(coreConfig, envVars) {
+function configureIdentityResolver(coreConfig, envVars) {
     coreConfig.types.identityResolverConnector ??= [];
     if (envVars.identityResolverConnector === engineTypes.IdentityResolverConnectorType.EntityStorage) {
         coreConfig.types.identityResolverConnector.push({
@@ -832,11 +879,11 @@ function configureIdentityResolverConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity profile connectors for the core.
+ * Configures the identity profile.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityProfileConnectors(coreConfig, envVars) {
+function configureIdentityProfile(coreConfig, envVars) {
     coreConfig.types.identityProfileConnector ??= [];
     if (envVars.identityProfileConnector === engineTypes.IdentityConnectorType.EntityStorage) {
         coreConfig.types.identityProfileConnector.push({
@@ -849,11 +896,11 @@ function configureIdentityProfileConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the attestation connectors for the core.
+ * Configures the attestation.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureAttestationConnectors(coreConfig, envVars) {
+function configureAttestation(coreConfig, envVars) {
     coreConfig.types.attestationConnector ??= [];
     if (envVars.attestationConnector === engineTypes.AttestationConnectorType.Nft) {
         coreConfig.types.attestationConnector.push({
@@ -873,11 +920,37 @@ function configureAttestationConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the data processing connectors for the core.
+ * Configures the auditable item graph.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureDataProcessingConnectors(coreConfig, envVars) {
+function configureAuditableItemGraph(coreConfig, envVars) {
+    if (core.Is.arrayValue(coreConfig.types.immutableStorageConnector)) {
+        coreConfig.types.auditableItemGraphComponent ??= [];
+        coreConfig.types.auditableItemGraphComponent.push({
+            type: engineTypes.AuditableItemGraphComponentType.Service
+        });
+    }
+}
+/**
+ * Configures the auditable item stream.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureAuditableItemStream(coreConfig, envVars) {
+    if (core.Is.arrayValue(coreConfig.types.immutableStorageConnector)) {
+        coreConfig.types.auditableItemStreamComponent ??= [];
+        coreConfig.types.auditableItemStreamComponent.push({
+            type: engineTypes.AuditableItemStreamComponentType.Service
+        });
+    }
+}
+/**
+ * Configures the data processing.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDataProcessing(coreConfig, envVars) {
     coreConfig.types.dataConverterConnector ??= [];
     coreConfig.types.dataExtractorConnector ??= [];
     const converterConnectors = envVars.dataConverterConnectors?.split(",") ?? [];
@@ -907,6 +980,22 @@ function configureDataProcessingConnectors(coreConfig, envVars) {
         coreConfig.types.dataProcessingComponent.push({ type: engineTypes.DataProcessingComponentType.Service });
     }
 }
+/**
+ * Configures the document management.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDocumentManagement(coreConfig, envVars) {
+    if (core.Is.arrayValue(coreConfig.types.auditableItemGraphComponent) &&
+        core.Is.arrayValue(coreConfig.types.blobStorageComponent) &&
+        core.Is.arrayValue(coreConfig.types.attestationComponent)) {
+        coreConfig.types.documentManagementComponent ??= [];
+        coreConfig.types.documentManagementComponent.push({
+            type: engineTypes.DocumentManagementComponentType.Service
+        });
+    }
+}
 
 exports.Engine = Engine;
+exports.EngineConfigHelper = EngineConfigHelper;
 exports.buildEngineConfiguration = buildEngineConfiguration;

package/dist/esm/index.mjs

@@ -1,7 +1,8 @@
 import { EngineCore } from '@twin.org/engine-core';
+import { Guards, StringHelper, Is, Coerce } from '@twin.org/core';
+import { EntityStorageComponentType, EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, WalletConnectorType, NftConnectorType, NftComponentType, ImmutableStorageConnectorType, ImmutableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityConnectorType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DocumentManagementComponentType } from '@twin.org/engine-types';
+import { EntitySchemaFactory } from '@twin.org/entity';
 import path from 'node:path';
-import { Is, Coerce } from '@twin.org/core';
-import { EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, WalletConnectorType, NftConnectorType, NftComponentType, ImmutableStorageConnectorType, ImmutableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityConnectorType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType } from '@twin.org/engine-types';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -62,6 +63,49 @@ class Engine extends EngineCore {
         this.addTypeInitialiser("dataConverterConnector", this._context.config.types.dataConverterConnector, "@twin.org/engine-types", "initialiseDataConverterConnector");
         this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
         this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
+        this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for engine config.
+ */
+class EngineConfigHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EngineConfigHelper";
+    /**
+     * Add a custom entity storage to the engine configuration.
+     * @param engineConfig The engine configuration.
+     * @param entityTypeName The entity type name.
+     * @param entitySchema The entity schema.
+     * @param restPath The rest path to serve the entity storage from.
+     * @param options Additional options.
+     * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
+     * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
+     */
+    static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
+        Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
+        Guards.stringValue(EngineConfigHelper.CLASS_NAME, "entityTypeName", entityTypeName);
+        Guards.object(EngineConfigHelper.CLASS_NAME, "entitySchema", entitySchema);
+        Guards.stringValue(EngineConfigHelper.CLASS_NAME, "restPath", restPath);
+        engineConfig.types.entityStorageComponent ??= [];
+        EntitySchemaFactory.register(entityTypeName, () => entitySchema);
+        engineConfig.types.entityStorageComponent.push({
+            type: EntityStorageComponentType.Service,
+            options: {
+                entityStorageType: entityTypeName,
+                config: {
+                    includeNodeIdentity: options?.includeNodeIdentity ?? true,
+                    includeUserIdentity: options?.includeUserIdentity ?? true
+                }
+            },
+            overrideInstanceType: StringHelper.kebabCase(entityTypeName),
+            restPath
+        });
     }
 }
 
@@ -87,31 +131,34 @@ function buildEngineConfiguration(envVars) {
         debug: Coerce.boolean(envVars.debug) ?? false,
         types: {}
     };
-    configureEntityStorageConnectors(coreConfig, envVars);
-    configureBlobStorageConnectors(coreConfig, envVars);
-    configureVaultConnectors(coreConfig, envVars);
-    configureLoggingConnectors(coreConfig, envVars);
-    configureBackgroundTaskConnectors(coreConfig, envVars);
-    configureEventBusConnectors(coreConfig, envVars);
-    configureTelemetryConnectors(coreConfig, envVars);
-    configureMessagingConnectors(coreConfig, envVars);
-    configureFaucetConnectors(coreConfig, envVars);
-    configureWalletConnectors(coreConfig, envVars);
-    configureNftConnectors(coreConfig, envVars);
-    configureImmutableStorageConnectors(coreConfig, envVars);
-    configureIdentityConnectors(coreConfig, envVars);
-    configureIdentityResolverConnectors(coreConfig, envVars);
-    configureIdentityProfileConnectors(coreConfig, envVars);
-    configureAttestationConnectors(coreConfig, envVars);
-    configureDataProcessingConnectors(coreConfig, envVars);
+    configureEntityStorage(coreConfig, envVars);
+    configureBlobStorage(coreConfig, envVars);
+    configureVault(coreConfig, envVars);
+    configureLogging(coreConfig, envVars);
+    configureBackgroundTask(coreConfig, envVars);
+    configureEventBus(coreConfig, envVars);
+    configureTelemetry(coreConfig, envVars);
+    configureMessaging(coreConfig, envVars);
+    configureFaucet(coreConfig, envVars);
+    configureWallet(coreConfig, envVars);
+    configureNft(coreConfig, envVars);
+    configureImmutableStorage(coreConfig, envVars);
+    configureIdentity(coreConfig, envVars);
+    configureIdentityResolver(coreConfig, envVars);
+    configureIdentityProfile(coreConfig, envVars);
+    configureAttestation(coreConfig, envVars);
+    configureDataProcessing(coreConfig, envVars);
+    configureAuditableItemGraph(coreConfig);
+    configureAuditableItemStream(coreConfig);
+    configureDocumentManagement(coreConfig);
     return coreConfig;
 }
 /**
- * Configures the entity storage connectors for the core.
+ * Configures the entity storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureEntityStorageConnectors(coreConfig, envVars) {
+function configureEntityStorage(coreConfig, envVars) {
     coreConfig.types ??= {};
     coreConfig.types.entityStorageConnector ??= [];
     if ((Coerce.boolean(envVars.entityMemoryEnable) ?? false) ||
@@ -256,11 +303,11 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the blob storage connectors for the core.
+ * Configures the blob storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureBlobStorageConnectors(coreConfig, envVars) {
+function configureBlobStorage(coreConfig, envVars) {
     coreConfig.types.blobStorageConnector ??= [];
     if ((Coerce.boolean(envVars.blobMemoryEnable) ?? false) ||
         envVars.blobStorageConnectorType === BlobStorageConnectorType.Memory) {
@@ -357,11 +404,11 @@ function configureBlobStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the logging connectors for the core.
+ * Configures the logging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureLoggingConnectors(coreConfig, envVars) {
+function configureLogging(coreConfig, envVars) {
     coreConfig.types.loggingConnector ??= [];
     const loggingConnectors = (envVars.loggingConnector ?? "").split(",");
     for (const loggingConnector of loggingConnectors) {
@@ -399,11 +446,11 @@ function configureLoggingConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the vault connectors for the core.
+ * Configures the vault.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureVaultConnectors(coreConfig, envVars) {
+function configureVault(coreConfig, envVars) {
     coreConfig.types.vaultConnector ??= [];
     if (envVars.vaultConnector === VaultConnectorType.EntityStorage) {
         coreConfig.types.vaultConnector.push({
@@ -423,11 +470,11 @@ function configureVaultConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the background task connectors for the core.
+ * Configures the background task.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureBackgroundTaskConnectors(coreConfig, envVars) {
+function configureBackgroundTask(coreConfig, envVars) {
     coreConfig.types.backgroundTaskConnector ??= [];
     if (envVars.backgroundTaskConnector === BackgroundTaskConnectorType.EntityStorage) {
         coreConfig.types.backgroundTaskConnector.push({
@@ -436,11 +483,11 @@ function configureBackgroundTaskConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the event bud connectors for the core.
+ * Configures the event bud.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureEventBusConnectors(coreConfig, envVars) {
+function configureEventBus(coreConfig, envVars) {
     coreConfig.types.eventBusConnector ??= [];
     if (envVars.eventBusConnector === EventBusConnectorType.Local) {
         coreConfig.types.eventBusConnector.push({
@@ -453,11 +500,11 @@ function configureEventBusConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the telemetry connectors for the core.
+ * Configures the telemetry.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureTelemetryConnectors(coreConfig, envVars) {
+function configureTelemetry(coreConfig, envVars) {
     coreConfig.types.telemetryConnector ??= [];
     if (envVars.telemetryConnector === TelemetryConnectorType.EntityStorage) {
         coreConfig.types.telemetryConnector.push({
@@ -470,11 +517,11 @@ function configureTelemetryConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the messaging connectors for the core.
+ * Configures the messaging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureMessagingConnectors(coreConfig, envVars) {
+function configureMessaging(coreConfig, envVars) {
     coreConfig.types.messagingEmailConnector ??= [];
     coreConfig.types.messagingSmsConnector ??= [];
     coreConfig.types.messagingPushNotificationConnector ??= [];
@@ -544,11 +591,11 @@ function configureMessagingConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the faucet connectors for the core.
+ * Configures the faucet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureFaucetConnectors(coreConfig, envVars) {
+function configureFaucet(coreConfig, envVars) {
     coreConfig.types.faucetConnector ??= [];
     if (envVars.faucetConnector === FaucetConnectorType.EntityStorage) {
         coreConfig.types.faucetConnector.push({
@@ -587,11 +634,11 @@ function configureFaucetConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the wallet connectors for the core.
+ * Configures the wallet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureWalletConnectors(coreConfig, envVars) {
+function configureWallet(coreConfig, envVars) {
     coreConfig.types.walletConnector ??= [];
     if (envVars.walletConnector === WalletConnectorType.EntityStorage) {
         coreConfig.types.walletConnector.push({
@@ -628,11 +675,11 @@ function configureWalletConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the NFT connectors for the core.
+ * Configures the NFT.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureNftConnectors(coreConfig, envVars) {
+function configureNft(coreConfig, envVars) {
     coreConfig.types.nftConnector ??= [];
     if (envVars.nftConnector === NftConnectorType.EntityStorage) {
         coreConfig.types.nftConnector.push({
@@ -673,11 +720,11 @@ function configureNftConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the immutable storage connectors for the core.
+ * Configures the immutable storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureImmutableStorageConnectors(coreConfig, envVars) {
+function configureImmutableStorage(coreConfig, envVars) {
     coreConfig.types.immutableStorageConnector ??= [];
     if (envVars.immutableStorageConnector === ImmutableStorageConnectorType.EntityStorage) {
         coreConfig.types.immutableStorageConnector.push({
@@ -738,11 +785,11 @@ function configureImmutableStorageConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity connectors for the core.
+ * Configures the identity.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityConnectors(coreConfig, envVars) {
+function configureIdentity(coreConfig, envVars) {
     coreConfig.types.identityConnector ??= [];
     if (envVars.identityConnector === IdentityConnectorType.EntityStorage) {
         coreConfig.types.identityConnector.push({
@@ -783,11 +830,11 @@ function configureIdentityConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity resolver connectors for the core.
+ * Configures the identity resolver.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityResolverConnectors(coreConfig, envVars) {
+function configureIdentityResolver(coreConfig, envVars) {
     coreConfig.types.identityResolverConnector ??= [];
     if (envVars.identityResolverConnector === IdentityResolverConnectorType.EntityStorage) {
         coreConfig.types.identityResolverConnector.push({
@@ -830,11 +877,11 @@ function configureIdentityResolverConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the identity profile connectors for the core.
+ * Configures the identity profile.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureIdentityProfileConnectors(coreConfig, envVars) {
+function configureIdentityProfile(coreConfig, envVars) {
     coreConfig.types.identityProfileConnector ??= [];
     if (envVars.identityProfileConnector === IdentityConnectorType.EntityStorage) {
         coreConfig.types.identityProfileConnector.push({
@@ -847,11 +894,11 @@ function configureIdentityProfileConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the attestation connectors for the core.
+ * Configures the attestation.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureAttestationConnectors(coreConfig, envVars) {
+function configureAttestation(coreConfig, envVars) {
     coreConfig.types.attestationConnector ??= [];
     if (envVars.attestationConnector === AttestationConnectorType.Nft) {
         coreConfig.types.attestationConnector.push({
@@ -871,11 +918,37 @@ function configureAttestationConnectors(coreConfig, envVars) {
     }
 }
 /**
- * Configures the data processing connectors for the core.
+ * Configures the auditable item graph.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-function configureDataProcessingConnectors(coreConfig, envVars) {
+function configureAuditableItemGraph(coreConfig, envVars) {
+    if (Is.arrayValue(coreConfig.types.immutableStorageConnector)) {
+        coreConfig.types.auditableItemGraphComponent ??= [];
+        coreConfig.types.auditableItemGraphComponent.push({
+            type: AuditableItemGraphComponentType.Service
+        });
+    }
+}
+/**
+ * Configures the auditable item stream.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureAuditableItemStream(coreConfig, envVars) {
+    if (Is.arrayValue(coreConfig.types.immutableStorageConnector)) {
+        coreConfig.types.auditableItemStreamComponent ??= [];
+        coreConfig.types.auditableItemStreamComponent.push({
+            type: AuditableItemStreamComponentType.Service
+        });
+    }
+}
+/**
+ * Configures the data processing.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDataProcessing(coreConfig, envVars) {
     coreConfig.types.dataConverterConnector ??= [];
     coreConfig.types.dataExtractorConnector ??= [];
     const converterConnectors = envVars.dataConverterConnectors?.split(",") ?? [];
@@ -905,5 +978,20 @@ function configureDataProcessingConnectors(coreConfig, envVars) {
         coreConfig.types.dataProcessingComponent.push({ type: DataProcessingComponentType.Service });
     }
 }
+/**
+ * Configures the document management.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDocumentManagement(coreConfig, envVars) {
+    if (Is.arrayValue(coreConfig.types.auditableItemGraphComponent) &&
+        Is.arrayValue(coreConfig.types.blobStorageComponent) &&
+        Is.arrayValue(coreConfig.types.attestationComponent)) {
+        coreConfig.types.documentManagementComponent ??= [];
+        coreConfig.types.documentManagementComponent.push({
+            type: DocumentManagementComponentType.Service
+        });
+    }
+}
 
-export { Engine, buildEngineConfiguration };
+export { Engine, EngineConfigHelper, buildEngineConfiguration };

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./engine";
 export * from "./models/IEngineEnvironmentVariables";
+export * from "./utils/engineConfigHelper";
 export * from "./utils/engineEnvBuilder";

package/dist/types/utils/engineConfigHelper.d.ts

@@ -0,0 +1,25 @@
+import { type IEngineConfig } from "@twin.org/engine-types";
+import { type IEntitySchema } from "@twin.org/entity";
+/**
+ * Helper methods for engine config.
+ */
+export declare class EngineConfigHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Add a custom entity storage to the engine configuration.
+     * @param engineConfig The engine configuration.
+     * @param entityTypeName The entity type name.
+     * @param entitySchema The entity schema.
+     * @param restPath The rest path to serve the entity storage from.
+     * @param options Additional options.
+     * @param options.includeNodeIdentity Whether to include the node identity in the entity, defaults to true.
+     * @param options.includeUserIdentity Whether to include the user identity in the entity, defaults to true.
+     */
+    static addCustomEntityStorage<T>(engineConfig: IEngineConfig, entityTypeName: string, entitySchema: IEntitySchema<T>, restPath: string, options?: {
+        includeNodeIdentity?: boolean;
+        includeUserIdentity?: true;
+    }): void;
+}

package/docs/reference/classes/EngineConfigHelper.md

@@ -0,0 +1,79 @@
+# Class: EngineConfigHelper
+
+Helper methods for engine config.
+
+## Constructors
+
+### new EngineConfigHelper()
+
+> **new EngineConfigHelper**(): [`EngineConfigHelper`](EngineConfigHelper.md)
+
+#### Returns
+
+[`EngineConfigHelper`](EngineConfigHelper.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### addCustomEntityStorage()
+
+> `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath`, `options`?): `void`
+
+Add a custom entity storage to the engine configuration.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+##### engineConfig
+
+`IEngineConfig`
+
+The engine configuration.
+
+##### entityTypeName
+
+`string`
+
+The entity type name.
+
+##### entitySchema
+
+`IEntitySchema`\<`T`\>
+
+The entity schema.
+
+##### restPath
+
+`string`
+
+The rest path to serve the entity storage from.
+
+##### options?
+
+Additional options.
+
+###### includeNodeIdentity?
+
+`boolean`
+
+Whether to include the node identity in the entity, defaults to true.
+
+###### includeUserIdentity?
+
+`true`
+
+Whether to include the user identity in the entity, defaults to true.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [Engine](classes/Engine.md)
+- [EngineConfigHelper](classes/EngineConfigHelper.md)
 
 ## Interfaces
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine",
-	"version": "0.0.1-next.52",
+	"version": "0.0.1-next.53",
 	"description": "Engine implementation.",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,9 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.1-next.52",
-		"@twin.org/engine-types": "0.0.1-next.52"
+		"@twin.org/engine-core": "0.0.1-next.53",
+		"@twin.org/engine-types": "0.0.1-next.53",
+		"@twin.org/entity": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",