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

package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md

@@ -0,0 +1,27 @@
+# Interface: IFastifyWebServerConstructorOptions
+
+The options for the Fastify web server constructor.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The type of the logging component to use, if undefined, no logging will happen.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IFastifyWebServerConfig`](IFastifyWebServerConfig.md)
+
+Additional configuration for the server.
+
+***
+
+### mimeTypeProcessors? {#mimetypeprocessors}
+
+> `optional` **mimeTypeProcessors?**: `IMimeTypeProcessor`[]
+
+Additional MIME type processors.

package/locales/.validate-ignore

@@ -0,0 +1,5 @@
+# Fastify plugin options in fastifySocketIo.ts — not locale keys
+>=5\.x\.x
+socket\.io
+127.0.0.1
+0.0.0.0

package/locales/en.json

@@ -0,0 +1,35 @@
+{
+	"error": {
+		"fastifyWebServer": {
+			"startFailed": "The Web Server failed to start",
+			"badRequest": "The web server could not handle the request",
+			"noRestProcessors": "You must configure at least one REST processor",
+			"noSocketProcessors": "You must configure at least one socket processor",
+			"postProcessorError": "There was a failure after 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]\".",
+			"unknownBodyLimit": "The route \"{route}\" uses the body limit named \"{bodyLimit}\", which is not configured",
+			"invalidBodyLimit": "The body limit named \"{bodyLimit}\" must be an integer greater than zero, but it is \"{value}\""
+		}
+	},
+	"info": {
+		"fastifyWebServer": {
+			"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",
+			"restRouteAdded": "Added REST route \"{route}\" \"{method}\"",
+			"socketRouteAdded": "Added socket route: handshake path \"{handshakePath}\", namespace \"{namespace}\", event name \"{eventName}\""
+		}
+	},
+	"health": {
+		"fastifyWebServer": {
+			"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,58 @@
 {
-  "name": "@3sixty/api-server-fastify",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-server-fastify",
+	"version": "0.20.0-next.0",
+	"description": "Fastify web server integration for exposing API routes with consistent runtime behaviour.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-server-fastify"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@fastify/compress": "9.2.0",
+		"@fastify/cors": "11.3.0",
+		"@3sixty/api-core": "0.20.0-next.0",
+		"@3sixty/api-models": "0.20.0-next.0",
+		"@3sixty/api-processors": "0.20.0-next.0",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/logging-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next",
+		"fastify": "5.12.5",
+		"fastify-plugin": "6.0.0",
+		"socket.io": "4.8.3"
+	},
+	"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"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}