@3sixty/api-core-server 0.20.0-next.0 → 0.20.0-next.1

package/docs/reference/interfaces/IBaseServerConstructorOptions.md

@@ -0,0 +1,33 @@
+# Interface: IBaseServerConstructorOptions
+
+Options for constructing a base server.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The type of the logging component to use, defaults to no logging.
+
+***
+
+### mimeTypeProcessors? {#mimetypeprocessors}
+
+> `optional` **mimeTypeProcessors?**: `IMimeTypeProcessor`[]
+
+The mime type processors to use for the request bodies.
+
+***
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.
+
+#### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/IRestProcessorChains.md

@@ -0,0 +1,171 @@
+# Interface: IRestProcessorChains
+
+The REST processor phase chains, bound to their processors when the server is built.
+
+## Properties
+
+### pre {#pre}
+
+> **pre**: ((`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`) => `Promise`\<`void`\>)[]
+
+The pre processing phase.
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The request to handle.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`IRestRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### process {#process}
+
+> **process**: ((`request`, `response`, `route`, `processorState`, `componentTypes?`) => `Promise`\<`void`\>)[]
+
+The main processing phase.
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The request to handle.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`IRestRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### post {#post}
+
+> **post**: ((`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`) => `Promise`\<`void`\>)[]
+
+The post processing phase.
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The request to handle.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`IRestRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/docs/reference/interfaces/IServerCorsOptions.md

@@ -0,0 +1,43 @@
+# Interface: IServerCorsOptions
+
+The resolved CORS options for a server.
+
+## Properties
+
+### origins {#origins}
+
+> **origins**: `string`[]
+
+The allowed origins.
+
+***
+
+### hasWildcardOrigin {#haswildcardorigin}
+
+> **hasWildcardOrigin**: `boolean`
+
+Whether the allowed origins include the wildcard, in which case any origin is allowed.
+
+***
+
+### methods {#methods}
+
+> **methods**: `HttpMethod`[]
+
+The allowed methods.
+
+***
+
+### allowedHeaders {#allowedheaders}
+
+> **allowedHeaders**: `string`[]
+
+The allowed headers.
+
+***
+
+### exposedHeaders {#exposedheaders}
+
+> **exposedHeaders**: `string`[]
+
+The exposed headers.

package/docs/reference/interfaces/ISocketProcessorChains.md

@@ -0,0 +1,245 @@
+# Interface: ISocketProcessorChains
+
+The socket processor phase chains, bound to their processors when the server is built.
+
+## Properties
+
+### connected {#connected}
+
+> **connected**: ((`request`, `route`, `loggingComponentType?`) => `Promise`\<`void`\>)[]
+
+The socket connected phase.
+
+Process the connected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### disconnected {#disconnected}
+
+> **disconnected**: ((`request`, `route`, `loggingComponentType?`) => `Promise`\<`void`\>)[]
+
+The socket disconnected phase.
+
+Process the disconnected event.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### pre {#pre}
+
+> **pre**: ((`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`) => `Promise`\<`void`\>)[]
+
+The pre processing phase.
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The request to handle.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### process {#process}
+
+> **process**: ((`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`) => `Promise`\<`void`\>)[]
+
+The main processing phase.
+
+Process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The server request object containing the socket id and other parameters.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### responseEmitter
+
+(`topic`, `response`) => `Promise`\<`void`\>
+
+The function to emit a response.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type for the request.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.
+
+***
+
+### post {#post}
+
+> **post**: ((`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`) => `Promise`\<`void`\>)[]
+
+The post processing phase.
+
+Post process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`ISocketServerRequest`
+
+The request to handle.
+
+##### response
+
+`IHttpResponse`
+
+The response data to send if any.
+
+##### route
+
+`ISocketRoute`\<`any`, `any`\> \| `undefined`
+
+The route being requested, if a matching one was found.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
+
+`string`
+
+The logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the request is processed.

package/locales/.validate-ignore

@@ -0,0 +1,3 @@
+# Host literals used when normalising the bind address in baseServer.ts, not locale keys
+127.0.0.1
+0.0.0.0

package/locales/en.json

@@ -0,0 +1,33 @@
+{
+	"error": {
+		"baseServer": {
+			"startFailed": "The Web Server failed to start",
+			"noRestProcessors": "You must configure at least one REST processor",
+			"noSocketProcessors": "You must configure at least one socket processor",
+			"postProcessorError": "There was a failure in a post processor for route \"{route}\"",
+			"invalidPublicOrigin": "The public origin \"{publicOrigin}\" is not a valid origin URL, it should be in the format \"protocol://host[:port]\".",
+			"invalidBodyLimit": "The body limit named \"{bodyLimit}\" must be an integer greater than zero, but it is \"{value}\"",
+			"invalidStatusCode": "The response status code \"{statusCode}\" is not valid",
+			"invalidHeader": "The response header \"{header}\" has an invalid name or value"
+		}
+	},
+	"info": {
+		"baseServer": {
+			"building": "Building Web Server",
+			"starting": "Starting Web Server with binding \"{host}\" on port \"{port}\"",
+			"started": "The Web Server started on {addresses}",
+			"stopped": "The Web Server was stopped"
+		}
+	},
+	"health": {
+		"baseServer": {
+			"healthConnectivityDescription": "Checks if the Web Server is reachable",
+			"reachable": "The Web Server is reachable",
+			"unreachable": "The Web Server is unreachable",
+			"healthApplicationDescription": "Checks if the root endpoint is reachable",
+			"rootEndpointReachable": "The root endpoint is reachable",
+			"rootEndpointError": "The root endpoint returned an unexpected response",
+			"serverNotBuilt": "The server has not been built"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,54 @@
-{
-  "name": "@3sixty/api-core-server",
-  "version": "0.20.0-next.0",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+	"name": "@3sixty/api-core-server",
+	"version": "0.20.0-next.1",
+	"description": "Base server class with transport agnostic route processing for building web servers.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-core-server"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "0.20.0-next.1",
+		"@3sixty/api-processors": "0.20.0-next.1",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "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"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"server",
+		"core"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}