@twin.org/api-server-fastify 0.0.3-next.20 → 0.0.3-next.22

package/README.md

@@ -1,6 +1,6 @@
 # TWIN API Server Fastify
 
-Use [Fastify](https://fastify.dev/) as the core web server for APIs.
+This package provides Fastify web server integration for exposing API routes with consistent runtime behaviour. It builds on the Fastify framework to offer a predictable hosting layer for API services.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,36 @@
-# @twin.org/api-server-fastify - Changelog
+# Changelog
+
+## [0.0.3-next.22](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.3-next.21...api-server-fastify-v0.0.3-next.22) (2026-03-27)
+
+
+### Miscellaneous Chores
+
+* **api-server-fastify:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/api-models bumped from 0.0.3-next.21 to 0.0.3-next.22
+    * @twin.org/api-processors bumped from 0.0.3-next.21 to 0.0.3-next.22
+
+## [0.0.3-next.21](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.3-next.20...api-server-fastify-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-server-fastify:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/api-core bumped from 0.0.3-next.20 to 0.0.3-next.21
+    * @twin.org/api-models bumped from 0.0.3-next.20 to 0.0.3-next.21
+    * @twin.org/api-processors bumped from 0.0.3-next.20 to 0.0.3-next.21
 
 ## [0.0.3-next.20](https://github.com/twinfoundation/api/compare/api-server-fastify-v0.0.3-next.19...api-server-fastify-v0.0.3-next.20) (2026-02-09)
 

package/docs/examples.md

@@ -1 +1,37 @@
-# @twin.org/api-server-fastify - Examples
+# Server Fastify Examples
+
+Use these snippets to build and run the Fastify server with explicit lifecycle control in scripts and integration tests.
+
+## FastifyWebServer
+
+```typescript
+import { FastifyWebServer } from '@twin.org/api-server-fastify';
+
+const webServer = new FastifyWebServer();
+
+await webServer.build(undefined, undefined, undefined, undefined, {
+  port: 8080,
+  host: '0.0.0.0'
+});
+
+await webServer.start();
+const instance = webServer.getInstance();
+
+console.log(instance.server.address() !== null); // true
+
+await webServer.stop();
+```
+
+```typescript
+import { FastifyWebServer } from '@twin.org/api-server-fastify';
+
+const webServer = new FastifyWebServer();
+
+await webServer.build(undefined, undefined, undefined, undefined, {
+  port: 3000,
+  host: '127.0.0.1'
+});
+
+await webServer.start();
+await webServer.stop();
+```

package/docs/reference/classes/FastifyWebServer.md

@@ -28,7 +28,7 @@ The options for the server.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### getInstance()
+### getInstance() {#getinstance}
 
 > **getInstance**(): `FastifyInstance`
 
@@ -54,7 +54,7 @@ The web server instance.
 
 ***
 
-### build()
+### build() {#build}
 
 > **build**(`restRouteProcessors?`, `restRoutes?`, `socketRouteProcessors?`, `socketRoutes?`, `options?`): `Promise`\<`void`\>
 
@@ -104,7 +104,7 @@ Nothing.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -122,7 +122,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IFastifyWebServerConfig.md

@@ -4,24 +4,24 @@ The configuration for the Fastify web server.
 
 ## Properties
 
-### web?
+### web? {#web}
 
-> `optional` **web**: `Partial`\<`FastifyServerOptions`\>
+> `optional` **web?**: `Partial`\<`FastifyServerOptions`\>
 
 The web server options.
 
 ***
 
-### socket?
+### socket? {#socket}
 
-> `optional` **socket**: `Partial`\<`ServerOptions`\>
+> `optional` **socket?**: `Partial`\<`ServerOptions`\>
 
 The socket server options.
 
 ***
 
-### includeErrorStack?
+### includeErrorStack? {#includeerrorstack}
 
-> `optional` **includeErrorStack**: `boolean`
+> `optional` **includeErrorStack?**: `boolean`
 
 Include the stack with errors.

package/docs/reference/interfaces/IFastifyWebServerConstructorOptions.md

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

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/api-server-fastify",
-	"version": "0.0.3-next.20",
-	"description": "Use Fastify as the core web server for APIs",
+	"version": "0.0.3-next.22",
+	"description": "Fastify web server integration for exposing API routes with consistent runtime behaviour.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/api.git",
@@ -14,18 +14,18 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@fastify/compress": "8.3.0",
-		"@fastify/cors": "11.1.0",
-		"@twin.org/api-core": "0.0.3-next.20",
-		"@twin.org/api-models": "0.0.3-next.20",
-		"@twin.org/api-processors": "0.0.3-next.20",
+		"@fastify/compress": "8.3.1",
+		"@fastify/cors": "11.2.0",
+		"@twin.org/api-core": "0.0.3-next.22",
+		"@twin.org/api-models": "0.0.3-next.22",
+		"@twin.org/api-processors": "0.0.3-next.22",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",
-		"fastify": "5.6.2",
-		"socket.io": "4.8.1"
+		"fastify": "5.8.4",
+		"socket.io": "4.8.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",