@twin.org/node-core 0.0.3-next.49 → 0.0.3-next.50

package/dist/es/builders/engineEnvBuilder.js

@@ -2,7 +2,7 @@
 // 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, HealthComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TenantComponentType, TrustComponentType, UrlTransformerComponentType, 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, MetricsCollectorComponentType, MetricsProducerComponentType, NftComponentType, NftConnectorType, NotarizationComponentType, NotarizationConnectorType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TenantComponentType, TrustComponentType, TrustVerifierComponentType, UrlTransformerComponentType, VaultConnectorType, WalletConnectorType } from "@twin.org/engine-types";
 import { OpenTelemetryReaderTypes } from "@twin.org/telemetry-connector-opentelemetry";
 import { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT } from "../defaults.js";
 import { isAuthEntityStorageRequired } from "./engineServerEnvBuilder.js";
@@ -43,7 +43,6 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
     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);
@@ -55,7 +54,6 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
     await configureDocumentManagement(coreConfig, envVars);
     await configureTrust(coreConfig, envVars);
     await configureRightsManagement(coreConfig, envVars);
-    await configureSynchronisedStorage(coreConfig, envVars);
     await configureFederatedCatalogue(coreConfig, envVars);
     await configureDataspace(coreConfig, envVars);
     return coreConfig;
@@ -284,14 +282,6 @@ async function configureBlobStorage(coreConfig, envVars) {
             if (config.type === defaultStorageConnectorType) {
                 config.isDefault = true;
             }
-            // If this blob storage connector is the one to use for public access
-            // then add it as a feature
-            if (Is.stringValue(envVars.blobStorageConnectorPublic) &&
-                config.type === envVars.blobStorageConnectorPublic) {
-                config.features ??= [];
-                config.features.push("public");
-                break;
-            }
         }
     }
     if (coreConfig.types.blobStorageConnector.length > 0) {
@@ -764,40 +754,6 @@ async function configureNotarization(coreConfig, envVars) {
         coreConfig.types.notarizationComponent.push({ type: NotarizationComponentType.Service });
     }
 }
