@twin.org/engine-server 0.0.1-next.67 → 0.0.1-next.69

package/dist/cjs/index.cjs

@@ -39,6 +39,16 @@ class EngineServer {
      * @internal
      */
     _loggingConnectorType;
+    /**
+     * The REST routes for the application.
+     * @internal
+     */
+    _restRoutes;
+    /**
+     * The Socket routes for the application.
+     * @internal
+     */
+    _socketRoutes;
     /**
      * Create a new instance of EngineServer.
      * @param options The options for the engine.
@@ -50,6 +60,8 @@ class EngineServer {
         this._engineCore = options.engineCore;
         this._restRouteGenerators = [];
         this._socketRouteGenerators = [];
+        this._restRoutes = [];
+        this._socketRoutes = [];
         const coreConfig = this._engineCore.getConfig();
         if (!core.Is.arrayValue(coreConfig.types.restRouteProcessor)) {
             coreConfig.types.restRouteProcessor = [];
@@ -131,6 +143,20 @@ class EngineServer {
             });
         }
     }
+    /**
+     * Get the built REST routes.
+     * @returns The REST routes.
+     */
+    getRestRoutes() {
+        return this._restRoutes;
+    }
+    /**
+     * Get the built socket routes.
+     * @returns The socket routes.
+     */
+    getSocketRoutes() {
+        return this._socketRoutes;
+    }
     /**
      * Start the engine server.
      * @returns True if the start was successful.
@@ -158,8 +184,8 @@ class EngineServer {
      * @internal
      */
     async startWebServer() {
-        const restRoutes = await this.buildRestRoutes();
-        const socketRoutes = await this.buildSocketRoutes();
+        this._restRoutes = await this.buildRestRoutes();
+        this._socketRoutes = await this.buildSocketRoutes();
         const restRouteProcessors = apiModels.RestRouteProcessorFactory.names().map(n => apiModels.RestRouteProcessorFactory.get(n));
         const socketRouteProcessors = apiModels.SocketRouteProcessorFactory.names().map(n => apiModels.SocketRouteProcessorFactory.get(n));
         const mimeTypeProcessors = apiModels.MimeTypeProcessorFactory.names().map(n => apiModels.MimeTypeProcessorFactory.get(n));
@@ -170,7 +196,7 @@ class EngineServer {
             loggingConnectorType: this._loggingConnectorType,
             mimeTypeProcessors
         });
-        await this._webServer.build(restRouteProcessors, restRoutes, socketRouteProcessors, socketRoutes, coreConfig.web);
+        await this._webServer.build(restRouteProcessors, this._restRoutes, socketRouteProcessors, this._socketRoutes, coreConfig.web);
         await this._webServer.start();
     }
     /**
@@ -416,16 +442,15 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, o
             }
         });
     }
-    addRestPaths(coreEngineConfig, serverConfig);
-    addSocketPaths(coreEngineConfig);
+    addDefaultRestPaths(serverConfig);
+    addDefaultSocketPaths(serverConfig);
     return serverConfig;
 }
 /**
  * Adds the rest paths to the server config.
- * @param coreEngineConfig The core engine config.
  * @param serverConfig The server config.
  */
