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

package/dist/esm/index.mjs

@@ -1,423 +0,0 @@
-import { RestRouteProcessorFactory, SocketRouteProcessorFactory, MimeTypeProcessorFactory } from '@twin.org/api-models';
-import { FastifyWebServer } from '@twin.org/api-server-fastify';
-import { Guards, Is, StringHelper } from '@twin.org/core';
-import { RestRouteProcessorType, SocketRouteProcessorType } from '@twin.org/engine-server-types';
-import { ModuleHelper } from '@twin.org/modules';
-
-/**
- * Server for the engine.
- */
-class EngineServer {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "EngineServer";
-    /**
-     * The engine.
-     * @internal
-     */
-    _engineCore;
-    /**
-     * The REST route generators.
-     * @internal
-     */
-    _restRouteGenerators;
-    /**
-     * The socket route generators.
-     * @internal
-     */
-    _socketRouteGenerators;
-    /**
-     * The web server.
-     * @internal
-     */
-    _webServer;
-    /**
-     * The logging component type.
-     * @internal
-     */
-    _loggingComponentType;
-    /**
-     * The REST routes for the application.
-     * @internal
-     */
-    _restRoutes;
-    /**
-     * The Socket routes for the application.
-     * @internal
-     */
-    _socketRoutes;
-    /**
-     * Create a new instance of EngineServer.
-     * @param options The options for the engine.
-     * @param options.engineCore The engine core to serve from.
-     */
-    constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.object(this.CLASS_NAME, "options.engineCore", options.engineCore);
-        this._engineCore = options.engineCore;
-        this._restRouteGenerators = [];
-        this._socketRouteGenerators = [];
-        this._restRoutes = [];
-        this._socketRoutes = [];
-        const coreConfig = this._engineCore.getConfig();
-        if (!Is.arrayValue(coreConfig.types.restRouteProcessor)) {
-            coreConfig.types.restRouteProcessor = [];
-            if (!coreConfig.silent) {
-                coreConfig.types.restRouteProcessor.push({
-                    type: RestRouteProcessorType.Logging,
-                    options: {
-                        config: {
-                            includeBody: coreConfig.debug
-                        }
-                    }
-                });
-            }
-            coreConfig.types.restRouteProcessor.push({
-                type: RestRouteProcessorType.RestRoute,
-                options: {
-                    config: {
-                        includeErrorStack: coreConfig.debug
-                    }
-                }
-            });
-        }
-        if (!Is.arrayValue(coreConfig.types.socketRouteProcessor)) {
-            coreConfig.types.socketRouteProcessor = [];
-            if (!coreConfig.silent) {
-                coreConfig.types.socketRouteProcessor.push({
-                    type: SocketRouteProcessorType.Logging,
-                    options: {
-                        config: {
-                            includeBody: coreConfig.debug
-                        }
-                    }
-                });
-            }
-            coreConfig.types.socketRouteProcessor.push({
-                type: SocketRouteProcessorType.SocketRoute,
-                options: {
-                    config: {
-                        includeErrorStack: coreConfig.debug
-                    }
-                }
-            });
-        }
-        this.addServerTypeInitialisers();
-        this.addServerRestRouteGenerators();
-        this.addServerSocketRouteGenerators();
-    }
-    /**
-     * Add a REST route generator.
-     * @param type The type to add the generator for.
-     * @param typeConfig The type config.
-     * @param module The module containing the generator.
-     * @param method The method to call on the module.
-     */
-    addRestRouteGenerator(type, typeConfig, module, method) {
-        if (!Is.empty(typeConfig)) {
-            this._restRouteGenerators.push({
-                type,
-                typeConfig,
-                module,
-                method
-            });
-        }
-    }
-    /**
-     * Add a socket route generator.
-     * @param type The type to add the generator for.
-     * @param typeConfig The type config.
-     * @param module The module containing the generator.
-     * @param method The method to call on the module.
-     */
-    addSocketRouteGenerator(type, typeConfig, module, method) {
-        if (!Is.empty(typeConfig)) {
-            this._socketRouteGenerators.push({
-                type,
-                typeConfig,
-                module,
-                method
-            });
-        }
-    }
-    /**
-     * Get the built REST routes.
-     * @returns The REST routes.
-     */
-    getRestRoutes() {
-        return this._restRoutes;
-    }
-    /**
-     * Get the built socket routes.
-     * @returns The socket routes.
-     */
-    getSocketRoutes() {
-        return this._socketRoutes;
-    }
-    /**
-     * Start the engine server.
-     * @returns True if the start was successful.
-     */
-    async start() {
-        const canContinue = await this._engineCore.start();
-        if (canContinue) {
-            await this.startWebServer();
-        }
-        return canContinue;
-    }
-    /**
-     * Stop the engine server.
-     * @returns Nothing.
-     */
-    async stop() {
-        if (this._webServer) {
-            await this._webServer.stop();
-            this._webServer = undefined;
-        }
-        await this._engineCore.stop();
-    }
-    /**
-     * Starts the web server.
-     * @internal
-     */
-    async startWebServer() {
-        this._restRoutes = await this.buildRestRoutes();
-        this._socketRoutes = await this.buildSocketRoutes();
-        const restRouteProcessors = RestRouteProcessorFactory.names().map(n => RestRouteProcessorFactory.get(n));
-        const socketRouteProcessors = SocketRouteProcessorFactory.names().map(n => SocketRouteProcessorFactory.get(n));
-        const mimeTypeProcessors = MimeTypeProcessorFactory.names().map(n => MimeTypeProcessorFactory.get(n));
-        const coreConfig = this._engineCore.getConfig();
-        this._loggingComponentType = coreConfig.silent
-            ? undefined
-            : this._engineCore.getRegisteredInstanceType("loggingComponent");
-        this._webServer = new FastifyWebServer({
-            loggingComponentType: this._loggingComponentType,
-            mimeTypeProcessors
-        });
-        await this._webServer.build(restRouteProcessors, this._restRoutes, socketRouteProcessors, this._socketRoutes, coreConfig.web);
-        await this._webServer.start();
-    }
-    /**
-     * The REST routes for the application.
-     * @returns The REST routes for the application.
-     * @internal
-     */
-    async buildRestRoutes() {
-        const routes = [];
-        for (const { type, typeConfig, module, method } of this._restRouteGenerators) {
-            await this.initialiseRestTypeRoute(routes, type, typeConfig, module, method);
-        }
-        return routes;
-    }
-    /**
-     * The socket routes for the application.
-     * @returns The socket routes for the application.
-     * @internal
-     */
-    async buildSocketRoutes() {
-        const routes = [];
-        for (const { type, typeConfig, module, method } of this._socketRouteGenerators) {
-            await this.initialiseSocketTypeRoute(routes, type, typeConfig, module, method);
-        }
-        return routes;
-    }
-    /**
-     * Initialise the rest routes from connector.
-     * @param routes The routes to add to.
-     * @param typeKey The key for the default types.
-     * @param typeConfig The type config.
-     * @param generateRoutes The function to generate the routes.
-     * @internal
-     */
-    async initialiseRestTypeRoute(routes, typeKey, typeConfig, module, method) {
-        if (Is.arrayValue(typeConfig)) {
-            const generateRoutes = await ModuleHelper.getModuleEntry(module, method);
-            for (let i = 0; i < typeConfig.length; i++) {
-                const restPath = typeConfig[i].restPath;
-                if (Is.string(restPath)) {
-                    const serviceType = typeConfig[i].overrideInstanceType ??
-                        this._engineCore.getRegisteredInstanceType(typeKey);
-                    if (Is.stringValue(serviceType)) {
-                        const generatedRoutes = generateRoutes(restPath, serviceType);
-                        for (const route of generatedRoutes) {
-                            // Don't strip trailing slashes from the root path.
-                            if (Is.stringValue(route.path) && route.path.length > 1) {
-                                route.path = StringHelper.trimTrailingSlashes(route.path);
-                            }
-                        }
-                        routes.push(...generatedRoutes);
-                    }
-                }
-            }
-        }
-    }
-    /**
-     * Initialise the socket routes from connector.
-     * @param routes The routes to add to.
-     * @param typeKey The key for the default types.
-     * @param typeConfig The type config.
-     * @param module The module containing the generator.
-     * @param method The method to call on the module.
-     * @internal
-     */
-    async initialiseSocketTypeRoute(routes, typeKey, typeConfig, module, method) {
-        if (Is.arrayValue(typeConfig)) {
-            const generateRoutes = await ModuleHelper.getModuleEntry(module, method);
-            for (let i = 0; i < typeConfig.length; i++) {
-                const socketPath = typeConfig[i].socketPath;
-                if (Is.string(socketPath)) {
-                    const serviceType = typeConfig[i].overrideInstanceType ??
-                        this._engineCore.getRegisteredInstanceType(typeKey);
-                    if (Is.stringValue(serviceType)) {
-                        routes.push(...generateRoutes(socketPath, serviceType));
-                    }
-                }
-            }
-        }
-    }
-    /**
-     * Add the server type initializers.
-     * @internal
-     */
-    addServerTypeInitialisers() {
-        const coreConfig = this._engineCore.getConfig();
-        this._engineCore.addTypeInitialiser("authenticationAdminComponent", coreConfig.types.authenticationAdminComponent, "@twin.org/engine-server-types", "initialiseAuthenticationAdminComponent");
-        this._engineCore.addTypeInitialiser("authenticationComponent", coreConfig.types.authenticationComponent, "@twin.org/engine-server-types", "initialiseAuthenticationComponent");
-        this._engineCore.addTypeInitialiser("informationComponent", coreConfig.types.informationComponent, "@twin.org/engine-server-types", "initialiseInformationComponent");
-        this._engineCore.addTypeInitialiser("restRouteProcessor", coreConfig.types.restRouteProcessor, "@twin.org/engine-server-types", "initialiseRestRouteProcessorComponent");
-        this._engineCore.addTypeInitialiser("socketRouteProcessor", coreConfig.types.socketRouteProcessor, "@twin.org/engine-server-types", "initialiseSocketRouteProcessorComponent");
-        this._engineCore.addTypeInitialiser("mimeTypeProcessor", coreConfig.types.mimeTypeProcessor, "@twin.org/engine-server-types", "initialiseMimeTypeProcessorComponent");
-    }
-    /**
-     * Add the server REST route generators.
-     * @internal
-     */
-    addServerRestRouteGenerators() {
-        const coreConfig = this._engineCore.getConfig();
-        this.addRestRouteGenerator("informationComponent", coreConfig.types.informationComponent, "@twin.org/api-service", "generateRestRoutesInformation");
-        this.addRestRouteGenerator("authenticationComponent", coreConfig.types.authenticationComponent, "@twin.org/api-auth-entity-storage-service", "generateRestRoutesAuthentication");
-        this.addRestRouteGenerator("loggingComponent", coreConfig.types.loggingComponent, "@twin.org/logging-service", "generateRestRoutesLogging");
-        this.addRestRouteGenerator("telemetryComponent", coreConfig.types.telemetryComponent, "@twin.org/telemetry-service", "generateRestRoutesTelemetry");
-        this.addRestRouteGenerator("blobStorageComponent", coreConfig.types.blobStorageComponent, "@twin.org/blob-storage-service", "generateRestRoutesBlobStorage");
-        this.addRestRouteGenerator("identityComponent", coreConfig.types.identityComponent, "@twin.org/identity-service", "generateRestRoutesIdentity");
-        this.addRestRouteGenerator("identityResolverComponent", coreConfig.types.identityResolverComponent, "@twin.org/identity-service", "generateRestRoutesIdentityResolver");
-        this.addRestRouteGenerator("identityProfileComponent", coreConfig.types.identityProfileComponent, "@twin.org/identity-service", "generateRestRoutesIdentityProfile");
-        this.addRestRouteGenerator("nftComponent", coreConfig.types.nftComponent, "@twin.org/nft-service", "generateRestRoutesNft");
-        this.addRestRouteGenerator("verifiableStorageComponent", coreConfig.types.verifiableStorageComponent, "@twin.org/verifiable-storage-service", "generateRestRoutesVerifiableStorage");
-        this.addRestRouteGenerator("attestationComponent", coreConfig.types.attestationComponent, "@twin.org/attestation-service", "generateRestRoutesAttestation");
-        this.addRestRouteGenerator("immutableProofComponent", coreConfig.types.immutableProofComponent, "@twin.org/immutable-proof-service", "generateRestRoutesImmutableProof");
-        this.addRestRouteGenerator("auditableItemGraphComponent", coreConfig.types.auditableItemGraphComponent, "@twin.org/auditable-item-graph-service", "generateRestRoutesAuditableItemGraph");
-        this.addRestRouteGenerator("auditableItemStreamComponent", coreConfig.types.auditableItemStreamComponent, "@twin.org/auditable-item-stream-service", "generateRestRoutesAuditableItemStream");
-        this.addRestRouteGenerator("entityStorageComponent", coreConfig.types.entityStorageComponent, "@twin.org/entity-storage-service", "generateRestRoutesEntityStorage");
-        this.addRestRouteGenerator("dataProcessingComponent", coreConfig.types.dataProcessingComponent, "@twin.org/data-processing-service", "generateRestRoutesDataProcessing");
-        this.addRestRouteGenerator("documentManagementComponent", coreConfig.types.documentManagementComponent, "@twin.org/document-management-service", "generateRestRoutesDocumentManagement");
-        this.addRestRouteGenerator("rightsManagementComponent", coreConfig.types.rightsManagementComponent, "@twin.org/rights-management-service", "generateRestRoutesRightsManagement");
-        this.addRestRouteGenerator("synchronisedStorageComponent", coreConfig.types.synchronisedStorageComponent, "@twin.org/synchronised-storage-service", "generateRestRoutesSynchronisedStorage");
-        this.addRestRouteGenerator("federatedCatalogueComponent", coreConfig.types.federatedCatalogueComponent, "@twin.org/federated-catalogue-service", "generateRestRoutesFederatedCatalogue");
-    }
-    /**
-     * Add the server socket route generators.
-     * @internal
-     */
-    addServerSocketRouteGenerators() {
-        const coreConfig = this._engineCore.getConfig();
-        this.addSocketRouteGenerator("eventBusComponent", coreConfig.types.eventBusComponent, "@twin.org/event-bus-service", "generateSocketRoutesEventBus");
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Adds the rest paths to the server config.
- * @param serverConfig The server config.
- */
-function addDefaultRestPaths(serverConfig) {
-    if (Is.arrayValue(serverConfig.types.informationComponent)) {
-        serverConfig.types.informationComponent[0].restPath = "";
-    }
-    if (Is.arrayValue(serverConfig.types.authenticationComponent) &&
-        !Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
-        serverConfig.types.authenticationComponent[0].restPath = "/authentication";
-    }
-    if (Is.arrayValue(serverConfig.types.blobStorageComponent) &&
-        !Is.stringValue(serverConfig.types.blobStorageComponent[0].restPath)) {
-        serverConfig.types.blobStorageComponent[0].restPath = "/blob";
-    }
-    if (Is.arrayValue(serverConfig.types.loggingComponent) &&
-        !Is.stringValue(serverConfig.types.loggingComponent[0].restPath)) {
-        serverConfig.types.loggingComponent[0].restPath = "/logging";
-    }
-    if (Is.arrayValue(serverConfig.types.telemetryComponent) &&
-        !Is.stringValue(serverConfig.types.telemetryComponent[0].restPath)) {
-        serverConfig.types.telemetryComponent[0].restPath = "/telemetry";
-    }
-    if (Is.arrayValue(serverConfig.types.identityComponent) &&
-        !Is.stringValue(serverConfig.types.identityComponent[0].restPath)) {
-        serverConfig.types.identityComponent[0].restPath = "/identity";
-    }
-    if (Is.arrayValue(serverConfig.types.identityResolverComponent) &&
-        !Is.stringValue(serverConfig.types.identityResolverComponent[0].restPath)) {
-        serverConfig.types.identityResolverComponent[0].restPath = "/identity";
-    }
-    if (Is.arrayValue(serverConfig.types.identityProfileComponent) &&
-        !Is.stringValue(serverConfig.types.identityProfileComponent[0].restPath)) {
-        serverConfig.types.identityProfileComponent[0].restPath = "/identity/profile";
-    }
-    if (Is.arrayValue(serverConfig.types.nftComponent) &&
-        !Is.stringValue(serverConfig.types.nftComponent[0].restPath)) {
-        serverConfig.types.nftComponent[0].restPath = "/nft";
-    }
-    if (Is.arrayValue(serverConfig.types.verifiableStorageComponent) &&
-        !Is.stringValue(serverConfig.types.verifiableStorageComponent[0].restPath)) {
-        serverConfig.types.verifiableStorageComponent[0].restPath = "/verifiable";
-    }
-    if (Is.arrayValue(serverConfig.types.immutableProofComponent) &&
-        !Is.stringValue(serverConfig.types.immutableProofComponent[0].restPath)) {
-        serverConfig.types.immutableProofComponent[0].restPath = "/immutable-proof";
-    }
-    if (Is.arrayValue(serverConfig.types.attestationComponent) &&
-        !Is.stringValue(serverConfig.types.attestationComponent[0].restPath)) {
-        serverConfig.types.attestationComponent[0].restPath = "/attestation";
-    }
-    if (Is.arrayValue(serverConfig.types.auditableItemGraphComponent) &&
-        !Is.stringValue(serverConfig.types.auditableItemGraphComponent[0].restPath)) {
-        serverConfig.types.auditableItemGraphComponent[0].restPath = "/aig";
-    }
-    if (Is.arrayValue(serverConfig.types.auditableItemStreamComponent) &&
-        !Is.stringValue(serverConfig.types.auditableItemStreamComponent[0].restPath)) {
-        serverConfig.types.auditableItemStreamComponent[0].restPath = "/ais";
-    }
-    if (Is.arrayValue(serverConfig.types.dataProcessingComponent) &&
-        !Is.stringValue(serverConfig.types.dataProcessingComponent[0].restPath)) {
-        serverConfig.types.dataProcessingComponent[0].restPath = "/data-processing";
-    }
-    if (Is.arrayValue(serverConfig.types.documentManagementComponent) &&
-        !Is.stringValue(serverConfig.types.documentManagementComponent[0].restPath)) {
-        serverConfig.types.documentManagementComponent[0].restPath = "/documents";
-    }
-    if (Is.arrayValue(serverConfig.types.rightsManagementComponent) &&
-        !Is.stringValue(serverConfig.types.rightsManagementComponent[0].restPath)) {
-        serverConfig.types.rightsManagementComponent[0].restPath = "/rights-management";
-    }
-    if (Is.arrayValue(serverConfig.types.synchronisedStorageComponent) &&
-        !Is.stringValue(serverConfig.types.synchronisedStorageComponent[0].restPath)) {
-        serverConfig.types.synchronisedStorageComponent[0].restPath = "/synchronised-storage";
-    }
-    if (Is.arrayValue(serverConfig.types.federatedCatalogueComponent) &&
-        !Is.stringValue(serverConfig.types.federatedCatalogueComponent[0].restPath)) {
-        serverConfig.types.federatedCatalogueComponent[0].restPath = "/federated-catalogue";
-    }
-}
-/**
- * Adds the socket paths to the server config.
- * @param serverConfig The server config.
- */
-function addDefaultSocketPaths(serverConfig) {
-    if (Is.arrayValue(serverConfig.types.eventBusComponent) &&
-        !Is.stringValue(serverConfig.types.eventBusComponent[0].socketPath)) {
-        serverConfig.types.eventBusComponent[0].socketPath = "event-bus";
-    }
-}
-
-export { EngineServer, addDefaultRestPaths, addDefaultSocketPaths };