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

package/dist/types/engineServer.d.ts

@@ -1,45 +1,42 @@
-import { type IEngineCore, type IEngineCoreTypeConfig, type IEngineServer, type IEngineServerConfig, type RestRouteGenerator, type SocketRouteGenerator } from "@twin.org/engine-models";
+import type { IEngineCore, IEngineCoreTypeConfig, IEngineServer } from "@twin.org/engine-models";
+import { type IEngineServerConfig } from "@twin.org/engine-server-types";
 /**
  * Server for the engine.
  */
-export declare class EngineServer implements IEngineServer {
+export declare class EngineServer<T extends IEngineServerConfig = IEngineServerConfig> implements IEngineServer {
     /**
      * Runtime name for the class.
      */
     readonly CLASS_NAME: string;
-    /**
-     * The server config.
-     */
-    protected readonly _config: IEngineServerConfig;
     /**
      * Create a new instance of EngineServer.
      * @param options The options for the engine.
-     * @param options.server The server options for the engine.
      * @param options.engineCore The engine core to serve from.
      */
     constructor(options: {
-        engineCore: IEngineCore;
-        server?: IEngineServerConfig;
+        engineCore: IEngineCore<T>;
     });
     /**
      * Add a REST route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, generator: RestRouteGenerator): void;
+    addRestRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
     /**
      * Add a socket route generator.
      * @param type The type to add the generator for.
      * @param typeConfig The type config.
-     * @param generator The generator to add.
+     * @param module The module containing the generator.
+     * @param method The method to call on the module.
      */
-    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, generator: SocketRouteGenerator): void;
+    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, module: string, method: string): void;
     /**
      * Start the engine server.
-     * @returns Nothing.
+     * @returns True if the start was successful.
      */
