@twin.org/engine-server 0.0.3-next.26 → 0.0.3-next.27

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Engine Server
 
-Engine implementation for a server.
+Engine Server exposes runtime capabilities through REST and socket routes and integrates hosting concerns with engine orchestration. It is intended for service deployments that need structured API entry points backed by shared runtime conventions.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,22 @@
-# @twin.org/engine-server - Changelog
+# Changelog
+
+## [0.0.3-next.27](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.3-next.26...engine-server-v0.0.3-next.27) (2026-03-20)
+
+
+### Features
+
+* update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/engine-models bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/engine-server-types bumped from 0.0.3-next.26 to 0.0.3-next.27
+  * devDependencies
+    * @twin.org/engine bumped from 0.0.3-next.26 to 0.0.3-next.27
 
 ## [0.0.3-next.26](https://github.com/twinfoundation/engine/compare/engine-server-v0.0.3-next.25...engine-server-v0.0.3-next.26) (2026-03-05)
 

package/docs/examples.md

@@ -1 +1,79 @@
-# @twin.org/engine-server - Examples
+# Engine Server Examples
+
+These examples show how to wire a core instance into an HTTP server and apply default REST and socket paths.
+
+## EngineServer
+
+```typescript
+import { Engine } from '@twin.org/engine';
+import { EngineServer } from '@twin.org/engine-server';
+import type { IEngineServerConfig } from '@twin.org/engine-server-types';
+import {
+  HostingComponentType,
+  InformationComponentType,
+  RestRouteProcessorType,
+  SocketRouteProcessorType
+} from '@twin.org/engine-server-types';
+
+const config: IEngineServerConfig = {
+  debug: false,
+  silent: true,
+  web: { port: 3001 },
+  types: {
+    hostingComponent: [{ type: HostingComponentType.Service }],
+    informationComponent: [{ type: InformationComponentType.Service, restPath: '/info' }],
+    restRouteProcessor: [{ type: RestRouteProcessorType.RestRoute }],
+    socketRouteProcessor: [{ type: SocketRouteProcessorType.SocketRoute }]
+  }
+};
+
+const engine = new Engine({ config, skipBootstrap: true });
+const server = new EngineServer({ engineCore: engine });
+
+server.addRestRouteGenerator(
+  'informationComponent',
+  '@twin.org/engine-server-types',
+  'generateInformationRestRoutes'
+);
+server.addSocketRouteGenerator(
+  'informationComponent',
+  '@twin.org/engine-server-types',
+  'generateInformationSocketRoutes'
+);
+
+console.log(server.getRestRoutes().length); // 0
+console.log(server.getSocketRoutes().length); // 0
+
+await server.start();
+console.log(server.getRestRoutes().length > 0); // true
+
+await server.stop();
+```
+
+## addDefaultRestPaths and addDefaultSocketPaths
+
+```typescript
+import { addDefaultRestPaths, addDefaultSocketPaths } from '@twin.org/engine-server';
+import type { IEngineServerConfig } from '@twin.org/engine-server-types';
+import {
+  InformationComponentType,
+  RestRouteProcessorType,
+  SocketRouteProcessorType
+} from '@twin.org/engine-server-types';
+
+const serverConfig: IEngineServerConfig = {
+  debug: false,
+  silent: false,
+  types: {
+    informationComponent: [{ type: InformationComponentType.Service }],
+    restRouteProcessor: [{ type: RestRouteProcessorType.RestRoute }],
+    socketRouteProcessor: [{ type: SocketRouteProcessorType.SocketRoute }]
+  }
+};
+
+addDefaultRestPaths(serverConfig);
+addDefaultSocketPaths(serverConfig);
+
+console.log(typeof serverConfig.types.informationComponent?.[0].restPath === 'string'); // true
+console.log(typeof serverConfig.types.informationComponent?.[0].socketPath === 'string'); // true
+```

package/docs/reference/classes/EngineServer.md

@@ -38,7 +38,7 @@ The engine core to serve from.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -46,7 +46,7 @@ Runtime name for the class.
 
 ## Methods
 
-### addRestRouteGenerator()
+### addRestRouteGenerator() {#addrestroutegenerator}
 
 > **addRestRouteGenerator**(`type`, `module`, `method`): `void`
 
@@ -82,7 +82,7 @@ The method to call on the module.
 
 ***
 
-### addSocketRouteGenerator()
+### addSocketRouteGenerator() {#addsocketroutegenerator}
 
 > **addSocketRouteGenerator**(`type`, `module`, `method`): `void`
 
@@ -118,7 +118,7 @@ The method to call on the module.
 
 ***
 
-### getRestRoutes()
+### getRestRoutes() {#getrestroutes}
 
 > **getRestRoutes**(): `IRestRoute`\<`any`, `any`\>[]
 
@@ -132,7 +132,7 @@ The REST routes.
 
 ***
 
-### getSocketRoutes()
+### getSocketRoutes() {#getsocketroutes}
 
 > **getSocketRoutes**(): `ISocketRoute`\<`any`, `any`\>[]
 
@@ -146,7 +146,7 @@ The socket routes.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -164,7 +164,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/engine-server",
-	"version": "0.0.3-next.26",
-	"description": "Engine implementation for a server.",
+	"version": "0.0.3-next.27",
+	"description": "Server runtime that exposes engine components through REST and socket routes.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/engine.git",
@@ -18,9 +18,9 @@
 		"@twin.org/api-server-fastify": "next",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.3-next.26",
-		"@twin.org/engine-models": "0.0.3-next.26",
-		"@twin.org/engine-server-types": "0.0.3-next.26",
+		"@twin.org/engine-core": "0.0.3-next.27",
+		"@twin.org/engine-models": "0.0.3-next.27",
+		"@twin.org/engine-server-types": "0.0.3-next.27",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
 	},