@twin.org/engine-server 0.0.1-next.4 → 0.0.1-next.6

package/dist/cjs/index.cjs

@@ -34,7 +34,7 @@ function initialiseAuthenticationComponent(engineCore$1, context, instanceConfig
     const type = instanceConfig.type;
     let component;
     let instanceType;
-    if (type === engineModels.AuthenticationComponentType.AuthEntityStorage) {
+    if (type === engineModels.AuthenticationComponentType.EntityStorage) {
         apiAuthEntityStorageService.initSchema();
         engineCore.initialiseEntityStorageConnector(engineCore$1, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new apiAuthEntityStorageService.EntityStorageAuthenticationService({
@@ -511,4 +511,117 @@ class EngineServer {
     }
 }
 
+/**
+ * Handles the configuration of the server.
+ * @param coreEngine The core engine.
+ * @param envVars The environment variables.
+ * @param serverInfo The server information.
+ * @returns The the config for the core and the server.
+ */
+function buildEngineServerConfiguration(coreEngine, envVars, serverInfo) {
+    envVars.adminUsername ??= "admin@node";
+    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 coreConfig = coreEngine.getConfig();
+    const authProcessorType = envVars.authProcessorType;
+    const serverConfig = {
+        web: webServerOptions,
+        informationComponent: [
+            {
+                type: engineModels.InformationComponentType.Service,
+                options: {
+                    config: {
+                        serverInfo
+                    }
+                }
+            }
+        ],
+        restRouteProcessor: []
+    };
+    serverConfig.restRouteProcessor ??= [];
+    serverConfig.socketRouteProcessor ??= [];
+    if (!coreConfig.silent) {
+        serverConfig.restRouteProcessor.push({
+            type: engineModels.RestRouteProcessorType.Logging,
+            options: {
+                config: {
+                    includeBody: coreConfig.debug
+                }
+            }
+        });
+        serverConfig.socketRouteProcessor.push({
+            type: engineModels.SocketRouteProcessorType.Logging,
+            options: {
+                config: {
+                    includeBody: coreConfig.debug
+                }
+            }
+        });
+    }
+    serverConfig.restRouteProcessor.push({
+        type: engineModels.RestRouteProcessorType.NodeIdentity
+    });
+    serverConfig.socketRouteProcessor.push({
+        type: engineModels.SocketRouteProcessorType.NodeIdentity
+    });
+    serverConfig.restRouteProcessor.push({
+        type: engineModels.RestRouteProcessorType.RestRoute,
+        options: {
+            config: {
+                includeErrorStack: coreConfig.debug
+            }
+        }
+    });
+    serverConfig.socketRouteProcessor.push({
+        type: engineModels.SocketRouteProcessorType.SocketRoute,
+        options: {
+            config: {
+                includeErrorStack: coreConfig.debug
+            }
+        }
+    });
+    if (authProcessorType === engineModels.AuthenticationComponentType.EntityStorage) {
+        serverConfig.authenticationComponent ??= [];
+        serverConfig.authenticationComponent.push({
+            type: engineModels.AuthenticationComponentType.EntityStorage,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+        serverConfig.restRouteProcessor.push({
+            type: engineModels.RestRouteProcessorType.AuthHeader,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+        serverConfig.socketRouteProcessor.push({
+            type: engineModels.SocketRouteProcessorType.AuthHeader,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+    }
+    return serverConfig;
+}
+
 exports.EngineServer = EngineServer;
+exports.buildEngineServerConfiguration = buildEngineServerConfiguration;

package/dist/esm/index.mjs

@@ -6,7 +6,7 @@ import { generateRestRoutesAttestation } from '@twin.org/attestation-service';
 import { generateRestRoutesAuditableItemGraph } from '@twin.org/auditable-item-graph-service';
 import { generateRestRoutesAuditableItemStream } from '@twin.org/auditable-item-stream-service';
 import { generateRestRoutesBlobStorage } from '@twin.org/blob-storage-service';
-import { I18n, GeneralError, ComponentFactory, Guards, Is } from '@twin.org/core';
+import { I18n, GeneralError, ComponentFactory, Guards, Is, Coerce } from '@twin.org/core';
 import { AuthenticationComponentType, InformationComponentType, MimeTypeProcessorType, RestRouteProcessorType, SocketRouteProcessorType } from '@twin.org/engine-models';
 import { generateRestRoutesEntityStorage } from '@twin.org/entity-storage-service';
 import { generateRestRoutesIdentity, generateRestRoutesIdentityProfile } from '@twin.org/identity-service';
@@ -32,7 +32,7 @@ function initialiseAuthenticationComponent(engineCore, context, instanceConfig,
     const type = instanceConfig.type;
     let component;
     let instanceType;
-    if (type === AuthenticationComponentType.AuthEntityStorage) {
+    if (type === AuthenticationComponentType.EntityStorage) {
         initSchema();
         initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.userEntityStorageType, "AuthenticationUser");
         component = new EntityStorageAuthenticationService({
@@ -509,4 +509,116 @@ class EngineServer {
     }
 }
 
-export { EngineServer };
+/**
+ * Handles the configuration of the server.
+ * @param coreEngine The core engine.
+ * @param envVars The environment variables.
+ * @param serverInfo The server information.
+ * @returns The the config for the core and the server.
+ */
+function buildEngineServerConfiguration(coreEngine, envVars, serverInfo) {
+    envVars.adminUsername ??= "admin@node";
+    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 coreConfig = coreEngine.getConfig();
+    const authProcessorType = envVars.authProcessorType;
+    const serverConfig = {
+        web: webServerOptions,
+        informationComponent: [
+            {
+                type: InformationComponentType.Service,
+                options: {
+                    config: {
+                        serverInfo
+                    }
+                }
+            }
+        ],
+        restRouteProcessor: []
+    };
+    serverConfig.restRouteProcessor ??= [];
+    serverConfig.socketRouteProcessor ??= [];
+    if (!coreConfig.silent) {
+        serverConfig.restRouteProcessor.push({
+            type: RestRouteProcessorType.Logging,
+            options: {
+                config: {
+                    includeBody: coreConfig.debug
+                }
+            }
+        });
+        serverConfig.socketRouteProcessor.push({
+            type: SocketRouteProcessorType.Logging,
+            options: {
+                config: {
+                    includeBody: coreConfig.debug
+                }
+            }
+        });
+    }
+    serverConfig.restRouteProcessor.push({
+        type: RestRouteProcessorType.NodeIdentity
+    });
+    serverConfig.socketRouteProcessor.push({
+        type: SocketRouteProcessorType.NodeIdentity
+    });
+    serverConfig.restRouteProcessor.push({
+        type: RestRouteProcessorType.RestRoute,
+        options: {
+            config: {
+                includeErrorStack: coreConfig.debug
+            }
+        }
+    });
+    serverConfig.socketRouteProcessor.push({
+        type: SocketRouteProcessorType.SocketRoute,
+        options: {
+            config: {
+                includeErrorStack: coreConfig.debug
+            }
+        }
+    });
+    if (authProcessorType === AuthenticationComponentType.EntityStorage) {
+        serverConfig.authenticationComponent ??= [];
+        serverConfig.authenticationComponent.push({
+            type: AuthenticationComponentType.EntityStorage,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+        serverConfig.restRouteProcessor.push({
+            type: RestRouteProcessorType.AuthHeader,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+        serverConfig.socketRouteProcessor.push({
+            type: SocketRouteProcessorType.AuthHeader,
+            options: {
+                config: {
+                    signingKeyName: envVars.authSigningKeyId
+                }
+            }
+        });
+    }
+    return serverConfig;
+}
+
+export { EngineServer, buildEngineServerConfiguration };

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,41 @@
+/**
+ * The engine server environment variables.
+ */
+export interface IEngineServerEnvironmentVariables {
+    /**
+     * The name of the admin user.
+     */
+    adminUsername: string;
+    /**
+     * 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;
+}

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

@@ -0,0 +1,11 @@
+import type { IServerInfo } from "@twin.org/api-models";
+import { type IEngineCore, type IEngineServerConfig } from "@twin.org/engine-models";
+import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerEnvironmentVariables";
+/**
+ * Handles the configuration of the server.
+ * @param coreEngine The core engine.
+ * @param envVars The environment variables.
+ * @param serverInfo The server information.
+ * @returns The the config for the core and the server.
+ */
+export declare function buildEngineServerConfiguration(coreEngine: IEngineCore, envVars: IEngineServerEnvironmentVariables, serverInfo: IServerInfo): IEngineServerConfig;

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/engine-server - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.6
 
 - Initial Release

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -0,0 +1,25 @@
+# Function: buildEngineServerConfiguration()
+
+> **buildEngineServerConfiguration**(`coreEngine`, `envVars`, `serverInfo`): `IEngineServerConfig`
+
+Handles the configuration of the server.
+
+## Parameters
+
+• **coreEngine**: `IEngineCore`\<`IEngineState`\>
+
+The core engine.
+
+• **envVars**: [`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
+
+The environment variables.
+
+• **serverInfo**: `IServerInfo`
+
+The server information.
+
+## Returns
+
+`IEngineServerConfig`
+
+The the config for the core and the server.

package/docs/reference/index.md

@@ -3,3 +3,11 @@
 ## Classes
 
 - [EngineServer](classes/EngineServer.md)
+
+## Interfaces
+
+- [IEngineServerEnvironmentVariables](interfaces/IEngineServerEnvironmentVariables.md)
+
+## Functions
+
+- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -0,0 +1,75 @@
+# Interface: IEngineServerEnvironmentVariables
+
+The engine server environment variables.
+
+## Properties
+
+### adminUsername
+
+> **adminUsername**: `string`
+
+The name of the admin user.
+
+***
+
+### port
+
+> **port**: `string`
+
+The port to serve the API from.
+
+***
+
+### host
+
+> **host**: `string`
+
+The host to serve the API from.
+
+***
+
+### corsOrigins
+
+> **corsOrigins**: `string`
+
+The CORS origins to allow, defaults to *.
+
+***
+
+### httpMethods
+
+> **httpMethods**: `string`
+
+The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
+
+***
+
+### httpAllowedHeaders
+
+> **httpAllowedHeaders**: `string`
+
+The CORS headers to allow.
+
+***
+
+### httpExposedHeaders
+
+> **httpExposedHeaders**: `string`
+
+The CORS headers to expose.
+
+***
+
+### authProcessorType
+
+> **authProcessorType**: `string`
+
+The type of auth processor to use on the API: entity-storage.
+
+***
+
+### authSigningKeyId
+
+> **authSigningKeyId**: `string`
+
+The id of the key in the vault to use for signing in auth operations.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.6",
 	"description": "Engine implementation for a server.",
 	"repository": {
 		"type": "git",
@@ -43,8 +43,8 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-schema-org": "next",
-		"@twin.org/engine-core": "0.0.1-next.4",
-		"@twin.org/engine-models": "0.0.1-next.4",
+		"@twin.org/engine-core": "0.0.1-next.6",
+		"@twin.org/engine-models": "0.0.1-next.6",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",