@twin.org/node-core 0.0.2-next.5 → 0.0.2-next.7

package/dist/cjs/index.cjs

@@ -96,13 +96,21 @@ async function fileExists(filename) {
         return false;
     }
 }
+/**
+ * Load the text file.
+ * @param filename The filename of the text file to load.
+ * @returns The contents of the text file if it could not be loaded.
+ */
+async function loadTextFile(filename) {
+    return promises.readFile(filename, "utf8");
+}
 /**
  * Load the JSON file.
  * @param filename The filename of the JSON file to load.
  * @returns The contents of the JSON file or null if it could not be loaded.
  */
 async function loadJsonFile(filename) {
-    const content = await promises.readFile(filename, "utf8");
+    const content = await loadTextFile(filename);
     return JSON.parse(content);
 }
 /**
@@ -591,6 +599,7 @@ function buildEngineConfiguration(envVars) {
     configureTaskScheduler(coreConfig, envVars);
     configureSynchronisedStorage(coreConfig, envVars);
     configureFederatedCatalogue(coreConfig, envVars);
+    configureDataSpaceConnector(coreConfig, envVars);
     return coreConfig;
 }
 /**
@@ -1354,6 +1363,26 @@ function configureRightsManagement(coreConfig, envVars) {
         coreConfig.types.rightsManagementPapComponent.push({
             type: engineTypes.RightsManagementPapComponentType.Service
         });
+        coreConfig.types.rightsManagementPmpComponent ??= [];
+        coreConfig.types.rightsManagementPmpComponent.push({
+            type: engineTypes.RightsManagementPmpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPipComponent ??= [];
+        coreConfig.types.rightsManagementPipComponent.push({
+            type: engineTypes.RightsManagementPipComponentType.Service
+        });
+        coreConfig.types.rightsManagementPxpComponent ??= [];
+        coreConfig.types.rightsManagementPxpComponent.push({
+            type: engineTypes.RightsManagementPxpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPdpComponent ??= [];
+        coreConfig.types.rightsManagementPdpComponent.push({
+            type: engineTypes.RightsManagementPdpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPepComponent ??= [];
+        coreConfig.types.rightsManagementPepComponent.push({
+            type: engineTypes.RightsManagementPepComponentType.Service
+        });
         coreConfig.types.rightsManagementComponent ??= [];
         coreConfig.types.rightsManagementComponent.push({
             type: engineTypes.RightsManagementComponentType.Service
@@ -1422,8 +1451,7 @@ function configureSynchronisedStorage(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 function configureFederatedCatalogue(coreConfig, envVars) {
-    if (core.Is.arrayValue(coreConfig.types.identityResolverComponent) &&
-        (core.Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false)) {
+    if (core.Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false) {
         coreConfig.types.federatedCatalogueComponent ??= [];
         coreConfig.types.federatedCatalogueComponent.push({
             type: engineTypes.FederatedCatalogueComponentType.Service,
@@ -1436,6 +1464,26 @@ function configureFederatedCatalogue(coreConfig, envVars) {
         });
     }
 }
+/**
+ * Configures the data space connector.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDataSpaceConnector(coreConfig, envVars) {
+    if (core.Coerce.boolean(envVars.dataSpaceConnectorEnabled) ?? false) {
+        coreConfig.types.dataSpaceConnectorComponent ??= [];
+        coreConfig.types.dataSpaceConnectorComponent.push({
+            type: engineTypes.DataSpaceConnectorComponentType.Service,
+            options: {
+                config: {
+                    dataSpaceConnectorAppDescriptors: core.Is.arrayValue(envVars.dataSpaceConnectorApps)
+                        ? envVars.dataSpaceConnectorApps
+                        : undefined
+                }
+            }
+        });
+    }
+}
 /**
  * Configures the DLT.
  * @param coreConfig The core config.
@@ -1679,7 +1727,7 @@ async function run(nodeOptions) {
         nodeOptions ??= {};
         const serverInfo = {
             name: nodeOptions?.serverName ?? "TWIN Node Server",
-            version: nodeOptions?.serverVersion ?? "0.0.2-next.5" // x-release-please-version
+            version: nodeOptions?.serverVersion ?? "0.0.2-next.7" // x-release-please-version
         };
         console.log(`\u001B[4m🌩️  ${serverInfo.name} v${serverInfo.version}\u001B[24m\n`);
         if (!core.Is.stringValue(nodeOptions?.executionDirectory)) {
@@ -1761,12 +1809,18 @@ async function buildConfiguration(processEnv, options, serverInfo) {
     // Expand any environment variables that use the @file: syntax
     const keys = Object.keys(envVars);
     for (const key of keys) {
-        if (core.Is.stringValue(envVars[key]) && envVars[key].startsWith("@file:")) {
+        if (core.Is.stringValue(envVars[key]) &&
+            (envVars[key].startsWith("@text:") || envVars[key].startsWith("@json:"))) {
             const filePath = envVars[key].slice(6).trim();
             const embeddedFile = path.resolve(path.join(options.executionDirectory ?? "", filePath));
-            console.info(`Expanding Environment Variable: ${key} from file: ${embeddedFile}`);
-            const fileContent = await loadJsonFile(embeddedFile);
-            envVars[key] = fileContent;
+            if (envVars[key].startsWith("@text:")) {
+                console.info(`Expanding Environment Variable: ${key} from text file: ${embeddedFile}`);
+                envVars[key] = await loadTextFile(embeddedFile);
+            }
+            else if (envVars[key].startsWith("@json:")) {
+                console.info(`Expanding Environment Variable: ${key} from JSON file: ${embeddedFile}`);
+                envVars[key] = await loadJsonFile(embeddedFile);
+            }
         }
     }
     // Extend the environment variables with any additional custom configuration.
@@ -1814,5 +1868,6 @@ exports.getExecutionDirectory = getExecutionDirectory;
 exports.getFeatures = getFeatures;
 exports.initialiseLocales = initialiseLocales;
 exports.loadJsonFile = loadJsonFile;
+exports.loadTextFile = loadTextFile;
 exports.run = run;
 exports.start = start;

package/dist/esm/index.mjs

@@ -2,7 +2,7 @@ import { PasswordHelper } from '@twin.org/api-auth-entity-storage-service';
 import { I18n, Is, Converter, RandomHelper, StringHelper, Coerce, Urn, GeneralError, ErrorHelper, EnvHelper } from '@twin.org/core';
 import { PasswordGenerator, Bip39 } from '@twin.org/crypto';
 import { AuthenticationComponentType, InformationComponentType, RestRouteProcessorType, SocketRouteProcessorType, AuthenticationAdminComponentType } from '@twin.org/engine-server-types';
-import { WalletConnectorType, IdentityConnectorType, EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, DltConfigType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, NftConnectorType, NftComponentType, VerifiableStorageConnectorType, VerifiableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DocumentManagementComponentType, RightsManagementPapComponentType, RightsManagementComponentType, TaskSchedulerComponentType, SynchronisedStorageComponentType, FederatedCatalogueComponentType } from '@twin.org/engine-types';
+import { WalletConnectorType, IdentityConnectorType, EntityStorageConnectorType, BlobStorageConnectorType, BlobStorageComponentType, VaultConnectorType, DltConfigType, LoggingConnectorType, LoggingComponentType, BackgroundTaskConnectorType, EventBusConnectorType, EventBusComponentType, TelemetryConnectorType, TelemetryComponentType, MessagingEmailConnectorType, MessagingSmsConnectorType, MessagingPushNotificationConnectorType, MessagingComponentType, FaucetConnectorType, NftConnectorType, NftComponentType, VerifiableStorageConnectorType, VerifiableStorageComponentType, ImmutableProofComponentType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, IdentityComponentType, IdentityResolverConnectorType, IdentityResolverComponentType, IdentityProfileConnectorType, IdentityProfileComponentType, AttestationConnectorType, AttestationComponentType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DocumentManagementComponentType, RightsManagementPapComponentType, RightsManagementPmpComponentType, RightsManagementPipComponentType, RightsManagementPxpComponentType, RightsManagementPdpComponentType, RightsManagementPepComponentType, RightsManagementComponentType, TaskSchedulerComponentType, SynchronisedStorageComponentType, FederatedCatalogueComponentType, DataSpaceConnectorComponentType } from '@twin.org/engine-types';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { IdentityProfileConnectorFactory, IdentityConnectorFactory, IdentityResolverConnectorFactory, DocumentHelper } from '@twin.org/identity-models';
 import { VaultConnectorFactory, VaultKeyType } from '@twin.org/vault-models';
@@ -75,13 +75,21 @@ async function fileExists(filename) {
         return false;
     }
 }
+/**
+ * Load the text file.
+ * @param filename The filename of the text file to load.
+ * @returns The contents of the text file if it could not be loaded.
+ */
+async function loadTextFile(filename) {
+    return readFile(filename, "utf8");
+}
 /**
  * Load the JSON file.
  * @param filename The filename of the JSON file to load.
  * @returns The contents of the JSON file or null if it could not be loaded.
  */
 async function loadJsonFile(filename) {
-    const content = await readFile(filename, "utf8");
+    const content = await loadTextFile(filename);
     return JSON.parse(content);
 }
 /**
@@ -570,6 +578,7 @@ function buildEngineConfiguration(envVars) {
     configureTaskScheduler(coreConfig, envVars);
     configureSynchronisedStorage(coreConfig, envVars);
     configureFederatedCatalogue(coreConfig, envVars);
+    configureDataSpaceConnector(coreConfig, envVars);
     return coreConfig;
 }
 /**
@@ -1333,6 +1342,26 @@ function configureRightsManagement(coreConfig, envVars) {
         coreConfig.types.rightsManagementPapComponent.push({
             type: RightsManagementPapComponentType.Service
         });
+        coreConfig.types.rightsManagementPmpComponent ??= [];
+        coreConfig.types.rightsManagementPmpComponent.push({
+            type: RightsManagementPmpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPipComponent ??= [];
+        coreConfig.types.rightsManagementPipComponent.push({
+            type: RightsManagementPipComponentType.Service
+        });
+        coreConfig.types.rightsManagementPxpComponent ??= [];
+        coreConfig.types.rightsManagementPxpComponent.push({
+            type: RightsManagementPxpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPdpComponent ??= [];
+        coreConfig.types.rightsManagementPdpComponent.push({
+            type: RightsManagementPdpComponentType.Service
+        });
+        coreConfig.types.rightsManagementPepComponent ??= [];
+        coreConfig.types.rightsManagementPepComponent.push({
+            type: RightsManagementPepComponentType.Service
+        });
         coreConfig.types.rightsManagementComponent ??= [];
         coreConfig.types.rightsManagementComponent.push({
             type: RightsManagementComponentType.Service
@@ -1401,8 +1430,7 @@ function configureSynchronisedStorage(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 function configureFederatedCatalogue(coreConfig, envVars) {
-    if (Is.arrayValue(coreConfig.types.identityResolverComponent) &&
-        (Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false)) {
+    if (Coerce.boolean(envVars.federatedCatalogueEnabled) ?? false) {
         coreConfig.types.federatedCatalogueComponent ??= [];
         coreConfig.types.federatedCatalogueComponent.push({
             type: FederatedCatalogueComponentType.Service,
@@ -1415,6 +1443,26 @@ function configureFederatedCatalogue(coreConfig, envVars) {
         });
     }
 }
+/**
+ * Configures the data space connector.
+ * @param coreConfig The core config.
+ * @param envVars The environment variables.
+ */
+function configureDataSpaceConnector(coreConfig, envVars) {
+    if (Coerce.boolean(envVars.dataSpaceConnectorEnabled) ?? false) {
+        coreConfig.types.dataSpaceConnectorComponent ??= [];
+        coreConfig.types.dataSpaceConnectorComponent.push({
+            type: DataSpaceConnectorComponentType.Service,
+            options: {
+                config: {
+                    dataSpaceConnectorAppDescriptors: Is.arrayValue(envVars.dataSpaceConnectorApps)
+                        ? envVars.dataSpaceConnectorApps
+                        : undefined
+                }
+            }
+        });
+    }
+}
 /**
  * Configures the DLT.
  * @param coreConfig The core config.
@@ -1658,7 +1706,7 @@ async function run(nodeOptions) {
         nodeOptions ??= {};
         const serverInfo = {
             name: nodeOptions?.serverName ?? "TWIN Node Server",
-            version: nodeOptions?.serverVersion ?? "0.0.2-next.5" // x-release-please-version
+            version: nodeOptions?.serverVersion ?? "0.0.2-next.7" // x-release-please-version
         };
         console.log(`\u001B[4m🌩️  ${serverInfo.name} v${serverInfo.version}\u001B[24m\n`);
         if (!Is.stringValue(nodeOptions?.executionDirectory)) {
@@ -1740,12 +1788,18 @@ async function buildConfiguration(processEnv, options, serverInfo) {
     // Expand any environment variables that use the @file: syntax
     const keys = Object.keys(envVars);
     for (const key of keys) {
-        if (Is.stringValue(envVars[key]) && envVars[key].startsWith("@file:")) {
+        if (Is.stringValue(envVars[key]) &&
+            (envVars[key].startsWith("@text:") || envVars[key].startsWith("@json:"))) {
             const filePath = envVars[key].slice(6).trim();
             const embeddedFile = path.resolve(path.join(options.executionDirectory ?? "", filePath));
-            console.info(`Expanding Environment Variable: ${key} from file: ${embeddedFile}`);
-            const fileContent = await loadJsonFile(embeddedFile);
-            envVars[key] = fileContent;
+            if (envVars[key].startsWith("@text:")) {
+                console.info(`Expanding Environment Variable: ${key} from text file: ${embeddedFile}`);
+                envVars[key] = await loadTextFile(embeddedFile);
+            }
+            else if (envVars[key].startsWith("@json:")) {
+                console.info(`Expanding Environment Variable: ${key} from JSON file: ${embeddedFile}`);
+                envVars[key] = await loadJsonFile(embeddedFile);
+            }
         }
     }
     // Extend the environment variables with any additional custom configuration.
@@ -1777,4 +1831,4 @@ async function buildConfiguration(processEnv, options, serverInfo) {
     return { engineServerConfig, nodeEnvVars: envVars };
 }
 
-export { NodeFeatures, bootstrap, bootstrapAuth, bootstrapBlobEncryption, bootstrapImmutableProofMethod, bootstrapNodeIdentity, bootstrapNodeUser, bootstrapSynchronisedStorage, buildConfiguration, buildEngineConfiguration, buildEngineServerConfiguration, fileExists, getExecutionDirectory, getFeatures, initialiseLocales, loadJsonFile, run, start };
+export { NodeFeatures, bootstrap, bootstrapAuth, bootstrapBlobEncryption, bootstrapImmutableProofMethod, bootstrapNodeIdentity, bootstrapNodeUser, bootstrapSynchronisedStorage, buildConfiguration, buildEngineConfiguration, buildEngineServerConfiguration, fileExists, getExecutionDirectory, getFeatures, initialiseLocales, loadJsonFile, loadTextFile, run, start };

package/dist/types/models/IEngineEnvironmentVariables.d.ts

@@ -446,4 +446,13 @@ export interface IEngineEnvironmentVariables {
      * Is the task scheduler enabled, defaults to false.
      */
     taskSchedulerEnabled?: string;