-    start(): Promise<void>;
+    start(): Promise<boolean>;
     /**
      * Stop the engine server.
      * @returns Nothing.

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,37 @@
+/**
+ * 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;
+}

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

@@ -0,0 +1,13 @@
+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;

package/docs/changelog.md

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

package/docs/reference/classes/EngineServer.md

@@ -1,7 +1,11 @@
-# Class: EngineServer
+# Class: EngineServer\<T\>
 
 Server for the engine.
 
+## Type Parameters
+
+• **T** *extends* `IEngineServerConfig` = `IEngineServerConfig`
+
 ## Implements
 
 - `IEngineServer`
@@ -10,27 +14,25 @@ Server for the engine.
 
 ### new EngineServer()
 
-> **new EngineServer**(`options`): [`EngineServer`](EngineServer.md)
+> **new EngineServer**\<`T`\>(`options`): [`EngineServer`](EngineServer.md)\<`T`\>
 
 Create a new instance of EngineServer.
 
 #### Parameters
 
-• **options**
+##### options
 
 The options for the engine.
 
-• **options.engineCore**: `IEngineCore`\<`IEngineState`\>
-
-The engine core to serve from.
+###### engineCore
 
-• **options.server?**: `IEngineServerConfig`
+`IEngineCore`\<`T`\>
 
-The server options for the engine.
+The engine core to serve from.
 
 #### Returns
 
-[`EngineServer`](EngineServer.md)
+[`EngineServer`](EngineServer.md)\<`T`\>
 
 ## Properties
 
@@ -40,35 +42,39 @@ The server options for the engine.
 
 Runtime name for the class.
 
-***
-
-### \_config
-
-> `protected` `readonly` **\_config**: `IEngineServerConfig`
-
-The server config.
-
 ## Methods
 
 ### addRestRouteGenerator()
 
-> **addRestRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
+> **addRestRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
 
 Add a REST route generator.
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type to add the generator for.
 
-• **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
+##### typeConfig
 
 The type config.
 
-• **generator**: `RestRouteGenerator`
+`undefined` | `IEngineCoreTypeConfig`[]
+
+##### module
 
-The generator to add.
+`string`
+
+The module containing the generator.
+
+##### method
+
+`string`
+
+The method to call on the module.
 
 #### Returns
 
@@ -82,23 +88,35 @@ The generator to add.
 
 ### addSocketRouteGenerator()
 
-> **addSocketRouteGenerator**(`type`, `typeConfig`, `generator`): `void`
+> **addSocketRouteGenerator**(`type`, `typeConfig`, `module`, `method`): `void`
 
 Add a socket route generator.
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type to add the generator for.
 
-• **typeConfig**: `undefined` \| `IEngineCoreTypeConfig`[]
+##### typeConfig
 
 The type config.
 
-• **generator**: `SocketRouteGenerator`
+`undefined` | `IEngineCoreTypeConfig`[]
+
+##### module
 
-The generator to add.
+`string`
+
+The module containing the generator.
+
+##### method
+
+`string`
+
+The method to call on the module.
 
 #### Returns
 
@@ -112,15 +130,15 @@ The generator to add.
 
 ### start()
 
-> **start**(): `Promise`\<`void`\>
+> **start**(): `Promise`\<`boolean`\>
 
 Start the engine server.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`boolean`\>
 
-Nothing.
+True if the start was successful.
 
 #### Implementation of
 

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -0,0 +1,37 @@
+# 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/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,67 @@
+# 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.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.41",
 	"description": "Engine implementation for a server.",
 	"repository": {
 		"type": "git",
@@ -14,83 +14,23 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-service": "next",
-		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/api-processors": "next",
 		"@twin.org/api-server-fastify": "next",
-		"@twin.org/api-service": "next",
-		"@twin.org/attestation-connector-entity-storage": "next",
-		"@twin.org/attestation-connector-iota": "next",
-		"@twin.org/attestation-models": "next",
-		"@twin.org/attestation-service": "next",
-		"@twin.org/auditable-item-graph-models": "next",
-		"@twin.org/auditable-item-graph-service": "next",
-		"@twin.org/auditable-item-stream-models": "next",
-		"@twin.org/auditable-item-stream-service": "next",
-		"@twin.org/background-task-connector-entity-storage": "next",
-		"@twin.org/background-task-models": "next",
-		"@twin.org/blob-storage-connector-aws-s3": "next",
-		"@twin.org/blob-storage-connector-azure": "next",
-		"@twin.org/blob-storage-connector-file": "next",
-		"@twin.org/blob-storage-connector-gcp": "next",
-		"@twin.org/blob-storage-connector-ipfs": "next",
-		"@twin.org/blob-storage-connector-memory": "next",
-		"@twin.org/blob-storage-models": "next",
-		"@twin.org/blob-storage-service": "next",
-		"@twin.org/cli-core": "next",
 		"@twin.org/core": "next",
-		"@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/entity": "next",
-		"@twin.org/entity-storage-connector-cosmosdb": "next",
-		"@twin.org/entity-storage-connector-dynamodb": "next",
-		"@twin.org/entity-storage-connector-file": "next",
-		"@twin.org/entity-storage-connector-gcp-firestore": "next",
-		"@twin.org/entity-storage-connector-memory": "next",
-		"@twin.org/entity-storage-connector-scylladb": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/entity-storage-service": "next",
-		"@twin.org/identity-connector-entity-storage": "next",
-		"@twin.org/identity-connector-iota": "next",
-		"@twin.org/identity-models": "next",
-		"@twin.org/identity-service": "next",
-		"@twin.org/immutable-proof-models": "next",
-		"@twin.org/immutable-proof-service": "next",
-		"@twin.org/immutable-storage-connector-entity-storage": "next",
-		"@twin.org/immutable-storage-connector-iota": "next",
-		"@twin.org/immutable-storage-models": "next",
-		"@twin.org/logging-connector-console": "next",
-		"@twin.org/logging-connector-entity-storage": "next",
-		"@twin.org/logging-models": "next",
-		"@twin.org/logging-service": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/nft-connector-entity-storage": "next",
-		"@twin.org/nft-connector-iota": "next",
-		"@twin.org/nft-models": "next",
-		"@twin.org/nft-service": "next",
-		"@twin.org/telemetry-connector-entity-storage": "next",
-		"@twin.org/telemetry-models": "next",
-		"@twin.org/telemetry-service": "next",
-		"@twin.org/vault-connector-entity-storage": "next",
-		"@twin.org/vault-connector-hashicorp": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/wallet-connector-entity-storage": "next",
-		"@twin.org/wallet-connector-iota": "next",
-		"@twin.org/wallet-models": "next",
-		"@twin.org/web": "next"
+		"@twin.org/engine-core": "0.0.1-next.41",
+		"@twin.org/engine-models": "0.0.1-next.41",
+		"@twin.org/engine-server-types": "0.0.1-next.41",
+		"@twin.org/modules": "next",
+		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},

package/dist/types/components/authentication.d.ts

@@ -1,11 +0,0 @@
-import { type IEngineCoreContext, type AuthenticationComponentConfig, type IEngineCore } from "@twin.org/engine-models";
-/**
- * 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.
- */
-export declare function initialiseAuthenticationComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: AuthenticationComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/information.d.ts

@@ -1,11 +0,0 @@
-import { type IEngineCore, type IEngineCoreContext, type InformationComponentConfig } from "@twin.org/engine-models";
-/**
- * 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.
- */
-export declare function initialiseInformationComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: InformationComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/mimeTypeProcessor.d.ts

@@ -1,11 +0,0 @@
-import { type IEngineCore, type IEngineCoreContext, type MimeTypeProcessorConfig } from "@twin.org/engine-models";
-/**
- * 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.
- */
-export declare function initialiseMimeTypeProcessorComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: MimeTypeProcessorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/restRouteProcessor.d.ts

@@ -1,11 +0,0 @@
-import { type IEngineCoreContext, type IEngineCore, type RestRouteProcessorConfig } from "@twin.org/engine-models";
-/**
- * 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.
- */
-export declare function initialiseRestRouteProcessorComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: RestRouteProcessorConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/components/socketRouteProcessor.d.ts

@@ -1,11 +0,0 @@
-import { type IEngineCoreContext, type IEngineCore, type SocketRouteProcessorConfig } from "@twin.org/engine-models";
-/**
- * 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.
- */
-export declare function initialiseSocketRouteProcessorComponent(engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: SocketRouteProcessorConfig, overrideInstanceType?: string): string | undefined;