@twin.org/engine-server 0.0.1-next.9 → 0.0.1

package/dist/types/engineServer.d.ts

@@ -1,45 +1,53 @@
-import { type IEngineCore, type IEngineCoreTypeConfig, type IEngineServer, type IEngineServerConfig, type RestRouteGenerator, type SocketRouteGenerator } from "@twin.org/engine-models";
+import type { IRestRoute, ISocketRoute } from "@twin.org/api-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, module: string, method: string): void;
+    /**
+     * Get the built REST routes.
+     * @returns The REST routes.
      */
-    addSocketRouteGenerator(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, generator: SocketRouteGenerator): void;
+    getRestRoutes(): IRestRoute[];
+    /**
+     * Get the built socket routes.
+     * @returns The socket routes.
+     */
+    getSocketRoutes(): ISocketRoute[];
     /**
      * 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,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,372 @@
 # @twin.org/engine-server - Changelog
 
-## v0.0.1-next.9
+## 0.0.1 (2025-07-11)
+
+
+### Features
+
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
+* release to production ([3a4acd1](https://github.com/twinfoundation/engine/commit/3a4acd1f6c66b841d80b6fd3bc1a439a77148fa5))
+* release to production ([5559958](https://github.com/twinfoundation/engine/commit/5559958e2128e6ec3a81e779d1ebd3f370bbb081))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
+* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.84 to 0.0.1
+    * @twin.org/engine-models bumped from 0.0.1-next.84 to 0.0.1
+    * @twin.org/engine-server-types bumped from 0.0.1-next.84 to 0.0.1
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.84 to 0.0.1
+
+## [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)
+
+
+### Features
+
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
+* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.81 to 0.0.1-next.83
+    * @twin.org/engine-models bumped from 0.0.1-next.81 to 0.0.1-next.83
+    * @twin.org/engine-server-types bumped from 0.0.1-next.81 to 0.0.1-next.83
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.81 to 0.0.1-next.83
+
+## [0.0.1-next.81](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.80...engine-server-v0.0.1-next.81) (2025-07-07)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.80 to 0.0.1-next.81
+    * @twin.org/engine-models bumped from 0.0.1-next.80 to 0.0.1-next.81
+    * @twin.org/engine-server-types bumped from 0.0.1-next.80 to 0.0.1-next.81
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.80 to 0.0.1-next.81
+
+## [0.0.1-next.80](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.79...engine-server-v0.0.1-next.80) (2025-06-23)
+
+
+### Features
+
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.79 to 0.0.1-next.80
+    * @twin.org/engine-models bumped from 0.0.1-next.79 to 0.0.1-next.80
+    * @twin.org/engine-server-types bumped from 0.0.1-next.79 to 0.0.1-next.80
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.79 to 0.0.1-next.80
+
+## [0.0.1-next.79](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.78...engine-server-v0.0.1-next.79) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.78 to 0.0.1-next.79
+    * @twin.org/engine-models bumped from 0.0.1-next.78 to 0.0.1-next.79
+    * @twin.org/engine-server-types bumped from 0.0.1-next.78 to 0.0.1-next.79
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.78 to 0.0.1-next.79
+
+## [0.0.1-next.78](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.77...engine-server-v0.0.1-next.78) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.77 to 0.0.1-next.78
+    * @twin.org/engine-models bumped from 0.0.1-next.77 to 0.0.1-next.78
+    * @twin.org/engine-server-types bumped from 0.0.1-next.77 to 0.0.1-next.78
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.77 to 0.0.1-next.78
+
+## [0.0.1-next.77](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.76...engine-server-v0.0.1-next.77) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.76 to 0.0.1-next.77
+    * @twin.org/engine-models bumped from 0.0.1-next.76 to 0.0.1-next.77
+    * @twin.org/engine-server-types bumped from 0.0.1-next.76 to 0.0.1-next.77
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.76 to 0.0.1-next.77
+
+## [0.0.1-next.76](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.75...engine-server-v0.0.1-next.76) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.75 to 0.0.1-next.76
+    * @twin.org/engine-models bumped from 0.0.1-next.75 to 0.0.1-next.76
+    * @twin.org/engine-server-types bumped from 0.0.1-next.75 to 0.0.1-next.76
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.75 to 0.0.1-next.76
+
+## [0.0.1-next.75](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.74...engine-server-v0.0.1-next.75) (2025-05-29)
+
+
+### Features
+
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.74 to 0.0.1-next.75
+    * @twin.org/engine-models bumped from 0.0.1-next.74 to 0.0.1-next.75
+    * @twin.org/engine-server-types bumped from 0.0.1-next.74 to 0.0.1-next.75
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.74 to 0.0.1-next.75
+
+## [0.0.1-next.74](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.73...engine-server-v0.0.1-next.74) (2025-05-23)
+
+
+### Features
+
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.73 to 0.0.1-next.74
+    * @twin.org/engine-models bumped from 0.0.1-next.73 to 0.0.1-next.74
+    * @twin.org/engine-server-types bumped from 0.0.1-next.73 to 0.0.1-next.74
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.73 to 0.0.1-next.74
+
+## [0.0.1-next.73](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.72...engine-server-v0.0.1-next.73) (2025-05-22)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.72 to 0.0.1-next.73
+    * @twin.org/engine-models bumped from 0.0.1-next.72 to 0.0.1-next.73
+    * @twin.org/engine-server-types bumped from 0.0.1-next.72 to 0.0.1-next.73
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.72 to 0.0.1-next.73
+
+## [0.0.1-next.72](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.71...engine-server-v0.0.1-next.72) (2025-05-06)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* method docs ([fb3d73f](https://github.com/twinfoundation/engine/commit/fb3d73fa9e71ab392378fe7bad7a3677e5e7b132))
+* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.71 to 0.0.1-next.72
+    * @twin.org/engine-models bumped from 0.0.1-next.71 to 0.0.1-next.72
+    * @twin.org/engine-server-types bumped from 0.0.1-next.71 to 0.0.1-next.72
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.71 to 0.0.1-next.72
+
+## [0.0.1-next.71](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.70...engine-server-v0.0.1-next.71) (2025-05-06)
+
+
+### Features
+
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.70 to 0.0.1-next.71
+    * @twin.org/engine-models bumped from 0.0.1-next.70 to 0.0.1-next.71
+    * @twin.org/engine-server-types bumped from 0.0.1-next.70 to 0.0.1-next.71
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.70 to 0.0.1-next.71
+
+## [0.0.1-next.70](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.69...engine-server-v0.0.1-next.70) (2025-04-28)
+
+
+### Miscellaneous Chores
+
+* **engine-server:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.69 to 0.0.1-next.70
+    * @twin.org/engine-models bumped from 0.0.1-next.69 to 0.0.1-next.70
+    * @twin.org/engine-server-types bumped from 0.0.1-next.69 to 0.0.1-next.70
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.69 to 0.0.1-next.70
+
+## [0.0.1-next.69](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.68...engine-server-v0.0.1-next.69) (2025-04-25)
+
+
+### Features
+
+* expose default rest and socket path creation ([e6c6e26](https://github.com/twinfoundation/engine/commit/e6c6e266c8017212a74d4997e2e335347457a2bc))
+
+
+### Bug Fixes
+
+* use abbreviated docs path ([9258a72](https://github.com/twinfoundation/engine/commit/9258a72adf266ddcc4f98002a07a7a162755f24b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.68 to 0.0.1-next.69
+    * @twin.org/engine-models bumped from 0.0.1-next.68 to 0.0.1-next.69
+    * @twin.org/engine-server-types bumped from 0.0.1-next.68 to 0.0.1-next.69
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.68 to 0.0.1-next.69
+
+## [0.0.1-next.68](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.67...engine-server-v0.0.1-next.68) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/engine-models bumped from 0.0.1-next.67 to 0.0.1-next.68
+    * @twin.org/engine-server-types bumped from 0.0.1-next.67 to 0.0.1-next.68
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.67 to 0.0.1-next.68
+
+## [0.0.1-next.67](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.1-next.66...engine-server-v0.0.1-next.67) (2025-03-28)
+
+
+### Features
+
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.1-next.66 to 0.0.1-next.67
+    * @twin.org/engine-models bumped from 0.0.1-next.66 to 0.0.1-next.67
+    * @twin.org/engine-server-types bumped from 0.0.1-next.66 to 0.0.1-next.67
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.1-next.66 to 0.0.1-next.67
+
+## v0.0.1-next.66
 
 - Initial Release

package/docs/reference/classes/EngineServer.md

@@ -1,36 +1,40 @@
-# Class: EngineServer
+# Class: EngineServer\<T\>
 
 Server for the engine.
 
+## Type Parameters
+
+### T
+
+`T` *extends* `IEngineServerConfig` = `IEngineServerConfig`
+
 ## Implements
 
 - `IEngineServer`
 
 ## Constructors
 
-### new EngineServer()
+### Constructor
 
-> **new EngineServer**(`options`): [`EngineServer`](EngineServer.md)
+> **new EngineServer**\<`T`\>(`options`): `EngineServer`\<`T`\>
 
 Create a new instance of EngineServer.
 
 #### Parameters
 
-• **options**
+##### options
 
 The options for the engine.
 
-• **options.engineCore**: `IEngineCore`\<`IEngineState`\>
+###### engineCore
 
-The engine core to serve from.
-
-• **options.server?**: `IEngineServerConfig`
+`IEngineCore`\<`T`\>
 
-The server options for the engine.
+The engine core to serve from.
 
 #### Returns
 
-[`EngineServer`](EngineServer.md)
+`EngineServer`\<`T`\>
 
 ## Properties
 
@@ -40,35 +44,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
+
+`string`
+
+The module containing the generator.
+
+##### method
+
+`string`
 
-The generator to add.
+The method to call on the module.
 
 #### Returns
 
@@ -82,23 +90,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
+
+`string`
+
+The module containing the generator.
+
+##### method
 
-The generator to add.
+`string`
+
+The method to call on the module.
 
 #### Returns
 
@@ -110,17 +130,45 @@ The generator to add.
 
 ***
 
+### getRestRoutes()
+
+> **getRestRoutes**(): `IRestRoute`\<`any`, `any`\>[]
+
+Get the built REST routes.
+
+#### Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The REST routes.
+
+***
+
+### getSocketRoutes()
+
+> **getSocketRoutes**(): `ISocketRoute`\<`any`, `any`\>[]
+
+Get the built socket routes.
+
+#### Returns
+
+`ISocketRoute`\<`any`, `any`\>[]
+
+The socket routes.
+
+***
+
 ### 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/addDefaultRestPaths.md

@@ -0,0 +1,17 @@
+# Function: addDefaultRestPaths()
+
+> **addDefaultRestPaths**(`serverConfig`): `void`
+
+Adds the rest paths to the server config.
+
+## Parameters
+
+### serverConfig
+
+`IEngineServerConfig`
+
+The server config.
+
+## Returns
+
+`void`

package/docs/reference/functions/addDefaultSocketPaths.md

@@ -0,0 +1,17 @@
+# Function: addDefaultSocketPaths()
+
+> **addDefaultSocketPaths**(`serverConfig`): `void`
+
+Adds the socket paths to the server config.
+
+## Parameters
+
+### serverConfig
+
+`IEngineServerConfig`
+
+The server config.
+
+## Returns
+
+`void`