+    /**
+     * Is the data space connector enabled, defaults to false.
+     */
+    dataSpaceConnectorEnabled?: string;
+    /**
+     * The application configuration for the data space connector.
+     * Use the @json: prefix to specify the path to the JSON configuration file.
+     */
+    dataSpaceConnectorApps?: string;
 }

package/dist/types/utils.d.ts

@@ -16,6 +16,12 @@ export declare function getExecutionDirectory(): string;
  * @returns True if the file exists.
  */
 export declare function fileExists(filename: string): Promise<boolean>;
+/**
+ * Load the text file.
+ * @param filename The filename of the text file to load.
+ * @returns The contents of the text file if it could not be loaded.
+ */
+export declare function loadTextFile(filename: string): Promise<string>;
 /**
  * Load the JSON file.
  * @param filename The filename of the JSON file to load.

package/docs/changelog.md

@@ -1,5 +1,22 @@
 # @twin.org/node-core - Changelog
 
+## [0.0.2-next.7](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.6...node-core-v0.0.2-next.7) (2025-08-26)
+
+
+### Features
+
+* add data space connector ([5a57087](https://github.com/twinfoundation/node/commit/5a57087d938265d3a4a812ff7c83d130ea4e103c))
+* add data space connector ([f7a3644](https://github.com/twinfoundation/node/commit/f7a364477ec664e333e5ad018795acec6ee61edc))
+* add data space connector ([157e8b0](https://github.com/twinfoundation/node/commit/157e8b0a76e3a8a63c1991924f7f963eb83e27ae))
+
+## [0.0.2-next.6](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.5...node-core-v0.0.2-next.6) (2025-08-22)
+
+
+### Features
+
+* add rights management ([78fba62](https://github.com/twinfoundation/node/commit/78fba62f82afdbe615d55dd90eca8ee70ea62fc0))
+* remove unused properties ([d8344b5](https://github.com/twinfoundation/node/commit/d8344b5aee5dc1c8104d75fad5093097f6530168))
+
 ## [0.0.2-next.5](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.4...node-core-v0.0.2-next.5) (2025-08-21)
 
 

package/docs/reference/functions/loadTextFile.md

@@ -0,0 +1,19 @@
+# Function: loadTextFile()
+
+> **loadTextFile**(`filename`): `Promise`\<`string`\>
+
+Load the text file.
+
+## Parameters
+
+### filename
+
+`string`
+
+The filename of the text file to load.
+
+## Returns
+
+`Promise`\<`string`\>
+
+The contents of the text file if it could not be loaded.

package/docs/reference/index.md

@@ -32,5 +32,6 @@
 - [initialiseLocales](functions/initialiseLocales.md)
 - [getExecutionDirectory](functions/getExecutionDirectory.md)
 - [fileExists](functions/fileExists.md)
+- [loadTextFile](functions/loadTextFile.md)
 - [loadJsonFile](functions/loadJsonFile.md)
 - [getFeatures](functions/getFeatures.md)

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -901,3 +901,20 @@ Is the rights management enabled, defaults to false.
 > `optional` **taskSchedulerEnabled**: `string`
 
 Is the task scheduler enabled, defaults to false.
+
+***
+
+### dataSpaceConnectorEnabled?
+
+> `optional` **dataSpaceConnectorEnabled**: `string`
+
+Is the data space connector enabled, defaults to false.
+
+***
+
+### dataSpaceConnectorApps?
+
+> `optional` **dataSpaceConnectorApps**: `string`
+
+The application configuration for the data space connector.
+Use the @json: prefix to specify the path to the JSON configuration file.

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -1336,6 +1336,31 @@ Is the task scheduler enabled, defaults to false.
 
 ***
 
+### dataSpaceConnectorEnabled?
+
+> `optional` **dataSpaceConnectorEnabled**: `string`
+
+Is the data space connector enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineEnvironmentVariables.md#dataspaceconnectorenabled)
+
+***
+
+### dataSpaceConnectorApps?
+
+> `optional` **dataSpaceConnectorApps**: `string`
+
+The application configuration for the data space connector.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineEnvironmentVariables.md#dataspaceconnectorapps)
+
+***
+
 ### port?
 
 > `optional` **port**: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.5",
+	"version": "0.0.2-next.7",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -17,6 +17,7 @@
 		"@twin.org/api-auth-entity-storage-service": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
+		"@twin.org/data-space-connector-models": "next",
 		"@twin.org/engine": "next",
 		"@twin.org/engine-core": "next",
 		"@twin.org/engine-models": "next",