@twin.org/engine-server 0.0.1-next.83 → 0.0.1-next.84

package/dist/cjs/index.cjs

@@ -240,7 +240,14 @@ class EngineServer {
                 if (core.Is.string(restPath)) {
                     const serviceType = typeConfig[i].overrideInstanceType ?? defaultEngineTypes[typeKey];
                     if (core.Is.stringValue(serviceType)) {
-                        routes.push(...generateRoutes(restPath, serviceType));
+                        const generatedRoutes = generateRoutes(restPath, serviceType);
+                        for (const route of generatedRoutes) {
+                            // Don't strip trailing slashes from the root path.
+                            if (core.Is.stringValue(route.path) && route.path.length > 1) {
+                                route.path = core.StringHelper.trimTrailingSlashes(route.path);
+                            }
+                        }
+                        routes.push(...generatedRoutes);
                     }
                 }
             }
@@ -318,136 +325,8 @@ class EngineServer {
     }
 }
 
-/**
- * Handles the configuration of the server.
- * @param envVars The environment variables.
- * @param coreEngineConfig The core engine config.
- * @param serverInfo The server information.
- * @param openApiSpecPath The path to the open api spec.
- * @returns The the config for the core and the server.
- */
-function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
-    envVars.authSigningKeyId ??= "auth-signing";
-    const webServerOptions = {
-        port: core.Coerce.number(envVars.port),
-        host: core.Coerce.string(envVars.host),
-        methods: core.Is.stringValue(envVars.httpMethods)
-            ? envVars.httpMethods.split(",")
-            : undefined,
-        allowedHeaders: core.Is.stringValue(envVars.httpAllowedHeaders)
-            ? envVars.httpAllowedHeaders.split(",")
-            : undefined,
-        exposedHeaders: core.Is.stringValue(envVars.httpExposedHeaders)
-            ? envVars.httpExposedHeaders.split(",")
-            : undefined,
-        corsOrigins: core.Is.stringValue(envVars.corsOrigins) ? envVars.corsOrigins.split(",") : undefined
-    };
-    const authProcessorType = envVars.authProcessorType;
-    const serverConfig = {
-        ...coreEngineConfig,
-        web: webServerOptions,
-        types: {
-            ...coreEngineConfig.types,
-            informationComponent: [
-                {
-                    type: engineServerTypes.InformationComponentType.Service,
-                    options: {
-                        config: {
-                            serverInfo,
-                            openApiSpecPath
-                        }
-                    }
-                }
-            ]
-        }
-    };
-    if (core.Is.stringValue(envVars.mimeTypeProcessors)) {
-        const mimeTypeProcessors = envVars.mimeTypeProcessors.split(",");
-        if (core.Is.arrayValue(mimeTypeProcessors)) {
-            serverConfig.types.mimeTypeProcessor ??= [];
-            for (const mimeTypeProcessor of mimeTypeProcessors) {
-                serverConfig.types.mimeTypeProcessor.push({
-                    type: mimeTypeProcessor
-                });
-            }
-        }
-    }
-    serverConfig.types.restRouteProcessor ??= [];
-    serverConfig.types.socketRouteProcessor ??= [];
-    const disableNodeIdentity = core.Coerce.boolean(envVars.disableNodeIdentity);
-    if (!disableNodeIdentity) {
-        serverConfig.types.restRouteProcessor.push({
-            type: engineServerTypes.RestRouteProcessorType.NodeIdentity
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: engineServerTypes.SocketRouteProcessorType.NodeIdentity
-        });
-    }
-    if (!coreEngineConfig.silent) {
-        serverConfig.types.restRouteProcessor.push({
-            type: engineServerTypes.RestRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: engineServerTypes.SocketRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-    }
-    serverConfig.types.restRouteProcessor.push({
-        type: engineServerTypes.RestRouteProcessorType.RestRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    serverConfig.types.socketRouteProcessor.push({
-        type: engineServerTypes.SocketRouteProcessorType.SocketRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    if (authProcessorType === engineServerTypes.AuthenticationComponentType.EntityStorage) {
-        serverConfig.types.authenticationComponent ??= [];
-        serverConfig.types.authenticationComponent.push({
-            type: engineServerTypes.AuthenticationComponentType.EntityStorage,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.types.restRouteProcessor.push({
-            type: engineServerTypes.RestRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: engineServerTypes.SocketRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-    }
-    addDefaultRestPaths(serverConfig);
-    addDefaultSocketPaths(serverConfig);
-    return serverConfig;
-}
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
 /**
  * Adds the rest paths to the server config.
  * @param serverConfig The server config.
@@ -458,71 +337,71 @@ function addDefaultRestPaths(serverConfig) {
     }
     if (core.Is.arrayValue(serverConfig.types.authenticationComponent) &&
         !core.Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
-        serverConfig.types.authenticationComponent[0].restPath = "authentication";
+        serverConfig.types.authenticationComponent[0].restPath = "/authentication";
     }
     if (core.Is.arrayValue(serverConfig.types.blobStorageComponent) &&
         !core.Is.stringValue(serverConfig.types.blobStorageComponent[0].restPath)) {
-        serverConfig.types.blobStorageComponent[0].restPath = "blob";
+        serverConfig.types.blobStorageComponent[0].restPath = "/blob";
     }
     if (core.Is.arrayValue(serverConfig.types.loggingComponent) &&
         !core.Is.stringValue(serverConfig.types.loggingComponent[0].restPath)) {
-        serverConfig.types.loggingComponent[0].restPath = "logging";
+        serverConfig.types.loggingComponent[0].restPath = "/logging";
     }
     if (core.Is.arrayValue(serverConfig.types.telemetryComponent) &&
         !core.Is.stringValue(serverConfig.types.telemetryComponent[0].restPath)) {
-        serverConfig.types.telemetryComponent[0].restPath = "telemetry";
+        serverConfig.types.telemetryComponent[0].restPath = "/telemetry";
     }
     if (core.Is.arrayValue(serverConfig.types.identityComponent) &&
         !core.Is.stringValue(serverConfig.types.identityComponent[0].restPath)) {
-        serverConfig.types.identityComponent[0].restPath = "identity";
+        serverConfig.types.identityComponent[0].restPath = "/identity";
     }
     if (core.Is.arrayValue(serverConfig.types.identityResolverComponent) &&
         !core.Is.stringValue(serverConfig.types.identityResolverComponent[0].restPath)) {
-        serverConfig.types.identityResolverComponent[0].restPath = "identity";
+        serverConfig.types.identityResolverComponent[0].restPath = "/identity";
     }
     if (core.Is.arrayValue(serverConfig.types.identityProfileComponent) &&
         !core.Is.stringValue(serverConfig.types.identityProfileComponent[0].restPath)) {
-        serverConfig.types.identityProfileComponent[0].restPath = "identity/profile";
+        serverConfig.types.identityProfileComponent[0].restPath = "/identity/profile";
     }
     if (core.Is.arrayValue(serverConfig.types.nftComponent) &&
         !core.Is.stringValue(serverConfig.types.nftComponent[0].restPath)) {
-        serverConfig.types.nftComponent[0].restPath = "nft";
+        serverConfig.types.nftComponent[0].restPath = "/nft";
     }
     if (core.Is.arrayValue(serverConfig.types.verifiableStorageComponent) &&
         !core.Is.stringValue(serverConfig.types.verifiableStorageComponent[0].restPath)) {
-        serverConfig.types.verifiableStorageComponent[0].restPath = "verifiable";
+        serverConfig.types.verifiableStorageComponent[0].restPath = "/verifiable";
     }
     if (core.Is.arrayValue(serverConfig.types.immutableProofComponent) &&
         !core.Is.stringValue(serverConfig.types.immutableProofComponent[0].restPath)) {
-        serverConfig.types.immutableProofComponent[0].restPath = "immutable-proof";
+        serverConfig.types.immutableProofComponent[0].restPath = "/immutable-proof";
     }
     if (core.Is.arrayValue(serverConfig.types.attestationComponent) &&
         !core.Is.stringValue(serverConfig.types.attestationComponent[0].restPath)) {
-        serverConfig.types.attestationComponent[0].restPath = "attestation";
+        serverConfig.types.attestationComponent[0].restPath = "/attestation";
     }
     if (core.Is.arrayValue(serverConfig.types.auditableItemGraphComponent) &&
         !core.Is.stringValue(serverConfig.types.auditableItemGraphComponent[0].restPath)) {
-        serverConfig.types.auditableItemGraphComponent[0].restPath = "aig";
+        serverConfig.types.auditableItemGraphComponent[0].restPath = "/aig";
     }
     if (core.Is.arrayValue(serverConfig.types.auditableItemStreamComponent) &&
         !core.Is.stringValue(serverConfig.types.auditableItemStreamComponent[0].restPath)) {
-        serverConfig.types.auditableItemStreamComponent[0].restPath = "ais";
+        serverConfig.types.auditableItemStreamComponent[0].restPath = "/ais";
     }
     if (core.Is.arrayValue(serverConfig.types.dataProcessingComponent) &&
         !core.Is.stringValue(serverConfig.types.dataProcessingComponent[0].restPath)) {
-        serverConfig.types.dataProcessingComponent[0].restPath = "data-processing";
+        serverConfig.types.dataProcessingComponent[0].restPath = "/data-processing";
     }
     if (core.Is.arrayValue(serverConfig.types.documentManagementComponent) &&
         !core.Is.stringValue(serverConfig.types.documentManagementComponent[0].restPath)) {
-        serverConfig.types.documentManagementComponent[0].restPath = "documents";
+        serverConfig.types.documentManagementComponent[0].restPath = "/documents";
     }
     if (core.Is.arrayValue(serverConfig.types.federatedCatalogueComponent) &&
         !core.Is.stringValue(serverConfig.types.federatedCatalogueComponent[0].restPath)) {
-        serverConfig.types.federatedCatalogueComponent[0].restPath = "federated-catalogue";
+        serverConfig.types.federatedCatalogueComponent[0].restPath = "/federated-catalogue";
     }
     if (core.Is.arrayValue(serverConfig.types.rightsManagementComponent) &&
         !core.Is.stringValue(serverConfig.types.rightsManagementComponent[0].restPath)) {
-        serverConfig.types.rightsManagementComponent[0].restPath = "rights-management";
+        serverConfig.types.rightsManagementComponent[0].restPath = "/rights-management";
     }
 }
 /**
@@ -539,4 +418,3 @@ function addDefaultSocketPaths(serverConfig) {
 exports.EngineServer = EngineServer;
 exports.addDefaultRestPaths = addDefaultRestPaths;
 exports.addDefaultSocketPaths = addDefaultSocketPaths;
-exports.buildEngineServerConfiguration = buildEngineServerConfiguration;

package/dist/esm/index.mjs

@@ -1,7 +1,7 @@
 import { RestRouteProcessorFactory, SocketRouteProcessorFactory, MimeTypeProcessorFactory } from '@twin.org/api-models';
 import { FastifyWebServer } from '@twin.org/api-server-fastify';
-import { Guards, Is, Coerce } from '@twin.org/core';
-import { RestRouteProcessorType, SocketRouteProcessorType, InformationComponentType, AuthenticationComponentType } from '@twin.org/engine-server-types';
+import { Guards, Is, StringHelper } from '@twin.org/core';
+import { RestRouteProcessorType, SocketRouteProcessorType } from '@twin.org/engine-server-types';
 import { ModuleHelper } from '@twin.org/modules';
 
 /**
@@ -238,7 +238,14 @@ class EngineServer {
                 if (Is.string(restPath)) {
                     const serviceType = typeConfig[i].overrideInstanceType ?? defaultEngineTypes[typeKey];
                     if (Is.stringValue(serviceType)) {
-                        routes.push(...generateRoutes(restPath, 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);
                     }
                 }
             }
@@ -316,136 +323,8 @@ class EngineServer {
     }
 }
 
-/**
- * Handles the configuration of the server.
- * @param envVars The environment variables.
- * @param coreEngineConfig The core engine config.
- * @param serverInfo The server information.
- * @param openApiSpecPath The path to the open api spec.
- * @returns The the config for the core and the server.
- */
-function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
-    envVars.authSigningKeyId ??= "auth-signing";
-    const webServerOptions = {
-        port: Coerce.number(envVars.port),
-        host: Coerce.string(envVars.host),
-        methods: Is.stringValue(envVars.httpMethods)
-            ? envVars.httpMethods.split(",")
-            : undefined,
-        allowedHeaders: Is.stringValue(envVars.httpAllowedHeaders)
-            ? envVars.httpAllowedHeaders.split(",")
-            : undefined,
-        exposedHeaders: Is.stringValue(envVars.httpExposedHeaders)
-            ? envVars.httpExposedHeaders.split(",")
-            : undefined,
-        corsOrigins: Is.stringValue(envVars.corsOrigins) ? envVars.corsOrigins.split(",") : undefined
-    };
-    const authProcessorType = envVars.authProcessorType;
-    const serverConfig = {
-        ...coreEngineConfig,
-        web: webServerOptions,
-        types: {
-            ...coreEngineConfig.types,
-            informationComponent: [
-                {
-                    type: InformationComponentType.Service,
-                    options: {
-                        config: {
-                            serverInfo,
-                            openApiSpecPath
-                        }
-                    }
-                }
-            ]
-        }
-    };
-    if (Is.stringValue(envVars.mimeTypeProcessors)) {
-        const mimeTypeProcessors = envVars.mimeTypeProcessors.split(",");
-        if (Is.arrayValue(mimeTypeProcessors)) {
-            serverConfig.types.mimeTypeProcessor ??= [];
-            for (const mimeTypeProcessor of mimeTypeProcessors) {
-                serverConfig.types.mimeTypeProcessor.push({
-                    type: mimeTypeProcessor
-                });
-            }
-        }
-    }
-    serverConfig.types.restRouteProcessor ??= [];
-    serverConfig.types.socketRouteProcessor ??= [];
-    const disableNodeIdentity = Coerce.boolean(envVars.disableNodeIdentity);
-    if (!disableNodeIdentity) {
-        serverConfig.types.restRouteProcessor.push({
-            type: RestRouteProcessorType.NodeIdentity
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: SocketRouteProcessorType.NodeIdentity
-        });
-    }
-    if (!coreEngineConfig.silent) {
-        serverConfig.types.restRouteProcessor.push({
-            type: RestRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: SocketRouteProcessorType.Logging,
-            options: {
-                config: {
-                    includeBody: coreEngineConfig.debug
-                }
-            }
-        });
-    }
-    serverConfig.types.restRouteProcessor.push({
-        type: RestRouteProcessorType.RestRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    serverConfig.types.socketRouteProcessor.push({
-        type: SocketRouteProcessorType.SocketRoute,
-        options: {
-            config: {
-                includeErrorStack: coreEngineConfig.debug
-            }
-        }
-    });
-    if (authProcessorType === AuthenticationComponentType.EntityStorage) {
-        serverConfig.types.authenticationComponent ??= [];
-        serverConfig.types.authenticationComponent.push({
-            type: AuthenticationComponentType.EntityStorage,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.types.restRouteProcessor.push({
-            type: RestRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-        serverConfig.types.socketRouteProcessor.push({
-            type: SocketRouteProcessorType.AuthHeader,
-            options: {
-                config: {
-                    signingKeyName: envVars.authSigningKeyId
-                }
-            }
-        });
-    }
-    addDefaultRestPaths(serverConfig);
-    addDefaultSocketPaths(serverConfig);
-    return serverConfig;
-}
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
 /**
  * Adds the rest paths to the server config.
  * @param serverConfig The server config.
@@ -456,71 +335,71 @@ function addDefaultRestPaths(serverConfig) {
     }
     if (Is.arrayValue(serverConfig.types.authenticationComponent) &&
         !Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
-        serverConfig.types.authenticationComponent[0].restPath = "authentication";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        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";
+        serverConfig.types.documentManagementComponent[0].restPath = "/documents";
     }
     if (Is.arrayValue(serverConfig.types.federatedCatalogueComponent) &&
         !Is.stringValue(serverConfig.types.federatedCatalogueComponent[0].restPath)) {
-        serverConfig.types.federatedCatalogueComponent[0].restPath = "federated-catalogue";
+        serverConfig.types.federatedCatalogueComponent[0].restPath = "/federated-catalogue";
     }
     if (Is.arrayValue(serverConfig.types.rightsManagementComponent) &&
         !Is.stringValue(serverConfig.types.rightsManagementComponent[0].restPath)) {
-        serverConfig.types.rightsManagementComponent[0].restPath = "rights-management";
+        serverConfig.types.rightsManagementComponent[0].restPath = "/rights-management";
     }
 }
 /**
@@ -534,4 +413,4 @@ function addDefaultSocketPaths(serverConfig) {
     }
 }
 
-export { EngineServer, addDefaultRestPaths, addDefaultSocketPaths, buildEngineServerConfiguration };
+export { EngineServer, addDefaultRestPaths, addDefaultSocketPaths };

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
 export * from "./engineServer";
-export * from "./models/IEngineServerEnvironmentVariables";
-export * from "./utils/engineServerEnvBuilder";
+export * from "./utils/engineServerConfigHelper";

package/dist/types/utils/engineServerConfigHelper.d.ts

@@ -0,0 +1,11 @@
+import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+/**
+ * Adds the rest paths to the server config.
+ * @param serverConfig The server config.
+ */
+export declare function addDefaultRestPaths(serverConfig: IEngineServerConfig): void;
+/**
+ * Adds the socket paths to the server config.
+ * @param serverConfig The server config.
+ */
+export declare function addDefaultSocketPaths(serverConfig: IEngineServerConfig): void;

package/docs/changelog.md

@@ -1,5 +1,23 @@
 # @twin.org/engine-server - Changelog
 
+## [0.0.1-next.84](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.83...engine-server-v0.0.1-next.84) (2025-07-11)
+
+
+### Features
+
+* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.83 to 0.0.1-next.84
+    * @twin.org/engine-models bumped from 0.0.1-next.83 to 0.0.1-next.84
+    * @twin.org/engine-server-types bumped from 0.0.1-next.83 to 0.0.1-next.84
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.83 to 0.0.1-next.84
+
 ## [0.0.1-next.83](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.82...engine-server-v0.0.1-next.83) (2025-07-10)
 
 

package/docs/reference/index.md

@@ -4,12 +4,7 @@
 
 - [EngineServer](classes/EngineServer.md)
 
-## Interfaces
-
-- [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
-
 ## Functions
 
-- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
 - [addDefaultRestPaths](functions/addDefaultRestPaths.md)
 - [addDefaultSocketPaths](functions/addDefaultSocketPaths.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.1-next.83",
+	"version": "0.0.1-next.84",
 	"description": "Engine implementation for a server.",
 	"repository": {
 		"type": "git",
@@ -17,9 +17,9 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.1-next.83",
-		"@twin.org/engine-models": "0.0.1-next.83",
-		"@twin.org/engine-server-types": "0.0.1-next.83",
+		"@twin.org/engine-core": "0.0.1-next.84",
+		"@twin.org/engine-models": "0.0.1-next.84",
+		"@twin.org/engine-server-types": "0.0.1-next.84",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
 	},

package/dist/types/models/IEngineServerEnvironmentVariables.d.ts

@@ -1,45 +0,0 @@
-/**
- * The engine server environment variables.
- */
-export interface IEngineServerEnvironmentVariables {
-    /**
-     * The port to serve the API from.
-     */
-    port?: string;
-    /**
-     * The host to serve the API from.
-     */
-    host?: string;
-    /**
-     * The CORS origins to allow, defaults to *.
-     */
-    corsOrigins?: string;
-    /**
-     * The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
-     */
-    httpMethods?: string;
-    /**
-     * The CORS headers to allow.
-     */
-    httpAllowedHeaders?: string;
-    /**
-     * The CORS headers to expose.
-     */
-    httpExposedHeaders?: string;
-    /**
-     * The type of auth processor to use on the API: entity-storage.
-     */
-    authProcessorType?: string;
-    /**
-     * The id of the key in the vault to use for signing in auth operations.
-     */
-    authSigningKeyId?: string;
-    /**
-     * Additional MIME type processors to include, comma separated.
-     */
-    mimeTypeProcessors?: string;
-    /**
-     * Disable Node Identity route processors.
-     */
-    disableNodeIdentity?: string;
-}

package/dist/types/utils/engineServerEnvBuilder.d.ts

@@ -1,23 +0,0 @@
-import type { IServerInfo } from "@twin.org/api-models";
-import type { IEngineCoreConfig } from "@twin.org/engine-models";
-import { type IEngineServerConfig } from "@twin.org/engine-server-types";
-import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerEnvironmentVariables";
-/**
- * Handles the configuration of the server.
- * @param envVars The environment variables.
- * @param coreEngineConfig The core engine config.
- * @param serverInfo The server information.
- * @param openApiSpecPath The path to the open api spec.
- * @returns The the config for the core and the server.
- */
-export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string): IEngineServerConfig;
-/**
- * Adds the rest paths to the server config.
- * @param serverConfig The server config.
- */
-export declare function addDefaultRestPaths(serverConfig: IEngineServerConfig): void;
-/**
- * Adds the socket paths to the server config.
- * @param serverConfig The server config.
- */
-export declare function addDefaultSocketPaths(serverConfig: IEngineServerConfig): void;

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,37 +0,0 @@
-# Function: buildEngineServerConfiguration()
-
-> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`): `IEngineServerConfig`
-
-Handles the configuration of the server.
-
-## Parameters
-
-### envVars
-
-[`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
-
-The environment variables.
-
-### coreEngineConfig
-
-`IEngineCoreConfig`
-
-The core engine config.
-
-### serverInfo
-
-`IServerInfo`
-
-The server information.
-
-### openApiSpecPath?
-
-`string`
-
-The path to the open api spec.
-
-## Returns
-
-`IEngineServerConfig`
-
-The the config for the core and the server.

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -1,83 +0,0 @@
-# Interface: IEngineServerEnvironmentVariables
-
-The engine server environment variables.
-
-## Properties
-
-### port?
-
-> `optional` **port**: `string`
-
-The port to serve the API from.
-
-***
-
-### host?
-
-> `optional` **host**: `string`
-
-The host to serve the API from.
-
-***
-
-### corsOrigins?
-
-> `optional` **corsOrigins**: `string`
-
-The CORS origins to allow, defaults to *.
-
-***
-
-### httpMethods?
-
-> `optional` **httpMethods**: `string`
-
-The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
-
-***
-
-### httpAllowedHeaders?
-
-> `optional` **httpAllowedHeaders**: `string`
-
-The CORS headers to allow.
-
-***
-
-### httpExposedHeaders?
-
-> `optional` **httpExposedHeaders**: `string`
-
-The CORS headers to expose.
-
-***
-
-### authProcessorType?
-
-> `optional` **authProcessorType**: `string`
-
-The type of auth processor to use on the API: entity-storage.
-
-***
-
-### authSigningKeyId?
-
-> `optional` **authSigningKeyId**: `string`
-
-The id of the key in the vault to use for signing in auth operations.
-
-***
-
-### mimeTypeProcessors?
-
-> `optional` **mimeTypeProcessors**: `string`
-
-Additional MIME type processors to include, comma separated.
-
-***
-
-### disableNodeIdentity?
-
-> `optional` **disableNodeIdentity**: `string`
-
-Disable Node Identity route processors.