-/**
- * Configures the verifiable storage.
- * @param coreConfig The core config.
- * @param envVars The environment variables.
- */
-async function configureVerifiableStorage(coreConfig, envVars) {
-    coreConfig.types.verifiableStorageConnector ??= [];
-    if (envVars.verifiableStorageConnector === VerifiableStorageConnectorType.EntityStorage) {
-        coreConfig.types.verifiableStorageConnector.push({
-            type: VerifiableStorageConnectorType.EntityStorage
-        });
-    }
-    else if (envVars.verifiableStorageConnector === VerifiableStorageConnectorType.Iota) {
-        const dltConfig = EngineTypeHelper.getConfigOfType(coreConfig, "dltConfig", DltConfigType.Iota);
-        const config = {
-            ...dltConfig?.options?.config,
-            deploymentPkgId: Is.stringValue(envVars.verifiableStoragePackageId)
-                ? envVars.verifiableStoragePackageId
-                : undefined
-        };
-        coreConfig.types.verifiableStorageConnector.push({
-            type: VerifiableStorageConnectorType.Iota,
-            options: {
-                config
-            }
-        });
-    }
-    if (coreConfig.types.verifiableStorageConnector.length > 0) {
-        coreConfig.types.verifiableStorageComponent ??= [];
-        coreConfig.types.verifiableStorageComponent.push({
-            type: VerifiableStorageComponentType.Service
-        });
-    }
-}
 /**
  * Configures the immutable proof.
  * @param coreConfig The core config.
@@ -1023,9 +979,23 @@ async function configureTrust(coreConfig, envVars) {
         coreConfig.types.trustVerifierComponent ??= [];
         const trustVerifierTypes = commaSeparatedListToArray(envVars.trustVerifiers);
         for (const trustVerifierType of trustVerifierTypes) {
-            coreConfig.types.trustVerifierComponent.push({
-                type: trustVerifierType
-            });
+            const type = trustVerifierType;
+            if (type === TrustVerifierComponentType.IdentityAllowDeny) {
+                coreConfig.types.trustVerifierComponent.push({
+                    type,
+                    options: {
+                        config: {
+                            allowIdentities: commaSeparatedListToArray(envVars.trustIdentitiesAllow),
+                            denyIdentities: commaSeparatedListToArray(envVars.trustIdentitiesDeny)
+                        }
+                    }
+                });
+            }
+            else {
+                coreConfig.types.trustVerifierComponent.push({
+                    type
+                });
+            }
         }
     }
 }
@@ -1155,48 +1125,6 @@ async function configureTaskScheduler(coreConfig, envVars) {
         });
     }
 }
-/**
- * Configures the synchronised storage.
- * @param coreConfig The core config.
- * @param envVars The environment variables.
- */
-async function configureSynchronisedStorage(coreConfig, envVars) {
-    if (Is.arrayValue(coreConfig.types.identityResolverComponent) &&
-        (Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false)) {
-        // Check if the config provides a custom verifiable storage key id
-        let verifiableStorageKeyId = Coerce.string(envVars.synchronisedStorageVerifiableStorageKeyId);
-        if (!Is.stringValue(verifiableStorageKeyId)) {
-            // No custom key so default to the network setting
-            verifiableStorageKeyId = envVars.iotaNetwork;
-        }
-        coreConfig.types.synchronisedStorageComponent ??= [];
-        coreConfig.types.synchronisedStorageComponent.push({
-            type: SynchronisedStorageComponentType.Service,
-            options: {
-                config: {
-                    verifiableStorageKeyId: verifiableStorageKeyId ?? "",
-                    blobStorageEncryptionKeyId: envVars.synchronisedStorageBlobStorageEncryptionKeyId,
-                    entityUpdateIntervalMinutes: Coerce.number(envVars.synchronisedStorageEntityUpdateIntervalMinutes),
-                    consolidationIntervalMinutes: Coerce.number(envVars.synchronisedStorageConsolidationIntervalMinutes),
-                    consolidationBatchSize: Coerce.number(envVars.synchronisedStorageConsolidationBatchSize),
-                    maxConsolidations: Coerce.number(envVars.synchronisedStorageMaxConsolidations)
-                }
-            }
-        });
-        // If there is a trusted url set, we need to add a client
-        // and give it a feature of trusted so that when the synchronised
-        // storage is created it can pickup the correct component
-        if (Is.stringValue(envVars.synchronisedStorageTrustedUrl)) {
-            coreConfig.types.synchronisedStorageComponent.push({
-                type: SynchronisedStorageComponentType.RestClient,
-                options: {
-                    endpoint: envVars.synchronisedStorageTrustedUrl
-                },
-                features: ["trusted"]
-            });
-        }
-    }
-}
 /**
  * Configures the federated catalogue.
  * @param coreConfig The core config.
@@ -1204,41 +1132,28 @@ async function configureSynchronisedStorage(coreConfig, envVars) {
  */
 async function configureFederatedCatalogue(coreConfig, envVars) {
     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
-        let overrideEntityStorageType;
-        if ((Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false) &&
-            Is.arrayValue(coreConfig.types.entityStorageConnector)) {
-            let defaultConnector = coreConfig.types.entityStorageConnector.find(connector => connector.isDefault);
-            if (Is.empty(defaultConnector)) {
-                // If there is no default connector, we set the first one as the default one
-                defaultConnector = coreConfig.types.entityStorageConnector[0];
-            }
-            overrideEntityStorageType = "federated-catalogue-dataset";
-            coreConfig.types.entityStorageConnector ??= [];
-            coreConfig.types.entityStorageConnector.push({
-                type: EntityStorageConnectorType.Synchronised,
-                overrideInstanceType: overrideEntityStorageType,
+        coreConfig.types.federatedCatalogueComponent ??= [];
+        if (Is.stringValue(envVars.federatedCatalogueRemoteEndpoint)) {
+            coreConfig.types.federatedCatalogueComponent.push({
+                type: FederatedCatalogueComponentType.RestClient,
                 options: {
-                    entityStorageConnectorType: defaultConnector.type
+                    endpoint: envVars.federatedCatalogueRemoteEndpoint
                 }
             });
         }
-        coreConfig.types.federatedCatalogueComponent ??= [];
-        coreConfig.types.federatedCatalogueComponent.push({
-            type: FederatedCatalogueComponentType.Service,
-            options: {
-                datasetEntityStorageType: overrideEntityStorageType
-            }
-        });
-        coreConfig.types.federatedCatalogueFilterComponent ??= [];
-        const filters = commaSeparatedListToArray(envVars.federatedCatalogueFilters);
-        for (const filter of filters) {
-            coreConfig.types.federatedCatalogueFilterComponent.push({
-                type: filter,
+        else {
+            coreConfig.types.federatedCatalogueComponent.push({
+                type: FederatedCatalogueComponentType.Service,
                 options: {}
             });
+            coreConfig.types.federatedCatalogueFilterComponent ??= [];
+            const filters = commaSeparatedListToArray(envVars.federatedCatalogueFilters);
+            for (const filter of filters) {
+                coreConfig.types.federatedCatalogueFilterComponent.push({
+                    type: filter,
+                    options: {}
+                });
+            }
         }
     }
 }
@@ -1327,12 +1242,12 @@ function commaSeparatedListToArray(value) {
  * 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.
+ * @returns True if rights-management, or dataspace is enabled.
  */
 export function isTrustRequired(envVars) {
     return (isRightsManagementRequired(envVars) ||
         (Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
-        (Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false));
+        isFederatedCatalogueRequired(envVars));
 }
 /**
  * Checks if the URL transformer subsystem is required.
@@ -1374,7 +1289,10 @@ export function isImmutableProofRequired(envVars) {
  * @returns True if verifiable storage is enabled.
  */
 export function isFederatedCatalogueRequired(envVars) {
-    return Coerce.boolean(envVars.dataspaceEnabled) ?? false;
+    return ((Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false) ||
+        Is.stringValue(envVars.federatedCatalogueRemoteEndpoint) ||
+        Is.stringValue(envVars.federatedCatalogueFilters) ||
+        (Coerce.boolean(envVars.dataspaceEnabled) ?? false));
 }
 /**
  * Checks if the rights management subsystem is required.
@@ -1396,7 +1314,6 @@ export function isRightsManagementRequired(envVars) {
  */
 export function isTaskSchedulerRequired(envVars) {
     return ((Coerce.boolean(envVars.dataspaceEnabled) ?? false) ||
-        (Coerce.boolean(envVars.synchronisedStorageEnabled) ?? false) ||
         isRightsManagementRequired(envVars) ||
         isAuthEntityStorageRequired(envVars));
 }