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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server-types",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Server types to use in an engine server.",
 	"repository": {
 		"type": "git",
@@ -22,28 +22,41 @@
 		"@twin.org/api-rest-client": "next",
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/api-service": "next",
+		"@twin.org/api-tenant-processor": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-models": "0.0.2-next.9",
-		"@twin.org/engine-types": "0.0.2-next.9",
+		"@twin.org/engine-models": "0.0.3-next.2",
+		"@twin.org/engine-types": "0.0.3-next.2",
 		"@twin.org/entity": "next",
+		"@twin.org/identity-authentication": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/engine/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,427 +0,0 @@
-'use strict';
-
-var apiAuthEntityStorageRestClient = require('@twin.org/api-auth-entity-storage-rest-client');
-var apiAuthEntityStorageService = require('@twin.org/api-auth-entity-storage-service');
-var core = require('@twin.org/core');
-var engineTypes = require('@twin.org/engine-types');
-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');
-
-// 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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === AuthenticationComponentType.EntityStorage) {
-        apiAuthEntityStorageService.initSchema();
-        engineTypes.initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
-        component = new apiAuthEntityStorageService.EntityStorageAuthenticationService({
-            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
-            authenticationAdminServiceType: engineCore.getRegisteredInstanceType("authenticationAdminComponent"),
-            ...instanceConfig.options
-        });
-        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationService");
-    }
-    else if (type === AuthenticationComponentType.RestClient) {
-        component = new apiAuthEntityStorageRestClient.EntityStorageAuthenticationClient(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("EntityStorageAuthenticationClient");
-    }
-    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;
-}
-
-// 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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Authentication Admin Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (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"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    core.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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Information Component: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === InformationComponentType.Service) {
-        component = new apiService.InformationService(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("InformationService");
-    }
-    else if (type === InformationComponentType.RestClient) {
-        component = new apiRestClient.InformationClient(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("InformationClient");
-    }
-    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;
-}
-
-// 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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Mime Type Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === MimeTypeProcessorType.Jwt) {
-        component = new apiProcessors.JwtMimeTypeProcessor();
-        instanceType = core.StringHelper.kebabCase("JwtMimeTypeProcessor");
-    }
-    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;
-}
-
-// 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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `REST Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === RestRouteProcessorType.AuthHeader) {
-        component = new apiAuthEntityStorageService.AuthHeaderProcessor({
-            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
-    }
-    else if (type === RestRouteProcessorType.Logging) {
-        component = new apiProcessors.LoggingProcessor({
-            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
-    }
-    else if (type === RestRouteProcessorType.NodeIdentity) {
-        component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
-    }
-    else if (type === RestRouteProcessorType.StaticUserIdentity) {
-        component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
-    }
-    else if (type === RestRouteProcessorType.RestRoute) {
-        component = new apiProcessors.RestRouteProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("RestRouteProcessor");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "restRouteProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    apiModels.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(core.I18n.formatMessage("engineCore.configuring", {
-        element: `Socket Route Processor: ${instanceConfig.type}`
-    }));
-    const type = instanceConfig.type;
-    let component;
-    let instanceType;
-    if (type === SocketRouteProcessorType.AuthHeader) {
-        component = new apiAuthEntityStorageService.AuthHeaderProcessor({
-            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = core.StringHelper.kebabCase("AuthHeaderProcessor");
-    }
-    else if (type === SocketRouteProcessorType.Logging) {
-        component = new apiProcessors.LoggingProcessor({
-            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
-            config: {
-                ...instanceConfig.options?.config
-            }
-        });
-        instanceType = core.StringHelper.kebabCase("LoggingProcessor");
-    }
-    else if (type === SocketRouteProcessorType.NodeIdentity) {
-        component = new apiProcessors.NodeIdentityProcessor();
-        instanceType = core.StringHelper.kebabCase("NodeIdentityProcessor");
-    }
-    else if (type === SocketRouteProcessorType.StaticUserIdentity) {
-        component = new apiProcessors.StaticUserIdentityProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("StaticUserIdentityProcessor");
-    }
-    else if (type === SocketRouteProcessorType.SocketRoute) {
-        component = new apiProcessors.SocketRouteProcessor(instanceConfig.options);
-        instanceType = core.StringHelper.kebabCase("SocketRouteProcessor");
-    }
-    else {
-        throw new core.GeneralError("engineCore", "componentUnknownType", {
-            type,
-            componentType: "socketRouteProcessorComponent"
-        });
-    }
-    const finalInstanceType = overrideInstanceType ?? instanceType;
-    context.componentInstances.push({
-        instanceType: finalInstanceType,
-        component
-    });
-    apiModels.SocketRouteProcessorFactory.register(finalInstanceType, () => component);
-    return finalInstanceType;
-}
-
-exports.AuthenticationAdminComponentType = AuthenticationAdminComponentType;
-exports.AuthenticationComponentType = AuthenticationComponentType;
-exports.InformationComponentType = InformationComponentType;
-exports.MimeTypeProcessorType = MimeTypeProcessorType;
-exports.RestRouteProcessorType = RestRouteProcessorType;
-exports.SocketRouteProcessorType = SocketRouteProcessorType;
-exports.initialiseAuthenticationAdminComponent = initialiseAuthenticationAdminComponent;
-exports.initialiseAuthenticationComponent = initialiseAuthenticationComponent;
-exports.initialiseInformationComponent = initialiseInformationComponent;
-exports.initialiseMimeTypeProcessorComponent = initialiseMimeTypeProcessorComponent;
-exports.initialiseRestRouteProcessorComponent = initialiseRestRouteProcessorComponent;
-exports.initialiseSocketRouteProcessorComponent = initialiseSocketRouteProcessorComponent;