@twin.org/engine-server 0.0.1-next.9 → 0.0.2-next.1

package/dist/esm/index.mjs

@@ -1,261 +1,9 @@
-import { initSchema, EntityStorageAuthenticationService, AuthHeaderProcessor, generateRestRoutesAuthentication } from '@twin.org/api-auth-entity-storage-service';
-import { MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory } from '@twin.org/api-models';
+import { RestRouteProcessorFactory, SocketRouteProcessorFactory, MimeTypeProcessorFactory } from '@twin.org/api-models';
 import { FastifyWebServer } from '@twin.org/api-server-fastify';
-import { InformationService, generateRestRoutesInformation } from '@twin.org/api-service';
-import { generateRestRoutesAttestation } from '@twin.org/attestation-service';
-import { generateRestRoutesAuditableItemGraph } from '@twin.org/auditable-item-graph-service';
-import { generateRestRoutesAuditableItemStream } from '@twin.org/auditable-item-stream-service';
-import { generateRestRoutesBlobStorage } from '@twin.org/blob-storage-service';
-import { I18n, GeneralError, ComponentFactory, Guards, Is, Coerce } from '@twin.org/core';
-import { AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType } from '@twin.org/engine-models';
-import { generateRestRoutesEntityStorage } from '@twin.org/entity-storage-service';
-import { generateRestRoutesIdentity, generateRestRoutesIdentityProfile } from '@twin.org/identity-service';
-import { generateRestRoutesLogging } from '@twin.org/logging-service';
-import { generateRestRoutesNft } from '@twin.org/nft-service';
-import { generateRestRoutesTelemetry } from '@twin.org/telemetry-service';
-import { initialiseEntityStorageConnector } from '@twin.org/engine-core';
-import { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, StaticUserIdentityProcessor, RestRouteProcessor, SocketRouteProcessor } from '@twin.org/api-processors';
+import { Guards, Is, StringHelper } from '@twin.org/core';
+import { RestRouteProcessorType, SocketRouteProcessorType } from '@twin.org/engine-server-types';
+import { ModuleHelper } from '@twin.org/modules';
 
-/**
- * Initialise the authentication.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === AuthenticationComponentType.EntityStorage) {
-        initSchema();
-        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
-        component = new EntityStorageAuthenticationService({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            ...instanceConfig.options
-        });
-        instanceType = EntityStorageAuthenticationService.NAMESPACE;
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-/**
- * Initialise the information component.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Information Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === InformationComponentType.Service) {
-        component = new InformationService(instanceConfig.options);
-        instanceType = InformationService.NAMESPACE;
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "informationComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialise the mime type processor.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Mime Type Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === MimeTypeProcessorType.Jwt) {
-        component = new JwtMimeTypeProcessor();
-        instanceType = JwtMimeTypeProcessor.NAMESPACE;
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "mimeTypeProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    MimeTypeProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialise the rest route processor.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `REST Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === RestRouteProcessorType.AuthHeader) {
-        component = new AuthHeaderProcessor({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = AuthHeaderProcessor.NAMESPACE;
-    }
-    else if (type === RestRouteProcessorType.Logging) {
-        component = new LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = LoggingProcessor.NAMESPACE;
-    }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
-        component = new NodeIdentityProcessor();
-        instanceType = NodeIdentityProcessor.NAMESPACE;
-    }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
-        component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StaticUserIdentityProcessor.NAMESPACE;
-    }
-    else if (type === RestRouteProcessorType.RestRoute) {
-        component = new RestRouteProcessor(instanceConfig.options);
-        instanceType = RestRouteProcessor.NAMESPACE;
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "restRouteProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    RestRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialise the socket route processor.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Socket Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === SocketRouteProcessorType.AuthHeader) {
-        component = new AuthHeaderProcessor({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = AuthHeaderProcessor.NAMESPACE;
-    }
-    else if (type === SocketRouteProcessorType.Logging) {
-        component = new LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = LoggingProcessor.NAMESPACE;
-    }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
-        component = new NodeIdentityProcessor();
-        instanceType = NodeIdentityProcessor.NAMESPACE;
-    }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
-        component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StaticUserIdentityProcessor.NAMESPACE;
-    }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
-        component = new SocketRouteProcessor(instanceConfig.options);
-        instanceType = SocketRouteProcessor.NAMESPACE;
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "socketRouteProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    SocketRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Server for the engine.
  */
