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

package/docs/reference/index.md

@@ -0,0 +1,10 @@
+# @3sixty/api-server-fastify
+
+## Classes
+
+- [FastifyWebServer](classes/FastifyWebServer.md)
+
+## Interfaces
+
+- [IFastifyWebServerConfig](interfaces/IFastifyWebServerConfig.md)
+- [IFastifyWebServerConstructorOptions](interfaces/IFastifyWebServerConstructorOptions.md)

package/docs/reference/interfaces/IFastifyWebServerConfig.md

@@ -0,0 +1,33 @@
+# Interface: IFastifyWebServerConfig
+
+The configuration for the Fastify web server.
+
+## Properties
+
+### web? {#web}
+
+> `optional` **web?**: `Partial`\<`FastifyServerOptions`\> & `object`
+
+The web server options, providing the https options serves over HTTPS.
+
+#### Type Declaration
+
+##### https?
+
+> `optional` **https?**: `ServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>
+
+***
+
+### socket? {#socket}
+
+> `optional` **socket?**: `Partial`\<`ServerOptions`\>
+
+The socket server options.
+
+***
+
+### includeErrorStack? {#includeerrorstack}
+
+> `optional` **includeErrorStack?**: `boolean`
+
+Include the stack with errors.

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,3 @@
+# Fastify plugin options in fastifySocketIo.ts, not locale keys
+>=5\.x\.x
+socket\.io

package/locales/en.json

@@ -0,0 +1,14 @@
+{
+	"error": {
+		"fastifyWebServer": {
+			"badRequest": "The web server could not handle the request",
+			"unknownBodyLimit": "The route \"{route}\" uses the body limit named \"{bodyLimit}\", which is not configured"
+		}
+	},
+	"info": {
+		"fastifyWebServer": {
+			"restRouteAdded": "Added REST route \"{route}\" \"{method}\"",
+			"socketRouteAdded": "Added socket route: handshake path \"{handshakePath}\", namespace \"{namespace}\", event name \"{eventName}\""
+		}
+	}
+}

package/package.json

@@ -1,6 +1,57 @@
 {
-  "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.1",
+	"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": {
+		"@3sixty/api-core": "0.20.0-next.1",
+		"@3sixty/api-core-server": "0.20.0-next.1",
+		"@3sixty/api-models": "0.20.0-next.1",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next",
+		"@fastify/compress": "9.2.2",
+		"@fastify/cors": "11.3.1",
+		"fastify": "5.12.7",
+		"fastify-plugin": "6.0.1",
+		"socket.io": "4.8.4"
+	},
+	"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"
+}