@twin.org/engine-server-types 0.0.2-next.2 → 0.0.2-next.20

package/dist/cjs/index.cjs

@@ -8,6 +8,7 @@ var apiRestClient = require('@twin.org/api-rest-client');
 var apiService = require('@twin.org/api-service');
 var apiModels = require('@twin.org/api-models');
 var apiProcessors = require('@twin.org/api-processors');
+var identityAuthentication = require('@twin.org/identity-authentication');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -31,44 +32,30 @@ 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.
  */
-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({
-            vaultConnectorType: context.defaultTypes.vaultConnector,
-            authenticationAdminServiceType: context.defaultTypes.authenticationAdminComponent,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            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.
@@ -89,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.
  */
-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.
@@ -145,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.
  */
-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");
+        instanceType = "information-client";
     }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "informationComponent"
-        });
-    }
-    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.
@@ -199,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.
  */
-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.
@@ -240,6 +185,10 @@ const RestRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Auth verifiable credential.
+     */
+    AuthVerifiableCredential: "auth-verifiable-credential",
     /**
      * Logging.
      */
@@ -265,60 +214,56 @@ 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.
  */
-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: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            config: {
+                ...instanceConfig.options?.config
+            }
+        });
+        instanceType = "auth-header-processor";
+    }
+    else if (instanceConfig.type === RestRouteProcessorType.AuthVerifiableCredential) {
+        component = new identityAuthentication.VerifiableCredentialAuthenticationProcessor({
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "verifiable-credential-authentication-processor";
     }
-    else if (type === RestRouteProcessorType.Logging) {
+    else if (instanceConfig.type === RestRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            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.
@@ -332,6 +277,10 @@ const SocketRouteProcessorType = {
      * Auth header.
      */
     AuthHeader: "auth-header",
+    /**
+     * Auth verifiable credential.
+     */
+    AuthVerifiableCredential: "auth-verifiable-credential",
     /**
      * Logging.
      */
@@ -357,60 +306,56 @@ 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.
  */
-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: context.defaultTypes.vaultConnector,
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
             config: {
                 ...instanceConfig.options?.config
             }
         });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
+        instanceType = "auth-header-processor";
     }
-    else if (type === SocketRouteProcessorType.Logging) {
+    else if (instanceConfig.type === SocketRouteProcessorType.AuthVerifiableCredential) {
+        component = new identityAuthentication.VerifiableCredentialAuthenticationProcessor({
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            config: {
+                ...instanceConfig.options?.config
+            }
+        });
+        instanceType = "verifiable-credential-authentication-processor";
+    }
+    else if (instanceConfig.type === SocketRouteProcessorType.Logging) {
         component = new apiProcessors.LoggingProcessor({
-            loggingConnectorType: context.defaultTypes.loggingConnector,
+            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;