-function addRestPaths(coreEngineConfig, serverConfig) {
+function addDefaultRestPaths(serverConfig) {
     if (core.Is.arrayValue(serverConfig.types.informationComponent)) {
         serverConfig.types.informationComponent[0].restPath = "";
     }
@@ -433,74 +458,75 @@ function addRestPaths(coreEngineConfig, serverConfig) {
         !core.Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
         serverConfig.types.authenticationComponent[0].restPath = "authentication";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.blobStorageComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.blobStorageComponent[0].restPath)) {
-        coreEngineConfig.types.blobStorageComponent[0].restPath = "blob";
+    if (core.Is.arrayValue(serverConfig.types.blobStorageComponent) &&
+        !core.Is.stringValue(serverConfig.types.blobStorageComponent[0].restPath)) {
+        serverConfig.types.blobStorageComponent[0].restPath = "blob";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.loggingComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.loggingComponent[0].restPath)) {
-        coreEngineConfig.types.loggingComponent[0].restPath = "logging";
+    if (core.Is.arrayValue(serverConfig.types.loggingComponent) &&
+        !core.Is.stringValue(serverConfig.types.loggingComponent[0].restPath)) {
+        serverConfig.types.loggingComponent[0].restPath = "logging";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.telemetryComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.telemetryComponent[0].restPath)) {
-        coreEngineConfig.types.telemetryComponent[0].restPath = "telemetry";
+    if (core.Is.arrayValue(serverConfig.types.telemetryComponent) &&
+        !core.Is.stringValue(serverConfig.types.telemetryComponent[0].restPath)) {
+        serverConfig.types.telemetryComponent[0].restPath = "telemetry";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.identityComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.identityComponent[0].restPath)) {
-        coreEngineConfig.types.identityComponent[0].restPath = "identity";
+    if (core.Is.arrayValue(serverConfig.types.identityComponent) &&
+        !core.Is.stringValue(serverConfig.types.identityComponent[0].restPath)) {
+        serverConfig.types.identityComponent[0].restPath = "identity";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.identityResolverComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.identityResolverComponent[0].restPath)) {
-        coreEngineConfig.types.identityResolverComponent[0].restPath = "identity";
+    if (core.Is.arrayValue(serverConfig.types.identityResolverComponent) &&
+        !core.Is.stringValue(serverConfig.types.identityResolverComponent[0].restPath)) {
+        serverConfig.types.identityResolverComponent[0].restPath = "identity";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.identityProfileComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.identityProfileComponent[0].restPath)) {
-        coreEngineConfig.types.identityProfileComponent[0].restPath = "identity/profile";
+    if (core.Is.arrayValue(serverConfig.types.identityProfileComponent) &&
+        !core.Is.stringValue(serverConfig.types.identityProfileComponent[0].restPath)) {
+        serverConfig.types.identityProfileComponent[0].restPath = "identity/profile";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.nftComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.nftComponent[0].restPath)) {
-        coreEngineConfig.types.nftComponent[0].restPath = "nft";
+    if (core.Is.arrayValue(serverConfig.types.nftComponent) &&
+        !core.Is.stringValue(serverConfig.types.nftComponent[0].restPath)) {
+        serverConfig.types.nftComponent[0].restPath = "nft";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.verifiableStorageComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.verifiableStorageComponent[0].restPath)) {
-        coreEngineConfig.types.verifiableStorageComponent[0].restPath = "verifiable";
+    if (core.Is.arrayValue(serverConfig.types.verifiableStorageComponent) &&
+        !core.Is.stringValue(serverConfig.types.verifiableStorageComponent[0].restPath)) {
+        serverConfig.types.verifiableStorageComponent[0].restPath = "verifiable";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.immutableProofComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.immutableProofComponent[0].restPath)) {
-        coreEngineConfig.types.immutableProofComponent[0].restPath = "immutable-proof";
+    if (core.Is.arrayValue(serverConfig.types.immutableProofComponent) &&
+        !core.Is.stringValue(serverConfig.types.immutableProofComponent[0].restPath)) {
+        serverConfig.types.immutableProofComponent[0].restPath = "immutable-proof";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.attestationComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.attestationComponent[0].restPath)) {
-        coreEngineConfig.types.attestationComponent[0].restPath = "attestation";
+    if (core.Is.arrayValue(serverConfig.types.attestationComponent) &&
+        !core.Is.stringValue(serverConfig.types.attestationComponent[0].restPath)) {
+        serverConfig.types.attestationComponent[0].restPath = "attestation";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.auditableItemGraphComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.auditableItemGraphComponent[0].restPath)) {
-        coreEngineConfig.types.auditableItemGraphComponent[0].restPath = "aig";
+    if (core.Is.arrayValue(serverConfig.types.auditableItemGraphComponent) &&
+        !core.Is.stringValue(serverConfig.types.auditableItemGraphComponent[0].restPath)) {
+        serverConfig.types.auditableItemGraphComponent[0].restPath = "aig";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.auditableItemStreamComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.auditableItemStreamComponent[0].restPath)) {
-        coreEngineConfig.types.auditableItemStreamComponent[0].restPath = "ais";
+    if (core.Is.arrayValue(serverConfig.types.auditableItemStreamComponent) &&
+        !core.Is.stringValue(serverConfig.types.auditableItemStreamComponent[0].restPath)) {
+        serverConfig.types.auditableItemStreamComponent[0].restPath = "ais";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.dataProcessingComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.dataProcessingComponent[0].restPath)) {
-        coreEngineConfig.types.dataProcessingComponent[0].restPath = "data-processing";
+    if (core.Is.arrayValue(serverConfig.types.dataProcessingComponent) &&
+        !core.Is.stringValue(serverConfig.types.dataProcessingComponent[0].restPath)) {
+        serverConfig.types.dataProcessingComponent[0].restPath = "data-processing";
     }
-    if (core.Is.arrayValue(coreEngineConfig.types.documentManagementComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.documentManagementComponent[0].restPath)) {
-        coreEngineConfig.types.documentManagementComponent[0].restPath = "document-management";
+    if (core.Is.arrayValue(serverConfig.types.documentManagementComponent) &&
+        !core.Is.stringValue(serverConfig.types.documentManagementComponent[0].restPath)) {
+        serverConfig.types.documentManagementComponent[0].restPath = "documents";
     }
 }
 /**
  * Adds the socket paths to the server config.
- * @param coreEngineConfig The core engine config.
  * @param serverConfig The server config.
  */
-function addSocketPaths(coreEngineConfig, serverConfig) {
-    if (core.Is.arrayValue(coreEngineConfig.types.eventBusComponent) &&
-        !core.Is.stringValue(coreEngineConfig.types.eventBusComponent[0].socketPath)) {
-        coreEngineConfig.types.eventBusComponent[0].socketPath = "event-bus";
+function addDefaultSocketPaths(serverConfig) {
+    if (core.Is.arrayValue(serverConfig.types.eventBusComponent) &&
+        !core.Is.stringValue(serverConfig.types.eventBusComponent[0].socketPath)) {
+        serverConfig.types.eventBusComponent[0].socketPath = "event-bus";
     }
 }
 
 exports.EngineServer = EngineServer;
+exports.addDefaultRestPaths = addDefaultRestPaths;
+exports.addDefaultSocketPaths = addDefaultSocketPaths;
 exports.buildEngineServerConfiguration = buildEngineServerConfiguration;

package/dist/esm/index.mjs

@@ -37,6 +37,16 @@ class EngineServer {
      * @internal
      */
     _loggingConnectorType;
+    /**
+     * The REST routes for the application.
+     * @internal
+     */
+    _restRoutes;
+    /**
+     * The Socket routes for the application.
+     * @internal
+     */
+    _socketRoutes;
     /**
      * Create a new instance of EngineServer.
      * @param options The options for the engine.
@@ -48,6 +58,8 @@ class EngineServer {
         this._engineCore = options.engineCore;
         this._restRouteGenerators = [];
         this._socketRouteGenerators = [];
+        this._restRoutes = [];
+        this._socketRoutes = [];
         const coreConfig = this._engineCore.getConfig();
         if (!Is.arrayValue(coreConfig.types.restRouteProcessor)) {
             coreConfig.types.restRouteProcessor = [];
@@ -129,6 +141,20 @@ class EngineServer {
             });
         }
     }
+    /**
+     * Get the built REST routes.
+     * @returns The REST routes.
+     */
+    getRestRoutes() {
+        return this._restRoutes;
+    }
+    /**
+     * Get the built socket routes.
+     * @returns The socket routes.
+     */
+    getSocketRoutes() {
+        return this._socketRoutes;
+    }
     /**
      * Start the engine server.
      * @returns True if the start was successful.
@@ -156,8 +182,8 @@ class EngineServer {
      * @internal
      */
     async startWebServer() {
-        const restRoutes = await this.buildRestRoutes();
-        const socketRoutes = await this.buildSocketRoutes();
+        this._restRoutes = await this.buildRestRoutes();
+        this._socketRoutes = await this.buildSocketRoutes();
         const restRouteProcessors = RestRouteProcessorFactory.names().map(n => RestRouteProcessorFactory.get(n));
         const socketRouteProcessors = SocketRouteProcessorFactory.names().map(n => SocketRouteProcessorFactory.get(n));
         const mimeTypeProcessors = MimeTypeProcessorFactory.names().map(n => MimeTypeProcessorFactory.get(n));
@@ -168,7 +194,7 @@ class EngineServer {
             loggingConnectorType: this._loggingConnectorType,
             mimeTypeProcessors
         });
-        await this._webServer.build(restRouteProcessors, restRoutes, socketRouteProcessors, socketRoutes, coreConfig.web);
+        await this._webServer.build(restRouteProcessors, this._restRoutes, socketRouteProcessors, this._socketRoutes, coreConfig.web);
         await this._webServer.start();
     }
     /**
@@ -414,16 +440,15 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, o
             }
         });
     }
-    addRestPaths(coreEngineConfig, serverConfig);
-    addSocketPaths(coreEngineConfig);
+    addDefaultRestPaths(serverConfig);
+    addDefaultSocketPaths(serverConfig);
     return serverConfig;
 }
 /**
  * Adds the rest paths to the server config.
- * @param coreEngineConfig The core engine config.
  * @param serverConfig The server config.
  */
-function addRestPaths(coreEngineConfig, serverConfig) {
+function addDefaultRestPaths(serverConfig) {
     if (Is.arrayValue(serverConfig.types.informationComponent)) {
         serverConfig.types.informationComponent[0].restPath = "";
     }
@@ -431,73 +456,72 @@ function addRestPaths(coreEngineConfig, serverConfig) {
         !Is.stringValue(serverConfig.types.authenticationComponent[0].restPath)) {
         serverConfig.types.authenticationComponent[0].restPath = "authentication";
     }
-    if (Is.arrayValue(coreEngineConfig.types.blobStorageComponent) &&
-        !Is.stringValue(coreEngineConfig.types.blobStorageComponent[0].restPath)) {
-        coreEngineConfig.types.blobStorageComponent[0].restPath = "blob";
+    if (Is.arrayValue(serverConfig.types.blobStorageComponent) &&
+        !Is.stringValue(serverConfig.types.blobStorageComponent[0].restPath)) {
+        serverConfig.types.blobStorageComponent[0].restPath = "blob";
     }
-    if (Is.arrayValue(coreEngineConfig.types.loggingComponent) &&
-        !Is.stringValue(coreEngineConfig.types.loggingComponent[0].restPath)) {
-        coreEngineConfig.types.loggingComponent[0].restPath = "logging";
+    if (Is.arrayValue(serverConfig.types.loggingComponent) &&
+        !Is.stringValue(serverConfig.types.loggingComponent[0].restPath)) {
+        serverConfig.types.loggingComponent[0].restPath = "logging";
     }
-    if (Is.arrayValue(coreEngineConfig.types.telemetryComponent) &&
-        !Is.stringValue(coreEngineConfig.types.telemetryComponent[0].restPath)) {
-        coreEngineConfig.types.telemetryComponent[0].restPath = "telemetry";
+    if (Is.arrayValue(serverConfig.types.telemetryComponent) &&
+        !Is.stringValue(serverConfig.types.telemetryComponent[0].restPath)) {
+        serverConfig.types.telemetryComponent[0].restPath = "telemetry";
     }
-    if (Is.arrayValue(coreEngineConfig.types.identityComponent) &&
-        !Is.stringValue(coreEngineConfig.types.identityComponent[0].restPath)) {
-        coreEngineConfig.types.identityComponent[0].restPath = "identity";
+    if (Is.arrayValue(serverConfig.types.identityComponent) &&
+        !Is.stringValue(serverConfig.types.identityComponent[0].restPath)) {
+        serverConfig.types.identityComponent[0].restPath = "identity";
     }
-    if (Is.arrayValue(coreEngineConfig.types.identityResolverComponent) &&
-        !Is.stringValue(coreEngineConfig.types.identityResolverComponent[0].restPath)) {
-        coreEngineConfig.types.identityResolverComponent[0].restPath = "identity";
+    if (Is.arrayValue(serverConfig.types.identityResolverComponent) &&
+        !Is.stringValue(serverConfig.types.identityResolverComponent[0].restPath)) {
+        serverConfig.types.identityResolverComponent[0].restPath = "identity";
     }
-    if (Is.arrayValue(coreEngineConfig.types.identityProfileComponent) &&
-        !Is.stringValue(coreEngineConfig.types.identityProfileComponent[0].restPath)) {
-        coreEngineConfig.types.identityProfileComponent[0].restPath = "identity/profile";
+    if (Is.arrayValue(serverConfig.types.identityProfileComponent) &&
+        !Is.stringValue(serverConfig.types.identityProfileComponent[0].restPath)) {
+        serverConfig.types.identityProfileComponent[0].restPath = "identity/profile";
     }
-    if (Is.arrayValue(coreEngineConfig.types.nftComponent) &&
-        !Is.stringValue(coreEngineConfig.types.nftComponent[0].restPath)) {
-        coreEngineConfig.types.nftComponent[0].restPath = "nft";
+    if (Is.arrayValue(serverConfig.types.nftComponent) &&
+        !Is.stringValue(serverConfig.types.nftComponent[0].restPath)) {
+        serverConfig.types.nftComponent[0].restPath = "nft";
     }
-    if (Is.arrayValue(coreEngineConfig.types.verifiableStorageComponent) &&
-        !Is.stringValue(coreEngineConfig.types.verifiableStorageComponent[0].restPath)) {
-        coreEngineConfig.types.verifiableStorageComponent[0].restPath = "verifiable";
+    if (Is.arrayValue(serverConfig.types.verifiableStorageComponent) &&
+        !Is.stringValue(serverConfig.types.verifiableStorageComponent[0].restPath)) {
+        serverConfig.types.verifiableStorageComponent[0].restPath = "verifiable";
     }
-    if (Is.arrayValue(coreEngineConfig.types.immutableProofComponent) &&
-        !Is.stringValue(coreEngineConfig.types.immutableProofComponent[0].restPath)) {
-        coreEngineConfig.types.immutableProofComponent[0].restPath = "immutable-proof";
+    if (Is.arrayValue(serverConfig.types.immutableProofComponent) &&
+        !Is.stringValue(serverConfig.types.immutableProofComponent[0].restPath)) {
+        serverConfig.types.immutableProofComponent[0].restPath = "immutable-proof";
     }
-    if (Is.arrayValue(coreEngineConfig.types.attestationComponent) &&
-        !Is.stringValue(coreEngineConfig.types.attestationComponent[0].restPath)) {
-        coreEngineConfig.types.attestationComponent[0].restPath = "attestation";
+    if (Is.arrayValue(serverConfig.types.attestationComponent) &&
+        !Is.stringValue(serverConfig.types.attestationComponent[0].restPath)) {
+        serverConfig.types.attestationComponent[0].restPath = "attestation";
     }
-    if (Is.arrayValue(coreEngineConfig.types.auditableItemGraphComponent) &&
-        !Is.stringValue(coreEngineConfig.types.auditableItemGraphComponent[0].restPath)) {
-        coreEngineConfig.types.auditableItemGraphComponent[0].restPath = "aig";
+    if (Is.arrayValue(serverConfig.types.auditableItemGraphComponent) &&
+        !Is.stringValue(serverConfig.types.auditableItemGraphComponent[0].restPath)) {
+        serverConfig.types.auditableItemGraphComponent[0].restPath = "aig";
     }
-    if (Is.arrayValue(coreEngineConfig.types.auditableItemStreamComponent) &&
-        !Is.stringValue(coreEngineConfig.types.auditableItemStreamComponent[0].restPath)) {
-        coreEngineConfig.types.auditableItemStreamComponent[0].restPath = "ais";
+    if (Is.arrayValue(serverConfig.types.auditableItemStreamComponent) &&
+        !Is.stringValue(serverConfig.types.auditableItemStreamComponent[0].restPath)) {
+        serverConfig.types.auditableItemStreamComponent[0].restPath = "ais";
     }
-    if (Is.arrayValue(coreEngineConfig.types.dataProcessingComponent) &&
-        !Is.stringValue(coreEngineConfig.types.dataProcessingComponent[0].restPath)) {
-        coreEngineConfig.types.dataProcessingComponent[0].restPath = "data-processing";
+    if (Is.arrayValue(serverConfig.types.dataProcessingComponent) &&
+        !Is.stringValue(serverConfig.types.dataProcessingComponent[0].restPath)) {
+        serverConfig.types.dataProcessingComponent[0].restPath = "data-processing";
     }
-    if (Is.arrayValue(coreEngineConfig.types.documentManagementComponent) &&
-        !Is.stringValue(coreEngineConfig.types.documentManagementComponent[0].restPath)) {
-        coreEngineConfig.types.documentManagementComponent[0].restPath = "document-management";
+    if (Is.arrayValue(serverConfig.types.documentManagementComponent) &&
+        !Is.stringValue(serverConfig.types.documentManagementComponent[0].restPath)) {
+        serverConfig.types.documentManagementComponent[0].restPath = "documents";
     }
 }
 /**
  * Adds the socket paths to the server config.
- * @param coreEngineConfig The core engine config.
  * @param serverConfig The server config.
  */
-function addSocketPaths(coreEngineConfig, serverConfig) {
-    if (Is.arrayValue(coreEngineConfig.types.eventBusComponent) &&
-        !Is.stringValue(coreEngineConfig.types.eventBusComponent[0].socketPath)) {
-        coreEngineConfig.types.eventBusComponent[0].socketPath = "event-bus";
+function addDefaultSocketPaths(serverConfig) {
+    if (Is.arrayValue(serverConfig.types.eventBusComponent) &&
+        !Is.stringValue(serverConfig.types.eventBusComponent[0].socketPath)) {
+        serverConfig.types.eventBusComponent[0].socketPath = "event-bus";
     }
 }
 
-export { EngineServer, buildEngineServerConfiguration };
+export { EngineServer, addDefaultRestPaths, addDefaultSocketPaths, buildEngineServerConfiguration };

package/dist/types/engineServer.d.ts

@@ -1,3 +1,4 @@
+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";
 /**
@@ -32,6 +33,16 @@ export declare class EngineServer<T extends IEngineServerConfig = IEngineServerC
      * @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.
+     */
+    getRestRoutes(): IRestRoute[];
+    /**
+     * Get the built socket routes.
+     * @returns The socket routes.
+     */
+    getSocketRoutes(): ISocketRoute[];
     /**
      * Start the engine server.
      * @returns True if the start was successful.

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

@@ -11,3 +11,13 @@ import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerE
  * @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/changelog.md

@@ -1,5 +1,46 @@
 # @twin.org/engine-server - Changelog
 
+## [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)
 
 

package/docs/reference/classes/EngineServer.md

@@ -4,7 +4,9 @@ Server for the engine.
 
 ## Type Parameters
 
-• **T** *extends* `IEngineServerConfig` = `IEngineServerConfig`
+### T
+
+`T` *extends* `IEngineServerConfig` = `IEngineServerConfig`
 
 ## Implements
 
@@ -12,9 +14,9 @@ Server for the engine.
 
 ## Constructors
 
-### new EngineServer()
+### Constructor
 
-> **new EngineServer**\<`T`\>(`options`): [`EngineServer`](EngineServer.md)\<`T`\>
+> **new EngineServer**\<`T`\>(`options`): `EngineServer`\<`T`\>
 
 Create a new instance of EngineServer.
 
@@ -32,7 +34,7 @@ The engine core to serve from.
 
 #### Returns
 
-[`EngineServer`](EngineServer.md)\<`T`\>
+`EngineServer`\<`T`\>
 
 ## Properties
 
@@ -128,6 +130,34 @@ The method to call on the module.
 
 ***
 
+### 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`\<`boolean`\>

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`

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildEngineServerConfiguration()
 
-> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath`?): `IEngineServerConfig`
+> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`): `IEngineServerConfig`
 
 Handles the configuration of the server.
 

package/docs/reference/index.md

@@ -11,3 +11,5 @@
 ## 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.67",
+	"version": "0.0.1-next.69",
 	"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.67",
-		"@twin.org/engine-models": "0.0.1-next.67",
-		"@twin.org/engine-server-types": "0.0.1-next.67",
+		"@twin.org/engine-core": "0.0.1-next.69",
+		"@twin.org/engine-models": "0.0.1-next.69",
+		"@twin.org/engine-server-types": "0.0.1-next.69",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
 	},