@twin.org/node-core 0.0.3-next.53 → 0.0.3-next.55

package/dist/es/builders/engineEnvBuilder.js

@@ -62,6 +62,7 @@ export async function buildEngineConfiguration(envVars) {
  * Configures the entity storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the entity storage configuration has been applied.
  */
 async function configureEntityStorage(coreConfig, envVars) {
     coreConfig.types ??= {};
@@ -69,7 +70,8 @@ async function configureEntityStorage(coreConfig, envVars) {
     const entityStorageConnectorTypes = commaSeparatedListToArray(envVars.entityStorageConnectorType);
     if (entityStorageConnectorTypes.includes(EntityStorageConnectorType.Memory)) {
         coreConfig.types.entityStorageConnector.push({
-            type: EntityStorageConnectorType.Memory
+            type: EntityStorageConnectorType.Memory,
+            options: {}
         });
     }
     if (entityStorageConnectorTypes.includes(EntityStorageConnectorType.File)) {
@@ -199,6 +201,7 @@ async function configureEntityStorage(coreConfig, envVars) {
  * Configures the blob storage.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the blob storage configuration has been applied.
  */
 async function configureBlobStorage(coreConfig, envVars) {
     coreConfig.types.blobStorageConnector ??= [];
@@ -302,6 +305,7 @@ async function configureBlobStorage(coreConfig, envVars) {
  * Configures the logging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the logging configuration has been applied.
  */
 async function configureLogging(coreConfig, envVars) {
     coreConfig.types.loggingConnector ??= [];
@@ -360,6 +364,7 @@ async function configureLogging(coreConfig, envVars) {
  * Configures the vault.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the vault configuration has been applied.
  */
 async function configureVault(coreConfig, envVars) {
     coreConfig.types.vaultConnector ??= [];
@@ -390,6 +395,7 @@ async function configureVault(coreConfig, envVars) {
  * Configures the background task.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the background task configuration has been applied.
  */
 async function configureBackgroundTask(coreConfig, envVars) {
     coreConfig.types.backgroundTaskComponent ??= [];
@@ -400,9 +406,10 @@ async function configureBackgroundTask(coreConfig, envVars) {
     }
 }
 /**
- * Configures the event bud.
+ * Configures the event bus.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the event bus configuration has been applied.
  */
 async function configureEventBus(coreConfig, envVars) {
     coreConfig.types.eventBusConnector ??= [];
@@ -420,6 +427,7 @@ async function configureEventBus(coreConfig, envVars) {
  * Configures the telemetry.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the telemetry configuration has been applied.
  */
 async function configureTelemetry(coreConfig, envVars) {
     coreConfig.types.telemetryConnector ??= [];
@@ -458,6 +466,7 @@ async function configureTelemetry(coreConfig, envVars) {
  * Configures the metrics producers and orchestrator service.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the metrics collector configuration has been applied.
  */
 async function configureMetricsCollector(coreConfig, envVars) {
     if (isTelemetryRequired(envVars)) {
@@ -483,6 +492,7 @@ async function configureMetricsCollector(coreConfig, envVars) {
  * Configures the automation.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the automation configuration has been applied.
  */
 async function configureAutomation(coreConfig, envVars) {
     coreConfig.types.automationComponent ??= [];
@@ -506,6 +516,7 @@ async function configureAutomation(coreConfig, envVars) {
  * Configures the health.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the health configuration has been applied.
  */
 async function configureHealth(coreConfig, envVars) {
     coreConfig.types.healthComponent ??= [];
@@ -525,6 +536,7 @@ async function configureHealth(coreConfig, envVars) {
  * Configures the platform.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the platform configuration has been applied.
  */
 async function configurePlatform(coreConfig, envVars) {
     const isTenantEnabled = Coerce.boolean(envVars.tenantEnabled) ?? false;
@@ -542,6 +554,7 @@ async function configurePlatform(coreConfig, envVars) {
  * Configures the tenant.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the tenant configuration has been applied.
  */
 async function configureTenant(coreConfig, envVars) {
     const isTenantEnabled = Coerce.boolean(envVars.tenantEnabled) ?? false;
@@ -553,9 +566,10 @@ async function configureTenant(coreConfig, envVars) {
     }
 }
 /**
- * Configures the context id handlers.
+ * Configures the context ID handlers.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the context ID handler configuration has been applied.
  */
 async function configureContextIdHandlers(coreConfig, envVars) {
     coreConfig.types.contextIdHandlerComponent ??= [];
@@ -574,6 +588,7 @@ async function configureContextIdHandlers(coreConfig, envVars) {
  * Configures the messaging.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the messaging configuration has been applied.
  */
 async function configureMessaging(coreConfig, envVars) {
     if (Coerce.boolean(envVars.messagingEnabled) ?? false) {
@@ -625,6 +640,16 @@ async function configureMessaging(coreConfig, envVars) {
             });
         }
         else if (envVars.messagingPushNotificationConnector === MessagingPushNotificationConnectorType.Aws) {
+            let messagingApps;
+            if (Is.stringValue(envVars.awsMessagingPushNotificationApplications)) {
+                try {
+                    messagingApps = JSON.parse(envVars.awsMessagingPushNotificationApplications);
+                }
+                catch { }
+            }
+            else if (Is.array(envVars.awsMessagingPushNotificationApplications)) {
+                messagingApps = envVars.awsMessagingPushNotificationApplications;
+            }
             coreConfig.types.messagingPushNotificationConnector.push({
                 type: MessagingPushNotificationConnectorType.Aws,
                 options: {
@@ -634,9 +659,7 @@ async function configureMessaging(coreConfig, envVars) {
                         accessKeyId: envVars.awsSesAccessKeyId,
                         secretAccessKey: envVars.awsSesSecretAccessKey,
                         endpoint: envVars.awsSesEndpoint,
-                        applicationsSettings: Is.array(envVars.awsMessagingPushNotificationApplications)
-                            ? JSON.parse(envVars.awsMessagingPushNotificationApplications)
-                            : []
+                        applicationsSettings: messagingApps ?? []
                     }
                 }
             });
@@ -653,6 +676,7 @@ async function configureMessaging(coreConfig, envVars) {
  * Configures the faucet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the faucet configuration has been applied.
  */
 async function configureFaucet(coreConfig, envVars) {
     coreConfig.types.faucetConnector ??= [];
@@ -679,6 +703,7 @@ async function configureFaucet(coreConfig, envVars) {
  * Configures the wallet.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the wallet configuration has been applied.
  */
 async function configureWallet(coreConfig, envVars) {
     coreConfig.types.walletConnector ??= [];
@@ -701,6 +726,7 @@ async function configureWallet(coreConfig, envVars) {
  * Configures the NFT.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the NFT configuration has been applied.
  */
 async function configureNft(coreConfig, envVars) {
     coreConfig.types.nftConnector ??= [];
@@ -731,6 +757,7 @@ async function configureNft(coreConfig, envVars) {
  * Configures the notarization.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the notarization configuration has been applied.
  */
 async function configureNotarization(coreConfig, envVars) {
     coreConfig.types.notarizationConnector ??= [];
@@ -757,6 +784,7 @@ async function configureNotarization(coreConfig, envVars) {
  * Configures the immutable proof.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the immutable proof configuration has been applied.
  */
 async function configureImmutableProof(coreConfig, envVars) {
     if (isImmutableProofRequired(envVars)) {
@@ -775,6 +803,7 @@ async function configureImmutableProof(coreConfig, envVars) {
  * Configures the identity.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the identity configuration has been applied.
  */
 async function configureIdentity(coreConfig, envVars) {
     coreConfig.types.identityConnector ??= [];
@@ -807,6 +836,7 @@ async function configureIdentity(coreConfig, envVars) {
  * Configures the identity resolver.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the identity resolver configuration has been applied.
  */
 async function configureIdentityResolver(coreConfig, envVars) {
     coreConfig.types.identityResolverConnector ??= [];
@@ -850,6 +880,7 @@ async function configureIdentityResolver(coreConfig, envVars) {
  * Configures the identity profile.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the identity profile configuration has been applied.
  */
 async function configureIdentityProfile(coreConfig, envVars) {
     coreConfig.types.identityProfileConnector ??= [];
@@ -867,6 +898,7 @@ async function configureIdentityProfile(coreConfig, envVars) {
  * Configures the attestation.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the attestation configuration has been applied.
  */
 async function configureAttestation(coreConfig, envVars) {
     coreConfig.types.attestationConnector ??= [];
@@ -891,6 +923,7 @@ async function configureAttestation(coreConfig, envVars) {
  * Configures the auditable item graph.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the auditable item graph configuration has been applied.
  */
 async function configureAuditableItemGraph(coreConfig, envVars) {
     if (Coerce.boolean(envVars.auditableItemGraphEnabled) ?? false) {
@@ -904,6 +937,7 @@ async function configureAuditableItemGraph(coreConfig, envVars) {
  * Configures the auditable item stream.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the auditable item stream configuration has been applied.
  */
 async function configureAuditableItemStream(coreConfig, envVars) {
     if (Coerce.boolean(envVars.auditableItemStreamEnabled) ?? false) {
@@ -917,6 +951,7 @@ async function configureAuditableItemStream(coreConfig, envVars) {
  * Configures the data processing.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the data processing configuration has been applied.
  */
 async function configureDataProcessing(coreConfig, envVars) {
     if (Coerce.boolean(envVars.dataProcessingEnabled) ?? false) {
@@ -942,6 +977,7 @@ async function configureDataProcessing(coreConfig, envVars) {
  * Configures the document management.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the document management configuration has been applied.
  */
 async function configureDocumentManagement(coreConfig, envVars) {
     if (Coerce.boolean(envVars.documentManagementEnabled) ?? false) {
@@ -955,6 +991,7 @@ async function configureDocumentManagement(coreConfig, envVars) {
  * Configures the trust components.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the trust configuration has been applied.
  */
 async function configureTrust(coreConfig, envVars) {
     if (isTrustRequired(envVars)) {
@@ -1002,6 +1039,7 @@ async function configureTrust(coreConfig, envVars) {
  * Configures the rights management.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the rights management configuration has been applied.
  */
 async function configureRightsManagement(coreConfig, envVars) {
     if (isRightsManagementRequired(envVars)) {
@@ -1115,6 +1153,7 @@ async function configureRightsManagement(coreConfig, envVars) {
  * Configures the task scheduler.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the task scheduler configuration has been applied.
  */
 async function configureTaskScheduler(coreConfig, envVars) {
     if (isTaskSchedulerRequired(envVars)) {
@@ -1128,6 +1167,7 @@ async function configureTaskScheduler(coreConfig, envVars) {
  * Configures the federated catalogue.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the federated catalogue configuration has been applied.
  */
 async function configureFederatedCatalogue(coreConfig, envVars) {
     if (isFederatedCatalogueRequired(envVars)) {
@@ -1160,6 +1200,7 @@ async function configureFederatedCatalogue(coreConfig, envVars) {
  * Configures the dataspace control plane and data plane.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the dataspace configuration has been applied.
  */
 async function configureDataspace(coreConfig, envVars) {
     if (Coerce.boolean(envVars.dataspaceEnabled) ?? false) {
@@ -1198,6 +1239,7 @@ async function configureDataspace(coreConfig, envVars) {
  * Configures the DLT.
  * @param coreConfig The core config.
  * @param envVars The environment variables.
+ * @returns A promise that resolves when the DLT configuration has been applied.
  */
 async function configureDlt(coreConfig, envVars) {
     // Create centralized DLT configuration for IOTA if essential IOTA variables are set
@@ -1269,10 +1311,10 @@ export function isImmutableProofRequired(envVars) {
         (Coerce.boolean(envVars.documentManagementEnabled) ?? false));
 }
 /**
- * Checks if the immutable proof subsystem is required.
- * Returns true when any component that depends on the immutable proof subsystem is enabled.
+ * Checks if the federated catalogue subsystem is required.
+ * Returns true when the catalogue is explicitly enabled, a remote endpoint is configured, filters are set, or dataspace is enabled.
  * @param envVars The environment variables.
- * @returns True if verifiable storage is enabled.
+ * @returns True if the federated catalogue is required.
  */
 export function isFederatedCatalogueRequired(envVars) {
     return ((Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false) ||
@@ -1283,7 +1325,7 @@ export function isFederatedCatalogueRequired(envVars) {
 /**
  * Checks if the rights management subsystem is required.
  * Returns true when any component that depends on the rights management subsystem is enabled.
- * Note: rights management has no standalone enable flag — it is gated entirely on
+ * Note: rights management has no standalone enable flag - it is gated entirely on
  * `dataspaceEnabled`. Setting `TWIN_RIGHTS_MANAGEMENT_*` env var in isolation does not
  * enable the subsystem; `TWIN_DATASPACE_ENABLED` must also be true.
  * @param envVars The environment variables.