@twin.org/node-core 0.0.3-next.2 → 0.0.3-next.20

package/dist/es/builders/engineEnvBuilder.js

@@ -2,9 +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, AuthenticationGeneratorComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DataSpaceConnectorComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementDapComponentType, RightsManagementDarpComponentType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType } from "@twin.org/engine-types";
-import { DataAccessPointRestClient, PolicyNegotiationPointRestClient } from "@twin.org/rights-management-rest-client";
-import { ATTESTATION_VERIFICATION_METHOD_ID, BLOB_STORAGE_ENCRYPTION_KEY_ID, IMMUTABLE_PROOF_VERIFICATION_METHOD_ID, SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID, VC_AUTHENTICATION_VERIFICATION_METHOD_ID } from "../defaults.js";
+import { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskComponentType, BlobStorageComponentType, BlobStorageConnectorType, ContextIdHandlerComponentType, DataProcessingComponentType, DataSpaceConnectorComponentType, DltConfigType, DocumentManagementComponentType, EngineTypeHelper, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingAdminComponentType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementPapComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementPipComponentType, RightsManagementPmpComponentType, RightsManagementPnapComponentType, RightsManagementPnpComponentType, RightsManagementPxpComponentType, SynchronisedStorageComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, TenantAdminComponentType, TrustComponentType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType } from "@twin.org/engine-types";
+import { PolicyNegotiationPointRestClient } from "@twin.org/rights-management-rest-client";
+import { CONTEXT_ID_HANDLER_FEATURE_DID, CONTEXT_ID_HANDLER_FEATURE_TENANT } from "../defaults.js";
 /**
  * Build the engine core configuration from environment variables.
  * @param envVars The environment variables.
@@ -19,9 +19,11 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
     }
     const coreConfig = {
         debug: Coerce.boolean(envVars.debug) ?? false,
+        silent: Coerce.boolean(envVars.silent) ?? false,
         types: {}
     };
     await configureTenant(coreConfig, envVars);
+    await configureContextIdHandlers(coreConfig, envVars);
     await configureEntityStorage(coreConfig, envVars);
     await configureBlobStorage(coreConfig, envVars);
     await configureVault(coreConfig, envVars);
@@ -44,7 +46,7 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
     await configureAuditableItemGraph(coreConfig, envVars);
     await configureAuditableItemStream(coreConfig, envVars);
     await configureDocumentManagement(coreConfig, envVars);
-    await configureVerifiableCredentialAuthentication(coreConfig, envVars);
+    await configureTrust(coreConfig, envVars);
     await configureRightsManagement(coreConfig, envVars);
     await configureSynchronisedStorage(coreConfig, envVars);
     await configureFederatedCatalogue(coreConfig, envVars);
@@ -59,7 +61,7 @@ export async function buildEngineConfiguration(envVars, contextIdKeys) {
 async function configureEntityStorage(coreConfig, envVars) {
     coreConfig.types ??= {};
     coreConfig.types.entityStorageConnector ??= [];
-    const entityStorageConnectorTypes = envVars.entityStorageConnectorType?.split(",") ?? [];
+    const entityStorageConnectorTypes = commaSeparatedListToArray(envVars.entityStorageConnectorType);
     if (entityStorageConnectorTypes.includes(EntityStorageConnectorType.Memory)) {
         coreConfig.types.entityStorageConnector.push({
             type: EntityStorageConnectorType.Memory
@@ -83,7 +85,8 @@ async function configureEntityStorage(coreConfig, envVars) {
                     authMode: envVars.awsDynamodbAuthMode,
                     accessKeyId: envVars.awsDynamodbAccessKeyId,
                     secretAccessKey: envVars.awsDynamodbSecretAccessKey,
-                    endpoint: envVars.awsDynamodbEndpoint
+                    endpoint: envVars.awsDynamodbEndpoint,
+                    connectionTimeoutMs: Coerce.integer(envVars.awsDynamodbConnectionTimeoutMs)
                 },
                 tablePrefix: envVars.entityStorageTablePrefix
             }
@@ -123,7 +126,7 @@ async function configureEntityStorage(coreConfig, envVars) {
             type: EntityStorageConnectorType.ScyllaDb,
             options: {
                 config: {
-                    hosts: envVars.scylladbHosts?.split(",") ?? [],
+                    hosts: commaSeparatedListToArray(envVars.scylladbHosts),
                     localDataCenter: envVars.scylladbLocalDataCenter ?? "",
                     keyspace: envVars.scylladbKeyspace ?? "",
                     port: Coerce.integer(envVars.scylladbPort)
@@ -203,7 +206,7 @@ async function configureEntityStorage(coreConfig, envVars) {
  */
 async function configureBlobStorage(coreConfig, envVars) {
     coreConfig.types.blobStorageConnector ??= [];
-    const blobStorageConnectorTypes = envVars.blobStorageConnectorType?.split(",") ?? [];
+    const blobStorageConnectorTypes = commaSeparatedListToArray(envVars.blobStorageConnectorType);
     if (blobStorageConnectorTypes.includes(BlobStorageConnectorType.Memory)) {
         coreConfig.types.blobStorageConnector.push({
             type: BlobStorageConnectorType.Memory
@@ -300,7 +303,7 @@ async function configureBlobStorage(coreConfig, envVars) {
             options: {
                 config: {
                     vaultKeyId: (envVars.blobStorageEnableEncryption ?? false)
-                        ? (envVars.blobStorageEncryptionKeyId ?? BLOB_STORAGE_ENCRYPTION_KEY_ID)
+                        ? envVars.blobStorageEncryptionKeyId
                         : undefined
                 }
             }
@@ -314,7 +317,7 @@ async function configureBlobStorage(coreConfig, envVars) {
  */
 async function configureLogging(coreConfig, envVars) {
     coreConfig.types.loggingConnector ??= [];
-    const loggingConnectorTypes = (envVars.loggingConnector ?? "").split(",");
+    const loggingConnectorTypes = commaSeparatedListToArray(envVars.loggingConnector);
     let additionalConnectorCount = 0;
     for (const loggingConnector of loggingConnectorTypes) {
         if (loggingConnector === LoggingConnectorType.Console) {
@@ -368,7 +371,12 @@ async function configureVault(coreConfig, envVars) {
     coreConfig.types.vaultConnector ??= [];
     if (envVars.vaultConnector === VaultConnectorType.EntityStorage) {
         coreConfig.types.vaultConnector.push({
-            type: VaultConnectorType.EntityStorage
+            type: VaultConnectorType.EntityStorage,
+            options: {
+                config: {
+                    prefix: envVars.vaultPrefix
+                }
+            }
         });
     }
     else if (envVars.vaultConnector === VaultConnectorType.Hashicorp) {
@@ -377,7 +385,8 @@ async function configureVault(coreConfig, envVars) {
             options: {
                 config: {
                     endpoint: envVars.hashicorpVaultEndpoint ?? "",
-                    token: envVars.hashicorpVaultToken ?? ""
+                    token: envVars.hashicorpVaultToken ?? "",
+                    prefix: envVars.vaultPrefix
                 }
             }
         });
@@ -389,10 +398,10 @@ async function configureVault(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 async function configureBackgroundTask(coreConfig, envVars) {
-    coreConfig.types.backgroundTaskConnector ??= [];
-    if (envVars.backgroundTaskConnector === BackgroundTaskConnectorType.EntityStorage) {
-        coreConfig.types.backgroundTaskConnector.push({
-            type: BackgroundTaskConnectorType.EntityStorage
+    coreConfig.types.backgroundTaskComponent ??= [];
+    if (Coerce.boolean(envVars.backgroundTasksEnabled) ?? false) {
+        coreConfig.types.backgroundTaskComponent.push({
+            type: BackgroundTaskComponentType.Service
         });
     }
 }
@@ -445,6 +454,24 @@ async function configureTenant(coreConfig, envVars) {
         coreConfig.types.tenantComponent.push({ type: TenantAdminComponentType.Service });
     }
 }
+/**
+ * Configures the context id handlers.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+async function configureContextIdHandlers(coreConfig, envVars) {
+    coreConfig.types.contextIdHandlerComponent ??= [];
+    coreConfig.types.contextIdHandlerComponent.push({
+        type: ContextIdHandlerComponentType.Did,
+        features: [CONTEXT_ID_HANDLER_FEATURE_DID]
+    });
+    if (Coerce.boolean(envVars.tenantEnabled) ?? false) {
+        coreConfig.types.contextIdHandlerComponent.push({
+            type: ContextIdHandlerComponentType.Tenant,
+            features: [CONTEXT_ID_HANDLER_FEATURE_TENANT]
+        });
+    }
+}
 /**
  * Configures the messaging.
  * @param coreConfig The core config.
@@ -629,7 +656,7 @@ async function configureVerifiableStorage(coreConfig, envVars) {
             type: ImmutableProofComponentType.Service,
             options: {
                 config: {
-                    verificationMethodId: envVars.immutableProofVerificationMethodId ?? IMMUTABLE_PROOF_VERIFICATION_METHOD_ID
+                    verificationMethodId: envVars.immutableProofVerificationMethodId
                 }
             }
         });
@@ -652,7 +679,10 @@ async function configureIdentity(coreConfig, envVars) {
         coreConfig.types.identityConnector.push({
             type: IdentityConnectorType.Iota,
             options: {
-                config: dltConfig?.options?.config ?? {}
+                config: {
+                    ...(dltConfig?.options?.config ?? {}),
+                    walletAddressIndex: Coerce.integer(envVars.identityWalletAddressIndex) ?? 0
+                }
             }
         });
     }
@@ -734,7 +764,7 @@ async function configureAttestation(coreConfig, envVars) {
             type: AttestationComponentType.Service,
             options: {
                 config: {
-                    verificationMethodId: envVars.attestationVerificationMethodId ?? ATTESTATION_VERIFICATION_METHOD_ID
+                    verificationMethodId: envVars.attestationVerificationMethodId
                 }
             }
         });
@@ -776,27 +806,18 @@ async function configureDataProcessing(coreConfig, envVars) {
         coreConfig.types.dataProcessingComponent ??= [];
         coreConfig.types.dataProcessingComponent.push({ type: DataProcessingComponentType.Service });
         coreConfig.types.dataConverterConnector ??= [];
-        const converterConnectors = envVars.dataConverterConnectors?.split(",") ?? [];
+        const converterConnectors = commaSeparatedListToArray(envVars.dataConverterConnectors);
         for (const converterConnector of converterConnectors) {
-            if (converterConnector === DataConverterConnectorType.Json) {
-                coreConfig.types.dataConverterConnector.push({
-                    type: DataConverterConnectorType.Json
-                });
-            }
-            else if (converterConnector === DataConverterConnectorType.Xml) {
-                coreConfig.types.dataConverterConnector.push({
-                    type: DataConverterConnectorType.Xml
-                });
-            }
+            coreConfig.types.dataConverterConnector.push({
+                type: converterConnector
+            });
         }
         coreConfig.types.dataExtractorConnector ??= [];
-        const extractorConnectors = envVars.dataExtractorConnectors?.split(",") ?? [];
+        const extractorConnectors = commaSeparatedListToArray(envVars.dataExtractorConnectors);
         for (const extractorConnector of extractorConnectors) {
-            if (extractorConnector === DataExtractorConnectorType.JsonPath) {
-                coreConfig.types.dataExtractorConnector.push({
-                    type: DataExtractorConnectorType.JsonPath
-                });
-            }
+            coreConfig.types.dataExtractorConnector.push({
+                type: extractorConnector
+            });
         }
     }
 }
@@ -814,23 +835,36 @@ async function configureDocumentManagement(coreConfig, envVars) {
     }
 }
 /**
- * Configures the verifiable credential authentication.
+ * Configures the trust components.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
  */
-async function configureVerifiableCredentialAuthentication(coreConfig, envVars) {
-    if (Coerce.boolean(envVars.vcAuthenticationEnabled) ?? false) {
-        // Can only perform VC authentication if identity component is available
-        coreConfig.types.authenticationGeneratorComponent ??= [];
-        coreConfig.types.authenticationGeneratorComponent.push({
-            type: AuthenticationGeneratorComponentType.VerifiableCredential,
-            options: {
-                config: {
-                    verificationMethodId: envVars.vcAuthenticationVerificationMethodId ?? VC_AUTHENTICATION_VERIFICATION_METHOD_ID
-                }
-            },
-            features: ["verifiable-credential"]
+async function configureTrust(coreConfig, envVars) {
+    if (Coerce.boolean(envVars.trustEnabled) ?? false) {
+        coreConfig.types.trustComponent ??= [];
+        coreConfig.types.trustComponent.push({
+            type: TrustComponentType.Service
         });
+        coreConfig.types.trustGeneratorComponent ??= [];
+        const trustGeneratorTypes = commaSeparatedListToArray(envVars.trustGenerators);
+        for (const trustGeneratorType of trustGeneratorTypes) {
+            coreConfig.types.trustGeneratorComponent.push({
+                type: trustGeneratorType,
+                options: {
+                    config: {
+                        verificationMethodId: envVars.trustVerificationMethodId ?? "",
+                        tokenTtlInSeconds: Coerce.integer(envVars.trustJwtTtlSeconds)
+                    }
+                }
+            });
+        }
+        coreConfig.types.trustVerifierComponent ??= [];
+        const trustVerifierTypes = commaSeparatedListToArray(envVars.trustVerifiers);
+        for (const trustVerifierType of trustVerifierTypes) {
+            coreConfig.types.trustVerifierComponent.push({
+                type: trustVerifierType
+            });
+        }
     }
 }
 /**
@@ -850,55 +884,26 @@ async function configureRightsManagement(coreConfig, envVars) {
         });
         coreConfig.types.rightsManagementPipComponent ??= [];
         coreConfig.types.rightsManagementPipComponent.push({
-            type: RightsManagementPipComponentType.Service,
-            options: {
-                informationModulesConfig: Is.arrayValue(envVars.rightsManagementInformationSources)
-                    ? envVars.rightsManagementInformationSources
-                    : undefined
-            }
+            type: RightsManagementPipComponentType.Service
         });
         coreConfig.types.rightsManagementPxpComponent ??= [];
         coreConfig.types.rightsManagementPxpComponent.push({
-            type: RightsManagementPxpComponentType.Service,
-            options: {
-                actionModulesConfig: Is.arrayValue(envVars.rightsManagementExecutionActions)
-                    ? envVars.rightsManagementExecutionActions
-                    : undefined
-            }
+            type: RightsManagementPxpComponentType.Service
         });
         coreConfig.types.rightsManagementPdpComponent ??= [];
         coreConfig.types.rightsManagementPdpComponent.push({
-            type: RightsManagementPdpComponentType.Service,
-            options: {
-                arbiterModulesConfig: Is.arrayValue(envVars.rightsManagementArbiters)
-                    ? envVars.rightsManagementArbiters
-                    : undefined
-            }
+            type: RightsManagementPdpComponentType.Service
         });
         coreConfig.types.rightsManagementPepComponent ??= [];
         coreConfig.types.rightsManagementPepComponent.push({
-            type: RightsManagementPepComponentType.Service,
-            options: {
-                processorModulesConfig: Is.arrayValue(envVars.rightsManagementEnforcementProcessors)
-                    ? envVars.rightsManagementEnforcementProcessors
-                    : undefined
-            }
+            type: RightsManagementPepComponentType.Service
         });
         coreConfig.types.rightsManagementPnpComponent ??= [];
         coreConfig.types.rightsManagementPnpComponent.push({
             type: RightsManagementPnpComponentType.Service,
             options: {
-                negotiatorModulesConfig: Is.arrayValue(envVars.rightsManagementNegotiators)
-                    ? envVars.rightsManagementNegotiators
-                    : undefined,
-                requesterModulesConfig: Is.arrayValue(envVars.rightsManagementRequesters)
-                    ? envVars.rightsManagementRequesters
-                    : undefined,
                 config: {
-                    baseCallbackUrl: envVars.rightsManagementBaseCallbackUrl ?? "",
-                    offers: Is.arrayValue(envVars.rightsManagementOffers)
-                        ? envVars.rightsManagementOffers
-                        : [],
+                    callbackPath: envVars.rightsManagementCallbackPath ?? "",
                     negotiationComponentCreator: async (url) => new PolicyNegotiationPointRestClient({ endpoint: url })
                 }
             }
@@ -907,19 +912,48 @@ async function configureRightsManagement(coreConfig, envVars) {
         coreConfig.types.rightsManagementPnapComponent.push({
             type: RightsManagementPnapComponentType.Service
         });
-        coreConfig.types.rightsManagementDapComponent ??= [];
-        coreConfig.types.rightsManagementDapComponent.push({
-            type: RightsManagementDapComponentType.Service
-        });
-        coreConfig.types.rightsManagementDarpComponent ??= [];
-        coreConfig.types.rightsManagementDarpComponent.push({
-            type: RightsManagementDarpComponentType.Service,
-            options: {
-                config: {
-                    dataAccessComponentCreator: async (url) => new DataAccessPointRestClient({ endpoint: url })
-                }
-            }
-        });
+        coreConfig.types.rightsManagementPolicyArbiterComponent ??= [];
+        const policyArbiterTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyArbiters);
+        for (const policyArbiterType of policyArbiterTypes) {
+            coreConfig.types.rightsManagementPolicyArbiterComponent.push({
+                type: policyArbiterType
+            });
+        }
+        coreConfig.types.rightsManagementPolicyEnforcementProcessorComponent ??= [];
+        const policyEnforcementProcessTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyEnforcementProcessors);
+        for (const policyEnforcementProcessorType of policyEnforcementProcessTypes) {
+            coreConfig.types.rightsManagementPolicyEnforcementProcessorComponent.push({
+                type: policyEnforcementProcessorType
+            });
+        }
+        coreConfig.types.rightsManagementPolicyExecutionActionComponent ??= [];
+        const policyExecutionActionTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyExecutionActions);
+        for (const policyExecutionActionType of policyExecutionActionTypes) {
+            coreConfig.types.rightsManagementPolicyExecutionActionComponent.push({
+                type: policyExecutionActionType
+            });
+        }
+        coreConfig.types.rightsManagementPolicyInformationSourceComponent ??= [];
+        const policyInformationSourceTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyInformationSources);
+        for (const policyInformationSourceType of policyInformationSourceTypes) {
+            coreConfig.types.rightsManagementPolicyInformationSourceComponent.push({
+                type: policyInformationSourceType
+            });
+        }
+        coreConfig.types.rightsManagementPolicyRequesterComponent ??= [];
+        const policyRequesterTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyRequesters);
+        for (const policyRequesterType of policyRequesterTypes) {
+            coreConfig.types.rightsManagementPolicyRequesterComponent.push({
+                type: policyRequesterType
+            });
+        }
+        coreConfig.types.rightsManagementPolicyNegotiatorComponent ??= [];
+        const policyNegotiatorTypes = commaSeparatedListToArray(envVars.rightsManagementPolicyNegotiators);
+        for (const policyNegotiatorType of policyNegotiatorTypes) {
+            coreConfig.types.rightsManagementPolicyNegotiatorComponent.push({
+                type: policyNegotiatorType
+            });
+        }
     }
 }
 /**
@@ -955,8 +989,7 @@ async function configureSynchronisedStorage(coreConfig, envVars) {
             options: {
                 config: {
                     verifiableStorageKeyId: verifiableStorageKeyId ?? "",
-                    blobStorageEncryptionKeyId: envVars.synchronisedStorageBlobStorageEncryptionKeyId ??
-                        SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID,
+                    blobStorageEncryptionKeyId: envVars.synchronisedStorageBlobStorageEncryptionKeyId,
                     entityUpdateIntervalMinutes: Coerce.number(envVars.synchronisedStorageEntityUpdateIntervalMinutes),
                     consolidationIntervalMinutes: Coerce.number(envVars.synchronisedStorageConsolidationIntervalMinutes),
                     consolidationBatchSize: Coerce.number(envVars.synchronisedStorageConsolidationBatchSize),
@@ -988,13 +1021,16 @@ async function configureFederatedCatalogue(coreConfig, envVars) {
         coreConfig.types.federatedCatalogueComponent ??= [];
         coreConfig.types.federatedCatalogueComponent.push({
             type: FederatedCatalogueComponentType.Service,
-            options: {
-                config: {
-                    subResourceCacheTtlMs: Coerce.number(envVars.federatedCatalogueCacheTtlMs),
-                    clearingHouseApproverList: Coerce.object(envVars.federatedCatalogueClearingHouseApproverList) ?? []
-                }
-            }
+            options: {}
         });
+        coreConfig.types.federatedCatalogueFilterComponent ??= [];
+        const filters = commaSeparatedListToArray(envVars.federatedCatalogueFilters);
+        for (const filter of filters) {
+            coreConfig.types.federatedCatalogueFilterComponent.push({
+                type: filter,
+                options: {}
+            });
+        }
     }
 }
 /**
@@ -1048,4 +1084,15 @@ async function configureDlt(coreConfig, envVars) {
         });
     }
 }
+/**
+ * Converts a comma separated list to an array.
+ * @param value The comma separated list.
+ * @returns The array.
+ */
+function commaSeparatedListToArray(value) {
+    return (value ?? "")
+        .split(",")
+        .map(item => item.trim())
+        .filter(item => item.length > 0);
+}
 //# sourceMappingURL=engineEnvBuilder.js.map