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

package/dist/esm/index.mjs

@@ -1,414 +0,0 @@
-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 { initialiseEntityStorageConnector } from '@twin.org/engine-types';
-import { InformationClient } from '@twin.org/api-rest-client';
-import { InformationService } from '@twin.org/api-service';
-import { MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory } from '@twin.org/api-models';
-import { JwtMimeTypeProcessor, LoggingProcessor, NodeIdentityProcessor, StaticUserIdentityProcessor, RestRouteProcessor, SocketRouteProcessor } from '@twin.org/api-processors';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Authentication component types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const AuthenticationComponentType = {
-    /**
-     * Entity storage.
-     */
-    EntityStorage: "entity-storage",
-    /**
-     * REST client.
-     */
-    RestClient: "rest-client"
-};
-
-/**
- * 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: engineCore.getRegisteredInstanceType("vaultConnector"),
-            authenticationAdminServiceType: engineCore.getRegisteredInstanceType("authenticationAdminComponent"),
-            ...instanceConfig.options
-        });
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationService");
-    }
-    else if (type === AuthenticationComponentType.RestClient) {
-        component = new EntityStorageAuthenticationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("EntityStorageAuthenticationClient");
-    }
-    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;
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Authentication admin component types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const AuthenticationAdminComponentType = {
-    /**
-     * Entity storage.
-     */
-    EntityStorage: "entity-storage"
-};
-
-/**
- * Initialise the authentication admin.
- * @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 initialiseAuthenticationAdminComponent(engineCore, context, instanceConfig, overrideInstanceType) {
-    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Admin Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (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"
-        });
-    }
-    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.
-/**
- * Information component types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const InformationComponentType = {
-    /**
-     * Service.
-     */
-    Service: "service",
-    /**
-     * REST client.
-     */
-    RestClient: "rest-client"
-};
-
-/**
- * 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 = StringHelper.kebabCase("InformationService");
-    }
-    else if (type === InformationComponentType.RestClient) {
-        component = new InformationClient(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("InformationClient");
-    }
-    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.
-/**
- * Mime type route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const MimeTypeProcessorType = {
-    /**
-     * Jwt.
-     */
-    Jwt: "jwt"
-};
-
-// 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 = StringHelper.kebabCase("JwtMimeTypeProcessor");
-    }
-    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.
-/**
- * REST route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const RestRouteProcessorType = {
-    /**
-     * Auth header.
-     */
-    AuthHeader: "auth-header",
-    /**
-     * Logging.
-     */
-    Logging: "logging",
-    /**
-     * Node Identity.
-     */
-    NodeIdentity: "node-identity",
-    /**
-     * Static User Identity.
-     */
-    StaticUserIdentity: "static-user-identity",
-    /**
-     * REST Route.
-     */
-    RestRoute: "rest-route"
-};
-
-// 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: engineCore.getRegisteredInstanceType("vaultConnector"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
-    }
-    else if (type === RestRouteProcessorType.Logging) {
-        component = new LoggingProcessor({
-            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
-    }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
-        component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
-    }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
-        component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
-    }
-    else if (type === RestRouteProcessorType.RestRoute) {
-        component = new RestRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("RestRouteProcessor");
-    }
-    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.
-/**
- * Socket route processor types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const SocketRouteProcessorType = {
-    /**
-     * Auth header.
-     */
-    AuthHeader: "auth-header",
-    /**
-     * Logging.
-     */
-    Logging: "logging",
-    /**
-     * Node Identity.
-     */
-    NodeIdentity: "node-identity",
-    /**
-     * Static User Identity.
-     */
-    StaticUserIdentity: "static-user-identity",
-    /**
-     * Socket Route.
-     */
-    SocketRoute: "socket-route"
-};
-
-// 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: engineCore.getRegisteredInstanceType("vaultConnector"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = StringHelper.kebabCase("AuthHeaderProcessor");
-    }
-    else if (type === SocketRouteProcessorType.Logging) {
-        component = new LoggingProcessor({
-            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = StringHelper.kebabCase("LoggingProcessor");
-    }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
-        component = new NodeIdentityProcessor();
-        instanceType = StringHelper.kebabCase("NodeIdentityProcessor");
-    }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
-        component = new StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("StaticUserIdentityProcessor");
-    }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
-        component = new SocketRouteProcessor(instanceConfig.options);
-        instanceType = StringHelper.kebabCase("SocketRouteProcessor");
-    }
-    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;
-}
-
-export { AuthenticationAdminComponentType, AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType, initialiseAuthenticationAdminComponent, initialiseAuthenticationComponent, initialiseInformationComponent, initialiseMimeTypeProcessorComponent, initialiseRestRouteProcessorComponent, initialiseSocketRouteProcessorComponent };