@twin.org/api-server-fastify 0.0.3-next.9 → 0.9.0

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,25 @@ Runtime name for the class.
 
 ## Methods
 
-### getInstance()
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IWebServer.className`
+
+***
+
+### getInstance() {#getinstance}
 
 > **getInstance**(): `FastifyInstance`
 
@@ -54,7 +72,7 @@ The web server instance.
 
 ***
 
-### build()
+### build() {#build}
 
 > **build**(`restRouteProcessors?`, `restRoutes?`, `socketRouteProcessors?`, `socketRoutes?`, `options?`): `Promise`\<`void`\>
 
@@ -96,7 +114,7 @@ Options for building the server.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the server is fully built and ready to start.
 
 #### Implementation of
 
@@ -104,7 +122,7 @@ Nothing.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(): `Promise`\<`void`\>
 
@@ -114,7 +132,7 @@ Start the server.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the server is listening for connections.
 
 #### Implementation of
 
@@ -122,7 +140,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -132,8 +150,26 @@ Stop the server.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the server has shut down all connections.
 
 #### Implementation of
 
 `IWebServer.stop`
+
+***
+
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Perform a health check on the server by fetching its own root endpoint.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health status of the server.
+
+#### Implementation of
+
+`IWebServer.health`

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,24 +4,24 @@ 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.
 
 ***
 
-### 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/locales/.validate-ignore

@@ -1,2 +1,3 @@
-^>=5.x.x$
-^socket.io$
+# Fastify plugin options in fastifySocketIo.ts — not locale keys
+>=5\.x\.x
+socket\.io

package/locales/en.json

@@ -5,7 +5,8 @@
 			"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}\""
+			"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]\"."
 		}
 	},
 	"info": {
@@ -17,5 +18,12 @@
 			"restRouteAdded": "Added REST route \"{route}\" \"{method}\"",
 			"socketRouteAdded": "Added socket route: handshake path \"{handshakePath}\", namespace \"{namespace}\", event name \"{eventName}\""
 		}
+	},
+	"health": {
+		"fastifyWebServer": {
+			"description": "Checks if the Web Server is reachable",
+			"reachable": "The Web Server is reachable",
+			"unreachable": "The Web Server is unreachable"
+		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-server-fastify",
-	"version": "0.0.3-next.9",
-	"description": "Use Fastify as the core web server for APIs",
+	"version": "0.9.0",
+	"description": "Fastify web server integration for exposing API routes with consistent runtime behaviour.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-server-fastify"
 	},
 	"author": "martyn.janes@iota.org",
@@ -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.9",
-		"@twin.org/api-models": "0.0.3-next.9",
-		"@twin.org/api-processors": "0.0.3-next.9",
-		"@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/compress": "9.0.0",
+		"@fastify/cors": "11.2.0",
+		"@twin.org/api-core": "^0.9.0",
+		"@twin.org/api-models": "^0.9.0",
+		"@twin.org/api-processors": "^0.9.0",
+		"@twin.org/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/logging-models": "^0.9.0-next.1",
+		"@twin.org/nameof": "^0.9.0",
+		"@twin.org/web": "^0.9.0",
+		"fastify": "5.8.5",
+		"socket.io": "4.8.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -51,7 +51,7 @@
 		"api"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }