@twin.org/node-core 0.0.3-next.33 → 0.0.3-next.35

package/dist/es/builders/engineEnvBuilder.js

@@ -2,8 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0.
 import path from "node:path";
 import { Coerce, Is } from "@twin.org/core";
-import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TrustComponentType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType } from "@twin.org/engine-types";
+import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AutomationComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataProcessingComponentType, DataspaceControlPlaneComponentType, DataspaceDataPlaneComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TrustComponentType, UrlTransformerComponentType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType } from "@twin.org/engine-types";
 import { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT } from "../defaults.js";
+import { isAuthEntityStorageRequired } from "./engineServerEnvBuilder.js";
 /**
  * Build the engine core configuration from environment variables.
  * @param envVars The environment variables.
@@ -34,11 +35,14 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
     await configureTelemetry(coreConfig, envVars);
     await configureMessaging(coreConfig, envVars);
     await configureAutomation(coreConfig, envVars);
+    await configureHealth(coreConfig, envVars);
+    await configureUrlTransformer(coreConfig, envVars);
     await configureFaucet(coreConfig, envVars);
     await configureWallet(coreConfig, envVars);
     await configureNft(coreConfig, envVars);
     await configureNotarization(coreConfig, envVars);
     await configureVerifiableStorage(coreConfig, envVars);
+    await configureImmutableProof(coreConfig, envVars);
     await configureIdentity(coreConfig, envVars);
     await configureIdentityResolver(coreConfig, envVars);
     await configureIdentityProfile(coreConfig, envVars);
@@ -391,7 +395,7 @@ async function configureVault(coreConfig, envVars) {
  */
 async function configureBackgroundTask(coreConfig, envVars) {
     coreConfig.types.backgroundTaskComponent ??= [];
-    if (Coerce.boolean(envVars.backgroundTasksEnabled) ?? false) {
+    if (isBackgroundTasksRequired(envVars)) {
         coreConfig.types.backgroundTaskComponent.push({
             type: BackgroundTaskComponentType.Service
         });
@@ -438,7 +442,7 @@ async function configureTelemetry(coreConfig, envVars) {
  */
 async function configureAutomation(coreConfig, envVars) {
     coreConfig.types.automationComponent ??= [];
-    if (Coerce.boolean(envVars.automationEnabled) ?? false) {
+    if (isAutomationRequired(envVars)) {
         coreConfig.types.automationComponent.push({
             type: AutomationComponentType.Service
         });
@@ -454,6 +458,45 @@ async function configureAutomation(coreConfig, envVars) {
         }
     }
 }
+/**
+ * Configures the health.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+async function configureHealth(coreConfig, envVars) {
+    coreConfig.types.healthComponent ??= [];
+    if (Coerce.boolean(envVars.healthEnabled) ?? false) {
+        coreConfig.types.healthComponent.push({
+            type: HealthComponentType.Service,
+            options: {
+                config: {
+                    healthCheckInterval: (Coerce.integer(envVars.healthIntervalSeconds) ?? 60) * 1000
+                }
+            }
+        });
+    }
+}
+/**
+ * Configures the url transformer.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+async function configureUrlTransformer(coreConfig, envVars) {
+    coreConfig.types.urlTransformerComponent ??= [];
+    if (isUrlTransformerRequired(envVars) ?? false) {
+        coreConfig.types.urlTransformerComponent.push({
+            type: UrlTransformerComponentType.Service,
+            options: {
+                config: {
+                    paramEncryptionKeyName: envVars.urlTransformerEncryptionKeyId,
+                    queryParamNames: {
+                        tenant: "tenant-token"
+                    }
+                }
+            }
+        });
+    }
+}
 /**
  * Configures the tenant.
  * @param coreConfig The core config.
@@ -692,6 +735,15 @@ async function configureVerifiableStorage(coreConfig, envVars) {
         coreConfig.types.verifiableStorageComponent.push({
             type: VerifiableStorageComponentType.Service
         });
+    }
+}
+/**
+ * Configures the immutable proof.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+async function configureImmutableProof(coreConfig, envVars) {
+    if (isImmutableProofRequired(envVars)) {
         coreConfig.types.immutableProofComponent ??= [];
         coreConfig.types.immutableProofComponent.push({
             type: ImmutableProofComponentType.Service,
@@ -881,7 +933,7 @@ async function configureDocumentManagement(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 async function configureTrust(coreConfig, envVars) {
-    if (Coerce.boolean(envVars.trustEnabled) ?? false) {
+    if (isTrustRequired(envVars)) {
         coreConfig.types.trustComponent ??= [];
         coreConfig.types.trustComponent.push({
             type: TrustComponentType.Service
@@ -914,7 +966,7 @@ async function configureTrust(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 async function configureRightsManagement(coreConfig, envVars) {
-    if (Coerce.boolean(envVars.rightsManagementEnabled) ?? false) {
+    if (isRightsManagementRequired(envVars)) {
         coreConfig.types.rightsManagementPapComponent ??= [];
         coreConfig.types.rightsManagementPapComponent.push({
             type: RightsManagementPapComponentType.Service
@@ -940,6 +992,8 @@ async function configureRightsManagement(coreConfig, envVars) {
             type: RightsManagementPepComponentType.Service
         });
         coreConfig.types.rightsManagementPnpComponent ??= [];
+        // Single source of truth for the rights-management mount path.
+        const rightsManagementPath = envVars.rightsManagementCallbackPath ?? "rights-management";
         // We add a multi instance REST client for the remote negotiations
         // use a dummy endpoint for now as the actual endpoint will be provided in the config
         // of the policy negotiator when it is used for remote negotiations
@@ -948,7 +1002,8 @@ async function configureRightsManagement(coreConfig, envVars) {
         coreConfig.types.rightsManagementPnpComponent.push({
             type: RightsManagementPnpComponentType.RestClient,
             options: {
-                endpoint: "http://localhost"
+                endpoint: "http://localhost",
+                pathPrefix: rightsManagementPath
             },
             isMultiInstance: true,
             features: ["remote"]
@@ -957,7 +1012,7 @@ async function configureRightsManagement(coreConfig, envVars) {
             type: RightsManagementPnpComponentType.Service,
             options: {
                 config: {
-                    callbackPath: envVars.rightsManagementCallbackPath ?? "",
+                    callbackPath: rightsManagementPath,
                     includeErrorDetails: coreConfig.debug ?? false
                 }
             },
@@ -1024,7 +1079,7 @@ async function configureRightsManagement(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 async function configureTaskScheduler(coreConfig, envVars) {
-    if (Coerce.boolean(envVars.taskSchedulerEnabled) ?? false) {
+    if (isTaskSchedulerRequired(envVars)) {
         coreConfig.types.taskSchedulerComponent ??= [];
         coreConfig.types.taskSchedulerComponent.push({
             type: TaskSchedulerComponentType.Service
@@ -1079,7 +1134,7 @@ async function configureSynchronisedStorage(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 async function configureFederatedCatalogue(coreConfig, envVars) {
-    if (Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false) {
+    if (isFederatedCatalogueRequired(envVars)) {
         // If synchronised storage is enabled, then we need to add an entity storage connector
         // using synchronised storage for the federated catalogue component
         // as it relies on the synchronised storage to sync the data between the different instances of the federated catalogue
@@ -1189,4 +1244,85 @@ function commaSeparatedListToArray(value) {
         .map(item => item.trim())
         .filter(item => item.length > 0);
 }
+/**
+ * Checks if the trust subsystem is required.
+ * Returns true when any component that depends on the trust subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if rights-management, synchronised-storage, or dataspace is enabled.
+ */
+export function isTrustRequired(envVars) {
+    return (isRightsManagementRequired(envVars) ||
+        (Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
+        (Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false));
+}
+/**
+ * Checks if the URL transformer subsystem is required.
+ * Returns true when any component that depends on the URL transformer subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if rights-management, dataspace, federated-catalogue, or tenant is enabled.
+ */
+export function isUrlTransformerRequired(envVars) {
+    return (isRightsManagementRequired(envVars) ||
+        (Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
+        (Coerce.boolean(envVars.tenantEnabled) ?? false) ||
+        isFederatedCatalogueRequired(envVars));
+}
+/**
+ * Checks if the background tasks subsystem is required.
+ * Returns true when any component that depends on the background tasks subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if dataspace or verifiable storage is enabled.
+ */
+export function isBackgroundTasksRequired(envVars) {
+    return (Coerce.boolean(envVars.dataspaceEnabled) ?? false) || isImmutableProofRequired(envVars);
+}
+/**
+ * Checks if the immutable proof subsystem is required.
+ * Returns true when any component that depends on the immutable proof subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if verifiable storage is enabled.
+ */
+export function isImmutableProofRequired(envVars) {
+    return (envVars.verifiableStorageConnector === VerifiableStorageConnectorType.EntityStorage ||
+        envVars.verifiableStorageConnector === VerifiableStorageConnectorType.Iota);
+}
+/**
+ * Checks if the immutable proof subsystem is required.
+ * Returns true when any component that depends on the immutable proof subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if verifiable storage is enabled.
+ */
+export function isFederatedCatalogueRequired(envVars) {
+    return Coerce.boolean(envVars.dataspaceEnabled) ?? false;
+}
+/**
+ * Checks if the rights management subsystem is required.
+ * Returns true when any component that depends on the rights management subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if rights management is enabled.
+ */
+export function isRightsManagementRequired(envVars) {
+    return Coerce.boolean(envVars.dataspaceEnabled) ?? false;
+}
+/**
+ * Checks if the task scheduler subsystem is required.
+ * Returns true when any component that depends on the task scheduler subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if task scheduler is enabled.
+ */
+export function isTaskSchedulerRequired(envVars) {
+    return ((Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
+        (Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false) ||
+        isRightsManagementRequired(envVars) ||
+        isAuthEntityStorageRequired(envVars));
+}
+/**
+ * Checks if the automation subsystem is required.
+ * Returns true when any component that depends on the automation subsystem is enabled.
+ * @param envVars The environment variables.
+ * @returns True if automation is enabled.
+ */
+export function isAutomationRequired(envVars) {
+    return isRightsManagementRequired(envVars);
+}
 //# sourceMappingURL=engineEnvBuilder.js.map