@twin.org/engine-server-types 0.0.2-next.17 → 0.0.2-next.19

package/dist/cjs/index.cjs

@@ -32,18 +32,12 @@ const AuthenticationComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationComponentType.EntityStorage) {
         apiAuthEntityStorageService.initSchema();
         engineTypes.initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new apiAuthEntityStorageService.EntityStorageAuthenticationService({
@@ -51,25 +45,17 @@ async function initialiseAuthenticationComponent(engineCore, context, instanceCo
             authenticationAdminServiceType: engineCore.getRegisteredInstanceType("authenticationAdminComponent"),
             ...instanceConfig.options
         });
-        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationService");
+        instanceType = "entity-storage-authentication-service";
     }
-    else if (type === AuthenticationComponentType.RestClient) {
+    else if (instanceConfig.type === AuthenticationComponentType.RestClient) {
         component = new apiAuthEntityStorageRestClient.EntityStorageAuthenticationClient(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationClient");
+        instanceType = "entity-storage-authentication-client";
     }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    core.ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: core.ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -90,38 +76,24 @@ const AuthenticationAdminComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Admin Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationAdminComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationAdminComponentType.EntityStorage) {
         apiAuthEntityStorageService.initSchema();
         engineTypes.initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new apiAuthEntityStorageService.EntityStorageAuthenticationAdminService({
             ...instanceConfig.options
         });
-        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationAdminService");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationAdminComponent"
-        });
+        instanceType = "entity-storage-authentication-admin-service";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    core.ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: core.ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -146,38 +118,24 @@ const InformationComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Information Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseInformationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === InformationComponentType.Service) {
+    if (instanceConfig.type === InformationComponentType.Service) {
         component = new apiService.InformationService(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("InformationService");
+        instanceType = "information-service";
     }
-    else if (type === InformationComponentType.RestClient) {
+    else if (instanceConfig.type === InformationComponentType.RestClient) {
         component = new apiRestClient.InformationClient(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("InformationClient");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "informationComponent"
-        });
+        instanceType = "information-client";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    core.ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: core.ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -200,34 +158,20 @@ const MimeTypeProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Mime Type Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === MimeTypeProcessorType.Jwt) {
+    if (instanceConfig.type === MimeTypeProcessorType.Jwt) {
         component = new apiProcessors.JwtMimeTypeProcessor();
-        instanceType = core.StringHelper.kebabCase("JwtMimeTypeProcessor");
+        instanceType = "jwt-mime-type-processor";
     }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "mimeTypeProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    apiModels.MimeTypeProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: apiModels.MimeTypeProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -270,27 +214,21 @@ const RestRouteProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `REST Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === RestRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === RestRouteProcessorType.AuthHeader) {
         component = new apiAuthEntityStorageService.AuthHeaderProcessor({
             vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === RestRouteProcessorType.AuthVerifiableCredential) {
+    else if (instanceConfig.type === RestRouteProcessorType.AuthVerifiableCredential) {
         component = new identityAuthentication.VerifiableCredentialAuthenticationProcessor({
             identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
@@ -298,42 +236,34 @@ async function initialiseRestRouteProcessorComponent(engineCore, context, instan
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("VerifiableCredentialAuthenticationProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === RestRouteProcessorType.Logging) {
+    else if (instanceConfig.type === RestRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.NodeIdentity) {
         component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.StaticUserIdentity) {
         component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === RestRouteProcessorType.RestRoute) {
+    else if (instanceConfig.type === RestRouteProcessorType.RestRoute) {
         component = new apiProcessors.RestRouteProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("RestRouteProcessor");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "restRouteProcessorComponent"
-        });
+        instanceType = "rest-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    apiModels.RestRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: apiModels.RestRouteProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -376,27 +306,21 @@ const SocketRouteProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Socket Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === SocketRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === SocketRouteProcessorType.AuthHeader) {
         component = new apiAuthEntityStorageService.AuthHeaderProcessor({
             vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === SocketRouteProcessorType.AuthVerifiableCredential) {
+    else if (instanceConfig.type === SocketRouteProcessorType.AuthVerifiableCredential) {
         component = new identityAuthentication.VerifiableCredentialAuthenticationProcessor({
             identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
@@ -404,42 +328,34 @@ async function initialiseSocketRouteProcessorComponent(engineCore, context, inst
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("VerifiableCredentialAuthenticationProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === SocketRouteProcessorType.Logging) {
+    else if (instanceConfig.type === SocketRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.NodeIdentity) {
         component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.StaticUserIdentity) {
         component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
+    else if (instanceConfig.type === SocketRouteProcessorType.SocketRoute) {
         component = new apiProcessors.SocketRouteProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("SocketRouteProcessor");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "socketRouteProcessorComponent"
-        });
+        instanceType = "socket-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    apiModels.SocketRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: apiModels.SocketRouteProcessorFactory
+    };
 }
 
 exports.AuthenticationAdminComponentType = AuthenticationAdminComponentType;

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { EntityStorageAuthenticationClient } from '@twin.org/api-auth-entity-storage-rest-client';
 import { initSchema, EntityStorageAuthenticationService, EntityStorageAuthenticationAdminService, AuthHeaderProcessor } from '@twin.org/api-auth-entity-storage-service';
-import { I18n, StringHelper, GeneralError, ComponentFactory } from '@twin.org/core';
+import { ComponentFactory } from '@twin.org/core';
 import { initialiseEntityStorageConnector } from '@twin.org/engine-types';
 import { InformationClient } from '@twin.org/api-rest-client';
 import { InformationService } from '@twin.org/api-service';
@@ -30,18 +30,12 @@ const AuthenticationComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseAuthenticationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationComponentType.EntityStorage) {
         initSchema();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationService({
@@ -49,25 +43,17 @@ async function initialiseAuthenticationComponent(engineCore, context, instanceCo
             authenticationAdminServiceType: engineCore.getRegisteredInstanceType("authenticationAdminComponent"),
             ...instanceConfig.options
         });
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationService");
+        instanceType = "entity-storage-authentication-service";
     }
-    else if (type === AuthenticationComponentType.RestClient) {
+    else if (instanceConfig.type === AuthenticationComponentType.RestClient) {
         component = new EntityStorageAuthenticationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationClient");
+        instanceType = "entity-storage-authentication-client";
     }
-    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;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -88,38 +74,24 @@ const AuthenticationAdminComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Admin Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === AuthenticationAdminComponentType.EntityStorage) {
+    if (instanceConfig.type === AuthenticationAdminComponentType.EntityStorage) {
         initSchema();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationAdminService({
             ...instanceConfig.options
         });
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationAdminService");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "authenticationAdminComponent"
-        });
+        instanceType = "entity-storage-authentication-admin-service";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -144,38 +116,24 @@ const InformationComponentType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseInformationComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Information Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseInformationComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === InformationComponentType.Service) {
+    if (instanceConfig.type === InformationComponentType.Service) {
         component = new InformationService(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("InformationService");
+        instanceType = "information-service";
     }
-    else if (type === InformationComponentType.RestClient) {
+    else if (instanceConfig.type === InformationComponentType.RestClient) {
         component = new InformationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("InformationClient");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "informationComponent"
-        });
+        instanceType = "information-client";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    ComponentFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -198,34 +156,20 @@ const MimeTypeProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Mime Type Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseMimeTypeProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === MimeTypeProcessorType.Jwt) {
+    if (instanceConfig.type === MimeTypeProcessorType.Jwt) {
         component = new JwtMimeTypeProcessor();
-        instanceType = StringHelper.kebabCase("JwtMimeTypeProcessor");
+        instanceType = "jwt-mime-type-processor";
     }
-    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;
+    return {
+        component,
+        instanceType,
+        factory: MimeTypeProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -268,27 +212,21 @@ const RestRouteProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `REST Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseRestRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === RestRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === RestRouteProcessorType.AuthHeader) {
         component = new AuthHeaderProcessor({
             vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === RestRouteProcessorType.AuthVerifiableCredential) {
+    else if (instanceConfig.type === RestRouteProcessorType.AuthVerifiableCredential) {
         component = new VerifiableCredentialAuthenticationProcessor({
             identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
@@ -296,42 +234,34 @@ async function initialiseRestRouteProcessorComponent(engineCore, context, instan
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("VerifiableCredentialAuthenticationProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === RestRouteProcessorType.Logging) {
+    else if (instanceConfig.type === RestRouteProcessorType.Logging) {
         component = new LoggingProcessor({
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === RestRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === RestRouteProcessorType.RestRoute) {
+    else if (instanceConfig.type === RestRouteProcessorType.RestRoute) {
         component = new RestRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("RestRouteProcessor");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "restRouteProcessorComponent"
-        });
+        instanceType = "rest-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    RestRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: RestRouteProcessorFactory
+    };
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -374,27 +304,21 @@ const SocketRouteProcessorType = {
  * @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.
+ * @returns The instance created and the factory for it.
  */
-async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Socket Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
+async function initialiseSocketRouteProcessorComponent(engineCore, context, instanceConfig) {
     let component;
     let instanceType;
-    if (type === SocketRouteProcessorType.AuthHeader) {
+    if (instanceConfig.type === SocketRouteProcessorType.AuthHeader) {
         component = new AuthHeaderProcessor({
             vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === SocketRouteProcessorType.AuthVerifiableCredential) {
+    else if (instanceConfig.type === SocketRouteProcessorType.AuthVerifiableCredential) {
         component = new VerifiableCredentialAuthenticationProcessor({
             identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
@@ -402,42 +326,34 @@ async function initialiseSocketRouteProcessorComponent(engineCore, context, inst
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("VerifiableCredentialAuthenticationProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === SocketRouteProcessorType.Logging) {
+    else if (instanceConfig.type === SocketRouteProcessorType.Logging) {
         component = new LoggingProcessor({
             loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
+        instanceType = "logging-processor";
     }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.NodeIdentity) {
         component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
+        instanceType = "node-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
+    else if (instanceConfig.type === SocketRouteProcessorType.StaticUserIdentity) {
         component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
+        instanceType = "static-user-identity-processor";
     }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
+    else if (instanceConfig.type === SocketRouteProcessorType.SocketRoute) {
         component = new SocketRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("SocketRouteProcessor");
-    }
-    else {
-        throw new GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "socketRouteProcessorComponent"
-        });
+        instanceType = "socket-route-processor";
     }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    SocketRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
+    return {
+        component,
+        instanceType,
+        factory: SocketRouteProcessorFactory
+    };
 }
 
 export { AuthenticationAdminComponentType, AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType, initialiseAuthenticationAdminComponent, initialiseAuthenticationComponent, initialiseInformationComponent, initialiseMimeTypeProcessorComponent, initialiseRestRouteProcessorComponent, initialiseSocketRouteProcessorComponent };

package/dist/types/components/authentication.d.ts

@@ -1,3 +1,4 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { AuthenticationComponentConfig } from "../models/config/authenticationComponentConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseAuthenticationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

package/dist/types/components/authenticationAdmin.d.ts

@@ -1,3 +1,4 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { AuthenticationAdminComponentConfig } from "../models/config/authenticationAdminComponentConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseAuthenticationAdminComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: AuthenticationAdminComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

package/dist/types/components/information.d.ts

@@ -1,3 +1,4 @@
+import { ComponentFactory, type IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { InformationComponentConfig } from "../models/config/informationComponentConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +7,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseInformationComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: InformationComponentConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof ComponentFactory;
+    component?: IComponent;
+}>;

package/dist/types/components/mimeTypeProcessor.d.ts

@@ -1,3 +1,5 @@
+import { MimeTypeProcessorFactory } from "@twin.org/api-models";
+import type { IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { MimeTypeProcessorConfig } from "../models/config/mimeTypeProcessorConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: MimeTypeProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof MimeTypeProcessorFactory;
+    component?: IComponent;
+}>;

package/dist/types/components/restRouteProcessor.d.ts

@@ -1,4 +1,6 @@
-import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
+import { RestRouteProcessorFactory } from "@twin.org/api-models";
+import type { IComponent } from "@twin.org/core";
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { RestRouteProcessorConfig } from "../models/config/restRouteProcessorConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
 /**
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: RestRouteProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof RestRouteProcessorFactory;
+    component?: IComponent;
+}>;

package/dist/types/components/socketRouteProcessor.d.ts

@@ -1,3 +1,5 @@
+import { SocketRouteProcessorFactory } from "@twin.org/api-models";
+import type { IComponent } from "@twin.org/core";
 import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { SocketRouteProcessorConfig } from "../models/config/socketRouteProcessorConfig";
 import type { IEngineServerConfig } from "../models/IEngineServerConfig";
@@ -6,8 +8,10 @@ import type { IEngineServerConfig } from "../models/IEngineServerConfig";
  * @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.
+ * @returns The instance created and the factory for it.
  */
-export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): Promise<string | undefined>;
+export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore<IEngineServerConfig>, context: IEngineCoreContext<IEngineServerConfig>, instanceConfig: SocketRouteProcessorConfig): Promise<{
+    instanceType?: string;
+    factory?: typeof SocketRouteProcessorFactory;
+    component?: IComponent;
+}>;

package/docs/changelog.md

@@ -1,5 +1,35 @@
 # @twin.org/engine-server-types - Changelog
 
+## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.18...engine-server-types-v0.0.2-next.19) (2025-10-02)
+
+
+### Features
+
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/engine-types bumped from 0.0.2-next.18 to 0.0.2-next.19
+
+## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.17...engine-server-types-v0.0.2-next.18) (2025-09-29)
+
+
+### Features
+
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/engine-types bumped from 0.0.2-next.17 to 0.0.2-next.18
+
 ## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-server-types-v0.0.2-next.16...engine-server-types-v0.0.2-next.17) (2025-09-26)
 
 

package/docs/reference/functions/initialiseAuthenticationAdminComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuthenticationAdminComponent()
 
-> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseAuthenticationAdminComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the authentication admin.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseAuthenticationComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseAuthenticationComponent()
 
-> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseAuthenticationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the authentication.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseInformationComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseInformationComponent()
 
-> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseInformationComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
 Initialise the information component.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IComponent`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseMimeTypeProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseMimeTypeProcessorComponent()
 
-> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseMimeTypeProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
 
 Initialise the mime type processor.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IMimeTypeProcessor`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseRestRouteProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseRestRouteProcessorComponent()
 
-> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseRestRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
 
 Initialise the rest route processor.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`IRestRouteProcessor`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/docs/reference/functions/initialiseSocketRouteProcessorComponent.md

@@ -1,6 +1,6 @@
 # Function: initialiseSocketRouteProcessorComponent()
 
-> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `Promise`\<`undefined` \| `string`\>
+> **initialiseSocketRouteProcessorComponent**(`engineCore`, `context`, `instanceConfig`): `Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
 
 Initialise the socket route processor.
 
@@ -24,18 +24,8 @@ The context for the engine.
 
 The instance config.
 
-### overrideInstanceType?
-
-`string`
-
-The instance type to override the default.
-
 ## Returns
 
-`Promise`\<`undefined` \| `string`\>
-
-The name of the instance created.
-
-## Throws
+`Promise`\<\{ `instanceType?`: `string`; `factory?`: `Factory`\<`ISocketRouteProcessor`\>; `component?`: `IComponent`; \}\>
 
-GeneralError if the component type is unknown.
+The instance created and the factory for it.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server-types",
-	"version": "0.0.2-next.17",
+	"version": "0.0.2-next.19",
 	"description": "Server types to use in an engine server.",
 	"repository": {
 		"type": "git",
@@ -23,8 +23,8 @@
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/api-service": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-models": "0.0.2-next.17",
-		"@twin.org/engine-types": "0.0.2-next.17",
+		"@twin.org/engine-models": "0.0.2-next.19",
+		"@twin.org/engine-types": "0.0.2-next.19",
 		"@twin.org/entity": "next",
 		"@twin.org/identity-authentication": "next",
 		"@twin.org/nameof": "next"
@@ -46,5 +46,13 @@
 		"dist/types",
 		"locales",
 		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine"
 	]
 }