@@ -264,10 +12,6 @@ class EngineServer {
      * Runtime name for the class.
      */
     CLASS_NAME = "EngineServer";
-    /**
-     * The server config.
-     */
-    _config;
     /**
      * The engine.
      * @internal
@@ -293,24 +37,34 @@ class EngineServer {
      * @internal
      */
     _loggingConnectorType;
+    /**
+     * The REST routes for the application.
+     * @internal
+     */
+    _restRoutes;
+    /**
+     * The Socket routes for the application.
+     * @internal
+     */
+    _socketRoutes;
     /**
      * Create a new instance of EngineServer.
      * @param options The options for the engine.
-     * @param options.server The server options for the engine.
      * @param options.engineCore The engine core to serve from.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);
         Guards.object(this.CLASS_NAME, "options.engineCore", options.engineCore);
-        this._config = options?.server ?? {};
         this._engineCore = options.engineCore;
         this._restRouteGenerators = [];
         this._socketRouteGenerators = [];
+        this._restRoutes = [];
+        this._socketRoutes = [];
         const coreConfig = this._engineCore.getConfig();
-        if (!Is.arrayValue(this._config.restRouteProcessor)) {
-            this._config.restRouteProcessor = [];
+        if (!Is.arrayValue(coreConfig.types.restRouteProcessor)) {
+            coreConfig.types.restRouteProcessor = [];
             if (!coreConfig.silent) {
-                this._config.restRouteProcessor.push({
+                coreConfig.types.restRouteProcessor.push({
                     type: RestRouteProcessorType.Logging,
                     options: {
                         config: {
@@ -319,7 +73,7 @@ class EngineServer {
                     }
                 });
             }
-            this._config.restRouteProcessor.push({
+            coreConfig.types.restRouteProcessor.push({
                 type: RestRouteProcessorType.RestRoute,
                 options: {
                     config: {
@@ -328,6 +82,27 @@ class EngineServer {
                 }
             });
         }
+        if (!Is.arrayValue(coreConfig.types.socketRouteProcessor)) {
+            coreConfig.types.socketRouteProcessor = [];
+            if (!coreConfig.silent) {
+                coreConfig.types.socketRouteProcessor.push({
+                    type: SocketRouteProcessorType.Logging,
+                    options: {
+                        config: {
+                            includeBody: coreConfig.debug
+                        }
+                    }
+                });
+            }
+            coreConfig.types.socketRouteProcessor.push({
+                type: SocketRouteProcessorType.SocketRoute,
+                options: {
+                    config: {
+                        includeErrorStack: coreConfig.debug
+                    }
+                }
+            });
+        }
         this.addServerTypeInitialisers();
         this.addServerRestRouteGenerators();
         this.addServerSocketRouteGenerators();
@@ -336,14 +111,16 @@ class EngineServer {
      * Add a REST route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addRestRouteGenerator(type, typeConfig, generator) {
+    addRestRouteGenerator(type, typeConfig, module, method) {
         if (!Is.empty(typeConfig)) {
             this._restRouteGenerators.push({
                 type,
                 typeConfig,
-                generator
+                module,
+                method
             });
         }
     }
@@ -351,24 +128,43 @@ class EngineServer {
      * Add a socket route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addSocketRouteGenerator(type, typeConfig, generator) {
+    addSocketRouteGenerator(type, typeConfig, module, method) {
         if (!Is.empty(typeConfig)) {
             this._socketRouteGenerators.push({
                 type,
                 typeConfig,
-                generator
+                module,
+                method
             });
         }
     }
+    /**
+     * Get the built REST routes.
+     * @returns The REST routes.
+     */
+    getRestRoutes() {
+        return this._restRoutes;
+    }
+    /**
+     * Get the built socket routes.
+     * @returns The socket routes.
+     */
+    getSocketRoutes() {
+        return this._socketRoutes;
+    }
     /**
      * Start the engine server.
-     * @returns Nothing.
+     * @returns True if the start was successful.
      */
     async start() {
-        await this._engineCore.start();
-        await this.startWebServer();
+        const canContinue = await this._engineCore.start();
+        if (canContinue) {
+            await this.startWebServer();
+        }
+        return canContinue;
     }
     /**
      * Stop the engine server.
@@ -386,8 +182,8 @@ class EngineServer {
      * @internal
      */
     async startWebServer() {
-        const restRoutes = this.buildRestRoutes();
-        const socketRoutes = this.buildSocketRoutes();
+        this._restRoutes = await this.buildRestRoutes();
+        this._socketRoutes = await this.buildSocketRoutes();
         const restRouteProcessors = RestRouteProcessorFactory.names().map(n => RestRouteProcessorFactory.get(n));
         const socketRouteProcessors = SocketRouteProcessorFactory.names().map(n => SocketRouteProcessorFactory.get(n));
         const mimeTypeProcessors = MimeTypeProcessorFactory.names().map(n => MimeTypeProcessorFactory.get(n));
@@ -398,7 +194,7 @@ class EngineServer {
             loggingConnectorType: this._loggingConnectorType,
             mimeTypeProcessors
         });
-        await this._webServer.build(restRouteProcessors, restRoutes, socketRouteProcessors, socketRoutes, this._config.web);
+        await this._webServer.build(restRouteProcessors, this._restRoutes, socketRouteProcessors, this._socketRoutes, coreConfig.web);
         await this._webServer.start();
     }
     /**
@@ -406,10 +202,10 @@ class EngineServer {
      * @returns The REST routes for the application.
      * @internal
      */
