@3sixty/engine-server 0.0.0-stage → 0.20.0-next.0

package/docs/reference/classes/EngineServer.md

@@ -0,0 +1,181 @@
+# Class: EngineServer\<T\>
+
+Server for the engine.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `IEngineServerConfig` = `IEngineServerConfig`
+
+## Implements
+
+- `IEngineServer`
+
+## Constructors
+
+### Constructor
+
+> **new EngineServer**\<`T`\>(`options`): `EngineServer`\<`T`\>
+
+Create a new instance of EngineServer.
+
+#### Parameters
+
+##### options
+
+The options for the engine.
+
+###### engineCore
+
+`IEngineCore`\<`T`\>
+
+The engine core to serve from.
+
+#### Returns
+
+`EngineServer`\<`T`\>
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### addRestRouteGenerator() {#addrestroutegenerator}
+
+> **addRestRouteGenerator**(`type`, `module`, `method`): `void`
+
+Add a REST route generator.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to add the generator for.
+
+##### module
+
+`string`
+
+The module containing the generator.
+
+##### method
+
+`string`
+
+The method to call on the module.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineServer.addRestRouteGenerator`
+
+***
+
+### addSocketRouteGenerator() {#addsocketroutegenerator}
+
+> **addSocketRouteGenerator**(`type`, `module`, `method`): `void`
+
+Add a socket route generator.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to add the generator for.
+
+##### module
+
+`string`
+
+The module containing the generator.
+
+##### method
+
+`string`
+
+The method to call on the module.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`IEngineServer.addSocketRouteGenerator`
+
+***
+
+### getRestRoutes() {#getrestroutes}
+
+> **getRestRoutes**(): `IRestRoute`\<`any`, `any`\>[]
+
+Get the built REST routes.
+
+#### Returns
+
+`IRestRoute`\<`any`, `any`\>[]
+
+The REST routes.
+
+***
+
+### getSocketRoutes() {#getsocketroutes}
+
+> **getSocketRoutes**(): `ISocketRoute`\<`any`, `any`\>[]
+
+Get the built socket routes.
+
+#### Returns
+
+`ISocketRoute`\<`any`, `any`\>[]
+
+The socket routes.
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Start the engine server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server has started and is ready to accept requests.
+
+#### Implementation of
+
+`IEngineServer.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the engine server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the server has stopped and all connections are closed.
+
+#### Implementation of
+
+`IEngineServer.stop`

package/docs/reference/functions/addDefaultRestPaths.md

@@ -0,0 +1,17 @@
+# Function: addDefaultRestPaths()
+
+> **addDefaultRestPaths**(`serverConfig`): `void`
+
+Adds the rest paths to the server config if not already set.
+
+## 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/index.md

@@ -0,0 +1,10 @@
+# @3sixty/engine-server
+
+## Classes
+
+- [EngineServer](classes/EngineServer.md)
+
+## Functions
+
+- [addDefaultRestPaths](functions/addDefaultRestPaths.md)
+- [addDefaultSocketPaths](functions/addDefaultSocketPaths.md)

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,54 @@
 {
-  "name": "@3sixty/engine-server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/engine-server",
+	"version": "0.20.0-next.0",
+	"description": "Server runtime that exposes engine components through REST and socket routes.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/engine.git",
+		"directory": "packages/engine-server"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "next",
+		"@3sixty/api-server-fastify": "next",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/engine-models": "0.20.0-next.0",
+		"@3sixty/engine-server-types": "0.20.0-next.0",
+		"@3sixty/modules": "next",
+		"@3sixty/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/engine/issues"
+	},
+	"homepage": "https://3sixty.global"
+}