@twin.org/engine-server 0.0.1-next.30 → 0.0.1-next.32

package/dist/cjs/index.cjs

@@ -291,9 +291,10 @@ class EngineServer {
  * @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) {
+function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
     envVars.authSigningKeyId ??= "auth-signing";
     const webServerOptions = {
         port: core.Coerce.number(envVars.port),
@@ -320,7 +321,8 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo) {
                     type: engineServerTypes.InformationComponentType.Service,
                     options: {
                         config: {
-                            serverInfo
+                            serverInfo,
+                            openApiSpecPath
                         }
                     }
                 }

package/dist/esm/index.mjs

@@ -289,9 +289,10 @@ class EngineServer {
  * @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) {
+function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
     envVars.authSigningKeyId ??= "auth-signing";
     const webServerOptions = {
         port: Coerce.number(envVars.port),
@@ -318,7 +319,8 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo) {
                     type: InformationComponentType.Service,
                     options: {
                         config: {
-                            serverInfo
+                            serverInfo,
+                            openApiSpecPath
                         }
                     }
                 }

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

@@ -7,6 +7,7 @@ import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerE
  * @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): IEngineServerConfig;
+export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string): IEngineServerConfig;

package/docs/reference/classes/EngineServer.md

@@ -20,11 +20,13 @@ Create a new instance of EngineServer.
 
 #### Parameters
 
-• **options**
+##### options
 
 The options for the engine.
 
-• **options.engineCore**: `IEngineCore`\<`T`, `IEngineState`\>
+###### engineCore
+
+`IEngineCore`\<`T`\>
 
 The engine core to serve from.
 
@@ -50,19 +52,27 @@ Add a REST route generator.
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type to add the generator for.
 
-• **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
+##### typeConfig
 
 The type config.
 
-• **module**: `string`
+`undefined` | `IEngineCoreTypeConfig`[]
+
+##### module
+
+`string`
 
 The module containing the generator.
 
-• **method**: `string`
+##### method
+
+`string`
 
 The method to call on the module.
 
@@ -84,19 +94,27 @@ Add a socket route generator.
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type to add the generator for.
 
-• **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
+##### typeConfig
 
 The type config.
 
-• **module**: `string`
+`undefined` | `IEngineCoreTypeConfig`[]
+
+##### module
+
+`string`
 
 The module containing the generator.
 
-• **method**: `string`
+##### method
+
+`string`
 
 The method to call on the module.
 

package/docs/reference/functions/buildEngineServerConfiguration.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.1-next.30",
+	"version": "0.0.1-next.32",
 	"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.30",
-		"@twin.org/engine-models": "0.0.1-next.30",
-		"@twin.org/engine-server-types": "0.0.1-next.30",
+		"@twin.org/engine-core": "0.0.1-next.32",
+		"@twin.org/engine-models": "0.0.1-next.32",
+		"@twin.org/engine-server-types": "0.0.1-next.32",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
 	},