-    buildRestRoutes() {
+    async buildRestRoutes() {
         const routes = [];
-        for (const { type, typeConfig, generator } of this._restRouteGenerators) {
-            this.initialiseRestTypeRoute(routes, type, typeConfig, generator);
+        for (const { type, typeConfig, module, method } of this._restRouteGenerators) {
+            await this.initialiseRestTypeRoute(routes, type, typeConfig, module, method);
         }
         return routes;
     }
@@ -418,10 +214,10 @@ class EngineServer {
      * @returns The socket routes for the application.
      * @internal
      */
-    buildSocketRoutes() {
+    async buildSocketRoutes() {
         const routes = [];
-        for (const { type, typeConfig, generator } of this._socketRouteGenerators) {
-            this.initialiseSocketTypeRoute(routes, type, typeConfig, generator);
+        for (const { type, typeConfig, module, method } of this._socketRouteGenerators) {
+            await this.initialiseSocketTypeRoute(routes, type, typeConfig, module, method);
         }
         return routes;
     }
@@ -433,31 +229,41 @@ class EngineServer {
      * @param generateRoutes The function to generate the routes.
      * @internal
      */
-    initialiseRestTypeRoute(routes, typeKey, typeConfig, generateRoutes) {
+    async initialiseRestTypeRoute(routes, typeKey, typeConfig, module, method) {
         if (Is.arrayValue(typeConfig)) {
             const defaultEngineTypes = this._engineCore.getDefaultTypes();
+            const generateRoutes = await ModuleHelper.getModuleEntry(module, method);
             for (let i = 0; i < typeConfig.length; i++) {
                 const restPath = typeConfig[i].restPath;
                 if (Is.string(restPath)) {
                     const serviceType = typeConfig[i].overrideInstanceType ?? defaultEngineTypes[typeKey];
                     if (Is.stringValue(serviceType)) {
-                        routes.push(...generateRoutes(restPath, serviceType));
+                        const generatedRoutes = generateRoutes(restPath, serviceType);
+                        for (const route of generatedRoutes) {
+                            // Don't strip trailing slashes from the root path.
+                            if (Is.stringValue(route.path) && route.path.length > 1) {
+                                route.path = StringHelper.trimTrailingSlashes(route.path);
+                            }
+                        }
+                        routes.push(...generatedRoutes);
                     }
                 }
             }
         }
     }
     /**
-     * Initialise the rest routes from connector.
+     * Initialise the socket routes from connector.
      * @param routes The routes to add to.
      * @param typeKey The key for the default types.
      * @param typeConfig The type config.
-     * @param generateRoutes The function to generate the routes.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      * @internal
      */
-    initialiseSocketTypeRoute(routes, typeKey, typeConfig, generateRoutes) {
+    async initialiseSocketTypeRoute(routes, typeKey, typeConfig, module, method) {
         if (Is.arrayValue(typeConfig)) {
             const defaultEngineTypes = this._engineCore.getDefaultTypes();
+            const generateRoutes = await ModuleHelper.getModuleEntry(module, method);
             for (let i = 0; i < typeConfig.length; i++) {
                 const socketPath = typeConfig[i].socketPath;
                 if (Is.string(socketPath)) {
@@ -474,191 +280,138 @@ class EngineServer {
      * @internal
      */
     addServerTypeInitialisers() {
-        this._engineCore.addTypeInitialiser("authenticationComponent", this._config.authenticationComponent, initialiseAuthenticationComponent);
-        this._engineCore.addTypeInitialiser("informationComponent", this._config.informationComponent, initialiseInformationComponent);
-        this._engineCore.addTypeInitialiser("restRouteProcessor", this._config.restRouteProcessor, initialiseRestRouteProcessorComponent);
-        this._engineCore.addTypeInitialiser("socketRouteProcessor", this._config.socketRouteProcessor, initialiseSocketRouteProcessorComponent);
-        this._engineCore.addTypeInitialiser("mimeTypeProcessor", this._config.mimeTypeProcessor, initialiseMimeTypeProcessorComponent);
+        const coreConfig = this._engineCore.getConfig();
+        this._engineCore.addTypeInitialiser("authenticationAdminComponent", coreConfig.types.authenticationAdminComponent, "@twin.org/engine-server-types", "initialiseAuthenticationAdminComponent");
+        this._engineCore.addTypeInitialiser("authenticationComponent", coreConfig.types.authenticationComponent, "@twin.org/engine-server-types", "initialiseAuthenticationComponent");
+        this._engineCore.addTypeInitialiser("informationComponent", coreConfig.types.informationComponent, "@twin.org/engine-server-types", "initialiseInformationComponent");
+        this._engineCore.addTypeInitialiser("restRouteProcessor", coreConfig.types.restRouteProcessor, "@twin.org/engine-server-types", "initialiseRestRouteProcessorComponent");
+        this._engineCore.addTypeInitialiser("socketRouteProcessor", coreConfig.types.socketRouteProcessor, "@twin.org/engine-server-types", "initialiseSocketRouteProcessorComponent");
+        this._engineCore.addTypeInitialiser("mimeTypeProcessor", coreConfig.types.mimeTypeProcessor, "@twin.org/engine-server-types", "initialiseMimeTypeProcessorComponent");
     }
     /**
      * Add the server REST route generators.
      * @internal
      */
     addServerRestRouteGenerators() {
-        this.addRestRouteGenerator("informationComponent", this._config.informationComponent, generateRestRoutesInformation);
-        this.addRestRouteGenerator("authenticationComponent", this._config.authenticationComponent, generateRestRoutesAuthentication);
         const coreConfig = this._engineCore.getConfig();
-        this.addRestRouteGenerator("loggingComponent", coreConfig.loggingComponent, generateRestRoutesLogging);
-        this.addRestRouteGenerator("telemetryComponent", coreConfig.telemetryComponent, generateRestRoutesTelemetry);
-        this.addRestRouteGenerator("blobStorageComponent", coreConfig.blobStorageComponent, generateRestRoutesBlobStorage);
-        this.addRestRouteGenerator("identityComponent", coreConfig.identityComponent, generateRestRoutesIdentity);
-        this.addRestRouteGenerator("identityProfileComponent", coreConfig.identityProfileComponent, generateRestRoutesIdentityProfile);
-        this.addRestRouteGenerator("nftComponent", coreConfig.nftComponent, generateRestRoutesNft);
-        this.addRestRouteGenerator("attestationComponent", coreConfig.attestationComponent, generateRestRoutesAttestation);
-        this.addRestRouteGenerator("auditableItemGraphComponent", coreConfig.auditableItemGraphComponent, generateRestRoutesAuditableItemGraph);
-        this.addRestRouteGenerator("auditableItemStreamComponent", coreConfig.auditableItemStreamComponent, generateRestRoutesAuditableItemStream);
-        this.addRestRouteGenerator("entityStorageComponent", coreConfig.entityStorageComponent, generateRestRoutesEntityStorage);
+        this.addRestRouteGenerator("informationComponent", coreConfig.types.informationComponent, "@twin.org/api-service", "generateRestRoutesInformation");
+        this.addRestRouteGenerator("authenticationComponent", coreConfig.types.authenticationComponent, "@twin.org/api-auth-entity-storage-service", "generateRestRoutesAuthentication");
+        this.addRestRouteGenerator("loggingComponent", coreConfig.types.loggingComponent, "@twin.org/logging-service", "generateRestRoutesLogging");
+        this.addRestRouteGenerator("telemetryComponent", coreConfig.types.telemetryComponent, "@twin.org/telemetry-service", "generateRestRoutesTelemetry");
+        this.addRestRouteGenerator("blobStorageComponent", coreConfig.types.blobStorageComponent, "@twin.org/blob-storage-service", "generateRestRoutesBlobStorage");
+        this.addRestRouteGenerator("identityComponent", coreConfig.types.identityComponent, "@twin.org/identity-service", "generateRestRoutesIdentity");
+        this.addRestRouteGenerator("identityResolverComponent", coreConfig.types.identityResolverComponent, "@twin.org/identity-service", "generateRestRoutesIdentityResolver");
+        this.addRestRouteGenerator("identityProfileComponent", coreConfig.types.identityProfileComponent, "@twin.org/identity-service", "generateRestRoutesIdentityProfile");
+        this.addRestRouteGenerator("nftComponent", coreConfig.types.nftComponent, "@twin.org/nft-service", "generateRestRoutesNft");
+        this.addRestRouteGenerator("verifiableStorageComponent", coreConfig.types.verifiableStorageComponent, "@twin.org/verifiable-storage-service", "generateRestRoutesVerifiableStorage");
+        this.addRestRouteGenerator("attestationComponent", coreConfig.types.attestationComponent, "@twin.org/attestation-service", "generateRestRoutesAttestation");
+        this.addRestRouteGenerator("immutableProofComponent", coreConfig.types.immutableProofComponent, "@twin.org/immutable-proof-service", "generateRestRoutesImmutableProof");
+        this.addRestRouteGenerator("auditableItemGraphComponent", coreConfig.types.auditableItemGraphComponent, "@twin.org/auditable-item-graph-service", "generateRestRoutesAuditableItemGraph");
+        this.addRestRouteGenerator("auditableItemStreamComponent", coreConfig.types.auditableItemStreamComponent, "@twin.org/auditable-item-stream-service", "generateRestRoutesAuditableItemStream");
+        this.addRestRouteGenerator("entityStorageComponent", coreConfig.types.entityStorageComponent, "@twin.org/entity-storage-service", "generateRestRoutesEntityStorage");
+        this.addRestRouteGenerator("dataProcessingComponent", coreConfig.types.dataProcessingComponent, "@twin.org/data-processing-service", "generateRestRoutesDataProcessing");
+        this.addRestRouteGenerator("documentManagementComponent", coreConfig.types.documentManagementComponent, "@twin.org/document-management-service", "generateRestRoutesDocumentManagement");
+        this.addRestRouteGenerator("federatedCatalogueComponent", coreConfig.types.federatedCatalogueComponent, "@twin.org/federated-catalogue-service", "generateRestRoutesFederatedCatalogue");
+        this.addRestRouteGenerator("rightsManagementComponent", coreConfig.types.rightsManagementComponent, "@twin.org/rights-management-service", "generateRestRoutesRightsManagement");
     }
     /**
      * Add the server socket route generators.
      * @internal
      */
     addServerSocketRouteGenerators() {
-        // const coreConfig = this._engineCore.getConfig();
-        // this.addSocketRouteGenerator("eventBusComponent", coreConfig.eventBusComponent, generateSocketRoutesEventBus);
+        const coreConfig = this._engineCore.getConfig();
+        this.addSocketRouteGenerator("eventBusComponent", coreConfig.types.eventBusComponent, "@twin.org/event-bus-service", "generateSocketRoutesEventBus");
     }
 }
 
-/**
- * Handles the configuration of the server.
- * @param envVars The environment variables.
- * @param coreEngineConfig The core engine config.
- * @param serverInfo The server information.
- * @returns The the config for the core and the server.
- */
-function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo) {
-    envVars.adminUsername ??= "admin@node";
-    envVars.authSigningKeyId ??= "auth-signing";
-    const webServerOptions = {
-        port: Coerce.number(envVars.port),
-        host: Coerce.string(envVars.host),
-        methods: Is.stringValue(envVars.httpMethods)
-            ? envVars.httpMethods.split(",")
-            : undefined,
-        allowedHeaders: Is.stringValue(envVars.httpAllowedHeaders)
-            ? envVars.httpAllowedHeaders.split(",")
-            : undefined,
-        exposedHeaders: Is.stringValue(envVars.httpExposedHeaders)
-            ? envVars.httpExposedHeaders.split(",")
-            : undefined,
-        corsOrigins: Is.stringValue(envVars.corsOrigins) ? envVars.corsOrigins.split(",") : undefined
-    };
-    const authProcessorType = envVars.authProcessorType;
-    const serverConfig = {
-        web: webServerOptions,
-        informationComponent: [
-            {
-                type: InformationComponentType.Service,
-                options: {
-                    config: {
-                        serverInfo
-                    }
-                }
-            }
-        ],
-        restRouteProcessor: []
-    };
-    serverConfig.restRouteProcessor ??= [];
-    serverConfig.socketRouteProcessor ??= [];
-    serverConfig.restRouteProcessor.push({
-        type: RestRouteProcessorType.NodeIdentity
-    });
-    serverConfig.socketRouteProcessor.push({
-        type: SocketRouteProcessorType.NodeIdentity
-    });
-    if (!coreEngineConfig.silent) {
-        serverConfig.restRouteProcessor.push({
-            type: RestRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-        serverConfig.socketRouteProcessor.push({
-            type: SocketRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-    }
-    serverConfig.restRouteProcessor.push({
-        type: RestRouteProcessorType.RestRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    serverConfig.socketRouteProcessor.push({
-        type: SocketRouteProcessorType.SocketRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    if (authProcessorType === AuthenticationComponentType.EntityStorage) {
-        serverConfig.authenticationComponent ??= [];
-        serverConfig.authenticationComponent.push({
-            type: AuthenticationComponentType.EntityStorage,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.restRouteProcessor.push({
-            type: RestRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.socketRouteProcessor.push({
-            type: SocketRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-    }
-    addRestPaths(coreEngineConfig, serverConfig);
-    return serverConfig;
-}
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
 /**
  * Adds the rest paths to the server config.
- * @param coreEngineConfig The core engine config.
  * @param serverConfig The server config.
  */
-function addRestPaths(coreEngineConfig, serverConfig) {
-    if (Is.arrayValue(serverConfig.informationComponent)) {
-        serverConfig.informationComponent[0].restPath = "";
+function addDefaultRestPaths(serverConfig) {
+    if (Is.arrayValue(serverConfig.types.informationComponent)) {
+        serverConfig.types.informationComponent[0].restPath = "";
+    }
+    if (Is.arrayValue(serverConfig.types.authenticationComponent) &&
+        !Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
+        serverConfig.types.authenticationComponent[0].restPath = "/authentication";
+    }
+    if (Is.arrayValue(serverConfig.types.blobStorageComponent) &&
+        !Is.stringValue(serverConfig.types.blobStorageComponent[0].restPath)) {
+        serverConfig.types.blobStorageComponent[0].restPath = "/blob";
+    }
+    if (Is.arrayValue(serverConfig.types.loggingComponent) &&
+        !Is.stringValue(serverConfig.types.loggingComponent[0].restPath)) {
+        serverConfig.types.loggingComponent[0].restPath = "/logging";
+    }
+    if (Is.arrayValue(serverConfig.types.telemetryComponent) &&
+        !Is.stringValue(serverConfig.types.telemetryComponent[0].restPath)) {
+        serverConfig.types.telemetryComponent[0].restPath = "/telemetry";
     }
-    if (Is.arrayValue(serverConfig.authenticationComponent)) {
-        serverConfig.authenticationComponent[0].restPath = "authentication";
+    if (Is.arrayValue(serverConfig.types.identityComponent) &&
+        !Is.stringValue(serverConfig.types.identityComponent[0].restPath)) {
+        serverConfig.types.identityComponent[0].restPath = "/identity";
     }
-    if (Is.arrayValue(coreEngineConfig.blobStorageComponent)) {
-        coreEngineConfig.blobStorageComponent[0].restPath = "blob";
+    if (Is.arrayValue(serverConfig.types.identityResolverComponent) &&
+        !Is.stringValue(serverConfig.types.identityResolverComponent[0].restPath)) {
+        serverConfig.types.identityResolverComponent[0].restPath = "/identity";
     }
-    if (Is.arrayValue(coreEngineConfig.loggingComponent)) {
-        coreEngineConfig.loggingComponent[0].restPath = "logging";
+    if (Is.arrayValue(serverConfig.types.identityProfileComponent) &&
+        !Is.stringValue(serverConfig.types.identityProfileComponent[0].restPath)) {
+        serverConfig.types.identityProfileComponent[0].restPath = "/identity/profile";
     }
-    if (Is.arrayValue(coreEngineConfig.telemetryComponent)) {
-        coreEngineConfig.telemetryComponent[0].restPath = "telemetry";
+    if (Is.arrayValue(serverConfig.types.nftComponent) &&
+        !Is.stringValue(serverConfig.types.nftComponent[0].restPath)) {
+        serverConfig.types.nftComponent[0].restPath = "/nft";
     }
-    if (Is.arrayValue(coreEngineConfig.identityComponent)) {
-        coreEngineConfig.identityComponent[0].restPath = "identity";
+    if (Is.arrayValue(serverConfig.types.verifiableStorageComponent) &&
+        !Is.stringValue(serverConfig.types.verifiableStorageComponent[0].restPath)) {
+        serverConfig.types.verifiableStorageComponent[0].restPath = "/verifiable";
     }
-    if (Is.arrayValue(coreEngineConfig.identityProfileComponent)) {
-        coreEngineConfig.identityProfileComponent[0].restPath = "identity/profile";
+    if (Is.arrayValue(serverConfig.types.immutableProofComponent) &&
+        !Is.stringValue(serverConfig.types.immutableProofComponent[0].restPath)) {
+        serverConfig.types.immutableProofComponent[0].restPath = "/immutable-proof";
     }
-    if (Is.arrayValue(coreEngineConfig.nftComponent)) {
-        coreEngineConfig.nftComponent[0].restPath = "nft";
+    if (Is.arrayValue(serverConfig.types.attestationComponent) &&
+        !Is.stringValue(serverConfig.types.attestationComponent[0].restPath)) {
+        serverConfig.types.attestationComponent[0].restPath = "/attestation";
     }
-    if (Is.arrayValue(coreEngineConfig.attestationComponent)) {
-        coreEngineConfig.attestationComponent[0].restPath = "attestation";
+    if (Is.arrayValue(serverConfig.types.auditableItemGraphComponent) &&
+        !Is.stringValue(serverConfig.types.auditableItemGraphComponent[0].restPath)) {
+        serverConfig.types.auditableItemGraphComponent[0].restPath = "/aig";
     }
-    if (Is.arrayValue(coreEngineConfig.auditableItemGraphComponent)) {
-        coreEngineConfig.auditableItemGraphComponent[0].restPath = "aig";
+    if (Is.arrayValue(serverConfig.types.auditableItemStreamComponent) &&
+        !Is.stringValue(serverConfig.types.auditableItemStreamComponent[0].restPath)) {
+        serverConfig.types.auditableItemStreamComponent[0].restPath = "/ais";
     }
-    if (Is.arrayValue(coreEngineConfig.auditableItemStreamComponent)) {
-        coreEngineConfig.auditableItemStreamComponent[0].restPath = "ais";
+    if (Is.arrayValue(serverConfig.types.dataProcessingComponent) &&
+        !Is.stringValue(serverConfig.types.dataProcessingComponent[0].restPath)) {
+        serverConfig.types.dataProcessingComponent[0].restPath = "/data-processing";
+    }
+    if (Is.arrayValue(serverConfig.types.documentManagementComponent) &&
+        !Is.stringValue(serverConfig.types.documentManagementComponent[0].restPath)) {
+        serverConfig.types.documentManagementComponent[0].restPath = "/documents";
+    }
+    if (Is.arrayValue(serverConfig.types.federatedCatalogueComponent) &&
+        !Is.stringValue(serverConfig.types.federatedCatalogueComponent[0].restPath)) {
+        serverConfig.types.federatedCatalogueComponent[0].restPath = "/federated-catalogue";
+    }
+    if (Is.arrayValue(serverConfig.types.rightsManagementComponent) &&
+        !Is.stringValue(serverConfig.types.rightsManagementComponent[0].restPath)) {
+        serverConfig.types.rightsManagementComponent[0].restPath = "/rights-management";
+    }
+}
+/**
+ * Adds the socket paths to the server config.
+ * @param serverConfig The server config.
+ */
+function addDefaultSocketPaths(serverConfig) {
+    if (Is.arrayValue(serverConfig.types.eventBusComponent) &&
+        !Is.stringValue(serverConfig.types.eventBusComponent[0].socketPath)) {
+        serverConfig.types.eventBusComponent[0].socketPath = "event-bus";
     }
 }
 
-export { EngineServer, buildEngineServerConfiguration };
+export { EngineServer, addDefaultRestPaths, addDefaultSocketPaths };